hellosign-ruby-sdk 3.7.0 → 3.7.1

data/lib/hello_sign/client.rb

@@ -32,7 +32,6 @@ require 'hello_sign/api'
 require 'logger'
 
 module HelloSign
-
   #
   # You'll need the HelloSign::Client to do just about everything, from creating
   # signatures to updating account information.
@@ -69,11 +68,11 @@ module HelloSign
     }
 
     #
-    # Creates a new HelloSign Client
+    # Initiates a new HelloSign Client
 
-    # @option opts [String] email_address email address
-    # @option opts [String] password password
-    # @option opts [String] api_key Api key
+    # @option opts [String] email_address The account's email address. (optional)
+    # @option opts [String] password The account's password, if authenticating with an email_address. (optional)
+    # @option opts [String] api_key The account's API key.
     # @return [HelloSign::Client] a new HelloSign::Client
     def initialize(opts={})
       options = HelloSign.options.merge(opts)
@@ -83,9 +82,9 @@ module HelloSign
     end
 
     #
-    # Make a http get request
-    # @param  path [String] relative path of the request
-    # @option options [Hash] params params of the url
+    # Makes an HTTP GET request
+    # @param  path [String] Relative path of the request.
+    # @option options [Hash] params Params of the URL.
     #
     def get(path, options={})
       response = request(path, :get, options)
@@ -95,10 +94,10 @@ module HelloSign
     end
 
     #
-    # Make a http post request
-    # @param  path [String] relative path of the request
-    # @option options [Hash] params params of the url
-    # @option options [Hash] body request body
+    # Makes an HTTP POST request
+    # @param  path [String] Relative path of the request.
+    # @option options [Hash] params Params of the URL.
+    # @option options [Hash] body Body of the request.
     #
     def post(path, options={})
       response = request(path, :post, options)
@@ -108,10 +107,10 @@ module HelloSign
     end
 
     #
-    # Make a http put request
-    # @param  path [String] relative path of the request
-    # @option options [Hash] params params of the url
-    # @option options [Hash] body request body
+    # Makes an HTTP PUT request
+    # @param  path [String] Relative path of the request.
+    # @option options [Hash] params Params of the URL.
+    # @option options [Hash] body Body of the request.
     #
     def put(path, options={})
       response = request(path, :put, options)
@@ -121,9 +120,9 @@ module HelloSign
     end
 
     #
-    # Make a http delete request
-    # @param  path [String] relative path of the request
-    # @option options [Hash] params params of the url
+    # Make an HTTP DELETE request
+    # @param  path [String] Relative path of the request.
+    # @option options [Hash] Params of the URL.
     #
     def delete(path, options={})
       response = request(path, :delete, options)
@@ -160,6 +159,7 @@ module HelloSign
         faraday.adapter :net_http
         faraday.options[:timeout] = timeout if timeout
       end
+
       if options[:no_auth]
       elsif auth_token
         connection.authorization :Bearer, auth_token
@@ -183,9 +183,6 @@ module HelloSign
       if response.status >= 400
         error_class = ERRORS[response.status] || HelloSign::Error::UnknownError
         error = error_class.new(response.status, response.body, response.to_hash[:url].to_s)
-        # error.response_status = response.status
-        # error.response_body = response.body
-        # error.request_uri = response.to_hash[:url].to_s
         raise error
       end
     end
@@ -204,7 +201,7 @@ module HelloSign
 
     def MIMEfromName(name)
       parts = name.split('.')
-      #default to pdf if no extension
+      # defaults to pdf if no extension provided
       if parts.length < 2
         return 'application/pdf'
       end
@@ -299,21 +296,21 @@ module HelloSign
         if (opts[:form_fields_per_document] and opts[:form_fields_per_document].is_a? Array)
             opts[:form_fields_per_document] = MultiJson.dump(opts[:form_fields_per_document])
         end
-        #ignore if it's already a string, or not present
+        # ignore if it's already a string, or not present
     end
 
     def prepare_custom_fields(opts)
         if (opts[:custom_fields] and opts[:custom_fields].is_a? Array)
             opts[:custom_fields] = MultiJson.dump(opts[:custom_fields])
         end
-        #ignore if it's already a string, or not present
+        # ignore if it's already a string, or not present
     end
 
     def prepare_merge_fields(opts)
         if (opts[:merge_fields] and opts[:merge_fields].is_a? Array)
             opts[:merge_fields] = MultiJson.dump(opts[:merge_fields])
         end
-        #ignore if it's already a string, or not present
+        # ignore if it's already a string, or not present
     end
 
     def prepare(opts, key)

data/lib/hello_sign/configuration.rb

@@ -23,7 +23,6 @@
 #
 
 module HelloSign
-
   #
   # Define config attributes and default values for HelloSign module
   #

data/lib/hello_sign/resource/account.rb

@@ -1,8 +1,8 @@
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
@@ -24,22 +24,20 @@
 
 module HelloSign
   module Resource
-
     #
-    # Contains information about an account and its settings.
-    # Take a look at our {https://app.hellosign.com/api/reference#Account account resource document}
+    # Contains information about an Account and its settings.
+    # Take a look at our API Documentation on the Account resource (https://app.hellosign.com/api/reference#Account)
     # for more information about this.
     #
     # @author [hellosign]
     #
     class Account < BaseResource
-
       #
-      # Create a new Account from a hash. If key defined then account data with be the value of hash[key], otherwise the hash itself
-      # @param  hash [Hash] account's data
-      # @param  key [String] (account) key of the hash, point to where account data is. If nil then the hash itself
+      # Creates a new Account from a hash. If key defined then account data with be the value of hash[key], otherwise the hash itself.
+      # @param hash [Hash] Account's data
+      # @param key [String] (account) key of the hash, point to where Account data is. If nil, then the hash itself.
       #
-      # @return [HelloSign::Resource:Account] a Account resource
+      # @return [HelloSign::Resource:Account] an Account resource
       def initialize(hash, key='account')
         super
       end

data/lib/hello_sign/resource/api_app.rb

@@ -24,20 +24,18 @@
 
 module HelloSign
   module Resource
-
     #
-    # Contains information about an team and its members.
-    # Take a look at our {https://app.hellosign.com/api/reference#ApiApp API Application resource document}
+    # Contains information about the ApiApp resource.
+    # Take a look at our API Documentation for ApiApps (https://app.hellosign.com/api/reference#ApiApp)
     # for more information about this.
     #
     # @author [hellosign]
     #
     class ApiApp < BaseResource
-
       #
-      # create a new ApiApp from a hash. If a key is defined then team data with be the value of hash[key], otherwise the hash itself
-      # @param  hash [Hash] API Application data
-      # @param  key [String] (api_app) key of the hash, point to where API application data is. If nil then the hash itself
+      # Creates a new ApiApp from a hash. If a key is defined then ApiApp data with be the value of hash[key], otherwise the hash itself.
+      # @param hash [Hash] ApiApp data
+      # @param key [String] (api_app) key of the hash, point to where ApiApp data is. If nil, then the hash itself.
       #
       # @return [HelloSign::Resource:ApiApp] an ApiApp resource
       def initialize(hash, key='api_app')

data/lib/hello_sign/resource/base_resource.rb

@@ -24,21 +24,19 @@
 
 module HelloSign
   module Resource
-
     #
-    # Store the value of a hash. Use missing_method to create method to access it like an object
+    # Stores the value of a hash. Use missing_method to create method to access it like an object
     #
     # @author [hellosign]
     #
     class BaseResource
 
       attr_reader :data, :raw_data, :warnings, :headers
-
       #
       # recursively convert hash data into BaseResource.
       #
-      # @param  hash [Hash] data of the resource
-      # @param  key [String] (nil) key of the hash, point to where resource data is. If nil then the hash itself
+      # @param  hash [Hash] Data of the resource
+      # @param  key [String] (nil) Key of the hash, point to where resource data is. If nil, then the hash itself.
       #
       # @return [HelloSign::Resource::BaseResource] a new BaseResource
       def initialize(hash, key=nil)
@@ -47,7 +45,7 @@ module HelloSign
         if hash[:body]
           @warnings = hash[:body]['warnings'] ? hash[:body]['warnings'] : nil
         end
-        
+
         @data = @raw_data.inject({}) do |data, (key, value)|
           data[key.to_s] = if value.is_a? Hash
             value = BaseResource.new(value)
@@ -62,17 +60,15 @@ module HelloSign
 
       #
       # Magic method, give class dynamic methods based on hash keys.
-      #
       # If initialized hash has a key which matches the method name, return value of that key.
-      #
-      # Otherwise, return nil
+      # Otherwise, return nil.
       #
       # @param method [Symbol] Method's name
       #
       # @example
-      #   resource  = BaseResource.new :email_address => "me@example.com"
-      #   resource.email_address # =>  "me@example.com"
-      #   resource.not_in_hash_keys # => nil
+      #   resource = BaseResource.new :email_address => "me@example.com"
+      #   resource.email_address => "me@example.com"
+      #   resource.not_in_hash_keys => nil
       def method_missing(method)
         @data.key?(method.to_s) ? @data[method.to_s] : nil
       end

data/lib/hello_sign/resource/embedded.rb

@@ -1,8 +1,8 @@
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
@@ -24,22 +24,20 @@
 
 module HelloSign
   module Resource
-
     #
-    # An object that contains necessary information to set up embedded signing.
-    # Take a look at our {https://app.hellosign.com/api/reference#Embedded account resource document}
+    # An object that contains necessary information to set up Embedded signing.
+    # Take a look at our Embedded Signing Walkthrough (https://app.hellosign.com/api/embeddedSigningWalkthrough)
     # for more information about this.
     #
     # @author [hellosign]
     #
     class Embedded < BaseResource
-
       #
-      # create a new Embedded resource from a hash. If a key is defined then embedded data with be the value of hash[key], otherwise the hash itself
-      # @param  hash [Hash] embedded's data
-      # @param  key [String] (embedded) key of the hash, point to where embedded data is. If nil then the hash itself
+      # create a new Embedded resource from a hash. If a key is defined then embedded data with be the value of hash[key], otherwise the hash itself.
+      # @param  hash [Hash] Embedded's data
+      # @param  key [String] (embedded) Key of the hash, point to where Embedded data is. If nil, then the hash itself.
       #
-      # @return [HelloSign::Resource:Embedded] a Embedded resource
+      # @return [HelloSign::Resource:Embedded] an Embedded resource
       def initialize(hash, key='embedded')
         super
       end

data/lib/hello_sign/resource/resource_array.rb

@@ -24,7 +24,6 @@
 
 module HelloSign
   module Resource
-
     #
     # Stores an array of HelloSign BaseResource with paging information
     #
@@ -32,13 +31,12 @@ module HelloSign
     #
     class ResourceArray < Array
       attr_reader :page, :num_pages, :num_results, :page_size, :warnings, :headers, :list_info
-
       #
       # create a new ResourceArray from a hash
       #
-      # @param  hash [Hash] data of the array
-      # @param  key [String] key of the hash, point to where resource array data is
-      # @param  resource_class [Class] a Resource Class object inherited from BaseResource. Use the created array item from hash[key]
+      # @param  hash [Hash] Data of the array.
+      # @param  key [String] Key of the hash, point to where resource array data is.
+      # @param  resource_class [Class] a ResourceClass object inherited from BaseResource. Uses the created array item from hash[key].
       #
       # @return [type] [description]
       def initialize(hash, key, resource_class)

data/lib/hello_sign/resource/signature_request.rb

@@ -1,8 +1,8 @@
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
@@ -24,21 +24,18 @@
 
 module HelloSign
   module Resource
-
     #
-    # Contains information regarding documents that need to be signed
-    # Take a look at our {https://app.hellosign.com/api/reference#SignatureRequest signature request resource document}
+    # Contains information regarding documents that need to be signed.
+    # Take a look at our API Documentation for sending Signature Requests (https://app.hellosign.com/api/reference#SignatureRequest)
     # for more information about this.
     #
     # @author [hellosign]
     #
     class SignatureRequest < BaseResource
-
-      #
-      # create a new SignatureRequest from a hash. If a key is defined then account data with be the value of hash[key], otherwise the hash itself
-      # @param  hash [Hash] signature request's data
-      # @param  key [String] (signature_request) key of the hash, point to where signature request data is. If nil then the hash itself
       #
+      # create a new SignatureRequest from a hash. If a key is defined then account data with be the value of hash[key], otherwise the hash itself.
+      # @param  hash [Hash] SignatureRequest's data
+      # @param  key [String] (signature_request) Key of the hash, point to where SignatureRequest data is. If nil, then the hash itself.
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest resource
       def initialize(hash, key='signature_request')

data/lib/hello_sign/resource/team.rb

@@ -1,8 +1,8 @@
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
@@ -24,20 +24,18 @@
 
 module HelloSign
   module Resource
-
     #
-    # Contains information about an team and its members.
-    # Take a look at our {https://app.hellosign.com/api/reference#Team team resource document}
+    # Contains information about a Team and its members.
+    # Take a look at our API Documentation on the Team Resource (https://app.hellosign.com/api/reference#Team)
     # for more information about this.
     #
     # @author [hellosign]
     #
     class Team < BaseResource
-
       #
-      # create a new Team from a hash. If a key is defined then team data with be the value of hash[key], otherwise the hash itself
-      # @param  hash [Hash] team's data
-      # @param  key [String] (team) key of the hash, point to where team data is. If nil then the hash itself
+      # Creates a new Team from a hash. If a key is defined then team data with be the value of hash[key], otherwise the hash itself.
+      # @param  hash [Hash] Team's data
+      # @param  key [String] (team) Key of the hash, point to where Team data is. If nil, then the hash itself.
       #
       # @return [HelloSign::Resource:Team] a Team resource
       def initialize(hash, key='team')

data/lib/hello_sign/resource/template.rb

@@ -1,8 +1,8 @@
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
@@ -24,22 +24,20 @@
 
 module HelloSign
   module Resource
-
     #
     # Contains information about the templates you and your team have created
-    # Take a look at our {https://app.hellosign.com/api/reference#Template Template resource document}
+    # Take a look at our API Documentation for Templates (https://app.hellosign.com/api/reference#Template)
     # for more information about this.
     #
     # @author [hellosign]
     #
     class Template < BaseResource
-
       #
-      # create a new Template from a hash. If a key is defined then template data will be the value of hash[key], otherwise the hash itself
-      # @param  hash [Hash] template's data
-      # @param  key [String] (template) key of the hash, point to where template data is. If nil then the hash itself
+      # Creates a new Template from a hash. If a key is defined then template data will be the value of hash[key], otherwise the hash itself.
+      # @param  hash [Hash] Template's data
+      # @param  key [String] (template) Key of the hash, point to where Template data is. If nil, then the hash itself.
       #
-      # @return [HelloSign::Resource:Team] a Team resource
+      # @return [HelloSign::Resource:Team] a Template resource
       def initialize(hash, key='template')
         super
       end

data/lib/hello_sign/resource/template_draft.rb

@@ -1,8 +1,8 @@
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
@@ -24,20 +24,18 @@
 
 module HelloSign
   module Resource
-
     #
-    # A group of documents that a user can take ownership of by going to the claim URL
-    # Take a look at our {https://app.hellosign.com/api/reference}
+    # A group of documents that a user can take ownership of by going to the claim_url.
+    # Take a look at our API Documentation for Templates (https://app.hellosign.com/api/reference#Template)
     # for more information about this.
     #
     # @author [hellosign]
     #
     class TemplateDraft < BaseResource
-
       #
-      # create a new TemplateDraft from a hash. If a key is defined then template draft data will be the value of hash[key], otherwise the hash itself
-      # @param  hash [Hash] template draft's data
-      # @param  key [String] (template_draft) key of the hash, point to where template draft data is. If nil then the hash itself
+      # Creates a new TemplateDraft from a hash. If a key is defined then TemplateDraft data will be the value of hash[key], otherwise the hash itself.
+      # @param  hash [Hash] TemplateDraft's data
+      # @param  key [String] (template_draft) Key of the hash, point to where TemplateDraft data is. If nil, then the hash itself.
       #
       # @return [HelloSign::Resource:Team] a Team resource
       def initialize(hash, key='template')