hellosign-ruby-sdk 3.0.3 → 3.0.4

data/README.md

@@ -13,11 +13,10 @@ And then execute:
 
     $ bundle
 
-
 ## Configuration
 
 Create a config block. At a minimum you'll want to set your [API Key](https://www.hellosign.com/home/myAccount/current_tab/integrations#api) but depending on your usage you'll possibly
-want to set your app's [Client ID](https://www.hellosign.com/oauth/createAppForm) and [Client Secret](https://www.hellosign.com/oauth/createAppForma). In Rails you can place it in `config/initializers/hello_sign.rb`
+want to set your app's [Client ID](https://www.hellosign.com/oauth/createAppForm) and [Client Secret](https://www.hellosign.com/oauth/createAppForm). In Rails you can place it in `config/initializers/hello_sign.rb`
 
 ```ruby
 require 'hello_sign'

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 

data/hellosign-ruby-sdk.gemspec

@@ -4,19 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hello_sign/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "hellosign-ruby-sdk"
+  spec.name          = 'hellosign-ruby-sdk'
   spec.version       = HelloSign::VERSION
-  spec.authors       = "HelloSign"
-  spec.email         = "support@hellosign.com"
-  spec.summary       = "A Ruby SDK for the HelloSign API."
-  spec.description   = ""
-  spec.homepage      = "http://www.hellosign.com"
-  spec.license       = "MIT"
+  spec.authors       = 'HelloSign'
+  spec.email         = 'support@hellosign.com'
+  spec.summary       = 'A Ruby SDK for the HelloSign API.'
+  spec.description   = ''
+  spec.homepage      = 'http://www.hellosign.com'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'

data/lib/hello_sign.rb

@@ -16,7 +16,6 @@ module HelloSign
     client.send(method, *args, &block)
   end
 
-
   #
   # If HelloSign module don't respond_to? method, ask HelloSign::Client whether it respond or not
   # @param  method [Symbol] method name
@@ -26,6 +25,7 @@ module HelloSign
   end
 
   private
+
   def self.client
     HelloSign::Client.new
   end

data/lib/hello_sign/api/account.rb

@@ -1,7 +1,6 @@
 module HelloSign
   module Api
 
-
     #
     # Contains all the api calls for the Account resource.
     # Take a look at our {https://www.hellosign.com/api/reference#Account account api document}
@@ -20,7 +19,7 @@ module HelloSign
       #   account = @client.get_account
       #
       def get_account
-        HelloSign::Resource::Account.new get("/account")
+        HelloSign::Resource::Account.new get('/account')
       end
 
       #
@@ -37,11 +36,10 @@ module HelloSign
       # @example
       #   account = @client.create_account :email_address => 'newuser@example.com', :password => 'securePW'
       #
-      def create_account opts
-        HelloSign::Resource::Account.new post("/account/create", :body => opts)
+      def create_account(opts)
+        HelloSign::Resource::Account.new post('/account/create', :body => opts)
       end
 
-
       #
       # Updates the current user's callback URL
       # @option opts [String] callback_url New user's callback url
@@ -51,11 +49,10 @@ module HelloSign
       # @example
       #   account = @client.update_account :callback_url => 'https://www.example.com/callback'
       #
-      def update_account opts
-        HelloSign::Resource::Account.new post("/account", :body => opts)
+      def update_account(opts)
+        HelloSign::Resource::Account.new post('/account', :body => opts)
       end
 
-
       #
       # Check whether an account exists
       # @option opts [String] email_address user email
@@ -64,8 +61,8 @@ module HelloSign
       # @example
       #   account = @client.verify :email_address => 'newuser@example.com'
       #
-      def verify opts
-        post("/account/verify", :body => opts).empty? ? false : true
+      def verify(opts)
+        post('/account/verify', :body => opts).empty? ? false : true
       end
     end
   end

data/lib/hello_sign/api/embedded.rb

@@ -19,7 +19,7 @@ module HelloSign
       # @example
       #   embedded = @client.get_embedded_sign_url :signature_id => '50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b'
       #
-      def get_embedded_sign_url opts
+      def get_embedded_sign_url(opts)
         HelloSign::Resource::Embedded.new get("/embedded/sign_url/#{opts[:signature_id]}")
       end
     end

data/lib/hello_sign/api/oauth.rb

@@ -17,7 +17,7 @@ module HelloSign
       # @param  state [String] used for security and must match throughout the flow for a given user.
       # It can be set to the value of your choice (preferably something random). You should verify it matches the expected value when validating the OAuth callback.
       # @return [type] [description]
-      def oauth_url state
+      def oauth_url(state)
         "#{self.oauth_end_point}/oauth/authorize?response_type=code&client_id=#{self.client_id}&state=#{state}"
       end
 
@@ -32,15 +32,13 @@ module HelloSign
       # @example
       #   client = HelloSign::Client.new :api_key => '%apikey%', :client_id => 'cc91c61d00f8bb2ece1428035716b', :client_secret => '1d14434088507ffa390e6f5528465'
       #   client.get_oauth_token :state => '900e06e2', :code =>'1b0d28d90c86c141'
-      def get_oauth_token opts
+      def get_oauth_token(opts)
         opts[:client_id] = self.client_id
         opts[:client_secret] = self.client_secret
         opts[:grant_type] = 'authorization_code'
-        post('/oauth/token', {:body => opts, :oauth_request => true})
-
+        post('/oauth/token', { :body => opts, :oauth_request => true })
       end
 
-
       #
       # refresh user oauth token.
       #
@@ -50,8 +48,8 @@ module HelloSign
       #
       # @example
       #   client.refresh_oauth_token :refresh_token => 'hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3'
-      def refresh_oauth_token refresh_token
-        post('/oauth/token', {:body => {:grant_type => 'refresh_token', :refresh_token => refresh_token}, :oauth_request => true})
+      def refresh_oauth_token(refresh_token)
+        post('/oauth/token', { :body => { :grant_type => 'refresh_token', :refresh_token => refresh_token }, :oauth_request => true })
       end
 
 
@@ -61,11 +59,11 @@ module HelloSign
       # @option opts [String] password new user password
       #
       # @return [Hash] details about new user, including oath data
-      def oauth_create_account opts
+      def oauth_create_account(opts)
         opts[:client_id] = self.client_id
         opts[:client_secret] = self.client_secret
 
-        HelloSign::Resource::Account.new post('/account/create', {:body => opts})
+        HelloSign::Resource::Account.new post('/account/create', { :body => opts })
       end
     end
   end

data/lib/hello_sign/api/signature_request.rb

@@ -19,7 +19,7 @@ module HelloSign
       # @example
       #   signature_request = @client.get_signature_request :signature_request_id => 'fa5c8a0b0f492d768749333ad6fcc214c111e967'
       #
-      def get_signature_request opts
+      def get_signature_request(opts)
         HelloSign::Resource::SignatureRequest.new get("/signature_request/#{opts[:signature_request_id]}")
       end
 
@@ -32,9 +32,9 @@ module HelloSign
       # @example
       #   signature_requests = @client.get_signature_requests :page => 1
       #
-      def get_signature_requests opts={}
+      def get_signature_requests(opts={})
         path = '/signature_request/list'
-        path += opts[:page] ? "?page=#{opts[:page]}" : ""
+        path += opts[:page] ? "?page=#{opts[:page]}" : ''
         HelloSign::Resource::ResourceArray.new get(path, opts), 'signature_requests',  HelloSign::Resource::SignatureRequest
       end
 
@@ -80,7 +80,7 @@ module HelloSign
       #   )
       #
 
-      def send_signature_request opts
+      def send_signature_request(opts)
         prepare_files opts
         prepare_signers opts
 
@@ -130,7 +130,7 @@ module HelloSign
       #    }
       #  )
       #
-      def send_signature_request_with_template opts
+      def send_signature_request_with_template(opts)
         prepare_signers opts
         prepare_ccs opts
         HelloSign::Resource::SignatureRequest.new post('/signature_request/send_with_template', :body => opts)
@@ -145,7 +145,7 @@ module HelloSign
       # @example
       #   signature_request = @client.remind_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491', :email_address => 'john@example.com'
       #
-      def remind_signature_request opts
+      def remind_signature_request(opts)
         HelloSign::Resource::SignatureRequest.new post("/signature_request/remind/#{opts[:signature_request_id]}", :body => opts)
       end
 
@@ -155,7 +155,7 @@ module HelloSign
       #
       # @example
       #   @client.cancel_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
-      def cancel_signature_request opts
+      def cancel_signature_request(opts)
         post("/signature_request/cancel/#{opts[:signature_request_id]}", :body => opts)
       end
 
@@ -169,7 +169,7 @@ module HelloSign
       # @example
       #   pdf = @client.signature_request_files :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
       #
-      def signature_request_files opts
+      def signature_request_files(opts)
         path = "/signature_request/files/#{opts[:signature_request_id]}"
         if opts[:file_type]
           path = path + "?file_type=#{opts[:file_type]}"
@@ -219,7 +219,7 @@ module HelloSign
       #     :files => ['NDA.pdf', 'AppendixA.pdf']
       #   )
       #
-      def create_embedded_signature_request opts
+      def create_embedded_signature_request(opts)
         opts[:client_id] ||= self.client_id
         prepare_files opts
         prepare_signers opts
@@ -273,7 +273,7 @@ module HelloSign
       #     }
       #   )
       #
-      def create_embedded_signature_request_with_template opts
+      def create_embedded_signature_request_with_template(opts)
         opts[:client_id] ||= self.client_id
         prepare_signers opts
         prepare_ccs opts

data/lib/hello_sign/api/team.rb

@@ -19,7 +19,7 @@ module HelloSign
       # @example
       #   team = @client.get_team
       def get_team
-        HelloSign::Resource::Team.new get("/team")
+        HelloSign::Resource::Team.new get('/team')
       end
 
       #
@@ -30,8 +30,8 @@ module HelloSign
       #
       # @example
       #   team = @client.create_team :name => 'Team America World Police'
-      def create_team opts
-        HelloSign::Resource::Team.new post("/team/create", :body => opts)
+      def create_team(opts)
+        HelloSign::Resource::Team.new post('/team/create', :body => opts)
       end
 
       #
@@ -42,8 +42,8 @@ module HelloSign
       #
       # @example
       #   team = @client.update_team :name => 'New Team Name'
-      def update_team opts
-        HelloSign::Resource::Team.new post("/team", :body => opts)
+      def update_team(opts)
+        HelloSign::Resource::Team.new post('/team', :body => opts)
       end
 
       #
@@ -52,7 +52,7 @@ module HelloSign
       # @example
       #   team = @client.destroy_team
       def destroy_team
-        post("/team/destroy")
+        post('/team/destroy')
       end
 
       #
@@ -67,8 +67,8 @@ module HelloSign
       #
       # @example
       #   team = @client.add_member_to_team :email_address => 'george@example.com'
-      def add_member_to_team opts
-        HelloSign::Resource::Team.new post("/team/add_member", :body => opts)
+      def add_member_to_team(opts)
+        HelloSign::Resource::Team.new post('/team/add_member', :body => opts)
       end
 
 
@@ -80,8 +80,8 @@ module HelloSign
       # @return [HelloSign::Resource::Team] updated Team object
       # @example
       #   team = @client.remove_member_from_team :email_address => 'george@example.com'
-      def remove_member_from_team opts
-        HelloSign::Resource::Team.new post("/team/remove_member", :body => opts)
+      def remove_member_from_team(opts)
+        HelloSign::Resource::Team.new post('/team/remove_member', :body => opts)
       end
     end
   end

data/lib/hello_sign/api/template.rb

@@ -19,7 +19,7 @@ module HelloSign
       # @example
       #   template = @client.get_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35'
       #
-      def get_template opts
+      def get_template(opts)
         HelloSign::Resource::Template.new get("/template/#{opts[:template_id]}")
       end
 
@@ -32,13 +32,12 @@ module HelloSign
       # @example
       #   templates = @client.get_templates :page => 1
       #
-      def get_templates opts={}
+      def get_templates(opts={})
         path = '/template/list'
-        path += opts[:page] ? "?page=#{opts[:page]}" : ""
-        HelloSign::Resource::ResourceArray.new get(path, opts), "templates", HelloSign::Resource::Template
+        path += opts[:page] ? "?page=#{opts[:page]}" : ''
+        HelloSign::Resource::ResourceArray.new get(path, opts), 'templates', HelloSign::Resource::Template
       end
 
-
       #
       # Gives the specified Account on your team access to a Template
       #
@@ -50,7 +49,7 @@ module HelloSign
       # @example
       #   templates = @client.add_user_to_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35', :email_address => 'george@example.com'
       #
-      def add_user_to_template opts
+      def add_user_to_template(opts)
         path = "/template/add_user/#{opts[:template_id]}"
         opts.delete(:template_id)
         HelloSign::Resource::Template.new post(path, :body => opts)
@@ -67,7 +66,7 @@ module HelloSign
       # @example
       #   templates = @client.remove_user_from_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35', :email_address => 'george@example.com'
       #
-      def remove_user_from_template opts
+      def remove_user_from_template(opts)
         path = "/template/remove_user/#{opts[:template_id]}"
         opts.delete(:template_id)
         HelloSign::Resource::Template.new post(path, :body => opts)

data/lib/hello_sign/api/unclaimed_draft.rb

@@ -69,7 +69,6 @@ module HelloSign
         HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create', :body => opts)
       end
 
-
       #
       # Creates a new embedded unclaimed draft object that can be launched in an iframe using the claim URL.
       # @option opts [Integer] test_mode (0) Whether this is a test, the signature request will not be legally binding if set to 1.
@@ -90,7 +89,7 @@ module HelloSign
       # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed.
       #
       # @return [HelloSign::Resource::UnclaimedDraft] a UnclaimedDraft object
-
+      #
       # @example request_signature
       #   unclaimed_draft = @client.create_embedded_unclaimed_draft(
       #     :test_mode => 1,
@@ -112,7 +111,7 @@ module HelloSign
       #     :files => ['NDA.pdf', 'AppendixA.pdf']
       #   )
       #
-      def create_embedded_unclaimed_draft opts
+      def create_embedded_unclaimed_draft(opts)
         opts[:client_id] ||= self.client_id
         prepare_files opts
         if opts[:type] == 'request_signature'
@@ -121,7 +120,6 @@ module HelloSign
 
         HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create_embedded', :body => opts)
       end
-
     end
   end
 end

data/lib/hello_sign/client.rb

@@ -106,7 +106,7 @@ module HelloSign
       strip_options_whitespace(options)
       make_connection(options).send method do |request|
         if options[:oauth_request]
-          request.url "#{path}", options[:params]
+          request.url path, options[:params]
         else
           request.url "#{api_version}#{path}", options[:params]
         end
@@ -122,11 +122,11 @@ module HelloSign
         logger.level = @log_level
       end
 
-      connection = Faraday.new(:url => url, :headers => {user_agent: user_agent}) do |faraday|
-        faraday.request  :multipart
-        faraday.request  :url_encoded
+      connection = Faraday.new(:url => url, :headers => { user_agent: user_agent }) do |faraday|
+        faraday.request :multipart
+        faraday.request :url_encoded
         faraday.response :logger, logger if @logging
-        faraday.adapter  :net_http
+        faraday.adapter :net_http
       end
       if options[:no_auth]
       elsif auth_token
@@ -147,7 +147,7 @@ module HelloSign
     end
 
     def parse(response)
-      if response["content-type"] == "application/pdf"
+      if response['content-type'] == 'application/pdf'
         response.body
       elsif response.body.strip.empty?
         {}
@@ -162,7 +162,7 @@ module HelloSign
       "Message: #{response.body}"
     end
 
-    def prepare_files opts
+    def prepare_files(opts)
       if opts[:files]
         opts[:files].each_with_index do |file, index|
           if file.is_a? String
@@ -184,16 +184,16 @@ module HelloSign
       end
     end
 
-    def prepare_signers opts
+    def prepare_signers(opts)
       prepare opts, :signers
     end
 
-    def prepare_ccs opts
+    def prepare_ccs(opts)
       prepare opts, :ccs
     end
 
     def strip_options_whitespace(hash)
-      hash.each do |k, v|
+      hash.each do |_, v|
         case v
           when String
             v.strip!
@@ -205,7 +205,7 @@ module HelloSign
       end
     end
 
-    def prepare opts, key
+    def prepare(opts, key)
       return unless opts[key]
       opts[key].each_with_index do |value, index|
         if value.is_a? String