assembla_cli 0.0.1 → 0.0.2

data/.assemblarc.sample

@@ -0,0 +1,10 @@
+{
+  "username"  : "",
+  "password"  : "",
+  "space"     : "",
+  "report_id" : ""
+  "zebra_colors" : {
+    "color1" : "black_background",
+    "color2" : "blue_background"
+  }
+}

data/README.md

@@ -1,38 +1,83 @@
-## use cases
+                                    |     |              |_)
+      _` |  __|  __|  _ \ __ `__ \  __ \  |  _` |    __| | |
+     (   |\__ \\__ \  __/ |   |   | |   | | (   |   (    | |
+    \__,_|____/____/\___|_|  _|  _|_.__/ _|\__,_|  \___|_|_|                                                        
 
-    > assembla
+## Installation
 
-    > tickets //returns a table with my tickets
+    gem install assembla_cli
 
-    #number priority status title
-    123     high     new    just another bug
-    321     low      test   an easy fix
+## Alternative Installation
 
-    > select(123) //sets ticket 123 as the current ticket
-    > open(123) //opens the ticket 123 in the browser for analysis
+    git clone git@github.com:azendal/assembla_cli.git
+    cd assembla_cli
+    bundle
+    gem build assembla_cli.gemspec
+    gem i assembla_cli-0.0.1.gem
 
-    > status //lists the possible statusses for the ticket
-    #  label
-    0  invalid
-    1  new
-    2  test
-    3  fixed
+## Configuration
 
-    > status 2 //sets the current ticket to test
-    > ticket //shows the current ticket summary
-    > comment "some comment or reason i already fixed this before ...."
+    echo -e "<username>\n<password>" >> ~/.assembla_cli
 
-    > exit //well it exits :P
+## Project configuration
+    
+    cd /path/to/project
+    touch .assemblarc
 
-## Install
+    #sample configuration
+    {
+      "space"     : "space",
+      "report_id" : "12341",
+      "zebra_colors" : {
+        "color1" : "black_background",
+        "color2" : "blue_background"
+      }
+    }
 
-    bundle
-    gem build assembla_cli.gemspec
-    gem i assembla_cli-0.0.1.gem
+## Use
 
-# Use
+    assembla
+    assembla> change_space 'Space'
+    
+    assembla(Space)> change_report
+    +--------+-------------------------------+
+    | id     | name                          |
+    +--------+-------------------------------+
+    | 12     | By Person - Open              |
+    | 32     | My Open tickets               |
+    +--------+-------------------------------+
+    select report number> 32
+
+    assembla(Space)> my_tickets
+    +--------+-------------+------------+-------------------+----------------------------------------+
+    | NUMBER | PRIORITY    | MILESTONE  | STATUS            | SUMMARY                                |
+    +--------+-------------+------------+-------------------+----------------------------------------+
+    | 5      | Highest (1) | Release    | Working           | Add some feature                       |
+    | 1      | Normal (3)  | Release    | New               | Improve some other feature             |
+    | 2      | Normal (3)  | Release    | New               | Remove unused method x                 |
+    | 7      | High (2)    | Refactor   | New               | Abstract method x into a factory       |
+    +--------+-------------+------------+-------------------+----------------------------------------+
+    
+    assembla(Space)> ticket 5
+    assembla(Space)> comment "will be fixed soon"
+    assembla(Space)> status 'test'
+
+    assembla(Space)> ticket 1
+
+## Full configured use
 
     $ assembla
-    $ assempla Space?> space-name
-    $ assembla> milestones
-    $ assembla> exit
+    assembla(Space)> my_tickets
+    +--------+-------------+------------+-------------------+----------------------------------------+
+    | NUMBER | PRIORITY    | MILESTONE  | STATUS            | SUMMARY                                |
+    +--------+-------------+------------+-------------------+----------------------------------------+
+    | 5      | Highest (1) | Release    | Working           | Add some feature                       |
+    | 1      | Normal (3)  | Release    | New               | Improve some other feature             |
+    | 2      | Normal (3)  | Release    | New               | Remove unused method x                 |
+    | 7      | High (2)    | Refactor   | New               | Abstract method x into a factory       |
+    +--------+-------------+------------+-------------------+----------------------------------------+
+
+## Getting help
+
+    assembla> commands
+    assembla> h

data/assembla_cli.gemspec

@@ -5,8 +5,8 @@ require "assembla_cli/version"
 Gem::Specification.new do |s|
   s.name        = "assembla_cli"
   s.version     = AssemblaCli::VERSION
-  s.authors     = ["azendal", "ktlacaelel", "edgarjs"]
-  s.email       = ["azendal@gmail.com", "ktlacaelel@gmail.com", "edgar.js@gmail.com"]
+  s.authors     = ["azendal", "ktlacaelel", "edgarjs", "luisgodinez", "chubas"]
+  s.email       = ["trasvina@gmail.com", "ktlacaelel@gmail.com", "edgar.js@gmail.com", "luisgodinez@gmail.com", "chubas7@gmail.com"]
   s.homepage    = "https://github.com/azendal/assembla_cli/"
   s.summary     = %q{A CLI to use Assembla for easy usage}
   s.description = %q{A CLI to use Assembla for easy usage}
@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "hashie"
   s.add_runtime_dependency "httparty"
   s.add_runtime_dependency "isna"
+  s.add_runtime_dependency "highline"
 end

data/bin/assembla

@@ -1,16 +1,37 @@
 #!/usr/bin/env ruby
 
-# $:.unshift File.expand_path('../..', __FILE__)
+$:.unshift File.expand_path("../../lib", __FILE__)
 require 'assembla_cli'
 
+extend Hirb::Console
+
 # TODO: Prompt for credentials and create this file if not exists
 # TODO: Move authentication to another class or module
-username, password = File.read("#{ENV['HOME']}/.assembla_cli").split
-Assembla.login(username, password)
-# Assembla.space('space name')
-# Assembla.my_report('personal report id')
+__assembla_rc = "#{ENV['HOME']}/.assembla_cli"
 
-extend Hirb::Console
+unless File.exists?(__assembla_rc)
+  puts "No configuration file found. Please input credentials."
+  File.open(__assembla_rc, 'w') do |file|
+    file.puts Assembla.setup_credentials
+  end
+end
+
+username, password = File.read(__assembla_rc).split
+
+@cfg = {
+  'username' => username,
+  'password' => password,
+  "zebra_colors" => {
+    "color1" => "black_background",
+    "color2" => "blue_background"
+  }
+}
+
+@cfg = @cfg.merge MultiJson.decode(File.read(Dir.pwd + '/.assemblarc')) if File.exists?(Dir.pwd + '/.assemblarc')
+
+Assembla.login(@cfg['username'], @cfg['password']) if @cfg['username'] && @cfg['password']
+Assembla.space(@cfg['space']) if @cfg['space']
+Assembla.my_report_id(@cfg['report_id']) if @cfg['report_id']
 
 # Statuses dont change a log, so keep them cached to make ticket
 # listing faster.
@@ -19,7 +40,7 @@ def status_translations
 end
 
 def milestone_translation
-  @milestone_translation ||= Assembla.milestones['milestones']
+  @milestone_translation ||= Assembla.milestones['milestones'] || []
 end
 
 def clean_cache
@@ -27,9 +48,9 @@ def clean_cache
   @status_translations
 end
 
-def priority_string number                                                                                                         
-  ['', 'Highest (1)', 'High (2)', 'Normal (3)', 'Low (4)', 'Lowest (5)'][number]                                                   
-end 
+def priority_string number
+  ['', 'Highest (1)', 'High (2)', 'Normal (3)', 'Low (4)', 'Lowest (5)'][number]
+end
 
 # Translates a status-id into its status-name equivalent.
 def status_string number
@@ -51,45 +72,231 @@ def milestone_string number
   'Unknown'
 end
 
-def tickets
-  # Prepare table data.
-  headers = ['number', 'priority', 'milestone_id', 'status_name', 'summary']
-  hash    = Assembla.my_tickets['tickets']
+def ticket_change_comment_string comment
+  c = YAML::load(comment).flatten
+  if c.count == 3
+    "#{c[0]} changed from: #{c[1]} to: #{c[2]}"
+  else
+    "Change: #{c.to_s}"
+  end
+end
+
+def reports
+  all_reports = Assembla.custom_reports['custom_reports']
+  table all_reports['user_reports'] + all_reports['team_reports'], :fields => ['id', 'name']
+end
 
-  # Replace status numbers for status strings
-  # TODO: we might need to send data so overriding is not cool.
-  # So maybe we should manage translations differently.
-  hash.each { |row| row['priority'] = priority_string(row['priority']) }
-  hash.each { |row| row['milestone_id'] = milestone_string(row['milestone_id']) }
+def change_report
+  reports
+  print "select report number> "
+  id = gets.chomp
+  Assembla.my_report_id id
+end
 
+def my_report
+  if Assembla.my_report_id.nil?
+    change_report
+  end
+  hash = Assembla.custom_report(Assembla.my_report_id)['tickets']
+  print_tickets hash
+end
+
+def my_tickets
+  print_tickets Assembla.my_tickets['tickets']
+end
+
+def tickets
+  hash = Assembla.tickets['tickets']
+  print_tickets hash
+end
+
+def print_table hash, fields = [], headers = {}
   # Print data
-  table = Hirb::Helpers::AutoTable.render(hash, :fields => headers)
-  c = :green
+  table = Hirb::Helpers::AutoTable.render(hash, :fields => fields, :headers => headers, :description => false)
+  c = @cfg['zebra_colors']['color1']
+  i = 0;
+  
   table.each_line do |line|
-    c = c == :green ? :yellow : :green
-    puts line.chomp.to_ansi.send(c)
+    if i > 2
+      c = c == @cfg['zebra_colors']['color1'] ? @cfg['zebra_colors']['color2'] : @cfg['zebra_colors']['color1']
+    end
+    puts line.chomp.to_ansi.white.send(c)
+    i = i + 1
   end
-  # TODO: Think on how this can be handled better.
-  # clean_cache
+
   nil
 end
 
+def print_tickets hash
+  # Prepare table data.
+  headers = {
+    'number'           => 'NUMBER',
+    'priority_name'    => 'PRIORITY',
+    'milestone_name'   => 'MILESTONE',
+    'status_name'      => 'STATUS',
+    'assigned_to_name' => 'ASSIGNED TO',
+    'summary'          => 'SUMMARY'
+  }
+
+  fields = ['number', 'priority_name', 'milestone_name', 'status_name', 'assigned_to_name', 'summary']
+  
+  hash.each { |row| row['priority_name'] = priority_string(row['priority']) }
+  hash.each { |row| row['milestone_name'] = milestone_string(row['milestone_id']) }
+  hash.each { |row| row['assigned_to_name'] = row['assigned_to'] ? row['assigned_to']['name'] : '' }
+
+  print_table hash, fields, headers
+end
+
+def print_ticket
+  ticket = Assembla.ticket['ticket']	  	
+  hash = []
+  hash[0] = {:col1 => 'id', :col2 => ticket['number'], :col3 => ''}
+  hash[1] = {:col1 => 'summary', :col2 => ticket['summary'], :col3 => ''}
+  hash[2] = {:col1 => 'description', :col2 => ticket['description'], :col3 => ''}
+  hash[3] = {:col1 => 'milestone', :col2 => milestone_string(ticket['milestone_id']), :col3 => ''}
+  hash[4] = {:col1 => 'assigned to', :col2 => ticket['assigned_to']['name'], :col3 => ''}
+  hash[5] = {:col1 => 'reported by', :col2 => ticket['reporter']['name'], :col3 => ''}
+  hash[6] = {:col1 => 'status', :col2 => ticket['status_name'], :col3 => ''}
+
+  table = Hirb::Helpers::AutoTable.render(hash, :headers => false) 	
+  c = @cfg['zebra_colors']['color1']
+  i = 0;
+
+  table.each_line do |line|  	  	
+    c = (i == 1) ? @cfg['zebra_colors']['color2'] : @cfg['zebra_colors']['color1']
+    puts line.chomp.to_ansi.white.send(c)
+    i = i + 1
+  end
+  puts '-' * Hirb::View.width
+  puts "Ticket changes:"
+  puts '-' * Hirb::View.width
+  ticket['ticket_comments'].map do |comment|
+    if comment['comment'].nil? && !comment['ticket_changes'].nil?
+      puts "Ticket change:"
+      puts ticket_change_comment_string(comment['ticket_changes'])
+      puts "Date:#{comment['updated_at']}:"
+      puts '-' * Hirb::View.width
+    else !comment['comment'].nil?
+      puts "#{comment['user']['name']} comment:"
+      puts comment['comment']
+      puts "Date:#{comment['updated_at']}:"
+      puts '-' * Hirb::View.width
+    end
+  end
+end
+
 def milestones
   table Assembla.milestones['milestones'], :fields => ['id', 'title']
 end
 
-def open (ticket_id)
-  `open https://www.assembla.com/spaces/breezi/tickets/#{ticket_id}`
+def http (ticket_id)
+  `open https://www.assembla.com/spaces/#{Assembla.space['space']['name']}/tickets/#{ticket_id}`
   nil
 end
 
-# TODO: Fix this
-print "assembla Space?> "
-cmd = gets.chomp
-Assembla.space(cmd)
-while cmd != 'exit' do
-  print "assembla> "
-  cmd = gets.chomp
-  send(cmd)
+def ticket (id = nil)
+  if id
+    Assembla.ticket id
+    print_ticket
+  elsif Assembla.ticket
+    print_ticket
+  else
+    puts 'Please select a ticket to display'
+  end
+end
+
+def comment (comment, id = nil)
+  if id.nil? && Assembla.ticket.nil?
+    puts 'Please select a ticket to comment'
+  elsif id
+    Assembla.ticket id
+    Assembla.add_comment(comment)
+    ticket(id)
+  else
+    Assembla.add_comment(comment)
+    ticket(Assembla.ticket['ticket']['number'])
+  end 
+end
+
+def update_status (status, id = nil)
+  if id.nil? && Assembla.ticket.nil?
+    puts 'Please select a ticket to comment'
+  elsif id
+    Assembla.ticket id
+    Assembla.change_status(status)
+    ticket(id)
+  else
+    Assembla.change_status(status)
+    ticket(Assembla.ticket['ticket']['number'])
+  end 
+end
+
+def fixed (id = nil)
+  update_status('Fixed', id)
+end
+
+def test (id = nil)
+  update_status('Test', id)
+end
+
+def invalid (id = nil)
+  update_status('Invalid', id)
+end
+
+def statuses
+  table Assembla.statuses['ticket_statuses'], :fields => ['name']
+end
+
+def change_space(space_name = nil)
+  unless space_name
+    spaces
+    print "enter space name> "
+    space_name = gets.chomp
+  end
+  Assembla.reset!
+  Assembla.space space_name
+  prompt = "assembla(#{space_name})> "
+  conf.prompt_i = conf.prompt_n = conf.prompt_s = conf.prompt_c = prompt
+end
+
+def spaces
+  hash = Assembla.spaces['spaces']
+  fields = ['name', 'wiki_name']
+  headers = { 'name' => 'NAME', 'wiki_name' => 'SLUG' }
+  print_table hash, fields, headers
 end
 
+def commands
+  # TODO: Complete help
+  puts <<-eos
+
+    Assembla CLI, version #{AssemblaCli::VERSION}
+
+    change_space              # Changes current space
+    change_report             # Changes current default report
+    tickets                   # Lists tickets for current space
+    my_tickets                # Lists active tickets assigned to 'me'
+    my_report                 # Lists custom report's tickets
+    statuses                  # Lists available statuses
+    comment('message')        # Add a comment to current ticket
+    comment('message',id)     # Add a comment to the specified ticket id
+    update_status('New')      # Change the status to current ticket
+    update_status('New', id)  # Update the status to the specified ticket
+    fixed                     # Close current ticket as fixed
+    fixed(id)                 # Close specified ticket as fixed
+    invalid                   # Close current ticket as invalid
+    invalid(id)               # Close specified ticket as invalid
+    test                      # Set current ticket status to test
+    test(id)                  # Set specified ticket status to test
+    commands, h               # Show this message
+
+  eos
+end
+
+def h
+  commands
+end
+
+ENV['IRBRC'] = File.expand_path('../../lib/assembla_cli/irbrc', __FILE__)
+IRB.start
+

data/lib/assembla_cli.rb

@@ -1,17 +1,30 @@
 require 'rubygems'
+require 'irb'
 require 'hirb'
 require 'hashie'
 require 'httparty'
 require 'isna'
+require 'yaml'
+require 'highline/import'
 require "assembla_cli/version"
 
 module Assembla
   include HTTParty
   format :xml
-  base_uri 'assembla.com'
+  base_uri 'www.assembla.com'
+
+  def self.reset!
+    @current_space = @milestones = @my_report_id = @statuses, @users = nil
+  end
 
   def self.xml_headers
-   {:headers => {'Accept' => 'application/xml'}}
+   {:headers => {'Accept' => 'application/xml', 'Content-Type' => 'application/xml'}}
+  end
+
+  def self.setup_credentials
+    login_name = ask('Username:')
+    password   = ask('Password:') { |prompt| prompt.echo = false }
+    [ login_name, password ]
   end
 
   def self.login (login_name, password)
@@ -22,42 +35,67 @@ module Assembla
   end
 
   def self.spaces
-    self.get('/spaces/my_spaces', xml_headers)
+    get('/spaces/my_spaces', xml_headers)
   end
 
-  def self.space (space_name)
-    @current_space = self.get("/spaces/#{space_name}", xml_headers)['space']
+  def self.space (space_name = nil)
+    if space_name
+        @current_space = get("/spaces/#{space_name.gsub(/ /, '-').downcase}", xml_headers)
+    end
+    @current_space
   end
 
-  def self.my_report (report_id)
-    @my_report_id = report_id
+  def self.my_report_id (report_id = nil)
+    if report_id
+        @my_report_id = report_id
+    end
+    @my_report_id
   end
 
   def self.statuses
-    self.get("/spaces/#{@current_space['id']}/tickets/custom_statuses", xml_headers)
+    @statuses ||= get("/spaces/#{space['space']['id']}/tickets/custom_statuses", xml_headers)
   end
 
   def self.users
-    self.get("/spaces/#{@current_space['id']}/users", xml_headers)
+    @users ||= get("/spaces/#{space['space']['id']}/users", xml_headers)
   end
 
   def self.milestones
-    @statusses ||= get("/spaces/#{@current_space['id']}/milestones/", xml_headers)
+    @milestones ||= get("/spaces/#{space['space']['id']}/milestones/", xml_headers)
+  end
+  
+  def self.ticket (ticket_id = nil)
+    if ticket_id
+      @current_ticket = get("/spaces/#{space['space']['id']}/tickets/#{ticket_id}", xml_headers)
+    end
+    @current_ticket
   end
 
   def self.tickets
-    self.get("/spaces/#{@current_space['id']}/tickets/report/9", xml_headers)
+    get("/spaces/#{space['space']['id']}/tickets/report/3", xml_headers)
   end
 
   def self.my_tickets
-    get("/spaces/#{@current_space['id']}/tickets/custom_report/#{@my_report_id}", xml_headers)
+    get("/spaces/#{space['space']['id']}/tickets/report/8", xml_headers)
   end
 
   def self.custom_reports
-    get("/spaces/#{@current_space['id']}/custom_reports", xml_headers)
+    get("/spaces/#{space['space']['id']}/custom_reports", xml_headers)
   end
 
   def self.custom_report (report_id)
-    get("/spaces/#{@current_space['id']}/tickets/custom_report/#{report_id}", xml_headers)
+    get("/spaces/#{space['space']['id']}/tickets/custom_report/#{report_id}", xml_headers)
+  end
+  
+  def self.add_comment (comment)
+    update_ticket("<ticket><user-comment>#{comment}</user-comment></ticket>")
+  end
+
+  def self.change_status (status_name)
+    update_ticket("<ticket><status>#{status_name}</status></ticket>")
+  end
+
+  def self.update_ticket (body)
+    put("/spaces/#{space['space']['id']}/tickets/#{ticket['ticket']['number']}", xml_headers.merge!(:body => "#{body}"))
   end
 end

data/lib/assembla_cli/irbrc

@@ -0,0 +1,16 @@
+require 'irb/completion'
+
+prompt = "assembla> "
+
+IRB.conf[:PROMPT][:ASSEMBLA] = {
+  :AUTO_INDENT => false,
+  :PROMPT_I    => prompt,
+  :PROMPT_N    => prompt,
+  :PROMPT_S    => prompt,
+  :PROMPT_C    => prompt,
+  :RETURN      => ""
+}
+IRB.conf[:PROMPT_MODE] = :ASSEMBLA
+IRB.conf[:SINGLE_IRB] = true
+IRB.conf[:IRB_NAME] = "assembla cli"
+

data/lib/assembla_cli/version.rb

@@ -1,3 +1,3 @@
 module AssemblaCli
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,23 +1,25 @@
 --- !ruby/object:Gem::Specification 
 name: assembla_cli
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - azendal
 - ktlacaelel
 - edgarjs
+- luisgodinez
+- chubas
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-01-06 00:00:00 Z
+date: 2012-01-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruby-debug
@@ -89,11 +91,27 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
 description: A CLI to use Assembla for easy usage
 email: 
-- azendal@gmail.com
+- trasvina@gmail.com
 - ktlacaelel@gmail.com
 - edgar.js@gmail.com
+- luisgodinez@gmail.com
+- chubas7@gmail.com
 executables: 
 - assembla
 extensions: []
@@ -101,7 +119,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .assemblarc
+- .assemblarc.sample
 - .gitignore
 - Gemfile
 - README.md
@@ -109,6 +127,7 @@ files:
 - assembla_cli.gemspec
 - bin/assembla
 - lib/assembla_cli.rb
+- lib/assembla_cli/irbrc
 - lib/assembla_cli/version.rb
 homepage: https://github.com/azendal/assembla_cli/
 licenses: []