roust 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cef798971363e9cf2f7413d94e90b84573281480
-  data.tar.gz: f6310fab56e67982258e61b0c038aac6b44a266d
+  metadata.gz: b2f1667d37f6c04f786ddb9bd4c437290151f549
+  data.tar.gz: e65c73bab11bd66ec7c904445de4aa7573440f69
 SHA512:
-  metadata.gz: 14173684c35624ecc5ff42142de0c26b9a233c42f96c9f8a5fa43134f23b2a77ccca45d498541b41a6538d2eebd3f05eeb4935cab549d9fcc1bb29feb5ec354d
-  data.tar.gz: 6e64614597cc7f8c3df383e75bfdba00f05b425b768b79bc9a922adcf8f6893de2c34b49aeab65c78cb7dfa535557c7c413b54bf248f53c367cd1dfb48ee838a
+  metadata.gz: 0aa451f3c531b9981ecd88f47d738122ed38684a3ec41ac27eb743b1bdb528c9377b42feb9e352f65039bc24a8458faa94d3717df009ebf0681da230ff77efc8
+  data.tar.gz: fdcf546e35a39bd594c9f2d5fa42d1232675a9019f6f019d77caf52e04fef5254bf4a15b452aad381c38feaa8a575941586256e30dc15e98674da7a65eff9d55

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - .rubocop_roust.yml
+  - .rubocop_todo.yml

data/.rubocop_roust.yml

@@ -0,0 +1,11 @@
+# These are project syntax rules. We won't ever fix these. Unless we all get fired or something.
+
+HashSyntax:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+# Configuration parameters: EnforcedStyleForEmptyBraces, SupportedStyles.
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space

data/.rubocop_todo.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-30 14:32:46 +1000 using RuboCop version 0.24.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 12
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- '1.9.3'
+- '2.0'
+- '2.1'
+script: bundle exec rspec spec

data/Gemfile

@@ -10,4 +10,5 @@ group :development do
   gem 'rake'
   gem 'webmock'
   gem 'pry'
+  gem 'rubocop', :require => false
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roust (1.3.0)
+    roust (1.4.0)
       activesupport (>= 4.1.0)
       httparty (>= 0.13.1)
       mail (>= 2.5.4)
@@ -16,11 +16,12 @@ GEM
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
     addressable (2.3.5)
+    ast (2.0.0)
     coderay (1.0.9)
     colorize (0.5.8)
     crack (0.4.1)
       safe_yaml (~> 0.9.0)
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.5)
     httparty (0.13.1)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
@@ -33,22 +34,38 @@ GEM
     mime-types (1.25.1)
     minitest (5.3.3)
     multi_xml (0.5.5)
+    parser (2.2.0.pre.3)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
     polyglot (0.3.4)
+    powerpack (0.0.9)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
+    rainbow (2.0.0)
     rake (10.1.0)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    rubocop (0.24.1)
+      json (>= 1.7.7, < 2)
+      parser (>= 2.2.0.pre.3, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.5.1)
     safe_yaml (0.9.7)
-    slop (3.4.6)
+    slop (3.5.0)
     thread_safe (0.3.3)
     treetop (1.4.15)
       polyglot
@@ -68,4 +85,5 @@ DEPENDENCIES
   rake
   roust!
   rspec
+  rubocop
   webmock

data/README.md

@@ -85,6 +85,7 @@ bundle exec rake
 
 Roust has reasonable test coverage of the core features mentioned above. It has some other features that have been ported from the original rt-client implementation that are not tested (and are probably broken). See the TODO section for more details.
 
+[![build status](https://travis-ci.org/bulletproofnetworks/roust.svg?branch=master)](https://travis-ci.org/bulletproofnetworks/roust)
 
 Releasing
 ---------

data/Rakefile

@@ -6,22 +6,22 @@ require 'colorize'
 
 RSpec::Core::RakeTask.new('spec')
 
-desc "build gem"
+desc 'build gem'
 task :build do
   build_output = `gem build roust.gemspec`
   puts build_output
 
-  gem_filename = build_output[/File: (.*)/,1]
-  pkg_path = "pkg"
+  gem_filename = build_output[/File: (.*)/, 1]
+  pkg_path = 'pkg'
   FileUtils.mkdir_p(pkg_path)
   FileUtils.mv(gem_filename, pkg_path)
 
   puts "Gem built in #{pkg_path}/#{gem_filename}".green
 end
 
-desc "push gem"
+desc 'push gem'
 task :push do
-  filenames = Dir.glob("pkg/*.gem")
+  filenames = Dir.glob('pkg/*.gem')
   filenames_with_times = filenames.map do |filename|
     [filename, File.mtime(filename)]
   end
@@ -34,4 +34,3 @@ task :push do
 end
 
 task :default => [:spec]
-

data/lib/roust/exceptions.rb

@@ -0,0 +1,5 @@
+class Unauthenticated < Exception; end
+class Unauthorized < Exception; end
+class BadRequest < Exception; end
+class UnhandledResponse < Exception; end
+class InvalidRecord < Exception; end

data/lib/roust/queue.rb

@@ -0,0 +1,21 @@
+module Roust::Queue
+  # id can be numeric (e.g. 28) or textual (e.g. sales)
+  def queue_show(id)
+    response = self.class.get("/queue/#{id}")
+
+    body, _ = explode_response(response)
+    if body =~ /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
+
+  alias_method :queue, :queue_show
+end

data/lib/roust/ticket.rb

@@ -0,0 +1,245 @@
+module Roust::Ticket
+  def ticket_show(id)
+    response = self.class.get("/ticket/#{id}/show")
+
+    body, _ = explode_response(response)
+
+    return nil if body =~ /^# (Ticket (\d+) does not exist\.)/
+
+    # 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 |m|
+        m.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 ticket_create(attrs)
+    default_attrs = {
+      'id' => 'ticket/new'
+    }
+    attrs = default_attrs.merge(attrs).stringify_keys!
+
+    error = create_invalid?(attrs)
+    raise InvalidRecord, error if error
+
+    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 = compose_content('ticket', attrs['id'], attrs)
+
+    response = self.class.post(
+      '/ticket/new',
+      :body => {
+        :content => content
+      }
+    )
+
+    body, _ = explode_response(response)
+
+    case body
+    when /^# Ticket (\d+) created/
+      id = body[/^# Ticket (\d+) created/, 1]
+      # Add the AdminCc after the ticket is created, because we can't set it
+      # on ticket creation.
+      update(id, 'AdminCc' => admincc) if admincc
+
+      # Return the whole ticket, not just the id.
+      show(id)
+    when /^# Could not create ticket/
+      raise BadRequest, body
+    when /^# Syntax error/
+      raise SyntaxError, body
+    else
+      raise UnhandledResponse, body
+    end
+  end
+
+  def ticket_update(id, attrs)
+    content = compose_content('ticket', id, attrs)
+
+    response = self.class.post(
+      "/ticket/#{id}/edit",
+      :body => {
+        :content => content
+      },
+    )
+
+    body, _ = explode_response(response)
+
+    case body
+    when /^# Ticket (\d+) updated/
+      id = body[/^# Ticket (\d+) updated/, 1]
+      show(id)
+    when /^# You are not allowed to modify ticket \d+/
+      raise Unauthorized, body
+    when /^# Syntax error/
+      raise SyntaxError, body
+    else
+      raise UnhandledResponse, body
+    end
+  end
+
+  def ticket_search(query)
+    params = {
+      :query   => query,
+      :format  => 's',
+      :orderby => '+id'
+    }
+    response = self.class.get('/search/ticket', :query => params)
+    # FIXME(auxesis) use explode_response here
+
+    body, _ = explode_response(response)
+    body.split("\n").map do |t|
+      id, subject = t.split(': ', 2)
+      {'id' => id, 'Subject' => subject}
+    end
+  end
+
+  def ticket_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, _ = explode_response(response)
+
+    case format
+    when 'short'
+      parse_short_history(body, :comments => comments)
+    when 'long'
+      parse_long_history(body, :comments => comments)
+    end
+  end
+
+  # TODO(auxesis): add method for getting ticket links
+  # TODO(auxesis): add method for updating ticket links
+  # TODO(auxesis): add method for listing ticket attachments
+  # TODO(auxesis): add method for getting a ticket attachment
+  # TODO(auxesis): add method for commenting on a ticket
+  # TODO(auxesis): add method for replying on a ticket
+
+  # To maintain backwards compatibility with previous versions (and rt-client),
+  # alias these methods to their short form.
+  alias_method :create, :ticket_create
+  alias_method :show, :ticket_show
+  alias_method :update, :ticket_update
+  alias_method :history, :ticket_history
+  alias_method :search, :ticket_search
+
+  private
+
+  def create_invalid?(attrs)
+    missing = %w(id Subject Queue).select { |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
+
+    list
+  end
+end

data/lib/roust/user.rb

@@ -0,0 +1,48 @@
+module Roust::User
+  # id can be numeric (e.g. 28) or textual (e.g. john)
+  def user_show(id)
+    response = self.class.get("/user/#{id}")
+
+    body, _ = explode_response(response)
+    if body =~ /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
+
+  def user_update(id, attrs)
+    content = compose_content('user', id, attrs)
+
+    response = self.class.post(
+      "/user/#{id}/edit",
+      :body => {
+        :content => content
+      }
+    )
+
+    body, _ = explode_response(response)
+
+    case body
+    when /^# User (.+) updated/
+      id = body[/^# User (.+) updated/, 1]
+      user_show(id)
+    when /^# You are not allowed to modify user \d+/
+      raise Unauthorized, body
+    when /^# Syntax error/
+      raise SyntaxError, body
+    else
+      raise UnhandledResponse
+    end
+  end
+
+  # TODO(auxesis): add method for creating a user
+
+  alias_method :user, :user_show
+end

data/lib/roust/version.rb

@@ -1,3 +1,3 @@
 class Roust
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end