HelpDeskAPI 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f17405bcdc7beb2c54da528e9ee8d13f6698b20a
+  data.tar.gz: 3de324b2dc16290b3e2669d7985913df8fbd2c04
+SHA512:
+  metadata.gz: 951db8336563881cb0b0828c2f3c844e13608bd52bcf91895f6d808a92a5833cd2f8f14e35c215e8fdd78ace48d2ff7e11849b05ff1724ba389d2f0dcf3bd880
+  data.tar.gz: 52617eae9e72af8da7808b24d5bfff30bcb68ec4b26c7556d746866b2bc10d2f1732d8cdba2c9c7750f15dc3c61dd5a14f08bb4ee81e21bcd82f3b36c7b387c0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Chase L Engel
+
+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,72 @@
+Ruby library for Spiceworks Help Desk.
+
+Currently only basic actions have been implemented.
+
+### Installation
+```
+$ gem build helpdeskapi.gemspec
+$ gem install ./HelpDeskAPI-1.0.0.gem
+```
+
+Note: Some actions require administrator user
+### Signing in
+```
+HelpDeskAPI::Client.new 'user@example.com', 'password'
+```
+### Tickets
+```
+# All tickets
+HelpDeskAPI::Tickets.all
+
+# Open tickets
+HelpDeskAPI::Tickets.open
+
+# Closed tickets
+HelpDeskAPI::Tickets.closed
+
+# My tickets
+HelpDeskAPI::Tickets.my
+
+# Unassigned tickets
+HelpDeskAPI::Tickets.unassigned
+
+# Waiting tickets
+HelpDeskAPI::Tickets.waiting
+
+# Past due tickets
+HelpDeskAPI::Tickets.past_due
+
+# Search for a ticket
+HelpDeskAPI::Tickets.search 'Summary'
+
+# Ticket creation
+ticket = HelpDeskAPI::Ticket.new 'Summary', 'Description', user.id, HelpDeskAPI::Ticket::Priority::HIGH
+ticket.submit
+
+# Delete ticket
+ticket.delete
+```
+### Comments
+```
+# Save comment
+comment = ticket.comment 'This is a comment'
+comment.save
+# or
+comment = HelpDeskAPI::Comment.new ticket.id, 'This is a comment'
+comment.save
+
+# Get all comment for a ticket
+ticket.comments
+# or
+HelpDeskAPI::Comments.comments ticket.id
+```
+### Users
+```
+# Get users (Administrators and Techs)
+HelpDeskAPI::Users.users
+```
+### Organizations
+```
+# All organizations
+HelpDeskAPI::Organizations.organizations
+```

data/helpdeskapi.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name = 'HelpDeskAPI'
+  s.version = '1.0.0'
+  s.date = '2017-06-22'
+  s.summary = 'Ruby Library for the Spiceworks Help Desk API'
+  s.authors = ['Chase L Engel']
+  s.email = 'chaselengel@gmail.com'
+  s.files = `git ls-files -z`.split("\0")
+  s.homepage = 'https://github.com/ChaseLEngel/HelpDeskAPI'
+  s.license = 'MIT'
+end

data/lib/helpdeskapi.rb

@@ -0,0 +1,68 @@
+require 'rest-client'
+require 'nokogiri'
+require 'json'
+
+require File.dirname(__FILE__) + '/helpdeskapi/authentication'
+require File.dirname(__FILE__) + '/helpdeskapi/ticket'
+require File.dirname(__FILE__) + '/helpdeskapi/request'
+require File.dirname(__FILE__) + '/helpdeskapi/tickets'
+require File.dirname(__FILE__) + '/helpdeskapi/users'
+require File.dirname(__FILE__) + '/helpdeskapi/organizations'
+require File.dirname(__FILE__) + '/helpdeskapi/endpoints'
+require File.dirname(__FILE__) + '/helpdeskapi/exceptions'
+
+module HelpDeskAPI
+  class Client
+
+    def initialize(username, password)
+      HelpDeskAPI::Authentication.username = username
+      HelpDeskAPI::Authentication.password = password
+      HelpDeskAPI::Authentication.authenticity_token = nil
+      HelpDeskAPI::Authentication.cookies = nil
+      sign_in
+    end
+
+    # Authenicate user and set cookies.
+    # This will be called automatically on endpoint request.
+    def sign_in
+      # Contact sign in page to set cookies.
+      begin
+        sign_in_res = RestClient.get(Endpoints::SIGN_IN)
+      rescue RestClient::ExceptionWithResponse => error
+        fail HelpDeskAPI::Exceptions.SignInError, "Error contacting #{Endpoints::SIGN_IN}: #{error}"
+      end
+
+      # Parse authenticity_token from sign in form.
+      page = Nokogiri::HTML(sign_in_res)
+      HelpDeskAPI::Authentication.authenticity_token = page.css('form').css('input')[1]['value']
+      unless HelpDeskAPI::Authentication.authenticity_token
+        fail HelpDeskAPI::Exceptions.AuthenticityTokenError, 'Error parsing authenticity_token: Token not found.'
+      end
+      # Parse sign_in HTML for csrf-token
+      page.css('meta').each do |tag|
+        HelpDeskAPI::Authentication.csrf_token = tag['content'] if tag['name'] == 'csrf-token'
+      end
+      unless HelpDeskAPI::Authentication.csrf_token
+        fail HelpDeskAPI::Exceptions.CsrfTokenError, 'No csrf-token found'
+      end
+
+      # Set cookies for later requests
+      HelpDeskAPI::Authentication.cookies = sign_in_res.cookies
+
+      # Simulate sign in form submit button.
+      body = {
+        'authenticity_token': HelpDeskAPI::Authentication.authenticity_token,
+        'user[email_address]': HelpDeskAPI::Authentication.username,
+        'user[password]': HelpDeskAPI::Authentication.password
+      }
+      RestClient.post(Endpoints::SESSIONS, body, {:cookies => HelpDeskAPI::Authentication.cookies}) do |response, request, result, &block|
+        # Response should be a 302 redirect from /sessions
+        if Request::responseError?(response)
+          fail HelpDeskAPI::Exceptions.SessionsError, "Error contacting #{Endpoints::SESSIONS}: #{error}"
+        end
+        # Update cookies just incase
+        HelpDeskAPI::Authentication.cookies = response.cookies
+      end
+    end
+  end
+end

data/lib/helpdeskapi/authentication.rb

@@ -0,0 +1,54 @@
+require 'singleton'
+require File.dirname(__FILE__) + '/organizations'
+
+module HelpDeskAPI
+  module Authentication
+
+    # Pass all function calls to Data singleton.
+    def self.method_missing(m, *args, &block)
+      Data.instance.send(m, *args)
+    end
+
+    private
+    class Data
+      include Singleton
+
+      attr_accessor :username, :password, :authenticity_token, :csrf_token, :cookies
+
+      def initialize
+        @username = nil
+        @password = nil
+        @authenticity_token = nil
+        @csrf_token = nil
+        @cookies = nil
+        @organization_id = nil
+        @creator_id = nil
+      end
+
+      def signed_in?
+        return !@cookies.nil?
+      end
+
+      # Returns creator_id for current user from users endpoint
+      def creator_id
+        return @creator_id if @creator_id
+
+        HelpDeskAPI::Users.users.each do |user|
+          if user.email == @username
+            @creator_id = user.id
+            return @creator_id
+          end
+        end
+
+        fail NoCreatorIdError, "Failed to find creator_id for user: #{@username}"
+      end
+
+      # Returns organization_id or contacts API to get
+      # id of first organization.
+      def organization_id
+        return @organization_id if @organization_id
+        @organization_id = HelpDeskAPI::Organizations.organizations.first.id
+      end
+    end
+  end
+end

data/lib/helpdeskapi/comment.rb

@@ -0,0 +1,56 @@
+require 'json'
+
+module HelpDeskAPI
+  class Comment
+
+    KEYS = [
+      'id',
+      'activity_type',
+      'created_at',
+      'body',
+      'attachment_ids',
+      'ticket',
+      'creator',
+    ]
+
+    def initialize(ticket_id = nil, body = nil)
+      @ticket_id = ticket_id
+      @body = body
+    end
+
+    def parse(comment_hash)
+      HelpDeskAPI::Utilities.validateHash(comment_hash, KEYS)
+      KEYS.each do |key|
+        instance_variable_set '@'+key, comment_hash[key]
+        self.class.class_eval { attr_accessor key }
+      end
+      return self
+    end
+
+    def save
+      payload = JSON.generate(
+        {
+          comment: {
+            activity_type: 'comment',
+            body: @body,
+            created_at: nil,
+            creator_id: nil,
+            creator_type: nil,
+            ticket_id: @ticket_id
+          },
+          ticket_comment: {
+            activity_type: 'comment',
+            body: @body,
+            created_at: nil,
+            creator_id: nil,
+            creator_type: nil,
+            initial_upload_ids: [],
+            ticket_id: @ticket_id
+          }
+        })
+      headers = {'authenticity_token': HelpDeskAPI::Authentication.authenticity_token, 'X-CSRF-Token': HelpDeskAPI::Authentication.csrf_token, 'Content-Type': 'application/json'}
+      response = HelpDeskAPI::Request.request('POST', Endpoints::TICKETS + "/#{@ticket_id}" + '/comments', payload, headers)
+      parse JSON.parse(response)['comment']
+    end
+  end
+end

data/lib/helpdeskapi/comments.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/request'
+require File.dirname(__FILE__) + '/utilities'
+
+module HelpDeskAPI
+  module Comments
+    def self.comments(ticket_id)
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::TICKETS + "/#{ticket_id}/comments"), 'ticket_comments', Comment
+    end
+  end
+end

data/lib/helpdeskapi/endpoints.rb

@@ -0,0 +1,19 @@
+module HelpDeskAPI
+  module Endpoints
+    URL = 'https://on.spiceworks.com'
+    SIGN_IN = URL + '/sign_in'
+    SESSIONS = URL + '/sessions'
+
+    API_URL = URL + '/api'
+    TICKETS = '/tickets'
+    TICKETS_OPEN = TICKETS + '/open'
+    TICKETS_ALL = TICKETS + '/all'
+    TICKETS_CLOSED = TICKETS + '/closed'
+    TICKETS_MY_TICKETS = TICKETS + '/my'
+    TICKETS_UNASSIGNED = TICKETS + '/unassigned'
+    TICKETS_WAITING = TICKETS + '/waiting'
+    TICKETS_PAST_DUE = TICKETS + '/past_due'
+    USERS = '/users'
+    ORGANIZATIONS = '/organizations'
+  end
+end

data/lib/helpdeskapi/exceptions.rb

@@ -0,0 +1,11 @@
+module HelpDeskAPI
+  module Exceptions
+    SignInError  = Class.new(StandardError)
+    AuthenticityTokenError = Class.new(StandardError)
+    CsrfTokenError = Class.new(StandardError)
+    SessionsError = Class.new(StandardError)
+    NoCreatorIdError = Class.new(StandardError)
+    RequestError = Class.new(StandardError)
+    MissingKey = Class.new(StandardError)
+  end
+end

data/lib/helpdeskapi/organization.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/utilities'
+
+module HelpDeskAPI
+  class Organization
+
+    KEYS = [
+      'id',
+      'name',
+      'host',
+      'links',
+      'domain_whitelist',
+      'email_footer',
+      'email_display_name',
+      'portal_enabled',
+      'ignore_subject',
+      'ignore_body',
+      'ignore_full_text',
+      'notification_settings',
+      'end_user_reopens_ticket',
+      'wants_automatic_assignment',
+      'category_ids',
+      'custom_attribute_ids',
+      'portal_setting_id',
+      'ticket_monitor_ids',
+      'active_directory_setting_id'
+    ]
+
+    def parse(organization_hash)
+      HelpDeskAPI::Utilities.validateHash organization_hash, KEYS
+      KEYS.each do |key|
+        instance_variable_set '@'+key, organization_hash[key]
+        self.class.class_eval { attr_accessor key }
+      end
+      return self
+    end
+  end
+end

data/lib/helpdeskapi/organizations.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/request'
+require File.dirname(__FILE__) + '/endpoints'
+require File.dirname(__FILE__) + '/utilities'
+require File.dirname(__FILE__) + '/organization'
+
+module HelpDeskAPI
+  module Organizations
+    def self.organizations
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::ORGANIZATIONS), 'organizations', Organization
+    end
+  end
+end

data/lib/helpdeskapi/request.rb

@@ -0,0 +1,40 @@
+require 'rest-client'
+
+require File.dirname(__FILE__) + '/authentication'
+require File.dirname(__FILE__) + '/endpoints'
+require File.dirname(__FILE__) + '/exceptions'
+
+module HelpDeskAPI
+  module Request
+    @api = RestClient::Resource.new Endpoints::API_URL
+
+    # Contact API given endpoint and return JSON
+    def self.request(method, endpoint, payload = nil, headers = {})
+      headers = headers.merge({:cookies => HelpDeskAPI::Authentication.cookies})
+      endpoint_response = nil
+
+      case method
+        when 'POST'
+          @api[endpoint].post(payload, headers) { |response, _, _, _| endpoint_response = response }
+        when 'GET'
+          endpoint_response = @api[endpoint].get(headers)
+        when 'DELETE'
+          endpoint_response = @api[endpoint].delete(headers)
+        when 'PUT'
+          endpoint_response = @api[endpoint].put(payload, headers)
+      end
+
+      if responseError?(endpoint_response)
+        fail HelpDeskAPI::Exceptions.RequestError, "Error contacting #{endpoint_response.request.url} with HTTP code: #{endpoint_response.code}"
+      end
+
+      return endpoint_response
+    end
+
+    # Returns true if response contains HTTP error code.
+    def self.responseError?(response)
+      error_codes = [400, 401, 402, 403, 404, 500, 501, 502, 503]
+      error_codes.include? response.code
+    end
+  end
+end

data/lib/helpdeskapi/ticket.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/endpoints'
+require File.dirname(__FILE__) + '/utilities'
+require File.dirname(__FILE__) + '/request'
+require File.dirname(__FILE__) + '/comment'
+require File.dirname(__FILE__) + '/comments'
+
+module HelpDeskAPI
+  class Ticket
+
+    module Priority
+      HIGH = '1'
+      MEDIUM = '2'
+      LOW = '3'
+    end
+
+    KEYS = [
+      'id',
+      'created_at',
+      'creator',
+      'description',
+      'due_at',
+      'organization_id',
+      'priority',
+      'status',
+      'summary',
+      'updated_at',
+      'custom_values',
+      'assignee',
+      'ticket_category',
+    ]
+
+    def initialize(summary = nil, description = nil, assignee_id = nil, priority = nil)
+      @summary = summary
+      @description = description
+      @assignee_id = assignee_id
+      @priority = priority
+    end
+
+    def parse(ticket_hash)
+      HelpDeskAPI::Utilities.validateHash(ticket_hash, KEYS)
+      KEYS.each do |key|
+        instance_variable_set '@'+key, ticket_hash[key]
+        self.class.class_eval { attr_accessor key }
+      end
+      return self
+    end
+
+    def submit
+      payload = JSON.generate({
+          ticket: {
+            summary: @summary,
+            description: @description,
+            priority: @priority,
+            due_at: nil,
+            updated_at: nil,
+            created_at: nil,
+            organization_id: HelpDeskAPI::Authentication.organization_id,
+            assignee_id: @assignee_id,
+            assignee_type: 'User',
+            creator_id: HelpDeskAPI::Authentication.creator_id,
+            creator_type: 'User',
+            custom_values: [],
+            ticket_category_id: nil,
+            ticket_category_type: nil,
+            watchers: []
+          }
+        })
+      headers = {'authenticity_token': HelpDeskAPI::Authentication.authenticity_token, 'X-CSRF-Token': HelpDeskAPI::Authentication.csrf_token, 'Content-Type': 'application/json'}
+      response = HelpDeskAPI::Request.request('POST', Endpoints::TICKETS, payload, headers)
+      parse JSON.parse(response)['tickets'].first
+    end
+
+    def close
+    end
+
+    def reopen
+    end
+
+    def delete
+      headers = {'authenticity_token': HelpDeskAPI::Authentication.authenticity_token, 'X-CSRF-Token': HelpDeskAPI::Authentication.csrf_token, 'Content-Type': 'application/json'}
+      HelpDeskAPI::Request.request('DELETE', Endpoints::TICKETS + "/#{@id}", nil, headers)
+    end
+
+    def comments
+      HelpDeskAPI::Comments.comments @id
+    end
+
+    def comment(body)
+      HelpDeskAPI::Comment.new @id, body
+    end
+  end
+end

data/lib/helpdeskapi/tickets.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/request'
+require File.dirname(__FILE__) + '/endpoints'
+require File.dirname(__FILE__) + '/ticket'
+require File.dirname(__FILE__) + '/utilities'
+
+require 'uri'
+
+module HelpDeskAPI
+  module Tickets
+    def self.search(query)
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::TICKETS_ALL+"?q=#{URI.escape query}"), 'tickets', Ticket
+    end
+
+    def self.all
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::TICKETS_ALL), 'tickets', Ticket
+    end
+
+    def self.open
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::TICKETS_OPEN), 'tickets', Ticket
+    end
+
+    def self.closed
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::TICKETS_CLOSED), 'tickets', Ticket
+    end
+
+    def self.my
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::TICKETS_MY_TICKETS), 'tickets', Ticket
+    end
+
+    def self.unassigned
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::TICKETS_UNASSIGNED), 'ticket', Ticket
+    end
+
+    def self.waiting
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::TICKETS_WAITING), 'ticket', Ticket
+    end
+
+    def self.past_due
+      HelpDeskAPI::Utilities.parse_response HelpDeskAPI::Request.request('GET', HelpDeskAPI::Endpoints::TICKETS_PAST_DUE), 'ticket', Ticket
+    end
+  end
+end

data/lib/helpdeskapi/user.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/utilities'
+require File.dirname(__FILE__) + '/request'
+require File.dirname(__FILE__) + '/authentication'
+
+require 'json'
+
+module HelpDeskAPI
+  class User
+
+    module Role
+      ADMIN = 'admin'
+      TECH = 'tech'
+    end
+
+    KEYS = [
+      'id',
+      'first_name',
+      'last_name',
+      'email',
+      'avatar_url',
+      'role',
+      'hourly_rate',
+      'spiceworks_user_id',
+      'wants_alerts',
+      'spiceworks_uid',
+      'system_user',
+      'verified',
+      'archived_user_id'
+    ]
+
+    def initialize(first_name = nil, last_name = nil, email = nil, hourly_rate = nil)
+      @first_name = first_name
+      @last_name = last_name
+      @email = email
+      @hourly_rate = hourly_rate
+    end
+
+    def edit(hash)
+      editable = ['first_name', 'last_name', 'email', 'wants_alerts', 'hourly_rate']
+      hash.keep_if { |key, _| editable.include? key.to_s }
+      JSON.generate(
+        {
+          user: {
+            account_id: nil,
+            archived_user_id: @archived_user_id,
+            avatar_url: @avatar_url,
+            deleted: @deleted,
+            email: @email,
+            first_name: @first_name,
+            hourly_rate: @hourly_rate,
+            last_name: @last_name,
+            owned_account_id: nil,
+            role: @role,
+            spiceworks_uid: @spiceworks_uid,
+            spiceworks_user_id: @spiceworks_user_id,
+            system_user: @system_user,
+            verified: @verified,
+            wants_alerts: @wants_alerts
+          }
+        })
+      return # Missing account_id
+      headers = {'authenticity_token': HelpDeskAPI::Authentication.authenticity_token, 'X-CSRF-Token': HelpDeskAPI::Authentication.csrf_token, 'Content-Type': 'application/json'}
+      HelpDeskAPI::Request.request('PUT', Endpoints::USERS + "/#{@id}", payload, headers)
+    end
+
+    def save
+    end
+
+    def parse(user_hash)
+      HelpDeskAPI::Utilities.validateHash(user_hash, KEYS)
+      KEYS.each do |key|
+        instance_variable_set '@'+key, user_hash[key]
+        self.class.class_eval { attr_accessor key }
+      end
+      return self
+    end
+  end
+end

data/lib/helpdeskapi/users.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/request'
+require File.dirname(__FILE__) + '/endpoints'
+require File.dirname(__FILE__) + '/user'
+require File.dirname(__FILE__) + '/utilities'
+
+module HelpDeskAPI
+  module Users
+    def self.users
+      HelpDeskAPI::Utilities.parse_response Request::request('GET', HelpDeskAPI::Endpoints::USERS), 'users', User
+    end
+
+    private
+    def self.parse(hash)
+      hash['users'].map { |user_hash| User.new.parse(user_hash) }
+    end
+  end
+end

data/lib/helpdeskapi/utilities.rb

@@ -0,0 +1,23 @@
+require 'json'
+
+require File.dirname(__FILE__) + '/exceptions'
+
+module HelpDeskAPI
+  module Utilities
+    # Makes sure all keys exist in hash
+    def self.validateHash(hash, keys)
+      keys.each do |key|
+        unless hash.has_key? key
+          fail HelpDeskAPI::Exceptions.MissingKey, "Missing key #{key} in hash:\n#{hash}\n"
+        end
+      end
+    end
+
+    # Converts response to JSON then creates given object and calls parse
+    # to handle parsing the response JSON
+    def self.parse_response(response, key, obj)
+      hash = JSON.parse response
+      hash[key].map { |object_hash| obj.new.parse(object_hash) }
+    end
+  end
+end

data/test/test_ticket.rb

@@ -0,0 +1,64 @@
+require 'minitest/autorun'
+
+require './lib/helpdeskapi'
+
+class TestTickets < Minitest::Test
+
+  def setup
+    username = ENV['HELP_DESK_API_USERNAME']
+    password = ENV['HELP_DESK_API_PASSWORD']
+    @user_id = ENV['HELP_DESK_API_USER_ID'].to_s
+
+    if username.nil? || password.nil? || @user_id.nil?
+      puts "HELP_DESK_API_USERNAME or HELP_DESK_API_PASSWORD or HELP_DESK_API_USER_ID undefinded. Exiting."
+      exit
+    end
+
+    HelpDeskAPI::Client.new username, password
+  end
+
+  def test_ticket_submit
+    time = Time.now.to_i.to_s
+
+    ticket = HelpDeskAPI::Ticket.new time, time, @user_id, HelpDeskAPI::Ticket::Priority::LOW
+    ticket.submit
+
+    tickets = HelpDeskAPI::Tickets.all
+
+    tickets.keep_if { |t| t.summary == time }
+    refute_empty tickets
+
+    assert_equal tickets.first.summary, time
+    assert_equal tickets.first.description, time
+    assert_equal tickets.first.assignee["id"].to_s, @user_id.to_s
+    assert_equal tickets.first.priority, HelpDeskAPI::Ticket::Priority::LOW
+
+  end
+
+  def test_ticket_comment
+    time = Time.now.to_i.to_s
+
+    tickets = HelpDeskAPI::Tickets.all
+    ticket = tickets.first
+
+    comment = ticket.comment time
+    comment.save
+
+    comments = ticket.comments
+    refute_empty comments
+
+    comments.keep_if { |c| c.body == time }
+    refute_empty comments
+  end
+
+  def test_ticket_delete
+    tickets = HelpDeskAPI::Tickets.all
+    ticket = tickets.first
+
+    ticket.delete
+
+    tickets = HelpDeskAPI::Tickets.all
+    tickets.keep_if { |t| t.id == ticket.id }
+    assert_empty tickets
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: HelpDeskAPI
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chase L Engel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-22 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: chaselengel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- helpdeskapi.gemspec
+- lib/helpdeskapi.rb
+- lib/helpdeskapi/authentication.rb
+- lib/helpdeskapi/comment.rb
+- lib/helpdeskapi/comments.rb
+- lib/helpdeskapi/endpoints.rb
+- lib/helpdeskapi/exceptions.rb
+- lib/helpdeskapi/organization.rb
+- lib/helpdeskapi/organizations.rb
+- lib/helpdeskapi/request.rb
+- lib/helpdeskapi/ticket.rb
+- lib/helpdeskapi/tickets.rb
+- lib/helpdeskapi/user.rb
+- lib/helpdeskapi/users.rb
+- lib/helpdeskapi/utilities.rb
+- test/test_ticket.rb
+homepage: https://github.com/ChaseLEngel/HelpDeskAPI
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Library for the Spiceworks Help Desk API
+test_files: []