razorpay 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c28a35f404b325fc0728618fb47732be4c0d37a59ba3fbc5cb60fed4ed4b3d89
-  data.tar.gz: 560ce32cd8d54fed25ed614b02135feb185780dcd3b3d37ffafaffe5b3e6c9e8
+  metadata.gz: 59699530109b442fdc1c6a26cb1df4c906af476b1df20a09847dcda7ca3b5633
+  data.tar.gz: d04d833b06a6b461f4ed2892a3fac80e33e6c43456598f4933b33036909f8337
 SHA512:
-  metadata.gz: aedf371db7bcc4dca051a85c937565f02bf117968562577bda35eb45613905ad104bb6a81d914eaf1fa8f9ec74148052aa44a2d9deabd30fd35694f9407e67d8
-  data.tar.gz: 9c96522ec5323027f4fdb6d7aa9e1339c3e690eac33bfc2e6f7c72a9ec5fe8ea5d8f3c7517fe9102d9490635ecccc35129cc98415b318d6a61d8c780790a187a
+  metadata.gz: a922d53c0aae270f874ac9160dc23112937361bcee7716a393e554ad94e1b999c00918a7a3fa1cf43fd1f3d2c8fbcad586b6f61e9a8cab712b264195a68c5e6a
+  data.tar.gz: 2fab3f791c26bceb31d30d7e02ba6b273e9db3ce0b1d250cbe1a4afe29a9e05ded085793085dd503e10c65c3f65f4ed2a004219daff9cca30b0bd4e02c5420b6

data/CHANGELOG.md

@@ -4,6 +4,10 @@ Changelog for Razorpay-Ruby SDK.
 
 ## Unreleased
 
+## [3.2.0] - 2023-12-11
+
+feat: Added generic access point
+
 ## [3.1.0] - 2023-10-13
 
 ### Added

data/README.md

@@ -70,6 +70,8 @@ If you are using rails, the right place to do this might be `config/initializers
 - [Register NACH and Charge First Payment Together](documents/registerNach.md)
 - [Payment Verification](documents/paymentVerification.md)
 - [Webhook](documents/webhook.md)
+- [Generic](documents/generic.md)
+
 ## Development
 
 - Everything is namespaced under the Razorpay module

data/documents/generic.md

@@ -0,0 +1,150 @@
+## Generic Access point
+
+
+```rb
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Method Signature
+```rb
+Razorpay::Generic.new(entity).do(url, method, payload, version)
+```    
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| entity*       | string      | The endpoint to which the request will be made. (e.g., "contacts" or "accounts") |
+| url*          | string      | Add params or query or query (e.g., "/order_000000000000001" or "?count=1") |
+| method*       | string      | The HTTP method for the request (e.g., 'Get', 'Post', 'Put', 'Patch', 'Delete'). |
+| payload          | object      | The data to be sent with the request.|
+| version         | string    | Add version (e.g., "v1" or "v2") |
+
+-------------------------------------------------------------------------------------------------------
+
+### Create a contacts using POST
+
+```rb
+
+payload = {
+  "name": "Gaurav Kumar",
+  "email": "gaurav.kumar@example.com",
+  "contact": "9123456789",
+  "type": "employee",
+  "reference_id":"Acme Contact ID 12345",
+  "notes": {
+    "notes_key_1":"Tea, Earl Grey, Hot",
+    "notes_key_2":"Tea, Earl Grey… decaf.",
+  },
+}
+
+Razorpay::Generic.new("contacts").do("/", "Post", payload)
+```
+
+**Response:**
+
+```json
+{
+  "id": "cont_00000000000001",
+  "entity": "contact",
+  "name": "Gaurav Kumar",
+  "contact": "9123456789",
+  "email": "gaurav.kumar@example.com",
+  "type": "employee",
+  "reference_id": "Acme Contact ID 12345",
+  "batch_id": null,
+  "active": true,
+  "notes": {
+    "notes_key_1": "Tea, Earl Grey, Hot",
+    "notes_key_2": "Tea, Earl Grey… decaf."
+  },
+  "created_at": 1545320320
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch an order using GET
+
+```rb
+Razorpay::Generic.new("orders").do("/order_00000000000001", "Get", {})
+```
+
+**Response:**
+
+```json
+{
+  "amount": 307,
+  "amount_due": 0,
+  "amount_paid": 307,
+  "attempts": 1,
+  "created_at": 1695625101,
+  "currency": "INR",
+  "entity": "order",
+  "id": "order_00000000000001",
+  "notes": [],
+  "offer_id": null,
+  "receipt": "851617",
+  "status": "paid"
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch payments of a linked account using headers
+
+```rb
+Razorpay.headers = {"X-Razorpay-Account" => "acc_00000000000001"}
+
+Razorpay::Generic.new("payments").do("/pay_00000000000001", "Get", {})
+```
+
+**Response:**
+
+```json
+{
+  "entity": "collection",
+  "count": 2,
+  "items": [
+    {
+      "id": "pay_00000000000001",
+      "entity": "payment",
+      "amount": 10000,
+      "currency": "INR",
+      "status": "captured",
+      "order_id": "order_00000000000001",
+      "invoice_id": null,
+      "international": false,
+      "method": "netbanking",
+      "amount_refunded": 0,
+      "refund_status": null,
+      "captured": true,
+      "description": "#JJCqaOhFihfkVE",
+      "card_id": null,
+      "bank": "YESB",
+      "wallet": null,
+      "vpa": null,
+      "email": "john.example@example.com",
+      "contact": "9999999999",
+      "notes": [],
+      "fee": 236,
+      "tax": 36,
+      "error_code": null,
+      "error_description": null,
+      "error_source": null,
+      "error_step": null,
+      "error_reason": null,
+      "acquirer_data": {
+        "bank_transaction_id": "2118867"
+      },
+      "created_at": 1649932775
+    }
+  ]
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>

data/lib/razorpay/constants.rb

@@ -2,5 +2,31 @@
 module Razorpay
   BASE_URI = 'https://api.razorpay.com'.freeze
   TEST_URL = 'https://api.razorpay.com/'.freeze
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.2.0'.freeze
+  ENTITIES_LIST =  {
+    "cards" => "card",
+    "invoices" => "invoice",
+    "refunds" => "refund",
+    "orders" => "order",
+    "payments" => "payment",
+    "customers" => "customer",
+    "plans" => "plan",
+    "virtual_accounts" => "virtualAccount",
+    "addons" => "addon",
+    "subscriptions" => "subscriptions",
+    "subscription_registrations" => "subscription_registrations",
+    "transfers" => "transfers",
+    "payment_links" => "payment_links",
+    "settlements" => "settlements",
+    "qr_codes" => "qr_codes",
+    "items" => "items",
+    "fund_accounts" => "fund_accounts",
+    "webhooks" => "webhook",
+    "payment_methods" => "payment_methods",
+    "products" => "products",
+    "tokens" => "tokens",
+    "iins" => "iins",
+    "stakeholders" => "stakeholders",
+    "accounts" => "accounts"
+  }
 end

data/lib/razorpay/generic.rb

@@ -0,0 +1,39 @@
+require 'razorpay/request'
+
+
+module Razorpay
+  class Generic
+    def initialize(entity)
+      @entity = entity
+    end
+
+    def request()
+      Razorpay::Request.new(@entity)
+    end
+
+    def do(url="", method="Get", options={}, version="v1")
+      r = self.request
+      r.doesEntityExist(@entity)
+
+      case method
+      when "Get"          
+        r.get url, options, version
+
+      when "Post"
+        r.post url, options, version
+
+      when "Patch"
+        r.patch url, options, version
+        
+      when "Put"
+        r.put url, options, version 
+      
+      when "Delete"
+        r.delete url, version
+      
+      else
+        warn("Unsupported method or error occurred") 
+      end   
+    end
+  end
+end

data/lib/razorpay/request.rb

@@ -115,5 +115,11 @@ module Razorpay
       # We got an unknown error, cast it to Error for now
       raise Razorpay::Error.new, 'Unknown Error'
     end
+
+    def doesEntityExist(entity)
+      if (Razorpay::ENTITIES_LIST.include?(entity))
+        warn("Warning: The entity already has a specific function. Consider using it instead.")
+      end
+    end 
   end
 end

data/lib/razorpay.rb

@@ -26,6 +26,7 @@ require 'razorpay/token'
 require 'razorpay/product'
 require 'razorpay/stakeholder'
 require 'razorpay/account'
+require 'razorpay/generic'
 
 # Base Razorpay module
 module Razorpay

data/test/razorpay/test_generic.rb

@@ -0,0 +1,112 @@
+require 'test_helper'
+
+module Razorpay
+  # Tests for Razorpay::Addon
+  class RazorpayGenericTest < Minitest::Test
+    class Generic < Razorpay::Entity; end
+
+    def setup
+      @order_id = 'order_50sX9hGHZJvjjI'
+      @customer_id = 'cust_6vRXClWqnLhV14'
+      @invoice_id = 'inv_6vRZmJYFAG1mNq'
+      @addon_id = 'ao_IrSY3UIqDRx7df'
+    end
+
+    def test_generic_should_be_defined
+      refute_nil Razorpay::Generic
+    end
+   
+    # Test fetch endpoint by order entity
+    def test_generic_orders_should_be_fetch   
+      stub_get(%r{orders/#{@order_id}$}, 'fake_order')
+
+      client = Razorpay::Generic.new("orders")
+      
+      order = client.do(@order_id)
+
+      assert_equal 5000, order.amount
+      assert_equal 'INR', order.currency
+      assert_equal 'TEST', order.receipt
+    end
+
+    # Test post endpoint by order entity
+    def test_generic_orders_should_be_create
+       para_attr = {
+         "amount": 5000
+       }
+
+      stub_post("#{BASE_URI}/v1/orders/", 'fake_order', para_attr.to_json)
+     
+      client = Razorpay::Generic.new("orders")
+      order = client.do("", "Post", para_attr.to_json)
+      assert_equal 5000, order.amount
+      assert_equal 'INR', order.currency
+      assert_equal 'TEST', order.receipt
+    end
+
+    # Test fetch endpoint by order entity
+    def test_generic_orders_should_be_edit
+        para_attr = {
+          "notes": {
+            "purpose": "Test UPI QR code notes uodate"
+          }
+        }
+ 
+       stub_patch("#{BASE_URI}/v1/orders/#{@order_id}", 'fake_order', para_attr.to_json)
+      
+       client = Razorpay::Generic.new("orders")
+       order = client.do(@order_id, "Patch", para_attr.to_json)
+       assert_equal 5000, order.amount
+       assert_equal 'INR', order.currency
+       assert_equal 'TEST', order.receipt
+     end
+
+    # Test post endpoint by order entity 
+    def test_generic_customer_should_be_create
+        para_attr = {
+           "name": "Gaurav Kumar",
+           "contact": 9123456780,
+           "email": "gaurav.kumar@example.com",
+           "notes": {
+             "notes_key_1": "Tea, Earl Grey, Hot",
+             "notes_key_2": "Tea, Earl Grey… decaf."
+           }
+        }
+ 
+       stub_post("#{BASE_URI}/v1/customers/", 'fake_customer', para_attr.to_json)
+      
+       client = Razorpay::Generic.new("customers")
+       customer = client.do("","Post", para_attr.to_json)
+       assert_equal 'test@razorpay.com', customer.email
+       assert_equal '9876543210', customer.contact
+    end
+
+    # Test put endpoint by order entity 
+    def test_generic_customer_should_be_edit
+        para_attr = {
+           "contact": 9123456780,
+        }
+ 
+       stub_put("#{BASE_URI}/v1/customers/#{@customer_id}", 'fake_customer', para_attr.to_json)
+      
+       client = Razorpay::Generic.new("customers")
+       customer = client.do(@customer_id, "Put", para_attr.to_json)
+       assert_equal 'test@razorpay.com', customer.email
+       assert_equal '9876543210', customer.contact
+    end
+    
+    def test_generic_delete_specific_invoice
+      stub_delete(%r{invoices/#{@invoice_id}$}, 'empty')
+      client = Razorpay::Generic.new("invoices")
+      invoice = client.do("#{@invoice_id}", "Delete")
+      refute_nil invoice
+    end
+
+    def test_generic_delete_addon
+      stub_delete(%r{addons/#{@addon_id}$}, 'empty')
+      client = Razorpay::Generic.new("addons")
+      addon = client.do("#{@addon_id}", "Delete")
+      refute_nil addon
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: razorpay
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Abhay Rana
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-13 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -137,6 +137,7 @@ files:
 - documents/customer.md
 - documents/emandate.md
 - documents/fund.md
+- documents/generic.md
 - documents/items.md
 - documents/order.md
 - documents/papernach.md
@@ -173,6 +174,7 @@ files:
 - lib/razorpay/errors/razorpay_error.rb
 - lib/razorpay/errors/server_error.rb
 - lib/razorpay/fund_account.rb
+- lib/razorpay/generic.rb
 - lib/razorpay/iin.rb
 - lib/razorpay/invoice.rb
 - lib/razorpay/item.rb
@@ -293,6 +295,7 @@ files:
 - test/razorpay/test_customer.rb
 - test/razorpay/test_entity.rb
 - test/razorpay/test_fund_account.rb
+- test/razorpay/test_generic.rb
 - test/razorpay/test_iin.rb
 - test/razorpay/test_invoice.rb
 - test/razorpay/test_item.rb
@@ -437,6 +440,7 @@ test_files:
 - test/razorpay/test_customer.rb
 - test/razorpay/test_entity.rb
 - test/razorpay/test_fund_account.rb
+- test/razorpay/test_generic.rb
 - test/razorpay/test_iin.rb
 - test/razorpay/test_invoice.rb
 - test/razorpay/test_item.rb