3llo 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e05bd8d3c7bea9ee60906b240c091388184e4564
-  data.tar.gz: 3c42a1c12897aba513a736b3afd84d3dcf624838
+SHA256:
+  metadata.gz: d98e6963031445c64839dea30b0306cc264319fba049f12c0fe37bf3ef96d0a9
+  data.tar.gz: 3337c122e25299bb64cd0c12f12e83949c7d3ff17a96bed1c58757a53e631712
 SHA512:
-  metadata.gz: d81e257f0a944ec5ab3dd6373814ee8d4ae0482d0029d169222b827865a10cbfff93b08a6f508dab1c2b068acbecc7f40dbf4d13fe8032617dbfd299e27e56b8
-  data.tar.gz: fbaa8605fb23e12ecf5c93133bcbe70933b6eb8f7bcfe33cf4cae18920ecaca99fa6d355eed44e77e79fb37b060b046aa136b86e655be0931d2716b08eec77e1
+  metadata.gz: 6cbbaf758f34553fa23b48e206651bd3240f3065830e2156c2e9c2ca6f88dad161ee5a6d6cf43d1e09105911653eac634dc61ba3af39b90485d42e5425711edf
+  data.tar.gz: a532fd7bed771cb61d1004721a583dade9e3962a4e8edef3fafdbe495d3ad74e5846b47f6361930687e4b104707d1bf78f6166774ac403a8a100f619ad6d3540

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.3.1
+
+* Improve self-documentation [#39](https://github.com/qcam/3llo/pull/39).
+
 ## v0.3.0
 
 * Accept multiline in "card comment" command [#33](https://github.com/qcam/3llo/pull/33).

data/README.md

@@ -29,9 +29,10 @@ export TRELLO_TOKEN=your_token
 
 ### Obtain Trello API key and token
 
-1. Go to [Get started](https://developers.trello.com/get-started/start-building).
-2. Click on **Get your Application Key**.
-3. Copy the Application Key and generate a Token using the instruction on the page.
+1. Ensure you're logged into your Trello account at [trello.com](https://trello.com)
+1. Visit [trello.com/app-key](https://trello.com/app-key), accept the Trello Developer Terms (if you're happy to do so) and press **Generate API Key**
+1. Copy the `Key` that's displayed at the top of the page and set this as an environment variable (`TRELLO_KEY`).
+1. Further down the page, follow the `Manually generate a token` link to generate a new API Token. Again, set this as an environment variable (`TRELLO_TOKEN`)
 
 ## Usage
 

data/bin/3llo

@@ -10,10 +10,26 @@ $container.register(:api_client, Tr3llo::HTTP::Client)
 prompt = TTY::Prompt.new
 $container.register(:interface, Tr3llo::Interface.new(prompt, $stdout))
 
+def print_help(stripped = false)
+  Tr3llo::Presenter::HelpPresenter
+    .new($container.resolve(:interface), stripped)
+    .print!
+end
+
+if ARGV.size == 1 && (ARGV[0] == "-h" || ARGV[0] == "--help")
+  print_help(true)
+  exit
+end
+
 configuration = Tr3llo::Configuration.new
-configuration.user_id = ENV.fetch('TRELLO_USER') { raise "Have you set TRELLO_USER?" }
-configuration.api_key = ENV.fetch('TRELLO_KEY') { raise "Have you set TRELLO_KEY?" }
-configuration.api_token = ENV.fetch('TRELLO_TOKEN') { raise "Have you set TRELLO_TOKEN?" }
+begin
+  configuration.user_id = ENV.fetch('TRELLO_USER') { raise "Have you set TRELLO_USER?" }
+  configuration.api_key = ENV.fetch('TRELLO_KEY') { raise "Have you set TRELLO_KEY?" }
+  configuration.api_token = ENV.fetch('TRELLO_TOKEN') { raise "Have you set TRELLO_TOKEN?" }
+rescue => error
+  abort "Invalid configuration: \e[1m#{error.message}".colorize(31)
+end
+
 configuration.finalize!
 
 $container.register(
@@ -24,8 +40,6 @@ $container.register(
 user = Tr3llo::API::User.find($container.resolve(:configuration).user_id)
 $container.register(:user, user)
 
-Tr3llo::Presenter::HelpPresenter
-  .new($container.resolve(:interface))
-  .print!
+print_help(false)
 
 Tr3llo::Controller.new.start

data/lib/3llo/presenter/help.rb

@@ -1,13 +1,18 @@
 module Tr3llo
   module Presenter
     class HelpPresenter
-      def initialize(interface)
+      def initialize(interface, stripped = false)
         @interface = interface
+        @stripped = stripped
       end
 
       def print!
         interface.print_frame do
-          interface.puts menu_text
+          text = menu_text(@stripped)
+          if @stripped
+            text = text.split("\n").map(&:lstrip).drop(1).join("\n")
+          end
+          interface.puts text
         end
       end
 
@@ -15,10 +20,16 @@ module Tr3llo
 
       attr_reader :interface
 
-      def menu_text
-        %q{
+      def menu_text(cli_help = false)
+        cli_help_text = %q{
+          This is an interactive program for trello cards. To start, you
+          need to set `TRELLO_USER`, `TRELL_KEY` and `TRELLO_TOKEN` to access
+          your account. After that, the following commands are available in interactive
+          mode:
+        }
+        %Q{
     3llo - CLI for Trello
-
+    #{if cli_help then cli_help_text end}
     Usage:
     board list                   - Show list of board
     board select                 - Select board

data/lib/3llo/version.rb

@@ -1,3 +1,3 @@
 module Tr3llo
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 3llo
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Cẩm Huỳnh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Trello CLI