klarna-xmlrpc 0.2.0

data/lib/klarna/api/methods/reservation.rb

@@ -0,0 +1,188 @@
+# encoding: utf-8
+
+module Klarna
+  module API
+    module Methods
+      module Reservation
+
+        # Reserve a purchase amount for a specific customer. The reservation is valid, by default, for 7 days.
+        # Pass cellphone no. instead of Pno for SMS payments.
+        #
+        def reserve_amount(params)
+          
+          xmlrpc_params = [
+            ::Klarna::API::PROTOCOL_VERSION,
+            ::XMLRPC::Client::USER_AGENT,
+            params[:pno],
+            params[:gender] || 0,
+            params[:amount],
+            params[:reference] || '',
+            params[:reference_code] || '',
+            params[:order_id],
+            params[:order_id],
+            params[:delivery_address],
+            params[:billing_address],
+            params[:client_ip] || '0.0.0.0',
+            params[:flags] || 0,
+            params[:currency],
+            params[:country],
+            params[:language],
+            self.store_id,
+            self.digest(params[:pno], params[:amount]),
+            params[:pno_encoding],
+            (params[:pclass] || ::Klarna::API::DEFAULTS[:PCLASS]),
+            params[:goods_list],
+            params[:comment] || '',
+            params[:shipmentinfo] || { delay_adjust: 1 },
+            params[:travelinfo] || [],
+            params[:income_expense] || [::Klarna::API::DEFAULTS[:YSALARY]],
+            params[:bankinfo] || [],
+            params[:session_id] || [],
+            params[:extra_info] || []
+          ]
+          
+          self.call(:reserve_amount, *xmlrpc_params).tap do |result|
+            result = result.first
+          end
+        end
+
+        def check_order_status(id)
+          xmlrpc_params = [
+            ::Klarna::API::PROTOCOL_VERSION,
+            ::XMLRPC::Client::USER_AGENT,
+            self.store_id.to_i,
+            self.digest(id.to_s),
+            id.to_s,
+            0
+          ]
+          self.call(:check_order_status, *xmlrpc_params)
+        end
+        # Activate purchases which have been previously reserved with the reserve_amount function.
+        #
+        def activate_reservation(params)
+                                   
+          xmlrpc_params = [
+            ::Klarna::API::PROTOCOL_VERSION,
+            ::XMLRPC::Client::USER_AGENT,
+            params[:reservation_id],
+            params[:ocr] || '',
+            params[:pno],
+            params[:gender] || 0,
+            params[:reference] || '',
+            params[:reference_code] || '',
+            params[:order_id_1],
+            params[:order_id_2],
+            params[:delivery_address],
+            params[:billing_address],
+            params[:client_ip] || '0.0.0.0',
+            params[:flags] || 0,
+            params[:currency],
+            params[:country],
+            params[:language],
+            self.store_id,
+            self.digest(params[:pno], params[:goods_list].map{ |goods| goods[:goods][:artno]+':'+goods[:qty].to_s } ),
+            params[:pno_encoding],
+            (params[:pclass] || ::Klarna::API::DEFAULTS[:PCLASS]),
+            params[:goods_list],
+            params[:comment] || '',
+            params[:shipmentinfo] || { delay_adjust: 1 },
+            params[:travelinfo] || [],
+            params[:income_expense] || [::Klarna::API::DEFAULTS[:YSALARY]],
+            params[:session_id] || [],
+            params[:extra_info] || []
+          ]
+          
+          xmlrpc_params = [xmlrpc_params] # Klarna needs all values to be in first param for activate_reservation only
+          
+          self.call(:activate_reservation, *xmlrpc_params)
+        end
+
+        # Cancel a reservation.
+        #
+        def cancel_reservation(params)
+          xmlrpc_params = [
+            ::Klarna::API::PROTOCOL_VERSION,
+            ::XMLRPC::Client::USER_AGENT,
+            params[:reservation_id],
+            self.store_id,
+            self.digest(params[:reservation_id])
+          ]
+          self.call(:cancel_reservation, *xmlrpc_params)
+        end
+
+        # Split a reservation due to for example outstanding articles.
+        #
+        def split_reservation(params)
+          
+          xmlrpc_params = [
+            ::Klarna::API::PROTOCOL_VERSION,
+            ::XMLRPC::Client::USER_AGENT,
+            params[:reservation_id],
+            params[:split_amount],
+            params[:order_id_1],
+            params[:order_id_2],
+            params[:flags].to_i || 0,
+            self.store_id,
+            self.digest(params[:reservation_id], params[:split_amount])
+          ]
+          self.call(:split_reservation, *xmlrpc_params).tap do |result|
+            result = result.first
+          end
+        end
+
+        # Change a reservation.
+        #
+        def change_reservation(params)
+          
+          xmlrpc_params = [
+            ::Klarna::API::PROTOCOL_VERSION,
+            ::XMLRPC::Client::USER_AGENT,
+            params[:reservation_id],
+            params[:new_amount],
+            self.store_id,
+            self.digest(params[:reservation_id], params[:new_amount])
+          ]
+          self.call(:change_reservation, *xmlrpc_params).tap do |result|
+            result = result.first
+          end
+        end
+
+        # Reserves one or more OCR numbers for your store.
+        #
+        def reserve_ocr_numbers(number_of_ocrs)
+          # params = [
+          #   ::Klarna::API::PROTOCOL_VERSION,
+          #   ::XMLRPC::Client::USER_AGENT,
+          #   number_of_ocrs,
+          #   self.store_id,
+          #   self.digest(number_of_ocrs)
+          # ]
+          # self.call(:reserve_ocr_nums, *params)
+          raise NotImplementedError
+        end
+
+        # Create addresses for arguments such as the +activate_reservation+ function.
+        #
+        def make_reservation_address(params)
+          {                              
+            :email            => (params[:email] || ''),
+            :telno            => (params[:telno] || ''),
+            :cellno           => (params[:cellno] || ''),
+            :fname            => (params[:fname] || ''),
+            :lname            => (params[:lname] || ''),
+            :company          => (params[:company] || ''),
+            :careof           => (params[:careof] || ''),
+            :street           => (params[:street] || ''),
+            :zip              => (params[:zip] || ''),
+            :city             => (params[:city] || ''),
+            :country          => (::Klarna::API.id_for(:country, params[:country]) || ''),
+            :house_number     => (params[:house_number] || ''),
+            :house_extension  => (params[:house_extension] || '')
+          }.with_indifferent_access
+        end
+        alias :mk_reservation_address :make_reservation_address
+
+      end
+    end
+  end
+end

data/lib/klarna/api/methods/standard.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+module Klarna
+  module API
+    module Methods
+      module Standard
+
+        # Retrieve a customer’s address(es). Using this, the customer is not required to enter
+        # any information – only confirm the one presented to him/her.
+        # Can also be used for companies: If the customer enters a company number,
+        # it will return all the addresses where the company is registered at.
+        #
+        # == Note:
+        #
+        #   ONLY allowed to be used for Swedish persons with the following conditions:
+        #
+        #     * It can be only used if invoice or part payment is the default payment method
+        #     * It has to disappear if the customer chooses another payment method
+        #     * The button is not allowed to be called get address ("hämta adress"), but continue ("fortsätt")
+        #       or it can be picked up automatically when all the numbers have been typed.
+        #
+        #   In the other Nordic countries you will have to have input fields for name, last name, street name,
+        #   zip code and city so that the customer can enter this information by himself.
+        #
+        def get_addresses(pno, pno_encoding, address_type = :GIVEN)
+          pno = pno.to_s.gsub(/[\W]/, '')
+          pno_encoding = ::Klarna::API.id_for(:pno_format, pno_encoding)
+          address_type = ::Klarna::API.id_for(:address_format, address_type)
+          params = [
+            ::Klarna::API::PROTOCOL_VERSION,
+            ::XMLRPC::Client::USER_AGENT,
+            pno,
+            self.store_id,
+            self.digest(pno),
+            pno_encoding,
+            address_type,
+            self.client_ip
+          ]
+          self.call(:get_addresses, *params).tap do |result|
+            result = result.first
+            country_id = ::Klarna::API.id_for(:country, result[5])
+            result[5] = ::Klarna::API::COUNTRIES.key(country_id)
+          end
+        end
+
+        # Same as +get_addresses+ but returns only first address.
+        #
+        def get_address(*args)
+          self.get_addresses(*args).first
+        end
+
+        # Create addresses (i.e. the +address+ argument to the +add_transaction+ method).
+        #
+        def make_address(co_address, street_address, zip, city, country, phone, cell_phone, email,
+                          house_number = nil, house_extension = nil)
+          country = ::Klarna::API.id_for(:country, country)
+          phone = phone.to_s.gsub(/[\W\s\t]/, '')
+          cell_phone = cell_phone.to_s.gsub(/[\W\s\t]/, '')
+          {
+            :careof  => co_address,
+            :street  => street_address,
+            :postno  => zip,
+            :city    => city,
+            :country => country,
+            :telno   => phone,
+            :cellno  => cell_phone,
+            :email   => email
+          }.with_indifferent_access
+        end
+        alias :mk_address :make_address
+
+        # Create an inventory (i.e. the +goods_list+ argument) to the +add_transaction+ function.
+        #
+        # == Flags:
+        #
+        # Argument +flags+ can be used to set the precision of the article, to indicate a shipment
+        # or a fee or sending the price with VAT.
+        #
+        # By using either +PRINT_1000+, +PRINT_100+, or +PRINT_10+, the +flags+
+        # function can be used to set article quantity (+quantity+). Unit is either +1/10+, +1/100+
+        # or +1/1000+. This is useful for goods measured in meters or kilograms, rather than number of items.
+        #
+        # By using the +IS_SHIPMENT+ or +IS_HANDLING+ flags a shipping or handling fee can
+        # be applied. The fees are sent excluding VAT with the arguments +shipping_fee+ or +handling_fee+.
+        #
+        # By using the +INC_VAT+ flag, you can send the price including VAT.
+        #
+        # == Note:
+        #
+        #   If you are implementing sales with Euros, use the function mk_goods_flags instead
+        #   since using this method can result in round off problems. With +mk_goods_flags+ you
+        #   are able to send the price with VAT.
+        #
+        def make_goods(quantity, article_no, title, price, vat, discount = nil, flags = nil)
+          flags = ::Klarna::API.parse_flags(:GOODS, flags)
+          goods = {
+            :goods => {
+              :artno     => article_no,
+              :title     => title,
+              :price     => price.to_i,
+              :vat       => vat.to_f.round(2),
+              :discount  => discount.to_f.round(2),
+            },
+            :qty => quantity.to_i
+          }
+          goods[:goods].merge!(:flags => flags.to_i) # if flags.present?
+          goods.with_indifferent_access
+        end
+        alias :mk_goods :make_goods
+        alias :mk_goods_flags :make_goods
+
+        # Check if a user has an account.
+        #
+        def has_account?(pno, pno_encoding)
+          params = [
+            self.store_id,
+            self.digest(pno),
+            pno_encoding
+          ]
+          self.call(:has_account, *params)
+        end
+
+      end
+    end
+  end
+end

data/lib/klarna/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Klarna
+  VERSION = '0.2.0'
+end

data/test/fixtures/api/companies.yml

@@ -0,0 +1,97 @@
+# Here are Klarnas test COMPANIES.
+# All approved persons have unlimited credit and the system will never accept purchases from the not approved ones.
+#
+# Purchases done with the test persons will be displayed in Klarna Online as regular invoices, although they will
+# unvisible unless you have "Yes" selected next to "Display test invoices" when searching for invoices.
+#
+# We will not pay for the invoices created with the test persons nor companies and we will not collect any fees as well.
+
+companies:
+  se:
+    approved:
+      cno: "6020310139"
+      name: "Kalle Anka AB"
+      street_address: "Storgatan 1"
+      postal_code: "12345"
+      city: "Ankeborg"
+      street_address_2: "Lillgatan 99"
+      postal_code_2: "77777"
+      city_2: "Ankeborg"
+      country: "SE"
+      cell_phone: "076 526 00 00"
+      currency: "SEK"
+      language: "SV"
+    unapproved:
+      cno: "6720217931"
+      name: "Björnligan AB"
+      street_address: "Fulgatan 1"
+      postal_code: "12345"
+      city: "Ankeborg"
+      street_address_2: "Bakgatan 99"
+      postal_code_2: "77777"
+      city_2: "Ankeborg"
+      country: "SE"
+      cell_phone: "076 526 00 00"
+      currency: "SEK"
+      language: "SV"
+
+  no:
+    # N/A
+
+  dk:
+    approved:
+      pno: "27968880"
+      first_name: ""
+      last_name: "Onbase ApS"
+      street_address: "Centrumgaden 37"
+      postal_code: "2750"
+      city: "Ballerup"
+      country: "DK"
+      cell_phone: "20 123 456"
+      currency: "DKK"
+      language: "DA"
+    unapproved:
+      pno: "99999993"
+      first_name: ""
+      last_name: "Larsen & Olsen Contracters ApS"
+      street_address: "Glarmestervej 2"
+      postal_code: "8600"
+      city: "Silkeborg"
+      street_address: "Kristianiagade 9"
+      postal_code: "2100"
+      city: "København Ø"
+      country: "DK"
+      cell_phone: "20 123 456"
+      currency: "DKK"
+      language: "DA"
+
+  fi:
+    approved:
+      pno: "10891871"
+      first_name: ""
+      last_name: "Porin Mies-Laulu r.y."
+      street_address: "Vapaudenkatu 10"
+      postal_code: "28100"
+      city: "Pori"
+      country: "FI"
+      cell_phone: "040 123 45 67"
+      currency: "EUR"
+      language: "FI"
+
+    unapproved:
+      pno: "07527622"
+      first_name: ""
+      last_name: "Mankalan Perhekodit Oy"
+      street_address: "Porrassalmenkatu 19 B"
+      postal_code: "50100"
+      city: "Parikkala"
+      country: "FI"
+      cell_phone: "040 123 45 67"
+      currency: "EUR"
+      language: "FI"
+
+  de:
+    # N/A
+
+  nl:
+    # N/A

data/test/fixtures/api/pclasses.yml

@@ -0,0 +1,37 @@
+# Pclass id number, Description, Amount of months for part payment, Start fee, Invoice fee, Interest rate, Minimum purchase amount for pclass
+
+pclasses:
+  sek:
+    390:
+      pclass_id: 390
+      description: "Konto"
+      months: 24
+      start_fee: 0
+      invoice_fee: 2900
+      interest_rate: 1950
+      minimum_purchase_amount: 100
+    121:
+      pclass_id: 121
+      description: "6 m\303\245n"
+      months: 6
+      start_fee: 19500
+      invoice_fee: 2900
+      interest_rate: 0
+      minimum_purchase_amount: 100000
+    120:
+      pclass_id: 120
+      description: "3 m\303\245n"
+      months: 3
+      start_fee: 9500
+      invoice_fee: 2900
+      interest_rate: 0
+      minimum_purchase_amount: 100000
+
+  nok:
+    # Not available (for some reason)
+
+  dkk:
+    # Not available (for some reason)
+
+  eur:
+    # Not available (for some reason)