zaypay 1.0.0

data/lib/zaypay.rb

@@ -0,0 +1,5 @@
+require 'httparty'
+require 'zaypay/price_setting'
+require 'zaypay/error'
+require 'zaypay/util'
+require "zaypay/version"

data/lib/zaypay/error.rb

@@ -0,0 +1,10 @@
+module Zaypay
+  class Error < StandardError
+     def initialize(type = nil, message = "default message")
+       @type = type
+       super(message)
+     end
+    attr_accessor :type
+  end
+  
+end

data/lib/zaypay/price_setting.rb

@@ -0,0 +1,138 @@
+module Zaypay
+  require 'yaml'
+  class PriceSetting
+    include HTTParty
+    attr_reader :price_setting_id, :key
+    attr_accessor :locale, :payment_method_id
+
+    base_uri 'https://secure.zaypay.com'
+    headers :Accept => 'application/xml'
+
+    def initialize(price_setting_id=nil, key=nil)
+      @price_setting_id, @key = price_setting_id, key
+      select_settings
+    end
+
+    def locale_for_ip(ip)
+      get "/#{ip}/pay/#{price_setting_id}/locale_for_ip" do |data|
+        parts = data[:locale].split('-')
+        {:country => parts[1], :language => parts[0]}
+      end
+    end
+
+    def locale_string_for_ip(ip)
+      get "/#{ip}/pay/#{price_setting_id}/locale_for_ip" do |data|
+        parts = data[:locale].split('-')
+        Zaypay::Util.stringify_locale_hash({:country => parts[1], :language => parts[0]})
+      end
+    end
+
+    def ip_country_is_configured?(ip, options={})
+      # options can take a :amount key
+      locale  = locale_for_ip(ip)
+      country = list_countries(options).select{ |c| c.has_value? locale[:country] }.first
+      {:country => country, :locale => locale} if country
+    end
+
+    # returns a hash containing keys countries and languages
+    def list_locales(options={})
+      get "/#{options[:amount]}/pay/#{price_setting_id}/list_locales" do |data|
+        {:countries => Zaypay::Util.arrayify_if_not_an_array(data[:countries][:country]),
+         :languages => data[:languages][:language]}
+      end
+    end
+
+    # returns an array with countries
+    def list_countries(options={})
+      get "/#{options[:amount]}/pay/#{price_setting_id}/list_locales" do |data|
+        Zaypay::Util.arrayify_if_not_an_array(data[:countries][:country])
+      end
+    end
+
+    # returns an array with languages
+    def list_languages(options={})
+      get "/#{options[:amount]}/pay/#{price_setting_id}/list_locales" do |data|
+        data[:languages][:language]
+      end
+    end
+
+    def list_payment_methods(options={})
+      raise Zaypay::Error.new(:locale_not_set, "locale was not set for your price setting") if @locale.nil?
+      get "/#{options[:amount]}/#{@locale}/pay/#{price_setting_id}/payments/new" do |data|
+        Zaypay::Util.arrayify_if_not_an_array(data[:payment_methods][:payment_method])
+      end
+    end
+
+    # Example: @price_setting.create_payment(:custom_variable => "my value", :payalogue_id => payalogue_id, :amount => optional_amount )
+    def create_payment(options={})
+      raise Zaypay::Error.new(:locale_not_set, "locale was not set for your price setting") if @locale.nil?
+      raise Zaypay::Error.new(:payment_method_id_not_set, "payment_method_id was not set for your price setting") if @payment_method_id.nil?
+      query = {:payment_method_id => payment_method_id}
+      query.merge!(options)
+      amount = query.delete(:amount)
+      post "/#{amount}/#{@locale}/pay/#{price_setting_id}/payments", query do |data|
+        payment_hash data
+      end
+    end
+
+    def show_payment(payment_id)
+      get "///pay/#{price_setting_id}/payments/#{payment_id}" do |data|
+        payment_hash data
+      end
+    end
+
+    def verification_code(payment_id, verification_code)
+      post "///pay/#{price_setting_id}/payments/#{payment_id}/verification_code", :verification_code => verification_code do |data|
+        payment_hash data
+      end
+    end
+
+    def mark_payload_provided(payment_id)
+      post "///pay/#{price_setting_id}/payments/#{payment_id}/mark_payload_provided" do |data|
+        payment_hash data
+      end
+    end
+
+    protected
+    def select_settings
+      unless @price_setting_id and @key
+        begin
+          config = YAML.load_file("#{Rails.root}/config/zaypay.yml")
+        rescue => e
+          puts 'Please either specify price_setting id and its API-key as first 2 arguments to #new, or create a config-file (checkout the plugin README)'
+          raise e
+        end
+        @price_setting_id = config['default'] unless @price_setting_id
+        @key = config[@price_setting_id]
+        if @key.nil? || @price_setting_id.nil?
+          raise Zaypay::Error.new(:config_error, "You did not provide a price_setting id or/and an API-key. You can either pass it to the constructor
+                                                  or create a config file (check out README)")
+        end
+      end
+    end
+
+    def method_missing(method, url, extra_query_string={})
+      super unless [:get, :post, :put, :delete].include?(method)
+      response = self.class.send(method, ('https://secure.zaypay.com' + url), {:query => default_query.merge!(extra_query_string), 
+                                                                              :headers => {'Accept' => 'application/xml' } })
+      
+      Zaypay::Util.uber_symbolize(response)
+      check response
+      block_given? ? yield(response[:response]) : response[:response]
+    end
+
+    def check(response)
+      raise Zaypay::Error.new(:http_error, "HTTP-request to zaypay yielded status #{response.code}..\n\nzaypay said:\n#{response.body}") unless response.code == 200
+      raise Zaypay::Error.new(:http_error, "HTTP-request to yielded an error:\n#{response[:response][:error]}") if response[:response].delete(:status)=='error'
+    end
+
+    def default_query
+      {:key => key}
+    end
+
+    def payment_hash(data)
+      {:payment => data.delete(:payment),
+       :instructions => data}.delete_if{|k,v| v.nil?}
+    end
+  end
+end

data/lib/zaypay/util.rb

@@ -0,0 +1,28 @@
+module Zaypay
+  class Util
+
+    def self.uber_symbolize(data)
+      if data.is_a?(Hash)
+        data.keys.each do |key|
+          data[(key.to_sym rescue key) || key] = data.delete(key)
+        end
+        data.values.each do |v|
+          Zaypay::Util.uber_symbolize(v)
+        end
+      end
+      if data.is_a?(Array)
+        data.each{|e| Zaypay::Util.uber_symbolize(e)}
+      end
+      data
+    end
+
+    def self.stringify_locale_hash(locale_hash)
+      locale_hash[:language] << '-' << locale_hash[:country]
+    end
+
+    def self.arrayify_if_not_an_array(obj)
+      obj.is_a?(Array) ? obj : [obj]
+    end
+
+  end
+end

data/lib/zaypay/version.rb

@@ -0,0 +1,3 @@
+module Zaypay
+  VERSION = "1.0.0"
+end

data/test/create_payment.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response status="success">
+  <payment>
+    <created-at type="datetime">2012-07-31T09:48:18Z</created-at>
+    <id type="integer">789456321</id>
+    <locale>nl-NL</locale>
+    <paycode>1372</paycode>
+    <payload-provided type="boolean">false</payload-provided>
+    <total-amount type="decimal">0.9</total-amount>
+    <currency>EUR</currency>
+    <amount-euro type="float">0.9</amount-euro>
+    <total-payout type="decimal">0.42</total-payout>
+    <number>7711</number>
+    <formatted-number>7711</formatted-number>
+    <keyword>PAY</keyword>
+    <platform>sms</platform>
+    <human-platform>sms</human-platform>
+    <messages-to-be-sent type="integer">1</messages-to-be-sent>
+    <messages-left-to-be-sent type="integer">1</messages-left-to-be-sent>
+    <partly-customer-phone-number>unknown</partly-customer-phone-number>
+    <customer-phone-number-hash>unknown</customer-phone-number-hash>
+    <customer-mo-message>unknown</customer-mo-message>
+    <verification-needed type="boolean">false</verification-needed>
+    <status>prepared</status>
+    <payment-method-id type="integer">2</payment-method-id>
+  </payment>
+  <status-string>De betaling is voorbereid</status-string>
+  <very-short-instructions>betaal per sms</very-short-instructions>
+  <very-short-instructions-with-amount>betaal &#8364; 0,90 per sms</very-short-instructions-with-amount>
+  <short-instructions>SMS de tekst PAY 1372 naar nummer 7711.</short-instructions>
+  <long-instructions>SMS de tekst PAY 1372 naar telefoonnummer 7711. Je zal 1 bericht ontvangen. Hiermee is dan &#8364; 0,90 betaald. Verder betaal je het normale tarief voor het versturen van &#233;&#233;n SMSje. </long-instructions>
+  <disclaimer>Je staat op het punt om met echt geld te betalen. Als je jonger bent dan 13 jaar, moet je hiervoor toestemming hebben van je ouders.</disclaimer>
+</response>

data/test/error_with_dynamic_amounts.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response status="error">
+  <error>It is not supported to use dynamic amounts with a Price Setting that is in Full Control mode. Use one in (Super) Easy mode if you want to use dynamic amounts through the API.</error>
+</response>

data/test/locale_for_ip.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response status="success">
+  <locale>nl-NL</locale>
+</response>

data/test/mark_payload_provided.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response status="success">
+  <payment>
+    <created-at type="datetime">2012-07-11T13:53:35Z</created-at>
+    <id type="integer">789456321</id>
+    <locale>nl-NL</locale>
+    <paycode>1543</paycode>
+    <payload-provided type="boolean">true</payload-provided>
+    <total-amount type="decimal">0.25</total-amount>
+    <currency>EUR</currency>
+    <amount-euro type="float">0.25</amount-euro>
+    <total-payout type="decimal">0.05</total-payout>
+    <number>7711</number>
+    <formatted-number>7711</formatted-number>
+    <keyword>PAY</keyword>
+    <platform>sms</platform>
+    <human-platform>sms</human-platform>
+    <messages-to-be-sent type="integer">1</messages-to-be-sent>
+    <messages-left-to-be-sent type="integer">0</messages-left-to-be-sent>
+    <partly-customer-phone-number>3161158xxxx</partly-customer-phone-number>
+    <customer-phone-number-hash>f86610eb216961e7caa46f009cb990bd98b0c8ae</customer-phone-number-hash>
+    <customer-mo-message>PAY 1543</customer-mo-message>
+    <verification-needed type="boolean">false</verification-needed>
+    <status>paid</status>
+    <payment-method-id type="integer">2</payment-method-id>
+    <ip-address>95.97.131.28</ip-address>
+  </payment>
+</response>

data/test/multi_countries_ps.xml

@@ -0,0 +1,280 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response status="success">
+  <languages>
+    <language>
+      <code>id</code>
+      <english-name>Indonesian</english-name>
+      <native-name>Bahasa indonesia</native-name>
+    </language>
+    <language>
+      <code>bs</code>
+      <english-name>Bosnian</english-name>
+      <native-name>Bosnian</native-name>
+    </language>
+    <language>
+      <code>da</code>
+      <english-name>Danish</english-name>
+      <native-name>Dansk</native-name>
+    </language>
+    <language>
+      <code>de</code>
+      <english-name>German</english-name>
+      <native-name>Deutsch</native-name>
+    </language>
+    <language>
+      <code>en</code>
+      <english-name>English</english-name>
+      <native-name>English</native-name>
+    </language>
+    <language>
+      <code>es</code>
+      <english-name>Spanish (Castellano)</english-name>
+      <native-name>Espa&#241;ol (Castellano)</native-name>
+    </language>
+    <language>
+      <code>ls</code>
+      <english-name>Spanish (Latin-American)</english-name>
+      <native-name>Espa&#241;ol (Latinoam&#233;rica)</native-name>
+    </language>
+    <language>
+      <code>fr</code>
+      <english-name>French</english-name>
+      <native-name>fran&#231;ais</native-name>
+    </language>
+    <language>
+      <code>hr</code>
+      <english-name>Croatian</english-name>
+      <native-name>Hrvatski</native-name>
+    </language>
+    <language>
+      <code>it</code>
+      <english-name>Italian</english-name>
+      <native-name>italiano</native-name>
+    </language>
+    <language>
+      <code>nl</code>
+      <english-name>Dutch</english-name>
+      <native-name>Nederlands</native-name>
+    </language>
+    <language>
+      <code>pl</code>
+      <english-name>Polish</english-name>
+      <native-name>Polski</native-name>
+    </language>
+    <language>
+      <code>pt</code>
+      <english-name>Portuguese</english-name>
+      <native-name>portugu&#234;s</native-name>
+    </language>
+    <language>
+      <code>ru</code>
+      <english-name>Russian</english-name>
+      <native-name>Pycc&#312;&#1080;&#1081;</native-name>
+    </language>
+    <language>
+      <code>ro</code>
+      <english-name>Romanian</english-name>
+      <native-name>Rom&#226;n&#259;</native-name>
+    </language>
+    <language>
+      <code>sr</code>
+      <english-name>Serbian</english-name>
+      <native-name>Srpski</native-name>
+    </language>
+    <language>
+      <code>fi</code>
+      <english-name>Finnish</english-name>
+      <native-name>suomi</native-name>
+    </language>
+    <language>
+      <code>sv</code>
+      <english-name>Swedish</english-name>
+      <native-name>svenska</native-name>
+    </language>
+    <language>
+      <code>cs</code>
+      <english-name>Czech</english-name>
+      <native-name>&#269;e&#353;tina</native-name>
+    </language>
+    <language>
+      <code>bg</code>
+      <english-name>Bulgarian</english-name>
+      <native-name>&#1041;&#1098;&#1083;&#1075;&#1072;&#1088;&#1089;&#1082;&#1080;</native-name>
+    </language>
+    <language>
+      <code>he</code>
+      <english-name>Hebrew</english-name>
+      <native-name>&#1506;&#1489;&#1512;&#1497;&#1514;</native-name>
+    </language>
+  </languages>
+  <countries>
+    <country>
+      <code>AR</code>
+      <name>Argentina</name>
+    </country>
+    <country>
+      <code>AU</code>
+      <name>Australia</name>
+    </country>
+    <country>
+      <code>AT</code>
+      <name>Austria</name>
+    </country>
+    <country>
+      <code>BE</code>
+      <name>Belgium</name>
+    </country>
+    <country>
+      <code>BA</code>
+      <name>Bosnia and Herzegovina</name>
+    </country>
+    <country>
+      <code>BG</code>
+      <name>Bulgaria</name>
+    </country>
+    <country>
+      <code>CA</code>
+      <name>Canada</name>
+    </country>
+    <country>
+      <code>CL</code>
+      <name>Chile</name>
+    </country>
+    <country>
+      <code>CZ</code>
+      <name>Czech Republic</name>
+    </country>
+    <country>
+      <code>DK</code>
+      <name>Denmark</name>
+    </country>
+    <country>
+      <code>EE</code>
+      <name>Estonia</name>
+    </country>
+    <country>
+      <code>FI</code>
+      <name>Finland</name>
+    </country>
+    <country>
+      <code>FR</code>
+      <name>France</name>
+    </country>
+    <country>
+      <code>DE</code>
+      <name>Germany</name>
+    </country>
+    <country>
+      <code>GR</code>
+      <name>Greece</name>
+    </country>
+    <country>
+      <code>HK</code>
+      <name>Hong Kong</name>
+    </country>
+    <country>
+      <code>HU</code>
+      <name>Hungary</name>
+    </country>
+    <country>
+      <code>IE</code>
+      <name>Ireland</name>
+    </country>
+    <country>
+      <code>IL</code>
+      <name>Israel</name>
+    </country>
+    <country>
+      <code>IT</code>
+      <name>Italy</name>
+    </country>
+    <country>
+      <code>LV</code>
+      <name>Latvia</name>
+    </country>
+    <country>
+      <code>LT</code>
+      <name>Lithuania</name>
+    </country>
+    <country>
+      <code>LU</code>
+      <name>Luxembourg</name>
+    </country>
+    <country>
+      <code>MX</code>
+      <name>Mexico</name>
+    </country>
+    <country>
+      <code>NL</code>
+      <name>Netherlands</name>
+    </country>
+    <country>
+      <code>NZ</code>
+      <name>New Zealand</name>
+    </country>
+    <country>
+      <code>NO</code>
+      <name>Norway</name>
+    </country>
+    <country>
+      <code>PL</code>
+      <name>Poland</name>
+    </country>
+    <country>
+      <code>PT</code>
+      <name>Portugal</name>
+    </country>
+    <country>
+      <code>RO</code>
+      <name>Romania</name>
+    </country>
+    <country>
+      <code>RU</code>
+      <name>Russian Federation</name>
+    </country>
+    <country>
+      <code>CS</code>
+      <name>Serbia and Montenegro</name>
+    </country>
+    <country>
+      <code>SK</code>
+      <name>Slovakia</name>
+    </country>
+    <country>
+      <code>ZA</code>
+      <name>South Africa</name>
+    </country>
+    <country>
+      <code>ES</code>
+      <name>Spain</name>
+    </country>
+    <country>
+      <code>SE</code>
+      <name>Sweden</name>
+    </country>
+    <country>
+      <code>CH</code>
+      <name>Switzerland</name>
+    </country>
+    <country>
+      <code>TW</code>
+      <name>Taiwan</name>
+    </country>
+    <country>
+      <code>TR</code>
+      <name>Turkey</name>
+    </country>
+    <country>
+      <code>UA</code>
+      <name>Ukraine</name>
+    </country>
+    <country>
+      <code>GB</code>
+      <name>United Kingdom</name>
+    </country>
+    <country>
+      <code>US</code>
+      <name>United States of America</name>
+    </country>
+  </countries>
+</response>