paynl 0.1.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 597bdb4dd6e58b7935e11868bb68fe0cc4d4d270
-  data.tar.gz: 157694b909a3c50486203eebe04362906fe8e904
+SHA256:
+  metadata.gz: 4519098345b93aafef2fdca13a3db5539c1409d8c90fba79b93ec20e27e9b4a7
+  data.tar.gz: 206a0cf8f40ab3680af5b28f6d9a890384d2b1a064f0026af89ea2b2b8efc78d
 SHA512:
-  metadata.gz: 1827605f64419ce0c155a09c2405f97bd5276f96e5d2bb1ab6ad14dc0ac3964f814051f19470699718055f611413442b6ef0e2d203fed9408f4c99784ae2c575
-  data.tar.gz: be136dfc0bf3af14525a17f86ae1ce0679ca626b69a79459cc134aefbfa7a0981bd4739c6a21cd90709446546aac7741bc981980cb4f94e2ea511ea7b6e8a3fe
+  metadata.gz: 4a696a0a1a098a624d4c6783bc297eeb3344cfdd7f7a438e277fe2df22763779d68d2401bf89de756ccee6d763fb3bd88c8f87dfad0c0b6f2b6fe15dfcfdf8e8
+  data.tar.gz: cac50aea97db25bbc4ba871431153d332d97856de07a0a49d6f55c2c33c988710b778f1f6da0069046ee7461cdf3962ac400420dc96b6b10e8b8167b1d611375

data/.gitlab-ci.yml

@@ -0,0 +1,41 @@
+image: "ruby:2.7"
+
+
+before_script:
+  - ruby -v  # Print out ruby version for debugging
+  - bundle install
+  - gem install rspec
+  - mkdir ~/.gem || true
+  - touch ~/.gem/credentials || true
+  - url_host=`git remote get-url origin | sed -e "s/https:\/\/gitlab-ci-token:.*@//g"`
+    # runner runs on a detached HEAD, checkout current branch for editing
+  - git reset --hard
+  - git clean -fd
+  - git checkout $CI_COMMIT_REF_NAME
+  - git pull origin $CI_COMMIT_REF_NAME
+  - |-
+     echo "---
+     :rubygems_api_key: $RUBYGEM_KEY" > ~/.gem/credentials
+  - chmod 600 ~/.gem/credentials
+
+rspec:
+  stage: test
+  script:
+    - rspec spec
+
+build:
+  stage: build
+  script:
+    - rake build
+
+prepare_deployment:
+  stage: deploy
+  only:
+    - web
+  script:
+    - rake spec
+    - rake build
+    - git config --global user.email "sebastian@sebsoft.nl"
+    - git config --global user.name "Sebastian Berm"
+    - git remote set-url origin "https://$GIT_ACCESS_USER:$GIT_ACCESS_PASSWORD@${url_host}"
+    - rake release

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
-before_install: gem install bundler -v 1.11.2
+  - 2.5
+  - 2.6
+  - 2.7
+before_install: gem install bundler

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem 'coveralls', require: false
+
 # Specify your gem's dependencies in paynl.gemspec
 gemspec

data/README.md

@@ -1,3 +1,4 @@
+[![Build Status](https://travis-ci.org/paynl/ruby-sdk.svg?branch=master)](https://travis-ci.org/paynl/ruby-sdk) [![Coverage Status](https://coveralls.io/repos/github/paynl/ruby-sdk/badge.svg?branch=master)](https://coveralls.io/github/paynl/ruby-sdk?branch=master)
 # Pay.nl SDK in Ruby
 
 ---
@@ -29,17 +30,158 @@ Or install it yourself as:
     $ gem install paynl
 
 ## Requirements
-This gem requires Ruby 1.9.2+.
+This gem requires Ruby 2.5+.
+We have tested this gem with Ruby 2.5, 2.6 and 2.7.
 
 ## Usage
 
-TODO: Write usage instructions here
+Loading the gem (after installation):
+```ruby
+require 'paynl'
+```
+
+Setting the configuration:
+```ruby
+require 'paynl'
 
-## Development
+Paynl::Config::setApiToken('e41f83b246b706291ea9ad798ccfd9f0fee5e0ab')
+Paynl::Config::setServiceId('SL-3490-4320')
+Paynl::Config::setTokenCode('AT-code-here')
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Getting a list of available payment methods for your site:
+```ruby
+require 'paynl'
+
+Paynl::Config::setApiToken('e41f83b246b706291ea9ad798ccfd9f0fee5e0ab')
+Paynl::Config::setServiceId('SL-3490-4320')
+Paynl::Config::setTokenCode('AT-code-here')
+api = Paynl::Paymentmethods.new
+options = Hash.new
+puts api.getList(options)
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Starting a transaction:
+```ruby
+require 'paynl'
+
+Paynl::Config::setApiToken('e41f83b246b706291ea9ad798ccfd9f0fee5e0ab')
+Paynl::Config::setServiceId('SL-3490-4320')
+Paynl::Config::setTokenCode('AT-code-here')
+
+data = Paynl::Transaction.new
+options = Hash.new
+# Required values
+options.store('amount', 6.21)
+options.store('returnUrl', 'http://some.url.for.your.system.example.org/visitor-return-after-payment')
+options.store('ipaddress', '127.0.0.1')
+
+
+# Optional values
+options.store('paymentMethod', 10)
+options.store('description', 'demo payment')
+options.store('testMode', true)
+options.store('extra1', 'ext1')
+options.store('extra2', 'ext2')
+options.store('extra3', 'ext3')
+
+# First product
+products = Hash.new
+product = Hash.new
+product.store('id', '234567')
+product.store('price', 1.21)
+product.store('tax', 0.21)
+product.store('name', 'Testproduct voor de demo tour')
+product.store('qty', 1)
+products.store(products.length + 1, product)
+
+# Second product
+product = Hash.new
+product.store('id', '2')
+product.store('price', 5.00)
+product.store('tax', 0.87)
+product.store('name', 'Testproduct 2 voor de demo tour')
+product.store('qty', 1)
+products.store(products.length + 1, product)
+options.store('products', products)
+
+# Enduser data
+enduser = Hash.new
+enduser.store('initials', 'T')
+enduser.store('lastName', 'Test')
+enduser.store('gender', 'M')
+enduser.store('dob', '14-05-1999')
+enduser.store('phoneNumber', '0612345678')
+enduser.store('emailAddress', 'test@example.org')
+enduser.store('language','EN')
+options.store('enduser', enduser)
+
+# Address data
+address = Hash.new
+address.store('streetName', 'Test')
+address.store('houseNumber', '10')
+address.store('zipCode', '1234AB')
+address.store('city', 'Test')
+address.store('country', 'NL')
+options.store('address', address)
+
+invoiceAddress = Hash.new
+invoiceAddress.store('initials', 'IT')
+invoiceAddress.store('lastName', 'ITTest')
+invoiceAddress.store('streetName', 'ITest')
+invoiceAddress.store('houseNumber', '15')
+invoiceAddress.store('zipCode', '1234CC')
+invoiceAddress.store('city', 'TTest')
+invoiceAddress.store('country', 'NL')
+options.store('invoiceAddress', invoiceAddress)
+
+result = data.start(options)
+
+# Store the transaction ID which is in
+puts result['transaction']['transactionId']
+
+# Redirect the user to the URL
+puts result['transaction']['paymentURL']
+```
+
+To determine if a transaction has been paid, you can use:
+```ruby
+require 'paynl'
+
+Paynl::Config::setApiToken('e41f83b246b706291ea9ad798ccfd9f0fee5e0ab')
+Paynl::Config::setServiceId('SL-3490-4320')
+Paynl::Config::setTokenCode('AT-code-here')
+
+data = Paynl::Transaction.new
+result = data.getTransaction(transactionId)
+if Paynl::Helper::transactionIsPaid(result) or Paynl::Helper::transactionIsPending(result)
+    # redirect user to thank you page
+else
+    # it has not been paid yet, so redirect user back to checkout
+end
+```
+
+When implementing the exchange script (where you should process the order in your backend):
+```ruby
+require 'paynl'
+
+Paynl::Config::setApiToken('e41f83b246b706291ea9ad798ccfd9f0fee5e0ab')
+Paynl::Config::setServiceId('SL-3490-4320')
+Paynl::Config::setTokenCode('AT-code-here')
+
+data = Paynl::Transaction.new
+result = data.getTransaction(transactionId)
+if Paynl::Helper::transactionIsPaid(result)
+    # Process the payment
+elsif Paynl::Helper::transactionIsCanceled(result)
+    # Payment canceled, restock items
+end
+
+puts 'TRUE| ' 
+# Optionally you can send a message after TRUE|, you can view these messages in the logs.
+# https://admin.pay.nl/logs/payment_state
+puts 'Paid: ' + Paynl::Helper::transactionIsPaid(result).to_s
+```
 
 ## Contributing
 
@@ -48,4 +190,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/paynl/
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/paynl.rb

@@ -1,21 +1,21 @@
 require 'yaml'
 require 'typhoeus'
 require 'json'
-require 'paynl/api/api'
-require 'paynl/error/required/serviceiderror'
-require 'paynl/error/required/apitokenerror'
-require 'paynl/error/requirederror'
-require 'paynl/helper'
-require 'paynl/version'
-require 'paynl/api/validate/is_pay_server_ip'
-require 'paynl/api/validate/get_pay_server_ips'
-require 'paynl/api/transaction/get_service'
-require 'paynl/api/transaction/start_transaction'
-require 'paynl/api/transaction/info'
-require 'paynl/api/transaction/refund'
-require 'paynl/api/api'
-require 'paynl/config'
-require 'paynl/transaction'
-require 'paynl/paymentmethods'
-require 'paynl'
+require_relative 'paynl/api/api'
+require_relative 'paynl/error/required/serviceiderror'
+require_relative 'paynl/error/required/apitokenerror'
+require_relative 'paynl/error/requirederror'
+require_relative 'paynl/helper'
+require_relative 'paynl/version'
+require_relative 'paynl/api/validate/is_pay_server_ip'
+require_relative 'paynl/api/validate/get_pay_server_ips'
+require_relative 'paynl/api/transaction/get_service'
+require_relative 'paynl/api/transaction/start_transaction'
+require_relative 'paynl/api/transaction/info'
+require_relative 'paynl/api/transaction/refund'
+require_relative 'paynl/api/api'
+require_relative 'paynl/config'
+require_relative 'paynl/transaction'
+require_relative 'paynl/paymentmethods'
+require_relative 'paynl'
 

data/lib/paynl/api/api.rb

@@ -1,11 +1,11 @@
 module Paynl
   module Api
     class Api
-      @version = 1;
+      @version = 1
       @@data = Hash.new
 
-      @apiTokenRequired = false;
-      @serviceIdRequired = false;
+      @apiTokenRequired = false
+      @serviceIdRequired = false
 
       def isApiTokenRequired
         return @apiTokenRequired
@@ -17,13 +17,13 @@ module Paynl
       end
 
       def getData
-        if self.isApiTokenRequired
+        if isApiTokenRequired
           Paynl::Helper::requireApiToken
 
           @@data['token'] = Paynl::Config::getApiToken
         end
 
-        if self.isServiceIdRequired
+        if isServiceIdRequired
           Paynl::Helper::requireServiceId
 
           @@data['serviceId'] = Paynl::Config::getServiceId
@@ -42,15 +42,27 @@ module Paynl
 
       def doRequest(endpoint, version = nil)
 
-        data = self.getData
+        data = getData
         uri = Paynl::Config::getApiUrl(endpoint, version)
-        # puts uri
-        # puts data
-        # Code to actually do the CURL request
-        response = Typhoeus::Request.post(
-            uri,
-            :params => data
-        )
+        #puts uri
+        #puts data
+
+        if isServiceIdRequired
+          # Code to actually do the CURL request
+          response = Typhoeus::Request.post(
+              uri,
+              params: data,
+              userpwd: Paynl::Config::getTokenCode + ':' + Paynl::Config::getApiToken,
+              :headers => { 'User-Agent' => 'Ruby SDK ' + VERSION }
+          )          
+        else
+          # Code to actually do the CURL request
+          response = Typhoeus::Request.post(
+              uri,
+              params: data,
+              :headers => { 'User-Agent' => 'Ruby SDK ' + VERSION }
+          )
+        end
 
         # if response.code != 200
         #   raise 'API error'
@@ -62,10 +74,10 @@ module Paynl
         # puts response.headers_hash # http headers put into a hash
         # puts response.body    # the response body
 
-        output = self.processResult(JSON.parse(response.body))
+        output = processResult(JSON.parse(response.body))
         return output
 
       end
     end
   end
-end
+end

data/lib/paynl/api/transaction/get_service.rb

@@ -14,7 +14,7 @@ module Paynl
 
       def doRequest
         # TODO: add caching to this
-        return super('transaction/getService', nil)
+        return super('transaction/getService', 16)
       end
     end
   end

data/lib/paynl/api/transaction/refund.rb

@@ -38,7 +38,7 @@ module Paynl
       end
 
       def doRequest
-        return super('transaction/refund', nil)
+        return super('transaction/refund', 15)
       end
     end
   end

data/lib/paynl/api/transaction/start_transaction.rb

@@ -157,7 +157,7 @@ module Paynl
         end
 
         unless @paymentOptionId.nil?
-          @@data['paymentOptionsId'] = @paymentOptionId
+          @@data['paymentOptionId'] = @paymentOptionId
         end
 
         if @finishUrl.nil?

data/lib/paynl/config.rb

@@ -1,10 +1,21 @@
 module Paynl
   class Config
     @@apiToken=''
+    @@tokenCode=''
     @@serviceId=''
     @@apiBase='https://rest-api.pay.nl'
     @@apiVersion=5
 
+    # getTokenCode - Retrieves Pay.nl tokencode
+    def self.getTokenCode
+      return @@tokenCode
+    end
+
+    # setTokenCode - Sets Pay.nl tokencode
+    def self.setTokenCode(tokenCode)
+      @@tokenCode = tokenCode
+    end
+
     # getApiToken - Retrieves Pay.nl api token
     def self.getApiToken
       return @@apiToken

data/lib/paynl/helper.rb

@@ -2,11 +2,17 @@ module Paynl
   class Helper
     def self.requireApiToken
       apiToken = Paynl::Config::getApiToken
+      tokenCode = Paynl::Config::getTokenCode
 
       # Hmm, porting PHP to Ruby is crap if you want to keep the structure
       if apiToken == nil? or apiToken == ''
         raise Paynl::Error::Required::ApiTokenError, 'Api token is required'
       end
+
+      if tokenCode == nil? or tokenCode == ''
+        raise Paynl::Error::Required::ApiTokenError, 'Api token code (AT-code) is required'
+      end
+      
     end
 
     def self.requireServiceId
@@ -29,7 +35,7 @@ module Paynl
       # Setup basic taxClasses (like in the PHP SDK)
       taxClasses = Hash.new
       taxClasses.store(0, 'N')
-      taxClasses.store(6, 'L')
+      taxClasses.store(9, 'L')
       taxClasses.store(21, 'H')
 
       if (taxAmount == 0 || amountInclTax == 0)
@@ -44,10 +50,10 @@ module Paynl
 
     def self.transactionIsPaid(transaction)
       unless transaction.is_a? Hash
-        raise("Please give me the output of the Paynl::Transaction::getTransaction function")
+        raise('Please give me the output of the Paynl::Transaction::getTransaction function')
       end
 
-      if result['paymentDetails']['stateName'] == 'PAID'
+      if transaction['paymentDetails']['stateName'] == 'PAID'
         return true
       end
 
@@ -56,10 +62,25 @@ module Paynl
 
     def self.transactionIsPending(transaction)
       unless transaction.is_a? Hash
-        raise("Please give me the output of the Paynl::Transaction::getTransaction function")
+        raise('Please give me the output of the Paynl::Transaction::getTransaction function')
+      end
+
+      if transaction['paymentDetails']['stateName'] == 'PENDING'
+        return true
+      end
+      if transaction['paymentDetails']['stateName'] == 'VERIFY'
+        return true
+      end
+
+      return false
+    end
+
+    def self.transactionIsCanceled(transaction)
+      unless transaction.is_a? Hash
+        raise('Please give me the output of the Paynl::Transaction::getTransaction function')
       end
 
-      if result['paymentDetails']['stateName'] == 'PENDING'
+      if transaction['paymentDetails']['stateName'] == 'CANCEL'
         return true
       end
 

data/lib/paynl/version.rb

@@ -1,3 +1,3 @@
 module Paynl
-  VERSION = "0.1.1"
+  VERSION = '1.0.4'
 end

data/paynl.gemspec

@@ -22,13 +22,12 @@ Gem::Specification.new do |spec|
   #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   # end
 
-  # Had to comment the next line to get this working correctly on Windows 10 in RubyMine
   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", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   # spec.add_development_dependency "spec"
   # spec.add_development_dependency "spectask"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paynl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.4
 platform: ruby
 authors:
 - Sebastian Berm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
@@ -119,8 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple interface to create transactions for the Pay.nl PSP