roust 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1a2f356ca5640d7d394f07ced73cc03abcd6e34
-  data.tar.gz: 41196d852637d8c592068c6e1faf993183349a5a
+  metadata.gz: ecda9bb4e79252eb39c2839ff0b8ae25f4069817
+  data.tar.gz: fc627b8cb18996b1658249f0cf5d434a219f1a90
 SHA512:
-  metadata.gz: 197a802ad243cafcff1965016d544b1722dd83ef9d633410ede414422a0ffba1de3e63f4d91f548ac546501f4c898bda05f459f50c255495c3a11252ee326089
-  data.tar.gz: 5a68904147845e22f3ff138eb0bf1d0a6d5f64da303d7cc877706ac57a132d7bea1ef7ef5122ea4bbe128a5ed44b8f77adc990a6283334a9461b04cda8ad2725
+  metadata.gz: 5773318cc0aad6e9f4da047481c7f3aecd760854f9d94dc6cefe3a2751f0c984ca0ca141dce9eb80da50468d2dfcb1b9a1b9f3ed064353d4a8e075d94edb22fd
+  data.tar.gz: eaa2ffe6bbcb5ff81ffa52c759d65a3af9cc34b85c781538a536ead7494806c61eed87471edf0b875f2d6f41b686daf80dfd7ccbea76f73599d1987faa6ecc73

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roust (1.4.1)
+    roust (1.5.0)
       activesupport (>= 4.1.0)
       httparty (>= 0.13.1)
       mail (>= 2.5.4)

data/lib/roust/queue.rb

@@ -1,21 +1,17 @@
-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}")
+class Roust
+  module 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 ]
-      }]
+      body, _ = explode_response(response)
+      if body =~ /No queue named/
+        nil
+      else
+        body_to_hash(body)
+      end
     end
-  end
 
-  alias_method :queue, :queue_show
+    alias_method :queue, :queue_show
+  end
 end

data/lib/roust/ticket.rb

@@ -1,245 +1,241 @@
-module Roust::Ticket
-  def ticket_show(id)
-    response = self.class.get("/ticket/#{id}/show")
+class Roust
+  module Ticket
+    def ticket_show(id)
+      response = self.class.get("/ticket/#{id}/show")
 
-    body, _ = explode_response(response)
+      body, _ = explode_response(response)
 
-    return nil if body =~ /^# (Ticket (\d+) does not exist\.)/
+      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
+        # 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
+      # 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
-    end
-
-    message = Mail.new(body)
 
-    hash = Hash[message.header.fields.map { |header|
-      key   = header.name.to_s
-      value = header.value.to_s
-      [ key, value ]
-    }]
+      hash = body_to_hash(body)
 
-    %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.
+      %w(Requestors Cc AdminCc).each do |field|
+        hash[field] = hash[field].split(', ') if hash[field]
+      end
 
-    # 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')
+      hash['id'] = hash['id'].split('/').last
 
-    content = compose_content('ticket', attrs['id'], attrs)
+      hash
+    end
 
-    response = self.class.post(
-      '/ticket/new',
-      :body => {
-        :content => content
+    def ticket_create(attrs)
+      default_attrs = {
+        'id' => 'ticket/new'
       }
-    )
-
-    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
+      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 = $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
-  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
+    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 = $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
-  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}
+    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
-  end
 
-  def ticket_history(id, opts = {})
-    options = {
-      :format   => 'short',
-      :comments => false
-    }.merge(opts)
+    def ticket_history(id, opts = {})
+      options = {
+        :format   => 'short',
+        :comments => false
+      }.merge(opts)
 
-    format   = options[:format]
-    comments = options[:comments]
-    params = {
-      :format => format[0]
-    }
+      format   = options[:format]
+      comments = options[:comments]
+      params = {
+        :format => format[0]
+      }
 
-    response = self.class.get("/ticket/#{id}/history", :query => params)
+      response = self.class.get("/ticket/#{id}/history", :query => params)
 
-    body, _ = explode_response(response)
+      body, _ = explode_response(response)
 
-    case format
-    when 'short'
-      parse_short_history(body, :comments => comments)
-    when 'long'
-      parse_long_history(body, :comments => comments)
+      case format
+      when 'short'
+        parse_short_history(body, :comments => comments)
+      when 'long'
+        parse_long_history(body, :comments => comments)
+      end
     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(', ')}"
+    # 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
-  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_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
+    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
-              attachments << s
+              reply['attachments'] = attachments
             end
-            reply['attachments'] = attachments
+          when 'content'
+            reply['content'] = value
+          else
+            reply["#{key}"] = value
           end
-        when 'content'
-          reply['content'] = value
-        else
-          reply["#{key}"] = value
         end
+        list << reply
       end
-      list << reply
-    end
 
-    list
+      list
+    end
   end
 end

data/lib/roust/user.rb

@@ -1,48 +1,109 @@
-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 ]
-      }]
+class Roust
+  module 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
+        hash = body_to_hash(body)
+        convert_response_boolean_attrs(hash)
+      end
     end
-  end
 
-  def user_update(id, attrs)
-    content = compose_content('user', id, attrs)
+    def user_update(id, attrs)
+      convert_request_boolean_attrs(attrs)
+
+      content = compose_content('user', id, attrs)
+
+      response = self.class.post(
+        "/user/#{id}/edit",
+        :body => {
+          :content => content
+        }
+      )
+
+      body, _ = explode_response(response)
 
-    response = self.class.post(
-      "/user/#{id}/edit",
-      :body => {
-        :content => content
+      case body
+      when /^# User (.+) updated/
+        id = $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
+
+    # Requires RT > 3.8.0
+    def user_create(attrs)
+      default_attrs = {
+        'id' => 'user/new'
       }
-    )
-
-    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
+      attrs = default_attrs.merge(attrs).stringify_keys!
+
+      content = compose_content('user', attrs['id'], attrs)
+
+      response = self.class.post(
+        '/user/new',
+        :body => {
+          :content => content
+        }
+      )
+
+      body, _ = explode_response(response)
+
+      case body
+      when /^# User (.+) created/
+        id = $1
+        # Return the whole user, not just the id.
+        user_show(id)
+      when /^# Could not create user/
+        raise BadRequest, body
+      when /^# Syntax error/
+        raise SyntaxError, body
+      else
+        raise UnhandledResponse, body
+      end
     end
-  end
 
-  # TODO(auxesis): add method for creating a user
+    alias_method :user, :user_show
+
+    private
 
-  alias_method :user, :user_show
+    def convert_request_boolean_attrs(attrs)
+      %w(Disabled Privileged).each do |key|
+        if attrs.has_key?(key)
+          attrs[key] = case attrs[key]
+                       when true
+                         1
+                       when false
+                         0
+                       end
+        end
+      end
+
+      attrs
+    end
+
+    def convert_response_boolean_attrs(attrs)
+      %w(Disabled Privileged).each do |key|
+        if attrs.has_key?(key)
+          attrs[key] = case attrs[key]
+                       when '1'
+                         true
+                       when '0'
+                         false
+                       end
+        end
+      end
+
+      attrs
+    end
+  end
 end

data/lib/roust/version.rb

@@ -1,3 +1,3 @@
 class Roust
-  VERSION = '1.4.1'
+  VERSION = '1.5.0'
 end

data/lib/roust.rb

@@ -13,50 +13,61 @@ class Roust
   include Roust::User
 
   def initialize(credentials)
-    server   = credentials[:server]
-    username = credentials[:username]
-    password = credentials[:password]
+    @server   = credentials[:server]
+    @username = credentials[:username]
+    @password = credentials[:password]
 
-    if server =~ /REST\/1\.0/
-      raise ArgumentError, "The supplied :server has REST in the URL. You only need to specify the base, e.g. http://rt.example.org/"
+    if @server =~ /REST\/1\.0/
+      raise ArgumentError, 'The supplied :server has REST in the URL. You only need to specify the base, e.g. http://rt.example.org/'
     end
 
-    self.class.base_uri(server)
+    authenticate!
+  end
+
+  def authenticate!
+    # - There is no way to authenticate against the API. The only way to log
+    #   in is to fill out the same HTML form humans fill in, cache the cookies
+    #   returned, and send them on every subsequent request.
+    # - RT does not provide *any* indication that the authentication request
+    #   has succeeded or failed. RT will always return a HTTP 200.
+
+    self.class.base_uri(@server)
 
     response = self.class.post(
       '/index.html',
       :body => {
-        :user => username,
-        :pass => password
+        :user => @username,
+        :pass => @password
       }
     )
 
-    if cookie = response.headers['set-cookie']
-      self.class.headers['Cookie'] = cookie
-    end
+    cookie = response.headers['set-cookie']
+    self.class.headers['Cookie'] = cookie if cookie
 
-    self.class.base_uri "#{server}/REST/1.0"
+    # Switch the base uri over to the actual REST API base uri.
+    self.class.base_uri "#{@server}/REST/1.0"
 
-    # - There is no way to authenticate against the API. The only way to log
-    #   in is to fill out the same HTML form humans fill in, cache the cookies
-    #   returned, and send them on every subsequent request.
-    # - RT does not provide *any* indication that the authentication request
-    #   has succeeded or failed. RT will always return a HTTP 200.
     # - The easiest way to programatically check if an authentication request
     #   succeeded is by doing a request for a ticket, and seeing if the API
     #   responds with some specific text ("401 Credentials required") that
     #   indicates authentication has previously failed.
-    # - The authenticated? method will raise an Unauthenticated exception if
-    #   it detects a response including this "401 Credentials required" string.
-    authenticated?
+    # - The authenticated? method will return false if an Unauthenticated
+    #   exception bubbles up from response handling. We (dirtily) rethrow the
+    #   exception.
+    raise Unauthenticated unless authenticated?
   end
 
   def authenticated?
     return true if show('1')
+  rescue Unauthenticated
+    return false
   end
 
   private
 
+  # compose_content turns a Hash into an RFC2822 "key: value"-like header blob
+  #
+  # This is the fucked up format RT demands all content is sent and received in.
   def compose_content(type, id, attrs)
     default_attrs = {
       'id' => [ type, id ].join('/')
@@ -84,6 +95,14 @@ class Roust
     content.join("\n")
   end
 
+  # explode_response separates RT's response content from the response status.
+  #
+  # All HTTP-level response codes from RT are a lie. The only way to check if
+  # the request was successful is by inspecting the body of the content back
+  # from RT, and separating the first line from the rest of the content.
+  #
+  # - The first line contains the status of the operation.
+  # - All subsequent lines (if there are any) are the message body.
   def explode_response(response)
     body   = response.body
     status = body[/RT\/\d+\.\d+\.\d+\s(\d{3}\s.*)\n/, 1]
@@ -95,4 +114,16 @@ class Roust
 
     return body, status
   end
+
+  def body_to_hash(body)
+    body.gsub!(/\n\s*\n/, "\n") # remove blank lines for Mail
+
+    message = Mail.new(body)
+    pairs = message.header.fields.map do |header|
+      key   = header.name.to_s
+      value = header.value.to_s
+      [ key, value ]
+    end
+    hash = Hash[pairs]
+  end
 end

data/roust.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   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.description  = "Roust is a Ruby API client to access Request Tracker's REST interface."
   s.homepage     = 'http://github.com/bulletproofnetworks/roust'
   s.license      = 'Apache 2.0'
 

data/spec/mocks/user-erin@us.example-create.txt

@@ -0,0 +1,3 @@
+RT/3.4.6 200 Ok
+
+# User erin@us.example created.

data/spec/mocks/user-erin@us.example.txt

@@ -0,0 +1,22 @@
+RT/3.4.6 200 Ok
+
+id: user/7268365
+Name: erinj
+Password: ********
+EmailAddress: erin@us.example
+RealName: Erin Jones
+NickName: erin
+Gecos: erin
+MobilePhone: 0400123457
+PagerPhone: DESC
+
+Signature: Erin Jones
+           Engineering Manager
+           Example Org
+           tel: 1300 000 123
+           mob: 0400 123 457
+           fax: 02 9000 1234
+
+Lang: en
+Privileged: 0
+Disabled: 0

data/spec/roust/authentication_spec.rb

@@ -5,12 +5,12 @@ describe Roust do
   include_context 'credentials'
 
   describe 'authentication' do
-    it 'authenticates on instantiation' do
+    it 'indicates authenticated status' do
       @rt = Roust.new(credentials)
       expect(@rt.authenticated?).to eq(true)
     end
 
-    it 'errors when credentials are incorrect' do
+    it 'errors on invalid credentials' do
       mocks_path = Pathname.new(__FILE__).parent.parent.join('mocks')
 
       stub_request(:post, 'http://rt.example.org/index.html')

data/spec/roust/queue_spec.rb

@@ -23,8 +23,8 @@ describe Roust do
 
   describe 'queue' do
     it 'can lookup queue details' do
-      attrs = %w(id name description correspondaddress commentaddress) +
-              %w(initialpriority finalpriority defaultduein)
+      attrs = %w(id Name Description CorrespondAddress CommentAddress) +
+              %w(InitialPriority FinalPriority DefaultDueIn)
 
       queue = @rt.queue('13')
       attrs.each do |attr|

data/spec/roust/user_spec.rb

@@ -23,13 +23,30 @@ describe Roust do
                     :body   => mocks_path.join('user-dan@us.example-edit.txt').read,
                     :headers => {})
 
+    stub_request(:post, "http://rt.example.org/REST/1.0/user/new")
+         .with(:body => "content=id%3A%20user%2Fnew%0AEmailAddress%3A%20erin%40us.example%0AName%3A%20erin%0ARealName%3A%20Erin%20Jones%0AGecos%3A%20erin%0ALang%3A%20en")
+         .to_return(:status => 200,
+                    :body   => mocks_path.join('user-erin@us.example-create.txt').read,
+                    :headers => {})
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/user/erin@us.example")
+         .to_return(:status => 200,
+                    :body   => mocks_path.join('user-erin@us.example.txt').read,
+                    :headers => {})
+
+    stub_request(:post, "http://rt.example.org/REST/1.0/user/erin@us.example/edit")
+         .with(:body => "content=id%3A%20user%2Ferin%40us.example%0ADisabled%3A%201%0APrivileged%3A%201")
+         .to_return(:status => 200,
+                    :body => "RT/3.4.6 200 Ok\n\n# User erin@us.example updated.\n",
+                    :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)
+      attrs = %w(Name RealName Gecos NickName EmailAddress id Lang Password)
 
       user = @rt.user_show('dan@us.example')
       attrs.each do |attr|
@@ -52,7 +69,40 @@ describe Roust do
       attrs = {'RealName' => 'Daniel Smith'}
       user  = @rt.user_update('dan@us.example', attrs)
 
-      expect(user['realname']).to eq('Daniel Smith')
+      expect(user['RealName']).to eq('Daniel Smith')
+    end
+
+    it 'can create a new user' do
+      attrs = {
+        'EmailAddress' => 'erin@us.example',
+        'Name' => 'erin',
+        'RealName' => 'Erin Jones',
+        'Gecos' => 'erin',
+        'Lang' => 'en'
+      }
+      user = @rt.user_create(attrs)
+      expect(user['RealName']).to eq('Erin Jones')
+      expect(user['EmailAddress']).to eq('erin@us.example')
+    end
+
+    it 'does type boolean conversion on request and response' do
+      user = @rt.user_show('erin@us.example')
+      expect(user['Disabled']).to eq(false)
+      expect(user['Privileged']).to eq(false)
+
+      stub_request(:get, "http://rt.example.org/REST/1.0/user/erin@us.example")
+         .to_return(:status => 200,
+                    :body => "RT/3.4.6 200 Ok\n\nDisabled: 1\nPrivileged: 1\n",
+                    :headers => {})
+
+      attrs = {
+        'Disabled' => true,
+        'Privileged' => true,
+      }
+
+      user = @rt.user_update('erin@us.example', attrs)
+      expect(user['Disabled']).to eq(true)
+      expect(user['Privileged']).to eq(true)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roust
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Lindsay Holmwood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-05 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -52,8 +52,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 4.1.0
-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.
+description: Roust is a Ruby API client to access Request Tracker's REST interface.
 email:
 - lindsay@holmwood.id.au
 executables: []
@@ -89,6 +88,8 @@ files:
 - spec/mocks/user-dan@us.example-after-edit.txt
 - spec/mocks/user-dan@us.example-edit.txt
 - spec/mocks/user-dan@us.example.txt
+- spec/mocks/user-erin@us.example-create.txt
+- spec/mocks/user-erin@us.example.txt
 - spec/mocks/user-nil.txt
 - spec/roust/authentication_spec.rb
 - spec/roust/queue_spec.rb
@@ -130,6 +131,8 @@ test_files:
 - spec/mocks/user-dan@us.example-after-edit.txt
 - spec/mocks/user-dan@us.example-edit.txt
 - spec/mocks/user-dan@us.example.txt
+- spec/mocks/user-erin@us.example-create.txt
+- spec/mocks/user-erin@us.example.txt
 - spec/mocks/user-nil.txt
 - spec/roust/authentication_spec.rb
 - spec/roust/queue_spec.rb