vitalish-chargify_api_ares 0.3.9

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree@chargify_ree

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Grasshopper Group, LLC
+
+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.md

@@ -0,0 +1,80 @@
+Chargify API wrapper for Ruby (using ActiveResource)
+====================================================
+
+chargify_api_ares
+-----------------
+
+This is a Ruby wrapper for the [Chargify](http://chargify.com) API that leverages ActiveResource.
+It allows you to interface with the Chargify API using simple ActiveRecord-like syntax, i.e.:
+
+    Chargify::Subscription.create(
+      :customer_reference => 'moklett',
+      :product_handle => 'chargify-api-ares-test',
+      :credit_card_attributes => {
+        :first_name => "Michael",
+        :last_name => "Klett",
+        :expiration_month => 1,
+        :expiration_year => 2010,
+        :full_number => "1234-1234-1234-1234"
+      }
+    )
+    
+    subscription.credit_card_attributes = {:expiration_year => 2013}
+    subscription.save
+    
+    subscription.cancel
+
+See the `samples` directory for more usage examples.
+
+
+### Installation
+
+This library can be installed as a gem.  It is hosted on [Gemcutter](http://gemcutter.org).
+
+If you don't have your system set up to use gemcutter, follow the instructions on their site
+<http://gemcutter.org>, i.e.:
+
+$ gem install gemcutter
+$ gem tumble
+
+This will install Gemcutter and set your gem sources to search the gemcutter repos.
+
+Then you can install this library as a gem:
+
+$ gem install chargify_api_ares
+
+
+### Requirements
+
+This library requires ActiveResource version 2.3.4 or greater.
+
+$ gem install activeresource
+
+
+### Usage
+
+Simply require this library before you use it:
+
+    require 'chargify_api_ares'
+    
+
+If you're using Rails, you could include this gem in your configuration, i.e. in `environment.rb`
+
+    config.gem 'chargify_api_ares'
+    
+
+Now you'll have access to classes the interact with the Chargify API, such as:
+
+`Chargify::Product`  
+`Chargify::Customer`  
+`Chargifiy::Subscription`
+
+Check out the examples in the `samples` directory.  If you're not familiar with how ActiveResource works,
+you may be interested in some [ActiveResource Documentation](http://apidock.com/rails/ActiveResource/Base)
+
+
+
+### Contributors
+
+* Michael Klett (Grasshopper Labs and Chargify)
+* The Lab Rats @ Phase Two Labs

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "chargify_api_ares"
+    gemspec.summary = "A Chargify API wrapper for Ruby using ActiveResource"
+    gemspec.description = ""
+    gemspec.email = "mklett@grasshopper.com"
+    gemspec.homepage = "http://github.com/grasshopperlabs/chargify_api_ares"
+    gemspec.authors = ["Michael Klett", "The Lab Rats @ Phase Two Labs", "Brian Rose","Nathan Verni"]
+    Jeweler::GemcutterTasks.new
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.9

data/chargify_api_ares.gemspec

@@ -0,0 +1,75 @@
+# 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_api_ares}
+  s.version = "0.3.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Klett", "Nathan Verni", "The Lab Rats @ Phase Two Labs", "Brian Rose"]
+  s.date = %q{2011-3-2}
+  s.description = %q{}
+  s.email = %q{mklett@grasshopper.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE.txt",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "chargify_api_ares.gemspec",
+     "config/remote.example.yml",
+     "lib/chargify_api_ares.rb",
+     "samples/customers.rb",
+     "samples/metered_components.rb",
+     "samples/products.rb",
+     "samples/subscriptions.rb",
+     "samples/transactions.rb",
+     "spec/base_spec.rb",
+     "spec/components_spec.rb",
+     "spec/customer_spec.rb",
+     "spec/factories.rb",
+     "spec/mocks/fake_resource.rb",
+     "spec/product_spec.rb",
+     "spec/remote/remote_spec.rb",
+     "spec/remote/spec_helper.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/subscription_spec.rb",
+     "spec/subscriptions_component_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/grasshopperlabs/chargify_api_ares}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Chargify API wrapper for Ruby using ActiveResource}
+  s.test_files = [
+    "spec/base_spec.rb",
+     "spec/components_spec.rb",
+     "spec/customer_spec.rb",
+     "spec/factories.rb",
+     "spec/mocks/fake_resource.rb",
+     "spec/product_spec.rb",
+     "spec/remote/remote_spec.rb",
+     "spec/remote/spec_helper.rb",
+     "spec/spec_helper.rb",
+     "spec/subscription_spec.rb",
+     "spec/subscriptions_component_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/config/remote.example.yml

@@ -0,0 +1,7 @@
+# Copy this file to config/remote.yml and make adjustments as necessary.
+#
+# Note: Remote tests will only work when configured to run on a test site that uses the Bogus gateway.
+# Warning: all data in the site specified by 'subdomain' will be cleared and replaced with test data.
+run_tests: true
+subdomain: yoursubdomain
+api_key: xxx

data/lib/chargify_api_ares.rb

@@ -0,0 +1,277 @@
+# Chargify API Wrapper using ActiveResource.
+#
+begin
+  require 'active_resource'
+rescue LoadError
+  begin
+    require 'rubygems'
+    require 'active_resource'
+  rescue LoadError
+    abort <<-ERROR
+The 'activeresource' library could not be loaded. If you have RubyGems 
+installed you can install ActiveResource by doing "gem install activeresource".
+ERROR
+  end
+end
+
+
+# Version check
+module Chargify
+  MIN_VERSION = '2.3.4'
+end
+require 'active_resource/version'
+unless Gem::Version.new(ActiveResource::VERSION::STRING) >= Gem::Version.new(Chargify::MIN_VERSION)
+  abort <<-ERROR
+    ActiveResource version #{Chargify::MIN_VERSION} or greater is required.
+  ERROR
+end
+
+# Patch ActiveResource version 2.3.4
+if ActiveResource::VERSION::STRING == '2.3.4'
+  module ActiveResource
+    class Base
+      def save
+        save_without_validation
+        true
+      rescue ResourceInvalid => error
+        case error.response['Content-Type']
+        when /application\/xml/
+          errors.from_xml(error.response.body)
+        when /application\/json/
+          errors.from_json(error.response.body)
+        end
+        false
+      end
+    end
+  end
+end
+
+
+module Chargify
+  
+  class << self
+    attr_accessor :subdomain, :api_key, :site, :format, :timeout
+    
+    def configure
+      yield self
+      
+      Base.user      = api_key
+      Base.password  = 'X'
+      Base.timeout   = timeout unless (timeout.blank?)
+      
+      self.site ||= "https://#{subdomain}.chargify.com"
+
+      Base.site                     = site
+      Subscription::Component.site  = site + "/subscriptions/:subscription_id"
+      Subscription::Statement.site  = site + "/subscriptions/:subscription_id"
+      Subscription::Transaction.site  = site + "/subscriptions/:subscription_id"
+    end
+  end
+  
+  class Base < ActiveResource::Base
+    def self.element_name
+      name.split(/::/).last.underscore
+    end
+    
+    def to_xml(options = {})
+      options.merge!(:dasherize => false)
+      super
+    end
+  end
+  
+  class Site < Base
+    def self.clear_data!(params = {})
+      post(:clear_data, params)
+    end
+  end
+  
+  class Customer < Base
+    def self.find_by_reference(reference)
+      Customer.new get(:lookup, :reference => reference)
+    end
+    
+    def subscriptions(params = {})
+      params.merge!({:customer_id => self.id})
+      Subscription.find(:all, :params => params)
+    end
+
+    def payment_profiles(params = {})
+      params.merge!({:customer_id => self.id})
+      PaymentProfile.find(:all, :params => params)
+    end
+  end
+  
+  class Subscription < Base
+    def self.find_by_customer_reference(reference)
+      customer = Customer.find_by_reference(reference)
+      find(:first, :params => {:customer_id => customer.id}) 
+    end
+    
+    # Strip off nested attributes of associations before saving, or type-mismatch errors will occur
+    def save
+      self.attributes.delete('customer')
+      self.attributes.delete('product')
+      self.attributes.delete('credit_card')
+      super
+    end
+    
+    def cancel
+      destroy
+    end
+    
+    def component(id)
+      Component.find(id, :params => {:subscription_id => self.id})
+    end
+    
+    def components(params = {})
+      params.merge!({:subscription_id => self.id})
+      Component.find(:all, :params => params)
+    end
+    
+    def payment_profile
+      credit_card
+    end
+    
+    # Perform a one-time charge on an existing subscription.
+    # 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)
+    end
+    
+    def credit(attrs = {})
+      post :credits, {}, attrs.to_xml(:root => :credit)
+    end
+    
+    def refund(attrs = {})
+      post :refunds, {}, attrs.to_xml(:root => :refund)
+    end
+    
+    def reactivate(params = {})
+      put :reactivate, params
+    end
+    
+    def reset_balance
+      put :reset_balance
+    end
+    
+    def migrate(attrs = {})
+      post :migrations, :migration => attrs
+    end
+
+    def statement(id)
+      statement = Chargify::Statement.find(id)
+      raise ActiveResource::ResourceNotFound.new(nil) if (statement.subscription_id != self.id)
+      statement
+    end
+      
+    def statements(params = {})
+      params.merge!(:subscription_id => self.id)
+      Statement.find(:all, :params => params)
+    end
+    
+    def transactions(params = {})
+      params.merge!(:subscription_id => self.id)
+      Transaction.find(:all, :params => params)
+    end
+    
+    class Component < Base
+      # All Subscription Components are considered already existing records, but the id isn't used
+      def id
+        self.component_id
+      end
+      
+      def create_usage(attrs = {})
+        post :usages, {}, attrs.to_xml(:root => :usage)
+      end
+      
+      def usages(attrs = {})
+        get :usages
+      end
+    end
+    
+    class Statement < Base
+    end
+
+    class Transaction < Base
+      def full_refund(attrs = {})
+        return false if self.transaction_type != 'payment'
+
+        attrs.merge!(:amount_in_cents => self.amount_in_cents)
+        self.refund(attrs)
+      end
+
+      def refund(attrs = {})
+        return false if self.transaction_type != 'payment'
+
+        attrs.merge!(:payment_id => self.id)
+        Subscription.find(self.prefix_options[:subscription_id]).refund(attrs)
+      end
+    end
+  end
+
+  class Product < Base
+    def self.find_by_handle(handle)
+      Product.new get(:lookup, :handle => handle)
+    end
+    
+    protected
+    
+    # Products are created in the scope of a ProductFamily, i.e. /product_families/nnn/products
+    #
+    # This alters the collection path such that it uses the product_family_id that is set on the 
+    # attributes.
+    def create
+      pfid = begin
+        self.product_family_id
+      rescue NoMethodError
+        0
+      end
+      connection.post("/product_families/#{pfid}/products.#{self.class.format.extension}", encode, self.class.headers).tap do |response|
+        self.id = id_from_response(response)
+        load_attributes_from_response(response)
+      end
+    end
+  end
+  
+  class ProductFamily < Base
+    def self.find_by_handle(handle, attributes = {})
+      ProductFamily.find(:one, :from => :lookup, :handle => handle)
+    end
+  end
+    
+  class Usage < Base
+    def subscription_id=(i)
+      self.prefix_options[:subscription_id] = i
+    end
+    def component_id=(i)
+      self.prefix_options[:component_id] = i
+    end    
+  end
+  
+  class Component < Base
+  end
+
+  class Statement < Base
+  end
+
+  class Transaction < Base
+    def full_refund(attrs = {})
+      return false if self.transaction_type != 'payment'
+
+      attrs.merge!(:amount_in_cents => self.amount_in_cents)
+      self.refund(attrs)
+    end
+
+    def refund(attrs = {})
+      return false if self.transaction_type != 'payment'
+
+      attrs.merge!(:payment_id => self.id)
+      Subscription.find(self.subscription_id).refund(attrs)
+    end
+  end
+  
+  class PaymentProfile < Base
+  end
+  
+end