swhd_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c8c21a8257146d6c2e916dbceefdd7aa7be8dc4
+  data.tar.gz: fc8a190a043edb5e6db5d4feb854b165ef583f34
+SHA512:
+  metadata.gz: a35de960ca06c60fc80b8b8d9cca1fdd99dd3962c93c274ef2cbf698092e400cb737e7159c5946842fec428ff6464df014ad3f181765543b8661b4eef48e8d45
+  data.tar.gz: f41f6bfd8efec1c0747534db1aaacac10fe7ca84cf1e9305befe2187b087edc5a3c5aad5d594119276a9321c77571c9e3f1275383fe19ac5a328ec9355adfbb1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - !ruby/regexp /old_and_unused\.rb$/
+
+Metrics/ClassLength:
+  Max: 200
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swhd_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marvin Frederickson
+
+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,57 @@
+# SolarWinds Helpdesk Api Helper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swhd_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swhd_api
+
+## Usage
+
+```ruby
+require 'swhd_api'
+m = SwhdApi::Manager.new(url, options)
+m.connect(credentials)
+m.request("Clients", :get).count 
+m.fetch("Clients").count
+```
+
+The _url_ is the api service url such as `https://helpdesk/helpdesk/WebObjects/Helpdesk.woa/ra`
+and _options_, if specified, is a hash that is passed to Typhoeus, and if you are using a self-signed
+SSL certificate, it may need to contain `{ ssl_verifypeer: false, ssl_verifyhost: 0 }`.  There's
+also the `{ verbose: true }` option, if you are debugging.
+
+The _credentials_ hash includes one of the following
+`{ apikey: value }`
+`{ techkey: value }`
+`{ username: value, password: value }`
+and is used to obtain a session for subsequent calls.
+
+** there are problems with their session api, so for now we have to pass the apikey: value in the credentials so they
+get stored in the code and passed along instead of the sessionKey.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/KPB-US/swhd_api.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swhd_api"
+
+# 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 "irb"
+IRB.start

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/lib/swhd_api.rb

@@ -0,0 +1,102 @@
+require 'swhd_api/version'
+require 'swhd_api/exceptions'
+require 'typhoeus'
+require 'json'
+
+module SwhdApi
+  # main api helper class
+  class Manager
+    attr_reader :session_id
+    attr_reader :url
+    attr_accessor :logger
+
+    def initialize(url = nil, options = {})
+      raise SwhdApi::MissingUrl if url.nil? || url.empty?
+      # TODO: strip trailing slash if any
+      @url = url
+      @options = options
+    end
+
+    def connect(credentials = {})
+      if credentials.key?(:apikey)
+        # HACK: remove once SolarWinds get the sessionKey working as documented
+        @session_id = credentials[:apikey]
+        return
+
+      elsif credentials.key?(:username) && credentials.key?(:password)
+        # use username and password
+        # @session_id = "2"
+      elsif credentials.key?(:techkey)
+        # use tech's key
+        # @session_id = "3"
+      else
+        raise MissingCredentials, ':apikey or :techkey or :username and :password'
+      end
+
+      results = request('Session', :get, credentials) # { "apiKey" => credentials[:apikey] })
+      @session_id = results['sessionKey']
+    end
+
+    def request(resource, method, params = {}, body = {})
+      raise NoSession if @session_id.nil? && resource != 'Session'
+      raise MissingResource if resource.nil? || resource.empty?
+
+      endpoint = "#{@url}/#{resource}"
+      # TODO: log a call to solarwinds and find out why no one can do this (other users on their forums)
+      # HACK: for now, use apikey instead of session key
+      params['apiKey'] = @session_id
+      payload = @options.dup
+      payload[:params] = params.reject { |_k, v| v.nil? }
+
+      response =
+        case method
+        when :post
+          payload[:body] = body.to_json
+          Typhoeus::Request.post(endpoint, payload)
+        when :get
+          Typhoeus::Request.get(endpoint, payload)
+        when :put
+          payload[:body] = body.to_json
+          Typhoeus::Request.put(endpoint, payload)
+        when :delete
+          Typhoeus::Request.delete(endpoint, payload)
+        end
+
+      if response.timed_out?
+        raise TimedOut, response.body
+      elsif response.code == 0
+        raise NoResponse, response.body
+      elsif response.return_code == :partial_file
+        raise PartialFile, response.body
+      elsif !response.success?
+        raise AuthenticationFailure, response.return_message if response.code == 401
+        raise RequestFailed, "Response Code: #{response.code}\n
+          Return Code: #{response.return_code} - #{response.return_message}\n
+          #{response.body}"
+      end
+
+      @logger.debug response.body unless @logger.nil?
+
+      JSON.parse(response.body)
+    end
+
+    # fetch all pages of results
+    def fetch(resource, params = {})
+      method = :get
+      page = 1
+
+      params[:page] = page
+      partial = request(resource, method, params)
+      while partial.is_a?(Array) && !partial.empty?
+        results ||= []
+        results += partial
+        page += 1
+        params[:page] = page
+        partial = request(resource, method, params)
+      end
+
+      results = partial unless partial.nil? || partial.empty?
+      results
+    end
+  end
+end

data/lib/swhd_api/exceptions.rb

@@ -0,0 +1,11 @@
+module SwhdApi
+  class AuthenticationFailure < StandardError; end
+  class MissingCredentials < ArgumentError; end
+  class MissingUrl < ArgumentError; end
+  class NoSession < StandardError; end
+  class MissingResource < ArgumentError; end
+  class TimedOut < StandardError; end
+  class PartialFile < StandardError; end
+  class NoResponse < StandardError; end
+  class RequestFailed < StandardError; end
+end

data/lib/swhd_api/version.rb

@@ -0,0 +1,3 @@
+module SwhdApi
+  VERSION = '0.1.0'.freeze
+end

data/swhd_api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swhd_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swhd_api"
+  spec.version       = SwhdApi::VERSION
+  spec.authors       = ["Marvin Frederickson"]
+  spec.email         = ["mfrederickson@kpb.us"]
+
+  spec.summary       = %q{A helper gem to access the solarwinds helpdesk api}
+  spec.description   = %q{A helper gem to access the solarwinds helpdesk api}
+  spec.homepage      = "http://github.com/KPB-US/swhd-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'typhoeus', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: swhd_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marvin Frederickson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: A helper gem to access the solarwinds helpdesk api
+email:
+- mfrederickson@kpb.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/swhd_api.rb
+- lib/swhd_api/exceptions.rb
+- lib/swhd_api/version.rb
+- swhd_api.gemspec
+homepage: http://github.com/KPB-US/swhd-api
+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.4.3
+signing_key: 
+specification_version: 4
+summary: A helper gem to access the solarwinds helpdesk api
+test_files: []