fawry 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 801fa2ec9cada4bf14b44b1733ff0010eae8c26ccc72ed23c500ae0b55ff6e30
-  data.tar.gz: c48087c1e6f133664be53c2e2d28d6a6b228379367eb4817a88e9d2ef9b5a669
+  metadata.gz: 5b36b534916d6923f8bc715652eac726e83e4d5bac78dc5ae3aabb2af08a28d7
+  data.tar.gz: 4cb3e3db3f83c80b130e2de91a43f85f4e489876b90a7f2dbedcf7417b53bbb2
 SHA512:
-  metadata.gz: b721a5d9d20bf0a7c4faccc2d6db668b9c3aae73fbffec5c3a917b9463ac6753b3e28189674d749239f6065f659e938b44c9bd3cb8588d57af83d8cfd114808a
-  data.tar.gz: 97a8f8acf8eb6c41531a8b1ef8d72a26f650d95b0cb9ad5a41deb306f152b0d8d70ece22f4c6284e218de04311d2ba187d434fe3ba07844948428cded4a7feda
+  metadata.gz: e049a63ce51c39786f674160e66b044ff0d72dd1c3e52fe4f0abb7aa829c99b16238f329f9a83e2ae3840609799d80160227b74874b610dd27bba6d9eaad4c84
+  data.tar.gz: 8dc4bd0949b640b3ab99a141938677351ec7c03ccf8c0b8b9297acfdb54b5ade84a97185accc39eb289667789df4fcbd4bcc04f3da34c01acc2466384292d84c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fawry (0.2.0)
+    fawry (0.3.0)
       dry-validation (~> 1.3, >= 1.3.1)
       faraday (~> 0.17.0)
 

data/README.md

@@ -3,7 +3,7 @@ A plug-and-play library that makes interfacing with Fawry's payment gateway API
 - [Charge customers](https://github.com/fawry-api/fawry#charge-customers)
 - [Refund customers](https://github.com/fawry-api/fawry#refund-customers)
 - [Get payment status](https://github.com/fawry-api/fawry#get-payment-status)
-- Parse Fawry's service callback V2 _(Not yet implemented)_
+- [Parse Fawry's service callback V2](https://github.com/fawry-api/fawry#parse-fawry-service-callback-v2)
 
 _Fawry's production and sandbox environments are supported._
 
@@ -78,6 +78,26 @@ res = Fawry.payment_status(params, sandbox: true)
 res.success? # => true
 res.payment_status # => UNPAID
 ```
+
+###  Parse Fawry service callback v2
+```ruby
+callback_params = { "requestId": 'c72827d084ea4b88949d91dd2db4996e', "fawryRefNumber": '970177',
+                    "merchantRefNumber": '9708f1cea8b5426cb57922df51b7f790',
+                    "customerMobile": '01004545545', "customerMail": 'fawry@fawry.com',
+                    "paymentAmount": 152.00, "orderAmount": 150.00, "fawryFees": 2.00,
+                    "shippingFees": '', "orderStatus": 'NEW', "paymentMethod": 'PAYATFAWRY',
+                    "messageSignature": 'b0175565323e464b01dc9407160368af5568196997fb6e379374a4f4fbbcf587',
+                    "orderExpiryDate": 1_533_554_719_314,
+                    "orderItems": [{ "itemCode": 'e6aacbd5a498487ab1a10ae71061535d', "price": 150.0, "quantity": 1 }] }
+
+fawry_callback = Fawry.parse_callback(callback_params, 'fawry_secure_key')
+# <Fawry::FawryCallback:0x000056339ac43730 @request_id="c72827d084ea4b88949d91dd2db4996e", @fawry_ref_number="970177",
+#                                          @merchant_ref_number="9708f1cea8b5426cb57922df51b7f790", @customer_mobile="01004545545",
+#                                          @customer_mail="fawry@fawry.com", @order_status="NEW", @order_amount=150.0, @fawry_fees=2.0, ...>
+
+fawry_callback.fawry_ref_number # => 970177
+fawry_callback.order_status # => NEW
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/fawry.rb

@@ -3,8 +3,10 @@
 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'
@@ -45,7 +47,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
     #
@@ -73,7 +75,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
     #
@@ -99,7 +101,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
     #
@@ -109,5 +111,25 @@ module Fawry
     def payment_status(params, opts = {})
       FawryRequest.new('payment_status', params, opts).fire_payment_status_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, fawry_secure_key, opts = {})
+      FawryCallback.new(params, fawry_secure_key, opts).parse
+    end
   end
 end

data/lib/fawry/errors.rb

@@ -1,5 +1,6 @@
 # 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, fawry_secure_key, opts)
+      @callback_params = callback_params
+      @fawry_secure_key = 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_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

@@ -53,7 +53,7 @@ module Fawry
 
       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

data/lib/fawry/requests/payment_status_request.rb

@@ -37,7 +37,7 @@ module Fawry
 
       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

data/lib/fawry/requests/refund_request.rb

@@ -39,7 +39,7 @@ module Fawry
 
       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

data/lib/fawry/utils.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Fawry
+  module Utils
+    # 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.keys.each 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 = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fawry
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Amr Bakry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -152,11 +152,13 @@ files:
 - 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/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: