slack_trello 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c412d076e38c5e27813959ae64e1db1c0daeb607
-  data.tar.gz: e714b20fe5e54749f90f046b84cf76b5fa272b51
+  metadata.gz: 26f2990100c4de1e0af8d6b3636450be18c240ce
+  data.tar.gz: d9666f4d7cdff344148a142767525ed002379469
 SHA512:
-  metadata.gz: 173e23b8b2c3f2384dbad5cef280f64c99a69bc81645510f38b071952528290424bc32c2696f119065fecacac42e4e99bad9b49c3f645da0c1e40d9784a4726d
-  data.tar.gz: 53b536445db574c7352d456a1c258c8a2fbc3f221a2608c499e58521e81c2d1d4571480c68336595b1bbdab0c565458e956321cb43606f834b8a1e0d058b1171
+  metadata.gz: b1c6b60e941556fe2f58db30341857a0371ce1a6492646dc4db57fd8b483da463731a893123aaf653e5fad147c2f9e76165452eca019ca7ecf7ce80ff18175dd
+  data.tar.gz: 446fbd9e29a3704095b75ea9c00986a91cbfadacf1722ee9fe5ad71273a3db7d1050c457f5387b88cf95dcc7916b547a2dc550fe2f347d3eb0f3b16ee3ed82bb

data/README.md

@@ -2,6 +2,84 @@
 
 The slack_trello gem makes it easy to parse POST requests sent to a Ruby application by the Slack API.  The gem is geared towards making Trello cards based on Slack POST requests, but the core modules and classes are generic and can be repourposed for other tasks as well.
 
+The Slack [slash commands](https://api.slack.com/slash-commands) send POST requests like this:
+
+```ruby
+{
+  "token" => "gIkuvaNzQIHg97ATvDxqgjtO",
+  "team_id" => "T0001",
+  "team_domain" => "example",
+  "channel_id" => "C2147483705",
+  "channel_name" => "test",
+  "user_id" => "U2147483697",
+  "user_name" => "Steve",
+  "command" => "/some_command",
+  "text" => "(some_arg another_arg) some stuff blah"
+}
+```
+
+The slack_trello gem parses these POST params and makes Trello cards.
+
+### Work Command
+
+Example usage of this command in Slack (assume the command is run in the #pandas channel):
+
+```
+/work Do some important stuff
+```
+
+This will create a Trello card in the From Chat list of the Pandas Backlog Trello board.  The code can be invoked as follows:
+
+```ruby
+SlackTrello::Commands::Work.new(params, ENV["SLACK_WEBHOOK_URL"]).run
+```
+
+### Retro Command
+
+Example usage of this command in Slack (assume the command is run in the #pandas channel):
+
+```
+/retro (questions) Why are we building that feature?
+```
+
+This will create a Trello card in the Questions list of the Pandas Retro Trello board.  The code can be invoked as follows:
+
+```ruby
+SlackTrello::Commands::Retro.new(params, ENV["SLACK_WEBHOOK_URL"]).run
+```
+
+### Card Command
+
+Example usage of this command in Slack (this command can run in any channel and function the same):
+
+```
+/card (pandaland on_deck) Build a cool cmap
+```
+
+This will create a Trello card in the On Deck list of the Pandaland Trello board.  The code can be invoked as follows:
+
+```ruby
+SlackTrello::Commands::Card.new(params, ENV["SLACK_WEBHOOK_URL"]).run
+```
+
+### CopyCards Command
+
+Example usage of this command in Slack (this command can run in any channel and function the same):
+
+```
+/copy_cards (recurring_engineering pandas pandaland on_deck)
+```
+
+This will copy all the cards from the the Pandas list of the Recurring Engineering Trello board to the On Deck list of the Pandaland Trello board.  The code can be invoked as follows:
+
+```ruby
+SlackTrello::Commands::CopyCards.new(params, ENV["SLACK_WEBHOOK_URL"]).run
+```
+
+## Usage
+
+The [slack-responder](https://github.com/medivo/slack-responder) Rails application includes the slack_trello gem and demonstrates how a Rails application that responds to Slack POST requests can be set up.  Cloning the slack-responder application is the easiest way to get up-and-running with the slack_trello gem.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +96,3 @@ Or install it yourself as:
 
     $ gem install slack_trello
 
-## Usage
-
-The [slack-responder](https://github.com/medivo/slack-responder) Rails application includes the slack_trello gem and demonstrates how a Rails application that responds to Slack POST requests can be set up.  Cloning the slack-responder application is the easiest way to get up-and-running with the slack_trello gem.
-

data/lib/slack_trello.rb

@@ -1,19 +1,18 @@
+require 'ostruct'
+
 require "active_support/core_ext/string"
 require "slack-notifier"
 
 require "slack_trello/version"
-require "slack_trello/trello_lookup"
-require "slack_trello/text_parser"
-require "slack_trello/response_parser"
 
-require "slack_trello/create_trello_card"
-require "slack_trello/copy_cards"
-require "slack_trello/speaker"
+def require_all(pattern)
+  root = File.expand_path("../", File.dirname(__FILE__))
+  Dir.glob("#{root}/#{pattern}/**/*.rb").sort.each { |path| require path }
+end
 
-require "slack_trello/copy_cards_command"
-require "slack_trello/create_card_command"
-require "slack_trello/work_command"
-require "slack_trello/retro_command"
+require_all("lib/slack_trello/slack_helpers")
+require_all("lib/slack_trello/trello_helpers")
+require_all("lib/slack_trello/commands")
 
 module SlackTrello
 end

data/lib/slack_trello/{copy_cards_command.rb → commands/copy_cards.rb}

@@ -1,11 +1,11 @@
-module SlackTrello; class CopyCardsCommand
+module SlackTrello; module Commands; class CopyCards
 
-  include TextParser
+  include SlackTrello::SlackHelpers::TextParser
 
-  attr_reader :parser, :webhook_url
+  attr_reader :slack_post_response, :webhook_url
 
-  def initialize(args, webhook_url)
-    @parser = ResponseParser.new(args)
+  def initialize(slack_post_args, webhook_url)
+    @slack_post_response = OpenStruct.new(slack_post_args)
     @webhook_url = webhook_url
   end
 
@@ -22,7 +22,7 @@ module SlackTrello; class CopyCardsCommand
 
   def help_message
 %{:cry: Invalid format
-Your message: #{parser.text}
+Your message: #{slack_post_response.text}
 Example: /copy_cards (source_board, source_list, destination_board, destination_list)
 }
   end
@@ -30,10 +30,10 @@ Example: /copy_cards (source_board, source_list, destination_board, destination_
   def speaker
     args = {
       webhook_url: webhook_url,
-      channel: parser.channel_name,
-      username: parser.user_name
+      channel: slack_post_response.channel_name,
+      username: slack_post_response.user_name
     }
-    Speaker.new(args)
+    SlackTrello::SlackHelpers::Speaker.new(args)
   end
 
   def card_copier
@@ -63,8 +63,8 @@ Example: /copy_cards (source_board, source_list, destination_board, destination_
   end
 
   def success_message
-    ":mega: [#{parser.user_name}] has copied all the cards from the #{source_list_name} of the #{source_board_name} to the #{destination_list_name} of the #{destination_board_name}"
+    ":mega: [#{slack_post_response.user_name}] has copied all the cards from the #{source_list_name} of the #{source_board_name} to the #{destination_list_name} of the #{destination_board_name}"
   end
 
-end; end
+end; end; end
 

data/lib/slack_trello/{create_card_command.rb → commands/create_card.rb}

@@ -1,11 +1,11 @@
-module SlackTrello; class CreateCardCommand
+module SlackTrello; module Commands; class CreateCard
 
-  include TextParser
+  include SlackTrello::SlackHelpers::TextParser
 
-  attr_reader :parser, :webhook_url
+  attr_reader :slack_post_response, :webhook_url
 
-  def initialize(args, webhook_url)
-    @parser = ResponseParser.new(args)
+  def initialize(slack_post_args, webhook_url)
+    @slack_post_response = OpenStruct.new(slack_post_args)
     @webhook_url = webhook_url
   end
 
@@ -33,10 +33,10 @@ For example, Some Board Name => some_board_name
   def speaker
     args = {
       webhook_url: webhook_url,
-      channel: parser.channel_name,
-      username: parser.user_name
+      channel: slack_post_response.channel_name,
+      username: slack_post_response.user_name
     }
-    Speaker.new(args)
+    SlackTrello::SlackHelpers::Speaker.new(args)
   end
 
   def trello_card_creator
@@ -45,7 +45,7 @@ For example, Some Board Name => some_board_name
       list_name: trello_list_name,
       card_name: card_title
     }
-    @trello_card_creator ||= CreateTrelloCard.new(args)
+    @trello_card_creator ||= SlackTrello::TrelloHelpers::CreateCard.new(args)
   end
 
   def trello_card
@@ -65,16 +65,12 @@ For example, Some Board Name => some_board_name
   end
 
   def success_message
-    ":mega: [#{parser.user_name}] has created a new trello card: <#{trello_card.short_url}|#{parser.text.strip}>"
+    ":mega: [#{slack_post_response.user_name}] has created a new trello card: <#{trello_card.short_url}|#{slack_post_response.text.strip}>"
   end
 
   def card_title
     text_message
   end
 
-  def text
-    parser.text
-  end
-
-end; end
+end; end; end
 

data/lib/slack_trello/{retro_command.rb → commands/retro.rb}

@@ -1,11 +1,11 @@
-module SlackTrello; class RetroCommand
+module SlackTrello; module Commands; class Retro
 
-  include TextParser
+  include SlackTrello::SlackHelpers::TextParser
 
-  attr_reader :parser, :webhook_url
+  attr_reader :slack_post_response, :webhook_url
 
-  def initialize(args, webhook_url)
-    @parser = ResponseParser.new(args)
+  def initialize(slack_post_args, webhook_url)
+    @slack_post_response = OpenStruct.new(slack_post_args)
     @webhook_url = webhook_url
   end
 
@@ -34,10 +34,10 @@ For example, Some List Name => some_list_name
   def speaker
     args = {
       webhook_url: webhook_url,
-      channel: parser.channel_name,
-      username: parser.user_name
+      channel: slack_post_response.channel_name,
+      username: slack_post_response.user_name
     }
-    Speaker.new(args)
+    SlackTrello::SlackHelpers::Speaker.new(args)
   end
 
   def trello_card_creator
@@ -46,7 +46,7 @@ For example, Some List Name => some_list_name
       list_name: trello_list_name,
       card_name: card_title
     }
-    @trello_card_creator ||= CreateTrelloCard.new(args)
+    @trello_card_creator ||= SlackTrello::TrelloHelpers::CreateCard.new(args)
   end
 
   def trello_card
@@ -54,7 +54,7 @@ For example, Some List Name => some_list_name
   end
 
   def trello_board_name
-    "#{parser.channel_name.titleize} Retro"
+    "#{slack_post_response.channel_name.titleize} Retro"
   end
 
   def trello_list_name
@@ -66,15 +66,11 @@ For example, Some List Name => some_list_name
   end
 
   def success_message
-    ":mega: [#{parser.user_name}] has created a new trello card: <#{trello_card.short_url}|#{parser.text.strip}>"
+    ":mega: [#{slack_post_response.user_name}] has created a new trello card: <#{trello_card.short_url}|#{slack_post_response.text.strip}>"
   end
 
   def card_title
-    "#{text_message} -- #{parser.user_name}"
-  end
-
-  def text
-    parser.text
+    "#{text_message} -- #{slack_post_response.user_name}"
   end
 
   def list_names
@@ -83,5 +79,5 @@ For example, Some List Name => some_list_name
     end
   end
 
-end; end
+end; end; end
 

data/lib/slack_trello/{work_command.rb → commands/work.rb}

@@ -1,9 +1,9 @@
-module SlackTrello; class WorkCommand
+module SlackTrello; module Commands; class Work
 
-  attr_reader :parser, :webhook_url
+  attr_reader :slack_post_response, :webhook_url
 
-  def initialize(args, webhook_url)
-    @parser = ResponseParser.new(args)
+  def initialize(slack_post_args, webhook_url)
+    @slack_post_response = OpenStruct.new(slack_post_args)
     @webhook_url = webhook_url
   end
 
@@ -20,10 +20,10 @@ module SlackTrello; class WorkCommand
   def speaker
     args = {
       webhook_url: webhook_url,
-      channel: parser.channel_name,
-      username: parser.user_name
+      channel: slack_post_response.channel_name,
+      username: slack_post_response.user_name
     }
-    Speaker.new(args)
+    SlackTrello::SlackHelpers::Speaker.new(args)
   end
 
   def trello_card_creator
@@ -32,7 +32,7 @@ module SlackTrello; class WorkCommand
       list_name: trello_list_name,
       card_name: card_title
     }
-    @trello_card_creator ||= CreateTrelloCard.new(args)
+    @trello_card_creator ||= SlackTrello::TrelloHelpers::CreateCard.new(args)
   end
 
   def trello_card
@@ -40,7 +40,7 @@ module SlackTrello; class WorkCommand
   end
 
   def trello_board_name
-    "#{parser.channel_name.titleize} Backlog"
+    "#{slack_post_response.channel_name.titleize} Backlog"
   end
 
   def trello_list_name
@@ -52,12 +52,12 @@ module SlackTrello; class WorkCommand
   end
 
   def success_message
-    ":mega: [#{parser.user_name}] has created a new work card: <#{trello_card.short_url}|#{parser.text.strip}>"
+    ":mega: [#{slack_post_response.user_name}] has created a new work card: <#{trello_card.short_url}|#{slack_post_response.text.strip}>"
   end
 
   def card_title
-    "(UNSIZED) #{parser.text.strip} {tag???}"
+    "(UNSIZED) #{slack_post_response.text.strip} {tag???}"
   end
 
-end; end
+end; end; end
 

data/lib/slack_trello/{speaker.rb → slack_helpers/speaker.rb}

@@ -1,4 +1,4 @@
-module SlackTrello; class Speaker
+module SlackTrello; module SlackHelpers; class Speaker
 
   def initialize(args)
     @webhook_url = args.fetch(:webhook_url)
@@ -20,4 +20,5 @@ module SlackTrello; class Speaker
     @channel.start_with?("#") ? @channel : "##{@channel}"
   end
 
-end; end
+end; end; end
+

data/lib/slack_trello/{text_parser.rb → slack_helpers/text_parser.rb}

@@ -1,4 +1,4 @@
-module SlackTrello; module TextParser
+module SlackTrello; module SlackHelpers; module TextParser
 
   def args
     return "" unless valid_text_format?
@@ -18,8 +18,6 @@ module SlackTrello; module TextParser
     args.length
   end
 
-  private
-
   def regex
     /\((.+?)\)(.+)?/
   end
@@ -28,6 +26,9 @@ module SlackTrello; module TextParser
     text.match(regex)
   end
 
-end; end
+  def text
+    slack_post_response.text
+  end
 
+end; end; end
 

data/lib/slack_trello/{copy_cards.rb → trello_helpers/copy_cards.rb}

@@ -1,4 +1,4 @@
-module SlackTrello; class CopyCards
+module SlackTrello; module TrelloHelpers; class CopyCards
 
   attr_reader :source_board, :source_list, :destination_board, :destination_list
 
@@ -11,16 +11,15 @@ module SlackTrello; class CopyCards
 
   def run
     source_cards.each do |source_card|
-      creator = CreateTrelloCard.new(board_name: destination_board, list_name: destination_list, card_name: source_card.name)
+      creator = CreateCard.new(board_name: destination_board, list_name: destination_list, card_name: source_card.name)
       creator.first_or_create
     end
   end
 
   def source_cards
-    l = TrelloLookup.list(source_board, source_list)
+    l = Lookup.list(source_board, source_list)
     l.cards
   end
 
-end; end
-
+end; end; end
 

data/lib/slack_trello/{create_trello_card.rb → trello_helpers/create_card.rb}

@@ -1,4 +1,4 @@
-module SlackTrello; class CreateTrelloCard
+module SlackTrello; module TrelloHelpers; class CreateCard
 
   attr_reader :board_name, :list_name, :card_name
 
@@ -9,7 +9,7 @@ module SlackTrello; class CreateTrelloCard
   end
 
   def first_or_create
-    card = TrelloLookup.card(board_name, list_name, card_name)
+    card = Lookup.card(board_name, list_name, card_name)
     return card if card
     create_card
   end
@@ -22,8 +22,8 @@ module SlackTrello; class CreateTrelloCard
   end
 
   def trello_list
-    TrelloLookup.list(board_name, list_name)
+    Lookup.list(board_name, list_name)
   end
 
-end; end
+end; end; end
 

data/lib/slack_trello/{trello_lookup.rb → trello_helpers/lookup.rb}

@@ -1,4 +1,4 @@
-module SlackTrello; class TrelloLookup
+module SlackTrello; module TrelloHelpers; class Lookup
 
   class << self
 
@@ -28,5 +28,5 @@ module SlackTrello; class TrelloLookup
 
   end
 
-end; end
+end; end; end
 

data/lib/slack_trello/version.rb

@@ -1,3 +1,3 @@
 module SlackTrello
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_trello
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matthew Powers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,17 +98,16 @@ files:
 - bin/console
 - bin/setup
 - lib/slack_trello.rb
-- lib/slack_trello/copy_cards.rb
-- lib/slack_trello/copy_cards_command.rb
-- lib/slack_trello/create_card_command.rb
-- lib/slack_trello/create_trello_card.rb
-- lib/slack_trello/response_parser.rb
-- lib/slack_trello/retro_command.rb
-- lib/slack_trello/speaker.rb
-- lib/slack_trello/text_parser.rb
-- lib/slack_trello/trello_lookup.rb
+- lib/slack_trello/commands/copy_cards.rb
+- lib/slack_trello/commands/create_card.rb
+- lib/slack_trello/commands/retro.rb
+- lib/slack_trello/commands/work.rb
+- lib/slack_trello/slack_helpers/speaker.rb
+- lib/slack_trello/slack_helpers/text_parser.rb
+- lib/slack_trello/trello_helpers/copy_cards.rb
+- lib/slack_trello/trello_helpers/create_card.rb
+- lib/slack_trello/trello_helpers/lookup.rb
 - lib/slack_trello/version.rb
-- lib/slack_trello/work_command.rb
 - slack_trello.gemspec
 homepage: https://github.com/MrPowers/slack_trello
 licenses:

data/lib/slack_trello/response_parser.rb

@@ -1,14 +0,0 @@
-module SlackTrello; class ResponseParser
-
-  attr_reader :args
-
-  def initialize(args)
-    @args = args
-  end
-
-  def method_missing(name)
-    super unless args.has_key?(name.to_s)
-    args.fetch(name.to_s)
-  end
-
-end; end