chargify_api_ares 0.5.2 → 0.5.4

data/Gemfile.lock

@@ -1,37 +1,49 @@
 PATH
   remote: .
   specs:
-    chargify_api_ares (0.5.2)
+    chargify_api_ares (0.5.4)
       activeresource (>= 2.3.5)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.1.1)
-      activesupport (= 3.1.1)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
       builder (~> 3.0.0)
+    activeresource (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+    activesupport (3.2.12)
       i18n (~> 0.6)
-    activeresource (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
-    activesupport (3.1.1)
       multi_json (~> 1.0)
-    builder (3.0.0)
+    builder (3.0.4)
+    coderay (1.0.8)
     diff-lcs (1.1.3)
     factory_girl (2.1.2)
       activesupport
-    faker (1.0.1)
-      i18n (~> 0.4)
+    faker (1.1.2)
+      i18n (~> 0.5)
     fakeweb (1.3.0)
     growl (1.0.3)
-    guard (0.8.8)
-      thor (~> 0.14.6)
-    guard-rspec (0.5.0)
+    guard (1.6.2)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      terminal-table (>= 1.4.3)
+      thor (>= 0.14.6)
+    guard-rspec (0.5.11)
       guard (>= 0.8.4)
-    i18n (0.6.0)
-    multi_json (1.0.3)
-    rake (0.9.2.2)
-    rb-fsevent (0.4.3.1)
+    i18n (0.6.1)
+    listen (0.7.2)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    multi_json (1.6.1)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (0.9.6)
+    rb-fsevent (0.9.3)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)
@@ -40,7 +52,9 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
-    thor (0.14.6)
+    slop (3.4.3)
+    terminal-table (1.4.5)
+    thor (0.17.0)
 
 PLATFORMS
   ruby
@@ -48,10 +62,10 @@ PLATFORMS
 DEPENDENCIES
   chargify_api_ares!
   factory_girl (~> 2.1.0)
-  faker (~> 1.0.1)
+  faker (~> 1.1.2)
   fakeweb (~> 1.3.0)
   growl (~> 1.0.3)
   guard-rspec (~> 0.5.0)
   rake (~> 0.9.2)
-  rb-fsevent (~> 0.4.2)
+  rb-fsevent (~> 0.9.2)
   rspec (~> 2.7.0)

data/README.md

@@ -1,8 +1,11 @@
-Chargify API wrapper for Ruby (using ActiveResource) [![build status](https://secure.travis-ci.org/chargify/chargify_api_ares.png)](http://travis-ci.org/chargify/chargify_api_ares)
+Chargify API wrapper for Ruby (using ActiveResource)
 ====================================================
+[![build status](https://secure.travis-ci.org/chargify/chargify_api_ares.png)](http://travis-ci.org/chargify/chargify_api_ares)
 
 This is a Ruby wrapper for the [Chargify](http://chargify.com) API that leverages ActiveResource.
 
+ActiveResource versions 3.0.0 to 3.0.19 are not compatible and will throw an exception. Please use at least version 3.0.20 if on 3.0. For more information see the [relevant rails pull request](https://github.com/rails/rails/pull/8853/files).
+
 It allows you to interface with the Chargify API using simple ActiveRecord-like syntax, i.e.:
 
 ``` ruby

data/chargify_api_ares.gemspec

@@ -4,11 +4,11 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.7'
   
   s.name    = 'chargify_api_ares'
-  s.version = '0.5.2'
-  s.date    = '2012-12-15'
+  s.version = '0.5.4'
+  s.date    = '2013-02-14'
   s.summary = 'A Chargify API wrapper for Ruby using ActiveResource'
   s.description = ''
-  s.authors = ["Michael Klett", "Nathan Verni", "Rodrigo Franco", "Shay Frendt"]
+  s.authors = ["Michael Klett", "Nathan Verni", "Graham McIntire", "Rodrigo Franco", "Shay Frendt"]
   s.email = 'support@chargify.com'
   s.homepage = 'http://github.com/chargify/chargify_api_ares'
   
@@ -24,8 +24,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rspec', '~> 2.7.0')
   s.add_development_dependency('factory_girl', '~> 2.1.0')
   s.add_development_dependency('fakeweb', '~> 1.3.0')
-  s.add_development_dependency('faker', '~> 1.0.1')
+  s.add_development_dependency('faker', '~> 1.1.2')
   s.add_development_dependency('guard-rspec', '~> 0.5.0')
   s.add_development_dependency('growl', '~> 1.0.3')
-  s.add_development_dependency('rb-fsevent', '~> 0.4.2')
+  s.add_development_dependency('rb-fsevent', '~> 0.9.2')
 end

data/lib/chargify_api_ares.rb

@@ -4,6 +4,7 @@ require 'chargify_api_ares/resources/base'
 require 'chargify_api_ares/resources/component'
 require 'chargify_api_ares/resources/coupon'
 require 'chargify_api_ares/resources/customer'
+require 'chargify_api_ares/resources/event'
 require 'chargify_api_ares/resources/payment_profile'
 require 'chargify_api_ares/resources/product'
 require 'chargify_api_ares/resources/product_family'
@@ -12,3 +13,11 @@ require 'chargify_api_ares/resources/statement'
 require 'chargify_api_ares/resources/subscription'
 require 'chargify_api_ares/resources/transaction'
 require 'chargify_api_ares/resources/usage'
+require 'chargify_api_ares/resources/webhook'
+
+if defined?(::ActiveResource::VERSION::MAJOR) &&
+      ::ActiveResource::VERSION::MAJOR == 3 &&
+      ::ActiveResource::VERSION::MINOR == 0 &&
+      ::ActiveResource::VERSION::TINY < 20
+  raise RuntimeError, 'This gem is not compatible with ActiveResource versions 3.0.0 to 3.0.19, please upgrade to at least 3.0.20'
+end

data/lib/chargify_api_ares/config.rb

@@ -11,6 +11,8 @@ module Chargify
       
       self.site ||= "https://#{subdomain}.chargify.com"
       Base.site = site
+      self.format ||= :xml
+      Base.format = format
     end
   end
 end

data/lib/chargify_api_ares/resources/coupon.rb

@@ -7,7 +7,19 @@ module Chargify
     def self.find_by_product_family_id_and_code(product_family_id, code)
       find(:one, :from => :lookup, :params => {:product_family_id => product_family_id, :code => code})
     end
-    
+
+    def self.validate(params = {})
+      product_family_id = params.fetch(:product_family_id, nil)
+      coupon_code = params.fetch(:coupon_code, nil)
+
+      raise ArgumentError, 'coupon_code is a required argument' if coupon_code.blank?
+
+      params = {:coupon_code => coupon_code}
+      params.merge!(:product_family_id => product_family_id) if product_family_id.present?
+
+      find :one, :from => :validate, :params => params
+    end
+
     def usage
       get :usage
     end

data/lib/chargify_api_ares/resources/event.rb

@@ -0,0 +1,4 @@
+module Chargify
+  class Event < Base
+  end
+end

data/lib/chargify_api_ares/resources/product_family.rb

@@ -10,6 +10,34 @@ module Chargify
     
     class Component < Base
       self.prefix = "/product_families/:product_family_id/"
+
+      def self.create_path(prefix_options = {}, query_options = nil)
+        check_prefix_options(prefix_options)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}:component_kind_plural.#{format.extension}#{query_string(query_options)}"
+      end
+
+      def create_path(options = nil)
+        path = self.class.create_path(options || prefix_options)
+        path.gsub(/:component_kind_plural/, component_kind_plural)
+      end
+
+      # Create uses a different path other than the collection_path.  It is expected to POST to
+      # /product_families/:product_family_id/:plural_kind.xml
+      def create
+        connection.post(create_path, encode(:root => component_kind, :except => [:kind]), self.class.headers).tap do |response|
+          self.id = id_from_response(response)
+          load_attributes_from_response(response)
+        end
+      end
+
+      def component_kind
+        @attributes['kind']
+      end
+
+      def component_kind_plural
+        "#{self.component_kind}s"
+      end
     end
     
     class Coupon < Base

data/lib/chargify_api_ares/resources/subscription.rb

@@ -25,6 +25,11 @@ module Chargify
       params.merge!({:subscription_id => self.id})
       Component.find(:all, :params => params)
     end
+    
+    def events(params = {})
+      params.merge!(:subscription_id => self.id)
+      Event.all(:params => params)
+    end
 
     def payment_profile
       self.respond_to?('credit_card') ? credit_card : nil
@@ -98,6 +103,10 @@ module Chargify
       end
     end
 
+    class Event < Base
+      self.prefix = '/subscriptions/:subscription_id/'
+    end
+    
     class Statement < Base
       self.prefix = "/subscriptions/:subscription_id/"
     end

data/lib/chargify_api_ares/resources/webhook.rb

@@ -0,0 +1,11 @@
+module Chargify
+  class Webhook < Base
+    def self.replay(webhook_ids_array)
+      post :replay, {}, webhook_ids_array.to_xml(:root => :ids)
+    end
+
+    def replay
+      self.class.replay([self.id])
+    end
+  end
+end

data/spec/remote/remote_spec.rb

@@ -313,6 +313,58 @@ describe "Remote" do
         tx.transaction_type.should == 'refund'
       end
     end
+    
+    describe 'Webhooks' do
+      before(:all) do
+        @subscription = Chargify::Subscription.create(
+          :product_handle => pro_plan.handle,
+          :customer_reference => johnadoe.reference,
+          :payment_profile_attributes => good_payment_profile_attributes)
+      end
+
+      it 'should list all webhooks' do
+        Chargify::Webhook.all.should_not be_empty
+      end
+
+      # The sleep in the next 2 examples precludes the use of expect{foo}.to change{bar}
+      it 'should replay specified webhooks' do
+        # Note: Webhook#reload doesn't work.
+        webhook = Chargify::Webhook.first
+        last_sent_at = webhook.last_sent_at
+
+        webhook.replay
+
+        sleep 4
+        Chargify::Webhook.first.last_sent_at.should_not == last_sent_at
+      end
+
+      it 'should replay webhooks specified by id' do
+        webhooks = Chargify::Webhook.all
+        webhook_ids = [0, 1].map {|i| webhooks[i].id}
+        fetch_last_sent_times = lambda {|ary| ary.select{ |w| webhook_ids.include?(w.id) }.map(&:last_sent_at)}
+        last_sent_at_times = fetch_last_sent_times.call(webhooks)
+        Chargify::Webhook.replay(webhook_ids)
+        sleep 4
+        fetch_last_sent_times.call(Chargify::Webhook.all).should_not == last_sent_at_times
+      end
+    end
+
+    describe 'Events' do
+      before(:all) do
+        @subscription = Chargify::Subscription.create(
+          :product_handle => pro_plan.handle,
+          :customer_reference => johnadoe.reference,
+          :payment_profile_attributes => good_payment_profile_attributes)
+      end
+
+      it 'should list all events for the site' do
+        Chargify::Event.all.should_not be_empty
+      end
+
+      it 'should lits all events for a subscription' do
+        @subscription.events.should_not be_empty
+      end
+    end
   end
 
   def clear_site_data

data/spec/resources/coupon_spec.rb

@@ -37,4 +37,27 @@ describe Chargify::Coupon do
       coupons.map{|c| c.should be_instance_of(Chargify::Coupon)}
     end
   end
+
+  context '.validate' do
+    let(:coupon_1) { Factory.build(:coupon, :product_family_id => 6) }
+
+    before do
+      FakeWeb.register_uri(:get, "#{test_domain}/coupons/validate.xml?product_family_id=6&coupon_code=foobar123", :body => coupon_1.attributes.to_xml)
+      FakeWeb.register_uri(:get, "#{test_domain}/coupons/validate.xml?coupon_code=foobar123", :body => coupon_1.attributes.to_xml)
+    end
+
+    it 'returns the coupon that matches the coupon code' do
+      coupon = Chargify::Coupon.validate(:product_family_id => 6, :coupon_code => 'foobar123')
+      coupon.should be_instance_of Chargify::Coupon
+    end
+
+    it 'treats the product_family_id as an optional parameter' do
+      coupon = Chargify::Coupon.validate(:coupon_code => 'foobar123')
+      coupon.should be_instance_of Chargify::Coupon
+    end
+
+    it 'treats the coupon_code as a required parameter' do
+      expect { coupon = Chargify::Coupon.validate }.to raise_error(ArgumentError)
+    end
+  end
 end

data/spec/resources/product_family_component_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Chargify::ProductFamily::Component do
+  context 'create' do
+    let(:component) { Chargify::ProductFamily::Component }
+    let(:connection) { double('connection').as_null_object }
+    let(:response) { double('response').as_null_object }
+
+    before :each do
+      component.any_instance.stub(:connection).and_return(connection)
+      response.stub(:tap)
+    end
+
+    it 'should post to the correct url' do
+      connection.should_receive(:post) do |path, body, headers|
+        path.should == '/product_families/123/quantity_based_components.xml'
+
+        response
+      end
+
+      component.create(:product_family_id => 123, :kind => 'quantity_based_component', :name => 'Foo Component')
+    end
+
+    it 'should not include the kind attribute in the post' do
+      connection.should_receive(:post) do |path, body, headers|
+        body.should_not match(/kind/)
+
+        response
+      end
+
+      component.create(:product_family_id => 123, :kind => 'quantity_based_component', :name => 'Foo Component')
+    end
+
+    it 'should have the component kind as the root' do
+      connection.should_receive(:post) do |path, body, headers|
+        #The second line in the xml should be the root.  This saves us from using nokogiri for this one example.
+        body.split($/)[1].should match(/quantity_based_component/)
+
+        response
+      end
+
+      component.create(:product_family_id => 123, :kind => 'quantity_based_component', :name => 'Foo Component')
+    end
+  end
+end

metadata

@@ -1,124 +1,179 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: chargify_api_ares
-version: !ruby/object:Gem::Version
-  version: 0.5.2
+version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 4
+  version: 0.5.4
 platform: ruby
-authors:
+authors: 
 - Michael Klett
 - Nathan Verni
+- Graham McIntire
 - Rodrigo Franco
 - Shay Frendt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-02-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   name: activeresource
-  requirement: &70241045282040 !ruby/object:Gem::Requirement
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
         version: 2.3.5
-  type: :runtime
+  requirement: *id001
   prerelease: false
-  version_requirements: *70241045282040
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: rake
-  requirement: &70241045281580 !ruby/object:Gem::Requirement
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
         version: 0.9.2
-  type: :development
+  requirement: *id002
   prerelease: false
-  version_requirements: *70241045281580
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: rspec
-  requirement: &70241045281120 !ruby/object:Gem::Requirement
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
         version: 2.7.0
-  type: :development
+  requirement: *id003
   prerelease: false
-  version_requirements: *70241045281120
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: factory_girl
-  requirement: &70241045280660 !ruby/object:Gem::Requirement
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
         version: 2.1.0
-  type: :development
+  requirement: *id004
   prerelease: false
-  version_requirements: *70241045280660
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: fakeweb
-  requirement: &70241045280200 !ruby/object:Gem::Requirement
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
-  type: :development
+  requirement: *id005
   prerelease: false
-  version_requirements: *70241045280200
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: faker
-  requirement: &70241045279740 !ruby/object:Gem::Requirement
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  requirement: *id006
   prerelease: false
-  version_requirements: *70241045279740
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: guard-rspec
-  requirement: &70241045279280 !ruby/object:Gem::Requirement
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
         version: 0.5.0
-  type: :development
+  requirement: *id007
   prerelease: false
-  version_requirements: *70241045279280
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: growl
-  requirement: &70241045278820 !ruby/object:Gem::Requirement
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
         version: 1.0.3
-  type: :development
+  requirement: *id008
   prerelease: false
-  version_requirements: *70241045278820
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: rb-fsevent
-  requirement: &70241045278360 !ruby/object:Gem::Requirement
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  requirement: *id009
   prerelease: false
-  version_requirements: *70241045278360
-description: ''
+description: ""
 email: support@chargify.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -140,6 +195,7 @@ files:
 - lib/chargify_api_ares/resources/component.rb
 - lib/chargify_api_ares/resources/coupon.rb
 - lib/chargify_api_ares/resources/customer.rb
+- lib/chargify_api_ares/resources/event.rb
 - lib/chargify_api_ares/resources/payment_profile.rb
 - lib/chargify_api_ares/resources/product.rb
 - lib/chargify_api_ares/resources/product_family.rb
@@ -148,6 +204,7 @@ files:
 - lib/chargify_api_ares/resources/subscription.rb
 - lib/chargify_api_ares/resources/transaction.rb
 - lib/chargify_api_ares/resources/usage.rb
+- lib/chargify_api_ares/resources/webhook.rb
 - spec/factories.rb
 - spec/remote/remote.example.yml
 - spec/remote/remote_spec.rb
@@ -155,6 +212,7 @@ files:
 - spec/resources/base_spec.rb
 - spec/resources/coupon_spec.rb
 - spec/resources/customer_spec.rb
+- spec/resources/product_family_component_spec.rb
 - spec/resources/product_family_spec.rb
 - spec/resources/product_spec.rb
 - spec/resources/subscription_component_spec.rb
@@ -165,29 +223,38 @@ files:
 - spec/support/fake_resource.rb
 homepage: http://github.com/chargify/chargify_api_ares
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A Chargify API wrapper for Ruby using ActiveResource
-test_files:
+test_files: 
 - spec/factories.rb
 - spec/remote/remote.example.yml
 - spec/remote/remote_spec.rb
@@ -195,6 +262,7 @@ test_files:
 - spec/resources/base_spec.rb
 - spec/resources/coupon_spec.rb
 - spec/resources/customer_spec.rb
+- spec/resources/product_family_component_spec.rb
 - spec/resources/product_family_spec.rb
 - spec/resources/product_spec.rb
 - spec/resources/subscription_component_spec.rb