razorpay 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17c4aad5f24c1236ebd6451887926d9bf5b45b34
-  data.tar.gz: ae0ef8f24f6de62bdf014e9a22b0a70de095a924
+  metadata.gz: f1342dbfd634ead754a60f675870429894fdab71
+  data.tar.gz: f3b91327653aa94ac1e19e684223ffc9e7e890c7
 SHA512:
-  metadata.gz: 127d16bbbc8b8a19a8cc4a0be9cab4d167781af3dd4fa847a4f9d7293044f732c5608f3eed52a82ec786280305fd80d5b35ddc3c448eeceaa5cd9f7f5652b012
-  data.tar.gz: eefee7a5c5011b3f88e0efec3763fc16ecda6f7469bf3e65a732adc3db1c228cef45ac8dea52f43c5fa0f39a23df67c967e5c1de4427fbb6610988dc66f115f5
+  metadata.gz: 977fee36b31a1d7e44d0679eddf5593702387974a46438613383ea9f9588f84c3e9dbda7d6a05f719f22086a206ab5e07918eb474be04822b144cfb329d45bbd
+  data.tar.gz: 3e32025de35f357144a6da06a492e42c9efe20e93ef546cfc55bafb607dc4df6a3d9d13fcbb01f656a6ac6cbeb018d108c8e674b5e5f78956247d334dd871305

data/CHANGELOG

@@ -2,7 +2,12 @@
 
 Changelog for Razorpay-Ruby SDK.
 
-## Unreleased
+## [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
@@ -25,7 +30,8 @@ Changelog for Razorpay-Ruby SDK.
 ### Added
 - Initial Release
 
-[Unreleased]: https://github.com/razorpay/razorpay-ruby/compare/1.2.0...HEAD
+[Unreleased]: https://github.com/razorpay/razorpay-ruby/compare/1.2.1...HEAD
+[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

data/README.md

@@ -53,9 +53,9 @@ see our online documentation on <https://docs.razorpay.com>
 
 ### Orders API
 
-Send us a mail at <support@razorpay.com> to enable the Orders API
-for your account. You can use the orders API using the following
-constructs:
+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'
@@ -70,8 +70,17 @@ puts order.amount
 
 # Fetching payments corresponding to an order
 payments = order.payments
+
+# Create a customer
+customer = Razorpay::Customer.create email: 'test@razorpay.com', contact: '9876543210'
+puts customer.id #cust_6vRXClWqnLhV14
+
+# 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>.
+
 ## Development
 
 - Everything is namespaced under the Razorpay module
@@ -90,3 +99,19 @@ payments = order.payments
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
+
+## Release
+
+Steps to follow for a release:
+
+0. Merge the branch with the new code to master.
+1. Bump the Version in `lib/razorpay/constants.rb`
+2. Rename Unreleased to the new tag in `CHANGELOG`
+3. Fix links at bottom in `CHANGELOG`
+4. Commit (message should include version number)
+5. Tag the release and push to GitHub. Get the tag signed using Razorpay GPG key.
+6. Create a release on GitHub using the website with more details about the release
+7. Run `gem build razorpay-ruby.gemspec`
+8. Run `gem push razorpay-{version}.gem`
+
+`gem push` will ask you for credentials, if you are not logged in already.

data/lib/razorpay.rb

@@ -1,5 +1,6 @@
 require 'razorpay/constants'
 require 'razorpay/payment'
+require 'razorpay/order'
 
 # Base Razorpay module
 module Razorpay

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 = '1.2.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

data/lib/razorpay/customer.rb

@@ -0,0 +1,15 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Customer API allows you to create customer IDs on Razorpay
+  class Customer < Entity
+    def self.request
+      Razorpay::Request.new('customers')
+    end
+
+    def self.create(options)
+      request.create options
+    end
+  end
+end

data/lib/razorpay/invoice.rb

@@ -0,0 +1,24 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Invoice API allows you to create and
+  # manage invoices with Razorpay
+  class Invoice < Entity
+    def self.request
+      Razorpay::Request.new('invoices')
+    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/order.rb

@@ -2,17 +2,14 @@ require 'razorpay/request'
 require 'razorpay/entity'
 
 module Razorpay
-  # Order API is currently in beta and allows you to
-  # associate Payments with an order entity
+  # Order API allows you to associate
+  # Payments with an order entity
   class Order < Entity
     def self.request
       Razorpay::Request.new('orders')
     end
 
     def self.create(options)
-      raise ArgumentError, 'Please provide order amount' unless options.key?(:amount)
-      raise ArgumentError, 'Please provide order currency' unless options.key?(:currency)
-      raise ArgumentError, 'Please provide order receipt' unless options.key?(:receipt)
       request.create options
     end
 

data/lib/razorpay/payment.rb

@@ -29,13 +29,11 @@ module Razorpay
     end
 
     def capture(options)
-      raise ArgumentError, 'Please provide capture amount' unless options.key?(:amount)
       self.class.request.post "#{id}/capture", options
     end
 
     def method
       method_missing(:method)
     end
-
   end
 end

data/test/fixtures/fake_customer.json

@@ -0,0 +1,8 @@
+{
+  "id": "cust_6vRXClWqnLhV14",
+  "email": "test@razorpay.com",
+  "contact": "9876543210",
+  "notes": [],
+  "created_at": 1482299274,
+  "entity": "customer"
+}

data/test/fixtures/fake_invoice.json

@@ -0,0 +1,29 @@
+{
+  "id": "inv_6vRZmJYFAG1mNq",
+  "entity": "invoice",
+  "receipt": 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,
+  "status": "issued",
+  "issued_at": 1482299421,
+  "paid_at": null,
+  "sms_status": "sent",
+  "email_status": "sent",
+  "date": 1482299421,
+  "amount": 100,
+  "description": "Test description",
+  "notes": [],
+  "currency": "INR",
+  "short_url": "http://bit.ly/2i8kSqu",
+  "view_less": true,
+  "type": "link",
+  "created_at": 1482299422
+}

data/test/fixtures/invoice_collection.json

@@ -0,0 +1,93 @@
+{
+  "entity": "collection",
+  "count": 3,
+  "items": [
+    {
+      "id": "inv_6vRZmJYFAG1mNq",
+      "entity": "invoice",
+      "receipt": 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,
+      "status": "issued",
+      "issued_at": 1482299421,
+      "paid_at": null,
+      "sms_status": "sent",
+      "email_status": "sent",
+      "date": 1482299421,
+      "amount": 100,
+      "description": "Test description",
+      "notes": [],
+      "currency": "INR",
+      "short_url": "http://bit.ly/2i8kSqu",
+      "view_less": true,
+      "type": "link",
+      "created_at": 1482299422
+    },
+    {
+      "id": "inv_6vRaHV8UDx58xy",
+      "entity": "invoice",
+      "receipt": null,
+      "customer_id": "cust_6vRXClWqnLhV14",
+      "customer_details": {
+        "customer_name": null,
+        "customer_email": "test@razorpay.com",
+        "customer_contact": "9876543210",
+        "customer_address": null
+      },
+      "order_id": "order_6vRaHVgZ1D3ESr",
+      "line_items": [],
+      "payment_id": null,
+      "status": "issued",
+      "issued_at": 1482299449,
+      "paid_at": null,
+      "sms_status": "sent",
+      "email_status": "sent",
+      "date": 1482299449,
+      "amount": 100,
+      "description": "Test description",
+      "notes": [],
+      "currency": "INR",
+      "short_url": "http://bit.ly/2h0nLV7",
+      "view_less": true,
+      "type": "link",
+      "created_at": 1482299450
+    },
+    {
+      "id": "inv_6vRaaIQ6I3vO53",
+      "entity": "invoice",
+      "receipt": null,
+      "customer_id": "cust_6vRXClWqnLhV14",
+      "customer_details": {
+        "customer_name": null,
+        "customer_email": "test@razorpay.com",
+        "customer_contact": "9876543210",
+        "customer_address": null
+      },
+      "order_id": "order_6vRaaInhKbWFUB",
+      "line_items": [],
+      "payment_id": null,
+      "status": "issued",
+      "issued_at": 1482299466,
+      "paid_at": null,
+      "sms_status": "sent",
+      "email_status": "sent",
+      "date": 1482299466,
+      "amount": 100,
+      "description": "Test description",
+      "notes": [],
+      "currency": "INR",
+      "short_url": "http://bit.ly/2h0jYHp",
+      "view_less": true,
+      "type": "link",
+      "created_at": 1482299468
+    }
+  ]
+}

data/test/razorpay/test_customer.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+require 'razorpay/customer'
+require 'razorpay/collection'
+
+module Razorpay
+  # Tests for Razorpay::Customer
+  class RazorpayCustomerTest < Minitest::Test
+    def setup
+      @customer_id = 'cust_6vRXClWqnLhV14'
+
+      # Any request that ends with customers/customer_id
+      stub_get(%r{customers/#{@customer_id}$}, 'fake_customer')
+    end
+
+    def test_customer_should_be_defined
+      refute_nil Razorpay::Customer
+    end
+
+    def test_customer_should_be_created
+      stub_post(/customers$/, 'fake_customer', 'email=test%40razorpay.com&contact=9876543210')
+      customer = Razorpay::Customer.create email: 'test@razorpay.com', contact: '9876543210'
+
+      assert_equal 'test@razorpay.com', customer.email
+      assert_equal '9876543210', customer.contact
+    end
+  end
+end

data/test/razorpay/test_invoice.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+require 'razorpay/invoice'
+require 'razorpay/collection'
+
+module Razorpay
+  # Tests for Razorpay::Invoice
+  class RazorpayInvoiceTest < Minitest::Test
+    def setup
+      @invoice_id = 'inv_6vRZmJYFAG1mNq'
+
+      # Any request that ends with invoices/invoice_id
+      stub_get(%r{invoices/#{@invoice_id}$}, 'fake_invoice')
+    end
+
+    def test_invoice_should_be_defined
+      refute_nil Razorpay::Invoice
+    end
+
+    def test_invoice_should_be_created
+      stub_post(/invoices$/, 'fake_invoice', 'customer_id=cust_6vRXClWqnLhV14&amount=100&currency=INR&description=Test%20description&type=link')
+      invoice = Razorpay::Invoice.create customer_id: 'cust_6vRXClWqnLhV14', amount: 100, currency: 'INR', description: 'Test description', type: 'link'
+
+      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 'link', invoice.type
+    end
+
+    def test_invoices_should_be_fetched
+      invoice = Razorpay::Invoice.fetch(@invoice_id)
+      assert_instance_of Razorpay::Invoice, invoice, 'invoice not an instance of Razorpay::Invoice class'
+      assert_equal @invoice_id, invoice.id, 'invoice IDs do not match'
+    end
+
+    def test_fetching_all_invoices
+      stub_get(/invoices$/, 'invoice_collection')
+      invoices = Razorpay::Invoice.all
+      assert_instance_of Razorpay::Collection, invoices, 'Invoices should be an array'
+      assert !invoices.items.empty?, 'invoices should be more than one'
+    end
+  end
+end

data/test/razorpay/test_payment.rb

@@ -57,9 +57,6 @@ module Razorpay
     def test_payment_capture
       stub_post(%r{payments/#{@payment_id}/capture$}, 'fake_captured_payment', 'amount=5100')
       payment = Razorpay::Payment.fetch(@payment_id)
-      assert_raises(ArgumentError, 'ArgumentError should be raised if amount is not provided') do
-        payment.capture
-      end
       payment = payment.capture(amount: 5100)
       assert_equal 'captured', payment.status
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: razorpay
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Abhay Rana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-23 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -101,12 +101,14 @@ files:
 - lib/razorpay.rb
 - lib/razorpay/collection.rb
 - lib/razorpay/constants.rb
+- lib/razorpay/customer.rb
 - lib/razorpay/entity.rb
 - lib/razorpay/errors.rb
 - lib/razorpay/errors/bad_request_error.rb
 - lib/razorpay/errors/gateway_error.rb
 - lib/razorpay/errors/razorpay_error.rb
 - lib/razorpay/errors/server_error.rb
+- lib/razorpay/invoice.rb
 - lib/razorpay/order.rb
 - lib/razorpay/payment.rb
 - lib/razorpay/refund.rb
@@ -114,17 +116,22 @@ files:
 - razorpay-ruby.gemspec
 - test/fixtures/bad_request_error.json
 - test/fixtures/fake_captured_payment.json
+- test/fixtures/fake_customer.json
+- test/fixtures/fake_invoice.json
 - test/fixtures/fake_order.json
 - test/fixtures/fake_payment.json
 - test/fixtures/fake_refund.json
 - test/fixtures/hello_response.json
+- test/fixtures/invoice_collection.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/refund_collection.json
+- test/razorpay/test_customer.rb
 - test/razorpay/test_entity.rb
 - test/razorpay/test_errors.rb
+- test/razorpay/test_invoice.rb
 - test/razorpay/test_order.rb
 - test/razorpay/test_payment.rb
 - test/razorpay/test_razorpay.rb
@@ -157,17 +164,22 @@ summary: Razorpay's Ruby API
 test_files:
 - test/fixtures/bad_request_error.json
 - test/fixtures/fake_captured_payment.json
+- test/fixtures/fake_customer.json
+- test/fixtures/fake_invoice.json
 - test/fixtures/fake_order.json
 - test/fixtures/fake_payment.json
 - test/fixtures/fake_refund.json
 - test/fixtures/hello_response.json
+- test/fixtures/invoice_collection.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/refund_collection.json
+- test/razorpay/test_customer.rb
 - test/razorpay/test_entity.rb
 - test/razorpay/test_errors.rb
+- test/razorpay/test_invoice.rb
 - test/razorpay/test_order.rb
 - test/razorpay/test_payment.rb
 - test/razorpay/test_razorpay.rb