climine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbb788a211786309edbfabcf74f633c26ee5937e
+  data.tar.gz: 24ba1f7ad37596f04a9bc319cb121479800ce518
+SHA512:
+  metadata.gz: 67ddb20630d7f425baf71d9f1903b461030d26819993b3bc5deca4edc82e9683c98a5fb985b95da61a1a1b3787f39b605ac8dec27a05b09bfa6df121eefb84b5
+  data.tar.gz: 85f611a2cd35591fceaf6b9f74010f30f449108cb1af1a3c49b502cc9772de8cec2ab264e9afb51a1d38dffe00fb9a29541c287d684fe6539f0345edf5aefa0b

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in climine.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    climine (0.0.1)
+      hashie (~> 2.0.5)
+      hirb (~> 0.7)
+      hirb-unicode (~> 0.0.5)
+      thor (~> 0.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    hashie (2.0.5)
+    hirb (0.7.1)
+    hirb-unicode (0.0.5)
+      hirb (~> 0.5)
+      unicode-display_width (~> 0.1.1)
+    rake (10.1.0)
+    redcarpet (3.0.0)
+    thor (0.18.1)
+    unicode-display_width (0.1.1)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  climine!
+  rake (~> 10.1.0)
+  redcarpet (~> 3.0)
+  yard (~> 0.8)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 yagince
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,148 @@
+# Climine (クリミネ)
+
+CLI for Redmine
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'climine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install climine
+
+## Usage
+
+### Initialize
+
+create `config.yml`
+
+```
+$ climine init -k xxxx -u http://xxxx.xxx.xx/
+```
+
+```config.yml
+url: http://xxxx.xxx.xx/
+apikey: xxxx
+```
+
+### Help
+
+- show all help
+
+```
+$ climine help
+Commands:
+  climine help [COMMAND]                                       # Describe available commands or one specific command
+  climine init  -k, --key=API-Access-Key -u, --url=RedmineURL  # initialize config.yml
+  climine issue [TICKET_NO]                                    # get Redmine Issues. see) http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Listing-issues
+  climine project [PROJECT_ID]                                 # get Redmine Projects.
+  climine user [ID]                                            # get Redmine Users
+```
+
+- show command help
+
+```
+$ climine help [COMMAND]
+```
+
+### Issues
+
+#### get issues
+
+```
+Usage:
+  climine issue get [TICKET_NO]
+
+Options:
+  -s, [--sort=SORT_KEYS]                # default asc. ex) 'id,category:desc,updated_on'
+  -l, [--limit=LIMIT]                   # limit of search result (default: 25)
+  -o, [--offset=OFFSET]                 # page of seach result(0 origin) (default: 0)
+  -p, [--project-id=PROJECT_ID]         # id of RedmineProject ( Please search by `climine project` ) (default: all project)
+  -u, [--assigned-to-id=USER_ID]        # ID of the user being assigned ( Please search by `climine user` )
+  -c, [--created-on=CREATED_DATE]       # ex) >=2013-10-01, >2013-10-01, <2013-10-01, 2013-10-01
+  -r, [--updated-on=LAST_UPDATED_DATE]  # ex) >=2013-10-01, >2013-10-01, <2013-10-01, 2013-10-01
+  -w, [--before-week=WEEKS]             # search tickets that has been updated in the last X weeks
+  -t, [--template=TEMPLATE_PATH]        # rendering by given template
+
+get Redmine Issues. see) http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Listing-issues
+```
+
+You can be rendered using the your own ERB template file.
+
+```
+$ climine issue get -t [template_path]
+```
+
+#### create issue
+
+```
+Usage:
+  climine new
+
+Options:
+  -p, [--project=PROJECT_ID]  # project_id (search by `project` command)
+  -t, [--tracker=TRACKER_ID]  # tracker_id (search by `tracker` command)
+  -s, [--status=STATUS_ID]    # status_id (search by `status` command)
+  -u, [--user=USER_ID]        # user_id (search by `user` command)
+      [--subject=SUBJECT]     # ticket title
+      [--desc=DESCRIPTION]    # ticket description
+
+create Issue
+```
+
+### Users
+
+```
+Usage:
+  climine user [ID]
+
+Options:
+  -n, [--name=NAME]  # filter users on their login, firstname, lastname and mail
+```
+
+### Projects
+
+```
+Usage:
+  climine project [PROJECT_ID]
+```
+
+### Ticket Statauses
+
+```
+Usage:
+  climine status
+```
+
+### Ticket Trackers
+
+```
+Usage:
+  climine tracker
+```
+
+### Project Members
+
+```
+Usage:
+  climine get -p, --project-id=PROJECT_ID
+
+Options:
+  -p, --project-id=PROJECT_ID  # see) http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET
+
+get Project Members
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "yard"
+
+YARD::Rake::YardocTask.new

data/bin/climine

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'climine'
+Climine::CLI.start(ARGV)

data/climine.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'climine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "climine"
+  spec.version       = Climine::VERSION
+  spec.authors       = ["yagince"]
+  spec.email         = ["straitwalk@gmail.com"]
+  spec.description   = %q{CLI for Redmine}
+  spec.summary       = %q{CLI for Redmine}
+  spec.homepage      = "https://github.com/yagince/climine"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.glob("**/*").select{|path| !(path =~ /^doc|^pkg/) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.18"
+  spec.add_dependency "hashie", "~> 2.0.5"
+  spec.add_dependency "hirb", "~> 0.7"
+  spec.add_dependency "hirb-unicode", "~> 0.0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1.0"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "redcarpet", "~> 3.0"
+end

data/config.yml

@@ -0,0 +1,2 @@
+url: http://www21124ue.sakura.ne.jp/redmine
+apikey: 7cf7f32a9b0a0e1667157a5f3de05813be13ed54

data/lib/climine/cli.rb

@@ -0,0 +1,27 @@
+require "pp"
+require "time"
+require "thor"
+require "hirb"
+require "hirb-unicode"
+
+require "climine/redmine"
+require "climine/config"
+require "climine/template"
+require "climine/command/base"
+require "climine/command/config"
+require "climine/command/issue"
+require "climine/command/user"
+require "climine/command/project"
+require "climine/command/tracker"
+require "climine/command/status"
+require "climine/command/member"
+
+class Climine::CLI < Thor
+  register Climine::Command::Config, :init, "init", "intialize config"
+  register Climine::Command::Issue, :issue, "issue [COMMAND]", "subcommands for issue"
+  register Climine::Command::User, :user, "user [COMMAND]", "subcommands for user"
+  register Climine::Command::Project, :project, "project [COMMAND]", "subcommands for project"
+  register Climine::Command::Tracker, :tracker, "tracker [COMMAND]", "subcommands for tracker"
+  register Climine::Command::Status, :status, "status [COMMAND]", "subcommands for status"
+  register Climine::Command::Member, :member, "member [COMMAND]", "subcommands for member"
+end

data/lib/climine/command/base.rb

@@ -0,0 +1,29 @@
+module Climine::Command
+  class Base < Thor
+
+    no_commands {
+      def redmine
+        @redmine ||= Climine::Redmine.new(Climine::Config.new)
+      end
+      def render template_name, response
+        unless response.error
+          template = Climine::Template.new(template_name)
+          if template.exist?
+            res = response
+            puts template.build.result(binding)
+          else
+            pp response
+          end
+        else
+          say "-- Error or NotFound", :red
+        end
+      end
+      def render_table data
+        puts Hirb::Helpers::AutoTable.render(data)
+      end
+      def sort_by_id ary
+        ary.sort{|a,b| a.id - b.id}
+      end
+    }
+  end
+end

data/lib/climine/command/config.rb

@@ -0,0 +1,34 @@
+require 'erb'
+
+module Climine::Command
+  class Config < Base
+    CONFIG = "config.yml"
+    TEMPLATE = <<-ERB
+url: <%= options[:url] %>
+apikey: <%= options[:key] %>
+    ERB
+
+    default_command :init
+
+    desc "init ", "initialize config.yml"
+    option :url, required: true, type: :string, aliases: '-u', banner: "RedmineURL", desc: "Your Redmine's URL"
+    option :key, required: true, type: :string, aliases: '-k', banner: "API-Access-Key", desc: "Your API Access Key"
+    def init
+      open(CONFIG, 'w'){|file| file.write(ERB.new(TEMPLATE).result(binding)) }
+      puts "create [ #{File.expand_path(CONFIG)} ]"
+    end
+    # def self.included base
+    #   base.class_eval do
+
+    #     desc "init ", "initialize config.yml"
+    #     option :url, required: true, type: :string, aliases: '-u', banner: "RedmineURL", desc: "Your Redmine's URL"
+    #     option :key, required: true, type: :string, aliases: '-k', banner: "API-Access-Key", desc: "Your API Access Key"
+    #     def init
+    #       open(CONFIG, 'w'){|file| file.write(ERB.new(TEMPLATE).result(binding)) }
+    #       puts "create [ #{File.expand_path(CONFIG)} ]"
+    #     end
+
+    #   end
+    # end
+  end
+end

data/lib/climine/command/issue.rb

@@ -0,0 +1,101 @@
+require "date"
+
+module Climine::Command
+  class Issue < Base
+
+    desc "get [TICKET_NO]", "get Redmine Issues. see) http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Listing-issues"
+    option :sort, type: :string, aliases: '-s', banner: "SORT_KEYS", desc: "default asc. ex) 'id,category:desc,updated_on'"
+    option :limit, type: :numeric, aliases: '-l', banner: "LIMIT", desc: "limit of search result (default: 25)", deafult: 25
+    option :offset, type: :numeric, aliases: '-o', banner: "OFFSET", desc: "page of seach result(0 origin) (default: 0)"
+    option :project_id, type: :numeric, aliases: '-p', banner: "PROJECT_ID", desc: "id of RedmineProject ( Please search by `climine project` ) (default: all project)"
+    option :assigned_to_id, type: :numeric, aliases: '-u', banner: "USER_ID", desc: "ID of the user being assigned ( Please search by `climine user` )"
+    option :created_on, type: :string, aliases: '-c', banner: "CREATED_DATE", desc: "ex) >=2013-10-01, >2013-10-01, <2013-10-01, 2013-10-01"
+    option :updated_on, type: :string, aliases: '-r', banner: "LAST_UPDATED_DATE", desc: "ex) >=2013-10-01, >2013-10-01, <2013-10-01, 2013-10-01"
+    option :before_week, type: :numeric, aliases: '-w', banner: "WEEKS", desc: "search tickets that has been updated in the last X weeks"
+    option :template, type: :string, aliases: '-t', banner: "TEMPLATE_PATH", desc: "rendering by given template"
+    def get(id=nil)
+      if id
+        render (options["template"] || :issue), redmine.issue(id)
+      else
+        render (options["template"] || :issues), redmine.issues(before_weeek_to_update_date(options.to_hash))
+      end
+    end
+
+    desc "new", "create Issue"
+    option :project, type: :numeric, aliases: '-p', banner: "PROJECT_ID", desc: "project_id (search by `project` command)"
+    option :tracker, type: :numeric, aliases: '-t', banner: "TRACKER_ID", desc: "tracker_id (search by `tracker` command)"
+    option :status, type: :numeric, aliases: '-s', banner: "STATUS_ID", desc: "status_id (search by `status` command)"
+    option :user, type: :numeric, aliases: '-u', banner: "USER_ID", desc: "user_id (search by `user` command)"
+    option :subject, type: :string, banner: "SUBJECT", desc: "ticket title"
+    option :desc, type: :string, banner: "DESCRIPTION", desc: "ticket description"
+    def new
+      # project
+      unless project_id = options["project"]
+        projects = sort_by_id redmine.projects.projects
+        projects.each{|project| puts "#{project.id} : #{project.name}" }
+        project_id = ask("Which project?", limited_to: projects.map{|project| project.id.to_s})
+      end
+   
+      # tracker
+      unless tracker_id = options["tracker"]
+        trackers = sort_by_id redmine.trackers.trackers
+        trackers.each{|tracker| puts "#{tracker.id} : #{tracker.name}" }
+        tracker_id = ask("Which tracker?", limited_to: trackers.map{|tracker| tracker.id.to_s})
+      end
+   
+      # status
+      unless status_id = options["status"]
+        statuses = sort_by_id redmine.statuses.issue_statuses
+        statuses.each{|status| puts "#{status.id} : #{status.name}" }
+        status_id = ask("Which status? (empty is default)")
+      end
+   
+      # assigned user
+      unless user_id = options["user"]
+        members = sort_by_id redmine.members(project_id).memberships
+        members.each{|member| puts "#{member.user.id} : #{member.user.name}"}
+        user_id = ask("Who do you assigned?")
+      end
+   
+      # subject
+      subject = ask_not_empty("subject > ")
+      # description
+      description = ask_not_empty("description > ")
+   
+      res = redmine.create_issue(
+        project_id: project_id,
+        tracker_id: tracker_id,
+        status_id: status_id,
+        assigned_to_id: user_id,
+        subject: subject,
+        description: description
+      )
+   
+      unless res.error
+        render :issue, res
+      else
+        say "Error! (Issue was not created)", :red
+      end
+    end
+
+    no_commands {
+      def before_weeek_to_update_date option
+        if weeks = option["before_week"]
+          option["updated_on"] = ">=#{(Date.today - (weeks * 7)).strftime('%Y-%m-%d')}"
+          option.delete "before_week"
+        end
+        option
+      end
+
+      def ask_not_empty statement
+        answer = nil
+        until answer
+          answer = ask(statement)
+          answer = answer.empty? ? nil : answer
+          say "! #{statement} is must not be empty", :magenta unless answer
+        end
+        answer
+      end
+    }
+  end
+end

data/lib/climine/command/member.rb

@@ -0,0 +1,11 @@
+module Climine::Command
+  class Member < Base
+    default_command :get
+
+    desc "get", "get Project Members"
+    option :project_id, type: :numeric, aliases: '-p', banner: "PROJECT_ID", required: true, desc: "see) http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET"
+    def get
+      render :members, redmine.members(options["project_id"])
+    end
+  end
+end

data/lib/climine/command/project.rb

@@ -0,0 +1,14 @@
+module Climine::Command
+  class Project < Base
+    default_command :project
+
+    desc "project [PROJECT_ID]", "get Redmine Projects."
+    def project(id=nil)
+      if id
+        render :project, redmine.project(id)
+      else
+        render :projects, redmine.projects(options.to_hash)
+      end
+    end
+  end
+end

data/lib/climine/command/status.rb

@@ -0,0 +1,24 @@
+require "hashie"
+
+module Climine::Command
+  class Status < Base
+    default_command :status
+
+    desc "status", "get Redmine IssueStatuses."
+    option :table, type: :boolean, aliases: '-t', desc: "default asc. ex) 'id,category:desc,updated_on'", default: false
+    def status
+      unless options[:table]
+        render :statuses, redmine.statuses
+      else
+        render_table redmine.statuses.issue_statuses.map{|status|
+          Hashie::Mash.new(
+            id: status.id,
+            name: status.name,
+            is_default: status.is_default,
+            is_closed: status.is_closed
+          )
+        }.sort{|a,b| a.id - b.id}
+      end
+    end
+  end
+end

data/lib/climine/command/tracker.rb

@@ -0,0 +1,10 @@
+module Climine::Command
+  class Tracker < Base
+    default_command :tracker
+
+    desc "tracker", "get Redmine Trackers."
+    def tracker
+      render :trackers, redmine.trackers
+    end
+  end
+end

data/lib/climine/command/user.rb

@@ -0,0 +1,15 @@
+module Climine::Command
+  class User < Base
+    default_command :user
+
+    desc "user [ID]", "get Redmine Users"
+    option :name, type: :string, aliases: '-n', banner: "NAME", desc: "filter users on their login, firstname, lastname and mail"
+    def user(id=nil)
+      if id
+        render :user, redmine.user(id)
+      else
+        render :users, redmine.users(options.to_hash)
+      end
+    end
+  end
+end

data/lib/climine/config.rb

@@ -0,0 +1,8 @@
+require "hashie"
+require "yaml"
+
+class Climine::Config < Hashie::Mash
+  def initialize
+    super YAML.load_file('config.yml')
+  end
+end

data/lib/climine/redmine.rb

@@ -0,0 +1,79 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require "hashie"
+
+class Climine::Redmine
+  attr_reader :config
+
+  def initialize config
+    @config = config
+  end
+
+  def issue id, query={}
+    get(build_url("/issues/#{id}.json", query))
+  end
+  def issues query={}
+    get(build_url("/issues.json", query))
+  end
+  def create_issue issue
+    post(build_url("/issues.json"), {issue: issue})
+  end
+  def user id, query={}
+    get(build_url("/users/#{id}.json", query))
+  end
+  def users query={}
+    get(build_url("/users.json", query))
+  end
+  def project id, query={}
+    get(build_url("/projects/#{id}.json", query))
+  end
+  def projects query={}
+    get(build_url("/projects.json", query))
+  end
+  def trackers
+    get(build_url("/trackers.json"))
+  end
+  def statuses
+    get(build_url("/issue_statuses.json"))
+  end
+  def members id
+    get(build_url("/projects/#{id}/memberships.json"))
+  end
+
+  private
+  def get url
+    res = Net::HTTP.get_response(URI.parse(url))
+    json = case res.code.to_i
+           when 200
+             JSON.parse(res.body)
+           else
+             { error: true }
+           end
+    Hashie::Mash.new json
+  end
+  def post url, content
+    uri = URI(url)
+
+    req = Net::HTTP::Post.new uri, initheader = {'Content-Type' =>'application/json'}
+    req.body = content.to_json
+
+    res = Net::HTTP.start(uri.host, uri.port, use_ssl: (uri.scheme == "https")) do |http|
+      http.request req
+    end
+
+    json = case res.code.to_i
+           when 201
+             JSON.parse(res.body)
+           else
+             { error: true }
+           end
+    Hashie::Mash.new json
+  end
+
+  def build_url path, query={}
+    query[:key] = config.apikey
+    params = query.map{|(key, value)| "#{key}=#{URI.encode(value.to_s)}"}.join("&")
+    "#{config.url}#{path}?#{params}"
+  end
+end

data/lib/climine/template/issue.erb

@@ -0,0 +1,11 @@
+<% issue = res.issue %>
+<<<%= issue.tracker.name %>>> [<%= issue.status.name %>] #<%= issue.id %> <%= issue.subject %>
+----------------------------------------------------------------------------------------
+[PROJECT ] <%= issue.project.name %>
+[created ] <%= Time.parse(issue.created_on).localtime.strftime("%Y-%m-%d %H:%M:%S") %>
+[Author  ] <%= issue.author.name %>
+[Assigned] <%= issue.assigned_to ? issue.assigned_to.name : "Unassigned" %>
+
+<%= issue.description %>
+----------------------------------------------------------------------------------------
+

data/lib/climine/template/issues.erb

@@ -0,0 +1,7 @@
+<% res.issues.each{|issue| -%>
+( <%= Time.parse(issue.updated_on).strftime("%Y-%m-%d %H:%M:%S") %> ) #<%= issue.id %> [<%= issue.project.name %>][<%= issue.status.name %>] <%= issue.subject %>  
+<% } -%>
+
+TOTAL : <%= res.total_count %>
+OFFSET: <%= res.offset %>
+LIMIT : <%= res.limit %>

data/lib/climine/template/members.erb

@@ -0,0 +1,7 @@
+TOTAL : <%= res.total_count %>
+OFFSET: <%= res.offset %>
+LIMIT : <%= res.limit %>
+
+<% res.memberships.select{ |m| m.user }.sort{|a,b| a.user.id.to_i - b.user.id.to_i}.each{|member| -%>
+[ <%= member.project.name %> ] <%= member.user.id %> : <%= member.user.name %>
+<% } -%>

data/lib/climine/template/project.erb

@@ -0,0 +1,7 @@
+<% project = res.project -%>
+================================
+ ProjectID : <%= project.id %>
+ Name      : <%= project.name %>
+================================
+
+<%= project.description %>

data/lib/climine/template/projects.erb

@@ -0,0 +1,7 @@
+TOTAL : <%= res.total_count %>
+OFFSET: <%= res.offset %>
+LIMIT : <%= res.limit %>
+
+<% res.projects.sort{|a,b| a.id.to_i - b.id.to_i}.each{|project| -%>
+<%= project.id %> : <%= project.name %>
+<% } -%>