recurly 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Manifest

@@ -0,0 +1,21 @@
+LICENSE
+Manifest
+README.md
+Rakefile
+init.rb
+lib/recurly.rb
+lib/recurly/account.rb
+lib/recurly/base.rb
+lib/recurly/billing_info.rb
+lib/recurly/charge.rb
+lib/recurly/credit.rb
+lib/recurly/plan.rb
+lib/recurly/subscription.rb
+recurly.gemspec
+test/account_test.rb
+test/billing_info_test.rb
+test/charge_test.rb
+test/credit_test.rb
+test/plan_test.rb
+test/subscription_test.rb
+test/test_helper.rb

data/README.md

@@ -0,0 +1,50 @@
+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).
+
+
+Usage
+-----
+
+Please see the [documentation](http://support.recurly.com/faqs/api/ruby-client) and
+[support forums](http://support.recurly.com/discussions) for more information.
+
+
+Installation
+------------
+
+This library can be installed as a gem or a plugin. Your choice.
+
+**Gem Installation:**
+
+    gem install recurly --source=http://gemcutter.org
+    
+**Plugin Installation:**
+
+    script/plugin install git@github.com:recurly/recurly-client-ruby.git
+
+
+Authentication
+--------------
+
+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.
+
+Create a file in your Rails app at __/config/initializers/recurly_config.rb__ with contents like:
+
+    Recurly.configure do |c|
+      c.username = 'api@yourcompany.com'
+      c.password = 'super_secret_password'
+    end
+
+
+Examples
+--------
+
+All the functionality is demonstrated by the unit tests in the __test__ directory.
+
+
+API Documentation
+-----------------
+
+Please see the [Recurly API](http://support.recurly.com/faqs/api/) for more information.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('recurly', '0.1.0') do |p|
+  p.description    = "A Ruby API wrapper for Recurly. Super Simple Subscription billing."
+  p.url            = "http://github.com/recurly/recurly-client-ruby"
+  p.author         = "Isaac Hall"
+  p.email          = "support@recurly.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

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

data/lib/recurly.rb

@@ -0,0 +1,9 @@
+require "active_resource"
+
+require File.dirname(__FILE__) + '/recurly/base'
+require File.dirname(__FILE__) + '/recurly/account'
+require File.dirname(__FILE__) + '/recurly/billing_info'
+require File.dirname(__FILE__) + '/recurly/charge'
+require File.dirname(__FILE__) + '/recurly/credit'
+require File.dirname(__FILE__) + '/recurly/plan'
+require File.dirname(__FILE__) + '/recurly/subscription'

data/lib/recurly/account.rb

@@ -0,0 +1,13 @@
+module Recurly
+  class Account < RecurlyBase
+    self.element_name = "account"
+    
+    def close_account
+      destroy
+    end
+    
+    def primary_key
+      self.account_code
+    end
+  end
+end

data/lib/recurly/base.rb

@@ -0,0 +1,68 @@
+require "rubygems"
+require "active_resource"
+
+# See http://github.com/rails/rails/commit/1488c6cc9e6237ce794e3c4a6201627b9fd4ca09
+# Errors in Rails 2.3.4 are not parsed correctly.
+module ActiveResource
+  class Base
+    def save
+      save_without_validation
+      true
+    rescue ResourceInvalid => error
+      case error.response['Content-Type']
+      when /application\/xml/
+        errors.from_xml(error.response.body)
+      when /application\/json/
+        errors.from_json(error.response.body)
+      end
+      false
+    end
+  end
+end
+
+module Recurly
+  
+  VERSION = '0.1.0'
+  
+  class << self
+    attr_accessor :username, :password
+    
+    def configure
+      yield self
+      
+      RecurlyBase.user = username
+      RecurlyBase.password = password
+      true
+    end
+  end
+  
+  class RecurlyBase < ActiveResource::Base
+    self.site = "https://app.recurly.com"
+    
+    # Add User-Agent to headers
+    def headers
+      super
+      @headers['User-Agent'] = "Recurly Ruby Client v#{VERSION}"
+      @headers
+    end
+  end
+  
+  # ActiveRecord treats resources as plural by default.  Some resources are singular.
+  class RecurlySingularResourceBase < RecurlyBase
+    
+    # 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?
+      # original: "#{prefix(prefix_options)}#{collection_name}/#{id}.#{format.extension}#{query_string(query_options)}"
+      "#{prefix(prefix_options)}#{CGI::escape(id || '')}/#{element_name}.#{format.extension}#{query_string(query_options)}"
+    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
+end

data/lib/recurly/billing_info.rb

@@ -0,0 +1,11 @@
+module Recurly
+  class BillingInfo < RecurlySingularResourceBase
+    self.element_name = "billing_info"
+    self.prefix = "/accounts/:account_code"
+    
+    # Create / Update is always a PUT
+    def save
+      update
+    end
+  end
+end

data/lib/recurly/charge.rb

@@ -0,0 +1,10 @@
+module Recurly
+  class Charge < RecurlyBase
+    self.element_name = "charge"
+    self.prefix = "/accounts/:account_code/"
+  
+    def self.list(account_code)
+      Charge.find(:all, :params => { :account_code => account_code })
+    end
+  end
+end

data/lib/recurly/credit.rb

@@ -0,0 +1,10 @@
+module Recurly
+  class Credit < RecurlyBase
+    self.element_name = "credit"
+    self.prefix = "/accounts/:account_code/"
+  
+    def self.list(account_code)
+      Credit.find(:all, :params => { :account_code => account_code })
+    end
+  end
+end

data/lib/recurly/plan.rb

@@ -0,0 +1,5 @@
+module Recurly
+  class Plan < RecurlyBase
+    self.element_name = "plan"
+  end
+end

data/lib/recurly/subscription.rb

@@ -0,0 +1,41 @@
+module Recurly
+  class Subscription < RecurlySingularResourceBase
+    self.element_name = "subscription"
+    self.prefix = "/accounts/:account_code"
+    
+    def self.refund(account_code, refund_type = :partial)
+      raise "Refund type must be :full or :partial." unless refund_type == :full or refund_type == :partial
+      Subscription.delete(nil, {:account_code => account_code, :refund => refund_type})
+    end
+    
+    # Stops the subscription from renewing. The subscription remains valid until the end of
+    # the current term (current_period_ends_at).
+    def cancel
+      Subscription.delete(self.subscription_account_code)
+    end
+    
+    # Terminates the subscription immediately and processes a full or partial refund
+    def refund(refund_type)
+      raise "Refund type must be :full or :partial." unless refund_type == :full or refund_type == :partial
+      Subscription.delete(nil, {:account_code => self.subscription_account_code, :refund => refund_type})
+    end
+    
+    # Valid timeframe: :now or :renewal
+    # Valid options: plan_code, quantity, unit_amount
+    def change(timeframe, options = {})
+      raise "Timeframe must be :full or :partial." unless timeframe == 'now' or timeframe == 'renewal'
+      options[:timeframe] = timeframe
+      connection.put(element_path(:account_code => self.subscription_account_code), 
+        self.class.format.encode(options, :root => :subscription), 
+        self.class.headers)
+    end
+    
+    def subscription_account_code
+      acct_code = self.account_code if defined?(self.account_code)
+      acct_code ||= account.account_code unless account.nil?
+      acct_code ||= self.primary_key if defined?(self.primary_key)
+      acct_code
+    end
+  end
+end
+

data/recurly.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{recurly}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Isaac Hall"]
+  s.date = %q{2009-11-22}
+  s.description = %q{A Ruby API wrapper for Recurly. Super Simple Subscription billing.}
+  s.email = %q{support@recurly.com}
+  s.extra_rdoc_files = ["LICENSE", "README.md", "lib/recurly.rb", "lib/recurly/account.rb", "lib/recurly/base.rb", "lib/recurly/billing_info.rb", "lib/recurly/charge.rb", "lib/recurly/credit.rb", "lib/recurly/plan.rb", "lib/recurly/subscription.rb"]
+  s.files = ["LICENSE", "Manifest", "README.md", "Rakefile", "init.rb", "lib/recurly.rb", "lib/recurly/account.rb", "lib/recurly/base.rb", "lib/recurly/billing_info.rb", "lib/recurly/charge.rb", "lib/recurly/credit.rb", "lib/recurly/plan.rb", "lib/recurly/subscription.rb", "recurly.gemspec", "test/account_test.rb", "test/billing_info_test.rb", "test/charge_test.rb", "test/credit_test.rb", "test/plan_test.rb", "test/subscription_test.rb", "test/test_helper.rb"]
+  s.homepage = %q{http://github.com/recurly/recurly-client-ruby}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Recurly", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{recurly}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Ruby API wrapper for Recurly. Super Simple Subscription billing.}
+  s.test_files = ["test/account_test.rb", "test/billing_info_test.rb", "test/charge_test.rb", "test/credit_test.rb", "test/plan_test.rb", "test/subscription_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/account_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class AccountTest < Test::Unit::TestCase
+
+  def test_create
+    account = create_account('create')
+    assert_not_nil account.created_at
+  end
+  
+  def test_get_account
+    account = create_account('get')
+    
+    get_acct = Recurly::Account.find(account.account_code)
+    assert_not_nil get_acct
+    assert_not_nil get_acct.created_at
+    assert_equal account.account_code, get_acct.account_code
+    assert_equal account.email, get_acct.email
+    assert_equal account.first_name, get_acct.first_name
+  end
+  
+  def test_update_account
+    account = create_account('update')
+    
+    account = Recurly::Account.find(account.account_code)
+    account.last_name = 'Update Test'
+    account.company_name = 'Recurly Ruby Gem -- Update'
+    account.save
+    
+    updated_acct = Recurly::Account.find(account.account_code)
+    assert_equal account.email, updated_acct.email
+    assert_not_equal account.last_name, updated_acct.last_name
+    assert_not_equal account.company_name, updated_acct.company_name
+  end
+  
+  def test_close_account
+    account = create_account('close')
+    
+    account.close_account
+    
+    assert_raises ActiveResource::ResourceNotFound do
+      get_acct = Recurly::Account.find(account.account_code)
+    end
+  end
+  
+end

data/test/billing_info_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class BillingInfoTest < Test::Unit::TestCase
+
+  def test_update_billing_info
+    account = create_account('billing')
+    
+    billing_info = Recurly::BillingInfo.create(
+      :account_code => account.account_code,
+      :first_name => account.first_name,
+      :last_name => account.last_name,
+      :address1 => '123 Test St',
+      :city => 'San Francisco',
+      :state => 'CA',
+      :zip => '94115',
+      :credit_card => {
+        :number => '1',
+        :year => Time.now.year + 1,
+        :month => Time.now.month,
+        :verification_value => '123'
+      }
+    )
+    
+    assert_instance_of Recurly::BillingInfo, billing_info
+    assert_not_nil billing_info.updated_at
+  end
+
+end

data/test/charge_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class ChargeTest < Test::Unit::TestCase
+
+  def test_charge_account
+    account = create_account('charge')
+     
+    charge = Recurly::Charge.create(
+      :account_code => account.account_code,
+      :amount => 9.50
+    )
+    
+    assert_not_nil charge.id
+    assert_equal charge.amount_in_cents, 950
+  end
+  
+  def test_list_charges
+    account = create_account('charge-list')
+     
+    charge = Recurly::Charge.create(
+      :account_code => account.account_code,
+      :amount => 9.23
+    )
+    
+    charge_list = Recurly::Charge.list(account.account_code)
+    assert_not_nil charge_list
+    assert_instance_of Array, charge_list
+  end
+  
+end

data/test/credit_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class CreditTest < Test::Unit::TestCase
+
+  def test_credit_account
+    account = create_account('credit')
+     
+    credit = Recurly::Credit.create(
+      :account_code => account.account_code,
+      :amount => 9.50
+    )
+    
+    assert_not_nil credit.id
+    assert_equal credit.amount_in_cents, -950 # Credits are negative
+  end
+  
+  def test_list_credits
+    account = create_account('credit-list')
+     
+    credit = Recurly::Credit.create(
+      :account_code => account.account_code,
+      :amount => 9.23
+    )
+    
+    credit_list = Recurly::Credit.list(account.account_code)
+    assert_not_nil credit_list
+    assert_instance_of Array, credit_list
+  end
+  
+end

data/test/plan_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class PlanTest < Test::Unit::TestCase
+
+  def test_list_plans
+    plans = Recurly::Plan.find(:all)
+    
+    assert_not_nil plans
+    assert_instance_of Array, plans
+  end
+  
+  def test_get_plan
+    plan = Recurly::Plan.find('trial')
+    assert_not_nil plan
+    assert_not_nil plan.name
+  end
+
+end

data/test/subscription_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+class SubscriptionTest < Test::Unit::TestCase
+
+  def test_create_subscription_new_account
+    account = Recurly::Account.new(
+      :account_code => "#{Time.now.to_i}-new-sub-new-account",
+      :first_name => 'Verena',
+      :last_name => 'Test',
+      :email => 'verena@test.com',
+      :company_name => 'Recurly Ruby Gem')
+      
+    sub = create_subscription(account, TEST_PLAN_CODE)
+    assert_not_nil sub
+    assert_nil sub.canceled_at
+    assert_equal sub.state, 'active'
+    assert_not_nil sub.current_period_started_at
+  end
+  
+  def test_create_subscription_existing_account
+    account = create_account('existing-account')
+    sub = create_subscription(account, TEST_PLAN_CODE)
+    
+    assert_equal sub.state, 'active'
+  end
+  
+  def test_update_subscription
+    account = create_account('update-subscription')
+    sub = create_subscription(account, TEST_PLAN_CODE)
+    
+    sub.change('now', :quantity => 2)
+    sub.reload
+    assert_equal sub.quantity, 2
+  end
+  
+  def test_cancel_subscription
+    account = create_account('cancel-subscription')
+    subscription = create_subscription(account, TEST_PLAN_CODE)
+    
+    subscription.cancel
+    
+    sub = Recurly::Subscription.find(account.account_code)
+    assert_equal sub.state, 'canceled'
+    assert_not_nil sub.canceled_at
+  end 
+  
+  def test_refund_subscription
+    account = create_account('refund-subscription')
+    subscription = create_subscription(account, TEST_PLAN_CODE)
+    
+    subscription.refund(:full)
+    
+    assert_raises ActiveResource::ResourceNotFound do
+      get_sub = Recurly::Subscription.find(account.account_code)
+    end
+  end
+  
+  def create_subscription(account, plan_code, quantity = 1)
+    account.billing_info = Recurly::BillingInfo.new(
+      :first_name => account.first_name,
+      :last_name => account.last_name,
+      :address1 => '123 Test St',
+      :city => 'San Francisco',
+      :state => 'CA',
+      :country => 'US',
+      :zip => '94103',
+      :credit_card => {
+        :number => '1',
+        :year => Time.now.year + 1,
+        :month => Time.now.month,
+        :verification_value => '123'
+      },
+      :ip_address => '127.0.0.1'
+    )
+    
+    sub = Recurly::Subscription.create(
+      :account_code => account.account_code,
+      :plan_code => plan_code, 
+      :quantity => quantity,
+      :account => account
+    )
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'test/unit'
+require 'rubygems'
+
+require File.dirname(__FILE__) + '/../lib/recurly'
+
+Recurly.configure do |c|
+  c.username = ''
+  c.password = ''
+end
+
+TEST_PLAN_CODE = 'trial'
+
+def create_account(account_code)
+  account = Recurly::Account.create(
+    :account_code => "#{Time.now.to_i}-#{account_code}",
+    :first_name => 'Verena',
+    :last_name => 'Test',
+    :email => 'verena@test.com',
+    :company_name => 'Recurly Ruby Gem')
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: recurly
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Isaac Hall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-22 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A Ruby API wrapper for Recurly. Super Simple Subscription billing.
+email: support@recurly.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- lib/recurly.rb
+- lib/recurly/account.rb
+- lib/recurly/base.rb
+- lib/recurly/billing_info.rb
+- lib/recurly/charge.rb
+- lib/recurly/credit.rb
+- lib/recurly/plan.rb
+- lib/recurly/subscription.rb
+files: 
+- LICENSE
+- Manifest
+- README.md
+- Rakefile
+- init.rb
+- lib/recurly.rb
+- lib/recurly/account.rb
+- lib/recurly/base.rb
+- lib/recurly/billing_info.rb
+- lib/recurly/charge.rb
+- lib/recurly/credit.rb
+- lib/recurly/plan.rb
+- lib/recurly/subscription.rb
+- recurly.gemspec
+- test/account_test.rb
+- test/billing_info_test.rb
+- test/charge_test.rb
+- test/credit_test.rb
+- test/plan_test.rb
+- test/subscription_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/recurly/recurly-client-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Recurly
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: recurly
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby API wrapper for Recurly. Super Simple Subscription billing.
+test_files: 
+- test/account_test.rb
+- test/billing_info_test.rb
+- test/charge_test.rb
+- test/credit_test.rb
+- test/plan_test.rb
+- test/subscription_test.rb
+- test/test_helper.rb