lionel_richie 0.1.5.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGRkODE3YzNlNjVkZmUzNWVhZTZjZTdmNzYyYzY0OWUyZmNjYWI2OA==
+    NGIyMjk4ZjAwYjc0ZTFhZjU3ZGY1NWY3ZWE5OTcxM2QzZmVlYjIwZg==
   data.tar.gz: !binary |-
-    YTBlNWFlNDFjYWY0Y2ZlMzAyNTJhMmIzYTc1OWNmZmVlZTY5M2JmYg==
-!binary "U0hBNTEy":
+    Mjk0YTljYjNkZDVlNDZlMTMzYTc3MWMyMWE4Nzc4MjNkOGJhOTk0Mg==
+SHA512:
   metadata.gz: !binary |-
-    MGViMDI0ZTdiZmI5ZjFkZDA5MmMxMWI2Zjg0MDFhYzNlZDBkMzgyMjU2Yzc1
-    YmU2MDg4Zjc0NTQxZDI5MTZkYWEzMjZjYzBlOGIzNTBkOWZmZDg3Njc4Mjhm
-    NWZlYjY3OWIwMWQ0ZDlkMTg5MTAwMWY5OTU4Y2MxNTYyODIwMWM=
+    MTg3NmM5ZDMyM2FhOWExNjYxNjEwODY1ZWQzMDQzNDA0ZWQxMzA1Y2M3MWE5
+    MzMyYzUyYWE0YTFmNGY3MDQyZGE5ZmQyNTZlMjYzZmNjM2JhYjQ4ZWEyM2U4
+    NWMwNDU2MmVlYzQ1OWVkMTczNzY5NjBiYjIwODE0NTUwZDA3NTE=
   data.tar.gz: !binary |-
-    YzEyZjNhZWUzMTM2N2M0MjI0YjFjN2NkZjA0YTdkOGYwNTk2NDgyODU3NmQw
-    ZTVlMjIzMmYwNjM3NjVmMzdiMzZiNzBhN2NhOTdmODI0Y2FjYWE3MjUxZDc5
-    NDg1NmU5MTY1ZmU3MDJmZTYzN2EzZjhkNzBjYjkyNzhjOTdmY2U=
+    ZWNlMDk4YWQyOTZjZTQ1ODc1NzU0YTA4NjBhMDNhYTRjZmYxMjc3MmEzMjMw
+    ODRjYWE0MjJiMTEwZWQzNjI2MTk1YTM2MzQwNzk5MDM1YTY0YWU3YjgwZTU0
+    NzQ0MzlmNWE4YTc0MDhkZTE2MzkyNmRhMDdkN2FhODBmNTMxNzM=

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 .env
 .ruby-version
 .versions.conf
+Lionelfile

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+
+0.2.0 - January 8, 2014
+
+* Configurable export
+
+0.1.0 - July 11, 2013
+
+* Command line interface
+* Trello and Google integration
+* Initial release

data/README.md

@@ -1,10 +1,12 @@
 # LionelRichie
 
-LionelRichie is a script for exporting Trello data to Google Docs. 
+[![Code Climate](https://codeclimate.com/github/rossta/lionel_richie.png)](https://codeclimate.com/github/rossta/lionel_richie)
+
+LionelRichie is a script for exporting Trello data to Google Docs.
 
 This gem is in its very early stages so its probably not useful to you yet.
 
-![lionel](https://www.evernote.com/shard/s111/sh/86ca745b-4e7e-4b06-9fd2-32112436c72b/19b422ac7bab8162f9268be34be85b2d/res/03b54478-c928-4732-8d6a-4b56bcc205dc/lionel-richie-trello.jpg?resizeSmall&width=832)
+![Trello? Is it me you're looking for?](https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRmSbZ56riC_raK-rR4HiV4YKjvXTTUQy4_GCpPAYqdSkCz3RhO)
 
 ## Installation
 
@@ -42,58 +44,61 @@ You'll then be directed to authorize the application and retrieve your google to
 
 You should now be ready to run the export:
 
-    $ lionel export           # uploads to your google doc
-    $ lionel export --print   # prints the output without uploading
+    $ lionel export                         # uploads to your google doc
+    $ lionel export --print                 # prints the output without uploading
+    $ lionel export -c ./path/to/Lionelfile # uploads export configured by given Lionelfile
 
 When running this command for the first time, you'll be asked to enter your trello board id and google doc id, which you can grab from the respective URLs of those resources.
 
 Run `lionel` to see a list of the available commands and options.
 
-## Crafting the Export (Doesn't exist yet)
+## Crafting the Export
 
-```ruby
+The export can be configured using the export DSL. Export methods take the form of a Google doc column, e.g. 'A', 'BC', etc. To set the value on a column, pass a value or a block. The block is rendered in the context of each `Card` object populated with data from Trello.
 
+```ruby
+# Lionelfile
 LionelRichie.export do
   # Card Id
-  b { id }
+  B { id }
 
   # Card Link
-  c { link }
+  C { link }
 
   # Ready date
-  d do
-    ready_action = card.first_action do |a|
-      (a.create? && a.board_id == trello_board_id) || a.moved_to?("Ready")
+  D do |export|
+    ready_action = first_action do |a|
+      (a.create? && a.board_id == export.trello_board_id) || a.moved_to?("Ready")
     end
     format_date(ready_action.date) if ready_action
   end
 
   # In Progress date
-  e { date_moved_to("In Progress") }
+  E { date_moved_to("In Progress") }
 
   # Code Review date
-  f { date_moved_to("Code Review") }
+  F { date_moved_to("Code Review") }
 
   # Review date
-  g { date_moved_to("Review") }
+  G { date_moved_to("Review") }
 
   # Deploy date
-  h { date_moved_to("Deploy") }
+  H { date_moved_to("Deploy") }
 
   # Completed date
-  i { date_moved_to("Completed") }
+  I { date_moved_to("Completed") }
 
   # Type
-  j { type }
+  J { type }
 
   # Project
-  k { project }
+  K { project }
 
   # Estimate
-  l { estimate }
+  L { estimate }
 
   # Due Date
-  m { due_date }
+  M { due_date }
 end
 ```
 

data/bin/lionel

@@ -19,30 +19,4 @@ def pute(*args)
   $stderr.puts(*args)
 end
 
-begin
-  Lionel::CLI.start(ARGV)
-
-rescue GoogleDrive::Error, GoogleDrive::AuthenticationError => e
-  @attempts ||= 0
-  @attempts += 1
-  Lionel::GoogleAuthentication.new.refresh
-  if @attempts < 2
-    retry
-  else
-    puts e.class
-    puts "-" * e.class.name.size
-    pute e.message
-    puts "Unable to access Google Drive"
-    puts "run 'lionel authorize google'"
-  end
-
-rescue Trello::Error, Trello::InvalidAccessToken => e
-  puts "Unable to access Trello"
-  puts "run 'lionel authorize trello'"
-
-rescue StandardError => e
-  puts e.class
-  puts "-" * e.class.name.size
-  pute e.message
-  raise e
-end
+Lionel::CLI.start(ARGV)

data/examples/Lionelfile.kanban.rb

@@ -0,0 +1,41 @@
+Lionel.export do
+  B { id }
+
+  # Card link
+  C { link(name.gsub(/^\[.*\]\s*/, "")) }
+
+  # Ready date
+  D do |export|
+    ready_action = first_action do |a|
+      (a.create? && a.board_id == export.trello_board_id) || a.moved_to?("Ready")
+    end
+    format_date(ready_action.date) if ready_action
+  end
+
+  # In Progress date
+  E { date_moved_to("In Progress") }
+
+  # Code Review date
+  F { date_moved_to("Code Review") }
+
+  # Review date
+  G { date_moved_to("Review") }
+
+  # Deploy date
+  H { date_moved_to("Deploy") }
+
+  # Completed date
+  I { date_moved_to("Completed") }
+
+  # Type
+  J { type }
+
+  # Project
+  K { project }
+
+  # Estimate
+  L { estimate }
+
+  # Due Date
+  M { due_date }
+end

data/lib/lionel.rb

@@ -4,11 +4,13 @@ require 'google_drive'
 require 'launchy'
 require 'thor'
 require 'logger'
+require 'forwardable'
 require 'lionel/version'
 require 'lionel/cli'
 require 'lionel/configuration'
 require 'lionel/configurable'
 require 'lionel/export'
+require 'lionel/export_builder'
 require 'lionel/proxy_action'
 require 'lionel/proxy_card'
 require 'lionel/proxy_worksheet'
@@ -16,6 +18,10 @@ require 'lionel/trello_authentication'
 require 'lionel/google_authentication'
 
 module Lionel
+  Error = Class.new(StandardError)
+  ColumnNameError = Class.new(Error)
+  MissingBuilderError = Class.new(Error)
+
   extend self
   attr_accessor :logger
 
@@ -25,6 +31,11 @@ module Lionel
     end
     @logger = logger
   end
+
+  def export(&block)
+    Export.builder = ExportBuilder.build(&block)
+  end
+
 end
 
 Lionel.logger = Logger.new(STDOUT)

data/lib/lionel/cli.rb

@@ -41,9 +41,13 @@ module Lionel
     method_option "print", :aliases => "-p", :type => :boolean, :default => false, :desc => "Print results instead of saving them to Google Docs."
     method_option "trello-board-id", :aliases => "-t", :type => :string, :default => nil, :desc => "Specify the source Trello board id."
     method_option "google-doc-id", :aliases => "-g", :type => :string, :default => nil, :desc => "Specify the target Google doc id."
-    method_option "save", :aliases => "-c", :type => :string, :default => true, :desc => "Save the command line ids as the default configuration."
+    method_option "save", :aliases => "-s", :type => :string, :default => true, :desc => "Save the command line ids as the default configuration."
     method_option "filter", :aliases => "-f", :type => :string, :default => 'open-lists', :desc => "Possible values: open-cards, open-lists."
+    method_option "configuration", :aliases => "-c", :type => :string, :default => nil, :desc => "Path to Lionelfile configuration"
     def export
+      lionel_file = options['configuration'] || './Lionelfile'
+      eval(File.read(lionel_file)) if File.exists?(lionel_file)
+
       export = Lionel::Export.new(options)
 
       if options['google-doc-id']
@@ -69,10 +73,10 @@ module Lionel
         if @google_attempts < 2
           retry
         else
-          invoke :authorize, ['google']
+          invoke :authorize, ['google'], {}
         end
       rescue Trello::Error, Trello::InvalidAccessToken
-        invoke :authorize, ['trello']
+        invoke :authorize, ['trello'], {}
       end
 
       welcome = "Trello? Is it me you're looking for?"

data/lib/lionel/configuration.rb

@@ -4,6 +4,7 @@ require 'ostruct'
 module Lionel
   class Configuration
     include Singleton
+    extend Forwardable
     attr_reader :path, :data
 
     FILE_NAME = '.lionelrc'
@@ -15,7 +16,7 @@ module Lionel
     ]
 
     def self.config_accessor(*args)
-      delegate(*args, to: :data)
+      def_delegators :data, *args
 
       args.each do |accessor|
         define_method("#{accessor}=") do |value|

data/lib/lionel/export.rb

@@ -6,6 +6,14 @@ module Lionel
 
     config_accessor :google_doc_id, :trello_board_id
 
+    def self.builder=(builder)
+      @builder = builder
+    end
+
+    def self.builder
+      @builder || ExportBuilder.default
+    end
+
     def initialize(options = {})
       @options = options
     end
@@ -48,24 +56,28 @@ module Lionel
       download
 
       if options['print']
-        rows.each { |row| Lionel.logger.info row.inspect }
+        Lionel.logger.info "DRY RUN..."
+        Lionel.logger.info "Results were not uploaded to Google Drive"
       else
+        Lionel.logger.info "Uploading..."
         upload
+        Lionel.logger.info "Done!"
       end
     end
 
     def download
+      raise_missing_builder_error unless builder
+
       Lionel.logger.info "Exporting trello board '#{board.name}' (#{trello_board_id}) to " + "google doc '#{spreadsheet.title}' (#{google_doc_id})"
 
       card_map.each do |row, card|
         begin
-          Timeout.timeout(5) {
-            Lionel.logger.info "row[#{row}] = #{card.name}"
-
-            sync_columns(card).each do |col, value|
+          Timeout.timeout(5) do
+            row_data = card_columns(card).map do |col, value|
               worksheet[col,row] = value
-            end
-          }
+            end.join(" | ")
+            Lionel.logger.info "row[#{row}]: " + row_data
+          end
         rescue Timeout::Error, Trello::Error => e
           Lionel.logger.warn e.inspect
           Lionel.logger.warn card.inspect
@@ -85,48 +97,22 @@ module Lionel
       worksheet.rows
     end
 
-    def sync_columns(card)
-      {}.tap do |columns|
-        columns["B"] = card.id
-
-        # Card link
-        columns["C"] = card.link(card.name.gsub(/^\[.*\]\s*/, ""))
+    def builder
+      self.class.builder
+    end
 
-        # Ready date
-        ready_action = card.first_action do |a|
-          (a.create? && a.board_id == trello_board_id) || a.moved_to?("Ready")
+    def card_columns(card)
+      card_column_rows[card.id] ||= {}.tap do |columns|
+        builder.columns.each do |col_name, block|
+          columns[col_name] = card.instance_exec(self, &block)
         end
-        columns["D"] = card.format_date(ready_action.date) if ready_action
-
-        # In Progress date
-        columns["E"] = card.date_moved_to("In Progress")
-
-        # Code Review date
-        columns["F"] = card.date_moved_to("Code Review")
-
-        # Review date
-        columns["G"] = card.date_moved_to("Review")
-
-        # Deploy date
-        columns["H"] = card.date_moved_to("Deploy")
-
-        # Completed date
-        columns["I"] = card.date_moved_to("Completed")
-
-        # Type
-        columns["J"] = card.type
-
-        # Project
-        columns["K"] = card.project
-
-        # Estimate
-        columns["L"] = card.estimate
-
-        # Due Date
-        columns["M"] = card.due_date
       end
     end
 
+    def card_column_rows
+      @card_column_rows ||= {}
+    end
+
     def authenticate
       return if @authenticated
       authenticate_trello
@@ -166,6 +152,19 @@ module Lionel
       end
     end
 
+    def raise_missing_builder_error
+      message = <<-ERROR.gsub(/^ {6}/, '')
+        The export is not configured. Example:
+
+        Lionel.export do
+          A { id }
+          B { name }
+          C { url }
+        end
+      ERROR
+      raise MissingBuilderError.new(message)
+    end
+
     class CardMap
       include Enumerable
 
@@ -186,10 +185,9 @@ module Lionel
       private
 
       def populate_rows
-        Lionel.logger.info "Using CardMap!!!!"
         {}.tap do |card_rows|
 
-          start_row = 2
+          start_row = 2 # Currently assumes a header column
           rows = worksheet.size
 
           # Find existing rows for current cards
@@ -210,5 +208,6 @@ module Lionel
         end
       end
     end
+
   end
 end

data/lib/lionel/export_builder.rb

@@ -0,0 +1,35 @@
+module Lionel
+  class ExportBuilder
+
+    def self.build(&block)
+      new.configure(&block)
+    end
+
+    def self.default
+      build do
+        A { id }
+        B { name }
+        C { url }
+      end
+    end
+
+    def configure(&block)
+      instance_eval(&block)
+      self
+    end
+
+    def columns
+      @columns ||= {}
+    end
+
+    def method_missing(sym, *args, &block)
+      column_name = sym.to_s.upcase
+      if column_name =~ /\A[A-Z]+\z/
+        columns[sym.to_s.upcase] = block_given? ? block : lambda { args.first }
+      else
+        raise ColumnNameError.new("Method '#{sym}' does not represent a valid Google Spreadsheet column name")
+      end
+    end
+
+  end
+end

data/lib/lionel/google_authentication.rb

@@ -25,7 +25,7 @@ module Lionel
       return false unless refresh_token
 
       current_token = OAuth2::AccessToken.from_hash(client,
-          {:refresh_token => refresh_token, :expires_at => 36000})
+          {:refresh_token => refresh_token, :expires_at => 604800}) # 1 week
       @access_token = current_token.refresh! # returns new access_token
     end
 

data/lib/lionel/proxy_action.rb

@@ -1,7 +1,9 @@
 module Lionel
   class ProxyAction
+    extend Forwardable
+
     attr_reader :action
-    delegate :data, :type, :date, to: :action
+    def_delegators :action, :data, :type, :date
 
     def initialize(action)
       @action = action

data/lib/lionel/proxy_card.rb

@@ -1,7 +1,10 @@
 module Lionel
   class ProxyCard
+    extend Forwardable
+
     attr_reader :card
-    delegate :id, :url, :name, :due, to: :card
+
+    def_delegators :card, :id, :url, :name, :due
 
     def initialize(card)
       @card = card
@@ -51,7 +54,7 @@ module Lionel
     end
 
     def estimate
-      match = card.name.match(/\[(?<estimate>\w)\]/)
+      match = card.name.match(/\[(?<estimate>\w+)\]/)
       return "" unless match
       match[:estimate]
     end

data/lib/lionel/proxy_worksheet.rb

@@ -1,7 +1,9 @@
 module Lionel
   class ProxyWorksheet
-    delegate :rows, :save, to: :worksheet
-    delegate :size, to: :rows
+    extend Forwardable
+
+    def_delegators :worksheet, :rows, :save
+    def_delegators :rows, :size
 
     attr_reader :worksheet
     def initialize(worksheet)

data/lib/lionel/version.rb

@@ -1,3 +1,3 @@
 module Lionel
-  VERSION = "0.1.5.1"
+  VERSION = "0.2.0"
 end

data/lionel_richie.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "google_drive"
   spec.add_dependency "yajl-ruby"
   spec.add_dependency "thor"
+  spec.add_dependency "faraday", "~> 0.8"
   spec.add_dependency "launchy"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/spec/lib/lionel/export_builder_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Lionel::ExportBuilder do
+  let(:builder) { described_class.new }
+
+  describe "configure" do
+    it "accepts block for column" do
+      builder.configure do
+        A { "123" }
+      end
+
+      builder.columns["A"].call.should eq("123")
+    end
+
+    it "accepts hard-coded value" do
+      builder.configure do
+        A "123"
+      end
+
+      builder.columns["A"].call.should eq("123")
+    end
+
+    it "raises error if not a column name (only letters)" do
+      expect { builder.configure { x123 "123" } }.to raise_error(Lionel::ColumnNameError)
+    end
+  end
+end

data/spec/lib/lionel/export_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Lionel::Export do
-
   describe "configuration" do
     before(:each) do
       subject.trello_board_id = "TRELLO_BOARD_ID"

data/spec/lib/lionel_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Lionel do
+  TestCard = Struct.new(:id, :name, :url)
+
+  describe "self.export" do
+    it "configures the export builder" do
+      card = TestCard.new(123, "Testing cards", "http://example.com")
+
+      Lionel.export do
+        A { id }
+        B { name }
+        C { url }
+      end
+
+      builder = Lionel::Export.builder
+
+      card.instance_eval(&builder.columns["A"]).should eq(123)
+      card.instance_eval(&builder.columns["B"]).should eq("Testing cards")
+      card.instance_eval(&builder.columns["C"]).should eq("http://example.com")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lionel_richie
 version: !ruby/object:Gem::Version
-  version: 0.1.5.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ross Kaffenberger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-trello
@@ -66,6 +66,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -132,17 +146,20 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/lionel
+- examples/Lionelfile.kanban.rb
 - lib/lionel.rb
 - lib/lionel/cli.rb
 - lib/lionel/configurable.rb
 - lib/lionel/configuration.rb
 - lib/lionel/export.rb
+- lib/lionel/export_builder.rb
 - lib/lionel/google_authentication.rb
 - lib/lionel/proxy_action.rb
 - lib/lionel/proxy_card.rb
@@ -152,9 +169,11 @@ files:
 - lib/lionel_richie.rb
 - lionel_richie.gemspec
 - script/console
+- spec/lib/lionel/export_builder_spec.rb
 - spec/lib/lionel/export_spec.rb
 - spec/lib/lionel/google_authentication_spec.rb
 - spec/lib/lionel/trello_authentication_spec.rb
+- spec/lib/lionel_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -176,12 +195,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Export Trello to Google Docs
 test_files:
+- spec/lib/lionel/export_builder_spec.rb
 - spec/lib/lionel/export_spec.rb
 - spec/lib/lionel/google_authentication_spec.rb
 - spec/lib/lionel/trello_authentication_spec.rb
+- spec/lib/lionel_spec.rb
 - spec/spec_helper.rb