chargify_api_ares 0.6.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 603c7ec312d18a99d9cce9e2f9f0e863afbce583
+  data.tar.gz: fe3b1ee31a4d5f14dffdc98cd953b4d68dfd0869
+SHA512:
+  metadata.gz: b824586396ae701bc6f06731bec1f146733184089af858803a83cdb6ed647fcbadf7d4cbd21e27aa43da13c3dea43a81fab15fe5762756752f92346c2a104d25
+  data.tar.gz: 96f8f56782d5d83344de9a0ec73e59cb78cebd6f78fa6ec5a38bf01b014a09af204e4f7ff317ffc1f6a161a30b79782437e6dc247fa316c362cefbce4bd82383

data/.travis.yml

@@ -1,7 +1,7 @@
+language: ruby
 rvm:
-  - 1.8.7
+  - 2.0.0
+  - 1.9.3
   - 1.9.2
+  - 1.8.7
   - ree
-branches:
-  only:
-    - master

data/Gemfile.lock

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

data/HISTORY.md

@@ -0,0 +1,34 @@
+## 1.0.0 / Nov 19 2013
+
+### Backwards-incompatible changes
+* `Chargify::Subscription.charge` now returns an ActiveResource `Charge` object. In the case of an error, the `Charge` object will have `errors`, and you will not have to rescue an HTTP `422`.
+
+* Adds new `Chargify::Migration` and `Chargify::Migration::Preview` resources. These can be used as follows:
+
+```ruby
+subscription = Chargify::Subscription.find_by_customer_reference('marky-mark')
+
+# Chargify::Migration
+migration = subscription.migrate(:product_handle => "basic-plan")
+
+migration = Chargify::Migration.create(:subscription_id => subscription.id, :product_handle => "basic-plan")
+
+# Chargify::Migration::Preview
+preview = Chargify::Migration::Preview.create(:subscription_id => subscription.id, :product_handle => "basic-plan")
+
+preview = Chargify::Migration.preview(:subscription_id => subscription.id, :product_handle => "basic-plan")
+```
+
+Error handling looks like:
+
+```ruby
+migration = subscription.migrate(:product_handle => "non-existent-plan")
+migration.errors.full_messages
+# => ["Invalid Product"]
+
+preview = Chargify::Migration.preview(:subscription_id => subscription.id, :product_handle => "non-existent-plan")
+preview.errors.full_messages
+# => ["Product must be specified"]
+```
+
+See `examples/migrations.rb` and specs for more details.

data/README.md

@@ -2,15 +2,48 @@ 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)
 
+**Note:** we have bumped to v1.0.0 to indicate a backwards incompatible change to the responses from `Chargify::Subscription.charge` and `Chargify::Subscription.migrate`.  Please see the HISTORY.md for more information.
+
 **Please see important compatibility information at the bottom of this file.**
 
 This is a Ruby wrapper for the [Chargify](http://chargify.com) API that leverages ActiveResource.
 
+### Installation
+
+This library can be installed as a gem. It is hosted on [Rubygems](http://rubygems.org).
+
+You can install this library as a gem using the following command:
+
+``` bash
+$ gem install chargify_api_ares
+```
+
+### Usage
+
+Simply require this library before you use it:
+
+``` ruby
+require 'chargify_api_ares'
+```
+
+If you're using Rails 3.x, you could include this gem in your Gemfile.
+``` ruby
+gem 'chargify_api_ares'
+```
+
+Install the gem using the following command:
+$ bundle install
+
+If you're using Rails 2 you could include this gem in your configuration, i.e. in `environment.rb`
+
+``` ruby
+config.gem 'chargify_api_ares'
+```
+
 To configure api key, site, domain, and protocol you can do the
 following. Please note that this step is required.
 
-Most common usage
-----------------
+#### Most common usage
 
 ``` ruby
   Chargify.configure do |c|
@@ -19,8 +52,7 @@ Most common usage
   end
 ```
 
-Overriding the endpoint
---------------
+#### Overriding the endpoint
 
 ``` ruby
   Chargify.configure do |c|
@@ -29,8 +61,7 @@ Overriding the endpoint
   end
 ```
 
-Available configuration options
--------------------------------
+### Available configuration options
 
 | Name              | Description                                                                                      | Default      | Required                   |
 | ----------------- | -----------------------------------------------------------------------------------              | ---------    | -------------------------- |
@@ -42,6 +73,12 @@ Available configuration options
 | format            | The format of the request and response type that you want to deal with                           | xml          | No                         |
 | timeout           | The time in seconds for a request to be valid. Will raise a timeout error if exceeds time limit. | N/A          | No                         |
 
+Now you'll have access to classes the interact with the Chargify API, such as:
+
+* `Chargify::Product`  
+* `Chargify::Customer`  
+* `Chargify::Subscription`
+
 It allows you to interface with the Chargify API using simple ActiveRecord-like syntax, i.e.:
 
 ``` ruby
@@ -63,44 +100,6 @@ subscription.save
 subscription.cancel
 ```
 
-See the `examples` directory for more usage examples.
-
-### Installation
-
-This library can be installed as a gem. It is hosted on [Rubygems](http://rubygems.org).
-
-You can install this library as a gem using the following command:
-
-$ gem install chargify_api_ares
-
-### Usage
-
-Simply require this library before you use it:
-
-``` ruby
-require 'chargify_api_ares'
-```
-
-If you're using Rails 3.x, you could include this gem in your Gemfile.
-``` ruby
-gem 'chargify_api_ares'
-```
-
-Install the gem using the following command:
-$ bundle install
-
-If you're using Rails 2 you could include this gem in your configuration, i.e. in `environment.rb`
-
-``` ruby
-config.gem 'chargify_api_ares'
-```
-    
-Now you'll have access to classes the interact with the Chargify API, such as:
-
-* `Chargify::Product`  
-* `Chargify::Customer`  
-* `Chargify::Subscription`
-
 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
@@ -143,3 +142,21 @@ requests will be rejected.
 Version 0.6.x of this gem will attempt to patch your ActiveModel if you
 have an incompatible version.  To avoid this patch, you should use
 3.0.20 or higher of ActiveResource.
+
+### Contributing
+
+* Check out the latest master to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet
+* Check out the [issue
+  tracker](http://github.com/chargify/chargify_api_ares/issues) to make
+sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for the feature/bugfix
+* Please squash your commits.
+* Please try not to mess with the Rakefile, version, or history. If you
+  want to have your own version, or is otherwise necessary, that is
+fine, but please isolate it to its own commit so we can cherry-pick
+around it.
+

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.6.1'
-  s.date    = '2013-02-26'
+  s.version = '1.0.0'
+  s.date    = '2013-11-19'
   s.summary = 'A Chargify API wrapper for Ruby using ActiveResource'
   s.description = ''
-  s.authors = ["Michael Klett", "Nathan Verni", "Graham McIntire", "Jeremy W. Rowe", "Rodrigo Franco", "Shay Frendt"]
+  s.authors = ["Michael Klett", "Nathan Verni", "Graham McIntire", "Jeremy W. Rowe", "Rodrigo Franco", "Shay Frendt", "Eric Farkas"]
   s.email = 'support@chargify.com'
   s.homepage = 'http://github.com/chargify/chargify_api_ares'
   

data/examples/charges.rb

@@ -0,0 +1,33 @@
+$: << 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__), '..', 'chargify.yml'))
+
+Chargify.configure do |c|
+  c.subdomain = chargify_config['subdomain']
+  c.api_key   = chargify_config['api_key']
+end
+
+# Lookup up existing Subscription using the Customer's reference
+subscription = 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"}>
+
+# Perform a one-time charge against this subscription
+Chargify::Charge.create(:subscription_id => subscription.id, :amount => 10.00, :memo => 'Extra service')
+# => #<Chargify::Charge:0x007f80da97b6b8 @attributes={"amount"=>10.00, "memo"=>"Extra service", "id"=>43382, "amount_in_cents"=>1000, "component_id"=>nil, "created_at"=>2013-11-08 21:16:03 UTC, "ending_balance_in_cents"=>1000, "kind"=>"one_time", "payment_id"=>4383, "product_id"=>153, "starting_balance_in_cents"=>0, "success"=>true, "tax_id"=>nil, "type"=>"Charge", "transaction_type"=>"charge", "gateway_transaction_id"=>nil, "statement_id"=>25695, "customer_id"=>40210}, @prefix_options={:subscription_id=>416940}, @persisted=true, @remote_errors=nil, @validation_context=nil, @errors=#<ActiveResource::Errors:0x007f80da97b0f0 @base=#<Chargify::Charge:0x007f80da97b6b8 ...>, @messages={}>>
+
+# If a charge fails
+charge = Chargify::Charge.create(:subscription_id => subscription.id, :amount => 10.00, :memo =>'Extra service')
+# => #<Chargify::Charge:0x007f80dcc9f428 @attributes={"amount"=>10.0, "memo"=>"Extra service"}, @prefix_options={:subscription_id=>41630}, @persisted=false, @remote_errors=#<ActiveResource::ResourceInvalid: Failed.  Response code = 422.  Response message = Unprocessable Entity.>, @validation_context=nil, @errors=#<ActiveResource::Errors:0x007f80dcc9f0b8 @base=#<Chargify::Charge:0x007f80dcc9f428 ...>, @messages={:base=>["Bogus Gateway: Forced failure"]}>>
+
+charge.valid?
+# => false
+
+charge.errors.full_messages
+# => ["Bogus Gateway: Forced failure"]
+
+# Or call 'charge' right on the subscription
+subscription.charge(:amount => 10.00, :memo => 'Extra service')
+# => #<Chargify::Charge:0x007f80da97b6b8 @attributes={"amount"=>10.00, "memo"=>"Extra service", "id"=>4313282, "amount_in_cents"=>1000, "component_id"=>nil, "created_at"=>2013-11-08 21:16:03 UTC, "ending_balance_in_cents"=>1000, "kind"=>"one_time", "payment_id"=>43303, "product_id"=>153, "starting_balance_in_cents"=>0, "success"=>true, "tax_id"=>nil, "type"=>"Charge", "transaction_type"=>"charge", "gateway_transaction_id"=>nil, "statement_id"=>25695, "customer_id"=>48210}, @prefix_options={:subscription_id=>41690}, @persisted=true, @remote_errors=nil, @validation_context=nil, @errors=#<ActiveResource::Errors:0x007f80da97b0f0 @base=#<Chargify::Charge:0x007f80da97b6b8 ...>, @messages={}>>

data/examples/coupons.rb

@@ -22,7 +22,7 @@ coupon = Chargify::Coupon.create(
 )
 
 # Lookup up existing coupon using the product_family_id and the coupon code
-coupon = Chargify::Subscription::Coupon.find_by_product_family_id_and_code(2,"10OFF")
+coupon = Chargify::Coupon.find_by_product_family_id_and_code(2,"10OFF")
 
 # Looking up all coupons for a product family
 coupons = Chargify::Coupon.find_all_by_product_family_id(12345)

data/examples/migrations.rb

@@ -0,0 +1,30 @@
+$: << 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__), '..', 'chargify.yml'))
+
+Chargify.configure do |c|
+  c.subdomain = chargify_config['subdomain']
+  c.api_key   = chargify_config['api_key']
+end
+
+# Lookup up existing Subscription using the Customer's reference
+subscription = Subscription.find_by_customer_reference('marky-mark')
+
+# Migrate the subscription to a new product
+subscription.migrate(:product_handle => "basic-plan")
+# => #<Chargify::Migration:0x007fe656ab4430 @attributes={"product_id"=>20, "id"=>518, "activated_at"=>2013-11-11 20:42:57 UTC, "balance_in_cents"=>-7499, "cancel_at_end_of_period"=>false, "canceled_at"=>nil, "cancellation_message"=>nil, "created_at"=>2013-11-11 20:42:55 UTC, "current_period_ends_at"=>2013-12-12 03:54:21 UTC, "expires_at"=>nil, "next_assessment_at"=>2013-12-12 03:54:21 UTC, "payment_collection_method"=>"automatic", "state"=>"active", "trial_ended_at"=>nil, "trial_started_at"=>nil, "updated_at"=>2013-11-12 03:54:21 UTC, "current_period_started_at"=>2013-11-12 03:54:21 UTC, "previous_state"=>"active", "signup_payment_id"=>2029, "signup_revenue"=>"99.00", "delayed_cancel_at"=>nil, "coupon_code"=>nil, "total_revenue_in_cents"=>10001, "product_price_in_cents"=>2400, "product_version_number"=>2, "customer"=>#<Chargify::Customer:0x007fe656977ea0 @attributes={"address"=>nil, "address_2"=>nil, "city"=>nil, "country"=>nil, "created_at"=>2013-11-11 20:42:35 UTC, "email"=>"marky@example.com", "first_name"=>"Marky ", "id"=>518, "last_name"=>"Mark", "organization"=>nil, "phone"=>nil, "reference"=>"marky-mark", "state"=>nil, "updated_at"=>2013-11-11 20:42:35 UTC, "zip"=>nil}, @prefix_options={}, @persisted=false>, "product"=>#<Chargify::Product:0x007fe656976910 @attributes={"accounting_code"=>nil, "archived_at"=>nil, "created_at"=>2013-11-09 20:00:59 UTC, "description"=>"Eos quam veritatis quo iste et.  Quaerat dolor suscipit explicabo et sit.  Nostrum dolor commodi voluptatum similique et facere accusamus.", "expiration_interval"=>nil, "expiration_interval_unit"=>"never", "handle"=>"basic-plan", "id"=>20, "initial_charge_in_cents"=>nil, "interval"=>1, "interval_unit"=>"month", "name"=>"Basic", "price_in_cents"=>2400, "request_credit_card"=>true, "require_credit_card"=>true, "return_params"=>nil, "return_url"=>nil, "trial_interval"=>1, "trial_interval_unit"=>"month", "trial_price_in_cents"=>0, "update_return_url"=>nil, "updated_at"=>2013-11-12 03:51:18 UTC, "product_family"=>#<Chargify::ProductFamily:0x007fe6569749f8 @attributes={"accounting_code"=>nil, "description"=>nil, "handle"=>"acme-online", "id"=>3, "name"=>"Acme Online"}, @prefix_options={}, @persisted=false>}, @prefix_options={}, @persisted=false>, "credit_card"=>#<Chargify::Migration::CreditCard:0x007fe65696de78 @attributes={"type"=>"PaymentProfile", "billing_address"=>nil, "billing_address_2"=>nil, "billing_city"=>nil, "billing_country"=>nil, "billing_state"=>nil, "billing_zip"=>nil, "card_type"=>"bogus", "current_vault"=>"bogus", "customer_id"=>518, "customer_vault_token"=>nil, "expiration_month"=>1, "expiration_year"=>2023, "first_name"=>"Marky", "id"=>518, "last_name"=>"Mark", "masked_card_number"=>"XXXX-XXXX-XXXX-1", "vault_token"=>"1"}, @prefix_options={}, @persisted=false>}, @prefix_options={}, @persisted=true, @remote_errors=nil, @validation_context=nil, @errors=#<ActiveResource::Errors:0x007fe656aafd18 @base=#<Chargify::Migration:0x007fe656ab4430 ...>, @messages={}>>
+
+# Another way to migrate a subscription to a new product
+Migration.create(:subscription_id => subscription.id, :product_handle => "basic-plan")
+# => #<Chargify::Migration:0x007fe656cc8b90 @attributes={"product_id"=>20, "id"=>518, "activated_at"=>2013-11-11 20:42:57 UTC, "balance_in_cents"=>-7499, "cancel_at_end_of_period"=>false, "canceled_at"=>nil, "cancellation_message"=>nil, "created_at"=>2013-11-11 20:42:55 UTC, "current_period_ends_at"=>2013-12-12 03:53:10 UTC, "expires_at"=>nil, "next_assessment_at"=>2013-12-12 03:53:10 UTC, "payment_collection_method"=>"automatic", "state"=>"active", "trial_ended_at"=>nil, "trial_started_at"=>nil, "updated_at"=>2013-11-12 03:53:10 UTC, "current_period_started_at"=>2013-11-12 03:53:09 UTC, "previous_state"=>"active", "signup_payment_id"=>2029, "signup_revenue"=>"99.00", "delayed_cancel_at"=>nil, "coupon_code"=>nil, "total_revenue_in_cents"=>9999, "product_price_in_cents"=>2400, "product_version_number"=>2, "customer"=>#<Chargify::Customer:0x007fe6548fdbc0 @attributes={"address"=>nil, "address_2"=>nil, "city"=>nil, "country"=>nil, "created_at"=>2013-11-11 20:42:35 UTC, "email"=>"marky@example.com", "first_name"=>"Marky ", "id"=>518, "last_name"=>"Mark", "organization"=>nil, "phone"=>nil, "reference"=>"marky-mark", "state"=>nil, "updated_at"=>2013-11-11 20:42:35 UTC, "zip"=>nil}, @prefix_options={}, @persisted=false>, "product"=>#<Chargify::Product:0x007fe6548fc608 @attributes={"accounting_code"=>nil, "archived_at"=>nil, "created_at"=>2013-11-09 20:00:59 UTC, "description"=>"Eos quam veritatis quo iste et.  Quaerat dolor suscipit explicabo et sit.  Nostrum dolor commodi voluptatum similique et facere accusamus.", "expiration_interval"=>nil, "expiration_interval_unit"=>"never", "handle"=>"basic-plan", "id"=>20, "initial_charge_in_cents"=>nil, "interval"=>1, "interval_unit"=>"month", "name"=>"Basic", "price_in_cents"=>2400, "request_credit_card"=>true, "require_credit_card"=>true, "return_params"=>nil, "return_url"=>nil, "trial_interval"=>1, "trial_interval_unit"=>"month", "trial_price_in_cents"=>0, "update_return_url"=>nil, "updated_at"=>2013-11-12 03:51:18 UTC, "product_family"=>#<Chargify::ProductFamily:0x007fe6548f6820 @attributes={"accounting_code"=>nil, "description"=>nil, "handle"=>"acme-online", "id"=>3, "name"=>"Acme Online"}, @prefix_options={}, @persisted=false>}, @prefix_options={}, @persisted=false>, "credit_card"=>#<Chargify::Migration::CreditCard:0x007fe6548f5d58 @attributes={"type"=>"PaymentProfile", "billing_address"=>nil, "billing_address_2"=>nil, "billing_city"=>nil, "billing_country"=>nil, "billing_state"=>nil, "billing_zip"=>nil, "card_type"=>"bogus", "current_vault"=>"bogus", "customer_id"=>518, "customer_vault_token"=>nil, "expiration_month"=>1, "expiration_year"=>2023, "first_name"=>"Marky", "id"=>518, "last_name"=>"Mark", "masked_card_number"=>"XXXX-XXXX-XXXX-1", "vault_token"=>"1"}, @prefix_options={}, @persisted=false>}, @prefix_options={}, @persisted=true, @remote_errors=nil, @validation_context=nil, @errors=#<ActiveResource::Errors:0x007fe656cc8320 @base=#<Chargify::Migration:0x007fe656cc8b90 ...>, @messages={}>>
+
+# Preview a migration
+preview = Migration::Preview.create(:subscription_id => subscription.id, :product_handle => "basic-plan")
+# => #<Chargify::Migration::Preview:0x007fe65686fb98 @attributes={"product_id"=>20, "prorated_adjustment_in_cents"=>"-9899", "charge_in_cents"=>"2400", "payment_due_in_cents"=>"0", "credit_applied_in_cents"=>"-7499"}, @prefix_options={}, @persisted=false, @remote_errors=nil, @validation_context=nil, @errors=#<ActiveResource::Errors:0x007fe65686f260 @base=#<Chargify::Migration::Preview:0x007fe65686fb98 ...>, @messages={}>>
+
+# Another way to preview a migration
+preview = Migration.preview(:subscription_id => subscription.id, :product_handle => "basic-plan")
+# => #<Chargify::Migration::Preview:0x007fe65686fb98 @attributes={"product_id"=>20, "prorated_adjustment_in_cents"=>"-9899", "charge_in_cents"=>"2400", "payment_due_in_cents"=>"0", "credit_applied_in_cents"=>"-7499"}, @prefix_options={}, @persisted=false, @remote_errors=nil, @validation_context=nil, @errors=#<ActiveResource::Errors:0x007fe65686f260 @base=#<Chargify::Migration::Preview:0x007fe65686fb98 ...>, @messages={}>>

data/examples/subscriptions.rb

@@ -12,9 +12,11 @@ end
 
 
 # Retrieve a list of all your customers
-subscription = Chargify::Subscription.find(:all)
+subscriptions = 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}>]]
 
+# Paginate through your subscriptions
+subscriptions = Chargify::Subscription.find(:all, params: { per_page: 50, page: 3})
 
 # Create a subscription from a customer reference
 subscription = Chargify::Subscription.create(
@@ -44,8 +46,7 @@ subscription.save
 
 # Perform a one-time charge against an existing subscription
 subscription.charge(:amount => 10.00, :memo => 'Extra service')
-# => #<Net::HTTPCreated>
-
+# => #<Chargify::Charge:0x007f80da97b6b8 @attributes={"amount"=>10.00, "memo"=>"Extra service", "id"=>43010382, "amount_in_cents"=>1000, "component_id"=>nil, "created_at"=>2013-11-08 21:16:03 UTC, "ending_balance_in_cents"=>1000, "kind"=>"one_time", "payment_id"=>410383, "product_id"=>153, "starting_balance_in_cents"=>0, "success"=>true, "tax_id"=>nil, "type"=>"Charge", "transaction_type"=>"charge", "gateway_transaction_id"=>nil, "statement_id"=>25179695, "customer_id"=>40110}, @prefix_options={:subscription_id=>41630}, @persisted=true, @remote_errors=nil, @validation_context=nil, @errors=#<ActiveResource::Errors:0x007f80da97b0f0 @base=#<Chargify::Charge:0x007f80da97b6b8 ...>, @messages={}>>
 
 # Cancel a subscription
 subscription.cancel

data/lib/chargify_api_ares.rb

@@ -1,10 +1,12 @@
 require 'active_resource'
 require 'chargify_api_ares/config'
 require 'chargify_api_ares/resources/base'
+require 'chargify_api_ares/resources/charge'
 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/migration'
 require 'chargify_api_ares/resources/payment_profile'
 require 'chargify_api_ares/resources/product'
 require 'chargify_api_ares/resources/product_family'

data/lib/chargify_api_ares/resources/charge.rb

@@ -0,0 +1,5 @@
+module Chargify
+  class Charge < Base
+    self.prefix = '/subscriptions/:subscription_id/'
+  end
+end

data/lib/chargify_api_ares/resources/migration.rb

@@ -0,0 +1,43 @@
+module Chargify
+  class Migration < Base
+    self.prefix = "/subscriptions/:subscription_id/"
+    
+    def self.preview(attrs = {})
+      Chargify::Migration::Preview.create(attrs) 
+    end
+
+    def subscription
+      self.attributes["id"].present? ? Chargify::Subscription.new(self.attributes) : nil
+    end
+
+    private
+
+    # Chargify returns a non-standard XML error response for Migration.  Since the API wants to maintain
+    # backwards compatibility, we will work around that when we parse errors here by overriding the
+    # framework's `load_remote_errors` with our own for just XML
+    def load_remote_errors(remote_errors, save_cache = false)
+      case self.class.format
+      when ActiveResource::Formats[:xml]
+        array = [Hash.from_xml(remote_errors.response.body)["errors"]] rescue []
+        errors.from_array array, save_cache
+      else
+        super
+      end
+    end
+
+    class Preview < Base
+      self.prefix = "/subscriptions/:subscription_id/migrations/"
+
+      def create
+        response = post(:preview, {}, attributes.send("to_#{self.class.format.extension}", :root => :migration, :dasherize => false))
+        load_attributes_from_response(response)
+      end
+
+      private
+
+      def custom_method_new_element_url(method_name, options = {})
+        "#{self.class.prefix(prefix_options)}#{method_name}.#{self.class.format.extension}#{self.class.__send__(:query_string, options)}"
+      end
+    end
+  end
+end

data/lib/chargify_api_ares/resources/subscription.rb

@@ -39,7 +39,7 @@ module Chargify
     # 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, {}, attrs.to_xml(:root => :charge)
+      Chargify::Charge.create(attrs.merge(:subscription_id => self.id))
     end
 
     def credit(attrs = {})
@@ -59,7 +59,7 @@ module Chargify
     end
 
     def migrate(attrs = {})
-      post :migrations, :migration => attrs
+      Chargify::Migration.create(attrs.merge(:subscription_id => self.id))
     end
 
     def statement(id)

data/spec/remote/remote_spec.rb

@@ -251,6 +251,145 @@ describe "Remote" do
     end
   end
 
+  describe "failing to add a one time charge" do
+    before(:all) do
+      @subscription = Chargify::Subscription.create(
+        :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
+
+    it "is not valid when creating a charge fails" do
+      expect(@charge).to_not be_valid
+    end
+
+    it "has errors when creating a charge fails" 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)  
+    end
+
+    it "is valid when the migration is successful" do
+      expect(@migration).to be_valid
+    end
+
+    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
+  end
+
+  describe "migrating a subscription to an invalid 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 => "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
+  end
+
+  describe "previewing a valid migration via Chargify::Migration" 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(:subscription_id => @subscription.id, :product_handle => pro_plan.handle)  
+    end
+
+    it "is valid when the migration preview is successful" do
+      expect(@preview).to be_valid
+    end
+
+    it "is a proper preview" 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)  
+    end
+
+    it "is valid when the migration preview is successful" do
+      expect(@preview).to be_valid
+    end
+
+    it "is a proper preview" 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(
+        :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_id => 9999999) 
+    end
+
+    it "is invalid when the migration preview is invalid" do
+      expect(@preview).to_not be_valid
+    end
+
+    it "has errors when the migration preview is invalid" 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(
+        :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_id => 9999999) 
+    end
+
+    it "is invalid when the migration preview is invalid" do
+      expect(@preview).to_not be_valid
+    end
+
+    it "has errors when the migration preview is invalid" 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(

data/spec/resources/charge_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Chargify::Charge, :fake_resource do
+  context '#create' do
+    it 'creates a one-time charge' do
+      id = generate(:subscription_id)
+      subscription = build(: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", :status => 201, :body => expected_response)
+    
+      response = Chargify::Charge.create(:subscription_id => subscription.id, :amount => "10.00", :memo => "one-time charge")
+    
+      expect(response.valid?).to be_true
+      expect(response).to be_a(Chargify::Charge)
+    end
+  end
+end

data/spec/resources/migration_preview_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Chargify::Migration::Preview, :fake_resource do
+  context "#create" do
+    it 'migrates the subscription' do
+      id = generate(:subscription_id)
+      subscription = build(:subscription, :id => id)
+      subscription.stub!(:persisted?).and_return(true)
+      expected_response = {:migration => {:prorated_adjustment_in_cents => -12500, :charge_in_cents => 90000, :payment_due_in_cents => 77500, :credit_applied_in_cents => 0 }}.to_xml
+      
+      FakeWeb.register_uri(:post, "#{test_domain}/subscriptions/#{id}/migrations/preview.xml?product_handle=upgraded-plan", :status => 201, :body => expected_response)
+      
+      response = Chargify::Migration::Preview.create(:subscription_id => subscription.id, :product_handle => 'upgraded-plan')
+
+      expect(response.valid?).to be_true
+      expect(response.errors.any?).to be_false
+      expect(response).to be_a(Chargify::Migration::Preview)
+    end
+  end 
+end

data/spec/resources/migration_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Chargify::Migration, :fake_resource do
+  context "#create" do
+    it 'migrates the subscription' do
+      id = generate(:subscription_id)
+      subscription = build(:subscription, :id => id)
+      subscription.stub!(:persisted?).and_return(true)
+      expected_response = [subscription.attributes].to_xml(:root => 'subscription')
+      
+      FakeWeb.register_uri(:post, "#{test_domain}/subscriptions/#{id}/migrations.xml?migration%5Bproduct_handle%5D=upgraded-plan", :status => 201, :body => expected_response)
+      
+      response = Chargify::Migration.create(:subscription_id => subscription.id, :product_handle => 'upgraded-plan')
+
+      expect(response.valid?).to be_true
+      expect(response.errors.any?).to be_false
+      expect(response).to be_a(Chargify::Migration)
+    end
+  end 
+end

data/spec/resources/subscription_spec.rb

@@ -41,8 +41,8 @@ describe Chargify::Subscription, :fake_resource do
     
     response = subscription.charge(:amount => "10.00", "memo" => "one-time charge")
     
-    response.body.should == expected_response
-    response.should be_a(Net::HTTPCreated)
+    expect(response.valid?).to be_true
+    expect(response).to be_a(Chargify::Charge)
   end
   
   it 'finds by customer reference' do
@@ -76,7 +76,8 @@ describe Chargify::Subscription, :fake_resource do
     
     response = subscription.migrate(:product_handle => 'upgraded-plan')
 
-    response.body.should == expected_response
-    response.should be_a(Net::HTTPCreated)
+    expect(response.valid?).to be_true
+    expect(response.errors.any?).to be_false
+    expect(response).to be_a(Chargify::Migration)
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargify_api_ares
 version: !ruby/object:Gem::Version
-  version: 0.6.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Klett
@@ -11,31 +10,29 @@ authors:
 - Jeremy W. Rowe
 - Rodrigo Franco
 - Shay Frendt
+- Eric Farkas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2013-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -43,7 +40,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -51,7 +47,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -59,7 +54,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -67,7 +61,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -75,7 +68,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -83,7 +75,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -91,7 +82,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -99,7 +89,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -107,7 +96,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -115,7 +103,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -123,7 +110,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -131,7 +117,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: growl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -139,7 +124,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -147,7 +131,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -155,7 +138,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -163,7 +145,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -171,7 +152,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -187,23 +167,28 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - chargify_api_ares.gemspec
+- examples/charges.rb
 - examples/coupons.rb
 - examples/customers.rb
 - examples/metered_components.rb
+- examples/migrations.rb
 - examples/products.rb
 - examples/subscriptions.rb
 - examples/transactions.rb
 - lib/chargify_api_ares.rb
 - lib/chargify_api_ares/config.rb
 - lib/chargify_api_ares/resources/base.rb
+- lib/chargify_api_ares/resources/charge.rb
 - 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/migration.rb
 - lib/chargify_api_ares/resources/payment_profile.rb
 - lib/chargify_api_ares/resources/product.rb
 - lib/chargify_api_ares/resources/product_family.rb
@@ -219,8 +204,11 @@ files:
 - spec/remote/remote_helper.rb
 - spec/remote/remote_spec.rb
 - spec/resources/base_spec.rb
+- spec/resources/charge_spec.rb
 - spec/resources/coupon_spec.rb
 - spec/resources/customer_spec.rb
+- spec/resources/migration_preview_spec.rb
+- spec/resources/migration_spec.rb
 - spec/resources/product_family_component_spec.rb
 - spec/resources/product_family_spec.rb
 - spec/resources/product_spec.rb
@@ -232,28 +220,24 @@ files:
 - spec/support/fake_resource.rb
 homepage: http://github.com/chargify/chargify_api_ares
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4368782760728078099
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 3
 summary: A Chargify API wrapper for Ruby using ActiveResource
@@ -263,8 +247,11 @@ test_files:
 - spec/remote/remote_helper.rb
 - spec/remote/remote_spec.rb
 - spec/resources/base_spec.rb
+- spec/resources/charge_spec.rb
 - spec/resources/coupon_spec.rb
 - spec/resources/customer_spec.rb
+- spec/resources/migration_preview_spec.rb
+- spec/resources/migration_spec.rb
 - spec/resources/product_family_component_spec.rb
 - spec/resources/product_family_spec.rb
 - spec/resources/product_spec.rb