fawry 0.1.0 → 1.2.1

data/Rakefile

@@ -2,7 +2,24 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-task default: :spec
+task default: :rspec_rubocop
+
+task :rspec_rubocop do
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec'].invoke
+end
+
+desc 'Start a console session with Fawry gem loaded'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'fawry'
+
+  ARGV.clear
+  IRB.start
+end

data/fawry.gemspec

@@ -7,13 +7,14 @@ require 'fawry/version'
 Gem::Specification.new do |spec|
   spec.name          = 'fawry'
   spec.version       = Fawry::VERSION
-  spec.authors       = ['Amr Bakry']
-  spec.email         = ['amrrbakry17@gmail.com']
+  spec.authors       = ['Amr El Bakry']
+  spec.email         = ['amrr@hey.com']
 
   spec.summary       = "A library to interface with Fawry's payment gateway API (charge, refund, payment status,
                         service callback)."
   spec.homepage      = 'https://github.com/amrrbakry/fawry'
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.6'
 
   spec.metadata['homepage_uri'] = 'https://github.com/amrrbakry/fawry'
   spec.metadata['source_code_uri'] = 'https://github.com/amrrbakry/fawry'
@@ -31,8 +32,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '~> 0.17.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'byebug', '~> 11.0', '>= 11.0.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.7', '>= 3.7.6'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop', '~> 1.11'
+  spec.add_development_dependency 'webmock', '~> 3.12'
 end

data/lib/fawry.rb

@@ -3,12 +3,22 @@
 require 'fawry/version'
 require 'fawry/connection'
 require 'fawry/errors'
+require 'fawry/utils'
 require 'fawry/fawry_request'
 require 'fawry/fawry_response'
+require 'fawry/fawry_callback'
 require 'fawry/requests/charge_request'
 require 'fawry/requests/refund_request'
+require 'fawry/requests/payment_status_request'
+require 'fawry/requests/create_card_token_request'
+require 'fawry/requests/list_tokens_request'
+require 'fawry/requests/delete_token_request'
 require 'fawry/contracts/charge_request_contract'
 require 'fawry/contracts/refund_request_contract'
+require 'fawry/contracts/payment_status_request_contract'
+require 'fawry/contracts/create_card_token_request_contract'
+require 'fawry/contracts/list_tokens_request_contract'
+require 'fawry/contracts/delete_token_request_contract'
 
 module Fawry
   class << self
@@ -17,19 +27,19 @@ module Fawry
     # the request signature
     #
     # @param params [Hash] list of params to send to fawry
-    # required(:merchant_code).value(:string)
     # required(:merchant_ref_num).value(:string)
     # required(:customer_profile_id).value(:string)
     # required(:amount).value(:decimal)
     # required(:description).value(:string)
     # required(:customer_mobile).value(:string)
-    # required(:fawry_secure_key).value(:string)
     # required(:charge_items).array(:hash) do
     #   required(:item_id).value(:string)
     #   required(:description).value(:string)
     #   required(:price).value(:decimal)
     #   required(:quantity).value(:integer)
     # end
+    # optional(:merchant_code).value(:string)
+    # optional(:fawry_secure_key).value(:string)
     # optional(:currency_code).value(:string)
     # optional(:card_token).value(:string)
     # optional(:customer_email).value(:string)
@@ -43,7 +53,7 @@ module Fawry
     # false by default
     # Example: `Fawry.charge(params, sandbox: true)`
     #
-    # @raise [Fawry::InvalidFawryRequest] raised when one
+    # @raise [Fawry::InvalidFawryRequestError] raised when one
     # or more of the params are invalid. the message
     # specifices which params and why are they invalid
     #
@@ -51,7 +61,7 @@ module Fawry
     # has Fawry API response keys as instance methods
     # plus some convenience methods e.g. success?
     def charge(params, opts = {})
-      FawryRequest.new('charge', params, opts).fire
+      FawryRequest.new('charge', params, opts).fire_charge_request
     end
 
     # Sends a refund request to Fawry API
@@ -59,10 +69,10 @@ module Fawry
     # the request signature
     #
     # @param params [Hash] list of params to send to fawry
-    # required(:merchant_code).value(:string)
     # required(:reference_number).value(:string)
     # required(:refund_amount).value(:decimal)
-    # required(:fawry_secure_key).value(:string)
+    # optional(:merchant_code).value(:string)
+    # optional(:fawry_secure_key).value(:string)
     # optional(:reason).value(:string)
     #
     # @param opts [Hash] list of options to
@@ -71,7 +81,7 @@ module Fawry
     # send the request to fawry sandbox env or not
     # false by default
     #
-    # @raise [Fawry::InvalidFawryRequest] raised when one
+    # @raise [Fawry::InvalidFawryRequestError] raised when one
     # or more of the params are invalid. the message
     # specifices which params and why are they invalid
     #
@@ -79,7 +89,139 @@ module Fawry
     # has Fawry API response keys as instance methods
     # plus some convenience methods e.g. success?
     def refund(params, opts = {})
-      FawryRequest.new('refund', params, opts).fire
+      FawryRequest.new('refund', params, opts).fire_refund_request
+    end
+
+    # Sends a payment status request to Fawry API
+    # performs param validation and builds
+    # the request signature
+    #
+    # @param params [Hash] list of params to send to fawry
+    # required(:merchant_ref_number).value(:string)
+    # optional(:merchant_code).value(:string)
+    # optional(:fawry_secure_key).value(:string)
+    #
+    # @param opts [Hash] list of options to
+    # configure the request
+    # @option opts :sandbox [Boolean] whether to
+    # send the request to fawry sandbox env or not
+    # false by default
+    #
+    # @raise [Fawry::InvalidFawryRequestError] raised when one
+    # or more of the params are invalid. the message
+    # specifices which params and why are they invalid
+    #
+    # @return [Fawry::FawryResponse] an object that
+    # has Fawry API response keys as instance methods
+    # plus some convenience methods e.g. success?
+    def payment_status(params, opts = {})
+      FawryRequest.new('payment_status', params, opts).fire_payment_status_request
+    end
+
+    # Sends a card token request to Fawry API
+    # performs param validation and builds
+    # the request signature
+    #
+    # @param params [Hash] list of params to send to fawry
+    # required(:customer_profile_id).value(:string)
+    # required(:customer_mobile).value(:string)
+    # required(:merchant_code).value(:string)
+    # required(:customer_email).value(:string)
+    # required(:card_number).value(:string)
+    # required(:expiry_year).value(:string)
+    # required(:expiry_month).value(:string)
+    # required(:cvv).value(:string)
+    #
+    # @param opts [Hash] list of options to
+    # configure the request
+    # @option opts :sandbox [Boolean] whether to
+    # send the request to fawry sandbox env or not
+    # false by default
+    #
+    # @raise [Fawry::InvalidFawryRequestError] raised when one
+    # or more of the params are invalid. the message
+    # specifices which params and why are they invalid
+    #
+    # @return [Fawry::FawryResponse] an object that
+    # has Fawry API response keys as instance methods
+    # plus some convenience methods e.g. success?
+
+    def create_card_token(params, opts = {})
+      FawryRequest.new('create_card_token', params, opts).fire_create_card_token_request
+    end
+
+    # Sends a list tokens request to Fawry API
+    # performs param validation and builds
+    # the request signature
+    #
+    # @param params [Hash] list of params to send to fawry
+    # required(:merchant_code).value(:string)
+    # required(:customer_profile_id).value(:string)
+    # optional(:fawry_secure_key).value(:string)
+    #
+    # @param opts [Hash] list of options to
+    # configure the request
+    # @option opts :sandbox [Boolean] whether to
+    # send the request to fawry sandbox env or not
+    # false by default
+    #
+    # @raise [Fawry::InvalidFawryRequestError] raised when one
+    # or more of the params are invalid. the message
+    # specifices which params and why are they invalid
+    #
+    # @return [Fawry::FawryResponse] an object that
+    # has Fawry API response keys as instance methods
+    # plus some convenience methods e.g. success?
+
+    def list_tokens(params, opts = {})
+      FawryRequest.new('list_tokens', params, opts).fire_list_tokens_request
+    end
+
+    # Sends delete token request to Fawry API
+    # performs param validation and builds
+    # the request signature
+    #
+    # @param params [Hash] list of params to send to fawry
+    # required(:customer_profile_id).value(:string)
+    # optional(:merchant_code).value(:string)
+    # optional(:fawry_secure_key).value(:string)
+    #
+    # @param opts [Hash] list of options to
+    # configure the request
+    # @option opts :sandbox [Boolean] whether to
+    # send the request to fawry sandbox env or not
+    # false by default
+    #
+    # @raise [Fawry::InvalidFawryRequestError] raised when one
+    # or more of the params are invalid. the message
+    # specifices which params and why are they invalid
+    #
+    # @return [Fawry::FawryResponse] an object that
+    # has Fawry API response keys as instance methods
+    # plus some convenience methods e.g. success?
+
+    def delete_token(params, opts = {})
+      FawryRequest.new('delete_token', params, opts).fire_delete_token_request
+    end
+
+    # Parses Fawry callback v2 into
+    # FawryCallback object with callback
+    # params as instance methods
+    #
+    # @param params [Hash] list of params sent
+    # from fawry server callback
+    #
+    # @param opts [Hash] list of options to
+    # configure the request. currently no
+    # options available
+    #
+    # @raise [Fawry::InvalidSignatureError] raised when
+    # request signature cannot be verified
+    #
+    # @return [Fawry::FawryCallback] an object that
+    # has Fawry server callback params' keys as instance methods
+    def parse_callback(params, opts = {})
+      FawryCallback.new(params, opts).parse
     end
   end
 end

data/lib/fawry/connection.rb

@@ -5,9 +5,9 @@ require 'json'
 
 module Fawry
   class Connection
-    FAWRY_BASE_URL = 'https://www.atfawry.com/ECommerceWeb/Fawry/payments/'
+    FAWRY_BASE_URL = 'https://www.atfawry.com/ECommerceWeb/Fawry/'
 
-    FAWRY_SANDBOX_BASE_URL = 'https://atfawry.fawrystaging.com//ECommerceWeb/Fawry/payments/'
+    FAWRY_SANDBOX_BASE_URL = 'https://atfawry.fawrystaging.com//ECommerceWeb/Fawry/'
 
     class << self
       def post(path, params, body, options)
@@ -19,16 +19,53 @@ module Fawry
         end
       end
 
+      def get(path, params, body, options)
+        conn = options[:sandbox] ? sandbox_connection : connection
+
+        conn.get(path) do |request|
+          request.params = params
+          request.body = body.to_json
+          # Fawry doesn't understand encoded params
+          request.options = request.options.merge(params_encoder: ParamsSpecialEncoder)
+        end
+      end
+
+      def delete(path, params, body, options)
+        conn = options[:sandbox] ? sandbox_connection : connection
+
+        conn.delete(path) do |request|
+          request.params = params
+          request.body = body.to_json
+          # Fawry doesn't understand encoded params
+          request.options = request.options.merge(params_encoder: ParamsSpecialEncoder)
+        end
+      end
+
       private
 
       def connection
         @connection ||= Faraday.new(url: FAWRY_BASE_URL, headers: { 'Content-Type': 'application/json',
-                                                                    'Accept': 'application/json' })
+                                                                    Accept: 'application/json' })
       end
 
       def sandbox_connection
         @sandbox_connection ||= Faraday.new(url: FAWRY_SANDBOX_BASE_URL, headers: { 'Content-Type': 'application/json',
-                                                                                    'Accept': 'application/json' })
+                                                                                    Accept: 'application/json' })
+      end
+
+      # Fawry does not understand encoded params
+      # so we use this encoder to convert the params
+      # hash to a string of query params without encoding
+      # { a: 1, b: 2 } => a=1&b=2
+      class ParamsSpecialEncoder
+        def self.encode(hash)
+          hash.each_with_object([]) { |(k, v), arr| arr << "#{k}=#{v}" }.join('&')
+        end
+
+        def self.decode(string)
+          arr = string.split('&')
+          arr.map { |str| str.split('=') }.to_h
+        end
       end
     end
   end

data/lib/fawry/contracts/charge_request_contract.rb

@@ -6,19 +6,19 @@ module Fawry
   module Contracts
     class ChargeRequestContract < Dry::Validation::Contract
       params do
-        required(:merchant_code).value(:string)
         required(:merchant_ref_num).value(:string)
         required(:customer_profile_id).value(:string)
         required(:amount).value(:decimal)
         required(:description).value(:string)
         required(:customer_mobile).value(:string)
-        required(:fawry_secure_key).value(:string)
         required(:charge_items).array(:hash) do
           required(:item_id).value(:string)
           required(:description).value(:string)
           required(:price).value(:decimal)
           required(:quantity).value(:integer)
         end
+        optional(:merchant_code).value(:string)
+        optional(:fawry_secure_key).value(:string)
         optional(:currency_code).value(:string)
         optional(:card_token).value(:string)
         optional(:customer_email).value(:string)
@@ -37,6 +37,18 @@ module Fawry
           key.failure('card_token is required when payment_method is CARD')
         end
       end
+
+      rule(:fawry_secure_key) do
+        if ENV['FAWRY_SECURE_KEY'].nil? && value.nil?
+          key(:fawry_secure_key).failure('fawry secure key is required as a param or an env var')
+        end
+      end
+
+      rule(:merchant_code) do
+        if ENV['FAWRY_MERCHANT_CODE'].nil? && value.nil?
+          key(:merchant_code).failure('fawry merchant code is required as a param or an env var')
+        end
+      end
     end
   end
 end

data/lib/fawry/contracts/create_card_token_request_contract.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module Fawry
+  module Contracts
+    class CreateCardTokenRequestContract < Dry::Validation::Contract
+      params do
+        required(:customer_profile_id).value(:string)
+        required(:customer_mobile).value(:string)
+        required(:merchant_code).value(:string)
+        required(:customer_email).value(:string)
+        required(:card_number).value(:string)
+        required(:expiry_year).value(:string)
+        required(:expiry_month).value(:string)
+        required(:cvv).value(:string)
+      end
+
+      rule(:customer_email) do
+        unless /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i.match?(value)
+          key? && key.failure('has invalid format')
+        end
+      end
+
+      rule(:merchant_code) do
+        if ENV['FAWRY_MERCHANT_CODE'].nil? && value.nil?
+          key(:merchant_code).failure('fawry merchant code is required as a param or an env var')
+        end
+      end
+    end
+  end
+end

data/lib/fawry/contracts/delete_token_request_contract.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module Fawry
+  module Contracts
+    class DeleteTokenRequestContract < Dry::Validation::Contract
+      params do
+        required(:merchant_code).value(:string)
+        required(:customer_profile_id).value(:string)
+        required(:fawry_secure_key).value(:string)
+        required(:card_token).value(:string)
+      end
+
+      rule(:fawry_secure_key) do
+        if ENV['FAWRY_SECURE_KEY'].nil? && value.nil?
+          key(:fawry_secure_key).failure('fawry secure key is required as a param or an env var')
+        end
+      end
+
+      rule(:merchant_code) do
+        if ENV['FAWRY_MERCHANT_CODE'].nil? && value.nil?
+          key(:merchant_code).failure('fawry merchant code is required as a param or an env var')
+        end
+      end
+    end
+  end
+end