trello_cli 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67d3269ab8c44f68e1ecdadb52a096162df122d3
-  data.tar.gz: 0995679927099f04e253b604d145f8d414665c18
+  metadata.gz: 40df02ef5553721b45c97fbcab9439acd9877248
+  data.tar.gz: 7400fe025f43fce5f77b373abb012eda3d39a0f2
 SHA512:
-  metadata.gz: a52aaeac10cf59ac1fdf54e614c83bcd3cbf0703ce545e3b699cdbc146ac74705847dd9b4701e1ab5d771c0789f31dac790d23349de5de56b6f8fe9c716dd21c
-  data.tar.gz: 01a9dcce612760fd26d7e3c3b83efff6cb683df5d9d394d73c81dd9430aab96a374d01303d3a7610064353b9bdbbdad13ffbd1e152e46a7adba33b1f60ae689b
+  metadata.gz: 57ef11ccd5519f117c77d8dbd1e949005a7582d07b0afabd50aae9e4d6df448e288ede1386cb6a1e1bdaaf1c22d9b78f10461a31a6be49b5bfcc068f7b56a964
+  data.tar.gz: 4a479da7c1e9559ab8d7532cb3220b818a42a9d477998664d3f6b983a61578248da24c8025da37f6dbe13f1f1cae001cc783833c07b0e70dc2355badb57204fd

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0:
+
+* Adding JSON and TSV output formatters
+
 ## 0.3.0:
 
 * Add ability to assign member to card on creation

data/README.md

@@ -62,19 +62,39 @@ To see help for a specific command:
         -l, --list [LIST]                List Of Card
         -n, --name [NAME]                Name Of Card
 
+### Output Formatters
+
+To allow for easy integration, the output of any command can format as either TSV (Tab
+Seperated Values) or JSON.
+
+**JSON Output**
+
+```json
+# trello card list -o json
+[{"name":"board1","id":"1234"},{"name":"board2","id":"4567"}]
+```
+
+**TSV Output**
+
+```
+# trello card list -o tsv
+1234  board1
+4567  board2
+```
+
 ## Examples
 
 List the boards available to the given credentials:
 
     trello board list
 
-List the lists for a given board id:
+List the lists for a given board id and output as a TSV list:
 
-    trello list list -b 123
+    trello list list -b 123 -o tsv
 
-Create a card:
+Create a card and output as JSON:
 
-    trello card create -b 123 -l 321 -n 'card name' -d 'card description'
+    trello card create -b 123 -l 321 -n 'card name' -d 'card description' -o json
 
 ## Contributing
 

data/lib/trello_cli/cli/board/list.rb

@@ -10,12 +10,12 @@ module TrelloCli
         def run
           option_parser.parse!
 
-          list_boards(@options[:closed]).each do |board|
-            name   = board.attributes[:name]
-            id     = board.attributes[:id]
-            closed = board.attributes[:closed]
-            puts "#{name} ( #{id} )"
+          data = list_boards(@options[:closed]).map do |b|
+            { name: b.attributes[:name],
+              id:   b.attributes[:id] }
           end
+
+          puts TrelloCli::Formatters::BoardList.new(data).output @options[:output]
         end
 
         private
@@ -36,6 +36,10 @@ module TrelloCli
             opts.on("-c", "--closed", "Include closed board." ) do |o|
               @options[:closed] = o
             end
+
+            opts.on("-o", "--output [OUTPUT]", "Output format [json|tsv|legacy]." ) do |o|
+              @options[:output] = o
+            end
           end
         end
 

data/lib/trello_cli/cli/card/create.rb

@@ -10,13 +10,12 @@ module TrelloCli
         def run
           option_parser.parse!
 
-          card        = create_card
-          name        = card.attributes[:name]
-          description = card.attributes[:description]
+          card = create_card
+          data = { id:   card.attributes[:id],
+                   name: card.attributes[:name],
+                   desc: card.attributes[:desc] }
 
-          puts "Card Created."
-          puts "Name        : #{name}"
-          puts "Description : #{description}"
+          puts TrelloCli::Formatters::CardCreate.new(data).output @options[:output]
         end
 
         private
@@ -35,7 +34,7 @@ module TrelloCli
             end
 
             opts.on("-d", "--description [DESCRIPTION]", "Description Of Card") do |d|
-              @options[:description] = d
+              @options[:desc] = d
             end
 
             opts.on("-l", "--list [LIST]", "List Of Card") do |l|
@@ -49,6 +48,10 @@ module TrelloCli
             opts.on("-n", "--name [NAME]", "Name Of Card") do |n|
               @options[:name] = n
             end
+
+            opts.on("-o", "--output [OUTPUT]", "Output format [json|tsv|legacy]." ) do |o|
+              @options[:output] = o
+            end
           end
         end
 

data/lib/trello_cli/cli/card/list.rb

@@ -10,11 +10,11 @@ module TrelloCli
         def run
           option_parser.parse!
 
-          list_cards.each do |card|
-            puts "| Name: #{card.name} ( #{card.id} )"
-            puts "| Description: #{card.description}" if @options[:description]
-            puts "|------------------------"
+          data = list_cards.map do |c|
+            { name: c.name, id: c.id, desc: c.desc }
           end
+
+          puts TrelloCli::Formatters::CardList.new(data).output(@options[:output])
         end
 
         private
@@ -35,8 +35,8 @@ module TrelloCli
               @options[:list_id] = l
             end
 
-            opts.on("-d", "--description", "Include description." ) do |o|
-              @options[:description] = o
+            opts.on("-o", "--output [OUTPUT]", "Output format [json|tsv|legacy]." ) do |o|
+              @options[:output] = o
             end
           end
         end

data/lib/trello_cli/cli/card/move.rb

@@ -10,9 +10,12 @@ module TrelloCli
         def run
           option_parser.parse!
 
-          move_card
+          result = move_card
+          data = { card_id: result["id"],
+                   list_id: result["idList"],
+                   success: (result["idList"] == @options[:list_id]) }
 
-          puts "Card '#{@options[:card_id]}' moved to list '#{@options[:list_id]}'."
+          puts TrelloCli::Formatters::CardMove.new(data).output @options[:output]
         end
 
         private
@@ -33,6 +36,10 @@ module TrelloCli
             opts.on("-l", "--list_id [LIST_ID]", "New List ID") do |l|
               @options[:list_id] = l
             end
+
+            opts.on("-o", "--output [OUTPUT]", "Output format [json|tsv|legacy]." ) do |o|
+              @options[:output] = o
+            end
           end
         end
 

data/lib/trello_cli/cli/commands/card.rb

@@ -8,9 +8,6 @@ module TrelloCli
         def create
           ensure_credential_envs_set
           TrelloCli::CLI::Card::Create.new.run
-        rescue TrelloCli::Errors => e
-          puts "error: #{e}"
-          exit 1
         end
 
         def list

data/lib/trello_cli/cli/list/list.rb

@@ -10,12 +10,14 @@ module TrelloCli
         def run
           option_parser.parse!
 
-          list_lists.each do |list|
-            name = list.attributes[:name]
-            id   = list.attributes[:id]
-
-            puts "#{name} ( #{id} )"
+          data = list_lists.map do |l|
+            {
+              id:   l.attributes[:id],
+              name: l.attributes[:name]
+            }
           end
+
+          puts TrelloCli::Formatters::ListList.new(data).output @options[:output]
         end
 
         private
@@ -34,6 +36,9 @@ module TrelloCli
               @options[:board_id] = b
             end
 
+            opts.on("-o", "--output [OUTPUT]", "Output format [json|tsv|legacy]." ) do |o|
+              @options[:output] = o
+            end
           end
         end
 

data/lib/trello_cli/cli/run.rb

@@ -16,6 +16,9 @@ module TrelloCli
           rescue OptionParser::InvalidOption, Trello::Error => e
             puts e.message
             exit 1
+          rescue TrelloCli::Errors => e
+            puts "error: #{e}"
+            exit 1
           rescue NoMethodError => e
             if e.message.match /SocketError/
               puts 'Please connect to the internet to access Trello'

data/lib/trello_cli/formatters/base.rb

@@ -0,0 +1,30 @@
+require 'json'
+
+module TrelloCli
+  module Formatters
+    class Base
+      def initialize(data)
+        @data = data
+      end
+
+      def output(format)
+        case format
+        when "json"
+          self.to_json
+        when "tsv"
+          self.to_tsv
+        else
+          self.to_legacy
+        end
+      end
+
+      def to_json
+        data.to_json
+      end
+
+      private
+
+      attr_reader :data
+    end
+  end
+end

data/lib/trello_cli/formatters/board_list.rb

@@ -0,0 +1,13 @@
+module TrelloCli
+  module Formatters
+    class BoardList < Base
+      def to_legacy
+        data.map {|d| "#{d[:name]} ( #{d[:id]} )"}.join("\n")
+      end
+
+      def to_tsv
+        data.map {|d| "#{d[:id]}\t#{d[:name]}\n"}
+      end
+    end
+  end
+end

data/lib/trello_cli/formatters/card_create.rb

@@ -0,0 +1,15 @@
+module TrelloCli
+  module Formatters
+    class CardCreate < Base
+      def to_legacy
+        msg = "Card Created.\n"
+        msg << "Name        : #{data[:name]}\n"
+        msg << "Description : #{data[:desc]}\n"
+      end
+
+      def to_tsv
+        [data[:id], data[:name], data[:desc]].join("\t") + "\n"
+      end
+    end
+  end
+end

data/lib/trello_cli/formatters/card_list.rb

@@ -0,0 +1,19 @@
+module TrelloCli
+  module Formatters
+    class CardList < Base
+      def to_legacy
+        data.map do |d|
+          msg = "| Name: #{d[:name]} ( #{d[:id]} )\n"
+          msg << "| Description: #{d[:desc]}\n" if d[:desc]
+          msg << "|------------------------\n"
+        end
+      end
+
+      def to_tsv
+        data.map do |d|
+          [d[:id], d[:name], d[:desc]].join("\t") + "\n"
+        end
+      end
+    end
+  end
+end

data/lib/trello_cli/formatters/card_move.rb

@@ -0,0 +1,17 @@
+module TrelloCli
+  module Formatters
+    class CardMove < Base
+      def to_legacy
+        if data[:success]
+          "Card #{data[:card_id]} was succesfully moved to #{data[:list_id]}.\n"
+        else
+          "Error moving card."
+        end
+      end
+
+      def to_tsv
+        [data[:success], data[:card_id], data[:list_id]].join("\t") + "\n"
+      end
+    end
+  end
+end

data/lib/trello_cli/formatters/list_list.rb

@@ -0,0 +1,13 @@
+module TrelloCli
+  module Formatters
+    class ListList < Base
+      def to_legacy
+        data.map {|d| "#{d[:name]} ( #{d[:id]} )"}.join("\n")
+      end
+
+      def to_tsv
+        data.map {|d| "#{d[:id]}\t#{d[:name]}\n"}
+      end
+    end
+  end
+end

data/lib/trello_cli/formatters.rb

@@ -0,0 +1,7 @@
+require 'trello_cli/formatters/base'
+
+require 'trello_cli/formatters/board_list'
+require 'trello_cli/formatters/card_create'
+require 'trello_cli/formatters/card_list'
+require 'trello_cli/formatters/card_move'
+require 'trello_cli/formatters/list_list'

data/lib/trello_cli/requests/create_card.rb

@@ -24,11 +24,13 @@ module TrelloCli
         end
 
         card = Trello::Card.new 'name'      => args[:name],
-                                'desc'      => args[:description],
+                                'desc'      => args[:desc],
                                 'idBoard'   => @board_id,
                                 'idList'    => args[:list_id],
                                 'idMembers' => member_ids.join(",")
         card.save
+
+        card
       end
 
       private

data/lib/trello_cli/requests/move_card.rb

@@ -11,7 +11,7 @@ module TrelloCli
       def move(args)
         card = Trello::Card.new 'id' => args[:card_id]
         list = Trello::List.find args[:list_id]
-        card.move_to_list list
+        JSON.parse(card.move_to_list list)
       end
 
     end

data/lib/trello_cli/version.rb

@@ -1,3 +1,3 @@
 module TrelloCli
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/trello_cli.rb

@@ -1,5 +1,6 @@
 require "trello_cli/cli"
 require "trello_cli/errors"
+require "trello_cli/formatters"
 require "trello_cli/requests"
 require "trello_cli/version"
 

data/spec/cli/board/list_spec.rb

@@ -22,8 +22,7 @@ describe TrelloCli::CLI::Board::List do
 
   it "should puts all boards" do
     subject.instance_variable_set(:@options, { closed: true })
-    expect(subject).to receive(:puts).with("board1 ( 1 )")
-    expect(subject).to receive(:puts).with("board2 ( 2 )")
+    expect(subject).to receive(:puts).with("board1 ( 1 )\nboard2 ( 2 )")
     subject.run
   end
 

data/spec/formatters/base_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe TrelloCli::Formatters::Base do
+  let(:data) { ( { data: "test1234" } ) }
+  let(:subject) { TrelloCli::Formatters::Base.new data }
+  it "should create a formater and output the data as JSON" do
+    subject.output("json").should == data.to_json
+  end
+end
+

data/spec/requests/create_card_spec.rb

@@ -10,13 +10,13 @@ describe TrelloCli::Requests::CreateCard do
   let(:member_struct) { Struct.new(:attributes) }
 
   before do
-    @args = { :name        => 'name',
-              :description => 'desc',
-              :board_id    => '123',
-              :list_id     => '321',
-              :members     => ["user1", "user2"] }
+    @args = { :name      => 'name',
+              :desc      => 'desc',
+              :board_id  => '123',
+              :list_id   => '321',
+              :members   => ["user1", "user2"] }
     @options = { 'name'      => @args[:name],
-                 'desc'      => @args[:description],
+                 'desc'      => @args[:desc],
                  'idBoard'   => @args[:board_id],
                  'idList'    => @args[:list_id],
                  'idMembers' => "id1,id2" }

data/spec/requests/move_card_spec.rb

@@ -15,7 +15,8 @@ describe TrelloCli::Requests::MoveCard do
     Trello::List.should_receive(:find).
                  with(args[:list_id]).
                  and_return trello_list_mock
-    trello_card_mock.should_receive(:move_to_list).with(trello_list_mock)
-    subject.move args
+    trello_card_mock.should_receive(:move_to_list).with(trello_list_mock).
+                     and_return({}.to_json)
+    subject.move(args).should == {} # JSON.parses results
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trello_cli
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Brett Weaver
@@ -97,6 +97,13 @@ files:
 - lib/trello_cli/cli/list/list.rb
 - lib/trello_cli/cli/run.rb
 - lib/trello_cli/errors.rb
+- lib/trello_cli/formatters.rb
+- lib/trello_cli/formatters/base.rb
+- lib/trello_cli/formatters/board_list.rb
+- lib/trello_cli/formatters/card_create.rb
+- lib/trello_cli/formatters/card_list.rb
+- lib/trello_cli/formatters/card_move.rb
+- lib/trello_cli/formatters/list_list.rb
 - lib/trello_cli/requests.rb
 - lib/trello_cli/requests/create_card.rb
 - lib/trello_cli/requests/list_boards.rb
@@ -109,6 +116,7 @@ files:
 - spec/cli/board/list_spec.rb
 - spec/cli/commands/shared_spec.rb
 - spec/cli/run_spec.rb
+- spec/formatters/base_spec.rb
 - spec/requests/create_card_spec.rb
 - spec/requests/list_boards_spec.rb
 - spec/requests/list_card_spec.rb
@@ -145,6 +153,7 @@ test_files:
 - spec/cli/board/list_spec.rb
 - spec/cli/commands/shared_spec.rb
 - spec/cli/run_spec.rb
+- spec/formatters/base_spec.rb
 - spec/requests/create_card_spec.rb
 - spec/requests/list_boards_spec.rb
 - spec/requests/list_card_spec.rb