chargebee 2.25.0 → 2.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6802473f9e53098c12e06f210e96a9067fa92b23
-  data.tar.gz: fa7fdb9c0533e6c5d8751517fa26516bce474130
+  metadata.gz: 47e67b64038c0962879a8cdc8b5fcfdb9188f7a6
+  data.tar.gz: 21248229802c3b25e40c6a43a7ccc1a0d23b7fb4
 SHA512:
-  metadata.gz: 8ed018f8398ebf065b7a25b92a70bf47bb0dd8a702ab85cc061ade52fd305155c10389fae40c043661e9bf8b1798a88d0b95a13384e090a954c1553021f94cb3
-  data.tar.gz: 9237adea2f062d4fad042d1c9dda997e8d621bbe2ea820132e313679746555fd73d090455d01bdce7da3e3f573d923cf4e20cfedcbbd70ab425a61bcaf39b320
+  metadata.gz: 2c5dc16a5704ca0b088200f37d95b03d36c5e94e4723f21f636037c883e2073e1ce7d2191a8d0633f9e5549aea03dfbcf3a285aefa799051ee03fea8d7c69e73
+  data.tar.gz: 8809d69227fe4269056c867f8f98965195f34ea454f2deb0c843eb268c99060ad0b0f5d2b6d4dcc8ece1b0b75d4d4f9226ce5b33104f5e1354a402c668069567

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 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.0)
       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.0'
+  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.0'
 
   @@default_env = nil
   @@verify_ca_certs = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee
 version: !ruby/object:Gem::Version
-  version: 2.25.0
+  version: 2.26.0
 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