razorpay 2.4.0 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39cc293b9e35da57fbe365e94ee9d46d9c21d7843d8e08f40382d9683d5dac8a
-  data.tar.gz: '086f7b483c58b0841a5b4a7cc677f4d4cc083536b0999f5abff1986287be0fe3'
+  metadata.gz: 20c9fe5dd27329aceee373510059552808b2ed481fb59da923f2dca95d857156
+  data.tar.gz: d58229258c2df81882fea1bdb99a136e34f458f3170f0df4ab2b5f7123a827a5
 SHA512:
-  metadata.gz: af4c5ba0f617c776ac5b4ad191062e9530eb1c70443bc1e030873f90edb8b6072a90e66d50e7b55da8d1cbf30f6f590cb94f51c67b6cb9383584cd1f44182aaa
-  data.tar.gz: 1ddbe5914250c4dd745da91780ad0ac9e35f13fee040490a4b49cd43f5a72a5882aeaec3af6b311220c3537af41b36e5348428dc746f0f8fe3a1f24cbcc45fe2
+  metadata.gz: fd7ecba7866f08006fc27b7d5a4b5cb4d9ccf7f5fdf39ca833e60988b46b0fded9afdea31bc7679b256a150fac525eeb2ca77985043143073d52471490919f67
+  data.tar.gz: 1d5747bf39b762bdbfd010fd212d07a78ab94c5cd712a121f8b6592e5850aa1bd8a0913ad8d26bce50f390631b94376088af78163574578f3b2e62a1e15f983d

data/.cursorignore

@@ -0,0 +1,174 @@
+# Distribution and Environment
+dist/*
+build/*
+venv/*
+env/*
+*.env
+.env.*
+virtualenv/*
+.python-version
+.ruby-version
+.node-version
+
+# Logs and Temporary Files
+*.log
+*.tsv
+*.csv
+*.txt
+tmp/*
+temp/*
+.tmp/*
+*.temp
+*.cache
+.cache/*
+logs/*
+
+# Sensitive Data
+*.sqlite
+*.sqlite3
+*.dbsql
+secrets.*
+.npmrc
+.yarnrc
+.aws/*
+.config/*
+
+# Credentials and Keys
+*.pem
+*.ppk
+*.key
+*.pub
+*.p12
+*.pfx
+*.htpasswd
+*.keystore
+*.jks
+*.truststore
+*.cer
+id_rsa*
+known_hosts
+authorized_keys
+.ssh/*
+.gnupg/*
+.pgpass
+
+# Config Files
+*.conf
+*.toml
+*.ini
+.env.local
+.env.development
+.env.test
+.env.production
+config/*
+
+# Database Files
+*.sql
+*.db
+*.dmp
+*.dump
+*.backup
+*.restore
+*.mdb
+*.accdb
+*.realm*
+
+# Backup and Archive Files
+*.bak
+*.backup
+*.swp
+*.swo
+*.swn
+*~
+*.old
+*.orig
+*.archive
+*.gz
+*.zip
+*.tar
+*.rar
+*.7z
+
+# Compiled and Binary Files
+*.pyc
+*.pyo
+**/__pycache__/**
+*.class
+*.jar
+*.war
+*.ear
+*.dll
+*.exe
+*.so
+*.dylib
+*.bin
+*.obj
+
+# IDE and Editor Files
+.idea/*
+*.iml
+.vscode/*
+.project
+.classpath
+.settings/*
+*.sublime-*
+.atom/*
+.eclipse/*
+*.code-workspace
+.history/*
+
+# Build and Dependency Directories
+node_modules/*
+bower_components/*
+vendor/*
+packages/*
+jspm_packages/*
+.gradle/*
+target/*
+out/*
+
+# Testing and Coverage Files
+coverage/*
+.coverage
+htmlcov/*
+.pytest_cache/*
+.tox/*
+junit.xml
+test-results/*
+
+# Mobile Development
+*.apk
+*.aab
+*.ipa
+*.xcarchive
+*.provisionprofile
+google-services.json
+GoogleService-Info.plist
+
+# Certificate and Security Files
+*.crt
+*.csr
+*.ovpn
+*.p7b
+*.p7s
+*.pfx
+*.spc
+*.stl
+*.pem.crt
+ssl/*
+
+# Container and Infrastructure
+*.tfstate
+*.tfstate.backup
+.terraform/*
+.vagrant/*
+docker-compose.override.yml
+kubernetes/*
+
+# Design and Media Files (often large and binary)
+*.psd
+*.ai
+*.sketch
+*.fig
+*.xd
+assets/raw/*

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+    timezone: Asia/Calcutta

data/.github/pull_request_template.md

@@ -0,0 +1,8 @@
+## Note :- Please follow the below points while attaching test cases document link below:
+   ### - If label `Tested` is added then test cases document URL is mandatory.
+   ### - Link added should be a valid URL and accessible throughout the org.
+   ### - If the branch name contains hotfix / revert by default the BVT workflow check will pass.
+
+| Test Case Document URL                        |
+|-----------------------------------------------|
+| Please paste test case document link here.... |

data/.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+      - fix/upgrade-github-actions-v4
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+*
+  pull_request:
+    branches:
+      - master
+jobs:
+ build:
+  name: Build
+  runs-on: ubuntu-latest
+
+  steps:
+  - uses: actions/checkout@v4
+  - name: Set up Ruby
+    uses: ruby/setup-ruby@v1
+    with:
+      ruby-version:  3.1
+  - name: Install dependencies
+    run: bundle install
+  - name: Build
+    run: gem build *.gemspec
+  - name: 'Upload Artifact'
+    uses: actions/upload-artifact@v4
+    with:
+      name: gems
+      path: '*.gem'
+ test:
+  runs-on: ubuntu-latest
+  needs: build
+  strategy:
+   matrix:
+    ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+  steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Set up Ruby latest
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests and collect coverage
+      run: bundle exec rake
+    - name: Upload coverage to Codecov
+      if: ${{ matrix.ruby-version == 3.1 }}
+      uses: codecov/codecov-action@v4
+      with:
+        files: ${{ github.workspace }}/coverage/coverage.xml
+ publish:      
+    name: Publish
+    # if: startsWith(github.ref, 'refs/tags/v')
+    needs: [build, test]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - run: sudo apt-get install -y oathtool
+    - name: Download all workflow run artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: gems
+        path: gems
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version:  3.1
+    - name: Publish gems to Rubygems
+      run: |
+       mkdir -p $HOME/.gem
+       touch $HOME/.gem/credentials
+       chmod 0600 $HOME/.gem/credentials
+       printf -- "---\n:rubygems_api_key: ${GEM_API_KEY}\n" > $HOME/.gem/credentials
+       gem push gems/*.gem
+      env:
+        GEM_API_KEY: ${{secrets.GEM_API_KEY}}

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -4,6 +4,87 @@ Changelog for Razorpay-Ruby SDK.
 
 ## Unreleased
 
+## [3.2.4] - 2026-06-08
+
+fix: Security fix for AES-GCM onboarding signature
+* Fixed nonce reuse vulnerability in `generate_onboarding_signature` by using a random nonce per call instead of a static IV derived from the secret key
+* New output format: `hex(iv[12] || ciphertext || tag[16])` — the receiver reads the first 24 hex chars as the IV before decrypting
+
+## [3.2.3] - 2024-05-27
+
+feat: Added new API endpoints
+* Added support for `add_bank_account`, `delete_bank_account`, `request_eligibility_check` & `fetch_eligibility` on customer
+* Added support for `expand_details` on payment
+* Added support for fetch Reversals for a Transfer
+* Added support for Dispute
+* Added support for Document
+* Added support for `view_rto` & `edit_fulfillment` on order
+
+## [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
+
+## [3.1.0] - 2023-10-13
+
+### Added
+
+feat: Added new API endpoints
+
+Added account onboarding API create, fetch, edit, delete
+Added stakeholders API create, fetch, all, edit
+Added product configuration API request_product_configuration, fetch, edit, fetch_tnc
+Added webhooks API create, fetch, all, edit, delete
+Added Documents API upload_account_doc, fetch_account_doc, upload_stakeholder_doc, fetch_stakeholder_doc
+Added token sharing API create, fetch, delete, process_payment_on_alternate_pa_or_pg
+
+## [3.0.1] - 2022-07-11
+
+### Added
+
+- Added Third party validation API for Payments (create_upi, validate_vpa)
+- New API for Payment Methods
+- Doc Updated
+
+## [3.0.0] - 2022-06-03
+
+### Added
+
+- QR code end point API
+- Settlement end point API
+- Fund Account end point API
+- PaymentLinks end point API
+- Item end point API
+- New APIs for Invoices (Delete, Send/resend)
+- New API for Customers (Fetch Tokens, Delete Token)
+- New APIs for Subscriptions (Update, Pause, Resume, Pending update, Delete offer)
+- New API for Addons (Fetch all Addons)
+- New API for Refund (Update refund)
+- New APIs for Payments (Update, Create recurring, Create Json, Payment downtime details, refunds of a payment, Otp generate, Otp submit, Otp resend)
+- New APIs for Virtual Account (Add receiver, add an allowed payer account, delete an allowed payer account)
+- Updated Testcases
+- Updated Readme
+
+## [2.4.1] - 2019-04-09
+
+### Fixed
+
+- Subscription signature verification [[#81][81]]
+
+### Added
+
+- Ruby version to user agent header [[#79][79]]
+
 ## [2.4.0] - 2019-04-08
 
 ### Changed
@@ -109,7 +190,8 @@ Changelog for Razorpay-Ruby SDK.
 
 # Diff
 
-- [Unreleased](https://github.com/razorpay/razorpay-ruby/compare/2.4.0...HEAD)
+- [Unreleased](https://github.com/razorpay/razorpay-ruby/compare/2.4.1...HEAD)
+- [2.4.1](https://github.com/razorpay/razorpay-ruby/compare/2.4.0...2.4.1)
 - [2.4.0](https://github.com/razorpay/razorpay-ruby/compare/2.3.0...2.4.0)
 - [2.3.0](https://github.com/razorpay/razorpay-ruby/compare/2.2.0...2.3.0)
 - [2.2.0](https://github.com/razorpay/razorpay-ruby/compare/2.1.0...2.2.0)
@@ -126,3 +208,5 @@ Changelog for Razorpay-Ruby SDK.
 [68]: https://github.com/razorpay/razorpay-ruby/pull/68
 [72]: https://github.com/razorpay/razorpay-ruby/pull/72
 [75]: https://github.com/razorpay/razorpay-ruby/pull/75
+[79]: https://github.com/razorpay/razorpay-ruby/pull/79
+[81]: https://github.com/razorpay/razorpay-ruby/pull/81

data/README.md

@@ -1,6 +1,6 @@
 # Razorpay Ruby bindings
 
-[![Build Status](https://travis-ci.org/razorpay/razorpay-ruby.svg?branch=master)](https://travis-ci.org/razorpay/razorpay-ruby) [![Gem Version](https://badge.fury.io/rb/razorpay.svg)](http://badge.fury.io/rb/razorpay) [![Coverage Status](https://coveralls.io/repos/github/Razorpay/razorpay-ruby/badge.svg?branch=master)](https://coveralls.io/github/Razorpay/razorpay-ruby?branch=master) [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
+[![Build Status](https://travis-ci.org/razorpay/razorpay-ruby.svg?branch=master)](https://travis-ci.org/razorpay/razorpay-ruby) [![Gem Version](https://img.shields.io/badge/gem%20version-v3.0.1-dark%20green.svg)](http://badge.fury.io/rb/razorpay) [![Coverage Status](https://coveralls.io/repos/github/Razorpay/razorpay-ruby/badge.svg?branch=master)](https://coveralls.io/github/Razorpay/razorpay-ruby?branch=master) [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
 
 This is the base ruby gem for interacting with the Razorpay API. This is primarily meant for users who wish to perform interactions with the Razorpay API programatically.
 
@@ -20,11 +20,18 @@ Or install it yourself as:
 
     $ gem install razorpay
 
+## Requirements
+
+Ruby 2.6.8 or later
 ## Usage
 
-Remember to `require razorpay` before anything else.
+Remember to `require 'razorpay'` before anything else.
+
+Next, you need to setup your auth details. This setup can be done via two ways:
 
-Next, you need to setup your key and secret using the following:
+### Using Private Auth
+
+you need to setup your key and secret using the following:
 
 ```rb
 Razorpay.setup('key_id', 'key_secret')
@@ -35,134 +42,51 @@ You can set customer headers for your requests using the following:
 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`.
-
-The most common construct is capturing a payment, which you do via the following:
-
-```rb
-Razorpay::Payment.fetch("payment_id").capture({amount:500})
-# Note that the amount should come from your session, so as to verify
-# that the purchase was correctly done and not tampered
-```
-
-You can refund a payment via the following:
-
-```rb
-Razorpay::Payment.fetch("payment_id").refund({amount:500})
-refunds = Razorpay::Payment.fetch("payment_id").refunds
-```
-
-A payment can also be refunded without fetching it:
+### Using Access Token
+you need to setup your access token using the following
 ```rb
-refund = Razorpay::Refund.create(payment_id:"payment_id")
-Razorpay::Refund.fetch(refund.id)
+Razorpay.setup_with_oauth('access_token')
 ```
-
-If payment is captured or refunded via `capture!` or `refund!`, then the calling object is also updated:
-```rb
-payment = Razorpay::Payment.fetch('payment_id')
-payment.status
-# 'authorized'
-payment.capture!
-payment.status
-# 'captured'
-payment.refund!
-payment.status
-# 'refunded'
-```
-
-For other applications (such as fetching payments and refunds),
-see our online documentation on <https://docs.razorpay.com>
-
-### Orders API
-
-You can use the orders API using the following constructs:
-
-You can find docs at <https://docs.razorpay.com/v1/page/orders>
-
-```rb
-order = Razorpay::Order.create amount: 5000, currency: 'INR', receipt: 'TEST'
-# order.id = order_50sX9hGHZJvjjI
-
-# Same collection as Refunds or Payments
-orders = Razorpay::Order.all
-
-# Fetching an Order
-order = Razorpay::Order.fetch('order_50sX9hGHZJvjjI')
-puts order.amount
-
-# Fetching payments corresponding to an order
-payments = order.payments
-```
-
-### Verification
-You can use the Utility class to verify the signature received in response to a payment made using Orders API
-```rb
-puts payment_response
-# {
-#   :razorpay_order_id   => "fake_order_id",
-#   :razorpay_payment_id => "fake_payment_id",
-#   :razorpay_signature  => "signature"
-# }
-Razorpay::Utility.verify_payment_signature(payment_response)
-```
-You can also [verify the signature](https://github.com/razorpay/razorpay-ruby/wiki/Webhooks) received in a webhook:
-```rb
-Razorpay::Utility.verify_webhook_signature(webhook_body, webhook_signature, webhook_secret)
-```
-
-### Customers
-```rb
-# Create a customer
-customer = Razorpay::Customer.create email: 'test@razorpay.com', contact: '9876543210'
-puts customer.id #cust_6vRXClWqnLhV14
-```
-
-### Cards
-```rb
-# Fetch a card
-card = Razorpay::Card.fetch('card_7EZLhWkDt05n7V')
-puts card.network #VISA
-```
-
-You can find cards API documentation at <https://docs.razorpay.com/v1/page/cards>.
-
-### Invoices
-```rb
-# Creating an invoice
-invoice = Razorpay::Invoice.create customer_id: customer.id, amount: 100, currency: 'INR', description: 'Test description', type: 'link'
-```
-
-You can find invoices API documentation at <https://docs.razorpay.com/v1/page/invoices>.
-
-### Plan
-```rb
-# Creating a plan
-plan = Razorpay::Plan.create interval: 1, period: 'monthly', item: { name: 'fake_plan', description: 'fake_desc', currency: 'INR', amount: 500 }, notes: { identifier: 'plan_monthly_super' }
-```
-
-You can find plan API documentation at <https://razorpay.com/docs/subscriptions/api/#plan>.
-
-### Subscription
+You can set customer headers for your requests using the following:
 ```rb
-# Creating a subscription and starting after 24 hours (24 hours = 60 * 60 * 24)
-subscription = Razorpay::Subscription.create plan_id: plan.id, customer_id: customer.id, start_at: (Time.now + (60 * 60 * 24)).to_i, total_count: 3
+Razorpay.headers = {"CUSTOM_APP_HEADER" => "CUSTOM_VALUE"}
 ```
 
-You can find subscription API documentation at <https://razorpay.com/docs/subscriptions/api/#subscription>.
-
-### Addon
-```rb
-# Creating an addon
-subscription_addon = Razorpay::Addon.create subscription.id, item: { name: 'fake_plan', description: 'fake_desc', currency: 'INR', amount: 500 }, quantity: 1
+You can find your API keys at <https://dashboard.razorpay.com/#/app/keys>.
 
-# Fetching an addon
-addon = Razorpay::Addon.fetch subscription_addon.id
-```
+If you are using rails, the right place to do this might be `config/initializers/razorpay.rb`.
 
-You can find addon API documentation at <https://razorpay.com/docs/subscriptions/api/#add-on>.
+## Supported Resources
+- [Account](documents/account.md)
+- [Customer](documents/customer.md)
+- [Token](documents/tokens.md)
+- [Order](documents/order.md)
+- [Payments](documents/payment.md)
+- [Settlements](documents/settlement.md)
+- [Fund](documents/fund.md)
+- [Refunds](documents/refund.md)
+- [Invoice](documents/Invoice.md)
+- [Plan](documents/plan.md)
+- [Item](documents/items.md)
+- [Subscriptions](documents/subscriptions.md)
+- [Add-on](documents/addon.md)
+- [Payment Links](documents/paymentLink.md)
+- [Product Configuration](documents/productConfiguration.md)
+- [Smart Collect](documents/virtualAccount.md)
+- [Stakeholder](documents/stakeholder.md)
+- [Transfer](documents/transfers.md)
+- [QR Code](documents/qrcode.md)
+- [Emandate](documents/emandate.md)
+- [Cards](documents/card.md)
+- [Paper NACH](documents/papernach.md)
+- [UPI](documents/upi.md)
+- [Register Emandate and Charge First Payment Together](documents/registerEmandate.md)
+- [Register NACH and Charge First Payment Together](documents/registerNach.md)
+- [Payment Verification](documents/paymentVerification.md)
+- [Webhook](documents/webhook.md)
+- [OAuthToken](documents/oauth_token.md)
+- [Dispute](documents/dispute.md)
+- [Document](documents/documents.md)
 
 ## Development
 
@@ -183,19 +107,6 @@ You can find addon API documentation at <https://razorpay.com/docs/subscriptions
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
 
-## Supported Versions
-
-While we support [all currently supported versions of Ruby](https://www.ruby-lang.org/en/downloads/branches/)
-only, the code is tested against the following versions:
-
-* 1.9.3
-* 2.0.0
-* 2.1.10
-* 2.3.8
-* 2.4.6
-* 2.5.5
-* 2.6.2
-
 ## Release
 
 Steps to follow for a release: