fawry 1.0.0 → 1.3.1

data/Rakefile

@@ -2,10 +2,17 @@
 
 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

data/fawry.gemspec

@@ -7,14 +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.required_ruby_version = '>= 2.6'
 
   spec.metadata['homepage_uri'] = 'https://github.com/amrrbakry/fawry'
   spec.metadata['source_code_uri'] = 'https://github.com/amrrbakry/fawry'
@@ -32,10 +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 'rspec_junit_formatter'
-  spec.add_development_dependency 'rubocop', '~> 0.76.0'
-  spec.add_development_dependency 'webmock', '~> 3.7', '>= 3.7.6'
+  spec.add_development_dependency 'rubocop', '~> 1.11'
+  spec.add_development_dependency 'webmock', '~> 3.12'
 end

data/lib/fawry.rb

@@ -1,20 +1,33 @@
 # frozen_string_literal: true
 
 require 'fawry/version'
+require 'fawry/utils'
 require 'fawry/connection'
+require 'fawry/config'
 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
+  configure do |config|
+    config.sandbox = false
+    config.fawry_secure_key = nil
+    config.fawry_merchant_code = nil
+  end
+
   class << self
     # Sends a charge request to Fawry API
     # performs param validation and builds
@@ -112,6 +125,92 @@ module Fawry
       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

data/lib/fawry/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Fawry
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :sandbox, :fawry_secure_key, :fawry_merchant_code
+  end
+end

data/lib/fawry/connection.rb

@@ -5,13 +5,16 @@ 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
+      include Utils
+
       def post(path, params, body, options)
-        conn = options[:sandbox] ? sandbox_connection : connection
+        sandbox = Fawry.configuration.sandbox || TRUTH_VALUES.include?(ENV.fetch('FAWRY_SANDBOX', options[:sandbox]))
+        conn =  sandbox ? sandbox_connection : connection
 
         conn.post(path) do |request|
           request.params = params
@@ -20,7 +23,8 @@ module Fawry
       end
 
       def get(path, params, body, options)
-        conn = options[:sandbox] ? sandbox_connection : connection
+        sandbox = Fawry.configuration.sandbox || TRUTH_VALUES.include?(ENV.fetch('FAWRY_SANDBOX', options[:sandbox]))
+        conn =  sandbox ? sandbox_connection : connection
 
         conn.get(path) do |request|
           request.params = params
@@ -30,16 +34,28 @@ module Fawry
         end
       end
 
+      def delete(path, params, body, options)
+        sandbox = Fawry.configuration.sandbox || TRUTH_VALUES.include?(ENV.fetch('FAWRY_SANDBOX', options[:sandbox]))
+        conn =  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

data/lib/fawry/contracts/charge_request_contract.rb

@@ -17,6 +17,7 @@ module Fawry
           required(:price).value(:decimal)
           required(:quantity).value(:integer)
         end
+        optional(:language).value(included_in?: %w[ar-eg en-gb])
         optional(:merchant_code).value(:string)
         optional(:fawry_secure_key).value(:string)
         optional(:currency_code).value(:string)
@@ -39,14 +40,16 @@ module Fawry
       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')
+        if Fawry.configuration.fawry_secure_key.nil? && ENV['FAWRY_SECURE_KEY'].nil? && value.nil?
+          key(:fawry_secure_key).failure('fawry secure key is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_SECURE_KEY), or as an argument to this method')
         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')
+        if Fawry.configuration.fawry_merchant_code.nil? && ENV['FAWRY_MERCHANT_CODE'].nil? && value.nil?
+          key(:merchant_code).failure('fawry merchant code is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_MERCHANT_CODE), or as an argument to this method')
         end
       end
     end

data/lib/fawry/contracts/create_card_token_request_contract.rb

@@ -0,0 +1,33 @@
+# 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 Fawry.configuration.fawry_merchant_code.nil? && ENV['FAWRY_MERCHANT_CODE'].nil? && value.nil?
+          key(:merchant_code).failure('fawry merchant code is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_MERCHANT_CODE), or as an argument to this method')
+        end
+      end
+    end
+  end
+end

data/lib/fawry/contracts/delete_token_request_contract.rb

@@ -0,0 +1,30 @@
+# 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 Fawry.configuration.fawry_secure_key.nil? && ENV['FAWRY_SECURE_KEY'].nil? && value.nil?
+          key(:fawry_secure_key).failure('fawry secure key is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_SECURE_KEY), or as an argument to this method')
+        end
+      end
+
+      rule(:merchant_code) do
+        if Fawry.configuration.fawry_merchant_code.nil? && ENV['FAWRY_MERCHANT_CODE'].nil? && value.nil?
+          key(:merchant_code).failure('fawry merchant code is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_MERCHANT_CODE), or as an argument to this method')
+        end
+      end
+    end
+  end
+end

data/lib/fawry/contracts/list_tokens_request_contract.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module Fawry
+  module Contracts
+    class ListTokensRequestContract < Dry::Validation::Contract
+      params do
+        required(:merchant_code).value(:string)
+        required(:customer_profile_id).value(:string)
+        optional(:fawry_secure_key).value(:string)
+      end
+
+      rule(:fawry_secure_key) do
+        if Fawry.configuration.fawry_secure_key.nil? && ENV['FAWRY_SECURE_KEY'].nil? && value.nil?
+          key(:fawry_secure_key).failure('fawry secure key is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_SECURE_KEY), or as an argument to this method')
+        end
+      end
+
+      rule(:merchant_code) do
+        if Fawry.configuration.fawry_merchant_code.nil? && ENV['FAWRY_MERCHANT_CODE'].nil? && value.nil?
+          key(:merchant_code).failure('fawry merchant code is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_MERCHANT_CODE), or as an argument to this method')
+        end
+      end
+    end
+  end
+end

data/lib/fawry/contracts/payment_status_request_contract.rb

@@ -12,14 +12,16 @@ module Fawry
       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')
+        if Fawry.configuration.fawry_secure_key.nil? && ENV['FAWRY_SECURE_KEY'].nil? && value.nil?
+          key(:fawry_secure_key).failure('fawry secure key is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_SECURE_KEY), or as an argument to this method')
         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')
+        if Fawry.configuration.fawry_merchant_code.nil? && ENV['FAWRY_MERCHANT_CODE'].nil? && value.nil?
+          key(:merchant_code).failure('fawry merchant code is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_MERCHANT_CODE), or as an argument to this method')
         end
       end
     end

data/lib/fawry/contracts/refund_request_contract.rb

@@ -14,14 +14,16 @@ module Fawry
       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')
+        if Fawry.configuration.fawry_secure_key.nil? && ENV['FAWRY_SECURE_KEY'].nil? && value.nil?
+          key(:fawry_secure_key).failure('fawry secure key is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_SECURE_KEY), or as an argument to this method')
         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')
+        if Fawry.configuration.fawry_merchant_code.nil? && ENV['FAWRY_MERCHANT_CODE'].nil? && value.nil?
+          key(:merchant_code).failure('fawry merchant code is required in either Fawry.configuration or'\
+            'as an environment variable (FAWRY_MERCHANT_CODE), or as an argument to this method')
         end
       end
     end

data/lib/fawry/errors.rb

@@ -2,5 +2,6 @@
 
 module Fawry
   class InvalidFawryRequestError < StandardError; end
+
   class InvalidSignatureError < StandardError; end
 end

data/lib/fawry/fawry_callback.rb

@@ -8,7 +8,7 @@ module Fawry
 
     def initialize(callback_params, opts)
       @callback_params = callback_params
-      @fawry_secure_key = ENV.fetch('FAWRY_SECURE_KEY')
+      @fawry_secure_key = Fawry.configuration.fawry_secure_key || ENV.fetch('FAWRY_SECURE_KEY')
       @options = opts
     end