paypal-sdk-core 0.1.0

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

@@ -0,0 +1,26 @@
+module PayPal::SDK::Core
+  module API
+    module DataTypes
+
+      class Enum < SimpleTypes::String
+        class << self
+          def options
+            @options ||= []
+          end
+
+          def options=(options)
+            if options.is_a? Hash
+              options.each do |const_name, value|
+                const_set(const_name, value)
+              end
+              @options = options.values
+            else
+              @options = options
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'date'
+
+module PayPal::SDK::Core
+  module API
+    module DataTypes
+
+      module SimpleTypes
+        class String < ::String
+          def self.new(string = "")
+            string.is_a?(::String) ? super : super(string.to_s)
+          end
+        end
+
+        class Integer < ::Integer
+          def self.new(number)
+            number.to_i
+          end
+        end
+
+        class Float < ::Float
+          def self.new(float)
+            float.to_f
+          end
+        end
+
+        class Boolean
+          def self.new(boolean)
+            ( boolean == 0 || boolean == "" || boolean =~ /^(false|f|no|n|0)$/i ) ? false : !!boolean
+          end
+        end
+
+        class Date < ::Date
+          def self.new(date)
+            date.is_a?(::Date) ? date : Date.parse(date.to_s)
+          end
+        end
+
+        class DateTime < ::DateTime
+          def self.new(date_time)
+            date_time.is_a?(::DateTime) ? date_time : parse(date_time.to_s)
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+require 'xmlsimple'
+
+module PayPal::SDK::Core
+
+  module API
+
+    # Use SOAP protocol to communicate with the Merchant Web services
+    # == Example
+    #   api       = API::Merchant.new
+    #   response  = api.request("TransactionSearch", { "StartDate" => "2012-09-30T00:00:00+0530",
+    #      "EndDate" => "2012-10-01T00:00:00+0530" })
+    class Merchant < Base
+
+
+      Namespaces = {
+        "@xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/",
+        "@xmlns:ns"      => "urn:ebay:api:PayPalAPI",
+        "@xmlns:ebl"     => "urn:ebay:apis:eBLBaseComponents",
+        "@xmlns:cc"      => "urn:ebay:apis:CoreComponentTypes",
+        "@xmlns:ed"      => "urn:ebay:apis:EnhancedDataTypes"
+      }
+      ContentKey = API::DataTypes::Base::ContentKey.to_s
+      DEFAULT_API_VERSION = "94.0"
+      XML_OUT_OPTIONS   = { 'RootName' => nil, 'AttrPrefix' => true, 'ContentKey' => ContentKey,
+        'noindent' => true, 'SuppressEmpty' => true }
+      XML_IN_OPTIONS    = { 'AttrPrefix' => true, 'ForceArray' => false, 'ContentKey' => ContentKey }
+      DEFAULT_PARAMS    = { :"ebl:Version" => DEFAULT_API_VERSION }
+      SKIP_ATTRIBUTES   = [ "@xmlns", "@xsi:type" ]
+      SOAP_HTTP_AUTH_HEADER  = {
+        :authorization  => "X-PP-AUTHORIZATION"
+      }
+      SOAP_AUTH_HEADER  = {
+        :username   => "ebl:Username",
+        :password   => "ebl:Password",
+        :signature  => "ebl:Signature",
+        :subject    => "ebl:Subject"
+      }
+
+      # Get SOAP or default end point
+      def service_endpoint
+        config.merchant_end_point || super || default_end_point(:merchant)
+      end
+
+      # Format the HTTP request content
+      # === Arguments
+      # * <tt>action</tt> -- Request action
+      # * <tt>params</tt> -- Parameters for Action in Hash format
+      # === Return
+      # * <tt>request_path</tt> -- Soap request path. DEFAULT("/")
+      # * <tt>request_content</tt> -- Request content in SOAP format.
+      def format_request(action, params)
+        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
+        request_content = XmlSimple.xml_out({
+          "soapenv:Envelope" => {
+            "soapenv:Header"  => { "ns:RequesterCredentials" => {
+                "ebl:Credentials" => user_auth_header
+             } },
+            "soapenv:Body"    => body(action, params)
+          }.merge(Namespaces)
+        }, XML_OUT_OPTIONS.merge( 'ContentKey' => content_key ))
+        header = map_header_value(SOAP_HTTP_AUTH_HEADER, credential_properties)
+        [ @uri, request_content, header ]
+      end
+
+      # Format Response object
+      # === Arguments
+      # * <tt>action</tt> -- Request action
+      # * <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
+      end
+
+      private
+
+      # Generate soap body
+      # == Arguments
+      # * <tt>action</tt> -- Request Action name
+      # * <tt>params</tt> -- Parameters for the action.
+      def body(action, params = {})
+        { "ns:#{action}Req" => { "ns:#{action}Request" => DEFAULT_PARAMS.merge(params) } }
+      end
+
+      # Remove specified attributes from the given Hash
+      # === Arguments
+      # * <tt>hash</tt>   -- Hash object
+      # * <tt>attrs</tt>  -- (Optional) Attribute list
+      # * <tt>content_key</tt> -- (Optional) content key
+      def skip_attributes(hash, attrs = SKIP_ATTRIBUTES, content_key = ContentKey)
+        hash.each do |key, value|
+          if attrs.include? key
+            hash.delete(key)
+          elsif value.is_a? Hash
+            hash[key] = skip_attributes(value, attrs, content_key)
+          elsif value.is_a? Array and value[0].is_a? Hash
+            value.each_with_index do |array_value, index|
+              value[index] = skip_attributes(array_value, attrs, content_key)
+            end
+          end
+        end
+        ( hash.one? and hash[content_key] ) ? hash[content_key] : ( hash.empty? ? nil : hash )
+      end
+
+      # Format Error object.
+      # == Arguments
+      # * <tt>exception</tt> -- Exception object or HTTP response object.
+      # * <tt>message</tt> -- Readable error message.
+      def format_error(exception, message)
+        { "Ack" => "Failure", "Errors" => { "ShortMessage" => message, "LongMessage" => exception.to_s } }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+require 'json'
+
+module PayPal::SDK::Core
+  module API
+
+    # Use NVP protocol to communicate with Platform Web services
+    # == Example
+    #   api       = API::Platform.new("AdaptivePayments")
+    #   response  = client.request("ConvertCurrency", {
+    #     "baseAmountList"        => { "currency" => [ { "code" => "USD", "amount" => "2.0"} ]},
+    #     "convertToCurrencyList" => { "currencyCode" => ["GBP"] } })
+    class Platform < Base
+
+      NVP_AUTH_HEADER = {
+        :username       => "X-PAYPAL-SECURITY-USERID",
+        :password       => "X-PAYPAL-SECURITY-PASSWORD",
+        :signature      => "X-PAYPAL-SECURITY-SIGNATURE",
+        :app_id         => "X-PAYPAL-APPLICATION-ID",
+        :authorization  => "X-PAYPAL-AUTHORIZATION",
+        :sandbox_email_address => "X-PAYPAL-SANDBOX-EMAIL-ADDRESS",
+        :device_ipaddress      => "X-PAYPAL-DEVICE-IPADDRESS"
+      }
+      DEFAULT_NVP_HTTP_HEADER = {
+        "X-PAYPAL-REQUEST-DATA-FORMAT"  => "JSON",
+        "X-PAYPAL-RESPONSE-DATA-FORMAT" => "JSON"
+      }
+      DEFAULT_PARAMS = {
+        "requestEnvelope"       => { "errorLanguage" => "en_US" }
+      }
+
+      # Get NVP service end point
+      def service_endpoint
+        config.platform_end_point || super || default_end_point(:platform)
+      end
+
+      # Format the Request.
+      # === Arguments
+      # * <tt>action</tt> -- Action to perform
+      # * <tt>params</tt> -- Action parameters will be in Hash
+      # === 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
+        header   = map_header_value(NVP_AUTH_HEADER, credential_properties).
+          merge(DEFAULT_NVP_HTTP_HEADER)
+        [ uri, DEFAULT_PARAMS.merge(params).to_json, header ]
+      end
+
+      # Format the Response object
+      # === Arguments
+      # * <tt>action</tt> -- Requested action name
+      # * <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"
+          JSON.parse(response.body)
+        else
+          format_error(response, response.message)
+        end
+      end
+
+      # Format Error object.
+      # == Arguments
+      # * <tt>exception</tt> -- Exception object or HTTP response object.
+      # * <tt>message</tt> -- Readable error message.
+      def format_error(exception, message)
+        {"responseEnvelope" => {"ack" => "Failure"}, "error" => [{"message" => message}]}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+
+module PayPal::SDK::Core
+
+  # Contains methods to format credentials for HTTP protocol.
+  # == Example
+  #  include Authentication
+  #  credential(url)
+  #  base_credential
+  #  third_party_credential(url)
+  #
+  #  add_certificate(http)
+  module Authentication
+
+    include Configuration
+
+    # Get credential object
+    # === Argument
+    # * <tt>url</tt> -- API request url
+    def credential(url)
+      third_party_credential(url) || base_credential
+    end
+
+    # Get base credential
+    def base_credential
+      @base_credential ||=
+        if config.cert_path
+          Credential::Certificate.new(config)
+        else
+          Credential::Signature.new(config)
+        end
+    end
+
+    # Get third party credential
+    def third_party_credential(url)
+      if config.token and config.token_secret
+        Credential::ThirdParty::Token.new(base_credential, config, url)
+      elsif config.subject
+        Credential::ThirdParty::Subject.new(base_credential, config)
+      end
+    end
+
+    # 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
+    end
+
+    # Configure ssl certificate to HTTP object
+    # === Argument
+    # * <tt>http</tt> -- Net::HTTP object
+    def add_certificate(http)
+      if base_credential.is_a? Credential::Certificate
+        http.cert = base_credential.cert
+        http.key  = base_credential.key
+      else
+        http.cert = nil
+        http.key  = nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,138 @@
+require 'erb'
+require 'yaml'
+
+module PayPal::SDK::Core
+
+  # Include Configuration module to access configuration from any object
+  # == Examples
+  #   # Include in any class
+  #   include Configuration
+  #
+  #   # Access config object and attributes
+  #   config
+  #   config.username
+  #
+  #   # Change configuration
+  #   set_config(:development)
+  module Configuration
+
+    # To get default Config object.
+    def config
+      @config ||= Config.config
+    end
+
+    # To change the configuration to given environment or configuration
+    # === Arguments
+    # * <tt>env</tt> -- Environment
+    # * <tt>override_configurations</tt> (Optional) -- To override the default configuration.
+    def set_config(env, override_configurations = {})
+      @config = env.is_a?(Config) ? env : Config.config(env, override_configurations)
+    end
+
+    alias_method :config=, :set_config
+  end
+
+  # Config class is used to hold the configurations.
+  # == Examples
+  #   # To load configurations from file
+  #   Config.load('config/paypal.yml', 'development')
+  #
+  #   # Get configuration
+  #   Config.config   # load default configuration
+  #   Config.config(:development) # load development configuration
+  #   Config.config(:development, :app_id => "XYZ") # Override configuration
+  #
+  #   # Read configuration attributes
+  #   config = Config.config
+  #   config.username
+  #   config.end_point
+  class Config
+    attr_accessor :username, :password, :signature, :app_id, :cert_path,
+        :token, :token_secret, :subject,
+        :http_timeout, :http_retry, :http_proxy, :ca_file,
+        :device_ipaddress, :sandbox_email_address,
+        :mode, :end_point, :merchant_end_point, :platform_end_point, :redirect_url, :dev_central_url,
+        :logfile
+
+    # Create Config object
+    # === Options(Hash)
+    # * <tt>username</tt>   -- Username
+    # * <tt>password</tt>   -- Password
+    # * <tt>signature</tt> (Optional if certificate present) -- Signature
+    # * <tt>app_id</tt>     -- Application ID
+    # * <tt>cert_path</tt> (Optional if signature present)  -- Certificate file path
+    def initialize(options)
+      options.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    class << self
+
+      @@config_cache = {}
+
+      # Load configurations from file
+      # === Arguments
+      # * <tt>file_name</tt>             -- Configuration file path
+      # * <tt>default_environment</tt> (Optional)    -- default environment configuration to load
+      # === Example
+      #   Config.load('config/paypal.yml', 'development')
+      def load(file_name, default_env = default_environment)
+        @@configurations      = read_configurations(file_name)
+        @@default_environment = default_env
+        config
+      end
+
+      # Get default environment name
+      def default_environment
+        @@default_environment ||= ENV['PAYPAL_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || ENV['ENV'] || "development"
+      end
+
+      # Create or Load Config object based on given environment and configurations.
+      # === Attributes
+      # * <tt>env</tt> (Optional) -- Environment name
+      # * <tt>override_configuration</tt> (Optional) -- Override the configuration given in file.
+      # === Example
+      #   Config.config
+      #   Config.config(:development)
+      #   Config.config(:development, { :app_id => "XYZ" })
+      def config(env = default_environment, override_configuration = {})
+        if env.is_a? Hash
+          override_configuration = env
+          env = default_environment
+        end
+        env = (env || default_environment).to_s
+        raise "Configuration[#{env}] NotFound" unless configurations[env]
+        if override_configuration.nil? or override_configuration.empty?
+          @@config_cache[env] ||= new configurations[env]
+        else
+          new configurations[env].merge(override_configuration)
+        end
+      end
+
+      def logger=(logger)
+        Logging.logger = logger
+      end
+
+      def logger
+        Logging.logger
+      end
+
+      private
+      # Read configurations from the given file name
+      # === Arguments
+      # * <tt>file_name</tt> (Optional) -- Configuration file path
+      def read_configurations(file_name = "config/paypal.yml")
+        erb = ERB.new(File.read(file_name))
+        erb.filename = file_name
+        YAML.load(erb.result)
+      end
+
+      # Get raw configurations in Hash format.
+      def configurations
+        @@configurations ||= read_configurations
+      end
+
+    end
+  end
+end