redminerb 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0eaa8da3e11151f1a2699b28ef9d1cdb1f5444f
-  data.tar.gz: 48d69b47bb1d62359ceb1c8561eaf725303af1ff
+  metadata.gz: 4ffa75b08fce4f5b9002a23c8390cf6bd82a9efe
+  data.tar.gz: b8aa4a4d89f7cd543e94026d5536cd4d0205998f
 SHA512:
-  metadata.gz: 5171b97f91535076e8329bdbe5a87ccb88e94cb5951670e8dc1447a1788efbc659b2036d6dffc17ff96b2b1db960c06338b8da30b0b6670e0c0c0fdb967f365f
-  data.tar.gz: e1ca1b8a22384bc489850c2dcec3671bb5792c4239399d1236ada750f73ad39e87f5354de4a7607f3daae1d4c50dd8922828b39a22b5d588691a8099083aa091
+  metadata.gz: 4f089f4606de00bfbf4da4df880b45c7c59dc982faf880f84c3ff7faf0995ee985217fa289bc8f4f0b5326388249621ab52e1c7dd7392589a611d95403b2209e
+  data.tar.gz: 58c101d78ccaf6f156fb4ea0155ac5422795aeb2c80daf9bf002464701aff3409aa12d9735ddff579f13f6ab01fb50f7da44ef36a22c5f8a7f7e61633b2bb7b8

data/README.md

@@ -127,13 +127,13 @@ The **users** command is the wrapper for part of the [Users resource](http://www
 
     $ redminerb users # i.e. 'redminerb users list'
 
-That should give you the current users on your Redmine server, one per line.
+That should give you the current users on your Redmine server, one per line. It will return a 403 error if our API key's user doesn't have permission to list users.
 
-You can use the `--name` option to list users as described by the *name* filter of the API resource. The `-q` and `--query` are aliases for this option. For example:
+You can use the `--name` option to list users as described by the *name* filter of the API resource (see the link above). The `-q` and `--query` are aliases for this option. For example:
 
     $ redminerb users -q red # i.e. 'redminerb users list --name=red'
 
-Will show us the users which login, first name, last name or email contains the 'red' word.
+Will show us the **users whose login, first name, last name or email** contains the **'red'** word.
 
 By omission *users list* gives you the ID, the login and the e-mail of the user. You can
 change that using the *--fields (-f)* option, that let you specify others separated
@@ -197,6 +197,19 @@ For example, to see the info of the issue #12539 we'd launch:
 
     $ redminerb issue 12539
 
+
+### Projects
+
+The **projects** command is the wrapper for part of the [Projects resource](http://www.redmine.org/projects/redmine/wiki/Rest_Projects) of the Redmine REST API.
+
+#### List projects
+
+    $ redminerb projects [list] [-q|--query <FILTER>]
+
+The command *projects* will give us the ids of every public and private project where the user have access to.
+
+The results can be **filtered** through a **case unsensitive match** using the *--query (-q, --name)* option. For example, the order `redminerb projects -q iber` will show us all projects whose names match **"IBER"**.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/redminerb/cli/projects.rb

@@ -0,0 +1,37 @@
+# Copyright (c) The Cocktail Experience S.L. (2015)
+require_relative '../projects'
+
+module Redminerb
+  module Cli
+    # Thor's 'projects' subcommand definition
+    class Projects < Thor
+      default_command :list
+  
+      desc 'list', 'Shows open projects in our Redmine'
+      option :name,   aliases: [:q, '--query'], banner: '<FILTER>'
+      option :offset, aliases: :o
+      option :limit, aliases: :l
+      def list(project_id = nil)
+        if project_id
+          show(project_id)
+        else
+          Redminerb.init!
+          name = options.delete(:name)
+          Redminerb::Projects.list(options).each do |project|
+            if name.nil? || project.name =~ /#{name}/i
+              puts "#{project.id}\t".green + 
+                   project.name.split.map { |i| i.capitalize }.join(' ').green
+            end
+          end
+        end
+      end
+
+      desc 'show <number>', 'Shows an project (SHORTCUT: "redminerb projects <number>")'
+      option :template, aliases: :t
+      def show(project_id)
+        Redminerb.init!
+        puts Redminerb::Template.render(:project, Redminerb::Projects.read(project_id), options)
+      end
+    end
+  end
+end

data/lib/redminerb/cli.rb

@@ -4,6 +4,7 @@ require 'colorize'
 require_relative '../redminerb'
 require_relative 'cli/users'
 require_relative 'cli/issues'
+require_relative 'cli/projects'
 
 module Redminerb
   # Thor's command class
@@ -19,9 +20,11 @@ module Redminerb
     end
 
     # The subcommad's classes are defined in lib/redminerb/cli
-    desc 'users [list]', "Manage Redmine's users"
+    desc 'users [list|<id>]', "Manage Redmine's users"
     subcommand 'users', Cli::Users
-    desc 'issues [show] <id>', "Manage Redmine's issues"
+    desc 'issues [list|<id>]', "Manage Redmine's issues"
     subcommand 'issues', Cli::Issues
+    desc 'projects [list|<id>]', "Manage Redmine's projects"
+    subcommand 'projects', Cli::Projects
   end
 end

data/lib/redminerb/projects.rb

@@ -0,0 +1,35 @@
+# Copyright (c) The Cocktail Experience S.L. (2015)
+require 'recursive-open-struct'
+
+module Redminerb
+  # Projects resource wrapper
+  class Projects
+    class << self
+      # Get Redmine's projects as OpenStruct objects.
+      #
+      # Example:
+      #   Redminerb.init!
+      #   Redminerb::Projects.list.each do |project|
+      #      puts "#{project.id}: #{project.name}"
+      #   end
+      #
+
+      def list(params)
+        Redminerb.client.get_json('/projects.json', params)['projects'].map do |project|
+          OpenStruct.new project
+        end
+      end
+
+      # Get an project's info as an OpenStruct object.
+      #
+      # Example:
+      #   Redminerb.init!
+      #   project = Redminerb::Projects.read(34)
+      #   puts "#{project.id}: #{project.name}"
+      #
+      def read(id)
+        RecursiveOpenStruct.new Redminerb.client.get_json("/projects/#{id}.json")['project']
+      end
+    end
+  end
+end

data/lib/redminerb/version.rb

@@ -1,4 +1,4 @@
 # Copyright (c) The Cocktail Experience S.L. (2015)
 module Redminerb
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/lib/redminerb.rb

@@ -39,7 +39,7 @@ module Redminerb
   end
 
   def init_required!
-    fail(UninitializedError, 'Call Redminerb.init! first') unless @initialized
+    fail(UninitializedError, 'call Redminerb.init! first') unless @initialized
   end
 
   def config

data/templates/issue.erb

@@ -1,12 +1,12 @@
 <%= Redminerb.separator.green %>
-<%= "[#{issue.tracker.name}]".blue + "[#{issue.project.name}:##{issue.id}]".green %> <%= issue.subject %>
+  <%= "[#{issue.tracker.name}]".blue + "[#{issue.project.name}##{issue.id}]".green %> <%= issue.subject %>
 <%= Redminerb.separator.green %>
-Author:      <%= issue.author.name.red %>
-Assigned to: <%= issue.assigned_to.name.red %>
-Status:      <%= issue.status.name.red %>
-Priority:    <%= issue.priority.name.red %>
+  Author:      <%= issue.author.name.red %>
+  Assigned to: <%= issue.assigned_to.name.red %>
+  Status:      <%= issue.status.name.red %>
+  Priority:    <%= issue.priority.name.red %>
 <%= Redminerb.separator.green %>
-<%= issue.description %>
+  <%= issue.description %>
 <%= Redminerb.separator.green %>
-<%= Redminerb.config.url + "issues/#{issue.id}" %>
+  <%= (Redminerb.config.url + "issues/#{issue.id}").red %>
 <%= Redminerb.separator.green %>

data/templates/project.erb

@@ -0,0 +1,14 @@
+<%= Redminerb.separator.green %>
+  <%= project.name.split.map { |i| i.capitalize }.join(' ').blue %> (#<%= project.id %>)
+<%= Redminerb.separator.green %>
+  <% if project.parent %>Parent:       <%= project.parent.name.capitalize.red %> (#<%= project.parent.id %>)<% end %>
+  Identifier:   <%= project.identifier.red %>
+  Homepage:     <%= project.homepage.red %>
+  Created date: <%= project.created_on.red %>
+  Updated:      <%= project.created_on.red %>
+  Status:       <%= project.status.to_s.red %>
+<%= Redminerb.separator.green %>
+  Description: <%= project.description.gsub("\n", "\n    ") %>
+<%= Redminerb.separator.green %>
+  <%= (Redminerb.config.url + "projects/#{project.id}").red %>
+<%= Redminerb.separator.green %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redminerb
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Fernando Garcia Samblas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -217,16 +217,19 @@ files:
 - lib/redminerb.rb
 - lib/redminerb/cli.rb
 - lib/redminerb/cli/issues.rb
+- lib/redminerb/cli/projects.rb
 - lib/redminerb/cli/users.rb
 - lib/redminerb/client.rb
 - lib/redminerb/config.rb
 - lib/redminerb/issues.rb
+- lib/redminerb/projects.rb
 - lib/redminerb/template.rb
 - lib/redminerb/users.rb
 - lib/redminerb/version.rb
 - redminerb.gemspec
 - templates/issue.erb
 - templates/issue_boxie.erb
+- templates/project.erb
 - templates/user.erb
 - templates/user_in_a_box.erb
 homepage: http://github.com/nando/redminerb