paynl 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 597bdb4dd6e58b7935e11868bb68fe0cc4d4d270
-  data.tar.gz: 157694b909a3c50486203eebe04362906fe8e904
+  metadata.gz: cefd0030debec27da0ed3b2b88b0f3c9ae94a4b9
+  data.tar.gz: 9a2fd0ccbe739aabeb9cf80c45e704c72911312b
 SHA512:
-  metadata.gz: 1827605f64419ce0c155a09c2405f97bd5276f96e5d2bb1ab6ad14dc0ac3964f814051f19470699718055f611413442b6ef0e2d203fed9408f4c99784ae2c575
-  data.tar.gz: be136dfc0bf3af14525a17f86ae1ce0679ca626b69a79459cc134aefbfa7a0981bd4739c6a21cd90709446546aac7741bc981980cb4f94e2ea511ea7b6e8a3fe
+  metadata.gz: 47aad5fa655a8e502c277149a81a42b6521976a73596a9b468ff94420a81eac1a169bda4f52654921ea88a38677f4d98b12dd13cfde1da9630166bfb3b4a260d
+  data.tar.gz: cd32b835f675913318ddbb24e8542708751466629e1ead24994d13bf2b4b3c2a00e74caf3ff16207a1a56b4b8c9a496c41ae2c07910b9fadbaa231d410db79f6

data/README.md

@@ -30,16 +30,152 @@ Or install it yourself as:
 
 ## Requirements
 This gem requires Ruby 1.9.2+.
+We have tested this gem with Ruby 2.2.1.
 
 ## Usage
 
-TODO: Write usage instructions here
+Loading the gem (after installation):
+```ruby
+require 'paynl'
+```
+
+Setting the configuration:
+```ruby
+require 'paynl'
+
+Paynl::Config::setApiToken('e41f83b246b706291ea9ad798ccfd9f0fee5e0ab')
+Paynl::Config::setServiceId('SL-3490-4320')
+```
+
+Getting a list of available payment methods for your site:
+```ruby
+require 'paynl'
 
-## Development
+Paynl::Config::setApiToken('e41f83b246b706291ea9ad798ccfd9f0fee5e0ab')
+Paynl::Config::setServiceId('SL-3490-4320')
+api = Paynl::Paymentmethods.new
+options = Hash.new
+puts api.getList(options)
+```
+
+Starting a transaction:
+```ruby
+require 'paynl'
+
+Paynl::Config::setApiToken('e41f83b246b706291ea9ad798ccfd9f0fee5e0ab')
+Paynl::Config::setServiceId('SL-3490-4320')
+
+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')
+options.store('language','EN')
+
+# 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')
+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']
+```
 
-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.
+To determine if a transaction has been paid, you can use:
+```ruby
+require 'paynl'
+
+Paynl::Config::setApiToken('e41f83b246b706291ea9ad798ccfd9f0fee5e0ab')
+Paynl::Config::setServiceId('SL-3490-4320')
+
+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
+```
 
-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).
+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')
+
+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
 

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/helper.rb

@@ -44,10 +44,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 +56,22 @@ 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 result['paymentDetails']['stateName'] == 'PENDING'
+      if transaction['paymentDetails']['stateName'] == 'PENDING'
+        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 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.0'
 end

data/paynl.gemspec

@@ -22,7 +22,6 @@ 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) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paynl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sebastian Berm