class WebtrekkConnector

This class is a wrapper around the Webtrekk/Mapp Analytics JSON/RPC API.

Public Class Methods

new(conf) click to toggle source

Create an instance of WebtrekkConnector.

@param conf the configuration object for the connector @option conf [String] :endpoint the API endpoint, e.g. https://xyz.webtrekk.com/cgi-bin/wt/JSONRPC.cgi (required) @option conf [String] :user the user name to use with the API (required) @option conf [String] :pwd the password for :user (required) @option conf [String] :customerId the customer Id to used for all requests (optional).

If not set, the id of the first account retrieved via +getAccountList+ will be used.

@option conf [Logger] :logger the logging object to use for logging output (optional, defaults to +Logger.new(STDERR)+)

# File lib/webtrekk_connector.rb, line 19
def initialize(conf)
    @endpoint = conf[:endpoint]
    @user = conf[:user]
    @pwd = conf[:pwd]
    @customerId = conf[:customerId]
    @logger = conf[:logger] ? conf[:logger] : Logger.new(STDERR)
    @logger.info("Connector set up for #{@endpoint}.")
end

Public Instance Methods

call_method(method, params={}) click to toggle source

Call a method on the API.

@param method the method name @param params the method parameters

@return [Object] the response body converted to a Ruby object by calling +JSON.parse(response)+

# File lib/webtrekk_connector.rb, line 60
def call_method(method, params={})
    @logger.info("call_method: #{method}")
    payload = {
        :params => params ,
        :version => "1.1" ,
        :method => method
    }
    response = make_https_request(URI(@endpoint), payload)
    data = JSON.parse(response)
    data['result']
end

get_account_list() click to toggle source

Get the list of accounts associated with user.

@return [Array] the list of accounts

# File lib/webtrekk_connector.rb, line 105
def get_account_list
    params = {
        :login => @user,
        :pass => @pwd ,
    }
    response = call_method('getAccountList', params)
end

get_analysis_objects_and_metrics_list() click to toggle source

Call the getAnalysisObjectsAndMetricsList method.

@return [Hash] the response body as a Hash

# File lib/webtrekk_connector.rb, line 137
def get_analysis_objects_and_metrics_list
    params = {
        :token => @token
    }
    response = call_method("getAnalysisObjectsAndMetricsList", params)
end

get_connection_test() click to toggle source

Call the getConnectionTest method.

@return [Object] the response body as a Ruby object

# File lib/webtrekk_connector.rb, line 75
def get_connection_test
    response = call_method('getConnectionTest')
end

get_first_account() click to toggle source

Get the first account associated with user.

@return [Hash] the first account as a Hash

# File lib/webtrekk_connector.rb, line 116
def get_first_account
    account_list = get_account_list
    account_list.first
end

get_token() click to toggle source

Get a token from the API by calling the login method.

@return [String] the token returned by the API

# File lib/webtrekk_connector.rb, line 82
def get_token
    unless @customerId
        @customerId = self.get_first_account['customerId']
    end
    params = {
        :login => @user,
        :pass => @pwd ,
        :customerId => @customerId ,
        :language => "en"
    }
    response = call_method('login', params)
end

Log into the API by setting the token attribute.

@return [String] the token returned by the API

# File lib/webtrekk_connector.rb, line 98
def login
    @token = get_token
end

make_https_request(uri, payload=nil) click to toggle source

Send the actual HTTP(s) request.

@param uri where to send the request @param payload the payload to be sent, will be converted by calling payload.to_json

@return [String] the response body @raise [Net::HTTPError] if the response code is not 200

# File lib/webtrekk_connector.rb, line 35
def make_https_request(uri, payload=nil)
    @logger.info("sending request (method #{payload[:method]}) ...")
    Net::HTTP.start(uri.host, uri.port,
        :use_ssl => uri.scheme == 'https', 
        :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|

        request = Net::HTTP::Post.new(uri.request_uri)
        request.body = payload.to_json

        response = http.request(request)

        if response.code.eql?("200")
            return response.body
        else
            raise Net::HTTPError.new(response.code, response.message)
        end
    end
end

request_analysis(analysis_config) click to toggle source

Call the getAnalysisData method.

@param analysis_config the analysisConfig object as a Ruby Hash.

@return [Hash] the response body converted as a Hash

# File lib/webtrekk_connector.rb, line 126
def request_analysis(analysis_config)
    params = {
        :token => @token ,
        :analysisConfig => analysis_config
    }
    response = call_method("getAnalysisData", params)
end