spreedly 2.0.3 → 2.0.4

data/HISTORY.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 2.0.4
+* Add ability to retrieve a transcript [hoenth]
+
 ## 2.0.3
 * Readme improvements
 * Smarter about timeouts - now only have long timeout for calls

data/README.md

@@ -227,7 +227,7 @@ transaction.order_id      # => '30-9904-31114'
 #### Retrieving the transcript for a transaction
 
 ``` ruby
-env.find_transaction_transcript(transaction_token)
+env.find_transcript(transaction_token)
 ```
 
 #### Updating a credit card

data/lib/spreedly/environment.rb

@@ -29,6 +29,10 @@ module Spreedly
       Transaction.new_from(xml_doc)
     end
 
+    def find_transcript(transaction_token)
+      ssl_raw_get(find_transcript_url(transaction_token), headers)
+    end
+
     def find_gateway(token)
       xml_doc = ssl_get(find_gateway_url(token), headers)
       Gateway.new(xml_doc)

data/lib/spreedly/ssl_requester.rb

@@ -2,31 +2,37 @@ module Spreedly
 
   module SslRequester
 
-    def ssl_get(endpoint, headers, talking_to_gateway = false)
-      ssl_request(:get, endpoint, nil, headers, talking_to_gateway)
+    def ssl_get(endpoint, headers)
+      ssl_request(:get, endpoint, nil, headers)
     end
 
     def ssl_post(endpoint, body, headers, talking_to_gateway = false)
-      ssl_request(:post, endpoint, body, headers, talking_to_gateway)
+      ssl_request(:post, endpoint, body, headers, talking_to_gateway: talking_to_gateway)
     end
 
-    def ssl_put(endpoint, body, headers, talking_to_gateway = false)
-      ssl_request(:put, endpoint, body, headers, talking_to_gateway)
+    def ssl_raw_get(endpoint, headers)
+      ssl_request(:get, endpoint, nil, headers, return_raw: true)
     end
 
-    def ssl_options(endpoint, talking_to_gateway = false)
-      ssl_request(:options, endpoint, nil, {}, talking_to_gateway)
+    def ssl_put(endpoint, body, headers)
+      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, talking_to_gateway)
-      how_long = talking_to_gateway ? 66 : 10
+    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
+
       raw_response = Timeout::timeout(how_long) do
         raw_ssl_request(method, endpoint, body, headers)
       end
 
       show_raw_response(raw_response)
-      handle_response(raw_response)
+      handle_response(raw_response, opts[:return_raw])
 
     rescue Timeout::Error => e
       raise Spreedly::TimeoutError.new
@@ -37,29 +43,31 @@ module Spreedly
       connection.request(method, body, headers)
     end
 
-    def handle_response(response)
-      xml_doc = Nokogiri::XML(response.body)
-
+    def handle_response(response, return_raw)
       case response.code.to_i
       when 200...300
-        xml_doc
+        return_raw ? response.body : xml_doc(response)
       when 401
-        raise AuthenticationError.new(xml_doc)
+        raise AuthenticationError.new(xml_doc(response))
       when 404
-        raise NotFoundError.new(xml_doc)
+        raise NotFoundError.new(xml_doc(response))
       when 402
-        raise PaymentRequiredError.new(xml_doc)
+        raise PaymentRequiredError.new(xml_doc(response))
       when 422
-        if xml_doc.at_xpath('.//errors/error')
-          raise TransactionCreationError.new(xml_doc)
+        if xml_doc(response).at_xpath('.//errors/error')
+          raise TransactionCreationError.new(xml_doc(response))
         else
-          xml_doc
+          xml_doc(response)
         end
       else
         raise UnexpectedResponseError.new(response)
       end
     end
 
+    def  xml_doc(response)
+      Nokogiri::XML(response.body)
+    end
+
     def show_raw_response(raw_response)
       return unless ENV['SHOW_RAW_RESPONSE'] == 'true'
       puts raw_response.inspect

data/lib/spreedly/urls.rb

@@ -10,6 +10,10 @@ module Spreedly
       "#{base_url}/v1/transactions/#{token}.xml"
     end
 
+    def find_transcript_url(transaction_token)
+      "#{base_url}/v1/transactions/#{transaction_token}/transcript"
+    end
+
     def find_gateway_url(token)
       "#{base_url}/v1/gateways/#{token}.xml"
     end

data/lib/spreedly/version.rb

@@ -1,3 +1,3 @@
 module Spreedly
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

data/test/remote/remote_find_transcript_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class RemoteFindTranscriptTest < Test::Unit::TestCase
+
+  def setup
+    @environment = Spreedly::Environment.new(remote_test_environment_key, remote_test_access_secret)
+  end
+
+  def test_invalid_login
+    assert_invalid_login do |environment|
+      environment.find_transcript("SomeToken")
+    end
+  end
+
+  def test_transaction_not_found
+    assert_raise_with_message(Spreedly::NotFoundError, "Unable to find the transaction SomeUnknownToken.") do
+       @environment.find_transcript("SomeUnknownToken")
+    end
+  end
+
+  def test_successfully_find_transcript
+    gateway_token = @environment.add_gateway(:test).token
+    card_token = create_failed_card_on(@environment).token
+    transaction = @environment.purchase_on_gateway(gateway_token, card_token, 144)
+
+    found = @environment.find_transcript(transaction.token)
+    assert_kind_of(String, found)
+  end
+
+end

data/test/unit/find_transcript_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class FindTransactionTranscriptTest < Test::Unit::TestCase
+
+  def setup
+    @environment = Spreedly::Environment.new("key", "secret")
+  end
+
+  def test_successful_find_transcript
+    t = find_using("Some Non XML String.  Could be anything really.")
+    assert_equal "Some Non XML String.  Could be anything really.", t
+  end
+
+  private
+  def find_using(response)
+    @environment.stubs(:raw_ssl_request).returns(StubResponse.succeeded(response))
+    @environment.find_transcript("IgnoredTokenSinceResponseIsStubbed")
+  end
+
+end

metadata

@@ -2,14 +2,14 @@
 name: spreedly
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Spreedly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -165,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_find_transcript_test.rb
 - test/remote/remote_gateway_options_test.rb
 - test/remote/remote_list_gateways_test.rb
 - test/remote/remote_list_payment_methods_test.rb
@@ -186,6 +187,7 @@ files:
 - test/unit/find_gateway_test.rb
 - test/unit/find_payment_method_test.rb
 - test/unit/find_transaction_test.rb
+- test/unit/find_transcript_test.rb
 - test/unit/gateway_options_test.rb
 - test/unit/list_gateways_test.rb
 - test/unit/list_payment_methods_test.rb
@@ -229,7 +231,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -2109504524353041148
+      hash: 4235559723397187348
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -238,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -2109504524353041148
+      hash: 4235559723397187348
       version: '0'
   none: false
 requirements: []
@@ -261,6 +263,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_find_transcript_test.rb
 - test/remote/remote_gateway_options_test.rb
 - test/remote/remote_list_gateways_test.rb
 - test/remote/remote_list_payment_methods_test.rb
@@ -282,6 +285,7 @@ test_files:
 - test/unit/find_gateway_test.rb
 - test/unit/find_payment_method_test.rb
 - test/unit/find_transaction_test.rb
+- test/unit/find_transcript_test.rb
 - test/unit/gateway_options_test.rb
 - test/unit/list_gateways_test.rb
 - test/unit/list_payment_methods_test.rb