chargify 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wynn Netherland
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,25 @@
+= chargify
+
+Ruby wrapper for the chargify.com SAAS and billing API
+
+== Installation
+
+    sudo gem install gemcutter
+    gem tumble
+    sudo gem install chargify
+    
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   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 (c) 2009 Wynn Netherland. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "chargify"
+    gem.summary = %Q{Ruby wrapper for the chargify.com SAAS and billing API}
+    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.add_dependency('hashie', '~> 0.1.3')
+    gem.add_dependency('httparty', '~> 0.4.5')
+
+    gem.add_development_dependency('thoughtbot-shoulda', '>= 2.10.1')
+    gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
+    gem.add_development_dependency('mocha', '0.9.4')
+    gem.add_development_dependency('fakeweb', '>= 1.2.5')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "chargify #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/chargify.rb

@@ -0,0 +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'
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+Hash.send :include, Hashie::HashExtensions
+
+require File.join(directory, 'chargify', 'client')

data/lib/chargify/client.rb

@@ -0,0 +1,104 @@
+module Chargify
+  class Client
+    include HTTParty
+    format :json
+    
+    attr_reader :api_key, :subdomain
+    
+    # Your API key can be generated on the settings screen.
+    def initialize(api_key, subdomain)
+      @api_key = api_key
+      @subdomain = subdomain
+      
+      self.class.base_uri "https://#{@subdomain}.chargify.com"
+      self.class.basic_auth @api_key, 'x'
+      
+    end
+    
+    # options: page
+    def list_customers(options={})
+      customers = self.class.get("/customers.json", :query => options)
+      customers.map{|c| Hashie::Mash.new c['customer']}
+    end
+    
+    def customer(chargify_id)
+      Hashie::Mash.new(self.class.get("/customers/#{chargify_id}.json")).customer
+    end
+    
+    #
+    # * first_name (Required)
+    # * last_name (Required)
+    # * email (Required)
+    # * organization (Optional) Company/Organization name
+    # * 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
+    end
+    
+    #
+    # * first_name (Required)
+    # * last_name (Required)
+    # * email (Required)
+    # * organization (Optional) Company/Organization name
+    # * reference (Optional, but encouraged) The unique identifier used within your own application for this customer
+    # 
+    def update_customer(info={})
+      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?
+      response
+    end
+    
+    def customer_subscriptions(chargify_id)
+      subscriptions = self.class.get("/customers/#{chargify_id}/subscriptions.json")
+      subscriptions.map{|s| Hashie::Mash.new s['subscription']}
+    end
+    
+    def subscription(subscription_id)
+      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
+    end
+    
+    def list_products
+      products = self.class.get("/products.json")
+      products.map{|p| Hashie::Mash.new p['product']}
+    end
+    
+    def product(product_id)
+      Hashie::Mash.new( self.class.get("/products/#{product_id}.json")).product
+    end
+    
+    def product_by_handle(handle)
+      Hashie::Mash.new(self.class.get("/products/handle/#{handle}.json")).product
+    end
+    
+    
+  end
+end

data/test/fixtures/customer.json

@@ -0,0 +1,12 @@
+{
+    "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"
+    }
+}

data/test/fixtures/customers.json

@@ -0,0 +1,12 @@
+[{
+    "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"
+    }
+}]

data/test/fixtures/new_customer.json

@@ -0,0 +1,12 @@
+{
+    "customer": {
+        "created_at": "2009-11-18T10:56:22-05:00", 
+        "email": "wynn.netherland@gmail.com", 
+        "first_name": "Wynn", 
+        "id": 333, 
+        "last_name": "Netherland", 
+        "organization": null, 
+        "reference": null, 
+        "updated_at": "2009-11-18T10:56:22-05:00"
+    }
+}

data/test/fixtures/product.json

@@ -0,0 +1,17 @@
+{
+    "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
+    }
+}

data/test/fixtures/products.json

@@ -0,0 +1,17 @@
+[{
+    "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
+    }
+}]

data/test/fixtures/subscription.json

@@ -0,0 +1,49 @@
+{
+    "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/fixtures/subscriptions.json

@@ -0,0 +1,49 @@
+[{
+    "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

@@ -0,0 +1,54 @@
+require 'test/unit'
+require 'pathname'
+require 'rubygems'
+
+gem 'thoughtbot-shoulda', '>= 2.10.1'
+gem 'jnunemaker-matchy', '0.4.0'
+gem 'mocha', '0.9.4'
+gem 'fakeweb', '>= 1.2.5'
+
+require 'shoulda'
+require 'matchy'
+require 'mocha'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'chargify'
+
+class Test::Unit::TestCase
+end
+
+FakeWeb.allow_net_connect = false
+
+
+class Test::Unit::TestCase
+end
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+
+def stub_get(url, filename, status=nil)
+  options = {:body => fixture_file(filename)}
+  options.merge!({:status => status}) unless status.nil?
+  
+  FakeWeb.register_uri(:get, url, options)
+end
+
+def stub_post(url, filename, status=nil)
+  options = {:body => fixture_file(filename)}
+  options.merge!({:status => status}) unless status.nil?
+  
+  FakeWeb.register_uri(:post, url, options)
+end
+
+def stub_put(url, filename, status=nil)
+  options = {:body => fixture_file(filename)}
+  options.merge!({:status => status}) unless status.nil?
+  
+  FakeWeb.register_uri(:put, url, options)
+end

data/test/test_chargify.rb

@@ -0,0 +1,96 @@
+require 'helper'
+
+class TestChargify < Test::Unit::TestCase
+  context "When hitting the Chargify API" do
+    setup do
+      @client = Chargify::Client.new('OU812', 'pengwynn')
+    end
+    
+    should "return a list of customers" do
+      stub_get "https://OU812:x@pengwynn.chargify.com/customers.json", "customers.json"
+      customers = @client.list_customers
+      customers.size.should == 1
+      customers.first.reference.should == 'bradleyjoyce'
+      customers.first.organization.should == 'Squeejee'
+    end
+    
+    
+    should "return info for a customer" do
+      stub_get "https://OU812:x@pengwynn.chargify.com/customers/16.json", "customer.json"
+      customer = @client.customer(16)
+      customer.reference.should == 'bradleyjoyce'
+      customer.organization.should == 'Squeejee'
+    end
+    
+    should "create a new customer" do
+      stub_post "https://OU812:x@pengwynn.chargify.com/customers.json", "new_customer.json"
+      info = {
+        :first_name   => "Wynn",
+        :last_name    => "Netherland",
+        :email        => "wynn@example.com"
+      }
+      customer = @client.create_customer(info)
+      customer.first_name.should == "Wynn"
+    end
+    
+    should "update a customer" do
+      stub_put "https://OU812:x@pengwynn.chargify.com/customers/16.json", "new_customer.json"
+      info = {
+        :id           => 16,
+        :first_name   => "Wynn",
+        :last_name    => "Netherland",
+        :email        => "wynn@example.com"
+      }
+      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)
+      subscriptions.size.should == 1
+      subscriptions.first.customer.reference.should == "bradleyjoyce"
+    end
+    
+    
+    should "return info for a subscription" do
+      stub_get "https://OU812:x@pengwynn.chargify.com/subscriptions/13.json", "subscription.json"
+      subscription = @client.subscription(13)
+      subscription.customer.reference.should == 'bradleyjoyce'
+    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_attributes = {
+        :first_name   => "Wynn",
+        :last_name    => "Netherland",
+        :email        => "wynn@example.com"
+      }
+      subscription = @client.create_subscription(options, customer_attributes)
+      subscription.customer.organization.should == 'Squeejee'
+    end
+    
+    should "return a list of products" do
+      stub_get "https://OU812:x@pengwynn.chargify.com/products.json", "products.json"
+      products = @client.list_products
+      products.first.accounting_code.should == 'TSMO'
+    end
+    
+    should "return info for a product" do
+      stub_get "https://OU812:x@pengwynn.chargify.com/products/8.json", "product.json"
+      product = @client.product(8)
+      product.accounting_code.should == 'TSMO'
+    end
+    
+    should "return info for a product by its handle" do
+      stub_get "https://OU812:x@pengwynn.chargify.com/products/handle/tweetsaver.json", "product.json"
+      product = @client.product_by_handle('tweetsaver')
+      product.accounting_code.should == 'TSMO'
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: chargify
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Wynn Netherland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-18 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.10.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-matchy
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.5
+    version: 
+description: Ruby wrapper for the chargify.com SAAS and billing API
+email: wynn.netherland@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/chargify.rb
+- lib/chargify/client.rb
+- test/fixtures/customer.json
+- test/fixtures/customers.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
+has_rdoc: true
+homepage: http://github.com/pengwynn/chargify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the chargify.com SAAS and billing API
+test_files: 
+- test/helper.rb
+- test/test_chargify.rb