trello-list2card 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8f227d65221b15768e81e4effc5a79d23b820ca
+  data.tar.gz: 60aae730bd906d9a83d36da13cd9060c796aa336
+SHA512:
+  metadata.gz: b3657c944296494a992ee16e81c48951baa610a7a772c800b61f2b61b6feaa01488c99b7993d7d37140b621decceaee02a5c03068288367acfb5139eafbd1185
+  data.tar.gz: 96f62bfec4bfaab516fc19885959f802ae4d827b8b6c8a8d64dcd605ba3f7468e7b8999bdd1438d609e644ed7c808ece65d69b59f4ea673b19063f1a66e81569

data/.gitignore

@@ -0,0 +1 @@
+/Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.1.1
+- Fix incorrect installation instructions
+
+# 0.1.0
+- Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2016 Tom Clark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# list2card
+A simple program to summarise the cards on a Trello list as a comment on a card, then archive the cards on the source list.
+
+## Purpose
+At the end of every week I summarise the "Done" column of my personal 
+Trello board into a "Captain's Log"
+metacard, before archiving all of the completed tasks. I wrote `list2card` to automate this process.
+
+Note: scheduling the execution of `list2card` is left as an exercise for the reader.
+
+## Installation
+```
+$ gem install trello-list2card
+```
+
+## Configuration
+`list2card` requires a configuration file to operate. An example is available on [Github](https://github.com/tomonocle/trello-list2card/blob/master/etc/config.toml.example), or you can follow the guide below.
+
+### Trello API key and token
+Visit [https://trello.com/app-key](https://trello.com/app-key) to get your unique API key and token.
+
+Config file:
+
+```
+$ cat config.toml
+user_key   = '<KEY>'
+user_token = '<TOKEN>'
+```
+
+### Source list, destination card
+
+First list your boards to find the id of board you want to work with
+
+```
+$ list2card --list-boards
+ *  id                       name                                       url
+[*] abc123abc123abc123abc123 Test board A                               https://trello.com/b/abc123ab/test-board-a
+[ ] 123abc123abc123abc123abc Test board B                               https://trello.com/b/123abc12/test-board-b
+```
+
+Now list the lists on the board to find your `source_list_id`
+
+```
+$ list2card --list-lists abc123abc123abc123abc123
+id                       name
+xyz789zxy789xyz789xyz789 Todo
+789xyz789xyz789xyz789xyz Done
+```
+
+Finally list the cards on the appropriate list to find the id of your summary metacard `dest_card_id`
+
+```
+$ list2card --list-cards xyz789zxy789xyz789xyz789
+id                       name                                       url
+def456def456def456def456 Captain's Log                              https://trello.com/c/aabbccdd
+```
+
+### Final config file
+```
+$ cat config.toml
+user_key   = '<KEY>'
+user_token = '<TOKEN>'
+
+source_list_id = '789xyz789xyz789xyz789xyz'
+dest_card_id   = 'def456def456def456def456'
+```
+
+## Usage
+
+```
+$ list2card -c config.toml
+```
+
+This will silently summarise the contents of `source_list_id` into `dest_card_id` as a comment in the following format:
+
+```
+N tasks completed
+<Task 1>
+<Task ..>
+<Task N>
+```
+
+Before archiving the cards on `source_list_id`.
+
+Note: No entry will be written if there are no cards to summarise.
+
+### Logging
+Log level can be adjusted with `-l [debug,info,warn,error,fatal]` (defaults to **warn**).
+
+### Dry-run
+Dry-run (read-only, don't write comment or archive cards) can be enabled with `-d`. Note: you'll probably want to increase the log level with `-l` for this to be useful.
+
+### Exit codes
+| Code | Meaning |
+|:----:|---------|
+| 0    | Success (wrote output, or nothing to do) |
+| 1    | Failure. Something went wrong. Always accompanied by a FATAL log message. |

data/bin/list2card

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'trello/list2card'
+
+options = {}
+OptionParser.new do |opts|
+    opts.banner = 'Usage: list2card -c <config> [options]'
+
+    opts.on( '-c', '--config <config>', 'Path to config file' ) {
+        |c|
+        options[ :config ] = c
+    }
+
+    opts.on( '-l', '--log-level <level>', 'Specify log level (debug,info,warn,error,fatal)' ) {
+        |l|
+        options[ :log_level ] = l
+    }
+
+    opts.on( '-d', '--dry-run', 'Dry run - don\'t change anything' ) {
+        options[ :dry_run ] = true
+    }
+
+    opts.on( '--list-boards', 'Enumerate all boards the user can access' ) {
+        options[ :list_boards ] = true
+    }
+
+    opts.on( '--list-lists <board>', 'Enumerate the lists under <board>' ) {
+        |b|
+        options[ :list_lists ] = b
+    }
+
+    opts.on( '--list-cards <list>', 'Enumerate the cards under <list>' ) {
+        |l|
+        options[ :list_cards ] = l
+    }
+
+    opts.on_tail( '-h', '--help', 'Display help' ) {
+    puts opts
+    exit
+}
+end.parse!
+
+list2card = Trello::List2Card.new( options[ :config ], options[ :log_level ], options[ :dry_run ] )
+
+## dispatch/routing
+if ( options[ :list_boards ] )
+    list2card.do_listboards
+
+elsif ( options[ :list_lists ] )
+    list2card.do_listlists( options[ :list_lists ] )
+
+elsif ( options[ :list_cards ] )
+    list2card.do_listcards( options[ :list_cards ] )
+
+else 
+    list2card.do_run
+end

data/etc/config.toml.example

@@ -0,0 +1,23 @@
+# log_level
+# The log_level to operate at: debug/info/warn/error/fatal
+# log_level = 'warn'
+
+# user_key
+# Your trello API key, available at https://trello.com/app-key
+# e.g user_key = '1234567a12abcd1ab12a123456a1a1a1'
+user_key = ''
+
+# user_token
+# Your trello API token, available at https://trello.com/app-key
+# e.g user_token = '12a12a1a1ab1ab12ab1234567a1a12345a12abc12a1ab12a123ab1a1ab123a12'
+user_token = ''
+
+# source_list_id
+# The trello id of the list to summarise, available via '--list-lists <board>'
+# e.g source_list_id = '12a12345678901a1234ab123'
+source_list_id = ''
+
+# dest_card_id
+# The trello id of the card to write the summary to, available via '--list-cards <list>'
+# e.g dest_card_id = '12a12345678901a1234ab123'
+dest_card_id = ''

data/etc/test.toml

@@ -0,0 +1,4 @@
+user_key = '6341728b71fbaa5dc78d229129f5b7b7'
+user_token = 'e0c7e6d1f3540c67f154d3330d38ee0b62da24e45bb352347ec31fb19cae990b'
+source_list_id = '58625fe5bf0d4380487d5e4c'
+dest_card_id = 'nOqSLSe2'

data/lib/trello/list2card.rb

@@ -0,0 +1,175 @@
+module Trello
+    class List2Card
+        require 'logger'
+        require 'ostruct'
+        require 'toml'
+        require 'trello'
+    
+        @@LOG_LEVEL_MAP = {
+            'debug' => Logger::DEBUG,
+            'info'  => Logger::INFO,
+            'warn'  => Logger::WARN,
+            'error' => Logger::ERROR,
+            'fatal' => Logger::FATAL,
+        }
+    
+        @@DEFAULT_LOG_LEVEL = 'warn'
+    
+        def initialize( config_path, log_level, dry_run )
+            @log = Logger.new( STDERR )
+            self.set_log_level( @@DEFAULT_LOG_LEVEL )
+    
+            @log.info 'Starting up'
+    
+            begin
+                raise 'config file not specified' if not config_path
+    
+                @log.info "Loading config from #{ config_path }"
+                @config = OpenStruct.new( TOML.load_file( config_path ) )
+                @log.info 'Loaded config'
+                @log.debug @config.to_s
+    
+            rescue => e
+                @log.fatal "Failed to load config: #{e.message}"
+                exit 1
+            end
+            
+            self.set_log_level( @config[ 'log_level' ] )
+            self.set_log_level( log_level )
+    
+            # very basic sanity check of the config
+            [ 'user_key', 'user_token' ].each do |key|
+                if ( not @config[ key ] )
+                    @log.fatal "Key #{ key } not present in config"
+                    exit 1
+                end
+            end
+    
+            Trello.configure do |c|
+                c.developer_public_key = @config.user_key
+                c.member_token         = @config.user_token
+            end
+    
+            if ( dry_run )
+                @log.warn 'Dry run mode: ON'
+                @dry_run = true
+            end
+        end
+    
+        def set_log_level( level )
+            return if not level
+            
+            level.downcase!
+    
+            if ( not @@LOG_LEVEL_MAP[ level ] )
+                @log.fatal "Unrecognised log_level '#{ level }'"
+                exit 1
+            end
+    
+            @log.level = @@LOG_LEVEL_MAP[ level ]    
+        end
+    
+        def do_listboards
+            begin
+                me = Trello::Member.find( 'me' )
+            rescue => e
+                @log.fatal "Failed to load boards: #{ e.message }"
+                exit 1
+            end
+    
+            puts sprintf ' *  %-24s %-42s %s', 'id', 'name', 'url'
+            me.boards( :filter => :open ).each do |board|
+                puts sprintf '[%s] %s %-42s %s', ( board.starred == true ? '*' : ' ' ), board.id, board.name[ 0, 42 ], board.url
+            end
+        end
+    
+        def do_listlists( board_id )
+            begin
+                board = Trello::Board.find( board_id )
+            rescue => e
+                @log.fatal "Failed to load board: #{ e.message }"
+                exit 1
+            end
+    
+            puts sprintf '%-24s %s', 'id', 'name'
+            board.lists.each do |list|
+              puts "#{ list.id } #{ list.name }"
+            end
+        end
+    
+        def do_listcards( list_id )
+            begin
+                list = Trello::List.find( list_id )
+            rescue => e
+                @log.fatal "Failed to load list: #{ e.message }"
+                exit 1
+            end
+            
+            puts sprintf '%-24s %-42s %s', 'id', 'name', 'url'
+            list.cards.each do |card|
+                puts sprintf '%s %-42s %s', card.id, card.name[ 0, 42 ], card.short_url
+            end
+        end
+    
+        def do_run
+            [ 'source_list_id', 'dest_card_id' ].each do |k|
+                if ( not @config[ k ] )
+                    @log.fatal "Key #{ k } not present in config"
+                    exit 1
+                end
+            end
+    
+            # avoid a possible race condition by taking a snapshot of the list
+            source_cards = []
+    
+            begin
+                list = Trello::List.find( @config.source_list_id )
+                source_cards = list.cards
+                @log.info "Loaded list #{ @config.source_list_id }"
+    
+            rescue => e
+                @log.fatal "Couldn't load list_id '#{ @config.source_list_id }': #{ e.message }"
+                exit 1
+            end
+    
+            if ( source_cards.count == 0 ) then
+                @log.info 'No cards to process - aborting'
+                exit 0
+    
+            else 
+                @log.info "#{ source_cards.count } card(s) to process"
+            end
+    
+            # prepare the message itself
+            message = sprintf "%d task%s completed\n\n%s", source_cards.count, ( source_cards.count == 1 ? '' : 's' ), ( source_cards.map { |card| card.short_url } ).join( "\n" )
+            @log.debug "message: '#{ message }'"
+    
+            begin
+                log_card = Trello::Card.find( @config.dest_card_id )
+                log_card.add_comment( message ) if not @dry_run
+                @log.info sprintf "%sWrote message to log_card '%s'", ( @dry_run == true ? "[DRYRUN] " : '' ), @config.dest_card_id
+    
+            rescue => e
+                @log.fatal "Failed to write message to log_card '#{ config.dest_card_id }': #{ e.message }"
+                exit 1
+            end
+    
+            # Successfully posted the message, now archive the cards
+            source_cards.each do |card|
+                begin
+                    if ( not @dry_run )
+                        card.close
+                        card.save
+                    end
+    
+                    @log.info sprintf "%sArchived '%s' (%s)", ( @dry_run == true ? '[DRYRUN] ' : '' ), card.name, card.id
+    
+                rescue => e
+                    @log.error "Failed to archive '#{ card.id }'"
+                end
+            end
+    
+            @log.info 'Done'
+        end
+    end
+end

data/lib/trello/list2card/version.rb

@@ -0,0 +1,5 @@
+module Trello
+    class List2Card
+        VERSION = '0.1.1'
+    end
+end

data/trello-list2card.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trello/list2card/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'trello-list2card'
+  spec.version       = Trello::List2Card::VERSION
+  spec.author        = 'tomonocle'
+  spec.email         = 'tomonocle@woot.co.uk'
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Tool to summarise a Trello list to a card'
+  spec.description   = 'A simple program to summarise the cards on a Trello list as a comment on a card, then archive the cards on the source list.'
+  spec.homepage      = 'https://github.com/tomonocle/trello-list2card'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ruby-trello', '~> 1.5'
+  spec.add_dependency 'toml-rb', '~> 0.3'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: trello-list2card
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- tomonocle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-trello
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: toml-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: A simple program to summarise the cards on a Trello list as a comment
+  on a card, then archive the cards on the source list.
+email: tomonocle@woot.co.uk
+executables:
+- list2card
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- bin/list2card
+- etc/config.toml.example
+- etc/test.toml
+- lib/trello/list2card.rb
+- lib/trello/list2card/version.rb
+- trello-list2card.gemspec
+homepage: https://github.com/tomonocle/trello-list2card
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Tool to summarise a Trello list to a card
+test_files: []