paymob_ruby 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 568a679887032b299bbf4111d8591f0bdc0a04914afc873ad6032c67ffa06d72
-  data.tar.gz: e22125d83676040a2efc5b4c72ae00ed3108177201500b051d0b0e9123bd608c
+  metadata.gz: 24822d16f0b04315481dd8af2d517107854013214adf5132f2fc94b3dcd681c1
+  data.tar.gz: cad7e761eadcda83ff6decd31471d8b03f9a373b5d97c236c260ecbcce5649e6
 SHA512:
-  metadata.gz: dd04ecd384ee403c933e1d954c895cb164b43f6704a693284a161230d0a4effc3592b28dbbc380a3d88d26ebfbc436e4af637d27bf4f027d795e9799a61d82fd
-  data.tar.gz: 5ece42acdb5b91d10cb9da1bae86de4adf104d178200cce7916fe87448e6f25aeff4fe0bc88365d93691cf4c56459812bf88bb690f0978e3f654456c3593fe4e
+  metadata.gz: 77b525f1ed5b776d363a912f456eb8b38e7de4b34c6ec34ef8b4b226f8c6a9082b04a683e3e21a9bf1361e699f298b60d7b6eec080d78dc3ddb45ef741490ae3
+  data.tar.gz: 566567124158c1af278e874fae4056e2f15285e57264c2b73cf995542a6b94e0fc498143fc166aa00c528434ee1af9ec125035868b5f3f1f91054efa554ede7a

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    paymob_accept_ruby (0.1.0)
-      activesupport (~> 7.0)
+    paymob_ruby (0.1.2)
       faraday (~> 2.7.5)
 
 GEM
@@ -74,6 +73,8 @@ GEM
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
+    json-schema (4.1.1)
+      addressable (>= 2.8)
     listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -180,7 +181,8 @@ DEPENDENCIES
   fuubar (~> 2.5.1)
   generator_spec
   guard-rspec
-  paymob_accept_ruby!
+  json-schema
+  paymob_ruby!
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.52.0)

data/README.md

@@ -18,12 +18,61 @@ Next, you need to run the generator:
 
 ## Usage
 
+### Configuration
+
+Configure the gem with your configuration
+
 ```ruby
 PaymobRuby.configure do |config|
   config.api_key = "api_key"
+	config.hmac_key = "hmac_key"
 end
 ```
 
+:bulb: You can get your API_KEY from Settings -> Account info -> API Key in your Paymob portal.
+
+For reference on the internals & specifics of Paymob, please head to their official documentation [here](https://docs.paymob.com/)
+
+Any API call will return an object with following methods: 
+
+```ruby
+result = PaymobRuby.doSomething
+result.success?
+result.failure?
+result.payload
+result.error
+```
+
+## Creating a payment:
+
+### Using iframe:
+
+```ruby
+user = { first_name: "John", last_name: "Doe", email: "johndoe@test.com", phone_number: "012xxxxxxxxx" }
+result = PaymobRuby::PayCard.call(user:, amount: 10, integration_id: 12345678, iframe_id: 123)
+```
+
+### Using motto:
+
+```ruby
+user = { first_name: "John", last_name: "Doe", email: "johndoe@test.com", phone_number: "012xxxxxxxxx" }
+result = PaymobRuby::PayToken.call(user:, amount: 10, integration_id: 12345678, token: "abc123")
+```
+
+### Calculating hash
+```ruby
+ PaymobRuby::Hmac.valid_signature?(paymob_response)
+```
+
+## Errors:
+Errors could be one of the following:
+
+```ruby
+AuthenticationError
+InvalidRequestError (With `param` attribute)
+APIError
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome.

data/Rakefile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
 
 require "rake"

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

@@ -2,4 +2,5 @@ require "paymob_ruby"
 
 PaymobRuby.configure do |config|
   config.api_key = "your_api_key"
+  config.hmac_key = "your_hmac_key"
 end

data/lib/paymob_ruby/{actions → api}/payment_token.rb

@@ -7,6 +7,7 @@ module PaymobRuby
       @integration_id  = integration_id
       @commission_fees = commission_fees
 
+      user_valid?
       sanity_checks!
 
       # Paymob order id

data/lib/paymob_ruby/configuration.rb

@@ -0,0 +1,5 @@
+module PaymobRuby
+  class Configuration
+    attr_accessor :api_key, :hmac_key
+  end
+end

data/lib/paymob_ruby/errors.rb

@@ -22,6 +22,9 @@ module PaymobRuby
     end
   end
 
+  # ConfigurationMissingError is raised when a configuration is missing
+  class ConfigurationMissingError < StandardError; end
+
   # AuthenticationError is raised when invalid credentials are used to connect
   # to Paymob's servers.
   class AuthenticationError < PaymobError
@@ -61,18 +64,4 @@ module PaymobRuby
       @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/hmac.rb

@@ -0,0 +1,20 @@
+module PaymobRuby
+  module Hmac
+    FILTERED_TRANSACTION_KEYS = %w[amount_cents created_at currency error_occured has_parent_transaction id
+                                   integration_id is_3d_secure is_auth is_capture is_refunded is_standalone_payment
+                                   is_voided order.id owner pending
+                                   source_data.pansource_data.sub_type source_data.type success].freeze
+
+    class << self
+      def valid_signature?(paymob_response)
+        digest = ::OpenSSL::Digest.new("sha512")
+
+        concatenated_str = FILTERED_TRANSACTION_KEYS.map do |element|
+          paymob_response.dig("obj", *element.split("."))
+        end.join
+        secure_hash = ::OpenSSL::HMAC.hexdigest(digest, PaymobRuby.hmac_key, concatenated_str)
+        secure_hash == paymob_response["hmac"]
+      end
+    end
+  end
+end

data/lib/paymob_ruby/json_schemas/user.rb

@@ -0,0 +1,29 @@
+module PaymobRuby
+  module JsonSchemas
+    module User
+      extend ActiveSupport::Concern
+
+      def user_valid?
+        JSON::Validator.validate!(customer_schema, @user)
+      rescue JSON::Schema::ValidationError => e
+        raise InvalidRequestError.new("Customer hash has the following error: #{e.message}", :user)
+      end
+
+      private
+
+      def customer_schema
+        {
+          type: "object",
+          "$schema": "http://json-schema.org/draft-04/schema",
+          properties: {
+            first_name: { type: "string" },
+            last_name: { type: "string" },
+            email: { type: "string" },
+            phone_number: { type: "string" }
+          },
+          required: %w[first_name last_name email phone_number]
+        }
+      end
+    end
+  end
+end

data/lib/paymob_ruby/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module PaymobRuby
-  VERSION = "0.1.1"
+  VERSION = "0.1.3".freeze
 end

data/lib/paymob_ruby.rb

@@ -1,28 +1,35 @@
-# frozen_string_literal: true
-
-require "faraday"
 require "active_support"
+require "faraday"
+require "json-schema"
 
 require_relative "paymob_ruby/version"
 
 # API resource support classes
 require "paymob_ruby/errors"
+require "paymob_ruby/configuration"
+require "paymob_ruby/hmac"
 
 # 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"
+require "paymob_ruby/api/application_service"
+require "paymob_ruby/api/login"
+require "paymob_ruby/api/payment_token"
+require "paymob_ruby/api/pay_card"
+require "paymob_ruby/api/pay_token"
+
+require "paymob_ruby/json_schemas/user"
 
 module PaymobRuby
-  BASE_URI = "https://accept.paymobsolutions.com/api"
+  BASE_URI = "https://accept.paymobsolutions.com/api".freeze
 
   class << self
-    attr_accessor :api_key
-  end
+    attr_accessor :api_key, :hmac_key
+
+    def configure
+      yield configuration
+    end
 
-  def self.configure
-    yield self
+    def configuration
+      @configuration ||= Configuration.new
+    end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: paymob_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Joe Kaldas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-09-19 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
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.7.5
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
 description:
 email:
 - joekaldas8@gmail.com
@@ -42,16 +70,18 @@ files:
 - 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/api/application_service.rb
+- lib/paymob_ruby/api/login.rb
+- lib/paymob_ruby/api/pay_card.rb
+- lib/paymob_ruby/api/pay_token.rb
+- lib/paymob_ruby/api/payment_token.rb
+- lib/paymob_ruby/configuration.rb
 - lib/paymob_ruby/errors.rb
+- lib/paymob_ruby/hmac.rb
+- lib/paymob_ruby/json_schemas/user.rb
 - lib/paymob_ruby/version.rb
 - sig/paymob.rbs
 homepage: https://github.com/JoeKaldas/paymob

data/config/initializers/paymob.rb

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