paymob_accept 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 519375883a2c35dd6406dc2aee7e471f3525905ded1faee4c286d9d4518014aa
+  data.tar.gz: dbb89c1765419b3114e0366302494097dae654d13fc9d0bdf20794420230b07e
+SHA512:
+  metadata.gz: 0e9bb8812b46f509a9ccbb96bfc97a140726fb360e044980eec42bad30828575e457361ba5a61df608324021bdf58424815c7ef828dad7909322b20ffdaae3a4
+  data.tar.gz: 7d2811bd93ee7c9a43492c984fa8a5c237929b64ad1f3393bb528f24f489d666427fccff34d15d914f55002e8e52cbce7501b7efa1aad9006b03467fafde577d

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

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 hesham_magdy97@hotmail.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in paymob.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    paymob_accept (0.1.0)
+      faraday
+      json-schema
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.5.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.0)
+    json-schema (3.0.0)
+      addressable (>= 2.8)
+    public_suffix (4.0.7)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  paymob_accept!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Hesham Ghaith
+
+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,116 @@
+
+# PaymobAccept
+
+`paymob_accept` is a Ruby gem created by [OneOrder](https://www.oneorder.net/) for integrating [Paymob](https://paymob.com/en) payment solutions with your Ruby application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paymob_accept'
+```
+
+And then execute:
+
+`$ bundle install`
+
+Or install it yourself as:
+
+`$ gem install paymob_accept`
+
+## Usage
+
+### Configuration
+
+Configure the gem with your `api_key`
+
+```ruby
+PaymobAccept.configure do |config|
+  config.api_key = YOUR_API_KEY
+end
+```
+
+Also you can pass the api_key to the constructor when initializing your payment service
+
+:raised_back_of_hand: You get your API_KEY from Settings -> Account info -> API Key in your Paymob portal
+
+### Creating the payment service
+
+  When performing a payment we expect to have two hashes (customer, address)
+
+- Customer schema
+
+
+## Payment service
+
+  - Initialize your payment service
+    ```ruby
+    service = PaymobAccept::Api::Pay.new(api_key: api_key) 
+    ```
+
+   - To charge:
+      ```ruby
+      customer_data = {name:  "test",  email:  "test@test.com",  phone_number:  "01000000000"}
+      address_data = {address_line1:  "10 street name", address_line2: "apt x. floor x",  region: "region", city: "Cairo", country: "EG"}
+      service.charge(customer: customer, address: address, integration_id: 'xxxxx', method: :online, iframe_id: 'xxxxx', amount_cents: 1000, amount_currency: 'EGP', order_id: order_id)
+      ```
+      If  order_id is not provided, an order is created then linked to this payment_intent
+
+---
+ ### Also, You can do it step by step
+ 
+ - Step #1  Get auth_token
+    ```ruby
+    token =  service.get_auth_token
+    ```
+
+ - Step #2 Create_order
+    ```ruby
+    service.create_order(auth_token: auth_token, amount_cents:  1000,  amount_currency:  'EGP', items:  [])
+    ```
+
+   auth_token is optional if not passed, it will be automatically generated.
+  </br>
+    - Items are optional
+
+      ```ruby
+        items  =  [{
+          "name":  "xxxxxxx-1",
+          "amount_cents": "5000",
+          "description": "Smart Watch",
+          "quantity": "10"
+          }]
+      ```
+
+  </br>
+
+  - Step #3 Create payment key
+  
+    ```ruby
+    generate_payment_intent(customer: customer, address: address, integration_id: "xxxxx", amount_cents: amount_cents, amount_currency: "EGP", iframe_id: "xxxxxx", order_id: "xxxxxx")
+    ```
+---
+## Dealing with charges 
+- retrieve transaction `PaymobAccept::Api::Charge.new.charge(transaction_id: transaction_id)`
+- refund transaction `PaymobAccept::Api::Charge.new.refund!(transaction_id: transaction_id, amount_cents: amount_cents)`
+- void a transaction using `PaymobAccept::Api::Charge.new.void!(transaction_id: transaction_id)`
+
+## 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](https://github.com/HeshamMagdy97/paymob).
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/HeshamMagdy97/paymob/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 PaymobAccept project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/HeshamMagdy97/paymob/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "paymob"
+
+# 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/lib/paymob_accept/api/base.rb

@@ -0,0 +1,129 @@
+module PaymobAccept
+  module Api
+    class Base
+      attr_reader :integration_id, :method, :customer, :address
+      attr_accessor :api_key, :iframe_id
+
+      def initialize(api_key: PaymobAccept.configuration.api_key)
+        @client = PaymobAccept::Api::Client.new
+        @api_key = api_key
+        @address = address
+      end
+
+      # STEP #!
+      def get_auth_token
+        response = @client.request('/auth/tokens', { api_key: api_key })
+        response['token']
+      end
+
+      # 2. Order Registration API
+      def create_order(amount_cents:, amount_currency: 'EGP', auth_token: get_auth_token,
+                       delivery_needed: false, items: [])
+        body = {
+          "auth_token": auth_token,
+          "delivery_needed": delivery_needed,
+          "amount_cents": amount_cents.to_i,
+          "currency": amount_currency,
+          "items": items
+        }
+        @client.request('/ecommerce/orders', body)
+      end
+
+      def generate_payment_intent(customer:, address:, integration_id:, amount_cents:, amount_currency:, iframe_id: nil, order_id: nil, auth_token: get_auth_token)
+        if order_id.nil?
+          order = create_order(amount_cents: amount_cents, amount_currency: amount_currency)
+          order_id = order['id']
+        end
+        payment_token = generate_payment_key(auth_token: auth_token, customer: customer, address: address, order_id: order_id, amount_cents: amount_cents, amount_currency: amount_currency,
+                                             integration_id: integration_id)
+
+        format_bill_reference(payment_token, iframe_id)
+      end
+
+      # 3. Payment Key Request
+
+      private
+
+      def generate_payment_key(customer:, address:, amount_cents:, amount_currency:, integration_id:, order_id: nil, auth_token: get_auth_token)
+        body = {
+          "auth_token": auth_token,
+          "amount_cents": amount_cents.to_i,
+          "currency": amount_currency,
+          "expiration": 36_000,
+          "order_id": order_id, # Remote
+          "billing_data": {
+            "first_name": customer&.dig(:first_name) || customer&.dig(:name)&.split(/\s/, 2)&.first,
+            "last_name": customer&.dig(:last_name) || customer&.dig(:name)&.split(/\s/, 2)&.last,
+            "email": customer[:email],
+            "phone_number": customer&.dig(:phone_number),
+            "street": address&.dig(:address_line1) || 'NA',
+            "building": address&.dig(:address_line2) || 'NA',
+            "floor": address&.dig(:address_clarification) || 'NA',
+            "apartment": 'NA',
+            "postal_code": address&.dig(:postal_code) || 'NA',
+            "city": address&.dig(:region) || 'NA',
+            "state": address&.dig(:city) || 'NA',
+            "country": address&.dig(:country) || 'NA',
+            "shipping_method": 'PKG'
+          },
+          "integration_id": integration_id
+        }
+        body['token'] = customer[:cc_token] unless customer[:cc_token].nil?
+
+        response = @client.request('/acceptance/payment_keys', body)
+
+        response['token']
+      end
+
+      def format_bill_reference(payment_token, iframe_id)
+        iframe_id.nil? ? payment_token : "#{Api::Client::API_ENDPOINT}/acceptance/iframes/#{iframe_id}?payment_token=#{payment_token}"
+      end
+
+      def customer_validator(customer)
+        JSON::Validator.validate!(customer_schema, customer)
+      rescue JSON::Schema::ValidationError => e
+        raise ArgumentError, "Customer field has the following error: #{e.message}"
+      end
+
+      def address_validator(address)
+        JSON::Validator.validate!(address_schema, address)
+      rescue JSON::Schema::ValidationError => e
+        raise ArgumentError, "Address field has the following error: #{e.message}"
+      end
+
+      def customer_schema
+        {
+          "type": 'object',
+          "$schema": 'http://json-schema.org/draft-04/schema',
+          "properties": {
+            "name": { "type": 'string' },
+            "first_name": { "type": 'string' },
+            "last_name": { "type": 'string' },
+            "email": { "type": 'string' },
+            "phone_number": { "type": 'string' },
+            "cc_token": { "type": 'string' },
+            "wallet_mobile_number": { "type": 'string' }
+          },
+          "required": %w[email phone_number]
+        }
+      end
+
+      def address_schema
+        {
+          "type": 'object',
+          "$schema": 'http://json-schema.org/draft-04/schema',
+          "properties": {
+            "address_line1": { "type": 'string' },
+            "address_line2": { "type": 'string' },
+            "postal_code": { "type": 'string' },
+            "region": { "type": 'string' },
+            "city": { "type": 'string' },
+            "country": { "type": 'string' },
+            "address_clarification": { "type": 'string' }
+          },
+          "required": %w[address_line1 address_line2 region city country]
+        }
+      end
+    end
+  end
+end

data/lib/paymob_accept/api/charge.rb

@@ -0,0 +1,43 @@
+module PaymobAccept
+  module Api
+    class Charge < Base
+      attr_reader :transaction_id
+
+      def initialize(api_key: PaymobAccept.configuration.api_key)
+        super(api_key: api_key)
+      end
+
+      def charge(transaction_id:)
+        response = @client.get(endpoint: "/acceptance/transactions/#{transaction_id}", headers: auth_headers)
+        JSON.parse(response.body).to_h
+      end
+
+      def capture!(transaction_id:, amount_cents:)
+        body = {
+          auth_token: get_auth_token,
+          transaction_id: transaction_id,
+          amount_cents: amount_cents
+        }
+        @client.request('/acceptance/capture', body)
+      end
+
+      def void!(transaction_id:)
+        body = { auth_token: get_auth_token, transaction_id: transaction_id }
+        response = @client.request('/acceptance/void_refund/void', body)
+        ['true', true].include? response['success']
+      end
+
+      def refund!(transaction_id:, amount_cents:)
+        body = { auth_token: get_auth_token, transaction_id: transaction_id, amount_cents: amount_cents }
+        response = @client.request('/acceptance/void_refund/refund', body)
+        ['true', true].include? response['success']
+      end
+
+      private
+
+      def auth_headers
+        { 'Authorization' => "Bearer #{get_auth_token}" }
+      end
+    end
+  end
+end

data/lib/paymob_accept/api/client.rb

@@ -0,0 +1,60 @@
+module PaymobAccept
+  module Api
+    class Client
+      API_ENDPOINT = 'https://accept.paymobsolutions.com/api'.freeze
+      def initialize; end
+
+      def get(endpoint:, params: {}, headers: {})
+        response = Faraday.get(
+          "#{API_ENDPOINT}/#{endpoint}",
+          params,
+          headers
+        )
+        raise StandardError, "code: #{response.status}, response: #{response.body}" unless response.success?
+
+        response
+      end
+
+      def request(endpoint, body = {})
+        response = Faraday.post(
+          "#{API_ENDPOINT}/#{endpoint.gsub(%r{^/+}, '')}",
+          body.to_json,
+          'Content-Type' => 'application/json'
+        )
+
+        begin
+          parsed_body = JSON.parse(response.body).to_h
+        rescue StandardError => e
+          # Manually send the error to Sentry
+        end
+
+        unless response.success?
+          # TODO: Instead of setting the status to failed, this payment intent could be destroyed
+
+          message = parsed_body&.dig('message') || response.body || default_error_message
+          raise PaymobAccept::Errors::BadGateway.new(message: "code: #{response.status}, gateway response: #{message}")
+        end
+
+        handle_paymob_request_errors unless paymob_request_successful?(parsed_body)
+
+        parsed_body
+      end
+
+      def handle_paymob_request_errors
+        raise PaymobAccept::Errors::BadGateway.new(message: default_error_message)
+      end
+
+      def default_error_message
+        'Gateway could not handle your request properly. Please try again later.'
+      end
+
+      def paymob_request_successful?(response)
+        !response.key?('success') || (response.key?('success') && ([true,
+                                                                    'true'].include?(response['success']) || ([false,
+                                                                                                               'false'].include?(response['success']) && [
+                                                                                                                 true, 'true'
+                                                                                                               ].include?(response['pending']))))
+      end
+    end
+  end
+end

data/lib/paymob_accept/api/pay.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module PaymobAccept
+  module Api
+    class Pay < Base
+      def initialize(api_key: PaymobAccept.configuration.api_key)
+        super(api_key: api_key)
+      end
+
+      def charge(customer:, address:, amount_cents:, integration_id:, method:, amount_currency: 'EGP', order_id: nil, iframe_id: nil, auth_token: get_auth_token)
+        raise ArgumentError, "unsupported payment method #{method}" unless %i[online moto kiosk cash auth
+                                                                              wallet].include? method
+
+        send("pay_#{method}".to_sym,
+             { auth_token: auth_token, customer: customer, address: address, amount_cents: amount_cents, amount_currency: amount_currency,
+               integration_id: integration_id, iframe_id: iframe_id, order_id: order_id })
+      end
+
+      private
+
+      def request_auth(customer:, address:, amount_cents:, amount_currency:, integration_id:, iframe_id:, order_id:, auth_token:)
+        generate_payment_intent(customer: customer, address: address, amount_cents: amount_cents, amount_currency: amount_currency,
+                                integration_id: integration_id, iframe_id: iframe_id, order_id: order_id, auth_token: auth_token)
+      end
+
+      # Returns iFrame URL. The iframe will be prepoulated if the credit card token is provided
+      def pay_online(customer:, address:, amount_cents:, amount_currency:, integration_id:, iframe_id:, order_id:, auth_token:)
+        generate_payment_intent(customer: customer, address: address, amount_cents: amount_cents, amount_currency: amount_currency,
+                                integration_id: integration_id, iframe_id: iframe_id, order_id: order_id, auth_token: auth_token)
+      end
+
+      def pay_moto(customer:, address:, amount_cents:, amount_currency:, integration_id:, iframe_id:, order_id:, auth_token:)
+        if customer[:cc_token].nil?
+          raise ArgumentError,
+                'You need to provide a credit card token for moto payments'
+        end
+
+        bill_reference = generate_payment_intent(customer: customer, address: address, amount_cents: amount_cents, amount_currency: amount_currency,
+                                                 integration_id: integration_id, iframe_id: iframe_id, order_id: order_id, auth_token: auth_token)
+        body = {
+          "source": { "subtype": 'TOKEN', "identifier": cc_token },
+          "payment_token": bill_reference
+        }
+        @client.request('/acceptance/payments/pay', body)
+      end
+
+      def pay_wallet(customer:, address:, amount_cents:, amount_currency:, integration_id:, iframe_id:, order_id:, auth_token:)
+        if customer[:wallet_mobile_number].nil?
+          raise ArgumentError,
+                'You need to provide a mobile number for wallet payments'
+        end
+
+        bill_reference = generate_payment_intent(customer: customer, address: address, amount_cents: amount_cents, amount_currency: amount_currency,
+                                                 integration_id: integration_id, iframe_id: iframe_id, order_id: order_id, auth_token: auth_token)
+        body = {
+          "source": { "subtype": 'WALLET', "identifier": wallet_mobile_number },
+          "payment_token": bill_reference
+        }
+        @client.request('/acceptance/payments/pay', body)
+      end
+
+      def pay_cash(customer:, address:, amount_cents:, amount_currency:, integration_id:, iframe_id:, order_id:, auth_token:)
+        if address.nil?
+          raise ArgumentError,
+                "Please provide a valid address in options. You must provide those keys: #{address_schema[:required]}"
+        end
+
+        address_validator(address)
+
+        bill_reference = generate_payment_intent(customer: customer, address: address, amount_cents: amount_cents, amount_currency: amount_currency,
+                                                 integration_id: integration_id, iframe_id: iframe_id, order_id: order_id, auth_token: auth_token)
+        body = {
+          "source": { "subtype": 'CASH', "identifier": 'cash' },
+          "payment_token": bill_reference
+        }
+        @client.request('/acceptance/payments/pay', body)
+      end
+
+      def pay_kiosk(customer:, address:, amount_cents:, amount_currency:, integration_id:, iframe_id:, order_id:, auth_token:)
+        bill_reference = generate_payment_intent(customer: customer, address: address, amount_cents: amount_cents, amount_currency: amount_currency,
+                                                 integration_id: integration_id, iframe_id: iframe_id, order_id: order_id, auth_token: auth_token)
+        body = {
+          "source": { "subtype": 'AGGREGATOR', "identifier": 'aggregator' },
+          "payment_token": bill_reference
+        }
+
+        @client.request('/acceptance/payments/pay', body)
+      end
+    end
+  end
+end

data/lib/paymob_accept/configuration.rb

@@ -0,0 +1,14 @@
+# require 'erb'
+# require 'yaml'
+
+module PaymobAccept
+  class Configuration
+    attr_accessor :api_key, :amount_currency
+
+    def initialize
+      @amount_currency = 'EGP'
+    end
+  end
+
+  class ConfigurationMissingError < StandardError; end
+end

data/lib/paymob_accept/errors/bad_gateway.rb

@@ -0,0 +1,13 @@
+module PaymobAccept
+  module Errors
+    class BadGateway < StandardError
+      def initialize(message:)
+        super(
+          title: 'Bad Gateway',
+          status: 502,
+          detail: message || 'An error has occured communicating with the external gateway',
+        )
+      end
+    end
+  end
+end

data/lib/paymob_accept/version.rb

@@ -0,0 +1,3 @@
+module PaymobAccept
+  VERSION = "0.1.0"
+end

data/lib/paymob_accept.rb

@@ -0,0 +1,25 @@
+require 'paymob_accept'
+require 'paymob_accept/api/base'
+require 'paymob_accept/api/pay'
+require 'paymob_accept/api/client'
+require 'paymob_accept/api/charge'
+require 'paymob_accept/configuration'
+
+require 'json'
+require 'faraday'
+require 'faraday/net_http'
+require 'paymob_accept/errors/bad_gateway'
+require 'json-schema'
+
+module PaymobAccept
+  class Error < StandardError; end
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/paymob.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/paymob_accept/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'paymob_accept'
+  spec.version       = PaymobAccept::VERSION
+  spec.authors       = ['Hesham Magdy']
+  spec.email         = ['hesham_magdy97@hotmail.com']
+
+  spec.summary       = 'Easy integration of Paymob payment gateway'
+  spec.description   = 'Paymob is a Ruby gem created by OneOrder tech team for integrating Paymob payment solutions with your Ruby application.'
+  spec.homepage      = "https://github.com/oneorder-tech/paymob"
+  spec.license       = 'MIT'
+  spec.homepage = 'https://github.com/oneorder-tech/paymob'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/oneorder-tech/paymob'
+  spec.metadata['changelog_uri'] = 'https://github.com/oneorder-tech/paymob'
+
+  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 'faraday'
+  spec.add_dependency 'json-schema'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: paymob_accept
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hesham Magdy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Paymob is a Ruby gem created by OneOrder tech team for integrating Paymob
+  payment solutions with your Ruby application.
+email:
+- hesham_magdy97@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paymob_accept.rb
+- lib/paymob_accept/api/base.rb
+- lib/paymob_accept/api/charge.rb
+- lib/paymob_accept/api/client.rb
+- lib/paymob_accept/api/pay.rb
+- lib/paymob_accept/configuration.rb
+- lib/paymob_accept/errors/bad_gateway.rb
+- lib/paymob_accept/version.rb
+- paymob.gemspec
+homepage: https://github.com/oneorder-tech/paymob
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/oneorder-tech/paymob
+  source_code_uri: https://github.com/oneorder-tech/paymob
+  changelog_uri: https://github.com/oneorder-tech/paymob
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Easy integration of Paymob payment gateway
+test_files: []