recurly 2.1.5 → 2.1.7

data/README.markdown

@@ -1,6 +1,6 @@
-# Recurly
+# Recurly [![Build Status](https://secure.travis-ci.org/recurly/recurly-client-ruby.png)](http://travis-ci.org/recurly/recurly-client-ruby)
 
-<http://github.com/recurly/recurly-ruby-client>
+<https://github.com/recurly/recurly-client-ruby>
 
 [Recurly](http://recurly.com/)'s Ruby client library is an interface to its
 [REST API](http://docs.recurly.com/api/basics).
@@ -35,9 +35,8 @@ Recurly.api_key        = ENV['RECURLY_API_KEY']
 Recurly.js.private_key = ENV['RECURLY_JS_PRIVATE_KEY']
 ```
 
-Configure the client library with the credentials you find at
-`https://{subdomain}.recurly.com/developer/api_access` (replace `{subdomain}`
-with your Recurly subdomain).
+Configure the client library with
+[your API credentials](https://app.recurly.com/go/developer/api_access).
 
 The default currency is USD. To override with a different code:
 
@@ -97,12 +96,6 @@ To run the suite using Nokogiri:
 $ XML=nokogiri bundle exec rake
 ```
 
-Or, if [Guard](https://github.com/guard/guard) is more your speed:
-
-``` bash
-$ bundle exec guard
-```
-
 If you plan on submitting a patch, please write tests for it (we use
 [MiniTest::Spec](http://bfts.rubyforge.org/minitest/MiniTest/Expectations.html)).
 
@@ -114,7 +107,7 @@ your changes.
 
 (The MIT License.)
 
-© 2011 Recurly Inc.
+© 2009–2013 Recurly Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/ecurly.rb

@@ -0,0 +1 @@
+require 'recurly'

data/lib/recurly.rb

@@ -1,22 +1,23 @@
 # Recurly is a Ruby client for Recurly's REST API.
 module Recurly
-  autoload :Account,      'recurly/account'
-  autoload :AddOn,        'recurly/add_on'
-  autoload :Adjustment,   'recurly/adjustment'
-  autoload :API,          'recurly/api'
-  autoload :BillingInfo,  'recurly/billing_info'
-  autoload :Coupon,       'recurly/coupon'
-  autoload :Helper,       'recurly/helper'
-  autoload :Invoice,      'recurly/invoice'
-  autoload :JS,           'recurly/js'
-  autoload :Money,        'recurly/money'
-  autoload :Plan,         'recurly/plan'
-  autoload :Redemption,   'recurly/redemption'
-  autoload :Resource,     'recurly/resource'
-  autoload :Subscription, 'recurly/subscription'
-  autoload :Transaction,  'recurly/transaction'
-  autoload :Version,      'recurly/version'
-  autoload :XML,          'recurly/xml'
+  autoload :Account,           'recurly/account'
+  autoload :AddOn,             'recurly/add_on'
+  autoload :Adjustment,        'recurly/adjustment'
+  autoload :API,               'recurly/api'
+  autoload :BillingInfo,       'recurly/billing_info'
+  autoload :Coupon,            'recurly/coupon'
+  autoload :Helper,            'recurly/helper'
+  autoload :Invoice,           'recurly/invoice'
+  autoload :JS,                'recurly/js'
+  autoload :Money,             'recurly/money'
+  autoload :Plan,              'recurly/plan'
+  autoload :Redemption,        'recurly/redemption'
+  autoload :Resource,          'recurly/resource'
+  autoload :Subscription,      'recurly/subscription'
+  autoload :SubscriptionAddOn, 'recurly/subscription_add_on'
+  autoload :Transaction,       'recurly/transaction'
+  autoload :Version,           'recurly/version'
+  autoload :XML,               'recurly/xml'
 
   # The exception class from which all Recurly exceptions inherit.
   class Error < StandardError

data/lib/recurly/add_on.rb

@@ -12,6 +12,7 @@ module Recurly
       created_at
     )
     alias to_param add_on_code
+    alias quantity default_quantity
 
     # Add-ons are only writeable and readable through {Plan} instances.
     embedded!

data/lib/recurly/invoice.rb

@@ -16,6 +16,9 @@ module Recurly
     # @return [Account]
     belongs_to :account
 
+    # @return [Redemption]
+    has_one :redemption
+
     define_attribute_methods %w(
       uuid
       state
@@ -53,7 +56,7 @@ module Recurly
     end
 
     def pdf
-      find to_param, :format => 'pdf'
+      self.class.find to_param, :format => 'pdf'
     end
 
     private

data/lib/recurly/js.rb

@@ -1,5 +1,6 @@
 require 'openssl'
 require 'base64'
+require 'cgi'
 
 module Recurly
   # A collection of helper methods to use to verify

data/lib/recurly/money.rb

@@ -14,15 +14,28 @@ module Recurly
     #   Recurly.default_currency = 'USD'
     #   Recurly::Money.new(49_00) # => #<Recurly::Money USD: 49_00>
     def initialize currencies = {}
-      @currencies = Helper.hash_with_indifferent_read_access
+      @currencies = {}
 
       if currencies.respond_to? :each_pair
-        currencies.each_pair { |key, value| @currencies[key.to_s] = value }
+        currencies.each_pair { |key, value| self[key] = value }
+      elsif Recurly.default_currency
+        self[Recurly.default_currency] = currencies
       else
-        @currencies[Recurly.default_currency] = currencies
+        message = 'expected a Hash'
+        message << ' or Numeric' if Recurly.default_currency
+        message << " but received #{currencies.class}"
+        raise ArgumentError, message
       end
     end
 
+    def [] code
+      currencies[code.to_s]
+    end
+
+    def []= code, amount
+      currencies[code.to_s] = amount
+    end
+
     # @return [Hash] A hash of currency codes to amounts.
     def to_hash
       currencies.dup

data/lib/recurly/redemption.rb

@@ -16,6 +16,7 @@ module Recurly
       single_use
       total_discounted_in_cents
       currency
+      state
       created_at
     )
 

data/lib/recurly/resource.rb

@@ -113,7 +113,8 @@ module Recurly
   #
   #   Account.find_each { |account| p account }
   class Resource
-    autoload :Pager, 'recurly/resource/pager'
+    autoload :Errors, 'recurly/resource/errors'
+    autoload :Pager,  'recurly/resource/pager'
 
     # Raised when a record cannot be found.
     #
@@ -256,6 +257,11 @@ module Recurly
         @scopes ||= Recurly::Helper.hash_with_indifferent_read_access
       end
 
+      # @return [Module] Module of scopes methods.
+      def scopes_helper
+        @scopes_helper ||= Module.new.tap { |helper| extend helper }
+      end
+
       # Defines a new resource scope.
       #
       # @return [Proc]
@@ -263,8 +269,7 @@ module Recurly
       # @param [Hash] params the scope params
       def scope name, params = {}
         scopes[name = name.to_s] = params
-        extend const_set :Scopes, Module.new unless const_defined? :Scopes
-        self::Scopes.send(:define_method, name) { paginate scopes[name] }
+        scopes_helper.send(:define_method, name) { paginate scopes[name] }
       end
 
       # Iterates through every record by automatically paging.
@@ -367,7 +372,7 @@ module Recurly
       # @see from_response
       def from_xml xml
         xml = XML.new xml
-        if xml.name == member_name
+        if self != Resource || xml.name == member_name
           record = new
         elsif Recurly.const_defined?(
           class_name = Helper.classify(xml.name), false
@@ -426,13 +431,13 @@ module Recurly
 
       # @return [Hash] A list of association names for the current class.
       def associations
-        @associations ||= begin
-          unless constants.include? :Associations
-            include const_set :Associations, Module.new
-          end
+        @associations ||= {
+          :has_many => [], :has_one => [], :belongs_to => []
+        }
+      end
 
-          { :has_many => [], :has_one => [], :belongs_to => [] }
-        end
+      def associations_helper
+        @associations_helper ||= Module.new.tap { |helper| include helper }
       end
 
       # Establishes a has_many association.
@@ -443,16 +448,16 @@ module Recurly
       # @option options [true, false] :readonly Don't define a setter.
       def has_many collection_name, options = {}
         associations[:has_many] << collection_name.to_s
-        self::Associations.module_eval {
-          define_method(collection_name) {
+        associations_helper.module_eval do
+          define_method collection_name do
             self[collection_name] ||= []
-          }
+          end
           if options.key?(:readonly) && options[:readonly] == false
-            define_method("#{collection_name}=") { |collection|
+            define_method "#{collection_name}=" do |collection|
               self[collection_name] = collection
-            }
+            end
           end
-        }
+        end
       end
 
       # Establishes a has_one association.
@@ -463,11 +468,11 @@ module Recurly
       # @option options [true, false] :readonly Don't define a setter.
       def has_one member_name, options = {}
         associations[:has_one] << member_name.to_s
-        self::Associations.module_eval {
+        associations_helper.module_eval do
           define_method(member_name) { self[member_name] }
           if options.key?(:readonly) && options[:readonly] == false
             associated = Recurly.const_get Helper.classify(member_name), false
-            define_method("#{member_name}=") { |member|
+            define_method "#{member_name}=" do |member|
               associated_uri = "#{path}/#{member_name}"
               self[member_name] = case member
               when Hash
@@ -477,18 +482,18 @@ module Recurly
               else
                 raise ArgumentError, "expected #{associated}"
               end
-            }
-            define_method("build_#{member_name}") { |*args|
+            end
+            define_method "build_#{member_name}" do |*args|
               attributes = args.shift || {}
               self[member_name] = associated.send(
                 :new, attributes.merge(:uri => "#{path}/#{member_name}")
               ).tap { |child| child.attributes[self.class.member_name] = self }
-            }
-            define_method("create_#{member_name}") { |*args|
+            end
+            define_method "create_#{member_name}" do |*args|
               send("build_#{member_name}", *args).tap { |child| child.save }
-            }
+            end
           end
-        }
+        end
       end
 
       # Establishes a belongs_to association.
@@ -496,14 +501,14 @@ module Recurly
       # @return [Proc]
       def belongs_to parent_name, options = {}
         associations[:belongs_to] << parent_name.to_s
-        self::Associations.module_eval {
+        associations_helper.module_eval do
           define_method(parent_name) { self[parent_name] }
           if options.key?(:readonly) && options[:readonly] == false
-            define_method("#{parent_name}=") { |parent|
+            define_method "#{parent_name}=" do |parent|
               self[parent_name] = parent
-            }
+            end
           end
-        }
+        end
       end
 
       # @return [:has_many, :has_one, :belongs_to, nil] An association type.
@@ -658,7 +663,7 @@ module Recurly
       if self.class.associations.values.flatten.include? key
         value = fetch_association key, value
       # FIXME: More explicit; less magic.
-      elsif key.end_with?('_in_cents') && !respond_to?(:currency)
+      elsif value && key.end_with?('_in_cents') && !respond_to?(:currency)
         value = Money.new value unless value.is_a? Money
       end
 
@@ -761,7 +766,7 @@ module Recurly
     #   account.valid? # => true
     def valid?
       return true if persisted? && changed_attributes.empty?
-      return if response.nil? || (errors.empty? && changed_attributes?)
+      return if errors.empty? && changed_attributes?
       errors.empty?
     end
 
@@ -799,7 +804,7 @@ module Recurly
     #   account.errors                # => {"account_code"=>["can't be blank"]}
     #   account.errors[:account_code] # => ["can't be blank"]
     def errors
-      @errors ||= Recurly::Helper.hash_with_indifferent_read_access
+      @errors ||= Errors.new
     end
 
     # Marks a record as persisted, i.e. not a new or deleted record, resetting

data/lib/recurly/resource/errors.rb

@@ -0,0 +1,20 @@
+module Recurly
+  class Resource
+    class Errors < Hash
+      def [] key
+        super key.to_s
+      end
+
+      def []= key, value
+        super key.to_s, value
+      end
+
+      def full_messages
+        map { |attribute, messages|
+          attribute_name = attribute.capitalize.gsub('_', ' ')
+          messages.map { |message| "#{attribute_name} #{message}." }
+        }.flatten
+      end
+    end
+  end
+end

data/lib/recurly/subscription.rb

@@ -75,7 +75,7 @@ module Recurly
 
     # @return [AddOns]
     def subscription_add_ons
-      AddOns.new self, super
+      self[:subscription_add_ons] ||= AddOns.new self, super
     end
     alias add_ons subscription_add_ons
 

data/lib/recurly/subscription/add_ons.rb

@@ -2,7 +2,7 @@ module Recurly
   class Subscription < Resource
     class AddOns
       instance_methods.each do |method|
-        undef_method method if method !~ /^__|^(object_id|respond_to\?|send)$/ 
+        undef_method method if method !~ /^__|^(object_id|respond_to\?|send)$/
       end
 
       # @param subscription [Subscription]
@@ -23,35 +23,37 @@ module Recurly
       #     {:add_on_code => "BONUS"}
       #   ]
       def << add_on
-        case add_on
-          when AddOn then add_on = { :add_on_code => add_on.add_on_code }
-          when String, Symbol then add_on = { :add_on_code => add_on.to_s }
-        end
-        add_on = Helper.hash_with_indifferent_read_access add_on
+        add_on = SubscriptionAddOn.new(add_on, @subscription)
 
-        exist = @add_ons.find { |a| a[:add_on_code] == add_on[:add_on_code] }
+        exist = @add_ons.find { |a| a.add_on_code == add_on.add_on_code }
         if exist
-          exist[:quantity] ||= 1 and exist[:quantity] += 1
+          exist.quantity ||= 1 and exist.quantity += 1
 
-          if add_on[:unit_amount_in_cents]
-            exist[:unit_amount_in_cents] = add_on[:unit_amount_in_cents]
+          if add_on.unit_amount_in_cents
+            exist.unit_amount_in_cents = add_on.unit_amount_in_cents
           end
         else
           @add_ons << add_on
         end
 
-        @subscription[:subscription_add_ons] = to_a and self
+        self
       end
 
       def to_a
         @add_ons.dup
       end
 
+      def errors
+        @add_ons.map { |add_on| add_on.errors }
+      end
+
       def to_xml options = {}
         builder = options[:builder] || XML.new('<subscription_add_ons/>')
         @add_ons.each do |add_on|
           node = builder.add_element 'subscription_add_on'
-          add_on.each_pair { |k, v| node.add_element k.to_s, v }
+          add_on.attributes.each_pair do |k, v|
+            node.add_element k.to_s, v if v
+          end
         end
         builder.to_s
       end

data/lib/recurly/subscription_add_on.rb

@@ -0,0 +1,36 @@
+module Recurly
+  class SubscriptionAddOn < Resource
+    define_attribute_methods %w(
+      add_on_code
+      quantity
+      unit_amount_in_cents
+    )
+
+    attr_reader :subscription
+
+    def initialize add_on = nil, subscription = nil
+      super()
+
+      case add_on
+      when AddOn, SubscriptionAddOn
+        self.add_on_code = add_on.add_on_code
+        self.quantity = add_on.quantity
+        if add_on.unit_amount_in_cents
+          self.unit_amount_in_cents = add_on.unit_amount_in_cents.to_i
+        end
+      when Hash
+        self.attributes = add_on
+      when String, Symbol
+        self.add_on_code = add_on
+      end
+
+      self.add_on_code = add_on_code.to_s
+
+      @subscription = subscription
+    end
+
+    def currency
+      subscription.currency if subscription
+    end
+  end
+end

data/lib/recurly/transaction.rb

@@ -37,6 +37,7 @@ module Recurly
       avs_result_street
       created_at
       details
+      transaction_error
     )
     alias to_param uuid
 
@@ -60,16 +61,18 @@ module Recurly
 
     # Refunds the transaction.
     #
-    # @return [Transaction, false] The refund when successful, false otherwise.
+    # @return [Transaction, false] The updated original transaction if voided,
+    #   a new refund transaction, false if the transaction isn't voidable or
+    #   refundable.
     # @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(
+      refund = self.class.from_response(
         self[:refund].call :params => { :amount_in_cents => amount_in_cents }
       )
+      refund.uuid == uuid ? copy_from(refund) && self : refund
     end
 
     def signable_attributes

data/lib/recurly/transaction/errors.rb

@@ -39,6 +39,11 @@ module Recurly
         xml.text '/errors/transaction_error/customer_message'
       end
 
+      # @return [String] The transaction error code.
+      def transaction_error_code
+        xml.text '/errors/transaction_error/error_code'
+      end
+
       private
 
       def update_transaction transaction

data/lib/recurly/version.rb

@@ -2,7 +2,7 @@ module Recurly
   module Version
     MAJOR   = 2
     MINOR   = 1
-    PATCH   = 5
+    PATCH   = 7
     PRE     = nil
 
     VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join('.').freeze

data/lib/recurly/xml.rb

@@ -17,9 +17,12 @@ module Recurly
           when 'integer'  then el.text.to_i
         else
           # FIXME: Move some of this logic to Resource.from_xml?
-          resource_name = Helper.classify el.name
-          if Recurly.const_defined? resource_name, false
-            return Recurly.const_get(resource_name, false).from_xml el
+          [el.name, type].each do |name|
+            next unless name
+            resource_name = Helper.classify name
+            if Recurly.const_defined? resource_name, false
+              return Recurly.const_get(resource_name, false).from_xml el
+            end
           end
           if el.elements.empty?
             el.text

data/lib/recurly/xml/nokogiri.rb

@@ -36,7 +36,7 @@ module Recurly
           if node.text?
             node.text
           else
-            node.children.each { |e| return e.text if e.text? }
+            node.children.map { |e| e.text if e.text? }.compact.join
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-30 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70247119507640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,62 +21,44 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70247119507640
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: &70247119507140 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.1
-  type: :development
-  prerelease: false
-  version_requirements: *70247119507140
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: &70247119506680 !ruby/object:Gem::Requirement
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.6
+        version: 2.6.1
   type: :development
   prerelease: false
-  version_requirements: *70247119506680
-- !ruby/object:Gem::Dependency
-  name: guard-minitest
-  requirement: &70247119506220 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :development
-  prerelease: false
-  version_requirements: *70247119506220
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: &70247119505760 !ruby/object:Gem::Requirement
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.3.1
+        version: 1.7.6
   type: :development
   prerelease: false
-  version_requirements: *70247119505760
-- !ruby/object:Gem::Dependency
-  name: growl_notify
-  requirement: &70247119505300 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :development
-  prerelease: false
-  version_requirements: *70247119505300
+        version: 1.7.6
 description: ! 'An API client library for Recurly: http://recurly.com'
 email: support@recurly.com
 executables:
@@ -85,6 +67,7 @@ extensions: []
 extra_rdoc_files:
 - README.markdown
 files:
+- lib/ecurly.rb
 - lib/rails/generators/recurly/config_generator.rb
 - lib/rails/recurly.rb
 - lib/recurly/account.rb
@@ -102,10 +85,12 @@ files:
 - lib/recurly/money.rb
 - lib/recurly/plan.rb
 - lib/recurly/redemption.rb
+- lib/recurly/resource/errors.rb
 - lib/recurly/resource/pager.rb
 - lib/recurly/resource.rb
 - lib/recurly/subscription/add_ons.rb
 - lib/recurly/subscription.rb
+- lib/recurly/subscription_add_on.rb
 - lib/recurly/transaction/errors.rb
 - lib/recurly/transaction.rb
 - lib/recurly/version.rb
@@ -114,9 +99,8 @@ files:
 - lib/recurly/xml.rb
 - lib/recurly.rb
 - README.markdown
-- !binary |-
-  YmluL3JlY3VybHk=
-homepage: http://github.com/recurly/recurly-client-ruby
+- bin/recurly
+homepage: https://github.com/recurly/recurly-client-ruby
 licenses:
 - MIT
 post_install_message: 
@@ -139,9 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Recurly API Client
 test_files: []
-has_rdoc: true