paypal-sdk-core 0.1.5 → 0.2.0

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

@@ -24,12 +24,16 @@ module PayPal::SDK::Core
         "X-PAYPAL-REQUEST-DATA-FORMAT"  => "JSON",
         "X-PAYPAL-RESPONSE-DATA-FORMAT" => "JSON"
       }
-      DEFAULT_PARAMS = Util::OrderedHash.new.merge!({ 
+      DEFAULT_PARAMS = Util::OrderedHash.new.merge!({
         "requestEnvelope" => { "errorLanguage" => "en_US" } })
+      DEFAULT_END_POINTS = {
+        :sandbox => "https://svcs.sandbox.paypal.com/",
+        :live    => "https://svcs.paypal.com/"
+      }
 
-      # Get NVP service end point
+      # Get service end point
       def service_endpoint
-        config.platform_end_point || super || default_end_point(:platform)
+        config.platform_endpoint || config.endpoint || DEFAULT_END_POINTS[api_mode]
       end
 
       # Format the Request.
@@ -39,13 +43,14 @@ module PayPal::SDK::Core
       # === Return
       # * <tt>request_path</tt> -- Generated URL for requested action
       # * <tt>request_content</tt> -- Format parameters in JSON with default values.
-      def format_request(action, params)
-        uri = @uri.dup
-        uri.path = @uri.path.sub(/\/?$/, "/#{action}")
-        credential_properties = credential(uri.to_s).properties
+      def format_request(payload)
+        payload[:uri].path = url_join(payload[:uri].path, payload[:action])
+        credential_properties = credential(payload[:uri].to_s).properties
         header   = map_header_value(NVP_AUTH_HEADER, credential_properties).
           merge(DEFAULT_NVP_HTTP_HEADER)
-        [ uri, MultiJson.dump(DEFAULT_PARAMS.merge(params)), header ]
+        payload[:header] = header.merge(payload[:header])
+        payload[:body]   = MultiJson.dump(DEFAULT_PARAMS.merge(payload[:params]))
+        payload
       end
 
       # Format the Response object
@@ -54,12 +59,14 @@ module PayPal::SDK::Core
       # * <tt>response</tt> -- HTTP response object
       # === Return
       # Parse response content using JSON and return the Hash object
-      def format_response(action, response)
-        if response.code == "200"
-          MultiJson.load(response.body)
-        else
-          format_error(response, response.message)
-        end
+      def format_response(payload)
+        payload[:data] =
+          if payload[:response].code == "200"
+            MultiJson.load(payload[:response].body)
+          else
+            format_error(payload[:response], payload[:response].message)
+          end
+        payload
       end
 
       # Format Error object.

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

@@ -0,0 +1,139 @@
+require 'multi_json'
+
+module PayPal::SDK::Core
+  module API
+    class REST < Base
+      NVP_AUTH_HEADER = {
+        :sandbox_email_address => "X-PAYPAL-SANDBOX-EMAIL-ADDRESS",
+        :device_ipaddress      => "X-PAYPAL-DEVICE-IPADDRESS"
+      }
+      DEFAULT_HTTP_HEADER = {
+        "Content-Type" => "application/json"
+      }
+
+      DEFAULT_REST_END_POINTS = {
+        :sandbox => "https://api.sandbox.paypal.com",
+        :live    => "https://api.paypal.com"
+      }
+      TOKEN_REQUEST_PARAMS = "grant_type=client_credentials"
+
+      # Get REST service end point
+      def service_endpoint
+        config.rest_endpoint || super || DEFAULT_REST_END_POINTS[api_mode]
+      end
+
+      # Token endpoint
+      def token_endpoint
+        config.rest_token_endpoint || service_endpoint
+      end
+
+      # Clear cached values.
+      def set_config(*args)
+        @token_uri = nil
+        @token = nil
+        super
+      end
+
+      # URI object token endpoint
+      def token_uri
+        @token_uri ||=
+          begin
+            new_uri = URI.parse(token_endpoint)
+            new_uri.path = "/v1/oauth2/token" if new_uri.path =~ /^\/?$/
+            new_uri
+          end
+      end
+
+      # Generate Oauth token or Get cached
+      def token
+        @token ||=
+          begin
+            basic_auth = ["#{config.client_id}:#{config.client_secret}"].pack('m').delete("\r\n")
+            token_headers = default_http_header.merge( "Authorization" => "Basic #{basic_auth}" )
+            response = http_call( :method => :post, :uri => token_uri, :body => TOKEN_REQUEST_PARAMS, :header => token_headers )
+            MultiJson.load(response.body)["access_token"]
+          end
+      end
+
+      # token setter
+      def token=(new_token)
+        @token = new_token
+      end
+
+      # Override the API call to handle Token Expire
+      def api_call(payload)
+        backup_payload  = payload.dup
+        begin
+          response = super(payload)
+        rescue UnauthorizedAccess => error
+          if @token and config.client_id
+            # Reset cached token and Retry api request
+            @token = nil
+            response = super(backup_payload)
+          else
+            raise error
+          end
+        end
+        response
+      end
+
+      # Validate HTTP response
+      def handle_response(response)
+        super
+      rescue BadRequest => error
+        # Catch BadRequest to get validation error message from the response.
+        error.response
+      end
+
+      # Format request payload
+      # === Argument
+      # * payload( uri, action, params, header)
+      # === Generate
+      # * payload( uri, body, header )
+      def format_request(payload)
+        # Request URI
+        payload[:uri].path = url_join(payload[:uri].path, payload[:action])
+        # HTTP Header
+        credential_properties = credential(payload[:uri].to_s).properties
+        header = map_header_value(NVP_AUTH_HEADER, credential_properties)
+        payload[:header]  = header.merge("Authorization" => "Bearer #{token}").
+          merge(DEFAULT_HTTP_HEADER).merge(payload[:header])
+        # Post Data
+        payload[:body]    = MultiJson.dump(payload[:params])
+        payload
+      end
+
+      # Format response payload
+      # === Argument
+      # * payload( response )
+      # === Generate
+      # * payload( data )
+      def format_response(payload)
+        payload[:data] =
+          if payload[:response].code >= "200" and payload[:response].code <= "299"
+            MultiJson.load(payload[:response].body)
+          elsif payload[:response].content_type == "application/json"
+            { "error" => MultiJson.load(payload[:response].body) }
+          else
+            { "error" => { "name" => payload[:response].code, "message" => payload[:response].message,
+              "developer_msg" => payload[:response] } }
+          end
+        payload
+      end
+
+      # Formate Exception object
+      def format_error(exception, message)
+        { "error" => { "name" => "ERROR", "message" => message, "developer_msg" => exception } }
+      end
+
+      # Log PayPal-Request-Id header
+      def log_http_call(payload)
+        if payload[:header] and payload[:header]["PayPal-Request-Id"]
+          logger.info "PayPal-Request-Id: #{payload[:header]["PayPal-Request-Id"]}"
+        end
+        super
+      end
+
+    end
+  end
+end

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

@@ -30,6 +30,11 @@ module PayPal::SDK::Core
         end
     end
 
+    # Get base credential type
+    def base_credential_type
+      config.cert_path ? :certificate : :three_token
+    end
+
     # Get third party credential
     def third_party_credential(url)
       if config.token and config.token_secret
@@ -41,26 +46,8 @@ module PayPal::SDK::Core
 
     # Clear cached variables on changing the configuration.
     def set_config(*args)
-      super
       @base_credential = nil
-    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 if key
-      end
-      header
+      super
     end
 
     # Configure ssl certificate to HTTP object

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

@@ -25,8 +25,25 @@ module PayPal::SDK::Core
     # === Arguments
     # * <tt>env</tt> -- Environment
     # * <tt>override_configurations</tt> (Optional) -- To override the default configuration.
+    # === Examples
+    #   obj.set_config(api.config)
+    #   obj.set_config(:http_timeout => 30)
+    #   obj.set_config(:development)
+    #   obj.set_config(:development, :http_timeout => 30)
     def set_config(env, override_configurations = {})
-      @config = env.is_a?(Config) ? env : Config.config(env, override_configurations)
+      @config =
+        case env
+        when Config
+          env
+        when Hash
+          begin
+            config.dup.merge!(env)
+          rescue Errno::ENOENT => error
+            Config.new(env)
+          end
+        else
+          Config.config(env, override_configurations)
+        end
     end
 
     alias_method :config=, :set_config
@@ -45,15 +62,31 @@ module PayPal::SDK::Core
   #   # Read configuration attributes
   #   config = Config.config
   #   config.username
-  #   config.end_point
+  #   config.endpoint
   class Config
+
+    include Logging
+    include Exceptions
+
     attr_accessor :username, :password, :signature, :app_id, :cert_path,
         :token, :token_secret, :subject,
-        :http_timeout, :http_retry, :http_proxy, :ca_file,
+        :http_timeout, :http_proxy,
         :device_ipaddress, :sandbox_email_address,
-        :mode, :end_point, :merchant_end_point, :platform_end_point, :ipn_end_point,
-        :redirect_url, :dev_central_url,
-        :logfile
+        :mode, :endpoint, :merchant_endpoint, :platform_endpoint, :ipn_endpoint,
+        :rest_endpoint, :rest_token_endpoint, :client_id, :client_secret
+
+    alias_method :end_point=, :endpoint=
+    alias_method :end_point, :endpoint
+    alias_method :platform_end_point=, :platform_endpoint=
+    alias_method :platform_end_point, :platform_endpoint
+    alias_method :merchant_end_point=, :merchant_endpoint=
+    alias_method :merchant_end_point, :merchant_endpoint
+    alias_method :ipn_end_point=, :ipn_endpoint=
+    alias_method :ipn_end_point, :ipn_endpoint
+    alias_method :rest_end_point, :rest_endpoint
+    alias_method :rest_end_point=, :rest_endpoint=
+    alias_method :rest_token_end_point, :rest_token_endpoint
+    alias_method :rest_token_end_point=, :rest_token_endpoint=
 
     # Create Config object
     # === Options(Hash)
@@ -66,6 +99,37 @@ module PayPal::SDK::Core
       merge!(options)
     end
 
+    def logfile=(filename)
+      logger.warn '`logfile=` is deprecated, Please use `PayPal::SDK::Core::Config.logger = Logger.new(STDERR)`'
+    end
+
+    def redirect_url=(redirect_url)
+      logger.warn '`redirect_url=` is deprecated.'
+    end
+
+    def dev_central_url=(dev_central_url)
+      logger.warn '`dev_central_url=` is deprecated.'
+    end
+
+    def ssl_options
+      @ssl_options ||= {}.freeze
+    end
+
+    def ssl_options=(options)
+      options = Hash[options.map{|key, value| [key.to_sym, value] }]
+      @ssl_options = ssl_options.merge(options).freeze
+    end
+
+    def ca_file=(ca_file)
+      logger.warn '`ca_file=` is deprecated, Please configure `ca_file=` under `ssl_options`'
+      self.ssl_options = { :ca_file => ca_file }
+    end
+
+    def http_verify_mode=(verify_mode)
+      logger.warn '`http_verify_mode=` is deprecated, Please configure `verify_mode=` under `ssl_options`'
+      self.ssl_options = { :verify_mode => verify_mode }
+    end
+
     # Override configurations
     def merge!(options)
       options.each do |key, value|
@@ -74,6 +138,12 @@ module PayPal::SDK::Core
       self
     end
 
+    # Validate required configuration
+    def required!(*names)
+      names = names.select{|name| send(name).nil? }
+      raise MissingConfig.new("Required configuration(#{names.join(", ")})") if names.any?
+    end
+
     class << self
 
       @@config_cache = {}
@@ -141,7 +211,7 @@ module PayPal::SDK::Core
       # Set configuration
       def configurations=(configs)
         @@config_cache   = {}
-        @@configurations = Hash[configs.map{|k,v| [k.to_s, v] }]
+        @@configurations = configs && Hash[configs.map{|k,v| [k.to_s, v] }]
       end
 
       private

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

@@ -0,0 +1,87 @@
+module PayPal::SDK::Core
+  module Exceptions
+    class ConnectionError < StandardError # :nodoc:
+      attr_reader :response
+
+      def initialize(response, message = nil)
+        @response = response
+        @message  = message
+      end
+
+      def to_s
+        message = "Failed."
+        message << "  Response code = #{response.code}." if response.respond_to?(:code)
+        message << "  Response message = #{response.message}." if response.respond_to?(:message)
+        message
+      end
+    end
+
+    # Raised when a Timeout::Error occurs.
+    class TimeoutError < ConnectionError
+      def initialize(message)
+        @message = message
+      end
+      def to_s; @message ;end
+    end
+
+    # Raised when a OpenSSL::SSL::SSLError occurs.
+    class SSLError < ConnectionError
+      def initialize(message)
+        @message = message
+      end
+      def to_s; @message ;end
+    end
+
+    # 3xx Redirection
+    class Redirection < ConnectionError # :nodoc:
+      def to_s
+        response['Location'] ? "#{super} => #{response['Location']}" : super
+      end
+    end
+
+    class MissingParam < ArgumentError # :nodoc:
+    end
+
+    class MissingConfig < StandardError # :nodoc:
+    end
+
+    # 4xx Client Error
+    class ClientError < ConnectionError # :nodoc:
+    end
+
+    # 400 Bad Request
+    class BadRequest < ClientError # :nodoc:
+    end
+
+    # 401 Unauthorized
+    class UnauthorizedAccess < ClientError # :nodoc:
+    end
+
+    # 403 Forbidden
+    class ForbiddenAccess < ClientError # :nodoc:
+    end
+
+    # 404 Not Found
+    class ResourceNotFound < ClientError # :nodoc:
+    end
+
+    # 409 Conflict
+    class ResourceConflict < ClientError # :nodoc:
+    end
+
+    # 410 Gone
+    class ResourceGone < ClientError # :nodoc:
+    end
+
+    # 5xx Server Error
+    class ServerError < ConnectionError # :nodoc:
+    end
+
+    # 405 Method Not Allowed
+    class MethodNotAllowed < ClientError # :nodoc:
+      def allowed_methods
+        @response['Allow'].split(',').map { |verb| verb.strip.downcase.to_sym }
+      end
+    end
+  end
+end