webtrekk_connector 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b819a855afac8ba9abefaccf438506ed01fde548121ac78a7315d70d7559e3b
-  data.tar.gz: 59c47922b57c4530b20c40b0e7456926c27df94b6b9e7118e63863f8ff83ed9a
+  metadata.gz: 0a0994104ef677b582c381c9551c5e69810722c814ef10c700d4a3f8cff90f88
+  data.tar.gz: 753a1052acb21d43b3c1aa9fca32fac7eeb262df06f6d630687ccfa30d97b014
 SHA512:
-  metadata.gz: 95008b5939109ca8f7697f168757bcec605472acf2ea166f2b31dcebb371835c3fc03313b712f8ae0d18d385e73f9dbf0a83063f32e52f1880db9c4430ec5dbf
-  data.tar.gz: '082831f7230ec827ecb5ef97716f05631181a7f1a8687150fd362b184a03daa0f220cff04abe4acb7ef2b66691a199901ea2995c86ded8af098385c95e3922e3'
+  metadata.gz: 95c843b3abc88691ec607b5af66db42dc0ec1c4118f10818f2e53f1d6ac0735a4c5f88f996f86a3a38dc2550ffb9fb64d83e7f13b45af721bfc46163acce2291
+  data.tar.gz: 06f4e36e67b93eaad35952e6e1f0218d983ad183b30c3c5582a44092657c804c111bd55fc9d6d598a75ea57e200461a5069b5586b804cb47cb3ef2910ec8abca

data/lib/webtrekk_connector.rb

@@ -3,7 +3,19 @@ require 'openssl'
 require 'logger'
 require 'json'
 
+# This class is a wrapper around the Webtrekk/Mapp Analytics JSON/RPC API.
+
 class WebtrekkConnector
+
+    # Create an instance of WebtrekkConnector.
+    #
+    # @param conf[Hash] 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)+)
     def initialize(conf)
         @endpoint = conf[:endpoint]
         @user = conf[:user]
@@ -13,6 +25,13 @@ class WebtrekkConnector
         @logger.info("Connector set up for #{@endpoint}.")
     end
 
+    # Send the actual HTTP(s) request.
+    #
+    # @param uri[URI] where to send the request
+    # @param payload[Object] 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
     def make_https_request(uri, payload=nil)
         @logger.info("sending request (method #{payload[:method]}) ...")
         Net::HTTP.start(uri.host, uri.port,
@@ -32,6 +51,12 @@ class WebtrekkConnector
         end
     end
 
+    # Call a method on the API.
+    #
+    # @param method[String] the method name
+    # @param params[Hash] the method parameters
+    #
+    # @return [Object] the response body converted to a Ruby object by calling +JSON.parse(response)+
     def call_method(method, params={})
         @logger.info("call_method: #{method}")
         payload = {
@@ -44,10 +69,16 @@ class WebtrekkConnector
         data['result']
     end
 
+    # Call the +getConnectionTest+ method.
+    #
+    # @return [Object] the response body as a Ruby object
     def get_connection_test
         response = call_method('getConnectionTest')
     end
 
+    # Get a token from the API by calling the +login+ method.
+    #
+    # @return [String] the token returned by the API
     def get_token
         unless @customerId
             @customerId = self.get_first_account['customerId']
@@ -60,12 +91,17 @@ class WebtrekkConnector
         }
         response = call_method('login', params)
     end
-
-
+    
+    # Log into the API by setting the \@token attribute.
+    #
+    # @return [String] the token returned by the API
     def login
         @token = get_token
     end
 
+    # Get the list of accounts associated with \@user.
+    #
+    # @return [Array] the list of accounts
     def get_account_list
         params = {
             :login => @user,
@@ -74,11 +110,19 @@ class WebtrekkConnector
         response = call_method('getAccountList', params)
     end
 
+    # Get the first account associated with \@user.
+    #
+    # @return [Hash] the first account as a Hash
     def get_first_account
         account_list = get_account_list
         account_list.first
     end
 
+    # Call the +getAnalysisData+ method.
+    #
+    # @param analysis_config[Hash] the +analysisConfig+ object as a Ruby Hash.
+    #
+    # @return [Hash] the response body converted as a Hash
     def request_analysis(analysis_config)
         params = {
             :token => @token ,
@@ -87,6 +131,9 @@ class WebtrekkConnector
         response = call_method("getAnalysisData", params)
     end
 
+    # Call the +getAnalysisObjectsAndMetricsList+ method.
+    #
+    # @return [Hash] the response body as a Hash
     def get_analysis_objects_and_metrics_list
         params = {
             :token => @token

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webtrekk_connector
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Knud Möller
@@ -17,7 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/webtrekk_connector.rb
-homepage: https://rubygems.org/gems/webtrekk_connector
+homepage: https://github.com/berlinonline/webtrekk_connector
 licenses:
 - MIT
 metadata: {}