lita-flowdock 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd90cf335f976ea77188bfc0c4a2d24ced729245
-  data.tar.gz: 553087cdca235214d0d402a3f2a8f0d153d94a2a
+  metadata.gz: d17560dac166db8aa3752365bcbfb733d07f37ec
+  data.tar.gz: 4e78edc712c4f725cfa939510e57cd61b44d9803
 SHA512:
-  metadata.gz: 34370d1303bb6c60f3e865b21b9658560eee8b9bda64e59c330ae3963b83e533943724b5444a4cc3724691c959f1b4b1f1e3b2582c982b9f117b30b8d0e72091
-  data.tar.gz: e16d9e9248541766d5e08461dbfd1c57852b7c1db4f8f92415c967b8177dbded3451d90f8d43db8631e9f5a5cb84e66a44551da25d9b469bca21fabc5a580ba3
+  metadata.gz: 124a803f2ff0243fd3b612ca678e48956f896cff9c12225d7f5163bb029adcf006ff792a7e6cef8ed525dd5768233181954fcb53e9b7fcfa3fb8a1a1cb91974b
+  data.tar.gz: d12dfe101062b92c469c7fb9e5d1d37581ea5c45bb83f82fb42b2594a9fbd50081522d79a2dc856108b87cc45ead652be9c2eff406282143e28aa2239619d36e

data/GETTING_STARTED.md

@@ -0,0 +1,75 @@
+# Getting Started
+
+## Flowdock setup
+
+1. Create a new Flowdock user for your bot and sign-in as the bot
+1. Get the Personal API token for the bot from the [API tokens](https://flowdock.com/account/tokens) page.
+1. Invite the bot account to the flows it should monitor
+
+## Bot setup
+
+Development can be done using vagrant and the [development-environment](https://github.com/litaio/development-environment) supplied by the lita project.
+
+See the [getting started](http://docs.lita.io/getting-started/installation/) docs page on the lita site for more information.
+
+Assuming you have vagrant installed:
+
+```shell
+git clone https://github.com/litaio/development-environment ~/lita-dev
+cd ~/lita-dev
+vagrant up
+vagrant ssh
+```
+
+Once you're logged into the vagrant vm:
+
+```shell
+export $BOT_NAME=<name of the bot>
+export $ORG=<flowdock organization name>
+export $FLOW_NAME=<flowdock flow name>
+export $FLOWDOCK_API_TOKEN=<flowdock bot's personal api token>
+```
+
+```shell
+cd /vagrant
+lita new .
+echo 'gem "lita-whois"' >> Gemfile
+echo 'gem "lita-flowdock"' >> Gemfile
+cat << EOF > lita_config.rb
+Lita.configure do |config|
+  config.robot.name = "$BOT_NAME"
+  config.robot.mention_name = "!"
+  config.robot.log_level = :debug
+  config.robot.adapter = :flowdock
+  config.adapters.flowdock.api_key = "$FLOWDOCK_API_TOKEN"
+  config.adapters.flowdock.organization = "$ORG"
+  config.adapters.flowdock.flows = ["$FLOW_NAME"]
+end
+EOF
+apt-get update && apt-get install build-essential -y
+bundle install --path vendor/bundle
+bundle update
+bundle exec lita
+```
+
+## Test it out
+
+In flowdock, try
+
+```
+!help
+
+<should output help for lita commands>
+
+!whois github.com
+
+Whois Server Version 2.0
+
+Domain names in the .com and .net domains can now be registered
+with many different competing registrars. Go to http://www.internic.net
+for detailed information.
+...
+```
+
+# Production
+For a production setup, try the [chef cookbook](https://github.com/litaio/chef-lita) for lita

data/README.md

@@ -3,41 +3,49 @@
 [![Build Status](https://travis-ci.org/bhouse/lita-flowdock.svg?branch=master)](https://travis-ci.org/bhouse/lita-flowdock)
 [![Coverage Status](https://coveralls.io/repos/bhouse/lita-flowdock/badge.svg?branch=master)](https://coveralls.io/r/bhouse/lita-flowdock?branch=master)
 
-## Testing
-```shell
-git clone https://github.com/litaio/development-environment ~/lita-dev
-git clone git@github.com:bhouse/lita-flowdock.git ~/lita-dev/lita-flowdock
-cd ~/lita-dev
-vagrant up
-vagrant ssh
-```
+## Welcome!
+
+
+[Lita](https://lita.io) is a chat service bot, similar to [hubot](http://hubot.github.com), but written in ruby. **lita-flowdock** is an adapter to connect Lita to the [Flowdock](http://flowdock.com) chat service.
+
+### Disclaimer
+This code is heavily based on the awesome work by [kenjij](https://github.com/kenjij) and [jimmycuadra](https://github.com/jimmycuadra) in the [lita-slack](https://github.com/kenjij/lita-slack) adapter. Changes were made for the difference in the API's between the services.
+
+Slack uses a bi-directional Websockets API for listening to and posting messages, whereas Flowdock uses a one-way [Server-Sent Events](https://www.flowdock.com/api/streaming) stream for listening in real-time, and a [REST API](https://www.flowdock.com/api/rest) for posting messages.
+
+
+## Installation
 
-On the vagrant vm:
+Add lita-flowdock to your Lita instance's Gemfile:
 
-```shell
-export $ORG=<flowdock organization name>
-export $FLOW_NAME=<flowdock flow name>
-export $FLOW_API_TOKEN=<flowdock flow api token>
+``` ruby
+gem "lita-flowdock"
 ```
 
-```shell
-cd /vagrant
-lita new .
-echo 'gem "lita-whois"' >> Gemfile
-echo 'gem "lita-flowdock", git: "git@github.com:bhouse/lita-flowdock.git", branch: "master"' >> Gemfile
-bundle config local.lita-flowdock /vagrant/lita-flowdock
-cat << EOF > lita_config.rb
+For quick setup, see the [Getting Started](https://github.com/bhouse/lita-flowdock/tree/master/GETTING_STARTED.md) page.
+
+## Configuration
+
+### Required Attributes
+* `api_token` (String) - The bot's personal API token
+ * Login to https://flowdock.com with the bot account
+ * Get the personal API token from https://flowdock.com/account/tokens
+* `organization` (String) - The organization for the flowdock account
+* `flows` (Array) - Array of flows the bot should connect to, i.e. `main`
+
+### Example
+
+```ruby
 Lita.configure do |config|
-  config.robot.name = "Lita"
-  config.robot.log_level = :info
   config.robot.adapter = :flowdock
-  config.adapters.flowdock.api_key = "$FLOW_API_TOKEN"
-  config.adapters.flowdock.organization = "$ORG"
-  config.adapters.flowdock.flows = ["$FLOW_NAME"]
+  config.robot.name = 'John_McClane'
+
+  config.robot.adapters.flowdock.api_token = '210bf4d1ae890b20265313fdc907903c'
+  config.robot.adapters.flowdock.organization = 'mycompany'
+  config.robot.adapters.flowdock.flows = ['main', 'ops']
 end
-EOF
-apt-get update && apt-get install build-essential -y
-bundle install --path vendor/bundle
-bundle update
-bundle exec lita
 ```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/lib/lita/adapters/flowdock.rb

@@ -7,9 +7,8 @@ module Lita
       namespace 'flowdock'
 
       config :api_token, type: String, required: true
-      config :bot_name, type: String, required: true
       config :organization, type: String, required: true
-      config :flows, type: [Symbol, Array], required: true
+      config :flows, type: Array, required: true
 
 
       def mention_format(name)
@@ -43,12 +42,7 @@ module Lita
       end
 
       private
-
         attr_reader :connector
-
-        def bot_name
-          config.bot_name
-        end
     end
 
     Lita.register_adapter(:flowdock, Flowdock)

data/lita-flowdock.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-flowdock"
-  spec.version       = "0.1.0"
+  spec.version       = "0.1.1"
   spec.authors       = ["Ben House"]
   spec.email         = ["ben@benhouse.io"]
   spec.description   = %q{flowdock adapter for lita.io}

data/spec/lita/adapters/flowdock/connector_spec.rb

@@ -9,12 +9,7 @@ describe Lita::Adapters::Flowdock::Connector, lita: true do
   let(:organization) { 'lita-test' }
   let(:flows) { ['testing'] }
   let(:fd_client) { instance_double('Flowdock::Client') }
-  let(:users) {
-    [
-      {'id' => 1, 'name' => 'Test User1', 'nick' => 'user1'},
-      {'id' => 2, 'name' => 'Test User2', 'nick' => 'user2'}
-    ]
-  }
+  let(:users) { [ user_hash(1), user_hash(2) ] }
 
   describe "#new" do
     it "creates users" do

data/spec/lita/adapters/flowdock/message_handler_spec.rb

@@ -12,9 +12,7 @@ describe Lita::Adapters::Flowdock::MessageHandler, lita: true do
     { 'id' => robot_id, 'name' => 'Lita', 'nick' => 'lita' }
   }
   let(:test_user_id) { 3 }
-  let(:test_fd_user) {
-    { 'id' => test_user_id, 'name' => 'Test User3', 'nick' => 'user3' }
-  }
+  let(:test_fd_user) { user_hash(3) }
   let(:test_flow) { 'testing:lita-test' }
 
   before do
@@ -37,7 +35,7 @@ describe Lita::Adapters::Flowdock::MessageHandler, lita: true do
       end
       let(:message) { instance_double('Lita::Message', command!: false) }
       let(:source) { instance_double('Lita::Source', private_message?: false) }
-      let(:user) { instance_double('Lita::User', id: test_user_id) }
+      let(:user) { user_double(test_user_id) }
 
       before do
         allow(Lita::User).to receive(:find_by_id).and_return(user)
@@ -103,7 +101,7 @@ describe Lita::Adapters::Flowdock::MessageHandler, lita: true do
           'user'    => robot_id
         }
       end
-      let(:robot_user) { instance_double('Lita::User', id: robot_id) }
+      let(:robot_user) { user_double(robot_id) }
 
       before do
         allow(Lita::User).to receive(:find_by_id).and_return(robot_user)
@@ -118,9 +116,7 @@ describe Lita::Adapters::Flowdock::MessageHandler, lita: true do
 
     context "a message from an unknown user" do
       let(:new_user_id) { 4 }
-      let(:new_fd_user) {
-        { 'id' => new_user_id, 'name' => 'Test User4', 'nick' => 'user4' }
-      }
+      let(:new_fd_user) { user_hash(4) }
 
 
       let(:data) do
@@ -131,9 +127,7 @@ describe Lita::Adapters::Flowdock::MessageHandler, lita: true do
           'user'    => new_user_id
         }
       end
-      let(:user4) { instance_double(
-        'Lita::User', id: 4, name: 'Test User4', mention_name: 'user4'
-      )}
+      let(:user4) { user_double(4) }
 
       before do
         allow(Lita::User).to receive(:find_by_id).with(
@@ -184,9 +178,7 @@ describe Lita::Adapters::Flowdock::MessageHandler, lita: true do
           }
         end
         let(:added_user_id) { 5 }
-        let(:added_user_fd) do
-          { 'id' => 5, 'name' => 'Test User5', 'nick' => 'user5' }
-        end
+        let(:added_user_fd) { user_hash(5) }
 
         before do
           allow(Lita::User).to receive(:find_by_id).with(5).and_return(nil)
@@ -206,9 +198,7 @@ describe Lita::Adapters::Flowdock::MessageHandler, lita: true do
 
       context "for a user joining the flow" do
         let(:joining_user_id) { 6 }
-        let(:joining_user_fd) do
-          { 'id' => 6, 'name' => 'Test User6', 'nick' => 'user6' }
-        end
+        let(:joining_user_fd) { user_hash(6) }
         let(:data) do
           {
             'content' => {'type' => 'join', 'description' => 'tbd'},

data/spec/lita/adapters/flowdock/users_creator_spec.rb

@@ -3,46 +3,32 @@ require 'spec_helper'
 describe Lita::Adapters::Flowdock::UsersCreator do
   subject { described_class }
 
-  def stubbed_user(id)
-    instance_double(
-      'Lita::User', id: id, name: "Test User#{id}", mention_name: "user#{id}"
-    )
-  end
-
   describe "#create_user" do
-    let(:user) do
-      {
-        'id'    => 1,
-        'name'  => 'Test User1',
-        'nick'  => 'user1'
-      }
-    end
+    let(:user1) { user_hash(1) }
 
     it "creates a single Lita user" do
       expect(Lita::User).to receive(:create).with(
         1,
-        { 'name' => 'Test User1', 'mention_name' => 'user1' }
-      ).and_return(stubbed_user(1))
+        {
+          'name' => 'Test User1',
+          'mention_name' => 'user1'
+        }).and_return(user_double(1))
 
-      subject.create_user(user)
+      subject.create_user(user1)
     end
   end
 
   describe "#create_users" do
-    let(:users) do
-      [
-        {'id' => 1, 'name' => 'Test User1', 'nick' => 'user1'},
-        {'id' => 2, 'name' => 'Test User2', 'nick' => 'user2'},
-        {'id' => 3, 'name' => 'Test User3', 'nick' => 'user3'}
-      ]
-    end
+    let(:users) { [ user_hash(1), user_hash(2), user_hash(3) ] }
 
     it "creates multiple Lita users" do
       (1..3).each do |id|
         expect(Lita::User).to receive(:create).with(
           id,
-          { 'name' => "Test User#{id}", 'mention_name' => "user#{id}" }
-        ).and_return(stubbed_user(id))
+          {
+            'name' => "Test User#{id}",
+            'mention_name' => "user#{id}"
+          }).and_return(user_double(id))
       end
 
       subject.create_users(users)

data/spec/spec_helper.rb

@@ -17,3 +17,13 @@ RSpec.configure do |config|
   config.color = true
   config.formatter = :documentation
 end
+
+def user_double(id)
+  instance_double(
+    'Lita::User', id: id, name: "Test User#{id}", mention_name: "user#{id}"
+  )
+end
+
+def user_hash(id)
+  { 'id' => id, 'name' => "Test User#{id}", "nick" => "user#{id}" }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-flowdock
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ben House
@@ -173,6 +173,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- GETTING_STARTED.md
 - Gemfile
 - LICENSE
 - README.md