razorpay 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e44bdd7fd838ec1ac184e39eafccd535f4789083
-  data.tar.gz: f38d503263f55d2e493e9ce046ce671621f2f69f
+  metadata.gz: 9694a52cd9fc7e6968d50450c8cd6baedcb13031
+  data.tar.gz: c8b1e34dc5549b3d5a3bde42447a4bac74271326
 SHA512:
-  metadata.gz: 4b581f65deb6964ebe58bb6a244f72f14f22c56392983cbaf02f307e6793d2b2ac9d57757756d256388d130b19262cc46e7df85fd2b768bbc6e139aafe519937
-  data.tar.gz: '078dfff04cd5ed1a6c6c9c2be451d8056dfbb5821f0b12fc816750451d0cbe8aba1b877ba4e1d6e03c13f8a8d5e8cd1bd5f061de72849286b9941923243d8af8'
+  metadata.gz: 655d3f40379bd8f58ce447fd3d96f6c2420909abf627d6775977a56d8809fd87dfaf4a66a0a341e23f7efe07d971ce146930d919f498d907fa37a9d64fcdef6d
+  data.tar.gz: 528df3860b6623d9215b097b5e4b82192ee444c980c5db7d13b618d77beafd8bb0ce1bd5ed46cbce1360a34bd591e0a7b225d376244c0eae9968d402adb42bfb

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+vendor

data/.travis.yml

@@ -1,10 +1,26 @@
 language: ruby
-rvm:
-  - "2.1.10"
-  - "2.2.6"
-  - "2.3.3"
-  - "2.4.0"
+# List is from https://www.ruby-lang.org/en/downloads/branches/
+# Merged with whatever is the top of each branch at https://www.ruby-lang.org/en/downloads/releases/
+matrix:
+  include:
+    - rvm: "1.9.3"
+    - rvm: "2.0.0"
+    - rvm: "2.1.10"
+    - rvm: "2.2.9"
+    - rvm: "2.3.6"
+    - rvm: "2.4.2"
+    - rvm: "2.5.0"
+    - rvm: "2.5.0"
+      env: LINT=rubocop
+  allow_failures:
+  # These are EOL versions of ruby
+    - rvm: "1.9.3"
+    - rvm: "2.0.0"
+    - rvm: "2.1.10"
 before_install: gem update --system
 script:
   - bundle exec rake test
-  - bundle exec rake rubocop
+  - |
+    if [[ "$LINT" == "rubocop" ]] ; then
+      bundle exec rake rubocop
+    fi

data/CHANGELOG.md

@@ -4,6 +4,10 @@ Changelog for Razorpay-Ruby SDK.
 
 ## Unreleased
 
+## [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
@@ -61,7 +65,8 @@ Changelog for Razorpay-Ruby SDK.
 ### Added
 - Initial Release
 
-[Unreleased]: https://github.com/razorpay/razorpay-ruby/compare/2.1.0...HEAD
+[Unreleased]: https://github.com/razorpay/razorpay-ruby/compare/2.2.0...HEAD
+[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

data/README.md

@@ -124,6 +124,33 @@ invoice = Razorpay::Invoice.create customer_id: customer.id, amount: 100, curren
 
 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>.
+
 ## Development
 
 - Everything is namespaced under the Razorpay module
@@ -143,6 +170,19 @@ You can find invoices API documentation at <https://docs.razorpay.com/v1/page/in
 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:

data/Rakefile

@@ -1,5 +1,7 @@
 require 'rake/testtask'
-require 'rubocop/rake_task'
+
+# Don't try to run rubocop in 1.9.3
+require 'rubocop/rake_task' if RUBY_VERSION >= '2.1.0'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
@@ -8,7 +10,7 @@ Rake::TestTask.new do |t|
 end
 
 desc 'Run tests'
-task default: [:test, :rubocop]
+task default: [:test]
 
 desc 'Run rubocop'
 task :rubocop do

data/lib/razorpay.rb

@@ -9,6 +9,9 @@ require 'razorpay/customer'
 require 'razorpay/constants'
 require 'razorpay/collection'
 require 'razorpay/virtual_account'
+require 'razorpay/plan'
+require 'razorpay/subscription'
+require 'razorpay/addon'
 
 # Base Razorpay module
 module Razorpay

data/lib/razorpay/addon.rb

@@ -0,0 +1,24 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Addon API allows you to fetch and delete
+  # subscription-addons with Razorpay
+  class Addon < Entity
+    def self.request
+      Razorpay::Request.new('addons')
+    end
+
+    def self.fetch(id)
+      request.fetch id
+    end
+
+    def self.create(subscription_id, options)
+      r = request
+      # POST /addons is not supported
+      # Addon creation endpoint is:
+      # POST subscriptions/{sub_id}/addons
+      r.request :post, "/subscriptions/#{subscription_id}/addons", options
+    end
+  end
+end

data/lib/razorpay/constants.rb

@@ -2,5 +2,5 @@
 module Razorpay
   BASE_URI = 'https://api.razorpay.com/v1/'.freeze
   TEST_URL = 'https://api.razorpay.com/'.freeze
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/lib/razorpay/invoice.rb

@@ -20,5 +20,29 @@ module Razorpay
     def self.all(options = {})
       request.all options
     end
+
+    def self.edit(id, options = {})
+      request.patch id, options
+    end
+
+    def self.issue(id)
+      request.post "#{id}/issue"
+    end
+
+    def self.cancel(id)
+      request.post "#{id}/cancel"
+    end
+
+    def edit(options = {})
+      self.class.edit id, options
+    end
+
+    def issue
+      self.class.issue id
+    end
+
+    def cancel
+      self.class.cancel id
+    end
   end
 end

data/lib/razorpay/plan.rb

@@ -0,0 +1,24 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Plan API allows you to create and
+  # manage subscription-plans with Razorpay
+  class Plan < Entity
+    def self.request
+      Razorpay::Request.new('plans')
+    end
+
+    def self.create(options)
+      request.create options
+    end
+
+    def self.fetch(id)
+      request.fetch id
+    end
+
+    def self.all(options = {})
+      request.all options
+    end
+  end
+end

data/lib/razorpay/request.rb

@@ -80,9 +80,7 @@ module Razorpay
       response = res.parsed_response
 
       # if there was an error, throw it
-      if response.nil? || response.key?('error')
-        raise_error(response['error'], res.code)
-      end
+      raise_error(response['error'], res.code) if response.nil? || response.key?('error')
 
       # There must be a top level entity
       # This is either one of payment, refund, or collection at present

data/lib/razorpay/subscription.rb

@@ -0,0 +1,32 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Subscription API allows you to create and
+  # manage subscriptions with Razorpay
+  class Subscription < Entity
+    def self.request
+      Razorpay::Request.new('subscriptions')
+    end
+
+    def self.create(options)
+      request.create options
+    end
+
+    def self.fetch(id)
+      request.fetch id
+    end
+
+    def self.all(options = {})
+      request.all options
+    end
+
+    def self.cancel(id, options = {})
+      request.post "#{id}/cancel", options
+    end
+
+    def cancel(options = {})
+      self.class.cancel id, options
+    end
+  end
+end

data/razorpay-ruby.gemspec

@@ -17,10 +17,20 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'httparty', '~> 0.14'
+
   spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'minitest', '~> 5.11'
   spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rubocop', '~> 0.49'
-  spec.add_development_dependency 'webmock', '~> 2.3'
-  spec.add_dependency 'httparty', '~> 0.14'
+
+  if RUBY_VERSION >= '2.1.0'
+    # rubocop is only run in the latest ruby build
+    # so we use the latest version and don't switch to a
+    # older version for 1.9.3
+    spec.add_development_dependency 'rubocop', '~> 0.49'
+    spec.add_development_dependency 'webmock', '~> 3.0'
+  else
+    # Webmock 3.0 does not support Ruby 1.9.3
+    spec.add_development_dependency 'webmock', '~> 2.3'
+  end
 end

data/test/fixtures/cancel_invoice.json

@@ -0,0 +1,44 @@
+{
+  "id": "inv_6vRZmJYFAG1mNq",
+  "entity": "invoice",
+  "receipt": null,
+  "invoice_number": null,
+  "customer_id": "cust_6vRXClWqnLhV14",
+  "customer_details": {
+    "customer_name": null,
+    "customer_email": "test@razorpay.com",
+    "customer_contact": "9876543210",
+    "customer_address": null
+  },
+  "order_id": "order_6vRZmJu7EPEMY0",
+  "line_items": [],
+  "payment_id": null,
+  "expire_by": null,
+  "status": "cancelled",
+  "issued_at": 1482299421,
+  "paid_at": null,
+  "cancelled_at": 1482299424,
+  "expired_at": null,
+  "sms_status": "sent",
+  "email_status": "sent",
+  "date": 1482299421,
+  "partial_payment": false,
+  "terms": null,
+  "gross_amount": 100,
+  "tax_amount": 0,
+  "amount": 100,
+  "amount_paid": 100,
+  "amount_due": 0,
+  "description": "Test description",
+  "notes": [],
+  "currency": "INR",
+  "short_url": "http://bit.ly/2i8kSqu",
+  "comment": null,
+  "view_less": true,
+  "type": "invoice",
+  "billing_start": null,
+  "billing_end": null,
+  "group_taxes_amounts": false,
+  "user_id": "fake_user_id",
+  "created_at": 1482299422
+}

data/test/fixtures/cancel_subscription.json

@@ -0,0 +1,20 @@
+{
+  "id": "fake_subscription_id",
+  "entity": "subscription",
+  "plan_id": "fake_plan_id",
+  "customer_id": "fake_customer_id",
+  "status": "cancelled",
+  "current_start": null,
+  "current_end": null,
+  "ended_at": 1509494400,
+  "quantity": 1,
+  "notes": [],
+  "charge_at": 1509494400,
+  "start_at": 1509494400,
+  "end_at": 1538332200,
+  "auth_attempts": 0,
+  "total_count": 12,
+  "paid_count": 0,
+  "customer_notify": true,
+  "created_at": 1509114729
+}

data/test/fixtures/fake_addon.json

@@ -0,0 +1,24 @@
+{
+  "id": "fake_addon_id",
+  "entity": "addon",
+  "item": {
+    "id": "fake_item_id",
+    "active": true,
+    "name": "fake_item_name",
+    "description": "fake_item_description",
+    "amount": 500,
+    "unit_amount": 500,
+    "currency": "INR",
+    "type": "addon",
+    "unit": null,
+    "tax_inclusive": false,
+    "tax_id": null,
+    "tax_group_id": null,
+    "created_at": 1511525691,
+    "updated_at": 1511525691
+  },
+  "quantity": 1,
+  "created_at": 1511525697,
+  "subscription_id": "fake_subscription_id",
+  "invoice_id": null
+}

data/test/fixtures/fake_invoice.json

@@ -2,6 +2,7 @@
   "id": "inv_6vRZmJYFAG1mNq",
   "entity": "invoice",
   "receipt": null,
+  "invoice_number": null,
   "customer_id": "cust_6vRXClWqnLhV14",
   "customer_details": {
     "customer_name": null,

data/test/fixtures/fake_plan.json

@@ -0,0 +1,26 @@
+{
+  "id": "fake_plan_id",
+  "entity": "plan",
+  "interval": 1,
+  "period": "monthly",
+  "item": {
+    "id": "item_92ARNuCnESXZkj",
+    "active": true,
+    "name": "Plan 751..1000",
+    "description": "Share docs + user mgmt",
+    "amount": 2500000,
+    "unit_amount": 2500000,
+    "currency": "INR",
+    "type": "plan",
+    "unit": null,
+    "tax_inclusive": false,
+    "tax_id": null,
+    "tax_group_id": null,
+    "created_at": 1510841630,
+    "updated_at": 1510841630
+  },
+  "notes": {
+    "identifier": "plan_monthly_1000"
+  },
+  "created_at": 1510841630
+}

data/test/fixtures/fake_subscription.json

@@ -0,0 +1,20 @@
+{
+  "id": "fake_subscription_id",
+  "entity": "subscription",
+  "plan_id": "fake_plan_id",
+  "customer_id": "fake_customer_id",
+  "status": "created",
+  "current_start": null,
+  "current_end": null,
+  "ended_at": null,
+  "quantity": 1,
+  "notes": [],
+  "charge_at": 1509494400,
+  "start_at": 1509494400,
+  "end_at": 1538332200,
+  "auth_attempts": 0,
+  "total_count": 12,
+  "paid_count": 0,
+  "customer_notify": true,
+  "created_at": 1509114729
+}

data/test/fixtures/issue_invoice.json

@@ -0,0 +1,44 @@
+{
+  "id": "inv_6vRZmJYFAG1mNq",
+  "entity": "invoice",
+  "receipt": null,
+  "invoice_number": null,
+  "customer_id": "cust_6vRXClWqnLhV14",
+  "customer_details": {
+    "customer_name": null,
+    "customer_email": "test@razorpay.com",
+    "customer_contact": "9876543210",
+    "customer_address": null
+  },
+  "order_id": "order_6vRZmJu7EPEMY0",
+  "line_items": [],
+  "payment_id": null,
+  "expire_by": null,
+  "status": "issued",
+  "issued_at": 1482299421,
+  "paid_at": null,
+  "cancelled_at": null,
+  "expired_at": null,
+  "sms_status": "sent",
+  "email_status": "sent",
+  "date": 1482299421,
+  "partial_payment": false,
+  "terms": null,
+  "gross_amount": 100,
+  "tax_amount": 0,
+  "amount": 100,
+  "amount_paid": 100,
+  "amount_due": 0,
+  "description": "Test description",
+  "notes": [],
+  "currency": "INR",
+  "short_url": "http://bit.ly/2i8kSqu",
+  "comment": null,
+  "view_less": true,
+  "type": "invoice",
+  "billing_start": null,
+  "billing_end": null,
+  "group_taxes_amounts": false,
+  "user_id": "fake_user_id",
+  "created_at": 1482299422
+}

data/test/fixtures/plan_collection.json

@@ -0,0 +1,32 @@
+{
+  "entity": "collection",
+  "count": 1,
+  "items": [
+    {
+      "id": "plan_92ARNuOYid1CoJ",
+      "entity": "plan",
+      "interval": 1,
+      "period": "monthly",
+      "item": {
+        "id": "item_92ARNuCnESXZkj",
+        "active": true,
+        "name": "Plan 751..1000",
+        "description": "Share docs + user mgmt",
+        "amount": 2500000,
+        "unit_amount": 2500000,
+        "currency": "INR",
+        "type": "plan",
+        "unit": null,
+        "tax_inclusive": false,
+        "tax_id": null,
+        "tax_group_id": null,
+        "created_at": 1510841630,
+        "updated_at": 1510841630
+      },
+      "notes": {
+        "identifier": "plan_monthly_1000"
+      },
+      "created_at": 1510841630
+    }
+  ]
+}

data/test/fixtures/subscription_collection.json

@@ -0,0 +1,26 @@
+{
+  "entity":"collection",
+  "count":10,
+  "items": [
+    {
+      "id": "fake_subscription_id",
+      "entity": "subscription",
+      "plan_id": "fake_plan_id",
+      "customer_id": "fake_customer_id",
+      "status": "created",
+      "current_start": null,
+      "current_end": null,
+      "ended_at": null,
+      "quantity": 1,
+      "notes": [],
+      "charge_at": 1509494400,
+      "start_at": 1509494400,
+      "end_at": 1538332200,
+      "auth_attempts": 0,
+      "total_count": 12,
+      "paid_count": 0,
+      "customer_notify": true,
+      "created_at": 1509114729
+    }
+  ]
+}

data/test/fixtures/update_invoice.json

@@ -0,0 +1,44 @@
+{
+  "id": "inv_6vRZmJYFAG1mNq",
+  "entity": "invoice",
+  "receipt": "12345678",
+  "invoice_number": "12345678",
+  "customer_id": "cust_6vRXClWqnLhV14",
+  "customer_details": {
+    "customer_name": null,
+    "customer_email": "test@razorpay.com",
+    "customer_contact": "9876543210",
+    "customer_address": null
+  },
+  "order_id": "order_6vRZmJu7EPEMY0",
+  "line_items": [],
+  "payment_id": null,
+  "expire_by": null,
+  "status": "issued",
+  "issued_at": 1482299421,
+  "paid_at": null,
+  "cancelled_at": null,
+  "expired_at": null,
+  "sms_status": "sent",
+  "email_status": "sent",
+  "date": 1482299421,
+  "partial_payment": false,
+  "terms": null,
+  "gross_amount": 100,
+  "tax_amount": 0,
+  "amount": 100,
+  "amount_paid": 100,
+  "amount_due": 0,
+  "description": "Test description",
+  "notes": [],
+  "currency": "INR",
+  "short_url": "http://bit.ly/2i8kSqu",
+  "comment": null,
+  "view_less": true,
+  "type": "invoice",
+  "billing_start": null,
+  "billing_end": null,
+  "group_taxes_amounts": false,
+  "user_id": "fake_user_id",
+  "created_at": 1482299422
+}

data/test/razorpay/test_addon.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+module Razorpay
+  # Tests for Razorpay::Addon
+  class RazorpayAddonTest < Minitest::Test
+    class Item < Razorpay::Entity; end
+
+    def setup
+      @subscription_id = 'fake_subscription_id'
+      @addon_id = 'fake_addon_id'
+
+      # Any request that ends with addons/addon_id
+      stub_get(%r{addons\/#{Regexp.quote(@addon_id)}$}, 'fake_addon')
+    end
+
+    def test_addon_should_be_defined
+      refute_nil Razorpay::Addon
+    end
+
+    def test_addon_should_be_available
+      addon = Razorpay::Addon.fetch(@addon_id)
+      assert_instance_of Razorpay::Addon, addon, 'Addon not an instance of Addon class'
+      assert_equal @addon_id, addon.id, 'Addon IDs do not match'
+      assert_equal 1, addon.quantity, 'Addon quantity is accessible'
+      assert_equal 'fake_subscription_id', addon.subscription_id, 'Addon subscription_id is accessible'
+      assert_nil addon.invoice_id, 'Addon invoice_id is accessible'
+
+      assert_addon_item_details(addon)
+    end
+
+    def test_add_addons_to_subscription
+      addon_attrs = {
+        item: {
+          name: 'fake_addon_name', currency: 'INR', amount: 5000,
+          description: 'fake_addon_description'
+        },
+        quantity: 1
+      }
+
+      stub_post(%r{subscriptions\/#{@subscription_id}\/addons$}, 'fake_addon', create_addon_stub_url_params)
+
+      addon = Razorpay::Addon.create(@subscription_id, addon_attrs)
+      assert_instance_of Razorpay::Addon, addon, 'Addon not an instance of Addon class'
+
+      assert_equal 'fake_addon_id', addon.id, 'Addon IDs do not match'
+      assert_equal 1, addon.quantity, 'Addon quantity is accessible'
+      assert_equal 'fake_subscription_id', addon.subscription_id, 'Addon subscription_id is accessible'
+      assert_nil addon.invoice_id, 'Addon invoice_id is accessible'
+
+      assert_addon_item_details(addon)
+    end
+
+    private
+
+    def assert_addon_item_details(addon)
+      addon_item = Item.new(addon.item)
+
+      assert_equal 'fake_item_id', addon_item.id, 'Addon Item id is accessible'
+      assert_equal 'fake_item_name', addon_item.name, 'Addon Item name is accessible'
+      assert_equal 'fake_item_description', addon_item.description, 'Addon Item description is accessible'
+      assert_equal 'INR', addon_item.currency, 'Addon Item currency is accessible'
+      assert_equal 500, addon_item.amount, 'Addon Item amount is accessible'
+    end
+
+    def create_addon_stub_url_params
+      %w(
+        item[name]=fake_addon_name&item[currency]=INR&item[amount]=5000&
+        item[description]=fake_addon_description&quantity=1
+      ).join
+    end
+  end
+end

data/test/razorpay/test_invoice.rb

@@ -41,5 +41,76 @@ module Razorpay
       assert_instance_of Razorpay::Collection, invoices, 'Invoices should be an array'
       assert !invoices.items.empty?, 'invoices should be more than one'
     end
+
+    def test_invoice_can_be_issued_by_invoice_id
+      stub_post(%r{invoices\/#{@invoice_id}\/issue$}, 'issue_invoice', {})
+      invoice = Razorpay::Invoice.issue(@invoice_id)
+
+      assert_equal 'issued', invoice.status
+      refute_nil invoice.issued_at
+
+      assert_invoice_details(invoice)
+    end
+
+    def test_invoice_can_be_issued_by_invoice_instance
+      stub_post(%r{invoices\/#{@invoice_id}\/issue$}, 'issue_invoice', {})
+      invoice = Razorpay::Invoice.fetch(@invoice_id)
+
+      assert_instance_of Razorpay::Invoice, invoice, 'invoice not an instance of Razorpay::Invoice class'
+
+      invoice = invoice.issue
+
+      assert_equal 'issued', invoice.status
+      refute_nil invoice.issued_at
+
+      assert_invoice_details(invoice)
+    end
+
+    def test_invoice_can_be_cancelled_by_invoice_id
+      stub_post(%r{invoices\/#{@invoice_id}\/cancel$}, 'cancel_invoice', {})
+      invoice = Razorpay::Invoice.cancel(@invoice_id)
+
+      assert_equal 'cancelled', invoice.status
+      refute_nil invoice.cancelled_at
+
+      assert_invoice_details(invoice)
+    end
+
+    def test_invoice_can_be_cancelled_by_invoice_instance
+      stub_post(%r{invoices\/#{@invoice_id}\/cancel$}, 'cancel_invoice', {})
+      invoice = Razorpay::Invoice.fetch(@invoice_id)
+
+      assert_instance_of Razorpay::Invoice, invoice, 'invoice not an instance of Razorpay::Invoice class'
+
+      invoice = invoice.cancel
+
+      assert_equal 'cancelled', invoice.status
+      refute_nil invoice.cancelled_at
+
+      assert_invoice_details(invoice)
+    end
+
+    def test_edit_invoice
+      invoice = Razorpay::Invoice.fetch(@invoice_id)
+      assert_instance_of Razorpay::Invoice, invoice, 'invoice not an instance of Razorpay::Invoice class'
+      assert_nil invoice.invoice_number
+
+      update_invoice_data = { invoice_number: '12345678' }
+      stub_patch(%r{invoices/#{@invoice_id}$}, 'update_invoice', update_invoice_data)
+
+      invoice = invoice.edit(update_invoice_data)
+      assert_instance_of Razorpay::Invoice, invoice, 'invoice not an instance of Razorpay::Invoice class'
+      refute_nil invoice.invoice_number
+    end
+
+    private
+
+    def assert_invoice_details(invoice)
+      assert_equal 'cust_6vRXClWqnLhV14', invoice.customer_id
+      assert_equal 100, invoice.amount
+      assert_equal 'INR', invoice.currency
+      assert_equal 'Test description', invoice.description
+      assert_equal 'invoice', invoice.type
+    end
   end
 end

data/test/razorpay/test_plan.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+module Razorpay
+  # Tests for Razorpay::Plan
+  class RazorpayPlanTest < Minitest::Test
+    def setup
+      @plan_id = 'fake_plan_id'
+
+      # Any request that ends with plans/plan_id
+      stub_get(%r{plans\/#{Regexp.quote(@plan_id)}$}, 'fake_plan')
+      stub_get(/plans$/, 'plan_collection')
+    end
+
+    def test_plan_should_be_defined
+      refute_nil Razorpay::Plan
+    end
+
+    def test_all_plans
+      plans = Razorpay::Plan.all
+      assert_instance_of Razorpay::Collection, plans, 'Plans should be an array'
+      assert !plans.items.empty?, 'Plans should be more than one'
+    end
+
+    def test_plan_should_be_available
+      plan = Razorpay::Plan.fetch(@plan_id)
+      assert_instance_of Razorpay::Plan, plan, 'Plan not an instance of Plan class'
+      assert_equal @plan_id, plan.id, 'Plan IDs do not match'
+      assert_equal 1, plan.interval, 'Plan interval is accessible'
+      assert_equal 'monthly', plan.period, 'Plan period is accessible'
+      assert_equal JSON.parse('{"identifier": "plan_monthly_1000"}'), plan.notes, 'Plan notes is accessible'
+    end
+
+    def test_plan_should_be_created
+      plan_attrs = {
+        interval: 1, period: 'monthly',
+        item: {
+          name: 'Plan 751..1000',
+          description: 'Share docs + user mgmt',
+          currency: 'INR',
+          amount: 500
+        },
+        notes: { identifier: 'plan_monthly_1000' }
+      }
+
+      stub_post(/plans$/, 'fake_plan', create_plan_stub_url_params)
+
+      plan = Razorpay::Plan.create plan_attrs
+
+      assert_equal 1, plan.interval, 'Plan interval is accessible'
+      assert_equal 'monthly', plan.period, 'Plan period is accessible'
+      assert_equal JSON.parse('{"identifier": "plan_monthly_1000"}'), plan.notes, 'Plan notes is accessible'
+    end
+
+    private
+
+    def create_plan_stub_url_params
+      %w(
+        interval=1&period=monthly&
+        item[name]=Plan%20751..1000&
+        item[description]=Share%20docs%20%2B%20user%20mgmt&item[currency]=INR&
+        item[amount]=500&notes[identifier]=plan_monthly_1000
+      ).join
+    end
+  end
+end

data/test/razorpay/test_subscription.rb

@@ -0,0 +1,95 @@
+require 'test_helper'
+
+module Razorpay
+  # Tests for Razorpay::Subscription
+  class RazorpaySubscriptionTest < Minitest::Test
+    class Item < Razorpay::Entity; end
+
+    def setup
+      @subscription_id = 'fake_subscription_id'
+
+      # Any request that ends with subscriptions/subscription_id
+      stub_get(%r{subscriptions\/#{Regexp.quote(@subscription_id)}$}, 'fake_subscription')
+      stub_get(/subscriptions$/, 'subscription_collection')
+    end
+
+    def test_subscription_should_be_defined
+      refute_nil Razorpay::Subscription
+    end
+
+    def test_all_subscriptions
+      subscriptions = Razorpay::Subscription.all
+      assert_instance_of Razorpay::Collection, subscriptions, 'Subscriptions should be an array'
+      assert !subscriptions.items.empty?, 'Subscriptions should be more than one'
+    end
+
+    def test_subscription_should_be_available
+      subscription = Razorpay::Subscription.fetch(@subscription_id)
+      assert_instance_of Razorpay::Subscription, subscription, 'not an instance of Subscription class'
+
+      assert_equal @subscription_id, subscription.id, 'Subscription IDs do not match'
+
+      assert_subscription_details(subscription)
+    end
+
+    def test_subscription_should_be_created
+      time_now = Time.now.to_i
+      subscription_attrs = {
+        plan_id: 'fake_plan_id', customer_id: 'fake_customer_id',
+        start_at: time_now, total_count: 12
+      }
+
+      stub_params = "plan_id=fake_plan_id&customer_id=fake_customer_id&start_at=#{time_now}&total_count=12"
+      stub_post(/subscriptions$/, 'fake_subscription', stub_params)
+
+      subscription = Razorpay::Subscription.create subscription_attrs
+      assert_instance_of Razorpay::Subscription, subscription, 'not an instance of Subscription class'
+
+      assert_equal @subscription_id, subscription.id, 'Subscription IDs do not match'
+      assert_equal 'created', subscription.status, 'Subscription status is accessible'
+
+      assert_subscription_details(subscription)
+    end
+
+    def test_subscription_can_be_cancelled_by_subscription_id
+      stub_post(%r{subscriptions\/#{@subscription_id}\/cancel$}, 'cancel_subscription', {})
+      subscription = Razorpay::Subscription.cancel(@subscription_id)
+
+      assert_equal @subscription_id, subscription.id, 'Subscription IDs do not match'
+      assert_equal 'cancelled', subscription.status, 'Subscription status is accessible'
+
+      assert_subscription_details(subscription)
+    end
+
+    def test_subscription_can_be_cancelled_by_subscription_instance
+      stub_post(%r{subscriptions\/#{@subscription_id}\/cancel$}, 'cancel_subscription', {})
+      subscription = Razorpay::Subscription.fetch(@subscription_id)
+
+      assert_instance_of Razorpay::Subscription, subscription, 'not an instance of Subscription class'
+      assert_equal @subscription_id, subscription.id, 'subscription IDs do not match'
+      assert_equal 'created', subscription.status, 'Subscription status is accessible'
+      assert_nil subscription.ended_at, 'Subscription ended_at is accessible'
+
+      subscription = subscription.cancel(cancel_at_cycle_end: 1)
+
+      assert_equal @subscription_id, subscription.id, 'Subscription IDs do not match'
+      assert_equal 'cancelled', subscription.status, 'Subscription status is accessible'
+      refute_nil subscription.ended_at, 'Subscription ended_at is accessible'
+
+      assert_subscription_details(subscription)
+    end
+
+    private
+
+    def assert_subscription_details(subscription)
+      assert_equal 'fake_plan_id', subscription.plan_id, 'Subscription plan_id is accessible'
+      assert_equal 'fake_customer_id', subscription.customer_id, 'Subscription customer_id is accessible'
+      assert_equal 12, subscription.total_count, 'Subscription total_count is accessible'
+      assert_equal 0, subscription.paid_count, 'Subscription paid_count is accessible'
+      refute_nil subscription.charge_at, 'Subscription charge_at is accessible'
+      refute_nil subscription.start_at, 'Subscription start_at is accessible'
+      refute_nil subscription.end_at, 'Subscription end_at is accessible'
+      assert_equal [], subscription.notes, 'Subscription notes is accessible'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: razorpay
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Abhay Rana
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -31,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -73,28 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '3.0'
 description: Official ruby bindings for the Razorpay API
 email:
 - nemo@razorpay.com
@@ -115,6 +115,7 @@ files:
 - Rakefile
 - lib/ca-bundle.crt
 - lib/razorpay.rb
+- lib/razorpay/addon.rb
 - lib/razorpay/card.rb
 - lib/razorpay/collection.rb
 - lib/razorpay/constants.rb
@@ -128,13 +129,18 @@ files:
 - lib/razorpay/invoice.rb
 - lib/razorpay/order.rb
 - lib/razorpay/payment.rb
+- lib/razorpay/plan.rb
 - lib/razorpay/refund.rb
 - lib/razorpay/request.rb
+- lib/razorpay/subscription.rb
 - lib/razorpay/utility.rb
 - lib/razorpay/virtual_account.rb
 - razorpay-ruby.gemspec
 - test/fixtures/bad_request_error.json
+- test/fixtures/cancel_invoice.json
+- test/fixtures/cancel_subscription.json
 - test/fixtures/customer_collection.json
+- test/fixtures/fake_addon.json
 - test/fixtures/fake_captured_payment.json
 - test/fixtures/fake_card.json
 - test/fixtures/fake_customer.json
@@ -144,19 +150,26 @@ files:
 - test/fixtures/fake_payment.json
 - test/fixtures/fake_payment_authorized_webhook.json
 - test/fixtures/fake_payment_bank_transfer.json
+- test/fixtures/fake_plan.json
 - test/fixtures/fake_refund.json
+- test/fixtures/fake_subscription.json
 - test/fixtures/fake_virtual_account.json
 - test/fixtures/fake_virtual_account_closed.json
 - test/fixtures/fake_virtual_account_collection.json
 - test/fixtures/hello_response.json
 - test/fixtures/invoice_collection.json
+- test/fixtures/issue_invoice.json
 - test/fixtures/order_collection.json
 - test/fixtures/order_payments.json
 - test/fixtures/payment_collection.json
 - test/fixtures/payment_collection_with_one_payment.json
+- test/fixtures/plan_collection.json
 - test/fixtures/refund_collection.json
 - test/fixtures/refund_collection_for_payment.json
+- test/fixtures/subscription_collection.json
+- test/fixtures/update_invoice.json
 - test/fixtures/welcome.json
+- test/razorpay/test_addon.rb
 - test/razorpay/test_card.rb
 - test/razorpay/test_customer.rb
 - test/razorpay/test_entity.rb
@@ -164,9 +177,11 @@ files:
 - test/razorpay/test_invoice.rb
 - test/razorpay/test_order.rb
 - test/razorpay/test_payment.rb
+- test/razorpay/test_plan.rb
 - test/razorpay/test_razorpay.rb
 - test/razorpay/test_refund.rb
 - test/razorpay/test_request.rb
+- test/razorpay/test_subscription.rb
 - test/razorpay/test_utility.rb
 - test/razorpay/test_virtual_account.rb
 - test/test_helper.rb
@@ -190,13 +205,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Razorpay's Ruby API
 test_files:
 - test/fixtures/bad_request_error.json
+- test/fixtures/cancel_invoice.json
+- test/fixtures/cancel_subscription.json
 - test/fixtures/customer_collection.json
+- test/fixtures/fake_addon.json
 - test/fixtures/fake_captured_payment.json
 - test/fixtures/fake_card.json
 - test/fixtures/fake_customer.json
@@ -206,19 +224,26 @@ test_files:
 - test/fixtures/fake_payment.json
 - test/fixtures/fake_payment_authorized_webhook.json
 - test/fixtures/fake_payment_bank_transfer.json
+- test/fixtures/fake_plan.json
 - test/fixtures/fake_refund.json
+- test/fixtures/fake_subscription.json
 - test/fixtures/fake_virtual_account.json
 - test/fixtures/fake_virtual_account_closed.json
 - test/fixtures/fake_virtual_account_collection.json
 - test/fixtures/hello_response.json
 - test/fixtures/invoice_collection.json
+- test/fixtures/issue_invoice.json
 - test/fixtures/order_collection.json
 - test/fixtures/order_payments.json
 - test/fixtures/payment_collection.json
 - test/fixtures/payment_collection_with_one_payment.json
+- test/fixtures/plan_collection.json
 - test/fixtures/refund_collection.json
 - test/fixtures/refund_collection_for_payment.json
+- test/fixtures/subscription_collection.json
+- test/fixtures/update_invoice.json
 - test/fixtures/welcome.json
+- test/razorpay/test_addon.rb
 - test/razorpay/test_card.rb
 - test/razorpay/test_customer.rb
 - test/razorpay/test_entity.rb
@@ -226,9 +251,11 @@ test_files:
 - test/razorpay/test_invoice.rb
 - test/razorpay/test_order.rb
 - test/razorpay/test_payment.rb
+- test/razorpay/test_plan.rb
 - test/razorpay/test_razorpay.rb
 - test/razorpay/test_refund.rb
 - test/razorpay/test_request.rb
+- test/razorpay/test_subscription.rb
 - test/razorpay/test_utility.rb
 - test/razorpay/test_virtual_account.rb
 - test/test_helper.rb