fawry 0.1.0 → 1.2.1

data/lib/fawry/contracts/list_tokens_request_contract.rb

@@ -0,0 +1,27 @@
+# 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 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/payment_status_request_contract.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module Fawry
+  module Contracts
+    class PaymentStatusRequestContract < Dry::Validation::Contract
+      params do
+        required(:merchant_ref_number).value(:string)
+        optional(:merchant_code).value(:string)
+        optional(:fawry_secure_key).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

data/lib/fawry/contracts/refund_request_contract.rb

@@ -6,12 +6,24 @@ module Fawry
   module Contracts
     class RefundRequestContract < Dry::Validation::Contract
       params do
-        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)
       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/errors.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module Fawry
-  class InvalidFawryRequest < StandardError; end
+  class InvalidFawryRequestError < StandardError; end
+
+  class InvalidSignatureError < StandardError; end
 end

data/lib/fawry/fawry_callback.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Fawry
+  class FawryCallback
+    include Utils
+
+    attr_reader :callback_params, :fawry_secure_key, :options
+
+    def initialize(callback_params, opts)
+      @callback_params = callback_params
+      @fawry_secure_key = ENV.fetch('FAWRY_SECURE_KEY')
+      @options = opts
+    end
+
+    def parse
+      verify_callback_signature!
+      build_callback
+
+      self
+    end
+
+    private
+
+    # Adds keys from fawry API response as methods
+    # on FawryCallback 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_callback = FawryCallback.new(callback_params, fawry_secure_key)
+    # fawry_callback.order_status => PAID
+    # fawry_callback.fawry_ref_number => 1234567
+    def build_callback
+      enrich_object(callback_params)
+    end
+
+    def verify_callback_signature!
+      raise InvalidSignatureError, 'Invalid Signature' unless signature == callback_params[:messageSignature]
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def signature
+      Digest::SHA256.hexdigest("#{callback_params[:fawryRefNumber]}#{callback_params[:merchantRefNum]}"\
+                               "#{format('%<paymentAmount>.2f', paymentAmount: callback_params[:paymentAmount])}"\
+                               "#{format('%<orderAmount>.2f', orderAmount: callback_params[:orderAmount])}"\
+                               "#{callback_params[:orderStatus]}#{callback_params[:paymentMethod]}"\
+                               "#{callback_params[:paymentRefrenceNumber]}#{fawry_secure_key}")
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/fawry/fawry_request.rb

@@ -16,6 +16,8 @@ module Fawry
 
     private
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def build_request
       case action
       when 'charge'
@@ -26,7 +28,25 @@ module Fawry
         self.class.include Requests::RefundRequest
         validate_refund_params!
         @request = build_refund_request
+      when 'payment_status'
+        self.class.include Requests::PaymentStatusRequest
+        validate_payment_status_params!
+        @request = build_payment_status_request
+      when 'create_card_token'
+        self.class.include Requests::CreateCardTokenRequest
+        validate_card_token_params!
+        @request = build_create_card_token_request
+      when 'list_tokens'
+        self.class.include Requests::ListTokensRequest
+        validate_list_tokens_params!
+        @request = build_list_tokens_request
+      when 'delete_token'
+        self.class.include Requests::DeleteTokenRequest
+        validate_delete_token_params!
+        @request = build_delete_token_request
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/fawry/fawry_response.rb

@@ -2,6 +2,8 @@
 
 module Fawry
   class FawryResponse
+    include Utils
+
     attr_reader :fawry_api_response
 
     def initialize(fawry_api_response)
@@ -39,13 +41,7 @@ module Fawry
     # fawry_res.status_code => 200
     # fawry_res.reference_number => 1234567
     def build_response
-      fawry_api_response.keys.each do |key|
-        method_name = key.split(/(?=[A-Z])/).map(&:downcase).join('_') # statusCode => status_code
-        instance_variable_set("@#{method_name}", fawry_api_response[key])
-        method_body = proc { instance_variable_get("@#{method_name}") }
-
-        self.class.public_send(:define_method, method_name, method_body)
-      end
+      enrich_object(fawry_api_response)
     end
   end
 end

data/lib/fawry/requests/charge_request.rb

@@ -7,7 +7,7 @@ module Fawry
     module ChargeRequest
       DEFAULTS = { payment_method: 'PAYATFAWRY', currency_code: 'EGP' }.freeze
 
-      def fire
+      def fire_charge_request
         fawry_api_response = Connection.post(request[:path], request[:params], request[:body], request[:options])
         response_body = JSON.parse(fawry_api_response.body)
 
@@ -18,7 +18,7 @@ module Fawry
 
       def build_charge_request
         {
-          path: 'charge',
+          path: 'payments/charge',
           params: {},
           body: charge_request_transformed_params,
           options: options
@@ -29,9 +29,11 @@ module Fawry
         @request_params ||= DEFAULTS.merge(params)
       end
 
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
       def charge_request_transformed_params
         {
-          merchantCode: request_params[:merchant_code],
+          merchantCode: fawry_merchant_code,
           merchantRefNum: request_params[:merchant_ref_num],
           customerProfileId: request_params[:customer_profile_id],
           cardToken: request_params[:card_token],
@@ -46,10 +48,20 @@ module Fawry
           signature: charge_request_signature
         }.compact
       end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      def fawry_merchant_code
+        ENV.fetch('FAWRY_MERCHANT_CODE') { request_params[:merchant_code] }
+      end
+
+      def fawry_secure_key
+        ENV.fetch('FAWRY_SECURE_KEY') { request_params[:fawry_secure_key] }
+      end
 
       def validate_charge_params!
         contract = Contracts::ChargeRequestContract.new.call(request_params)
-        raise InvalidFawryRequest, contract.errors.to_h if contract.failure?
+        raise InvalidFawryRequestError, contract.errors.to_h if contract.failure?
       end
 
       def charge_items
@@ -57,10 +69,10 @@ module Fawry
       end
 
       def charge_request_signature
-        Digest::SHA256.hexdigest("#{request_params[:merchant_code]}#{request_params[:merchant_ref_num]}"\
+        Digest::SHA256.hexdigest("#{fawry_merchant_code}#{request_params[:merchant_ref_num]}"\
                                  "#{request_params[:customer_profile_id]}#{request_params[:payment_method]}"\
                                  "#{format('%<amount>.2f', amount: request_params[:amount])}"\
-                                 "#{request_params[:card_token]}#{request_params[:fawry_secure_key]}")
+                                 "#{request_params[:card_token]}#{fawry_secure_key}")
       end
     end
   end

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
+        ENV.fetch('FAWRY_MERCHANT_CODE') { create_card_token_request[:merchant_code] }
+      end
+
+      def fawry_secure_key
+        ENV.fetch('FAWRY_SECURE_KEY') { create_card_token_request[: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
+        ENV.fetch('FAWRY_MERCHANT_CODE') { request_params[:merchant_code] }
+      end
+
+      def 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
+        ENV.fetch('FAWRY_MERCHANT_CODE') { request_params[:merchant_code] }
+      end
+
+      def 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