chargify 0.1.0 → 0.2.0

data/README.markdown

@@ -1,15 +1,15 @@
-= chargify
+# chargify
 
 Ruby wrapper for the chargify.com SAAS and billing API
 
-== Installation
+## Installation
 
     sudo gem install gemcutter
     gem tumble
     sudo gem install chargify
     
 
-== Note on Patches/Pull Requests
+## Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -20,6 +20,6 @@ Ruby wrapper for the chargify.com SAAS and billing API
    bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+### Copyright
 
-Copyright (c) 2009 Wynn Netherland. See LICENSE for details.
+Copyright (c) 2009 [Wynn Netherland](http://wynnnetherland.com). See LICENSE for details.

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.description = %Q{Ruby wrapper for the chargify.com SAAS and billing API}
     gem.email = "wynn.netherland@gmail.com"
     gem.homepage = "http://github.com/pengwynn/chargify"
-    gem.authors = ["Wynn Netherland"]
+    gem.authors = ["Wynn Netherland","Nash Kabbara"]
     
     gem.add_dependency('hashie', '~> 0.1.3')
     gem.add_dependency('httparty', '~> 0.4.5')

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/changelog.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.2.0 January 26, 2010
+
+* Substantial fixes and convenience enhancements from [@nkabbara](http://github.com/nkabbara)
+
+## 0.1.0 November 18, 2009
+
+* Initial version

data/chargify.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{chargify}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Wynn Netherland", "Nash Kabbara"]
+  s.date = %q{2010-01-26}
+  s.description = %q{Ruby wrapper for the chargify.com SAAS and billing API}
+  s.email = %q{wynn.netherland@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "changelog.md",
+     "chargify.gemspec",
+     "lib/chargify.rb",
+     "lib/chargify/client.rb",
+     "test/fixtures/customer.json",
+     "test/fixtures/customers.json",
+     "test/fixtures/deleted_subscription.json",
+     "test/fixtures/invalid_subscription.json",
+     "test/fixtures/new_customer.json",
+     "test/fixtures/product.json",
+     "test/fixtures/products.json",
+     "test/fixtures/subscription.json",
+     "test/fixtures/subscriptions.json",
+     "test/helper.rb",
+     "test/test_chargify.rb"
+  ]
+  s.homepage = %q{http://github.com/pengwynn/chargify}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby wrapper for the chargify.com SAAS and billing API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_chargify.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, ["~> 0.1.3"])
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.4.5"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 2.10.1"])
+      s.add_development_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
+      s.add_development_dependency(%q<mocha>, ["= 0.9.4"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2.5"])
+    else
+      s.add_dependency(%q<hashie>, ["~> 0.1.3"])
+      s.add_dependency(%q<httparty>, ["~> 0.4.5"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 2.10.1"])
+      s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
+      s.add_dependency(%q<mocha>, ["= 0.9.4"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.5"])
+    end
+  else
+    s.add_dependency(%q<hashie>, ["~> 0.1.3"])
+    s.add_dependency(%q<httparty>, ["~> 0.4.5"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 2.10.1"])
+    s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
+    s.add_dependency(%q<mocha>, ["= 0.9.4"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2.5"])
+  end
+end
+

data/lib/chargify.rb

@@ -1,16 +1,16 @@
 require 'rubygems'
 
-gem 'oauth', '~> 0.3.5'
-require 'oauth'
-
 gem 'hashie', '~> 0.1.3'
 require 'hashie'
 
 gem 'httparty', '~> 0.4.5'
 require 'httparty'
 
+gem 'json', '~> 1.1.9'
+require "json"
+
 directory = File.expand_path(File.dirname(__FILE__))
 
 Hash.send :include, Hashie::HashExtensions
 
-require File.join(directory, 'chargify', 'client')
+require File.join(directory, 'chargify', 'client')

data/lib/chargify/client.rb

@@ -1,7 +1,22 @@
 module Chargify
+  class UnexpectedResponseError < RuntimeError;end
+
+  def self.custom_parser
+    proc do |data|  
+      begin
+        Crack::JSON.parse(data)
+      rescue => e
+        error_msg = "Crack could not parse JSON. It said: #{e.message}. Chargify's raw response: #{data}"
+        raise UnexpectedResponseError, error_msg
+      end
+    end
+  end
+    
   class Client
     include HTTParty
     format :json
+    parser Chargify::custom_parser
+    headers 'Content-Type' => 'application/json' 
     
     attr_reader :api_key, :subdomain
     
@@ -33,8 +48,8 @@ module Chargify
     # * reference (Optional, but encouraged) The unique identifier used within your own application for this customer
     # 
     def create_customer(info={})
-      response = Hashie::Mash.new(self.class.post("/customers.json", :body => {:customer => info}))
-      return response.customer unless response.customer.blank?
+      response = Hashie::Mash.new(self.class.post("/customers.json", :body => {:customer => info}.to_json))
+      return response.customer if response.customer
       response
     end
     
@@ -49,7 +64,7 @@ module Chargify
       info.stringify_keys!
       chargify_id = info.delete('id')
       response = Hashie::Mash.new(self.class.put("/customers/#{chargify_id}.json", :body => {:customer => info}))
-      return response.customer unless response.customer.blank?
+      return response.customer unless response.customer.to_a.empty?
       response
     end
     
@@ -62,30 +77,33 @@ module Chargify
       Hashie::Mash.new(self.class.get("/subscriptions/#{subscription_id}.json")).subscription
     end
     
-    # When creating a subscription, you must specify a product, a customer, and payment (credit card) details.
-    # 
-    # The product may be specified by product_id or by product_handle (API Handle).
-    # 
-    # An existing customer may be specified by a customer_id (ID within Chargify) or a customer_reference (unique value within your app that you have shared with Chargify via the reference attribute on a customer). A new customer may be created by providing customer_attributes.
-    # 
-    #     * product_handle The API Handle of the product for which you are creating a subscription. Required, unless a product_id is given instead.
-    #     * product_id The Product ID of the product for which you are creating a subscription. The product ID is not currently published, so we recommend using the API Handle instead.
-    #     * customer_id The ID of an existing customer within Chargify. Required, unless a customer_reference or a set of customer_attributes is given.
-    #     * customer_reference The reference value (provided by your app) of an existing customer within Chargify. Required, unless a customer_id or a set of customer_attributes is given.
-    #     * customer_attributes
-    #           o first_name The first name of the customer. Required when creating a customer via attributes.
-    #           o last_name The last name of the customer. Required when creating a customer via attributes.
-    #           o email The email address of the customer. Required when creating a customer via attributes.
-    #           o organization The organization/company of the customer. Optional.
-    #           o reference A customer "reference", or unique identifier from your app, stored in Chargify. Can be used so that you may reference your customers within Chargify using the same unique value you use in your application. Optional.
-    # 
-    def create_subscription(options, customer_attributes={})
-      options.merge({:customer_attributes => customer_attributes}) unless customer_attributes.blank?
-      response = Hashie::Mash.new(self.class.post("/subscriptions.json", :body => options))
-      return response.subscription unless response.subscription.blank?
-      response
+    # Returns all elements outputted by Chargify plus:
+    # response.success? -> true if response code is 201, false otherwise
+    def create_subscription(subscription_attributes={})
+      raw_response = self.class.post("/subscriptions.json", :body => {:subscription => subscription_attributes}.to_json)
+      created  = true if raw_response.code == 201
+      response = Hashie::Mash.new(raw_response)
+      (response.subscription || response).update(:success? => created)
     end
-    
+
+    # Returns all elements outputted by Chargify plus:
+    # response.success? -> true if response code is 200, false otherwise
+    def update_subscription(sub_id, subscription_attributes = {})
+      raw_response = self.class.put("/subscriptions/#{sub_id}.json", :body => {:subscription => subscription_attributes}.to_json)
+      updated      = true if raw_response.code == 200
+      response     = Hashie::Mash.new(raw_response)
+      (response.subscription || response).update(:success? => updated)
+    end
+
+    # Returns all elements outputted by Chargify plus:
+    # response.success? -> true if response code is 200, false otherwise
+    def cancel_subscription(sub_id, message="")
+      raw_response = self.class.delete("/subscriptions/#{sub_id}.json", :body => {:subscription => {:cancellation_message => message} }.to_json)
+      deleted      = true if raw_response.code == 200
+      response     = Hashie::Mash.new(raw_response)
+      (response.subscription || response).update(:success? => deleted)
+    end
+
     def list_products
       products = self.class.get("/products.json")
       products.map{|p| Hashie::Mash.new p['product']}
@@ -99,6 +117,5 @@ module Chargify
       Hashie::Mash.new(self.class.get("/products/handle/#{handle}.json")).product
     end
     
-    
   end
-end
+end

data/test/fixtures/deleted_subscription.json

@@ -0,0 +1 @@
+{"created_at":"Tue Jan 26 18:40:32 -0600 2010","activated_at":"Tue Jan 26 18:40:33 -0600 2010","expires_at":null,"cancellation_message":"Optional message","trial_ended_at":null,"updated_at":"Tue Jan 26 18:40:35 -0600 2010","credit_card":{"card_type":"bogus","expiration_year":2013,"masked_card_number":"XXXX-XXXX-XXXX-1","expiration_month":3,"last_name":"Indicisive","first_name":"John"},"id":3642,"current_period_ends_at":"Fri Feb 26 18:40:32 -0600 2010","product":{"product_family":{"name":"ZipZoomAuto","handle":"zipzoomauto","accounting_code":null,"id":268,"description":""},"name":"Basic Plan","handle":"basic","price_in_cents":5000,"accounting_code":"","id":689,"interval":1,"description":"","interval_unit":"month"},"success?":true,"customer":{"reference":"11654","created_at":"Tue Jan 26 18:40:32 -0600 2010","updated_at":"Tue Jan 26 18:40:32 -0600 2010","id":3546,"last_name":"Indicisive","organization":null,"email":"john@doe.com","first_name":"John"},"trial_started_at":null,"balance_in_cents":0,"current_period_started_at":"Tue Jan 26 18:40:32 -0600 2010","state":"canceled"}

data/test/fixtures/invalid_subscription.json

@@ -0,0 +1,48 @@
+    "subscription": {
+        "customer": {
+            "reference": "bradleyjoyce",
+            "updated_at": "2009-10-07T11:10:27-04:00",
+            "id": 16,
+            "organization": "Squeejee",
+            "first_name": "Bradley",
+            "last_name": "Joyce",
+            "email": "bradley@squeejee.com",
+            "created_at": "2009-10-07T11:10:27-04:00"
+        },
+        "cancellation_message": null,
+        "updated_at": "2009-10-07T11:10:56-04:00",
+        "expires_at": null,
+        "activated_at": "2009-10-23T16:16:59-04:00",
+        "current_period_started_at": "2009-11-14T11:10:56-05:00",
+        "credit_card": {
+            "card_type": "bogus",
+            "expiration_year": 2015,
+            "masked_card_number": "XXXX-XXXX-XXXX-1",
+            "first_name": "Bradley",
+            "last_name": "Joyce",
+            "expiration_month": 7
+        },
+        "trial_ended_at": "2009-10-14T11:10:56-04:00",
+        "id": 14,
+        "product": {
+            "price_in_cents": 500,
+            "name": "Monthly",
+            "handle": "monthly",
+            "id": 8,
+            "accounting_code": "TSMO",
+            "product_family": {
+                "name": "TweetSaver",
+                "handle": "tweetsaver",
+                "id": 7,
+                "accounting_code": null
+            },
+            "interval_unit": "month",
+            "interval": 1
+        },
+        "current_period_ends_at": "2009-12-14T11:10:56-05:00",
+        "trial_started_at": "2009-10-07T11:10:56-04:00",
+        "balance_in_cents": 0,
+        "state": "active",
+        "created_at": "2009-10-07T11:10:56-04:00"
+    }
+}

data/test/helper.rb

@@ -51,4 +51,11 @@ def stub_put(url, filename, status=nil)
   options.merge!({:status => status}) unless status.nil?
   
   FakeWeb.register_uri(:put, url, options)
-end
+end
+
+def stub_delete(url, filename, status=nil)
+  options = {:body => fixture_file(filename)}
+  options.merge!({:status => status}) unless status.nil?
+  
+  FakeWeb.register_uri(:delete, url, options)
+end

data/test/test_chargify.rb

@@ -5,6 +5,22 @@ class TestChargify < Test::Unit::TestCase
     setup do
       @client = Chargify::Client.new('OU812', 'pengwynn')
     end
+
+    should "raise UnexpectedResponseError when reponse is invalid JSON" do
+      stub_post "https://OU812:x@pengwynn.chargify.com/subscriptions.json", "invalid_subscription.json"
+      options = {
+        :product_handle     => 'monthly',
+        :customer_reference => 'bradleyjoyce',
+        :customer_attributes => {
+          :first_name   => "Wynn",
+          :last_name    => "Netherland",
+          :email        => "wynn@example.com"
+        }
+      }
+      assert_raise Chargify::UnexpectedResponseError do
+        @client.create_subscription(options)
+      end
+    end
     
     should "return a list of customers" do
       stub_get "https://OU812:x@pengwynn.chargify.com/customers.json", "customers.json"
@@ -44,7 +60,7 @@ class TestChargify < Test::Unit::TestCase
       customer = @client.update_customer(info)
       customer.first_name.should == "Wynn"
     end
-    
+
     should "return a list of customer subscriptions" do
       stub_get "https://OU812:x@pengwynn.chargify.com/customers/16/subscriptions.json", "subscriptions.json"
       subscriptions = @client.customer_subscriptions(16)
@@ -59,20 +75,116 @@ class TestChargify < Test::Unit::TestCase
       subscription.customer.reference.should == 'bradleyjoyce'
     end
     
+    should "update a customer subscription" do
+      stub_put "https://OU812:x@pengwynn.chargify.com/subscriptions/123.json", "subscription.json"
+      options = {
+        :product_handle     => 'monthly',
+        :customer_reference => 'bradleyjoyce',
+        :customer_attributes => {
+          :first_name   => "Wynn",
+          :last_name    => "Netherland",
+          :email        => "wynn@example.com"
+        }
+      }
+      subscription = @client.update_subscription(123, options)
+      subscription.customer.organization.should == 'Squeejee'
+    end
+
+    should "set success? to true when subscription is updated successfully" do
+      stub_put "https://OU812:x@pengwynn.chargify.com/subscriptions/123.json", "subscription.json", 200
+      options = {
+        :product_handle     => 'monthly',
+        :customer_reference => 'bradleyjoyce',
+        :customer_attributes => {
+          :first_name   => "Wynn",
+          :last_name    => "Netherland",
+          :email        => "wynn@example.com"
+        }
+      }
+      subscription = @client.update_subscription(123, options)
+      subscription.success?.should == true
+    end
+
+    should "set success? to false when subscription is not updated successfully" do
+      stub_put "https://OU812:x@pengwynn.chargify.com/subscriptions/123.json", "subscription.json", 500
+      options = {
+        :product_handle     => 'monthly',
+        :customer_reference => 'bradleyjoyce',
+        :customer_attributes => {
+          :first_name   => "Wynn",
+          :last_name    => "Netherland",
+          :email        => "wynn@example.com"
+        }
+      }
+      subscription = @client.update_subscription(123, options)
+      subscription.success?.should == nil
+    end
+    
     should "create a customer subscription" do
       stub_post "https://OU812:x@pengwynn.chargify.com/subscriptions.json", "subscription.json"
       options = {
         :product_handle     => 'monthly',
-        :customer_reference => 'bradleyjoyce'
+        :customer_reference => 'bradleyjoyce',
+        :customer_attributes => {
+          :first_name   => "Wynn",
+          :last_name    => "Netherland",
+          :email        => "wynn@example.com"
+        }
       }
-      customer_attributes = {
-        :first_name   => "Wynn",
-        :last_name    => "Netherland",
-        :email        => "wynn@example.com"
-      }
-      subscription = @client.create_subscription(options, customer_attributes)
+      subscription = @client.create_subscription(options)
       subscription.customer.organization.should == 'Squeejee'
     end
+
+    should "set success? to true when subscription is created successfully" do 
+      stub_post "https://OU812:x@pengwynn.chargify.com/subscriptions.json", "subscription.json", 201
+      options = {
+        :product_handle     => 'monthly',
+        :customer_reference => 'bradleyjoyce',
+        :customer_attributes => {
+          :first_name   => "Wynn",
+          :last_name    => "Netherland",
+          :email        => "wynn@example.com"
+        }
+      }
+      subscription = @client.create_subscription(options)
+      subscription.success?.should == true
+    end
+
+    should "set success? to nil when subscription is not created successfully" do 
+      stub_post "https://OU812:x@pengwynn.chargify.com/subscriptions.json", "subscription.json", 400
+      options = {
+        :product_handle     => 'monthly',
+        :customer_reference => 'bradleyjoyce',
+        :customer_attributes => {
+          :first_name   => "Wynn",
+          :last_name    => "Netherland",
+          :email        => "wynn@example.com"
+        }
+      }
+      subscription = @client.create_subscription(options)
+      subscription.success?.should == nil
+    end
+
+    should "cancel subscription" do
+      stub_delete "https://OU812:x@pengwynn.chargify.com/subscriptions/123.json", "deleted_subscription.json", 200
+      subscription = @client.cancel_subscription(123)
+
+      subscription.state.should == "canceled"
+    end
+
+    should "set success? to nil when subscription is not cancelled successfully" do
+      stub_delete "https://OU812:x@pengwynn.chargify.com/subscriptions/123.json", "deleted_subscription.json", 500
+      subscription = @client.cancel_subscription(123)
+
+      subscription.success?.should == nil
+    end
+
+    should "set success? to true when subscription is cancelled successfully" do
+      stub_delete "https://OU812:x@pengwynn.chargify.com/subscriptions/123.json", "deleted_subscription.json", 200
+      subscription = @client.cancel_subscription(123)
+
+      subscription.success?.should == true
+    end
     
     should "return a list of products" do
       stub_get "https://OU812:x@pengwynn.chargify.com/products.json", "products.json"
@@ -93,4 +205,4 @@ class TestChargify < Test::Unit::TestCase
     end
     
   end
-end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: chargify
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Wynn Netherland
+- Nash Kabbara
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-11-18 00:00:00 -06:00
+date: 2010-01-26 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,10 +89,14 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- changelog.md
+- chargify.gemspec
 - lib/chargify.rb
 - lib/chargify/client.rb
 - test/fixtures/customer.json
 - test/fixtures/customers.json
+- test/fixtures/deleted_subscription.json
+- test/fixtures/invalid_subscription.json
 - test/fixtures/new_customer.json
 - test/fixtures/product.json
 - test/fixtures/products.json