rightsignature-railstyle 1.1.9

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rspec'
+
+require File.dirname(__FILE__) + '/../lib/rightsignature'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+
+  c.before(:each) do
+    @rs = RightSignature::Connection.new({:consumer_key => "Consumer123", :consumer_secret => "Secret098", :access_token => "AccessToken098", :access_secret => "AccessSecret123", :api_token => "APITOKEN"})
+  end
+end

data/spec/template_spec.rb

@@ -0,0 +1,408 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe RightSignature::Template do 
+  describe "templates_list" do
+    it "should GET /api/templates.xml" do
+      @rs.should_receive(:get).with('/api/templates.xml', {})
+      @rs.templates_list
+    end
+
+    it "should pass search options to /api/templates.xml" do
+      @rs.should_receive(:get).with('/api/templates.xml', {:search => "search", :page => 2})
+      @rs.templates_list(:search => "search", :page => 2)
+    end
+    
+    it "should convert tags array of mixed strings and hashes into into normalized Tag string" do
+      @rs.should_receive(:get).with('/api/templates.xml', {:tags => "hello,abc:def,there"})
+      @rs.templates_list(:tags => ["hello", {"abc" => "def"}, "there"])
+    end
+
+    it "should keep tags as string if :tags is a string" do
+      @rs.should_receive(:get).with('/api/templates.xml', {:tags => "voice,no:way,microphone"})
+      @rs.templates_list(:tags => "voice,no:way,microphone")
+    end
+  end
+  
+  describe "template_details" do
+    it "should GET /api/templates/MYGUID.xml" do
+      @rs.should_receive(:get).with('/api/templates/MYGUID.xml', {})
+      @rs.template_details('MYGUID')
+    end
+  end
+
+  describe "prepackage" do
+    it "should POST /api/templates/MYGUID/prepackage.xml" do
+      @rs.should_receive(:post).with('/api/templates/MYGUID/prepackage.xml', {})
+      @rs.prepackage('MYGUID')
+    end
+  end
+
+  
+  describe "prepackage_and_send" do
+    it "should POST /api/templates/GUID123/prepackage.xml and POST /api/templates.xml using guid, and subject from prepackage response" do
+      @rs.should_receive(:post).with('/api/templates/GUID123/prepackage.xml', 
+        {}
+      ).and_return({"template" => {
+        "guid" => "a_123985_1z9v8pd654",
+        "subject" => "subject template",
+        "message" => "Default message here"
+      }})
+      @rs.should_receive(:post).with('/api/templates.xml', {:template => {
+          :guid => "a_123985_1z9v8pd654", 
+          :action => "send", 
+          :subject => "sign me", 
+          :roles => []
+        }})
+      @rs.prepackage_and_send("GUID123", [], {:subject => "sign me"})
+    end
+    
+    it "should default subject to one in Template prepackage response" do
+      @rs.should_receive(:post).with('/api/templates/GUID123/prepackage.xml', 
+        {}
+      ).and_return({"template" => {
+        "guid" => "a_123985_1z9v8pd654",
+        "subject" => "subject template",
+        "message" => "Default message here"
+      }})
+      @rs.should_receive(:post).with('/api/templates.xml', {:template => {
+          :guid => "a_123985_1z9v8pd654", 
+          :action => "send", 
+          :subject => "subject template", 
+          :roles => []
+        }})
+      @rs.prepackage_and_send("GUID123", [])
+    end
+  end
+
+  describe "prefill/send_template" do
+    it "should POST /api/templates.xml with action of 'prefill', MYGUID guid, roles, and \"sign me\" subject in template hash" do
+      @rs.should_receive(:post).with('/api/templates.xml', {:template => {:guid => "MYGUID", :action => "prefill", :subject => "sign me", :roles => []}})
+      @rs.prefill("MYGUID", "sign me", [])
+    end
+    
+    it "should add \"@role_name\"=>'Employee' key to roles in xml hash" do
+      @rs.should_receive(:post).with('/api/templates.xml', {
+        :template => {
+          :guid => "MYGUID", 
+          :action => "prefill",
+          :subject => "sign me", 
+          :roles => [
+            {:role => {
+              :name => "John Employee", 
+              :email => "john@employee.com", 
+              "@role_name" => "Employee"
+            }}
+          ]
+        }
+      })
+      @rs.prefill("MYGUID", "sign me", [{"Employee" => {:name => "John Employee", :email => "john@employee.com"}}])
+    end
+    
+    it "should add \"@role_id\"=>'signer_A' key to roles in xml hash" do
+      @rs.should_receive(:post).with('/api/templates.xml', {
+        :template => {
+          :guid => "MYGUID", 
+          :action => "prefill",
+          :subject => "sign me", 
+          :roles => [
+            {:role => {
+              :name => "John Employee", 
+              :email => "john@employee.com", 
+              "@role_id" => "signer_A"
+            }}
+          ]
+        }
+      })
+      @rs.prefill("MYGUID", "sign me", [{"signer_A" => {:name => "John Employee", :email => "john@employee.com"}}])
+    end
+
+    describe "optional options" do
+      it "should add \"@merge_field_name\"=>'Tax_id' key to merge_fields in xml hash" do
+        @rs.should_receive(:post).with('/api/templates.xml', {
+          :template => {
+            :guid => "MYGUID", 
+            :action => "prefill",
+            :subject => "sign me", 
+            :roles => [
+            ],
+            :merge_fields => [{:merge_field => {:value => "123456", "@merge_field_name" => "Tax_id"}}]
+          }
+        })
+        @rs.prefill("MYGUID", "sign me", [], {:merge_fields => [{"Tax_id" => "123456"}]})
+      end
+
+      it "should add \"@merge_field_id\"=>'123_abc_78' key to merge_fields in xml hash" do
+        @rs.should_receive(:post).with('/api/templates.xml', {
+          :template => {
+            :guid => "MYGUID", 
+            :action => "prefill",
+            :subject => "sign me", 
+            :roles => [
+            ],
+            :merge_fields => [{:merge_field => {:value => "123456", "@merge_field_id" => "123_abc_78"}}]
+          }
+        })
+        @rs.prefill("MYGUID", "sign me", [], {:merge_fields => [{"123_abc_78" => "123456"}], :use_merge_field_ids => true})
+      end
+
+      it "should add \"tag\" key to tags in xml hash" do
+        @rs.should_receive(:post).with('/api/templates.xml', {
+          :template => {
+            :guid => "MYGUID", 
+            :action => "prefill",
+            :subject => "sign me", 
+            :roles => [],
+            :tags => [{:tag => {:name => "I_Key", :value => "I_Value"}}, {:tag => {:name => "Alone"}}]
+          }
+        })
+        @rs.prefill("MYGUID", "sign me", [], {:tags => [{"I_Key" => "I_Value"}, "Alone"]})
+      end
+
+      it "should include options :expires_in, :description, :redirect_location, :document_data, and :callback_location" do
+        @rs.should_receive(:post).with('/api/templates.xml', {
+          :template => {
+            :guid => "MYGUID", 
+            :action => "prefill",
+            :subject => "sign me", 
+            :roles => [],
+            :expires_in => 15, 
+            :description => "Hey, I'm a description", 
+            :redirect_location => 'http://example.com/redirectme',
+            :document_data => {:type => 'base64', :filename => "originalfile.pdf", :value => "mOio90cv"},
+            :callback_location => 'http://example.com/callie'
+          }
+        })
+        @rs.prefill("MYGUID", "sign me", [], {:expires_in => 15, :description => "Hey, I'm a description", :redirect_location => 'http://example.com/redirectme', :callback_location => "http://example.com/callie", :document_data => {:type => 'base64', :filename => "originalfile.pdf", :value => "mOio90cv"}})
+      end
+
+      it "should include extra options" do
+        @rs.should_receive(:post).with('/api/templates.xml', {
+          :template => {
+            :guid => "MYGUID", 
+            :action => "prefill",
+            :subject => "sign me", 
+            :roles => [
+              {:role => {
+                :name => "John Employee", 
+                :email => "john@employee.com", 
+                "@role_id" => "signer_A"
+            }}],
+            :expires_in => 15, 
+            :description => "Hey, I'm a description", 
+            :redirect_location => 'http://example.com/redirectme',
+            :document_data => {:type => 'base64', :filename => "originalfile.pdf", :value => "mOio90cv"},
+            :callback_location => 'http://example.com/callie',
+            :something_else => "else",
+            :merge_fields => [{:merge_field => {:value => "123456", "@merge_field_id" => "123_abc_78"}}]
+          }
+        })
+        @rs.prefill("MYGUID", "sign me", [{"signer_A" => {:name => "John Employee", :email => "john@employee.com"}}], {:expires_in => 15, :description => "Hey, I'm a description", :redirect_location => 'http://example.com/redirectme', :callback_location => "http://example.com/callie", :document_data => {:type => 'base64', :filename => "originalfile.pdf", :value => "mOio90cv"}, :merge_fields => [{"123_abc_78" => "123456"}], :use_merge_field_ids => true, :something_else => "else"})
+      end
+    end
+
+    it "should POST /api/templates.xml with action of 'send', MYGUID guid, roles, and \"sign me\" subject in template hash" do
+      @rs.should_receive(:post).with('/api/templates.xml', {:template => {:guid => "MYGUID", :action => "send", :subject => "sign me", :roles => []}})
+      @rs.send_template("MYGUID", "sign me", [])
+    end
+  end
+  
+  describe "generate_build_url" do
+    it "should POST /api/templates/generate_build_token.xml" do
+      @rs.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => {}}).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+      @rs.generate_build_url
+    end
+
+    it "should return https://rightsignature.com/builder/new?rt=REDIRECT_TOKEN" do
+      @rs.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => {}}).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+      @rs.generate_build_url.should == "#{@rs.site}/builder/new?rt=REDIRECT_TOKEN"
+    end
+
+    describe "options" do
+      it "should include normalized :acceptable_merge_field_names in params" do
+        @rs.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => 
+          {:acceptable_merge_field_names => 
+            [
+              {:name => "Site ID"}, 
+              {:name => "Starting City"}
+            ]}
+        }).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+        @rs.generate_build_url(:acceptable_merge_field_names => ["Site ID", "Starting City"])
+      end
+
+      it "should include normalized :acceptable_role_names, in params" do
+        @rs.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => 
+          {:acceptable_role_names => 
+            [
+              {:name => "Http Monster"}, 
+              {:name => "Party Monster"}
+            ]}
+        }).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+        @rs.generate_build_url(:acceptable_role_names => ["Http Monster", "Party Monster"])
+      end
+
+      it "should include normalized :tags in params" do
+        @rs.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => 
+          {:tags => 
+            [
+              {:tag => {:name => "Site"}}, 
+              {:tag => {:name => "Starting City", :value => "NY"}}
+            ]}
+        }).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+        @rs.generate_build_url(:tags => ["Site", "Starting City" => "NY"])
+      end
+      
+      it "should include :callback_location and :redirect_location in params" do
+        @rs.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => {
+          :callback_location => "http://example.com/done_signing", 
+          :redirect_location => "http://example.com/come_back_here"
+        }}).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+
+        @rs.generate_build_url(:callback_location => "http://example.com/done_signing", :redirect_location => "http://example.com/come_back_here")
+      end
+
+      it "should include other extra options in params" do
+        @rs.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => {
+          :tags => 
+            [
+              {:tag => {:name => "Site"}}
+            ],
+          :acceptable_merge_field_names => 
+            [
+              {:name => "Site ID"}, 
+              {:name => "Starting City"}
+            ],
+          :acceptable_role_names => 
+            [
+              {:name => "Http Party"}
+            ],
+          :callback_location => "http://example.com/done_signing", 
+          :redirect_location => "http://example.com/come_back_here",
+          :extras => "stuff here"
+        }}).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+
+        @rs.generate_build_url(:tags => ["Site"], :acceptable_merge_field_names => ["Site ID", "Starting City"], :acceptable_role_names => ["Http Party"], :callback_location => "http://example.com/done_signing", :redirect_location => "http://example.com/come_back_here", :extras => "stuff here")
+      end
+    end
+  end
+  
+  describe "send_as_self_signers" do
+    before do
+      @prepackage_response = {"template"=>{
+        "type"=>"Document",
+        "guid"=>"a_123_456",
+        "created_at"=>"2012-09-25T14:51:44-07:00",
+        "filename"=>"assets-363-demo_document.pdf",
+        "size"=>"14597",
+        "content_type"=>"pdf",
+        "page_count"=>"1",
+        "subject"=>"subject template",
+        "message"=>"Default message here",
+        "tags"=>"template_id:31,user:1",
+        "processing_state"=>"done-processing",
+        "roles"=>
+        {"role"=>
+          [{"role"=>"Document Sender",
+            "name"=>"Document Sender",
+            "must_sign"=>"false",
+            "document_role_id"=>"cc_A",
+            "is_sender"=>"true"},
+           {"role"=>"Leasee",
+            "name"=>"Leasee",
+            "must_sign"=>"true",
+            "document_role_id"=>"signer_A",
+            "is_sender"=>"false"},
+           {"role"=>"Leaser",
+            "name"=>"Leaser",
+            "must_sign"=>"true",
+            "document_role_id"=>"signer_B",
+            "is_sender"=>"true"}]},
+        "merge_fields"=>nil,
+        "pages"=>
+          {"page"=>
+            {"page_number"=>"1",
+             "original_template_guid"=>"GUID123",
+             "original_template_filename"=>"demo_document.pdf"}
+          },
+        "thumbnail_url"=>
+        "https%3A%2F%2Fs3.amazonaws.com%3A443%2Frightsignature.com%2Fassets%2F1464%2Fabcde_p1_t.png%3FSignature%3D1234AC",
+        "redirect_token"=>
+        "123456bcde"
+      }}
+      
+      @sent_document_response = {"document"=> {
+        "status"=>"sent", 
+        "guid"=>"ABCDEFGH123"
+      }}
+      
+    end
+    
+    it "should prepackage template, send template with reciepents with noemail@rightsignature.com and return self-signer links" do
+      @rs.should_receive(:post).with('/api/templates/TGUID/prepackage.xml', 
+        {}
+      ).and_return(@prepackage_response)
+      @rs.should_receive(:post).with('/api/templates.xml', {:template => {
+          :guid => "a_123_456", 
+          :action => "send", 
+          :subject => "subject template",
+          :roles => [
+            {:role => {:name => "John Bellingham", :email => "noemail@rightsignature.com", "@role_name" => "Leasee"}},
+            {:role => {:name => "Tim Else", :email => "noemail@rightsignature.com", "@role_name" => "Leaser"}}
+          ]
+        }}).and_return(@sent_document_response)
+      @rs.should_receive(:get).with("/api/documents/ABCDEFGH123/signer_links.xml", {}).and_return({"document" => {
+        "signer_links" => {"signer_link" => [
+          {"name" => "John Bellingham", "role" => "signer_A", "signer_token" => "slkfj2"},
+          {"name" => "Tim Else", "role" => "signer_B", "signer_token" => "asfd1"}
+        ]}
+      }})
+      
+      
+      results = @rs.send_as_embedded_signers("TGUID", [
+        {"Leasee" => {:name => "John Bellingham"}}, 
+        {"Leaser" => {:name => "Tim Else"}}
+      ])
+      results.size.should == 2
+      results.include?({"name" => "John Bellingham", "url" => "#{@rs.site}/signatures/embedded?rt=slkfj2"})
+      results.include?({"name" => "Tim Else", "url" => "#{@rs.site}/signatures/embedded?rt=asfd1"})
+    end
+    
+    it "should not overwrite email if one is already set for receipient" do
+      @rs.should_receive(:post).with('/api/templates/TGUID/prepackage.xml', 
+        {}
+      ).and_return(@prepackage_response)
+      @rs.should_receive(:post).with('/api/templates.xml', {:template => {
+          :guid => "a_123_456", 
+          :action => "send", 
+          :subject => "subject template",
+          :roles => [
+            {:role => {:name => "John Bellingham", :email => "dontchange@example.com", "@role_name" => "Leasee"}},
+            {:role => {:name => "Tim Else", :email => "noemail@rightsignature.com", "@role_name" => "Leaser"}}
+          ]
+        }}).and_return(@sent_document_response)
+      @rs.should_receive(:get).with("/api/documents/ABCDEFGH123/signer_links.xml", {}).and_return({"document" => {
+        "signer_links" => {"signer_link" => [
+          {"name" => "John Bellingham", "email" => "dontchange@example.com", "role" => "signer_A", "signer_token" => "slkfj2"},
+          {"name" => "Tim Else", "role" => "signer_B", "signer_token" => "asfd1"}
+        ]}
+      }})
+      
+      results = @rs.send_as_embedded_signers("TGUID", [
+        {"Leasee" => {:name => "John Bellingham", :email => "dontchange@example.com"}}, 
+        {"Leaser" => {:name => "Tim Else"}}
+      ])
+      results.size.should == 2
+      results.include?({"name" => "John Bellingham", "url" => "#{@rs.site}/signatures/embedded?rt=slkfj2"})
+      results.include?({"name" => "Tim Else", "url" => "#{@rs.site}/signatures/embedded?rt=asfd1"})
+    end
+    
+    it "should pass in options"
+  end
+
+  describe "trash" do
+    it "should DELETE /api/templates/MYGUID.xml" do
+      expect(@rs).to receive(:delete).with('/api/templates/MYGUID.xml')
+      @rs.trash_template('MYGUID')
+    end
+  end
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: rightsignature-railstyle
+version: !ruby/object:Gem::Version
+  version: 1.1.9
+platform: ruby
+authors:
+- Nick Barone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: xml-fu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Provides a wrapper for the RightSignature API.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/rightsignature.rb
+- lib/rightsignature/account.rb
+- lib/rightsignature/connection.rb
+- lib/rightsignature/connection/oauth_connection.rb
+- lib/rightsignature/connection/token_connection.rb
+- lib/rightsignature/document.rb
+- lib/rightsignature/errors.rb
+- lib/rightsignature/helpers/normalizing.rb
+- lib/rightsignature/helpers/refine_hash_to_indifferent_access.rb
+- lib/rightsignature/rails_style.rb
+- lib/rightsignature/template.rb
+- lib/rightsignature/version.rb
+- rightsignature-api.gemspec
+- spec/account_spec.rb
+- spec/api_token_connection_spec.rb
+- spec/configuration_spec.rb
+- spec/connection_spec.rb
+- spec/document_spec.rb
+- spec/errors_spec.rb
+- spec/normalizing_spec.rb
+- spec/oauth_connnection_spec.rb
+- spec/rails_style_spec.rb
+- spec/spec_helper.rb
+- spec/template_spec.rb
+homepage: http://github.com/narfanator/rightsignature-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.8
+signing_key: 
+specification_version: 4
+summary: API wrapper for RightSignature
+test_files: []