redminerb 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78b4c1082e72394b5aab415a8f9b1e19d93cdbcd
-  data.tar.gz: 3d2b52e472d8df0671609bcfbea5517cb455a015
+  metadata.gz: da909c714880dbb6b5574f5231f23fc6b6746212
+  data.tar.gz: a441ec352a81a81fae4b9ba561fedd475984607d
 SHA512:
-  metadata.gz: f7c4dd68bc9cc2c16612611ef5b39db474151b1b9de856525d122cebd789c1d7f3b9a4194fd080adea69fa8235ee0f77a9fd6bb3d8ea54a817c9edece6f06028
-  data.tar.gz: 5c5a92008102dded2da0d9a0ffa202a3819cb808bd93ffe863f0e30e17a2cc63809af1397517a1ddb9543dbc89c95a7effd4d5cc32ceb0003c762b0953b98b5d
+  metadata.gz: f1950ab70ede6e2a8614098ea9137a8bb978c4999ca44baa9db5304e190561ff914294fa2aeba7539acc4467744bd0b2b6c1c92ea28b770e2db1a6b0457f96b2
+  data.tar.gz: e1676c311102229ef787b6a2c285925d7a2faf9f4959e64d8e9fb496e5910724bc9dfdf77f32d47efde1d3a8e1e01c9045db5413343cce6cb3629d529ceb077b

data/.rubocop.yml

@@ -7,3 +7,5 @@ Style/TrailingWhitespace:
   Enabled: false
 Style/RedundantReturn:
   Enabled: false
+
+# inherit_from: .rubocop_todo.yml

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 0.3, released 2015-09-22
+
+* 'redminerb issues [show] <number>' to see an issue's info
+* 'redminerb issues list' to see open issues
+
 == 0.2, released 2015-09-17
 
 * 'redminerb users create' to create a brand new user!

data/README.md

@@ -34,8 +34,9 @@ Or install it yourself as:
 
 ## Usage
 
-The URL and the API key needed to access to your Redmine REST API need to be in
-in your environment or in the `~/.redminerb.yml`.
+The URL and the API key of your Redmine REST API must be in your environment
+using *REDMINERB_URL* and *REDMINERB_API_KEY*, or in the `~/.redminerb.yml` as values
+of the *url* and *api_key* keys.
 
 For example, this `~/.redminerb.yml`:
 
@@ -47,6 +48,13 @@ Would be the same as having the following in your `.bashrc`:
     export REDMINERB_URL=http://localhost:3000/
     export REDMINERB_API_KEY=69b47d74e36a6757bac5d45f8398dd23bfa8f52c
 
+GET request on a collection ressources give us the results as indicated by the
+[Redmine pagination documentation](http://www.redmine.org/projects/redmine/wiki/Rest_api#Collection-resources-and-pagination). You can use the *--limit (-l)* and *--offset (-o)* options.
+
+For example, you can see the third user of your Redmine with:
+
+    $ redminerb users -o 3 -l 1
+
 ### Configuration (config)
 
 To see the current configuration used by Redminerb we have the `config` command:
@@ -55,28 +63,35 @@ To see the current configuration used by Redminerb we have the `config` command:
     URL:     http://localhost:3000/
     API-KEY: 69b47d74e36a6757bac5d45f8398dd23bfa8f52c
 
-*NOTICE: soon will be possible to specify this values using env. vars and this
-command will have more sense.*
-
 ### Users
 
-**IMPORTANT: Be sure that you API key have the right permissions in the server.**
+The **users** command is the wrapper for part of the [Users resource](http://www.redmine.org/projects/redmine/wiki/Rest_Users) of the Redmine REST API.
+
+**IMPORTANT: Be sure that your API key's user have the right permissions in the server.**
 
 #### List current users
 
-    $ redminerb users # a.k.a. redminerb users list
+**List** is the default subcommand of the *users* command:
+
+    $ redminerb users # i.e. 'redminerb users list'
 
 That should give you the current users on your Redmine server, one per line.
 
-By omission it gives you the ID, the login and the e-mail of the user. You can
-change that using the --fields option, that let you specify others separated
+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:
+
+    $ 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.
+
+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
 by semicolons. For example:
  
-    $ redminerb users list --fields=id:mail
+    $ redminerb users -f id:mail
 
-Will return only the ID following by the user e-mail.
+Will return only the ID following by the user's email.
 
-You can see all the available fields with `redminerb users me`.
+You can see **all the fields available** with `redminerb users me`.
 
 #### Show our info in the Redmine server
 
@@ -88,10 +103,43 @@ the API key used to access the Rest API (hopefully your data :).
 
 #### Create new user
 
-    $ redminerb users create --login "wadus" --password "ultrasecret" \
-                             --firstname="Wadux" --lastname="Wallace" \
+To create a new user we should use the *create* subcommand:
+
+    $ redminerb users create --login wadus --password="ultrasecret" \
+                             --firstname="Wadux" --lastname Wallace \
                              --mail "wadus@waduxwallace.out"
 
+The options have the following aliases (extracted from `redminerb users help create`):
+
+    l, --login=LOGIN           
+    p, --password=PASSWORD     
+    fn, --firstname=FIRSTNAME  
+    ln, --lastname=LASTNAME    
+    m, --mail=MAIL
+
+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
+
+#### List issues
+
+    $ redminerb issues list
+
+#### Show an issue
+
+Shows the info of an issue with a number or id.
+
+    $ redminerb issues [show] <number>
+
+For example, to see the info of the issue #12532 we'd launch:
+
+    $ redminerb issues show 12539
+
+*show* is the default subcommand, so the following order has the same output as the following:
+
+    $ redminerb issues 12539
+
 ## 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/issues.rb

@@ -0,0 +1,30 @@
+# Copyright (c) The Cocktail Experience S.L. (2015)
+require 'erb'
+require_relative '../issues'
+
+module Redminerb
+  module Cli
+    # Thor's 'issues' subcommand definition
+    class Issues < Thor
+      default_command :show
+  
+      desc 'list', 'Shows open issues in our Redmine'
+      option :offset, aliases: :o
+      option :limit, aliases: :l
+      def list
+        Redminerb.init!
+        Redminerb::Issues.list(options).each do |issue|
+          puts "[#{issue.id}] ".blue + issue.subject.green
+        end
+      end
+
+      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)
+      end
+    end
+  end
+end

data/lib/redminerb/cli/users.rb

@@ -1,35 +1,42 @@
 # Copyright (c) The Cocktail Experience S.L. (2015)
-module Redminerb
-  # 'users' Thor subcommand definition
-  class Users < Thor
-    default_command :list
+require_relative '../users'
 
-    desc 'list', 'Shows the current users in our Redmine'
-    option :fields, banner: 'id:login:email'
-    def list
-      Redminerb.init!
-      fields = options[:fields] || 'id:login:mail'
-      Redminerb.client.users.each do |user|
-        puts fields.split(':').map {|f| user.send(f)}.join("\t").green
+module Redminerb
+  module Cli
+    # 'users' Thor subcommand definition
+    class Users < Thor
+      default_command :list
+  
+      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
+      option :limit, aliases: :l
+      def list
+        Redminerb.init!
+        fields = options.delete(:fields) || 'id:login:mail'
+        Redminerb::Users.list(options).each do |user|
+          puts fields.split(':').map {|f| user.send(f)}.join("\t").green
+        end
       end
-    end
-
-    desc 'create', 'Creates a user.'
-    option :login, required: true
-    option :password, required: true
-    option :firstname, required: true
-    option :lastname, required: true
-    option :mail, required: true
-    def create
-      Redminerb.init!
-      puts Redminerb.client.create_user(options).green
-    end
-
-    desc 'me', 'Shows the info of the owner of the API key'
-    def me
-      Redminerb.init!
-      Redminerb.client.me.each do |field, value|
-        puts "#{field}: ".blue + value.to_s.green
+  
+      desc 'create', 'Creates a user.'
+      option :login,     aliases: :l,  required: true
+      option :password,  aliases: :p,  required: true
+      option :firstname, aliases: :fn, required: true
+      option :lastname,  aliases: :ln, required: true
+      option :mail,      aliases: :m,  required: true
+      def create
+        Redminerb.init!
+        puts Redminerb::Users.create(options).green
+      end
+  
+      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
     end
   end

data/lib/redminerb/cli.rb

@@ -3,6 +3,7 @@ require 'thor'
 require 'colorize'
 require_relative '../redminerb'
 require_relative 'cli/users'
+require_relative 'cli/issues'
 
 module Redminerb
   # Thor's command class
@@ -19,6 +20,8 @@ module Redminerb
 
     # The subcommad's classes are defined in lib/redminerb/cli
     desc 'users [list]', "Manage Redmine's users"
-    subcommand 'users', Users
+    subcommand 'users', Cli::Users
+    desc 'issues [list]', "Manage Redmine's issues"
+    subcommand 'issues', Cli::Issues
   end
 end

data/lib/redminerb/client.rb

@@ -1,7 +1,6 @@
 # Copyright (c) The Cocktail Experience S.L. (2015)
 require 'faraday'
 require 'json'
-require 'ostruct'
 
 module Redminerb
   # HTTP client to communicate w/ the Redmine server.
@@ -17,59 +16,15 @@ module Redminerb
       @connection.basic_auth(cfg.api_key, cfg.api_key)
     end
 
-    # Get the users of our Redmine as OpenStruct objects.
-    #
-    # Example:
-    #   Redminerb.init!
-    #   Redminerb.client.users.each do |user|
-    #      puts user.firstname
-    #   end
-    #
-    # See lib/reminerb/cli/user.rb code to see other example/s.
-
-    def users
-      get_json('/users.json')['users'].map do |user|
-        OpenStruct.new user
-      end
-    end
-
-    # Creates a brand new user with the given params. In lib/reminerb/cli/user.rb
-    # you can see which ones are required (or running 'redminerb users create'
-    # from the command line).
-    #
-    # Example (missing required params):
-    #   Redminerb.init!
-    #   Redminerb.client.create_user login: 'wadus'
-
-    def create_user(params)
-      response = post_json('/users.json', user: params)
-
-      if response.success?
-        'Created'
-      else
-        raise_error! response
-      end
-    end
-
-    # Returns a hash with the info of the user's account behind the API key that
-    # is used by the script to access the Redmine's REST API.
-    #
-    # Example (missing required params):
-    #   Redminerb.init!
-    #   me = Redminerb.client.me
-    #   puts me['login'] + ': ' + me['mail']
-
-    def me
-      get_json('/users/current.json')['user']
-    end
-
-    private
-
     # Makes a GET request of the given 'path' param and returns the body of the
     # response parsed as JSON.
-    def get_json(path)
+    def get_json(path, params = {})
       Redminerb.init_required!
-      res = @connection.get(path)
+      res = @connection.get do |req|
+        req.url path
+        req.headers['Content-Type'] = 'application/json'
+        req.body = params.to_json if params.any?
+      end
       JSON.parse(res.body)
     rescue JSON::ParserError => e
       raise e, "HTTP status code #{res.status}"
@@ -77,6 +32,7 @@ module Redminerb
 
     # Makes a POST request to 'path' with 'params' in JSON format. 
     def post_json(path, params)
+      Redminerb.init_required!
       @connection.post do |req|
         req.url path
         req.headers['Content-Type'] = 'application/json'
@@ -85,7 +41,7 @@ module Redminerb
     end
 
     # It raises an exception giving the validation messages for 422 responses
-    def raise_error!(res)
+    def self.raise_error!(res)
       if res.status == 422
         begin
           errors = JSON.parse(res.body)['errors']

data/lib/redminerb/issues.rb

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

data/lib/redminerb/template.rb

@@ -0,0 +1,25 @@
+# Copyright (c) The Cocktail Experience S.L. (2015)
+require 'ostruct'
+
+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.
+      #
+      # Example:
+      #   Redminerb::Template.read(:issue) # Returns the content of templates/issue.erb
+      #
+
+      def read(name)
+        File.read(filepath(name))
+      end
+
+      private
+
+      def filepath(name)
+        File.join(File.dirname(__FILE__)[0..-15], 'templates', "#{name}.erb")
+      end
+    end
+  end
+end

data/lib/redminerb/users.rb

@@ -0,0 +1,55 @@
+# Copyright (c) The Cocktail Experience S.L. (2015)
+require 'ostruct'
+
+module Redminerb
+  # Users resource wrapper
+  class Users
+    class << self
+      # Get the users of our Redmine as OpenStruct objects.
+      #
+      # Example:
+      #   Redminerb.init!
+      #   Redminerb::Users.list.each do |user|
+      #      puts user.firstname
+      #   end
+      #
+      # See lib/reminerb/cli/user.rb code to see other example/s.
+  
+      def list(params)
+        Redminerb.client.get_json('/users.json', params)['users'].map do |user|
+          OpenStruct.new user
+        end
+      end
+  
+      # Creates a brand new user with the given params. In lib/reminerb/cli/user.rb
+      # you can see which ones are required (or running 'redminerb users create'
+      # from the command line).
+      #
+      # Example (that will miss required params :_(:
+      #   Redminerb.init!
+      #   Redminerb::Users.create login: 'wadus'
+  
+      def create(params)
+        response = Redminerb.client.post_json('/users.json', user: params)
+  
+        if response.success?
+          'Created'
+        else
+          Redminerb::Client.raise_error! response
+        end
+      end
+  
+      # Returns a hash with the info of the user's account behind the API key that
+      # is used by the script to access the Redmine's REST API.
+      #
+      # Example:
+      #   Redminerb.init!
+      #   me = Redminerb::Users.me
+      #   puts me['login'] + ': ' + me['mail']
+  
+      def me
+        Redminerb.client.get_json('/users/current.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.2.3'
+  VERSION = '0.3.0'
 end

data/lib/redminerb.rb

@@ -1,8 +1,10 @@
 # Copyright (c) The Cocktail Experience S.L. (2015)
+require 'terminfo'
 require_relative 'redminerb/version'
 require_relative 'redminerb/config'
 require_relative 'redminerb/client'
 require_relative 'redminerb/cli'
+require_relative 'redminerb/template'
 
 # Main module 
 module Redminerb
@@ -46,4 +48,8 @@ module Redminerb
   def client
     @client
   end
+
+  def separator
+    @separator ||= ('-' * TermInfo.screen_columns).green
+  end
 end

data/redminerb.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor'
   spec.add_dependency 'colorize'
   spec.add_dependency 'faraday'
+  spec.add_dependency 'ruby-terminfo'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'

data/templates/issue.erb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redminerb
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Fernando Garcia Samblas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -160,11 +174,16 @@ files:
 - exe/redminerb
 - lib/redminerb.rb
 - lib/redminerb/cli.rb
+- lib/redminerb/cli/issues.rb
 - lib/redminerb/cli/users.rb
 - lib/redminerb/client.rb
 - lib/redminerb/config.rb
+- lib/redminerb/issues.rb
+- lib/redminerb/template.rb
+- lib/redminerb/users.rb
 - lib/redminerb/version.rb
 - redminerb.gemspec
+- templates/issue.erb
 homepage: http://github.com/nando/redminerb
 licenses: []
 metadata: {}