chargify_api_ares 0.3.3 → 0.3.4

data/.gitignore

@@ -1,2 +1,3 @@
-config
-pkg
+config/remote.yml
+pkg
+.rvmrc

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/chargify_api_ares.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chargify_api_ares}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   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.date = %q{2010-08-03}
   s.description = %q{}
   s.email = %q{mklett@grasshopper.com}
   s.extra_rdoc_files = [
@@ -23,17 +23,22 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "chargify_api_ares.gemspec",
+     "config/remote.example.yml",
      "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/remote/remote_spec.rb",
+     "spec/remote/spec_helper.rb",
+     "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/subscription_spec.rb",
      "spec/subscriptions_component_spec.rb"
@@ -50,6 +55,8 @@ Gem::Specification.new do |s|
      "spec/factories.rb",
      "spec/mocks/fake_resource.rb",
      "spec/product_spec.rb",
+     "spec/remote/remote_spec.rb",
+     "spec/remote/spec_helper.rb",
      "spec/spec_helper.rb",
      "spec/subscription_spec.rb",
      "spec/subscriptions_component_spec.rb"

data/config/remote.example.yml

@@ -0,0 +1,7 @@
+# Copy this file to config/remote.yml and make adjustments as necessary.
+#
+# Note: Remote tests will only work when configured to run on a test site that uses the Bogus gateway.
+# Warning: all data in the site specified by 'subdomain' will be cleared and replaced with test data.
+run_tests: true
+subdomain: yoursubdomain
+api_key: xxx

data/lib/chargify_api_ares.rb

@@ -50,29 +50,25 @@ end
 module Chargify
   
   class << self
-    attr_accessor :subdomain, :api_key, :site, :format
+    attr_accessor :subdomain, :api_key, :site, :format, :timeout
     
     def configure
       yield self
       
       Base.user      = api_key
       Base.password  = 'X'
+      Base.timeout   = timeout unless (timeout.blank?)
       
-      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
+      self.site ||= "https://#{subdomain}.chargify.com"
+
+      Base.site                     = site
+      Subscription::Component.site  = site + "/subscriptions/:subscription_id"
     end
   end
   
   class Base < ActiveResource::Base
-    class << self
-      def element_name
-        name.split(/::/).last.underscore
-      end
+    def self.element_name
+      name.split(/::/).last.underscore
     end
     
     def to_xml(options = {})
@@ -81,10 +77,26 @@ module Chargify
     end
   end
   
+  class Site < Base
+    def self.clear_data!
+      post(:clear_data)
+    end
+  end
+  
   class Customer < Base
     def self.find_by_reference(reference)
       Customer.new get(:lookup, :reference => reference)
     end
+    
+    def subscriptions(params = {})
+      params.merge!({:customer_id => self.id})
+      Subscription.find(:all, :params => params)
+    end
+
+    def payment_profiles(params = {})
+      params.merge!({:customer_id => self.id})
+      PaymentProfile.find(:all, :params => params)
+    end
   end
   
   class Subscription < Base
@@ -114,6 +126,10 @@ module Chargify
       Component.find(:all, :params => params)
     end
     
+    def payment_profile
+      credit_card
+    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
@@ -121,6 +137,18 @@ module Chargify
       post :charges, :charge => attrs
     end
     
+    def credit(attrs = {})
+      post :credits, :credit => attrs
+    end
+    
+    def reactivate(params = {})
+      put :reactivate, params
+    end
+    
+    def reset_balance
+      put :reset_balance
+    end
+    
     def transactions()
       Transaction.find(:all, :params =>{:subscription_id => self.id})
     end
@@ -137,9 +165,30 @@ module Chargify
     def self.find_by_handle(handle)
       Product.new get(:lookup, :handle => handle)
     end
+    
+    protected
+    
+    # Products are created in the scope of a ProductFamily, i.e. /product_families/nnn/products
+    #
+    # This alters the collection path such that it uses the product_family_id that is set on the 
+    # attributes.
+    def create
+      pfid = begin
+        self.product_family_id
+      rescue NoMethodError
+        0
+      end
+      connection.post("/product_families/#{pfid}/products.#{self.class.format.extension}", encode, self.class.headers).tap do |response|
+        self.id = id_from_response(response)
+        load_attributes_from_response(response)
+      end
+    end
   end
   
   class ProductFamily < Base
+    def self.find_by_handle(handle, attributes = {})
+      ProductFamily.find(:one, :from => :lookup, :handle => handle)
+    end
   end
     
   class Usage < Base
@@ -157,4 +206,7 @@ module Chargify
   class Transaction < Base
   end
   
+  class PaymentProfile < Base
+  end
+  
 end

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/remote/remote_spec.rb

@@ -0,0 +1,446 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+if run_remote_tests?
+  describe "Remote" do
+    before(:all) do
+      clear_site_data
+      setup_plans
+      setup_customer
+    end
+    
+    describe "creating a new subscription to a product with a trial" do
+      context "when providing valid attributes for the customer and the payment profile" do
+        before(:each) do
+          @subscription = create_once(:subscription) do
+            Chargify::Subscription.create(
+              :product_handle => @@basic_plan.handle,
+              :customer_attributes => valid_customer_attributes,
+              :payment_profile_attributes => good_payment_profile_attributes
+            )
+          end
+        end
+        
+        it "successfully creates the subscription" do
+          @subscription.should be_a(Chargify::Subscription)
+        end
+        
+        it "sets the current_period_started_at attribute to now" do
+          @subscription.current_period_started_at.utc.should be_close(now.utc, approximately)
+        end
+        
+        it "sets the current_period_ends_at attribute to 1 month from now" do
+          @subscription.current_period_ends_at.utc.should be_close(one_month_from_now.utc, approximately)
+        end
+        
+        it "is in the trialing state" do
+          @subscription.state.should == 'trialing'
+        end
+      end
+    end
+    
+    describe "creating a new subscription to a product without a trial" do
+      context "when providing an existing customer reference and valid payment profile attributes" do
+        before(:each) do
+          @subscription = create_once(:subscription) do
+            Chargify::Subscription.create(
+              :product_handle => @@pro_plan.handle,
+              :customer_reference => @@johnadoe.reference,
+              :payment_profile_attributes => good_payment_profile_attributes
+            )
+          end
+        end
+        
+        it "successfully creates the subscription" do
+          @subscription.should be_a(Chargify::Subscription)
+        end
+        
+        it "sets the current_period_started_at attribute to now" do
+          @subscription.current_period_started_at.utc.should be_close(now.utc, approximately)
+        end
+        
+        it "sets the current_period_ends_at attribute to 1 month from now" do
+          @subscription.current_period_ends_at.utc.should be_close(one_month_from_now.utc, approximately)
+        end
+        
+        it "is in the active state" do
+          @subscription.state.should == 'active'
+        end
+        
+        it "belongs to the existing customer" do
+          @subscription.customer.should == @@johnadoe
+        end
+      end
+
+      context "when providing an existing customer reference and an existing payment profile" do
+        before(:each) do
+          @subscription = create_once(:subscription) do
+            Chargify::Subscription.create(
+              :product_handle => @@pro_plan.handle,
+              :customer_reference => @@johnadoe.reference,
+              :payment_profile_id => @@johnadoes_credit_card.id.to_s
+            )
+          end
+        end
+        
+        it "successfully creates the subscription" do
+          @subscription.should be_a(Chargify::Subscription)
+        end
+        
+        it "is in the active state" do
+          @subscription.state.should == 'active'
+        end
+        
+        it "belongs to the existing customer" do
+          @subscription.customer.should == @@johnadoe
+        end
+        
+        it "uses the provided credit card" do
+          expected_card = Chargify::PaymentProfile.find(@@johnadoes_credit_card.id)
+          @subscription.payment_profile.id.should == @@johnadoes_credit_card.id
+          @subscription.payment_profile.attributes.should == expected_card.attributes
+        end
+      end
+
+      context "when providing valid attributes for the customer and attributes for a credit card that cannot be stored" do
+        before(:each) do
+          @customer_attributes = valid_customer_attributes.dup
+          @subscription = create_once(:subscription) do
+            Chargify::Subscription.create(
+              :product_handle => @@basic_plan.handle,
+              :customer_attributes => @customer_attributes,
+              :payment_profile_attributes => unstorable_payment_profile_attributes
+            )
+          end
+        end
+        
+        it "does not create the subscription" do
+          @subscription.should_not be_valid
+        end
+      
+        it "does not create the customer" do
+          lambda {
+            Chargify::Customer.find_by_reference(@customer_attributes[:reference])
+          }.should raise_error(ActiveResource::ResourceNotFound)
+        end
+      end
+
+    end
+    
+    describe "importing a subscription to a product with a trial and a next billing date 10 days from now" do
+      context "when giving valid attributes for the customer and the payment profile" do
+        before(:each) do
+          @subscription = create_once(:subscription) do
+            Chargify::Subscription.create(
+              :product_handle => @@basic_plan.handle,
+              :customer_attributes => valid_customer_attributes,
+              :payment_profile_attributes => pretokenized_card_attributes,
+              :next_billing_at => ten_days_from_now.utc
+            )
+          end
+        end
+        
+        it "successfully creates the subscription" do
+          @subscription.should be_a(Chargify::Subscription)
+        end
+        
+        it "sets the current_period_started_at attribute to now" do
+          @subscription.current_period_started_at.utc.should be_close(now.utc, approximately)
+        end
+    
+        it "sets the current_period_ends_at attribute to 1 month from now" do
+          @subscription.current_period_ends_at.utc.should be_close(ten_days_from_now.utc, approximately)
+        end
+        
+        it "is in the active state" do
+          @subscription.state.should == 'active'
+        end
+      end
+    end
+
+    describe "creating failed subscriptions" do
+      context "due to providing payment profile attribtues for a card that will be declined" do
+        before(:each) do
+          @customer_attributes = valid_customer_attributes.dup
+          @subscription = create_once(:subscription) do
+            Chargify::Subscription.create(
+              :product_handle => @@pro_plan.handle,
+              :customer_attributes => @customer_attributes,
+              :payment_profile_attributes => declined_payment_profile_attributes
+            )
+          end
+        end
+      
+        it "does not create the subscription" do
+          @subscription.should_not be_valid
+        end
+      
+        it "does not create the customer" do
+          lambda {
+            Chargify::Customer.find_by_reference(@customer_attributes[:reference])
+          }.should raise_error(ActiveResource::ResourceNotFound)
+        end
+      end
+    end
+    
+    describe "cancelling a subscription" do
+      before(:each) do
+        @subscription = create_once(:subscription) do
+          Chargify::Subscription.create(
+            :product_handle => @@pro_plan.handle,
+            :customer_reference => @@johnadoe.reference,
+            :payment_profile_attributes => good_payment_profile_attributes
+          )
+        end
+        @subscription.cancel
+      end
+      
+      it "is in the canceled state" do
+        Chargify::Subscription.find(@subscription.id).state.should == 'canceled'
+      end
+    end
+    
+    describe "reactivating a subscriptions" do
+      before(:each) do
+        @subscription = create_once(:subscription) do
+          Chargify::Subscription.create(
+            :product_handle => @@pro_plan.handle,
+            :customer_reference => @@johnadoe.reference,
+            :payment_profile_attributes => good_payment_profile_attributes
+          )
+        end
+        @subscription.cancel
+        @subscription.reload.state.should == 'canceled'
+        @subscription.reactivate
+      end
+      
+      it "puts it in the active state" do
+        @subscription.reload.state.should == 'active'
+      end
+    end
+    
+    describe "adding a one time charge" do
+      before(:each) do
+        @subscription = create_once(:subscription) do
+          Chargify::Subscription.create(
+            :product_handle => @@pro_plan.handle,
+            :customer_reference => @@johnadoe.reference,
+            :payment_profile_attributes => good_payment_profile_attributes
+          )
+        end
+      end
+      it "creates a charge and payment" do
+        lambda{
+          @subscription.charge(:amount => 7, :memo => 'One Time Charge')
+        }.should change{@subscription.reload.transactions.size}.by(2)
+        @subscription.transactions.first.amount_in_cents.should == 700
+      end
+    end
+    
+    describe "adding a credit" do
+      before(:each) do
+        @subscription = create_once(:subscription) do
+          Chargify::Subscription.create(
+            :product_handle => @@pro_plan.handle,
+            :customer_reference => @@johnadoe.reference,
+            :payment_profile_attributes => good_payment_profile_attributes
+          )
+        end
+      end
+      
+      it "creates a credit" do
+        lambda{
+          @subscription.credit(:amount => 7, :memo => 'credit')
+        }.should change{@subscription.reload.transactions.size}.by(1)
+        @subscription.transactions.first.amount_in_cents.should == 700
+      end
+    end
+    
+    def already_cleared_site_data?
+      @@already_cleared_site_data ||= nil
+      @@already_cleared_site_data == true
+    end
+    
+    def cleared_site_data!
+      @@already_cleared_site_data = true
+    end
+    
+    def clear_site_data
+      return if already_cleared_site_data?
+      begin
+        Chargify::Site.clear_data!
+        cleared_site_data!
+      rescue ActiveResource::ForbiddenAccess
+        raise StandardError.new("Remote specs may only be run against a site in test mode")
+      end
+    end
+
+    # Create Basic and Pro products in the Acme Projects family
+    def setup_plans
+      begin
+        @@acme_projects ||= Chargify::ProductFamily.find_by_handle('acme-projects')
+      rescue ActiveResource::ResourceNotFound
+        @@acme_projects = Chargify::ProductFamily.new(
+          :name => "Acme Projects"
+        )
+        result = @@acme_projects.save
+        result.should be_true
+      end
+  
+      begin
+        @@basic_plan ||= Chargify::Product.find_by_handle('basic')
+      rescue ActiveResource::ResourceNotFound
+        @@basic_plan = Chargify::Product.new(
+          :product_family_id => @@acme_projects.id,
+          :name => "Basic Plan",
+          :handle => "basic",
+          :price_in_cents => 1000,
+          :interval => 1,
+          :interval_unit => 'month',
+          :trial_interval => 1,
+          :trial_interval_unit => 'month',
+          :trial_price_in_cents => 0
+        )
+        result = @@basic_plan.save
+        result.should be_true
+      end
+
+      begin
+        @@pro_plan ||= Chargify::Product.find_by_handle('pro')
+      rescue ActiveResource::ResourceNotFound
+        @@pro_plan = Chargify::Product.new(
+          :product_family_id => @@acme_projects.id,
+          :name => "Pro Plan",
+          :handle => "pro",
+          :price_in_cents => 5000,
+          :interval => 1,
+          :interval_unit => 'month'
+        )
+        result = @@pro_plan.save
+        result.should be_true
+      end
+    end
+
+    def setup_customer
+      # Create a customer
+      begin
+        @@johnadoe ||= Chargify::Customer.find_by_reference('a')
+      rescue ActiveResource::ResourceNotFound
+        @@johnadoe = Chargify::Customer.new(valid_customer_attributes)
+        result = @@johnadoe.save
+        result.should be_true
+        
+        @@johnadoes_credit_card = Chargify::PaymentProfile.new(
+          good_payment_profile_attributes.merge(:customer_id => @@johnadoe.id)
+        )
+        result = @@johnadoes_credit_card.save
+        result.should be_true
+      end
+    end
+    
+    def now
+      Time.now
+    end
+  
+    def one_month_from_now
+      Time.now + 1.month
+    end
+  
+    def ten_days_from_now
+      10.days.from_now
+    end
+  
+    # Gives a reasonable range for time comparisons
+    def approximately
+      @approximately ||= 5.minutes
+    end
+  
+    def valid_customer_attributes
+      initial = next_customer_initial
+      {
+        :first_name => "John #{initial.upcase}",
+        :last_name => "Doe",
+        :email => "john.#{initial}.doe@example.com",
+        :reference => initial
+      }
+    end
+  
+    def good_payment_profile_attributes
+      {
+        :full_number => '1',
+        :expiration_month => '12',
+        :expiration_year => Time.now.year + 1
+      }
+    end
+
+    def declined_payment_profile_attributes
+      {
+        :full_number => '2',
+        :expiration_month => '12',
+        :expiration_year => Time.now.year + 1
+      }
+    end
+
+    def unstorable_payment_profile_attributes
+      {
+        :full_number => '3',
+        :expiration_month => '12',
+        :expiration_year => Time.now.year + 1
+      }
+    end
+
+    def expired_payment_profile_attributes
+      {
+        :full_number => '1',
+        :expiration_month => '12',
+        :expiration_year => Time.now.year - 1
+      }
+    end
+  
+    def pretokenized_card_attributes
+      {
+        :vault_token => '1',
+        :current_vault => 'bogus',
+        :expiration_month => '12',
+        :expiration_year => Time.now.year + 1,
+        :last_four => '1234',
+        :card_type => 'visa'
+      }
+    end
+  
+    # Don't create more than 26 customers until we add more initials :)
+    def next_customer_initial
+      @@customer_initial_index ||= 0
+      initial = customer_initials[@@customer_initial_index]
+      @@customer_initial_index += 1
+      initial
+    end
+  
+    # An array of intials
+    def customer_initials
+      @customer_initials ||= ('a'..'z').to_a
+    end
+
+    # Allows us to create remote resources once per spec hierarchy
+    def create_once(type, &block)
+      hierarchy = example_group_hierarchy.collect(&:object_id).to_s
+
+      unless resource(type, hierarchy)
+        register_resource(type, hierarchy, block.call)
+      end
+      resource(type, hierarchy)
+    end
+  
+    def resource(type, hierarchy)
+      @@resources ||= {}
+      @@resources[type] ||= {}
+      @@resources[type][hierarchy]
+    end
+  
+    def register_resource(type, hierarchy, resource)
+      @@resources ||= {}
+      @@resources[type] ||= {}
+      @@resources[type][hierarchy] = resource
+    end
+
+  end
+end

data/spec/remote/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'spec'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+
+require 'chargify_api_ares'
+
+Spec::Runner.configure do |config|
+  config.before(:all) do
+    Chargify.configure do |c|
+      c.subdomain = remote_configuration['subdomain']
+      c.api_key = remote_configuration['api_key']
+      if remote_configuration['site']
+        c.site = remote_configuration['site']
+      end
+    end
+  end
+end
+
+def run_remote_tests?
+  remote_configuration['run_tests'] === true
+end
+
+def remote_configuration
+  @remote_configuration ||= load_remote_configuration_file
+end
+
+private
+
+def load_remote_configuration_file
+  configuration_file = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'config', 'remote.yml'))
+  if File.exist?(configuration_file)
+    YAML.load_file(configuration_file)
+  else
+    {}
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/spec/subscription_spec.rb

@@ -63,5 +63,4 @@ describe Chargify::Subscription do
     @subscription.cancel
     find_subscription.should raise_error
   end
-  
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chargify_api_ares
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Michael Klett
@@ -17,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-24 00:00:00 -04:00
+date: 2010-08-03 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -37,17 +38,22 @@ files:
 - Rakefile
 - VERSION
 - chargify_api_ares.gemspec
+- config/remote.example.yml
 - 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/remote/remote_spec.rb
+- spec/remote/spec_helper.rb
+- spec/spec.opts
 - spec/spec_helper.rb
 - spec/subscription_spec.rb
 - spec/subscriptions_component_spec.rb
@@ -61,23 +67,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Chargify API wrapper for Ruby using ActiveResource
@@ -88,6 +98,8 @@ test_files:
 - spec/factories.rb
 - spec/mocks/fake_resource.rb
 - spec/product_spec.rb
+- spec/remote/remote_spec.rb
+- spec/remote/spec_helper.rb
 - spec/spec_helper.rb
 - spec/subscription_spec.rb
 - spec/subscriptions_component_spec.rb