rightsignature 1.0.5 → 1.0.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2Q2MTU5ZGRiMjIwMGYyNTk1NWQzZjhhNWZhMDlkZjQxYWFiOTgzYw==
+  data.tar.gz: !binary |-
+    NWU3Y2UxOTE1MzAyYjY5Yzc0MmU5NTk4ZmYxNTg0ZjcwMWUxNWZhMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MGYwM2RmZjFhMDcyMjM5ZDhkMTg2OGY3MzA5OTE1YTY5ODU4N2UyODYxNjU3
+    NWFjOWFkZTk1ZWUwM2YxM2I5YTdiODZjMTZlMjMwZTZlOTc4YmUyYmQ4Yjky
+    ZjQ4MDJiNjkxZDlmNjQxMmQ5ZjljZjc0NzcyYTJjNzU0NzlmNjU=
+  data.tar.gz: !binary |-
+    MmFiMTAzMGMwY2M4M2FjZDIyMzM1OTA5NzE3NGE5Yzg4YjFhN2QwYTlmNzYw
+    ZjVjZTllM2EwMGEyMjc3ZTQ2ZWE0YjMyODAzNzI0NGQ5MGExMWU3M2Y4M2Qw
+    NWMwYTQyZDhkMTI1ZTdlNTgzMjY3ZWY0YTBlMWE3YjcyM2E2MGM=

data/README.md

@@ -414,13 +414,30 @@ request_hash= {
 @rs_connection.post('/api/documents.xml', request_hash, {'custom_header' => 'headerValue'})
 ```
 
+Getting API Error Messages
+--------------------------
+If a request does not return a success response (200), a RightSignature::ResponseError is raised. You can rescue the error and inspect the response object or call detailed_message. detailed_message only returns if the response from the server contains an error message in the XML.
+#####Ex. Trying to parse the error message response from API
+```
+begin
+  @rs_connection.post('/api/documents.xml', {:bad => 'params'})
+rescue RightSignature::ResponseError => error
+  puts error.detailed_message
+end
+```
+
+#####Ex. Trying to inspect the response object for more information
+```
+begin
+  @rs_connection.post('/api/documents.xml', {:bad => 'params'})
+rescue RightSignature::ResponseError => error
+  puts error.response.inspect
+end
+```
+
 Development Notes
 -----------------
 To load in irb from project root:
 ```
 $:.push File.expand_path("../lib", __FILE__); require "rightsignature"; RightSignature::Connection.new(MY_KEYS)
 ```
-
-TODO:
------
-* Parse error message from response body on unsuccessful requests

data/lib/rightsignature/connection.rb

@@ -190,14 +190,12 @@ module RightSignature
     def parse_response(response)
       if response.is_a? Net::HTTPResponse
         unless response.is_a? Net::HTTPSuccess
-          puts response.body
           raise RightSignature::ResponseError.new(response)
         end
 
         MultiXml.parse(response.body)
       else
         unless response.success?
-          puts response.body
           raise RightSignature::ResponseError.new(response)
         end
         

data/lib/rightsignature/errors.rb

@@ -2,6 +2,10 @@ module RightSignature
   class ResponseError < Exception
     attr_reader :response
 
+    # Creates new instance of RightSignature::ResponseError to make API calls
+    # * <b>response</b>: Net::HTTP response or HTTParty response
+    # * <b>message</b>: (Optional) Custom error message
+    #     
     def initialize(response, message=nil)
       self.set_backtrace(caller[1..-1]) if self.backtrace.nil?
       @response = response
@@ -23,6 +27,21 @@ module RightSignature
         "Check the format of your xml or json"
       end
     end
+
+    # Attempts to parse an error message from the response body
+    def detailed_message
+      if @response.is_a? Net::HTTPResponse
+        parsed_response = MultiXml.parse(@response.body)
+
+        parsed_response["error"]["message"] if parsed_response && parsed_response["error"]
+      else
+        if @response.parsed_response.is_a? Hash
+          @response.parsed_response["error"]["message"] if @response.parsed_response["error"]
+        end
+      end
+    end
+    
+
   end
 
   class TokenResponseError < ResponseError # :nodoc:

data/lib/rightsignature/helpers/normalizing.rb

@@ -22,9 +22,9 @@ module RightSignature::Helpers #:nodoc:
         tags_array.map do |t|
           if t.is_a? Hash
             name, value = t.first
-            {:tag => {:name => name, :value => value}}
+            {:tag => {:name => name.to_s, :value => value.to_s}}
           else
-            {:tag => {:name => t}}
+            {:tag => {:name => t.to_s}}
           end
         end
       end
@@ -43,9 +43,9 @@ module RightSignature::Helpers #:nodoc:
           name, value = role_hash.first
           raise "Hash '#{role_hash.inspect}' is malformed, should be something like {ROLE_NAME => {:name => \"a\", :email => \"a@a.com\"}}" unless value.is_a? Hash and name.is_a? String
           if name.match(/^signer_[A-Z]+$/) || name.match(/^cc_[A-Z]+$/)
-            roles_hash_array << {:role => value.merge({"@role_id" => name})}
+            roles_hash_array << {:role => value.merge({"@role_id" => name.to_s})}
           else
-            roles_hash_array << {:role => value.merge({"@role_name" => name})}
+            roles_hash_array << {:role => value.merge({"@role_name" => name.to_s})}
           end
         end
       
@@ -65,9 +65,9 @@ module RightSignature::Helpers #:nodoc:
         merge_fields_array.each do |merge_field_hash|
           name, value = merge_field_hash.first
           if use_id
-            merge_fields << { :merge_field => {:value => value, "@merge_field_id" => name}}
+            merge_fields << { :merge_field => {:value => value.to_s, "@merge_field_id" => name.to_s}}
           else
-            merge_fields << { :merge_field => {:value => value, "@merge_field_name" => name}}
+            merge_fields << { :merge_field => {:value => value.to_s, "@merge_field_name" => name.to_s}}
           end
         end
 

data/lib/rightsignature/template.rb

@@ -94,7 +94,7 @@ module RightSignature
       use_merge_field_ids = options.delete(:use_merge_field_ids)
       xml_hash[:template][:merge_fields] = MergeFieldsHelper.array_to_xml_hash(options[:merge_fields], use_merge_field_ids) if options[:merge_fields]
       xml_hash[:template][:tags] = TagsHelper.array_to_xml_hash(options[:tags]) if options[:tags]
-      [:expires_in, :description, :callback_location, :redirect_location, :action].each do |other_option|
+      [:expires_in, :description, :callback_location, :redirect_location, :action, :document_data].each do |other_option|
         xml_hash[:template][other_option] = options[other_option] if options[other_option]
       end
 

data/lib/rightsignature/version.rb

@@ -1,3 +1,3 @@
 module RightSignature
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/spec/errors_spec.rb

@@ -25,6 +25,22 @@ describe RightSignature::ResponseError do
         error.message.should == 'No Way'
       end
     end
+    
+    describe "detailed_message" do
+      it "should return error message from xml" do
+        response = Net::HTTPNotAcceptable.new('1.1', 406, 'Not Acceptable')
+        response.stub(:body).and_return('<error><message>Invalid GUID</message></error>')
+        error = RightSignature::ResponseError.new(response)
+        error.detailed_message.should == 'Invalid GUID'
+      end
+
+      it "should return nothing if response does not have error message node" do
+        response = Net::HTTPNotFound.new('1.1', 404, 'Not Found')
+        response.stub(:body).and_return('<html><body>Not Found</body></html>')
+        error = RightSignature::ResponseError.new(response)
+        error.detailed_message.should be_nil
+      end
+    end
 
     describe "common_solutions" do
       describe "on 406" do
@@ -82,6 +98,24 @@ describe RightSignature::ResponseError do
       end
     end
 
+    describe "detailed_message" do
+      it "should return error message from xml" do
+        net_http_response = Net::HTTPNotAcceptable.new('1.1', 406, 'Not Acceptable')
+        net_http_response.stub(:body).and_return('<error><message>Invalid GUID</message></error>')
+        response = HTTParty::Response.new(HTTParty::Request.new(Net::HTTP::Get, '/'), net_http_response, lambda{{"error" => {"message" => "Invalid GUID"}}})
+        error = RightSignature::ResponseError.new(response)
+        error.detailed_message.should == 'Invalid GUID'
+      end
+
+      it "should return nothing if response does not have error message node" do
+        net_http_response = Net::HTTPNotFound.new('1.1', 404, 'Not Found')
+        net_http_response.stub(:body).and_return('<html><body>Not Found</body></html>')
+        response = HTTParty::Response.new(HTTParty::Request.new(Net::HTTP::Get, '/'), net_http_response, lambda{ {}})
+        error = RightSignature::ResponseError.new(response)
+        error.detailed_message.should be_nil
+      end
+    end
+
     describe "common_solutions" do
       describe "on 406" do
         it "should suggest to check Content-Type header, url, or Accept header" do

data/spec/normalizing_spec.rb

@@ -15,6 +15,13 @@ describe RightSignature::Helpers::TagsHelper do
     it "should convert array of string and hash of {name => value} into array of :tag => {:name => name, :value => value}" do
       RightSignature::Helpers::TagsHelper.array_to_xml_hash(['abc', {"taggy" => "tvalue"}]).should == [{:tag => {:name => 'abc'}}, {:tag => {:name => 'taggy', :value => 'tvalue'}}]
     end
+    
+    it "should convert a symbol to a string for names and values" do
+      RightSignature::Helpers::TagsHelper.array_to_xml_hash([:abc, {:taggy => :tvalue}]).should == [
+        {:tag => {:name => 'abc'}}, 
+        {:tag => {:name => 'taggy', :value => 'tvalue'}}
+      ]
+    end
   end
 end
 
@@ -63,5 +70,16 @@ describe RightSignature::Helpers::MergeFieldsHelper do
       results.include?({:merge_field => {:value => "Santa Barbara", "@merge_field_id" => "1_abc_defg"}})
       results.include?({:merge_field => {:value => "House", "@merge_field_id" => "2_345_789"}})
     end
+    
+    it "should convert a symbol to a string for names and values" do
+      results = RightSignature::Helpers::MergeFieldsHelper.array_to_xml_hash([
+        {:abc_defg => :SomeValue},
+        {:higjk => "House"}
+      ], true)
+      results.size.should == 2
+      results.include?({:merge_field => {:value => "SomeValue", "@merge_field_id" => "abc_defg"}})
+      results.include?({:merge_field => {:value => "House", "@merge_field_id" => "higjk"}})
+    end
+
   end
 end

data/spec/template_spec.rb

@@ -158,7 +158,7 @@ describe RightSignature::Template do
         @rs.prefill("MYGUID", "sign me", [], {:tags => [{"I_Key" => "I_Value"}, "Alone"]})
       end
 
-      it "should include options :expires_in, :description, :redirect_location, and :callback_location" do
+      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", 
@@ -168,10 +168,11 @@ describe RightSignature::Template do
             :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"})
+        @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
     end
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rightsignature
 version: !ruby/object:Gem::Version
-  version: 1.0.5
-  prerelease: 
+  version: 1.0.6
 platform: ruby
 authors:
 - Alex Chee
@@ -11,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -24,7 +22,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -32,7 +29,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -40,7 +36,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,7 +43,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -56,7 +50,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -64,7 +57,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -72,7 +64,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -80,7 +71,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -88,7 +78,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -96,7 +85,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-fu
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -104,7 +92,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -143,27 +130,26 @@ files:
 - spec/template_spec.rb
 homepage: http://github.com/rightsignature/rightsignature-api
 licenses: []
+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: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: API wrapper for RightSignature
 test_files: []
 has_rdoc: