klarna 0.1.3

data/lib/klarna.rb

@@ -0,0 +1,175 @@
+# encoding: utf-8
+# require 'rubygems'
+# require 'bundler'
+# Bundler.require
+require 'i18n'
+require 'active_support/all'
+
+module Klarna
+
+  autoload :API,      'klarna/api'
+  autoload :VERSION,  'klarna/version'
+
+  module API
+    autoload :Client,     'klarna/api/client'
+    autoload :Constants,  'klarna/api/constants'
+    autoload :Errors,     'klarna/api/errors'
+
+    module Methods
+      autoload :Standard,         'klarna/api/methods/standard'
+      autoload :Invoicing,        'klarna/api/methods/invoicing'
+      autoload :Reservation,      'klarna/api/methods/reservation'
+      autoload :CostCalculations, 'klarna/api/methods/cost_calculations'
+    end
+  end
+
+  class KlarnaConfigError < ::StandardError
+  end
+
+  DEFAULT_STORE_CONFIG_FILE = File.join(ENV['HOME'], '.klarna.yml') unless defined?(::Klarna::DEFAULT_STORE_CONFIG_FILE)
+  VALID_COUNTRIES = [:SE, :NO, :FI, :DK] unless defined?(::Klarna::VALID_COUNTRIES)
+  DEFAULT_COUNTRY = VALID_COUNTRIES.first unless defined?(::Klarna::DEFAULT_COUNTRY)
+  DEFAULT_MODE = :test unless defined?(::Klarna::DEFAULT_MODE)
+
+  # Specifies running mode: +:test+ (alla actions gets virtual) or +:production+ (live)
+  # Default: +:test+
+  mattr_accessor :mode
+  @@mode = :test
+
+  # Country used to ensure that params sent to Klarna service is correct.
+  # Default: +:SE+
+  mattr_accessor :country
+  @@country = ::Klarna::DEFAULT_COUNTRY
+
+  # Klarna e-store ID (a.k.a. "eid") used for Klarna API authentication.
+  # Default: +nil+
+  # NOTE: If +nil+, Klarna will look for credentials in file specified by +Devise.store_config_file+.
+  mattr_accessor :store_id
+  @@store_id = nil
+
+  # Klarna e-store shared secret token used for Klarna API authentication.
+  # Default: +nil+
+  # NOTE: If +nil+, Klarna will look for credentials in file specified by +Devise.credentials_file+.
+  mattr_accessor :store_secret
+  @@store_secret = nil
+
+  # Klarna e-store-specific pclasses (a.k.a. campaigns).
+  # Default: +nil+
+  #
+  # NOTE:
+  #   * Required for campaigns
+  #   * This should maybe be initialized from database to make more dynamic (e.g. admin inteface).
+  #
+  mattr_accessor :store_pclasses
+  @@store_pclasses = nil
+
+  # Path to a YAML file containing API credentials - used only if +store_id+ and +store_secret+ are not set.
+  # Default: +"~/.klarna.yml"+
+  mattr_accessor :store_config_file
+  @@store_config_file = ::Klarna::DEFAULT_STORE_CONFIG_FILE
+
+  # The logger to use in log mode.
+  # Default: +::Logger.new(::STDOUT)+
+  mattr_accessor :logger
+  @@logger = ::Logger.new(::STDOUT)
+
+  # Sets if activity should be logged or not - for high-level debugging.
+  # Default: +false+
+  mattr_accessor :logging
+  @@logging = false
+
+  # Sets if Net::HTTP activity should be logged or not - for low-level debugging.
+  # Default: +false+
+  mattr_accessor :http_logging
+  @@http_logging = false
+
+  class << self
+
+    # Configuration DSL helper method.
+    #
+    # == Usage/Example:
+    #
+    #   Klarna::Setup do |config|
+    #     config.country = :SE
+    #     # etc.
+    #   end
+    #
+    def setup
+      yield self
+      self.load_credentials_from_file unless self.store_id || self.store_secret
+    end
+    alias :configure :setup
+
+    # Reset to defaults - mostly usable in specs.
+    #
+    def reset!
+      self.mode = ::Klarna::DEFAULT_MODE
+      self.country = ::Klarna::DEFAULT_COUNTRY
+      self.store_id = nil
+      self.store_secret = nil
+      self.store_pclasses = nil
+      self.store_config_file = ::Klarna::DEFAULT_STORE_CONFIG_FILE
+      self.logger = ::Logger.new(::STDOUT)
+      self.logging = false
+      self.http_logging = false
+    end
+
+    # Logging helper for debugging purposes.
+    #
+    def log(message, level = :info)
+      return unless self.logging?
+      level = :info if level.blank?
+      self.logger ||= ::Logger.new(::STDOUT)
+      self.logger.send(level.to_sym, "[klarna:]  #{level.to_s.upcase}  #{message}")
+    end
+
+    # Logging helper for debugging "log return value"-cases.
+    #
+    def log_result(label, &block)
+      result = block.call
+      self.log label % result.inspect
+      result
+    end
+
+    # Optional: Try to load credentials from a system file.
+    #
+    def load_credentials_from_file(force = false)
+      begin
+        store_config = File.open(self.store_config_file) { |file| YAML.load(file).with_indifferent_access }
+        self.store_id = store_config[self.mode][:store_id] if force || self.store_id.nil?
+        self.store_secret = store_config[self.mode][:store_secret] if force || self.store_secret.nil?
+        self.store_pclasses = store_config[self.mode][:store_pclasses] if force || self.store_pclasses.nil?
+      rescue
+        raise KlarnaConfigError, "Could not load store details from: #{self.store_config_file.inspect}"
+      end
+    end
+
+    def store_id=(value)
+      @@store_id = value ? value.to_i : value
+    end
+
+    def store_secret=(value)
+      @@store_secret = value ? value.to_s.strip : value
+    end
+
+    def country=(value)
+      @@country = value.to_s.upcase.to_sym rescue ::Klarna::DEFAULT_COUNTRY
+    end
+
+    def mode=(value)
+      @@mode = value.to_s.downcase.to_sym rescue ::Klarna::DEFAULT_MODE
+    end
+
+    def valid_countries
+      ::Klarna::VALID_COUNTRIES
+    end
+
+    def default_country
+      ::Klarna::DEFAULT_COUNTRY
+    end
+
+    alias :logging? :logging
+    alias :http_logging? :http_logging
+  end
+
+end

data/lib/klarna/api.rb

@@ -0,0 +1,170 @@
+# encoding: utf-8
+require 'iconv'
+require 'digest/md5'
+require 'digest/sha2'
+require 'xmlrpc/base64'
+
+require 'klarna/api/constants'
+require 'klarna/api/errors'
+
+module Klarna
+  module API
+
+    # == Reference:
+    #
+    #   * http://integration.klarna.com/api-functions
+    #
+    # == Note:
+    #
+    #   All input data strings should be coded in accordance with ISO-8859-1.
+    #
+    #   This implementation is not 1-to-1 implementation of the Klarna API functions.
+    #   The methods are refactored/cleaned up to meet Ruby code standards; avoid
+    #   unessecary code-repetition and spaghetti-code like the other implementations.
+    #   Same functionality can be achieved though; see the RDocs.
+    #
+    #   To obtain pclasses - or download the pclasses file:
+    #
+    #     1. Log in to Kreditor Online.
+    #     2. Click on "Display store"
+    #     3. Click on "Click here to view campaigns".
+    #
+    #   ...or use the API-method +::Klarna::API.get_pclasses+.
+    #
+
+    include ::Klarna::API::Constants
+    include ::Klarna::API::Errors
+
+    @@client = nil
+
+    class << self
+
+      # Re-use or (re-)initialize a new Klarna XML-RPC API client.
+      #
+      def client(force_new = false)
+        begin
+          if force_new || @@client.nil?
+            @@client = ::Klarna::API::Client.new
+          end
+        rescue => e
+          ::Klarna.log e, :error
+        end
+        @@client
+      end
+
+      def key_for(kind, value)
+        begin
+          kind = validated_kind(kind)
+        rescue => e
+          raise e
+        end
+
+        begin
+          is_correct_format = !(value.to_s =~ /^\d+$/)
+          constants = ::Klarna::API.const_get(kind)
+          key = is_correct_format ? value : constants.invert[value.to_i] # BUG: Should lookup the value's key.
+        rescue
+          raise ::Klarna::API::KlarnaArgumentError, "Invalid '#{kind}': #{value.inspect}"
+        end
+
+        key ? key.to_sym : nil
+      end
+
+      def id_for(kind, value)
+        begin
+          kind = validated_kind(kind)
+        rescue => e
+          raise e
+        end
+
+        begin
+          is_correct_format = (value.to_s =~ /^\d+$/)
+          constants = ::Klarna::API.const_get(kind)
+          id = is_correct_format ? value.to_i : constants[value.to_s.upcase.to_sym]
+        rescue
+          raise ::Klarna::API::KlarnaArgumentError, "Invalid '#{kind}': #{value.inspect}"
+        end
+
+        id ? id.to_i : nil
+      end
+
+      # Validate if specified +kind+ is a valid constant.
+      #
+      def validated_kind(kind)
+        valid_kinds = [:country, :currency, :language, :pno_format, :address_format, :shipment_type, :pclass, :mobile, :invoice, :goods, :monthly_cost]
+        valid_kinds.collect! do |valid_kind|
+          [valid_kind.to_s.singularize.to_sym, valid_kind.to_s.pluralize.to_sym]
+        end
+        valid_kinds.flatten!
+        kind = kind.to_s.pluralize.to_sym
+
+        unless kind.is_a?(String) || kind.is_a?(Symbol)
+          raise ::Klarna::API::KlarnaArgumentError, "Not a valid kind: #{kind.inspect}. Expects a symbol or a string: #{valid_kinds.join(', ')}"
+        end
+
+        unless valid_kinds.include?(kind.to_s.downcase.to_sym)
+          raise ::Klarna::API::KlarnaArgumentError, "Not a valid kind: #{kind.inspect}. Valid kinds: #{valid_kinds.join(', ')}"
+        end
+
+        kind.to_s.upcase.to_sym
+      end
+
+      # Parse, validate, and cast a method argument before RPC-call.
+      #
+      def validate_arg(value, cast_to, format_expression, strip_expression = nil, &block)
+        raise ::Klarna::API::KlarnaArgumentError,
+          "Argument cast_to should be Symbol, but was #{cast_to.class.name}." unless cast_to.is_a?(Symbol)
+        raise ::Klarna::API::KlarnaArgumentError,
+          "Argument regexp should be Regexp, but was #{format_expression.class.name}." unless format_expression.is_a?(Regexp)
+        raise ::Klarna::API::KlarnaArgumentError,
+          "Argument strip should be Regexp, but was #{strip_expression.class.name}." unless strip_expression.is_a?(Regexp)
+
+        value = value.to_s.gsub(strip_expression, '') if strip_expression
+
+        unless value.to_s =~ format_expression
+          raise ::Klarna::API::KlarnaArgumentError, "Invalid argument: #{value.inspect}. Expected format: #{format_expression.inspect}"
+        end
+
+        # Pass value to block - for type casting, etc. - if given.
+        value = block.call(value) if block_given?
+
+        value.tap do |v|
+          case cast_to
+          when :string then v.to_s
+          when :integer then v.to_i
+          when :decimal then v.to_f # number of decimals?
+          when :date then v # TODO
+          else
+            raise ::Klarna::API::KlarnaArgumentError, "Invalid cast_to value: #{cast_to.inspect}. "
+          end
+        end
+      end
+
+      def parse_flags(constant_name, flags)
+        if flags.is_a?(Hash)
+          flags = flags.sum { |k,v|
+            ::Klarna::API.const_get(constant_name.to_s.upcase.to_sym)[k.to_s.upcase.to_sym]
+          }
+        end
+        flags.to_i
+      end
+
+      def digest(*args)
+        string = args.join(':')
+        iso_value = self.encode(string) 
+        
+        
+        hex_md5_digest = [*::Digest::MD5.hexdigest(iso_value)].pack('H*')
+        base64_digest = ::XMLRPC::Base64.encode(hex_md5_digest).strip
+        hex_sha512_digest = [*Digest::SHA512.hexdigest(iso_value)].pack('H*')
+        base64_digest = ::XMLRPC::Base64.encode(hex_sha512_digest).strip
+      end
+
+      def encode(string, from_encoding = 'utf-8')
+        ::Iconv.conv(::Klarna::API::PROTOCOL_ENCODING, from_encoding, string)
+      end
+
+    end
+
+  end
+end

data/lib/klarna/api/client.rb

@@ -0,0 +1,128 @@
+# encoding: utf-8
+require 'xmlrpc/client'
+
+require 'klarna/api/methods'
+
+module Klarna
+  module API
+    class Client < ::XMLRPC::Client
+
+      include ::Klarna::API::Methods
+
+      attr_accessor :store_id,
+                    :store_secret,
+                    :mode,
+                    :timeout,
+                    :last_request_headers,
+                    :last_request_params,
+                    :last_response,
+                    :client_ip,
+                    :protocol,
+                    :host,
+                    :port
+
+      def initialize(*args)
+        self.store_id = args.shift || ::Klarna.store_id
+        self.store_secret = args.shift || ::Klarna.store_secret
+
+        if self.store_id.blank? || self.store_secret.blank?
+          raise ::Klarna::API::KlarnaCredentialsError, "Both STORE_ID or STORE_SECRET must be set."
+        end
+
+        options = args.extract_options!
+        self.client_ip = options[:client_ip].presence || '127.0.0.1'
+        self.mode = options.key?(:mode) ? options[:mode] : ::Klarna.mode
+        self.timeout = options.key?(:timeout) ? options[:timeout] : 10 # seconds
+
+        unless ::Klarna::API::END_POINT.keys.include?(self.mode)
+          raise "No such mode: #{self.mode.inspect}. " <<
+          "Valid modes: #{::Klarna::API::END_POINT.keys.collect(&:inspect).join(', ')}"
+        end
+
+        begin
+          ::Klarna.log "Endpoint URI: %s" % self.endpoint_uri.inspect
+
+          super(self.host, '/', self.port, nil, nil, nil, nil, self.use_ssl?, self.timeout)
+
+          self.http_header_extra ||= {}
+          self.http_header_extra.merge!(self.content_type_headers)
+
+          self.instance_variable_get(:@http).set_debug_output(::Klarna.logger) if ::Klarna.http_logging?
+        rescue ::XMLRPC::FaultException => e
+          raise ::Klarna::API::KlarnaServiceError.new(e.faultCode, e.faultString)
+        end
+      end
+
+      def call(service_method, *args)
+        args.collect! { |arg| arg.is_a?(String) ? ::Iconv.conv('utf-8', ::Klarna::API::PROTOCOL_ENCODING, arg) : arg }
+        ::Klarna.log "Method: #{service_method}"
+        ::Klarna.log "Params: %s" % self.add_meta_params(*args).inspect
+
+        self.last_request_headers = http_header_extra
+
+        begin
+          ::Klarna.log_result("Result: %s") do
+            params = self.add_meta_params(*args)
+            self.last_request_params = params
+            self.last_response = super(service_method, *params)
+          end
+        rescue ::XMLRPC::FaultException => e
+          raise ::Klarna::API::KlarnaServiceError.new(e.faultCode, e.faultString)
+        rescue ::Timeout::Error => e
+          raise ::Klarna::API::KlarnaServiceError.new(-1, e.message)
+        end
+      end
+
+      def ssl?
+        self.protocol == 'https'
+      end
+      alias :use_ssl? :ssl?
+
+      def protocol
+        @protocol = ::Klarna::API::END_POINT[self.mode][:protocol]
+      end
+
+      def host
+        @host = ::Klarna::API::END_POINT[self.mode][:host]
+      end
+
+      def port
+        @port = ::Klarna::API::END_POINT[self.mode][:port]
+      end
+
+      def endpoint_uri
+        @endpoint_uri = "#{self.protocol}://#{self.host}:#{self.port}"
+      end
+
+      protected
+
+        # Request content-type headers.
+        #
+        def content_type_headers
+          {
+            :'Accept-Encoding' => 'deflate,gzclient_ip',
+            :'Content-Type' => "text/xml;charset=#{::Klarna::API::PROTOCOL_ENCODING}",
+            :'Accept-Charset' => 'iso-8859-1', # REVISIT: 'UTF-8,ISO-8859-1,US-ASCII',
+            :'Connection' => 'close',
+            :'User-Agent' => 'ruby/xmlrpc' # Note: Default "User-Agent" gives 400-error.
+          }.with_indifferent_access
+        end
+
+        # Ensure that the required client info params get sent with each Klarna API request.
+        # Without these the Klarna API will get a service error response.
+        #
+        def add_meta_params(*args)
+          args.unshift *[::Klarna::API::PROTOCOL_VERSION, ::XMLRPC::Client::USER_AGENT]
+          args
+        end
+
+        # Pass additional required digest args to the raw digest method.
+        #
+        def digest(*args)
+          options = args.extract_options!
+          ::Klarna::API.digest(*[(self.store_id unless options[:store_id] == false), args, self.store_secret].compact.flatten)
+        end
+
+    end
+  end
+end