class ConnectStoopid::ReportingClient
Constants
- LOG_LEVELS
Public Class Methods
new(psa_address, company, username, password, options = {})
click to toggle source
Parameters:
psa_address -- The hostname of your ConnectWise PSA, ie. con.companyconnect.net company -- Company id used when logging into ConnectWise username -- ConnectWise Integration username password -- ConnectWise Integration password options -- Override the default ReportingClient options
# File lib/connect-stoopid/reporting-client.rb, line 17 def initialize(psa_address, company, username, password, options = {}) @wsdl = "https://#{psa_address}/v4_6_release/apis/1.5/ReportingApi.asmx?wsdl" @company = company @username = username @password = password @client_options = { :client_logging => true, :client_logging_level => :error, :soap_version => 2, :soap_logging => false, :soap_logging_level => :fatal } @client_options.merge!(options) @soap_client = Savon.client({ :wsdl => @wsdl, :soap_version => @client_options[:soap_version], :log => @client_options[:soap_logging], :log_level => @client_options[:soap_logging_level] }) end
Public Instance Methods
get_all_report_fields(options = {})
click to toggle source
Parameters:
options: Key value pairs to add to the Savon SOAP request For this request, options must include "reportName" => "Some_Report"
Returns:
[String]
# File lib/connect-stoopid/reporting-client.rb, line 89 def get_all_report_fields(options = {}) log_client_message("Getting list of available fields for a given report type", :debug) request_options = base_soap_hash request_options.merge!(options) begin response = @soap_client.call(:get_report_fields, :message => request_options) rescue Savon::SOAPFault => error log_client_message("SOAP Fault\nError Message:\n#{error}", :error) else if response.success? report_fields = [] xml_doc = REXML::Document.new(response.to_xml) REXML::XPath.each(xml_doc, "//FieldInfo") do |field| report_fields << field.attributes["Name"].to_s end return report_fields.sort end end end
get_all_report_types(options = {"includeFields" => "false"})
click to toggle source
Parameters:
options: Key value pairs to add to the Savon SOAP request For this request, options must include "includeFields" => "true" (or "false") Defaults to "includeFields" => "false"
Returns:
If the "includeFields" option is set to "false", returns an array of strings containing all report names in alphabetical order If set to "true", returns an array of hashes of format {:report_name => "Activity", :fields => ["field1", "field2", ...]}
# File lib/connect-stoopid/reporting-client.rb, line 49 def get_all_report_types(options = {"includeFields" => "false"}) log_client_message("Getting list of report types", :debug) request_options = base_soap_hash request_options.merge!(options) begin response = @soap_client.call(:get_reports, :message => request_options) rescue Savon::SOAPFault => error log_client_message("SOAP Fault\nError Message:\n#{error}", :error) else if response.success? report_types = [] xml_doc = REXML::Document.new(response.to_xml) if options["includeFields"] == "false" REXML::XPath.each(xml_doc, "//Report") do |report| report_types << report.attributes["Name"].to_s end return report_types.sort elsif options["includeFields"] == "true" REXML::XPath.each(xml_doc, "//Report") do |report| report_fields = [] REXML::XPath.each(report, "Field") do |field| report_fields << field.attributes["Name"].to_s end report_types << {:report_name => report.attributes["Name"], :fields => report_fields} end return report_types.sort_by! {|x| x[:report_name]} end end end end
run_report_count(options = {})
click to toggle source
Parameters:
options: Key value pairs to add to the Savon SOAP request For this request, options must include "reportName" => "Some_Report", and should probably include "conditions" => "some condition set"
Returns:
Integer
# File lib/connect-stoopid/reporting-client.rb, line 119 def run_report_count(options = {}) log_client_message("Getting a count of records per a set of conditions", :debug) request_options = base_soap_hash request_options.merge!(options) begin response = @soap_client.call(:run_report_count, :message => request_options) rescue Savon::SOAPFault => error log_client_message("SOAP Fault\nError Message:\n#{error}", :error) else if response.success? xml_doc = REXML::Document.new(response.to_xml) return REXML::XPath.first(xml_doc, "//RunReportCountResult").text.to_i end end end
run_report_query(options = {})
click to toggle source
Parameters:
options: Key value pairs to add to the Savon SOAP request For this request, options must include "reportName" => "Some_Report", and should probably (read: definitely) include "conditions" => "some condition set"
Returns:
[{field1 => value1, field2 => value2}]
# File lib/connect-stoopid/reporting-client.rb, line 145 def run_report_query(options = {}) log_client_message("Running full query per a set of conditions", :debug) request_options = base_soap_hash request_options.merge!(options) begin response = @soap_client.call(:run_report_query, :message => request_options) rescue Savon::SOAPFault => error log_client_message("SOAP Fault\nError Message:\n#{error}", :error) else if response.success? xml_doc = REXML::Document.new(response.to_xml) rows = [] REXML::XPath.each(xml_doc, "//ResultRow") do |row| row_key_vals = {} REXML::XPath.each(row, "Value") do |col| row_key_vals[col.attributes["Name"].to_s] = col.text.to_s end rows << row_key_vals end return rows end end end
Private Instance Methods
base_soap_hash()
click to toggle source
# File lib/connect-stoopid/reporting-client.rb, line 190 def base_soap_hash request_options = { "credentials" => { "CompanyId" => @company, "IntegratorLoginId" => @username, "IntegratorPassword" => @password } } return request_options end
log_client_message(message, level = :error)
click to toggle source
# File lib/connect-stoopid/reporting-client.rb, line 182 def log_client_message(message, level = :error) if logging if LOG_LEVELS[level] >= LOG_LEVELS[@client_options[:client_logging_level]] puts "#{self.class.to_s.split("::").last} Logger -- #{message}" end end end
logging()
click to toggle source
# File lib/connect-stoopid/reporting-client.rb, line 178 def logging return @client_options[:client_logging] end