hellosign-ruby-sdk 3.7.5 → 3.7.6

data/lib/hello_sign/client.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,7 +19,6 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-#
 
 require 'faraday'
 require 'multi_json'
@@ -32,13 +30,10 @@ 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.
   #
-  # @example
-  #   client = HelloSign::Client.new :email_address => "me@example.com", :password => "mypassword"
-  #
   # @author [hellosign]
   class Client
     include Api::Account
@@ -49,6 +44,7 @@ module HelloSign
     include Api::Embedded
     include Api::OAuth
     include Api::ApiApp
+    include Api::BulkSendJob
 
     attr_accessor :end_point, :oauth_end_point, :api_version, :user_agent, :client_id, :client_secret, :email_address, :password, :api_key, :auth_token, :logging, :log_level, :proxy_uri, :proxy_user, :proxy_pass, :timeout
 
@@ -67,13 +63,18 @@ module HelloSign
       503 => Error::ServiceUnavailable
     }
 
-    #
     # Initiates a new HelloSign Client
-
     # @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
+    #
+    # @example Authenticating with username and password
+    #   client = HelloSign::Client.new email_address: 'me@example.com', password: 'mypassword'
+    #
+    # @example Authenticating with API key
+    #   client = HelloSign::Client.new api_key: '1234567890123456789012345678901234567890123456789012345678901234'
     def initialize(opts={})
       options = HelloSign.options.merge(opts)
       HelloSign::Configuration::VALID_OPTIONS_KEYS.each do |key|
@@ -81,11 +82,9 @@ module HelloSign
       end
     end
 
-    #
     # Makes an HTTP GET request
-    # @param  path [String] Relative path of the 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)
       validate response
@@ -93,12 +92,10 @@ module HelloSign
       data = { headers: response.headers, body: parsed_response }
     end
 
-    #
     # Makes an HTTP POST request
-    # @param  path [String] Relative path of the 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)
       validate response
@@ -106,12 +103,10 @@ module HelloSign
       data = { headers: response.headers, body: parsed_response }
     end
 
-    #
     # Makes an HTTP PUT request
-    # @param  path [String] Relative path of the 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)
       validate response
@@ -119,11 +114,9 @@ module HelloSign
       data = { headers: response.headers, body: parsed_response }
     end
 
-    #
-    # Make an HTTP DELETE request
-    # @param  path [String] Relative path of the request.
+    # Makes 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)
       validate response
@@ -277,7 +270,11 @@ module HelloSign
     end
 
     def prepare_signers(opts)
-      prepare opts, :signers
+      if opts[:signers]
+        prepare opts, :signers
+      elsif opts[:signer_group]
+        prepare_signer_group opts, :signer_group
+      end
     end
 
     def prepare_ccs(opts)
@@ -292,6 +289,10 @@ module HelloSign
       prepare opts, :signer_roles
     end
 
+    def prepare_attachments(opts)
+      prepare opts, :attachments
+    end
+
     def prepare_form_fields(opts)
         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])
@@ -313,6 +314,18 @@ module HelloSign
         # ignore if it's already a string, or not present
     end
 
+    def prepare_bulk_signers(opts)
+      if opts[:signer_file]
+        file = opts[:signer_file]
+        mime_type = MIMEfromIO file
+        opts[:signer_file] = Faraday::UploadIO.new(file, mime_type)
+      elsif opts[:signer_list]
+        opts[:signer_list] = MultiJson.dump(opts[:signer_list])
+      else
+        raise HelloSign::Error::NotSupportedType.new "Upload a CSV file or JSON list of signers"
+      end
+    end
+
     def prepare(opts, key)
       return unless opts[key]
       opts[key].each_with_index do |value, index|
@@ -329,5 +342,28 @@ module HelloSign
       end
       opts.delete(key)
     end
+
+    def prepare_signer_group(opts, key)
+      opts[key].each_with_index do |value, index|
+        if value[:role]
+          group_index_or_role = value[:role]
+        else
+          group_index_or_role = index
+        end
+
+        opts[:"signers[#{group_index_or_role}][group]"] = value[:group_name]
+        opts[key] = value[:signers]
+        prepare_signers_for_group(value[:signers], group_index_or_role, opts)
+      end
+      opts.delete(key)
+    end
+
+    def prepare_signers_for_group(signers, group_index_or_role, opts)
+      signers.each_with_index do |signer, index|
+        signer.each do |param, data|
+          opts[:"signers[#{group_index_or_role}][#{index}][#{param}]"] = data
+        end
+      end
+    end
   end
 end

data/lib/hello_sign/configuration.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,21 +19,18 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-#
 
 module HelloSign
-  #
-  # Define config attributes and default values for HelloSign module
+
+  # Defines config attributes and default values for HelloSign module
   #
   # @author [hellosign]
-  #
   module Configuration
     DEFAULT_ENDPOINT = 'https://api.hellosign.com'
     DEFAULT_API_VERSION = '/v3'
     DEFAULT_OAUTH_ENDPOINT = 'https://app.hellosign.com'
     VALID_OPTIONS_KEYS = [:end_point, :oauth_end_point, :api_version, :user_agent, :client_id, :client_secret, :email_address, :password, :api_key, :auth_token, :log_level, :logging, :proxy_uri, :proxy_user, :proxy_pass, :timeout]
 
-
     DEFAULT_USER_AGENT = "hellosign-ruby-sdk/" + HelloSign::VERSION
 
     attr_accessor *VALID_OPTIONS_KEYS
@@ -42,7 +38,7 @@ module HelloSign
     # Sets all configuration options to their default values
     # when this module is extended.
     #
-    # @param base [Object] new module or class extend thid module
+    # @param base [Object] New module or class extends this module
     def self.extended(base)
       base.reset
     end

data/lib/hello_sign/error.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,10 +19,10 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-#
 
 module HelloSign
   module Error
+
     # Custom error class for rescuing from all HelloSign errors.
     class Error < StandardError;
       attr_accessor :request_uri, :response_body, :response_status
@@ -43,7 +42,7 @@ module HelloSign
       end
     end
 
-    # Raise when attributes are missing.
+    # Raised when attributes are missing.
     class MissingAttributes < Error; end
 
     # Raised when API endpoint credentials not configured.

data/lib/hello_sign/resource.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,7 +19,6 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-#
 
 require 'hello_sign/resource/base_resource'
 require 'hello_sign/resource/resource_array'
@@ -32,3 +30,4 @@ require 'hello_sign/resource/signature_request'
 require 'hello_sign/resource/team'
 require 'hello_sign/resource/unclaimed_draft'
 require 'hello_sign/resource/api_app'
+require 'hello_sign/resource/bulk_send_job'

data/lib/hello_sign/resource/account.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,24 +19,22 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-#
 
 module HelloSign
   module Resource
-    #
     # 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
-      #
+
       # 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] an Account resource
+      # @return [HelloSign::Resource::Account] an Account
       def initialize(hash, key='account')
         super
       end

data/lib/hello_sign/resource/api_app.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2015 hellosign.com
@@ -20,24 +19,22 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-#
 
 module HelloSign
   module Resource
-    #
     # 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
-      #
+
       # 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
+      # @return [HelloSign::Resource::ApiApp] an ApiApp
       def initialize(hash, key='api_app')
         super
       end

data/lib/hello_sign/resource/base_resource.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,20 +19,18 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-#
 
 module HelloSign
   module Resource
-    #
     # 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.
+
+      # Converts hash data recursively 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.
@@ -58,15 +55,14 @@ module HelloSign
         end
       end
 
-      #
-      # Magic method, give class dynamic methods based on hash keys.
+      # Magic method, gives 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.
       #
       # @param method [Symbol] Method's name
       #
       # @example
-      #   resource = BaseResource.new :email_address => "me@example.com"
+      #   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/lib/hello_sign/resource/bulk_send_job.rb

@@ -0,0 +1,43 @@
+# 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
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module HelloSign
+  module Resource
+    # Contains information about a BulkSendJob.
+    # Take a look at our API Documentation on BulkSendJobs (https://app.hellosign.com/api/reference#BulkSendJob)
+    # for more information about this.
+    #
+    # @author [hellosign]
+
+    class BulkSendJob < BaseResource
+
+      # Creates a new BulkSendJob 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] BulkSendJob's data
+      # @param  key [String] (bulk_send_job) Key of the hash, point to where BulkSendJob data is. If nil, then the hash itself.
+      #
+      # @return [HelloSign::Resource::BulkSendJob] a BulkSendJob
+      def initialize(hash, key='bulk_send_job')
+        super
+      end
+    end
+  end
+end

data/lib/hello_sign/resource/embedded.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,24 +19,22 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-#
 
 module HelloSign
   module Resource
-    #
-    # An object that contains necessary information to set up Embedded signing.
+    # Contains information about Embedded workflows.
     # Take a look at our Embedded Signing Walkthrough (https://app.hellosign.com/api/embeddedSigningWalkthrough)
     # for more information about this.
     #
     # @author [hellosign]
-    #
+
     class Embedded < BaseResource
+
+      # Creates 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] an Embedded resource
+      # @return [HelloSign::Resource::Embedded] an Embedded resource
       def initialize(hash, key='embedded')
         super
       end