roust 1.3.0 → 1.4.0

data/lib/roust.rb

@@ -1,12 +1,16 @@
 require 'httparty'
 require 'mail'
 require 'active_support/core_ext/hash'
-
-class Unauthenticated < Exception ; end
+require 'roust/ticket'
+require 'roust/queue'
+require 'roust/user'
+require 'roust/exceptions'
 
 class Roust
   include HTTParty
-  #debug_output
+  include Roust::Ticket
+  include Roust::Queue
+  include Roust::User
 
   def initialize(credentials)
     server   = credentials[:server]
@@ -43,358 +47,48 @@ class Roust
     authenticated?
   end
 
-  def show(id)
-    response = self.class.get("/ticket/#{id}/show")
-
-    body, status = explode_response(response)
-
-    if match = body.match(/^# (Ticket (\d+) does not exist\.)/)
-      return { 'error' => match[1] }
-    end
-
-    # Replace CF spaces with underscores
-    while body.match(/CF\.\{[\w_ ]*[ ]+[\w ]*\}/)
-      body.gsub!(/CF\.\{([\w_ ]*)([ ]+)([\w ]*)\}/, 'CF.{\1_\3}')
-    end
-
-    # Sometimes the API returns requestors formatted like this:
-    #
-    #   Requestors: foo@example.org,
-    #               bar@example.org, baz@example.org
-    #               qux@example.org, quux@example.org,
-    #               corge@example.org
-    #
-    # Turn it into this:
-    #
-    #   Requestors: foo@example.org, bar@example.org, baz@example.org, ...
-    #
-    body.gsub!(/\n\n/, "\n")
-
-    %w(Requestors Cc AdminCc).each do |field|
-      body.gsub!(/^#{field}:(.+)^\n/m) do |match|
-        match.strip.split(/,\s+/).join(', ').strip
-      end
-    end
-
-    message = Mail.new(body)
-
-    hash = Hash[message.header.fields.map {|header|
-      key   = header.name.to_s
-      value = header.value.to_s
-      [ key, value ]
-    }]
-
-    %w(Requestors Cc AdminCc).each do |field|
-      hash[field] = hash[field].split(', ') if hash[field]
-    end
-
-    hash["id"] = hash["id"].split('/').last
-
-    hash
-  end
-
-  def create(attrs)
-    default_attrs = {
-      'id' => 'ticket/new'
-    }
-    attrs = default_attrs.merge(attrs).stringify_keys!
-
-    if error = create_invalid?(attrs)
-      return {'error' => error }
-    end
-
-    attrs['Text'].gsub!(/\n/,"\n ") if attrs['Text'] # insert a space on continuation lines.
-
-    # We can't set more than one AdminCc when creating a ticket. WTF RT.
-    #
-    # Delete it from the ticket we are creating, and we'll update the ticket
-    # after we've created.
-    admincc = attrs.delete("AdminCc")
-
-    content = attrs.map { |k,v|
-      # Don't lowercase strings if they're already camel cased.
-      k = case
-      when k.is_a?(Symbol)
-        k.to_s
-      when k == 'id'
-        k
-      when k =~ /^[a-z]/
-        k.capitalize
-      else
-        k
-      end
-
-      v = v.join(', ') if v.respond_to?(:join)
-
-      "#{k}: #{v}"
-    }.join("\n")
-
-    response = self.class.post(
-      "/ticket/new",
-      :body => {
-        :content => content
-      },
-    )
-
-    body, status = explode_response(response)
-
-    case body
-    when /^# Could not create ticket/
-      false
-    when /^# Syntax error/
-      false
-    when /^# Ticket (\d+) created/
-      id = body[/^# Ticket (\d+) created/, 1]
-      update(id, 'AdminCc' => admincc) if admincc
-      show(id)
-    else
-      # We should never hit this, but if we do, just pass it through and
-      # surprise the user (!!!).
-      body
-    end
-  end
-
-  def update(id, attrs)
-    content = compose_content('ticket', id, attrs)
-
-    response = self.class.post(
-      "/ticket/#{id}/edit",
-      :body => {
-        :content => content
-      },
-    )
-
-    body, status = explode_response(response)
-
-    case body
-    when /^# You are not allowed to modify ticket \d+/
-      { 'error' => body.strip }
-    when /^# Syntax error/
-      { 'error' => body.strip }
-    when /^# Ticket (\d+) updated/
-      id = body[/^# Ticket (\d+) updated/, 1]
-      show(id)
-    else
-      # We should never hit this, but if we do, just pass it through and
-      # surprise the user (!!!).
-      body
-    end
-  end
-
   def authenticated?
     return true if show('1')
   end
 
-  def search(query)
-    params = {
-      :query  => query,
-      :format => 's',
-      :orderby => '+id'
-    }
-    response = self.class.get("/search/ticket", :query => params)
-    body = response.body
-    body.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n\n/,"")
-
-    body.split("\n").map do |t|
-      id, subject = t.split(': ', 2)
-      {'id' => id, 'Subject' => subject}
-    end
-  end
-
-  def history(id, opts={})
-    options = {
-      :format   => 'short',
-      :comments => false
-    }.merge(opts)
-
-    format   = options[:format]
-    comments = options[:comments]
-    params = {
-      :format => format[0]
-    }
-
-    response = self.class.get("/ticket/#{id}/history", :query => params)
-
-    body, status = explode_response(response)
-
-    case format
-    when 'short'
-      parse_short_history(body, :comments => comments)
-    when 'long'
-      parse_long_history(body, :comments => comments)
-    end
-  end
-
-  # id can be numeric (e.g. 28) or textual (e.g. sales)
-  def queue(id)
-    response = self.class.get("/queue/#{id}")
-
-    body, status = explode_response(response)
-    case body
-    when /No queue named/
-      nil
-    else
-      body.gsub!(/\n\s*\n/,"\n") # remove blank lines for Mail
-      message = Mail.new(body)
-      Hash[message.header.fields.map {|header|
-        key   = header.name.to_s.downcase
-        value = header.value.to_s
-        [ key, value ]
-      }]
-    end
-  end
-
-  # id can be numeric (e.g. 28) or textual (e.g. john)
-  def user_show(id)
-    response = self.class.get("/user/#{id}")
-
-    body, status = explode_response(response)
-    case body
-    when /No user named/
-     nil
-    else
-      body.gsub!(/\n\s*\n/,"\n") # remove blank lines for Mail
-      message = Mail.new(body)
-      Hash[message.header.fields.map {|header|
-        key   = header.name.to_s.downcase
-        value = header.value.to_s
-        [ key, value ]
-      }]
-    end
-  end
-
-  alias :user :user_show
-
-  def user_update(id, attrs)
-    content = compose_content('user', id, attrs)
-
-    response = self.class.post(
-      "/user/#{id}/edit",
-      :body => {
-        :content => content
-      },
-    )
-
-    body, status = explode_response(response)
-
-    case body
-    when /^# You are not allowed to modify user \d+/
-      { 'error' => body.strip }
-    when /^# Syntax error/
-      { 'error' => body.strip }
-    when /^# User (.+) updated/
-      id = body[/^# User (.+) updated/, 1]
-      user_show(id)
-    else
-      # We should never hit this, but if we do, just pass it through and
-      # surprise the user (!!!).
-      body
-    end
-  end
-
   private
+
   def compose_content(type, id, attrs)
     default_attrs = {
       'id' => [ type, id ].join('/')
     }
     attrs = default_attrs.merge(attrs).stringify_keys!
 
-    content = attrs.map { |k,v|
+    content = attrs.map do |k, v|
       # Don't lowercase strings if they're already camel cased.
       k = case
-      when k.is_a?(Symbol)
-        k.to_s
-      when k == 'id'
-        k
-      when k =~ /^[a-z]/
-        k.capitalize
-      else
-        k
-      end
+          when k.is_a?(Symbol)
+            k.to_s
+          when k == 'id'
+            k
+          when k =~ /^[a-z]/
+            k.capitalize
+          else
+            k
+          end
 
       v = v.join(', ') if v.respond_to?(:join)
 
       "#{k}: #{v}"
-    }.join("\n")
+    end
+
+    content.join("\n")
   end
 
   def explode_response(response)
     body   = response.body
     status = body[/RT\/\d+\.\d+\.\d+\s(\d{3}\s.*)\n/, 1]
 
-    body.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n/,"")
+    body.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n/, '')
     body = body.empty? ? nil : body.lstrip
 
-    raise Unauthenticated, "Invalid username or password" if status =~ /401 Credentials required/
+    raise Unauthenticated, 'Invalid username or password' if status =~ /401 Credentials required/
 
     return body, status
   end
-
-  def create_invalid?(attrs)
-    missing = %w(id Subject Queue).find_all {|k| !attrs.include?(k) }
-
-    if missing.empty?
-      return false
-    else
-      "Needs attributes: #{missing.join(', ')}"
-    end
-  end
-
-  def parse_short_history(body, opts={})
-    comments = opts[:comments]
-    regex    = comments ? '^\d+:' : '^\d+: [^Comments]'
-    history  = body.split("\n").select { |l| l =~ /#{regex}/ }
-    history.map { |l| l.split(": ", 2) }
-  end
-
-  def parse_long_history(body, opts={})
-    comments = opts[:comments]
-    items = body.split("\n--\n")
-    list = []
-    items.each do |item|
-      # Yes, this messes with the "content:" field but that's the one that's upsetting Mail.new
-      item.gsub!(/\n\s*\n/,"\n") # remove blank lines for Mail
-      history = Mail.new(item)
-      next if not comments and history['type'].to_s =~ /Comment/ # skip comments
-      reply = {}
-
-      history.header.fields.each_with_index do |header, index|
-        next if index == 0
-
-        key   = header.name.to_s.downcase
-        value = header.value.to_s
-
-        attachments = []
-        case key
-        when "attachments"
-          temp = item.match(/Attachments:\s*(.*)/m)
-          if temp.class != NilClass
-            atarr = temp[1].split("\n")
-            atarr.map { |a| a.gsub!(/^\s*/,"") }
-            atarr.each do |a|
-              i = a.match(/(\d+):\s*(.*)/)
-              s = {
-                :id   => i[1].to_s,
-                :name => i[2].to_s
-              }
-              sz = i[2].match(/(.*?)\s*\((.*?)\)/)
-              if sz.class == MatchData
-                s[:name] = sz[1].to_s
-                s[:size] = sz[2].to_s
-              end
-              attachments << s
-            end
-            reply["attachments"] = attachments
-          end
-        when "content"
-          reply["content"] = value
-        else
-          reply["#{key}"] = value
-        end
-      end
-      list << reply
-    end
-
-    return list
-  end
 end

data/roust.gemspec

@@ -1,25 +1,25 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "roust/version"
+$LOAD_PATH.push(File.expand_path('../lib', __FILE__))
+require 'roust/version'
 
 Gem::Specification.new do |s|
-  s.name    = "roust"
+  s.name    = 'roust'
   s.version = Roust::VERSION
-  s.date    = %q{2014-01-23}
+  s.date    = Time.now.strftime('%Y-%m-%d')
 
-  s.authors = [ "Lindsay Holmwood" ]
-  s.email   = [ "lindsay@holmwood.id.au" ]
-  s.summary      = %q{Ruby client for RT's REST API}
-  s.description  = %q{Roust is a Ruby API client that accesses the REST interface version 1.0 of a Request Tracker instance. See http://www.bestpractical.com/ for Request Tracker.}
-  s.homepage     = "http://github.com/bulletproofnetworks/roust"
-  s.license      = "Apache 2.0"
+  s.authors = ['Lindsay Holmwood']
+  s.email   = ['lindsay@holmwood.id.au']
+  s.summary      = "Ruby client for RT's REST API"
+  s.description  = 'Roust is a Ruby API client that accesses the REST interface version 1.0 of a Request Tracker instance. See http://www.bestpractical.com/ for Request Tracker.'
+  s.homepage     = 'http://github.com/bulletproofnetworks/roust'
+  s.license      = 'Apache 2.0'
 
-  s.required_ruby_version     = ">= 1.9.2"
+  s.required_ruby_version     = '>= 1.9.2'
 
   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"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = %w(lib)
 
   s.add_runtime_dependency 'mail',                '>= 2.5.4'
   s.add_runtime_dependency 'httparty',            '>= 0.13.1'

data/spec/mocks/ticket-1-show-unauthenticated.txt

@@ -0,0 +1 @@
+RT/3.4.6 401 Credentials required

data/spec/roust/authentication_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'roust'
+
+describe Roust do
+  include_context 'credentials'
+
+  describe 'authentication' do
+    it 'authenticates on instantiation' do
+      @rt = Roust.new(credentials)
+      expect(@rt.authenticated?).to eq(true)
+    end
+
+    it 'errors when credentials are incorrect' do
+      mocks_path = Pathname.new(__FILE__).parent.parent.join('mocks')
+
+      stub_request(:post, 'http://rt.example.org/index.html').
+        with(:body => {
+              'user'=>'admin',
+              'pass'=>'incorrect',
+             }).
+        to_return(:status => 200, :body => '', :headers => {})
+
+      stub_request(:get, 'http://rt.example.org/REST/1.0/ticket/1/show').
+        to_return(:status  => 200,
+                  :body    => mocks_path.join('ticket-1-show-unauthenticated.txt').read,
+                  :headers => {})
+
+      credentials.merge!({:username => 'admin', :password => 'incorrect'})
+
+      expect { Roust.new(credentials) }.to raise_error(Unauthenticated)
+    end
+  end
+end

data/spec/roust/queue_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'roust'
+
+describe Roust do
+  include_context 'credentials'
+
+  before do
+    mocks_path = Pathname.new(__FILE__).parent.parent.join('mocks')
+
+    stub_request(:get, 'http://rt.example.org/REST/1.0/queue/13')
+       .to_return(:status => 200,
+                  :body    => mocks_path.join('queue-13.txt').read,
+                  :headers => {})
+
+    stub_request(:get, 'http://rt.example.org/REST/1.0/queue/nil')
+       .to_return(:status => 200,
+                  :body    => mocks_path.join('queue-nil.txt').read,
+                  :headers => {})
+
+    @rt = Roust.new(credentials)
+    expect(@rt.authenticated?).to eq(true)
+  end
+
+  describe 'queue' do
+    it 'can lookup queue details' do
+      attrs = %w(id name description correspondaddress commentaddress) +
+              %w(initialpriority finalpriority defaultduein)
+
+      queue = @rt.queue('13')
+      attrs.each do |attr|
+        expect(queue[attr]).to_not eq(nil), "#{attr} key doesn't exist"
+      end
+    end
+
+    it 'returns nil for unknown queues' do
+      queue = @rt.queue('nil')
+      expect(queue).to eq(nil)
+    end
+  end
+end

data/spec/roust/ticket_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'roust'
+
+describe Roust do
+  include_context 'credentials'
+
+  before do
+    mocks_path = Pathname.new(__FILE__).parent.parent.join('mocks')
+
+    stub_request(:get, 'http://rt.example.org/REST/1.0/search/ticket?format=s&orderby=%2Bid&query%5Bquery%5D=id%20=%201%20or%20id%20=%202')
+       .to_return(:status  => 200,
+                  :body    => mocks_path.join('ticket-search-1-or-2.txt').read,
+                  :headers => {})
+
+    stub_request(:get, 'http://rt.example.org/REST/1.0/ticket/1/history?format=s')
+       .to_return(:status  => 200,
+                  :body    => mocks_path.join('ticket-1-history-short.txt').read,
+                  :headers => {})
+
+    stub_request(:get, 'http://rt.example.org/REST/1.0/ticket/1/history?format=l')
+       .to_return(:status  => 200,
+                  :body    => mocks_path.join('ticket-1-history-long.txt').read,
+                  :headers => {})
+
+    @rt = Roust.new(credentials)
+    expect(@rt.authenticated?).to eq(true)
+  end
+
+  describe 'tickets' do
+    it 'can list tickets matching a query' do
+      results = @rt.search(:query => 'id = 1 or id = 2')
+      expect(results.size).to eq(2)
+      results.each do |result|
+        expect(result.size).to eq(2)
+      end
+    end
+
+    it 'can fetch metadata on individual tickets' do
+      ticket = @rt.show('1')
+      expect(ticket).to_not eq(nil)
+
+      attrs = %w(id Subject Queue) +
+              %w(Requestors Cc AdminCc Owner Creator) +
+              %w(Resolved Status) +
+              %w(Starts Started TimeLeft Due TimeWorked TimeEstimated) +
+              %w(LastUpdated Created Told) +
+              %w(Priority FinalPriority InitialPriority)
+
+      attrs.each do |attr|
+        expect(ticket[attr]).to_not eq(nil), "#{attr} key doesn't exist"
+      end
+
+      %w(Requestors Cc AdminCc).each do |field|
+        expect(ticket[field].size).to be > 1
+      end
+    end
+
+    it 'can fetch transactions on individual tickets' do
+      short = @rt.history('1', :format => 'short')
+
+      expect(short.size).to be > 1
+      short.each do |txn|
+        expect(txn.size).to eq(2)
+        expect(txn.first).to match(/^\d+$/)
+        expect(txn.last).to match(/^\w.*\w$/)
+      end
+
+      attrs = %w(ticket data oldvalue timetaken) +
+              %w(id type field newvalue content description)
+
+      long = @rt.history('1', :format => 'long')
+      expect(long.size).to be > 0
+      long.each do |txn|
+        attrs.each do |attr|
+          expect(txn[attr]).to_not eq(nil), "#{attr} key doesn't exist"
+        end
+      end
+    end
+  end
+end

data/spec/roust/user_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'roust'
+
+describe Roust do
+  include_context 'credentials'
+
+  before do
+    mocks_path = Pathname.new(__FILE__).parent.parent.join('mocks')
+
+    stub_request(:get, 'http://rt.example.org/REST/1.0/user/dan@us.example')
+       .to_return(:status  => 200,
+                  :body    => mocks_path.join('user-dan@us.example.txt').read,
+                  :headers => {})
+
+    stub_request(:get, 'http://rt.example.org/REST/1.0/user/nil')
+       .to_return(:status  => 200,
+                  :body    => mocks_path.join('user-nil.txt').read,
+                  :headers => {})
+
+    stub_request(:post, 'http://rt.example.org/REST/1.0/user/dan@us.example/edit')
+         .with(:body => 'content=id%3A%20user%2Fdan%40us.example%0ARealName%3A%20Daniel%20Smith')
+         .to_return(:status => 200,
+                    :body   => mocks_path.join('user-dan@us.example-edit.txt').read,
+                    :headers => {})
+
+    @rt = Roust.new(credentials)
+    expect(@rt.authenticated?).to eq(true)
+  end
+
+  describe 'user' do
+    it 'can lookup user details' do
+      attrs = %w(name realname gecos nickname emailaddress id lang password)
+
+      user = @rt.user_show('dan@us.example')
+      attrs.each do |attr|
+        expect(user[attr]).to_not eq(nil), "#{attr} key doesn't exist"
+      end
+    end
+
+    it 'returns nil for unknown users' do
+      queue = @rt.user_show('nil')
+      expect(queue).to eq(nil)
+    end
+
+    it 'can modify an existing user' do
+      mocks_path = Pathname.new(__FILE__).parent.parent.join('mocks')
+      stub_request(:get, 'http://rt.example.org/REST/1.0/user/dan@us.example')
+         .to_return(:status  => 200,
+                    :body    => mocks_path.join('user-dan@us.example-after-edit.txt').read,
+                    :headers => {})
+
+      attrs = {'RealName' => 'Daniel Smith'}
+      user  = @rt.user_update('dan@us.example', attrs)
+
+      expect(user['realname']).to eq('Daniel Smith')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,20 +7,39 @@
 
 require 'pathname'
 lib = Pathname.new(__FILE__).parent.parent.join('lib').to_s
-$: << lib
+$LOAD_PATH << lib
 require 'webmock/rspec'
 
 RSpec.configure do |config|
-  # Use color in STDOUT
-  config.color_enabled = true
-
   # Use color not only in STDOUT but also in pagers and files
   config.tty = true
+end
+
+# Boilerplate for all tests.
+#
+# All tests need to authenticate before they can do anything, so mock it out.
+RSpec.shared_context 'credentials' do
+  let :credentials do
+    {
+      :server   => 'http://rt.example.org',
+      :username => 'admin',
+      :password => 'password'
+    }
+  end
 
-  # Use the specified formatter
-  config.formatter = :documentation # :progress, :html, :textmate
+  before(:each) do
+    mocks_path = Pathname.new(__FILE__).parent.join('mocks')
 
-  # Rspec 3 forward compatibility
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-end
+    stub_request(:post, 'http://rt.example.org/index.html')
+      .with(:body => {
+              'user' => 'admin',
+              'pass' => 'password'
+            })
+      .to_return(:status => 200, :body => '', :headers => {})
 
+    stub_request(:get, 'http://rt.example.org/REST/1.0/ticket/1/show')
+      .to_return(:status  => 200,
+                 :body    => mocks_path.join('ticket-1-show.txt').read,
+                 :headers => {})
+  end
+end