chargebee 1.7.4

data/lib/chargebee/models/model.rb

@@ -0,0 +1,70 @@
+require 'uri'
+
+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 method_missing(m, *args, &block)
+      if(@values.has_key?(m))
+          return @values[m]
+      elsif(m[0,3] == "cf_") # All the custom fields start with prefix cf_. 
+          return nil
+      end
+      puts "There's no method called #{m} #{args} here -- please try again."
+      puts @values
+    end
+    
+    def self.uri_path(*paths) 
+      url = ""
+      for path in paths
+          if(path.nil? || path.strip.length < 1) 
+             raise "Id is empty or nil" 
+          end
+          url = "#{url}/#{URI.encode(path.strip)}"
+      end
+      return url
+    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/order.rb

@@ -0,0 +1,31 @@
+module ChargeBee
+  class Order < Model
+
+  attr_accessor :id, :invoice_id, :status, :reference_id, :fulfillment_status, :note, :tracking_id,
+  :batch_id, :created_by, :created_at, :status_update_at
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("orders"), params, env, headers)
+  end
+
+  def self.update(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("orders",id.to_s), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("orders",id.to_s), {}, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send('get', uri_path("orders"), params, env, headers)
+  end
+
+  def self.orders_for_invoice(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("invoices",id.to_s,"orders"), params, env, headers)
+  end
+
+  end # ~Order
+end # ~ChargeBee

data/lib/chargebee/models/payment_intent.rb

@@ -0,0 +1,27 @@
+module ChargeBee
+  class PaymentIntent < Model
+
+    class PaymentAttempt < Model
+      attr_accessor :id, :status, :id_at_gateway, :error_code, :error_text, :created_at, :modified_at
+    end
+
+  attr_accessor :id, :status, :amount, :gateway_account_id, :expires_at, :reference_id, :created_at,
+  :modified_at, :customer_id, :gateway, :active_payment_attempt
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("payment_intents"), params, env, headers)
+  end
+
+  def self.update(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("payment_intents",id.to_s), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("payment_intents",id.to_s), {}, env, headers)
+  end
+
+  end # ~PaymentIntent
+end # ~ChargeBee

data/lib/chargebee/models/plan.rb

@@ -0,0 +1,33 @@
+module ChargeBee
+  class Plan < Model
+
+  attr_accessor :id, :name, :invoice_name, :description, :price, :period, :period_unit, :trial_period,
+  :trial_period_unit, :charge_model, :free_quantity, :setup_cost, :downgrade_penalty, :status,
+  :archived_at, :billing_cycles, :redirect_url, :enabled_in_hosted_pages, :enabled_in_portal,
+  :invoice_notes, :taxable, :meta_data
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("plans"), params, env, headers)
+  end
+
+  def self.update(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("plans",id.to_s), params, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send('get', uri_path("plans"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("plans",id.to_s), {}, env, headers)
+  end
+
+  def self.delete(id, env=nil, headers={})
+    Request.send('post', uri_path("plans",id.to_s,"delete"), {}, env, headers)
+  end
+
+  end # ~Plan
+end # ~ChargeBee

data/lib/chargebee/models/portal_session.rb

@@ -0,0 +1,31 @@
+module ChargeBee
+  class PortalSession < Model
+
+    class LinkedCustomer < Model
+      attr_accessor :customer_id, :email, :has_billing_address, :has_payment_method, :has_active_subscription
+    end
+
+  attr_accessor :id, :token, :access_url, :redirect_url, :status, :created_at, :expires_at, :customer_id,
+  :login_at, :logout_at, :login_ipaddress, :logout_ipaddress, :linked_customers
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("portal_sessions"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("portal_sessions",id.to_s), {}, env, headers)
+  end
+
+  def self.logout(id, env=nil, headers={})
+    Request.send('post', uri_path("portal_sessions",id.to_s,"logout"), {}, env, headers)
+  end
+
+  def self.activate(id, params, env=nil, headers={})
+    Request.send('post', uri_path("portal_sessions",id.to_s,"activate"), params, env, headers)
+  end
+
+  end # ~PortalSession
+end # ~ChargeBee

data/lib/chargebee/models/subscription.rb

@@ -0,0 +1,86 @@
+module ChargeBee
+  class Subscription < Model
+
+    class Addon < Model
+      attr_accessor :id, :quantity
+    end
+
+    class Coupon < Model
+      attr_accessor :coupon_id, :apply_till, :applied_count, :coupon_code
+    end
+
+    class ShippingAddress < Model
+      attr_accessor :first_name, :last_name, :email, :company, :phone, :line1, :line2, :line3, :city, :state_code, :state, :country, :zip
+    end
+
+  attr_accessor :id, :plan_id, :plan_quantity, :status, :start_date, :trial_start, :trial_end,
+  :current_term_start, :current_term_end, :remaining_billing_cycles, :po_number, :created_at,
+  :started_at, :activated_at, :cancelled_at, :cancel_reason, :affiliate_token, :created_from_ip,
+  :has_scheduled_changes, :due_invoices_count, :due_since, :total_dues, :addons, :coupon, :coupons,
+  :shipping_address, :invoice_notes, :meta_data
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions"), params, env, headers)
+  end
+
+  def self.create_for_customer(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"subscriptions"), params, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send('get', uri_path("subscriptions"), params, env, headers)
+  end
+
+  def self.subscriptions_for_customer(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"subscriptions"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("subscriptions",id.to_s), {}, env, headers)
+  end
+
+  def self.retrieve_with_scheduled_changes(id, env=nil, headers={})
+    Request.send('get', uri_path("subscriptions",id.to_s,"retrieve_with_scheduled_changes"), {}, env, headers)
+  end
+
+  def self.remove_scheduled_changes(id, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_changes"), {}, env, headers)
+  end
+
+  def self.remove_scheduled_cancellation(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_cancellation"), params, env, headers)
+  end
+
+  def self.update(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s), params, env, headers)
+  end
+
+  def self.change_term_end(id, params, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"change_term_end"), params, env, headers)
+  end
+
+  def self.cancel(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"cancel"), params, env, headers)
+  end
+
+  def self.reactivate(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"reactivate"), params, env, headers)
+  end
+
+  def self.add_charge_at_term_end(id, params, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"add_charge_at_term_end"), params, env, headers)
+  end
+
+  def self.charge_addon_at_term_end(id, params, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"charge_addon_at_term_end"), params, env, headers)
+  end
+
+  def self.delete(id, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"delete"), {}, env, headers)
+  end
+
+  end # ~Subscription
+end # ~ChargeBee

data/lib/chargebee/models/transaction.rb

@@ -0,0 +1,45 @@
+module ChargeBee
+  class Transaction < Model
+
+    class LinkedInvoice < Model
+      attr_accessor :invoice_id, :applied_amount, :applied_at, :invoice_date, :invoice_amount
+    end
+
+    class LinkedRefund < Model
+      attr_accessor :txn_id, :txn_status, :txn_date, :txn_amount
+    end
+
+  attr_accessor :id, :customer_id, :subscription_id, :payment_method, :reference_number, :gateway,
+  :description, :type, :date, :currency_code, :amount, :id_at_gateway, :status, :initiator_type,
+  :three_d_secure, :error_code, :error_text, :voided_at, :void_description, :amount_unused, :masked_card_number,
+  :reference_transaction_id, :refunded_txn_id, :reversal_transaction_id, :linked_invoices, :linked_refunds
+
+  # OPERATIONS
+  #-----------
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send('get', uri_path("transactions"), params, env, headers)
+  end
+
+  def self.transactions_for_customer(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"transactions"), params, env, headers)
+  end
+
+  def self.transactions_for_subscription(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("subscriptions",id.to_s,"transactions"), params, env, headers)
+  end
+
+  def self.transactions_for_invoice(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("invoices",id.to_s,"transactions"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("transactions",id.to_s), {}, env, headers)
+  end
+
+  def self.record_payment(id, params, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"record_payment"), params, env, headers)
+  end
+
+  end # ~Transaction
+end # ~ChargeBee

data/lib/chargebee/request.rb

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

data/lib/chargebee/rest.rb

@@ -0,0 +1,90 @@
+require 'rest_client'
+require 'json'
+
+module ChargeBee
+  module Rest
+    
+    def self.request(method, url, env, params=nil, headers)
+      raise Error.new('No environment configured.') unless env
+      api_key = env.api_key
+      
+      if(ChargeBee.verify_ca_certs?)
+        ssl_opts = {
+          :verify_ssl => OpenSSL::SSL::VERIFY_PEER,
+          :ssl_ca_file => ChargeBee.ca_cert_path
+        }
+      else
+        ssl_opts = {
+          :verify_ssl => false
+        }
+      end
+      case method.to_s.downcase.to_sym
+      when :get, :head, :delete
+        headers = { :params => params }.merge(headers)
+        payload = nil
+      else
+        payload = params
+      end
+      
+      user_agent = "Chargebee-Ruby-Client v#{ChargeBee::VERSION}"
+      headers = { 
+        "User-Agent" => user_agent,
+        :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 RestClient::ExceptionWithResponse => e
+        if rcode = e.http_code and rbody = e.http_body
+            raise handle_for_error(e, rcode, rbody)
+        else
+            raise IOError.new("IO Exception when trying to connect to chargebee with url #{opts[:url]} . Reason #{e}",e)
+        end
+      rescue Exception => e
+            raise IOError.new("IO Exception when trying to connect to chargebee with url #{opts[:url]} . Reason #{e}",e)        
+      end
+      rbody = response.body
+      rcode = response.code
+      begin
+        resp = JSON.parse(rbody)
+      rescue Exception => e
+        raise Error.new("Response not in JSON format. Probably not a ChargeBee response \n #{rbody.inspect}",e)
+      end
+      resp = Util.symbolize_keys(resp)
+      resp
+    end
+    
+    def self.handle_for_error(e, rcode=nil, rbody=nil)
+      if(rcode == 204)
+        raise Error.new("No response returned by the chargebee api. The http status code is #{rcode}")
+      end
+      begin
+        error_obj = JSON.parse(rbody)
+        error_obj = Util.symbolize_keys(error_obj)
+      rescue Exception => e
+        raise Error.new("Error response not in JSON format. The http status code is #{rcode} \n #{rbody.inspect}",e)
+      end
+      type = error_obj[:type]
+      if("payment" == type)
+        raise PaymentError.new(rcode, error_obj)
+      elsif("operation_failed" == type)
+        raise OperationFailedError.new(rcode, error_obj)
+      elsif("invalid_request" == type)
+        raise InvalidRequestError.new(rcode, error_obj)
+      else
+        raise APIError.new(rcode, error_obj)
+      end
+      
+    end
+    
+  end
+end

data/lib/chargebee/result.rb

@@ -0,0 +1,100 @@
+module ChargeBee
+  class Result
+
+    def initialize(response)
+      @response = response
+    end
+    
+    def subscription() 
+        get(:subscription, Subscription, 
+        {:addons => Subscription::Addon, :coupons => Subscription::Coupon, :shipping_address => Subscription::ShippingAddress});
+    end
+
+    def customer() 
+        get(:customer, Customer, 
+        {:billing_address => Customer::BillingAddress, :contacts => Customer::Contact, :payment_method => Customer::PaymentMethod});
+    end
+
+    def card() 
+        get(:card, Card);
+    end
+
+    def invoice() 
+        get(:invoice, Invoice, 
+        {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :taxes => Invoice::Tax, :linked_transactions => Invoice::LinkedTransaction, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :billing_address => Invoice::BillingAddress});
+    end
+
+    def order() 
+        get(:order, Order);
+    end
+
+    def transaction() 
+        get(:transaction, Transaction, 
+        {:linked_invoices => Transaction::LinkedInvoice, :linked_refunds => Transaction::LinkedRefund});
+    end
+
+    def hosted_page() 
+        get(:hosted_page, HostedPage);
+    end
+
+    def estimate() 
+        get(:estimate, Estimate, 
+        {:line_items => Estimate::LineItem, :discounts => Estimate::Discount, :taxes => Estimate::Tax});
+    end
+
+    def plan() 
+        get(:plan, Plan);
+    end
+
+    def addon() 
+        get(:addon, Addon);
+    end
+
+    def coupon() 
+        get(:coupon, Coupon);
+    end
+
+    def coupon_code() 
+        get(:coupon_code, CouponCode);
+    end
+
+    def address() 
+        get(:address, Address);
+    end
+
+    def event() 
+        get(:event, Event, 
+        {:webhooks => Event::Webhook});
+    end
+
+    def comment() 
+        get(:comment, Comment);
+    end
+
+    def download() 
+        get(:download, Download);
+    end
+
+    def portal_session() 
+        get(:portal_session, PortalSession, 
+        {:linked_customers => PortalSession::LinkedCustomer});
+    end
+
+    def payment_intent() 
+        get(:payment_intent, PaymentIntent, 
+        {:payment_attempt => PaymentIntent::PaymentAttempt});
+    end
+
+
+
+    private
+    def get(type, klass, sub_types = {})
+      klass.construct(@response[type], sub_types)
+    end
+
+    def to_s(*args) 
+      JSON.pretty_generate(@response) 
+    end
+
+  end
+end