help_spot_issues 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+Gemfile.lock
+.bundle

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Jon Phenow, Ian Ehlert
+
+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

@@ -0,0 +1,27 @@
+
+= HelpSpot
+
+Ruby gem to talk to the API of a HelpSpot instance.
+
+For information on HelpSpot: http://www.userscape.com/products/helpspot/
+
+Details of HelpSpot's API are at: http://www.userscape.com/helpdesk/index.php?pg=kb.book&id=6
+
+== License
+
+Licensed under the MIT License. See the included LICENSE file.
+
+= Usage
+
+== Installation
+
+Copy the <tt>config/help_spot.yml.sample</tt> file to <tt>THE_ROOT_DIR_OF_YOUR_APP/config/help_spot.yml</tt>. Edit the file to have some sensible values.
+
+Somewhere in your application, you'll want to do this once:
+
+<tt>HelpSpot.configure</tt>
+
+In my app, it also turns out it's useful to do this once:
+
+<tt>HELPSPOT_CATEGORIES = HelpSpot.category_key_value_pairs</tt>
+

data/Rakefile

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

data/config/help_spot.yml.sample

@@ -0,0 +1,6 @@
+root_url: http://www.example.com/helpspot/api/index.php?format=json
+username: helpspot_user@example.com
+password: my_p@ssw0rd
+hidden_categories: 
+  - Deactivations
+  - 'Contact Us'

data/help_spot_issues.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "help_spot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "help_spot_issues"
+  s.version     = HelpSpot::VERSION
+  s.authors     = ["Jon Phenow"]
+  s.email       = ["j.phenow@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Connector to Help Spot API}
+  s.description = %q{}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/help_spot.rb

@@ -0,0 +1,6 @@
+require 'uri'
+require 'net/http'
+require 'json'
+require 'yaml'
+
+require 'help_spot/base'

data/lib/help_spot/base.rb

@@ -0,0 +1,109 @@
+##
+# help_spot
+#
+# A partial basic implementation of a HelpSpot API interface
+#
+# == Using help_spot
+#
+# === Basics
+#
+# Copy and edit the included config file. Include the gem in your app. Call the configure method. Hit the API.
+#
+#   require 'help_spot'
+#   HelpSpot.configure(:app_root => '/my_app/')
+#   HelpSpot.forums_list
+#
+#   => [{"xForumId"=>"1", "fClosed"=>"0", "sForumName"=>"The First Forum", "iOrder"=>"0", "sDescription"=>"A test forum"}, {"xForumId"=>"2", "fClosed"=>"0", "sForumName"=>"Secondary Forum", "iOrder"=>"0", "sDescription"=>"Forum #2"}]
+#
+
+module HelpSpot
+  class << self
+
+    # Loads the config file.
+    # 
+    # == Options
+    # * app_root (optional)
+    #     Path to the root directory of your app. Shouldn't be required when using merb or Rails.
+    # * config_file (optional)
+    #     Defaults to '/config/help_spot.yml'
+    #
+    def configure(args={})    
+      # work out the default app_root
+      app_root = args[:app_root] || '.'
+
+      config_file = args[:config_file] || '/config/help_spot.yml'
+      yml_file    = app_root+config_file
+
+      raise yml_file+" not found" unless File.exist? yml_file
+      @config = YAML.load(File.open yml_file)
+      @config["api_url"] = @config["root_url"] + "/api/index.php?output=json"
+    end
+
+    def root_url
+      @config["root_url"]
+    end
+
+    def get_request(request_id)
+      JSON.parse(api_request('private.request.get', 'GET', {:xRequest => request_id})) if request_id
+    end
+
+    def get_changed(time, category)
+      requests = []
+      req_ids = JSON.parse(api_request('private.request.getChanged', 'GET', {:dtGMTChange => time.to_i}))["xRequest"]
+      req_ids.uniq!
+      req_ids.each do |req_id|
+        request = get_request(req_id)
+        requests << request if request["xCategory"] == category
+      end
+      requests
+    end
+
+    def get_custom_fields(category=nil)
+      JSON.parse(api_request('private.request.getCustomFields', 'GET', {:xCategory => category}))["field"]
+    end
+
+    def get_categories(category=nil)
+      JSON.parse(api_request('request.getCategories', 'GET'))["category"]
+    end
+
+    def categories(args={})
+      res = api_request('private.request.getCategories', 'GET')
+      res = JSON.parse(res)['category'] rescue []
+
+      unless args[:include_deleted] and args[:include_deleted] == true
+        res.reject!{|k, v| v['fDeleted'] == '1'} rescue []
+      end
+
+      return res
+    end
+
+    def update_request(options)
+      JSON.parse(api_request('private.request.update', 'POST', options))
+    end
+
+    def api_request(api_method, http_method='POST', args={})
+      api_params =  {:method => api_method, :output => 'json'}.merge(args)
+      query_params = api_params.collect{|k,v| [k.to_s, v.to_s]} # [URI.encode(k.to_s),URI.encode(v.to_s.gsub(/\ /, '+'))]
+      built_query  = query_params.collect{|i| i.join('=')}.join('&') # make a query string
+
+      ru = URI::parse(@config['api_url']) # where ru = ROOT_URL
+      merged_query = [built_query, (ru.query == '' ? nil : ru.query)].compact.join('&') # merge our generated query string with the ROOT_URL's query string
+
+      url = URI::HTTP.new(ru.scheme, ru.userinfo, ru.host, ru.port, ru.registry, ru.path, ru.opaque, merged_query, ru.fragment)
+
+      if http_method == 'POST'
+        req = Net::HTTP::Post.new(url.path)
+        req.set_form_data(query_params)
+        req.basic_auth @config['username'], @config['password']
+        res = Net::HTTP.new(url.host, url.port).start {|http| http.request(req) }
+      else
+        req = Net::HTTP::Get.new(url.path+'?'+url.query)
+        req.basic_auth @config['username'], @config['password']
+        res = Net::HTTP.start(url.host, url.port) {|http| http.request(req) }
+      end
+
+      res.body
+    end
+
+  end # class
+end # module

data/lib/help_spot/version.rb

@@ -0,0 +1,3 @@
+module HelpSpot
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: help_spot_issues
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon Phenow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- j.phenow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- config/help_spot.yml.sample
+- help_spot_issues.gemspec
+- lib/help_spot.rb
+- lib/help_spot/base.rb
+- lib/help_spot/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Connector to Help Spot API
+test_files: []