chargify_api_ares 0.2.5 → 0.3.1

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.3.1

data/chargify_api_ares.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chargify_api_ares}
-  s.version = "0.2.5"
+  s.version = "0.3.1"
 
   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-03-18}
+  s.date = %q{2010-04-16}
   s.description = %q{}
   s.email = %q{mklett@grasshopper.com}
   s.extra_rdoc_files = [
@@ -35,7 +35,8 @@ Gem::Specification.new do |s|
      "spec/mocks/fake_resource.rb",
      "spec/product_spec.rb",
      "spec/spec_helper.rb",
-     "spec/subscription_spec.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"]
@@ -50,7 +51,8 @@ Gem::Specification.new do |s|
      "spec/mocks/fake_resource.rb",
      "spec/product_spec.rb",
      "spec/spec_helper.rb",
-     "spec/subscription_spec.rb"
+     "spec/subscription_spec.rb",
+     "spec/subscriptions_component_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/chargify_api_ares.rb

@@ -56,8 +56,15 @@ module Chargify
       yield self
       
       Base.user      = api_key
-      Base.password  = 'X'      
-      Base.site      = site.blank? ? "https://#{subdomain}.chargify.com" : site
+      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
   
@@ -98,12 +105,28 @@ module Chargify
       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
+    
+    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

data/samples/metered_components.rb

@@ -13,7 +13,9 @@ Chargify.configure do |c|
   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)

data/spec/factories.rb

@@ -47,3 +47,16 @@ 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/product_spec.rb

@@ -6,7 +6,6 @@ describe Chargify::Product do
     before do
       @handle = 'handle1'
       @existing_product = Factory(:product, :handle => @handle, :id => Factory.next(:product_id))
-      puts @existing_product.attributes.to_xml
       FakeWeb.register_uri(:get, "#{test_domain}/products/lookup.xml?handle=#{@existing_product.handle}", :body => @existing_product.attributes.to_xml)
     end
 

data/spec/spec_helper.rb

@@ -25,4 +25,4 @@ 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
+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

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 5
-  version: 0.2.5
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Michael Klett
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-18 00:00:00 -04:00
+date: 2010-04-16 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -50,6 +50,7 @@ files:
 - 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: []
@@ -89,3 +90,4 @@ test_files:
 - spec/product_spec.rb
 - spec/spec_helper.rb
 - spec/subscription_spec.rb
+- spec/subscriptions_component_spec.rb