allorails 0.3.1

data/lib/allorails/request/request.rb

@@ -0,0 +1,284 @@
+require 'net/http'
+require 'cgi'
+require 'digest'
+
+module Allorails
+  module Request
+    
+    class ApiRequest
+
+      # API response format needed to provide response object mapping
+      MAPPING_FORMAT = 'json'
+      # API remote base path
+      API_PATH = '/rest'
+
+      ## Returns the remote path of the Allopass API service
+      #
+      #  @return (string) A remote path
+      def _path
+        self.class::PATH
+      end
+
+      # class of the Response
+      ## Returns an object mapping the Allopass API response
+      #
+      #  @param signature (string) Expected response signature
+      #  @param headers (list) Response HTTP headers
+      #  @param body (string) Raw response data 
+      #
+      #  @return ApiResponse An object mapping the Allopass API response
+      def _new_response(signature, headers, body)
+        raise "new_response is not implemented"
+      end
+
+      ## Constructor
+      #
+      #  @param parameters (array) Parameters to the API call
+      #  @param mapping (boolean) Wether to return a raw response or an object
+      #  @param emailAccount (string) Configurated email account
+      def initialize(parameters, mapping = true, email_account = nil)
+        @_mapping = mapping
+        @_parameters = parameters
+        @_email_account = email_account
+      end
+
+      ## Call the Allopass API and returns the response (raw or object)
+      #
+      #  @return ApiResponse The API response
+      def call()
+        headers, body = self._build_parameters._sign._call
+        signature = self._hash(body + Allorails.config.private_key(@_email_account))
+
+        if (@_mapping)
+          return self._new_response(signature, headers, body)
+        else
+          return Allorails::Response::ApiResponse.new(signature, headers, body)
+        end
+      end
+
+      ## Internal method building special required API parameters
+      #
+      #  @return ApiRequest Class instance for chaining purpose
+      def _build_parameters
+        formats = ['json', 'xml']
+
+        @_parameters.update({
+          'api_ts' => Time.now.to_i,
+          'api_key' => Allorails.config.api_key(@_email_account),
+          'api_hash' => Allorails.config.default_hash
+        })
+
+        if @_parameters.has_key?('format')
+          if (@_mapping)
+            @_parameters['format'] = self::MAPPING_FORMAT
+          elsif !formats.include?(@_parameters['format'])
+            @_parameters['format'] = Allorails.config.default_format
+          end
+        else
+          @_parameters['format'] = Allorails.config.default_format
+        end
+
+        self
+      end
+
+      ## Internal methods used to sign the request call
+      #
+      #  @return ApiRequest Class instance for chaining purpose
+      def _sign
+        params = @_parameters.dup
+        
+        if params.has_key?('code')
+          params['code'] = params['code'].join
+        end
+        
+        sign = params.sort.map{|p| "#{p[0]}#{p[1]}"}.join
+        @_parameters['api_sig'] = self._hash(sign + Allorails.config.private_key(@_email_account))
+        
+        self
+      end
+
+      ## Internal method hashing data with defined cipher #TODO en prenant en compte la donnée incrite dans les confs
+      #
+      #  @parameter data (string) Data to hash
+      #
+      #  @throws ApiMissingHashFeatureError If defined cipher method isn'h available
+      def _hash(data)
+        ::Digest::SHA1.hexdigest(data)
+      end
+
+      ## Internal method deciding wether to use a POST request
+      #
+      #  @return (boolean) True to use POST
+      def _is_http_post
+        false
+      end
+
+      ## Internal method calling the Allopass API
+      #
+      #  @return (tuple) Pair containing response headers and body
+      def _call
+        protocol = Allorails.config.network_protocol
+        server   = Allorails.config.host
+        timeout  = Allorails.config.network_timeout.to_f
+
+        port    = protocol == 'https' ? 443 : 80
+        uri     = URI(protocol + '://' + server + ApiRequest::API_PATH + _path)
+        method  = _is_http_post ? 'POST' : 'GET'
+        headers = {
+          "Content-Type" => "application/x-www-form-urlencoded; charset=utf-8",
+          "User-Agent" => "Allopass-ApiKit-AlloRails"
+        }
+        
+        # use a proxy?
+        use_proxy = false
+        http_class = if use_proxy then Net::HTTP::Proxy('127.0.0.1', 9999) else Net::HTTP end
+
+        # prepare and send HTTP request
+        http_class.start(uri.host, port, :use_ssl => uri.scheme == 'https') do |http|
+          
+          if method == 'GET'
+            uri.query = _encode_parameters
+            req = http_class::Get.new uri.request_uri
+          else
+            #uri.query = _encode_parameters
+            req = http_class::Post.new uri.request_uri
+            req.body = _encode_parameters
+          end    
+          
+          # set headers
+          headers.each_pair{|k, v| req[k] = v}
+          
+          # send the request and see if successful
+          case res = http.request(req)
+            when Net::HTTPSuccess then return [res.to_hash, res.body]
+            else raise Allorails::ApiUnavailableResourceError, "Request failed: #{res.body}"
+          end
+        end
+      end
+
+      ## Internal method encoding request paramters
+      #
+      #  @return (string) Encoded request parameters
+      def _encode_parameters
+        params = @_parameters.dup
+        # The Allopass API expects an array of codes encoded
+        # in a slightly different matter than urlencode does
+        if params.has_key?('code')
+          codes = params.delete('code')
+          hash_codes = Hash[[0..codes.length-1].map{|i| ["code[#{i}]",codes[i]]}]
+          params = params.merge(hash_codes)          
+        end
+        
+        URI::encode params.collect { |k,v| "#{k}=#{v}" }.join('&') #CGI::escape(v.to_s)
+      end
+    
+    end # -- end class ApiRequest
+    
+    
+    ## Class providing a onetime pricing API request
+    class OnetimePricingRequest < ApiRequest
+      PATH = '/onetime/pricing'
+      
+      def _new_response(signature, headers, body)
+        Allorails::Response::OnetimePricingResponse.new(signature, headers, body)
+      end
+    end
+    
+    
+    ## Class providing a onetime dicrete pricing API request
+    class OnetimeDiscretePricingRequest < ApiRequest
+      PATH = '/onetime/discrete-pricing'
+      
+      def _new_response(signature, headers, body)
+        Allorails::Response::OnetimePricingResponse.new(signature, headers, body)
+      end
+    end
+    
+    
+    ## Class providing a onetime validate codes API request
+    class OnetimeValidateCodesRequest < ApiRequest
+      PATH = '/onetime/validate-codes'
+      
+      def _is_http_post
+        true
+      end
+      
+      def _new_response(signature, headers, body)
+        Allorails::Response::OnetimeValidateCodesResponse.new(signature, headers, body)
+      end
+    end
+    
+    
+    ## Class providing a product detail API request
+    class ProductDetailRequest < ApiRequest
+      PATH = '/product'
+      
+      def _new_response(signature, headers, body)
+        Allorails::Response::ProductDetailResponse.new(signature, headers, body)
+      end
+    end
+    
+    
+    ## Class providing a transaction prepare API request
+    class TransactionPrepareRequest < ApiRequest
+      PATH = '/transaction/prepare'
+      
+      def _is_http_post
+        true
+      end
+      
+      def _new_response(signature, headers, body)
+        Allorails::Response::TransactionPrepareResponse.new(signature, headers, body)
+      end
+    end
+    
+    
+    ## Class providing a transaction detail API request
+    class TransactionDetailRequest < ApiRequest
+      PATH = '/transaction'
+      
+      def _new_response(signature, headers, body)
+        Allorails::Response::TransactionDetailResponse.new(signature, headers, body)
+      end
+    end
+    
+    
+    ## Class providing a transaction detail from merchant transaction id API request
+    class TransactionMerchantRequest < ApiRequest
+      PATH = '/transaction/merchant'
+      
+      def _new_response(signature, headers, body)
+        Allorails::Response::TransactionDetailResponse.new(signature, headers, body)
+      end
+    end
+    
+    
+    ## Class providing a onetime button API request
+    class OnetimeButtonRequest < ApiRequest
+      PATH = '/onetime/button'
+      
+      def _is_http_post
+        true
+      end
+      
+      def _new_response(signature, headers, body)
+        Allorails::Response::OnetimeButtonResponse.new(signature, headers, body)
+      end
+    end
+    
+    
+    ## Class providing a onetime discrete button API request
+    class OnetimeDiscreteButtonRequest < ApiRequest
+      PATH = '/onetime/discrete-button'
+      
+      def _is_http_post
+        true
+      end
+      
+      def _new_response(signature, headers, body)
+        Allorails::Response::OnetimeButtonResponse.new(signature, headers, body)
+      end
+    end
+    
+  end
+end

data/lib/allorails/response/model.rb

@@ -0,0 +1,278 @@
+module Allorails
+
+
+  ## Basis for the models used in the Apikit object responses
+  # extends ApiMappingResponse to inherit the node_reader helper
+  class Base < Allorails::Response::ApiMappingResponse 
+    
+    def initialize(node)
+      @json = node
+    end
+    
+  end
+
+  
+  ## Class providing object mapping of a website item 
+  class Website < Base
+  
+    ## Provides the website id
+    #  @return (int) website id
+    node_reader :id, Integer
+  
+    ## Provides the website name
+    #  @return (string) website name
+    node_reader :name
+  
+    ## Provides the website url
+    #  @return (string) website url
+    node_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'
+    end
+  
+    ## Provides the website category
+    #  @return (string) website category
+    node_reader :category
+
+  end
+  
+  
+  ## Class providing object mapping of a country item 
+  class Country < Base
+  
+    ## Provides the country code
+    #  @return (string) country code (two characters)
+    node_reader :code
+  
+    ## Provides the country name
+    #  @return (string) country name
+    node_reader :name
+    
+  end
+  
+  
+  ## Class providing object mapping of a region item 
+  class Region < Base
+  
+    ## Provides the region name
+    #  @return (string) region name
+    node_reader :name
+  
+    ## Provides the countries in the region
+    #  @return (Array) region's countries
+    def countries
+      json.children.values.map{|c| ::Allorails::Country.new(c)}
+    end
+  
+  end
+  
+  
+  ## Class providing object mapping of a market item
+  class Market < Base
+  
+    ## Provides the country code
+    #  @return (string) country code (two characters)
+    node_reader :country_code
+  
+    ## Provides the country name
+    #  @return (string) country name
+    node_reader :country
+  
+    ## Provides the pricepoints available in this market
+    #  @return (Array) available pricepoints (list of Pricepoint objects)
+    def pricepoints
+      json.children.values.map{|c| ::Allorails::Pricepoint.new(c)}
+    end
+    
+  end
+
+
+  ## Class providing object mapping of a price item
+  class Price < Base
+  
+    ## Provides the currency
+    #  @return (string) currency (three characters)
+    node_reader :currency
+  
+    ## Provides the amount
+    #  @return (float) amount
+    node_reader :currency, Float
+  
+    ## Provides the day's exchange rate
+    #  @return (float) exchange rate
+    node_reader :exchange, Float
+  
+    ## Provides the reference currency
+    #  @return (string) reference currency
+    node_reader :reference_currency
+  
+    ## Provides the amount in the reference currency
+    #  @return (float) reference amount
+    node_reader :reference_amount, Float
+
+  end
+  
+  ## Class providing object mapping of a payout item
+  class Payout < Base
+  
+    ## Provides the currency
+    #  @return (string) currency (three characters)
+    node_reader :currency
+  
+    ## Provides the amount
+    #  @return (float) amount
+    node_reader :amount, Float
+  
+    ## Provides the day's exchange rate
+    #  @return (float) exchange rate
+    node_reader :exchange, Float
+  
+    ## Provides the reference currency
+    #  @return (string) reference currency
+    node_reader :reference_currency
+  
+    ## Provides the amount in the reference currency
+    #  @return (float) reference amount
+    node_reader :reference_amount, Float
+  
+  end
+  
+  
+  ## Class providing object mapping of a phone number item
+  class PhoneNumber < Base
+  
+    ## Provides the phone number
+    #  @return (string) phone number
+    node_reader :value
+  
+    ## Provides the description of the phone number
+    #  @return (string) description
+    node_reader :description
+    
+  end
+  
+  
+  ## Class providing object mapping of a keyword item
+  class Keyword < Base
+  
+    ## Provides the keyword name
+    #  @return (string) keyword name
+    node_reader :name
+  
+    ## Provides the keyword's shortcode
+    #  @return (string) shortcode
+    node_reader :shortcode
+  
+    ## Provides the keyword operators
+    #  @return (string) keyword operators
+    node_reader :operators
+  
+    ## Provides the number of billed messages of the keyword
+    #  @return (int) number of billed messages
+    node_reader :number_billed_messages, Integer
+  
+    ## Provides a description of the keyword
+    #  @return (string) description
+    node_reader :description
+    
+  end
+  
+  
+  ## Class providing object mapping of a pricepoint item
+  class Pricepoint < Base
+  
+    ## Provides the pricepoint's id
+    #  @return (int) pricepoint id
+    node_reader :id, Integer
+  
+    ## Provides the pricepoint's type
+    #  @return (string) pricepoint type
+    node_reader :type
+  
+    ## Provides the pricepoint's country code
+    #  @return (string) country code (two characters)
+    node_reader :country_code
+  
+    ## Provides price information
+    #  @return (Price) price information
+    node_reader :price, ::Allorails::Price
+  
+    ## Provides the pricepoint's payout
+    #  @return (Payout) pricepoint's payout
+    node_reader :payout, ::Allorails::Payout
+  
+    ## Provides the buy url
+    #  @return (string) buy url
+    node_reader :buy_url
+  
+    ## 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)}
+    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)}
+    end
+  
+    ## Provides the pricepoint's description
+    #  @return (string) pricepoint's description
+    node_reader :description
+  
+  end
+  
+  
+  ## Class providing object mapping of a partner item
+  class Partner < Base
+  
+    ## Provides the partner id
+    #  @return (int) partner id
+    node_reader :id, Integer
+  
+    ## Provides the parnter's amount share
+    #  @return (float) parnter's amount share
+    node_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
+    end
+    
+  end
+  
+  
+  ## Class providing object mapping of a code item
+  class Code < Base
+  
+    ## Provides the code value
+    #  @return (string) code
+    node_reader :value
+  
+    ## Provides the pricepoint's description
+    #  @return (string) pricepoint's description
+    node_reader :pricepoint, ::Allorails::Pricepoint
+  
+    ## 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 pricepoint's payout
+    #  @return (Payout) pricepoint's payout
+    node_reader :payout, ::Allorails::Payout
+    
+  end
+      
+end