razorpay 3.2.0 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59699530109b442fdc1c6a26cb1df4c906af476b1df20a09847dcda7ca3b5633
-  data.tar.gz: d04d833b06a6b461f4ed2892a3fac80e33e6c43456598f4933b33036909f8337
+  metadata.gz: 0f1899756cb2c34271a9cd8167029bb2aa56d3a07094df776feab8de024aa69b
+  data.tar.gz: daf3f8a28f3d5f211a1f83de9772d4f71fa3aa8b0b415bb0731846930584e11a
 SHA512:
-  metadata.gz: a922d53c0aae270f874ac9160dc23112937361bcee7716a393e554ad94e1b999c00918a7a3fa1cf43fd1f3d2c8fbcad586b6f61e9a8cab712b264195a68c5e6a
-  data.tar.gz: 2fab3f791c26bceb31d30d7e02ba6b273e9db3ce0b1d250cbe1a4afe29a9e05ded085793085dd503e10c65c3f65f4ed2a004219daff9cca30b0bd4e02c5420b6
+  metadata.gz: 9458dcd7356a9017800f5ec4cdae747f17e4595ab7b9f194cb8f14c617f41b8c077497b4438afbd559ecd2f6c0f580f4de5ca5935ed7d7aa6de05679e27be535
+  data.tar.gz: 3377a46637db6e97d2c2435818de9d8b4782aac20d72adf4721e149c9fff2b7fbe41a83a0374090d2556cec2b996438160850d95ffa3b7f0d92a6f99d22aa024

data/.github/workflows/ruby.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['3.0']
 
     steps:
     - uses: actions/checkout@v3

data/CHANGELOG.md

@@ -4,6 +4,17 @@ Changelog for Razorpay-Ruby SDK.
 
 ## Unreleased
 
+## [3.2.2] - 2024-04-16
+
+feat: Added oauth APIs and support for access token based authentication mechanism
+* Added oauth APIs (getAuthURL, getAccessToken, refreshToken, revokeToken)
+* Added support for access token based authentication mechanism
+* Added support for onboarding signature generation
+
+## [3.2.1] - 2023-12-19
+
+Rollback: Generic access point due to some performance concern
+
 ## [3.2.0] - 2023-12-11
 
 feat: Added generic access point

data/README.md

@@ -27,7 +27,11 @@ Ruby 2.6.8 or later
 
 Remember to `require 'razorpay'` before anything else.
 
-Next, you need to setup your key and secret using the following:
+Next, you need to setup your auth details. This setup can be done via two ways:
+
+### Using Private Auth
+
+you need to setup your key and secret using the following:
 
 ```rb
 Razorpay.setup('key_id', 'key_secret')
@@ -38,6 +42,16 @@ You can set customer headers for your requests using the following:
 Razorpay.headers = {"CUSTOM_APP_HEADER" => "CUSTOM_VALUE"}
 ```
 
+### Using Access Token
+you need to setup your access token using the following
+```rb
+Razorpay.setup_with_oauth('access_token')
+```
+You can set customer headers for your requests using the following:
+```rb
+Razorpay.headers = {"CUSTOM_APP_HEADER" => "CUSTOM_VALUE"}
+```
+
 You can find your API keys at <https://dashboard.razorpay.com/#/app/keys>.
 
 If you are using rails, the right place to do this might be `config/initializers/razorpay.rb`.
@@ -70,7 +84,7 @@ 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)
+- [OAuthToken](documents/oauth_token.md)
 
 ## Development
 

data/documents/oauth_token.md

@@ -0,0 +1,142 @@
+### OAuthToken
+
+```rb
+require "razorpay"
+```
+
+### Generate Authorize Url
+```rb
+body = {
+    submerchant_id: '<SUBMERCHANT_MID>',
+    timestamp: Time.now.to_i
+}
+onboarding_signature = Razorpay::Utility.generate_onboarding_signature(body, '<YOUR_CLIENT_SECRET>')
+
+options = {
+    'client_id'            => '<YOUR_CLIENT_ID>',
+    'redirect_uri'         => 'https://example.com/razorpay_callback',
+    'scopes'               => ["read_write"],
+    'state'                => 'NOBYtv8r6c75ex6WZ',
+    'onboarding_signature' => onboarding_signature
+}
+authorize_url = Razorpay::OAuthToken.get_auth_url(options)
+```
+
+**Parameters:**
+
+| Name                 | Type   | Description                                                                                                                                             |
+|----------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| client_id*           | string | Unique client identifier.                                                                                                                               |
+| redirect_uri*        | string | Callback URL used by Razorpay to redirect after the user approves or denies the authorisation request. The client should whitelist the 'redirect_uri'.  |
+| scopes*              | array  | Defines what access your application is requesting from the user. You can request one or multiple scopes by adding them to an array as indicated above. |
+| state*               | string | A random string generated by your service. This parameter helps prevent cross-site request forgery (CSRF) attacks.                                      |
+| onboarding_signature | string | A cryptographic string generated by your service using generateOnboardingSignature method in Utils class. Only applicable for accounts created with pre-fill KYC |
+
+**Response:**
+```
+"https://auth.razorpay.com/authorize?response_type=code&client_id=<YOUR_CLIENT_ID>&redirect_uri=https:%2F%2Fexample.com%2Frazorpay_callback&scope[]=read_only&scope[]=rx_read_write&state=NOBYtv8r6c75ex6WZ&onboarding_signature=<GENERATED_ONBOARDING_SIGNATURE>"
+```
+
+-------------------------------------------------------------------------------------------------------
+### Get Access token
+```rb
+options = {
+    'client_id'          => '<YOUR_CLIENT_ID>',
+    'client_secret'     => '<YOUR_CLIENT_SECRET>',
+    'redirect_uri'      => 'https://example.com/razorpay_callback',
+    'grant_type'        => 'authorization_code',
+    'code'              => '<AUTHORIZATION_CODE>',
+    'mode'              => 'test'
+}
+oauth_token = Razorpay::OAuthToken.get_access_token(options)
+```
+
+**Parameters:**
+
+| Name           | Type   | Description                                                                                                                  |
+|----------------|--------|------------------------------------------------------------------------------------------------------------------------------|
+| client_id*     | string | Unique client identifier.                                                                                                    |
+| client_secret* | string | Client secret string.                                                                                                        |
+| redirect_uri*  | string | Specifies the same redirect_uri used in the authorisation request.                                                           |
+| grant_type*    | string | Defines the grant type for the request. Possible value are:<ul><li>authorization_code</li><li>client_credentials</li></ul>   |
+| code*          | string | Decoded authorisation code received in the last step. Note: Pass this parameter only when grant_type is 'authorization_code' |
+| mode           | string | The type of mode. Possible values: <ul><li>test</li><li>live (default)</li></ul>                                             |
+
+**Response:**
+```json
+{
+  "public_token": "rzp_test_oauth_9xu1rkZqoXlClS",
+  "token_type": "Bearer",
+  "expires_in": 7862400,
+  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IkY1Z0NQYkhhRzRjcUpnIn0.eyJhdWQiOiJGNFNNeEgxanMxbkpPZiIsImp0aSI6IkY1Z0NQYkhhRzRjcUpnIiwiaWF0IjoxNTkyODMxMDExLCJuYmYiOjE1OTI4MzEwMTEsInN1YiI6IiIsImV4cCI6MTYwMDc3OTgxMSwidXNlcl9pZCI6IkYycVBpejJEdzRPRVFwIiwibWVyY2hhbnRfaWQiOiJGMnFQaVZ3N0lNV01GSyIsInNjb3BlcyI6WyJyZWFkX29ubHkiXX0.Wwqt5czhoWpVzP5_aoiymKXoGj-ydo-4A_X2jf_7rrSvk4pXdqzbA5BMrHxPdPbeFQWV6vsnsgbf99Q3g-W4kalHyH67LfAzc3qnJ-mkYDkFY93tkeG-MCco6GJW-Jm8xhaV9EPUak7z9J9jcdluu9rNXYMtd5qxD8auyRYhEgs",
+  "refresh_token": "def50200f42e07aded65a323f6c53181d802cc797b62cc5e78dd8038d6dff253e5877da9ad32f463a4da0ad895e3de298cbce40e162202170e763754122a6cb97910a1f58e2378ee3492dc295e1525009cccc45635308cce8575bdf373606c453ebb5eb2bec062ca197ac23810cf9d6cf31fbb9fcf5b7d4de9bf524c89a4aa90599b0151c9e4e2fa08acb6d2fe17f30a6cfecdfd671f090787e821f844e5d36f5eacb7dfb33d91e83b18216ad0ebeba2bef7721e10d436c3984daafd8654ed881c581d6be0bdc9ebfaee0dc5f9374d7184d60aae5aa85385690220690e21bc93209fb8a8cc25a6abf1108d8277f7c3d38217b47744d7",
+  "razorpay_account_id": "acc_Dhk2qDbmu6FwZH"
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Get Access token using refresh token
+```rb
+options = {
+    'client_id'          => '<YOUR_CLIENT_ID>',
+    'client_secret'     => '<YOUR_CLIENT_SECRET>',
+    'refresh_token'     => 'def5020096e1c470c901d34cd60fa53abdaf3662sa0'
+}
+oauth_token = Razorpay::OAuthToken.refresh_token(options)
+```
+
+**Parameters:**
+
+| Name           | Type      | Description                                |
+|----------------|-----------|--------------------------------------------|
+| client_id*     | string    | Unique client identifier.                  |
+| client_secret* | string    | Client secret string.                      |
+| refresh_token* | string    | The previously-stored refresh token value. |
+
+**Response:**
+```json
+{
+  "public_token": "rzp_test_oauth_9xu1rkZqoXlClS",
+  "token_type": "Bearer",
+  "expires_in": 7862400,
+  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6Ijl4dTF",
+  "refresh_token": "def5020096e1c470c901d34cd60fa53abdaf36620e823ffa53"
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Revoke a token
+```rb
+options = {
+    'client_id'         => '<YOUR_CLIENT_ID>',
+    'client_secret'     => '<YOUR_CLIENT_SECRET>',
+    'token'             => 'def5020096e1c470c901d34cd60fa53abdaf36620e823ffa53'
+    'token_type_hint'   => 'access_token'
+}
+response = Razorpay::OAuthToken.revoke_token(options)
+```
+
+**Parameters:**
+
+| Name             | Type     | Description                                                                                              |
+|------------------|----------|----------------------------------------------------------------------------------------------------------|
+| client_id*       | string   | Unique client identifier.                                                                                |
+| client_secret*   | string   | Client secret string.                                                                                    |
+| token_type_hint* | string   | The type of token for the request. Possible values: <ul><li>access_token</li><li>refresh_token</li></ul> |
+| token*           | string   | The token whose access should be revoked.                                                                |
+
+**Response:**
+```json
+{
+  "message": "Token Revoked"
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/partners/platform/onboard-businesses/integrate-oauth/integration-steps)**
+

data/lib/razorpay/constants.rb

@@ -2,31 +2,10 @@
 module Razorpay
   BASE_URI = 'https://api.razorpay.com'.freeze
   TEST_URL = 'https://api.razorpay.com/'.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"
-  }
+  VERSION  = '3.2.2'.freeze
+  AUTH_URL = 'https://auth.razorpay.com'.freeze
+  API_HOST = 'API'.freeze
+  AUTH_HOST    = 'AUTH'.freeze
+  PRIVATE_AUTH = 'Private'.freeze
+  OAUTH        = 'OAuth'.freeze
 end

data/lib/razorpay/oauth_token.rb

@@ -0,0 +1,109 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+require 'razorpay/payload_validator'
+require 'razorpay/validation_config'
+
+module Razorpay
+  # OAuth APIs allow to you create and manage access tokens
+  class OAuthToken < Entity
+    def self.request
+      Razorpay::Request.new('token', Razorpay::AUTH_HOST)
+    end
+
+    def self.get_auth_url(options)
+      validate_auth_url_request(options)
+      uri = URI.join(Razorpay::AUTH_URL, '/authorize')
+
+      query_params = {
+        'response_type' => 'code',
+        'client_id' => options['client_id'], 
+        'redirect_uri' => options['redirect_uri'], 
+        'state' => options['state']
+      }
+
+      options['scopes'].each { |scope| query_params["scope[]"] = scope }
+
+      if options.has_key?('onboarding_signature')
+        query_params['onboarding_signature'] = options['onboarding_signature']
+      end
+      uri.query = URI.encode_www_form(query_params)
+      uri.to_s
+    end
+
+    def self.get_access_token(options)
+      validate_access_token_request(options)
+      r = request
+      r.request :post, "/token", options
+    end
+
+    def self.refresh_token(options)
+        options['grant_type'] = 'refresh_token'
+      validate_refresh_token_request(options)
+      r = request
+      r.request :post, "/token", options
+    end
+
+    def self.revoke_token(options)
+      validate_revoke_token_request(options)
+      r = request
+      r.request :post, "/revoke", options
+    end
+
+    class << self
+        
+      private
+      
+      def validate_auth_url_request(options)
+        Razorpay::PayloadValidator.validate(options, get_validations_for_auth_request_url)
+      end
+
+      def validate_access_token_request(options)
+        Razorpay::PayloadValidator.validate(options, get_validations_for_access_token_request)
+      end
+
+      def validate_refresh_token_request(options)
+        Razorpay::PayloadValidator.validate(options, get_validations_for_refresh_token_request)
+      end
+
+      def validate_revoke_token_request(options)
+        Razorpay::PayloadValidator.validate(options, get_validations_for_revoke_token_request)
+      end
+
+      def get_validations_for_auth_request_url
+        [
+          Razorpay::ValidationConfig.new('client_id', [:id]),
+          Razorpay::ValidationConfig.new('redirect_uri', [:non_empty_string, :url]),
+          Razorpay::ValidationConfig.new('scopes', [:non_null]),
+          Razorpay::ValidationConfig.new('state', [:non_empty_string])
+        ]
+      end
+
+      def get_validations_for_access_token_request
+        [
+          Razorpay::ValidationConfig.new('client_id', [:id]),
+          Razorpay::ValidationConfig.new('client_secret', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('redirect_uri', [:non_empty_string, :url]),
+          Razorpay::ValidationConfig.new('grant_type', [:token_grant])
+        ]
+      end
+
+      def get_validations_for_refresh_token_request
+        [
+          Razorpay::ValidationConfig.new('client_id', [:id]),
+          Razorpay::ValidationConfig.new('client_secret', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('refresh_token', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('grant_type', [:token_grant])
+        ]
+      end
+
+      def get_validations_for_revoke_token_request
+        [
+          Razorpay::ValidationConfig.new('client_id', [:id]),
+          Razorpay::ValidationConfig.new('client_secret', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('token', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('token_type_hint', [:non_empty_string])
+        ]
+      end
+    end
+  end 
+end

data/lib/razorpay/payload_validator.rb

@@ -0,0 +1,93 @@
+module Razorpay
+
+  ValidationType = {
+    non_null: :non_null,
+    non_empty_string: :non_empty_string,
+    url: :url,
+    id: :id,
+    mode: :mode,
+    token_grant: :token_grant
+  }
+
+  # PayloadValidator allows to perform basic validations
+  class PayloadValidator
+    def self.validate(request, validation_configs)
+      validation_configs.each do |config|
+        field_name = config.field_name
+        config.validations.each do |validation_type|
+          apply_validation(request, field_name, validation_type)
+        end
+      end
+    end
+
+    class << self
+
+      private
+
+      def apply_validation(payload, field, validation_type)
+        case validation_type
+        when ValidationType[:non_null]
+          validate_non_null(payload, field)
+        when ValidationType[:non_empty_string]
+          validate_non_empty_string(payload, field)
+        when ValidationType[:url]
+          validate_url(payload, field)
+        when ValidationType[:id]
+          validate_id(payload, field)
+        when ValidationType[:mode]
+          validate_mode(payload, field)
+        when ValidationType[:token_grant]
+          validate_grant_type(payload, field)
+        end
+      end
+
+      def validate_non_null(payload, field)
+        raise Razorpay::Error.new, "Field #{field} cannot be null" unless payload.key?(field) && !payload[field].nil?
+      end
+
+      def validate_non_empty_string(payload, field)
+        raise Razorpay::Error.new, "Field #{field} cannot be empty" if payload[field].to_s.strip.empty?
+      end
+
+      def validate_url(payload, field)
+        url = payload[field]
+        url_regex = /^(http[s]?):\/\/[^\s\/$.?#].[^\s]*$/
+        
+        unless url_regex.match?(url)
+          error_message = "Field #{field} is not a valid URL"
+          raise Razorpay::Error.new, error_message
+        end
+      end
+
+      def validate_id(payload, field)
+        validate_non_null(payload, field)
+        validate_non_empty_string(payload, field)
+        value = payload[field]
+        id_regex = /^[A-Za-z0-9]{1,14}$/
+
+        unless value.match?(id_regex)
+          error_message = "Field #{field} is not a valid ID"
+          raise Razorpay::Error.new, error_message
+        end
+      end
+
+      def validate_mode(payload, field)
+        validate_non_null(payload, field)
+        unless ["test", "live"].include?(payload[field])
+          error_message = "Invalid value provided for field #{field}"
+          raise Razorpay::Error.new, error_message
+        end
+      end
+
+      def validate_grant_type(payload, field)
+        validate_non_null(payload, field)
+        case payload[field]
+        when 'authorization_code'
+          validate_non_null(payload, 'code');
+        when 'refresh_token'
+          validate_non_null(payload, 'refresh_token');
+        end
+      end
+    end
+  end
+end

data/lib/razorpay/request.rb

@@ -11,20 +11,30 @@ module Razorpay
 
     ssl_ca_file File.dirname(__FILE__) + '/../ca-bundle.crt'
 
-    def initialize(entity_name = nil)
-      self.class.base_uri(Razorpay::BASE_URI)
+    def initialize(entity_name = nil, host = Razorpay::API_HOST)
+      self.class.base_uri(get_base_url(host))
       @entity_name = entity_name
       custom_headers = Razorpay.custom_headers || {}
       predefined_headers = {
         'User-Agent' => "Razorpay-Ruby/#{Razorpay::VERSION}; Ruby/#{RUBY_VERSION}"
       }
+
       # Order is important to give precedence to predefined headers
       headers = custom_headers.merge(predefined_headers)
-      @options = {
-        basic_auth: Razorpay.auth,
-        timeout: 30,
-        headers: headers
-      }
+
+      if Razorpay.auth_type == Razorpay::OAUTH
+        @options = {
+          timeout: 30,
+          headers: headers
+        }
+        headers['Authorization'] = 'Bearer ' + Razorpay.access_token 
+      else 
+        @options = {
+          basic_auth: Razorpay.auth,
+          timeout: 30,
+          headers: headers
+        }
+      end
     end
 
     def fetch(id, version="v1")
@@ -74,6 +84,13 @@ module Razorpay
       self.class.send(method, url, @options)
     end
 
+    def get_base_url(host)
+      if host == Razorpay::AUTH_HOST
+        return Razorpay::AUTH_URL
+      end 
+      Razorpay::BASE_URI
+    end
+
     # Since we need to change the base route
     def make_test_request
       self.class.get Razorpay::TEST_URL, @options
@@ -115,11 +132,5 @@ 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/utility.rb

@@ -26,6 +26,11 @@ module Razorpay
       verify_signature(body, signature, secret)
     end
 
+    def self.generate_onboarding_signature(body, secret)
+      json_data = body.to_json
+      encrypt(json_data, secret);
+    end
+
     class << self
       private
 
@@ -52,6 +57,25 @@ module Razorpay
 
         r.zero?
       end
+
+      def encrypt(data, secret)
+        iv = secret[0, 12]
+        key = secret[0, 16]
+
+        cipher = OpenSSL::Cipher.new('aes-128-gcm')
+        cipher.encrypt
+        cipher.key = key
+        cipher.iv = iv
+
+        cipher.auth_data = ""
+
+        encrypted = cipher.update(data) + cipher.final
+
+        tag = cipher.auth_tag
+        combined_encrypted_data = encrypted + tag
+
+        encrypted_data_hex = combined_encrypted_data.unpack1("H*")
+      end
     end
   end
 end

data/lib/razorpay/validation_config.rb

@@ -0,0 +1,11 @@
+module Razorpay
+
+  class ValidationConfig
+    attr_reader :field_name, :validations
+
+    def initialize(field_name, validations)
+      @field_name = field_name
+      @validations = validations
+    end
+  end
+end

data/lib/razorpay.rb

@@ -26,16 +26,22 @@ require 'razorpay/token'
 require 'razorpay/product'
 require 'razorpay/stakeholder'
 require 'razorpay/account'
-require 'razorpay/generic'
+require 'razorpay/oauth_token'
 
 # Base Razorpay module
 module Razorpay
   class << self
-    attr_accessor :auth, :custom_headers
+    attr_accessor :auth, :custom_headers, :access_token, :auth_type
   end
 
   def self.setup(key_id, key_secret)
     self.auth = { username: key_id, password: key_secret }
+    self.auth_type = Razorpay::PRIVATE_AUTH
+  end
+
+  def self.setup_with_oauth(access_token)
+    self.access_token = access_token
+    self.auth_type = Razorpay::OAUTH
   end
 
   def self.headers=(headers = {})

data/test/fixtures/fake_oauth_token.json

@@ -0,0 +1,8 @@
+{
+    "public_token": "rzp_test_oauth_9xu1rkZqoXlClS",
+    "token_type": "Bearer",
+    "expires_in": 7862400,
+    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IkY1Z0NQYkhhRzRjcUpnIn0.eyJhdWQiOiJGNFNNeEgxanMxbkpPZiIsImp0aSI6IkY1Z0NQYkhhRzRjcUpnIiwiaWF0IjoxNTkyODMxMDExLCJuYmYiOjE1OTI4MzEwMTEsInN1YiI6IiIsImV4cCI6MTYwMDc3OTgxMSwidXNlcl9pZCI6IkYycVBpejJEdzRPRVFwIiwibWVyY2hhbnRfaWQiOiJGMnFQaVZ3N0lNV01GSyIsInNjb3BlcyI6WyJyZWFkX29ubHkiXX0.Wwqt5czhoWpVzP5_aoiymKXoGj-ydo-4A_X2jf_7rrSvk4pXdqzbA5BMrHxPdPbeFQWV6vsnsgbf99Q3g-W4kalHyH67LfAzc3qnJ-mkYDkFY93tkeG-MCco6GJW-Jm8xhaV9EPUak7z9J9jcdluu9rNXYMtd5qxD8auyRYhEgs",
+    "refresh_token": "def50200f42e07aded65a323f6c53181d802cc797b62cc5e78dd8038d6dff253e5877da9ad32f463a4da0ad895e3de298cbce40e162202170e763754122a6cb97910a1f58e2378ee3492dc295e1525009cccc45635308cce8575bdf373606c453ebb5eb2bec062ca197ac23810cf9d6cf31fbb9fcf5b7d4de9bf524c89a4aa90599b0151c9e4e2fa08acb6d2fe17f30a6cfecdfd671f090787e821f844e5d36f5eacb7dfb33d91e83b18216ad0ebeba2bef7721e10d436c3984daafd8654ed881c581d6be0bdc9ebfaee0dc5f9374d7184d60aae5aa85385690220690e21bc93209fb8a8cc25a6abf1108d8277f7c3d38217b47744d7",
+    "razorpay_account_id": "acc_Dhk2qDbmu6FwZH"
+}

data/test/fixtures/fake_revoke_token.json

@@ -0,0 +1,3 @@
+{
+    "message": "Token Revoked"
+}

data/test/razorpay/test_oauth_token.rb

@@ -0,0 +1,105 @@
+require 'test_helper'
+
+module Razorpay
+    # Tests for Razorpay::OauthToken
+  class RazorpayOAuthTokenTest < Minitest::Test
+    class OAuthToken < Razorpay::Entity; end
+      
+      def test_get_auth_url
+        options = {
+            'client_id'    => '8DXCMTshWSWECc',
+            'redirect_uri' => 'https://example.com/razorpay_callback',
+            'state'        => 'NOBYtv8r6c75ex6WZ',
+            'scopes'       => ["read_write"]
+        }
+
+        expected_auth_url = "https://auth.razorpay.com/authorize?response_type=code&client_id=8DXCMTshWSWECc&redirect_uri=https%3A%2F%2Fexample.com%2Frazorpay_callback&state=NOBYtv8r6c75ex6WZ&scope%5B%5D=read_write"
+        auth_url = Razorpay::OAuthToken.get_auth_url(options)
+        assert_equal expected_auth_url, auth_url
+      end
+
+      def test_request_validation_for_get_auth_url
+        options = {
+            'client_id'    => '8DXCMTshWSWECc',
+            'redirect_uri' => 'https://example.com/razorpay_callback',
+            'scopes'       => ["read_write"]
+        }
+        assert_raises(Razorpay::Error) do
+          Razorpay::OAuthToken.get_auth_url(options)
+        end
+      end
+
+      def test_get_access_token 
+        options = {
+            'client_id'     => '8DXCMTshWSWECc',
+            'client_secret' => 'AESSECRETKEY',
+            'grant_type'    => 'client_credentials',
+            'redirect_uri'  => 'http://example.com/razorpay_callback',
+            'mode'          => 'test'
+        }
+        stub_post(/token$/,'fake_oauth_token',options)
+        oauth_token = Razorpay::OAuthToken.get_access_token(options)
+        assert_instance_of Razorpay::Entity, oauth_token, 'OAuthToken not an instance of Entity class'
+        assert_equal 'rzp_test_oauth_9xu1rkZqoXlClS', oauth_token.public_token, 'Public Tokens do not match'
+      end
+
+      def test_get_access_token_validation_failure
+        options = {
+          'client_id'     => '8DXCMTshWSWECc',
+          'grant_type'    => 'client_credentials',
+          'redirect_uri'  => 'http://example.com/razorpay_callback',
+          'mode'          => 'test'
+        }
+        assert_raises(Razorpay::Error) do
+          Razorpay::OAuthToken.get_access_token(options)
+        end
+      end
+
+      def test_refresh_token
+        options = {
+            'client_id'     => '8DXCMTshWSWECc',
+            'client_secret' => 'AESSECRETKEY',
+            'refresh_token' => 'def5020096e1c470c901d34cd60fa53abdaf3662sa0'
+        }
+        expected_request_payload = options.merge('grant_type': 'refresh_token')
+        stub_post(/token$/,'fake_oauth_token',expected_request_payload)
+        oauth_token = Razorpay::OAuthToken.refresh_token(options)
+        assert_instance_of Razorpay::Entity, oauth_token, 'OAuthToken not an instance of Entity class'
+        assert_equal 'rzp_test_oauth_9xu1rkZqoXlClS', oauth_token.public_token, 'Public Tokens do not match'
+      end
+
+      def test_refresh_token_validation_failure
+        options = {
+          'client_id'     => '8DXCMTshWSWECc',
+          'refresh_token' => 'def5020096e1c470c901d34cd60fa53abdaf3662sa0'
+        }
+        assert_raises(Razorpay::Error) do
+          Razorpay::OAuthToken.refresh_token(options)
+        end
+      end
+
+      def test_revoke_token
+        options = {
+            'client_id'     => '8DXCMTshWSWECc',
+            'client_secret' => 'AESSECRETKEY',
+            'token_type_hint' => 'access_token',
+            'token'           => 'eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJKQTFwODVudE1ySEpoQSIsImp0aSI6IkpPZkd0aHFDTmhqQUhTIiwiaWF0IjoxNjUxMTI0NTU0LCJuYmYiOjE2NTExMjQ1NTQsInN1YiI6IiIsImV4cCI6MTY1ODk4Njk1Miw'
+        }
+        stub_post(/revoke$/,'fake_revoke_token',options)
+        oauth_token = Razorpay::OAuthToken.revoke_token(options)
+        assert_instance_of Razorpay::Entity, oauth_token, 'OAuthToken not an instance of Entity class'
+        assert_equal 'Token Revoked', oauth_token.message, 'Messages do not match'
+      end
+
+      def test_revoke_token_validation_failure
+        options = {
+          'client_id'     => '8DXCMTshWSWECc',
+          'client_secret' => 'AESSECRETKEY',
+          'token_type_hint' => 'access_token'
+        }
+        assert_raises(Razorpay::Error) do
+          Razorpay::OAuthToken.revoke_token(options)
+        end
+      end
+  end
+end

data/test/razorpay/test_payload_validator.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+require 'razorpay/validation_config'
+
+module Razorpay
+  # Tests for Razorpay::PayloadValidator
+  class RazorpayPayloadValidatorTest < Minitest::Test
+    def test_validate_mode
+      payload = {
+        'mode1' => 'test',
+        'mode2' => 'live'
+      }
+      assert_silent do
+        Razorpay::PayloadValidator.validate(payload, [
+          Razorpay::ValidationConfig.new('mode1', [:mode]),
+          Razorpay::ValidationConfig.new('mode2', [:mode]),
+        ])
+      end
+    end
+
+    def test_mode_validation_failure
+      payload = {
+        'mode' => 'testvalue'
+      }
+      assert_raises(Razorpay::Error) do
+        Razorpay::PayloadValidator.validate(payload, [
+          Razorpay::ValidationConfig.new('mode', [:mode])
+        ])
+      end
+    end
+
+    def test_url_validation_failure
+      payload = {
+        'redirect_uri' => 'test.com'
+      }
+      assert_raises(Razorpay::Error) do
+        Razorpay::PayloadValidator.validate(payload, [
+          Razorpay::ValidationConfig.new('redirect_uri', [:url])
+        ])
+      end
+    end
+
+    def test_non_null_validation_failure
+      assert_raises(Razorpay::Error) do
+        Razorpay::PayloadValidator.validate({}, [
+          Razorpay::ValidationConfig.new('redirect_uri', [:non_null])
+        ])
+      end
+    end
+
+    def test_id_validation_failure
+      payload = {
+        'client_id' => 'fjidhf'
+      }
+      assert_raises(Razorpay::Error) do
+        Razorpay::PayloadValidator.validate({}, [
+          Razorpay::ValidationConfig.new('client_id', [:id])
+        ])
+      end
+    end
+  end
+end

data/test/razorpay/test_razorpay.rb

@@ -49,5 +49,22 @@ module Razorpay
                        headers: headers,
                        times: 1
     end
+
+    def test_oauth_setup
+      Razorpay.setup_with_oauth('access_token')
+      assert_equal 'access_token', Razorpay.access_token
+    end
+
+    # # We mock this request
+    def test_auth_header_and_user_agent_for_oauth
+      stub_get(/$/, 'hello_response')
+      Razorpay.setup_with_oauth('access_token')
+      Razorpay::Request.new('dummy').make_test_request
+      user_agent = "Razorpay-Ruby/#{Razorpay::VERSION}; Ruby/#{RUBY_VERSION}"
+      headers = { 'User-Agent' => user_agent, 'Authorization' => 'Bearer access_token' }
+      assert_requested :get, 'https://api.razorpay.com/',
+                       headers: headers,
+                       times: 1
+    end
   end
 end

data/test/razorpay/test_utility.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'json'
 
 module Razorpay
   # Tests for Razorpay::Utility
@@ -80,5 +81,38 @@ module Razorpay
         Razorpay::Utility.verify_webhook_signature(webhook_body, signature, secret)
       end
     end
+
+    def test_generate_onboarding_signature
+      secret = "EnLs21M47BllR3X8PSFtjtbd"
+      timestamp = Time.now.to_i
+      body = {
+        submerchant_id: 'NSgKfYIR2f9v2y',
+        timestamp: timestamp
+      }
+      encryptedData = Razorpay::Utility.generate_onboarding_signature(body, secret)
+      json_data = decrypt(encryptedData, secret)
+      body = JSON.parse(json_data)
+      assert_equal 'NSgKfYIR2f9v2y', body['submerchant_id'], 'Submerchant IDs do not match'
+      assert_equal timestamp, body['timestamp'], 'Timestamps do not match'
+    end
+
+    def decrypt(data, secret)
+      combined_encrypted_data = [data].pack("H*")
+
+      iv = secret[0, 12]
+      key = secret[0, 16]
+      tag = combined_encrypted_data[-16..]
+
+      encrypted_data = combined_encrypted_data[0...-16]
+
+      cipher = OpenSSL::Cipher.new('aes-128-gcm')
+      cipher.decrypt
+      cipher.key = key
+      cipher.iv = iv
+      cipher.auth_tag = tag
+      cipher.auth_data = ""
+
+      cipher.update(encrypted_data) + cipher.final
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: razorpay
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.2
 platform: ruby
 authors:
 - Abhay Rana
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -137,8 +137,8 @@ files:
 - documents/customer.md
 - documents/emandate.md
 - documents/fund.md
-- documents/generic.md
 - documents/items.md
+- documents/oauth_token.md
 - documents/order.md
 - documents/papernach.md
 - documents/payment.md
@@ -174,11 +174,12 @@ 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
+- lib/razorpay/oauth_token.rb
 - lib/razorpay/order.rb
+- lib/razorpay/payload_validator.rb
 - lib/razorpay/payment.rb
 - lib/razorpay/payment_link.rb
 - lib/razorpay/payment_method.rb
@@ -194,6 +195,7 @@ files:
 - lib/razorpay/token.rb
 - lib/razorpay/transfer.rb
 - lib/razorpay/utility.rb
+- lib/razorpay/validation_config.rb
 - lib/razorpay/virtual_account.rb
 - lib/razorpay/webhook.rb
 - razorpay-ruby.gemspec
@@ -221,6 +223,7 @@ files:
 - test/fixtures/fake_instant_settlement.json
 - test/fixtures/fake_invoice.json
 - test/fixtures/fake_item.json
+- test/fixtures/fake_oauth_token.json
 - test/fixtures/fake_order.json
 - test/fixtures/fake_order_transfers.json
 - test/fixtures/fake_otp_generate.json
@@ -238,6 +241,7 @@ files:
 - test/fixtures/fake_recurring.json
 - test/fixtures/fake_refund.json
 - test/fixtures/fake_refunded_payment.json
+- test/fixtures/fake_revoke_token.json
 - test/fixtures/fake_settlement.json
 - test/fixtures/fake_settlement_on_demand.json
 - test/fixtures/fake_stakeholder.json
@@ -295,11 +299,12 @@ 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
+- test/razorpay/test_oauth_token.rb
 - test/razorpay/test_order.rb
+- test/razorpay/test_payload_validator.rb
 - test/razorpay/test_payment.rb
 - test/razorpay/test_payment_link.rb
 - test/razorpay/test_plan.rb
@@ -366,6 +371,7 @@ test_files:
 - test/fixtures/fake_instant_settlement.json
 - test/fixtures/fake_invoice.json
 - test/fixtures/fake_item.json
+- test/fixtures/fake_oauth_token.json
 - test/fixtures/fake_order.json
 - test/fixtures/fake_order_transfers.json
 - test/fixtures/fake_otp_generate.json
@@ -383,6 +389,7 @@ test_files:
 - test/fixtures/fake_recurring.json
 - test/fixtures/fake_refund.json
 - test/fixtures/fake_refunded_payment.json
+- test/fixtures/fake_revoke_token.json
 - test/fixtures/fake_settlement.json
 - test/fixtures/fake_settlement_on_demand.json
 - test/fixtures/fake_stakeholder.json
@@ -440,11 +447,12 @@ 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
+- test/razorpay/test_oauth_token.rb
 - test/razorpay/test_order.rb
+- test/razorpay/test_payload_validator.rb
 - test/razorpay/test_payment.rb
 - test/razorpay/test_payment_link.rb
 - test/razorpay/test_plan.rb

data/documents/generic.md

@@ -1,150 +0,0 @@
-## 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/generic.rb

@@ -1,39 +0,0 @@
-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/test/razorpay/test_generic.rb

@@ -1,112 +0,0 @@
-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