chargify_api_ares 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 068fdf18d68304e12298e546b2c2d8d6a74edd2f
-  data.tar.gz: 93999e1561575a8a3ee53bfdcc4975bf1d84bf1f
+  metadata.gz: 2caae8888bb7f0c0d3b233532c05ce0d38276965
+  data.tar.gz: d7924e0dfccd7f0077f06a78e6779a87b7f65c40
 SHA512:
-  metadata.gz: 07cddfce56890486b484d5a3f12d4acad608cdabcef31788f713ce74a75e4a3db3fa55cb9d2b4036317d5fb515162a365120856871fb6b3f64c8ee51e6866fc3
-  data.tar.gz: f41b1837ce9b83b4f38f1dc913f0d45f2370638a564d70c162824d5bac47de23d36b6f4d9fa5ab400c015c2701f3743dcf8198b4a04a2e08ee257cd37fcf2f0b
+  metadata.gz: 13c421925c09b7062a12ac605d97bf2e02dcef6b8dbd45640bb8134253f7ed217cc2489667680266f5bd53ce0b708170dfe8a5fbd0cef2016f9ae9abf40088a1
+  data.tar.gz: 9c9ad7f26b9f0e1900ad026b464b95a8507949f264e0289d0d8d1a66f28da7f7352c7f20d3ab80f89394e680783a89d23f7a293d32b31271e1e3512a892329c1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargify_api_ares (1.0.3)
+    chargify_api_ares (1.0.5)
       activeresource (>= 3.0.0)
 
 GEM

data/README.md

@@ -100,6 +100,27 @@ subscription.save
 subscription.cancel
 ```
 
+##### Note
+
+Updating nested resources is _not_ supported nor recommended. If you wish to update a subscriptions customer please do so by updating the customer object itself.
+
+Bad:
+
+```ruby
+subscription = Chargify::Subscription.find(123)
+subscription.customer.first_name = 'fred'
+subscription.customer.save
+```
+
+Good:
+
+```ruby
+subscription = Chargify::Subscription.find(123)
+customer     = Chargify::Customer.find(subscription.customer.id)
+customer.first_name = 'fred'
+customer.save
+```
+
 Check out the examples in the `examples` directory.  If you're not familiar with how ActiveResource works, you may be interested in some [ActiveResource Documentation](http://apidock.com/rails/ActiveResource/Base)
 
 ### Compatibility

data/chargify_api_ares.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.7'
 
   s.name    = 'chargify_api_ares'
-  s.version = '1.0.4'
+  s.version = '1.0.5'
   s.date    = '2014-01-21'
   s.summary = 'A Chargify API wrapper for Ruby using ActiveResource'
   s.description = ''

data/lib/chargify_api_ares.rb

@@ -1,5 +1,6 @@
 require 'active_resource'
 require 'chargify_api_ares/config'
+require 'chargify_api_ares/response_helper'
 require 'chargify_api_ares/resources/base'
 require 'chargify_api_ares/resources/charge'
 require 'chargify_api_ares/resources/component'

data/lib/chargify_api_ares/resources/coupon.rb

@@ -1,9 +1,11 @@
 module Chargify
   class Coupon < Base
+    include ResponseHelper
+
     def self.find_all_by_product_family_id(product_family_id)
       Coupon.find(:all, :params => { :product_family_id => product_family_id })
     end
-    
+
     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
@@ -21,7 +23,9 @@ module Chargify
     end
 
     def usage
-      get :usage
+      process_capturing_errors do
+        get :usage
+      end
     end
 
     def archive

data/lib/chargify_api_ares/resources/invoice.rb

@@ -1,6 +1,6 @@
 module Chargify
   class Invoice < Base
-    
+
     def self.find_by_invoice_id(id)
       find(:first, params: {id: id})
     end
@@ -8,7 +8,7 @@ module Chargify
     def self.find_by_subscription_id(id)
       find(:all, params: {subscription_id: id})
     end
-  
+
     def self.unpaid_from_subscription(subscription_id)
       find(:all, params: {subscription_id: subscription_id, state: "unpaid"})
     end
@@ -17,4 +17,4 @@ module Chargify
       find(:all, params: {state: "unpaid"})
     end
   end
-end
+end

data/lib/chargify_api_ares/resources/product.rb

@@ -3,7 +3,7 @@ module Chargify
     def self.find_by_handle(handle)
       find(:one, :from => :lookup, :params => {:handle => handle})
     end
-    
+
     protected
 
     # Products are created in the scope of a ProductFamily, i.e. /product_families/nnn/products

data/lib/chargify_api_ares/resources/product_family.rb

@@ -3,11 +3,11 @@ module Chargify
     def self.find_by_handle(handle, attributes = {})
       ProductFamily.find(:one, :from => :lookup, :params => { :handle => handle })
     end
-    
+
     class Product < Base
       self.prefix = "/product_families/:product_family_id/"
     end
-    
+
     class Component < Base
       self.prefix = "/product_families/:product_family_id/"
 
@@ -39,16 +39,16 @@ module Chargify
         "#{self.component_kind}s"
       end
     end
-    
+
     class Coupon < Base
       self.prefix = "/product_families/:product_family_id/"
     end
-    
+
     def products(params = {})
       params.merge!(:product_family_id => self.id)
       ::Chargify::ProductFamily::Product.find(:all, :params => params)
     end
-    
+
     def components(params = {})
       params.merge!({:product_family_id => self.id})
       ::Chargify::ProductFamily::Component.find(:all, :params => params)

data/lib/chargify_api_ares/resources/subscription.rb

@@ -1,5 +1,7 @@
 module Chargify
   class Subscription < Base
+    include ResponseHelper
+
     def self.find_by_customer_reference(reference)
       customer = Customer.find_by_reference(reference)
       find(:first, :params => {:customer_id => customer.id})
@@ -25,7 +27,7 @@ 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)
@@ -43,19 +45,27 @@ module Chargify
     end
 
     def credit(attrs = {})
-      post :credits, {}, attrs.to_xml(:root => :credit)
+      process_capturing_errors do
+        post :credits, {}, attrs.to_xml(:root => :credit)
+      end
     end
 
     def refund(attrs = {})
-      post :refunds, {}, attrs.to_xml(:root => :refund)
+      process_capturing_errors do
+        post :refunds, {}, attrs.to_xml(:root => :refund)
+      end
     end
 
     def reactivate(params = {})
-      put :reactivate, params
+      process_capturing_errors do
+        put :reactivate, params
+      end
     end
 
     def reset_balance
-      put :reset_balance
+      process_capturing_errors do
+        put :reset_balance
+      end
     end
 
     def migrate(attrs = {})
@@ -79,21 +89,29 @@ module Chargify
     end
 
     def adjustment(attrs = {})
-      post :adjustments, {}, attrs.to_xml(:root => :adjustment)
+      process_capturing_errors do
+        post :adjustments, {}, attrs.to_xml(:root => :adjustment)
+      end
     end
 
     def add_coupon(code)
-      post :add_coupon, :code => code
+      process_capturing_errors do
+        post :add_coupon, :code => code
+      end
     end
 
     def remove_coupon(code=nil)
-      if code.nil?
-        delete :remove_coupon
-      else
-        delete :remove_coupon, :code => code
+      process_capturing_errors do
+        if code.nil?
+          delete :remove_coupon
+        else
+          delete :remove_coupon, :code => code
+        end
       end
     end
 
+    private
+
     class Component < Base
       self.prefix = "/subscriptions/:subscription_id/"
 
@@ -106,7 +124,7 @@ module Chargify
     class Event < Base
       self.prefix = '/subscriptions/:subscription_id/'
     end
-    
+
     class Statement < Base
       self.prefix = "/subscriptions/:subscription_id/"
     end

data/lib/chargify_api_ares/resources/usage.rb

@@ -3,7 +3,7 @@ module Chargify
     def subscription_id=(i)
       self.prefix_options[:subscription_id] = i
     end
-    
+
     def component_id=(i)
       self.prefix_options[:component_id] = i
     end

data/lib/chargify_api_ares/resources/webhook.rb

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

data/lib/chargify_api_ares/response_helper.rb

@@ -0,0 +1,17 @@
+module Chargify
+  module ResponseHelper
+    private
+    def process_capturing_errors(&block)
+      begin
+        yield if block_given?
+      rescue ActiveResource::ResourceInvalid => error
+        if :xml == Chargify.format.to_sym
+          self.errors.from_xml(error.response.body)
+        else
+          self.errors.from_json(error.response.body)
+        end
+      end
+      self
+    end
+  end
+end

data/spec/remote/remote_spec.rb

@@ -235,6 +235,25 @@ describe "Remote" do
     end
   end
 
+  describe 'failing to reactivate a subscription' do
+    before(:all) do
+      @reactivated_subscription = Chargify::Subscription.create(
+        :product_handle => pro_plan.handle,
+        :customer_reference => johnadoe.reference,
+        :payment_profile_attributes => good_payment_profile_attributes)
+
+      @result = @reactivated_subscription.reactivate
+    end
+
+    it "is not valid after a reactivation" do
+      expect(@result.errors.any?).to be_true
+    end
+
+    it 'has errors when the reactivation fails' do
+      expect(@result.errors.full_messages.first).to eql 'Cannot reactivate a subscription that is not marked "Canceled", "Unpaid", or "Trial Ended".'
+    end
+  end
+
   describe "adding a one time charge" do
     before(:all) do
       @subscription = Chargify::Subscription.create(
@@ -257,7 +276,7 @@ describe "Remote" do
         :product_handle => basic_plan.handle,
         :customer_reference => johnadoe.reference,
         :payment_profile_attributes => declined_payment_profile_attributes)
-      
+
       @charge = @subscription.charge(:amount => 7, :memo => 'One Time Charge')
     end
 
@@ -269,15 +288,15 @@ describe "Remote" do
       expect(@charge.errors.full_messages.first).to eql "Bogus Gateway: Forced failure"
     end
   end
-  
+
   describe "migrating a subscription to a valid product" do
     before(:all) do
       @subscription = Chargify::Subscription.create(
         :product_handle => basic_plan.handle,
         :customer_reference => johnadoe.reference,
         :payment_profile_attributes => good_payment_profile_attributes)
-      
-      @migration = @subscription.migrate(:product_handle => pro_plan.handle)  
+
+      @migration = @subscription.migrate(:product_handle => pro_plan.handle)
     end
 
     it "is valid when the migration is successful" do
@@ -287,7 +306,7 @@ describe "Remote" do
     it "migrates the product" do
       expect(@migration.subscription.product.handle).to eql "pro"
     end
-    
+
     it "has a subscription" do
       expect(@migration.subscription).to_not be_nil
     end
@@ -299,18 +318,18 @@ describe "Remote" do
         :product_handle => basic_plan.handle,
         :customer_reference => johnadoe.reference,
         :payment_profile_attributes => good_payment_profile_attributes)
-      
-      @migration = @subscription.migrate(:product_handle => "a-bad-handle")  
+
+      @migration = @subscription.migrate(:product_handle => "a-bad-handle")
     end
 
     it "is invalid when the migration is not successful" do
       expect(@migration).to_not be_valid
     end
-    
+
     it "is has errors when the migration is not successful" do
       expect(@migration.errors.full_messages.first).to eql "Invalid Product"
     end
-    
+
     it "will not have a subscription" do
       expect(@migration.subscription).to be_nil
     end
@@ -322,7 +341,7 @@ describe "Remote" do
         :product_handle => basic_plan.handle,
         :customer_reference => johnadoe.reference,
         :payment_profile_attributes => good_payment_profile_attributes)
-      @preview = Chargify::Migration.preview(:subscription_id => @subscription.id, :product_handle => pro_plan.handle)  
+      @preview = Chargify::Migration.preview(:subscription_id => @subscription.id, :product_handle => pro_plan.handle)
     end
 
     it "is valid when the migration preview is successful" do
@@ -333,14 +352,14 @@ describe "Remote" do
       expect(@preview.charge_in_cents).to eql "5000"
     end
   end
-  
+
   describe "previewing a valid migration via Chargify::Migration::Preview" do
     before(:all) do
       @subscription = Chargify::Subscription.create(
         :product_handle => basic_plan.handle,
         :customer_reference => johnadoe.reference,
         :payment_profile_attributes => good_payment_profile_attributes)
-      @preview = Chargify::Migration::Preview.create(:subscription_id => @subscription.id, :product_handle => pro_plan.handle)  
+      @preview = Chargify::Migration::Preview.create(:subscription_id => @subscription.id, :product_handle => pro_plan.handle)
     end
 
     it "is valid when the migration preview is successful" do
@@ -351,7 +370,7 @@ describe "Remote" do
       expect(@preview.charge_in_cents).to eql "5000"
     end
   end
-  
+
   describe "previewing an invalid migration via Chargify::Migration" do
     before(:all) do
       @subscription = Chargify::Subscription.create(
@@ -359,7 +378,7 @@ describe "Remote" do
         :customer_reference => johnadoe.reference,
         :payment_profile_attributes => good_payment_profile_attributes)
 
-      @preview = Chargify::Migration.preview(:subscription_id => @subscription.id, :product_id => 9999999) 
+      @preview = Chargify::Migration.preview(:subscription_id => @subscription.id, :product_id => 9999999)
     end
 
     it "is invalid when the migration preview is invalid" do
@@ -370,7 +389,7 @@ describe "Remote" do
       expect(@preview.errors.full_messages.first).to eql "Product must be specified"
     end
   end
-  
+
   describe "previewing an invalid migration via Chargify::Migration::Preview" do
     before(:all) do
       @subscription = Chargify::Subscription.create(
@@ -378,7 +397,7 @@ describe "Remote" do
         :customer_reference => johnadoe.reference,
         :payment_profile_attributes => good_payment_profile_attributes)
 
-      @preview = Chargify::Migration::Preview.create(:subscription_id => @subscription.id, :product_id => 9999999) 
+      @preview = Chargify::Migration::Preview.create(:subscription_id => @subscription.id, :product_id => 9999999)
     end
 
     it "is invalid when the migration preview is invalid" do
@@ -389,7 +408,7 @@ describe "Remote" do
       expect(@preview.errors.full_messages.first).to eql "Product must be specified"
     end
   end
-  
+
   describe "adding a credit" do
     before(:all) do
       @subscription = Chargify::Subscription.create(
@@ -404,6 +423,11 @@ describe "Remote" do
       }.should change{@subscription.reload.transactions.size}.by(1)
       most_recent_transaction(@subscription).amount_in_cents.should == -700
     end
+
+    it 'responds with errors when request is invalid' do
+      response = @subscription.credit(:amount => nil)
+      expect(response.errors.full_messages.first).to eql "Amount in cents: is not a number."
+    end
   end
 
   describe "adding a refund" do
@@ -422,6 +446,12 @@ describe "Remote" do
     end
 
     context "via Chargify::Subscription#refund" do
+
+      it 'responds with an error if params are not present' do
+        response = @subscription.refund(:payment_id => @payment.id)
+        expect(response.errors.full_messages.first).to eql("Memo: cannot be blank.")
+      end
+
       it "creates a refund" do
         lambda{
           @subscription.refund :payment_id => @payment.id, :amount => 7,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargify_api_ares
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Michael Klett
@@ -198,6 +198,7 @@ files:
 - lib/chargify_api_ares/resources/transaction.rb
 - lib/chargify_api_ares/resources/usage.rb
 - lib/chargify_api_ares/resources/webhook.rb
+- lib/chargify_api_ares/response_helper.rb
 - lib/patches/activemodel_3_0_patch.rb
 - spec/factories.rb
 - spec/remote/remote.example.yml
@@ -238,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 3
 summary: A Chargify API wrapper for Ruby using ActiveResource
@@ -263,4 +264,3 @@ test_files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/fake_resource.rb
-has_rdoc: