hellosign-ruby-sdk 3.0.9 → 3.0.10

data/README.md

@@ -26,8 +26,6 @@ HelloSign.configure do |config|
   # If api_key, email_address and password are all present, api_key will be used
   # config.email_address = 'email_address'
   # config.password = 'password'
-  config.client_id = 'your_client_id' #required only when you want to use embedded or OAuth
-  config.client_secret = 'your_client_secret' #required only when you want to use OAuth
 end
 ```
 

data/lib/hello_sign/api/embedded.rb

@@ -22,6 +22,17 @@ module HelloSign
       def get_embedded_sign_url(opts)
         HelloSign::Resource::Embedded.new get("/embedded/sign_url/#{opts[:signature_id]}")
       end
+      #
+      # Retrieves the edit url for an embedded template.
+      # @option opts [String] template_id The id of the template to get a edit url for
+      #
+      # @return [HelloSign::Resource::Embedded] Returns an Embedded object
+      # @example
+      #   edit_url = @client.get_embedded_template_edit_url :template_id => '39e3387f738adfa7ddd4cbd4c00d2a8ab6e4194b'
+      #
+      def get_embedded_template_edit_url(opts)
+        HelloSign::Resource::Embedded.new get("/embedded/edit_url/#{opts[:template_id]}")
+      end
     end
   end
 end

data/lib/hello_sign/api/template.rb

@@ -23,6 +23,17 @@ module HelloSign
         HelloSign::Resource::Template.new get("/template/#{opts[:template_id]}")
       end
 
+      #
+      # Deletes the Template specified by the id parameter.
+      # @option opts [String] template_id The id of the Template to delete.
+      ##
+      # @example
+      #   template = @client.get_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35'
+      #
+      def delete_template(opts)
+        post("/template/#{opts[:template_id]}")
+      end
+
       #
       # Retrieves the Templates for the current user account.
       #
@@ -71,6 +82,56 @@ module HelloSign
         opts.delete(:template_id)
         HelloSign::Resource::Template.new post(path, :body => opts)
       end
+
+      #
+      # Creates a new embedded template 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.
+      # @option opts [Array<String>] files Use files to indicate the uploaded file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
+      # @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
+      # @option opts [String] title The default template email subject.
+      # @option opts [String] subject The subject in the email that will be sent to the signers.
+      # @option opts [String] requester_email_address The email address of the requester.
+      # @option opts [String] message The custom message in the email that will be sent to the signers.
+      # @option opts [Array<Hash>] signers List of signer_roles, each item is a Hash with these keys:
+      #   * :name (String) signer's role name
+      #   * :order (Integer) The order the signer is required to sign in (optional)
+      # @option opts [Array<Hash>] cc_roles The email addresses CC roles. Will mean the CC role will be Required when sending the template.
+      # @option opts [Array<Hash>] merge_fields List of fields that can be pre-populated by your application when using the resulting template to send a signature request
+      #   * :name (String) merge field name
+      #   * :type (String) <text|checkbox>
+      #
+      # @example create_embedded_draft
+      #   template_draft = @client.create_embedded_template_draft(
+      #     :test_mode => 1,
+      #     :subject => 'The NDA we talked about',
+      #     :requester_email_address => requester@example.com",
+      #     :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
+      #     :signer_roles => [{
+      #         :name => 'Manager',
+      #         :order => 0
+      #       },{
+      #         :name => 'Client',
+      #         :order => 1
+      #       }
+      #     ],
+      #     :cc_roles => ['HRManager'],
+      #     :files => ['NDA.pdf', 'AppendixA.pdf'],
+      #     :merge_fields => '[{
+      #         :name => 'contract_id',
+      #         :type => 'text'
+      #       },{
+      #         :name => 'purchase_price',
+      #         :order => 'text'
+      #       }
+      #     ]'
+      #   )
+      #
+      def create_embedded_template_draft(opts)
+        opts[:client_id] ||= self.client_id
+        prepare_files opts
+        prepare_signer_roles opts
+        HelloSign::Resource::TemplateDraft.new post("/template/create_embedded_draft", :body => opts)
+      end
     end
   end
 end

data/lib/hello_sign/api/unclaimed_draft.rb

@@ -128,6 +128,61 @@ module HelloSign
 
         HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create_embedded', :body => opts)
       end
+
+
+      #
+      # Creates a new embedded unclaimed draft object from a template 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.
+      # @option opts [String] subject The subject in the email that will be sent to the signers.
+      # @option opts [String] requester_email_address The email address of the requester.
+      # @option opts [String] message The custom message in the email that will be sent to the signers.
+      # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
+      #
+      # @option opts [Array<Hash>] signers List of signers, each item is a Hash with these keys:
+      #   * :name (String) Sender' name
+      #   * :email_address (String) Sender's email address
+      #   * :order (Integer) The order the signer is required to sign in (optional)
+      #   * :pin (Integer) The 4-digit code that will secure this signer's signature page. You must have a business plan to use this feature. (optional)
+      # @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_with_template(
+      #     :test_mode => 1,
+      #     :subject => 'The NDA we talked about',
+      #     :template_id => 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
+      #     :requester_email_address => requester@example.com",
+      #     :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
+      #     :metadata => {
+      #      :client_id => '1234',
+      #      :custom_text => 'NDA #9'
+      #     },
+      #      :signers => [
+      #       {
+      #         :email_address => 'george@example.com',
+      #         :name => 'George',
+      #         :role => 'Client'
+      #       }
+      #     ],
+      #     :ccs => [
+      #       {
+      #         :email_address =>'accounting@example.com',
+      #         :role => "Accounting"
+      #       }
+      #     ],
+      #     :custom_fields => {
+      #       :Cost => '$20,000'
+      #     }
+      #   )
+      #
+      def create_embedded_unclaimed_draft_with_template(opts)
+        opts[:client_id] ||= self.client_id
+        prepare_signers opts
+        prepare_ccs opts
+        prepare_templates opts
+        HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create_embedded_with_template', :body => opts)
+      end
     end
   end
 end

data/lib/hello_sign/client.rb

@@ -152,7 +152,7 @@ module HelloSign
       elsif response.body.strip.empty?
         {}
       else
-        MultiJson.load response.body
+        MultiJson.load response.body.strip
       end
     end
 
@@ -196,6 +196,14 @@ 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
+
     def prepare(opts, key)
       return unless opts[key]
       opts[key].each_with_index do |value, index|

data/lib/hello_sign/resource.rb

@@ -1,5 +1,6 @@
 require 'hello_sign/resource/base_resource'
 require 'hello_sign/resource/resource_array'
+require 'hello_sign/resource/template_draft'
 require 'hello_sign/resource/account'
 require 'hello_sign/resource/embedded'
 require 'hello_sign/resource/template'

data/lib/hello_sign/resource/template_draft.rb

@@ -0,0 +1,25 @@
+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://www.hellosign.com/api/reference}
+    # 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
+      #
+      # @return [HelloSign::Resource:Team] a Team resource
+      def initialize(hash, key='template')
+        super
+      end
+    end
+
+  end
+end

data/lib/hello_sign/version.rb

@@ -1,3 +1,3 @@
 module HelloSign
-  VERSION = '3.0.9'
+  VERSION = '3.0.10'
 end

metadata

@@ -1,97 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: hellosign-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 3.0.9
+  version: 3.0.10
+  prerelease: 
 platform: ruby
 authors:
 - HelloSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: ''
@@ -100,9 +113,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -129,6 +142,7 @@ files:
 - lib/hello_sign/resource/signature_request.rb
 - lib/hello_sign/resource/team.rb
 - lib/hello_sign/resource/template.rb
+- lib/hello_sign/resource/template_draft.rb
 - lib/hello_sign/resource/unclaimed_draft.rb
 - lib/hello_sign/version.rb
 - spec/fixtures/account.json
@@ -156,26 +170,27 @@ files:
 homepage: http://www.hellosign.com
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A Ruby SDK for the HelloSign API.
 test_files:
 - spec/fixtures/account.json

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 9d25f5b018fddb236b999be3180ac75d09f8ac88
-  data.tar.gz: d999948d08a67e479010c86df94981e4d202179c
-SHA512:
-  metadata.gz: b201a69a221b32e13f5d0c6874a885fb5ab1d84fc396f0a059704249cd4945976127994625172fef21f5781f653c79a1aca62615a326712a84b5fbff720e5375
-  data.tar.gz: 6ae74ea3cd74e11da0346f8c4373181120dac9317221eb51f9257b50d96d0eaed8e3619f31155a26f989e677c95ab4be9eb9f8ede74d4fc960818d6b5f75954f