allorails 0.4.2 → 0.5.1

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+gemspec
+gem 'rspec'
+gem 'nokogiri'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    allorails (0.4.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    nokogiri (1.5.5)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  allorails!
+  nokogiri
+  rspec

data/Manifest

@@ -1,3 +1,6 @@
+Gemfile
+Gemfile.lock
+Manifest
 README.md
 Rakefile
 allorails.gemspec
@@ -8,9 +11,12 @@ lib/allorails/core.rb
 lib/allorails/errors/errors.rb
 lib/allorails/rails.rb
 lib/allorails/request/request.rb
+lib/allorails/response/api_mapping_response.rb
+lib/allorails/response/api_response.rb
 lib/allorails/response/model.rb
-lib/allorails/response/response.rb
-test/allorails_spec.rb
-test/test-conf-sample.yml
-test/test-conf.yml
-Manifest
+lib/allorails/response/onetime_button_response.rb
+lib/allorails/response/onetime_pricing_response.rb
+lib/allorails/response/onetime_validate_codes_response.rb
+lib/allorails/response/product_detail_response.rb
+lib/allorails/response/transaction_detail_response.rb
+lib/allorails/response/transaction_prepare_response.rb

data/README.md

@@ -54,7 +54,6 @@ You can put your configuration options in a yaml file located at `config/allorai
       # optional settings
       # (the values below are the defaults)
       default_hash: "sha1"
-      default_format: "json"
       network_timeout: 20
       network_protocol: "http"
       network_port: 80

data/Rakefile

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('allorails', '0.4.2') do |p|
-  p.description    = "Ruby client for the Allopass online payment REST API"
+Echoe.new('allorails', '0.5.1') do |p|
+  p.description    = "Ruby/Rails client for the Allopass online payment API"
   p.url            = "http://github.com/davb/allorails"
   p.author         = "Davide Bonapersona"
   p.email          = "davide@feeligo.com"
-  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.ignore_pattern = ["tmp/*", "script/*", "spec/*"]
   p.development_dependencies = []
 end
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/allorails.gemspec

@@ -2,21 +2,21 @@
 
 Gem::Specification.new do |s|
   s.name = "allorails"
-  s.version = "0.4.2"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Davide Bonapersona"]
-  s.date = "2012-05-10"
-  s.description = "Ruby client for the Allopass online payment REST API"
+  s.date = "2013-01-15"
+  s.description = "Ruby/Rails client for the Allopass online payment API"
   s.email = "davide@feeligo.com"
-  s.extra_rdoc_files = ["README.md", "lib/allorails.rb", "lib/allorails/api/api.rb", "lib/allorails/core.rb", "lib/allorails/errors/errors.rb", "lib/allorails/rails.rb", "lib/allorails/request/request.rb", "lib/allorails/response/model.rb", "lib/allorails/response/response.rb"]
-  s.files = ["README.md", "Rakefile", "allorails.gemspec", "init.rb", "lib/allorails.rb", "lib/allorails/api/api.rb", "lib/allorails/core.rb", "lib/allorails/errors/errors.rb", "lib/allorails/rails.rb", "lib/allorails/request/request.rb", "lib/allorails/response/model.rb", "lib/allorails/response/response.rb", "test/allorails_spec.rb", "test/test-conf-sample.yml", "test/test-conf.yml", "Manifest"]
+  s.extra_rdoc_files = ["README.md", "lib/allorails.rb", "lib/allorails/api/api.rb", "lib/allorails/core.rb", "lib/allorails/errors/errors.rb", "lib/allorails/rails.rb", "lib/allorails/request/request.rb", "lib/allorails/response/api_mapping_response.rb", "lib/allorails/response/api_response.rb", "lib/allorails/response/model.rb", "lib/allorails/response/onetime_button_response.rb", "lib/allorails/response/onetime_pricing_response.rb", "lib/allorails/response/onetime_validate_codes_response.rb", "lib/allorails/response/product_detail_response.rb", "lib/allorails/response/transaction_detail_response.rb", "lib/allorails/response/transaction_prepare_response.rb"]
+  s.files = ["Gemfile", "Gemfile.lock", "Manifest", "README.md", "Rakefile", "allorails.gemspec", "init.rb", "lib/allorails.rb", "lib/allorails/api/api.rb", "lib/allorails/core.rb", "lib/allorails/errors/errors.rb", "lib/allorails/rails.rb", "lib/allorails/request/request.rb", "lib/allorails/response/api_mapping_response.rb", "lib/allorails/response/api_response.rb", "lib/allorails/response/model.rb", "lib/allorails/response/onetime_button_response.rb", "lib/allorails/response/onetime_pricing_response.rb", "lib/allorails/response/onetime_validate_codes_response.rb", "lib/allorails/response/product_detail_response.rb", "lib/allorails/response/transaction_detail_response.rb", "lib/allorails/response/transaction_prepare_response.rb"]
   s.homepage = "http://github.com/davb/allorails"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Allorails", "--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = "allorails"
   s.rubygems_version = "1.8.21"
-  s.summary = "Ruby client for the Allopass online payment REST API"
+  s.summary = "Ruby/Rails client for the Allopass online payment API"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/allorails/core.rb

@@ -108,7 +108,7 @@ module Allorails
       # registers configuration options
       add_option :accounts, {}
       add_option :default_hash, 'sha1'
-      add_option :default_format, 'json'
+      add_option :default_format, Allorails::Request::ApiRequest::MAPPING_FORMAT
       add_option :network_timeout, 20
       add_option :network_protocol, 'http'
       add_option :network_port, 80

data/lib/allorails/request/request.rb

@@ -8,7 +8,7 @@ module Allorails
     class ApiRequest
 
       # API response format needed to provide response object mapping
-      MAPPING_FORMAT = 'json'
+      MAPPING_FORMAT = 'xml'
       # API remote base path
       API_PATH = '/rest'
 

data/lib/allorails/response/api_mapping_response.rb

@@ -0,0 +1,93 @@
+require 'nokogiri'
+
+module Allorails
+  module Response
+
+    ## Basis of an object mapped API response
+    class ApiMappingResponse < Allorails::Response::ApiResponse
+      
+      attr_reader :xml
+      
+      ##
+      # Constructor
+      #  @param signature (string) Expected response signature
+      #  @param headers (list) Response HTTP headers
+      #  @param body (string) Raw response data
+      def initialize(signature, headers, body)
+        super(signature, headers, body)
+        # parse the XML response
+        @xml = Nokogiri.XML(body)
+        # error if no root element
+        raise Allorails::ApiWrongFormatResponseError if @xml.root.nil?
+        # verify the response
+        _verify
+      end
+      
+      ##
+      # Internal method checking the response
+      # @throws ApiRemoteErrorError If response doesn't contain valid XML
+      def _verify
+        raise Allorails::ApiRemoteErrorError if @xml.root[:code] != '0'
+        # call the parent _verify method which will check the signature
+        super
+      end
+      
+      ##
+      # Internal method allowing easy reading of XML nodes
+      #  @param (sym) name of the node that needs to be read
+      #  @param (Class) type to which the result should be cast
+      def self.node_reader(node_name, type = String)
+        # define a Proc to cast the node's text to the specified type
+        node_value = case true
+          when type == String then Proc.new{|x| x.text}
+          when type == Integer then Proc.new{|x| x.text.to_i}
+          when type == Float then Proc.new{|x| x.text.to_f}
+          when type == DateTime then Proc.new{|x|
+            if x.respond_to?(:attribute) && (ts = x.attribute('timestamp'))
+              DateTime.strptime(ts.value, "%s")
+            elsif x.respond_to?(:attribute) && (d = x.attribute('date'))
+              DateTime.strptime(d.value)
+            else
+              nil
+            end
+          }
+          else Proc.new{|x| type.new x}
+        end
+        # add a method accessing the node and casting the text
+        send :define_method, node_name do
+          node = xml.css(node_name.to_s).first
+          return node_value.call(node) unless node.nil?
+        end
+      end
+
+      ##
+      # Internal method allowing easy reading of XML attributes
+      #  @param (sym) name of the attribute that needs to be read
+      #  @param (Class) type to which the result should be cast
+      def self.attribute_reader(attr_name, type = String)
+        # define a Proc to cast the attribute's value to the specified type
+        attr_value = case true
+          when type == String then Proc.new{|x| x.value}
+          when type == Integer then Proc.new{|x| x.value.to_i}
+          when type == Float then Proc.new{|x| x.value.to_f}
+          when type == DateTime then Proc.new{|x|
+            if x.respond_to?(:attribute) && (ts = x.attribute('timestamp'))
+              DateTime.strptime(ts.value, "%s")
+            elsif x.respond_to?(:attribute) && (d = x.attribute('date'))
+              DateTime.strptime(d.value)
+            else
+              nil
+            end
+          }
+          else Proc.new{|x| type.new x}
+        end
+        # add a method accessing the node and casting the text
+        send :define_method, attr_name do
+          att = xml.attribute(attr_name.to_s)
+          return attr_value.call(att) unless att.nil?
+        end
+      end
+      
+    end
+  end
+end

data/lib/allorails/response/api_response.rb

@@ -0,0 +1,27 @@
+module Allorails
+  module Response
+    class ApiResponse
+      
+      ##
+      # Constructor
+      #  @param signature (string) Expected response signature
+      #  @param headers (list) Response HTTP headers
+      #  @param body (string) Raw response data
+      def initialize(signature, headers, body)
+        @_signature = signature
+        @_headers = headers
+        @_body = body
+      end
+      
+      ##
+      # Internal method checking the response
+      # @throws ApiFalseResponseSignature If the expected signature is not found among response headers
+      def _verify
+        unless (@_headers['x-allopass-response-signature'] || []).include?(@_signature)
+          raise Allorails::ApiFalseResponseSignatureError
+        end
+      end
+
+    end
+  end
+end

data/lib/allorails/response/model.rb

@@ -6,7 +6,7 @@ module Allorails
   class Base < Allorails::Response::ApiMappingResponse 
     
     def initialize(node)
-      @json = node
+      @xml = node
     end
     
   end
@@ -17,25 +17,25 @@ module Allorails
   
     ## Provides the website id
     #  @return (int) website id
-    node_reader :id, Integer
+    attribute_reader :id, Integer
   
     ## Provides the website name
     #  @return (string) website name
-    node_reader :name
+    attribute_reader :name
   
     ## Provides the website url
     #  @return (string) website url
-    node_reader :url
+    attribute_reader :url
   
     ## Checks wether the website's audience is restricted
     #  @return (boolean) wether the website's audience is restricted
     def audience_restricted?
-      @json.audience_restricted == 'true'
+      xml.attribute('audience_restricted') == 'true'
     end
   
     ## Provides the website category
     #  @return (string) website category
-    node_reader :category
+    attribute_reader :category
 
   end
   
@@ -45,11 +45,11 @@ module Allorails
   
     ## Provides the country code
     #  @return (string) country code (two characters)
-    node_reader :code
+    attribute_reader :code
   
     ## Provides the country name
     #  @return (string) country name
-    node_reader :name
+    attribute_reader :name
     
   end
   
@@ -59,12 +59,12 @@ module Allorails
   
     ## Provides the region name
     #  @return (string) region name
-    node_reader :name
+    attribute_reader :name
   
     ## Provides the countries in the region
     #  @return (Array) region's countries
     def countries
-      json.children.values.map{|c| ::Allorails::Country.new(c)}
+      xml.css('country').map{|c| Allorails::Country.new(c)}
     end
   
   end
@@ -75,16 +75,16 @@ module Allorails
   
     ## Provides the country code
     #  @return (string) country code (two characters)
-    node_reader :country_code
+    attribute_reader :country_code
   
     ## Provides the country name
     #  @return (string) country name
-    node_reader :country
+    attribute_reader :country
   
     ## Provides the pricepoints available in this market
     #  @return (Array) available pricepoints (list of Pricepoint objects)
     def pricepoints
-      json.pricepoint.map{|c| ::Allorails::Pricepoint.new(c)}
+      xml.css('pricepoint').map{|c| Allorails::Pricepoint.new(c)}
     end
     
   end
@@ -95,23 +95,23 @@ module Allorails
   
     ## Provides the currency
     #  @return (string) currency (three characters)
-    node_reader :currency
+    attribute_reader :currency
   
     ## Provides the amount
     #  @return (float) amount
-    node_reader :amount, Float
+    attribute_reader :amount, Float
   
     ## Provides the day's exchange rate
     #  @return (float) exchange rate
-    node_reader :exchange, Float
+    attribute_reader :exchange, Float
   
     ## Provides the reference currency
     #  @return (string) reference currency
-    node_reader :reference_currency
+    attribute_reader :reference_currency
   
     ## Provides the amount in the reference currency
     #  @return (float) reference amount
-    node_reader :reference_amount, Float
+    attribute_reader :reference_amount, Float
 
   end
   
@@ -120,23 +120,23 @@ module Allorails
   
     ## Provides the currency
     #  @return (string) currency (three characters)
-    node_reader :currency
+    attribute_reader :currency
   
     ## Provides the amount
     #  @return (float) amount
-    node_reader :amount, Float
+    attribute_reader :amount, Float
   
     ## Provides the day's exchange rate
     #  @return (float) exchange rate
-    node_reader :exchange, Float
+    attribute_reader :exchange, Float
   
     ## Provides the reference currency
     #  @return (string) reference currency
-    node_reader :reference_currency
+    attribute_reader :reference_currency
   
     ## Provides the amount in the reference currency
     #  @return (float) reference amount
-    node_reader :reference_amount, Float
+    attribute_reader :reference_amount, Float
   
   end
   
@@ -146,7 +146,7 @@ module Allorails
   
     ## Provides the phone number
     #  @return (string) phone number
-    node_reader :value
+    attribute_reader :value
   
     ## Provides the description of the phone number
     #  @return (string) description
@@ -160,23 +160,23 @@ module Allorails
   
     ## Provides the keyword name
     #  @return (string) keyword name
-    node_reader :name
+    attribute_reader :name
   
     ## Provides the keyword's shortcode
     #  @return (string) shortcode
-    node_reader :shortcode
+    attribute_reader :shortcode
   
     ## Provides the keyword operators
     #  @return (string) keyword operators
-    node_reader :operators
+    attribute_reader :operators
   
     ## Provides the number of billed messages of the keyword
     #  @return (int) number of billed messages
-    node_reader :number_billed_messages, Integer
+    attribute_reader :number_billed_messages, Integer
   
     ## Provides a description of the keyword
     #  @return (string) description
-    node_reader :description
+    attribute_reader :description
     
   end
   
@@ -186,23 +186,23 @@ module Allorails
   
     ## Provides the pricepoint's id
     #  @return (int) pricepoint id
-    node_reader :id, Integer
+    attribute_reader :id, Integer
   
     ## Provides the pricepoint's type
     #  @return (string) pricepoint type
-    node_reader :type
+    attribute_reader :type
   
     ## Provides the pricepoint's country code
     #  @return (string) country code (two characters)
-    node_reader :country_code
+    attribute_reader :country_code
   
     ## Provides price information
     #  @return (Price) price information
-    node_reader :price, ::Allorails::Price
+    node_reader :price, Allorails::Price
   
     ## Provides the pricepoint's payout
     #  @return (Payout) pricepoint's payout
-    node_reader :payout, ::Allorails::Payout
+    node_reader :payout, Allorails::Payout
   
     ## Provides the buy url
     #  @return (string) buy url
@@ -211,15 +211,13 @@ module Allorails
     ## Provides the pricepoint's phone numbers
     #  @return (list) pricepoint's phone number (list of PhoneNumber objects)
     def phone_numbers
-      return nil if json.phone_numbers.nil?
-      json.phone_numbers.children.values.map{|c| ::Allorails::PhoneNumber(c)}
+      xml.css('phone_number').map{|c| Allorails::PhoneNumber.new(c)}
     end
   
     ## Provides the pricepoint's keywords
     #  @return (list) pricepoint's keywords (list of Keyword objects)
     def keywords
-      return nil if json.keywords.nil?
-      json.keywords.children.values.map{|c| ::Allorails::Keyword(c)}
+      xml.css('keyword').map{|c| Allorails::Keyword.new(c)}
     end
   
     ## Provides the pricepoint's description
@@ -234,17 +232,18 @@ module Allorails
   
     ## Provides the partner id
     #  @return (int) partner id
-    node_reader :id, Integer
+    attribute_reader :id, Integer
   
     ## Provides the parnter's amount share
     #  @return (float) parnter's amount share
-    node_reader :share, Float
+    attribute_reader :share, Float
   
     ## Provides the associated map id
     #  @return (int) map id
     def map
-      return nil unless json.map.is_a?(String) && json.map.length > 0
-      json.map.to_i
+      if (map = xml.attribute('map')) && map.text.length > 0
+        return map.to_i
+      end
     end
     
   end
@@ -259,19 +258,19 @@ module Allorails
   
     ## Provides the pricepoint's description
     #  @return (string) pricepoint's description
-    node_reader :pricepoint, ::Allorails::Pricepoint
+    node_reader :pricepoint, Allorails::Pricepoint
   
     ## Provides price information
     #  @return (Price) price information
-    node_reader :price, ::Allorails::Price
+    node_reader :price, Allorails::Price
   
     ## Provides paid price information
     #  @return (Price) paid price information
-    node_reader :paid, ::Allorails::Price
+    node_reader :paid, Allorails::Price
   
     ## Provides the pricepoint's payout
     #  @return (Payout) pricepoint's payout
-    node_reader :payout, ::Allorails::Payout
+    node_reader :payout, Allorails::Payout
     
   end
       

data/lib/allorails/response/onetime_button_response.rb

@@ -0,0 +1,28 @@
+## Class defining a onetime button request's response
+class Allorails::Response::OnetimeButtonResponse < Allorails::Response::ApiMappingResponse
+
+  ## Provides access type
+  #  @return (string) access type
+  node_reader :access_type
+
+  ## Provides the button id
+  #  @return (string) button id
+  node_reader :button_id
+
+  ## Provides the creation date
+  #  @return (datetime.datetime) Creation date
+  node_reader :creation_date, DateTime
+
+  ## Provides the website
+  #  @return (Website) website
+  node_reader :website, Allorails::Website
+
+  ## Provides the buy url
+  #  @return (string) buy url
+  node_reader :buy_url
+
+  ## Provides the checkout button
+  #  @return (string) checkout button (html code)
+  node_reader :checkout_button
+
+end

data/lib/allorails/response/onetime_pricing_response.rb

@@ -0,0 +1,37 @@
+class Allorails::Response::OnetimePricingResponse < Allorails::Response::ApiMappingResponse
+
+  ## Provides the creation date
+  #  @return (DateTime) Creation date
+  node_reader :creation_date, DateTime
+
+  ## Provides the customer ip
+  #  @return (string) customer ip
+  node_reader :customer_ip
+
+  ## Provides the customer country
+  #  @return (string) customer country
+  node_reader :customer_country
+
+  ## Provides the website
+  #  @return (Website) website
+  node_reader :website, Allorails::Website
+
+  ## Provides the pricepoints by countries
+  #  @return (Array) available countries (list of Country object)
+  def countries
+    xml.css('countries country').map{|c| Allorails::Country.new(c)}
+  end
+
+  ## Provides the pricepoints by region
+  #  @return (Array) available regions (list of Regions object)
+  def regions
+    xml.css('countries region').map{|r| ::Allorails::Region.new(r)}
+  end
+
+  ## Provides the pricepoints by markets
+  #  @return (list) available markets (list of Market object)
+  def markets
+    xml.css('markets market').map{|m| Allorails::Market.new(m)}
+  end
+
+end