Improve Yard documentation

Author: chrisbarber86

Fudgefile

@@ -3,7 +3,7 @@ task_group :spec do
 end
 
 task_group :docs do
-  task :yard, :coverage => 68
+  task :yard, :coverage => 100
 end
 
 task_group :codestyle do

lib/sageone_sdk.rb

@@ -6,6 +6,7 @@ module SageoneSdk
   class << self
     include SageoneSdk::Configurable
 
+    # Returns an instance of SageoneSdk::Client
     def client
       @client = SageoneSdk::Client.new unless defined?(@client)
       @client

lib/sageone_sdk/client.rb

@@ -62,37 +62,59 @@ def initialize(options = {})
       end
     end
 
+    # Last Response
     def last_response
       @last_response if defined? @last_response
     end
 
+    # Paginate Get Request
+    # @param [String] resource the request resource
+    # @param [Hash] options the request data
     def paginate(resource, options = {})
       data = get(resource, options)
       data
     end
 
+    # Get Request
+    # @param [String] path the request path
+    # @param [Hash] data the request data
     def get(path, data={})
       request(:get, path, data)
     end
 
+    # Post Request
+    # @param [String] path the request path
+    # @param [Hash] data the request data
     def post(path, data={})
       request(:post, path, data)
     end
 
+    # Put Request
+    # @param [String] path the request path
+    # @param [Hash] data the request data
     def put(path, data={})
       request(:put, path, data)
     end
 
+    # Delete Request
+    # @param [String] path the request path
+    # @param [Hash] data the request data
     def delete(path, data={})
       request(:delete, path, data)
     end
 
+    # Request
+    # @param [String] method the request method
+    # @param [String] path the request path
+    # @param [Hash] data the request data
+    # @param [Hash] options Options for the request
     def request(method, path, data, options = {})
       path = File.join("accounts", "v1", path)
       @last_response = response = agent.public_send(method, URI::Parser.new.escape(path.to_s), data, options)
       response.body
     end
 
+    # Agent
     def agent
       @agent ||= Faraday.new(api_endpoint, faraday_options) do |builder|
         builder.request :url_encoded

lib/sageone_sdk/client/contact_types.rb

@@ -3,7 +3,9 @@ class Client
 
     # Represents the types of contact records in Sage One such as Customer or Supplier.
     module ContactTypes
+      # Customer Contact Type
       CUSTOMER = 1.freeze
+      # Supplier Contact Type
       SUPPLIER = 2.freeze
 
       # @return [object] Returns all of the contact types in Sage One. For example, Customer.

lib/sageone_sdk/client/expenditures.rb

@@ -2,22 +2,34 @@ module SageoneSdk
   class Client
     # Expenditures
     module Expenditures
+      # @return [object] Returns paginated expenditures for the authenticated user's business.
       def expenditures(options = {})
         paginate "expenditures", options
       end
 
+      # @return [object] Returns the expenditure with the given id.
       def expenditure(id, options = {})
         get "expenditures/#{id}", options
       end
 
+      # Creates an expenditure with the data provided
+      # @param [hash] data The expenditure information
+      # @param [hash] options
       def create_expenditure(data, options = {})
         post "expenditures", :expenditure => data
       end
 
+      # Updates an expenditure with the data provided
+      # @param [integer] id The expenditure id
+      # @param [hash] data The expenditure information
+      # @param [hash] options
       def update_expenditure(id, data, options = {})
         put "expenditures/#{id}", :expenditure => data
       end
 
+      # Deletes the specified expenditure
+      # @param [integer] id The expenditure id
+      # @param [hash] options
       def delete_expenditure(id, options = {})
         delete "expenditures/#{id}"
       end

lib/sageone_sdk/configurable.rb

@@ -6,6 +6,7 @@ module Configurable
     attr_writer :api_endpoint
 
     class << self
+      # Configuration Keys
       def keys
         @keys ||= [
           :access_token,
@@ -18,10 +19,12 @@ def keys
       end
     end
 
+    # Configure
     def configure
       yield self
     end
 
+    # Reset!
     def reset!
       SageoneSdk::Configurable.keys.each do |key|
         instance_variable_set(:"@#{key}", SageoneSdk::Default.options[key])
@@ -30,6 +33,7 @@ def reset!
     end
     alias :setup :reset!
 
+    # Api Endpoint
     def api_endpoint
       File.join(@api_endpoint, "")
     end

lib/sageone_sdk/default.rb

@@ -3,37 +3,49 @@
 module SageoneSdk
   # Default
   module Default
+    # Default Access Token
     ACCESS_TOKEN = "default_access_token"
+    # Default Signing Secret
     SIGNING_SECRET = "default_signing_secret"
+    # API Endpoint
     API_ENDPOINT = "https://api.sageone.com".freeze
+    # User Agent
     USER_AGENT = "sageone_sdk Ruby Gem #{SageoneSdk::VERSION}".freeze
+    # Media Type
     MEDIA_TYPE = "application/json"
 
     class << self
+      # Options
       def options
         Hash[SageoneSdk::Configurable.keys.map{|key| [key, send(key)]}]
       end
 
+      # Retrieve access token
       def access_token
         ENV["SAGE_ONE_ACCESS_TOKEN"] || ACCESS_TOKEN
       end
 
+      # Retrieve signing secret
       def signing_secret
         ENV["SAGE_ONE_SIGNING_SECRET"] || SIGNING_SECRET
       end
 
+      # Retrieve api endpoint
       def api_endpoint
         ENV["SAGE_ONE_API_ENDPOINT"] || API_ENDPOINT
       end
 
+      # Retrieve media type
       def default_media_type
         ENV["SAGE_ONE_DEFAULT_MEDIA_TYPE"] || MEDIA_TYPE
       end
 
+      # Retrieve user agent
       def user_agent
         ENV["SAGE_ONE_USER_AGENT"] || USER_AGENT
       end
 
+      # Connection Options
       def connection_options
         {
           :headers => {

lib/sageone_sdk/middleware.rb

@@ -1,4 +1,5 @@
 module SageoneSdk
+  # Middleware
   module Middleware
     autoload :Signature, "sageone_sdk/middleware/signature"
     autoload :SDataParser, "sageone_sdk/middleware/sdata_parser"

lib/sageone_sdk/middleware/sdata_parser.rb

@@ -8,6 +8,7 @@ module SageoneSdk
   module Middleware
     # Sdata parser
     class SDataParser < Faraday::Middleware
+      # Call
       def call(environment)
         @app.call(environment).on_complete do |env|
           element = ::JSON.parse(env[:body])

lib/sageone_sdk/middleware/signature.rb

@@ -12,6 +12,7 @@ def initialize(app, access_token, signing_secret)
         @signing_secret = signing_secret
       end
 
+      # Call
       def call(env)
         nonce = SageoneSdk::Signature.generate_nonce
         signature = SageoneSdk::Signature.new(env.method, env.url, env.body, nonce, @signing_secret, @access_token)

lib/sageone_sdk/sdata_error_response.rb

@@ -7,24 +7,31 @@ def initialize(data = {})
       @data = data
     end
 
+    # Diagnoses
     def diagnoses
       @data["$diagnoses"]
     end
 
+    # Full Messages
     def full_messages
       diagnoses.map do |x|
         "#{x["$source"].humanize}: #{x["$message"]}"
       end
     end
 
+    # Error?
+    # @return Boolean
     def error?
       true
     end
 
+    # Respond to missing?
+    # @return Boolean
     def respond_to_missing?(method, include_private =  false)
       resources.respond_to?(method, include_private)
     end
 
+    # Handle method missing
     def method_missing(method, *args, &block)
       if diagnoses.respond_to?(method)
         diagnoses.send(method, *args)

lib/sageone_sdk/sdata_response.rb

@@ -7,26 +7,34 @@ def initialize(data = {})
       @data = data
     end
 
+    # Total Results
     def total_results
       @data["$totalResults"]
     end
 
+    # Starting Index
     def start_index
       @data["startIndex"]
     end
 
+    # Items Per Page
     def items_per_page
       @data["$itemsPerPage"]
     end
 
+    # Resources
     def resources
       @data["$resources"]
     end
 
+    # Error?
+    # @return Boolean
     def error?
       false
     end
 
+    # Find By
+    # @param conditions
     def find_by(conditions)
       resources.detect do |resource|
         @skip = false
@@ -41,10 +49,13 @@ def find_by(conditions)
       end
     end
 
+    # Respond to missing?
+    # @return Boolean
     def respond_to_missing?(method, include_private =  false)
       resources.respond_to?(method, include_private) || data.respond_to?(method, include_private)
     end
 
+    # Handle method missing
     def method_missing(method, *args, &block)
       if resources.respond_to?(method)
         resources.send(method, *args)

lib/sageone_sdk/signature.rb

@@ -17,6 +17,7 @@ def initialize(http_method, url, request_body, nonce, secret, token)
       @token = token
     end
 
+    # Generate None
     def self.generate_nonce
       SecureRandom.hex
     end

lib/sageone_sdk/version.rb

@@ -1,3 +1,4 @@
 module SageoneSdk
+  # Version Number
   VERSION = "0.0.1"
 end