chargebee 2.25.0 → 2.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6802473f9e53098c12e06f210e96a9067fa92b23
-  data.tar.gz: fa7fdb9c0533e6c5d8751517fa26516bce474130
+  metadata.gz: e8f49942d789e63f0f1c44b234e16de02983f15f
+  data.tar.gz: e5feb8906f49350edc3136a2845e248b58d9e7f5
 SHA512:
-  metadata.gz: 8ed018f8398ebf065b7a25b92a70bf47bb0dd8a702ab85cc061ade52fd305155c10389fae40c043661e9bf8b1798a88d0b95a13384e090a954c1553021f94cb3
-  data.tar.gz: 9237adea2f062d4fad042d1c9dda997e8d621bbe2ea820132e313679746555fd73d090455d01bdce7da3e3f573d923cf4e20cfedcbbd70ab425a61bcaf39b320
+  metadata.gz: 0358f0b36273e2a6d50f44f10bb36ef8b6106f3924c073ff21ad127c95f29485bfbdfa1b9097a3c59e157121dc04ae63c78f806b4586ec478c9b83bd0cd4668b
+  data.tar.gz: 3ed155cb9b0f10d70ee68a3cf8422fc21c3f3e43b0b773d93f2cf30120c0180b5d9823f55a1cf101f605ebd617c7f2a35a4c4335d0ad8a1949aba34a33af2f0b

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+### v2.26.1 (2023-05-16)
+* * *
+
+* Fixed test action failures.
+
+
+### v2.26.0 (2023-05-16)
+* * *
+
+#### New Feature:
+* Added utility to pass **Idempotency key** along with request headers to allow a safe retry of POST requests.
+* Added is_idempotency_replayed() utility to differentiate between original and replayed requests.
+* Added get_response_headers() utility to fetch the response headers.
+
+
 ### v2.25.0 (2023-04-28)
 * * *
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargebee (2.25.0)
+    chargebee (2.26.1)
       cgi (>= 0.1.0, < 1.0.0)
       json_pure (~> 2.1)
       rest-client (>= 1.8, <= 2.0.2)

data/README.md

@@ -0,0 +1,77 @@
+# Chargebee Ruby Client Library - API V2
+
+[![gem](https://img.shields.io/gem/v/chargebee.svg?maxAge=2592000)](https://rubygems.org/gems/chargebee)
+[![gem](https://img.shields.io/gem/dtv/chargebee.svg?maxAge=2592000)](https://rubygems.org/gems/chargebee)
+
+This is the Ruby Library for integrating with Chargebee. Sign up for a Chargebee account {here}[https://www.chargebee.com].
+
+Chargebee now supports two API versions - [V1](https://apidocs.chargebee.com/docs/api/v1) and [V2](https://apidocs.chargebee.com/docs/api), of which V2 is the latest release and all future developments will happen in V2. This library is for <b>API version V2</b>. If you’re looking for V1, head to [chargebee-v1 branch](https://github.com/chargebee/chargebee-ruby/tree/chargebee-v1).
+
+## Installation
+
+Install the latest version of the gem with the following command...
+
+    $ sudo gem install chargebee -v '~>2'
+
+
+## Requirements
+
+* Ruby 1.9.3 or above.
+* rest-client
+
+## Documentation
+
+See our [Ruby API Reference](https://apidocs.chargebee.com/docs/api?lang=ruby "API Reference").
+
+## Usage
+
+### To create a new subscription:
+
+```ruby
+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}"
+```
+
+### Create an Idempotent Request
+
+[Idempotency keys](https://apidocs.chargebee.com/docs/api) are passed along with request headers to allow a safe retry of POST requests. 
+
+```ruby
+require 'chargebee'
+ChargeBee.configure({:api_key => "your_api_key" , :site => "your_site"})
+result = ChargeBee::Customer.create({
+  :first_name => "John",
+  :last_name => "Doe",
+  :email => "john@test.com",
+  :locale => "fr-CA",
+  :billing_address => {
+    :first_name => "John",
+    :last_name => "Doe",
+    :line1 => "PO Box 9999",
+    :city => "Walnut",
+    :state => "California",
+    :zip => "91789",
+    :country => "US"
+    }
+  },
+  nil,
+  {"chargebee-idempotency-key" => "<<UUID>>"} # Replace <<UUID>> with a unique string
+)
+customer = result.customer
+card = result.card
+responseHeader = result.get_response_headers # Retrieves response headers
+puts(responseHeader)
+idempotencyReplayedValue = result.is_idempotency_replayed # Retrieves Idempotency replayed header value
+puts(idempotencyReplayedValue)
+```
+`is_idempotency_replayed` method can be accessed to differentiate between original and replayed requests.
+
+## License
+
+See the LICENSE file.
+

data/chargebee.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
   s.required_ruby_version = '>= 1.9.3'
   s.name              = 'chargebee'
-  s.version           = '2.25.0'
-  s.date              = '2023-04-28'
+  s.version           = '2.26.1'
+  s.date              = '2023-05-16'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
 
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     Gemfile
     Gemfile.lock
     LICENSE
+    README.md
     README.rdoc
     Rakefile
     chargebee.gemspec

data/lib/chargebee/list_result.rb

@@ -10,12 +10,17 @@ module ChargeBee
     
     attr_reader :next_offset
 
-    def initialize(response, next_offset=nil)
+    def initialize(response, next_offset=nil, rheaders = nil)
       @response = response
+      @rheaders = rheaders
       @list = Array.new
       @next_offset = JSON.parse(next_offset).to_s if next_offset
       initItems()
     end
+
+    def get_response_headers()
+      @rheaders
+    end
     
     private
     def initItems()

data/lib/chargebee/request.rb

@@ -15,11 +15,11 @@ module ChargeBee
     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)
+      resp, rheaders = Rest.request(method, url, env, ser_params||={}, headers)
       if resp.has_key?(:list)
-        ListResult.new(resp[:list], resp[:next_offset]) 
+        ListResult.new(resp[:list], resp[:next_offset], rheaders) 
       else 
-        Result.new(resp)
+        Result.new(resp, rheaders)
       end
     end
       

data/lib/chargebee/rest.rb

@@ -54,6 +54,7 @@ module ChargeBee
       rescue Exception => e
             raise IOError.new("IO Exception when trying to connect to chargebee with url #{opts[:url]} . Reason #{e}",e)        
       end
+      rheaders = response.headers
       rbody = response.body
       rcode = response.code
       begin
@@ -68,7 +69,7 @@ module ChargeBee
         end
       end
       resp = Util.symbolize_keys(resp)
-      resp
+      return resp, rheaders
     end
     
     def self.handle_for_error(e, rcode=nil, rbody=nil)

data/lib/chargebee/result.rb

@@ -1,10 +1,26 @@
 module ChargeBee
   class Result
 
-    def initialize(response)
-      @response = response
+    IDEMPOTENCY_REPLAYED_HEADER = :chargebee_idempotency_replayed
+
+    def initialize(response, rheaders = nil)
+        @response = response
+        @rheaders = rheaders
+    end
+
+    def get_response_headers()
+        @rheaders
     end
     
+    def is_idempotency_replayed()
+        replayed_header = get_response_headers[IDEMPOTENCY_REPLAYED_HEADER]
+        if replayed_header != nil
+           return !!replayed_header
+        else
+           return false
+        end
+    end
+
     def subscription() 
         subscription = get(:subscription, Subscription,
         {:subscription_items => Subscription::SubscriptionItem, :item_tiers => Subscription::ItemTier, :charged_items => Subscription::ChargedItem, :addons => Subscription::Addon, :event_based_addons => Subscription::EventBasedAddon, :charged_event_based_addons => Subscription::ChargedEventBasedAddon, :coupons => Subscription::Coupon, :shipping_address => Subscription::ShippingAddress, :referral_info => Subscription::ReferralInfo, :contract_term => Subscription::ContractTerm, :discounts => Subscription::Discount});

data/lib/chargebee.rb

@@ -68,7 +68,7 @@ require File.dirname(__FILE__) + '/chargebee/models/token.rb'
 
 module ChargeBee
 
-  VERSION = '2.25.0'
+  VERSION = '2.26.1'
 
   @@default_env = nil
   @@verify_ca_certs = true

data/spec/chargebee_spec.rb

@@ -55,8 +55,10 @@ describe "chargebee" do
   end
 
   it "should properly convert the response json into proper object" do
-    @request.expects(:execute).once.returns(mock_response(simple_subscription))
+    @request.expects(:execute).once.returns(mock_response(simple_subscription, headers))
     result = ChargeBee::Subscription.retrieve("simple_subscription")
+    h = result.get_response_headers
+    expect(h).to eq(headers)
     s = result.subscription
     expect(s.id).to eq("simple_subscription")
     expect(s.plan_id).to eq('basic')
@@ -66,7 +68,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))
+    @request.expects(:execute).once.returns(mock_response(nested_subscription, headers))
     result = ChargeBee::Subscription.retrieve("nested_subscription")
     s = result.subscription
     expect(s.id).to eq("nested_subscription")
@@ -78,7 +80,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))
+    @request.expects(:execute).once.returns(mock_response(list_subscriptions, headers))
     result = ChargeBee::Subscription.list({:limit => 2})
     expect(result.length).to eq(2)
     result.each do |i|
@@ -87,7 +89,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))
+    @request.expects(:execute).once.returns(mock_response(sample_event, headers))
     result = ChargeBee::Event.retrieve("sample_event")
     event = result.event
     s = event.content.subscription

data/spec/sample_response.rb

@@ -12,6 +12,17 @@ def api_index_urls()
   }
 end
 
+def headers 
+  {
+    :cache_control=>"no-store, no-cache, must-revalidate",
+    :pragma=>"no-cache", 
+    :content_type=>"application/json;charset=utf-8", 
+    :content_length=>"986", 
+    :date=>"Tue, 16 May 2023 08:12:00 GMT", 
+    :server=>"ChargeBee"
+  }
+end
+
 def simple_subscription
   {
     :subscription => {

data/spec/spec_helper.rb

@@ -9,12 +9,13 @@ RSpec.configure do |config|
   config.mock_with :mocha
 end
 
-def mock_response(body, code=200)
+def mock_response(body, code=200, headers)
   body = body.to_json if !(body.kind_of? String)
   m = mock
-  m.instance_variable_set('@resp_values', { :body => body, :code => code })
+  m.instance_variable_set('@resp_values', { :body => body, :code => code, :headers => headers })
   def m.body; @resp_values[:body]; end
   def m.code; @resp_values[:code]; end
+  def m.headers; @resp_values[:headers]; end
   m
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee
 version: !ruby/object:Gem::Version
-  version: 2.25.0
+  version: 2.26.1
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-28 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -107,6 +107,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- README.md
 - README.rdoc
 - Rakefile
 - chargebee.gemspec