payson_api 0.1.0 → 0.2.0

data/Guardfile

@@ -5,5 +5,5 @@ guard 'test' do
   watch(%r{^test/unit/.+_test\.rb$}) { "test" }
   watch(%r{^test/fixtures/(.+)\.yml$}) { "test" }
   watch(%r{^test/integration/.+_test\.rb$}) { "test" }
-  watch('test/.+.rb')   { "test" }
+  watch('test/.+\.rb')   { "test" }
 end

data/README.rdoc

@@ -38,7 +38,10 @@ You can configure the following default values by overriding these values using
   receivers = []
   receivers << PaysonAPI::Receiver.new(
     email = 'me@mydomain.com',
-    amount = 100
+    amount = 100,
+    first_name = 'Me',
+    last_name = 'Just me',
+    primary = true
   )
 
   sender = PaysonAPI::Sender.new(
@@ -116,8 +119,8 @@ This example assumes the use of the Rails web framework.
       ipn_response = PaysonAPI::Response::IPN.new(request_body)
 
       # Do business stuff, e.g. update the corresponding order:
-      #   order = Order.find_by_payson_token(ipn.token)
-      #   order.payson_status = ipn.status
+      #   order = Order.find_by_payson_token(ipn_response.token)
+      #   order.payson_status = ipn_response.status
       #   order.save!
 
       # Create a new IPN request object containing the raw response from above
@@ -134,10 +137,7 @@ This example assumes the use of the Rails web framework.
 
 == Todo
 
-Implement the following requests:
-
-* Validate - Validate an IPN (Instant Payment Notification).
-
+Nothing at the moment. Will focus on writing more thourough test cases and look over the code all in all.
 
 
 == Build Status {<img src="https://secure.travis-ci.org/stoffus/payson_api.png"/>}[http://travis-ci.org/stoffus/payson_api]

data/lib/payson_api/config.rb

@@ -11,8 +11,20 @@ module PaysonAPI
   PAYSON_API_PAYMENT_UPDATE_ACTION = "PaymentUpdate"
   PAYSON_API_PAYMENT_VALIDATE_ACTION = "Validate"
 
-  LOCALES = %w[SV FI EN]
+  LOCALES = %w[SV EN FI]
   CURRENCIES = %w[SEK EUR]
+  FEES_PAYERS = %w[EACHRECEIVER SENDER PRIMARYRECEIVER SECONDARYONLY]
+  FUNDING_CONSTRAINTS = %w[CREDITCARD BANK INVOICE]
+  GUARANTEE_OFFERINGS = %w[OPTIONAL REQUIRED NO]
+  PAYMENT_STATUSES = %w[CREATED PENDING PROCESSING COMPLETED CREDITED
+    INCOMPLETE ERROR EXPIRED REVERSALERROR ABORTED]
+  PAYMENT_TYPES = %w[TRANSFER GUARANTEE INVOICE]
+  GUARANTEE_STATUSES = %w[WAITINGFORSEND WAITINGFORACCEPTANCE WAITINGFORRETURN
+    WAITINGFORRETURNACCEPTANCE RETURNNOTACCEPTED NOTRECEIVED RETURNNOTRECEIVED
+    MONEYRETURNEDTOSENDER RETURNACCEPTED
+  ]
+  INVOICE_STATUSES = %w[PENDING ORDERCREATED CANCELED SHIPPED DONE CREDITED]
+  PAYMENT_ACTIONS = %w[CANCELORDER SHIPORDER CREDITORDER REFUND]
 
   def configure(&block)
     yield @config ||= Configuration.new

data/lib/payson_api/envelope.rb

@@ -13,7 +13,7 @@ class Envelope
 
   def self.parse(data)
     ack = data[FORMAT_STRING % 'ack']
-    timestamp = DateTime.parse(CGI.unescape(data[FORMAT_STRING % 'timestamp']))
+    timestamp = DateTime.parse(CGI.unescape(data[FORMAT_STRING % 'timestamp'].to_s))
     correlation_id = data[FORMAT_STRING % 'correlationId']
     self.new(ack, timestamp, correlation_id)
   end

data/lib/payson_api/funding.rb

@@ -4,6 +4,9 @@ class Funding
   attr_accessor :constraint
 
   def initialize(constraint)
+    if !FUNDING_CONSTRAINTS.include?(constraint)
+      raise "Unknown funding constraint: #{constraint}"
+    end
     @constraint = constraint
   end
 
@@ -11,7 +14,7 @@ class Funding
     {}.tap do |hash|
       fundings.each_with_index do |funding, index|
         hash.merge!({
-          FORMAT_STRING % [index, 'email'] => funding.constraint
+          FORMAT_STRING % [index, 'constraint'] => funding.constraint
         })
       end
     end

data/lib/payson_api/order_item.rb

@@ -31,7 +31,7 @@ class OrderItem
     [].tap do |order_items|
       i = 0
       while data[FORMAT_STRING % [i, 'description']]
-        description = CGI.unescape(data[FORMAT_STRING % [i, 'description']])
+        description = CGI.unescape(data[FORMAT_STRING % [i, 'description']].to_s)
         unit_price = data[FORMAT_STRING % [i, 'unitPrice']]
         quantity = data[FORMAT_STRING % [i, 'quantity']]
         tax = data[FORMAT_STRING % [i, 'taxPercentage']]

data/lib/payson_api/receiver.rb

@@ -3,11 +3,14 @@ require 'cgi'
 module PaysonAPI
 class Receiver
   FORMAT_STRING = "receiverList.receiver(%d).%s"
-  attr_accessor :email, :amount
+  attr_accessor :email, :amount, :first_name, :last_name, :primary
 
-  def initialize(email, amount)
+  def initialize(email, amount, first_name, last_name, primary = true)
     @email = email
     @amount = amount
+    @first_name = first_name
+    @last_name = last_name
+    @primary = primary
   end
 
   def self.to_hash(receivers)
@@ -16,7 +19,10 @@ class Receiver
         raise "Invalid receiver" unless receiver.instance_of?(self)
         hash.merge!({
           FORMAT_STRING % [index, 'email'] => receiver.email,
-          FORMAT_STRING % [index, 'amount'] => receiver.amount
+          FORMAT_STRING % [index, 'amount'] => receiver.amount,
+          FORMAT_STRING % [index, 'firstName'] => receiver.first_name,
+          FORMAT_STRING % [index, 'lastName'] => receiver.last_name,
+          FORMAT_STRING % [index, 'primary'] => receiver.primary
         })
       end
     end
@@ -26,9 +32,12 @@ class Receiver
     [].tap do |receivers|
       i = 0
       while data[FORMAT_STRING % [i, 'email']]
-        email = CGI.unescape(data[FORMAT_STRING % [i, 'email']])
+        email = CGI.unescape(data[FORMAT_STRING % [i, 'email']].to_s)
         amount = data[FORMAT_STRING % [i, 'amount']]
-        receivers << self.new(email, amount)
+        first_name = CGI.unescape(data[FORMAT_STRING % [i, 'firstName']].to_s)
+        last_name = CGI.unescape(data[FORMAT_STRING % [i, 'lastName']].to_s)
+        primary = data[FORMAT_STRING % [i, 'primary']]
+        receivers << self.new(email, amount, first_name, last_name, primary)
         i += 1
       end
     end

data/lib/payson_api/request/payment.rb

@@ -2,7 +2,8 @@ module PaysonAPI
 module Request
 class Payment
   attr_accessor :return_url, :cancel_url, :ipn_url, :memo, :sender, :receivers,
-    :locale, :currency, :tracking_id, :invoice_fee, :order_items
+    :locale, :currency, :tracking_id, :invoice_fee, :order_items, :fundings,
+    :fees_payer, :guarantee_offered
 
   def initialize(return_url, cancel_url, ipn_url, memo, sender, receivers)
     @return_url = return_url
@@ -15,21 +16,51 @@ class Payment
 
   def to_hash
     {}.tap do |hash|
+      # Append mandatory params
       hash['returnUrl'] = @return_url
       hash['cancelUrl'] = @cancel_url
-      if @ipn_url && !@ipn_url.empty?
-        hash['ipnNotificationUrl'] = @ipn_url
-      end
       hash['memo'] = @memo
-      hash['localeCode'] = LOCALES[@locale] if @locale
-      hash['currencyCode'] = CURRENCIES[@currency] if @currency
-      hash.merge!(Receiver.to_hash(@receivers))
       hash.merge!(@sender.to_hash)
+      hash.merge!(Receiver.to_hash(@receivers))
+
+      # Append optional params
+      append_locale(hash, @locale) if @locale
+      append_currency(hash, @currency) if @currency
+      append_fees_payer(hash, @fees_payer) if @fees_payer
+      append_guarantee(hash, @guarantee_offered) if @guarantee_offered
       hash.merge!(OrderItem.to_hash(@order_items)) if @order_items
+      hash.merge!(Funding.to_hash(@fundings)) if @fundings
+      hash['ipnNotificationUrl'] = @ipn_url if @ipn_url
       hash['invoiceFee'] = @invoice_fee if @invoice_fee
       hash['trackingId'] = @tracking_id if @tracking_id
     end
   end
+
+private
+
+  def append_locale(hash, locale)
+    raise "Unknown locale: #{locale}" if !LOCALES.include?(locale)
+    hash['localeCode'] = locale
+  end
+
+  def append_currency(hash, currency)
+    raise "Unknown currency: #{currency}" if !CURRENCIES.include?(currency)
+    hash['currencyCode'] = currency
+  end
+
+  def append_guarantee(hash, guarantee_offered)
+    if !GUARANTEE_OFFERINGS.include?(guarantee_offered)
+      raise "Unknown guarantee offering: #{guarantee_offered}"
+    end
+    hash['guaranteeOffered'] = guarantee_offered
+  end
+
+  def append_fees_payer(hash, fees_payer)
+    if !FEES_PAYERS.include?(fees_payer)
+      raise "Unknown fees payer: #{fees_payer}"
+    end
+    hash['feesPayer'] = fees_payer if fees_payer
+  end
 end
 end
 end

data/lib/payson_api/request/payment_update.rb

@@ -5,6 +5,9 @@ class PaymentUpdate
 
   def initialize(token, action)
     @token = token
+    if !PAYMENT_ACTIONS.include?(action)
+      raise "Unknown payment update action: #{action}"
+    end
     @action = action
   end
 

data/lib/payson_api/response/payment_details.rb

@@ -27,7 +27,9 @@ class PaymentDetails
       @guarantee_deadline_at = Time.at(data['guaranteeDeadlineTimestamp'])
     when 'INVOICE'
       @invoice_status = data['invoiceStatus']
-      @shipping_address = ShippingAddress.parse(data)
+      if %w[ORDERCREATED SHIPPED DONE CREDITED].include?(@invoice_status)
+        @shipping_address = ShippingAddress.parse(data)
+      end
     end
   end
 

data/lib/payson_api/sender.rb

@@ -21,8 +21,8 @@ class Sender
 
   def self.parse(data)
     email = data[FORMAT_STRING % 'email']
-    first_name = CGI.unescape(data[FORMAT_STRING % 'FirstName'])
-    last_name = CGI.unescape(data[FORMAT_STRING % 'LastName'])
+    first_name = CGI.unescape(data[FORMAT_STRING % 'FirstName'].to_s)
+    last_name = CGI.unescape(data[FORMAT_STRING % 'LastName'].to_s)
     self.new(email, first_name, last_name)
   end
 end

data/lib/payson_api/shipping_address.rb

@@ -25,11 +25,11 @@ class ShippingAddress
 
   def self.parse(data)
     return unless data[FORMAT_STRING % 'name']
-    name = CGI.unescape(data[FORMAT_STRING % 'name'])
-    street_address = CGI.unescape(data[FORMAT_STRING % 'streetAddress'])
-    postal_code = CGI.unescape(data[FORMAT_STRING % 'postalCode'])
-    city = CGI.unescape(data[FORMAT_STRING % 'city'])
-    country = CGI.unescape(data[FORMAT_STRING % 'country'])
+    name = CGI.unescape(data[FORMAT_STRING % 'name'].to_s)
+    street_address = CGI.unescape(data[FORMAT_STRING % 'streetAddress'].to_s)
+    postal_code = CGI.unescape(data[FORMAT_STRING % 'postalCode'].to_s)
+    city = CGI.unescape(data[FORMAT_STRING % 'city'].to_s)
+    country = CGI.unescape(data[FORMAT_STRING % 'country'].to_s)
     self.new(name, street_address, postal_code, city, country)
   end
 end

data/lib/payson_api/version.rb

@@ -1,3 +1,3 @@
 module PaysonAPI
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/fixtures/payment_data.yml

@@ -1,18 +1,24 @@
 :return_url: http://localhost/return
 :cancel_url: http://localhost/cancel
-:ipn_url: 
+:ipn_url: http://localhost/ipn
 :memo: Test
 :receivers:
   -
     :email: mytest@domain.com
     :amount: 123
+    :first_name: Test
+    :last_name: Person 1
+    :primary: true
   -
     :email: mytest2@domain2.com
     :amount: 234
+    :first_name: Test
+    :last_name: Person 2
+    :primary: false
 :sender:
   :email: test_person@anotherdomain.com
   :first_name: Test
-  :last_name: Person
+  :last_name: Receiver
 :order_items:
   -
     :description: 'My order item description'
@@ -26,3 +32,11 @@
     :quantity: 2
     :tax: 10
     :sku: 'MY-ITEM-2'
+:fundings:
+  -
+    :constraint: CREDITCARD
+  -
+    :constraint: BANK
+:fees_payer: EACHRECEIVER
+:guarantee_offered: NO
+:locale: SV

data/test/integration/payment_details_test.rb

@@ -19,9 +19,6 @@ class PaymentDetailsTest < Test::Unit::TestCase
 
     payment_details = PaysonAPI::Request::PaymentDetails.new(token)
     response = PaysonAPI::Client.get_payment_details(payment_details)
-
-
-
-p response
+#p response
   end
 end

data/test/integration/payment_test.rb

@@ -14,15 +14,22 @@ class PaymentTest < Test::Unit::TestCase
     assert_equal PAYMENT_DATA[:cancel_url], @payment_hash['cancelUrl']
     assert_equal PAYMENT_DATA[:ipn_url], @payment_hash['ipnNotificationUrl']
     assert_equal PAYMENT_DATA[:memo], @payment_hash['memo']
+    assert_equal PAYMENT_DATA[:locale], @payment_hash['localeCode']
 
     # Ensure expected format of receiver list
     receiver_format = PaysonAPI::Receiver::FORMAT_STRING
     @receivers.each_with_index do |receiver, index|
       email = @payment_hash[receiver_format % [index, 'email']]
       amount = @payment_hash[receiver_format % [index, 'amount']]
+      first_name = @payment_hash[receiver_format % [index, 'firstName']]
+      last_name = @payment_hash[receiver_format % [index, 'lastName']]
+      primary = @payment_hash[receiver_format % [index, 'primary']]
 
       assert_equal receiver.email, email
       assert_equal receiver.amount, amount
+      assert_equal receiver.first_name, first_name
+      assert_equal receiver.last_name, last_name
+      assert_equal receiver.primary, primary
     end
 
     # Do same test for order items
@@ -40,6 +47,13 @@ class PaymentTest < Test::Unit::TestCase
       assert_equal order_item.tax, tax
       assert_equal order_item.sku, sku
     end
+
+    # Ensure expected format of fundings list
+    funding_format = PaysonAPI::Funding::FORMAT_STRING
+    @fundings.each_with_index do |funding, index|
+      constraint = @payment_hash[funding_format % [index, 'constraint']]
+      assert_equal funding.constraint, constraint
+    end
   end
 
   def test_payment_initiation_request

data/test/test_helper.rb

@@ -22,7 +22,10 @@ module TestHelper
     PAYMENT_DATA[:receivers].each do |receiver|
       @receivers << PaysonAPI::Receiver.new(
         receiver[:email],
-        receiver[:amount]
+        receiver[:amount],
+        receiver[:first_name],
+        receiver[:last_name],
+        receiver[:primary]
       )
     end
 
@@ -46,7 +49,19 @@ module TestHelper
       )
     end
 
+    @fundings = []
+    PAYMENT_DATA[:fundings].each do |funding|
+      @fundings << PaysonAPI::Funding.new(
+        funding[:constraint]
+      )
+    end
+
     @payment.order_items = @order_items if include_order_items
+    @payment.fundings = @fundings
+    @payment.fees_payer = PAYMENT_DATA[:fees_payer]
+    @payment.locale = PAYMENT_DATA[:locale]
+    @payment.guarantee_offered = PAYMENT_DATA[:guarantee_offered]
+
     @payment_hash = @payment.to_hash
   end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Christopher Svensson