gopay-ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7ba20408322f371b9de9e36af01afb3e02c7638
-  data.tar.gz: 29a80a9197e1125a353a6837428b692d18fe5e0d
+  metadata.gz: 29758303f4240c5454eda97ba81cd6dd21e256fc
+  data.tar.gz: 0528b98ea9cb686ce4de2b9da133e0e8cef91560
 SHA512:
-  metadata.gz: 67f6cc99c7be3fc151a43c4976257135f9a0618b0f6fa8ea5e5362f882d978ca69ecdbb8b8484b1966ab2569a9361f45eb0a047d4d43a1a1dc4036c53abfdcc2
-  data.tar.gz: dac32604cb0813f31c57ce474a5aa94833d5a1addc3ead785624302a1c0ac6b5f85fc5bcdd3f265404d1279432e6c073be7c6deeeb73bfdd1766f9646909e5c7
+  metadata.gz: 007ed3780d3cfc8a375a49e548c661e1e3351d4f135b0564120ae64a224b12d4f43fc8fef2be3af4989ffde7bf7990c360cc63743eb5f43489928b9a1ba83036
+  data.tar.gz: dd7379e99b17452b379da4412ba1bcd7647c0f9180650f82308fb92b1b35ade09b465f66e1d18bf9ec0a17235dd2bd5a4e70f946a1a73dcc4368d9600042247e

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.DS_Store
 .DS_Store
 *.gem
 *.rbc

data/.travis.yml

@@ -6,7 +6,6 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
-  - jruby-head
   - rbx-2
   - ruby-head
 

data/README.md

@@ -2,18 +2,20 @@
 
 [![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)
-[![Dependency Status](https://gemnasium.com/PrimeHammer/gopay-ruby.png)](https://gemnasium.com/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/PrimeHammer/gopay-ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/PrimeHammer/gopay-ruby?branch=master)
 
-Unofficial wrapper for GoPay REST API
+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.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'gopay-ruby'
+gem 'gopay-ruby', require: 'gopay'
+
 ```
 
 And then execute:
@@ -24,14 +26,118 @@ 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
+```
+
+```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
+```
+
 ## Usage
 
-### Retrieve a payment
+### 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.
+
+```ruby
+GoPay::Payment.create payment_data
+```
+
+### payment_data example
+
+```ruby
+{
+  "payer":{"allowed_payment_instruments": ["BANK_ACCOUNT"],
+            "contact":{"first_name": "John",
+                       "last_name": "Doe",
+                       "email": "john.doe@example.com"
+                      }
+          },
+  "target":{"type": "ACCOUNT",
+            "goid": "8123456789"
+           },
+  "amount":"1000",
+  "currency":"CZK",
+  "order_number":"001",
+  "order_description":"description001",
+  "callback":{"return_url":"url.for.return",
+              "notification_url":"url.for.notification"
+             },
+  "lang":"en"
+}
+```
+
+### Create a Payment response example
+This is a basic example of response hash, for more complex examples visit [GoPay API docs](https://doc.gopay.com).
+```ruby
+{
+  "id":3000006529,
+  "order_number":"001",
+  "state":"CREATED",
+  "amount":1000,"currency":"CZK",
+  "payer":{"allowed_payment_instruments":["BANK_ACCOUNT"],
+           "contact": {"first_name":"John",
+                       "last_name":"Doe",
+                       "email":"john.doe@example.com",
+                      }
+          },
+  "target":{"type":"ACCOUNT",
+            "goid":8123456789
+           },
+  "additional_params":[{"name":"invoicenumber",
+                        "value":"2015001003"
+                      }],
+  "lang":"en",
+  "gw_url":" https://gw.sandbox.gopay.com/gw/v3/bCcvmwTKK5hrJx2aGG8ZnFyBJhAvF"
+}
+```
+
+### Retrieve the Payment
+If you want to return a payment object from GoPay REST API.
+
+```ruby
+GoPay::Payment.retrieve gopay_id
+```
+
+### Refund of the payment
+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
+```
+
+### 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
+```
+
+## Dealing with errors
+Errors are raised as GoPay::Error. The error contains error code error body returned by GoPay API.
+You can easily catch errors in your models as shown below.
 
 ```ruby
-GoPay::Payment.retrieve 35345534
+begin
+  response = GoPay::Payment.refund(gopay_id, gopay_amount)
+rescue GoPay::Error => exception
+  log_gopay_error exception
+end
 ```
 
+## Documentation
+Parameters for all GoPay methods follow the official documentation. For further explanation please visit [GoPay API docs](https://doc.gopay.com).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/PrimeHammer/gopay-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/gopay/payment.rb

@@ -19,5 +19,10 @@ module GoPay
     def self.refund(id, amount)
       GoPay.request :post, "/api/payments/payment/#{id}/refund", body_parameters: { amount: amount }
     end
+
+    def self.create_recurrence(original_payment_id, recurring_payment_data)
+      GoPay.request :post, "/api/payments/payment/#{original_payment_id}/create-recurrence", body_parameters: recurring_payment_data
+    end
+
   end
 end

data/lib/gopay/version.rb

@@ -1,8 +1,8 @@
 module GoPay
   class Version
     MAJOR = 0
-    MINOR = 1
-    PATCH = 1
+    MINOR = 2
+    PATCH = 0
 
     class << self
       def to_s

data/lib/gopay.rb

@@ -36,7 +36,11 @@ module GoPay
     end
 
     def get_content_type(path)
-      path == '/api/payments/payment' ? 'application/json' : 'application/x-www-form-urlencoded'
+      if (path == '/api/payments/payment') || (path =~ /create-recurrence/)
+        'application/json'
+      else
+        'application/x-www-form-urlencoded'
+      end
     end
 
     # payment-create - for new payment

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gopay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - David Hrachovy & Ondrej Zadnik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,7 +45,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".coveralls.yaml"
 - ".gitignore"
 - ".rspec"
@@ -55,9 +54,7 @@ files:
 - README.md
 - Rakefile
 - gopay.gemspec
-- lib/.DS_Store
 - lib/gopay.rb
-- lib/gopay/.DS_Store
 - lib/gopay/error.rb
 - lib/gopay/payment.rb
 - lib/gopay/version.rb
@@ -81,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Unofficial wrapper for GoPay REST API