troo 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25d9e705a6baae8f54e59d630224178f8752c229
-  data.tar.gz: f02c744c0f64a0a18448b0668d6a7803fc47f4c5
+  metadata.gz: e68baa9983b5fa453d4feceb5542febfa90bb445
+  data.tar.gz: 3b3a8343f7f8b1d80ac3ee811faa29fdaefde523
 SHA512:
-  metadata.gz: fdbd5da52500592454d7c5f25cb60259697bba0401a7a78966b0c06332682f0a215098135ef805cda54235676d5f9d01ee27ec44b27e1bcd7409a364dbc8af7d
-  data.tar.gz: 700c9f4d5776861fe287b689e5d3b79472c2ac2bbe9863f167d063719da7885d6a71c8fb0c5c793228b82650966405a380dee11b7c0425835f7539e40e17c664
+  metadata.gz: 58654c3f6350bd6e016a44b94191263577cb655835882926896c553c7b8c10e79eb8b387130b71b7ced574533a0a8f9dfc47b9158263616836a67b2f5f3c8f9f
+  data.tar.gz: f3d8a493bba1fcc134496dd3f437b7ba613ba978802cd45fd74786d46adedfdaae4e1ea579148eaec983b20a8864ecc42485c32016db149e07bc40b224951259

data/.gitignore

@@ -23,3 +23,5 @@ test/support/fake_trello/my-server.crt
 test/support/fake_trello/my-server.key
 
 test/support/private_remotes/*.json
+.gemtags
+.tags

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    troo (0.0.9)
+    troo (0.0.11)
       addressable
-      curses (= 1.0.0)
+      curses (= 1.0.1)
       dispel
       json
       oauth
@@ -26,7 +26,6 @@ GEM
       cucumber (>= 1.1.1)
       rspec-expectations (>= 2.7.0)
     ast (1.1.0)
-    atomic (1.1.16)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
@@ -50,7 +49,7 @@ GEM
       gherkin (~> 2.12)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.1.1)
-    curses (1.0.0)
+    curses (1.0.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
@@ -147,11 +146,10 @@ GEM
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.18.1)
-    thread_safe (0.3.1)
-      atomic (>= 1.1.7, < 2)
+    thread_safe (0.3.3)
     tilt (1.4.1)
     timers (1.1.0)
-    tins (1.0.1)
+    tins (1.1.0)
     vcr (2.9.0)
     virtus (1.0.2)
       axiom-types (~> 0.1)
@@ -162,6 +160,7 @@ GEM
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
     yajl-ruby (1.2.0)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
@@ -184,3 +183,4 @@ DEPENDENCIES
   troo!
   vcr
   webmock
+  yard

data/README.md

@@ -4,6 +4,45 @@
 
 CLI interface for Trello. Named after Trello's mascot 'Roo'.
 
+## Requirements
+
+- A Trello account with API key/secret.
+- MacOSX/Linux (I've not tested with Windows, sorry.)
+- Ruby 2.1.1 (>= 1.9.3 should be fine, developed mainly in 2.1.0 so far.)
+- Redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'troo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install troo
+
+## Usage
+
+You will need user authentication tokens to access your Trello account.
+
+1) Sign in to Trello in the normal way.
+
+2) Create your developer key at Trello:
+
+    https://trello.com/1/appKey/generate
+
+3) Go to:
+
+    https://trello.com/1/connect?key=your_key_here&name=troo&response_type=token&scope=read,write
+
+4) Add your authentication tokens to the configuration file `.trooconf` in your home directory. (This file will be created for you the first time you run `troo init`)
+
+5) Have fun, and tweet me @gavinlaking if you like it.
+
 ## Commands
 
 - Add board, list, card or comment.
@@ -50,46 +89,6 @@ CLI interface for Trello. Named after Trello's mascot 'Roo'.
 
         troo version
 
-
-## Requirements
-
-- A Trello account with API key/secret.
-- MacOSX/Linux (I've not tested with Windows, sorry.)
-- Ruby 2.1.1 (>= 1.9.3 should be fine, developed mainly in 2.1.0 so far.)
-- Redis.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'troo'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install troo
-
-## Usage
-
-You will need user authentication tokens to access your Trello account.
-
-1) Sign in to Trello in the normal way.
-
-2) Create your developer key at Trello:
-
-    https://trello.com/1/appKey/generate
-
-3) Go to:
-
-    https://trello.com/1/connect?key=your_key_here&name=troo&response_type=token&scope=read,write
-
-4) Add your authentication tokens to the configuration file `.trooconf` in your home directory. (This file will be created for you the first time you run `troo init`)
-
-5) Have fun, and tweet me @gavinlaking if you like it.
-
 ## Todo
 
 - Fix multitude of sins.

data/Rakefile

@@ -3,17 +3,23 @@ require "rake/testtask"
 require 'cucumber'
 require 'cucumber/rake/task'
 
-Cucumber::Rake::Task.new(:cucumber) do |t|
-  t.cucumber_opts = "features --format progress"
-end
+if File.exist?(Dir.home + '/.trooconf')
+  Cucumber::Rake::Task.new(:cucumber) do |t|
+    t.cucumber_opts = "features --format progress"
+  end
 
-Rake::TestTask.new do |t|
-  t.libs << 'lib/troo'
-  t.test_files = FileList["test/lib/troo/*_test.rb",
-                          "test/lib/troo/**/*_test.rb"]
-  t.verbose = false
-end
+  Rake::TestTask.new do |t|
+    t.libs << 'lib/troo'
+    t.test_files = FileList["test/lib/troo/*_test.rb",
+                            "test/lib/troo/**/*_test.rb"]
+    t.verbose = false
+  end
 
-task :default => :test
+  task :default => :test
 
-Rake::Task['cucumber'].execute
+  Rake::Task['cucumber'].execute
+else
+  warn "\nConfiguration cannot be found, please run 'troo " \
+       "init' or './bin/troo init' first.\n"
+  exit(1)
+end

data/features/step_definitions/troo_steps.rb

@@ -7,7 +7,7 @@ Then(/^the output should be the version number of troo$/) do
 end
 
 Before do
-  config = Troo::Configuration.load('config/trooconf.yml', :test)
+  config = Troo::Configuration.load('config/trooconf.yml', 'test')
   Ohm.connect(db: config.database)
 end
 

data/lib/troo.rb

@@ -8,58 +8,47 @@ module Troo
   InvalidAccessToken    = Class.new(StandardError)
   EndpointNotFound      = Class.new(StandardError)
 
-  def self.configuration(file = Dir.home + '/.trooconf', env = :default)
+  # @param  []
+  # @param  [String]
+  # @return []
+  def self.configuration(file = Dir.home + '/.trooconf', env = 'default')
+    unless File.exist?(file)
+      warn "\nConfiguration cannot be found, please run 'troo " \
+           "init' or './bin/troo init' first.\n"
+      file = configuration_path + '/trooconf.yml'
+    end
+
     @configuration ||= Troo::Configuration.load(file, env)
   end
 
-  def self.endpoints(version = :version_1)
+  # @param  [String]
+  # @return []
+  def self.endpoints(version = 'version_1')
     @endpoints ||= Troo::API::Endpoints
-      .load(File.dirname(__FILE__) + '/../config/trello_api.yml', version)
+      .load(configuration_path + '/trello_api.yml', version)
   end
-  endpoints
 
+  # @return []
   def self.logger
     @logger ||= Logger
-      .new(File.dirname(__FILE__) + '/../logs/troo.log').tap do |log|
+      .new(log_path + '/troo.log').tap do |log|
       log.formatter = proc do |mode, time, prog, msg|
-        "#{time.iso8601} #{mode}:\n#{msg}\n\n"
+        "#{time.iso8601} #{mode}:\n#{msg}\n"
       end
     end
   end
 
-  # RestClient.log = File.dirname(__FILE__) + '/../logs/restclient.log'
+  # RestClient.log = log_dir + '/restclient.log'
 
   Database.connect(configuration)
 
-  class Launcher
-    def initialize(argv, stdin = STDIN,
-                         stdout = STDOUT,
-                         stderr = STDERR,
-                         kernel = Kernel)
-      @argv = argv
-      @stdin = stdin
-      @stdout = stdout
-      @stderr = stderr
-      @kernel = kernel
-    end
+  private
 
-    def execute!
-      $stdin, $stdout, $stderr = @stdin, @stdout, @stderr
-      pad { Troo::CLI::Main.start(@argv) }
-      @kernel.exit(0)
-    rescue Redis::CannotConnectError
-      pad { puts 'Cannot connect to Redis database.' }
-      @kernel.exit(1)
-    ensure
-      $stdin, $stdout, $stderr = STDIN, STDOUT, STDERR
-    end
-
-    private
+  def self.configuration_path
+    File.dirname(__FILE__) + '/../config'
+  end
 
-    def pad
-      puts
-      yield
-      puts
-    end
+  def self.log_path
+    File.dirname(__FILE__) + '/../logs'
   end
 end

data/lib/troo/api/client.rb

@@ -10,11 +10,14 @@ module Troo
       attribute :model
 
       class << self
+        # @param  [Hash]
+        # @return [Array]
         def perform(parameters)
           new(parameters).perform
         end
       end
 
+      # @return [Array]
       def perform
         return [] unless allow_remote?
         return [] if missing_parameters?

data/lib/troo/api/endpoints.rb

@@ -25,11 +25,17 @@ module Troo
       end
 
       class << self
+        # @param  [String]
+        # @param  [String]
+        # @return [Troo::API::Endpoints]
         def load(file, version)
-          new(YAML.load_file(file)[version.to_s])
+          new(YAML.load_file(file)[version])
         end
       end
 
+      # @param  [Symbol]
+      # @param  [Hash]
+      # @return [String, EndpointNotFound]
       def interpolate!(endpoint, value = {})
         return send(endpoint) % value if respond_to?(endpoint)
         fail EndpointNotFound

data/lib/troo/api/headers.rb

@@ -2,15 +2,22 @@ module Troo
   module API
     class Headers
       class << self
+        # @param  [String]
+        # @param  [Hash]
+        # @return [Hash]
         def build!(uri, headers = {})
           new(uri, headers).build!
         end
       end
 
+      # @param  [String]
+      # @param  [Hash]
+      # @return [Troo::API::Headers]
       def initialize(uri, headers = {})
         @uri, @headers = uri, headers
       end
 
+      # @return [Hash]
       def build!
         defaults.merge!(@headers)
       end

data/lib/troo/api/request.rb

@@ -2,15 +2,24 @@ module Troo
   module API
     class Request
       class << self
+        # @param  [Symbol]
+        # @param  [String]
+        # @param  [Hash]
+        # @return [Response, ErrorResponse]
         def make(verb, uri, query = {})
           new(verb, uri, query).make
         end
       end
 
+      # @param  [Symbol]
+      # @param  [String]
+      # @param  [Hash]
+      # @return [Troo::API::Request]
       def initialize(verb, uri, query = {})
         @verb, @uri, @query = verb, uri, query
       end
 
+      # @return [Response, ErrorResponse]
       def make
         @request ||= request
       rescue RestClient::Exception => e

data/lib/troo/api/response.rb

@@ -9,11 +9,14 @@ module Troo
       end
 
       class << self
+        # @param  [Hash]
+        # @return [Response, ErrorResponse]
         def build(response)
           new(response).build
         end
       end
 
+      # @return [Response, ErrorResponse]
       def build
         ok? ? Response.new(attributes) : ErrorResponse.new(attributes)
       end

data/lib/troo/cli/add.rb

@@ -3,6 +3,8 @@ module Troo
     class Add < ThorFixes
       package_name 'add'
 
+      # @param  [String]
+      # @return [String]
       desc 'board (<name>)',
            'Add a new board with <name>; prompts if <name> not ' \
            'provided.'
@@ -11,6 +13,9 @@ module Troo
         say Commands::Add.dispatch(value, nil, type: :board)
       end
 
+      # @param  [String]
+      # @param  [String]
+      # @return [String]
       desc 'card <list_id> (<name>)',
            'Add a new card to the list with <list_id> with <name>; ' \
            'prompts if <name> not provided.'
@@ -19,6 +24,9 @@ module Troo
         say Commands::Add.dispatch(value, id, type: :card)
       end
 
+      # @param  [String]
+      # @param  [String]
+      # @return [String]
       desc 'comment <card_id> (<comment>)',
            'Add a new comment to the card with <card_id> with ' \
            '<comment>; prompts if <comment> not provided.'
@@ -27,6 +35,9 @@ module Troo
         say Commands::Add.dispatch(value, id, type: :comment)
       end
 
+      # @param  [String]
+      # @param  [String]
+      # @return [String]
       desc 'list <board_id> (<name>)',
            'Add a new list to the board with <board_id> with ' \
            '<name>; prompts if <name> not provided.'

data/lib/troo/cli/commands/add.rb

@@ -4,15 +4,24 @@ module Troo
       attr_reader :id, :value
 
       class << self
+        # @param  []
+        # @param  []
+        # @param  [Hash]
+        # @return []
         def dispatch(value, id = nil, options = {})
           new(value, id, options).add
         end
       end
 
+      # @param  []
+      # @param  []
+      # @param  [Hash]
+      # @return []
       def initialize(value, id = nil, options = {})
         @value, @id, @options = value, id, options
       end
 
+      # @return []
       def add
         return success if create
         error