gopay-ruby 0.3.0 → 0.4.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3e34205c1824d0fa8554f7d1b2aa07c1d319ec5e
-  data.tar.gz: 11a370a101de525db3488b608e361cafa44d3b3c
+SHA256:
+  metadata.gz: 3c5d871fa56f9ff5b430c311521f6baf459163e70002a4bd55e9de4a7890a11e
+  data.tar.gz: 8fe34a47178bc633ae2c00ffb88014239c9409f31016a87653df0b16220707e7
 SHA512:
-  metadata.gz: a99ff0a1ff750b90cd37b3b32b88ab59b79d85aa4e4e24eb4b5884cc34f5b85a065a0306942b7c4f336beffdf16812aeda34bff551821ff2c6c7e771df43cfbf
-  data.tar.gz: 69197fe9d22d06841a90e780e58e829f3c329ac5c59726a33cea6a50ac956bac80359109a1be3fdc5001dba1dac59d74bda9ac2cdea0ee3fe43667d9dcbd79f0
+  metadata.gz: 7f1e7623ad8f437d3aa18ffe16d16a8d9ffeb49060055ec2e80a964c858f836a61ae8a1fb931a89958cee94476caaf560937bce3155d656d36c053d5c7e544c5
+  data.tar.gz: 21bc88b460bd2bb89e909b8a2ddd7e50179480ac180044618f4c3f50d90e02b643e2c8efa030340d73dcd977b34574ece3791a9dcfa4b941f3e0d0112edec5b2

data/.gitignore

@@ -10,4 +10,5 @@
 *.DS_Store
 .DS_Store
 *.gem
-*.rbc
+*.rbc
+.env

data/.travis.yml

@@ -3,23 +3,11 @@ cache: bundler
 language: ruby
 
 rvm:
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - rbx-2
+  - 2.4
+  - 2.5
+  - 2.6
   - ruby-head
 
 sudo: false
 
-bundler_args: --without development --retry=3 --jobs=3
-
-env:
-  global:
-    - JRUBY_OPTS="$JRUBY_OPTS --debug"
-
-matrix:
-  allow_failures:
-    - rvm: jruby-head
-    - rvm: rbx-2
-    - rvm: ruby-head
-  fast_finish: true
+bundler_args: --without development --retry=3 --jobs=3

data/Gemfile

@@ -5,7 +5,8 @@ gem 'rspec'
 gem 'vcr'
 gem 'webmock'
 gem 'addressable'
-gem "coveralls"
+gem 'dotenv'
+gem "coveralls", require: false
 gem "simplecov"
 
 # Specify your gem's dependencies in gopay-ruby.gemspec

data/README.md

@@ -3,11 +3,12 @@
 [![Gem Version](https://badge.fury.io/rb/gopay-ruby.png)](http://badge.fury.io/rb/gopay-ruby)
 [![Build Status](https://travis-ci.org/PrimeHammer/gopay-ruby.png?branch=master)](https://travis-ci.org/PrimeHammer/gopay-ruby)
 [![Code Climate](https://codeclimate.com/github/PrimeHammer/gopay-ruby.png)](https://codeclimate.com/github/PrimeHammer/gopay-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/PrimeHammer/gopay-ruby/badge.svg?branch=master)](https://coveralls.io/github/PrimeHammer/gopay-ruby?branch=master)
 
 The GoPay Ruby allows Ruby applications to access to the GoPay REST API.
 
 ## Benefits
-It does OAuth authorization under the hood automatically. Easy configuration through initializer.
+It does authorization under the hood automatically, supports multiple accounts. Easy configuration.
 
 ## Installation
 
@@ -26,33 +27,30 @@ Or install it yourself as:
 
     $ gem install gopay-ruby
 
-## Configure
-The Gem is framework agnostic. However, if you use Rails, put the initializer in Rails config dir:
-```ruby
-config/initializers/gopay.rb
-```
+
+
+## Usage
+
+### Gateway
+
+Before creating a payment, use Gateway object to configure your access to GoPay:
 
 ```ruby
-GoPay.configure do |config|
-  config.goid = GOPAY_ID
-  config.client_id = GOPAY_CLIENT_ID
-  config.client_secret = GOPAY_SECRET
-  config.return_host = RETURN_HOST_URL
-  config.notification_host = NOTIFICATION_HOST_URL
-  config.gate = GATE_URL
-end
+gateway = GoPay::Gateway.new(gate: 'https://testgw.gopay.cz', goid: 123, client_id: 456, client_secret: 'xxx')
 ```
 
-## Usage
+The values above are just examples. Note that you can use multiple Gateway objects to connect to different accounts. With one Gateway, you can do multiple requests.
+
 
 ### Create a Payment
-Before charging a user, we need to create a new payment. This will return a hash including a URL which you can use to popup payment modal or redirect the user to the GoPay payment page.
+
+Before charging a user, we need to create a new payment using our `gateway` object. The method will return a hash including a URL which you can use to popup payment modal or redirect the user to the GoPay payment page.
 
 ```ruby
-GoPay::Payment.create payment_data
+gateway.create payment_data
 ```
 
-### payment_data example
+#### payment_data example
 
 ```ruby
 {
@@ -76,7 +74,7 @@ GoPay::Payment.create payment_data
 }
 ```
 
-### Create a Payment response example
+#### Response example
 This is a basic example of response hash, for more complex examples visit [GoPay API docs](https://doc.gopay.com).
 ```ruby
 {
@@ -105,7 +103,7 @@ This is a basic example of response hash, for more complex examples visit [GoPay
 If you want to return a payment object from GoPay REST API.
 
 ```ruby
-GoPay::Payment.retrieve gopay_id
+gateway.retrieve gopay_id
 ```
 
 ### Refund of the payment
@@ -113,14 +111,14 @@ This functionality allows you to refund payment paid by a customer.
 You can use the refund in two ways. First option is a full refund payment and the other one is a partial refund. Both based on `amount` parameter.
 
 ```ruby
-GoPay::Payment.refund gopay_id, amount
+gateway.refund gopay_id, amount
 ```
 
 ### Cancellation of the recurring payment
 The functionality allows you to cancel recurrence of a previously created recurring payment.
 
 ```ruby
-GoPay::Payment.void_recurrence gopay_id
+gateway.void_recurrence gopay_id
 ```
 
 ## Dealing with errors
@@ -129,13 +127,78 @@ You can easily catch errors in your models as shown below.
 
 ```ruby
 begin
-  response = GoPay::Payment.refund(gopay_id, gopay_amount)
+  response = gateway.refund(gopay_id, gopay_amount)
 rescue GoPay::Error => exception
   log_gopay_error exception
 end
 ```
 
-## Documentation
+
+## Testing
+
+Use these env variables in `.env` file:
+
+```
+GOPAY_GATE='https://testgw.gopay.cz'
+
+GOPAY_1_GOID=1111111111
+GOPAY_1_CLIENT_ID=1
+GOPAY_1_CLIENT_SECRET=x
+
+GOPAY_2_GOID=2222222222
+GOPAY_2_CLIENT_ID=2
+GOPAY_2_CLIENT_SECRET=x
+```
+
+Then run:
+
+```ruby
+bundle exec rspec
+```
+
+
+### Upgrading 
+
+#### 0.4.0
+
+In short, using `GoPay` class and `GoPay::Payment` was deprecated.
+
+Using `GoPay.configure` and `GoPay.request` is discouraged in favor of `Gateway` object. Instead of this:
+
+```ruby
+GoPay.configure do |config|
+  config.goid = GOPAY_ID
+  config.client_id = GOPAY_CLIENT_ID
+  config.client_secret = GOPAY_SECRET
+  config.return_host = RETURN_HOST_URL
+  config.notification_host = NOTIFICATION_HOST_URL
+  config.gate = GATE_URL
+end
+```
+
+please use `Gateway` object:
+
+```ruby
+gateway = GoPay::Gateway.new(gate: GATE_URL, goid: GOPAY_ID, client_id: GOPAY_CLIENT_ID, client_secret: GOPAY_SECRET)
+```
+
+`return_host` and `notification_host` will be deprecated as well.
+
+Also `GoPay::Payment` will be deprecated. Instead of this:
+
+```ruby
+GoPay::Payment.retrieve gopay_id
+```
+
+use `Gateway` for creating payments, retrieval, refunds:
+
+```ruby
+gateway.retrieve gopay_id
+```
+
+
+
+## Full Documentation
 Parameters for all GoPay methods follow the official documentation. For further explanation please visit [GoPay API docs](https://doc.gopay.com).
 
 ## Contributing

data/gopay.gemspec

@@ -8,16 +8,15 @@ Gem::Specification.new do |spec|
   spec.version       = GoPay::Version
   spec.authors       = ["David Hrachovy & Ondrej Zadnik"]
   spec.email         = ["david.hrachovy@gmail.com"]
-
   spec.summary       = %q{Unofficial wrapper for GoPay REST API}
   spec.description   = %q{Unofficial wrapper for GoPay REST API}
   spec.homepage      = "https://github.com/PrimeHammer/gopay-ruby"
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.4'
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.add_development_dependency "bundler"
-  spec.add_dependency 'unirest', '~> 1.1'
+  spec.add_dependency 'rest-client', '~> 2.1.0'
 end

data/lib/gopay/client.rb

@@ -0,0 +1,67 @@
+require 'rest-client'
+
+module GoPay
+  class Client
+    def initialize(config)
+      @config = config
+    end
+
+    def request(method, path, body_parameters: {})
+      token = token get_token_scope(method, path)
+      content_type = get_content_type(path)
+
+      body_parameters = content_type == 'application/json' ? body_parameters.to_json : from_hash_to_query(body_parameters)
+
+      begin
+        response = RestClient::Request.execute(method: method, url: @config[:gate]+path, payload: body_parameters, headers: { "Accept" => "application/json", "Content-Type" => content_type, "Authorization" => "Bearer #{token}" })
+      rescue RestClient::ExceptionWithResponse => e
+        raise Error.handle_gopay_error(e.response)
+      end
+
+      unless response.code == 200
+        raise Error.handle_gopay_error(response)
+      end
+
+      JSON.parse response.body
+    end
+
+    private
+
+    def get_token_scope(method, path)
+      if method == :post && path == '/api/payments/payment'
+        'payment-create'
+      else
+        'payment-all'
+      end
+    end
+
+    def get_content_type(path)
+      if (path == '/api/payments/payment') || (path =~ /create-recurrence/)
+        'application/json'
+      else
+        'application/x-www-form-urlencoded'
+      end
+    end
+
+    # payment-create - for new payment
+    # payment-all - for testing state etc
+    def token(scope = 'payment-create')
+      response = RestClient.post(
+        "#{@config[:gate]}/api/oauth2/token",
+        { grant_type: 'client_credentials',
+          scope: scope,
+        },
+        {
+          "Accept" => "application/json",
+          "Content-Type" => "application/x-www-form-urlencoded",
+          "Authorization" => "Basic #{Base64.encode64(@config[:client_id] + ':' + @config[:client_secret])}"
+        })
+      JSON.parse(response.body)["access_token"]
+    end
+
+    def from_hash_to_query(hash)
+      hash = hash == "{}" ? "{}" : URI.escape(hash.collect { |key,val| "#{CGI.escape(key.to_s)}=#{CGI.escape(val.to_s)}" }.join('&'))
+      return hash
+    end
+  end
+end

data/lib/gopay/gateway.rb

@@ -0,0 +1,25 @@
+module GoPay
+  class Gateway
+    def initialize(config)
+      @client = Client.new(config)
+      @goid = config[:goid]
+    end
+
+    def create(payment_data)
+      target = { target: { type: "ACCOUNT", goid: @goid } }
+      @client.request :post, "/api/payments/payment", body_parameters: payment_data.merge(target)
+    end
+
+    def retrieve(id)
+      @client.request :get, "/api/payments/payment/#{id}"
+    end
+
+    def refund(id, amount)
+      @client.request :post, "/api/payments/payment/#{id}/refund", body_parameters: { amount: amount }
+    end
+
+    def void_recurrence(id)
+      @client.request :post, "/api/payments/payment/#{id}/void-recurrence"
+    end
+  end
+end

data/lib/gopay/payment.rb

@@ -1,6 +1,3 @@
-require 'unirest'
-require 'gopay/error'
-
 module GoPay
   class Payment
     

data/lib/gopay/version.rb

@@ -1,12 +1,12 @@
 module GoPay
   class Version
     MAJOR = 0
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
 
     class << self
       def to_s
-        [MAJOR, MINOR, PATCH].compact.join('.')
+        [MAJOR, MINOR, PATCH].compact.join('.') + '.alpha'
       end
     end
   end

data/lib/gopay.rb

@@ -1,4 +1,7 @@
+require 'gopay/client'
 require 'gopay/payment'
+require 'gopay/gateway'
+require 'gopay/error'
 
 module GoPay
   class << self
@@ -10,56 +13,7 @@ module GoPay
   end
 
   def self.request(method, path, body_parameters: {})
-    token = token get_token_scope(method, path)
-    content_type = get_content_type(path)
-
-    body_parameters = content_type == 'application/json' ? body_parameters.to_json : from_hash_to_query(body_parameters)
-
-    response = Unirest.send(method, GoPay.gate+path, headers: { "Accept" => "application/json", "Content-Type" => content_type, "Authorization" => "Bearer #{token}" }, parameters: body_parameters)
-
-    unless response.code == 200
-      raise GoPay::Error.handle_gopay_error(response)
-    end
-
-    response.body
-  end
-
-  class << self
-    private
-
-    def get_token_scope(method, path)
-      if method == :post && path == '/api/payments/payment'
-        'payment-create'
-      else
-        'payment-all'
-      end
-    end
-
-    def get_content_type(path)
-      if (path == '/api/payments/payment') || (path =~ /create-recurrence/)
-        'application/json'
-      else
-        'application/x-www-form-urlencoded'
-      end
-    end
-
-    # payment-create - for new payment
-    # payment-all - for testing state etc
-    def token(scope = 'payment-create')
-      response = Unirest.post(
-        "#{gate}/api/oauth2/token",
-        headers: {
-          "Accept" => "application/json",
-          "Content-Type" => "application/x-www-form-urlencoded",
-          "Authorization" => "Basic #{Base64.encode64(client_id + ':' + client_secret)}"
-        },
-        parameters: "grant_type=client_credentials&scope=#{scope}")
-      response.body["access_token"]
-    end
-
-    def from_hash_to_query(hash)
-      hash = hash == "{}" ? "{}" : URI.escape(hash.collect { |key,val| "#{CGI.escape(key.to_s)}=#{CGI.escape(val.to_s)}" }.join('&'))
-      return hash
-    end
+    client = GoPay::Client.new({gate: gate, client_id: client_id, goid: goid, client_secret: client_secret})
+    client.request(method, path, body_parameters: body_parameters)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gopay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0.alpha
 platform: ruby
 authors:
 - David Hrachovy & Ondrej Zadnik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: unirest
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 2.1.0
 description: Unofficial wrapper for GoPay REST API
 email:
 - david.hrachovy@gmail.com
@@ -45,7 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yaml"
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -55,7 +55,9 @@ files:
 - Rakefile
 - gopay.gemspec
 - lib/gopay.rb
+- lib/gopay/client.rb
 - lib/gopay/error.rb
+- lib/gopay/gateway.rb
 - lib/gopay/payment.rb
 - lib/gopay/version.rb
 homepage: https://github.com/PrimeHammer/gopay-ruby
@@ -70,15 +72,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Unofficial wrapper for GoPay REST API