ki_pivotal 0.0.2 → 0.0.3

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-spec/fixtures
+spec/fixtures
+spec/configs

data/bin/ki_pivotal

@@ -19,16 +19,14 @@ require 'ki_pivotal'
 require 'colored'
 include GLI
 
-program_desc 'A command-line interface for Pivotal Tracker'
+program_desc 'A Kiseru command-line interface for Pivotal Tracker'
 
 version KiPivotal::VERSION
 
-desc 'Setup'
-command :setup do |c|
+desc 'Initialise config files'
+command :init do |c|
   c.action do |global_options,options,args|
-    print "Enter API key> "
-    token = $stdin.gets.chomp
-    Kiseru::Config[:ki_pivotal].write('api_token', token)
+    Kiseru::Config[:ki_pivotal].write('api_token', KiPivotal::Interactive.repeatedly_ask("Please enter your Pivotal Tracker API token.\n  This can be found at the bottom of your 'Profile' page.\n  Token"))
   end
 end
 
@@ -36,33 +34,60 @@ desc 'Get projects'
 command :projects do |c|
   c.action do |global_options,options,args|
     pretty = $stdout.tty?
-    $stdout.puts KiPivotal::Api.projects(:pretty => pretty)
+    $stdout.puts KiPivotal::Api.new.projects(:pretty => pretty)
   end
 end
 
-desc 'Create a bug'
-command :story do |c|
-  c.flag [:project]
+desc 'Create a story'
+command :new_story do |c|
+  c.desc "The project ID"
+  c.flag [:p, :project]
+  c.desc "A file containing the JSON for a story"
   c.flag [:f, :file]
+  c.desc "Interactive mode"
+  c.switch [:i, :interactive]
   c.action do |global_options,options,args|
+    # When we have received JSON via a pipe/file
+    # interactive mode should allow a missing
+    # project ID to be specified.
+    if options[:f] || !$stdin.tty?
+      story_json = options[:f] ? File.read(options[:f]) : $stdin.read
+      unless project_id = options[:project]
+        projects = MultiJson.load(KiPivotal::Api.new.projects)
+        if options[:i]
+          $stdin = STDIN.reopen('/dev/tty')
+          project_id = KiPivotal::Interactive.select_project
+        else
+          $stderr.puts "\n  A story cannot be created without specifying which project to create it under:"
+          $stderr.puts "  *  The ID of a chosen project may be specified with --project=<ID>"
+          $stderr.puts "  *  A project may be chosen interactively by using the switch -i."
+          $stderr.puts "\n  Available projects:"
 
-    unless project_id = options[:project]
-      projects = KiPivotal::Api.projects
+          projects.each { |project| $stderr.puts "    #{project['id']} ".green + " #{project['name']}" }
 
-      $stderr.puts "\n  Project ID must be specified with --project=<ID>"
-      $stderr.puts "\n  Available projects:"
-
-      MultiJson.load(projects).each { |project| $stderr.puts "    #{project['id']}".green + " #{project['name']}" }
-
-      $stderr.puts
-      raise "No project ID given"
+          $stderr.puts
+          raise "No project given"
+        end
+      end
+    # When there is no JSON provided
+    # interactive mode should allow the
+    # entire story to be created.
+    else
+      if options[:i]
+        project_id = KiPivotal::Interactive.select_project
+        story_json = KiPivotal::Interactive.new_story
+      else
+        $stderr.puts "\n  Input must be given to this tool to create a story."
+        $stderr.puts "\n  You must do one of the following:"
+        $stderr.puts "  * Provide an input file with --file=<file> or -f=<file>."
+        $stderr.puts "  * Pipe compatible JSON representing a story to this tool."
+        $stderr.puts "  * Use the interactive switch -i to create a story via the command line."
+        $stderr.puts
+        raise "No input given."
+      end
     end
 
-    if options[:f]
-      story_json = File.read(options[:f])
-    end
-    story_json ||= $stdin.read
-    $stdout.puts KiPivotal::Api.create_story(project_id, story_json)
+    $stdout.puts KiPivotal::Api.new.new_story(project_id, story_json)
   end
 end
 

data/lib/ki_pivotal/api.rb

@@ -1,14 +1,20 @@
 module KiPivotal
 
+  class ApiError < StandardError; end;
+
   class Api
 
+    def initialize(config = Kiseru::Config[:ki_pivotal])
+      @config = config
+    end
+
     # TODO - this is only used internally, unlike the other methods
     # It also doesn't return JSON because it is used internally
-    def self.get_token(username, password)
+    def get_token(username, password)
       PivotalTracker::Client.token(username, password)
     end
 
-    def self.projects(opts = {})
+    def projects(opts = {})
       with_session do
         pretty = opts.fetch(:pretty) { true }
 
@@ -25,7 +31,7 @@ module KiPivotal
       end
     end
 
-    def self.create_story(project_id, json)
+    def new_story(project_id, json)
       from_and_to_json(json, true) do |data|
         with_session do
           data.delete('ki_type')
@@ -53,28 +59,44 @@ module KiPivotal
     # * interact with PivotalTracker gem
     # * convert PivotalTracker gem response (object) into data
     # * convert data back into JSON
-    def self.add_story_to_project(project_id, data)
-      project = PivotalTracker::Project.find(project_id)
+    def add_story_to_project(project_id, data)
+      begin
+        project = PivotalTracker::Project.find(project_id)
+      rescue RestClient::ResourceNotFound => e
+        raise ApiError, "Invalid project ID #{project_id}"
+      end
+
       story = project.stories.create(data)
 
-      created_story = {}
-      story.instance_variables.each do |instance_var|
-        string_name = instance_var.to_s.gsub('@','')
-        created_story[string_name] = story.instance_variable_get(instance_var)
+      if story.errors.empty?
+        created_story = {}
+        story.instance_variables.each do |instance_var|
+          string_name = instance_var.to_s.gsub('@','')
+          created_story[string_name] = story.instance_variable_get(instance_var)
+        end
+        created_story
+      else
+        all_errors = story.errors.errors.last
+        raise ApiError, "JSON for story was invalid: #{all_errors}"
       end
-      created_story
     end
 
-    def self.from_and_to_json(json, pretty=false)
+    def from_and_to_json(json, pretty=false)
       data = MultiJson.load(json)
       new_data = yield data
       MultiJson.dump(new_data, :pretty => pretty)
     end
 
-    def self.with_session
-      session = Session.new(Kiseru::Config[:ki_pivotal])
+    def with_session
+      session = Session.new(@config)
       session.init
-      yield
+      begin
+        yield
+      rescue PivotalTracker::Client::NoToken => e
+        raise ApiError, "Authentication failed. Check your API token."
+      rescue RestClient::Unauthorized => e
+        raise ApiError, "Not authorized. Check your API token."
+      end
     end
 
   end

data/lib/ki_pivotal/interactive.rb

@@ -0,0 +1,70 @@
+module KiPivotal
+
+  class Interactive
+  # "Resistance is futile!", "We will get an answer!"
+    def self.repeatedly_ask(question)
+      response = ""
+      while response == ""
+        response = simple_query(question)
+      end
+      response
+    end
+  # "We have ways of making you talk!"
+    def self.repeatedly_choose_from(things, question)
+      index = nil
+      while index.nil?
+        index = choose_from_many(things, question)
+      end
+      index
+    end
+
+    def self.choose_from_many(things, question)
+      $stderr.puts "\n  "+question
+
+      things.each_with_index { |thing, index| $stderr.puts "  #{index+1} ".green + " #{thing}" }
+
+      index = ( (simple_query( "Enter an index (#{(1..things.size)})" ).to_i) - 1 )
+      index = ( index >= 0 && index < things.size ) ? index : nil
+    end
+
+    def self.simple_query(prompt)
+      if prompt.nil?
+        $stderr.print "\n> "
+      else
+        $stderr.print "\n  #{prompt}: "
+      end
+      $stdin.gets.chomp
+    end
+
+    def self.select_project
+      projects = MultiJson.load(KiPivotal::Api.new.projects)
+
+      if projects.size > 1
+        index = repeatedly_choose_from(projects.map { |p| p['name'] }, "Which project should this story be created under?")
+      else
+        index = 0
+      end
+
+        $stderr.puts "\n  Story will be created under the project, '#{projects[index]['name']}'"
+        projects[index]['id']
+    end
+
+    def self.new_story
+      name = repeatedly_ask("Name of story")
+
+      description = repeatedly_ask("Description of story")
+
+      types = ["bug","feature","release","chore"]
+      type = types[repeatedly_choose_from(types, "What type of story is this?")]
+
+      {
+        name: name,
+        description: description,
+        story_type: type,
+        requested_by: 'Kiseru',
+        ki_type: 'pivotal_story'
+      }.to_json
+    end
+  end
+end
+

data/lib/ki_pivotal/kiseru.rb

@@ -1,18 +1,23 @@
 require 'pathname'
+require 'fileutils'
 
 module Kiseru
 
+  class ConfigError < StandardError; end;
+
   class ConfigDir
 
-    DIR_NAME = '.kiseru'
+    NAME = '.kiseru'
 
     attr_reader :path
 
     def initialize(opts = {})
+      name = opts.fetch(:name) { NAME }
       root = Pathname.new(File.expand_path(opts.fetch(:root) { '~' }))
-      @path = root + DIR_NAME
+      @path = root + name
       unless File.directory?(@path)
         Dir.mkdir(@path)
+        FileUtils.chmod(0700, @path)
       end
     end
 
@@ -24,18 +29,34 @@ module Kiseru
 
   class Config
 
+    attr_reader :path
+
     def self.[](key)
       ConfigDir.new.config(key)
     end
 
     def initialize(root_path, app_name)
-      file_path = (root_path + "#{app_name}.yml").to_s
-      @store = YAML::Store.new(file_path)
+      @path = (root_path + "#{app_name}.yml").to_s
+      unless File.exists?(@path)
+        FileUtils.touch(@path)
+        FileUtils.chmod(0600, @path)
+      end
+      @store = YAML::Store.new(@path)
+      @store.transaction do
+      end
+    end
+
+    def ensure_present(*keys)
+      keys.each do |key|
+        if read(key).nil?
+          raise ConfigError, "'#{key}' is not defined in config"
+        end
+      end
     end
 
-    def write(key, time)
+    def write(key, value)
       @store.transaction do
-        @store[key] = time
+        @store[key] = value
       end
     end
 

data/lib/ki_pivotal/session.rb

@@ -7,6 +7,7 @@ module KiPivotal
     end
 
     def init
+      @config.ensure_present('api_token')
       PivotalTracker::Client.token = @config.read('api_token')
     end
 

data/lib/ki_pivotal/version.rb

@@ -1,3 +1,3 @@
 module KiPivotal
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/ki_pivotal.rb

@@ -9,6 +9,7 @@ autoload :Kiseru, 'ki_pivotal/kiseru'
 module KiPivotal
 
   autoload :Api, 'ki_pivotal/api'
+  autoload :Interactive, 'ki_pivotal/interactive'
   autoload :Session, 'ki_pivotal/session'
 
 end

data/spec/integration/api_spec.rb

@@ -4,8 +4,15 @@ include KiPivotal
 
 describe KiPivotal::Api do
 
+  let(:config) do
+    Kiseru::ConfigDir.new(:root => SPEC_DIR,
+                          :name => SPEC_CONFIG_DIR).config(:ki_pivotal)
+  end
+
+
   it "returns projects", :vcr do
-    json = Api.projects
+    api = Api.new(config)
+    json = api.projects
     projects = MultiJson.load(json)
 
     projects.each do |project|
@@ -15,7 +22,6 @@ describe KiPivotal::Api do
   end
 
   it "creates bugs", :vcr do
-    # uses open-source kiseru tracker project
     name = "Something is broken"
 
     input_json = MultiJson.dump({ 'ki_type' => 'pivotal_story',
@@ -23,7 +29,8 @@ describe KiPivotal::Api do
                                   'requested_by' => 'Kiseru',
                                   'story_type'   => 'bug'
                                 })
-    json = Api.create_story(617613, input_json)
+    api = Api.new(config)
+    json = api.new_story(617613, input_json)
     story = MultiJson.load(json)
 
     story['id'].should_not be_nil

data/spec/spec_helper.rb

@@ -12,6 +12,9 @@ require 'vcr'
 
 include Construct::Helpers
 
+SPEC_DIR = File.expand_path(File.dirname(__FILE__))
+SPEC_CONFIG_DIR = 'configs'
+
 if [0, 'false', false, 'f', 'n', 'no', 'off'].include?(ENV['VCR'])
   puts "VCR off"
 else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ki_pivotal
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-08-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
-  requirement: &70225014267120 !ruby/object:Gem::Requirement
+  requirement: &70107004966400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70225014267120
+  version_requirements: *70107004966400
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70225014266700 !ruby/object:Gem::Requirement
+  requirement: &70107004965980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70225014266700
+  version_requirements: *70107004965980
 - !ruby/object:Gem::Dependency
   name: pivotal-tracker
-  requirement: &70225014266280 !ruby/object:Gem::Requirement
+  requirement: &70107004965560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70225014266280
+  version_requirements: *70107004965560
 - !ruby/object:Gem::Dependency
   name: colored
-  requirement: &70225014265860 !ruby/object:Gem::Requirement
+  requirement: &70107004965140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70225014265860
+  version_requirements: *70107004965140
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70225014265440 !ruby/object:Gem::Requirement
+  requirement: &70107004994920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70225014265440
+  version_requirements: *70107004994920
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70225014265020 !ruby/object:Gem::Requirement
+  requirement: &70107004994500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70225014265020
+  version_requirements: *70107004994500
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70225014264600 !ruby/object:Gem::Requirement
+  requirement: &70107004994080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70225014264600
+  version_requirements: *70107004994080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70225022254180 !ruby/object:Gem::Requirement
+  requirement: &70107004993660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70225022254180
+  version_requirements: *70107004993660
 - !ruby/object:Gem::Dependency
   name: test-construct
-  requirement: &70225022253760 !ruby/object:Gem::Requirement
+  requirement: &70107004993240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70225022253760
+  version_requirements: *70107004993240
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70225022253340 !ruby/object:Gem::Requirement
+  requirement: &70107004992820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70225022253340
+  version_requirements: *70107004992820
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70225022252920 !ruby/object:Gem::Requirement
+  requirement: &70107004992400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,7 +132,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70225022252920
+  version_requirements: *70107004992400
 description: Kiseru Pivotal Tracker client
 email:
 - ben@freeagent.com
@@ -152,6 +152,7 @@ files:
 - ki_pivotal.gemspec
 - lib/ki_pivotal.rb
 - lib/ki_pivotal/api.rb
+- lib/ki_pivotal/interactive.rb
 - lib/ki_pivotal/kiseru.rb
 - lib/ki_pivotal/session.rb
 - lib/ki_pivotal/version.rb