recurly 0.4.16 → 2.0.0

data/lib/recurly/transaction.rb

@@ -1,68 +1,80 @@
 module Recurly
-  class Transaction < Base
-    self.element_name = "transaction"
+  class Transaction < Resource
+    require 'recurly/transaction/errors'
 
-    def self.known_attributes
-      [
-        "description",
-        "amount_in_cents",
-        "account_code",
-        "type",
-        "action",
-        "date",
-        "status",
-        "message",
-        "reference",
-        "ccv_result",
-        "avs_result",
-        "avs_result_street",
-        "avs_result_postal",
-        "test",
-        "voidable",
-        "refundable"
-      ]
-    end
+    # @macro [attach] scope
+    #   @scope class
+    #   @return [Pager] a pager that yields +$1+ transactions.
+    scope :authorizations, :type  => 'authorization'
+    scope :purchases,      :type  => 'purchase'
+    scope :refunds,        :type  => 'refund'
 
-    # initialize fields with blank data
-    def initialize(attributes = {}, persisted = false)
-      # initialize embedded attributes
-      attributes = attributes.with_indifferent_access
-      attributes[:account] ||= {}
-      super
-    end
+    scope :successful,     :state => 'successful'
+    scope :failed,         :state => 'failed'
+    scope :voided,         :state => 'voided'
 
-    def self.list(status = :all)
+    # @return [Account]
+    belongs_to :account
 
-      options = {}
-      if status != :all
-        options[:params] = {:show => status.to_s}
-      end
-
-      find(:all, options)
-    end
+    define_attribute_methods %w(
+      uuid
+      action
+      amount_in_cents
+      tax_in_cents
+      currency
+      status
+      reference
+      recurring
+      test
+      voidable
+      refundable
+      cvv_result
+      avs_result
+      avs_result_street
+      created_at
+      details
+    )
+    alias to_param uuid
 
-    def self.list_for_account(account_code, status = :all)
-      results = find(:all, :from => "/accounts/#{CGI::escape(account_code.to_s)}/transactions")
+    # @return ["credit", "charge", nil] The type of transaction.
+    attr_reader :type
 
-      # filter by status
-      if status != :all
-        results = results.select{|t| t.status == status.to_s }
-      end
-
-      results
+    # @see Resource#initialize
+    def initialize attributes = {}
+      super({ :currency => Recurly.default_currency }.merge attributes)
     end
 
-    def self.lookup(account_code, id)
-      find(id, :params => { :account_code => account_code })
+    # Saves new records only.
+    #
+    # @return [true, false]
+    # @raise [Recurly::Error] For persisted transactions.
+    # @see Resource#save
+    def save
+      return super if new_record?
+      raise Recurly::Error, "#{self.class.collection_name} cannot be updated"
     end
 
-    def void
-      connection.delete(element_path(:action => "void"), self.class.headers)
+    # Refunds the transaction.
+    #
+    # @return [Transaction, false] The refund when successful, false otherwise.
+    # @raise [Error] If the refund fails.
+    # @param amount_in_cents [Integer, nil] The amount (in cents) to refund
+    #   (refunds fully if nil).
+    # @see Transaction#void
+    def refund amount_in_cents = nil
+      return false unless self[:refund]
+      self.class.from_response(
+        self[:refund].call :params => { :amount_in_cents => amount_in_cents }
+      )
     end
 
-    def refund(amount_in_cents)
-      connection.delete(element_path(:action => "refund", :amount_in_cents => amount_in_cents), self.class.headers)
+    # @return [String]
+    def inspect
+      attributes = self.class.attribute_names
+      unless type == 'credit_card'
+        attributes -= %w(cvv_result avs_result avs_result_street)
+      end
+      super attributes
     end
-
   end
-end
+end

data/lib/recurly/transaction/errors.rb

@@ -0,0 +1,98 @@
+module Recurly
+  class Transaction < Resource
+    # The base error class for transaction errors, raised when a transaction
+    # fails.
+    #
+    # Error messages are customer-friendly, though only {DeclinedError}
+    # messages should be a part of the normal API flow (a {ConfigurationError},
+    # for example, is a problem that a customer cannot solve and requires your
+    # attention).
+    #
+    # If a record of the transaction was stored in Recurly, it will be
+    # accessible via {Error#transaction}.
+    #
+    # @example
+    #   begin
+    #     subscription.save!
+    #   rescue Recurly::Resource::Invalid => e
+    #     # Display e.record.errors...
+    #   rescue Recurly::Transaction::DeclinedError => e
+    #     # Display e.message and/or subscription (and associated) errors...
+    #   rescue Recurly::Transaction::RetryableError => e
+    #     # You should be able to attempt to save this again later.
+    #   rescue Recurly::Transaction::Error => e
+    #     # Alert yourself of the issue (i.e., log e.transaction).
+    #     # Display a generic error message.
+    #   end
+    class Error < API::UnprocessableEntity
+      # @return [Transaction] The transaction as returned (or updated) by
+      #   Recurly.
+      attr_reader :transaction
+
+      def initialize request, response, transaction
+        super request, response
+        update_transaction transaction
+      end
+
+      # @return [String] A customer-friendly error message.
+      def to_s
+        xml.text '/errors/transaction_error/customer_message'
+      end
+
+      private
+
+      def update_transaction transaction
+        return unless transaction_xml = xml['/errors/transaction']
+
+        @transaction = transaction
+        transaction = Transaction.from_xml transaction_xml
+        if @transaction.nil?
+          @transaction = transaction
+        else
+          @transaction.instance_variable_get(:@attributes).update(
+            transaction.attributes
+          )
+        end
+        @transaction.persist!
+      end
+    end
+
+    # Raised when a transaction fails for a temporary reason. The transaction
+    # should be retried later.
+    class RetryableError < Error
+    end
+
+    # Raised when a transaction fails due to a misconfiguration, e.g. if the
+    # gateway hasn't been configured.
+    class ConfigurationError < Error
+    end
+
+    # Raised when a transaction fails because the billing information was
+    # invalid.
+    class DeclinedError < Error
+    end
+
+    # Raised when the gateway believes this transaction to be a duplicate.
+    class DuplicateError < DeclinedError
+    end
+
+    class << Error
+      CATEGORY_MAP = Hash.new DeclinedError
+      CATEGORY_MAP.update(
+        'communication' => RetryableError,
+        'configuration' => ConfigurationError,
+        'duplicate'     => DuplicateError
+      )
+
+      def validate! exception, transaction
+        return unless exception.is_a? API::UnprocessableEntity
+
+        category = exception.send(:xml).text(
+          '/errors/transaction_error/error_category'
+        ) and raise CATEGORY_MAP[category].new(
+          exception.request, exception.response, transaction
+        )
+      end
+    end
+  end
+end

data/lib/recurly/version.rb

@@ -1,3 +1,17 @@
-module Recurly #:nodoc
-  VERSION = "0.4.16"
+module Recurly
+  module Version
+    MAJOR   = 2
+    MINOR   = 0
+    PATCH   = 0
+    PRE     = nil
+
+    VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join('.').freeze
+
+    class << self
+      def inspect
+        VERSION.dup
+      end
+      alias to_s inspect
+    end
+  end
 end

data/lib/recurly/xml.rb

@@ -0,0 +1,85 @@
+module Recurly
+  class XML
+    class << self
+      def cast el
+        return if el.attribute 'nil'
+
+        if el.attribute 'type'
+          type = el.attribute('type').value
+        end
+
+        case type
+          when 'array'    then el.elements.map { |e| { e.name => XML.cast(e) } }
+          when 'boolean'  then el.text == 'true'
+          when 'date'     then Date.parse el.text
+          when 'datetime' then DateTime.parse el.text
+          when 'float'    then el.text.to_f
+          when 'integer'  then el.text.to_i
+        else
+          # FIXME: Move some of this logic to Resource.from_xml?
+          if type and resource_name = Helper.classify(type)
+            if Recurly.const_defined? resource_name
+              resource_class = Recurly.const_get(Helper.classify(type))
+              return resource_class.new resource_class.from_xml(el)
+            end
+          end
+          if el.elements.empty?
+            el.text
+          else
+            Hash[el.elements.map { |e| [e.name, XML.cast(e)] }]
+          end
+        end
+      end
+
+      def filter text
+        xml = XML.new text
+        xml.each do |el|
+          el = XML.new el
+          case el.name
+          when /number/
+            text = el.text
+            last = text[-4, 4]
+            el.text = "#{text[0, text.length - 4].gsub(/\d/, '*')}#{last}"
+          when /verification_value/
+            el.text = el.text.gsub(/\d/, '*')
+          end
+        end
+        xml.to_s
+      end
+    end
+
+    attr_reader :root
+
+    def initialize xml
+      @root = xml.is_a?(String) ? super : xml
+    end
+
+    # Adds an element to the root.
+    def add_element name, value = nil
+      value = value.respond_to?(:xmlschema) ? value.xmlschema : value.to_s
+      XML.new super(name, value)
+    end
+
+    # Iterates over the root's elements.
+    def each_element xpath = nil
+      return enum_for :each_element unless block_given?
+      super
+    end
+
+    # Returns the root's name.
+    def name
+      super
+    end
+
+    # Returns an XML string.
+    def to_s
+      super
+    end
+  end
+end
+
+if defined? Nokogiri
+  require 'recurly/xml/nokogiri'
+else
+  require 'recurly/xml/rexml'
+end

data/lib/recurly/xml/nokogiri.rb

@@ -0,0 +1,49 @@
+module Recurly
+  class XML
+    module NokogiriAdapter
+      def initialize xml
+        @root = Nokogiri(xml).root
+      end
+
+      def add_element name, value = nil
+        root.add_child(node = ::Nokogiri::XML::Element.new(name, root))
+        node << value if value
+        node
+      end
+
+      def each_element xpath = nil
+        elements = xpath.nil? ? root.children : root.xpath(xpath)
+        elements.each { |el| yield el }
+      end
+
+      def each element = root
+        element.elements.each do |el|
+          yield el
+          each el, &Proc.new
+        end
+      end
+
+      def name
+        root.name
+      end
+
+      def [] xpath
+        root.at_xpath xpath
+      end
+
+      def text xpath = nil
+        node = root.at_xpath(xpath) and node.text
+      end
+
+      def text= text
+        root.content = text
+      end
+
+      def to_s
+        root.to_xml(:indent => 0).gsub(/$\n/, '')
+      end
+    end
+
+    include NokogiriAdapter
+  end
+end

data/lib/recurly/xml/rexml.rb

@@ -0,0 +1,50 @@
+require 'rexml/document'
+
+module Recurly
+  class XML
+    module REXMLAdapter
+      def initialize xml
+        @root = ::REXML::Document.new(xml).root
+      end
+
+      def add_element name, value = nil
+        node = root.add_element name
+        node.text = value if value
+        node
+      end
+
+      def each_element xpath = nil
+        root.each_element(xpath) { |el| yield el }
+      end
+
+      def each element = root
+        element.each_element do |el|
+          yield el
+          each el, &Proc.new
+        end
+      end
+
+      def name
+        root.name
+      end
+
+      def [] xpath
+        root.get_elements(xpath).first
+      end
+
+      def text xpath = nil
+        text = root.get_text(xpath) and text.to_s
+      end
+
+      def text= text
+        root.text = text
+      end
+
+      def to_s
+        root.to_s
+      end
+    end
+
+    include REXMLAdapter
+  end
+end

metadata

@@ -1,198 +1,137 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 0.4.16
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
-- Isaac Hall
-- Jacques Crocker
+- Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2011-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activeresource
-  requirement: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &70168118224900 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
+        version: 0.9.2
+  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.3'
+  version_requirements: *70168118224900
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  name: bundler
+  requirement: &70168118239400 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
+        version: 1.1.pre.10
+  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.3'
+  version_requirements: *70168118239400
 - !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
+  name: minitest
+  requirement: &70168118236700 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
+        version: 2.6.1
+  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.2'
+  version_requirements: *70168118236700
 - !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
+  name: webmock
+  requirement: &70168118235440 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :runtime
+        version: 1.7.6
+  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.4'
+  version_requirements: *70168118235440
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  name: guard-minitest
+  requirement: &70168118234400 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta.22
+        version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0.beta.22
+  version_requirements: *70168118234400
 - !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
+  name: rb-fsevent
+  requirement: &70168118232720 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.3.1
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70168118232720
 - !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
+  name: growl_notify
+  requirement: &70168122344800 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A Ruby API wrapper for Recurly. Super Simple Subscription billing.
-email:
-- support@recurly.com
-executables: []
+  version_requirements: *70168122344800
+description: ! 'An API client library for Recurly: http://recurly.com'
+email: support@recurly.com
+executables:
+- recurly
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.markdown
 files:
-- lib/patches/rails2/active_resource/base.rb
-- lib/patches/rails2/active_resource/connection.rb
-- lib/patches/rails3/active_model/serializers/xml.rb
-- lib/patches/rails3/active_resource/connection.rb
+- lib/rails/generators/recurly/config_generator.rb
+- lib/rails/recurly.rb
 - lib/recurly/account.rb
-- lib/recurly/account_base.rb
-- lib/recurly/base.rb
+- lib/recurly/add_on.rb
+- lib/recurly/adjustment.rb
+- lib/recurly/api/errors.rb
+- lib/recurly/api/net_http.rb
+- lib/recurly/api.rb
 - lib/recurly/billing_info.rb
-- lib/recurly/charge.rb
-- lib/recurly/config_parser.rb
 - lib/recurly/coupon.rb
-- lib/recurly/credit.rb
-- lib/recurly/exceptions.rb
-- lib/recurly/formats/xml_with_errors.rb
-- lib/recurly/formats/xml_with_pagination.rb
+- lib/recurly/helper.rb
 - lib/recurly/invoice.rb
+- lib/recurly/js.rb
+- lib/recurly/money.rb
 - lib/recurly/plan.rb
-- lib/recurly/rails2/compatibility.rb
-- lib/recurly/rails3/railtie.rb
-- lib/recurly/rails3/recurly.rake
+- lib/recurly/redemption.rb
+- lib/recurly/resource/pager.rb
+- lib/recurly/resource.rb
+- lib/recurly/subscription/add_ons.rb
 - lib/recurly/subscription.rb
+- lib/recurly/transaction/errors.rb
 - lib/recurly/transaction.rb
-- lib/recurly/transparent.rb
-- lib/recurly/verification.rb
 - lib/recurly/version.rb
+- lib/recurly/xml/nokogiri.rb
+- lib/recurly/xml/rexml.rb
+- lib/recurly/xml.rb
 - lib/recurly.rb
-- init.rb
-- LICENSE
-- README.md
-- spec/config/recurly.yml
-- spec/config/test1.yml
-- spec/config/test2.yml
-- spec/integration/account_spec.rb
-- spec/integration/add_on_spec.rb
-- spec/integration/billing_info_spec.rb
-- spec/integration/charge_spec.rb
-- spec/integration/coupon_spec.rb
-- spec/integration/credit_spec.rb
-- spec/integration/invoice_spec.rb
-- spec/integration/plan_spec.rb
-- spec/integration/subscription_spec.rb
-- spec/integration/transaction_spec.rb
-- spec/integration/transparent_spec.rb
-- spec/spec_helper.rb
-- spec/support/factory.rb
-- spec/support/vcr.rb
-- spec/unit/account_spec.rb
-- spec/unit/billing_info_spec.rb
-- spec/unit/charge_spec.rb
-- spec/unit/config_spec.rb
-- spec/unit/coupon_spec.rb
-- spec/unit/credit_spec.rb
-- spec/unit/plan_spec.rb
-- spec/unit/subscription_spec.rb
-- spec/unit/transaction_spec.rb
-- spec/unit/transparent_spec.rb
-- spec/unit/verification_spec.rb
+- README.markdown
+- bin/recurly
 homepage: http://github.com/recurly/recurly-client-ruby
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- --main
+- README.markdown
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -208,37 +147,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: recurly
-rubygems_version: 1.8.23
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Ruby API wrapper for Recurly
-test_files:
-- spec/config/recurly.yml
-- spec/config/test1.yml
-- spec/config/test2.yml
-- spec/integration/account_spec.rb
-- spec/integration/add_on_spec.rb
-- spec/integration/billing_info_spec.rb
-- spec/integration/charge_spec.rb
-- spec/integration/coupon_spec.rb
-- spec/integration/credit_spec.rb
-- spec/integration/invoice_spec.rb
-- spec/integration/plan_spec.rb
-- spec/integration/subscription_spec.rb
-- spec/integration/transaction_spec.rb
-- spec/integration/transparent_spec.rb
-- spec/spec_helper.rb
-- spec/support/factory.rb
-- spec/support/vcr.rb
-- spec/unit/account_spec.rb
-- spec/unit/billing_info_spec.rb
-- spec/unit/charge_spec.rb
-- spec/unit/config_spec.rb
-- spec/unit/coupon_spec.rb
-- spec/unit/credit_spec.rb
-- spec/unit/plan_spec.rb
-- spec/unit/subscription_spec.rb
-- spec/unit/transaction_spec.rb
-- spec/unit/transparent_spec.rb
-- spec/unit/verification_spec.rb
+summary: Recurly API Client
+test_files: []