fiddler 0.0.1 → 1.0.1

data/README.md

@@ -3,6 +3,76 @@ Fiddler
 
 Ruby gem to provide an easy interface to Request Tracker Installation.
 
+Installation
+-------------
+
+Install the gem using this commands
+
+`gem install fiddler`
+
+or you can include it in your Gemfile.
+
+`gem 'fiddler'`
+
+Configuration
+--------------
+
+For a Rails app, create an initializer files and for any other app, include this before using the gem.
+<pre>
+<code>
+   Fiddler.configure do |config|
+      config.server_url = "request_tracker_url"
+      config.username = "some_user"
+      config.password = "some_password"
+   end
+</code>
+</pre>
+
+You can modify the settings on the fly as well using `Fiddler.configuration` variable.
+
+Attachments
+-----------
+
+Fiddler saves the attachments object in a folder specified by
+`Fiddler.configuration.attachments_path`. This is relative to the rails
+root.
+
+Using Cookies
+-------------
+
+Make sure you have RT-External-Auth configured properly to use cookies with Request Tracker.
+Once that part has been done, change the config file to the following format.
+
+<pre>
+<code>
+   Fiddler.configure do |config|
+      config.server_url = "request_tracker_url"
+      config.use_cookies = true
+      config.cookie_domain = ".domainname"
+      config.request_tracker_key = "loginCookieValue"
+   end
+</code>
+</pre>
+
+Once the configuration is done, cookie value can be set using
+`Fiddler.configuration.cookie_value` method (appropriate place for that
+would be somewhere like ApplicationController where it can set
+dynamically).
+
+Debugging Response
+------------------
+
+You can set the config option `Fiddler.configuration.debug_response` to
+`true` to start debugging the responses from RT. If using in rails, it
+will log to the current environment log otherwise print it to the stdout.
+
+SSL Verification
+----------------
+
+SSL certificate verification can be turned off by using
+`Fiddler.configuration.ssl_verify` option. This is very helpful in jruby
+implementations where ssl is bit of a pain.
+
 Supported Versions of Request Tracker
 -------------------------------------
 * 4.0.4

data/lib/fiddler.rb

@@ -2,7 +2,11 @@ require 'fiddler/configuration'
 require 'fiddler/errors'
 require 'fiddler/parsers'
 require 'fiddler/formatters'
-require 'fiddler/ticket'
+require 'fiddler/extensions'
 require 'fiddler/connection_manager'
 
+require 'fiddler/ticket'
+require 'fiddler/history'
+require 'fiddler/attachment'
+
 require 'active_support/all'

data/lib/fiddler/attachment.rb

@@ -0,0 +1,142 @@
+require 'active_attr'
+module Fiddler
+   class AttachmentCollection < Array
+      def to_payload
+         hash = Hash.new
+         self.each_with_index do |attach, index|
+            hash["attachment_#{index+1}"] = attach
+         end
+         hash
+      end
+
+      def self.fill(*args)
+         AttachmentCollection.new Array(args.compact).flatten.map { |attachment|
+            if attachment.is_a?(File)
+               AttachmentFile.new(attachment.path)
+            elsif attachment.is_a?(String)
+               AttachmentFile.new(attachment)
+            elsif attachment.is_a?(ActionDispatch::Http::UploadedFile)
+               AttachmentFile.new(attachment.tempfile.path, attachment.original_filename)
+            end
+         }.compact
+      end
+   end
+
+   class AttachmentFile < File
+      attr_accessor :name
+
+      def initialize(path,name=nil)
+         super(path)
+         @name = name || File.basename(path)
+      end
+   end
+   
+   # the attachment in itself
+   class Attachment
+      include ActiveAttr::Model
+
+      attribute :id
+      attribute :subject
+      attribute :creator
+      attribute :created
+      attribute :transaction
+      attribute :parent
+      attribute :message_id
+      attribute :filename
+      attribute :content_type
+      attribute :content_encoding
+      attribute :headers
+      
+      attr_accessor :ticket_id, :content, :path
+
+      # Public class method to get an attachment
+      def self.get(id, ticket_id)
+         url = "/ticket/#{ticket_id}/attachments/#{id}"
+         response = Fiddler::ConnectionManager.get(url)
+         attachment = Fiddler::Parsers::AttachmentParser.parse_single(response)
+         attachment.ticket_id = ticket_id
+         attachment
+      end
+
+      def content_length
+         length = header_value_for_key("Content-Length")
+         if !length.nil?
+            length.to_i
+         elsif @content.nil?
+            -1
+         else
+            @content.length
+         end
+      end
+
+      def content
+         populate_data
+         @content
+      end
+
+      def path
+         populate_data
+         @path
+      end
+
+      def has_text_content
+         if content_type == "text/plain" or content_type == "text/html"
+            return true
+         else
+            return false
+         end
+      end
+
+      protected
+
+      def populate_data
+         @data_populated ||= false
+         unless @data_populated
+            if content_length != 0
+               if has_text_content
+                  load_content
+                  @path = nil
+               else
+                  @path = full_path_for_filename
+                  if File.exists?(@path)
+                     @content = ""
+                  else
+                     load_content
+                     save_content_to_file
+                  end
+               end
+            else
+               @content = ""
+            end
+            @data_populated = true
+         end
+      end
+
+      def load_content
+         url = "/ticket/#{ticket_id}/attachments/#{id}/content"
+         response = Fiddler::ConnectionManager.get(url)
+         @content = Fiddler::Parsers::AttachmentParser.parse_content(response)
+      end
+
+      def header_value_for_key(header_key)
+         final_value = nil
+         headers.each do |header_line|
+            (key,value) = header_line.split(":")
+            if header_key == key
+               final_value = value
+               break
+            end
+         end
+         return final_value
+      end
+
+      def save_content_to_file
+         File.open(full_path_for_filename, "w") { |f| f.write(@content) }
+         @content = ""
+      end
+
+      def full_path_for_filename
+         "#{Fiddler.configuration.attachments_path}/#{id}-#{filename}"
+      end
+   end
+end

data/lib/fiddler/configuration.rb

@@ -1,11 +1,16 @@
 module Fiddler
   # Based on the Clearance gem configuration - https://github.com/thoughtbot/clearance/blob/master/lib/clearance/configuration.rb
   class Configuration
-    attr_accessor :server_url, :username, :password, :use_cookies, :cookie_domain, :ssl_verify
+    attr_accessor :server_url, :username, :password, :use_cookies, :cookie_domain, :cookie_value, :request_tracker_key, :ssl_verify, :attachments_path, :debug_response
 
     def initialize
       @use_cookies = false
       @ssl_verify = true
+      @attachments_path = "attachments"
+      @cookie_value = nil
+      @cookie_domain = nil
+      @request_tracker_key = "loginCookieValue"
+      @debug_response = false
     end
   end
 
@@ -17,4 +22,4 @@ module Fiddler
     self.configuration ||= Configuration.new
     yield configuration
   end
-end
+end

data/lib/fiddler/connection_manager.rb

@@ -1,33 +1,67 @@
 require 'httpclient'
+require 'awesome_print'
 
 module Fiddler
    module ConnectionManager
 
       class Connection
-         attr_accessor :client
+         attr_accessor :client, :logged_in
+
          def initialize
             @client = HTTPClient.new
             @client.set_cookie_store("cookies.dat")
+            @logged_in = false
          end
 
-         def base_url
-            "#{Fiddler.configuration.server_url}/REST/1.0/"
+         def get(path,options)
+            login! unless @logged_in
+            @client.get(url_for(path),options).content
          end
 
-         def get(url,options)
-            url = "#{base_url}#{url}"
-            options = options_with_login(options)
-            @client.get(url,options).content
+         def post(path,options)
+            login! unless @logged_in
+            @client.post(url_for(path),options).content
          end
 
-         def post(url,options)
-            url = "#{base_url}#{url}"
-            @client.post(url,options_with_login(options)).content
+         def post_content(path,options)
+            login! unless @logged_in
+            @client.post_content(url_for(path),options)
          end
 
-         def options_with_login(options)
+         private 
+
+         def login!
             unless Fiddler.configuration.use_cookies
-               options.merge({ :user => Fiddler.configuration.username, :pass => Fiddler.configuration.password })
+               unless @logged_in
+                  @client.post(url_for(base_url), :user => Fiddler.configuration.username, :pass => Fiddler.configuration.password )
+                  @logged_in = true
+               end
+            else
+               @client.cookie_manager.cookies = []
+               cookie = WebAgent::Cookie.new
+               cookie.name = Fiddler.configuration.request_tracker_key
+               cookie.value = Fiddler.configuration.cookie_value
+               cookie.url = URI.parse(Fiddler.configuration.server_url)
+               cookie.domain_orig = Fiddler.configuration.cookie_domain
+               @client.cookie_manager.add(cookie)
+               @logged_in = false
+            end
+         end
+
+         def base_url
+            server_url = Fiddler.configuration.server_url
+            if server_url =~ /\/$/
+               "#{Fiddler.configuration.server_url}REST/1.0"
+            else
+               "#{Fiddler.configuration.server_url}/REST/1.0"
+            end
+         end
+
+         def url_for(path)
+            if path =~ /^\//
+               "#{base_url}#{path}"
+            else
+               "#{base_url}/#{path}"
             end
          end
       end
@@ -37,16 +71,17 @@ module Fiddler
 
          def get(url,options={})
             check_config
-            response = connection.get(url,options)
-            debug(response)
-            response
+            debug connection.get(url,options)
          end
 
          def post(url,options={})
             check_config
-            response = connection.post(url,options)
-            debug(response)
-            response
+            debug connection.post(url,options)
+         end
+
+         def post_content(url,options={})
+            check_config
+            debug connection.post_content(url,options)
          end
 
          protected
@@ -55,7 +90,7 @@ module Fiddler
             config = Fiddler.configuration
             raise InvalidConfigurationError if config.server_url.blank?
             if config.username.blank? or config.password.blank?
-               raise InvalidConfigurationError unless config.use_cookies
+               raise InvalidConfigurationError unless config.use_cookies and config.request_tracker_key and config.cookie_value and config.cookie_domain
             end
          end
 
@@ -64,7 +99,14 @@ module Fiddler
          end
 
          def debug(response)
-            puts response.inspect if ENV['DEBUG']
+            if ENV['DEBUG'] or Fiddler.configuration.debug_response
+               if defined?(Rails)
+                  Rails.logger.debug response
+               else
+                  ap response
+               end
+            end
+            return response
          end
       end # end class method definitions
    end # end ConnectionManager module definition

data/lib/fiddler/errors.rb

@@ -4,4 +4,5 @@ module Fiddler
    class InvalidConfigurationError < StandardError; end
    class TicketAccessDeniedError < StandardError; end
    class RequestError < StandardError; end
+   class IllegalCharacterError < StandardError; end
 end

data/lib/fiddler/extensions.rb

@@ -0,0 +1,2 @@
+require 'fiddler/extensions/hash'
+require 'fiddler/extensions/file'

data/lib/fiddler/extensions/file.rb

@@ -0,0 +1,5 @@
+class File
+   def name
+      File.basename(path)
+   end
+end

data/lib/fiddler/extensions/hash.rb

@@ -0,0 +1,15 @@
+class Hash
+  def to_content_format
+    fields = self.map do |key,value|
+      unless value.nil?
+        value = Fiddler::Formatters::BaseFormatter.format_string(value.to_s)
+        if key.to_s.match(/^cf_.+/)
+          "CF-#{key.to_s[3..key.to_s.length].gsub(/_/, " ").camelize.humanize}: #{value}"
+        else
+          "#{key.to_s.camelize}: #{value}"
+        end
+      end
+    end
+    content = fields.compact.sort.join("\n")
+  end
+end

data/lib/fiddler/formatters/base_formatter.rb

@@ -1,6 +1,9 @@
 module Fiddler
    module Formatters
       class BaseFormatter
+         def self.format_string(string)
+            string.gsub("\r", '').gsub("\n", "\n  ")
+         end
       end
    end
 end

data/lib/fiddler/formatters/search_request_formatter.rb

@@ -51,8 +51,8 @@ module Fiddler
                         end
                         query_array << '( ' + parts.join(" AND ") + ' )'
                      elsif value.is_a?(String)
-                        # special case for when user is Nobody, like doesnt work there
-                        if key == "Owner" and value == "Nobody"
+                        # special case for the owner field
+                        if key == "Owner"
                            query_array << "#{key} = '#{value}'"
                         else
                            query_array << "#{key} LIKE '#{value}'"

data/lib/fiddler/history.rb

@@ -0,0 +1,32 @@
+require 'active_attr'
+module Fiddler
+   class History
+      include ActiveAttr::Model
+
+      attribute :id
+      attribute :ticket
+      attribute :time_taken
+      attribute :type
+      attribute :field
+      attribute :old_value
+      attribute :new_value
+      attribute :data
+      attribute :description
+      attribute :content
+      attribute :creator
+      attribute :created
+      attribute :attachment_ids
+      
+      attr_reader :attachments
+
+      def attachments
+         if @attachments == nil
+            @attachments = []
+            attachment_ids.each do |id|
+               @attachments << Fiddler::Attachment.get(id,ticket)
+            end
+         end
+         @attachments
+      end
+   end
+end