chargebee 2.48.0 → 2.50.0

data/lib/chargebee/nativeRequest.rb

@@ -0,0 +1,138 @@
+require 'json'
+require 'net/http'
+require 'uri'
+require 'stringio'
+
+module ChargeBee
+  module NativeRequest
+
+    def self.request(method, url, env, params = nil, headers = {}, subdomain = nil, isJsonRequest = false)
+      raise Error.new('No environment configured.') unless env
+      api_key = env.api_key
+
+      uri = URI(env.api_url(url, subdomain))
+
+      case method.to_s.downcase.to_sym
+      when :get, :head, :delete
+        uri.query = URI.encode_www_form(params) if params
+        payload = nil
+      else
+        payload = isJsonRequest ? params : URI.encode_www_form(params || {})
+      end
+      user_agent = ChargeBee.user_agent
+      content_type_header = isJsonRequest ? "application/json;charset=UTF-8" : "application/x-www-form-urlencoded"
+      headers = {
+        "User-Agent" => user_agent,
+        "Accept" => "application/json",
+        "Lang-Version" => RUBY_VERSION,
+        "OS-Version" => RUBY_PLATFORM,
+        "Content-Type" => content_type_header
+      }.merge(headers)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.open_timeout=env.connect_timeout
+      http.read_timeout=env.read_timeout
+      if ChargeBee.verify_ca_certs?
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http.ca_file = ChargeBee.ca_cert_path
+      else
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      request_class = case method.to_s.downcase.to_sym
+                      when :get then Net::HTTP::Get
+                      when :post then Net::HTTP::Post
+                      when :put then Net::HTTP::Put
+                      when :delete then Net::HTTP::Delete
+                      else raise Error.new("Unsupported HTTP method: #{method}")
+                      end
+
+      request = request_class.new(uri, headers)
+      request.body = payload if payload
+
+      request.basic_auth(api_key, nil)
+
+      begin
+        response = http.request(request)
+      rescue => e
+        raise IOError.new("IO Exception when trying to connect to ChargeBee with URL #{uri} . Reason: #{e}", e)
+      end
+      handle_response(response, headers)
+    end
+
+    def self.handle_response(response, headers)
+      rcode = response.code.to_i
+      rbody = response.body
+
+      # converting headers to rest-client format previously we were using rest-client,
+      # and mapping headers to that format to support backward compatability
+      rheaders = beautify_headers(response.to_hash)
+
+      # When a custom 'Accept-Encoding' header is set to gzip, Net::HTTP will not automatically
+      # decompress the response. Therefore, we need to manually handle decompression
+      # based on the 'Content-Encoding' header in the response.
+      # https://github.com/ruby/ruby/blob/19c1f0233eb5202403c52b196f1d573893eacab7/lib/net/http/generic_request.rb#L82
+      if headers.keys.any? { |k| k.downcase == 'accept-encoding' } && rheaders[:content_encoding] == 'gzip' && rbody && !rbody.empty?
+        rbody = Zlib::GzipReader.new(StringIO.new(rbody)).read
+      end
+
+      if rcode >= 200 && rcode < 300
+        begin
+          resp = JSON.parse(rbody)
+        rescue JSON::ParserError => e
+          raise handle_json_error(rbody, e)
+        end
+        return Util.symbolize_keys(resp), rheaders, rcode
+      else
+        raise handle_for_error(rcode, rbody)
+      end
+    end
+
+    def self.handle_json_error(rbody, e)
+      if rbody.include?("503")
+        raise Error.new("Sorry, the server is currently unable to handle the request due to a temporary overload or scheduled maintenance. Please retry after sometime. \n type: internal_temporary_error, \n http_status_code: 503, \n error_code: internal_temporary_error,\n content: #{rbody.inspect}",e)
+      elsif rbody.include?("504")
+        raise Error.new("The server did not receive a timely response from an upstream server, request aborted. If this problem persists, contact us at support@chargebee.com. \n type: gateway_timeout, \n http_status_code: 504, \n error_code: gateway_timeout,\n content:  #{rbody.inspect}",e)
+      else
+        raise Error.new("Sorry, something went wrong when trying to process the request. If this problem persists, contact us at support@chargebee.com. \n type: internal_error, \n http_status_code: 500, \n error_code: internal_error,\n content:  #{rbody.inspect}",e)
+      end
+    end
+
+    def self.handle_for_error(rcode, rbody)
+      return Error.new("No response returned by ChargeBee API. HTTP status code: #{rcode}") if rcode == 204
+      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]
+      case type
+      when "payment"
+        raise PaymentError.new(rcode, error_obj)
+      when "operation_failed"
+        raise OperationFailedError.new(rcode, error_obj)
+      when "invalid_request"
+        raise InvalidRequestError.new(rcode, error_obj)
+      else
+        raise APIError.new(rcode, error_obj)
+      end
+    end
+    # directly copying headers formatting from rest-client to support backward compatability for rest-client
+    def self.beautify_headers(headers)
+      headers.inject({}) do |out, (key, value)|
+        key_sym = key.tr('-', '_').downcase.to_sym
+
+        # Handle Set-Cookie specially since it cannot be joined by comma.
+        if key.downcase == 'set-cookie'
+          out[key_sym] = value
+        else
+          out[key_sym] = value.join(', ')
+        end
+
+        out
+      end
+    end
+  end
+end

data/lib/chargebee/request.rb

@@ -1,27 +1,27 @@
 module ChargeBee
-  class Request    
+  class Request
 
-    def self.send_list_request(method, url, params={}, env=nil, headers={})
+    def self.send_list_request(method, url, params={}, env=nil, headers={}, sub_domain=nil, isJsonRequest=nil, jsonKeys={})
       serialized = {}
       params.each do |k, v|
         if(v.kind_of? Array)
           v = v.to_json
         end
         serialized["#{k}"] = v
-      end 
-      self.send(method, url, serialized, env, headers) 
+      end
+      self.send(method, url, serialized, env, headers, sub_domain, isJsonRequest=nil, jsonKeys={})
     end
 
-    def self.send(method, url, params={}, env=nil, headers={})
+    def self.send(method, url, params={}, env=nil, headers={}, sub_domain=nil, isJsonRequest=nil, jsonKeys={})
       env ||= ChargeBee.default_env
-      ser_params = Util.serialize(params)
-      resp, rheaders = Rest.request(method, url, env, ser_params||={}, headers)
+      ser_params = isJsonRequest ? params.to_json : Util.serialize(params, nil, nil, jsonKeys)
+      resp, rheaders, rcode = NativeRequest.request(method, url, env, ser_params||={}, headers, sub_domain, isJsonRequest)
       if resp.has_key?(:list)
-        ListResult.new(resp[:list], resp[:next_offset], rheaders) 
-      else 
-        Result.new(resp, rheaders)
+        ListResult.new(resp[:list], resp[:next_offset], rheaders, rcode)
+      else
+        Result.new(resp, rheaders, rcode)
       end
     end
-      
+
   end
 end

data/lib/chargebee/result.rb

@@ -3,15 +3,24 @@ module ChargeBee
 
     IDEMPOTENCY_REPLAYED_HEADER = :chargebee_idempotency_replayed
 
-    def initialize(response, rheaders = nil)
+    def initialize(response, rheaders = nil, http_status_code=nil)
       @response = response
         @rheaders = rheaders
+        @http_status_code = http_status_code
     end
 
     def get_response_headers()
         @rheaders
     end
 
+    def get_raw_response()
+        @response
+    end
+
+    def get_http_status_code()
+        @http_status_code
+    end
+
     def is_idempotency_replayed()
         replayed_header = get_response_headers[IDEMPOTENCY_REPLAYED_HEADER]
         if replayed_header != nil
@@ -97,7 +106,7 @@ module ChargeBee
 
     def invoice() 
         invoice = get(:invoice, Invoice,
-        {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :line_item_discounts => Invoice::LineItemDiscount, :taxes => Invoice::Tax, :line_item_taxes => Invoice::LineItemTax, :line_item_tiers => Invoice::LineItemTier, :linked_payments => Invoice::LinkedPayment, :dunning_attempts => Invoice::DunningAttempt, :applied_credits => Invoice::AppliedCredit, :adjustment_credit_notes => Invoice::AdjustmentCreditNote, :issued_credit_notes => Invoice::IssuedCreditNote, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :statement_descriptor => Invoice::StatementDescriptor, :billing_address => Invoice::BillingAddress, :einvoice => Invoice::Einvoice, :site_details_at_creation => Invoice::SiteDetailsAtCreation, :tax_origin => Invoice::TaxOrigin});
+        {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :line_item_discounts => Invoice::LineItemDiscount, :taxes => Invoice::Tax, :line_item_taxes => Invoice::LineItemTax, :line_item_credits => Invoice::LineItemCredit, :line_item_tiers => Invoice::LineItemTier, :linked_payments => Invoice::LinkedPayment, :dunning_attempts => Invoice::DunningAttempt, :applied_credits => Invoice::AppliedCredit, :adjustment_credit_notes => Invoice::AdjustmentCreditNote, :issued_credit_notes => Invoice::IssuedCreditNote, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :statement_descriptor => Invoice::StatementDescriptor, :billing_address => Invoice::BillingAddress, :einvoice => Invoice::Einvoice, :site_details_at_creation => Invoice::SiteDetailsAtCreation, :tax_origin => Invoice::TaxOrigin});
         return invoice;
     end
 
@@ -158,13 +167,13 @@ module ChargeBee
         estimate.init_dependant(@response[:estimate], :subscription_estimate,
         {:shipping_address => SubscriptionEstimate::ShippingAddress, :contract_term => SubscriptionEstimate::ContractTerm});
         estimate.init_dependant(@response[:estimate], :invoice_estimate,
-        {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
+        {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_credits => InvoiceEstimate::LineItemCredit, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
         estimate.init_dependant(@response[:estimate], :next_invoice_estimate,
-        {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
+        {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_credits => InvoiceEstimate::LineItemCredit, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
         estimate.init_dependant_list(@response[:estimate], :subscription_estimates,
         {:shipping_address => SubscriptionEstimate::ShippingAddress, :contract_term => SubscriptionEstimate::ContractTerm});
         estimate.init_dependant_list(@response[:estimate], :invoice_estimates,
-        {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
+        {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_credits => InvoiceEstimate::LineItemCredit, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
         estimate.init_dependant_list(@response[:estimate], :payment_schedule_estimates,
         {:schedule_entries => PaymentScheduleEstimate::ScheduleEntry});
         estimate.init_dependant_list(@response[:estimate], :credit_note_estimates,
@@ -461,6 +470,16 @@ module ChargeBee
         return recorded_purchase;
     end
 
+    def rule() 
+        rule = get(:rule, Rule);
+        return rule;
+    end
+
+    def usage_event() 
+        usage_event = get(:usage_event, UsageEvent);
+        return usage_event;
+    end
+
     def advance_invoice_schedules() 
         advance_invoice_schedules = get_list(:advance_invoice_schedules, AdvanceInvoiceSchedule,
         {:fixed_interval_schedule => AdvanceInvoiceSchedule::FixedIntervalSchedule, :specific_dates_schedule => AdvanceInvoiceSchedule::SpecificDatesSchedule});
@@ -475,7 +494,7 @@ module ChargeBee
 
     def invoices() 
         invoices = get_list(:invoices, Invoice,
-        {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :line_item_discounts => Invoice::LineItemDiscount, :taxes => Invoice::Tax, :line_item_taxes => Invoice::LineItemTax, :line_item_tiers => Invoice::LineItemTier, :linked_payments => Invoice::LinkedPayment, :dunning_attempts => Invoice::DunningAttempt, :applied_credits => Invoice::AppliedCredit, :adjustment_credit_notes => Invoice::AdjustmentCreditNote, :issued_credit_notes => Invoice::IssuedCreditNote, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :statement_descriptor => Invoice::StatementDescriptor, :billing_address => Invoice::BillingAddress, :einvoice => Invoice::Einvoice, :site_details_at_creation => Invoice::SiteDetailsAtCreation, :tax_origin => Invoice::TaxOrigin});
+        {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :line_item_discounts => Invoice::LineItemDiscount, :taxes => Invoice::Tax, :line_item_taxes => Invoice::LineItemTax, :line_item_credits => Invoice::LineItemCredit, :line_item_tiers => Invoice::LineItemTier, :linked_payments => Invoice::LinkedPayment, :dunning_attempts => Invoice::DunningAttempt, :applied_credits => Invoice::AppliedCredit, :adjustment_credit_notes => Invoice::AdjustmentCreditNote, :issued_credit_notes => Invoice::IssuedCreditNote, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :statement_descriptor => Invoice::StatementDescriptor, :billing_address => Invoice::BillingAddress, :einvoice => Invoice::Einvoice, :site_details_at_creation => Invoice::SiteDetailsAtCreation, :tax_origin => Invoice::TaxOrigin});
         return invoices;
     end
 
@@ -520,10 +539,6 @@ module ChargeBee
         JSON.pretty_generate(@response)
     end
 
-    def get_raw_response()
-      @response;
-    end
-
     private
     def get_list(type, klass, sub_types = {}, dependant_types = {}, dependant_sub_types = {})
       if(@response[type] == nil)

data/lib/chargebee/util.rb

@@ -1,15 +1,18 @@
 module ChargeBee
   module Util
 
-    def self.serialize(value, prefix = nil, idx = nil)
+    def self.serialize(value, prefix = nil, idx = nil, json_keys = nil, level = 0)
       serialized = {}
       case value
         when Hash
           value.each do |k, v|
-            if k == :metadata or k == :meta_data  # metadata is encoded as a JSON string instead of URL-encoded.
-              serialized.merge!({k.to_s => as_str(v)})
+            should_json_encode = json_keys[k] && json_keys[k] == level
+            if should_json_encode
+              key = "#{prefix || ''}#{prefix ? "[#{k}]" : k}#{idx ? "[#{idx}]" : ''}"
+              serialized.merge!({key.to_s => v.to_json})
             elsif(v.kind_of? Hash or v.kind_of? Array)
-              serialized.merge!(serialize(v, k))
+              temp_prefix = prefix!=nil ? "#{prefix}[#{k}]" : k
+              serialized.merge!(serialize(v, temp_prefix, nil , json_keys, level+1))
             else
               key = "#{(prefix!=nil) ? prefix:''}#{(prefix!=nil) ? '['+k.to_s+']' : k}#{(idx != nil) ? '['+idx.to_s+']':''}"
               serialized.merge!({key => as_str(v)})
@@ -17,7 +20,7 @@ module ChargeBee
           end
         when Array
           value.each_with_index do |v, i|
-            serialized.merge!(serialize(v, prefix, i))
+            serialized.merge!(serialize(v, prefix, i, json_keys, level))
           end
       else
            if(idx != nil and prefix != nil)

data/lib/chargebee.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/chargebee/environment'
-require File.dirname(__FILE__) + '/chargebee/rest'
+require File.dirname(__FILE__) + '/chargebee/nativeRequest'
 require File.dirname(__FILE__) + '/chargebee/util'
 require File.dirname(__FILE__) + '/chargebee/request'
 require File.dirname(__FILE__) + '/chargebee/result'
@@ -83,11 +83,13 @@ require File.dirname(__FILE__) + '/chargebee/models/omnichannel_transaction'
 require File.dirname(__FILE__) + '/chargebee/models/recorded_purchase'
 require File.dirname(__FILE__) + '/chargebee/models/omnichannel_subscription_item'
 require File.dirname(__FILE__) + '/chargebee/models/configuration'
+require File.dirname(__FILE__) + '/chargebee/models/usage_event'
+require File.dirname(__FILE__) + '/chargebee/models/rule'
 
 
 module ChargeBee
 
-  VERSION = '2.48.0'
+  VERSION = '2.50.0'
 
   @@default_env = nil
   @@verify_ca_certs = true

data/spec/chargebee/list_result_spec.rb

@@ -43,7 +43,7 @@ describe ChargeBee::ListResult do
   end
 
   before do
-    ChargeBee::Rest.stubs(:request).returns(response)
+    ChargeBee::NativeRequest.stubs(:request).returns(response)
   end
 
   it "returns list object, with next offset attribute" do

data/spec/chargebee_spec.rb

@@ -1,11 +1,10 @@
 require 'spec_helper'
-require 'rest_client'
 require 'sample_response'
 
 describe "chargebee" do
 
   before(:all) do
-    @request = RestClient::Request
+    @request = ChargeBee::NativeRequest
   end
 
   it "serialize should convert the hash to acceptable format" do
@@ -55,7 +54,7 @@ describe "chargebee" do
   end
 
   it "should properly convert the response json into proper object" do
-    @request.expects(:execute).once.returns(mock_response(simple_subscription, headers))
+    @request.expects(:request).once.returns([simple_subscription, headers])
     result = ChargeBee::Subscription.retrieve("simple_subscription")
     h = result.get_response_headers
     expect(h).to eq(headers)
@@ -68,7 +67,7 @@ describe "chargebee" do
   end
 
   it "should properly convert the nested response json into proper object with sub types" do
-    @request.expects(:execute).once.returns(mock_response(nested_subscription, headers))
+    @request.expects(:request).once.returns([nested_subscription, headers])
     result = ChargeBee::Subscription.retrieve("nested_subscription")
     s = result.subscription
     expect(s.id).to eq("nested_subscription")
@@ -80,7 +79,7 @@ describe "chargebee" do
   end
 
   it "should properly convert the list response json into proper result object" do
-    @request.expects(:execute).once.returns(mock_response(list_subscriptions, headers))
+    @request.expects(:request).once.returns([list_subscriptions, headers])
     result = ChargeBee::Subscription.list({:limit => 2})
     expect(result.length).to eq(2)
     result.each do |i|
@@ -89,7 +88,7 @@ describe "chargebee" do
   end
 
   it "should parse event api response and provide the content properly" do
-    @request.expects(:execute).once.returns(mock_response(sample_event, headers))
+    @request.expects(:request).once.returns([sample_event, headers])
     result = ChargeBee::Event.retrieve("sample_event")
     event = result.event
     s = event.content.subscription

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee
 version: !ruby/object:Gem::Version
-  version: 2.48.0
+  version: 2.50.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -25,26 +25,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - <=
-      - !ruby/object:Gem::Version
-        version: 2.0.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - <=
-      - !ruby/object:Gem::Version
-        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: cgi
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +166,7 @@ files:
 - lib/chargebee/models/ramp.rb
 - lib/chargebee/models/recorded_purchase.rb
 - lib/chargebee/models/resource_migration.rb
+- lib/chargebee/models/rule.rb
 - lib/chargebee/models/site_migration_detail.rb
 - lib/chargebee/models/subscription.rb
 - lib/chargebee/models/subscription_entitlement.rb
@@ -197,7 +178,9 @@ files:
 - lib/chargebee/models/transaction.rb
 - lib/chargebee/models/unbilled_charge.rb
 - lib/chargebee/models/usage.rb
+- lib/chargebee/models/usage_event.rb
 - lib/chargebee/models/virtual_bank_account.rb
+- lib/chargebee/nativeRequest.rb
 - lib/chargebee/request.rb
 - lib/chargebee/rest.rb
 - lib/chargebee/result.rb