fawry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35a9a9bd2b1674d4f6df24e1b7a8fb187585906fed608c41991613f25f459214
+  data.tar.gz: f1c205a1f9d92c758df8fe13f0a4bcd0bc70ea22106ab380984db00bc1303f6a
+SHA512:
+  metadata.gz: 7d3f2b4b9f111b8f967cbe2a67da12ed9c4683fd99a70e784d14963642b609594f4a2592782e5cfa0d92b8c16cbbe024d70fa99c150a74a0600656bab61057ed
+  data.tar.gz: f65d775062f6a683b855b7d3deb10d8fa99b4f05a4f365bcb6b86312f2375d506f6e7e50f87f91ce517c5878e6b707a1dafc6b873ff0a729f6a101193709e4d1

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at amrrbakry17@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fawry.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    fawry (0.1.0)
+      dry-validation (~> 1.3, >= 1.3.1)
+      faraday (~> 0.17.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    dry-configurable (0.8.3)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.2)
+    dry-inflector (0.2.0)
+    dry-initializer (3.0.1)
+    dry-logic (1.0.3)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-schema (1.4.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.2)
+    dry-types (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.2, >= 0.2.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.3.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.0, >= 1.3.1)
+    faraday (0.17.0)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.0)
+    multipart-post (2.1.1)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    safe_yaml (1.0.5)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug (~> 11.0, >= 11.0.1)
+  fawry!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.7, >= 3.7.6)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Amr Bakry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# 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)_
+- Parse Fawry's service callback V2 _(Not yet implemented)_
+
+_Fawry's production and sandbox environments are supported._
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fawry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fawry
+
+## Usage
+### Charge customers
+```ruby
+params = { "merchant_code": 'merchant_code',
+           "merchant_ref_num": 'io5jxf3jp27kfh8m719arcqgw7izo7db',
+           "customer_profile_id": 'ocvsydvbu2gcp528wvl64i9z5srdalg5',
+           "customer_mobile": '012345678901',
+           "payment_method": 'PAYATFAWRY',
+           "currency_code": 'EGP',
+           "amount": 20,
+           "fawry_secure_key": 'fawry_secure_key',
+           "description": 'the charge request description',
+           "charge_items": [{ "item_id": 'fk3fn9flk8et9a5t9w3c5h3oc684ivho',
+                              "description": 'desc', "price": 20, "quantity": 1 }] }
+
+# use sandbox option to call Fawry's sandbox env
+res = Fawry.charge(params, sandbox: true)
+#  => #<Fawry::FawryResponse:0x0000564257d0ea90 @type="ChargeResponse", @reference_number="931600239",
+#                                               @merchant_ref_number="io5jxf3jp27kfh8m719arcqgw7izo7db",
+#                                               @expiration_time=1573153206979, @status_code=200,
+#                                               @status_description="Operation done successfully">
+
+res.success? # => true
+res.reference_number # => 931600239
+```
+###  Refund Customers
+```ruby
+params = { "merchant_code": 'merchant_code',
+           "reference_number": '931337410',
+           "refund_amount": 20,
+           "fawry_secure_key": 'fawry_secure_key' }
+
+res = Fawry.refund(params, sandbox: true)
+#  => #<Fawry::FawryResponse:0x0000564257d0ea90 @type="ResponseDataModel", @status_code=200,
+#                                               @status_description="Operation done successfully">
+
+res.success? # => true
+```
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amrrbakry/fawry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fawry project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/amrrbakry/fawry/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fawry'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fawry.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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.metadata['homepage_uri'] = 'https://github.com/amrrbakry/fawry'
+  spec.metadata['source_code_uri'] = 'https://github.com/amrrbakry/fawry'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-validation', '~> 1.3', '>= 1.3.1'
+  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 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.7', '>= 3.7.6'
+end

data/lib/fawry.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'fawry/version'
+require 'fawry/connection'
+require 'fawry/errors'
+require 'fawry/fawry_request'
+require 'fawry/fawry_response'
+require 'fawry/requests/charge_request'
+require 'fawry/requests/refund_request'
+require 'fawry/contracts/charge_request_contract'
+require 'fawry/contracts/refund_request_contract'
+
+module Fawry
+  class << self
+    # Sends a charge 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_num).value(:string)
+    # required(:customer_profile_id).value(:string)
+    # required(:amount).value(:decimal)
+    # required(:description).value(:string)
+    # required(:customer_mobile).value(:string)
+    # required(:fawry_secure_key).value(:string)
+    # required(:charge_items).array(:hash) do
+    #   required(:item_id).value(:string)
+    #   required(:description).value(:string)
+    #   required(:price).value(:decimal)
+    #   required(:quantity).value(:integer)
+    # end
+    # optional(:currency_code).value(:string)
+    # optional(:card_token).value(:string)
+    # optional(:customer_email).value(:string)
+    # optional(:payment_method).value(:string)
+    # optional(:payment_expiry).value(:integer)
+    #
+    # @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
+    # Example: `Fawry.charge(params, sandbox: true)`
+    #
+    # @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 charge(params, opts = {})
+      FawryRequest.new('charge', params, opts).fire
+    end
+
+    # Sends a refund 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(:reference_number).value(:string)
+    # required(:refund_amount).value(:decimal)
+    # required(:fawry_secure_key).value(:string)
+    # optional(:reason).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 refund(params, opts = {})
+      FawryRequest.new('refund', params, opts).fire
+    end
+  end
+end

data/lib/fawry/connection.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+
+module Fawry
+  class Connection
+    FAWRY_BASE_URL = 'https://www.atfawry.com/ECommerceWeb/Fawry/payments/'
+
+    FAWRY_SANDBOX_BASE_URL = 'https://atfawry.fawrystaging.com//ECommerceWeb/Fawry/payments/'
+
+    class << self
+      def post(path, params, body, options)
+        conn = options[:sandbox] ? sandbox_connection : connection
+
+        conn.post(path) do |request|
+          request.params = params
+          request.body = body.to_json
+        end
+      end
+
+      private
+
+      def connection
+        @connection ||= Faraday.new(url: FAWRY_BASE_URL, headers: { 'Content-Type': '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' })
+      end
+    end
+  end
+end

data/lib/fawry/contracts/charge_request_contract.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module Fawry
+  module Contracts
+    class ChargeRequestContract < Dry::Validation::Contract
+      params do
+        required(:merchant_code).value(:string)
+        required(:merchant_ref_num).value(:string)
+        required(:customer_profile_id).value(:string)
+        required(:amount).value(:decimal)
+        required(:description).value(:string)
+        required(:customer_mobile).value(:string)
+        required(:fawry_secure_key).value(:string)
+        required(:charge_items).array(:hash) do
+          required(:item_id).value(:string)
+          required(:description).value(:string)
+          required(:price).value(:decimal)
+          required(:quantity).value(:integer)
+        end
+        optional(:currency_code).value(:string)
+        optional(:card_token).value(:string)
+        optional(:customer_email).value(:string)
+        optional(:payment_method).value(:string)
+        optional(:payment_expiry).value(:integer)
+      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(:payment_method) do
+        if key? && value == 'CARD' && values[:card_token].nil?
+          key.failure('card_token is required when payment_method is CARD')
+        end
+      end
+    end
+  end
+end

data/lib/fawry/contracts/refund_request_contract.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+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(:reason).value(:string)
+      end
+    end
+  end
+end

data/lib/fawry/errors.rb

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

data/lib/fawry/fawry_request.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Fawry
+  class FawryRequest
+    DEFAULT_OPTIONS = { sandbox: false }.freeze
+
+    attr_reader :action, :params, :request, :options
+
+    def initialize(action, params, opts)
+      @action = action
+      @params = params
+      @options = DEFAULT_OPTIONS.merge(opts)
+
+      build_request
+    end
+
+    private
+
+    def build_request
+      case action
+      when 'charge'
+        self.class.include Requests::ChargeRequest
+        validate_charge_params!
+        @request = build_charge_request
+      when 'refund'
+        self.class.include Requests::RefundRequest
+        validate_refund_params!
+        @request = build_refund_request
+      end
+    end
+  end
+end

data/lib/fawry/fawry_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Fawry
+  class FawryResponse
+    attr_reader :fawry_api_response
+
+    def initialize(fawry_api_response)
+      @fawry_api_response = fawry_api_response
+
+      build_response
+    end
+
+    def success?
+      status_code == 200
+    end
+
+    def failure?
+      !success?
+    end
+
+    def fawry_api_response_body
+      fawry_api_response
+    end
+
+    private
+
+    # Adds keys from fawry API response as methods
+    # on FawryResponse 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 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
+    end
+  end
+end

data/lib/fawry/requests/charge_request.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Fawry
+  module Requests
+    module ChargeRequest
+      DEFAULTS = { payment_method: 'PAYATFAWRY', currency_code: 'EGP' }.freeze
+
+      def fire
+        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_charge_request
+        {
+          path: 'charge',
+          params: {},
+          body: charge_request_transformed_params,
+          options: options
+        }
+      end
+
+      def request_params
+        @request_params ||= DEFAULTS.merge(params)
+      end
+
+      def charge_request_transformed_params
+        {
+          merchantCode: request_params[:merchant_code],
+          merchantRefNum: request_params[:merchant_ref_num],
+          customerProfileId: request_params[:customer_profile_id],
+          cardToken: request_params[:card_token],
+          customerMobile: request_params[:customer_mobile],
+          customerEmail: request_params[:customer_email],
+          paymentMethod: request_params[:payment_method],
+          amount: request_params[:amount],
+          description: request_params[:description],
+          paymentExpiry: request_params[:payment_expiry],
+          chargeItems: charge_items,
+          currencyCode: request_params[:currency_code],
+          signature: charge_request_signature
+        }.compact
+      end
+
+      def validate_charge_params!
+        contract = Contracts::ChargeRequestContract.new.call(request_params)
+        raise InvalidFawryRequest, contract.errors.to_h if contract.failure?
+      end
+
+      def charge_items
+        request_params[:charge_items].each { |hash| hash[:itemId] = hash.delete(:item_id) }
+      end
+
+      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
+    end
+  end
+end

data/lib/fawry/requests/refund_request.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Fawry
+  module Requests
+    module RefundRequest
+      def fire
+        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_refund_request
+        {
+          path: 'refund',
+          params: {},
+          body: refund_request_transformed_params,
+          options: options
+        }
+      end
+
+      def request_params
+        @request_params = params
+      end
+
+      def refund_request_transformed_params
+        {
+          merchantCode: request_params[:merchant_code],
+          referenceNumber: request_params[:reference_number],
+          refundAmount: request_params[:refund_amount],
+          reason: request_params[:reason],
+          signature: refund_request_signature
+        }.compact
+      end
+
+      def validate_refund_params!
+        contract = Contracts::RefundRequestContract.new.call(request_params)
+        raise InvalidFawryRequest, contract.errors.to_h if contract.failure?
+      end
+
+      def refund_request_signature
+        Digest::SHA256.hexdigest("#{request_params[:merchant_code]}#{request_params[:reference_number]}"\
+                                 "#{format('%<refund_amount>.2f', refund_amount: request_params[:refund_amount])}"\
+                                 "#{request_params[:reason]}#{request_params[:fawry_secure_key]}")
+      end
+    end
+  end
+end

data/lib/fawry/version.rb

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

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: fawry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amr Bakry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.6
+description: 
+email:
+- amrrbakry17@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fawry.gemspec
+- lib/fawry.rb
+- lib/fawry/connection.rb
+- lib/fawry/contracts/charge_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/refund_request.rb
+- lib/fawry/version.rb
+homepage: https://github.com/amrrbakry/fawry
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amrrbakry/fawry
+  source_code_uri: https://github.com/amrrbakry/fawry
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A library to interface with Fawry's payment gateway API (charge, refund,
+  payment status, service callback).
+test_files: []