paypal-sdk-core 0.1.5 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWMwM2MzM2I5ZDkwMDY1ZWE1NDFkODJhMzQxMmEwZDM4NzhlMzk0YQ==
+  data.tar.gz: !binary |-
+    ZTA1MGNhNjE3MzdmZTBmNjY2M2IxNjU2YzNkM2FlMmVhYmMyNjBjNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDFmMzU2ZGNiM2JhOWM0ZDQ5NTI5MTUyNjY1MDU2MzA0ZTlmMDVmNWY2Yzc3
+    ZjE4ODBkMWViNjQ4Y2NhNGY4NjIzOThkOTBiMzI4ZDE3NmNkNmYzMzVjYzky
+    MjBiYTc0ZWFhZjBiZTliYWUxODM3NWFhZWExZGU2MWYyNDMzMjQ=
+  data.tar.gz: !binary |-
+    YWE5YjYwNjYzYWIxOGFhMDMzNGIwY2UyODcwZjg4OGIxZjliMzllNTJjOGFi
+    Y2MwMWFlZTNlOWEzNGYyZWY1YjA2ZTI5Njc2NjY2YTg2NmE2OTE1Y2ZlM2Qw
+    YzdkMzI5MjY0NTY0YjFiNDIwMTJiM2IzYWU4NzlkMWE2MWY5ZDQ=

data/lib/generators/paypal/sdk/templates/paypal.yml

@@ -1,32 +1,29 @@
 test: &default
+
+  # Credentials for New APIs
+  client_id: EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM
+  client_secret: EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM
+
+  # Mode can be 'live' or 'sandbox'
+  mode: sandbox
+
+  # Credentials for Classic APIs
   username: jb-us-seller_api1.paypal.com
   password: WX4WTU3S8MY44S7F
   signature: AFcWxV21C7fd0v3bYYYRCpSSRl31A7yDhhsPUU2XhtMoZXsWHFxu-RWy
   app_id: APP-80W284485P519543T
-  http_timeout: 30
-  mode: sandbox
+  # # With Certificate
+  # cert_path: "config/cert_key.pem"
   sandbox_email_address: Platform.sdk.seller@gmail.com
 
+  # # IP Address
+  # ip_address: 127.0.0.1
+  # # HTTP Proxy
+  # http_proxy: http://proxy-ipaddress:3129/
+
 development:
   <<: *default
 
 production:
   <<: *default
   mode: live
-
-# with_certificate:
-#   <<: *default
-#   username: platfo_1255170694_biz_api1.gmail.com
-#   password: 2DPPKUPKB7DQLXNR
-#   signature:
-#   cert_path: "config/cert_key.pem"
-#   app_id: APP-80W284485P519543T
-#
-# with_oauth_token:
-#   <<: *default
-#   token: ESTy2hio5WJQo1iixkH29I53RJxaS0Gvno1A6.YQXZgktxbY4I2Tdg
-#   token_secret: ZKPhUYuwJwYsfWdzorozWO2U9pI
-#
-# with_proxy:
-#   <<: *default
-#   http_proxy: http://proxy-ipaddress:3129/

data/lib/paypal-sdk-core.rb

@@ -1,17 +1,19 @@
-require "paypal-sdk/core/version"
-require "paypal-sdk/core/config"
-require "paypal-sdk/core/logging"
-
 module PayPal
   module SDK
     module Core
 
+      autoload :VERSION,        "paypal-sdk/core/version"
+      autoload :Config,         "paypal-sdk/core/config"
+      autoload :Configuration,  "paypal-sdk/core/config"
+      autoload :Logging,        "paypal-sdk/core/logging"
       autoload :Authentication, "paypal-sdk/core/authentication"
+      autoload :Exceptions,     "paypal-sdk/core/exceptions"
 
       module API
         autoload :Base,     "paypal-sdk/core/api/base"
         autoload :Merchant, "paypal-sdk/core/api/merchant"
         autoload :Platform, "paypal-sdk/core/api/platform"
+        autoload :REST,     "paypal-sdk/core/api/rest"
         autoload :IPN,      "paypal-sdk/core/api/ipn"
 
         module DataTypes
@@ -25,6 +27,7 @@ module PayPal
       module Util
         autoload :OauthSignature, "paypal-sdk/core/util/oauth_signature"
         autoload :OrderedHash,    "paypal-sdk/core/util/ordered_hash"
+        autoload :HTTPHelper,     "paypal-sdk/core/util/http_helper"
       end
 
       module Credential

data/lib/paypal-sdk/core/api/base.rb

@@ -1,5 +1,3 @@
-require 'net/https'
-
 module PayPal::SDK::Core
 
   module API
@@ -9,35 +7,12 @@ module PayPal::SDK::Core
     #   response = api.request("GetPaymentOptions", "")
     class Base
 
-      include Configuration
-      include Logging
-      include Authentication
+      include Util::HTTPHelper
 
       attr_accessor :http, :uri, :service_name
 
-      DEFAULT_END_POINTS = {
-        :sandbox => {
-          :platform => { # NVP EndPoint
-            :three_token  => "https://svcs.sandbox.paypal.com/",
-            :certificate  => "https://svcs.sandbox.paypal.com/"
-          },
-          :merchant => { # SOAP EndPoint
-            :three_token  => "https://api-3t.sandbox.paypal.com/2.0",
-            :certificate  => "https://api.sandbox.paypal.com/2.0"
-          }
-        },
-        :live => {
-          :platform => { # NVP EndPoint
-            :three_token  => "https://svcs.paypal.com/",
-            :certificate  => "https://svcs.paypal.com/"
-          },
-          :merchant => { # SOAP EndPoint
-            :three_token  => "https://api-3t.paypal.com/2.0",
-            :certificate  => "https://api.paypal.com/2.0"
-          }
-        }
-      }
-      DEFAULT_HTTP_HEADER = {}
+      DEFAULT_API_MODE    = :sandbox
+      API_MODES           = [ :live, :sandbox ]
 
       # Initialize API object
       # === Argument
@@ -56,89 +31,89 @@ module PayPal::SDK::Core
         set_config(environment, options)
       end
 
-      # Override set_config method to create http connection on changing the configuration.
-      def set_config(*args)
-        super
-        create_http_connection
+      def uri
+        @uri ||=
+          begin
+            uri = URI.parse("#{service_endpoint}/#{service_name}")
+            uri.path = uri.path.gsub(/\/+/, "/")
+            uri
+          end
       end
 
-      # Create HTTP connection based on given service name or configured end point
-      def create_http_connection
-        service_path = "#{service_endpoint}/#{service_name}"
-        @uri  = URI.parse(service_path)
-        if config.http_proxy
-          proxy = URI.parse(config.http_proxy)
-          @http = Net::HTTP.new(@uri.host, @uri.port, proxy.host, proxy.port, proxy.user, proxy.password)
-        else
-          @http = Net::HTTP.new(@uri.host, @uri.port)
-        end
-        @uri.path = @uri.path.gsub(/\/+/, "/")
-        configure_http_connection
+      def http
+        @http ||= create_http_connection(uri)
       end
 
-      # Configure HTTP connection based on configuration.
-      def configure_http_connection
-        if @uri.scheme == "https"
-          http.use_ssl  = true
-          if config.ca_file
-            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-            http.ca_file  = config.ca_file
-          end
-        end
-        if config.http_timeout
-          http.open_timeout = config.http_timeout
-          http.read_timeout = config.http_timeout
-        end
-        add_certificate(http)
+      # Override set_config method to create http connection on changing the configuration.
+      def set_config(*args)
+        @http = @uri = nil
+        super
       end
 
       # Get configured API mode( sandbox or live)
       def api_mode
-        api_modes   = DEFAULT_END_POINTS.keys
-        config_mode = ( config.mode || api_modes.first ).to_sym
-        api_modes.include?(config_mode) ? config_mode : api_modes.first
-      end
-
-      # Get default endpoint for the given service name
-      # === Argument
-      # * <tt>name</tt> -- Service name ( platform or merchant)
-      # === Returns
-      # Return service end point based on the configured API mode.
-      def default_end_point(name)
-        default_end_point = DEFAULT_END_POINTS[api_mode][name]
-        if default_end_point
-          config.cert_path ? default_end_point[:certificate] : default_end_point[:three_token]
+        if config.mode and API_MODES.include? config.mode.to_sym
+          config.mode.to_sym
+        else
+          DEFAULT_API_MODE
         end
       end
 
       # Get service end point
       def service_endpoint
-        config.end_point ? default_end_point(config.end_point.to_sym) : config.end_point
+        config.endpoint
       end
 
       # Default Http header
       def default_http_header
-        DEFAULT_HTTP_HEADER
+        { "User-Agent" => self.class.user_agent }
       end
 
       # Generate HTTP request for given action and parameters
       # === Arguments
+      # * <tt>http_method</tt> -- HTTP method(get/put/post/delete/patch)
       # * <tt>action</tt> -- Action to perform
       # * <tt>params</tt> -- (Optional) Parameters for the action
       # * <tt>initheader</tt> -- (Optional) HTTP header
-      def request(action, params = {}, initheader = {})
-        uri, content, header = format_request(action, params)
-        initheader    = default_http_header.merge(header).merge(initheader)
-        initheader.delete_if{|key, val| val.nil? }
-        response      = 
-          log_event("Request: #{action}") do
-            @http.post(uri.path, content, initheader)
-          end
-        format_response(action, response)
+      def api_call(payload)
+        payload[:header] = default_http_header.merge(payload[:header])
+        payload[:uri]   ||= uri.dup
+        payload[:http]  ||= http.dup
+        payload[:uri].query = encode_www_form(payload[:query]) if payload[:query] and payload[:query].any?
+        format_request(payload)
+        payload[:response] = http_call(payload)
+        format_response(payload)
+        payload[:data]
       rescue Net::HTTPBadGateway, Errno::ECONNRESET, Errno::ECONNABORTED, SocketError => error
         format_error(error, error.message)
       end
 
+      # Generate HTTP request for given action and parameters
+      # === Arguments
+      # * <tt>action</tt> -- Action to perform
+      # * <tt>params</tt> -- (Optional) Parameters for the action
+      # * <tt>initheader</tt> -- (Optional) HTTP header
+      def post(action, params = {}, header = {})
+        api_call(:method => :post, :action => action, :params => params, :header => header)
+      end
+      alias_method :request, :post
+
+      def get(action, params = {}, header = {})
+        api_call(:method => :get, :action => action, :query => params, :params => nil, :header => header)
+      end
+
+      def patch(action, params = {}, header = {})
+        api_call(:method => :patch, :action => action, :params => params, :header => header)
+      end
+
+      def put(action, params = {}, header = {})
+        api_call(:method => :put, :action => action, :params => params, :header => header)
+      end
+
+      def delete(action, params = {}, header = {})
+        api_call(:method => :delete, :action => action, :params => params, :header => header)
+      end
+
       # Format Request data. It will be override by child class
       # == Arguments
       # * <tt>action</tt> -- Request action
@@ -147,16 +122,19 @@ module PayPal::SDK::Core
       # * <tt>path</tt>   -- Formated request uri object
       # * <tt>params</tt> -- Formated request Parameters
       # * <tt>header</tt> -- HTTP Header
-      def format_request(action, params)
-        [ @uri, params, {} ]
+      def format_request(payload)
+        payload[:uri].path = url_join(payload[:uri].path, payload[:action])
+        payload[:body] = payload[:params].to_s
+        payload
       end
 
       # Format Response object. It will be override by child class
       # == Argument
       # * <tt>action</tt> -- Request action
       # * <tt>response</tt> -- HTTP response object
-      def format_response(action, response)
-        response
+      def format_response(payload)
+        payload[:data] = payload[:response].body
+        payload
       end
 
       # Format Error object. It will be override by child class.
@@ -166,6 +144,12 @@ module PayPal::SDK::Core
       def format_error(exception, message)
         raise exception
       end
+
+      class << self
+        def user_agent
+          @user_agent ||= "paypal-sdk-core/#{VERSION} #{RUBY_DESCRIPTION}"
+        end
+      end
     end
   end
 end

data/lib/paypal-sdk/core/api/data_types/base.rb

@@ -110,20 +110,32 @@ module PayPal::SDK::Core
 
         # Initialize options.
         def initialize(options = {}, &block)
+          merge!(options, &block)
+        end
+
+        # Merge values
+        def merge!(options, &block)
           if options.is_a? Hash
             options.each do |key, value|
-              begin
-                send("#{key}=", value)
-              rescue TypeError, ArgumentError => error
-                raise TypeError, "#{error.message}(#{value.inspect}) for #{self.class.name}.#{key} member"
-              end
+              set(key, value)
             end
           elsif members[ContentKey]
-            self.value = options
+            set(ContentKey, options)
           else
             raise ArgumentError, "invalid data(#{options.inspect}) for #{self.class.name} class"
           end
           self.instance_eval(&block) if block
+          self
+        end
+
+        # Set value for given member
+        # === Arguments
+        # * <tt>key</tt> -- member name
+        # * <tt>value</tt> -- value for member
+        def set(key, value)
+          send("#{key}=", value)
+        rescue TypeError, ArgumentError => error
+          raise TypeError, "#{error.message}(#{value.inspect}) for #{self.class.name}.#{key} member"
         end
 
         # Create array of objects.

data/lib/paypal-sdk/core/api/ipn.rb

@@ -1,5 +1,3 @@
-require 'net/https'
-
 module PayPal
   module SDK
     module Core
@@ -14,7 +12,7 @@ module PayPal
           INVALID    = "INVALID"
 
           class Message
-            include PayPal::SDK::Core::Configuration
+            include Util::HTTPHelper
 
             attr_accessor :message
 
@@ -24,31 +22,23 @@ module PayPal
             end
 
             # Fetch end point
-            def ipn_end_point
-              config.ipn_end_point || default_ipn_end_point
+            def ipn_endpoint
+              config.ipn_endpoint || default_ipn_endpoint
             end
 
             # Default IPN end point
-            def default_ipn_end_point
-              end_point = END_POINTS[(config.mode || :sandbox).to_sym] rescue nil
-              end_point || END_POINTS[:sandbox]
+            def default_ipn_endpoint
+              endpoint = END_POINTS[(config.mode || :sandbox).to_sym] rescue nil
+              endpoint || END_POINTS[:sandbox]
             end
 
             # Request IPN service for validating the content
             # === Return
             # return http response object
             def request
-              uri  = URI(ipn_end_point)
-              http = Net::HTTP.new(uri.host, uri.port)
-              if uri.scheme == "https"
-                http.use_ssl = true
-                if config.ca_file
-                  http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-                  http.ca_file =  config.ca_file
-                end
-              end
+              uri  = URI(ipn_endpoint)
               query_string = "cmd=_notify-validate&#{message}"
-              http.post(uri.path, query_string)
+              http_call(:method => :post, :uri => uri, :body => query_string)
             end
 
             # Validate the given content

data/lib/paypal-sdk/core/api/merchant.rb

@@ -35,10 +35,20 @@ module PayPal::SDK::Core
         :signature  => "ebl:Signature",
         :subject    => "ebl:Subject"
       }
+      DEFAULT_END_POINTS = {
+        :sandbox => {
+          :three_token  => "https://api-3t.sandbox.paypal.com/2.0/",
+          :certificate  => "https://api.sandbox.paypal.com/2.0/"
+        },
+        :live => {
+          :three_token  => "https://api-3t.paypal.com/2.0/",
+          :certificate  => "https://api.paypal.com/2.0/"
+        }
+      }
 
-      # Get SOAP or default end point
+      # Get services end point
       def service_endpoint
-        config.merchant_end_point || super || default_end_point(:merchant)
+        config.merchant_endpoint || config.endpoint || DEFAULT_END_POINTS[api_mode][base_credential_type]
       end
 
       # Format the HTTP request content
@@ -48,22 +58,24 @@ module PayPal::SDK::Core
       # === Return
       # * <tt>request_path</tt> -- Soap request path. DEFAULT("/")
       # * <tt>request_content</tt> -- Request content in SOAP format.
-      def format_request(action, params)
+      def format_request(payload)
         credential_properties  = credential(uri.to_s).properties
         user_auth_header = map_header_value(SOAP_AUTH_HEADER, credential_properties)
-        content_key      = params.keys.first.is_a?(Symbol) ? ContentKey.to_sym : ContentKey.to_s
+        content_key      = payload[:params].keys.first.is_a?(Symbol) ? ContentKey.to_sym : ContentKey.to_s
         xml_out_options  = XML_OUT_OPTIONS.merge( 'ContentKey' => content_key )
         request_content = XmlSimple.xml_out({
           "soapenv:Envelope" => {
           content_key => (
-              XmlSimple.xml_out({"soapenv:Header"  => { "ns:RequesterCredentials" => {
+              XmlSimple.xml_out({"soapenv:Header" => { "ns:RequesterCredentials" => {
                   "ebl:Credentials" => user_auth_header
                }}}, xml_out_options) +
-              XmlSimple.xml_out({"soapenv:Body"    => body(action, params)}, xml_out_options))
+              XmlSimple.xml_out({"soapenv:Body"   => request_body(payload[:action], payload[:params])}, xml_out_options))
           }.merge(Namespaces)
         }, xml_out_options.merge('noescape' => true))
         header = map_header_value(SOAP_HTTP_AUTH_HEADER, credential_properties)
-        [ @uri, request_content, header ]
+        payload[:header]  = header.merge(header)
+        payload[:body]    = request_content
+        payload
       end
 
       # Format Response object
@@ -72,14 +84,22 @@ module PayPal::SDK::Core
       # * <tt>response</tt> -- Response object
       # === Return
       # Parse the SOAP response content and return Hash object
-      def format_response(action, response)
-        if response.code == "200"
-          hash = XmlSimple.xml_in(response.body, XML_IN_OPTIONS)
-          hash = skip_attributes(hash)
-          hash["Body"].find{|key_val| key_val[0] =~ /^[^@]/ }[1] || {}
-        else
-          format_error(response, response.message)
-        end
+      def format_response(payload)
+        payload[:data] =
+          if payload[:response].code == "200"
+            hash = XmlSimple.xml_in(payload[:response].body, XML_IN_OPTIONS)
+            hash = skip_attributes(hash)
+            hash["Body"].find{|key_val| key_val[0] =~ /^[^@]/ }[1] || {}
+          else
+            format_error(payload[:response], payload[:response].message)
+          end
+        payload
+      end
+
+      # Log additional information
+      def log_http_call(payload)
+        logger.info "Action: #{payload[:action]}" if payload[:action]
+        super
       end
 
       private
@@ -88,7 +108,7 @@ module PayPal::SDK::Core
       # == Arguments
       # * <tt>action</tt> -- Request Action name
       # * <tt>params</tt> -- Parameters for the action.
-      def body(action, params = {})
+      def request_body(action, params = {})
         { "ns:#{action}Req" => { "ns:#{action}Request" => DEFAULT_PARAMS.merge(params) } }
       end