rightsignature 0.1.0

data/spec/errors_spec.rb

@@ -0,0 +1,119 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe RightSignature::ResponseError do
+  describe "For OAuth response" do
+    before do
+      @net_http_response = Net::HTTPSuccess.new('1.1', '200', 'OK')
+      @error = RightSignature::ResponseError.new(@net_http_response)
+    end
+
+    it "response should return Net::HTTP response" do
+      @error.response.should == @net_http_response
+    end
+
+    it "code should return response code" do
+      @error.code.should == '200'
+    end
+
+    describe "message" do
+      it "should return response message" do
+        @error.message.should == 'OK'
+      end
+
+      it "should return specified message" do
+        error = RightSignature::ResponseError.new(@net_http_response, "No Way")
+        error.message.should == 'No Way'
+      end
+    end
+
+    describe "common_solutions" do
+      describe "on 406" do
+        it "should suggest to check Content-Type header, url, or Accept header" do
+          net_http_response = Net::HTTPNotAcceptable.new('1.1', '406', 'Not Acceptable')
+          error = RightSignature::ResponseError.new(net_http_response)
+          error.common_solutions.should match /Check the Content-Type/i
+          error.common_solutions.should match /ensure url has \.xml or \.json/i
+          error.common_solutions.should match /check 'Accept' header/i
+        end
+      end
+
+      describe "on 401" do
+        it "should suggest to check credentials" do
+          net_http_response = Net::HTTPUnauthorized.new('1.1', '401', 'Unauthorized Access')
+          error = RightSignature::ResponseError.new(net_http_response)
+          error.common_solutions.should match /Check your credentials/i
+        end
+      end
+
+      describe "on 500s" do
+        it "should suggest to check xml or json format" do
+          net_http_response = Net::HTTPInternalServerError.new('1.1', '500', 'Internal Server Error')
+          error = RightSignature::ResponseError.new(net_http_response)
+          error.common_solutions.should match /Check the format of your xml or json/i
+        end
+      end
+    end
+  end
+
+  describe "For HTTParty response" do
+    before do
+      @net_http_response = Net::HTTPOK.new('1.1', 200, 'OK')
+      @net_http_response.stub(:body =>"{}")
+
+      @response = HTTParty::Response.new(HTTParty::Request.new(Net::HTTP::Get, '/'), @net_http_response, lambda { {} })
+      @error = RightSignature::ResponseError.new(@response)
+    end
+
+    it "response should return HTTParty response" do
+      @error.response.should == @response
+    end
+
+    it "code should return response code" do
+      @error.code.should == 200
+    end
+
+    describe "message" do
+      it "should return response message" do
+        @error.message.should == 'OK'
+      end
+      it "should return specified message" do
+        error = RightSignature::ResponseError.new(@response, "No Way")
+        error.message.should == 'No Way'
+      end
+    end
+
+    describe "common_solutions" do
+      describe "on 406" do
+        it "should suggest to check Content-Type header, url, or Accept header" do
+          net_http_response = Net::HTTPNotAcceptable.new('1.1', '406', 'Not Acceptable')
+          net_http_response.stub(:body =>"{}")
+          response = HTTParty::Response.new(HTTParty::Request.new(Net::HTTP::Get, '/'), net_http_response, lambda { {} })
+          error = RightSignature::ResponseError.new(response)
+          error.common_solutions.should match /Check the Content-Type/i
+          error.common_solutions.should match /ensure url has \.xml or \.json/i
+          error.common_solutions.should match /check 'Accept' header/i
+        end
+      end
+
+      describe "on 401" do
+        it "should suggest to check credentials" do
+          net_http_response = Net::HTTPUnauthorized.new('1.1', '401', 'Unauthorized Access')
+          net_http_response.stub(:body =>"{}")
+          response = HTTParty::Response.new(HTTParty::Request.new(Net::HTTP::Get, '/'), net_http_response, lambda { {} })
+          error = RightSignature::ResponseError.new(response)
+          error.common_solutions.should match /Check your credentials/i
+        end
+      end
+
+      describe "on 500s" do
+        it "should suggest to check xml or json format" do
+          net_http_response = Net::HTTPInternalServerError.new('1.1', '500', 'Internal Server Error')
+          net_http_response.stub(:body =>"{}")
+          response = HTTParty::Response.new(HTTParty::Request.new(Net::HTTP::Get, '/'), net_http_response, lambda { {} })
+          error = RightSignature::ResponseError.new(response)
+          error.common_solutions.should match /Check the format of your xml or json/i
+        end
+      end
+    end
+  end
+end

data/spec/oauth_connnection_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe RightSignature::OauthConnection do
+  before do
+    @consumer_mock = mock(OAuth::Consumer)
+    @access_token_mock = mock(OAuth::AccessToken)
+  end
+
+  describe "access_token" do
+    it "should create OAuth access token with credentials" do
+      OAuth::Consumer.should_receive(:new).with(
+        "Consumer123",
+        "Secret098",
+        {
+         :site              => "https://rightsignature.com",
+         :scheme            => :header,
+         :http_method        => :post,
+         :authorize_path    =>'/oauth/authorize', 
+         :access_token_path =>'/oauth/access_token', 
+         :request_token_path=>'/oauth/request_token'
+        }).and_return(@consumer_mock)
+      OAuth::AccessToken.should_receive(:new).with(@consumer_mock, 'AccessToken098', 'AccessSecret123')
+
+      RightSignature::OauthConnection.access_token
+    end
+  end
+
+  describe "request" do
+    it "should create GET request with access token and path with custom headers as 3rd argument" do
+      @access_token_mock.should_receive(:get).with('path', {"User-Agent" => 'My own', "Accept"=>"*/*", "content-type"=>"application/xml"})
+      RightSignature::OauthConnection.stub(:access_token).and_return(@access_token_mock)
+      RightSignature::OauthConnection.request(:get, "path", {"User-Agent" => 'My own'})
+    end
+
+    it "should create POST request with access token and path with body as 3rd argument and custom headers as 4th argument" do
+      @access_token_mock.should_receive(:post).with('path', "<template></template>", {"User-Agent" => 'My own', "Accept"=>"*/*", "content-type"=>"application/xml"})
+      RightSignature::OauthConnection.stub(:access_token).and_return(@access_token_mock)
+      RightSignature::OauthConnection.request(:post, "path", "<template></template>", {"User-Agent" => 'My own'})
+    end
+  end
+
+end

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
+    RightSignature::configuration = {: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,189 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe RightSignature::Template do 
+  describe "list" do
+    it "should GET /api/templates.xml" do
+      RightSignature::Connection.should_receive(:get).with('/api/templates.xml', {})
+      RightSignature::Template.list
+    end
+
+    it "should pass search options to /api/templates.xml" do
+      RightSignature::Connection.should_receive(:get).with('/api/templates.xml', {:search => "search", :page => 2})
+      RightSignature::Template.list(:search => "search", :page => 2)
+    end
+    
+    it "should convert tags array of mixed strings and hashes into into normalized Tag string" do
+      RightSignature::Connection.should_receive(:get).with('/api/templates.xml', {:tags => "hello,abc:def,there"})
+      RightSignature::Template.list(:tags => ["hello", {"abc" => "def"}, "there"])
+    end
+
+    it "should keep tags as string if :tags is a string" do
+      RightSignature::Connection.should_receive(:get).with('/api/templates.xml', {:tags => "voice,no:way,microphone"})
+      RightSignature::Template.list(:tags => "voice,no:way,microphone")
+    end
+  end
+  
+  describe "details" do
+    it "should GET /api/templates/MYGUID.xml" do
+      RightSignature::Connection.should_receive(:get).with('/api/templates/MYGUID.xml', {})
+      RightSignature::Template.details('MYGUID')
+    end
+  end
+
+  describe "prepackage" do
+    it "should POST /api/templates/MYGUID/prepackage.xml" do
+      RightSignature::Connection.should_receive(:post).with('/api/templates/MYGUID/prepackage.xml', {})
+      RightSignature::Template.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
+      RightSignature::Connection.should_receive(:post).with('/api/templates/GUID123/prepackage.xml', 
+        {}
+      ).and_return({"template" => {
+        "guid" => "a_123985_1z9v8pd654",
+        "subject" => "subject template",
+        "message" => "Default message here"
+      }})
+      RightSignature::Connection.should_receive(:post).with('/api/templates.xml', {:template => {
+          :guid => "a_123985_1z9v8pd654", 
+          :action => "send", 
+          :subject => "sign me", 
+          :roles => []
+        }})
+      RightSignature::Template.prepackage_and_send("GUID123", "sign me", [])
+    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
+      RightSignature::Connection.should_receive(:post).with('/api/templates.xml', {:template => {:guid => "MYGUID", :action => "prefill", :subject => "sign me", :roles => []}})
+      RightSignature::Template.prefill("MYGUID", "sign me", [])
+    end
+    
+    it "should add \"@role_name\"=>'Employee' key to roles in xml hash" do
+      RightSignature::Connection.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"
+            }}
+          ]
+        }
+      })
+      RightSignature::Template.prefill("MYGUID", "sign me", [{"Employee" => {: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
+        RightSignature::Connection.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"}}]
+          }
+        })
+        RightSignature::Template.prefill("MYGUID", "sign me", [], {:merge_fields => [{"Tax_id" => "123456"}]})
+      end
+
+      it "should add \"tag\" key to tags in xml hash" do
+        RightSignature::Connection.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"}}]
+          }
+        })
+        RightSignature::Template.prefill("MYGUID", "sign me", [], {:tags => [{"I_Key" => "I_Value"}, "Alone"]})
+      end
+
+      it "should include options :expires_in, :description, and :callback_url" do
+        RightSignature::Connection.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", 
+            :callback_url => 'http://example.com/callie'
+          }
+        })
+        RightSignature::Template.prefill("MYGUID", "sign me", [], {:expires_in => 15, :description => "Hey, I'm a description", :callback_url => "http://example.com/callie"})
+      end
+    end
+
+    it "should POST /api/templates.xml with action of 'send', MYGUID guid, roles, and \"sign me\" subject in template hash" do
+      RightSignature::Connection.should_receive(:post).with('/api/templates.xml', {:template => {:guid => "MYGUID", :action => "send", :subject => "sign me", :roles => []}})
+      RightSignature::Template.send_template("MYGUID", "sign me", [])
+    end
+  end
+  
+  describe "generate_build_url" do
+    it "should POST /api/templates/generate_build_token.xml" do
+      RightSignature::Connection.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => {}}).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+      RightSignature::Template.generate_build_url
+    end
+
+    it "should return https://rightsignature.com/builder/new?rt=REDIRECT_TOKEN" do
+      RightSignature::Connection.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => {}}).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+      RightSignature::Template.generate_build_url.should == "#{RightSignature::Connection.site}/builder/new?rt=REDIRECT_TOKEN"
+    end
+
+    describe "options" do
+      it "should include normalized :acceptable_merge_field_names in params" do
+        RightSignature::Connection.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"}})
+        RightSignature::Template.generate_build_url(:acceptable_merge_field_names => ["Site ID", "Starting City"])
+      end
+
+      it "should include normalized :acceptabled_role_names, in params" do
+        RightSignature::Connection.should_receive(:post).with("/api/templates/generate_build_token.xml", {:template => 
+          {:acceptabled_role_names => 
+            [
+              {:name => "Http Monster"}, 
+              {:name => "Party Monster"}
+            ]}
+        }).and_return({"token"=>{"redirect_token" => "REDIRECT_TOKEN"}})
+        RightSignature::Template.generate_build_url(:acceptabled_role_names => ["Http Monster", "Party Monster"])
+      end
+
+      it "should include normalized :tags in params" do
+        RightSignature::Connection.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"}})
+        RightSignature::Template.generate_build_url(:tags => ["Site", "Starting City" => "NY"])
+      end
+      
+      it "should include :callback_location and :redirect_location in params" do
+        RightSignature::Connection.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"}})
+
+        RightSignature::Template.generate_build_url(:callback_location => "http://example.com/done_signing", :redirect_location => "http://example.com/come_back_here")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rightsignature
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Chee
+- Geoff Ereth
+- Cary Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70117188199340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70117188199340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70117188198600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70117188198600
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70117204029320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70117204029320
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &70117204028660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70117204028660
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70117204027840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70117204027840
+- !ruby/object:Gem::Dependency
+  name: xml-fu
+  requirement: &70117204026860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *70117204026860
+description: Provides a wrapper for the RightSignature API.
+email:
+- dev@rightsignature.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/rightsignature.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/template.rb
+- lib/rightsignature/version.rb
+- rightsignature-api.gemspec
+- spec/api_token_connection_spec.rb
+- spec/configuration_spec.rb
+- spec/connection_spec.rb
+- spec/document_spec.rb
+- spec/errors_spec.rb
+- spec/oauth_connnection_spec.rb
+- spec/spec_helper.rb
+- spec/template_spec.rb
+homepage: http://github.com/alexchee/rightsignature-api
+licenses: []
+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: 1.8.10
+signing_key: 
+specification_version: 3
+summary: API wrapper for RightSignature
+test_files: []
+has_rdoc: