spreedly 2.0.1 → 2.0.2

data/HISTORY.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 2.0.2
+* Add support for gateway options call.
+
 ## 2.0.1
 * List the transactions for a payment method
 * Allow adding other gateways

data/lib/spreedly/connection.rb

@@ -20,6 +20,8 @@ module Spreedly
         http.put(endpoint.request_uri, body, headers)
       when :delete
         http.delete(endpoint.request_uri, headers)
+      when :options
+        http.request(OptionsWithResponseBody.new(endpoint.request_uri, headers))
       else
         raise ArgumentError, "Unsupported request method #{method.to_s.upcase}"
       end
@@ -36,5 +38,12 @@ module Spreedly
       http
     end
   end
+
+  class OptionsWithResponseBody < Net::HTTPRequest
+    METHOD = 'OPTIONS'
+    REQUEST_HAS_BODY = false
+    RESPONSE_HAS_BODY = true
+  end
+
 end
 

data/lib/spreedly/environment.rb

@@ -7,10 +7,11 @@ module Spreedly
     include SslRequester
     include Urls
 
-    attr_reader :key, :currency_code
+    attr_reader :key, :currency_code, :base_url
 
     def initialize(environment_key, access_secret, options={})
       @key, @access_secret = environment_key, access_secret
+      @base_url = options[:base_url] || "https://core.spreedly.com"
       @currency_code = options[:currency_code] || 'USD'
     end
 
@@ -86,6 +87,11 @@ module Spreedly
       Gateway.new_list_from(xml_doc)
     end
 
+    def gateway_options
+      xml_doc = ssl_options(gateway_options_url)
+      GatewayClass.new_list_from(xml_doc)
+    end
+
     def add_gateway(gateway_type, credentials = {})
       body = add_gateway_body(gateway_type, credentials)
       xml_doc = ssl_post(add_gateway_url, body, headers)

data/lib/spreedly/gateway_class.rb

@@ -0,0 +1,36 @@
+module Spreedly
+
+  class GatewayClass
+
+    include Fields
+    field :gateway_type, :name, :supported_countries, :homepage
+    attr_reader :supported_countries, :payment_methods
+
+    def initialize(xml_doc)
+      initialize_fields(xml_doc)
+      init_supported_countries(xml_doc)
+      init_payment_methods(xml_doc)
+    end
+
+    def self.new_list_from(xml_doc)
+      gateways = xml_doc.xpath('.//gateways/gateway')
+      gateways.map do |each|
+        self.new(each)
+      end
+    end
+
+    private
+    def init_supported_countries(xml_doc)
+      list = xml_doc.at_xpath(".//supported_countries").inner_html.strip
+      @supported_countries = list.split(/\s*,\s*/)
+    end
+
+    def init_payment_methods(xml_doc)
+      @payment_methods = xml_doc.xpath('.//payment_methods/payment_method').map do |each|
+        each.text
+      end
+    end
+
+  end
+
+end

data/lib/spreedly/ssl_requester.rb

@@ -14,6 +14,10 @@ module Spreedly
       ssl_request(:put, endpoint, body, headers)
     end
 
+    def ssl_options(endpoint)
+      ssl_request(:options, endpoint, nil, {})
+    end
+
     private
     def ssl_request(method, endpoint, body, headers)
       raw_response = Timeout::timeout(70) do
@@ -57,6 +61,7 @@ module Spreedly
 
     def show_raw_response(raw_response)
       return unless ENV['SHOW_RAW_RESPONSE'] == 'true'
+      puts raw_response.inspect
       puts "\nraw_response.code: #{raw_response.code}\nraw_response.body:\n#{raw_response.body}"
     end
 

data/lib/spreedly/urls.rb

@@ -2,10 +2,6 @@ module Spreedly
 
   module Urls
 
-    def base_url
-      "https://core.spreedly.com"
-    end
-
     def find_payment_method_url(token)
       "#{base_url}/v1/payment_methods/#{token}.xml"
     end
@@ -67,6 +63,10 @@ module Spreedly
       "#{base_url}/v1/gateways.xml#{since_param}"
     end
 
+    def gateway_options_url
+      "#{base_url}/v1/gateways.xml"
+    end
+
     def add_gateway_url
       "#{base_url}/v1/gateways.xml"
     end

data/lib/spreedly/version.rb

@@ -1,3 +1,3 @@
 module Spreedly
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/lib/spreedly.rb

@@ -23,6 +23,7 @@ require 'spreedly/transactions/retain_payment_method'
 require 'spreedly/transactions/redact_payment_method'
 require 'spreedly/transactions/redact_gateway'
 require 'spreedly/gateway'
+require 'spreedly/gateway_class'
 require 'spreedly/error'
 
 module Spreedly

data/test/remote/remote_gateway_options_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class RemoteGatewayOptionsTest < Test::Unit::TestCase
+
+  def setup
+    @environment = Spreedly::Environment.new(remote_test_environment_key, remote_test_access_secret)
+  end
+
+  def test_successfully_get_options
+    gateway_classes = @environment.gateway_options
+    braintree = gateway_classes.select { |each| each.name == "Braintree" }.first
+    assert_equal "http://www.braintreepaymentsolutions.com/", braintree.homepage
+    assert_equal ["credit_card", "third_party_token"], braintree.payment_methods
+  end
+
+end
+

data/test/unit/environment_test.rb

@@ -15,4 +15,12 @@ class EnvironmentTest < Test::Unit::TestCase
     assert_equal "EUR", environment.currency_code
   end
 
+  def test_base_url_default
+    assert_equal "https://core.spreedly.com", @environment.base_url
+  end
+
+  def test_base_url_override
+    environment = Spreedly::Environment.new("TheKey", "TheAccessSecret", base_url: "http://it.com")
+    assert_equal "http://it.com", environment.base_url
+  end
 end

data/test/unit/gateway_options_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+require 'unit/response_stubs/gateway_options_stubs'
+
+class ListGatewaysTest < Test::Unit::TestCase
+
+  include GatewayOptionsStubs
+
+  def setup
+    @environment = Spreedly::Environment.new("key", "secret")
+  end
+
+  def test_successful_gateway_options
+    @environment.stubs(:raw_ssl_request).returns(successful_gateway_options_response)
+    list = @environment.gateway_options
+
+    assert_kind_of(Array, list)
+    assert_equal 2, list.size
+
+    assert_equal 'PayPal', list.first.name
+    assert_equal ["US", "GB", "CA"], list.first.supported_countries
+    assert_equal ["credit_card", "paypal"], list.first.payment_methods
+    assert_equal "paypal", list.first.gateway_type
+    assert_equal "http://paypal.com/", list.first.homepage
+    assert_kind_of Spreedly::GatewayClass, list.first
+    assert_kind_of Spreedly::GatewayClass, list.last
+  end
+
+end

data/test/unit/response_stubs/gateway_options_stubs.rb

@@ -0,0 +1,137 @@
+module GatewayOptionsStubs
+
+  def successful_gateway_options_response
+    StubResponse.succeeded <<-XML
+      <gateways>
+        <gateway>
+          <gateway_type>paypal</gateway_type>
+          <name>PayPal</name>
+          <auth_modes>
+            <auth_mode>
+              <auth_mode_type>signature</auth_mode_type>
+              <name>Signature</name>
+              <credentials>
+                <credential>
+                  <name>login</name>
+                  <label>Login</label>
+                  <safe type="boolean">true</safe>
+                </credential>
+                <credential>
+                  <name>password</name>
+                  <label>Password</label>
+                  <safe type="boolean">false</safe>
+                </credential>
+                <credential>
+                  <name>signature</name>
+                  <label>Signature</label>
+                  <safe type="boolean">false</safe>
+                </credential>
+              </credentials>
+            </auth_mode>
+            <auth_mode>
+              <auth_mode_type>certificate</auth_mode_type>
+              <name>Certificate</name>
+              <credentials>
+                <credential>
+                  <name>login</name>
+                  <label>Login</label>
+                  <safe type="boolean">true</safe>
+                </credential>
+                <credential>
+                  <name>password</name>
+                  <label>Password</label>
+                  <safe type="boolean">false</safe>
+                </credential>
+                <credential>
+                  <name>pem</name>
+                  <label>PEM Certificate</label>
+                  <safe type="boolean">false</safe>
+                  <large type="boolean">true</large>
+                </credential>
+              </credentials>
+            </auth_mode>
+            <auth_mode>
+              <auth_mode_type>delegate</auth_mode_type>
+              <name>Delegate</name>
+              <credentials>
+                <credential>
+                  <name>email</name>
+                  <label>PayPal Email</label>
+                  <safe type="boolean">true</safe>
+                </credential>
+              </credentials>
+            </auth_mode>
+          </auth_modes>
+          <characteristics>
+            <supports_purchase type="boolean">true</supports_purchase>
+            <supports_authorize type="boolean">true</supports_authorize>
+            <supports_capture type="boolean">true</supports_capture>
+            <supports_credit type="boolean">true</supports_credit>
+            <supports_void type="boolean">true</supports_void>
+            <supports_reference_purchase type="boolean">true</supports_reference_purchase>
+            <supports_purchase_via_preauthorization type="boolean">true</supports_purchase_via_preauthorization>
+            <supports_offsite_purchase type="boolean">true</supports_offsite_purchase>
+            <supports_offsite_authorize type="boolean">true</supports_offsite_authorize>
+            <supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
+            <supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
+            <supports_store type="boolean">false</supports_store>
+            <supports_remove type="boolean">true</supports_remove>
+          </characteristics>
+          <payment_methods>
+            <payment_method>credit_card</payment_method>
+            <payment_method>paypal</payment_method>
+          </payment_methods>
+          <gateway_specific_fields>
+            <gateway_specific_field>recurring</gateway_specific_field>
+          </gateway_specific_fields>
+          <supported_countries>US, GB, CA</supported_countries>
+          <homepage>http://paypal.com/</homepage>
+        </gateway>
+        <gateway>
+          <gateway_type>worldpay</gateway_type>
+          <name>WorldPay</name>
+          <auth_modes>
+            <auth_mode>
+              <auth_mode_type>default</auth_mode_type>
+              <name>Default</name>
+              <credentials>
+                <credential>
+                  <name>login</name>
+                  <label>Login</label>
+                  <safe type="boolean">true</safe>
+                </credential>
+                <credential>
+                  <name>password</name>
+                  <label>Password</label>
+                  <safe type="boolean">false</safe>
+                </credential>
+              </credentials>
+            </auth_mode>
+          </auth_modes>
+          <characteristics>
+            <supports_purchase type="boolean">true</supports_purchase>
+            <supports_authorize type="boolean">true</supports_authorize>
+            <supports_capture type="boolean">true</supports_capture>
+            <supports_credit type="boolean">true</supports_credit>
+            <supports_void type="boolean">true</supports_void>
+            <supports_reference_purchase type="boolean">true</supports_reference_purchase>
+            <supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
+            <supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
+            <supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
+            <supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
+            <supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
+            <supports_store type="boolean">false</supports_store>
+            <supports_remove type="boolean">false</supports_remove>
+          </characteristics>
+          <payment_methods>
+            <payment_method>credit_card</payment_method>
+          </payment_methods>
+          <gateway_specific_fields/>
+          <supported_countries>HK, US, GB, AU, AD, BE, CH, CY, CZ, DE, DK, ES, FI, FR, GI, GR, HU, IE, IL, IT, LI, LU, MC, MT, NL, NO, NZ, PL, PT, SE, SG, SI, SM, TR, UM, VA</supported_countries>
+          <homepage>http://worldpay.com</homepage>
+        </gateway>
+      </gateways>
+    XML
+  end
+
+end

metadata

@@ -2,14 +2,14 @@
 name: spreedly
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Spreedly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -129,6 +129,7 @@ files:
 - lib/spreedly/environment.rb
 - lib/spreedly/error.rb
 - lib/spreedly/gateway.rb
+- lib/spreedly/gateway_class.rb
 - lib/spreedly/model.rb
 - lib/spreedly/payment_methods/bank_account.rb
 - lib/spreedly/payment_methods/credit_card.rb
@@ -164,6 +165,7 @@ files:
 - test/remote/remote_find_gateway_test.rb
 - test/remote/remote_find_payment_method_test.rb
 - test/remote/remote_find_transaction_test.rb
+- test/remote/remote_gateway_options_test.rb
 - test/remote/remote_list_gateways_test.rb
 - test/remote/remote_list_payment_methods_test.rb
 - test/remote/remote_list_transactions_test.rb
@@ -184,6 +186,7 @@ files:
 - test/unit/find_gateway_test.rb
 - test/unit/find_payment_method_test.rb
 - test/unit/find_transaction_test.rb
+- test/unit/gateway_options_test.rb
 - test/unit/list_gateways_test.rb
 - test/unit/list_payment_methods_test.rb
 - test/unit/list_transactions_test.rb
@@ -198,6 +201,7 @@ files:
 - test/unit/response_stubs/find_gateway_stubs.rb
 - test/unit/response_stubs/find_payment_method_stubs.rb
 - test/unit/response_stubs/find_transaction_stubs.rb
+- test/unit/response_stubs/gateway_options_stubs.rb
 - test/unit/response_stubs/list_gateways_stubs.rb
 - test/unit/response_stubs/list_payment_methods_stubs.rb
 - test/unit/response_stubs/list_transactions_stubs.rb
@@ -225,7 +229,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 2278846472039598155
+      hash: -3250380428935698253
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -234,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 2278846472039598155
+      hash: -3250380428935698253
       version: '0'
   none: false
 requirements: []
@@ -257,6 +261,7 @@ test_files:
 - test/remote/remote_find_gateway_test.rb
 - test/remote/remote_find_payment_method_test.rb
 - test/remote/remote_find_transaction_test.rb
+- test/remote/remote_gateway_options_test.rb
 - test/remote/remote_list_gateways_test.rb
 - test/remote/remote_list_payment_methods_test.rb
 - test/remote/remote_list_transactions_test.rb
@@ -277,6 +282,7 @@ test_files:
 - test/unit/find_gateway_test.rb
 - test/unit/find_payment_method_test.rb
 - test/unit/find_transaction_test.rb
+- test/unit/gateway_options_test.rb
 - test/unit/list_gateways_test.rb
 - test/unit/list_payment_methods_test.rb
 - test/unit/list_transactions_test.rb
@@ -291,6 +297,7 @@ test_files:
 - test/unit/response_stubs/find_gateway_stubs.rb
 - test/unit/response_stubs/find_payment_method_stubs.rb
 - test/unit/response_stubs/find_transaction_stubs.rb
+- test/unit/response_stubs/gateway_options_stubs.rb
 - test/unit/response_stubs/list_gateways_stubs.rb
 - test/unit/response_stubs/list_payment_methods_stubs.rb
 - test/unit/response_stubs/list_transactions_stubs.rb