redmine_cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97c8fe7610bf14e98e31cd06ecd5bd1fef70ba09
-  data.tar.gz: 20e0a9f511c6225149c8e45bf9937699202b8161
+  metadata.gz: 2f33a25599255db90496beb40a22b6b2bf43fd5f
+  data.tar.gz: 20990a7478cd142ffd4b44dc8415b1cf827e466a
 SHA512:
-  metadata.gz: 235aa01145508dd3568adc818d23a9b9e344179a3596c85939864d98d8cc35af3218421a4ae176355fdef17188f77317fd545b82d0fdbb1ac4dcd519bae983ed
-  data.tar.gz: 0eab2ada375a2bbcc2324fc03498d89a66a3ade1c3e828fe5eeec92f4e5c5525848fbeddd396f5f3174aa66571388a490d9e435c3f5a55560e9ad3d5bf5c777f
+  metadata.gz: e25ba315ea686838a6bf2efdae21b825c85a71f169119d178231e12b8b3ca312c47ad0f9b75c8757edffb3290ba8c13a461d4e7f1db384e97e3a8f48721ab005
+  data.tar.gz: 1218d34fce41ae549cba4560f0ad5abf8923d484a25ffdc77f515faed325a246a35650169229b91f4312c29ef4061b5924321ca940af85a506339e5afe908e10

data/README.md

@@ -1,4 +1,5 @@
 # RedmineCLI
+[![Gem Version](https://badge.fury.io/rb/redmine_cli.svg)](https://badge.fury.io/rb/redmine_cli)
 
 Command-Line Interface for Redmine.
 
@@ -6,27 +7,22 @@ Why? Because web-browser + mouse sucks
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'redmine_cli'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install redmine_cli
 
 ## Usage
 
+    redmine help
+    redmine conf init
+    redmine issue list [user id]
+    redmine issue show <issue id>
+    redmine user find vasya
+    redmine user find 123
+    redmine user find pupkin@yet.another.mail.com
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redmine_cli.
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/Nondv/redmine_cli.
 
 ## License
 

data/lib/assets/default_config.yml

@@ -1,5 +1,4 @@
 ---
-
 user: nil
 password: nil
 site: nil

data/lib/assets/messages/en.yml

@@ -1,7 +1,25 @@
 en:
-  test: '1234'
   desc:
     client:
-      :issue: 'Command for working with issues. See "redmine issue help"'
+      issue: 'Works with issues. See "redmine issue help"'
+      conf: 'Works with config file. See "redmine conf help"'
+      user: 'Works with users. See "redmine user help"'
     issue:
-      list: 'Lists issues of user. By default it is you'
+      list: 'Lists issues of user. By default it is you'
+      show: 'More info about issue'
+    conf:
+      init: 'Asks you few question to make your config file useful'
+    user:
+      find: 'Finds users by id|email|name. Without arguments it will show your info'
+
+  commands:
+    conf:
+      init:
+        enter_user: 'Enter your login to Redmine: '
+        enter_password: 'Enter your password: '
+        enter_site: 'Enter URL to your Redmine: '
+
+  thank_you: 'Thank you!'
+  error_try_again: 'Error! Try again.'
+  error_input_required: 'Input cant be empty.'
+  not_found: 'Not found'

data/lib/assets/templates/issue/list.erb

@@ -1,9 +1,9 @@
 % max_id_len = issues.max_by { |i| i.id.size }.id.size
 % subject_limit = 60
 %
-% issues.group_by { |i| i.project.name }.each do |project, project_issues|
+% issues.group_by_project.each do |project, project_issues|
 
-<%= "[ #{project} ]".center(max_id_len + 3 + subject_limit + 3 + 8).red + "\n" %>
+<%= "[ #{project.name} ]".center(max_id_len + 3 + subject_limit + 3 + 8).red + "\n" %>
 <%= '(id)'.center(max_id_len).yellow %> | <%= '(subject)'.center(subject_limit).yellow %> | <%= "(status)\n".yellow %>
 <% project_issues.each do |i| %>
 <%= i.id.ljust(max_id_len) %>   <%= i.subject.cut(subject_limit).ljust(subject_limit) %>   <%= i.status.name %><%= "\n" %>

data/lib/assets/templates/issue/show.erb

@@ -0,0 +1,24 @@
+
+ID:           <%= issue.id %>
+Subject:      <%= issue.subject %>
+Status:       <%= issue.status.name %>
+Priority:     <%= issue.priority.name %>
+Readiness:    <%= issue.done_ratio + '%' %>
+% if issue.project?
+Project:      <%= issue.project.name %>
+% end
+% if issue.version?
+Version:      <%= issue.version.name %>
+% end
+Assigned to:  <%= issue.assigned_to.name %> (<%= issue.assigned_to.id %>)
+Author:       <%= issue.author.name %> (<%= issue.author.id %>)
+% if issue.description? && !issue.description.empty?
+
+*****
+
+<%= issue.description %>
+
+
+*****
+% end
+

data/lib/assets/templates/user/find.erb

@@ -0,0 +1,12 @@
+% max_id_len = users.map { |u| u.id.size }.max
+% max_name_len = users.map { |u| u.firstname.size + u.lastname.size + 1 }.max
+% max_email_len = users.map { |u| u.mail? ? u.mail.size : 0 }.max
+%
+% if users.size > 1
+<%= 'id'.ljust(max_id_len).yellow %> | <%= 'name'.center(max_name_len).yellow %> | <%= 'e-mail'.center(max_email_len).yellow + "\n" %>
+% end
+%
+% users.each do |u|
+%   name = u.firstname + ' ' + u.lastname
+<%= u.id.ljust(max_id_len) %>   <%= name.ljust(max_name_len) %>   <%= "#{u.mail? && u.mail}\n" %>
+% end

data/lib/redmine_cli.rb

@@ -26,7 +26,21 @@ module RedmineCLI
   class Client < Thor
     extend Helpers::Output
 
+    map %w(--version -v) => :__print_version
+
+    desc '--version, -v', 'print the version'
+    # two underscores hides method from help
+    def __print_version
+      puts "redmine_cli version #{VERSION}"
+    end
+
     desc 'issue ...', m('desc.client.issue')
     subcommand 'issue', Subcommands::Issue
+
+    desc 'conf ...', m('desc.client.conf')
+    subcommand 'conf', Subcommands::Conf
+
+    desc 'user ...', m('desc.client.user')
+    subcommand 'user', Subcommands::User
   end
 end

data/lib/redmine_cli/helpers/input.rb

@@ -0,0 +1,84 @@
+require 'uri'
+
+require_relative 'output'
+
+module RedmineCLI
+  module Helpers
+    #
+    # Helpers for input
+    #
+    module Input
+      include Helpers::Output
+
+      #
+      # #ask with :limited_to set to url regexp
+      #
+      def ask_url(text, params = {})
+        params[:limited_to] = /\A#{URI.regexp(%w('http', 'https'))}\z/
+        ask(text, params)
+      end
+
+      #
+      # Asks user for something.
+      #
+      # Params:
+      # * `:default`
+      # * `:limited_to` - can be `Array<String>` or `Regexp`
+      # * `:required` - force user input until it's not empty
+      #
+      def ask(text, params = {})
+        default_set = params.key?(:default)
+        if params[:required]
+          fail('required + default options') if default_set
+          fail('required + array with limits') if params[:limited_to].is_a? Array
+        end
+
+        print_prompt_message(text, params)
+        input = read(params)
+
+        return params[:default] if default_set && input.empty?
+        input
+      end
+
+      private
+
+      def read(params)
+        return read_with_limitations(params) if params[:limited_to]
+        return read_until_not_empty if params[:required]
+
+        gets.chomp
+      end
+
+      def read_until_not_empty
+        loop do
+          input = gets.chomp
+          return input unless input.empty?
+
+          puts m(:error_input_required)
+        end
+      end
+
+      def read_with_limitations(params)
+        input = nil
+
+        loop do
+          input = gets.chomp
+          break if fit_in_limit?(input, params[:limited_to])
+          return params[:default] if input.empty? && params.key?(:default)
+
+          puts m(:error_try_again)
+        end
+
+        input
+      end
+
+      def fit_in_limit?(input, limit)
+        fail('limit should be Array or Regexp') unless limit.is_a?(Array) || limit.is_a?(Regexp)
+
+        return limit.include?(input) if limit.is_a? Array
+
+        limit =~ input
+      end
+    end
+  end
+end

data/lib/redmine_cli/helpers/output.rb

@@ -4,6 +4,15 @@ module RedmineCLI
     # Helpers for output
     #
     module Output
+      #
+      # for Helpers::Input
+      #
+      def print_prompt_message(text, params = {})
+        print text
+        print "[#{params[:default]}] " if params.key? :default
+        print "(#{params[:limited_to].join(', ')}) " if params[:limited_to].is_a? Array
+      end
+
       #
       # Alias for TemplateRenderer#render
       #

data/lib/redmine_cli/subcommands/conf.rb

@@ -0,0 +1,27 @@
+require 'thor'
+
+module RedmineCLI
+  module Subcommands
+    #
+    # All methods for working with config file
+    #
+    class Conf < Thor
+      extend Helpers::Output
+
+      include Helpers::Output
+      include Helpers::Input
+
+      desc 'init', m('desc.conf.init')
+      def init
+        Config['user'] = ask m('commands.conf.init.enter_user'), default: Config['user']
+        Config['password'] = ask m('commands.conf.init.enter_password'), default: Config['password']
+        Config['site'] = ask_url m('commands.conf.init.enter_site'), default: Config['site']
+        Config['just_created'] = false
+
+        Config.save
+
+        puts m(:thank_you)
+      end
+    end
+  end
+end

data/lib/redmine_cli/subcommands/issue.rb

@@ -18,6 +18,13 @@ module RedmineCLI
 
         puts erb('issue/list', issues: Models::User.find(id).issues)
       end
+
+      desc 'show <id>', m('desc.issue.show')
+      def show(id)
+        puts erb('issue/show', issue: Models::Issue.find(id))
+      rescue ActiveResource::ResourceNotFound
+        puts m(:not_found)
+      end
     end
   end
 end

data/lib/redmine_cli/subcommands/user.rb

@@ -0,0 +1,33 @@
+require 'thor'
+require 'redmine_rest'
+module RedmineCLI
+  module Subcommands
+    #
+    # All methods for working with users
+    #
+    class User < Thor
+      extend Helpers::Output
+
+      include RedmineRest
+      include Helpers::Output
+      include Helpers::Input
+
+      desc 'find [id|name|email]', m('desc.user.find')
+      def find(*args)
+        input = args.join ' '
+
+        puts erb('user/find', users: users_from_input(input))
+      end
+
+      private
+
+      def users_from_input(input)
+        if input.empty? || !input.to_i.zero? # TODO: numeric?
+          [Models::User.find(input.empty? ? 'current' : input.to_i)]
+        else
+          Models::User.all_by_name_or_mail(input).sort { |a, b| a.id.to_i <=> b.id.to_i }
+        end
+      end
+    end
+  end
+end

data/lib/redmine_cli/version.rb

@@ -1,3 +1,3 @@
 module RedmineCLI
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/redmine_cli.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'thor', '~> 0.19'
   spec.add_dependency 'i18n', '~> 0.7'
-  spec.add_dependency 'redmine_rest', '0.1.1'
+  spec.add_dependency 'redmine_rest', '0.2.0'
   spec.add_dependency 'non_config', '0.1.2'
   spec.add_dependency 'colorize', '~> 0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dmitriy Non
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: non_config
   requirement: !ruby/object:Gem::Requirement
@@ -158,11 +158,16 @@ files:
 - lib/assets/default_config.yml
 - lib/assets/messages/en.yml
 - lib/assets/templates/issue/list.erb
+- lib/assets/templates/issue/show.erb
+- lib/assets/templates/user/find.erb
 - lib/redmine_cli.rb
 - lib/redmine_cli/config.rb
+- lib/redmine_cli/helpers/input.rb
 - lib/redmine_cli/helpers/monkey_patching.rb
 - lib/redmine_cli/helpers/output.rb
+- lib/redmine_cli/subcommands/conf.rb
 - lib/redmine_cli/subcommands/issue.rb
+- lib/redmine_cli/subcommands/user.rb
 - lib/redmine_cli/template_renderer.rb
 - lib/redmine_cli/version.rb
 - redmine_cli.gemspec