judopay 2.1.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ee2fddf46aa4fa23cc6e41a1bf37766134704c47
-  data.tar.gz: 41e0f0af43a8c59434748d81a4a7a2f3b3736da1
+SHA256:
+  metadata.gz: c4322bcef8c0b210b38579fe124137e8b92e9ff150f2b76449e9d91b4b5c4174
+  data.tar.gz: 29e03ee4dba7843a6417842348f77dc02eae10f1fbe25ddbc70800a5cbb1a2b3
 SHA512:
-  metadata.gz: 3b73e9514861890092abbfc44c3538298a2231ca8f296efb9cd602658c0f37061e1f1acce80b0194f0c9e55c7b8436de87130af057402038e40a025ddd703569
-  data.tar.gz: 505a41b6bfe31584202759a318fdc24369851b3d3cf12d511cbc293f4e757871384ec8fb99b1b007cb16536296851a93bab80694b6561b55d512d63f0a355a0d
+  metadata.gz: d2d9f55bd0cb4b04ad493ebd46a18ab5749e42c15302a44967679a93dc33399505fa1855bc17d81bdcc6b4136f310dd6959a7a9a408df5d4c7a1bbabafbbffa6
+  data.tar.gz: 377e8961642271df5917446752e9d09f85a27228d81c2e117fd1a8d87ae2a973493f595effa402e79a9c4fac84d82595635d8d0c004b9f23e88b2933dbbe2aae

data/.gitignore

@@ -1,23 +1,24 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-
-log.txt
-
-cmd.txt
-
-output.txt
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+log.txt
+
+cmd.txt
+
+output.txt

data/.rspec

@@ -1,2 +1,2 @@
---color
+--color
 --require spec_helper

data/.rubocop.yml

@@ -1,51 +1,54 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-06-26 17:06:45 +0100 using RuboCop version 0.23.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Lint/UnusedMethodArgument:
-  Enabled: false
-
-# Offense count: 1
-Style/CyclomaticComplexity:
-  Max: 10
-
-# Offense count: 15
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 18
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/DotPosition:
-  Enabled: false
-
-# Offense count: 73
-# Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles.
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
-# Offense count: 18
-Style/Lambda:
-  Enabled: false
-
-# Offense count: 25
-Style/LineLength:
-  Max: 138
-
-# Offense count: 3
-# Configuration parameters: CountComments.
-Style/MethodLength:
-  Max: 32
-
-# Offense count: 2
-Style/RegexpLiteral:
-  MaxSlashes: 0
-  
-AllCops:
-  Exclude:
-    - 'judopay.gemspec'
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-26 17:06:45 +0100 using RuboCop version 0.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 15
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 18
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Layout/DotPosition:
+  Enabled: false
+
+# Offense count: 73
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# Offense count: 18
+Style/Lambda:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+# Offense count: 25
+Metrics/LineLength:
+  Max: 141
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 80
+
+Metrics/BlockLength:
+  Max: 65
+  
+AllCops:
+  Exclude:
+    - 'judopay.gemspec'
+    - 'spec/factories.rb'

data/.travis.yml

@@ -1,6 +1,6 @@
-language: ruby
-rvm:
-  - 2.3.0
-  - 2.1.2
-  - 2.0.0
-sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.1.2
+  - 2.0.0
+sudo: false

data/CHANGELOG.md

@@ -1,17 +1,17 @@
-# Version 2.0.0
-
-#### Modifications
-In version 2.0 we changed error model and added couple of new models. 
-
-We decreased amount of Exceptions to two:
- - Local validation error (ValidationError)
- - ApiException which arise when Judo REST API returns error.
-
-So at first you need to update your error handling principle. See example at [Error handling](https://github.com/JudoPay/RubySdk/wiki/Error-handling).
-
-#### Additions
- - ```validate``` method added to [Collect](https://github.com/JudoPay/RubySdk/wiki/Collecting-on-a-Pre-Authorization#validating-the-collection) and [Refund](https://github.com/JudoPay/PhpSdk/wiki/Refund-a-Payment#validating-the-refund) models so now you could check yours transactions.
- - [Void model](https://github.com/JudoPay/RubySdk/wiki/Voiding-requests)
- - [Register card model](https://github.com/JudoPay/RubySdk/wiki/Registering-a-Card)
- - [Save card model](https://github.com/JudoPay/RubySdk/wiki/Saving-a-Card)
- - Integration tests
+# Version 2.0.0
+
+#### Modifications
+In version 2.0 we changed error model and added couple of new models. 
+
+We decreased amount of Exceptions to two:
+ - Local validation error (ValidationError)
+ - ApiException which arise when Judo REST API returns error.
+
+So at first you need to update your error handling principle. See example at [Error handling](https://github.com/JudoPay/RubySdk/wiki/Error-handling).
+
+#### Additions
+ - ```validate``` method added to [Collect](https://github.com/JudoPay/RubySdk/wiki/Collecting-on-a-Pre-Authorization#validating-the-collection) and [Refund](https://github.com/JudoPay/PhpSdk/wiki/Refund-a-Payment#validating-the-refund) models so now you could check yours transactions.
+ - [Void model](https://github.com/JudoPay/RubySdk/wiki/Voiding-requests)
+ - [Register card model](https://github.com/JudoPay/RubySdk/wiki/Registering-a-Card)
+ - [Save card model](https://github.com/JudoPay/RubySdk/wiki/Saving-a-Card)
+ - Integration tests

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in judopay.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in judopay.gemspec
+gemspec

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2016 Alternative Payments Ltd
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2016 Alternative Payments Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,94 +1,96 @@
-# Judopay Ruby gem [![Build Status](https://travis-ci.org/JudoPay/Judo-Ruby.svg?branch=master)](https://travis-ci.org/JudoPay/Judo-Ruby)
-The JudoPay gem provides you with ability to integrate card payments into your Ruby and Rails projects. Judo's SDK enables a faster, simpler and more secure payment experience within your app.
-##### **\*\*\*Due to industry-wide security updates, versions below 2.0 of this SDK will no longer be supported after 1st Oct 2016. For more information regarding these updates, please read our blog [here](http://hub.judopay.com/pci31-security-updates/).*****
-
-## Requirements
-The Judopay gem supports Ruby 1.9.3 and above (including 2.0.x and 2.1.x).
-
-## Getting started
-##### 1. Integration
-Add this line to your application's Gemfile:
-
-	gem 'judopay'
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install judopay
-
-##### 2. Setup
-To start using the gem, you need to pass block with your API credentials:
-```ruby
-	Judopay.configure do |config|
-	  config.judo_id = 'your-judo-id'
-	  config.api_token = 'your-token'
-	  config.api_secret = 'your-secret'
-	  config.use_production = false    # set to true on production, defaults to false which is the sandbox
-	end
-```
-
-##### 3. Make a payment
-To make a new payment with full card details:
-```ruby
-payment = Judopay::CardPayment.new(
-  :judoId => 'your_judo_id',
-  :your_consumer_reference => 'xxxxxxxx',
-  :your_payment_reference => 'xxxxxxxx',
-  :amount => 5.01,
-  :currency => 'GBP',
-  :card_number => '4976000000003436',
-  :expiry_date => '12/20',
-  :cv2 => '452',
-  :card_address => {
-    :line1 => '32 Edward Street',
-    :town => 'Camborne',
-    :postcode => 'TR14 8PA'
-  },
-  :consumer_location => {
-    :latitude => 51.5033630,
-    :longitude => -0.1276250
-  }
-)
-```
-**Note:** Please make sure that you are using a unique Consumer Reference for each different consumer, and a unique Payment Reference for each transaction.
-
-You can check on the required fields and the format of each field in the [Judopay REST API reference](https://www.judopay.com/docs/version-52/api/restful-api/#post-card-payment).
-
-To send the request to the API, call:
-```ruby
-    payment_response = payment.create
-```
-
-##### 4. Check the payment result
-If the payment is successful, you'll `payment_response` variable will contain Mash like this (see full response [here](https://www.judopay.com/docs/v5/api-reference/restful-api/#post-card-payment)):
-```ruby
-{
-  "receipt_id"=>"xxxxxxx",
-  "type"=>"Payment",
-  "created_at"=>"2016-09-23T09:28:47.1207+01:00",
-  "result"=>"Success",
-  ...
-  "amount"=>"5.01",
-  "currency"=>"GBP",
-  ...
-}
-```
-So your check code might look like this:
-```ruby
-    if result_payment.result == 'Success'
-        puts 'Payment successful'
-    else
-        puts 'There were some problems while processing your payment'
-    end
-```
-
-Also important to handle different exceptions in your code. See more details in our [error handling section](https://github.com/JudoPay/RubySdk/wiki/Error-handling). 
-
-## Next steps
-The Judopay gem supports a range of customization options. For more information on using judo see our [wiki documentation](https://github.com/JudoPay/RubySdk/wiki). 
-
-## License
-See the [LICENSE](https://github.com/JudoPay/RubySdk/blob/master/LICENSE.txt) file for license rights and limitations (MIT).
+# Judopay Ruby gem [![Build Status](https://travis-ci.org/Judopay/Judo-Ruby.svg?branch=master)](https://travis-ci.org/Judopay/Judo-Ruby)
+The JudoPay gem provides you with ability to integrate card payments into your Ruby and Rails projects. Judo's SDK enables a faster, simpler and more secure payment experience within your app.
+
+
+## Requirements
+The Judopay gem supports Ruby 1.9.3 and above (including 2.x).
+
+## Getting started
+##### 1. Integration
+Add this line to your application's Gemfile:
+
+	gem 'judopay'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install judopay
+
+##### 2. Setup
+To start using the gem, you need to pass block with your API credentials:
+```ruby
+require 'judopay'
+Judopay.configure do |config|
+	config.judo_id = '<JUDO_ID>'
+	config.api_token = '<TOKEN>'
+	config.api_secret = '<SECRET>'
+	config.use_production = false    # set to true on production, defaults to false which is the sandbox
+end
+```
+
+##### 3. Make a payment
+Add model inclusion to your source code:
+```ruby
+require 'judopay/models/card_payment'
+```
+**Note:** by default we only include the minimum models in order to keep memory footprint down. You will need to include it explicitly when using each type of payment model as defined in the wiki.
+
+To make a new payment with full card details:
+```ruby
+payment = Judopay::CardPayment.new(
+  :judoId => '<JUDO_ID>',
+  :your_consumer_reference => '<CONSUMER_REFERENCE>',
+  :your_payment_reference => '<PAYMENT_REFERENCE>',
+  :amount => 5.01,
+  :currency => 'GBP',
+  :card_number => '4976000000003436',
+  :expiry_date => '12/20',
+  :cv2 => '452',
+  :card_address => {
+    :line1 => '32 Edward Street',
+    :town => 'Camborne',
+    :postcode => 'TR14 8PA'
+  }
+)
+```
+**Note:** Please make sure that you are using a unique `your_consumer_reference` for each different consumer, and a unique `your_payment_reference` for each transaction.
+
+You can check on the required fields and the format of each field in the [Judopay REST API reference](https://www.judopay.com/docs/version-52/api/restful-api/#post-card-payment).
+
+To send the request to the API, call:
+```ruby
+payment_response = payment.create
+```
+
+##### 4. Check the payment result
+The response will contain the full details of the transaction: (see full response [here](https://www.judopay.com/docs/v5/api-reference/restful-api/#post-card-payment)):
+```ruby
+{
+  "receipt_id"=>"xxxxxxx",
+  "type"=>"Payment",
+  "created_at"=>"2016-09-23T09:28:47.1207+01:00",
+  "result"=>"Success",
+  "amount"=>"5.01",
+  "currency"=>"GBP",
+  ...
+}
+```
+The status of the transaction can be checked to see if it was successful:
+```ruby
+    if payment_response.result == 'Success'
+        puts 'Payment successful'
+    else
+        puts 'There was an issue while processing the payment'
+    end
+```
+
+It's important to handle different exceptions in your code. See more details in our [error handling section](https://github.com/JudoPay/RubySdk/wiki/Error-handling). 
+
+## Next steps
+The Judopay gem supports a range of customization options. For more information on using the Judo Ruby SDK see our [wiki documentation](https://github.com/JudoPay/RubySdk/wiki). 
+
+## License
+See the [LICENSE](https://github.com/JudoPay/RubySdk/blob/master/LICENSE.txt) file for license rights and limitations (MIT).