kaseyaws 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa55ab6fd4e0e3dd702df0c3b29bd1775afb6e3a
+  data.tar.gz: 6eab6b4fcb01edaa4e69f5698b7881d58fc11242
+SHA512:
+  metadata.gz: d69947ee91373caa8f9a23f1889ad00bd4a50ff2d1830fd91e4809cbb20912c490414902208225c00f731cad4aa1ea48ec315fc7c38bb23d51ca02b3e7e78956
+  data.tar.gz: 5b6153c44c1d017c213be11ece6bb273d22eec05aaf965b239ad2ad700552cca036c6c8f5df1ca5d1f541e686987182b6dff22b348dcb5f05f2b5ad42ce72d78

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kaseyaws.gemspec
+gemspec
+
+gem "savon", "~> 2.1.0"
+gem "json", "~> 1.7.7"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Phillip Henslee
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# KaseyaWS
+
+A simple Ruby Gem that provides a Ruby client for Kaseya's VSA web service.
+
+This is currently a work in progress, as all Kaseya web service operations are not implemented yet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kaseyaws'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kaseyaws
+
+## Usage
+
+``` ruby
+require 'kaseyaws'
+
+# Create a new web service client instance
+kclient = KaseyaWS::Client.new("username","password","mykserver.domain.com")
+
+#Get alarm list, returns hash
+alarms = kclient.get_alarm_list
+
+#Get a specific alarm by alarm id, returns hash
+alarm = kclient.get_alarm(alarms[:alarms][:alarm][0][:monitor_alarm_id])
+
+alarm[:alarm_subject]
+# => "Monitoring generated Counter ALARM at 5:47:54 am 01-Feb-13 on computer.systems.company"
+
+```
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kaseyaws.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kaseyaws/version'
+
+Gem::Specification.new do |s|
+  s.name          = "kaseyaws"
+  s.version       = KaseyaWS::VERSION
+  s.authors       = ["Phillip Henslee"]
+  s.email         = ["phenslee@towerdigital.us"]
+  s.description   = ["A Ruby client for Kaseya web services"]
+  s.summary       = ["A simple client for the Kaseya VSA web service"]
+  s.homepage      = "https://github.com/towerdigital/kaseyaws"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|s|features)/})
+  s.require_paths = ["lib"]
+  s.add_dependency("savon", [">= 2.1.0"])
+  s.add_dependency("json")
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+end

data/lib/kaseyaws/security.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2013 by Phillip Henslee (phenslee@towerdigital.us).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#
+
+# Provides some helper methods for web service authentication
+
+require 'digest'
+require 'net/http'
+require 'securerandom'
+require 'json'
+
+module KaseyaWS
+  class Security
+
+    # Utility method to return the client's IP address
+    # Most but not all Kaseya VSA SOAP request require <BrowserIP>
+
+    def self.client_ip
+      r =  Net::HTTP.get( 'jsonip.com','/' )
+      r = JSON::parse(r)['ip']
+    end
+
+    # Create a secure random number, returns a eight digit string
+    # Used to compute the second hash for the double hash sequence
+    
+    def self.secure_random
+      i = SecureRandom.random_bytes
+      i = i.each_byte.map { |b| b.to_s }.join
+      i = i.gsub("0","")
+      i = i[1..8]
+    end
+
+    # Computes the double hashed covered password to authenticate with the VSA
+    
+    def self.compute_covered_password(username, password, rnd_number, hashing_algorithm)
+      if hashing_algorithm == "SHA-1"
+        hash1 = Digest::SHA1.hexdigest(password + username)
+        covered_password = Digest::SHA1.hexdigest(hash1 + rnd_number)
+      else # Assume SHA-256
+        hash1 = Digest::SHA256.hexdigest(password + username)
+        covered_password = Digest::SHA256.hexdigest(hash1 + rnd_number)
+      end
+    end
+
+  end
+end

data/lib/kaseyaws/version.rb

@@ -0,0 +1,8 @@
+module KaseyaWS
+  VERSION_NUMBERS = [
+    VERSION_MAJOR = 0,
+    VERSION_MINOR = 0,
+    VERSION_BUILD = 2,
+  ]
+  VERSION = VERSION_NUMBERS.join(".")
+end

data/lib/kaseyaws.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2013 by Phillip Henslee (phenslee@towerdigital.us).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#
+
+# Provides a simple client for the Kaseya VSA web service.
+
+require "kaseyaws/version"
+require "kaseyaws/security"
+require "savon"
+
+module KaseyaWS
+
+  class Client
+    HASH_ALGORITHM = "SHA-256"
+    attr_accessor :client
+
+    def initialize (username,password,hostname)
+
+      @vsa_serviceurl = "https://" + hostname + "/vsaWS/kaseyaWS.asmx?WSDL"
+      @client_ip = KaseyaWS::Security.client_ip
+      @savon_options={
+        wsdl: @vsa_serviceurl,
+        convert_request_keys_to: :camelcase,
+        env_namespace: :soap,
+        open_timeout: 30,
+        log: false
+      }
+      @sessionid = self.authenticate(username,password)
+
+    end
+
+    # TODO To be added...
+    # def add_org(org_ref, org_name, default_dept_name, default_mg_name, website, no_emps, ann_revenue,
+    #             method_of_contact, org_parent_ref, addr1, city, state, postal_code, country_ref, org_type
+    #             primary_email, primary_phone, primary_fax, primary_staff_fk, browser_ip, sesion_id)
+
+    #   client = Savon.client(@savon_options)
+
+    #   response = client.call(:add_org, message: {req:[{
+    #                                                                     group_name: group_name,
+    #                                                                     scope_name: scope_name,
+    #                                                                     browser_ip: @client_ip,
+    #                          session_i_d: @sessionid}]}
+    #                          )
+    #   response.body[:get_machine_list_response][:get_machine_list_result]
+    # end
+
+
+    def add_mach_group_to_scope(group_name,scope_name)
+
+      response = self.client.call(:add_mach_group_to_scope, message: {req:[{
+                                                                        group_name: group_name,
+                                                                        scope_name: scope_name,
+                                                                        browser_ip: @client_ip,
+                             session_i_d: @sessionid}]}
+                             )
+      response.body[:add_mach_group_to_scope_response][:add_mach_group_to_scope_result]
+    end
+
+    def add_org_to_scope(company_id,scope_id)
+
+      response = self.client.call(:add_org_to_scope, message: {req:[{
+                                                                 company_i_d: company_id,
+                                                                 scope_i_d: scope_id,
+                             session_i_d: @sessionid}]}
+                             )
+      response.body[:add_org_to_scope_response][:add_org_to_scope_result]
+    end
+
+    def add_user_to_role(username,role_id)
+
+      response = self.client.call(:add_user_to_role, message: {req:[{
+                                                                 user_name: user_name,
+                                                                 role_i_d: role_id,
+                             session_i_d: @sessionid}]}
+                             )
+      response.body[:add_user_to_role_response][:add_user_to_role_result]
+    end
+
+    def authenticate(username,password)
+
+      random_number = KaseyaWS::Security.secure_random
+      covered_password = KaseyaWS::Security.compute_covered_password(username,password, random_number, HASH_ALGORITHM)
+      browser_ip = @client_ip
+
+      self.client = Savon::Client.new(@savon_options)
+
+      response = self.client.call(:authenticate, message: {req:[{
+                                                                  user_name: username,
+                                                                  covered_password: covered_password,
+                                                                  random_number: random_number,
+                                                                  browser_ip: browser_ip,
+                                  hashing_algorithm: HASH_ALGORITHM}]}
+                                  )
+      @sessionid = response.body[:authenticate_response][:authenticate_result][:session_id]
+    end
+
+    def close_alarm (monitor_alarm_id, notes)
+
+      response = self.client.call(:close_alarm, message: {req:[{
+                                                            monitor_alarm_i_d: monitor_alarm_id,
+                                                            notes: notes,
+                                                            browser_ip: @client_ip,
+                             session_i_d: @sessionid}]}
+                             )
+      response.body[:close_alarm_response][:close_alarm_result]
+    end
+
+    def create_role (role_name,role_type,parent_role_name)
+
+      response = self.client.call(:create_role, message: {req:[{
+                                                            role_name: role_name,
+                                                            role_type: role_type,
+                                                            parent_role_name: parent_role_name,
+                                                            browser_ip: @client_ip,
+                             session_i_d: @sessionid}]}
+                             )
+      response.body[:create_role_response][:create_role_result]
+    end
+
+    def get_alarm (monitor_alarm_id)
+
+      response = self.client.call(:get_alarm, message: {req:[{
+                                                               monitor_alarm_i_d: monitor_alarm_id,
+                                                               browser_ip: @client_ip,
+                                  session_i_d: @sessionid}]}
+                                  )
+      response.body[:get_alarm_response][:get_alarm_result]
+    end
+
+    def get_alarm_list (get_all_records=true)
+
+      response = self.client.call(:get_alarm_list, message: {req:[{
+                                                                    return_all_records: get_all_records,
+                                                                    browser_ip: @client_ip,
+                                  session_i_d: @sessionid}]}
+                                  )
+      response.body[:get_alarm_list_response][:get_alarm_list_result]
+    end
+
+    def get_machine(machine_group_id)
+
+      response = self.client.call(:get_machine, message: {req:[{
+                                                            machine___group_i_d: machine_group_id,
+                                                            browser_ip: @client_ip,
+                             session_i_d: @sessionid}]}
+                             )
+      response.body[:get_machine_response][:get_machine_result]
+    end
+
+    def get_machine_group_list
+
+      response = self.client.call(:get_machine_group_list, message: {req:[{
+                                                                       browser_ip: @client_ip,
+                             session_i_d: @sessionid}]}
+                             )
+      response.body[:get_machine_group_list_response][:get_machine_group_list_result]
+    end
+
+    def get_machine_list(machine_group,machine_collection)
+
+      response = self.client.call(:get_machine_list, message: {req:[{
+                                                                 machine_group: machine_group,
+                                                                 machine_collection: machine_collection,
+                                                                 browser_ip: @client_ip,
+                             session_i_d: @sessionid}]}
+                             )
+      response.body[:get_machine_list_response][:get_machine_list_result]
+    end
+
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: kaseyaws
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Phillip Henslee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: '["A Ruby client for Kaseya web services"]'
+email:
+- phenslee@towerdigital.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kaseyaws.gemspec
+- lib/kaseyaws.rb
+- lib/kaseyaws/security.rb
+- lib/kaseyaws/version.rb
+homepage: https://github.com/towerdigital/kaseyaws
+licenses:
+- MIT
+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.3
+signing_key: 
+specification_version: 4
+summary: '["A simple client for the Kaseya VSA web service"]'
+test_files: []