paymob_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 52b1f6acf063b140de9deb2bc110562cd0697c1b8960cca0a3a1093ad18420ce
+  data.tar.gz: 83958c28994ea5488bf23d6c10184139c224a471078811726473899d51662f23
+SHA512:
+  metadata.gz: ab7868fa87491d7aa84582798d490c03cd54ac8dd002dbbfc0feb43dafc294282226d05e723ca0cb2a39ebd3c3c2b2376dc06197a746af8353e59bb0f5a49f4d
+  data.tar.gz: c2b16ddd7b2597c6a9f9d82b4d01534c257c827fd4fd36855d1d83142af124fb1228c65e177f01650a6526fca1e76fb6a8cd8f5e19ebe439dc195965d7484101

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,102 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-rails
+  - rubocop-performance
+
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/fixtures/**/*'
+    - 'Guardfile'
+  TargetRubyVersion: 3.1.2
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/FetchEnvVar:
+  Enabled: false
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Layout/LineLength:
+  Max: 180
+
+Layout/ClassStructure:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+  
+Rails:
+  Enabled: true
+
+Rails/FilePath:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Rails/HelperInstanceVariable:
+  Enabled: false
+
+Rails/UnknownEnv:
+  Enabled: false
+
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+HttpPositionalArguments:
+  Enabled: false
+
+HasAndBelongsToMany:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Naming/VariableNumber:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,30 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-06-01 20:03:10 UTC using RuboCop version 1.28.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    - 'paymob_ruby.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'paymob_ruby.gemspec'
+
+# Offense count: 2
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'paymob_ruby.gemspec'

data/.ruby-version

@@ -0,0 +1 @@
+3.1.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-01
+
+- Initial release

data/Gemfile

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in paymob_ruby.gemspec
+gemspec
+
+group :development, :test do
+  gem "dotenv-rails"
+  gem "fuubar", "~> 2.5.1"
+  gem "guard-rspec"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.52.0"
+  gem "rubocop-performance", "~> 1.18.0"
+  gem "rubocop-rails", "~> 2.19.1"
+end
+
+group :test do
+  gem "generator_spec"
+  gem "simplecov", "~> 0.22.0"
+  gem "vcr"
+  gem "webmock", "~> 3.18.1"
+end

data/Gemfile.lock

@@ -0,0 +1,194 @@
+PATH
+  remote: .
+  specs:
+    paymob_accept_ruby (0.1.0)
+      activesupport (~> 7.0)
+      faraday (~> 2.7.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.5)
+      actionview (= 7.0.5)
+      activesupport (= 7.0.5)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.5)
+      activesupport (= 7.0.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dotenv (2.8.1)
+    dotenv-rails (2.8.1)
+      dotenv (= 2.8.1)
+      railties (>= 3.2)
+    erubi (1.12.0)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    fuubar (2.5.1)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    nenv (0.3.0)
+    nokogiri (1.15.2-arm64-darwin)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.5)
+      actionpack (= 7.0.5)
+      activesupport (= 7.0.5)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.19.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    shellany (0.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    thor (1.2.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    vcr (6.2.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  dotenv-rails
+  fuubar (~> 2.5.1)
+  generator_spec
+  guard-rspec
+  paymob_accept_ruby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.52.0)
+  rubocop-performance (~> 1.18.0)
+  rubocop-rails (~> 2.19.1)
+  simplecov (~> 0.22.0)
+  vcr
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.3.26

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories(%w[lib config spec] \
+  .select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") })
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Joe Kaldas
+
+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,33 @@
+# Paymob
+
+Unofficial Paymob Ruby gem for [Paymob](https://paymob.com/)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+	$ bundle add paymob
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+	$ gem install paymob
+
+Next, you need to run the generator:
+
+  	$ rails generate paymob:install
+
+## Usage
+
+```ruby
+PaymobRuby.configure do |config|
+  config.api_key = "api_key"
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rake"
+begin
+  require "bundler/setup"
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts "although not required, bundler is recommended for running the tests"
+end
+
+task default: :spec
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new do |task|
+  task.requires << "rubocop-performance"
+  task.requires << "rubocop-rspec"
+end

data/config/initializers/paymob.rb

@@ -0,0 +1,5 @@
+require "paymob_ruby"
+
+PaymobRuby.configure do |config|
+  config.api_key = "your_api_key"
+end

data/lib/generators/paymob_ruby/install_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators"
+
+module PaymobRuby
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates a Paymob initializers file."
+
+      def copy_initializer
+        copy_file "paymob.rb", "config/initializers/paymob.rb"
+      end
+    end
+  end
+end

data/lib/generators/paymob_ruby/templates/paymob.rb

@@ -0,0 +1,5 @@
+require "paymob_ruby"
+
+PaymobRuby.configure do |config|
+  config.api_key = "your_api_key"
+end

data/lib/paymob_ruby/actions/application_service.rb

@@ -0,0 +1,24 @@
+module PaymobRuby
+  class ApplicationService
+    Response = Struct.new(:success?, :payload, :error) do
+      def failure?
+        !success?
+      end
+    end
+
+    def self.call(...)
+      service = new
+      service.call(...)
+    rescue StandardError => e
+      service.failure(e)
+    end
+
+    def success(payload = nil)
+      Response.new(true, payload)
+    end
+
+    def failure(exception)
+      Response.new(false, nil, exception)
+    end
+  end
+end

data/lib/paymob_ruby/actions/login.rb

@@ -0,0 +1,13 @@
+module PaymobRuby
+  class Login < ApplicationService
+    def call
+      url = "#{BASE_URI}/auth/tokens"
+      response = ::Faraday.post(url, { api_key: PaymobRuby.api_key }.to_json, "Content-Type" => "application/json")
+
+      raise AuthenticationError.new("Invalid API key", http_status: response.status, http_body: response.body) unless response.success?
+
+      response_json = JSON.parse(response.body)
+      success(response_json["token"])
+    end
+  end
+end

data/lib/paymob_ruby/actions/pay_card.rb

@@ -0,0 +1,29 @@
+module PaymobRuby
+  class PayCard < ApplicationService
+    def call(user:, amount:, integration_id:, iframe_id:, commission_fees: 0)
+      @iframe_id = iframe_id
+      result = PaymobRuby::PaymentToken.call(
+        integration_id:,
+        user:,
+        amount:,
+        commission_fees:
+      ).payload
+      @payment_token = result[:payment_token]
+
+      valid_url?
+
+      success({ payment_link: }.merge(result))
+    end
+
+    private
+
+    def valid_url?
+      response = ::Faraday.get(payment_link)
+      raise InvalidRequestError.new("Invalid iframe ID", :iframe_id, http_status: response.status, http_body: response.body) unless response.success?
+    end
+
+    def payment_link
+      @payment_link ||= "#{BASE_URI}/acceptance/iframes/#{@iframe_id}?payment_token=#{@payment_token}"
+    end
+  end
+end

data/lib/paymob_ruby/actions/pay_token.rb

@@ -0,0 +1,38 @@
+module PaymobRuby
+  class PayToken < ApplicationService
+    def call(user:, amount:, integration_id:, cc_token:, commission_fees: 0)
+      @cc_token = cc_token
+      result = PaymobRuby::PaymentToken.call(
+        integration_id:,
+        user:,
+        amount:,
+        commission_fees:
+      ).payload
+      @payment_token = result[:payment_token]
+
+      response = pay!
+
+      success({ response: }.merge(result))
+    end
+
+    private
+
+    def pay!
+      response = Faraday.post(
+        "#{BASE_URI}/acceptance/payments/pay",
+        {
+          source: {
+            subtype: "TOKEN",
+            identifier: @cc_token
+          },
+          payment_token: @payment_token
+        }.to_json,
+        "Content-Type" => "application/json"
+      )
+
+      raise APIError.new("Something went wrong", http_status: response.status, http_body: response.body) unless response.success?
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/paymob_ruby/actions/payment_token.rb

@@ -0,0 +1,112 @@
+module PaymobRuby
+  class PaymentToken < ApplicationService
+    def call(user:, amount:, integration_id:, commission_fees: 0)
+      @login_token     = PaymobRuby::Login.call.payload
+      @user            = user
+      @amount          = amount.round
+      @integration_id  = integration_id
+      @commission_fees = commission_fees
+
+      sanity_checks!
+
+      # Paymob order id
+      @order_id = order_response["id"]
+
+      success({ payment_token: payment_key_response["token"], order_id: @order_id })
+    end
+
+    private
+
+    def sanity_checks! # rubocop:disable Metrics/AbcSize
+      raise InvalidRequestError.new("Amount must be positive", :amount) unless @amount.positive?
+      raise InvalidRequestError.new("Commission fees can't be negative", :commission_fees) if @commission_fees.negative?
+      raise InvalidRequestError.new("First name is missing", :user) if first_name.blank?
+      raise InvalidRequestError.new("Last name is missing", :user) if last_name.blank?
+      raise InvalidRequestError.new("Email is missing", :user) if email.blank?
+      raise InvalidRequestError.new("Phone number is missing", :user) if phone_number.blank?
+    end
+
+    def order_response
+      @order_response ||= Faraday.post(
+        "#{BASE_URI}/ecommerce/orders",
+        order_body.to_json,
+        "Content-Type": "application/json"
+      )
+
+      raise APIError.new("Something went wrong", http_status: @order_response.status, http_body: @order_response.body) unless @order_response.success?
+
+      JSON.parse(@order_response.body)
+    end
+
+    def payment_key_response
+      @payment_key_response ||= Faraday.post(
+        "#{BASE_URI}/acceptance/payment_keys",
+        payment_key_body.to_json,
+        "Content-Type": "application/json"
+      )
+
+      unless @payment_key_response.success?
+        raise InvalidRequestError.new("Invalid integration ID", :integration_id, http_status: @payment_key_response.status, http_body: @payment_key_response.body)
+      end
+
+      JSON.parse(@payment_key_response.body)
+    end
+
+    def first_name
+      @first_name ||= @user[:first_name]
+    end
+
+    def last_name
+      @last_name ||= @user[:last_name]
+    end
+
+    def phone_number
+      @phone_number ||= @user[:phone_number]
+    end
+
+    def email
+      @email ||= @user[:email]
+    end
+
+    def order_body
+      {
+        auth_token: @login_token,
+        delivery_needed: false,
+        amount_cents: (@amount * 100).to_i,
+        currency: "EGP",
+        items: [],
+        commission_fees: @commission_fees
+      }
+    end
+
+    def payment_key_body
+      {
+        auth_token: @login_token,
+        amount_cents: (@amount * 100).to_i,
+        expiration: 36_000,
+        order_id: @order_id,
+        billing_data: address_info,
+        currency: "EGP",
+        card_integration_id: @integration_id
+      }
+    end
+
+    def address_info
+      {
+        first_name:,
+        last_name:,
+        phone_number:,
+        email:,
+        street: "NA",
+        building: "NA",
+        floor: "NA",
+        apartment: "NA",
+        postal_code: "NA",
+        city: "NA",
+        state: "NA",
+        country: "EG",
+        shipping_method: "PKG"
+      }
+    end
+  end
+end

data/lib/paymob_ruby/errors.rb

@@ -0,0 +1,78 @@
+module PaymobRuby
+  # PaymobError is the base error from which all other more specific Paymob
+  # errors derive.
+  class PaymobError < StandardError
+    attr_reader :message, :error, :http_body, :http_headers, :http_status, :json_body
+
+    # Initializes a PaymobError.
+    def initialize(message = nil, http_status: nil, http_body: nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      begin
+        @json_body = JSON.parse(http_body)
+      rescue StandardError
+        @json_body = nil
+      end
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+
+  # AuthenticationError is raised when invalid credentials are used to connect
+  # to Paymob's servers.
+  class AuthenticationError < PaymobError
+  end
+
+  # APIConnectionError is raised in the event that the SDK can't connect to
+  # Paymob's servers. That can be for a variety of different reasons from a
+  # downed network to a bad TLS certificate.
+  class APIConnectionError < PaymobError
+  end
+
+  # APIError is a generic error that may be raised in cases where none of the
+  # other named errors cover the problem. It could also be raised in the case
+  # that a new error has been introduced in the API, but this version of the
+  # Ruby SDK doesn't know how to handle it.
+  class APIError < PaymobError
+  end
+
+  # InvalidRequestError is raised when a request is initiated with invalid
+  # parameters.
+  class InvalidRequestError < PaymobError
+    attr_accessor :param
+
+    def initialize(message, param, http_status: nil, http_body: nil)
+      super(message, http_status:, http_body:)
+      @param = param
+    end
+  end
+
+  # SignatureVerificationError is raised when the signature verification for a
+  # webhook fails
+  class SignatureVerificationError < PaymobError
+    attr_accessor :sig_header
+
+    def initialize(message, sig_header, http_body: nil)
+      super(message, http_body:)
+      @sig_header = sig_header
+    end
+  end
+
+  module OAuth
+    # OAuthError is raised when the OAuth API returns an error.
+    class OAuthError < PaymobError
+      def initialize(description, http_status: nil, http_body: nil)
+        super(description, http_status:, http_body:)
+      end
+    end
+
+    # InvalidRequestError is raised when a code, refresh token, or grant type
+    # parameter is not provided, but was required.
+    class InvalidRequestError < OAuthError
+    end
+  end
+end

data/lib/paymob_ruby/version.rb

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

data/lib/paymob_ruby.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "active_support"
+
+require_relative "paymob_ruby/version"
+
+# API resource support classes
+require "paymob_ruby/errors"
+
+# API operations
+require "paymob_ruby/actions/application_service"
+require "paymob_ruby/actions/login"
+require "paymob_ruby/actions/payment_token"
+require "paymob_ruby/actions/pay_card"
+require "paymob_ruby/actions/pay_token"
+
+module PaymobRuby
+  BASE_URI = "https://accept.paymobsolutions.com/api"
+
+  class << self
+    attr_accessor :api_key
+  end
+
+  def self.configure
+    yield self
+  end
+end

data/sig/paymob.rbs

@@ -0,0 +1,4 @@
+module PaymobRuby
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: paymob_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Kaldas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+description:
+email:
+- joekaldas8@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/initializers/paymob.rb
+- lib/generators/paymob_ruby/install_generator.rb
+- lib/generators/paymob_ruby/templates/paymob.rb
+- lib/paymob_ruby.rb
+- lib/paymob_ruby/actions/application_service.rb
+- lib/paymob_ruby/actions/login.rb
+- lib/paymob_ruby/actions/pay_card.rb
+- lib/paymob_ruby/actions/pay_token.rb
+- lib/paymob_ruby/actions/payment_token.rb
+- lib/paymob_ruby/errors.rb
+- lib/paymob_ruby/version.rb
+- sig/paymob.rbs
+homepage: https://github.com/JoeKaldas/paymob
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/JoeKaldas/paymob
+  source_code_uri: https://github.com/JoeKaldas/paymob
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Ruby bindings for the Paymob API.
+test_files: []