fawry 0.2.0 → 1.3.0

data/lib/fawry/requests/create_card_token_request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Fawry
+  module Requests
+    module CreateCardTokenRequest
+      def fire_create_card_token_request
+        fawry_api_response = Connection.post(request[:path], request[:params], request[:body], request[:options])
+        response_body = JSON.parse(fawry_api_response.body)
+
+        FawryResponse.new(response_body)
+      end
+
+      private
+
+      def build_create_card_token_request
+        {
+          path: 'cards/cardToken',
+          params: {},
+          body: create_card_token_request_transformed_params,
+          options: options
+        }
+      end
+
+      def create_card_token_request
+        @create_card_token_request ||= params
+      end
+
+      def create_card_token_request_transformed_params
+        {
+          merchantCode: fawry_merchant_code,
+          customerProfileId: create_card_token_request[:customer_profile_id],
+          customerMobile: create_card_token_request[:customer_mobile],
+          customerEmail: create_card_token_request[:customer_email],
+          cardNumber: create_card_token_request[:card_number],
+          expiryYear: create_card_token_request[:expiry_year],
+          expiryMonth: create_card_token_request[:expiry_month],
+          cvv: create_card_token_request[:cvv]
+        }.compact
+      end
+
+      def fawry_merchant_code
+        Fawry.configuration.fawry_merchant_code || ENV.fetch('FAWRY_MERCHANT_CODE') { request_params[:merchant_code] }
+      end
+
+      def fawry_secure_key
+        Fawry.configuration.fawry_secure_key || ENV.fetch('FAWRY_SECURE_KEY') { request_params[:fawry_secure_key] }
+      end
+
+      def validate_card_token_params!
+        contract = Contracts::CreateCardTokenRequestContract.new.call(create_card_token_request)
+        raise InvalidFawryRequestError, contract.errors.to_h if contract.failure?
+      end
+    end
+  end
+end

data/lib/fawry/requests/delete_token_request.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Fawry
+  module Requests
+    module DeleteTokenRequest
+      def fire_delete_token_request
+        fawry_api_response = Connection.delete(request[:path], request[:params], request[:body], request[:options])
+        response_body = JSON.parse(fawry_api_response.body)
+
+        FawryResponse.new(response_body)
+      end
+
+      private
+
+      def build_delete_token_request
+        {
+          path: 'cards/cardToken',
+          params: {},
+          body: delete_token_request_transformed_params,
+          options: options
+        }
+      end
+
+      def request_params
+        @request_params = params
+      end
+
+      def delete_token_request_transformed_params
+        {
+          merchantCode: fawry_merchant_code,
+          customerProfileId: request_params[:customer_profile_id],
+          signature: delete_token_request_signature,
+          cardToken: request_params[:card_token]
+        }.compact
+      end
+
+      def fawry_merchant_code
+        Fawry.configuration.fawry_merchant_code || ENV.fetch('FAWRY_MERCHANT_CODE') { request_params[:merchant_code] }
+      end
+
+      def fawry_secure_key
+        Fawry.configuration.fawry_secure_key || ENV.fetch('FAWRY_SECURE_KEY') { request_params[:fawry_secure_key] }
+      end
+
+      def card_token
+        request_params[:card_token]
+      end
+
+      def validate_delete_token_params!
+        contract = Contracts::ListTokensRequestContract.new.call(request_params)
+        raise InvalidFawryRequestError, contract.errors.to_h if contract.failure?
+      end
+
+      def delete_token_request_signature
+        Digest::SHA256.hexdigest("#{fawry_merchant_code}#{request_params[:customer_profile_id]}"\
+                                 "#{card_token}#{fawry_secure_key}")
+      end
+    end
+  end
+end

data/lib/fawry/requests/list_tokens_request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Fawry
+  module Requests
+    module ListTokensRequest
+      def fire_list_tokens_request
+        fawry_api_response = Connection.get(request[:path], request[:params], request[:body], request[:options])
+        response_body = JSON.parse(fawry_api_response.body)
+
+        FawryResponse.new(response_body)
+      end
+
+      private
+
+      def build_list_tokens_request
+        {
+          path: 'cards/cardToken',
+          params: list_tokens_request_transformed_params,
+          body: {},
+          options: options
+        }
+      end
+
+      def request_params
+        @request_params = params
+      end
+
+      def list_tokens_request_transformed_params
+        {
+          merchantCode: fawry_merchant_code,
+          customerProfileId: request_params[:customer_profile_id],
+          signature: list_tokens_request_signature
+        }.compact
+      end
+
+      def fawry_merchant_code
+        Fawry.configuration.fawry_merchant_code || ENV.fetch('FAWRY_MERCHANT_CODE') { request_params[:merchant_code] }
+      end
+
+      def fawry_secure_key
+        Fawry.configuration.fawry_secure_key || ENV.fetch('FAWRY_SECURE_KEY') { request_params[:fawry_secure_key] }
+      end
+
+      def validate_list_tokens_params!
+        contract = Contracts::ListTokensRequestContract.new.call(request_params)
+        raise InvalidFawryRequestError, contract.errors.to_h if contract.failure?
+      end
+
+      def list_tokens_request_signature
+        Digest::SHA256.hexdigest("#{fawry_merchant_code}#{request_params[:customer_profile_id]}"\
+                                 "#{fawry_secure_key}")
+      end
+    end
+  end
+end

data/lib/fawry/requests/payment_status_request.rb

@@ -16,7 +16,7 @@ module Fawry
 
       def build_payment_status_request
         {
-          path: 'status',
+          path: 'payments/status',
           params: payment_status_request_transformed_params,
           body: {},
           options: options
@@ -29,20 +29,28 @@ module Fawry
 
       def payment_status_request_transformed_params
         {
-          merchantCode: request_params[:merchant_code],
+          merchantCode: fawry_merchant_code,
           merchantRefNumber: request_params[:merchant_ref_number],
           signature: payment_status_request_signature
         }.compact
       end
 
+      def fawry_merchant_code
+        Fawry.configuration.fawry_merchant_code || ENV.fetch('FAWRY_MERCHANT_CODE') { request_params[:merchant_code] }
+      end
+
+      def fawry_secure_key
+        Fawry.configuration.fawry_secure_key || ENV.fetch('FAWRY_SECURE_KEY') { request_params[:fawry_secure_key] }
+      end
+
       def validate_payment_status_params!
         contract = Contracts::PaymentStatusRequestContract.new.call(request_params)
-        raise InvalidFawryRequest, contract.errors.to_h if contract.failure?
+        raise InvalidFawryRequestError, contract.errors.to_h if contract.failure?
       end
 
       def payment_status_request_signature
-        Digest::SHA256.hexdigest("#{request_params[:merchant_code]}#{request_params[:merchant_ref_number]}"\
-                                 "#{request_params[:fawry_secure_key]}")
+        Digest::SHA256.hexdigest("#{fawry_merchant_code}#{request_params[:merchant_ref_number]}"\
+                                 "#{fawry_secure_key}")
       end
     end
   end

data/lib/fawry/requests/refund_request.rb

@@ -16,7 +16,7 @@ module Fawry
 
       def build_refund_request
         {
-          path: 'refund',
+          path: 'payments/refund',
           params: {},
           body: refund_request_transformed_params,
           options: options
@@ -29,7 +29,7 @@ module Fawry
 
       def refund_request_transformed_params
         {
-          merchantCode: request_params[:merchant_code],
+          merchantCode: fawry_merchant_code,
           referenceNumber: request_params[:reference_number],
           refundAmount: request_params[:refund_amount],
           reason: request_params[:reason],
@@ -37,15 +37,23 @@ module Fawry
         }.compact
       end
 
+      def fawry_merchant_code
+        Fawry.configuration.fawry_merchant_code || ENV.fetch('FAWRY_MERCHANT_CODE') { request_params[:merchant_code] }
+      end
+
+      def fawry_secure_key
+        Fawry.configuration.fawry_secure_key || ENV.fetch('FAWRY_SECURE_KEY') { request_params[:fawry_secure_key] }
+      end
+
       def validate_refund_params!
         contract = Contracts::RefundRequestContract.new.call(request_params)
-        raise InvalidFawryRequest, contract.errors.to_h if contract.failure?
+        raise InvalidFawryRequestError, contract.errors.to_h if contract.failure?
       end
 
       def refund_request_signature
-        Digest::SHA256.hexdigest("#{request_params[:merchant_code]}#{request_params[:reference_number]}"\
+        Digest::SHA256.hexdigest("#{fawry_merchant_code}#{request_params[:reference_number]}"\
                                  "#{format('%<refund_amount>.2f', refund_amount: request_params[:refund_amount])}"\
-                                 "#{request_params[:reason]}#{request_params[:fawry_secure_key]}")
+                                 "#{request_params[:reason]}#{fawry_secure_key}")
       end
     end
   end

data/lib/fawry/utils.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Fawry
+  module Utils
+    TRUTH_VALUES = [true, 'true', '1', 't'].freeze
+
+    # Adds keys from fawry API response as methods
+    # on object instance that return the value
+    # of each key
+    #
+    # type => type
+    # referenceNumber => reference_number
+    # merchantRefNumber => merchant_ref_number
+    # expirationTime => expiration_time
+    # statusCode => status_code
+    # statusDescription => status_description
+    #
+    # fawry_res = FawryResponse.new(response)
+    # fawry_res.status_code => 200
+    # fawry_res.reference_number => 1234567
+    def enrich_object(fawry_params)
+      fawry_params.each_key do |key|
+        method_name = key.to_s.split(/(?=[A-Z])/).map(&:downcase).join('_') # statusCode => status_code
+        instance_variable_set("@#{method_name}", fawry_params[key])
+        method_body = proc { instance_variable_get("@#{method_name}") }
+
+        self.class.public_send(:define_method, method_name, method_body)
+      end
+    end
+  end
+end

data/lib/fawry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fawry
-  VERSION = '0.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fawry
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.3.0
 platform: ruby
 authors:
-- Amr Bakry
-autorequire: 
+- Amr El Bakry
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -65,9 +65,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -75,23 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,56 +101,90 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-    - - ">="
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
-description: 
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description:
 email:
-- amrrbakry17@gmail.com
+- amrr@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- README-ar.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - fawry.gemspec
 - lib/fawry.rb
+- lib/fawry/config.rb
 - lib/fawry/connection.rb
 - lib/fawry/contracts/charge_request_contract.rb
+- lib/fawry/contracts/create_card_token_request_contract.rb
+- lib/fawry/contracts/delete_token_request_contract.rb
+- lib/fawry/contracts/list_tokens_request_contract.rb
 - lib/fawry/contracts/payment_status_request_contract.rb
 - lib/fawry/contracts/refund_request_contract.rb
 - lib/fawry/errors.rb
+- lib/fawry/fawry_callback.rb
 - lib/fawry/fawry_request.rb
 - lib/fawry/fawry_response.rb
 - lib/fawry/requests/charge_request.rb
+- lib/fawry/requests/create_card_token_request.rb
+- lib/fawry/requests/delete_token_request.rb
+- lib/fawry/requests/list_tokens_request.rb
 - lib/fawry/requests/payment_status_request.rb
 - lib/fawry/requests/refund_request.rb
+- lib/fawry/utils.rb
 - lib/fawry/version.rb
 homepage: https://github.com/amrrbakry/fawry
 licenses:
@@ -164,13 +192,13 @@ licenses:
 metadata:
   homepage_uri: https://github.com/amrrbakry/fawry
   source_code_uri: https://github.com/amrrbakry/fawry
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -179,8 +207,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A library to interface with Fawry's payment gateway API (charge, refund,
   payment status, service callback).