redminerb 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15c9f30f16fc1632e7870c461e94abfaf4cb9aaf
-  data.tar.gz: b7a41abe3ddeebbf1d4629e527a66616f2e0e1d4
+  metadata.gz: cd0185c2de7d0faff680a3e8a2e3dfeac153b230
+  data.tar.gz: c56b99239805b7a73bb8abb9277bd0a8b8b93843
 SHA512:
-  metadata.gz: 3c9cd6099fbafe3f5c778946480cd2f681ec2efad16866239f4900c81e716531480913f0e8e8a5e6a505f6e0e58c05e4760fac5895c5168ed28dd9905bd1a850
-  data.tar.gz: a32012f49690855eb5634dadd7cf04079a88cda0cae7f4147e255e8acbb5c5d51a80199fcebc46453e506633e93531aded30e94898d3cfb9ec73c9550ade4872
+  metadata.gz: e44711b8c5840d5025a19cd4ea762561dfda63d553583ddba94a1df8d79779c41885c818c108bc7037327923cf727c7c8f2dd9c6a9e3017a0f3efbe44821232b
+  data.tar.gz: a38bb575b580d4cca4e008751e8e725137403bd85506e1b18bc0a1059b90081c927df21da1b00197fe9a72b3b8521eec30e024586c30fe122a500703944bea91

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 2.2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.rdoc

@@ -1,9 +1,13 @@
 = CHANGELOG
+== 0.8.4, released 2016-10-20
+
+* Option +fixed_version_id+ added to the _issues_ command.
+
 == 0.8, released 2015-10-09
 
 * Users' create now asks for each param unless we use the --no-ask option
-* +redminerb project [show] <id>+ to see a project's info
-* +redminerb projects list [--name <FILTER>]+ to see our projects
+* <tt>redminerb project [show] <id></tt> to see a project's info
+* <tt>redminerb projects list [--name <FILTER>]</tt> to see our projects
 * +--project_id+, +assigned_to+ and +--closed+ options to filter *issues*
 * Minor fixes
 

data/CONTRIBUTORS.md

@@ -0,0 +1,7 @@
+redminerb contributors
+======================
+
+* **[Jesús Sayar](https://github.com/jesus-sayar)**
+
+  * Fix parse not succeed responses
+  * Add *fixed_version_id* option in **issues** command

data/README.md

@@ -18,40 +18,50 @@ Work in progress with RDD[1]: README > Spec > Implementation
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'redminerb'
-```
-
-And then execute:
+    $ gem install redminerb
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+    redminerb [COMMAND] [SUBCOMMAND|<id>]
 
-    $ gem install redminerb
+Behind the scenes `redminerb` uses the gem Thor, so calling it without params is the same as asking for help:
 
-## Usage
+    $ redminerb
+    Commands:
+      redminerb config                # Shows this session current configuration
+      redminerb help [COMMAND]        # Describe available commands or one specific command
+      redminerb issues [list|<id>]    # Manage Redmine's issues
+      redminerb projects [list|<id>]  # Manage Redmine's projects
+      redminerb users [list|<id>]     # Manage Redmine's users
 
 In order to use `redminerb` the URL and the API key of your Redmine REST API must be available in one of the following places:
 
-1. **In your environment**: using *REDMINERB_URL* and *REDMINERB_API_KEY* env. vars.
-2. **In `~/.redminerb.yml`**: as values of *url* and *api_key*.
+1. **In your environment**: using *REDMINERB_URL* and *REDMINERB_API_KEY* environment variables.
+2. **In `~/.redminerb.yml`**: as values of *url* and *api_key* keys.
 
 For example, this `~/.redminerb.yml`:
 
-    url: http://localhost:3000/
+    url: https://redmine.ruby-lang.org/
     api_key: 69b47d74e36a6757bac5d45f8398dd23bfa8f52c
 
 Would be the same as having the following in your environment (declared in `~/.bashrc`, for example):
 
-    export REDMINERB_URL=http://localhost:3000/
+    export REDMINERB_URL=https://redmine.ruby-lang.org/
     export REDMINERB_API_KEY=69b47d74e36a6757bac5d45f8398dd23bfa8f52c
 
-If both present **environment variables have priority**.
+If both present **environment variables have priority** (remember that you can remove them from the environment running `unset NAME-OF-VARIABLE`).
 
-As a general rule, the `list` subcomand is the one assumed when omitted, but if a number is given instead of a subcomand, then the `show` subcommand will be call using that number as param. For example `redminerb users 1` will show us the info of the first user of our Redmine. Notice that also the singular can be used for the command, which is nice for these cases (i.e. `redminerb user 1`, thanks Thor!)
+As **a general rule**, the `list` subcommand is the one assumed when omitted, but if a number is given then the `show` subcommand will be call using that number as param. For example, `redminerb issues` will show us the **list** of the last issues availables for our user, and `redminerb issue 11962` will **show** us the info of the the issue with id number 11962 (notice that also the singular, *issue* here, can be used as the command, which sounds more natural for this feature -thanks Thor!)
+
+You can find your API key on your account page in Redmine ( /my/account ) when logged in, on the right-hand pane of the default layout.
+
+### Configuration (config)
+
+To see the current configuration used by Redminerb run the `config` command:
+
+    $ redminerb config
+    URL:     https://redmine.ruby-lang.org/
+    API-KEY: 69b47d74e36a6757bac5d45f8398dd23bfa8f52c
 
 ### Pagination
 
@@ -70,28 +80,26 @@ Because `list` is the default subcommand for the `users` command.
 
 ### Custom ERB templates
 
-The output of **a single resource** obtained with **the `show` subcommand can be customized creating the corresponding `.erb` file** in the *.redminerb/templates* directory. In the template we can access to the resource using its generic name, e.g. `user` or `issue`.
+The output of **a single resource** obtained with **the `show` subcommand can be customized creating the corresponding `.erb` file** in the `.redminerb/templates` directory. The `.redminerb` directory will be searched **first in the current directory and then in your home directory**.
 
-The default templates could be found in the *templates* directory.
+Into the template we access the resource using its generic name (`user`, `issue`, `project`...). The default templates used by *redminerb* and other examples could be found in the *templates* directory of this repository.
 
-For example, to customize the output of an issue, we write the following content in the `.redminerb/issue.erb` file:
+For example, to customize the output of an issue, we write the following content in the `.redminerb/templates/issue.erb` file:
 
     Number: <%= issue.id %>
     Title: <%= issue.subject %>
 
-The *.redminerb* directory will be search **in the current directory first**, and then in **your home directory**.
-
-We can also create other templates and use them through **the `--template` option**. For example:
+We can also create a template to be used only when asked through **the `--template` option**. For example:
 
-    $ redminerb users show 34 --template user_in_a_box
+    $ redminerb user show 34 --template user_in_a_box
 
-Will use the file `.redminerb/user_in_a_box.erb` as template, whose content could be the following:
+Will use the file `.redminerb/templates/user_in_a_box.erb` as template, whose content could be the following:
 
     <%= Redminerb.top %>
     <%= Redminerb.line user.login %>
     <%= Redminerb.bottom %>
 
-That would give us an output similar to this:
+...which will give us an output similar to this:
 
     ┌────────────────────────────────────┐
     │ roger.williams                     │
@@ -105,21 +113,11 @@ As you can see Redminerb give us also **some functions to draw** its output usin
 * **Redminerb.line** *string*: content into the box (i.e. `│ Example │`).
 * **Redminerb.separator**: a line from left to right (like *middle* wo/ box borders).
 
-Have fun with them!
-
-### Configuration (config)
-
-To see the current configuration used by Redminerb we have the `config` command:
-
-    $ redminerb config
-    URL:     http://localhost:3000/
-    API-KEY: 69b47d74e36a6757bac5d45f8398dd23bfa8f52c
-
 ### Users
 
 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.**
+**IMPORTANT: This is an admin command so be sure that your API key's user have that permission in the Redmine server. Otherwise a 403 exception will be thrown.**
 
 #### List current users
 
@@ -184,7 +182,7 @@ The **issues** command is the wrapper for part of the [Issues resource](http://w
 
 #### List issues
 
-    $ redminerb issues [list] [--closed|-c] [--project_id|-p <id>] [--assigned_to_id|-a <id>]
+    $ redminerb issues [list] [--closed|-c] [--project_id|-p <id>] [--assigned_to_id|-a <id>] [--fixed_version_id|-v <id>]
 
 Examples:
 

data/Rakefile

@@ -12,4 +12,4 @@ Rake::TestTask.new(:spec) do |t|
   t.verbose = true
 end
 
-task default: [:spec, :rubocop]
+task default: [:spec]

data/TODO.md

@@ -0,0 +1 @@
+* Format output w/ [terminal-table](https://github.com/tj/terminal-table) (recommended by @jsayar)

data/lib/redminerb/cli/issues.rb

@@ -10,11 +10,12 @@ module Redminerb
       # rubocop:disable Metrics/AbcSize
       # (disabled to let the "closed" option be managed here)
       desc 'list', 'Shows open issues in our Redmine'
-      option :offset,         aliases: :o
-      option :limit,          aliases: :l
-      option :closed,         aliases: :c, type: :boolean
-      option :assigned_to_id, aliases: :a
-      option :project_id,     aliases: :p
+      option :offset,           aliases: :o
+      option :limit,            aliases: :l
+      option :closed,           aliases: :c, type: :boolean
+      option :assigned_to_id,   aliases: :a
+      option :project_id,       aliases: :p
+      option :fixed_version_id, aliases: :v
       def list(issue_id = nil)
         if issue_id
           show(issue_id)

data/lib/redminerb/client.rb

@@ -39,10 +39,10 @@ module Redminerb
     def get_json(path, params = {})
       Redminerb.init_required!
       res = _get(path, params)
-      if res.status == 404
-        fail Redminerb::NotFoundError, path
-      else
+      if res.success?
         JSON.parse(res.body)
+      else
+        fail StandardError, "ERROR (status code #{res.status})"
       end
     rescue JSON::ParserError => e
       raise e, "HTTP status code #{res.status}"

data/lib/redminerb/version.rb

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

data/redminerb.gemspec

@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'climate_control' # fake ENV
   spec.add_development_dependency 'minitest-vcr'
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'webmock', '= 1.24.6'
 
   spec.add_development_dependency 'rubocop'
 

data/templates/issue_boxie.erb

@@ -4,11 +4,11 @@
     Redminerb.line("[#{issue.tracker.name}][#{issue.project.name}:##{issue.id}] #{issue.subject}"),
     Redminerb.middle,
     [
-      "Author: #{issue.author.name}",
-      "Assigned to: #{issue.assigned_to.name}",
-      "Status: #{issue.status.name}",
-      "Priority: #{issue.priority.name}"
-    ].map{|l| Redminerb.line l },
+      issue.author ? "Author: #{issue.author.name}" : nil,
+      issue.assigned_to ? "Assigned to: #{issue.assigned_to.name}" : nil,
+      issue.status ? "Status: #{issue.status.name}" : nil,
+      issue.priority ? "Priority: #{issue.priority.name}" : nil
+    ].compact.map{|l| Redminerb.line l },
     Redminerb.middle,
     issue.description.lines.map {|raw_line| Redminerb.line raw_line.chomp },
     Redminerb.middle,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redminerb
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Fernando Garcia Samblas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -154,16 +154,16 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.24.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.24.6
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -192,8 +192,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-      Redminerb is a command-line tool to speak with a Redmine server using its REST API.
+description: "    Redminerb is a command-line tool to speak with a Redmine server
+  using its REST API.\n"
 email:
 - fernando.garcia@the-cocktail.com
 executables:
@@ -206,11 +206,13 @@ files:
 - ".travis.yml"
 - CHANGELOG.rdoc
 - CODE_OF_CONDUCT.md
+- CONTRIBUTORS.md
 - Gemfile
 - LICENCE.txt
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
 - exe/redminerb
@@ -251,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Redminerb is a command-line Redmine client.