micah_chargify_api_ares 0.3.4

data/.gitignore

@@ -0,0 +1,2 @@
+config
+pkg

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Grasshopper Group, LLC
+
+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/README.md

@@ -0,0 +1,80 @@
+Chargify API wrapper for Ruby (using ActiveResource)
+====================================================
+
+chargify_api_ares
+-----------------
+
+This is a Ruby wrapper for the [Chargify](http://chargify.com) API that leverages ActiveResource.
+It allows you to interface with the Chargify API using simple ActiveRecord-like syntax, i.e.:
+
+    Chargify::Subscription.create(
+      :customer_reference => 'moklett',
+      :product_handle => 'chargify-api-ares-test',
+      :credit_card_attributes => {
+        :first_name => "Michael",
+        :last_name => "Klett",
+        :expiration_month => 1,
+        :expiration_year => 2010,
+        :full_number => "1234-1234-1234-1234"
+      }
+    )
+    
+    subscription.credit_card_attributes = {:expiration_year => 2013}
+    subscription.save
+    
+    subscription.cancel
+
+See the `samples` directory for more usage examples.
+
+
+### Installation
+
+This library can be installed as a gem.  It is hosted on [Gemcutter](http://gemcutter.org).
+
+If you don't have your system set up to use gemcutter, follow the instructions on their site
+<http://gemcutter.org>, i.e.:
+
+$ gem install gemcutter
+$ gem tumble
+
+This will install Gemcutter and set your gem sources to search the gemcutter repos.
+
+Then you can install this library as a gem:
+
+$ gem install chargify_api_ares
+
+
+### Requirements
+
+This library requires ActiveResource version 2.3.4 or greater.
+
+$ gem install activeresource
+
+
+### Usage
+
+Simply require this library before you use it:
+
+    require 'chargify_api_ares'
+    
+
+If you're using Rails, you could include this gem in your configuration, i.e. in `environment.rb`
+
+    config.gem 'chargify_api_ares'
+    
+
+Now you'll have access to classes the interact with the Chargify API, such as:
+
+`Chargify::Product`  
+`Chargify::Customer`  
+`Chargifiy::Subscription`
+
+Check out the examples in the `samples` directory.  If you're not familiar with how ActiveResource works,
+you may be interested in some [ActiveResource Documentation](http://apidock.com/rails/ActiveResource/Base)
+
+
+
+### Contributors
+
+* Michael Klett (Grasshopper Labs and Chargify)
+* The Lab Rats @ Phase Two Labs

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "micah_chargify_api_ares"
+    gemspec.summary = "A Chargify API wrapper for Ruby using ActiveResource"
+    gemspec.description = ""
+    gemspec.email = "mklett@grasshopper.com"
+    gemspec.homepage = "http://github.com/grasshopperlabs/chargify_api_ares"
+    gemspec.authors = ["Michael Klett", "The Lab Rats @ Phase Two Labs", "Brian Rose","Nathan Verni","Micah Wedemeyer"]
+    Jeweler::GemcutterTasks.new
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.4

data/chargify_api_ares.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{chargify_api_ares}
+  s.version = "0.3.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Klett", "The Lab Rats @ Phase Two Labs", "Brian Rose", "Nathan Verni"]
+  s.date = %q{2010-06-24}
+  s.description = %q{}
+  s.email = %q{mklett@grasshopper.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE.txt",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "chargify_api_ares.gemspec",
+     "lib/chargify_api_ares.rb",
+     "samples/customers.rb",
+     "samples/metered_components.rb",
+     "samples/products.rb",
+     "samples/subscriptions.rb",
+     "spec/base_spec.rb",
+     "spec/components_spec.rb",
+     "spec/customer_spec.rb",
+     "spec/factories.rb",
+     "spec/mocks/fake_resource.rb",
+     "spec/product_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/subscription_spec.rb",
+     "spec/subscriptions_component_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/grasshopperlabs/chargify_api_ares}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A Chargify API wrapper for Ruby using ActiveResource}
+  s.test_files = [
+    "spec/base_spec.rb",
+     "spec/components_spec.rb",
+     "spec/customer_spec.rb",
+     "spec/factories.rb",
+     "spec/mocks/fake_resource.rb",
+     "spec/product_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/subscription_spec.rb",
+     "spec/subscriptions_component_spec.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/lib/chargify_api_ares.rb

@@ -0,0 +1,167 @@
+# Chargify API Wrapper using ActiveResource.
+#
+begin
+  require 'active_resource'
+rescue LoadError
+  begin
+    require 'rubygems'
+    require 'active_resource'
+  rescue LoadError
+    abort <<-ERROR
+The 'activeresource' library could not be loaded. If you have RubyGems 
+installed you can install ActiveResource by doing "gem install activeresource".
+ERROR
+  end
+end
+
+
+# Version check
+module Chargify
+  MIN_VERSION = '2.3.4'
+end
+require 'active_resource/version'
+unless ActiveResource::VERSION::STRING >= Chargify::MIN_VERSION
+  abort <<-ERROR
+    ActiveResource version #{Chargify::MIN_VERSION} or greater is required.
+  ERROR
+end
+
+# Patch ActiveResource version 2.3.4
+if ActiveResource::VERSION::STRING == '2.3.4'
+  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
+end
+
+
+module Chargify
+  
+  class << self
+    attr_accessor :subdomain, :api_key, :site, :format
+    
+    def configure
+      yield self
+      
+      Base.user      = api_key
+      Base.password  = 'X'
+      
+      if site.blank?
+        Base.site                     = "https://#{subdomain}.chargify.com"
+        Subscription::Component.site  = "https://#{subdomain}.chargify.com/subscriptions/:subscription_id"
+      else
+        Base.site                     = site
+        Subscription::Component.site  = site + "/subscriptions/:subscription_id"
+      end
+    end
+  end
+  
+  class Base < ActiveResource::Base
+    class << self
+      def element_name
+        name.split(/::/).last.underscore
+      end
+    end
+    
+    def to_xml(options = {})
+      options.merge!(:dasherize => false)
+      super
+    end
+  end
+  
+  class Customer < Base
+    def self.find_by_reference(reference)
+      Customer.new get(:lookup, :reference => reference)
+    end
+  end
+  
+  class Subscription < Base
+    def self.find_by_customer_reference(reference)
+      customer = Customer.find_by_reference(reference)
+      find(:first, :params => {:customer_id => customer.id}) 
+    end
+    
+    # Strip off nested attributes of associations before saving, or type-mismatch errors will occur
+    def save
+      self.attributes.delete('customer')
+      self.attributes.delete('product')
+      self.attributes.delete('credit_card')
+      super
+    end
+    
+    def cancel
+      destroy
+    end
+    
+    def component(id)
+      Component.find(id, :params => {:subscription_id => self.id})
+    end
+    
+    def components(params = {})
+      params.merge!({:subscription_id => self.id})
+      Component.find(:all, :params => params)
+    end
+    
+    # Perform a one-time charge on an existing subscription.
+    # For more information, please see the one-time charge API docs available 
+    # at: http://support.chargify.com/faqs/api/api-charges
+    def charge(attrs = {})
+      post :charges, :charge => attrs
+    end
+    
+    # Give a credit on an existing subscription.
+    # For more information, see the API docs available at
+    # http://support.chargify.com/faqs/api/api-credits
+    def credit(attrs = {})
+      post :credits, :credit => attrs
+    end
+    
+    def transactions()
+      Transaction.find(:all, :params =>{:subscription_id => self.id})
+    end
+    
+    class Component < Base
+      # All Subscription Components are considered already existing records, but the id isn't used
+      def id
+        self.component_id
+      end
+    end
+  end
+
+  class Product < Base
+    def self.find_by_handle(handle)
+      Product.new get(:lookup, :handle => handle)
+    end
+  end
+  
+  class ProductFamily < Base
+  end
+    
+  class Usage < Base
+    def subscription_id=(i)
+      self.prefix_options[:subscription_id] = i
+    end
+    def component_id=(i)
+      self.prefix_options[:component_id] = i
+    end    
+  end
+  
+  class Component < Base
+  end
+  
+  class Transaction < Base
+  end
+  
+end

data/samples/customers.rb

@@ -0,0 +1,51 @@
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'chargify_api_ares'
+
+# You could load your credentials from a file...
+chargify_config = YAML::load_file(File.join(File.dirname(__FILE__), '..', 'config', 'chargify.yml'))
+
+Chargify.configure do |c|
+  c.subdomain = chargify_config['subdomain']
+  c.api_key   = chargify_config['api_key']
+end
+
+
+# Retrieve a list of all your customers
+Chargify::Customer.find(:all)
+# => [#<Chargify::Customer:0x102d0cef8 @prefix_options={}, @attributes={"reference"=>"moklett", "updated_at"=>Mon Nov 16 23:19:25 UTC 2009, "id"=>325, "first_name"=>"Michael", "organization"=>"Chargify", "last_name"=>"Klett", "email"=>"moklett@example.com", "created_at"=>Mon Nov 16 23:19:25 UTC 2009}>]
+
+
+customer = Chargify::Customer.find(325)
+
+customer.first_name
+# => Michael
+
+customer.last_name
+# => Klett
+
+# Update a customer - success!
+customer.first_name = "Miguel"
+customer.save
+# => true
+
+customer.first_name
+# => Miguel
+
+# Update a customer - fail!
+customer.first_name = ""
+customer.save
+# => false
+
+customer.errors.full_messages.inspect
+# => ["First name: cannot be blank."]
+
+
+# Create a new customer - success!
+Chargify::Customer.create(
+  :first_name   => "Charlie",
+  :last_name    => "Bull",
+  :email        => "charlie@example.com",
+  :organization => "Chargify"
+)
+# => #<Chargify::Customer:0x102c27970 @prefix_options={}, @attributes={"reference"=>nil, "updated_at"=>Mon Nov 16 23:43:33 UTC 2009, "id"=>327, "organization"=>"Chargify", "first_name"=>"Charlie", "last_name"=>"Bull", "created_at"=>Mon Nov 16 23:43:33 UTC 2009, "email"=>"charlie@example.com"}>

data/samples/metered_components.rb

@@ -0,0 +1,35 @@
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'chargify_api_ares'
+
+# You could load your credentials from a file...
+chargify_config = YAML::load_file(File.join(File.dirname(__FILE__), '..', 'config', 'chargify.yml'))
+
+Chargify.configure do |c|
+  c.subdomain = chargify_config['subdomain']
+  c.api_key   = chargify_config['api_key']
+  if chargify_config['site']
+    c.site = chargify_config['site']
+  end
+end
+
+#
+# This assumes you have a product family with a metered component setup
+#
+product_family = Chargify::ProductFamily.find(:first)
+component =  Chargify::Component.find(:first, :params => {:product_family_id => product_family.id})
+subscription = Chargify::Subscription.find(:first)
+
+
+u = Chargify::Usage.new
+u.subscription_id = subscription.id
+u.component_id = component.id
+u.quantity = 5
+d = DateTime.now.to_s
+u.memo = d
+puts d
+u.save
+
+
+x = Chargify::Usage.find(:last, :params => {:subscription_id => subscription.id, :component_id => component.id})
+puts x.memo == d

data/samples/products.rb

@@ -0,0 +1,24 @@
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'chargify_api_ares'
+
+# You could load your credentials from a file...
+chargify_config = YAML::load_file(File.join(File.dirname(__FILE__), '..', 'config', 'chargify.yml'))
+
+Chargify.configure do |c|
+  c.subdomain = chargify_config['subdomain']
+  c.api_key   = chargify_config['api_key']
+end
+
+
+# Retrieve a list of all your products
+products = Chargify::Product.find(:all)
+# => [#<Chargify::Product:0x102cdcac8 @prefix_options={}, @attributes={"name"=>"Chargify API Ares Test", "price_in_cents"=>0, "handle"=>"chargify-api-ares-test", "product_family"=>#<Chargify::Product::ProductFamily:0x102cdbad8 @prefix_options={}, @attributes={"name"=>"Chargify API ARes Test", "handle"=>"chargify-api-ares-test", "id"=>78, "accounting_code"=>nil}>, "id"=>152, "accounting_code"=>nil, "interval_unit"=>"month", "interval"=>1}>]
+
+# Find a single product by id
+product = Chargify::Product.find(products.first.id)
+# => #<Chargify::Product:0x102ce7540 @prefix_options={}, @attributes={"price_in_cents"=>0, "name"=>"Chargify API Ares Test", "handle"=>"chargify-api-ares-test", "product_family"=>#<Chargify::Product::ProductFamily:0x102ce6ca8 @prefix_options={}, @attributes={"name"=>"Chargify API ARes Test", "handle"=>"chargify-api-ares-test", "id"=>78, "accounting_code"=>nil}>, "id"=>152, "accounting_code"=>nil, "interval_unit"=>"month", "interval"=>1}>
+
+# Find a single product by its handle
+product = Chargify::Product.find_by_handle(products.first.handle)
+# => #<Chargify::Product:0x102c7a828 @prefix_options={}, @attributes={"price_in_cents"=>0, "name"=>"Chargify API Ares Test", "handle"=>"chargify-api-ares-test", "product_family"=>#<Chargify::Product::ProductFamily:0x102c798b0 @prefix_options={}, @attributes={"name"=>"Chargify API ARes Test", "handle"=>"chargify-api-ares-test", "id"=>78, "accounting_code"=>nil}>, "id"=>152, "accounting_code"=>nil, "interval_unit"=>"month", "interval"=>1}>

data/samples/subscriptions.rb

@@ -0,0 +1,56 @@
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'chargify_api_ares'
+
+# You could load your credentials from a file...
+chargify_config = YAML::load_file(File.join(File.dirname(__FILE__), '..', 'config', 'chargify.yml'))
+
+Chargify.configure do |c|
+  c.subdomain = chargify_config['subdomain']
+  c.api_key   = chargify_config['api_key']
+end
+
+
+# Retrieve a list of all your customers
+subscription = Chargify::Subscription.find(:all)
+# => [#<Chargify::Subscription:0x1020fff70 @prefix_options={}, @attributes={"cancellation_message"=>nil, "activated_at"=>Tue Nov 17 15:51:42 UTC 2009, "expires_at"=>nil, "updated_at"=>Tue Nov 17 15:51:41 UTC 2009, "credit_card"=>#<Chargify::Subscription::CreditCard:0x1020f24d8 @prefix_options={}, @attributes={"card_type"=>"bogus", "expiration_year"=>2015, "masked_card_number"=>"XXXX-XXXX-XXXX-2", "first_name"=>"Michael", "expiration_month"=>1, "last_name"=>"Klett"}>, "product"=>#<Chargify::Product:0x1020f5a70 @prefix_options={}, @attributes={"price_in_cents"=>0, "name"=>"Chargify API Ares Test", "handle"=>"chargify-api-ares-test", "product_family"=>#<Chargify::Product::ProductFamily:0x1020f48f0 @prefix_options={}, @attributes={"name"=>"Chargify API ARes Test", "handle"=>"chargify-api-ares-test", "id"=>79, "accounting_code"=>nil}>, "id"=>153, "accounting_code"=>nil, "interval_unit"=>"month", "interval"=>1}>, "trial_ended_at"=>nil, "id"=>328, "current_period_ends_at"=>Thu Dec 17 15:51:41 UTC 2009, "trial_started_at"=>nil, "customer"=>#<Chargify::Customer:0x1020f6d80 @prefix_options={}, @attributes={"reference"=>"moklett", "updated_at"=>Tue Nov 17 15:51:02 UTC 2009, "id"=>331, "first_name"=>"Michael", "organization"=>"Chargify", "last_name"=>"Klett", "email"=>"moklett@example.com", "created_at"=>Tue Nov 17 15:51:02 UTC 2009}>, "balance_in_cents"=>0, "current_period_started_at"=>Tue Nov 17 15:51:41 UTC 2009, "state"=>"canceled", "created_at"=>Tue Nov 17 15:51:41 UTC 2009}>]]
+
+
+# Create a subscription from a customer reference
+subscription = Chargify::Subscription.create(
+  :customer_reference => 'moklett',
+  :product_handle => 'chargify-api-ares-test',
+  :credit_card_attributes => {
+    :first_name => "Michael",
+    :last_name => "Klett",
+    :expiration_month => 1,
+    :expiration_year => 2020,
+    :full_number => "1"
+  }
+)
+# => #<Chargify::Subscription:0x1020ed4b0 @prefix_options={}, @attributes={"cancellation_message"=>nil, "activated_at"=>Tue Nov 17 16:00:17 UTC 2009, "expires_at"=>nil, "updated_at"=>Tue Nov 17 16:00:17 UTC 2009, "credit_card"=>#<Chargify::Subscription::CreditCard:0x102046b10 @prefix_options={}, @attributes={"card_type"=>"bogus", "expiration_year"=>2020, "masked_card_number"=>"XXXX-XXXX-XXXX-1", "first_name"=>"Michael", "expiration_month"=>1, "last_name"=>"Klett"}>, "product"=>#<Chargify::Product:0x10204a2d8 @prefix_options={}, @attributes={"price_in_cents"=>0, "name"=>"Chargify API Ares Test", "handle"=>"chargify-api-ares-test", "product_family"=>#<Chargify::Product::ProductFamily:0x1020490b8 @prefix_options={}, @attributes={"name"=>"Chargify API ARes Test", "handle"=>"chargify-api-ares-test", "id"=>79, "accounting_code"=>nil}>, "id"=>153, "accounting_code"=>nil, "interval_unit"=>"month", "interval"=>1}>, "credit_card_attributes"=>#<Chargify::Subscription::CreditCardAttributes:0x1020ecab0 @prefix_options={}, @attributes={"expiration_year"=>2020, "full_number"=>"1", "first_name"=>"Michael", "expiration_month"=>1, "last_name"=>"Klett"}>, "trial_ended_at"=>nil, "id"=>331, "current_period_ends_at"=>Thu Dec 17 16:00:17 UTC 2009, "product_handle"=>"chargify-api-ares-test", "trial_started_at"=>nil, "customer"=>#<Chargify::Customer:0x10204b688 @prefix_options={}, @attributes={"reference"=>"moklett", "updated_at"=>Tue Nov 17 15:51:02 UTC 2009, "id"=>331, "first_name"=>"Michael", "organization"=>"Chargify", "last_name"=>"Klett", "email"=>"moklett@example.com", "created_at"=>Tue Nov 17 15:51:02 UTC 2009}>, "balance_in_cents"=>0, "current_period_started_at"=>Tue Nov 17 16:00:17 UTC 2009, "state"=>"active", "created_at"=>Tue Nov 17 16:00:17 UTC 2009, "customer_reference"=>"moklett"}>
+
+
+# Lookup up existing Subscription using the Customer's reference
+Subscription.find_by_customer_reference('moklett')
+# => #<Chargify::Subscription:0x1020ed4b0 @prefix_options={}, @attributes={"cancellation_message"=>nil, "activated_at"=>Tue Nov 17 16:00:17 UTC 2009, "expires_at"=>nil, "updated_at"=>Tue Nov 17 16:00:17 UTC 2009, "credit_card"=>#<Chargify::Subscription::CreditCard:0x102046b10 @prefix_options={}, @attributes={"card_type"=>"bogus", "expiration_year"=>2020, "masked_card_number"=>"XXXX-XXXX-XXXX-1", "first_name"=>"Michael", "expiration_month"=>1, "last_name"=>"Klett"}>, "product"=>#<Chargify::Product:0x10204a2d8 @prefix_options={}, @attributes={"price_in_cents"=>0, "name"=>"Chargify API Ares Test", "handle"=>"chargify-api-ares-test", "product_family"=>#<Chargify::Product::ProductFamily:0x1020490b8 @prefix_options={}, @attributes={"name"=>"Chargify API ARes Test", "handle"=>"chargify-api-ares-test", "id"=>79, "accounting_code"=>nil}>, "id"=>153, "accounting_code"=>nil, "interval_unit"=>"month", "interval"=>1}>, "trial_ended_at"=>nil, "id"=>331, "current_period_ends_at"=>Thu Dec 17 16:00:17 UTC 2009, "product_handle"=>"chargify-api-ares-test", "trial_started_at"=>nil, "customer"=>#<Chargify::Customer:0x10204b688 @prefix_options={}, @attributes={"reference"=>"moklett", "updated_at"=>Tue Nov 17 15:51:02 UTC 2009, "id"=>331, "first_name"=>"Michael", "organization"=>"Chargify", "last_name"=>"Klett", "email"=>"moklett@example.com", "created_at"=>Tue Nov 17 15:51:02 UTC 2009}>, "balance_in_cents"=>0, "current_period_started_at"=>Tue Nov 17 16:00:17 UTC 2009, "state"=>"active", "created_at"=>Tue Nov 17 16:00:17 UTC 2009, "customer_reference"=>"moklett"}>
+
+
+# Update credit card information
+subscription.credit_card_attributes = {:full_number => "2", :expiration_year => "2015"}
+subscription.save
+# => #<Chargify::Subscription:0x1020ed4b0 @prefix_options={}, @attributes={"cancellation_message"=>nil, "activated_at"=>Tue Nov 17 16:00:17 UTC 2009, "expires_at"=>nil, "updated_at"=>Tue Nov 17 16:00:17 UTC 2009, "credit_card"=>#<Chargify::Subscription::CreditCard:0x1023ba878 @prefix_options={}, @attributes={"card_type"=>"bogus", "expiration_year"=>2015, "masked_card_number"=>"XXXX-XXXX-XXXX-2", "first_name"=>"Michael", "expiration_month"=>1, "last_name"=>"Klett"}>, "product"=>#<Chargify::Product:0x1023baa80 @prefix_options={}, @attributes={"price_in_cents"=>0, "name"=>"Chargify API Ares Test", "handle"=>"chargify-api-ares-test", "product_family"=>#<Chargify::Product::ProductFamily:0x1023c04d0 @prefix_options={}, @attributes={"name"=>"Chargify API ARes Test", "handle"=>"chargify-api-ares-test", "id"=>79, "accounting_code"=>nil}>, "id"=>153, "accounting_code"=>nil, "interval_unit"=>"month", "interval"=>1}>, "credit_card_attributes"=>{:full_number=>"2", :expiration_year=>"2015"}, "trial_ended_at"=>nil, "id"=>331, "current_period_ends_at"=>Thu Dec 17 16:00:17 UTC 2009, "product_handle"=>"chargify-api-ares-test", "customer"=>#<Chargify::Customer:0x1023bae40 @prefix_options={}, @attributes={"reference"=>"moklett", "updated_at"=>Tue Nov 17 15:51:02 UTC 2009, "id"=>331, "first_name"=>"Michael", "organization"=>"Chargify", "last_name"=>"Klett", "email"=>"moklett@example.com", "created_at"=>Tue Nov 17 15:51:02 UTC 2009}>, "trial_started_at"=>nil, "balance_in_cents"=>0, "current_period_started_at"=>Tue Nov 17 16:00:17 UTC 2009, "state"=>"active", "created_at"=>Tue Nov 17 16:00:17 UTC 2009, "customer_reference"=>"moklett"}>
+
+
+# Perform a one-time charge against an existing subscription
+subscription.charge(:amount => 10.00, :memo => 'Extra service')
+# => #<Net::HTTPCreated>
+
+# Give a credit to an existing subscription
+subscription.credit(:amount_in_cents => 1000, :memo => 'Free subscription time')
+# => #<Net::HTTPCreated>
+
+# Cancel a subscription
+subscription.cancel
+subscription.reload
+# => #<Chargify::Subscription:0x1020ed4b0 @prefix_options={}, @attributes={"cancellation_message"=>nil, "activated_at"=>Tue Nov 17 16:00:17 UTC 2009, "expires_at"=>nil, "updated_at"=>Tue Nov 17 16:00:17 UTC 2009, "credit_card"=>#<Chargify::Subscription::CreditCard:0x10234f168 @prefix_options={}, @attributes={"card_type"=>"bogus", "expiration_year"=>2015, "masked_card_number"=>"XXXX-XXXX-XXXX-2", "first_name"=>"Michael", "expiration_month"=>1, "last_name"=>"Klett"}>, "product"=>#<Chargify::Product:0x10234f370 @prefix_options={}, @attributes={"price_in_cents"=>0, "name"=>"Chargify API Ares Test", "handle"=>"chargify-api-ares-test", "product_family"=>#<Chargify::Product::ProductFamily:0x102354708 @prefix_options={}, @attributes={"name"=>"Chargify API ARes Test", "handle"=>"chargify-api-ares-test", "id"=>79, "accounting_code"=>nil}>, "id"=>153, "accounting_code"=>nil, "interval_unit"=>"month", "interval"=>1}>, "credit_card_attributes"=>{:full_number=>"2", :expiration_year=>"2015"}, "trial_ended_at"=>nil, "id"=>331, "current_period_ends_at"=>Thu Dec 17 16:00:17 UTC 2009, "product_handle"=>"chargify-api-ares-test", "customer"=>#<Chargify::Customer:0x10234f730 @prefix_options={}, @attributes={"reference"=>"moklett", "updated_at"=>Tue Nov 17 15:51:02 UTC 2009, "id"=>331, "first_name"=>"Michael", "organization"=>"Chargify", "last_name"=>"Klett", "email"=>"moklett@example.com", "created_at"=>Tue Nov 17 15:51:02 UTC 2009}>, "trial_started_at"=>nil, "balance_in_cents"=>0, "current_period_started_at"=>Tue Nov 17 16:00:17 UTC 2009, "state"=>"canceled", "created_at"=>Tue Nov 17 16:00:17 UTC 2009, "customer_reference"=>"moklett"}>

data/samples/transactions.rb

@@ -0,0 +1,17 @@
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'chargify_api_ares'
+
+# You could load your credentials from a file...
+chargify_config = YAML::load_file(File.join(File.dirname(__FILE__), '..', 'config', 'chargify.yml'))
+
+Chargify.configure do |c|
+  c.subdomain = chargify_config['subdomain']
+  c.api_key   = chargify_config['api_key']
+end
+
+
+# Retrieve a list of all your customers
+subscription = Chargify::Subscription.find(:all).first
+
+transactions = subscription.transactions

data/spec/base_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Chargify::Base do
+  
+  it 'parses element names' do
+    Chargify::Base.stub!(:name).and_return("Test::Namespace::ElementName")
+    Chargify::Base.element_name.should eql('element_name')
+  end
+  
+end

data/spec/components_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Chargify::Component do
+  describe "Recording usage" do
+    before do
+      @subscription = Factory(:subscription)
+      @component = Factory(:component)
+      @now = DateTime.now.to_s
+    end
+    
+    it "should create a usage record" do
+      u = Chargify::Usage.new
+      u.subscription_id = @subscription.id
+      u.component_id = @component.id
+      u.quantity = 5
+      u.memo = @now
+      u.save
+      
+      component = Chargify::Usage.find(:last, :params => {:subscription_id => @subscription.id, :component_id => @component.id})
+      component.memo.should == @now
+      component.quantity.should == 5
+    end
+  end
+  
+  describe "Listing usages" do
+    before do
+      @subscription = Factory(:subscription)
+      @component = Factory(:component)
+      @now = DateTime.now.to_s
+      create_usage
+    end
+    
+    it "should return all usages for a component and subscription" do
+      component = Chargify::Usage.find(:last, :params => {:subscription_id => @subscription.id, :component_id => @component.id})
+      component.quantity.should == 5
+    end
+  end
+  
+  def create_usage
+    u = Chargify::Usage.new
+    u.subscription_id = @subscription.id
+    u.component_id = @component.id
+    u.quantity = 5
+    u.memo = @now
+    u.save
+  end
+end
+  

data/spec/customer_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Chargify::Customer do
+  
+  context 'find by reference' do
+    before do
+      @reference = 'ref0123'
+      @existing_customer = Factory(:customer, :reference => @reference, :id => Factory.next(:customer_id))
+      FakeWeb.register_uri(:get, "#{test_domain}/customers/lookup.xml?reference=#{@existing_customer.reference}", :body => @existing_customer.attributes.to_xml)
+    end
+    
+    it 'finds the correct customer by reference' do
+      customer = Chargify::Customer.find_by_reference(@reference)
+      customer.should eql(@existing_customer)
+    end
+    
+    it 'is an instance of Chargify::Customer' do
+      customer = Chargify::Customer.find_by_reference(@reference)
+      customer.should be_instance_of(Chargify::Customer)
+    end
+  end
+  
+end

data/spec/factories.rb

@@ -0,0 +1,62 @@
+Factory.sequence :email do |n|
+  "customer#{n}@example.com"
+end
+
+Factory.sequence :customer_id do |n|
+  n
+end
+
+Factory.define :customer, :class => Chargify::Customer do |c|
+  c.first_name { Faker::Name.first_name }
+  c.last_name { Faker::Name.last_name }
+  c.email { Factory.next(:email) }
+  c.organization { Faker::Company.name }
+  c.created_at { 2.days.ago }
+  c.updated_at { 1.hour.ago }
+end
+
+
+Factory.sequence :product_id do |n|
+  n
+end
+
+Factory.sequence :product_name do |n|
+  "Product #{n}"
+end
+
+Factory.define :product, :class => Chargify::Product do |p|
+  p.name { Factory.next(:product_name) }
+end
+
+Factory.sequence :subscription_id do |n|
+  n
+end
+
+Factory.define :subscription, :class => Chargify::Subscription do |s|
+  s.balance_in_cents 500
+  s.current_period_ends_at 3.days.from_now
+end
+
+Factory.define :subscription_with_extra_attrs, :parent => :subscription do |swea|
+  swea.customer Chargify::Customer.new
+  swea.product Chargify::Product.new
+  swea.credit_card "CREDIT CARD"
+end
+
+Factory.define :component, :class => Chargify::Component do |f|
+  f.name { Faker::Company.bs }
+  f.unit_name 'unit'
+end
+
+Factory.define :quantity_based_component, :class => Chargify::Component do |f|
+  f.name { Faker::Company.bs }
+  f.unit_name 'unit'
+  f.pricing_scheme 'tiered'
+  f.component_type 'quantity_based_component'
+end
+
+Factory.define :subscriptions_component, :class => Chargify::Subscription::Component do |f|
+  f.name { Faker::Company.bs }
+  f.unit_name 'unit'
+  f.component_type 'quantity_based_component'
+end

data/spec/mocks/fake_resource.rb

@@ -0,0 +1,82 @@
+# Taken from https://gist.github.com/238158/487a411c392e1fb2a0c00347e32444320f5cdd49
+require 'FakeWeb'
+ 
+module ActiveResource
+ 
+  #
+  # The FakeResource fakes ActiveResources so that no real resources are transferred. It catches the creation methods
+  # and stores the resources internally instead of sending to a remote service and responds these resources back on
+  # request.
+  #
+  # Additionally it adds a save! method and can be used in conjunction with Cucumber/Pickle/FactoryGirl to fully
+  # fake a back end service in the BDD cycle
+  #
+  module FakeResource
+ 
+    @@fake_resources = []
+ 
+    def self.clean
+      FakeWeb.clean_registry
+      @@fake_resources = []
+    end
+ 
+    def self.included(base)
+      base.class_eval do
+ 
+        def save
+          @@fake_resources << self
+          update_fake_responses
+        end
+ 
+        def destroy
+          @@fake_resources.delete(self)
+          update_fake_responses
+        end
+ 
+        def self.delete(id, options = {})
+          puts "delete"
+          @@fake_resources.delete_if {|r| r.id == id }
+          #update_fake_responses
+        end
+ 
+        def self.exists?(id, options = {})
+          not @@fake_resources.select {|r| r.id == id}.blank?
+        end
+ 
+      end
+    end
+ 
+    def save!
+      save
+    end
+    
+    def save
+      super
+    end
+ 
+    private
+ 
+      def update_fake_responses
+        FakeWeb.clean_registry
+ 
+        @@fake_resources.each do |r|
+          FakeWeb.register_uri(:get, element_uri, :body => r.to_xml)
+        end
+ 
+        FakeWeb.register_uri(:get, collection_uri, :body => @@fake_resources.to_xml)
+      end
+ 
+      def element_uri
+        "#{base_uri}#{element_path}"
+      end
+ 
+      def collection_uri
+        "#{base_uri}#{collection_path}"
+      end
+ 
+      def base_uri
+        "#{connection.site.scheme}://#{connection.user}:#{connection.password}@#{connection.site.host}:#{connection.site.port}"
+      end
+ 
+    end
+end

data/spec/product_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Chargify::Product do
+  
+  context 'find by handle' do
+    before do
+      @handle = 'handle1'
+      @existing_product = Factory(:product, :handle => @handle, :id => Factory.next(:product_id))
+      FakeWeb.register_uri(:get, "#{test_domain}/products/lookup.xml?handle=#{@existing_product.handle}", :body => @existing_product.attributes.to_xml)
+    end
+
+    it 'finds the correct product by handle' do
+      product = Chargify::Product.find_by_handle(@handle)
+      product.should eql(@existing_product)
+    end
+    
+    it 'is an instance of Chargify::Product' do
+      product = Chargify::Product.find_by_handle(@handle)
+      product.should be_instance_of(Chargify::Product)
+    end  
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'spec'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'chargify_api_ares'
+
+require 'fakeweb'
+require 'mocks/fake_resource'
+ActiveResource::Base.send :include, ActiveResource::FakeResource
+FakeWeb.allow_net_connect = false
+require 'factory_girl'
+require 'faker'
+
+Chargify.configure do |c|
+  c.subdomain = 'test'
+  c.api_key   = 'test'
+end
+ 
+Spec::Runner.configure do |config|
+  config.after(:each) do
+    ActiveResource::FakeResource.clean
+  end
+end
+
+def test_domain
+  "#{Chargify::Base.connection.site.scheme}://#{Chargify::Base.connection.user}:#{Chargify::Base.connection.password}@#{Chargify::Base.connection.site.host}:#{Chargify::Base.connection.site.port}"
+end

data/spec/subscription_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Chargify::Subscription do
+  
+  context 'strips nested association attributes before saving' do
+    before do
+      @subscription = Factory.build(:subscription_with_extra_attrs)
+    end
+    
+    it 'strips customer' do
+      @subscription.attributes['customer'].should_not be_blank
+      @subscription.save!
+      @subscription.attributes['customer'].should be_blank
+    end
+    
+    it 'strips product' do
+      @subscription.attributes['product'].should_not be_blank
+      @subscription.save!
+      @subscription.attributes['product'].should be_blank
+    end
+    
+    it 'strips credit card' do
+      @subscription.attributes['credit_card'].should_not be_blank
+      @subscription.save!
+      @subscription.attributes['credit_card'].should be_blank
+    end
+    
+    it 'doesn\'t strip other attrs' do
+      subscription = Factory.build(:subscription)
+      
+      lambda { subscription.save! }.should_not change(subscription, :attributes)
+    end
+  end
+  
+  it 'creates a one-time charge' do
+    id = Factory.next(:subscription_id)
+    subscription = Factory(:subscription, :id => id)
+    expected_response = {:charge => {:amount_in_cents => 1000, :memo => "one-time charge", :success => true}}.to_xml
+    FakeWeb.register_uri(:post, "#{test_domain}/subscriptions/#{id}/charges.xml?charge%5Bamount%5D=10.00&charge%5Bmemo%5D=one-time+charge", :status => 201, :body => expected_response)
+    
+    response = subscription.charge(:amount => "10.00", "memo" => "one-time charge")
+    
+    response.body.should == expected_response
+    response.should be_a(Net::HTTPCreated)
+  end
+  
+  it 'finds by customer reference' do
+    customer = Factory(:customer, :reference => 'roger', :id => 10)
+    subscription = Factory(:subscription, :id => 11, :customer_id => customer.id, :product => Factory(:product))
+    
+    expected_response = [subscription.attributes].to_xml(:root => 'subscriptions')
+    FakeWeb.register_uri(:get, "#{test_domain}/subscriptions.xml?customer_id=#{customer.id}", :status => 200, :body => expected_response)
+    
+    Chargify::Customer.stub!(:find_by_reference).with('roger').and_return(customer)
+    Chargify::Subscription.find_by_customer_reference('roger').should eql(subscription)
+  end
+  
+  it 'cancels the subscription' do
+    @subscription = Factory(:subscription, :id => 1)
+    find_subscription = lambda { Chargify::Subscription.find(1) }
+    
+    find_subscription.should_not raise_error
+    @subscription.cancel
+    find_subscription.should raise_error
+  end
+  
+end

data/spec/subscriptions_component_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Chargify::Subscription::Component do
+  before(:each) do
+    @subscription = Chargify::Subscription.new(:id => 1)
+    @sc1 = Chargify::Subscription::Component.new(
+      :subscription_id => @subscription.id,
+      :component_id => 1,
+      :allocated_quantity => 0,
+      :name => "Paying Customers",
+      :unit_name => "customers",
+      :component_type => "quantity_based_component",
+      :pricing_scheme => "stairstep"
+    )
+    @sc2 = Chargify::Subscription::Component.new(
+      :subscription_id => @subscription.id,
+      :component_id => 2,
+      :unit_balance => 0,
+      :name => "Text Messages",
+      :unit_name => "text message",
+      :component_type => "metered_component"
+    )
+    @subscriptions_components = [@sc1, @sc2]
+  end
+
+  describe "listing subscription components" do
+    before(:each) do
+      FakeWeb.register_uri(:get, "#{test_domain}/subscriptions/#{@subscription.id}.xml", :body => @subscription.to_xml)
+      FakeWeb.register_uri(:get, "#{test_domain}/subscriptions/#{@subscription.id}/components.xml", :body => @subscriptions_components.to_xml(:root => 'components'))
+    end
+    
+    it "returns an array of components from Chargify::Subscription::Component.find(:all, :params => {:subscription_id => @subscription.id})" do
+      Chargify::Subscription::Component.find(:all, :params => {:subscription_id => @subscription.id}).should == @subscriptions_components
+    end
+
+    it "returns an array of components from Chargify::Subscription.find(2).components" do
+      subscription = Chargify::Subscription.find(@subscription.id)
+      subscription.components.should == @subscriptions_components
+    end
+  end
+  
+  describe "reading a subscription component" do
+    before(:each) do
+      FakeWeb.register_uri(:get, "#{test_domain}/subscriptions/#{@subscription.id}.xml", :body => @subscription.to_xml)
+      FakeWeb.register_uri(:get, "#{test_domain}/subscriptions/#{@subscription.id}/components/#{@sc1.component_id}.xml", :body => @sc1.to_xml)
+    end
+    
+    it "returns the subscription's component resource from Chargify::Subscription::Component.find(1, :params => {:subscription_id => 1})" do
+      Chargify::Subscription::Component.find(@sc1.component_id, :params => {:subscription_id => @subscription.id}).should == @sc1
+    end
+    
+    it "returns the subscription's component resource from Chargify::Subscription.find(1).component(1)" do
+      subscription = Chargify::Subscription.find(@subscription.id)
+      subscription.component(@sc1.component_id).should == @sc1
+    end
+  end
+
+  describe "updating a subscription component" do
+    before(:each) do
+      @new_allocated_quantity = @sc1.allocated_quantity + 5
+      
+      FakeWeb.register_uri(:get, "#{test_domain}/subscriptions/#{@subscription.id}.xml", :body => @subscription.to_xml)
+      FakeWeb.register_uri(:get, "#{test_domain}/subscriptions/#{@subscription.id}/components/#{@sc1.component_id}.xml", :body => @sc1.to_xml)
+
+      @sc1_prime = @sc1
+      @sc1_prime.allocated_quantity = @new_allocated_quantity
+
+      FakeWeb.register_uri(:put, "#{test_domain}/subscriptions/#{@subscription.id}/components/#{@sc1.component_id}.xml", :body => @sc1_prime.to_xml)
+      FakeWeb.register_uri(:get, "#{test_domain}/subscriptions/#{@subscription.id}/components/#{@sc1.component_id}.xml", :body => @sc1_prime.to_xml)
+    end
+    
+    it "updates the subscription's component allocated quantity" do
+      component = Chargify::Subscription::Component.find(@sc1.component_id, :params => {:subscription_id => @subscription.id})
+      component.allocated_quantity = @new_allocated_quantity
+
+      result = component.save
+      result.should be_true
+      
+      Chargify::Subscription::Component.find(@sc1.component_id, :params => {:subscription_id => @subscription.id}).should == @sc1_prime
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: micah_chargify_api_ares
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 4
+  version: 0.3.4
+platform: ruby
+authors: 
+- Michael Klett
+- The Lab Rats @ Phase Two Labs
+- Brian Rose
+- Nathan Verni
+- Micah Wedemeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-27 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: mklett@grasshopper.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .gitignore
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- chargify_api_ares.gemspec
+- lib/chargify_api_ares.rb
+- samples/customers.rb
+- samples/metered_components.rb
+- samples/products.rb
+- samples/subscriptions.rb
+- samples/transactions.rb
+- spec/base_spec.rb
+- spec/components_spec.rb
+- spec/customer_spec.rb
+- spec/factories.rb
+- spec/mocks/fake_resource.rb
+- spec/product_spec.rb
+- spec/spec_helper.rb
+- spec/subscription_spec.rb
+- spec/subscriptions_component_spec.rb
+has_rdoc: true
+homepage: http://github.com/grasshopperlabs/chargify_api_ares
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A Chargify API wrapper for Ruby using ActiveResource
+test_files: 
+- spec/base_spec.rb
+- spec/components_spec.rb
+- spec/customer_spec.rb
+- spec/factories.rb
+- spec/mocks/fake_resource.rb
+- spec/product_spec.rb
+- spec/spec_helper.rb
+- spec/subscription_spec.rb
+- spec/subscriptions_component_spec.rb