allorails 0.3.1

data/lib/allorails/response/response.rb

@@ -0,0 +1,448 @@
+require 'net/http'
+require 'json'
+
+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
+        raise Allorails::ApiFalseResponseSignatureError unless @_headers['x-allopass-response-signature'].include?(@_signature)
+      end
+      
+      ## Custom print result
+      def to_s
+        @_body
+      end
+    
+    end # -- end class ApiResponse
+    
+    
+    class JsonNode
+      
+      attr_reader :children
+      attr_reader :attributes
+      
+      def initialize(json_obj)
+        @attributes = json_obj.delete('@attributes') || {}
+        @children = {}
+        json_obj.each_pair do |k, v|
+          @children[k] = v.is_a?(Hash) ? JsonNode.new(v) : (v.is_a?(Array) ? v.map{|el| JsonNode.new(el)} : v)
+        end
+      end
+      
+      def method_missing(m, *args, &block)
+        m = m.to_s
+        return attributes[m] if attributes.has_key?(m)
+        return children[m] if children.has_key?(m)
+        return nil
+      end
+      
+    end
+    
+    
+    class ApiMappingResponse < ApiResponse
+      
+      attr_reader :json
+      
+      ##
+      # 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)
+        begin
+          @json = JsonNode.new(JSON.parse(body)['response'] || {})
+        rescue JSON::ParserError => e
+          raise Allorails::ApiWrongFormatResponseError
+        end
+        _verify
+      end
+      
+      ##
+      # Internal method checking the response
+      # @throws ApiFalseResponseSignature If the expected signature is not found among response headers
+      def _verify
+        if json.code.nil? || json.code.to_i != 0
+          raise Allorails::ApiRemoteErrorError
+        end
+        super
+      end
+      
+      ##
+      # Internal method allowing easy reading of JSON nodes
+      #  @param (sym) name of the (top-level) 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
+        cast = case true
+          when type == String then Proc.new{|x| x.to_s}
+          when type == Integer then Proc.new{|x| x.to_i}
+          when type == Float then Proc.new{|x| to_f}
+          when type == DateTime then Proc.new{|x| x.date.nil? ? (x.timestamp.nil? ? nil : DateTime.strptime(x.timestamp, "%s")) : DateTime.strptime(x.date)}
+          else Proc.new{|x| type.new x}
+        end
+        # add a method accessing the node and casting the text
+        send :define_method, node_name do
+          result = json.send(node_name)
+          return cast.call(result) unless result.nil?
+        end
+      end
+      
+    end
+    
+    
+    class OnetimePricingResponse < 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
+    
+      ## Provides the pricepoints by countries
+      #  @return (Array) available countries (list of Country object)
+      def countries
+        countries = []
+        json.countries.children.values.each{|r| countries += r.children.values.map{|c| ::Allorails::Country.new(c)}}
+        countries
+      end
+    
+      ## Provides the pricepoints by region
+      #  @return (Array) available regions (list of Regions object)
+      def regions
+        json.countries.children.values.map{|r| ::Allorails::Region.new(r)}
+      end
+    
+      ## Provides the pricepoints by markets
+      #  @return (list) available markets (list of Market object)
+      def markets
+        json.markets.children.values.map{|m| ::Allorails::Market.new(m)}
+      end
+
+    end
+    
+    
+    ## Class defining a onetime validate-codes request's response
+    class OnetimeValidateCodesResponse < ApiMappingResponse
+      ## The validation is successful
+      VALIDATESCODES_SUCCESS = 0
+    
+      ## The validation failed
+      VALIDATESCODES_FAILED = 1
+    
+      ## Provides the validation status
+      #  @return (int) validation status
+      node_reader :status, Integer
+    
+      ## Provides the validation status description
+      #  @return (string) validation status description
+      node_reader :status_description
+    
+      ## Provides access type
+      #  @return (string) access type
+      node_reader :access_type
+    
+      ## Provides the transaction id
+      #  @return (string) transaction id
+      node_reader :transaction_id
+    
+      ## Provides price information
+      #  @return (Price) price information
+      node_reader :price, ::Allorails::Price
+    
+      ## Provides paid price information
+      #  @return (Price) paid price information
+      node_reader :paid, ::Allorails::Price
+    
+      ## Provides the validation date
+      #  @return (datetime.datetime) validation date
+      node_reader :validation_date, DateTime
+    
+      ## Provides the product name
+      #  @return (string) product name
+      node_reader :product_name
+    
+      ## Provides the website
+      #  @return (Website) website
+      node_reader :website
+    
+      ## 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 expected number of codes
+      #  @return (int) expected number of codes
+      node_reader :expected_number_of_codes, Integer
+    
+      ## Provides the codes you tried to validate
+      #  @return (Array) list of Code objects
+      def codes
+        json.codes.children.values.map{|c| ::Allorails::Code.new(c)}
+      end
+    
+      ## Provides the merchant transaction id
+      #  @return (string) merchant transaction id
+      node_reader :merchant_transaction_id
+    
+      ## Provides the client data
+      #  @return (string) client data
+      node_reader :data
+    
+      ## Provides the affiliation code
+      #  @return (string) affiliation code
+      node_reader :affiliate
+    
+      ## Provides information about the associated partners
+      #  @return (list) partners information (list of Partner objects)
+      def partners
+        json.partners.children.values.map{|c| ::Allorails::Partner.new(c)}
+      end
+
+    end
+  
+  
+    ## Class defining a product detail request's response
+    class ProductDetailResponse < ApiMappingResponse
+    
+      ## Provides the product id
+      #  @return (int) product id
+      node_reader :id, Integer
+    
+      ## Provides the product key
+      #  @return (string) product key
+      node_reader :key
+    
+      ## Provides access type
+      #  @return (string) access type
+      node_reader :access_type
+    
+      ## Provides the creation date
+      #  @return (datetime.datetime) Creation date
+      node_reader :creation_date, DateTime
+    
+      ## Provides the product name
+      #  @return (string) product name
+      node_reader :name
+    
+      ## Provides the website
+      #  @return (Website) website
+      node_reader :website
+    
+      ## Provides the expected number of codes
+      #  @return (int) expected number of codes
+      node_reader :expected_number_of_codes, Integer
+    
+      ## Provides the purchase url
+      #  @return (string) purchase url
+      node_reader :purchase_url
+    
+      ## Provides the forward url
+      #  @return (string) forward url
+      node_reader :forward_url
+    
+      ## Provides the error url
+      #  @return (string) error url
+      node_reader :error_url
+    
+      ## Provides the notification url
+      #  @return (string) notification url
+      node_reader :notification_url
+    
+    end
+    
+    
+    ## Class defining a transaction prepare request's response
+    class TransactionPrepareResponse < ApiMappingResponse
+    
+      ## Provides access type
+      #  @return (string) access type
+      node_reader :access_type
+    
+      ## Provides the transaction id
+      #  @return (string) transaction id
+      node_reader :transaction_id
+    
+      ## Provides the creation date
+      #  @return (datetime.datetime) Creation date
+      node_reader :creation_date, DateTime
+    
+      ## Provides price information
+      #  @return (Price) price information
+      node_reader :price, ::Allorails::Price
+    
+      ## Provides information about the pricepoint
+      #  @return (Pricepoint) pricepoint information
+      node_reader :pricepoint, ::Allorails::Pricepoint
+    
+      ## Provides the website
+      #  @return (Website) website
+      node_reader :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
+    
+    
+    ## Class defining a transaction detail request's response
+    class TransactionDetailResponse < ApiMappingResponse
+    
+      ## The transaction is at first step : initialization
+      INIT = -1
+    
+      ## The transaction is successful
+      SUCCESS = 0
+    
+      ## The transaction failed due to insufficient funds
+      INSUFFICIENT_FUNDS = 1
+    
+      ## The transaction timeouted
+      TIMEOUT = 2
+    
+      ## The transaction has been cancelled by user
+      CANCELLED = 3
+    
+      ## The transaction has been blocked due to fraud suspicions
+      ANTI_FRAUD = 4
+    
+      ## Provides the transaction status
+      #  @return (int) transaction status
+      node_reader :status, Integer
+    
+      ## Provides the validation status description
+      #  @return (string) validation status description
+      node_reader :status_description
+    
+      ## Provides access type
+      #  @return (string) access type
+      node_reader :access_type
+    
+      ## Provides the tansaction id
+      #  @return (string) transaction id
+      node_reader :transaction_id
+    
+      ## Provides price information
+      #  @return (Price) price information
+      node_reader :price, ::Allorails::Price
+    
+      ## Provides paid price information
+      #  @return (Price) paid price information
+      node_reader :paid, ::Allorails::Price
+    
+      ## Provides the creation date
+      #  @return (datetime.datetime) Creation date
+      node_reader :creation_date, DateTime
+    
+      ## Provides the end date
+      #  @return (datetime.datetime) end date
+      node_reader :end_date, DateTime
+    
+      ## Provides the product name
+      #  @return (string) product name
+      node_reader :product_name
+    
+      ## 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 expected number of codes
+      #  @return (int) expected number of codes
+      node_reader :expected_number_of_codes, Integer
+    
+      ## Provides the codes associated with the transaction
+      #  @return (list) list of codes (list of string)
+      def codes
+        json.codes.children.values.map{|c| ::Allorails::Code.new(c)}
+      end
+    
+      ## Provides the merchant transaction id
+      #  @return (string) merchant transaction id
+      node_reader :merchant_transaction_id
+    
+      ## Provides the client data
+      #  @return (string) client data
+      node_reader :data
+    
+      ## Provides the affiliation code
+      #  @return (string) affiliation code
+      node_reader :affiliate
+    
+      ## Provides information about the associated partners
+      #  @return (list) partners information (list of Partner objects)
+      def partners
+        json.partners.children.values.map{|c| ::Allorails::Partner.new(c)}
+      end
+    
+    end
+    
+    
+    ## Class defining a onetime button request's response
+    class OnetimeButtonResponse < 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, 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
+    
+  end #-- end module Allorails::Response
+end #-- end module Allorails

data/lib/allorails.rb

@@ -0,0 +1,51 @@
+require 'allorails/core'
+
+require 'allorails/errors/errors'
+
+module Allorails
+  
+  #autoload :Conf, 'allorails/conf'
+  autoload :Api, 'allorails/api/api'
+  
+  #def self.Conf
+  #  Allorails::Conf.instance
+  #end
+
+  autoload :Website, 'allorails/response/model'
+  autoload :Country, 'allorails/response/model'
+  autoload :Region, 'allorails/response/model'
+  autoload :Market, 'allorails/response/model'
+  autoload :Pricepoint, 'allorails/response/model'
+  autoload :Price, 'allorails/response/model'
+  autoload :Payout, 'allorails/response/model'
+  autoload :PhoneNumber, 'allorails/response/model'
+  autoload :Keyword, 'allorails/response/model'
+  autoload :Partner, 'allorails/response/model'
+  autoload :Code, 'allorails/response/model'
+  
+  module Request
+    autoload :ApiRequest, 'allorails/request/request'
+    autoload :OnetimePricingRequest, 'allorails/request/request'
+    autoload :OnetimeDiscretePricingRequest, 'allorails/request/request'
+    autoload :OnetimeValidateCodesRequest, 'allorails/request/request'
+    autoload :ProductDetailRequest, 'allorails/request/request'
+    autoload :TransactionPrepareRequest, 'allorails/request/request'
+    autoload :TransactionDetailRequest, 'allorails/request/request'
+    autoload :TransactionMerchantRequest, 'allorails/request/request'
+    autoload :OnetimeButtonRequest, 'allorails/request/request'
+    autoload :OnetimeDiscreteButtonRequest, 'allorails/request/request'
+  end
+
+  module Response
+    autoload :ApiResponse, 'allorails/response/response'
+    autoload :OnetimePricingResponse, 'allorails/response/response'
+    autoload :OnetimeValidateCodesResponse, 'allorails/response/response'
+    autoload :ProductDetailResponse, 'allorails/response/response'
+    autoload :TransactionPrepareResponse, 'allorails/response/response'
+    autoload :TransactionDetailResponse, 'allorails/response/response'
+    autoload :OnetimeButtonResponse, 'allorails/response/response'
+  end
+  
+end
+
+require 'allorails/rails'

data/test/allorails_spec.rb

@@ -0,0 +1,69 @@
+require 'allorails'
+require 'yaml'
+
+# load Allorails configuration options for testing
+#
+# to be able to run these tests, create a test/test-conf.yml file,
+# based on test/test-conf-sample.yml
+# but using your own API credentials
+Allorails.config(YAML.load File.read(File.join(File.dirname(__FILE__), 'test-conf.yml')))
+
+
+# some additional parameters for the tests
+YOUR_SITE_ID = 281629
+TEST_COUNTRY_CODE = 'UK'
+
+
+# run the tests
+
+describe Allorails::Request::ApiRequest, "#init" do
+  it "starts" do
+    req = Allorails::Request::ApiRequest.new(params = {}, mapping = true, email_account = nil)
+    req.should_not be_nil
+  end
+end
+
+describe Allorails::Api, "#init" do
+  it "initializes with email=nil" do
+    api = Allorails::Api.new
+  end
+end
+
+describe Allorails::Api, "#get_onetime_pricing" do
+  api = Allorails::Api.new
+  resp = api.get_onetime_pricing({'site_id' => YOUR_SITE_ID, 'country' => TEST_COUNTRY_CODE})
+  it "returns a valid response" do
+    resp.to_s.should_not be_nil
+    resp.creation_date.is_a?(DateTime).should be_true
+    resp.regions.is_a?(Array).should be_true
+    resp.regions.each do |reg|
+      reg.is_a?(Allorails::Region).should be_true
+      reg.countries.is_a?(Array).should be_true
+      reg.countries.each do |ctry|
+        ctry.is_a?(Allorails::Country).should be_true
+        (ctry.code.length > 0).should be_true
+      end
+    end
+  end
+end
+
+describe Allorails::Api, "#create_discrete_button" do
+  api = Allorails::Api.new
+  resp = api.create_discrete_button({
+    'site_id' => YOUR_SITE_ID,
+    'product_name' => 'TEST-DISCRETE-BUTTON',
+    'forward_url' => 'http://any-test.url/is?good',
+    'price_mode' => 'price',
+    'amount' => 0.99,
+    'price_policy' => 'high-preferred',
+    'reference_currency' => 'EUR'
+  })
+  it "returns a valid response" do
+    resp.to_s.should_not be_nil
+    resp.is_a?(Allorails::Response::OnetimeButtonResponse).should be_true
+    (resp.json).should_not be_nil
+    # puts resp.json.inspect #DEBUG
+    resp.button_id.should_not be_nil
+    resp.website.is_a?(Allorails::Website).should be_true
+  end
+end

data/test/test-conf-sample.yml

@@ -0,0 +1,11 @@
+accounts:
+  your@email.com:
+    api_key: 9696ba35ebb3dc6c11c964c269f262a6
+    private_key: 50372be654ecacf9dbb1b431535f21d0
+
+default_hash: sha1
+default_format: json
+network_timeout: 20
+network_protocol: http
+network_port: 80
+host: pgeoffroy.api.payment.allopass.dev

data/test/test-conf.yml

@@ -0,0 +1,12 @@
+accounts:
+  jonathan@feeligo.com:
+    api_key: d33102f78bea414ed098e5cd0bf17632
+    private_key: 2670c0094d163a718ea44f5459114301 
+      
+
+default_hash: sha1
+default_format: json
+network_timeout: 20
+network_protocol: http
+network_port: 80
+host: api.allopass.com

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: allorails
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+  prerelease: 
+platform: ruby
+authors:
+- Davide Bonapersona
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-08 00:00:00.000000000 Z
+dependencies: []
+description: Ruby client for the Allopass online payment REST API
+email: davide@feeligo.com
+executables: []
+extensions: []
+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
+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
+homepage: http://github.com/davb/allorails
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Allorails
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: allorails
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Ruby client for the Allopass online payment REST API
+test_files: []