redminerb 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da909c714880dbb6b5574f5231f23fc6b6746212
-  data.tar.gz: a441ec352a81a81fae4b9ba561fedd475984607d
+  metadata.gz: 86ab53553c2c822bbd2eca3a1509d0cbf5398e55
+  data.tar.gz: 4fa29701cab649703cb0e724530e5a21b43b2de1
 SHA512:
-  metadata.gz: f1950ab70ede6e2a8614098ea9137a8bb978c4999ca44baa9db5304e190561ff914294fa2aeba7539acc4467744bd0b2b6c1c92ea28b770e2db1a6b0457f96b2
-  data.tar.gz: e1676c311102229ef787b6a2c285925d7a2faf9f4959e64d8e9fb496e5910724bc9dfdf77f32d47efde1d3a8e1e01c9045db5413343cce6cb3629d529ceb077b
+  metadata.gz: a1fa0e876a7043e7c7276b097647c6572e97ad90bbf97f658c10a85ece9f3281401c05e372cd72045d51c3fc0e3da2e79e5704d181e39da89b87de1aca5ec075
+  data.tar.gz: 1b73b40315e6d8c78c265811d7d2719c49413898b57afe601272e5240cb7435268003b1469b69e4dce9ee11c0d848402388f8c1ff88af7182dbce6edfcf91775

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.4, released 2015-09-22
+
+* 'redminerb users show <id>' to see a user's info.
+
 == 0.3, released 2015-09-22
 
 * 'redminerb issues [show] <number>' to see an issue's info

data/README.md

@@ -100,6 +100,11 @@ You can see **all the fields available** with `redminerb users me`.
 Will show the data in the Redmine server associated with the account that has
 the API key used to access the Rest API (hopefully your data :).
 
+#### Show user's data
+
+    $ redminerb users show <id>
+
+Will give us the info associated with the user with the given *id*.
 
 #### Create new user
 
@@ -122,6 +127,10 @@ So, the previous command is the same as the following:
     $ redminerb users create -l wadus -p ultrasecret -fn Wadux -ln Wallace \
                              -m wadus@waduxwallace.out
 
+### Issues
+
+The **issues** command is the wrapper for part of the [Issues resource](http://www.redmine.org/projects/redmine/wiki/Rest_Issues) of the Redmine REST API.
+
 #### List issues
 
     $ redminerb issues list

data/lib/redminerb/cli.rb

@@ -21,7 +21,7 @@ module Redminerb
     # The subcommad's classes are defined in lib/redminerb/cli
     desc 'users [list]', "Manage Redmine's users"
     subcommand 'users', Cli::Users
-    desc 'issues [list]', "Manage Redmine's issues"
+    desc 'issues [show] <id>', "Manage Redmine's issues"
     subcommand 'issues', Cli::Issues
   end
 end

data/lib/redminerb/cli/issues.rb

@@ -1,5 +1,4 @@
 # Copyright (c) The Cocktail Experience S.L. (2015)
-require 'erb'
 require_relative '../issues'
 
 module Redminerb
@@ -21,9 +20,7 @@ module Redminerb
       desc 'show <number>', 'Shows the data of the issue which id match with #<number>'
       def show(issue_id)
         Redminerb.init!
-        issue = Redminerb::Issues.read(issue_id)
-        template = Redminerb::Template.read(:issue)
-        puts ERB.new(template).result(binding)
+        puts Redminerb::Template.render(:issue, Redminerb::Issues.read(issue_id))
       end
     end
   end

data/lib/redminerb/cli/users.rb

@@ -7,7 +7,7 @@ module Redminerb
     class Users < Thor
       default_command :list
   
-      desc 'list', 'Shows the current users in our Redmine'
+      desc 'list', 'Shows the current users in our Redmine.'
       option :fields, aliases: :f, banner: 'id:login:email'
       option :name,   aliases: [:q, '--query'], banner: '<FILTER>'
       option :offset, aliases: :o
@@ -31,13 +31,19 @@ module Redminerb
         puts Redminerb::Users.create(options).green
       end
   
-      desc 'me', 'Shows the info of the owner of the API key'
+      desc 'me', 'Shows the info of the owner of the API key.'
       def me
         Redminerb.init!
         Redminerb::Users.me.each do |field, value|
           puts "#{field}: ".blue + value.to_s.green
         end
       end
+
+      desc 'show <id>', 'Shows the info of the user with id <id>.'
+      def show(user_id)
+        Redminerb.init!
+        puts Redminerb::Template.render(:user, Redminerb::Users.read(user_id))
+      end
     end
   end
 end

data/lib/redminerb/template.rb

@@ -1,23 +1,49 @@
 # Copyright (c) The Cocktail Experience S.L. (2015)
-require 'ostruct'
+require 'erb'
 
 module Redminerb
   # Class to read Redminerb's ERB templates
   class Template
     class << self
-      # Returns the content of the given ERB file in the templates directory.
+      # Renders the template +name+ using +resource+ assigned to a local
+      # variable with that same name in its binding (i.e. the template will
+      # have a local variable with the same name of the template that let
+      # us access to the resource).
+      #
+      # ==== Parameters
+      #
+      # * +name+ - Filename (without the erb extension) of the template in the
+      #   templates directory.
+      #
+      # * +resource+ - The object that will be available into the template with
+      #   the same name as the the template itself.
+      #
+      # ==== Example:
+      #
+      #   # With this content in templates/issue.erb:
       #
-      # Example:
-      #   Redminerb::Template.read(:issue) # Returns the content of templates/issue.erb
+      #   Title: <%= issue[:subject] %>
+      #
+      #   # ...we could call +render+ this way:
+      #
+      #   Redminerb::Template.render(:issue, {subject: 'Fixme!'})
       #
 
-      def read(name)
-        File.read(filepath(name))
+      def render(name, resource)
+        b = binding
+        b.local_variable_set(name, resource)
+        template = _read_template(name)
+        ERB.new(template).result(b)
       end
 
       private
 
-      def filepath(name)
+      # Returns the content of the given ERB file in the templates directory.
+      def _read_template(name)
+        File.read(_filepath(name))
+      end
+
+      def _filepath(name)
         File.join(File.dirname(__FILE__)[0..-15], 'templates', "#{name}.erb")
       end
     end

data/lib/redminerb/users.rb

@@ -50,6 +50,10 @@ module Redminerb
       def me
         Redminerb.client.get_json('/users/current.json')['user']
       end
+
+      def read(id)
+        OpenStruct.new Redminerb.client.get_json("/users/#{id}.json")['user']
+      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.3.0'
+  VERSION = '0.4.0'
 end

data/templates/user.erb

@@ -0,0 +1,13 @@
+<%= Redminerb.separator %>
+  <%= user.login.upcase.green %>
+<%= Redminerb.separator %>
+   * Id:        <%= user.id.to_s.blue %>
+   * Firstname: <%= user.firstname.red %>
+   * Lastname:  <%= user.lastname.red %>
+   * Login:     <%= user.login.red %>
+   * E-Mail:    <%= user.mail.red %>
+<%= Redminerb.separator %>
+   * Created:    <%= user.created_on.blue %>
+   * Last login: <%= user.last_login_on.blue %>
+   * Status:     <%= user.status.to_s.blue %>
+<%= Redminerb.separator %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redminerb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Fernando Garcia Samblas
@@ -184,6 +184,7 @@ files:
 - lib/redminerb/version.rb
 - redminerb.gemspec
 - templates/issue.erb
+- templates/user.erb
 homepage: http://github.com/nando/redminerb
 licenses: []
 metadata: {}