kaseya 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4828eab96ff60e4d59b7b5b9df30a03f87b0a32e8515e22c4beb9f9993e276c7
+  data.tar.gz: e2204f67564dc0b6259c32a3d116f5b95349601a8c18a3cae48e3b5a19e8133f
+SHA512:
+  metadata.gz: 452497382f2165e56c18d365c8aa1e8c7f1112670f6234bc2aee8ddb05912c01449b715d99ba20d4d0d833fc59b292d6c670a2f50ba316f8a002fc404ff287e4
+  data.tar.gz: c2d2625d8f3c8ee7c4485296017e29941f60d950bd69cc7d617c43ecdc70d9f103b0b92a5417099ea0f62ed7b103d96895bae9208df214f3647c24535df37891

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Debugging history
+.byebug_history
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cbisnett@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kaseya.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Chris Bisnett
+
+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,118 @@
+# Kaseya
+
+The Kaseya Ruby library provides convenient access to the Kaseya [BMS](https://www.kaseya.com/products/bms/) and [VSA](https://www.kaseya.com/products/vsa/) API's. The library is structured such that it can be used to manage multiple Kaseya tenants.
+
+*Note: Not all API endpoints are implemented and more continue to be added as time permits.*
+
+## Documentation
+
+API documentation:
+- BMS: https://bms.kaseya.com/api
+- VSA: http://help.kaseya.com/webhelp/EN/restapi/9040000/index.asp
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kaseya'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kaseya
+
+## Usage
+
+To manage a BMS tenant, create a client by providing the required authentication parameters:
+
+```ruby
+bms = Kaseya::BMS.authenticate("bms.kaseya.com", "username", "password", "Company Name")
+
+# get all accounts in the CRM
+bms.accounts.all()
+```
+
+API methods are organized in the client based on the record type. For example, methods for creating/modifying/deleting contacts can be accessed through the `contacts` namespace:
+
+```ruby
+# get all contacts
+bms.contacts.all()
+
+# add a contact
+bms.contacts.new(
+    account_id: 2528,
+    location_id: 3169,
+    first_name: "Jane",
+    last_name: "Doe",
+    default_email_type_id: 1,
+    default_email_address: "foo@example.com",
+    default_phone_type_id: 1,
+    default_phone_number: "5551234567")
+```
+
+### Parameters
+
+In order to support an idiomatic Ruby experience, symbol parameters will be converted from snake-case to camel-case before being submitted to the API.
+
+```ruby
+bms.locations.new(
+    account_id: 1,
+    location_name: "California Office",
+    addresses: [{
+        address_1: "One Infinite Loop",
+        city: "Cupertino",
+        state: "CA",
+        zip_code: "95014"
+    }])
+```
+
+is equivalent to:
+
+```ruby
+bms.locations.new(
+    "AccountId" => 1,
+    "LocationName" => "California Office",
+    "Addresses" => [{
+        "Address1" => "One Infinite Loop",
+        "City" => "Cupertino",
+        "State" => "CA",
+        "ZipCode" => "95014"
+    }])
+```
+
+### Filtering, Sorting, Paging
+
+Both the BMS and VSA API's use Odata expressions to specify filtering, sorting, and paging parameters. Where supported, these parameters can be passed as options using `skip`, `top`, `orderby`, and `filter` and the library will prepend the `$` before adding them to the query.
+
+To query the second page of accounts where each page has 50 results:
+
+```ruby
+bms.accounts(top: 50, skip: 50)
+```
+
+Consult the documentation for details on which filtering expressions are supported and which properties support sorting.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Run all tests:
+
+    bundle exec rake spec
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/huntresslabs/kaseya-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kaseya project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/huntresslabs/kaseya-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kaseya"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "byebug"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kaseya.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kaseya/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kaseya"
+  spec.version       = Kaseya::VERSION
+  spec.authors       = ["Chris Bisnett"]
+  spec.email         = ["cbisnett@gmail.com"]
+
+  spec.summary       = "Ruby client for the Kaseya BMS and VSA APIs"
+  spec.description   = "Ruby client for the Kaseya BMS and VSA APIs"
+  spec.homepage      = "https://github.com/huntresslabs/kaseya-ruby"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency "faraday", "~> 0.15.0"
+  spec.add_dependency "faraday_middleware", "~> 0.13.1"
+  spec.add_dependency "activesupport", "~> 5.2.3"
+end

data/lib/kaseya/bms/api.rb

@@ -0,0 +1,29 @@
+module Kaseya::BMS
+  class Api
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get_many(path, params = {})
+      Kaseya::Collection.new connection.get(path, params)
+    end
+
+    def get_one(path, params = {})
+      Kaseya::Response.new connection.get(path, params)
+    end
+
+    def post(path, params = {})
+      Kaseya::Result.new connection.post(path, params)
+    end
+
+    def put(path, params = {})
+      Kaseya::Result.new connection.put(path, params)
+    end
+
+    def delete(path)
+      connection.delete(path)
+    end
+  end
+end

data/lib/kaseya/bms/client/accounts.rb

@@ -0,0 +1,56 @@
+module Kaseya::BMS
+  class Client::Accounts < Api
+    def all(params = {})
+      get_many "crm/accounts", params
+    end
+
+    def find(id)
+      get_one "crm/accounts/#{id}"
+    end
+
+    def create(params = {})
+      post "crm/accounts", params
+    end
+
+    def update(id, params = {})
+      put "crm/accounts/#{id}", params
+    end
+
+    def delete(id)
+      delete "crm/accounts/#{id}"
+    end
+
+    def locations(id, params = {})
+      get_many "crm/accounts/#{id}/locations", params
+    end
+
+    def main_location(id)
+      response = get_many("crm/accounts/#{id}/locations", top: 1, filter: "IsMain eq true")
+      response.first
+    end
+
+    def main_location_id(id)
+      (main_location(id) || {})["Id"]
+    end
+
+    def notes(id, params = {})
+      get_many "crm/accounts/#{id}/notes", params
+    end
+
+    def activities(id, params = {})
+      get_many "crm/accounts/#{id}/activity", params
+    end
+
+    def linked(id, params = {})
+      get_many "crm/accounts/#{id}/linkedaccounts", params
+    end
+
+    def types(params = {})
+      get_many "crm/accounts/types", params
+    end
+
+    def new_type(params = {})
+      post "crm/accounts/types", params
+    end
+  end
+end

data/lib/kaseya/bms/client/activities.rb

@@ -0,0 +1,23 @@
+module Kaseya::BMS
+  class Client::Activities < Api
+    def all(params = {})
+      get_many "crm/activity", params
+    end
+
+    def find(id)
+      get_one "crm/activity/#{id }"
+    end
+
+    def new(params = {})
+      post "crm/activity", params
+    end
+
+    def update(id, params = {})
+      put "crm/activity/#{id}", params
+    end
+
+    def notes(id, params = {})
+      get_many "crm/activity/#{id}/notes", params
+    end
+  end
+end

data/lib/kaseya/bms/client/admin.rb

@@ -0,0 +1,15 @@
+module Kaseya::BMS
+  class Client::Admin < Api
+    def statuses(params = {})
+      get_many "system/statuses", params
+    end
+
+    def priorities(params = {})
+      get_many "system/priorities", params
+    end
+
+    def queues(params = {})
+      get_many "system/queues", params
+    end
+  end
+end

data/lib/kaseya/bms/client/contacts.rb

@@ -0,0 +1,27 @@
+module Kaseya::BMS
+  class Client::Contacts < Api
+    def all(params = {})
+      get_many "crm/contacts", params
+    end
+
+    def find(id)
+      get_one "crm/contacts/#{id}"
+    end
+
+    def new(params = {})
+      post "crm/contacts", params
+    end
+
+    def update(id, params = {})
+      put "crm/contacts/#{id}", params
+    end
+
+    def delete(id)
+      delete "crm/contacts/#{id}"
+    end
+
+    def notes(id, params = {})
+      get_many "crm/contacts/#{id}/notes", params
+    end
+  end
+end

data/lib/kaseya/bms/client/lists.rb

@@ -0,0 +1,13 @@
+module Kaseya::BMS
+  class Client
+    class Lists < Api
+      def find(id, params = {})
+        get_many "system/lists/#{id}", params
+      end
+
+      def ticket_types(params = {})
+        find(LIST_TYPES[:ticket_type], params)
+      end
+    end
+  end
+end

data/lib/kaseya/bms/client/locations.rb

@@ -0,0 +1,23 @@
+module Kaseya::BMS
+  class Client::Locations < Api
+    def all(params = {})
+      get_many "crm/locations", params
+    end
+
+    def find(id)
+      get_one "crm/locations/#{id}"
+    end
+
+    def new(params = {})
+      post "crm/locations", params
+    end
+
+    def update(id, params = {})
+      put "crm/locations/#{id}", params
+    end
+
+    def delete(id)
+      delete "crm/locations/#{id}"
+    end
+  end
+end

data/lib/kaseya/bms/client/tickets.rb

@@ -0,0 +1,7 @@
+module Kaseya::BMS
+  class Client::Tickets < Api
+    def new(params = {})
+      post "servicedesk/tickets", params
+    end
+  end
+end

data/lib/kaseya/bms/client.rb

@@ -0,0 +1,39 @@
+module Kaseya::BMS
+  class Client
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def accounts
+      @accounts ||= Client::Accounts.new(@connection)
+    end
+
+    def activities
+      @activities ||= Client::Activities.new(@connection)
+    end
+
+    def admin
+      @admin ||= Client::Admin.new(@connection)
+    end
+
+    def contacts
+      @contacts ||= Client::Contacts.new(@connection)
+    end
+
+    def lists
+      @lists ||= Client::Lists.new(@connection)
+    end
+
+    def locations
+      @locations ||= Client::Locations.new(@connection)
+    end
+
+    def tickets
+      @tickets ||= Client::Tickets.new(@connection)
+    end
+  end
+end

data/lib/kaseya/bms/configuration.rb

@@ -0,0 +1,37 @@
+module Kaseya::BMS
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :debug,
+      :user_agent,
+    ].freeze
+
+    DEFAULT_DEBUG = false
+
+    DEFAULT_USER_AGENT = "Kaseya BMS Ruby Gem #{Kaseya::VERSION}".freeze
+
+    # Define accessor methods for configuration keys
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      self.debug = DEFAULT_DEBUG
+      self.user_agent = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/kaseya/bms/connection.rb

@@ -0,0 +1,24 @@
+require "faraday"
+
+require_relative "http_errors"
+
+module Kaseya::BMS
+  class Connection < Kaseya::Connection
+    ERROR_MIDDLEWARE = [Kaseya::BMS::HttpErrors]
+
+    def initialize(host, token, expires)
+      super(host, token)
+      @expires = expires
+    end
+
+    def connection_options
+      {
+        headers: {
+          user_agent: Kaseya::BMS.user_agent,
+        },
+        url: "https://#{@host}/api",
+        ssl: { verify: !Kaseya::BMS.debug },
+      }
+    end
+  end
+end

data/lib/kaseya/bms/exceptions.rb

@@ -0,0 +1,15 @@
+module Kaseya::BMS
+  class BMSError < Kaseya::ApiError
+    attr_reader :response, :error, :description
+
+    def initialize(response)
+      @response = response
+      if @response&.body
+        @error = @response.body["error"]
+        @description = @response.body["error_description"]
+      end
+
+      super("#{@error || 'Error'}: #{@description || 'Unknown API error'}")
+    end
+  end
+end

data/lib/kaseya/bms/http_errors.rb

@@ -0,0 +1,10 @@
+module Kaseya::BMS
+  class HttpErrors < Faraday::Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 400..600
+        raise BMSError, env.response
+      end
+    end
+  end
+end

data/lib/kaseya/bms/version.rb

@@ -0,0 +1,3 @@
+module Kaseya::BMS
+  VERSION = '0.1.0'.freeze
+end

data/lib/kaseya/bms.rb

@@ -0,0 +1,53 @@
+module Kaseya
+  module BMS
+    require_relative "bms/api"
+    require_relative "bms/client"
+    require_relative "bms/configuration"
+    require_relative "bms/connection"
+    require_relative "bms/exceptions"
+    require_relative "bms/http_errors"
+    require_relative "bms/version"
+
+    extend Configuration
+
+    TICKET_SOURCES = {
+      client_portal:      0,
+      phone:              1,
+      in_person:          2,
+      on_site:            3,
+      email:              4,
+      monitoring_system:  5,
+      voice_mail:         6,
+      verbal:             7,
+      other:              8,
+      recurring:          9,
+    }
+
+    LIST_TYPES = {
+      ticket_type: 1,
+    }
+
+    def self.authenticate(host, username, password, tenant)
+      params = {
+        grant_type: "password",
+        username: username,
+        password: password,
+        tenant: tenant
+      }
+
+      conn = Faraday.new(url: "https://#{host}/api", ssl: { verify: !debug }) do |faraday|
+        faraday.use HttpErrors
+
+        faraday.request :url_encoded
+        faraday.response :json
+        faraday.adapter Faraday.default_adapter
+      end
+
+      response = conn.post('token', params)
+      connection = Connection.new(host, response.body["access_token"], response.body["expires_in"])
+      Client.new(connection)
+    rescue Faraday::ConnectionFailed => e
+      raise Kaseya::ConnectionFailed, e.message
+    end
+  end
+end

data/lib/kaseya/collection.rb

@@ -0,0 +1,15 @@
+module Kaseya
+  class Collection
+    attr_reader :total, :code, :status, :error, :result
+
+    delegate_missing_to :@results
+
+    def initialize(response)
+      @total = response["TotalRecords"]
+      @code = response["ResponseCode"]
+      @status = response["Status"]
+      @error = response["Error"]
+      @results = (response["Result"] || []).map { |r| Result.new r }
+    end
+  end
+end

data/lib/kaseya/connection.rb

@@ -0,0 +1,60 @@
+require "faraday"
+require "faraday_middleware"
+
+module Kaseya
+  class Connection
+    ODATA_PARAMS = [:skip, :top, :orderby, :filter]
+    ERROR_MIDDLEWARE = []
+
+    def initialize(host, token)
+      @host = host
+      @token = token
+
+      @connection = Faraday::Connection.new(connection_options) do |conn|
+        ERROR_MIDDLEWARE.each do |klass|
+          conn.use klass
+        end
+
+        conn.authorization :Bearer, @token
+        conn.request :json
+        conn.response :json
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def get(path, params = {})
+      response = @connection.get(path, format_params(params))
+      response.body
+    end
+
+    def post(path, params = {})
+      response = @connection.post(path, format_params(params))
+      response.body
+    end
+
+    def put(path, params = {})
+      response = @connection.put(path, format_params(params))
+      response.body
+    end
+
+    def delete(path)
+      response = @connection.delete(path)
+    end
+
+    private
+
+    def connection_options
+      {}
+    end
+
+    def format_params(params)
+      params.transform_keys do |key|
+        case
+        when ODATA_PARAMS.include?(key.to_sym)  then "$#{key}"
+        when key.is_a?(Symbol)                  then key.to_s.camelize
+        else key
+        end
+      end
+    end
+  end
+end

data/lib/kaseya/exceptions.rb

@@ -0,0 +1,5 @@
+module Kaseya
+  class ConnectionFailed < StandardError; end
+
+  class ApiError < StandardError; end
+end

data/lib/kaseya/response.rb

@@ -0,0 +1,22 @@
+module Kaseya
+  class Response
+    attr_reader :code, :status, :error, :result
+
+    delegate_missing_to :@result
+
+    def initialize(response)
+      @code = response["ResponseCode"]
+      @status = response["Status"]
+      @error = response["Error"]
+      @result = Result.new(response["Result"])
+    end
+
+    def error?
+      @error != "None"
+    end
+
+    def success?
+      !error?
+    end
+  end
+end

data/lib/kaseya/result.rb

@@ -0,0 +1,17 @@
+module Kaseya
+  class Result
+    attr_reader :raw
+
+    delegate_missing_to :@raw
+
+    def initialize(result)
+      @raw = result || {}
+    end
+
+    def [](key)
+      # Convert snake-case symbols to camel-case strings
+      key = key.to_s.camelize if key.is_a?(Symbol)
+      @raw[key]
+    end
+  end
+end

data/lib/kaseya/version.rb

@@ -0,0 +1,3 @@
+module Kaseya
+  VERSION = "0.2.0"
+end

data/lib/kaseya/vsa/api.rb

@@ -0,0 +1,29 @@
+module Kaseya::VSA
+  class Api
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get_many(path, params = {})
+      Kaseya::Collection.new connection.get(path, params)
+    end
+
+    def get_one(path, params = {})
+      Kaseya::Response.new connection.get(path, params)
+    end
+
+    def post(path, params = {})
+      Kaseya::Result.new connection.post(path, params)
+    end
+
+    def put(path, params = {})
+      Kaseya::Result.new connection.put(path, params)
+    end
+
+    def delete(path)
+      connection.delete(path)
+    end
+  end
+end

data/lib/kaseya/vsa/client/agents.rb

@@ -0,0 +1,11 @@
+module Kaseya::VSA
+  class Client::Agents < Api
+    def all(params = {})
+      get_many "assetmgmt/agents", params
+    end
+
+    def find(id)
+      get_one "assetmgmt/agents/#{id}"
+    end
+  end
+end

data/lib/kaseya/vsa/client/machine_groups.rb

@@ -0,0 +1,7 @@
+module Kaseya::VSA
+  class Client::MachineGroups < Api
+    def all(params = {})
+      get_many "system/machinegroups", params
+    end
+  end
+end

data/lib/kaseya/vsa/client/organizations.rb

@@ -0,0 +1,27 @@
+module Kaseya::VSA
+  class Client::Organizations < Api
+    def all(params = {})
+      get_many "system/orgs", params
+    end
+
+    def find(id)
+      get_one "system/orgs/#{id}"
+    end
+
+    def machine_groups(id, params = {})
+      get_many "system/orgs/#{id}/machine_groups", params
+    end
+
+    def create(params = {})
+      post "system/orgs", params
+    end
+
+    def update(id, params = {})
+      put "system/orgs/#{id}", params
+    end
+
+    def delete(id)
+      delete "system/orgs/#{id}"
+    end
+  end
+end

data/lib/kaseya/vsa/client.rb

@@ -0,0 +1,23 @@
+module Kaseya::VSA
+  class Client
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def agents
+      @agents ||= Client::Agents.new(@connection)
+    end
+
+    def machine_groups
+      @machine_groups ||= Client::MachineGroups.new(@connection)
+    end
+
+    def organizations
+      @organizations ||= Client::Organizations.new(@connection)
+    end
+  end
+end

data/lib/kaseya/vsa/configuration.rb

@@ -0,0 +1,37 @@
+module Kaseya::VSA
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :debug,
+      :user_agent,
+    ].freeze
+
+    DEFAULT_DEBUG = false
+
+    DEFAULT_USER_AGENT = "Kaseya VSA Ruby Gem #{Kaseya::VERSION}".freeze
+
+    # Define accessor methods for configuration keys
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      self.debug = DEFAULT_DEBUG
+      self.user_agent = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/kaseya/vsa/connection.rb

@@ -0,0 +1,19 @@
+require "faraday"
+
+require_relative "http_errors"
+
+module Kaseya::VSA
+  class Connection < Kaseya::Connection
+    ERROR_MIDDLEWARE = [Kaseya::VSA::HttpErrors]
+
+    def connection_options
+      {
+        headers: {
+          user_agent: Kaseya::VSA.user_agent
+        },
+        url: "https://#{@host}/api/v1.0",
+        ssl: { verify: !Kaseya::VSA.debug },
+      }
+    end
+  end
+end

data/lib/kaseya/vsa/exceptions.rb

@@ -0,0 +1,15 @@
+module Kaseya::VSA
+  class VSAError < Kaseya::ApiError
+    attr_reader :response, :code, :error
+
+    def initialize(response)
+      @response = response
+      if @response&.body
+        @code = @response.body["ResponseCode"]
+        @error = @response.body["Error"]
+      end
+
+      super("Error (#{@code}): #{@error || 'Unknown API error'}")
+    end
+  end
+end

data/lib/kaseya/vsa/http_errors.rb

@@ -0,0 +1,10 @@
+module Kaseya::VSA
+  class HttpErrors < Faraday::Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 400..600
+        raise VSAError, env.response
+      end
+    end
+  end
+end

data/lib/kaseya/vsa/json_errors.rb

@@ -0,0 +1,9 @@
+module Kaseya::VSA
+  class JsonErrors < Faraday::Response::Middleware
+    def on_complete(env)
+      unless env.response.body["ResponseCode"] == 0
+        raise VSAError, env.response
+      end
+    end
+  end
+end

data/lib/kaseya/vsa.rb

@@ -0,0 +1,42 @@
+require "digest"
+
+module Kaseya
+  module VSA
+    require_relative "vsa/api"
+    require_relative "vsa/client"
+    require_relative "vsa/configuration"
+    require_relative "vsa/connection"
+    require_relative "vsa/exceptions"
+    require_relative "vsa/http_errors"
+    require_relative "vsa/json_errors"
+
+    extend Configuration
+
+    def self.authenticate(host, username, password)
+      nonce = SecureRandom.random_number(2**16).to_s
+      raw2 = Digest::SHA256.hexdigest(password)
+      pass2 = Digest::SHA256.hexdigest(Digest::SHA256.hexdigest(password + username) + nonce)
+      raw1 = Digest::SHA1.hexdigest(password)
+      pass1 = Digest::SHA1.hexdigest(Digest::SHA1.hexdigest(password + username) + nonce)
+
+      auth_string = "user=#{username},pass2=#{pass2},pass1=#{pass1},rpass2=#{raw2},rpass1=#{raw1},rand2=#{nonce}"
+      auth = Base64.strict_encode64(auth_string)
+
+      conn = Faraday.new(url: "https://#{host}/api/v1.0", ssl: { verify: !debug }) do |faraday|
+        faraday.use JsonErrors
+        faraday.use HttpErrors
+
+        faraday.authorization :Basic, auth
+        faraday.request :url_encoded
+        faraday.response :json
+        faraday.adapter Faraday.default_adapter
+      end
+
+      response = conn.get("auth")
+      connection = Connection.new(host, response.body.dig("Result", "ApiToken"))
+      Client.new(connection)
+    rescue Faraday::ConnectionFailed => e
+      raise Kaseya::ConnectionFailed, e.message
+    end
+  end
+end

data/lib/kaseya.rb

@@ -0,0 +1,15 @@
+require "kaseya/version"
+
+require "active_support"
+require "active_support/core_ext/hash"
+
+module Kaseya
+  require "kaseya/collection"
+  require "kaseya/connection"
+  require "kaseya/exceptions"
+  require "kaseya/response"
+  require "kaseya/result"
+
+  require "kaseya/bms"
+  require "kaseya/vsa"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: kaseya
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Chris Bisnett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+description: Ruby client for the Kaseya BMS and VSA APIs
+email:
+- cbisnett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kaseya.gemspec
+- lib/kaseya.rb
+- lib/kaseya/bms.rb
+- lib/kaseya/bms/api.rb
+- lib/kaseya/bms/client.rb
+- lib/kaseya/bms/client/accounts.rb
+- lib/kaseya/bms/client/activities.rb
+- lib/kaseya/bms/client/admin.rb
+- lib/kaseya/bms/client/contacts.rb
+- lib/kaseya/bms/client/lists.rb
+- lib/kaseya/bms/client/locations.rb
+- lib/kaseya/bms/client/tickets.rb
+- lib/kaseya/bms/configuration.rb
+- lib/kaseya/bms/connection.rb
+- lib/kaseya/bms/exceptions.rb
+- lib/kaseya/bms/http_errors.rb
+- lib/kaseya/bms/version.rb
+- lib/kaseya/collection.rb
+- lib/kaseya/connection.rb
+- lib/kaseya/exceptions.rb
+- lib/kaseya/response.rb
+- lib/kaseya/result.rb
+- lib/kaseya/version.rb
+- lib/kaseya/vsa.rb
+- lib/kaseya/vsa/api.rb
+- lib/kaseya/vsa/client.rb
+- lib/kaseya/vsa/client/agents.rb
+- lib/kaseya/vsa/client/machine_groups.rb
+- lib/kaseya/vsa/client/organizations.rb
+- lib/kaseya/vsa/configuration.rb
+- lib/kaseya/vsa/connection.rb
+- lib/kaseya/vsa/exceptions.rb
+- lib/kaseya/vsa/http_errors.rb
+- lib/kaseya/vsa/json_errors.rb
+homepage: https://github.com/huntresslabs/kaseya-ruby
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Kaseya BMS and VSA APIs
+test_files: []