connect-stoopid 0.1.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2Q3NzU4MDVlMWY2ZjQ5MjU2ZjIwNjAzMzVlNDVhMjYwOTY4YzU0NA==
+  data.tar.gz: !binary |-
+    ZjAyMjIyMTRlOWIzZmMxNDE4MjIzNTQxNmUzOGEwZDAwM2VmMGY2MA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDU1NzcwYjM4NTU3ZTExMjU5NDI4OWIxZTk1YmU4ODUxYTRmMmNkYzc0NDEx
+    OTBmMjBiMDhkNDZhZjkwMzY5MWZmYWY0ZWU4ZDQwNDg4ZjQ2Nzg3MjBhM2Vj
+    YjY0YzgwOGRjZDQ3ZWI2NGZkY2RmODA2OWRiODI0YWE5NjdiYzA=
+  data.tar.gz: !binary |-
+    MzdmMWY3YzYyNTNkOGYwZGNjYTMxNjJkMjNkY2YwNWFjNWRiZWRmNGY3ZDdh
+    YzFmZTYxMmQ5MzA3YjhhYWU4NWMyMDhlMDBlN2ZiMThmOTMyYjMwYTliZTgy
+    ZDhkYTJiZThjN2NiNzhhMTEzMWVlYTBlYmYyZjZmZjRhMDM5NzQ=

data/lib/connect-stoopid.rb

@@ -0,0 +1,7 @@
+module ConnectStoopid
+	VERSION = "0.1.3"
+
+	require 'savon'
+	require 'rexml/document'
+	require 'connect-stoopid/reporting-client'
+end

data/lib/connect-stoopid/reporting-client.rb

@@ -0,0 +1,201 @@
+=begin
+	ConnectStoopid::ReportingClient
+	Provides an interface to the ConnectWise Reporting API
+=end
+
+module ConnectStoopid
+	class ReportingClient
+		
+		##
+		# 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
+		##
+		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
+
+		##
+		# 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", ...]}
+		##
+		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
+
+		##
+		# Parameters:
+		# 	options: Key value pairs to add to the Savon SOAP request
+		# 		For this request, options must include "reportName" => "Some_Report"
+		# Returns:
+		# 	[String]
+		##
+		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
+
+		##
+		# 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
+		##
+		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
+
+		##
+		# 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}]
+		##
+		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
+		LOG_LEVELS = {
+			:debug => 1,
+			:standard => 2,
+			:error => 3
+		}
+
+		def logging
+			return @client_options[:client_logging]
+		end
+
+		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
+
+		def base_soap_hash
+			request_options = {
+				"credentials" => {
+					"CompanyId" => @company,
+					"IntegratorLoginId" => @username,
+					"IntegratorPassword" => @password
+				}
+			}
+			return request_options
+		end
+	end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: connect-stoopid
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Josh Stump
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: Simple Ruby client handling access to the ConnectWise SOAP APIs
+email: websupport@bytesofknowledge.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./lib/connect-stoopid.rb
+- ./lib/connect-stoopid/reporting-client.rb
+homepage: https://github.com/bytesofknowledge/connect-stoopid
+licenses:
+- GPL-2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Run queries against the ConnectWise Reporting SOAP API
+test_files: []