redmine-cli 0.1.1 → 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: cc478e4f17439fc1f2a7d167365e96b271c12c846182000c3c7dc5563b751a8c9e4f33add97d6df6195b60a7624db6a61eff7987bc8c6fad051c32688b71b1dc
+  data.tar.gz: c40552a5ff0f9b21b73190a151ae48a03fde7625828118ee5cbf64725ec66c7818a7448fc140a026e70f4d5be824520d8c8013ced4502714e1c94255a908080b
+SHA1: 
+  metadata.gz: 46a0d3ee489a5d807551fb3d1b38220e55ff0333
+  data.tar.gz: 8b27f9c02e87d3c635db32fea2a6a707cdae243e

data/Gemfile.lock

@@ -1,27 +1,28 @@
 PATH
   remote: .
   specs:
-    redmine-cli (0.1.0)
+    redmine-cli (0.1.3)
       activeresource (~> 3.0.0)
+      interactive_editor
       thor
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.1)
-      activesupport (= 3.0.1)
+    activemodel (3.0.20)
+      activesupport (= 3.0.20)
       builder (~> 2.1.2)
-      i18n (~> 0.4.1)
-    activeresource (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
-    activesupport (3.0.1)
+      i18n (~> 0.5.0)
+    activeresource (3.0.20)
+      activemodel (= 3.0.20)
+      activesupport (= 3.0.20)
+    activesupport (3.0.20)
     aruba (0.2.3)
       background_process
       cucumber (~> 0.9.0)
     background_process (1.2)
     builder (2.1.2)
-    columnize (0.3.1)
+    columnize (0.3.6)
     cucumber (0.9.3)
       builder (~> 2.1.2)
       diff-lcs (~> 1.1.2)
@@ -29,12 +30,17 @@ GEM
       json (~> 1.4.6)
       term-ansicolor (~> 1.0.5)
     diff-lcs (1.1.2)
+    ffi (1.9.3)
     gherkin (2.2.9)
       json (~> 1.4.6)
       term-ansicolor (~> 1.0.5)
-    i18n (0.4.2)
+    i18n (0.5.3)
+    interactive_editor (0.0.10)
+      spoon (>= 0.0.1)
     json (1.4.6)
-    linecache (0.43)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    rbx-require-relative (0.0.9)
     rspec (2.0.1)
       rspec-core (~> 2.0.1)
       rspec-expectations (~> 2.0.1)
@@ -45,22 +51,22 @@ GEM
     rspec-mocks (2.0.1)
       rspec-core (~> 2.0.1)
       rspec-expectations (~> 2.0.1)
-    ruby-debug (0.10.3)
+    ruby-debug (0.10.4)
       columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.3.0)
-    ruby-debug-base (0.10.3)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
       linecache (>= 0.3)
+    spoon (0.0.4)
+      ffi
     term-ansicolor (1.0.5)
-    thor (0.14.3)
+    thor (0.18.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activeresource (~> 3.0.0)
   aruba
   cucumber
   redmine-cli!
   rspec
   ruby-debug
-  thor

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jorge Dias
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# redmine-cli
+### A command line interface for redmine
+Because using the browser is overrated.
+[![Gem Version](https://badge.fury.io/rb/redmine-cli.png)](http://badge.fury.io/rb/redmine-cli)
+
+## Installation
+You first need to have Ruby with RubyGems.
+
+Then run:
+
+    gem install redmine-cli
+    redmine install
+
+This will create a .redmine file in your home directory. The file is a yaml file which contains our necessary configuration
+
+During install, you can select the fields that you wish to be displayed, or accept the default (url, status, subject). This list can contain custom fields.
+
+Note that previous versions of redmine-cli installed a version of .redmine that do not take full advantage of new features. For compatiblity purposes, this version is compatible with older .redmine files. However, for best results, you should re-run "redmine install" every time you upgrade the gem.
+
+## Usage
+You can get help by simpling executing:
+
+    redmine
+
+Listing tickets
+
+    redmine list
+    redmine list -a me -T bug
+
+Display ticket
+
+    redmine show 524
+
+Updating a ticket
+
+    redmine update 524 -description "New description"
+    redmine update 256 --assigned_to me
+
+Updating multiple tickets
+
+    redmine update 2 3 4 --assigned_to johndoe
+
+Updating all tickets for a list
+
+    redmine list --status new --std_output | xargs redmine update --asigned_to me --status 3 -l
+
+(Note that the last argument of the update command must be -l)
+
+Interactively editing a ticket's fields
+
+    redmine edit --description 2
+
+Your editor will pop up, and you can modify the field. The ticket will be updated when you save the file and exit the editor.
+
+## Configuration
+Redmine-cli will install a default configuration file. However you can edit it to fit your redmine installation. 
+You can add mappings for users, statuses, custom queries, and trackers like:
+
+    user_mappings:
+      "me": 1
+      "johndoe": 24
+    status_mappings:
+      "new": 1
+      "closed": 4
+    tracker_mappings:
+      "bug" : 1
+      "feature" : 2
+
+This will allow to use those names with the commands instead of the ids your redmine installation uses.
+
+Additionally, you can choose which fields are displayed when you use "redmine list" by editing the list_fields section like:
+    list_fields:
+      - project
+      - id
+      - tracker
+      - status
+      - priority
+      - assigned_to
+      - subject
+      - updated_on
+
+You can choose from any of these fields:
+
+* url - A "clickable" link to the issue
+* id  - The ID number of the issue
+* subject
+* status - Open, Closed, Resolved, etc.
+* start_date
+* estimated_hours
+* tracker - Bug, Feature, Improvement, etc.
+* priority - Low, High, Immediate, etc. (Note: this field is colorized on terminals that support it)
+* description
+* assigned_to
+* project
+* author
+* done_ratio
+* due_date
+* created_on
+* updated_on
+
+In addition to these fields, you can also specify any custom fields that you've configured in your Redmine site. If a field is not found on an issue, or the value is blank, then a blank value will be displayed in the list.
+
+## Known Issues
+
+If you use a non-administrative account, redmine-cli's mapping cache will not be able to retrieve the list of users (you must manually populate the user mappings in this case). Additionally, you'll receive an error like this whenever you try to update an issue:
+
+    Updating mapping cache...
+    Failed to fetch users: Failed.  Response code = 403.  Response message = Forbidden.
+
+If this happens, you can disable the caching feature by setting "disable_caching": true in ~/.redmine

data/lib/redmine-cli.rb

@@ -1,6 +1,6 @@
 require 'thor'
 require 'active_resource'
-require 'redmine-cli/issue'
+require 'redmine-cli/resources'
 require 'redmine-cli/generators/install'
 require 'redmine-cli/cli'
 require 'redmine-cli/git'

data/lib/redmine-cli/cli.rb

@@ -1,39 +1,165 @@
 require 'thor'
-require 'redmine-cli/issue'
+require 'redmine-cli/field'
+require 'redmine-cli/config'
+require 'redmine-cli/resources'
 require 'redmine-cli/generators/install'
+require 'rubygems'
+require 'interactive_editor'
+require 'yaml'
+require 'pp'
+
+$KCODE='u'
 
 module Redmine
   module Cli
     class CLI < Thor
+
       desc "list", "List all issues for the user"
       method_option :assigned_to, :aliases => "-a",  :desc => "id or user name of person the ticket is assigned to"
       method_option :status,      :aliases => "-s",  :desc => "id or name of status for ticket"
-      method_option :std_output,  :aliases => "-o",  :type => :boolean,
-                    :desc => "special output for STDOUT (useful for updates)"
+      method_option :project,     :aliases => "-p",  :desc => "project id"
+      method_option :version,     :aliases => "-v",  :desc => "the target version"
+      method_option :query,       :aliases => "-q",  :desc => "list issues according to a saved custom query"
+      method_option :tracker,     :aliases => "-T",  :desc => "id or name of tracker for ticket"
+      method_option :std_output,  :aliases => "-o",  :desc => "output a space-delimited list of ticket numbers that match the specified criteria (useful when piped to \"update\" command", :type => :boolean
+      method_option :sort,        :aliases => "-S",  :desc => "sort by the specified column"
+
       def list
         params = {}
 
         params[:assigned_to_id] = map_user(options.assigned_to) if options.assigned_to
-
         params[:status_id] = map_status(options.status) if options.status
+        params[:tracker_id] = map_tracker(options.tracker) if options.tracker
+        params[:project_id] = map_project(options.project) if options.project
+        params[:query_id] = map_query(options.query) if options.query
+        params[:sort] = options[:sort] if options[:sort]
+
+        collection = Issue.fetch_all(params)
 
-        collection = Issue.all(:params => params)
+        selected_fields = Redmine::Cli::config.list_fields || ["url", "subject", "status"]
 
         unless options.std_output
-          issues = collection.collect { |issue| [link_to_issue(issue.id), issue.subject, issue.status.name] }
+          # collection.sort! {|i,j| i.status.id <=> j.status.id }
+          collection.sort! {|i,j| i.priority.id <=> j.priority.id }
+          
+          # Retrieve the list of issue fields in selected_fields
+          issues = collection.collect { |issue| selected_fields.collect {| key |
+
+            assignee = ""
+            assignee = issue.assigned_to.name if issue.respond_to?(:assigned_to)
+            version = issue.fixed_version.name if issue.respond_to?(:fixed_version)
+
+            # Hack, because I don't feel like spending much time on this
+            next unless version == options.version
+
+            begin
+              # If this is a built-in field for which we have a title, ref, and display method, use that.
+              field = fields.fetch(key)
+              if field.display
+                value = issue.attributes.fetch(field.ref)
+                field.display.call(value)
+              else
+                f = fields.fetch(key).ref
+                issue.attributes.fetch(f)
+              end
+            rescue IndexError
+              # Otherwise, let's look for a custom field by that name.
+              if issue.attributes[:custom_fields].present?
+                issue.attributes[:custom_fields].collect { | field | 
+                  if field.attributes.fetch("name") == key
+                    field.attributes.fetch("value")
+                  end
+                }
+              end
+              ""
+              #TODO: If the custom field doesn't exist, then we end up returning a blank value (not an error). I guess that's OK?
+            end
+
+          }}
 
           if issues.any?
-            issues.insert(0, ["URL", "Subject", "Status"])
+            issues.insert(0, selected_fields.collect {| key |
+              begin
+                fields.fetch(key).title
+              rescue IndexError
+                key
+              end
+            })
+
             print_table(issues)
+            say "#{collection.count} issues - #{link_to_project(params[:project_id])}", :yellow
           end
+          
+          # Clean up after ourselves
+          issues.compact!
         else
           say collection.collect(&:id).join(" ")
         end
       end
 
+      desc "projects", "Lists all projects"
+      def projects
+        projects = Project.fetch_all.sort {|i,j| i.name <=> j.name}.collect { |project| [ project.id, project.identifier, project.name ] }
+        if projects.any?
+          projects.insert(0, ["Id", "Key", "Name"])
+          print_table(projects)
+          say "#{projects.count-1} projects - #{link_to_project}", :yellow
+        end
+      end
+
+      method_option :status,      :type => :boolean, :aliases => "-s",  :desc => "id or name of status for ticket"
+      method_option :priority,    :type => :boolean, :aliases => "-p",  :desc => "id or name of priority for ticket"
+      method_option :tracker,     :type => :boolean, :aliases => "-T",  :desc => "id or name of tracker for ticket"
+      method_option :subject,     :type => :boolean, :aliases => "-t",  :desc => "subject for ticket (title)"
+      method_option :description, :type => :boolean, :aliases => "-d",  :desc => "description for ticket"
+      method_option :assigned_to, :type => :boolean, :aliases => "-a",  :desc => "id or user name of person the ticket is assigned to"
+      method_option :notes,       :type => :boolean, :aliases => "-n",  :desc => "add a note to the Redmine ticket (interactively)"
+      desc "edit [OPTIONS] TICKET", "Interactively edit the fields of an issue"
+      def edit(ticket)
+        issue = Issue.find(ticket)
+
+        if options.empty?
+          say "You must specify at least one field to edit", :red
+          exit
+        end
+        
+        data = {}
+        options.each { | key, val |
+          # Set the initial value to one of:
+          #   The direct string representation of the issue's key
+          #   The value of the issue's key's "name" member
+          #   A multi-line string initialized to a message appropriate to the value (most useful for "notes" and "description")
+          initialval = issue.attributes.has_key?(key) && ! issue.attributes[key].nil? ? case issue.attributes[key]
+            when String then issue.attributes[key].to_s
+            else issue.attributes[key].name.to_s
+          end : "Enter your #{key} here.\n\n"
+
+          data[key] = initialval.clone.ed
+
+          if data[key] == initialval
+            # If the user didn't actually edit the field, then don't submit it for update.
+            say "You did not change the value, so the edit to #{key} was ignored.", :red 
+            data.delete(key)
+          end
+        }
+
+        unless data.empty?
+          update_ticket(ticket, data.with_indifferent_access)
+        else
+          say "There was no new data to submit, so #{ticket} was not updated.", :red
+        end
+
+
+      rescue ActiveResource::ResourceNotFound
+        say "No ticket with number: #{ticket}", :red
+      end
+
       desc "show TICKET", "Display information of a ticket"
       def show(ticket)
-        issue = Issue.find(ticket)
+        params = {}
+        params[:params] = {:include => "journals,changesets"}
+
+        issue = Issue.find(ticket, params)
 
         display_issue(issue)
       rescue ActiveResource::ResourceNotFound
@@ -48,7 +174,7 @@ module Redmine
         params =
           Thor::CoreExt::HashWithIndifferentAccess.new(:subject => subject,
                                                        :description => description,
-                                                       :project => Issue.config.default_project_id)
+                                                       :project => Redmine::Cli::config.default_project_id)
         params.merge!(options)
 
         unless params.project
@@ -66,9 +192,12 @@ module Redmine
 
       method_option :tickets,     :aliases => "-l",  :desc => "list of tickets", :type => :array
       method_option :status,      :aliases => "-s",  :desc => "id or name of status for ticket"
+      method_option :priority,    :aliases => "-p",  :desc => "id or name of priority for ticket"
+      method_option :tracker,     :aliases => "-T",  :desc => "id or name of tracker for ticket"
       method_option :subject,     :aliases => "-t",  :desc => "subject for ticket (title)"
       method_option :description, :aliases => "-d",  :desc => "description for ticket"
       method_option :assigned_to, :aliases => "-a",  :desc => "id or user name of person the ticket is assigned to"
+      method_option :notes,       :aliases => "-n",  :desc => "an optional note about this update"
       desc "update [TICKETS]", "Update tickets"
       def update(*tickets)
         tickets = options.tickets if tickets.blank? && options.tickets.present?
@@ -81,9 +210,9 @@ module Redmine
         tickets.collect { |ticket| Thread.new { update_ticket(ticket, options) } }.each(&:join)
       end
 
-      desc "install [URL][USERNAME]", "Generates a default configuration file"
+      desc "install [URL] [USERNAME] [FIELDS]", "Generates a default configuration file"
       method_option :test, :type => :boolean
-      def install(url = "localhost:3000", username = "")
+      def install(url = "localhost:3000", username = "", fieldcsv="")
         url = "http://#{url}" unless url =~ /\Ahttp/
 
         if username.blank?
@@ -92,33 +221,154 @@ module Redmine
 
         password = ask_password("Password?")
 
-        arguments = [url, username, password]
+        if fieldcsv.blank?
+          fieldcsv = ask("\nWhat fields should be displayed in \"redmine list\"?\n\nPossible values are: [" + fields.keys.join(", ") + "]\n\nEnter a list of comma-separated fields: ")
+        end
+
+        list_fields = fieldcsv.split(",")
+
+        arguments = [url, username, password, list_fields]
         arguments.concat(["--test"]) if options.test
 
         Redmine::Cli::Generators::Install.start(arguments)
       end
 
       no_tasks do
+
+        # Prints a table.
+        #
+        # ==== Parameters
+        # Array[Array[String, String, ...]]
+        #
+        # ==== Options
+        # indent<Integer>:: Indent the first column by indent value.
+        # colwidth<Integer>:: Force the first column to colwidth spaces wide.
+        #
+        def print_table(array, options = {}) # rubocop:disable MethodLength
+          return if array.empty?
+  
+          formats, indent, colwidth = [], options[:indent].to_i, options[:colwidth]
+          options[:truncate] = terminal_width if options[:truncate] == true
+  
+          formats << "%-#{colwidth + 2}s" if colwidth
+          start = colwidth ? 1 : 0
+  
+          colcount = array.max { |a, b| a.size <=> b.size }.size
+  
+          maximas = []
+  
+          start.upto(colcount - 1) do |index|
+            maxima = array.map { |row|
+              skip = false
+              rowlen = row[index].to_s.chars.collect { | char |
+                # Deal with ASCII escape sequences (skip them), also acknowledge that
+                # a char might consist of more than one byte in the case of unicode characters.
+                bytes = char.bytes.to_a
+                if bytes[0] < 32
+                  skip = true
+                end
+                if bytes[0] == 109 && skip == true
+                  skip = false
+                  0
+                  next
+                end
+                #puts "#{bytes.to_s} #{char} skip=#{skip}"
+                # FIXME: Unicode characters in most terminal fonts take up somewhere
+                # between 1 and 2 columns. So this isn't exact. (But it's better than nothing)
+                skip == true ? 0 : char.bytes.to_a.length > 1 ? 2 : 1
+              }.compact.reduce(:+)
+              row[index].present? ? rowlen : 0
+            }.max
+            maximas << maxima
+            if index == colcount - 1
+              # Don't output 2 trailing spaces when printing the last column
+              formats << '%-s'
+            else
+              formats << "%-#{maxima + 2}s"
+            end
+          end
+  
+          formats[0] = formats[0].insert(0, ' ' * indent)
+          formats << '%s'
+
+          array.each do |row|
+            sentence = ''
+  
+            row.each_with_index do |column, index|
+              maxima = maximas[index]
+  
+              if column.is_a?(Numeric)
+                if index == row.size - 1
+                  # Don't output 2 trailing spaces when printing the last column
+                  f = "%#{maxima}s"
+                else
+                  f = "%#{maxima}s "
+                end
+              else
+                f = formats[index]
+              end
+              sentence << f % column.to_s
+            end
+  
+            sentence = truncate(sentence, options[:truncate]) if options[:truncate]
+            puts sentence
+          end
+        end
+
         def link_to_issue(id)
-          "#{Issue.config.url}/issues/#{id}"
+          "#{Redmine::Cli::config.url}/issues/#{id}"
+        end
+
+        def link_to_project(name = nil)
+          if name
+            "#{Redmine::Cli::config.url}/projects/#{name}/issues"
+          else
+            "#{Redmine::Cli::config.url}"
+          end
+        end
+
+        def status_name(status)
+           status.name
         end
 
         def ticket_attributes(options)
           attributes = {}
 
-          attributes[:subject]        = options.subject               if options.subject.present?
-          attributes[:description]    = options.description           if options.description.present?
-          attributes[:project_id]     = options.project               if options.project.present?
-          attributes[:assigned_to_id] = map_user(options.assigned_to) if options.assigned_to.present?
-          attributes[:status_id]      = options.status                if options.status.present?
+          attributes[:subject]        = options["subject"]               if options["subject"].present?
+          attributes[:description]    = options["description"]           if options["description"].present?
+          attributes[:project_id]     = map_project(options["project"])  if options["project"].present?
+          attributes[:assigned_to_id] = map_user(options["assigned_to"]) if options["assigned_to"].present?
+          attributes[:status_id]      = map_status(options["status"])    if options["status"].present?
+          attributes[:priority_id]    = map_priority(options["priority"])if options["priority"].present?
+          attributes[:tracker_id]     = map_tracker(options["tracker"])  if options["tracker"].present?
+          attributes[:notes]          = options["notes"]                 if options["notes"].present?
 
           attributes
         end
 
         def display_issue(issue)
-          shell.print_wrapped "#{link_to_issue(issue.id)} - #{issue.status.name}"
+          shell.print_wrapped "#{issue.project.name} ##{issue.id} - #{link_to_issue(issue.id)} - #{issue.status.name}"
+          shell.print_wrapped "Priority: #{issue.priority.name}"
+          if issue.attributes[:assigned_to].present?
+            shell.print_wrapped "Assigned To: #{issue.attributes[:assigned_to].name}"
+          end
           shell.print_wrapped "Subject: #{issue.subject}"
-          shell.print_wrapped issue.description || "", :ident => 2
+          shell.print_wrapped "Tracker: #{issue.tracker.name}"
+          shell.print_wrapped issue.description || "", :indent => 2
+          if issue.journals.any?
+            issue.journals.each do |journal|
+              details = journal.details.collect do |detail|
+                unless detail.name == "description"
+                  "#{detail.name}: #{detail.old_value} => #{detail.new_value}"
+                else
+                  # Multi-line descriptions can make output unreadable.
+                  "#{detail.name} updated"
+                end
+              end
+              shell.print_wrapped "Updated by #{journal.user.name} on #{journal.created_on} (#{details})"
+              shell.print_wrapped "#{journal.notes}\n\n###".bold, :indent => 2 if journal.notes.present?
+            end
+          end
         end
 
         def map_user(user_name)
@@ -129,22 +379,116 @@ module Redmine
           get_mapping(:status_mappings, status_name)
         end
 
-        def get_mapping(mapping, value)
-          return value if value.to_i != 0
+        def map_priority(priority_name)
+          result = get_mapping(:priority_mappings, priority_name)
+          if Redmine::Cli::config["colorize"]
+            case result
+              # This is sort of a hack... ANSI sequences make it hard to figure out column lengths.
+              # So we make all fields the same length and with the same number of unprintable ansi
+              # sequence characters.
+  
+              when "Low" then       "Low      ".blue.blue.blue
+              when "Normal" then    "Normal   ".green.green.green
+              when "High" then      "High     ".red.red.red
+              when "Urgent" then    "Urgent   ".bold.red.red
+              when "Immediate" then "Immediate".blink.bold.red
+              else result[0...9]
+            end
+          else
+            result
+          end
+        end
+
+        def map_project(project_name)
+          get_mapping(:project_mappings, project_name)
+        end
+
+        def map_query(query_name)
+          get_mapping(:query_mappings, query_name)
+        end
 
-          if Issue.config[mapping].nil? || (mapped = Issue.config[mapping][value]).nil?
-            say "No #{mapping} for #{value}", :red
-            exit 1
+        def update_mapping_cache
+          unless Redmine::Cli::config["disable_caching"]
+            say 'Updating mapping cache...', :yellow
+            # TODO: Updating user mapping requries Redmine 1.1+
+            # TODO: Retrieving user mapping requires admin privileges in Redmine
+            users = []
+            begin
+              users = User.fetch_all.collect { |user| [ user.login, user.id ] }
+            rescue Exception => e
+              say "Failed to fetch users: #{e}", :red
+            end
+            projects = Project.fetch_all.collect { |project| [ project.identifier, project.id ] }
+            queries = Query.fetch_all.collect { |query|
+                    [ query.name, query.id ]
+            }
+  
+            priorities = {}
+            status = {}
+            Issue.fetch_all.each do |issue|
+                priorities[issue.priority.name] = issue.priority.id if issue.priority
+                status[issue.status.name] = issue.status.id if issue.status
+            end
+          
+            # TODO: Need to determine where to place cache file based on
+            #       config file location.
+            File.open(File.expand_path('~/.redmine_cache'), 'w') do |out|
+              YAML.dump({
+                :user_mappings => Hash[users],
+                :project_mappings => Hash[projects],
+                :priority_mappings => priorities,
+                :status_mappings => status,
+                :query_mappings => Hash[queries],
+              }, out)
+            end
+          end
+        end
+
+        def map_tracker(tracker_name)
+          get_mapping(:tracker_mappings, tracker_name)
+        end
+
+        def get_mapping(mapping, value)
+          begin
+            return value if value.to_i != 0
+          rescue NoMethodError
+            return value.attributes.fetch("name") if value.id.to_i != 0
+          end
+          
+          if Redmine::Cli::config[mapping].nil? || (mapped = Redmine::Cli::config[mapping][value]).nil?
+            if !(mapped = get_mapping_from_cache(mapping, value))
+              update_mapping_cache
+
+              if !(mapped = get_mapping_from_cache(mapping, value))
+                say "No #{mapping} for #{value}", :red
+                exit 1
+              end
+            end
           end
 
           return mapped
         end
 
+        def get_mapping_from_cache(mapping, value)
+          begin
+            if Redmine::Cli::cache[mapping].nil? || (mapped = Redmine::Cli::cache[mapping][value]).nil?
+              return false
+            end
+            return mapped
+          rescue
+            # We need to recover here from any error that could happen
+            # in case the cache is corrupted.
+            return false
+          end
+        end
+
         def update_ticket(ticket, options)
           issue = Issue.find(ticket)
           params = ticket_attributes(options)
 
           if issue.update_attributes(params)
+            params[:params] = {:include => "journals,changesets"}
+            issue = Issue.find(ticket, params)
             say "Updated: #{ticket}. Options: #{params.inspect}", :green
             display_issue(issue)
           else
@@ -160,7 +504,57 @@ module Redmine
           system "stty echo"
           password
         end
+
+        def fields()
+          # This is a collection of built-in Redmine fields, the key by which they can be accessed, and a wrapper
+          # method that is used to display their value. Pseudo-fields can be added that use different wrapper
+          # methods to give the user flexibility over their output (see url vs. id)
+          return {
+            "url" => Field.new("URL", "id", method(:link_to_issue)),
+            "id" => Field.new("ID#", "id"),
+            "subject" => Field.new("Subject", "subject"),
+            "status" => Field.new("Status", "status", method(:status_name)),
+            "start_date" => Field.new("Start", "start_date"),
+            "estimated_hours" => Field.new("Estd", "estimated_hours"),
+            "tracker" => Field.new("Type", "tracker", method(:map_user)),
+            "priority" => Field.new("Priority", "priority", method(:map_priority)),
+            "description" => Field.new("Description", "description"),
+            "assigned_to" => Field.new("Assigned To", "assigned_to", method(:map_user)),
+            "project" => Field.new("Project", "project", method(:map_user)),
+            "author" => Field.new("Author", "author", method(:map_user)),
+            "done_ratio" => Field.new("% Done", "done_ratio"),
+            "due_date" => Field.new("Due On", "due_date"),
+            "created_on" => Field.new("Created On", "created_on"),
+            "updated_on" => Field.new("Updated On", "updated_on"),
+          }
+        end
+
+        def default_parameters
+          {:limit => 100}
+        end
       end
     end
   end
 end
+
+class String
+  def black;          "\033[30m#{self}\033[0m" end
+  def red;            "\033[31m#{self}\033[0m" end
+  def green;          "\033[32m#{self}\033[0m" end
+  def brown;          "\033[33m#{self}\033[0m" end
+  def blue;           "\033[34m#{self}\033[0m" end
+  def magenta;        "\033[35m#{self}\033[0m" end
+  def cyan;           "\033[36m#{self}\033[0m" end
+  def gray;           "\033[37m#{self}\033[0m" end
+  def bg_black;       "\033[40m#{self}\0330m"  end
+  def bg_red;         "\033[41m#{self}\033[0m" end
+  def bg_green;       "\033[42m#{self}\033[0m" end
+  def bg_brown;       "\033[43m#{self}\033[0m" end
+  def bg_blue;        "\033[44m#{self}\033[0m" end
+  def bg_magenta;     "\033[45m#{self}\033[0m" end
+  def bg_cyan;        "\033[46m#{self}\033[0m" end
+  def bg_gray;        "\033[47m#{self}\033[0m" end
+  def bold;           "\033[1m#{self}\033[22m" end
+  def blink;          "\033[5m#{self}\033[22m" end
+  def reverse_color;  "\033[7m#{self}\033[27m" end
+end

data/lib/redmine-cli/config.rb

@@ -0,0 +1,48 @@
+require 'thor'
+require 'yaml'
+
+module Redmine
+  module Cli
+    class << self
+
+      def config
+        begin
+          generic_conf '.redmine'
+        rescue Errno::ENOENT
+          puts "You need to create the file .redmine in your home with your username, password and url"
+          exit 1
+        end
+      end
+
+      def cache
+        begin
+          generic_conf '.redmine_cache'
+        rescue Errno::ENOENT
+          @cache = Thor::CoreExt::HashWithIndifferentAccess.new
+        end
+      end
+
+      private
+
+      def generic_conf(config_file)
+        # Using Ruby Magic(tm) to get the caller's function name to use for
+        # setting up instance variables/accessors for generic config files.
+        config_name = caller[0][/`.*'/][1..-2]
+
+        if !File.file? config_file
+          config_file = File.expand_path "~/#{config_file}"
+        end
+
+        contents = YAML.load_file config_file
+        if contents
+          config ||= Thor::CoreExt::HashWithIndifferentAccess.new(YAML.load_file(config_file))
+        else
+          config ||= Thor::CoreExt::HashWithIndifferentAccess.new
+        end
+        self.instance_variable_set("@#{config_name}", config)
+      end
+
+
+    end
+  end
+end

data/lib/redmine-cli/field.rb

@@ -0,0 +1,18 @@
+module Redmine
+  class Field
+    def initialize(title, ref, dm=nil)
+      @title=title      # The string displayed in the listing table for this field
+      @ref=ref        # The attribute referenced from the issue record
+      @display_method=dm    # A method used to process the value before displaying (optional)
+    end
+    def title
+      return @title
+    end
+    def ref
+      return @ref
+    end
+    def display
+      return @display_method
+    end
+  end
+end

data/lib/redmine-cli/generators/.redmine

@@ -2,6 +2,8 @@ url: "<%= url %>"
 username: "<%= username %>"
 password: "<%= password %>"
 default_project_id: 1
+disable_caching: false
+colorize: true
 user_mappings:
   "admin": 1
 status_mappings:
@@ -11,3 +13,8 @@ status_mappings:
   "feedback": 4
   "closed": 5
   "rejected": 6
+list_fields:
+  - <%= list_fields.join("\n  - ") %>
+tracker_mappings:
+  "bug" : 1
+  "feature": 2

data/lib/redmine-cli/generators/install.rb

@@ -9,9 +9,10 @@ module Redmine::Cli::Generators
       File.dirname(__FILE__)
     end
 
-    argument :url,       :type => :string
-    argument :username,  :type => :string
-    argument :password,  :type => :string
+    argument :url,          :type => :string
+    argument :username,     :type => :string
+    argument :password,     :type => :string
+    argument :list_fields,  :type => :array
     class_option :test,  :type => :boolean
     def copy_configuration_file
       self.destination_root = File.expand_path("~") unless options.test

data/lib/redmine-cli/git.rb

@@ -1,5 +1,5 @@
 require 'thor'
-require 'redmine-cli/issue'
+require 'redmine-cli/resources'
 
 module Redmine
   module Cli

data/lib/redmine-cli/resources.rb

@@ -0,0 +1,64 @@
+require 'thor'
+require 'active_resource'
+require 'active_support/core_ext/object/with_options'
+require 'redmine-cli/config'
+require 'pp'
+
+module Redmine
+  module Cli
+    class BaseResource < ActiveResource::Base
+      self.site = Redmine::Cli::config.url
+      self.user = Redmine::Cli::config.username
+      self.password = Redmine::Cli::config.password
+
+      class << self
+        # HACK: Redmine API isn't ActiveResource-friendly out of the box, so
+        # we need to pass nometa=1 to all requests since we don't care about
+        # the metadata that gets passed back in the top level attributes.
+        def find(*arguments)
+          arguments[1] = arguments[1] || {}
+          arguments[1][:params] = arguments[1][:params] || {}
+          arguments[1][:params][:nometa] = 1
+
+          super
+        end
+
+        def fetch_all(params = {})
+          limit  = 100
+          offset = 0
+
+          resources = []
+
+          while((fetched_resources = self.all(:params => params.merge({:limit => limit, :offset => offset}))).any?)
+            resources += fetched_resources
+            offset    += limit
+          end
+
+          resources
+        end
+      end
+    end
+
+    class Issue   < BaseResource; end
+    class User    < BaseResource; end
+    class Project < BaseResource; end
+    class Query < BaseResource; end
+  end
+end
+
+
+# HACK: Redmine API isn't ActiveResource-friendly out of the box, and
+# also some versions of Redmine ignore the nometa=1 parameter. So we
+# need to manually strip out metadata that confuses ActiveResource.
+class Hash
+  class << self
+    alias_method :from_xml_original, :from_xml
+    def from_xml(xml)
+      scrubbed = scrub_attributes(xml)
+      from_xml_original(scrubbed)
+    end
+    def scrub_attributes(xml)
+      xml.gsub(/<issues .*?>/, "<issues type=\"array\">")
+    end
+  end
+end

data/lib/redmine-cli/version.rb

@@ -1,5 +1,5 @@
 module Redmine
   module Cli
-    VERSION = "0.1.1"
+    VERSION = "0.1.4"
   end
 end

data/redmine-cli.gemspec

@@ -21,8 +21,13 @@ Gem::Specification.new do |s|
 
   s.add_dependency "activeresource", "~>3.0.0"
   s.add_dependency "thor"
-  s.add_development_dependency "ruby-debug"
+  if RUBY_VERSION =~ /1.9/
+    s.add_development_dependency "ruby-debug19"
+  else
+    s.add_development_dependency "ruby-debug"
+  end
   s.add_development_dependency "rspec"
   s.add_development_dependency "cucumber"
   s.add_development_dependency "aruba"
+  s.add_dependency "interactive_editor"
 end

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: redmine-cli
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors: 
 - Jorge Dias
@@ -15,22 +9,15 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-01 00:00:00 +01:00
-default_executable: 
+date: 2015-02-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activeresource
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
         version: 3.0.0
   type: :runtime
   version_requirements: *id001
@@ -38,72 +25,53 @@ dependencies:
   name: thor
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ">="
+    - &id003 
+      - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: ruby-debug
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    - *id003
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    - *id003
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: cucumber
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    - *id003
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: aruba
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    - *id003
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: interactive_editor
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
+  type: :runtime
+  version_requirements: *id008
 description: A simple command line interface for redmine for easy scripting
 email: 
 - jorge@mrdias.com
@@ -118,7 +86,8 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
-- README.markdown
+- LICENSE
+- README.md
 - Rakefile
 - bin/git-redmine
 - bin/redmine
@@ -127,45 +96,39 @@ files:
 - features/support/setup.rb
 - lib/redmine-cli.rb
 - lib/redmine-cli/cli.rb
+- lib/redmine-cli/config.rb
+- lib/redmine-cli/field.rb
 - lib/redmine-cli/generators/.redmine
 - lib/redmine-cli/generators/install.rb
 - lib/redmine-cli/git.rb
-- lib/redmine-cli/issue.rb
+- lib/redmine-cli/resources.rb
 - lib/redmine-cli/version.rb
 - redmine-cli.gemspec
-has_rdoc: true
 homepage: http://rubygems.org/gems/redmine-cli
 licenses: []
 
+metadata: {}
+
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  - *id003
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  - *id003
 requirements: []
 
 rubyforge_project: redmine-cli
-rubygems_version: 1.3.7
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Command line interface for redmine
-test_files: []
-
+test_files: 
+- features/install.feature
+- features/step_definitions/install_steps.rb
+- features/support/setup.rb
+has_rdoc: 

data/README.markdown

@@ -1,44 +0,0 @@
-# A command line interface for redmine
-
-## Install
-
-  Execute
-      redmine install
-
-  This will create a .redmine file in your home directory. The file is a yaml file which contains our necessary configuration
-
-  Here you can add mappings for users and status like:
-
-      user_mappings:
-        "me": 1
-        "johndoe": 24
-      status_mappings:
-        "new": 1
-        "closed": 4
-
-  This will allow to use those names with the commands instead of the ids of users or status
-
-## Use cases
-
-- Listing tickets
-
-    redmine list
-    redmine list -a me
-
-- Display ticket
-
-    redmine show 524
-
-- Updating a ticket
-
-    redmine update 524 -description "New description"
-    redmine update 256 --assigned_to me
-
-- Updating multiple tickets
-
-    redmine update 2 3 4 --assigned_to johndoe
-
-- Updating all tickets for a list
-
-    redmine list --status new --std_output | xargs redmine update --asigned_to me --status 3 -l
-    \# Note that the last argument of the update command must be -l

data/lib/redmine-cli/issue.rb

@@ -1,22 +0,0 @@
-require 'thor'
-require 'active_resource'
-
-module Redmine
-  module Cli
-    class Issue < ActiveResource::Base
-      def self.config
-        @config ||=
-          begin
-            Thor::CoreExt::HashWithIndifferentAccess.new(YAML.load_file(File.expand_path("~/.redmine")))
-          rescue Errno::ENOENT
-            puts "You need to create the file .redmine in your home with your username, password and url"
-            Thor::CoreExt::HashWithIndifferentAccess.new
-          end
-      end
-
-      self.site = config.url
-      self.user = config.username
-      self.password = config.password
-    end
-  end
-end