spreedly 2.0.18 → 2.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fee7ae1d3bf0eaf6126ead42e28a16367920632f
-  data.tar.gz: b38482be678195d537c456b845fa6f1c33dcf7c7
+SHA256:
+  metadata.gz: 43cf51954eea13a2f1305e712c4ea4c4870f4de8b1066160b8023ca45b8e2aa0
+  data.tar.gz: 0dd8522435f12b094dbdb8f07dfb45143ac265aaac416457f95242a038e1e5b6
 SHA512:
-  metadata.gz: e8637191e25984c4fa21fb0afe9ef517fbfc68c4bd714f9ffb000ace8348d9d91980aded43f8ae30311990791055ac769ff3c1217bc53e0606fd59b9ddc5a626
-  data.tar.gz: ca75c0e0a89f28e5f19c87bea810e0939ae58e6d7d1e921ea0a7ee8e99bcd8dd1596f858032c2f740458c086cbf5035e90930742f738e8d56c2d51b3112728db
+  metadata.gz: 1d36b133483e50f955c4e392a2f43a6ae6efa0edae54f2b7f1266b7a4587b47fc4a8e1725b6de49e90b4e2cc3a390e78b4c10e919eb8b2d675df73c3b8232c2a
+  data.tar.gz: 77f2b68c2f8b94250836a3a8a2dadaf47e2950717c5a0ef192d39150ba0844b5b874799773c3f4eb46c1b53209374cb62e6264093eb752f19374120381501067

data/.gitignore

@@ -5,5 +5,6 @@ pkg
 .bundle
 tmp
 vendor/ruby
-test/credentials/personal_credentials.yml
+test/credentials/*.yml
 .ruby-version
+.idea

data/CHANGELOG.md

@@ -0,0 +1,174 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [2.0.24]
+### Added
+- @jeremywrowe - Add 3D Secure 2 complete transaction
+
+## [2.0.23] - 2019-08-16
+### Added
+- @bayprogrammer - Add 3D Secure 2 third-party auth abilities to gateway class
+
+## [2.0.22] - 2019-08-14
+### Added
+- @jeremywrowe - Support for three_ds_version, three_ds_context, and channel on
+  authorization / purchase
+
+## [2.0.21] - 2019-07-19
+### Added
+- @jeremywrowe - Support for Stored Credentials on authorization / purchase
+- @jeremywrowe - 3D Secure 2 abilities to gateway class
+
+## [2.0.20] - 2019-06-27
+### Changed
+- @patrickarnett - Modify `list_transactions` and `list_transactions_url` to take `count`, `order`, and `state` arguments in an optional hash.
+
+## [2.0.19] - 2019-06-07
+### Added
+- Lori Holden - Receiver redaction
+- Lancelot Carlson - Recached payment method support
+- @pawel-krysiak and @jeremywrowe - Support 3D-Secure transactions
+
+### Changed
+- @therufs - Expose `display_api_url` on gateway
+- @ZeusPerez - Expose `continue_caching` on transactions
+- @adamcohen - Expose `transaction_type` on transaction
+- @adamcohen - Expose `gateway_specific_response_fields` on transaction
+- @adamcohen - Expose `payment_method_type` on transaction
+
+## [2.0.16]
+- Support disburse [rwdaigle]
+- Support full_name property [maccca]
+- Add support for purchase shipping address override [davidsantoso]
+- Allow email override in transactions [duff]
+- Add options for store_on_gateway [fedesoria]
+- Support fingerprint [duff]
+
+## 2.0.15
+- Add support for supports_fraud_review gateway characteristic [markabe]
+- Add support for the store API call [duff]
+- Add support for company name property on credit card [duff]
+- Deliver payment method uses talking to gateway timeout [duff]
+- Fix issue creating production receiver [duff]
+
+## 2.0.14
+- Add support for gateway_specific_fields [duff]
+
+## 2.0.13
+- Check attributes for non-nil before sending [markabe]
+- Add supports_verify option to Gateway [duff]
+- Add support for verify_on_gateway API call [duff]
+- Add support for RecacheSensitiveData transaction [duff]
+- Remove cacert.pem and rely on system certs [duff]
+- Adds add_receiver method to environment [Thomas Hoen]
+- Adds deliver_receiver functionality [Thomas Hoen]
+- Add support for first_six_digits [duff]
+- Add support for supports_general_credit characteristic [markabe]
+
+## 2.0.12
+- Add support for new credit card field: eligible_for_card_updater [markabe]
+
+## 2.0.11
+- Add support for ThirdPartyTokens [duff]
+
+## 2.0.10
+- Add support for gateway_transaction_id [hoenth]
+
+## 2.0.9
+- Improve support for base_url around ssl [duff]
+
+## 2.0.8
+- Add support for gateway regions [duff]
+
+## 2.0.7
+- Add support for company_name to gateway options [duff]
+- Implemented gateway characteristics [ilyutov]
+- Allow access to gateway options w/o credentials [duff]
+
+## 2.0.6
+- Add auth_mode support to gateway options call [sosedoff]
+- Pass through verification_value when creating a card directly [duff]
+
+## 2.0.5
+- Add ability to retrieve a transcript [hoenth]
+
+## 2.0.3
+- Readme improvements
+- Smarter about timeouts - now only have long timeout for calls
+  that actually talk to a payment gateway.  The other calls can
+  have shorter timeouts.
+
+## 2.0.2
+- Add support for gateway options call.
+
+## 2.0.1
+- List the transactions for a payment method
+- Allow adding other gateways
+- Listing Payment Methods (retained on an account)
+- Updating a Payment Method
+- Listing Your Gateways
+- Finding a Gateway
+- Fix Ruby 1.9.2 private method issue
+- Add ability to find a bank account payment method
+- Add ability to redact a gateway
+
+## 2.0.0
+- This gem is now intended for the Spreedly API.  For the Spreedly
+  Subscriptions API, you can use the spreedly_subscriptions gem
+  which has everything that 1.4.0 had.
+
+## 1.4.0
+- Add accessor for invoices
+- Add accessor for last successful invoice
+
+## 1.3.6
+- Modernize packaging
+- Improve handling of bad credentials
+
+## 1.3.5
+- Move to Spreedly repo.
+
+## 1.3.4
+- Add result body to comp validation failure. [ntalbott]
+
+## 1.3.3
+- Add support for return_url in Spreedly.edit_subscriber_url [jjthrash]
+- Add support for return_url in Spreedly.subscribe_url [jjthrash]
+
+## 1.3.2
+- Added methods on subscriber: update, allow_free_trial,
+  add_fee [mateuszzawisza]
+- Fixing tests: generate spreedly url and edit url working with all
+  site names [mateuszzawisza]
+- Add support for pre-population of the subscribe page via the subscribe
+  url. [davemcp]
+
+## 1.3.1
+- Handle new error reporting when creating a subscriber.
+- Use a more sane way of setting attributes in the mock, and make plans have a
+  plan type [seancribbs].
+- Allow optional arguments to be passed when creating subscribers [jaknowlden].
+
+## 1.3.0 / 2009-06-04
+- Properly handle invalid Subscriber lookup [karnowski].
+- Added support for stopping auto renew [scottmotte, dsimard].
+
+## 1.2.2 / 2009-05-11
+- Fixed an error in the README [karnowski].
+
+## 1.2.1 / 2009-04-30
+- A few documentation tweaks.
+
+## 1.2.0 / 2009-04-30
+- Added mock support for Subscriber#activate_free_trial [scottmotte].
+- Added tests for Subscriber#activate_free_trial.
+
+## 1.1.0 / 2009-04-24
+- Compatibility with the latest hoe and HTTParty [seancribbs].
+- Added Subscriber.delete! [scottmotte].
+- Added Subscriber#activate_free_trial [scottmotte].
+
+## 1.0.0 / 2009-03-17
+- Initial release.
+

data/README.md

@@ -181,6 +181,12 @@ env.purchase_on_gateway(gateway_token, payment_method_token, amount,
                        )
 ```
 
+#### Complete a transaction (3DS 2)
+
+```ruby
+env.complete_transaction(transaction_token)
+```
+
 #### Retain on success
 Retain a payment method automatically if the purchase, verify, or authorize transaction succeeded.  Saves you a separate call to retain:
 
@@ -273,7 +279,7 @@ Here's how you can do it:
 
 ``` ruby
 options = {
-email: 'perrin@wot.com', number: '5555555555554444', month: 1, year: 2019, last_name: 'Aybara', first_name: 'Perrin', data: "occupation: Blacksmith"
+email: 'perrin@wot.com', number: '5555555555554444', month: 1, year: 2023, last_name: 'Aybara', first_name: 'Perrin', data: "occupation: Blacksmith"
 }
 transaction = env.add_credit_card(options)
 
@@ -286,7 +292,7 @@ You can also retain the card immediately like so:
 
 ``` ruby
 options = {
-email: 'perrin@wot.com', number: '5555555555554444', month: 1, year: 2019, last_name: 'Aybara', first_name: 'Perrin', data: "occupation: Blacksmith", retained: true
+email: 'perrin@wot.com', number: '5555555555554444', month: 1, year: 2023, last_name: 'Aybara', first_name: 'Perrin', data: "occupation: Blacksmith", retained: true
 }
 transaction = env.add_credit_card(options)
 
@@ -322,7 +328,6 @@ You can get the full list of supported receivers like so:
 env.receiver_options
 ```
 
-
 ## Error Handling
 
 When you make a call to the API, there are times when things don't go as expected.  For the most part, when a call is made, a Transaction is created behind the scenes at Spreedly.  In general,
@@ -409,3 +414,7 @@ There are two rake tasks to help run the tests:
 rake test:remote  # Run remote tests that actually hit the Spreedly site
 rake test:units   # Run unit tests
 ```
+
+To run remote tests you'll need to copy `test/credentials/credentials.yml.example` to `test/credentials/credentials.yml` and update the values of `environment_key` and `access_secret`.
+
+When you're happy with your change, don't forget to add your contributions to CHANGELOG.md. We follow the changelog format found [here](https://keepachangelog.com/en/1.0.0/).

data/Rakefile

@@ -2,20 +2,10 @@ require "bundler/gem_tasks"
 
 require 'rake/testtask'
 
-# Rake::TestTask.new do |t|
-#   t.libs << 'test'
-# end
-
-# desc "Run tests"
-# task :default => :test
-
-
-
-desc "Run the unit test suite"
-task :default => 'test:units'
+desc 'Run the unit test suite'
+task default: 'test:units'
 
 namespace :test do
-
   Rake::TestTask.new(:units) do |t|
     t.pattern = 'test/unit/**/*_test.rb'
     t.libs << 'test'
@@ -27,6 +17,4 @@ namespace :test do
     t.libs << 'test'
     t.verbose = true
   end
-
 end
-

data/lib/spreedly/environment.rb

@@ -30,7 +30,8 @@ module Spreedly
     end
 
     def find_transcript(transaction_token)
-      ssl_raw_get(find_transcript_url(transaction_token), headers)
+      transcript_url = find_transcript_url(transaction_token)
+      ssl_raw_get(transcript_url, headers)
     end
 
     def find_gateway(token)
@@ -48,6 +49,10 @@ module Spreedly
       api_post(authorize_url(gateway_token), body)
     end
 
+    def complete_transaction(transaction_token)
+      api_post(complete_transaction_url(transaction_token), '')
+    end
+
     def verify_on_gateway(gateway_token, payment_method_token, options = {})
       body = verify_body(payment_method_token, options)
       api_post(verify_url(gateway_token), body)
@@ -76,13 +81,24 @@ module Spreedly
       Transaction.new_from(xml_doc)
     end
 
+    def recache_payment_method(payment_method_token, options = {})
+      body = recache_payment_method_body(options)
+      xml_doc = ssl_put(recache_payment_method_url(payment_method_token), body, headers)
+      RecacheSensitiveData.new_from(xml_doc)
+    end
+
     def redact_gateway(gateway_token, options = {})
       xml_doc = ssl_put(redact_gateway_url(gateway_token), '', headers)
       Transaction.new_from(xml_doc)
     end
 
-    def list_transactions(since_token = nil, payment_method_token = nil)
-      xml_doc = ssl_get(list_transactions_url(since_token, payment_method_token), headers)
+    def redact_receiver(receiver_token, options = {})
+      xml_doc = ssl_put(redact_receiver_url(receiver_token), '', headers)
+      Transaction.new_from(xml_doc)
+    end
+
+    def list_transactions(since_token = nil, payment_method_token = nil, options = {})
+      xml_doc = ssl_get(list_transactions_url(since_token, payment_method_token, options), headers)
       Transaction.new_list_from(xml_doc)
     end
 
@@ -160,6 +176,8 @@ module Spreedly
         doc.currency_code(options[:currency_code] || currency_code)
         doc.payment_method_token(payment_method_token)
         add_to_doc(doc, options, :retain_on_success)
+        add_to_doc(doc, options, :stored_credential_initiator)
+        add_to_doc(doc, options, :stored_credential_reason_type)
         add_extra_options_for_basic_ops(doc, options)
       end
     end
@@ -205,6 +223,14 @@ module Spreedly
       end
     end
 
+    def recache_payment_method_body(options)
+      build_xml_request('payment_method') do |doc|
+        doc.credit_card do
+          add_to_doc(doc, options, :verification_value)
+        end
+      end
+    end
+
     def add_gateway_body(gateway_type, credentials)
       build_xml_request('gateway') do |doc|
         doc.gateway_type gateway_type
@@ -279,7 +305,8 @@ module Spreedly
       add_gateway_specific_fields(doc, options)
       add_shipping_address_override(doc, options)
       add_to_doc(doc, options, :order_id, :description, :ip, :email, :merchant_name_descriptor,
-                               :merchant_location_descriptor, :redirect_url, :callback_url)
+                               :merchant_location_descriptor, :redirect_url, :callback_url,
+                               :continue_caching, :attempt_3dsecure, :browser_info, :three_ds_version, :channel)
     end
 
     def add_gateway_specific_fields(doc, options)
@@ -315,6 +342,5 @@ module Spreedly
       xml_doc = ssl_post(url, body, headers, talking_to_gateway)
       Transaction.new_from(xml_doc)
     end
-
   end
 end

data/lib/spreedly/gateway_class.rb

@@ -3,11 +3,13 @@ module Spreedly
   class GatewayClass
     include Fields
 
-    field :gateway_type, :name, :homepage, :company_name
+    field :gateway_type, :name, :homepage, :company_name, :display_api_url
     field :supports_purchase, :supports_authorize, :supports_capture, :supports_credit,
           :supports_void, :supports_verify, :supports_reference_purchase,
           :supports_purchase_via_preauthorization, :supports_offsite_purchase,
           :supports_offsite_authorize, :supports_3dsecure_purchase, :supports_3dsecure_authorize,
+          :supports_3dsecure_2_purchase, :supports_3dsecure_2_authorize,
+          :supports_3dsecure_2_mpi_purchase, :supports_3dsecure_2_mpi_authorize,
           :supports_store, :supports_remove, :supports_general_credit,
           :supports_fraud_review, type: :boolean
 

data/lib/spreedly/payment_methods/payment_method.rb

@@ -6,7 +6,7 @@ module Spreedly
 
     include ErrorsParser
 
-    field :email, :storage_state, :data
+    field :email, :storage_state, :data, :payment_method_type
     attr_reader :errors
 
     def initialize(xml_doc)

data/lib/spreedly/receiver.rb

@@ -3,7 +3,7 @@ module Spreedly
 
   class Receiver < Model
 
-    field :receiver_type, :hostnames
+    field :receiver_type, :hostnames, :state, :company_name
     attr_reader :credentials
 
     def initialize(xml_doc)

data/lib/spreedly/ssl_requester.rb

@@ -1,7 +1,5 @@
 module Spreedly
-
   module SslRequester
-
     def ssl_get(endpoint, headers)
       ssl_request(:get, endpoint, nil, headers)
     end
@@ -23,6 +21,7 @@ module Spreedly
     end
 
     private
+
     def ssl_request(method, endpoint, body, headers, options = {})
       opts = { talking_to_gateway: false, return_raw: false }.merge(options)
       how_long = opts[:talking_to_gateway] ? 66 : 10
@@ -73,7 +72,5 @@ module Spreedly
       puts raw_response.inspect
       puts "\nraw_response.code: #{raw_response.code}\nraw_response.body:\n#{raw_response.body}"
     end
-
   end
-
 end

data/lib/spreedly/transactions/auth_purchase.rb

@@ -1,8 +1,8 @@
 module Spreedly
-
   class AuthPurchase < GatewayTransaction
-
-    field :currency_code
+    field :currency_code, :checkout_url, :checkout_form, :redirect_url, :callback_url
+    field :required_action, :challenge_form, :challenge_url, :device_fingerprint_form
+    field :stored_credential_initiator, :stored_credential_reason_type, :three_ds_context
     field :amount, type: :integer
 
     attr_reader :payment_method
@@ -11,7 +11,5 @@ module Spreedly
       super
       @payment_method = PaymentMethod.new_from(xml_doc.at_xpath('.//payment_method'))
     end
-
   end
-
 end

data/lib/spreedly/transactions/authorization.rb

@@ -1,7 +1,3 @@
 module Spreedly
-
-  class Authorization < AuthPurchase
-
-  end
-
+  Authorization = Class.new(AuthPurchase)
 end

data/lib/spreedly/transactions/gateway_transaction.rb

@@ -1,12 +1,10 @@
 module Spreedly
-
   class GatewayTransaction < Transaction
-
-    field :order_id, :ip, :description, :gateway_token, :gateway_transaction_id, :email
+    field :order_id, :ip, :description, :gateway_token, :gateway_transaction_id, :email, :transaction_type
     field :merchant_name_descriptor, :merchant_location_descriptor
     field :on_test_gateway, type: :boolean
 
-    attr_reader :response, :gateway_specific_fields, :shipping_address
+    attr_reader :response, :gateway_specific_fields, :gateway_specific_response_fields, :shipping_address
 
     def initialize(xml_doc)
       super
@@ -14,13 +12,14 @@ module Spreedly
       shipping_address_xml_doc = xml_doc.at_xpath('.//shipping_address')
       @response = response_xml_doc ? Response.new(response_xml_doc) : nil
       @shipping_address = shipping_address_xml_doc ? ShippingAddress.new(shipping_address_xml_doc) : nil
-      @gateway_specific_fields = parse_gateway_specific_fields(xml_doc)
+      @gateway_specific_fields = parse_gateway_fields(xml_doc, './/gateway_specific_fields')
+      @gateway_specific_response_fields = parse_gateway_fields(xml_doc, './/gateway_specific_response_fields')
     end
 
-    def parse_gateway_specific_fields(xml_doc)
+    def parse_gateway_fields(xml_doc, path)
       result = {}
 
-      xml_doc.at_xpath('.//gateway_specific_fields').xpath('*').each do |node|
+      xml_doc.at_xpath(path).xpath('*').each do |node|
         node_name = node.name.to_sym
         if (node.elements.empty?)
           result[node_name] = node.text
@@ -35,28 +34,4 @@ module Spreedly
       result
     end
   end
-
-  class Response
-    include Fields
-
-    field :success, :pending, :cancelled, :fraud_review, type: :boolean
-    field :created_at, :updated_at, type: :date_time
-    field :message, :avs_code, :avs_message, :cvv_code, :cvv_message, :error_code, :error_detail
-
-    def initialize(xml_doc)
-      initialize_fields(xml_doc)
-    end
-
-  end
-
-  class ShippingAddress
-    include Fields
-
-    field :name, :address1, :address2, :city, :state, :zip, :country, :phone_number
-
-    def initialize(xml_doc)
-      initialize_fields(xml_doc)
-    end
-
-  end
 end

data/lib/spreedly/transactions/purchase.rb

@@ -1,7 +1,4 @@
 module Spreedly
-
   class Purchase < AuthPurchase
-
   end
-
 end

data/lib/spreedly/transactions/response.rb

@@ -0,0 +1,13 @@
+module Spreedly
+  class Response
+    include Fields
+
+    field :success, :pending, :cancelled, :fraud_review, type: :boolean
+    field :created_at, :updated_at, type: :date_time
+    field :message, :avs_code, :avs_message, :cvv_code, :cvv_message, :error_code, :error_detail
+
+    def initialize(xml_doc)
+      initialize_fields(xml_doc)
+    end
+  end
+end

data/lib/spreedly/transactions/shipping_address.rb

@@ -0,0 +1,11 @@
+module Spreedly
+  class ShippingAddress
+    include Fields
+
+    field :name, :address1, :address2, :city, :state, :zip, :country, :phone_number
+
+    def initialize(xml_doc)
+      initialize_fields(xml_doc)
+    end
+  end
+end

data/lib/spreedly/transactions/transaction.rb

@@ -1,8 +1,6 @@
 
 module Spreedly
-
   class Transaction < Model
-
     field :state, :message
     field :succeeded, type: :boolean
 
@@ -47,7 +45,5 @@ module Spreedly
         self.new_from(each)
       end
     end
-
   end
-
 end

data/lib/spreedly/urls.rb

@@ -1,7 +1,5 @@
 module Spreedly
-
   module Urls
-
     def find_payment_method_url(token)
       "#{base_url}/v1/payment_methods/#{token}.xml"
     end
@@ -14,6 +12,10 @@ module Spreedly
       "#{base_url}/v1/transactions/#{transaction_token}/transcript"
     end
 
+    def complete_transaction_url(token)
+      "#{base_url}/v1/transactions/#{token}/complete.xml"
+    end
+
     def find_gateway_url(token)
       "#{base_url}/v1/gateways/#{token}.xml"
     end
@@ -50,6 +52,10 @@ module Spreedly
       "#{base_url}/v1/payment_methods/#{payment_method_token}/redact.xml"
     end
 
+    def recache_payment_method_url(payment_method_token)
+      "#{base_url}/v1/payment_methods/#{payment_method_token}/recache.xml"
+    end
+
     def redact_gateway_url(gateway_token)
       "#{base_url}/v1/gateways/#{gateway_token}/redact.xml"
     end
@@ -58,11 +64,20 @@ module Spreedly
       "#{base_url}/v1/gateways/#{gateway_token}/store.xml"
     end
 
-    def list_transactions_url(since_token, payment_method_token)
-      since_param = "?since_token=#{since_token}" if since_token
-      return "#{base_url}/v1/transactions.xml#{since_param}" unless payment_method_token
+    def list_transactions_url(since_token, payment_method_token, options = {})
+      options.each do |key, val|
+        options[key.to_sym] = val
+      end
+
+      params = []
+      params << "since_token=#{since_token}" if since_token
+      params << "count=#{options[:count]}" if options[:count]
+      params << "order=#{options[:order]}" if options[:order]
+      params << "state=#{options[:state]}" if options[:state]
+      param_string = "?#{params.join('&')}" if params.any?
+      return "#{base_url}/v1/transactions.xml#{param_string}" unless payment_method_token
 
-      "#{base_url}/v1/payment_methods/#{payment_method_token}/transactions.xml#{since_param}"
+      "#{base_url}/v1/payment_methods/#{payment_method_token}/transactions.xml#{param_string}"
     end
 
     def list_payment_methods_url(since_token)
@@ -91,6 +106,10 @@ module Spreedly
       "#{base_url}/v1/receivers.xml"
     end
 
+    def redact_receiver_url(token)
+      "#{base_url}/v1/receivers/#{token}/redact.xml"
+    end
+
     def add_payment_method_url
       "#{base_url}/v1/payment_methods.xml"
     end
@@ -102,7 +121,5 @@ module Spreedly
     def deliver_to_receiver_url(receiver_token)
       "#{base_url}/v1/receivers/#{receiver_token}/deliver.xml"
     end
-
   end
-
 end

data/lib/spreedly/version.rb

@@ -1,3 +1,3 @@
 module Spreedly
-  VERSION = "2.0.18"
+  VERSION = "2.0.24"
 end

data/lib/spreedly.rb

@@ -13,6 +13,8 @@ require 'spreedly/payment_methods/paypal'
 require 'spreedly/payment_methods/sprel'
 require 'spreedly/payment_methods/bank_account'
 require 'spreedly/payment_methods/third_party_token'
+require 'spreedly/transactions/shipping_address'
+require 'spreedly/transactions/response'
 require 'spreedly/transactions/transaction'
 require 'spreedly/transactions/gateway_transaction'
 require 'spreedly/transactions/add_payment_method'