razorruby 3.0.1

data/lib/razorpay/request.rb

@@ -0,0 +1,119 @@
+require 'httparty'
+require 'extensions/httparty/hash_conversions'
+require 'razorpay/constants'
+
+module Razorpay
+  # Request objects are used to create fetch
+  # objects, which make requests to the server
+  # using HTTParty
+  class Request
+    include HTTParty
+
+    ssl_ca_file File.dirname(__FILE__) + '/../ca-bundle.crt'
+
+    def initialize(entity_name = nil)
+      self.class.base_uri(Razorpay::BASE_URI)
+      @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
+      }
+    end
+
+    def fetch(id)
+      request :get, "/#{@entity_name}/#{id}"
+    end
+
+    def all(options)
+      request :get, "/#{@entity_name}", options
+    end
+
+    def post(url, data = {})
+      request :post, "/#{@entity_name}/#{url}", data
+    end
+
+    def get(url, data = {})
+      request :get, "/#{@entity_name}/#{url}", data
+    end
+    
+    def delete(url)
+      request :delete, "/#{@entity_name}/#{url}"
+    end
+
+    def put(id, data = {})
+      request :put, "/#{@entity_name}/#{id}", data
+    end
+
+    def patch(id, data = {})
+      request :patch, "/#{@entity_name}/#{id}", data
+    end
+
+    def create(data)
+      request :post, "/#{@entity_name}", data
+    end
+
+    def request(method, url, data = {})
+      create_instance raw_request(method, url, data)
+    end
+
+    def raw_request(method, url, data = {}) 
+      case method
+      when :get
+        @options[:query] = data
+      when :post, :put, :patch
+        @options[:body] = data
+      end
+      
+      self.class.send(method, url, @options)
+    end
+
+    # Since we need to change the base route
+    def make_test_request
+      self.class.get Razorpay::TEST_URL, @options
+    end
+
+    # Recursively builds entity instances
+    # out of all hashes in the response object
+    def create_instance(res)
+      response = res.parsed_response
+
+      if response.is_a?(Array)==true || response.to_s.length == 0
+        return response
+      end 
+      
+      # if there was an error, throw it
+      raise_error(response['error'], res.code) if response.nil? || response.key?('error') && res.code !=200
+      # There must be a top level entity
+      # This is either one of payment, refund, or collection at present
+      begin
+        class_name = response['entity'].split('_').collect(&:capitalize).join
+
+        klass = Razorpay.const_get class_name
+      rescue NameError
+        # Use Entity class if we don't find any
+        klass = Razorpay::Entity
+      end
+      klass.new(response)
+    end
+
+    def raise_error(error, status)
+      # Get the error class name, require it and instantiate an error
+      class_name = error['code'].split('_').map(&:capitalize).join('')
+      args = [error['code'], status]
+      args.push error['field'] if error.key?('field')
+      require "razorpay/errors/#{error['code'].downcase}"
+      klass = Razorpay.const_get(class_name)
+      raise klass.new(*args), error['description']
+    rescue NameError, LoadError
+      # We got an unknown error, cast it to Error for now
+      raise Razorpay::Error.new, 'Unknown Error'
+    end
+  end
+end

data/lib/razorpay/settlement.rb

@@ -0,0 +1,39 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Settlement API allows you to fetch and delete
+  # Docs: https://razorpay.com/docs/api/settlements/
+  class Settlement < Entity
+    def self.request
+      Razorpay::Request.new('settlements')
+    end
+
+    def self.fetch(id)
+      request.fetch id
+    end
+
+    def self.reports(options={})
+      request.get "recon/combined", options
+    end
+
+    def self.all(options = {})
+      request.all options
+    end
+
+    def self.create(options={})
+      if(!options.is_a?(String) && options.key?(:settle_full_balance))
+        options[:settle_full_balance] = (options[:settle_full_balance] ? 1 : 0)
+      end 
+      request.post "ondemand", options
+    end
+
+    def self.fetch_all_ondemand_settlement(options={})
+      request.get "ondemand", options
+    end
+
+    def self.fetch_ondemand_settlement_by_id(id, options={})
+      request.get "ondemand/#{id}", options
+    end
+  end
+end

data/lib/razorpay/subscription.rb

@@ -0,0 +1,60 @@
+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
+
+    def cancel!(options = {})
+      with_a_bang { cancel options }
+    end
+
+    def edit(options = {})
+      self.class.request.patch id, options
+    end
+
+    def pending_update
+      self.class.request.get "#{id}/retrieve_scheduled_changes"
+    end
+
+    def self.cancel_scheduled_changes(id)
+      request.post "#{id}/cancel_scheduled_changes"
+    end
+
+    def self.pause(id, options = {})
+      request.post "#{id}/pause", options
+    end
+
+    def self.resume(id, options = {})
+      request.post "#{id}/resume", options
+    end
+
+    def self.delete_offer(id, offerId)
+      request.delete "#{id}/#{offerId}"
+    end
+  end
+end

data/lib/razorpay/subscription_registration.rb

@@ -0,0 +1,16 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # SubscriptionRegistration are an alternate way of 
+  # creating an authorization transaction
+  class SubscriptionRegistration < Entity
+    def self.request
+      Razorpay::Request.new('subscription_registration/auth_links')
+    end
+
+    def self.create(options)
+        request.create options
+    end
+  end
+end

data/lib/razorpay/transfer.rb

@@ -0,0 +1,35 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Transfer class handles all refund objects
+  class Transfer < Entity
+    def self.request
+      Razorpay::Request.new('transfers')
+    end
+    
+    def self.create(options)
+      request.create options
+    end
+
+    def self.all(options = {})
+     request.all options
+    end
+
+    def self.fetch(id)
+      request.fetch id
+    end
+
+    def edit(options = {})
+      self.class.request.patch id, options
+    end
+
+    def reverse(options = {})
+      self.class.request.post "#{id}/reversals", options
+    end
+
+    def self.fetch_settlements
+      request.get "?expand[]=recipient_settlement"
+    end
+  end
+end

data/lib/razorpay/utility.rb

@@ -0,0 +1,57 @@
+require 'openssl'
+
+module Razorpay
+  # Helper functions are defined here
+  class Utility
+    def self.verify_payment_signature(attributes)
+      signature = attributes.delete(:razorpay_signature) 
+
+      # Data requires the values to be in sorted order of their keys.
+      # attributes.sort returns a nested array, and the last
+      # element of each is the value. These are joined.
+      data = attributes.sort.map(&:last).join('|')
+      secret = Razorpay.auth[:password]
+      verify_signature(data, signature, secret)
+    end
+
+    def self.verify_payment_link_signature(attributes)
+      signature = attributes.delete(:razorpay_signature)
+      # element of each is the value. These are joined.
+      data = attributes.values.join('|')
+      secret = Razorpay.auth[:password]
+      verify_signature(data, signature, secret)
+    end
+
+    def self.verify_webhook_signature(body, signature, secret)
+      verify_signature(body, signature, secret)
+    end
+
+    class << self
+      private
+
+      def verify_signature(data, signature, secret)
+        expected_signature = OpenSSL::HMAC.hexdigest('SHA256', secret, data)
+        verified = secure_compare(expected_signature, signature)
+
+        raise SecurityError, 'Signature verification failed' unless verified
+
+        verified
+      end
+
+      def secure_compare(a, b)
+        return false unless a.bytesize == b.bytesize
+
+        l = a.unpack('C*')
+        r = 0
+        i = -1
+
+        b.each_byte do |v|
+          i += 1
+          r |= v ^ l[i]
+        end
+
+        r.zero?
+      end
+    end
+  end
+end

data/lib/razorpay/virtual_account.rb

@@ -0,0 +1,49 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Virtual Account API allows you to create and
+  # manage virtual accounts with Razorpay
+  class VirtualAccount < Entity
+    def self.request
+      Razorpay::Request.new('virtual_accounts')
+    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.close(id)
+       request.post "#{id}/close"
+    end
+
+    def close!
+      with_a_bang { close }
+    end
+
+    def payments(options = {})
+      r = self.class.request
+      r.request :get, "/virtual_accounts/#{id}/payments", options
+    end
+
+    def self.add_receiver(id, options = {})
+      request.post "#{id}/receivers", options
+    end
+
+    def self.allowed_payer(id, options = {})
+      request.post "#{id}/allowed_payers", options
+    end
+
+    def self.delete_allowed_payer(id, payer_id)
+      request.delete "#{id}/allowed_payers/#{payer_id}"
+    end
+  end
+end

data/lib/razorpay.rb

@@ -0,0 +1,37 @@
+require 'razorpay/card'
+require 'razorpay/order'
+require 'razorpay/errors'
+require 'razorpay/refund'
+require 'razorpay/invoice'
+require 'razorpay/payment'
+require 'razorpay/utility'
+require 'razorpay/customer'
+require 'razorpay/constants'
+require 'razorpay/collection'
+require 'razorpay/virtual_account'
+require 'razorpay/plan'
+require 'razorpay/subscription'
+require 'razorpay/addon'
+require 'razorpay/transfer'
+require 'razorpay/subscription_registration'
+require 'razorpay/settlement'
+require 'razorpay/payment_link'
+require 'razorpay/fund_account'
+require 'razorpay/item'
+require 'razorpay/qr_code'
+require 'razorpay/payment_method'
+
+# Base Razorpay module
+module Razorpay
+  class << self
+    attr_accessor :auth, :custom_headers
+  end
+
+  def self.setup(key_id, key_secret)
+    self.auth = { username: key_id, password: key_secret }
+  end
+
+  def self.headers=(headers = {})
+    self.custom_headers = headers
+  end
+end

data/razorpay-ruby.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', Dir.pwd)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'razorpay/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'razorruby'
+  spec.version       = Razorpay::VERSION
+  spec.authors       = ['Abhay Rana', 'Harman Singh']
+  spec.email         = ['nemo@razorpay.com', 'harman@razorpay.com']
+  spec.summary       = "Razorpay's Ruby API"
+  spec.description   = 'Official ruby bindings for the Razorpay API'
+  spec.homepage      = 'https://razorpay.com/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  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.11'
+  spec.add_development_dependency 'rake', '~> 12.0'
+
+  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/addon_collection.json

@@ -0,0 +1,60 @@
+{
+  "entity":"collection",
+  "count":2,
+  "items":[
+    {
+      "id":"ao_00000000000002",
+      "entity":"addon",
+      "item":{
+        "id":"item_00000000000002",
+        "active":true,
+        "name":"Extra sweet",
+        "description":"1 extra sweet of the day with meals",
+        "amount":90000,
+        "unit_amount":90000,
+        "currency":"INR",
+        "type":"addon",
+        "unit":null,
+        "tax_inclusive":false,
+        "hsn_code":null,
+        "sac_code":null,
+        "tax_rate":null,
+        "tax_id":null,
+        "tax_group_id":null,
+        "created_at":1581597318,
+        "updated_at":1581597318
+      },
+      "quantity":1,
+      "created_at":1581597318,
+      "subscription_id":"sub_00000000000001",
+      "invoice_id":"inv_00000000000001"
+    },
+    {
+      "id":"ao_00000000000001",
+      "entity":"addon",
+      "item":{
+        "id":"item_00000000000001",
+        "active":true,
+        "name":"Extra appala (papadum)",
+        "description":"1 extra oil fried appala with meals",
+        "amount":30000,
+        "unit_amount":30000,
+        "currency":"INR",
+        "type":"addon",
+        "unit":null,
+        "tax_inclusive":false,
+        "hsn_code":null,
+        "sac_code":null,
+        "tax_rate":null,
+        "tax_id":null,
+        "tax_group_id":null,
+        "created_at":1581597318,
+        "updated_at":1581597318
+      },
+      "quantity":2,
+      "created_at":1581597318,
+      "subscription_id":"sub_00000000000001",
+      "invoice_id":null
+    }
+  ]
+}

data/test/fixtures/bad_request_error.json

@@ -0,0 +1,7 @@
+{
+   "error": {
+      "code": "BAD_REQUEST_ERROR",
+      "description": "The amount is invalid",
+      "field": "amount"
+   }
+}

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/create_json_payment.json

@@ -0,0 +1,13 @@
+{
+    "razorpay_payment_id": "pay_FVmAstJWfsD3SO",
+    "next": [
+      {
+        "action": "redirect",
+        "url": "https://api.razorpay.com/v1/payments/FVmAtLUe9XZSGM/authorize"
+      },
+      {
+        "action": "otp_generate",
+        "url": "https://api.razorpay.com/v1/payments/pay_FVmAstJWfsD3SO/otp_generate?track_id=FVmAtLUe9XZSGM&key_id=<YOUR_KEY_ID>"
+      }
+    ]
+}

data/test/fixtures/customer_collection.json

@@ -0,0 +1,22 @@
+{
+  "entity": "collection",
+  "count": 2,
+  "items": [
+    {
+      "id": "cust_6vRXClWqnLhV14",
+      "email": "test@razorpay.com",
+      "contact": "9876543210",
+      "notes": [],
+      "created_at": 1482299274,
+      "entity": "customer"
+    },
+    {
+      "id": "cust_50smJrkZ4Qb0HJ",
+      "email": "test2@razorpay.com",
+      "contact": "9876543211",
+      "notes": [],
+      "created_at": 1482299274,
+      "entity": "customer"
+    }
+  ]
+}

data/test/fixtures/delete_token.json

@@ -0,0 +1,3 @@
+{
+   "deleted": true
+}

data/test/fixtures/downtimes_collection.json

@@ -0,0 +1,21 @@
+{
+      "entity": "collection",
+      "count": 1,
+      "items": [
+        {
+          "id": "down_F7LroRQAAFuswd",
+          "entity": "payment.downtime",
+          "method": "card",
+          "begin": 1593196031,
+          "end": null,
+          "status": "started",
+          "scheduled": false,
+          "severity": "high",
+          "instrument": {
+            "issuer": "SBIN"
+          },
+          "created_at": 1593196089,
+          "updated_at": 1593196089
+        }
+      ]
+}

data/test/fixtures/empty.json

@@ -0,0 +1,2 @@
+
+{}

data/test/fixtures/fake_addon.json

@@ -0,0 +1,24 @@
+{
+  "id": "ao_IrSY3UIqDRx7df",
+  "entity": "addon",
+  "item": {
+    "id": "item_00000000000001",
+    "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": "sub_00000000000001",
+  "invoice_id": null
+}