spreedly 2.0.11 → 2.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d3536add302f60e0f9c0a6d3e03f31ca6b1ba72
-  data.tar.gz: 05b193ba95d04a5b4fe40c3dbf8e87dc5ee0f3c8
+  metadata.gz: a37f361841f4061cc7399fe9bd2ef837b78130fd
+  data.tar.gz: 056a38b2f942463ba7f370ff77348520660346e1
 SHA512:
-  metadata.gz: 389d569b613f65d763383b1fedba752adcca0b47024e4a2887ac323315e1e93e49fa28cbc7003bb0652a40852089c092feb65bb45c9593aea027d1036396d6e1
-  data.tar.gz: bb4f1a6b376557a35f67b5c249e7934dbdd839fe3a028d5341b69234629ce4fb5c18fab95335d61853a378a7959b7cf1279d8dc2a515b041d1e20a303205f92a
+  metadata.gz: 68d2591350a32dc483495c667710caf9af2c5c39863991935e51c45db417bcc34ae10d82116a2afa4c3649a97b8b9aecfc1da2c60a5600be748f87a9b7d89e39
+  data.tar.gz: 3a5d21b3104d2cdd510f8cbea4bae54acba20004cf1bd1420681b447cf2979d2425cbed727c37aef2ea78a705205f0d899b233d8208df9590a802daa0743b6a6

data/HISTORY.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## Next Version
+
+
+## 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]

data/README.md

@@ -52,7 +52,7 @@ gateway.token     # => "DnbEJaaY2egcVkCvg3s8qT38xgt"
 
 #### Add a payment method
 Need a payment method token to try things out?  With Spreedly it's pretty straightforward to use a
-[transparent redirect](https://core.spreedly.com/manual/quickstart#submit-payment-form) to give you a
+[transparent redirect](https://docs.spreedly.com/guides/adding-payment-methods/web-form/) to give you a
 payment method token.  A payment form in your application could look something like this:
 
 ``` html
@@ -84,7 +84,7 @@ Once Spreedly has recorded the information, it will redirect the browser to the
 
     http://yourdomain.com/transparent_redirect_done?token=OEj2G2QJZM4C10AfTLYTrsKIsZH
 
-Once you have the payment method token (OEj2G2QJZM4C10AfTLYTrsKIsZH in this case), you can remember it and use it whenever you'd like.  These [test cards](https://core.spreedly.com/manual/test-data) will help.
+Once you have the payment method token (OEj2G2QJZM4C10AfTLYTrsKIsZH in this case), you can remember it and use it whenever you'd like.  These [test cards](https://docs.spreedly.com/reference/test-data/) will help.
 
 #### Retrieve a payment method
 Let's say you'd like some additional information about the payment method.  You can find a payment method like so:
@@ -119,6 +119,13 @@ You can also specify an optional amount to capture.
 capture_transaction = env.capture_transaction(auth_transaction.token, amount: 100)
 ```
 
+#### Verify
+
+Verify a card is legitimate so you can charge it at a later date.
+
+``` ruby
+env.verify_on_gateway(gateway_token, payment_method_token, retain_on_success: true)
+```
 
 #### Void and refund
 
@@ -162,7 +169,7 @@ env.purchase_on_gateway(gateway_token, payment_method_token, amount, currency_co
 
 
 #### Extra options for the basic operations
-For Purchase, Authorize, Capture, Refund, and Void calls, you can specify additional options:
+For Purchase, Authorize, Capture, Refund, Verify, and Void calls, you can specify additional options:
 
 ``` ruby
 env.purchase_on_gateway(gateway_token, payment_method_token, amount,
@@ -175,12 +182,16 @@ env.purchase_on_gateway(gateway_token, payment_method_token, amount,
 ```
 
 #### Retain on success
-Retain a payment method automatically if the purchase or authorize transaction succeeded.  Saves you a separate call to retain:
+Retain a payment method automatically if the purchase, verify, or authorize transaction succeeded.  Saves you a separate call to retain:
 
 ``` ruby
 env.purchase_on_gateway(gateway_token, payment_method_token, amount, retain_on_success: true)
 ```
 
+``` ruby
+env.verify_on_gateway(gateway_token, payment_method_token, retain_on_success: true)
+```
+
 #### Retrieving gateways
 
 ``` ruby
@@ -358,7 +369,7 @@ env.purchase_on_gateway(gateway_token, "Some Unknown Token", 4432) # Raises Spre
 
 #### Trying to use a non-test gateway or a non-test payment method with an inactive account
 
-You're free to use [test card data](https://core.spreedly.com/manual/test-data) and a [Test gateway](https://core.spreedly.com/manual/payment-gateways/test) to integrate Spreedly without having a
+You're free to use [test card data](https://docs.spreedly.com/reference/test-data/) and a [Test gateway](https://docs.spreedly.com/payment-gateways/test/) to integrate Spreedly without having a
 paid Spreedly account.  If you try to use a real card or a real gateway when your account isn't yet paid for, we'll raise an exception:
 
 ``` ruby
@@ -378,7 +389,7 @@ For api calls that actually talk to a payment gateway, the timout is longer sinc
 
 ## Sample applications using the gem
 
-There are some sample applications with source code using this gem.  You can [find them here](https://core.spreedly.com/manual/sample_applications).
+There are some sample applications with source code using this gem.  You can [find them here](https://docs.spreedly.com/resources/apps-libs/).
 
 ## Contributing
 

data/lib/spreedly.rb

@@ -19,13 +19,17 @@ require 'spreedly/transactions/add_payment_method'
 require 'spreedly/transactions/auth_purchase'
 require 'spreedly/transactions/purchase'
 require 'spreedly/transactions/void'
+require 'spreedly/transactions/verification'
 require 'spreedly/transactions/authorization'
 require 'spreedly/transactions/capture'
 require 'spreedly/transactions/refund'
 require 'spreedly/transactions/retain_payment_method'
 require 'spreedly/transactions/redact_payment_method'
 require 'spreedly/transactions/redact_gateway'
+require 'spreedly/transactions/recache_sensitive_data'
+require 'spreedly/transactions/deliver_payment_method'
 require 'spreedly/gateway'
+require 'spreedly/receiver'
 require 'spreedly/gateway_class'
 require 'spreedly/error'
 

data/lib/spreedly/connection.rb

@@ -41,7 +41,6 @@ module Spreedly
 
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      http.ca_file = File.dirname(__FILE__) + '/../certs/cacert.pem'
     end
 
   end

data/lib/spreedly/environment.rb

@@ -48,6 +48,11 @@ module Spreedly
       api_post(authorize_url(gateway_token), body)
     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)
+    end
+
     def capture_transaction(authorization_token, options = {})
       api_post(capture_url(authorization_token), capture_body(options))
     end
@@ -106,6 +111,12 @@ module Spreedly
       Gateway.new(xml_doc)
     end
 
+    def add_receiver(receiver_type, host_names = nil, credentials = [])
+      body = add_receiver_body(receiver_type, host_names, credentials)
+      xml_doc = ssl_post(add_receiver_url, body, headers)
+      Receiver.new(xml_doc)
+    end
+
     def add_credit_card(options)
       api_post(add_payment_method_url, add_credit_card_body(options), false)
     end
@@ -116,6 +127,12 @@ module Spreedly
       PaymentMethod.new_from(xml_doc)
     end
 
+    def deliver_to_receiver(receiver_token, payment_method_token, receiver_options)
+      body = deliver_to_receiver_body(payment_method_token, receiver_options)
+      xml_doc = ssl_post(deliver_to_receiver_url(receiver_token), body, headers)
+      DeliverPaymentMethod.new_from(xml_doc)
+    end
+
     private
     def headers
       {
@@ -134,6 +151,14 @@ module Spreedly
       end
     end
 
+    def verify_body(payment_method_token, options)
+      build_xml_request('transaction') do |doc|
+        doc.payment_method_token(payment_method_token)
+        add_to_doc(doc, options, :retain_on_success)
+        add_extra_options_for_basic_ops(doc, options)
+      end
+    end
+
     def capture_body(options)
       return '' if options.empty?
 
@@ -174,12 +199,31 @@ module Spreedly
       end
     end
 
+    def add_receiver_body(receiver_type, host_names, credentials)
+      build_xml_request('receiver') do |doc|
+        doc.receiver_type receiver_type
+        doc.hostnames host_names
+        add_credentials_to_doc(doc, credentials) if credentials && !credentials.empty?
+      end
+    end
+
+    def add_credentials_to_doc(doc, credentials)
+      doc.credentials do
+        credentials.each do |credential|
+          doc.credential do
+            add_to_doc(doc, credential, :name, :value, :safe)
+          end
+        end
+      end
+    end
+
     def add_credit_card_body(options)
       build_xml_request('payment_method') do |doc|
         add_to_doc(doc, options, :data, :retained, :email)
         doc.credit_card do
           add_to_doc(doc, options, :number, :verification_value, :month, :first_name, :last_name,
-                     :year, :address1, :address2, :city, :state, :zip, :country, :phone_number)
+                     :year, :address1, :address2, :city, :state, :zip, :country, :phone_number,
+                     :eligible_for_card_updater)
         end
       end
     end
@@ -187,13 +231,27 @@ module Spreedly
     def update_credit_card_body(options)
       build_xml_request('payment_method') do |doc|
         add_to_doc(doc, options, :email, :month, :first_name, :last_name, :year,
-                   :address1, :address2, :city, :state, :zip, :country, :phone_number)
+                   :address1, :address2, :city, :state, :zip, :country, :phone_number,
+                   :eligible_for_card_updater)
+      end
+    end
+
+    def deliver_to_receiver_body(payment_method_token, receiver_options)
+      build_xml_request('delivery') do |doc|
+        doc.payment_method_token payment_method_token
+        doc.url receiver_options[:url]
+        doc.headers do
+          doc.cdata receiver_options[:headers].map { |k, v| "#{k}: #{v}" }.join("\r\n")
+        end
+        doc.body do
+          doc.cdata receiver_options[:body]
+        end
       end
     end
 
     def add_to_doc(doc, options, *attributes)
       attributes.each do |attr|
-        doc.send(attr, options[attr.to_sym]) if options[attr.to_sym]
+        doc.send(attr, options[attr.to_sym]) if options[attr.to_sym] != nil
       end
     end
 

data/lib/spreedly/gateway_class.rb

@@ -5,9 +5,10 @@ module Spreedly
 
     field :gateway_type, :name, :homepage, :company_name
     field :supports_purchase, :supports_authorize, :supports_capture, :supports_credit,
-          :supports_void, :supports_reference_purchase, :supports_purchase_via_preauthorization,
-          :supports_offsite_purchase, :supports_offsite_authorize, :supports_3dsecure_purchase,
-          :supports_3dsecure_authorize, :supports_store, :supports_remove, type: :boolean
+          :supports_void, :supports_verify, :supports_reference_purchase,
+          :supports_purchase_via_preauthorization, :supports_offsite_purchase,
+          :supports_offsite_authorize, :supports_3dsecure_purchase, :supports_3dsecure_authorize,
+          :supports_store, :supports_remove, :supports_general_credit, type: :boolean
 
     attr_reader :supported_countries, :payment_methods, :auth_modes, :regions
 

data/lib/spreedly/payment_methods/credit_card.rb

@@ -2,8 +2,9 @@ module Spreedly
 
   class CreditCard < PaymentMethod
     field :first_name, :last_name, :full_name, :month, :year
-    field :number, :last_four_digits, :card_type, :verification_value
+    field :number, :last_four_digits, :first_six_digits, :card_type, :verification_value
     field :address1, :address2, :city, :state, :zip, :country, :phone_number
+    field :eligible_for_card_updater, type: :boolean
   end
 
 end

data/lib/spreedly/receiver.rb

@@ -0,0 +1,30 @@
+
+module Spreedly
+
+  class Receiver < Model
+
+    field :receiver_type, :hostnames
+    attr_reader :credentials
+
+    def initialize(xml_doc)
+      super
+      init_credentials(xml_doc)
+    end
+
+    private
+    def init_credentials(xml_doc)
+      @credentials = {}
+
+      xml_doc.xpath('.//credentials/credential').each do |each|
+        @credentials[each.at_xpath('.//name').text] = cred_value(each)
+      end
+    end
+
+    def cred_value(cred)
+      value = cred.at_xpath('.//value')
+      value ? value.text : nil
+    end
+
+  end
+
+end

data/lib/spreedly/transactions/deliver_payment_method.rb

@@ -0,0 +1,31 @@
+module Spreedly
+
+  class DeliverPaymentMethod < Transaction
+
+    attr_reader :response
+    attr_reader :payment_method, :receiver
+    field :succeeded, type: :boolean
+
+    def initialize(xml_doc)
+      super
+      @payment_method = PaymentMethod.new_from(xml_doc.at_xpath('.//payment_method'))
+      @receiver = Receiver.new(xml_doc.at_xpath('.//receiver'))
+
+      response_xml_doc = xml_doc.at_xpath('.//response')
+      @response = response_xml_doc ? DeliverPaymentResponse.new(response_xml_doc) : nil
+    end
+
+  end
+
+  class DeliverPaymentResponse
+    include Fields
+
+    field :status, :headers, :body
+
+    def initialize(xml_doc)
+      initialize_fields(xml_doc)
+    end
+
+  end
+
+end

data/lib/spreedly/transactions/recache_sensitive_data.rb

@@ -0,0 +1,17 @@
+module Spreedly
+
+  class RecacheSensitiveData < Transaction
+
+    field :data
+    attr_reader :payment_method
+
+    def initialize(xml_doc)
+      super
+      @payment_method = PaymentMethod.new_from(xml_doc.at_xpath('.//payment_method'))
+    end
+
+  end
+
+end
+
+

data/lib/spreedly/transactions/transaction.rb

@@ -20,12 +20,18 @@ module Spreedly
         return Refund.new(xml_doc)
       when 'Void'
         return Void.new(xml_doc)
+      when 'Verification'
+        return Verification.new(xml_doc)
       when 'RetainPaymentMethod'
         return RetainPaymentMethod.new(xml_doc)
       when 'RedactPaymentMethod'
         return RedactPaymentMethod.new(xml_doc)
       when 'RedactGateway'
         return RedactGateway.new(xml_doc)
+      when 'RecacheSensitiveData'
+        return RecacheSensitiveData.new(xml_doc)
+      when 'DeliverPaymentMethod'
+        return DeliverPaymentMethod.new(xml_doc)
       else
         Transaction.new(xml_doc)
       end

data/lib/spreedly/transactions/verification.rb

@@ -0,0 +1,12 @@
+module Spreedly
+
+  class Verification < GatewayTransaction
+    attr_reader :payment_method
+
+    def initialize(xml_doc)
+      super
+      @payment_method = PaymentMethod.new_from(xml_doc.at_xpath('.//payment_method'))
+    end
+  end
+
+end

data/lib/spreedly/urls.rb

@@ -26,6 +26,10 @@ module Spreedly
       "#{base_url}/v1/gateways/#{gateway_token}/authorize.xml"
     end
 
+    def verify_url(gateway_token)
+      "#{base_url}/v1/gateways/#{gateway_token}/verify.xml"
+    end
+
     def capture_url(authorization_token)
       "#{base_url}/v1/transactions/#{authorization_token}/capture.xml"
     end
@@ -75,6 +79,10 @@ module Spreedly
       "#{base_url}/v1/gateways.xml"
     end
 
+    def add_receiver_url
+      "#{base_url}/v1/receivers.xml"
+    end
+
     def add_payment_method_url
       "#{base_url}/v1/payment_methods.xml"
     end
@@ -83,6 +91,10 @@ module Spreedly
       "#{base_url}/v1/payment_methods/#{token}.xml"
     end
 
+    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.11"
+  VERSION = "2.0.13"
 end

data/test/remote/remote_add_gateway_test.rb

@@ -2,8 +2,6 @@ require 'test_helper'
 
 class RemoteAddGatewayTest < Test::Unit::TestCase
 
-  # TODO We'll add more to this soon.
-
   def setup
     @environment = Spreedly::Environment.new(remote_test_environment_key, remote_test_access_secret)
   end
@@ -29,7 +27,7 @@ class RemoteAddGatewayTest < Test::Unit::TestCase
 
   def test_need_active_account
     assert_raise_with_message(Spreedly::PaymentRequiredError, "Your account has not been activated for real transactions. Please update your subscription settings.") do
-      gateway = @environment.add_gateway(:wirecard)
+      @environment.add_gateway(:wirecard)
     end
   end