razorpay 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cd8a703b64189d31348ac44fccf9edef384ff5af
-  data.tar.gz: f007b3cd479849931bda5fc5f59d584f4a15e18b
+SHA256:
+  metadata.gz: 16358451a0774ffe1eee29516c7a196315c9b224169fb28aa0faa07664041e14
+  data.tar.gz: 841f735f70da6e8b54b8d0370005ddbdad26ee393960133eb08505869dd04d6f
 SHA512:
-  metadata.gz: 6d0c677d255482d7378c2eecf523d3ee8ae9d106af592885613d6c08a4a2b5be24c39c9c1c8dba270029336e1a1a56dc385358b48e90ff3e80adf638dedcf266
-  data.tar.gz: 942c7c1247d66d697b4f597125d5c2c145112e0ea62f1fa14c4fe5835c03607a13fdcce26c36185a4ccd0fd08cd08fbaeb260a4751e2983c105c7a9d0229a22c
+  metadata.gz: ffd3b0c1f38c5debb4a6b8a15fdfa00df1ca7b5f3f7d72b1d64227681923ec7307ae39d0e060346660c3270e143bbf7ac88185e664331390a52e7103a53a868e
+  data.tar.gz: e6048a8c9abfb4169d1f5e69203d9abb5824c13b8655a85cc53648497cfb38103887073562f3188297b8437fd6a823219456cfd72db67876e50f8409e06888ea

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/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: ['2.6', '2.7', '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/.rubocop.yml

@@ -9,9 +9,6 @@ Metrics/LineLength:
 Style/SymbolArray:
   MinSize: 3
 
-Style/ClassVars:
-  Enabled: false
-
 Metrics/MethodLength:
   Max: 15
 
@@ -19,3 +16,7 @@ Naming/UncommunicativeMethodParamName:
   MinNameLength: 1
   AllowNamesEndingInNumbers: false
 
+# Near-duplicate of a file from an external package, want to keep changes minimal
+AllCops:
+  Exclude:
+    - 'lib/extensions/httparty/hash_conversions.rb'

data/CHANGELOG.md

@@ -4,32 +4,85 @@ Changelog for Razorpay-Ruby SDK.
 
 ## Unreleased
 
+## [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
+
+- Indexed keys used in x-www-form-urlencoded request bodies [[#68][68]]
+- Updated Utility verify\_\* methods to return verification bool [[#72][72]]
+
+### Added
+
+- Support for custom JSON options to Entity to_json [[#75][75]]
+
 ## [2.3.0] - 2018-04-20
+
 ### Added
+
 - Support for subscription signature verification
 - Bang! methods (`capture!`, `refund!`) that update the calling entity
 
 ## [2.2.0] - 2018-01-29
+
 ### Added
+
 - Support for Subscriptions
 
 ## [2.1.0] - 2017-11-17
+
 ### Changed
+
 - Generic `Razorpay::Error` is thrown when server is unreachable
 
 ### Added
+
 - Support for making raw requests to the API via `raw_request`.
 
 ## [2.1.0.pre] - 2017-08-17
+
 ### Added
+
 - Support for Virtual Accounts
 
 ## [2.0.1] - 2017-07-31
+
 ### Fixed
+
 - Webhook signature verification
 
 ## [2.0.0] - 2017-03-02
+
 ### Added
+
 - Adds `require` for all Razorpay supported entities
 - All entity objects now throw `NoMethodError` instead of `NameError` if the attribute doesn't exist
 - Adds customer edit API
@@ -42,43 +95,66 @@ Changelog for Razorpay-Ruby SDK.
 - Adds rake test groups
 
 ## [1.2.1] - 2016-12-22
+
 ### Changed
+
 - Drops ArgumentError checks for local validation. Rely on server side checks instead.
 
 ### Added
+
 - Support for customers and invoices API
 - Loads Order class by default.
 
 ## [1.2.0] - 2016-11-23
+
 ### Added
+
 - Fixed payment.method as an attribute accessor
 
 ## [1.1.0] - 2016-02-25
+
 ### Added
+
 - Add support for Orders API
 - Bundles the CA Certificate with the gem. See #6
 
 ## [1.0.3] - 2015-03-31
+
 ### Changed
+
 - Handles error requests properly
 
 ## [1.0.1] - 2015-02-23
+
 ### Added
+
 - Added support for ruby versions below 2.0
 
 ## [1.0.0] - 2015-01-17
+
 ### Added
+
 - Initial Release
 
-[Unreleased]: https://github.com/razorpay/razorpay-ruby/compare/2.3.0...HEAD
-[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
-[2.1.0]: https://github.com/razorpay/razorpay-ruby/compare/2.0.1...2.1.0
-[2.1.0.pre]: https://github.com/razorpay/razorpay-ruby/compare/2.0.1...2.1.0.pre
-[2.0.1]: https://github.com/razorpay/razorpay-ruby/compare/2.0.0...2.0.1
-[2.0.0]: https://github.com/razorpay/razorpay-ruby/compare/1.2.1...2.0.0
-[1.2.1]: https://github.com/razorpay/razorpay-ruby/compare/1.2.0...1.2.1
-[1.2.0]: https://github.com/razorpay/razorpay-ruby/compare/1.1.0...1.2.0
-[1.1.0]: https://github.com/razorpay/razorpay-ruby/compare/1.0.3...1.1.0
-[1.0.3]: https://github.com/razorpay/razorpay-ruby/compare/1.0.1...1.0.3
-[1.0.1]: https://github.com/razorpay/razorpay-ruby/compare/1.0.0...1.0.1
+# Diff
+
+- [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)
+- [2.1.0](https://github.com/razorpay/razorpay-ruby/compare/2.0.1...2.1.0)
+- [2.1.0.pre](https://github.com/razorpay/razorpay-ruby/compare/2.0.1...2.1.0.pre)
+- [2.0.1](https://github.com/razorpay/razorpay-ruby/compare/2.0.0...2.0.1)
+- [2.0.0](https://github.com/razorpay/razorpay-ruby/compare/1.2.1...2.0.0)
+- [1.2.1](https://github.com/razorpay/razorpay-ruby/compare/1.2.0...1.2.1)
+- [1.2.0](https://github.com/razorpay/razorpay-ruby/compare/1.1.0...1.2.0)
+- [1.1.0](https://github.com/razorpay/razorpay-ruby/compare/1.0.3...1.1.0)
+- [1.0.3](https://github.com/razorpay/razorpay-ruby/compare/1.0.1...1.0.3)
+- [1.0.1](https://github.com/razorpay/razorpay-ruby/compare/1.0.0...1.0.1)
+
+[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/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Razorpay
+Copyright (c) 2019 Razorpay
 
 MIT License
 

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.0-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,9 +20,12 @@ 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 key and secret using the following:
 
@@ -39,131 +42,30 @@ 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:
-```rb
-refund = Razorpay::Refund.create(payment_id:"payment_id")
-Razorpay::Refund.fetch(refund.id)
-```
-
-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
-```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
-```
-
-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
-
-# Fetching an addon
-addon = Razorpay::Addon.fetch subscription_addon.id
-```
-
-You can find addon API documentation at <https://razorpay.com/docs/subscriptions/api/#add-on>.
-
+## Supported Resources
+- [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)
+- [Smart Collect](documents/virtualAccount.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)
 ## Development
 
 - Everything is namespaced under the Razorpay module
@@ -183,19 +85,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.2.9
-* 2.3.6
-* 2.4.2
-* 2.5.0
-
 ## Release
 
 Steps to follow for a release: