recurly 0.4.2 → 0.4.3

data/lib/recurly.rb

@@ -14,6 +14,7 @@ end
 require 'recurly/version'
 require 'recurly/exceptions'
 require 'recurly/formats/xml_with_pagination'
+require 'recurly/formats/xml_with_errors'
 require 'recurly/config_parser'
 require 'recurly/rails3/railtie' if defined?(::Rails::Railtie)
 require 'recurly/base'

data/lib/recurly/base.rb

@@ -5,18 +5,7 @@ module Recurly
   class Base < ActiveResource::Base
     extend ActiveSupport::Memoizable
 
-    self.format = Recurly::Formats::XmlWithPaginationFormat.new
-
-    def initialize(attributes = {})
-      super(attributes)
-    end
-
-    # Add User-Agent to headers
-    def headers
-      super
-      @headers['User-Agent'] = "Recurly Ruby Client v#{VERSION}"
-      @headers
-    end
+    self.format = Recurly::Formats::XmlWithErrorsFormat.new
 
     def update_only
       false
@@ -56,6 +45,36 @@ module Recurly
       !persisted?
     end
 
+    # patched to read Errors array
+    def load(attributes)
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      @prefix_options, attributes = split_options(attributes)
+      attributes.each do |key, value|
+        if key.to_s == 'errors' && value.is_a?(Array)
+          load_errors_from_array(value)
+          next
+        end
+        @attributes[key.to_s] =
+          case value
+            when Array
+              resource = find_or_create_resource_for_collection(key)
+              value.map do |attrs|
+                if attrs.is_a?(Hash)
+                  resource.new(attrs)
+                else
+                  attrs.duplicable? ? attrs.dup : attrs
+                end
+              end
+            when Hash
+              resource = find_or_create_resource_for(key)
+              resource.new(value)
+            else
+              value.dup rescue value
+          end
+      end
+      self
+    end
+
     # builds the object from the transparent results
     def from_transparent_results(response)
       self.load_attributes_from_response(response)
@@ -68,6 +87,39 @@ module Recurly
         super
         @persisted = true
       end
+      
+      # Patched to read errors with field information
+      def load_errors_from_array(new_errors, save_cache = false)
+        errors.clear unless save_cache
+        return if new_errors.nil? or new_errors.empty?
+        humanized_attributes = Hash[self.known_attributes.map { |attr_name| [attr_name.humanize, attr_name] }] unless self.known_attributes.nil?
+        humanized_attributes ||= Hash[@attributes.keys.map { |attr_name| [attr_name.humanize, attr_name] }]
+        new_errors.each do |error|
+          if error.is_a?(Hash)
+            field = error['field']
+            message = error['message']
+
+            if field.blank?
+              errors[:base] << message
+            end
+
+            humanized_name = field.humanize
+            message = message[(humanized_name.size + 1)..-1] if message[0, humanized_name.size + 1] == "#{humanized_name} "
+
+            errors.add field.to_sym, message
+          elsif error.is_a?(String)
+            message = error
+            attr_message = humanized_attributes.keys.detect do |attr_name|
+              if message[0, attr_name.size + 1] == "#{attr_name} "
+                errors.add humanized_attributes[attr_name], message[(attr_name.size + 1)..-1]
+                next
+              end
+            end
+
+            errors[:base] << message
+          end
+        end
+      end
 
     private
       # patch instantiate_record so it marks result records as persisted
@@ -77,6 +129,34 @@ module Recurly
         result
       end
 
+      def build_request_headers(headers, http_method, uri)
+        super(headers, http_method, uri).update({'User-Agent' => "Recurly Ruby Client v#{VERSION}"})
+      end
+
+      def handle_response(response)
+        case response.code.to_i
+        when 401
+          message = Hash.from_xml(response.body)['errors']['error'] rescue nil
+          raise(UnauthorizedAccess.new(response, message))
+        when 403
+          message = Hash.from_xml(response.body)['errors']['error'] rescue nil
+          raise(ForbiddenAccess.new(response, message))
+        when 404
+          message = Hash.from_xml(response.body)['errors']['error'] rescue nil
+          raise ResourceNotFound.new(response, message)
+        when 422
+          message = Hash.from_xml(response.body)['errors']['error'] rescue nil
+          raise ResourceInvalid.new(response, message)
+        when 412
+          message = Hash.from_xml(response.body)['errors']['error'] rescue nil
+          raise ClientError.new(response, message)
+        when 500
+          message = Hash.from_xml(response.body)['errors']['error'] rescue nil
+          raise(ServerError.new(response, message))
+        else
+          super
+        end
+      end
   end
 
   # backwards compatibility

data/lib/recurly/formats/xml_with_errors.rb

@@ -0,0 +1,132 @@
+require 'nokogiri'
+
+module Recurly
+  module Formats
+    class XmlWithErrorsFormat
+      include ActiveResource::Formats::XmlFormat
+
+      def decode(xml)
+        doc = Nokogiri::XML(xml)
+        data = xml_node_to_hash(doc.root)
+
+        if data.is_a?(Hash) and data["type"] == 'collection' and data["current_page"]
+          data = paginate_data(data)
+        end
+
+        data
+      end
+
+      def xml_node_to_hash(node)
+        return node.content.to_s.strip unless node.element?
+
+        node_type = xml_node_type(node)
+        if node.children.size == 1 && node.children[0].text?
+          return [] if node_type == 'array'
+          return xml_node_value(node)
+        end
+
+        if node.name == 'errors'
+          return node.children.collect do |child|
+            error_xml_node_to_hash(child) if child.name == 'error'
+          end.reject { |n| n.nil? }
+        elsif node_type == 'array'
+          return node.children.collect do |child|
+            xml_node_to_hash(child)
+          end
+        end
+        
+        return nil if node.children.empty?
+
+        result_hash = {}
+        result_hash['type'] = node_type unless node_type.nil?
+
+        node.children.each do |child|
+          child_name = child.name
+          result = xml_node_to_hash(child)
+
+          next if child_name == 'text' && result == ''
+
+          if result_hash[child_name]
+            next if result == ''
+            if result_hash[child_name].is_a?(Array)
+              result_hash[child_name] << result
+            else
+              result_hash[child_name] = [result_hash[child_name]] << result
+            end
+          else
+            result_hash[child_name] = result
+          end
+        end
+
+        result_hash
+      end
+      
+      def error_xml_node_to_hash(node)
+        xml_attributes(node).merge('message' => node.children[0].content.to_s)
+      end
+
+      def xml_node_value(node)
+        return nil if xml_node_nil?(node)
+
+        case xml_node_type(node)
+        when 'integer'
+          node.content.to_i
+        when 'boolean'
+          ['true','1'].include?(node.content.downcase)
+        when 'datetime'
+          Time.parse(node.content)
+        else
+          node.content.to_s.strip
+        end
+      end
+
+      def xml_node_nil?(node)
+        return true if node.nil?
+        attr_node = node.attribute('nil')
+        attr_node.nil? ? false : true
+      end
+      
+      def xml_node_type(node)
+        attr_node = node.attribute('type')
+        attr_node.nil? ? nil : attr_node.value
+      end
+      
+      def xml_attributes(node)
+        return nil if node.attribute_nodes.empty?
+        values = {}
+        node.attribute_nodes.each do |attribute|
+          values[attribute.name] = attribute.value
+        end
+        values
+      end
+
+      # convert the data into a paginated resultset (array with singleton methods)
+      def paginate_data(data)
+        per_page = data["per_page"] || 0
+        current_page = data["current_page"] || 0
+        total_entries = data["total_entries"] || 0
+
+        # find the first array and use that as the resultset (lame workaround)
+        results = data.values.select{|v| v.is_a?(Array)}.first || []
+        if results.empty?
+          data.delete("per_page")
+          data.delete("current_page")
+          data.delete("total_entries")
+          data.delete("type")
+          results = [data.values.first].compact
+        end
+
+        # define total_entries accessor on result object
+        results.instance_eval "def total_entries; #{total_entries.to_i}; end"
+
+        # define current_page accessor on result object
+        results.instance_eval "def current_page; #{current_page.to_i}; end"
+
+        # define per_page accessor on result object
+        results.instance_eval "def per_page; #{per_page.to_i}; end"
+
+        results
+      end
+    end
+  end
+end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly #:nodoc
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/spec/config/recurly.yml

@@ -1,8 +1,8 @@
 ---
-username: api-test-123@litle.com
-password: 82a98ee0c1c2495789775177babfadb7 
-private_key: 986bfa2bec61479ca560dbaaec345820
-subdomain: litle-test
+username: api-test@hello-test.com
+password: 50a5b8a69a2545db84ac4112ba8cac6f 
+private_key: 54922a65b9ba4d49a486de7f0b2057c3
+subdomain: hello-test
 environment: :development
 
 #username: api-test@isaactest.com

data/spec/integration/transaction_spec.rb

@@ -65,8 +65,8 @@ module Recurly
         end
 
         it "should be in void state" do
-          @transactions.first.amount_in_cents.should == 100
-          @transactions.first.status.should == 'void'
+          @transactions.first.amount_in_cents.should == 0
+          @transactions.first.status.should == 'success'
         end
       end
 
@@ -84,7 +84,8 @@ module Recurly
         end
 
         it "should return a list of transactions made on the account" do
-          @successful_transactions.length.should == 3
+          # one authorization and three transactions
+          @successful_transactions.length.should == 4
           @total_transactions.length.should == 4
         end
 

data/spec/vcr/account/accept-language-account/1297746103.yml

@@ -2,7 +2,7 @@
 - !ruby/struct:VCR::HTTPInteraction 
   request: !ruby/struct:VCR::Request 
     method: :post
-    uri: http://api-test-123%40litle.com:82a98ee0c1c2495789775177babfadb7@app.recurly.local:3000/accounts.xml
+    uri: http://api-test%40hello-test.com:50a5b8a69a2545db84ac4112ba8cac6f@app.recurly.local:3000/accounts.xml
     body: |
       <?xml version="1.0" encoding="UTF-8"?>
       <account>
@@ -20,7 +20,7 @@
 
     headers: 
       authorization: 
-      - Basic YXBpLXRlc3QtMTIzQGxpdGxlLmNvbTo4MmE5OGVlMGMxYzI0OTU3ODk3NzUxNzdiYWJmYWRiNw==
+      - Basic YXBpLXRlc3RAaGVsbG8tdGVzdC5jb206NTBhNWI4YTY5YTI1NDVkYjg0YWM0MTEyYmE4Y2FjNmY=
       content-type: 
       - application/xml
       accept: 
@@ -39,13 +39,13 @@
       location: 
       - http://app.recurly.local:3000/accounts/account1-french-1297746103
       x-runtime: 
-      - "433"
+      - "340"
       content-type: 
       - application/xml; charset=utf-8
       content-length: 
       - "585"
       set-cookie: 
-      - _recurly_session=2646fb7dc231fbc50507e35872ded86d; domain=.recurly.local; path=/; HttpOnly
+      - _recurly_session=f0053268a5a52285db50fb2ac850bbb6; domain=.recurly.local; path=/; HttpOnly
       connection: 
       - close
       server: 
@@ -62,8 +62,8 @@
         <company_name>Recurly Ruby Gem</company_name>
         <balance_in_cents type="integer">0</balance_in_cents>
         <closed type="boolean">false</closed>
-        <hosted_login_token>e38a18fa5fd94ef4a2df36503bc62111</hosted_login_token>
-        <created_at type="datetime">2011-03-18T18:47:35Z</created_at>
+        <hosted_login_token>7528d672c9194529b738db26528b8f81</hosted_login_token>
+        <created_at type="datetime">2011-04-04T02:17:56Z</created_at>
         <state>active</state>
       </account>
 

data/spec/vcr/account/close/1297746103.yml

@@ -2,7 +2,7 @@
 - !ruby/struct:VCR::HTTPInteraction 
   request: !ruby/struct:VCR::Request 
     method: :post
-    uri: http://api-test-123%40litle.com:82a98ee0c1c2495789775177babfadb7@app.recurly.local:3000/accounts.xml
+    uri: http://api-test%40hello-test.com:50a5b8a69a2545db84ac4112ba8cac6f@app.recurly.local:3000/accounts.xml
     body: |
       <?xml version="1.0" encoding="UTF-8"?>
       <account>
@@ -20,7 +20,7 @@
 
     headers: 
       authorization: 
-      - Basic YXBpLXRlc3QtMTIzQGxpdGxlLmNvbTo4MmE5OGVlMGMxYzI0OTU3ODk3NzUxNzdiYWJmYWRiNw==
+      - Basic YXBpLXRlc3RAaGVsbG8tdGVzdC5jb206NTBhNWI4YTY5YTI1NDVkYjg0YWM0MTEyYmE4Y2FjNmY=
       content-type: 
       - application/xml
       accept: 
@@ -39,13 +39,13 @@
       location: 
       - http://app.recurly.local:3000/accounts/account-close-1297746103
       x-runtime: 
-      - "347"
+      - "330"
       content-type: 
       - application/xml; charset=utf-8
       content-length: 
       - "581"
       set-cookie: 
-      - _recurly_session=feaecccc5b88d662541ee1e1c65c0b66; domain=.recurly.local; path=/; HttpOnly
+      - _recurly_session=9225b6b1bc4bc9e4c294a37a04543860; domain=.recurly.local; path=/; HttpOnly
       connection: 
       - close
       server: 
@@ -62,8 +62,8 @@
         <company_name>Recurly Ruby Gem</company_name>
         <balance_in_cents type="integer">0</balance_in_cents>
         <closed type="boolean">false</closed>
-        <hosted_login_token>1c795d69f9e5437883fd99cc5a915d19</hosted_login_token>
-        <created_at type="datetime">2011-03-18T18:47:23Z</created_at>
+        <hosted_login_token>43d53db8bae74f36bfcef0fad8ff4499</hosted_login_token>
+        <created_at type="datetime">2011-04-04T02:17:42Z</created_at>
         <state>active</state>
       </account>
 
@@ -71,11 +71,11 @@
 - !ruby/struct:VCR::HTTPInteraction 
   request: !ruby/struct:VCR::Request 
     method: :delete
-    uri: http://api-test-123%40litle.com:82a98ee0c1c2495789775177babfadb7@app.recurly.local:3000/accounts/account-close-1297746103.xml
+    uri: http://api-test%40hello-test.com:50a5b8a69a2545db84ac4112ba8cac6f@app.recurly.local:3000/accounts/account-close-1297746103.xml
     body: 
     headers: 
       authorization: 
-      - Basic YXBpLXRlc3QtMTIzQGxpdGxlLmNvbTo4MmE5OGVlMGMxYzI0OTU3ODk3NzUxNzdiYWJmYWRiNw==
+      - Basic YXBpLXRlc3RAaGVsbG8tdGVzdC5jb206NTBhNWI4YTY5YTI1NDVkYjg0YWM0MTEyYmE4Y2FjNmY=
       accept: 
       - application/xml
       user-agent: 
@@ -90,13 +90,13 @@
       cache-control: 
       - no-cache
       x-runtime: 
-      - "481"
+      - "574"
       content-type: 
       - application/xml; charset=utf-8
       content-length: 
       - "1"
       set-cookie: 
-      - _recurly_session=217d1e05f1a8ea27ddfd1f6dc856d77b; domain=.recurly.local; path=/; HttpOnly
+      - _recurly_session=a9dd2fed298913d0bf1a222c6eb3f3e7; domain=.recurly.local; path=/; HttpOnly
       connection: 
       - close
       server: 
@@ -106,11 +106,11 @@
 - !ruby/struct:VCR::HTTPInteraction 
   request: !ruby/struct:VCR::Request 
     method: :get
-    uri: http://api-test-123%40litle.com:82a98ee0c1c2495789775177babfadb7@app.recurly.local:3000/accounts/account-close-1297746103.xml
+    uri: http://api-test%40hello-test.com:50a5b8a69a2545db84ac4112ba8cac6f@app.recurly.local:3000/accounts/account-close-1297746103.xml
     body: 
     headers: 
       authorization: 
-      - Basic YXBpLXRlc3QtMTIzQGxpdGxlLmNvbTo4MmE5OGVlMGMxYzI0OTU3ODk3NzUxNzdiYWJmYWRiNw==
+      - Basic YXBpLXRlc3RAaGVsbG8tdGVzdC5jb206NTBhNWI4YTY5YTI1NDVkYjg0YWM0MTEyYmE4Y2FjNmY=
       accept: 
       - application/xml
       accept-encoding: 
@@ -125,17 +125,17 @@
       message: OK
     headers: 
       x-runtime: 
-      - "293"
+      - "291"
       content-type: 
       - application/xml; charset=utf-8
       etag: 
-      - "\"2a99494260c548f181eba47d258df6c2\""
+      - "\"507894927f1390fd5c54ee01dad7cb82\""
       cache-control: 
       - private, max-age=0, must-revalidate
       content-length: 
       - "580"
       set-cookie: 
-      - _recurly_session=d093e4e66b3ca4d1dde043580ada11c2; domain=.recurly.local; path=/; HttpOnly
+      - _recurly_session=5881daad994bb5da5746c645afc5d914; domain=.recurly.local; path=/; HttpOnly
       connection: 
       - close
       server: 
@@ -152,8 +152,8 @@
         <company_name>Recurly Ruby Gem</company_name>
         <balance_in_cents type="integer">0</balance_in_cents>
         <closed type="boolean">true</closed>
-        <hosted_login_token>1c795d69f9e5437883fd99cc5a915d19</hosted_login_token>
-        <created_at type="datetime">2011-03-18T18:47:23Z</created_at>
+        <hosted_login_token>43d53db8bae74f36bfcef0fad8ff4499</hosted_login_token>
+        <created_at type="datetime">2011-04-04T02:17:42Z</created_at>
         <state>closed</state>
       </account>