paypal-sdk-core 0.1.5 → 0.2.0

data/lib/paypal-sdk/core/logging.rb

@@ -26,7 +26,7 @@ module PayPal::SDK::Core
 
       # Get or Create configured logger based on the default environment configuration
       def logger
-        @logger ||= Logger.new(Config.config.logfile || STDERR)
+        @logger ||= Logger.new(STDERR)
       end
 
       # Set logger directly and clear the loggers cache.
@@ -35,7 +35,7 @@ module PayPal::SDK::Core
       # === Example
       #   Logging.logger = Logger.new(STDERR)
       def logger=(logger)
-        @logger  = logger
+        @logger = logger
       end
 
     end

data/lib/paypal-sdk/core/util/http_helper.rb

@@ -0,0 +1,146 @@
+require 'net/https'
+require 'uri'
+require 'cgi'
+
+module PayPal::SDK::Core
+  module Util
+    module HTTPHelper
+
+      include Configuration
+      include Logging
+      include Authentication
+      include Exceptions
+
+      # Create HTTP connection based on given service name or configured end point
+      def create_http_connection(uri)
+        new_http(uri).tap do |http|
+          if config.http_timeout
+            http.open_timeout = config.http_timeout
+            http.read_timeout = config.http_timeout
+          end
+          configure_ssl(http) if uri.scheme == "https"
+        end
+      end
+
+      # New raw HTTP object
+      def new_http(uri)
+        if config.http_proxy
+          proxy = URI.parse(config.http_proxy)
+          Net::HTTP.new(uri.host, uri.port, proxy.host, proxy.port, proxy.user, proxy.password)
+        else
+          Net::HTTP.new(uri.host, uri.port)
+        end
+      end
+
+      # Default ca file
+      def default_ca_file
+        File.expand_path("../../../../../data/paypal.crt", __FILE__)
+      end
+
+      # Apply ssl configuration to http object
+      def configure_ssl(http)
+        http.tap do |https|
+          https.use_ssl = true
+          https.ca_file = default_ca_file
+          https.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          config.ssl_options.each do |key, value|
+            http.send("#{key}=", value)
+          end
+          add_certificate(https)
+        end
+      end
+
+      # Join url
+      def url_join(path, action)
+        path.sub(/\/?$/, "/#{action}")
+      end
+
+      # Make Http call
+      # * payload - Hash(:http, :method, :uri, :body, :header)
+      def http_call(payload)
+        response =
+          log_http_call(payload) do
+            http = payload[:http] || create_http_connection(payload[:uri])
+            http.start do |session|
+              if payload[:method] == :get
+                session.get(payload[:uri].request_uri, payload[:header])
+              else
+                session.send(payload[:method], payload[:uri].request_uri, payload[:body], payload[:header])
+              end
+            end
+          end
+        handle_response(response)
+      end
+
+      # Log Http call
+      # * payload - Hash(:http, :method, :uri, :body, :header)
+      def log_http_call(payload)
+        logger.info "Request[#{payload[:method]}]: #{payload[:uri].to_s}"
+        start_time = Time.now
+        response = yield
+        logger.info sprintf("Response[%s]: %s, Duration: %.3fs", response.code,
+          response.message, Time.now - start_time)
+        response
+      end
+
+      # Generate header based on given header keys and properties
+      # === Arguments
+      # * <tt>header_keys</tt> -- List of Header keys for the properties
+      # * <tt>properties</tt>  -- properties
+      # === Return
+      #  Hash with header as key property as value
+      # === Example
+      # map_header_value( { :username => "X-PAYPAL-USERNAME"}, { :username => "guest" })
+      # # Return: { "X-PAYPAL-USERNAME" => "guest" }
+      def map_header_value(header_keys, properties)
+        header = {}
+        properties.each do |key, value|
+          key = header_keys[key]
+          header[key] = value.to_s if key and value
+        end
+        header
+      end
+
+      def encode_www_form(hash)
+        if defined? URI.encode_www_form
+          URI.encode_www_form(hash)
+        else
+          hash.map{|key, value| "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" }.join("&")
+        end
+      end
+
+      # Handles response and error codes from the remote service.
+      def handle_response(response)
+        case response.code.to_i
+          when 301, 302, 303, 307
+            raise(Redirection.new(response))
+          when 200...400
+            response
+          when 400
+            raise(BadRequest.new(response))
+          when 401
+            raise(UnauthorizedAccess.new(response))
+          when 403
+            raise(ForbiddenAccess.new(response))
+          when 404
+            raise(ResourceNotFound.new(response))
+          when 405
+            raise(MethodNotAllowed.new(response))
+          when 409
+            raise(ResourceConflict.new(response))
+          when 410
+            raise(ResourceGone.new(response))
+          when 422
+            raise(ResourceInvalid.new(response))
+          when 401...500
+            raise(ClientError.new(response))
+          when 500...600
+            raise(ServerError.new(response))
+          else
+            raise(ConnectionError.new(response, "Unknown response code: #{response.code}"))
+        end
+      end
+
+    end
+  end
+end

data/lib/paypal-sdk/core/version.rb

@@ -1,7 +1,7 @@
 module PayPal
   module SDK
     module Core
-      VERSION     = "0.1.5"
+      VERSION     = "0.2.0"
     end
   end
 end

data/spec/config/paypal.yml

@@ -6,13 +6,15 @@ test: &default
   http_timeout: 30
   mode: sandbox
   sandbox_email_address: Platform.sdk.seller@gmail.com
-  logfile: spec/log/test.log
-  ca_file: <%= File.expand_path("../cacert.pem", __FILE__) %>
-  ipn_end_point: https://www.sandbox.paypal.com/cgi-bin/webscr
 
 development:
   <<: *default
 
+with_authentication:
+  <<: *default
+  client_id: EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM
+  client_secret: EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM
+
 with_certificate:
   <<: *default
   username: platfo_1255170694_biz_api1.gmail.com

data/spec/core/api/data_type_spec.rb

@@ -25,6 +25,18 @@ describe PayPal::SDK::Core::API::DataTypes::Base do
     object_of :created_at, DateTime
   end
 
+  class Message < DataType
+    object_of :value, String
+  end
+
+  it "should allow content key" do
+    message = Message.new("Testing message")
+    message.value.should eql "Testing message"
+
+    message = Message.new(:value => "Testing message")
+    message.value.should eql "Testing message"
+  end
+
   it "should create member object automatically" do
     test_type = TestType.new
     test_type.fromCurrency.should   be_a TestCurrency

data/spec/core/api/ipn_spec.rb

@@ -5,10 +5,17 @@ describe PayPal::SDK::Core::API::IPN do
   IPN = PayPal::SDK::Core::API::IPN
 
   describe "Configuration" do
-    it "set IPN end_point" do
-      ipn_validate_url = "https://www.sandbox.paypal.com/cgi-bin/webscr"
-      message = IPN::Message.new(samples["ipn"]["valid_message"], :ipn_end_point => ipn_validate_url )
-      message.config.ipn_end_point.should eql ipn_validate_url
+    it "set IPN endpoint" do
+      message = IPN::Message.new("")
+      message.ipn_endpoint.should eql "https://www.sandbox.paypal.com/cgi-bin/webscr"
+      message = IPN::Message.new("", :mode => :sandbox)
+      message.ipn_endpoint.should eql "https://www.sandbox.paypal.com/cgi-bin/webscr"
+
+      message = IPN::Message.new("", :mode => :live)
+      message.ipn_endpoint.should eql "https://ipnpb.paypal.com/cgi-bin/webscr"
+
+      message = IPN::Message.new("", :ipn_endpoint => "http://example.com")
+      message.ipn_endpoint.should eql "http://example.com"
     end
   end
 

data/spec/core/api/merchant_spec.rb

@@ -5,9 +5,46 @@ describe PayPal::SDK::Core::API::Merchant do
   Merchant = PayPal::SDK::Core::API::Merchant
 
   TransactionSearchParams = { "StartDate" => "2012-09-30T00:00:00+0530", "EndDate" => "2012-09-30T00:01:00+0530"}
-  MassPayParams = { "ReceiverType" => "EmailAddress", "MassPayItem" => [{ 
+  MassPayParams = { "ReceiverType" => "EmailAddress", "MassPayItem" => [{
             "ReceiverEmail" => "enduser_biz@gmail.com", "Amount" => { "@currencyID" => "USD", "value" => "3.00" } }] }
 
+  describe "Configuration" do
+    it "service endpoint for sandbox" do
+      client = Merchant.new
+      client.service_endpoint.should eql "https://api-3t.sandbox.paypal.com/2.0/"
+      client = Merchant.new( :mode => "sandbox" )
+      client.service_endpoint.should eql "https://api-3t.sandbox.paypal.com/2.0/"
+      client = Merchant.new( :mode => :sandbox )
+      client.service_endpoint.should eql "https://api-3t.sandbox.paypal.com/2.0/"
+      client = Merchant.new( :mode => "invalid" )
+      client.service_endpoint.should eql "https://api-3t.sandbox.paypal.com/2.0/"
+      client = Merchant.new( :mode => nil )
+      client.service_endpoint.should eql "https://api-3t.sandbox.paypal.com/2.0/"
+
+      client = Merchant.new(:with_certificate)
+      client.service_endpoint.should eql "https://api.sandbox.paypal.com/2.0/"
+    end
+
+    it "service_endpoint for live" do
+      client = Merchant.new( :mode => "live" )
+      client.service_endpoint.should eql "https://api-3t.paypal.com/2.0/"
+      client = Merchant.new( :mode => :live )
+      client.service_endpoint.should eql "https://api-3t.paypal.com/2.0/"
+
+      client = Merchant.new( :with_certificate, :mode => "live" )
+      client.service_endpoint.should eql "https://api.paypal.com/2.0/"
+    end
+
+    it "override service endpoint" do
+      client = Merchant.new( :merchant_endpoint => "http://example.com" )
+      client.service_endpoint.should eql "http://example.com"
+      client = Merchant.new( :merchant_endpoint => "http://example.com", :mode => :live )
+      client.service_endpoint.should eql "http://example.com"
+      client = Merchant.new( :endpoint => "http://example.com" )
+      client.service_endpoint.should eql "http://example.com"
+    end
+  end
+
   describe "Success request" do
     it "with default configuration" do
       client    = Merchant.new
@@ -37,33 +74,33 @@ describe PayPal::SDK::Core::API::Merchant do
     end
 
     it "should handle :value member" do
-      uri, request, http_header = @client.format_request("Action", :amount => { :value => "50" } )
-      request.should match '<amount>50</amount>'
-      uri, request, http_header = @client.format_request("Action", "amount" => { "value" => "50" } )
-      request.should match '<amount>50</amount>'
+      payload = @client.format_request(:action => "Action", :params => { :amount => { :value => "50" } } )
+      payload[:body].should match '<amount>50</amount>'
+      payload = @client.format_request(:action => "Action", :params => { "amount" => { "value" => "50" } } )
+      payload[:body].should match '<amount>50</amount>'
     end
 
     it "should handle attribute" do
-      uri, request, http_header = @client.format_request("Action", :amount => { "@currencyID" => "USD", :value => "50" } )
-      request.should match '<amount currencyID="USD">50</amount>'
-      uri, request, http_header = @client.format_request("Action", "amount" => { "@currencyID" => "USD", "value" => "50" } )
-      request.should match '<amount currencyID="USD">50</amount>'
+      payload = @client.format_request(:action => "Action", :params => { :amount => { "@currencyID" => "USD", :value => "50" } } )
+      payload[:body].should match '<amount currencyID="USD">50</amount>'
+      payload = @client.format_request(:amount => "Action", :params => { "amount" => { "@currencyID" => "USD", "value" => "50" } } )
+      payload[:body].should match '<amount currencyID="USD">50</amount>'
     end
 
     it "should handle members" do
-      uri, request, http_header = @client.format_request("Action", :list => { :amount => { "@currencyID" => "USD", :value => "50" } } )
-      request.should match '<list><amount currencyID="USD">50</amount></list>'
+      payload = @client.format_request(:action => "Action", :params => { :list => { :amount => { "@currencyID" => "USD", :value => "50" } } })
+      payload[:body].should match '<list><amount currencyID="USD">50</amount></list>'
     end
 
     it "should handle array of members" do
-      uri, request, http_header = @client.format_request("Action",
-        :list => { :amount => [ { "@currencyID" => "USD", :value => "50" }, { "@currencyID" => "USD", :value => "25" } ] }  )
-      request.should match '<list><amount currencyID="USD">50</amount><amount currencyID="USD">25</amount></list>'
+      payload = @client.format_request(:action => "Action", :params => {
+        :list => { :amount => [ { "@currencyID" => "USD", :value => "50" }, { "@currencyID" => "USD", :value => "25" } ] } })
+      payload[:body].should match '<list><amount currencyID="USD">50</amount><amount currencyID="USD">25</amount></list>'
     end
 
     it "should handle namespace" do
-      uri, request, http_header = @client.format_request("Action", :"ebl:amount" => { "@cc:currencyID" => "USD", :value => "50" } )
-      request.should match '<ebl:amount cc:currencyID="USD">50</ebl:amount>'
+      payload = @client.format_request(:action => "Action", :params => { :"ebl:amount" => { "@cc:currencyID" => "USD", :value => "50" } } )
+      payload[:body].should match '<ebl:amount cc:currencyID="USD">50</ebl:amount>'
     end
   end
 
@@ -78,7 +115,7 @@ describe PayPal::SDK::Core::API::Merchant do
     end
 
     it "invalid 3 token authentication" do
-      client   = Merchant.new(:username => "invalid")
+      client   = Merchant.new(:username => "invalid", :password => 1234 )
       response = client.request("TransactionSearch", TransactionSearchParams )
       should_be_failure(response, "Security error")
     end
@@ -90,9 +127,10 @@ describe PayPal::SDK::Core::API::Merchant do
     end
 
     it "invalid action" do
-      client   = Merchant.new
-      response = client.request("InvalidAction", TransactionSearchParams )
-      should_be_failure(response, "Internal Server Error")
+      lambda {
+        client   = Merchant.new
+        response = client.request("InvalidAction", TransactionSearchParams )
+      }.should raise_error PayPal::SDK::Core::Exceptions::ServerError
     end
 
     it "invalid params" do

data/spec/core/api/platform_spec.rb

@@ -13,9 +13,45 @@ describe PayPal::SDK::Core::API::Platform do
                                     { "name"=>"item2", "quantity"=>"2", "unitPrice"=>"2.00" } ] },
         "currencyCode" => "USD", "paymentTerms" => "DueOnReceipt" } }
 
-  it "create client with Service name" do
-    client = Platform.new("AdaptivePayments")
-    client.uri.path.should match "AdaptivePayments$"
+  describe "Configuration" do
+    it "create client with Service name" do
+      client = Platform.new("AdaptivePayments")
+      client.uri.path.should match "AdaptivePayments$"
+      client.service_name.should eql "AdaptivePayments"
+    end
+
+    it "service endpoint for sandbox" do
+      sandbox_endpoint = "https://svcs.sandbox.paypal.com/"
+      client = Platform.new("AdaptivePayments")
+      client.service_endpoint.should eql sandbox_endpoint
+      client = Platform.new("AdaptivePayments", :with_certificate)
+      client.service_endpoint.should eql sandbox_endpoint
+      client = Platform.new("AdaptivePayments", :mode => "sandbox")
+      client.service_endpoint.should eql sandbox_endpoint
+      client = Platform.new("AdaptivePayments", :mode => :sandbox)
+      client.service_endpoint.should eql sandbox_endpoint
+      client = Platform.new("AdaptivePayments", :mode => "invalid")
+      client.service_endpoint.should eql sandbox_endpoint
+      client = Platform.new("AdaptivePayments", :mode => nil)
+      client.service_endpoint.should eql sandbox_endpoint
+    end
+
+    it "service endpoint for live" do
+      live_endpoint = "https://svcs.paypal.com/"
+      client = Platform.new("AdaptivePayments", :mode => "live")
+      client.service_endpoint.should eql live_endpoint
+      client = Platform.new("AdaptivePayments", :with_certificate, :mode => :live)
+      client.service_endpoint.should eql live_endpoint
+    end
+
+    it "override service endpoint" do
+      client = Platform.new("AdaptivePayments", :platform_endpoint => "http://example.com" )
+      client.service_endpoint.should eql "http://example.com"
+      client = Platform.new("AdaptivePayments", :platform_endpoint => "http://example.com", :mode => :live )
+      client.service_endpoint.should eql "http://example.com"
+      client = Platform.new("AdaptivePayments", :endpoint => "http://example.com" )
+      client.service_endpoint.should eql "http://example.com"
+    end
   end
 
   describe "Success request" do
@@ -58,8 +94,22 @@ describe PayPal::SDK::Core::API::Platform do
         should_be_success(response)
       end
     end
+
+    describe "Override Configuration" do
+      it "Set verify_mode" do
+        api = Platform.new("AdaptivePayments", :ssl_options => { :verify_mode => 0 } )
+        api.http.verify_mode.should eql 0
+      end
+
+      it "Set ca_file" do
+        api = Platform.new("AdaptivePayments", :ssl_options => { :ca_file => "ca_file_path" } )
+        api.http.ca_file.should eql "ca_file_path"
+      end
+    end
+
   end
 
+
   describe "Failure request" do
     def should_be_failure(response, message = nil)
       response.should_not be_nil
@@ -69,7 +119,7 @@ describe PayPal::SDK::Core::API::Platform do
     end
 
     it "invalid 3 token authentication" do
-      client   = Platform.new("AdaptivePayments", :password => "invalid")
+      client   = Platform.new("AdaptivePayments", :username => 1234, :password => "invalid")
       response = client.request("ConvertCurrency", ConvertCurrencyParams )
       should_be_failure(response, "Authentication failed")
     end
@@ -81,9 +131,10 @@ describe PayPal::SDK::Core::API::Platform do
     end
 
     it "invalid action" do
-      client   = Platform.new("AdaptivePayments")
-      response = client.request("InvalidAction", ConvertCurrencyParams)
-      should_be_failure(response, "Internal Server Error")
+      lambda {
+        client   = Platform.new("AdaptivePayments")
+        response = client.request("InvalidAction", ConvertCurrencyParams)
+      }.should raise_error PayPal::SDK::Core::Exceptions::ServerError
     end
 
     it "invalid params" do