help_spot 0.0.2 → 0.0.3

data/.gitignore

@@ -1,4 +1,4 @@
 pkg
 doc
 *.gem
-config/help_spot.yml
+*.gemspec

data/README.rdoc

@@ -6,20 +6,22 @@ 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
+= Installation
 
-Licensed under the MIT License. See the included LICENSE file.
+A gem has been pushed to gemcutter[http://gemcutter.org/]
 
-= Usage
+Once you have gemcutter setup as a gem source:
 
-== Installation
+  gem install help_spot
 
-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.
+= Usage
 
-Somewhere in your application, you'll want to do this once:
+  help_spot = HelpSpot.new("https://support.yourwebsite.com/api/", "user@localhost.com", "sekrit")
 
-<tt>HelpSpot.configure</tt>
+== Documentation
 
-In my app, it also turns out it's useful to do this once:
+Documentation is hosted at rdoc.info[http://rdoc.info/projects/jnewland/help_spot]
+
+== License
 
-<tt>HELPSPOT_CATEGORIES = HelpSpot.category_key_value_pairs</tt>
+Licensed under the MIT License. See the included LICENSE file.

data/Rakefile

@@ -1,21 +1,25 @@
-require 'rubygems'
-require 'rake'
+$LOAD_PATH.unshift 'lib'
+require 'help_spot/version'
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
+    gem.version = HelpSpot::VERSION
     gem.name = "help_spot"
-    gem.summary = %Q{A package for interacting with UserScape's HelpSpot product.}
-    gem.description = %Q{A package for interacting with UserScape's HelpSpot product.}
+    gem.summary = %Q{API wrapper for HelpSpot}
+    gem.description = %Q{API wrapper for HelpSpot}
     gem.email = "jnewland@gmail.com"
     gem.homepage = "http://github.com/jnewland/help_spot"
-    gem.authors = ["Jamie Wilson","Jesse Newland"]
-    gem.add_development_dependency "rspec"
+    gem.authors = ["Jesse Newland"]
+    gem.add_development_dependency "rspec", "= 1.3.0"
+    gem.add_development_dependency "fakeweb"
+    gem.add_dependency "hashie", "~> 0.1.8"
+    gem.add_dependency "httparty", "~> 0.5.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
 require 'spec/rake/spectask'
@@ -36,14 +40,10 @@ task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
+  version = HelpSpot::VERSION
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "help_spot #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/TODO

@@ -0,0 +1,35 @@
+Unimplemented API Methods
+
+private.customer.getPasswordByEmail
+private.customer.setPasswordByEmail
+private.request.addTimeEvent
+private.request.deleteTimeEvent
+private.request.getTimeEvents
+private.request.getMailboxes
+private.request.merge
+private.filter.getColumnNames
+private.timetracker.search
+private.user.getFilters
+private.user.preferences
+private.util.getActiveStaff
+customer.getRequests
+request.create
+request.update
+request.getCategories
+request.getCustomFields
+request.get
+forums.list
+forums.get
+forums.getTopics
+forums.getPosts
+forums.createTopic
+forums.createPost
+forums.search
+kb.list
+kb.get
+kb.getBookTOC
+kb.getPage
+kb.search
+kb.voteHelpful
+kb.voteNotHelpful
+util.getFieldLabels

data/lib/help_spot/version.rb

@@ -0,0 +1,3 @@
+class HelpSpot
+  VERSION = '0.0.3'
+end

data/lib/help_spot.rb

@@ -1,200 +1,87 @@
-require 'uri'
-require 'net/http'
-require 'net/https'
-require 'json'
-
-##
-# 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(:config_file => '/path/to/help_spot.yml')
-#   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
-    # * config_file (optional)
-    #     Defaults to '/config/help_spot.yml'
-    #     Shouldn't be required when using merb or Rails.
-    #
-    def configure(args={})
-      # work out the default app_root
-      if defined?(Merb)
-        app_root = Merb.root
-      elsif defined?(Rails)
-        app_root = RAILS_ROOT
-      else
-        app_root = '.'
-      end
-
-      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(yml_file)
-    end
-
-    # sends a feedback request to HelpSpot and returns the request ID number and access key
-    #
-    # == Options
-    # In addition to note you must also have at least one of the following set: first_name, last_name, user_id, email or phone
-    # * note
-    #     The body of the ticket
-    # * category
-    # * first_name
-    # * last_name
-    # * user_id
-    # * email
-    # * phone
-    # * urgent
-    #     A boolean flag. Defaults to false.
-    #
-    def create(args)
-      help_form = {:tNote       => args[:note],
-                   :xCategory   => args[:category],
-                   :sFirstName  => args[:first_name],
-                   :sLastName   => args[:last_name],
-                   :sUserId     => args[:user_id],
-                   :sEmail      => args[:email],
-                   :sPhone      => args[:phone],
-                   :fUrgent     => args[:urgent]}.reject!{|k,v| v == nil}
-
-      JSON.parse(api_request('request.create', 'POST', help_form))['xRequest'] rescue []
-    end
-
-    # Returns an array of tickets belonging to a given user id.
-    #
-    # == Authentication
-    # This method does require authentication.
-    #
-    # == Options
-    # * user_id
-    #     The user who's tickets you wish to view.
-    #
-    def get_by_user_id(args)
-      JSON.parse(api_request('private.request.search', 'GET', {:sUserId => args[:user_id]}))['request'] rescue nil
-    end
-
-    # Returns ticket categories.
-    #
-    # == Authentication
-    # This method does require authentication.
-    #
-    # == Options
-    # * include_deleted
-    #     true if you want to include deleted categories.
-    #
-    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
-
-    # Returns an array of non-deleted categories, as key value pairs. Useful for select lists.
-    #
-    # == Authentication
-    # This method does require authentication.
-    #
-    def category_key_value_pairs
-      categories.collect{|k,v| [k,v['sCategory']]} rescue []
-    end
-
-    # Returns non-deleted categories, with a list of predefined categories removed
-    #
-    def category_key_value_pairs_without(categories=nil)
-      categories ||= @config['hidden_categories'] rescue nil
-
-      orig_categories = category_key_value_pairs
-      if categories
-        categories.each do |category|
-          orig_categories.reject!{|i| i[1] == category}
-        end
-      end
-      orig_categories
-    end
-
-    # Returns an array of forums
-    #
-    def forums_list
-      JSON.parse(HelpSpot.api_request('forums.list'))['forum'] rescue []
-    end
-
-    # Returns an array of forums
-    #
-    # == Options
-    # * forum_id
-    #     The numeric id of the forum you want.
-    def forum_get(args)
-      JSON.parse(HelpSpot.api_request('forums.get', 'GET', :xForumId => args[:forum_id])) rescue []
+require 'hashie'
+require 'httparty'
+require 'help_spot/version'
+
+class HelpSpot
+  include HTTParty
+  format :xml
+  mattr_inheritable :base
+
+  def initialize(base, user, pass)
+    self.class.base_uri base
+    self.class.basic_auth user, pass
+  end
+
+  # Verify authentication credentials
+  #
+  def authenticated?
+    version = api_request(:get, 'private.version')
+    return false if version.errors
+    return true if version.results.version
+    false
+  end
+
+  def create_request(options = {})
+    raise ArgumentError unless options[:tNote] && options[:xCategory]
+    raise ArgumentError unless options[:sFirstName] || options[:sLastName] || options[:sUserId] || options[:sEmail] || options[:sPhone]
+    api_request(:post, 'private.request.create', options, :item => 'request').xRequest.to_i
+  end
+
+  def update_request(id, options = {})
+    api_request(:post, 'private.request.update', options.merge(:xRequest => id), :item => 'request').xRequest.to_i
+  end
+
+  def request(id, options = {})
+    response = api_request(:get, 'private.request.get', options.merge(:xRequest => id), :item => 'request')
+    #munge even further the request history
+    response.request_history = response.request_history.map { |item| item[1].first }
+    response
+  end
+
+  def search_requests(options = {})
+    api_request(:get, 'private.request.search', options, {:collection => 'requests', :item => 'request'})
+  end
+
+  def categories
+    api_request(:get, 'private.request.getCategories', {:fDeleted => 0}, {:collection => 'categories', :item => 'category'})
+  end
+
+  def status_types
+    api_request(:get, 'private.request.getStatusTypes', {:fActiveOnly => 1}, {:collection => 'results', :item => 'status'})
+  end
+
+  def custom_fields(options = {})
+    api_request(:get, 'private.request.getCustomFields', options, {:collection => 'customfields', :item => 'field'})
+  end
+
+  def filter(id, options = {})
+    api_request(:get, 'private.filter.get', options.merge(:xFilter => id), {:collection => 'filter', :item => 'request'})
+  end
+
+private
+
+  def api_request(http_method, method, options = {}, munge_options = {})
+    parsed_options = {}
+    if http_method == :get
+      parsed_options[:query] = options
+    else
+      parsed_options[:query] = {}
+      parsed_options[:body] = options
     end
-
-    # Returns an array of topics from a given forum
-    #
-    # == Options
-    # * forum_id
-    #     The numeric id of the forum you want.
-    # * start
-    #     record set position to start at
-    # * length
-    #     how many records to return
-    #
-    def forum_get_topics(args={})
-      JSON.parse(HelpSpot.api_request('forums.getTopics', 'GET', {:xForumId => args[:forum_id]}.merge(args)))['topic'] rescue []
-    end
-
-    # Returns an array of posts from a given topic
-    #
-    # == Options
-    # * topic_id
-    #     The numeric id of the topic
-    #
-    def forum_get_topic_posts(args={})
-      JSON.parse(HelpSpot.api_request('forums.getPosts', 'GET', :xTopicId => args[:topic_id]))['post'] rescue []
-    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['root_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)
-
-      request = nil
-      if http_method == 'POST'
-        request = Net::HTTP::Post.new(url.path)
-        request.set_form_data(query_params)
+    parsed_options[:query].merge!(:method => method)
+    response = self.class.send(http_method, '/index.php', parsed_options)
+    if munge_options[:collection]
+      return [] unless collection = response[munge_options[:collection]][munge_options[:item]]
+      if collection.is_a?(Array)
+        collection.map { |item| Hashie::Mash.new(item) }
       else
-        request = Net::HTTP::Get.new(url.path+'?'+url.query)
+        Hashie::Mash.new(collection)
       end
-      request.basic_auth @config['username'], @config['password']
-      http = Net::HTTP.new(url.host, url.port)
-      http.use_ssl = (url.scheme == 'https')
-      response = http.start { |h| h.request(request) }
-
-      response.body
+    elsif munge_options[:item]
+      Hashie::Mash.new(response[munge_options[:item]])
+    else
+      Hashie::Mash.new(response)
     end
+  end
 
-  end # class
-end # module
+end

data/spec/fixtures/error.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<errors>
+<error>
+<id>2</id>
+<description>User authentication failed</description>
+</error>
+</errors>

data/spec/fixtures/filter.get.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<filter>
+<request>
+<xRequest>12624</xRequest>
+<fOpenedVia>Email</fOpenedVia>
+<xOpenedViaId>Customer.Service</xOpenedViaId>
+<xPersonOpenedBy />
+<xPersonAssignedTo>Henry Yount</xPersonAssignedTo>
+<fOpen>1</fOpen>
+<xStatus>Active</xStatus>
+<fUrgent>0</fUrgent>
+<xCategory>Feature Request</xCategory>
+<dtGMTOpened>July 12, 2007</dtGMTOpened>
+<dtGMTClosed />
+<sRequestPassword>pgupzu</sRequestPassword>
+<sTitle>Upload documents over 1gig</sTitle>
+<sUserId>8389332</sUserId>
+<sFirstName>Harry</sFirstName>
+<sLastName>Waterman</sLastName>
+<sEmail>hw@example.com</sEmail>
+<sPhone>845.555.1234</sPhone>
+<iLastReplyBy>0</iLastReplyBy>
+<fTrash>0</fTrash>
+<dtGMTTrashed />
+<fullname>Harry Waterman</fullname>
+<tNote>I would like to be able to upload documents over 1 gigabyte.</tNote>
+</request>
+<request>
+<xRequest>12451</xRequest>
+<fOpenedVia>Phone</fOpenedVia>
+<xOpenedViaId />
+<xPersonOpenedBy>Tiffany Prince</xPersonOpenedBy>
+<xPersonAssignedTo>Henry Yount</xPersonAssignedTo>
+<fOpen>0</fOpen>
+<xStatus>Problem Solved</xStatus>
+<fUrgent>0</fUrgent>
+<xCategory>Feature Request</xCategory>
+<dtGMTOpened>September 19, 2007</dtGMTOpened>
+<dtGMTClosed>September 30, 2007</dtGMTClosed>
+<sRequestPassword>vyzfua</sRequestPassword>
+<sTitle>Improved searching</sTitle>
+<sUserId />
+<sFirstName>Sarah</sFirstName>
+<sLastName>Ryan</sLastName>
+<sEmail />
+<sPhone />
+<iLastReplyBy>0</iLastReplyBy>
+<fTrash>0</fTrash>
+<dtGMTTrashed />
+<fullname>Sarah Ryan</fullname>
+<tNote>I would like to see the searching imrpoved in the upcoming release.</tNote>
+</request>
+</filter>

data/spec/fixtures/request.get.xml

@@ -0,0 +1,89 @@
+<request>
+<xRequest>12745</xRequest>
+<fOpenedVia>Web Service</fOpenedVia>
+<xOpenedViaId>0</xOpenedViaId>
+<xPersonOpenedBy />
+<xPersonAssignedTo>Ian Landsman</xPersonAssignedTo>
+<fOpen>1</fOpen>
+<xStatus>Active</xStatus>
+<fUrgent>0</fUrgent>
+<xCategory>Bugs</xCategory>
+<dtGMTOpened>September 24, 2007</dtGMTOpened>
+<dtGMTClosed />
+<sRequestPassword>itetxb</sRequestPassword>
+<sTitle />
+<sUserId>12345</sUserId>
+<sFirstName />
+<sLastName />
+<sEmail />
+<sPhone />
+<iLastReplyBy>Ian Landsman</iLastReplyBy>
+<fTrash>0</fTrash>
+<dtGMTTrashed />
+<fullname> </fullname>
+<request_history>
+<item>
+<xRequestHistory>1378</xRequestHistory>
+<xRequest>12745</xRequest>
+<xPerson>Ian Landsman</xPerson>
+<dtGMTChange>Tue, September 25, 2007, 11:00 AM</dtGMTChange>
+<fPublic>1</fPublic>
+<fInitial>0</fInitial>
+<tLog />
+<tNote><p>An HTML note example</p></tNote>
+<tEmailHeaders />
+<fNoteIsHTML>1</fNoteIsHTML>
+<fMergedFromRequest>0</fMergedFromRequest>
+<files>
+<file>
+<sFileMimeType>application/pdf</sFileMimeType>
+<sFilename>Invoice.pdf</sFilename>
+<xDocumentId>60</xDocumentId>
+<public_url>http://www.domain.com/index.php?pg=file&from=3&id=60&reqid=12745&reqhisid=1378</public_url>
+<private_url>http://www.domain.com/admin.php?pg=file&from=0&id=60&showfullsize=1&download=1</private_url>
+</file>
+</files>
+</item>
+<item>
+<xRequestHistory>1377</xRequestHistory>
+<xRequest>12745</xRequest>
+<xPerson>Ian Landsman</xPerson>
+<dtGMTChange>Tue, September 25, 2007, 11:00 AM</dtGMTChange>
+<fPublic>0</fPublic>
+<fInitial>0</fInitial>
+<tLog>Category changed from "" to "Bugs"</tLog>
+<tNote />
+<tEmailHeaders />
+<fNoteIsHTML>0</fNoteIsHTML>
+<fMergedFromRequest>0</fMergedFromRequest>
+</item>
+<item>
+<xRequestHistory>1376</xRequestHistory>
+<xRequest>12745</xRequest>
+<xPerson> </xPerson>
+<dtGMTChange>Mon, September 24, 2007, 08:03 PM</dtGMTChange>
+<fPublic>1</fPublic>
+<fInitial>0</fInitial>
+<tLog />
+<tNote>Plain text update to the request.</tNote>
+<tEmailHeaders />
+<fNoteIsHTML>0</fNoteIsHTML>
+<fMergedFromRequest>0</fMergedFromRequest>
+<files />
+</item>
+<item>
+<xRequestHistory>1375</xRequestHistory>
+<xRequest>12745</xRequest>
+<xPerson> </xPerson>
+<dtGMTChange>Mon, September 24, 2007, 07:44 PM</dtGMTChange>
+<fPublic>1</fPublic>
+<fInitial>1</fInitial>
+<tLog />
+<tNote>This is the request.</tNote>
+<tEmailHeaders />
+<fNoteIsHTML>0</fNoteIsHTML>
+<fMergedFromRequest>0</fMergedFromRequest>
+<files />
+</item>
+</request_history>
+</request>

data/spec/fixtures/request.getCategories.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<categories>
+<category>
+<xCategory>1</xCategory>
+<sCategory>Pre Sales Question</sCategory>
+<fDeleted>0</fDeleted>
+<fAllowPublicSubmit>1</fAllowPublicSubmit>
+<xPersonDefault>1</xPersonDefault>
+<fAutoAssignTo>0</fAutoAssignTo>
+<sPersonList>
+<person>
+<xPerson>3</xPerson>
+<fullname>Steve Benson</fullname>
+<assigned_requests>6</assigned_requests>
+</person>
+<person>
+<xPerson>4</xPerson>
+<fullname>Tiffany Prince</fullname>
+<assigned_requests>7</assigned_requests>
+</person>
+<person>
+<xPerson>5</xPerson>
+<fullname>Henry Yount</fullname>
+<assigned_requests>8</assigned_requests>
+</person>
+</sPersonList>
+<sCustomFieldList>
+<xCustomField>2</xCustomField>
+<xCustomField>13</xCustomField>
+</sCustomFieldList>
+<reportingTags>
+<tag>
+<xReportingTag>5</xReportingTag>
+<sReportingTag>Pricing</sReportingTag>
+</tag>
+<tag>
+<xReportingTag>9</xReportingTag>
+<sReportingTag>Support Options</sReportingTag>
+</tag>
+<tag>
+<xReportingTag>7</xReportingTag>
+<sReportingTag>System Requirements</sReportingTag>
+</tag>
+</reportingTags>
+</category>
+</categories>

data/spec/fixtures/request.getCustomFields.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<customfields>
+<field>
+<xCustomField>10</xCustomField>
+<fieldName>Ajax Lookup</fieldName>
+<isRequired>1</isRequired>
+<isPublic>0</isPublic>
+<fieldType>ajax</fieldType>
+<iOrder>0</iOrder>
+<sTxtSize />
+<lrgTextRows />
+<listItems />
+<iDecimalPlaces>0</iDecimalPlaces>
+<sRegex />
+<sAjaxUrl>http://www.domain.com/ajax_field_lookup.php</sAjaxUrl>
+<isAlwaysVisible>0</isAlwaysVisible>
+</field>
+<field>
+<xCustomField>7</xCustomField>
+<fieldName>VIP Customer</fieldName>
+<isRequired>0</isRequired>
+<isPublic>1</isPublic>
+<fieldType>checkbox</fieldType>
+<iOrder>0</iOrder>
+<sTxtSize />
+<lrgTextRows />
+<listItems />
+<iDecimalPlaces>0</iDecimalPlaces>
+<sRegex />
+<sAjaxUrl />
+<isAlwaysVisible>0</isAlwaysVisible>
+</field>
+<field>
+<xCustomField>2</xCustomField>
+<fieldName>Database Type</fieldName>
+<isRequired>0</isRequired>
+<isPublic>1</isPublic>
+<fieldType>select</fieldType>
+<iOrder>0</iOrder>
+<sTxtSize />
+<lrgTextRows />
+<listItems>
+<item>MySQL</item>
+<item>MS SQL Server</item>
+<item>PostgreSQL</item>
+</listItems>
+<iDecimalPlaces>0</iDecimalPlaces>
+<sRegex />
+<sAjaxUrl />
+<isAlwaysVisible>0</isAlwaysVisible>
+</field>
+</customfields>

data/spec/fixtures/request.getStatusTypes.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<results>
+<status>
+<sStatus>Active</sStatus>
+<xStatus>1</xStatus>
+</status>
+<status>
+<sStatus>Problem Solved</sStatus>
+ 
+<xStatus>3</xStatus>
+</status>
+<status>
+<sStatus>Not Fixable</sStatus>
+<xStatus>4</xStatus>
+</status>
+<status>
+ 
+<sStatus>Customer Unreachable</sStatus>
+<xStatus>5</xStatus>
+</status>
+<status>
+<sStatus>Customer Found Solution</sStatus>
+<xStatus>6</xStatus>
+</status>
+ 
+<status>
+<sStatus>Software Bug</sStatus>
+<xStatus>7</xStatus>
+</status>
+<status>
+<sStatus>SPAM</sStatus>
+<xStatus>2</xStatus>
+ 
+</status>
+</results>

data/spec/fixtures/request.id.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<request>
+<xRequest>12746</xRequest>
+</request>

data/spec/fixtures/request.search.xml

@@ -0,0 +1,52 @@
+<requests>
+<request>
+<xRequest>12650</xRequest>
+<fOpenedVia>Phone</fOpenedVia>
+<xOpenedViaId>0</xOpenedViaId>
+<xPersonOpenedBy>Ian Landsman</xPersonOpenedBy>
+<xPersonAssignedTo>Ian Landsman</xPersonAssignedTo>
+<fOpen>1</fOpen>
+<xStatus>Active</xStatus>
+<fUrgent>1</fUrgent>
+<xCategory>Bugs</xCategory>
+<dtGMTOpened>January 16, 2006</dtGMTOpened>
+<dtGMTClosed />
+<sRequestPassword>oxvgys</sRequestPassword>
+<sTitle>RE: Update on Your Request</sTitle>
+<sUserId />
+<sFirstName />
+<sLastName>landsman</sLastName>
+<sEmail />
+<sPhone />
+<iLastReplyBy>0</iLastReplyBy>
+<fTrash>0</fTrash>
+<dtGMTTrashed />
+<fullname> landsman</fullname>
+<tNote><span class="initsubject">Some text here</span> - Help with printer issue please.</tNote>
+</request>
+<request>
+<xRequest>12733</xRequest>
+<fOpenedVia>Web Service</fOpenedVia>
+<xOpenedViaId>0</xOpenedViaId>
+<xPersonOpenedBy />
+<xPersonAssignedTo>Ian Landsman</xPersonAssignedTo>
+<fOpen>1</fOpen>
+<xStatus>Active</xStatus>
+<fUrgent>0</fUrgent>
+<xCategory>Bugs</xCategory>
+<dtGMTOpened>September 13, 2007</dtGMTOpened>
+<dtGMTClosed />
+<sRequestPassword>bwpkqv</sRequestPassword>
+<sTitle />
+<sUserId>567</sUserId>
+<sFirstName />
+<sLastName />
+<sEmail />
+<sPhone />
+<iLastReplyBy>0</iLastReplyBy>
+<fTrash>0</fTrash>
+<dtGMTTrashed />
+<fullname> </fullname>
+<tNote><span class="initsubject">Text Here</span> - Need printer assistance.</tNote>
+</request>
+</requests>

data/spec/fixtures/version.xml

@@ -0,0 +1,4 @@
+<results> 
+	<version>1.3</version> 
+	<min_version>1.0</min_version> 
+</results>

data/spec/help_spot_spec.rb

@@ -1,7 +1,87 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "HelpSpot" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  it "should provide a version constant" do
+    HelpSpot::VERSION.should be_instance_of(String)
   end
-end
+  before :each do
+    @help_spot = HelpSpot.new("https://support.local/api/", "foobar@localhost.com", "sekrit")
+  end
+  describe "verifying authentcation" do
+    it "returns true when properly authenticated" do
+      @help_spot.stub_get('/api/index.php?method=private.version', 'version.xml')
+      @help_spot.authenticated?.should be_true
+    end
+    it "returns false when not properly authenticated" do
+      @help_spot.stub_http_response_with('error.xml')
+      @help_spot.authenticated?.should be_false
+    end
+  end
+
+  describe 'requests' do
+    describe "being created" do
+      before(:each) do
+        @help_spot.stub_post('/api/index.php?method=private.request.create', 'request.id.xml')
+      end
+      it "require a note, a category, and some contact info" do
+        lambda { @help_spot.create_request() }.should raise_exception
+        lambda { @help_spot.create_request(:tNote => 'foo') }.should raise_exception
+        lambda { @help_spot.create_request(:xCategory => 1) }.should raise_exception
+        lambda { @help_spot.create_request(:tNote => 'foo', :xCategory => 1) }.should raise_exception
+        %w(sFirstName sLastName sUserId sEmail sPhone).each do |valid_contact_info|
+          lambda { @help_spot.create_request(:tNote => 'foo', :xCategory => 1, valid_contact_info.intern => 'foo') }.should_not raise_exception
+        end
+      end
+      it "return the request id" do
+        @help_spot.create_request(:tNote => 'foo', :xCategory => 1, :sEmail => 'needy@customer.com').should == 12746
+      end
+    end
+    describe "being updated" do
+      before(:each) do
+        @help_spot.stub_post('/api/index.php?method=private.request.update', 'request.id.xml')
+      end
+      it "return the request id" do
+        @help_spot.update_request(12746, :tNote => 'foo', :xCategory => 1, :sEmail => 'needy@customer.com').should == 12746
+      end
+    end
+    it "should be accessible" do
+      @help_spot.stub_get('/api/index.php?method=private.request.get&xRequest=12745', 'request.get.xml')
+      request = @help_spot.request(12745)
+      request.xPersonAssignedTo.should == 'Ian Landsman'
+      request.request_history.first.xPerson.should == 'Ian Landsman'
+    end
+    it "should be searchable" do
+      @help_spot.stub_get('/api/index.php?method=private.request.search&sSearch=printer', 'request.search.xml')
+      requests = @help_spot.search_requests(:sSearch => 'printer')
+      requests.first.xPersonAssignedTo.should == 'Ian Landsman'
+    end
+  end
+  describe 'categories' do
+    it "can be listed" do
+      @help_spot.stub_get('/api/index.php?method=private.request.getCategories&fDeleted=0', 'request.getCategories.xml')
+      categories = @help_spot.categories
+      categories.sCategory.should == 'Pre Sales Question'
+    end
+  end
+  describe 'statuses' do
+    it "can be listed" do
+      @help_spot.stub_get('/api/index.php?method=private.request.getStatusTypes&fActiveOnly=1', 'request.getStatusTypes.xml')
+      statues = @help_spot.status_types
+      statues.first.sStatus.should == 'Active'
+    end
+  end
+  describe 'custom fields' do
+    it "can be listed" do
+      @help_spot.stub_get('/api/index.php?method=private.request.getCustomFields', 'request.getCustomFields.xml')
+      fields = @help_spot.custom_fields
+      fields.first.fieldName.should == 'Ajax Lookup'
+    end
+  end
+  describe 'filters' do
+    it "can have their requests retrieved" do
+      @help_spot.stub_get('/api/index.php?method=private.filter.get&xFilter=1234', 'filter.get.xml')
+      requests = @help_spot.filter(1234)
+      requests.first.tNote.should == 'I would like to be able to upload documents over 1 gigabyte.'
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--backtrace

data/spec/spec_helper.rb

@@ -1,9 +1,52 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'help_spot'
 require 'spec'
 require 'spec/autorun'
+require 'fakeweb'
 
-Spec::Runner.configure do |config|
-  
-end
+FakeWeb.allow_net_connect = false
+
+class HelpSpot
+
+  def help_spot_url(path)
+    uri = URI.parse(self.class.default_options[:base_uri])
+    uri.path, uri.query = path.split('?')
+    uri.userinfo = "#{self.class.default_options[:basic_auth][:username]}:#{self.class.default_options[:basic_auth][:password]}".gsub(/@/, '%40')
+    uri.to_s
+  end
+
+  def file_fixture(filename)
+    open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read
+  end
+
+  def stub_get(path, filename, status=nil)
+    options = {:body => file_fixture(filename)}
+    options.merge!({:status => status}) unless status.nil?
+    FakeWeb.register_uri(:get, help_spot_url(path), options)
+  end
+
+  def stub_post(path, filename)
+    FakeWeb.register_uri(:post, help_spot_url(path), :body => file_fixture(filename))
+  end
+
+  def stub_put(path, filename)
+    FakeWeb.register_uri(:put, help_spot_url(path), :body => file_fixture(filename))
+  end
+
+  def stub_delete(path, filename)
+    FakeWeb.register_uri(:delete, help_spot_url(path), :body => file_fixture(filename))
+  end
+
+  def stub_http_response_with(filename)
+    format = filename.split('.').last.intern
+    data = file_fixture(filename)
+
+    response = Net::HTTPOK.new("1.1", 200, "Content for you")
+    response.stub!(:body).and_return(data)
+
+    http_request = HTTParty::Request.new(Net::HTTP::Get, 'http://localhost', :format => format)
+    http_request.stub!(:perform_actual_request).and_return(response)
+
+    HTTParty::Request.should_receive(:new).at_least(1).and_return(http_request)
+  end
+
+end

metadata

@@ -1,29 +1,58 @@
 --- !ruby/object:Gem::Specification 
 name: help_spot
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
-- Jamie Wilson
 - Jesse Newland
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-11 00:00:00 -04:00
+date: 2010-01-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   type: :development
   version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: A package for interacting with UserScape's HelpSpot product.
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.0
+    version: 
+description: API wrapper for HelpSpot
 email: jnewland@gmail.com
 executables: []
 
@@ -32,17 +61,26 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
+- TODO
 files: 
 - .gitignore
-- History.txt
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
-- config/help_spot.yml.sample
-- help_spot.gemspec
+- TODO
 - lib/help_spot.rb
+- lib/help_spot/version.rb
+- spec/fixtures/error.xml
+- spec/fixtures/filter.get.xml
+- spec/fixtures/request.get.xml
+- spec/fixtures/request.getCategories.xml
+- spec/fixtures/request.getCustomFields.xml
+- spec/fixtures/request.getStatusTypes.xml
+- spec/fixtures/request.id.xml
+- spec/fixtures/request.search.xml
+- spec/fixtures/version.xml
 - spec/help_spot_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/jnewland/help_spot
@@ -68,10 +106,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.3
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A package for interacting with UserScape's HelpSpot product.
+summary: API wrapper for HelpSpot
 test_files: 
 - spec/help_spot_spec.rb
 - spec/spec_helper.rb

data/History.txt

@@ -1,14 +0,0 @@
-== 0.0.2 2009-10-11
-
-* Add to SSL
-* Release to Gemcutter
-
-== 0.0.1.4 2009-02-09
-
-* Pushed to github
-
-== 0.0.1   2009-01-05
-
-* 1 major enhancement:
-  * Initial release
-

data/VERSION

@@ -1 +0,0 @@
-0.0.2

data/config/help_spot.yml.sample

@@ -1,6 +0,0 @@
-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.gemspec

@@ -1,54 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{help_spot}
-  s.version = "0.0.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jamie Wilson", "Jesse Newland"]
-  s.date = %q{2009-10-11}
-  s.description = %q{A package for interacting with UserScape's HelpSpot product.}
-  s.email = %q{jnewland@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "History.txt",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "config/help_spot.yml.sample",
-     "help_spot.gemspec",
-     "lib/help_spot.rb",
-     "spec/help_spot_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/jnewland/help_spot}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.3}
-  s.summary = %q{A package for interacting with UserScape's HelpSpot product.}
-  s.test_files = [
-    "spec/help_spot_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
-end