recurly 0.3.3 → 0.3.4

data/README.md

@@ -1,22 +1,20 @@
 Recurly Ruby Client
 ===================
 
-The Recurly Ruby Client library is an open source library to interact with Recurly's subscription management from your Ruby on Rails website. The library interacts with Recurly's [REST API](http://support.recurly.com/faqs/api).
+The Recurly Ruby Client library is an open source library to interact with Recurly's subscription management from your Ruby on Rails website. The library interacts with Recurly's [REST API](http://support.recurly.com/api/basics).
 
 
 Usage
 -----
 
 Please see the [documentation](http://support.recurly.com/faqs/api/ruby-client) and
-[support forums](http://support.recurly.com/discussions) for more information.
+[support forums](http://support.recurly.com/discussions) for more information. The [API Documentation](http://docs.recurly.com/api/basics) has numerous examples demonstrating how to use the Recurly Ruby client library.
 
 
 Installation
 ------------
 
-This library can be installed as a gem or a plugin. Your choice.
-
-**Rails3 Stable Version:**
+**Stable Version:**
 
     gem 'recurly'
 
@@ -28,7 +26,7 @@ This library can be installed as a gem or a plugin. Your choice.
 Setup (Rails 3)
 --------------
 
-The Recurly Ruby Client requires a username and password to connect.  We recommend creating a user just for your API.  Please see the [Authentication](http://support.recurly.com/faqs/api/authentication) documentation for more information.
+The Recurly Ruby Client requires an API user to connect. Please see the [Authentication](http://support.recurly.com/faqs/api/authentication) documentation for more information.
 
 If using Rails 3, the easiest way to get Recurly set up is to run `rake recurly:setup`. This will create a config/recurly.yml that has your recurly account authentication, and the Recurly rails initializer will pick it up on restart of your web app.
 
@@ -40,8 +38,10 @@ Alternatively, if not using Rails 3, just make sure to call a Recurly configure
 
     Recurly.configure do |c|
       c.username = 'api@yourcompany.com'
-      c.password = 'super_secret_password'
-      c.site = 'https://my-recurly-site.recurly.com'
+      c.password = 'your_api_key'
+      c.private_key = 'your_private_key'
+      c.environment = :production # or :sandbox for test sites
+      c.subdomain = 'your-recurly-subdomain'
     end
 
 In Rails 2.x, this code should be in config/initializers/recurly.rb
@@ -58,8 +58,10 @@ You can also configure Recurly via a YAML file by using:
 The Recurly Configuration YAML is in the format of:
 
     username: myrecurlyuser@domain.com
-    password: myrecurlypassword
-    site: https://myrecurlysite.recurly.com
+    password: your_api_key
+    private_key: your_private_key
+    environment: :production
+    subdomain: your_recurly_subdomain
 
 
 The same format could be applied in JSON instead of YAML using: Recurly.configure_from_json('path/to/file.json')
@@ -81,6 +83,8 @@ Rails Demo Application
 Examples
 --------
 
+The [API Documentation](http://docs.recurly.com/api/basics) has numerous examples demonstrating how to use the Ruby client library.
+
 All the functionality is demonstrated by the tests in the __spec__ directory.
 
 
@@ -124,4 +128,4 @@ This will run `recurly:clear_test_data` (using your spec/config/recurly.yml auth
 API Documentation
 -----------------
 
-Please see the [Recurly API](http://docs.recurly.com/api/basics) for more information.
+Please see the [Recurly API](http://docs.recurly.com/api/basics) for more information and examples.

data/lib/patches/active_resource/connection.rb

@@ -0,0 +1,10 @@
+module ActiveResource
+  class Connection
+
+    # Get the results without decoding
+    def get_raw(path, headers = {})
+      with_auth { request(:get, path, build_request_headers(headers, :get, self.site.merge(path))) }
+    end
+
+  end
+end

data/lib/recurly.rb

@@ -1,8 +1,13 @@
 require 'active_resource'
 require 'active_support/deprecation'
 require 'cgi'
+require 'openssl'
+require 'addressable/uri'
+
+require 'patches/active_resource/connection'
 
 require 'recurly/version'
+require 'recurly/exceptions'
 require 'recurly/formats/xml_with_pagination'
 require 'recurly/config_parser'
 require 'recurly/rails3/railtie' if defined?(::Rails::Railtie)
@@ -17,6 +22,7 @@ end
 module Recurly
 
   autoload :Account,        'recurly/account'
+  autoload :AccountBase,    'recurly/account_base'
   autoload :BillingInfo,    'recurly/billing_info'
   autoload :Charge,         'recurly/charge'
   autoload :Coupon,         'recurly/coupon'
@@ -25,9 +31,10 @@ module Recurly
   autoload :Plan,           'recurly/plan'
   autoload :Subscription,   'recurly/subscription'
   autoload :Transaction,    'recurly/transaction'
+  autoload :Transparent,    'recurly/transparent'
 
   class << self
-    attr_accessor :username, :password, :site
+    attr_accessor :username, :password, :environment, :subdomain, :private_key
 
     # default Recurly.settings_path to config/recurly.yml
     unless respond_to?(:settings_path)
@@ -41,16 +48,16 @@ module Recurly
     end
 
     def configured?
-      RecurlyBase.user && RecurlyBase.password && RecurlyBase.site
+      Base.user && Base.password && Base.site
     end
 
     def configure
       if block_given?
         yield self
 
-        RecurlyBase.user = username
-        RecurlyBase.password = password
-        RecurlyBase.site = site || "https://app.recurly.com"
+        Base.user = username
+        Base.password = password
+        Base.site = site_for_environment(environment)
 
         return true
       else
@@ -61,9 +68,24 @@ module Recurly
         end
       end
     end
+    
+    def site_for_environment(environment)
+      environment = :production if environment.nil? # Default to production
+      case environment.to_sym
+      when :development
+        "http://app.recurly.local:3000"
+      when :production
+        "https://api-production.recurly.com"
+      when :sandbox
+        "https://api-sandbox.recurly.com"
+      else
+        raise Recurly::ConfigurationError.new("Invalid environment (#{environment}). Valid values are: :production, :sandbox.")
+      end
+    end
+
 
     # allows configuration from a yml file that contains the fields:
-    # username,password,site
+    # username,password,site,private_key
     def configure_from_yaml(path = nil)
       configure do |c|
         # parse configuration from yml
@@ -78,19 +100,23 @@ module Recurly
 
           c.username = recurly_config["username"]
           c.password = recurly_config["password"]
-          c.site = recurly_config["site"]
+          c.subdomain = recurly_config["subdomain"]
+          c.private_key = recurly_config["private_key"]
+          c.environment = recurly_config["environment"]
         end
       end
     end
 
     # allows configuration from a json string that contains the fields:
-    # username,password,site
+    # username,password,site,private_key
     def configure_from_json(json_string)
       config_data = ActiveSupport::JSON.decode(json_string)
       configure do |c|
         c.username = config_data['username']
         c.password = config_data['password']
-        c.site = config_data['site']
+        c.subdomain = config_data['subdomain']
+        c.private_key = config_data['private_key']
+        c.environment = config_data['environment']
       end
     end
 

data/lib/recurly/account.rb

@@ -1,8 +1,29 @@
 module Recurly
-  class Account < RecurlyBase
+  class Account < Base
     self.element_name = "account"
     self.primary_key = :account_code
 
+    # known attributes for a recurly account
+    def self.known_attributes
+      [
+        "account_code",
+        "username",
+        "first_name",
+        "last_name",
+        "email",
+        "company_name",
+        "hosted_login_token",
+        "accept_language"
+      ]
+    end
+
+    # initialize associations
+    def initialize(attributes = {})
+      attributes = attributes.with_indifferent_access
+      attributes[:billing_info] ||= {}
+      super(attributes)
+    end
+
     attr_accessor :account_code_was
     def account_code=(new_account_code)
       self.account_code_was = self.account_code

data/lib/recurly/account_base.rb

@@ -0,0 +1,35 @@
+
+module Recurly
+  # ActiveRecord treats resources as plural by default.  Some resources are singular.
+  class AccountBase < Base
+    self.prefix = "/accounts/:account_code/"
+
+    # Override element_path because this is a singular resource
+    def self.element_path(id, prefix_options = {}, query_options = nil)
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      prefix_options.merge!(:account_code => id) if id
+      # original: "#{prefix(prefix_options)}#{collection_name}/#{URI.escape id.to_s}.#{format.extension}#{query_string(query_options)}"
+      "#{prefix(prefix_options)}#{element_name}.#{format.extension}#{query_string(query_options)}"
+    end
+
+    # element path
+    def element_path(options = nil)
+      self.class.element_path(to_param, options || prefix_options)
+    end
+
+    def to_param
+      attributes[:account_code]
+    end
+
+    # Override collection_path because this is a singular resource
+    def self.collection_path(prefix_options = {}, query_options = nil)
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      # original: "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
+      "#{prefix(prefix_options)}#{element_name}.#{format.extension}#{query_string(query_options)}"
+    end
+
+  end
+  
+  # backwards compatibility
+  RecurlyAccountBase = AccountBase
+end

data/lib/recurly/base.rb

@@ -1,11 +1,16 @@
 require 'active_support/memoizable'
 
 module Recurly
-  class RecurlyBase < ActiveResource::Base
+
+  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
@@ -51,47 +56,29 @@ module Recurly
       !persisted?
     end
 
-    # patch load_attributes_from_response so it marks result records as persisted
-    def load_attributes_from_response(response)
-      super
-      @persisted = true
+    # builds the object from the transparent results
+    def from_transparent_results(response)
+      self.load_attributes_from_response(response)
+      self
     end
 
-    # patch instantiate_record so it marks result records as persisted
-    def self.instantiate_record(record, prefix_options)
-      result = super
-      result.instance_eval{ @persisted = true }
-      result
-    end
-  end
-
-  # ActiveRecord treats resources as plural by default.  Some resources are singular.
-  class RecurlyAccountBase < RecurlyBase
-    self.prefix = "/accounts/:account_code/"
-
-    # Override element_path because this is a singular resource
-    def self.element_path(id, prefix_options = {}, query_options = nil)
-      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-      prefix_options.merge!(:account_code => id) if id
-      # original: "#{prefix(prefix_options)}#{collection_name}/#{URI.escape id.to_s}.#{format.extension}#{query_string(query_options)}"
-      "#{prefix(prefix_options)}#{element_name}.#{format.extension}#{query_string(query_options)}"
-    end
-
-    # element path
-    def element_path(options = nil)
-      self.class.element_path(to_param, options || prefix_options)
-    end
-
-    def to_param
-      attributes[:account_code]
-    end
+    protected
+      # patch load_attributes_from_response so it marks result records as persisted
+      def load_attributes_from_response(response)
+        super
+        @persisted = true
+      end
 
-    # Override collection_path because this is a singular resource
-    def self.collection_path(prefix_options = {}, query_options = nil)
-      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-      # original: "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
-      "#{prefix(prefix_options)}#{element_name}.#{format.extension}#{query_string(query_options)}"
-    end
+    private
+      # patch instantiate_record so it marks result records as persisted
+      def self.instantiate_record(record, prefix_options)
+        result = super
+        result.instance_eval{ @persisted = true }
+        result
+      end
 
   end
+
+  # backwards compatibility
+  RecurlyBase = Base
 end

data/lib/recurly/billing_info.rb

@@ -1,7 +1,46 @@
 module Recurly
-  class BillingInfo < RecurlyAccountBase
+  class BillingInfo < AccountBase
     self.element_name = "billing_info"
 
+    def self.known_attributes
+      [
+        "first_name",
+        "last_name",
+        "address1",
+        "address2",
+        "city",
+        "state",
+        "zip",
+        "country",
+        "phone",
+        "ip_address"
+      ]
+    end
+
+    # define attributes for inner CreditCard type
+    class CreditCard < Base
+      def self.known_attributes
+        [
+          "number",
+          "last_four",
+          "type",
+          "verification_value",
+          "month",
+          "year",
+          "start_month",
+          "start_year",
+          "issue_number"
+        ]
+      end
+    end
+
+    # initialize associations
+    def initialize(attributes = {})
+      attributes = attributes.with_indifferent_access
+      attributes[:credit_card] ||= {}
+      super(attributes)
+    end
+
     def update_only
       true
     end

data/lib/recurly/charge.rb

@@ -1,8 +1,19 @@
 module Recurly
-  class Charge < RecurlyBase
+  class Charge < Base
     self.element_name = "charge"
     self.prefix = "/accounts/:account_code/"
 
+    def self.known_attributes
+      [
+        "account_code",
+        "amount_in_cents",
+        "start_date",
+        "end_date",
+        "description",
+        "created_at"
+      ]
+    end
+
     def self.list(account_code, status = :all)
       params = {:account_code => account_code}
 

data/lib/recurly/coupon.rb

@@ -1,5 +1,13 @@
 module Recurly
   class Coupon < RecurlyAccountBase
     self.element_name = "coupon"
+
+    def self.known_attributes
+      [
+        "coupon_code",
+        "redeemed_at"
+      ]
+    end
+
   end
 end

data/lib/recurly/credit.rb

@@ -1,8 +1,19 @@
 module Recurly
-  class Credit < RecurlyBase
+  class Credit < Base
     self.element_name = "credit"
     self.prefix = "/accounts/:account_code/"
 
+    def self.known_attributes
+      [
+        "account_code",
+        "amount_in_cents",
+        "start_date",
+        "end_date",
+        "description",
+        "created_at"
+      ]
+    end
+
     def self.list(account_code)
       find(:all, :params => { :account_code => account_code })
     end