chargebee 1.0.0

data/LICENSE

@@ -0,0 +1,24 @@
+(The MIT License)
+
+Copyright (c) 2011-2012 Bubblepath Inc
+
+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.rdoc

@@ -0,0 +1,30 @@
+= ChargeBee Ruby Client Library
+
+The ruby library for integrating with ChargeBee Recurring Billing and Subscription Management solution.
+
+== Installation
+
+Install the latest version of the gem with the following command...
+
+  $ sudo gem install ghargebee
+
+== Documentation
+
+For API reference see https://apidocs.chargebee.com/docs/api?lang=ruby
+
+== Usage
+
+To create a new subscription:
+  
+  ChargeBee.configure({:api_key => "your_api_key"}, {:site => "your_site"})
+  result = ChargeBee::Subscription.create({
+  :id => "sub_KyVqDh__dev__NTn4VZZ1", 
+  :plan_id => "basic", 
+  })
+  subscription = result.subscription
+  puts "created subscription is #{subscription}"
+
+== License
+
+See the LICENSE file.
+

data/chargebee.gemspec

@@ -0,0 +1,24 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'chargebee/version'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'chargebee'
+  s.version = ChargeBee::Version.to_s
+  s.summary = 'Ruby client for Chargebee API'
+  s.description = 'Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com'
+  
+  s.files = Dir.glob ["README.rdoc", "LICENSE", "{lib}/**/*.rb", "*.gemspec"]
+    
+  s.authors = ['Rajaraman S', 'Thiyagarajan T']
+  s.email = ['rr@chargebee.com', 'thiyagu@chargebee.com']
+  s.homepage = 'https://apidocs.chargebee.com/api/docs'
+  
+  s.homepage = 'http://github.com/chargebee/chargebee-ruby'
+
+  s.add_dependency('json_pure', '~> 1.5')
+  s.add_dependency('rest-client', '~> 1.4')
+  
+  s.add_development_dependency('rpsec', '~> 2.9.0')
+  s.add_development_dependency('mocha')
+  
+end

data/lib/chargebee.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/chargebee/environment'
+require File.dirname(__FILE__) + '/chargebee/rest'
+require File.dirname(__FILE__) + '/chargebee/util'
+require File.dirname(__FILE__) + '/chargebee/request'
+require File.dirname(__FILE__) + '/chargebee/result'
+require File.dirname(__FILE__) + '/chargebee/list_result'
+
+require File.dirname(__FILE__) + '/chargebee/api_error'
+
+require File.dirname(__FILE__) + '/chargebee/models/model'
+require File.dirname(__FILE__) + '/chargebee/models/subscription'
+require File.dirname(__FILE__) + '/chargebee/models/customer'
+require File.dirname(__FILE__) + '/chargebee/models/card'
+require File.dirname(__FILE__) + '/chargebee/models/transaction'
+require File.dirname(__FILE__) + '/chargebee/models/invoice'
+require File.dirname(__FILE__) + '/chargebee/models/hosted_page'
+require File.dirname(__FILE__) + '/chargebee/models/event'
+
+
+module ChargeBee
+
+  @@default_env = nil
+  
+  def self.configure(options)
+    @@default_env = Environment.new(options)
+  end
+  
+  def self.default_env
+    @@default_env
+  end
+  
+end
+

data/lib/chargebee/api_error.rb

@@ -0,0 +1,23 @@
+module ChargeBee
+  class APIError < StandardError
+
+    attr_reader :message, :http_code, :http_body, :json_obj, :error_code, :param
+    
+    def initialize(message=nil, http_code=nil, http_body=nil, json_obj = nil)
+      @message = message
+      @http_code = http_code
+      @http_body = http_body
+      @json_obj = json_obj
+      if(json_obj != nil)
+        @error_code = json_obj[:error_code]
+        @param = json_obj[:param]
+      end
+    end
+    
+    def to_s
+      hc = @http_code.nil? ? "" : "(Http Code #{@http_code}) "
+      "#{hc}#{@message}"
+    end
+    
+  end
+end

data/lib/chargebee/environment.rb

@@ -0,0 +1,23 @@
+module ChargeBee
+  class Environment
+    
+    attr_accessor :api_key, :site
+    attr_reader :api_endpoint
+      
+    def initialize(options)
+      [:api_key, :site].each do |attr|
+        instance_variable_set "@#{attr}", options[attr]
+      end
+      if($CHARGEBEE_DOMAIN == nil)
+        @api_endpoint = "https://#{@site}.chargebee.com/api/v1"
+      else
+        @api_endpoint = "http://#{@site}.#{$CHARGEBEE_DOMAIN}:8080/api/v1"
+      end
+    end
+
+    def api_url(url)
+      url = @api_endpoint + url
+    end
+    
+  end
+end

data/lib/chargebee/list_result.rb

@@ -0,0 +1,25 @@
+require 'forwardable'
+
+module ChargeBee
+  class ListResult 
+    extend Forwardable
+    include Enumerable
+    
+    def_delegator :@list, :each, :each
+    def_delegator :@list, :length, :length
+    
+    def initialize(response)
+      @response = response
+      @list = Array.new
+      initItems()
+    end
+    
+    private
+    def initItems()
+      @response.each do |item|
+        @list.push(Result.new(item))
+      end
+    end
+  
+  end
+end

data/lib/chargebee/models/card.rb

@@ -0,0 +1,19 @@
+module ChargeBee
+  class Card < Model
+
+  attr_accessor :customer_id, :status, :gateway, :first_name, :last_name, :iin, :last4, :card_type,
+  :expiry_month, :expiry_year, :masked_number
+
+  # OPERATIONS
+  #-----------
+    
+  def self.retrieve(id, env=nil)
+    Request.send('get', "/cards/#{id.to_s}", {}, env)
+  end    
+
+  def self.update_card_for_customer(id, params, env=nil)
+    Request.send('post', "/customers/#{id.to_s}/credit_card", params, env)
+  end    
+
+  end # ~Card
+end # ~ChargeBee    

data/lib/chargebee/models/customer.rb

@@ -0,0 +1,22 @@
+module ChargeBee
+  class Customer < Model
+
+  attr_accessor :id, :first_name, :last_name, :email, :company, :created_at, :card_status
+
+  # OPERATIONS
+  #-----------
+    
+  def self.list(params={}, env=nil)
+    Request.send('get', "/customers", params, env)
+  end    
+
+  def self.retrieve(id, env=nil)
+    Request.send('get', "/customers/#{id.to_s}", {}, env)
+  end    
+
+  def self.update(id, params={}, env=nil)
+    Request.send('post', "/customers/#{id.to_s}", params, env)
+  end    
+
+  end # ~Customer
+end # ~ChargeBee    

data/lib/chargebee/models/event.rb

@@ -0,0 +1,25 @@
+module ChargeBee
+  class Event < Model
+
+  attr_accessor :id, :occurred_at, :webhook_status, :webhook_failure_reason, :event_type
+
+  class Content < Result
+  end
+
+  def content
+    Content.new(@values[:content])
+  end
+
+  # OPERATIONS
+  #-----------
+    
+  def self.list(params={}, env=nil)
+    Request.send('get', "/events", params, env)
+  end    
+
+  def self.retrieve(id, env=nil)
+    Request.send('get', "/events/#{id.to_s}", {}, env)
+  end    
+
+  end # ~Event
+end # ~ChargeBee    

data/lib/chargebee/models/hosted_page.rb

@@ -0,0 +1,33 @@
+module ChargeBee
+  class HostedPage < Model
+
+  attr_accessor :id, :type, :url, :state, :failure_reason, :pass_thru_content, :created_at, :expires_at
+
+  class Content < Result
+  end
+
+  def content
+    Content.new(@values[:content])
+  end
+
+  # OPERATIONS
+  #-----------
+    
+  def self.checkout_new(params, env=nil)
+    Request.send('post', "/hosted_pages/checkout_new", params, env)
+  end    
+
+  def self.checkout_existing(params, env=nil)
+    Request.send('post', "/hosted_pages/checkout_existing", params, env)
+  end    
+
+  def self.update_card(params, env=nil)
+    Request.send('post', "/hosted_pages/update_card", params, env)
+  end    
+
+  def self.retrieve(id, env=nil)
+    Request.send('get', "/hosted_pages/#{id.to_s}", {}, env)
+  end    
+
+  end # ~HostedPage
+end # ~ChargeBee    

data/lib/chargebee/models/invoice.rb

@@ -0,0 +1,31 @@
+module ChargeBee
+  class Invoice < Model
+
+    class LineItem < Model
+      attr_accessor :date_from, :date_to, :unit_amount, :quantity
+    end
+
+    class Discount < Model
+      attr_accessor :amount, :description
+    end
+
+  attr_accessor :id, :subscription_id, :status, :start_date, :end_date, :amount, :paid_on, :next_retry,
+  :sub_total, :line_items, :discounts
+
+  # OPERATIONS
+  #-----------
+    
+  def self.list(params={}, env=nil)
+    Request.send('get', "/invoices", params, env)
+  end    
+
+  def self.retrieve(id, env=nil)
+    Request.send('get', "/invoices/#{id.to_s}", {}, env)
+  end    
+
+  def self.invoices_for_subscription(id, params={}, env=nil)
+    Request.send('get', "/subscriptions/#{id.to_s}/invoices", params, env)
+  end    
+
+  end # ~Invoice
+end # ~ChargeBee    

data/lib/chargebee/models/model.rb

@@ -0,0 +1,47 @@
+module ChargeBee
+  class Model
+    
+    def initialize(values, sub_types={})
+      @values = values
+      @sub_types = sub_types
+    end
+    
+    def to_s(*args) 
+      JSON.pretty_generate(@values) 
+    end
+    
+    def inspect()
+      "#<#{self.class}:0x#{self.object_id.to_s(16)} > JSON: " + JSON.pretty_generate(@values)
+    end
+    
+    def load(values)
+      instance_eval do
+        values.each do |k, v|
+          set_val = nil
+          case v
+          when Hash
+            set_val = (@sub_types[k] != nil) ? @sub_types[k].construct(v) : v
+          when Array
+            if(@sub_types[k] != nil)
+              set_val = v.map { |item| @sub_types[k].construct(item)}
+            else
+              set_val = v
+            end
+          else
+            set_val = v
+          end
+          instance_variable_set("@#{k}", set_val)
+        end
+      end
+    end
+    
+    def self.construct(values, sub_types = {})
+      if(values != nil)
+        obj = self.new(values, sub_types)
+        obj.load(values)
+        obj
+      end
+    end
+    
+  end
+end

data/lib/chargebee/models/subscription.rb

@@ -0,0 +1,40 @@
+module ChargeBee
+  class Subscription < Model
+
+    class Addon < Model
+      attr_accessor :id, :quantity
+    end
+
+  attr_accessor :id, :plan_id, :plan_quantity, :status, :trial_start, :trial_end, :current_term_start,
+  :current_term_end, :created_at, :activated_at, :cancelled_at, :due_invoices_count, :due_since,
+  :total_dues, :addons
+
+  # OPERATIONS
+  #-----------
+    
+  def self.create(params, env=nil)
+    Request.send('post', "/subscriptions", params, env)
+  end    
+
+  def self.list(params={}, env=nil)
+    Request.send('get', "/subscriptions", params, env)
+  end    
+
+  def self.retrieve(id, env=nil)
+    Request.send('get', "/subscriptions/#{id.to_s}", {}, env)
+  end    
+
+  def self.update(id, params={}, env=nil)
+    Request.send('post', "/subscriptions/#{id.to_s}", params, env)
+  end    
+
+  def self.cancel(id, params={}, env=nil)
+    Request.send('post', "/subscriptions/#{id.to_s}/cancel", params, env)
+  end    
+
+  def self.reactivate(id, env=nil)
+    Request.send('post', "/subscriptions/#{id.to_s}/reactivate", {}, env)
+  end    
+
+  end # ~Subscription
+end # ~ChargeBee    

data/lib/chargebee/models/transaction.rb

@@ -0,0 +1,23 @@
+module ChargeBee
+  class Transaction < Model
+
+  attr_accessor :id, :subscription_id, :gateway, :invoice_id, :type, :date, :amount, :id_at_gateway,
+  :masked_card_number, :error_code, :error_text, :refunded_tx_id, :refund_memo, :voided_at, :status
+
+  # OPERATIONS
+  #-----------
+    
+  def self.list(params={}, env=nil)
+    Request.send('get', "/transactions", params, env)
+  end    
+
+  def self.retrieve(id, env=nil)
+    Request.send('get', "/transactions/#{id.to_s}", {}, env)
+  end    
+
+  def self.transactions_for_subscription(id, params={}, env=nil)
+    Request.send('get', "/subscriptions/#{id.to_s}/transactions", params, env)
+  end    
+
+  end # ~Transaction
+end # ~ChargeBee    

data/lib/chargebee/request.rb

@@ -0,0 +1,12 @@
+module ChargeBee
+  class Request    
+
+    def self.send(method, url, params={}, env=nil)
+      env ||= ChargeBee.default_env
+      ser_params = Util.serialize(params)
+      resp = Rest.request(method, url, env, ser_params||={})
+      resp.has_key?(:list) ? ListResult.new(resp[:list]) : Result.new(resp)
+    end
+      
+  end
+end

data/lib/chargebee/rest.rb

@@ -0,0 +1,80 @@
+require 'rest_client'
+require 'json'
+
+module ChargeBee
+  module Rest
+
+    def self.request(method, url, env, params=nil)
+      raise APIError.new('No environment configured.') unless env
+      api_key = env.api_key
+      headers = {}
+      ssl_opts = { :verify_ssl => ($API_DOMAIN==nil)?true:false }
+    
+      case method.to_s.downcase.to_sym
+      when :get, :head, :delete
+        headers = { :params => params }.merge(headers)
+        payload = nil
+      else
+        payload = params
+      end
+      
+      headers = { 
+        "User-Agent" => "Chargebee-Ruby-Client",
+        :accept => :json 
+        }.merge(headers)
+            
+      opts = {
+        :method => method,
+        :url => env.api_url(url),
+        :user => api_key,
+        :headers => headers,
+        :payload => payload,
+        :open_timeout => 50,
+        :timeout => 100
+        }.merge(ssl_opts)
+        
+      begin
+        response = RestClient::Request.execute(opts)
+      rescue Exception => e
+        case(e)
+        when SocketError
+          raise APIError.new("Error while connecting to chargebee. If you see this repeatedly, contact us at support@chargebee.com")
+        when RestClient::ExceptionWithResponse
+          if rcode = e.http_code and rbody = e.http_body
+            raise handle_for_error(e, rcode, rbody)
+          else
+            raise APIError.new(e.message)
+          end
+        when RestClient::Exception
+          raise APIError.new("Unexpected error received: #{e.message}", e.http_code, e.http_body)
+        else
+          raise APIError.new(e.message)
+        end
+      end
+      rbody = response.body
+      rcode = response.code
+      begin
+        resp = JSON.parse(rbody)
+      rescue JSON::ParserError
+        raise APIError.new("Invalid response object from API", rcode, rbody)
+      end
+
+      resp = Util.symbolize_keys(resp)
+      resp
+    end
+    
+    def self.handle_for_error(e, rcode=nil, rbody=nil)
+      if(rcode == 204)
+        raise APIError.new("No response returned by the chargebee api", rcode)
+      end
+      begin
+        error_obj = JSON.parse(rbody)
+        error_obj = Util.symbolize_keys(error_obj)
+      rescue JSON::ParseError
+        raise APIError.new("Invalid JSON response #{rbody.inspect} received with HTTP response code #{rcode}", rcode, rbody)
+      end
+      raise APIError.new(error_obj[:error_msg], rcode, rbody, error_obj)
+    end
+    
+  end
+end

data/lib/chargebee/result.rb

@@ -0,0 +1,46 @@
+module ChargeBee
+  class Result
+
+    def initialize(response)
+      @response = response
+    end
+    
+    def subscription()
+      get(:subscription, Subscription, {:addons => Subscription::Addon})
+    end
+
+    def customer()
+      get(:customer, Customer)
+    end
+
+    def card()
+      get(:card, Card)
+    end
+    
+    def invoice()
+      get(:invoice, Invoice, {:line_items => Invoice::LineItem, :discounts => Invoice::Discount})
+    end
+
+    def transaction()
+      get(:transaction, Transaction)
+    end
+
+    def event()
+      get(:event, Event)
+    end
+
+    def hosted_page()
+      get(:hosted_page, HostedPage)
+    end
+    
+    def to_s(*args) 
+      JSON.pretty_generate(@response) 
+    end
+    
+    private
+    def get(type, klass, sub_types = {})
+      klass.construct(@response[type], sub_types)
+    end
+    
+  end
+end

data/lib/chargebee/util.rb

@@ -0,0 +1,43 @@
+module ChargeBee
+  module Util
+    
+    def self.serialize(value, prefix = nil, idx = nil)
+      serialized = {}
+      case value
+        when Hash
+          value.each do |k, v|
+            if(v.instance_of? Hash or v.instance_of? Array)
+              serialized.merge!(serialize(v, k))
+            else
+              key = "#{(prefix!=nil) ? prefix:''}#{(idx != nil) ? '['+idx.to_s+']':''}#{(prefix!=nil) ? '['+k.to_s+']' : k}"
+              serialized.merge!({key => (v!=nil)?v:''})
+            end
+          end
+        when Array
+          value.each_with_index do |v, i|
+            serialized.merge!(serialize(v, prefix, i))
+          end
+        else
+          raise ArgumentError.new("only hash or arrays are allowed as value")
+      end
+      serialized
+    end
+    
+    def self.symbolize_keys(object)
+      case object
+      when Hash
+        new = {}
+        object.each do |key, value|
+          key = (key.to_sym rescue key) || key
+          new[key] = symbolize_keys(value)
+        end
+        new
+      when Array
+        object.map { |value| symbolize_keys(value) }
+      else
+        object
+      end
+    end
+    
+  end
+end

data/lib/chargebee/version.rb

@@ -0,0 +1,13 @@
+module ChargeBee
+  module Version
+    
+    VERSION = '1.0.0'
+
+    class << self
+      def inspect
+        VERSION.dup
+      end
+      alias to_s inspect
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification 
+name: chargebee
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Rajaraman S
+- Thiyagarajan T
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rpsec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 2
+        - 9
+        - 0
+        version: 2.9.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com
+email: 
+- rr@chargebee.com
+- thiyagu@chargebee.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- LICENSE
+- lib/chargebee/api_error.rb
+- lib/chargebee/environment.rb
+- lib/chargebee/list_result.rb
+- lib/chargebee/models/card.rb
+- lib/chargebee/models/customer.rb
+- lib/chargebee/models/event.rb
+- lib/chargebee/models/hosted_page.rb
+- lib/chargebee/models/invoice.rb
+- lib/chargebee/models/model.rb
+- lib/chargebee/models/subscription.rb
+- lib/chargebee/models/transaction.rb
+- lib/chargebee/request.rb
+- lib/chargebee/rest.rb
+- lib/chargebee/result.rb
+- lib/chargebee/util.rb
+- lib/chargebee/version.rb
+- lib/chargebee.rb
+- chargebee.gemspec
+homepage: http://github.com/chargebee/chargebee-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Ruby client for Chargebee API
+test_files: []
+