fawry 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a9a9bd2b1674d4f6df24e1b7a8fb187585906fed608c41991613f25f459214
-  data.tar.gz: f1c205a1f9d92c758df8fe13f0a4bcd0bc70ea22106ab380984db00bc1303f6a
+  metadata.gz: 801fa2ec9cada4bf14b44b1733ff0010eae8c26ccc72ed23c500ae0b55ff6e30
+  data.tar.gz: c48087c1e6f133664be53c2e2d28d6a6b228379367eb4817a88e9d2ef9b5a669
 SHA512:
-  metadata.gz: 7d3f2b4b9f111b8f967cbe2a67da12ed9c4683fd99a70e784d14963642b609594f4a2592782e5cfa0d92b8c16cbbe024d70fa99c150a74a0600656bab61057ed
-  data.tar.gz: f65d775062f6a683b855b7d3deb10d8fa99b4f05a4f365bcb6b86312f2375d506f6e7e50f87f91ce517c5878e6b707a1dafc6b873ff0a729f6a101193709e4d1
+  metadata.gz: b721a5d9d20bf0a7c4faccc2d6db668b9c3aae73fbffec5c3a917b9463ac6753b3e28189674d749239f6065f659e938b44c9bd3cb8588d57af83d8cfd114808a
+  data.tar.gz: 97a8f8acf8eb6c41531a8b1ef8d72a26f650d95b0cb9ad5a41deb306f152b0d8d70ece22f4c6284e218de04311d2ba187d434fe3ba07844948428cded4a7feda

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,8 @@
 # Fawry
 A plug-and-play library that makes interfacing with Fawry's payment gateway API a breeze:
-- [Charge customers](https://github.com/amrrbakry/fawry#charge-customers)
-- [Refund customers](https://github.com/amrrbakry/fawry#refund-customers)
-- Get payment status _(Not yet implemented)_
+- [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)_
 
 _Fawry's production and sandbox environments are supported._
@@ -61,6 +61,23 @@ res = Fawry.refund(params, sandbox: true)
 
 res.success? # => true
 ```
+
+###  Get Payment Status
+```ruby
+params = { "merchant_code": 'merchant_code',
+           "merchant_ref_number": 'ssshxb98phmyvm434es62kage3nsm2cj',
+           "fawry_secure_key": 'fawry_secure_key' }
+
+res = Fawry.payment_status(params, sandbox: true)
+ # => #<Fawry::FawryResponse:0x0000559974056898 @type="PaymentStatusResponse", @reference_number="931922417",
+ #                                              @merchant_ref_number="ssshxb98phmyvm434es62kage3nsm2cj",
+ #                                              @expiration_time=1573297736167, @status_code=200,
+ #                                              @status_description="Operation done successfully", @payment_amount=20,
+ #                                              @payment_method="PAYATFAWRY", @payment_status="UNPAID">
+
+res.success? # => true
+res.payment_status # => UNPAID
+```
 ## 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/fawry.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
                         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'

data/lib/fawry.rb

@@ -7,8 +7,10 @@ require 'fawry/fawry_request'
 require 'fawry/fawry_response'
 require 'fawry/requests/charge_request'
 require 'fawry/requests/refund_request'
+require 'fawry/requests/payment_status_request'
 require 'fawry/contracts/charge_request_contract'
 require 'fawry/contracts/refund_request_contract'
+require 'fawry/contracts/payment_status_request_contract'
 
 module Fawry
   class << self
@@ -51,7 +53,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
@@ -79,7 +81,33 @@ 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_code).value(:string)
+    # required(:merchant_ref_number).value(:string)
+    # required(: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::InvalidFawryRequest] 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
   end
 end

data/lib/fawry/connection.rb

@@ -19,6 +19,17 @@ 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
+
       private
 
       def connection
@@ -30,6 +41,21 @@ module Fawry
         @sandbox_connection ||= Faraday.new(url: FAWRY_SANDBOX_BASE_URL, headers: { 'Content-Type': '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
 end

data/lib/fawry/contracts/payment_status_request_contract.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module Fawry
+  module Contracts
+    class PaymentStatusRequestContract < Dry::Validation::Contract
+      params do
+        required(:merchant_code).value(:string)
+        required(:merchant_ref_number).value(:string)
+        required(:fawry_secure_key).value(:string)
+      end
+    end
+  end
+end

data/lib/fawry/fawry_request.rb

@@ -16,6 +16,7 @@ module Fawry
 
     private
 
+    # rubocop:disable Metrics/MethodLength
     def build_request
       case action
       when 'charge'
@@ -26,7 +27,12 @@ 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
       end
+      # rubocop:enable Metrics/MethodLength
     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)
 
@@ -29,6 +29,8 @@ 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],
@@ -46,6 +48,8 @@ module Fawry
           signature: charge_request_signature
         }.compact
       end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
 
       def validate_charge_params!
         contract = Contracts::ChargeRequestContract.new.call(request_params)
@@ -56,12 +60,14 @@ module Fawry
         request_params[:charge_items].each { |hash| hash[:itemId] = hash.delete(:item_id) }
       end
 
+      # rubocop:disable Metrics/AbcSize
       def charge_request_signature
         Digest::SHA256.hexdigest("#{request_params[: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]}")
       end
+      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/fawry/requests/payment_status_request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Fawry
+  module Requests
+    module PaymentStatusRequest
+      def fire_payment_status_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_payment_status_request
+        {
+          path: 'status',
+          params: payment_status_request_transformed_params,
+          body: {},
+          options: options
+        }
+      end
+
+      def request_params
+        @request_params = params
+      end
+
+      def payment_status_request_transformed_params
+        {
+          merchantCode: request_params[:merchant_code],
+          merchantRefNumber: request_params[:merchant_ref_number],
+          signature: payment_status_request_signature
+        }.compact
+      end
+
+      def validate_payment_status_params!
+        contract = Contracts::PaymentStatusRequestContract.new.call(request_params)
+        raise InvalidFawryRequest, 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]}")
+      end
+    end
+  end
+end

data/lib/fawry/requests/refund_request.rb

@@ -5,7 +5,7 @@ require 'digest'
 module Fawry
   module Requests
     module RefundRequest
-      def fire
+      def fire_refund_request
         fawry_api_response = Connection.post(request[:path], request[:params], request[:body], request[:options])
         response_body = JSON.parse(fawry_api_response.body)
 

data/lib/fawry/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fawry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Amr Bakry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -149,11 +149,13 @@ files:
 - lib/fawry.rb
 - lib/fawry/connection.rb
 - lib/fawry/contracts/charge_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_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/version.rb
 homepage: https://github.com/amrrbakry/fawry
@@ -168,9 +170,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="