hellosign-ruby-sdk 3.2.15 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc286c2e7deb343afb8db65133aeb5d89999bb6c
-  data.tar.gz: 3256f9e3bc52d1de408767151018fd3429f18661
+  metadata.gz: 27defe774dc5edc27189e7e7035ea4eba0ae8378
+  data.tar.gz: 7c3e32790e3d0c1b402aa4f7cb66d4d96ed8afcd
 SHA512:
-  metadata.gz: 4dad57320385d7ea26252bb56aafbdf22fe38184f9a89ad7c9767af50831ef77d8a29b2ae209381c09f7b7a5b5b16ffc76c8f83e3e0fe8af2daaeeb2e3977535
-  data.tar.gz: d0fdcae57723f28d8269aaf2fd589c65ad29ddb3be0b040e5052f3a2b5b13215ecf1d4beca9caf3424f7acb941c7154795921f6cb90337cbc15e2d27c319b9fc
+  metadata.gz: fe008cbea3e86b187794b687d5d67875e6c7463a0ea9fb0e1c427d23db3ed831c5b962f1d40815841ff24e3c079649654b420033b4aa292a3d17942ac0bdb3ef
+  data.tar.gz: 337c05db297b5955dfa85162e4eabd6f18b639cc42f9665bd8e2de957ac2c94e5ce99111aff767123e538b2d8354154936755c9d252f4112b765d103cfaa3143

data/lib/hello_sign/api/embedded.rb

@@ -51,6 +51,7 @@ module HelloSign
       # @option opts [String] template_id The id of the template to get a edit url for
       # @option opts [Integer] skip_signer_roles Whether editing signer roles should be skipped
       # @option opts [Integer] skip_subject_message Whether editing subject/message should be skipped
+      # @option opts [Array<Hash>] merge_fields Merge fields that can be placed in the template
       #
       # @return [HelloSign::Resource::Embedded] Returns an Embedded object
       # @example
@@ -60,7 +61,9 @@ module HelloSign
         defaults = { :skip_signer_roles => 0, :skip_subject_message => 0, :test_mode => 0 }
         opts = defaults.merge(opts)
 
-        HelloSign::Resource::Embedded.new get("/embedded/edit_url/#{opts[:template_id]}?skip_signer_roles=#{opts[:skip_signer_roles]}&skip_subject_message=#{opts[:skip_subject_message]}&test_mode=#{opts[:test_mode]}")
+        prepare_merge_fields opts
+
+        HelloSign::Resource::Embedded.new post("/embedded/edit_url/#{opts[:template_id]}", :body => opts)
       end
     end
   end

data/lib/hello_sign/api/signature_request.rb

@@ -67,7 +67,8 @@ module HelloSign
         opts[:query] = create_search_string(opts[:query]) if opts[:query]
         query = create_query_string(opts, [:page, :page_size, :ux_version, :query])
         path += query
-        HelloSign::Resource::ResourceArray.new get(path, opts), 'signature_requests',  HelloSign::Resource::SignatureRequest
+        HelloSign::Resource::ResourceArray.new get(path, opts), 'signature_requests', HelloSign::Resource::SignatureRequest
+
       end
 
       #
@@ -235,6 +236,16 @@ module HelloSign
         post("/signature_request/cancel/#{opts[:signature_request_id]}", :body => opts)
       end
 
+      #
+      # Removes your access to a completed a SignatureRequest.
+      # @option opts [String] signature_request_id The id of the SignatureRequest to remove.
+      #
+      # @example
+      #   @client.remove_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
+      def remove_signature_request(opts)
+        post("/signature_request/remove/#{opts[:signature_request_id]}", :body => opts)
+      end
+
       #
       # Download the PDF copy of the current documents specified by the signature_request_id parameter.
       # @option opts [String] file_type Either 'pdf' or 'zip' depending on the file type desired. Defaults to pdf.

data/lib/hello_sign/client.rb

@@ -287,10 +287,6 @@ module HelloSign
       prepare opts, :template_ids
     end
 
-    def prepare_cc_roles(opts)
-      prepare opts, :merge_fields
-    end
-
     def prepare_signer_roles(opts)
       prepare opts, :signer_roles
     end
@@ -302,6 +298,13 @@ module HelloSign
         #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
+    end
+
     def prepare(opts, key)
       return unless opts[key]
       opts[key].each_with_index do |value, index|

data/lib/hello_sign/resource/resource_array.rb

@@ -47,9 +47,13 @@ module HelloSign
         @num_results = hash['list_info']['num_results']
         @page_size = hash['list_info']['page_size']
         @warnings = hash['warnings'] ? hash['warnings'] : nil
-        hash[key] && hash[key].each do |resouce|
-          self << resource_class.new(resouce, nil)
+
+        self << resource_class.new(hash, nil)
+
+        hash[key] && hash[key].each do |resource|
+          self << resource_class.new(resource, nil)
         end
+
       end
     end
   end

data/lib/hello_sign/version.rb

@@ -23,5 +23,5 @@
 #
 
 module HelloSign
-  VERSION = '3.2.15'
+  VERSION = '3.3.0'
 end

data/spec/hello_sign/api/signature_request_spec.rb

@@ -33,6 +33,14 @@ describe HelloSign::Api::SignatureRequest do
     it 'each of Array is an SignatureRequest' do
       expect(@signature_requests[0]).to be_an HelloSign::Resource::SignatureRequest
     end
+
+    it 'should return list_info as a BaseResource in results' do
+      expect(@signature_requests[0].list_info).to be_an HelloSign::Resource::BaseResource
+    end
+
+    it 'should return page numbers as an integer' do
+      expect(@signature_requests[0].list_info.page).to be_an Integer
+    end
   end
 
   describe '#send_signature_request' do
@@ -79,6 +87,17 @@ describe HelloSign::Api::SignatureRequest do
     end
   end
 
+  describe '#remove_signature_request' do
+    before do
+      stub_post('/signature_request/remove/1', 'signature_request')
+      @signature_request = HelloSign.remove_signature_request(:signature_request_id => 1)
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/remove/1')).to have_been_made
+    end
+  end
+
   describe '#signature_request_files' do
     before do
       stub_get('/signature_request/files/1', 'file')

data/spec/hello_sign/api/template_spec.rb

@@ -33,6 +33,14 @@ describe HelloSign::Api::Template do
     it 'each of Array is an Template' do
       expect(@template[0]).to be_an HelloSign::Resource::Template
     end
+
+    it 'should return list_info as a BaseResource in results' do
+      expect(@template[0].list_info).to be_an HelloSign::Resource::BaseResource
+    end
+
+    it 'should return page numbers as an integer' do
+      expect(@template[0].list_info.page).to be_an Integer
+    end
   end
 
   describe '#add_user_to_template' do

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: hellosign-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 3.2.15
+  version: 3.3.0
 platform: ruby
 authors:
 - HelloSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: ''
@@ -114,9 +114,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile
@@ -188,17 +188,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A Ruby SDK for the HelloSign API.