paymob_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 568a679887032b299bbf4111d8591f0bdc0a04914afc873ad6032c67ffa06d72
-  data.tar.gz: e22125d83676040a2efc5b4c72ae00ed3108177201500b051d0b0e9123bd608c
+  metadata.gz: 750c9f04ad4dbc611da0fb7ddbd90b2a92487fe7721d996ce52a0bfa564817b0
+  data.tar.gz: 184bf8bed0172cfde51e056c043e73530fd43b760e2fd2693bd5e405f93ad7b4
 SHA512:
-  metadata.gz: dd04ecd384ee403c933e1d954c895cb164b43f6704a693284a161230d0a4effc3592b28dbbc380a3d88d26ebfbc436e4af637d27bf4f027d795e9799a61d82fd
-  data.tar.gz: 5ece42acdb5b91d10cb9da1bae86de4adf104d178200cce7916fe87448e6f25aeff4fe0bc88365d93691cf4c56459812bf88bb690f0978e3f654456c3593fe4e
+  metadata.gz: aab1bfc777adc31cfbd2f25c18d9d0951f165fde6756de153ed392a89be0570e0749db475f4a464de3ff69b7766333c8ee369325b3c8b90b1d1d73e7c065e4b1
+  data.tar.gz: 71602fa03c0ef3253b1f71126e48f2933ce18d3503d6a8026272d6013fb647341de2649ee3b58887abe291626fdd3c3f3f1a93850510d5958341c57c9088d493

data/README.md

@@ -18,12 +18,55 @@ 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"
 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")
+```
+
+## Errors:
+Errors could be one of the following:
+
+```ruby
+AuthenticationError
+InvalidRequestError (With `param` attribute)
+APIError
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome.

data/lib/paymob_ruby/errors.rb

@@ -61,18 +61,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/version.rb

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

data/lib/paymob_ruby.rb

@@ -9,11 +9,11 @@ require_relative "paymob_ruby/version"
 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"
+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"
 
 module PaymobRuby
   BASE_URI = "https://accept.paymobsolutions.com/api"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paymob_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Joe Kaldas
@@ -46,13 +46,15 @@ files:
 - 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/errors.rb
 - lib/paymob_ruby/version.rb
+- paymob_ruby-0.1.0.gem
+- paymob_ruby-0.1.1.gem
 - sig/paymob.rbs
 homepage: https://github.com/JoeKaldas/paymob
 licenses: