connect-stoopid 0.1.3 → 0.1.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!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=
+SHA1:
+  metadata.gz: e3ad83e5c20885435d1a49cccf9f79ad6458fdd1
+  data.tar.gz: 5480f53f59e1859b1ef065d517223e1d4092bb3c
+SHA512:
+  metadata.gz: 336ff88d78aaf947c83388144311cc9dcde6c8aa203bb5840319ae158756b76c28605403d2e455ab56e94649169800986fef0c954549b2bfda7bc83324eff54c
+  data.tar.gz: 8b1d2cc42d80c42a60616707e44b4473ade6061da8995ff5eaef4aeafaebbab369eb16f8828d365ad8661a271870bcd8974002a2ebbf42b1449b056fce9d6bf3

data/lib/connect-stoopid.rb

@@ -1,7 +1,78 @@
 module ConnectStoopid
-	VERSION = "0.1.3"
+	VERSION = "0.1.4"
 
 	require 'savon'
 	require 'rexml/document'
 	require 'connect-stoopid/reporting-client'
-end
+	require 'connect-stoopid/time-entry'
+	require 'connect-stoopid/company'
+
+  # The WSDL and the SOAP client currently need to be accessible by the API classes.
+  class << self; attr_accessor :wsdl end
+  class << self; attr_accessor :soap_client end
+
+  # The methods defined need to be accessible and instance methods of the ConnectStoopid module.
+  class << self
+  	##
+  	# 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 connect(company, username, password, options = {})
+  		@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
+
+  	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
+  
+  	private
+
+  	LOG_LEVELS = {
+  		:debug    => 1,
+  		:standard => 2,
+  		:error    => 3
+  	}
+
+  	def logging
+  		return @client_options[:client_logging]
+  	end
+
+  end
+end

data/lib/connect-stoopid/company.rb

@@ -0,0 +1,76 @@
+=begin
+	ConnectStoopid::Company
+	Provides an interface to the ConnectWise Time Entry API
+=end
+
+module ConnectStoopid
+  class Company
+    
+    def initialize(psa_address, company, username, password, options = {})
+      ConnectStoopid.wsdl = "https://#{psa_address}/v4_6_release/apis/1.5/CompanyApi.asmx?wsdl"
+      ConnectStoopid.connect(company, username, password, options)
+    end
+  
+  	##
+  	# Parameters:
+  	# 	options: Key value pairs to add to the Savon SOAP request
+  	# Returns:
+    #   False on failure, an array of companies on success.
+  	##
+  	def find_companies(options = {})
+  		ConnectStoopid.log_client_message("FindCompanies", :debug)
+
+  		request_options = ConnectStoopid.base_soap_hash
+  		request_options.merge!(options)
+		
+  		begin
+  			response = ConnectStoopid.soap_client.call(:find_companies, :message => request_options)
+  		rescue Savon::SOAPFault => error
+  			ConnectStoopid.log_client_message("SOAP Fault\nError Message:\n#{error}", :error)
+  		else
+  			if response.success?
+          companies = []
+          xml_doc   = REXML::Document.new(response.to_xml)
+          #REXML::XPath.each(xml_doc, "//Company") do |company|
+          #  companies << company 
+          #end
+          result = xml_doc
+        else
+          result = false
+  			end
+  		end
+      return result
+  	end
+
+  	##
+  	# Parameters:
+  	# 	options: Key value pairs to add to the Savon SOAP request
+  	# Returns:
+    #   False on failure, an array of companies on success.
+  	##
+  	def get_company(id)
+  		ConnectStoopid.log_client_message("GetCompany", :debug)
+
+  		request_options = ConnectStoopid.base_soap_hash
+  		request_options.merge!(
+        { "id" => id }
+      )
+		
+  		begin
+  			response = ConnectStoopid.soap_client.call(:get_company, :message => request_options)
+  		rescue Savon::SOAPFault => error
+  			ConnectStoopid.log_client_message("SOAP Fault\nError Message:\n#{error}", :error)
+  		else
+  			if response.success?
+          xml_doc   = REXML::Document.new(response.to_xml)
+          result = xml_doc
+        else
+          result = false
+  			end
+  		end
+      return result
+  	end
+
+
+  end
+end

data/lib/connect-stoopid/time-entry.rb

@@ -0,0 +1,50 @@
+=begin
+	ConnectStoopid::TimeEntry
+	Provides an interface to the ConnectWise Time Entry API
+=end
+
+module ConnectStoopid
+  class TimeEntry
+    
+    def initialize(psa_address, company, username, password, options = {})
+      ConnectStoopid.wsdl = "https://#{psa_address}/v4_6_release/apis/1.5/TimeEntryApi.asmx?wsdl"
+      ConnectStoopid.connect(company, username, password, options)
+    end
+  
+  	##
+  	# Parameters:
+  	# 	options: Key value pairs to add to the Savon SOAP request
+  	# Returns:
+    #   Error on failure, returns true on addition of time entry.
+  	##
+  	def add_time_entry(
+      options = {
+        "MemberID"   => "testuser",
+        "ChargeCode" => "Automated (testuser)",
+        "WorkType"   => "Regular",
+        "DateStart"  => "",
+        "TimeStart"  => "",
+        "TimeEnd"    => "",
+        "Notes"      => "",
+      }
+    )
+  		ConnectStoopid.log_client_message("Adding a Time Entry | Member: #{options['MemberID']} Start: #{options['TimeStart']} End: #{options['TimeEnd']}", :debug)
+
+  		request_options = ConnectStoopid.base_soap_hash
+  		request_options.merge!({ "timeEntry" => options })
+		
+  		begin
+  			response = ConnectStoopid.soap_client.call(:add_time_entry, :message => request_options)
+  		rescue Savon::SOAPFault => error
+  			ConnectStoopid.log_client_message("SOAP Fault\nError Message:\n#{error}", :error)
+  		else
+  			if response.success?
+          result = true
+        else
+          result = false
+  			end
+  		end
+      return result
+  	end
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: connect-stoopid
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Josh Stump
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2014-01-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
@@ -30,8 +30,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ./lib/connect-stoopid.rb
-- ./lib/connect-stoopid/reporting-client.rb
+- "./lib/connect-stoopid.rb"
+- "./lib/connect-stoopid/reporting-client.rb"
+- "./lib/connect-stoopid/time-entry.rb"
+- "./lib/connect-stoopid/company.rb"
 homepage: https://github.com/bytesofknowledge/connect-stoopid
 licenses:
 - GPL-2
@@ -42,18 +44,18 @@ 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
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Run queries against the ConnectWise Reporting SOAP API
+summary: Run queries against the ConnectWise SOAP API
 test_files: []