redmine-cli 0.0.1 → 0.1.0

data/README.markdown

@@ -1,11 +1,44 @@
 # 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
+    redmine list -a me
+
+- Display ticket
+
     redmine show 524
-    redmine update 524 -d "New description"
-    redmine update 256 --assigned_to "me"
-    redmine update 2,3,4 --assigned_to "me"
-    redmine list --status 1 | xargs redmine update --asigned_to "me" --status 3 -l
+
+- 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.rb

@@ -2,3 +2,4 @@ require 'thor'
 require 'active_resource'
 require 'redmine-cli/issue'
 require 'redmine-cli/cli'
+require 'redmine-cli/generators/install'

data/lib/redmine-cli/cli.rb

@@ -79,6 +79,12 @@ module Redmine
         tickets.collect { |ticket| Thread.new { update_ticket(ticket, options) } }.each(&:join)
       end
 
+      desc "install [URL][USERNAME][PASSWORD]", "Generates a recipe scaffold"
+      def install(url = "localhost:3000", username = "admin", password = "admin")
+        url = "http://#{url}" unless url =~ /\Ahttp/
+        Redmine::Cli::Generators::Install.start([url, username, password])
+      end
+
       no_tasks do
         def link_to_issue(id)
           "#{Issue.config.url}/issues/#{id}"

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

@@ -0,0 +1,12 @@
+url: "<%= url %>"
+username: "<%= username %>"
+password: "<%= password %>"
+user_mappings:
+  "admin": 1
+status_mappings:
+  "new": 1
+  "in-progress": 2
+  "resolved": 3
+  "feedback": 4
+  "closed": 5
+  "rejected": 6

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

@@ -0,0 +1,20 @@
+require 'thor/group'
+require 'pathname'
+
+module Redmine::Cli::Generators
+  class Install < Thor::Group
+    include Thor::Actions
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    argument :url,      :type => :string
+    argument :username, :type => :string
+    argument :password, :type => :string
+    def copy_configuration_file
+      self.destination_root = File.expand_path("~")
+      template(".redmine")
+    end
+  end
+end

data/lib/redmine-cli/version.rb

@@ -1,5 +1,5 @@
 module Redmine
   module Cli
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: redmine-cli
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jorge Dias
@@ -80,6 +80,8 @@ files:
 - bin/redmine
 - lib/redmine-cli.rb
 - lib/redmine-cli/cli.rb
+- lib/redmine-cli/generators/.redmine
+- lib/redmine-cli/generators/install.rb
 - lib/redmine-cli/issue.rb
 - lib/redmine-cli/version.rb
 - redmine-cli.gemspec