lita-tweet 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2075bb6c559760c56f41340005b53999d1dfa134
-  data.tar.gz: dd51909e34b310662c31ae91b983a2937f7a2762
+  metadata.gz: 263cf1dd5488823347205ebf4056792676e7e3e4
+  data.tar.gz: 84a43ad8a14e1f04ae2d8bc76b41497be2b09e91
 SHA512:
-  metadata.gz: 838bd08b7db776304826b8211349c8d983c318fd95a5eb2e776b1fa096669c3481a0a6dd97cc6cb6da4ed37814c342b1e1802705c95365156b8e4aee432e227b
-  data.tar.gz: 87353ed0740d0b6673e24c2535b36e32608a16a4a6e5c084c24e4db00eb7e889e3c7a7e9f2a861a277f288d78506342ca8c6fa537f4a01cd4a07c662b3c98c80
+  metadata.gz: c6a3960e01053b68c3fb483f7b7ec6e7e7e0adb4fc8b35051cd924b7c5661172b3b6292f293f08fc0a6f6e9cabb8b8b296f1d577c055011e7dbf78cc865194ec
+  data.tar.gz: 14c659282690525c55dce342dab2f9bc3512619f77e6707dd2805ef64abc44f115b4c7e7c0a973e3c37837acfc8d1a5b85eca6ccc1232df8661926b2b164b27d

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.rspec_examples
 .yardoc
 Gemfile.lock
 InstalledFiles

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
 rvm:
   - 2.3.1
-script: bundle exec rake
-before_install:
-  - gem update --system
+script:
+  - bin/rake
 services:
   - redis-server

data/Gemfile

@@ -1,3 +1,17 @@
 source "https://rubygems.org"
 
 gemspec
+
+group :development do
+  gem "coveralls", require: false
+  gem "guard-rspec"
+  gem "pry-byebug"
+  gem "rack-test"
+  gem "rake"
+  gem "rspec", "~> 3.4"
+  gem "simplecov"
+  gem "webmock"
+end
+
+# This fixes `already initialized constant` warnings while running commands
+begin; require "rb-readline"; rescue LoadError; end

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bin/rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -5,18 +5,31 @@
 
 Allows the Lita chat bot to tweet on command.
 
+
 ## Installation
 
 Add lita-tweet to your Lita instance's Gemfile:
 
-``` ruby
+```ruby
 gem "lita-tweet"
 ```
 
 ## Configuration
 
-TODO: Describe any configuration attributes the plugin exposes.
+To make this plugin work, you'll need to set at least `TWITTER\_CONSUMER\_KEY` and `TWITTER\_CONSUMER\_SECRET`. If you want to host the bot at a specific URL, rather than the default `0.0.0.0:1234` type address, you'll also need to set `SERVER\_URL` so that the bot knows where to send users and Twitter auth callbacks.
+
+```ruby
+require "lita-tweet" if ENV.has_key?("TWITTER_CONSUMER_KEY")
+
+Lita.configure do |config|
+  if ENV.has_key?("TWITTER_CONSUMER_KEY")
+    config.handlers.tweet.http_url = ENV["SERVER_URL"]
+    config.handlers.tweet.consumer_key = ENV.fetch("TWITTER_CONSUMER_KEY")
+    config.handlers.tweet.consumer_secret = ENV.fetch("TWITTER_CONSUMER_SECRET")
+  end
+end
+```
 
 ## Usage
 
-TODO: Describe the plugin's features and how to use them.
+To authorize an account for tweeting, use the command `twitter accounts add` and follow the instructions. To tweet, use the command `tweet some text that should go in the tweet`. To delete the last tweet, use the command `untweet`. For a complete list of commands, including how to map specific twitter accounts to specific chat channels, see the output from the command `help`.

data/bin/guard

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/lita/handlers/tweet.rb

@@ -15,12 +15,16 @@ module Lita
         restrict_to: :tweeters, help: {
           "twitter accounts" => "List accounts that can be tweeted from.",
           "twitter accounts add" => "Authorize a new account for tweeting.",
-          "twitter accounts remove NAME" => "Remove the twitter account NAME"
+          "twitter accounts remove NAME" => "Remove the twitter account NAME."
         }
-      # route %r{^twitter channels\s(.+?)\s(.+)}, :channels, command: true, help: {
-      #   "twitter channels" => "List account to channel mappings.",
-      #   "twitter channels NAME CHANNEL" => "Tweet as twitter account NAME when told to tweet in channel CHANNEL."
-      # }
+      route %r{^twitter default}, :default, command: true, restrict_to: :tweeters,
+        help: { "twitter default ACCOUNT" => "Set the default account to tweet from." }
+      route %r{^twitter map}, :map, command: true, restrict_to: :tweeters, help: {
+        "twitter map" => "List account to channel mappings.",
+        "twitter map NAME ACCOUNT" => "Tweet as ACCOUNT when told to tweet from NAME.",
+      }
+      route %r{^twitter unmap}, :unmap, command: true, restrict_to: :tweeters,
+        help: { "twitter unmap NAME" => "Tweet as the default twitter account when told to tweet in channel CHANNEL." }
 
       TWITTER_AUTH_URL = "/twitter/auth"
       TWITTER_AUTH_CALLBACK_URL = "/twitter/callback"
@@ -33,17 +37,17 @@ module Lita
           return response.reply("I need something to tweet!")
         end
 
-        account = account_for(response)
-        return response.relpy(no_accounts) if account.nil?
+        account = account_for(response.message.source)
+        return response.reply(no_accounts_message) if account.nil?
 
         tweet = account.tweet(text)
         twitter_data.set_last_tweet(account.username, tweet.id)
-        response.reply(tweet.url)
+        response.reply(tweet.url.to_s)
       end
 
       def untweet(response)
-        account = account_for(response)
-        return response.relpy(no_accounts) if account.nil?
+        account = account_for(response.message.source)
+        return response.reply(no_accounts_message) if account.nil?
 
         if account.untweet
           response.reply("Removed last tweet.")
@@ -63,9 +67,27 @@ module Lita
         end
       end
 
-      # def channels(response)
-      #   # do channel stuff here
-      # end
+      def map(response)
+        name, account = response.args[1..2]
+        account.gsub!(/^@/, '') if account
+
+        if name
+          response.reply(set_map(name, account))
+        else
+          response.reply(list_map)
+        end
+      end
+
+      def default(response)
+        account = response.args[1]
+        account.gsub!(/^@/, '') if account
+        response.reply(set_default_map(account))
+      end
+
+      def unmap(response)
+        name = response.args[1]
+        response.reply(clear_map(name))
+      end
 
       def twitter_auth(request, response)
         callback_url = TWITTER_AUTH_CALLBACK_URL
@@ -81,6 +103,10 @@ module Lita
         response.body << "Done! You can now tweet from @#{account.username}."
       end
 
+      def twitter_data
+        @twitter_data ||= Data.new(redis, config, robot)
+      end
+
     private
 
       def list_accounts
@@ -103,12 +129,86 @@ module Lita
         twitter_data.remove_account(name)
         "Removed @#{name}."
       end
-      def account_for(response)
-        twitter_data.account(twitter_data.usernames.first)
+
+      def valid_name?(name)
+        %w[@ #].include?(name[0])
       end
 
-      def twitter_data
-        @twitter_data ||= Data.new(redis, config, robot)
+      def invalid_name
+        "Names for mapping need to be @username (for DMs) or #channel!"
+      end
+
+      def list_map
+        return "No accounts are configured." unless default_account
+
+        channels = twitter_data.channel_map
+        if channels.empty?
+          "All channels will tweet as @#{default_account.username}"
+        else
+          "Channel twitter accounts:\n" +
+            channels.map{|c,u| " - #{c} will tweet as @#{u}" }.join("\n") +
+            "\n - all other channels will tweet as @#{default_account.username}"
+        end
+      end
+
+      def set_default_map(username)
+        if username.nil?
+          "You need to provide an account to set as the default!"
+        elsif twitter_data.set_default(username)
+          "Done. The default account is now @#{username}."
+        else
+          "I can't tweet as @#{username}, so it can't be the default."
+        end
+      end
+
+      def set_map(channel, username)
+        if !valid_name?(channel)
+          invalid_name
+        elsif username.nil?
+          "Provide an account name to set as the default!"
+        elsif twitter_data.set_channel_map(channel, username)
+          "From now on, tweets from #{channel} will use the twitter account @#{username}."
+        else
+          "I can't tweet as @#{username}, so it can't be mapped."
+        end
+      end
+
+      def clear_map(channel)
+        return invalid_name unless valid_name?(channel)
+
+        twitter_data.clear_channel_map(channel)
+
+        if default_account
+          "Tweets from #{channel} will come from the default account, @#{default_account.username}."
+        else
+          no_accounts_message
+        end
+      end
+
+      def account_for(source)
+        channel_name = sender_for(source)
+        twitter_data.get_channel_account(channel_name) || default_account
+      end
+
+      def default_account
+        twitter_data.default_account
+      end
+
+      def no_accounts_message
+        "No accounts are configured for tweeting."
+      end
+
+      def sender_for(source)
+        if source.private_message
+          handle = source.user.metadata["mention_name"] || source.user.name
+          handle ? "@#{handle}" : nil
+        else
+          # lita-slack has a bug where source.room_object.name is wrong,
+          # and to get the correct name you have to find the room again
+          # https://github.com/litaio/lita-slack/issues/44
+          name = Lita::Room.find_by_id(source.room).name
+          name ? "##{name}" : nil
+        end
       end
 
       Lita.register_handler(self)

data/lib/lita/handlers/tweet/account.rb

@@ -6,10 +6,6 @@ module Lita
     class Tweet < Handler
 
       Account = KeywordStruct.new(:username, :token, :secret, :config, :last_tweet) do
-        def username
-          @username ||= client.user.screen_name
-        end
-
         def tweet(text)
           client.update(text)
         end
@@ -18,9 +14,17 @@ module Lita
           last_tweet ? client.destroy_status(last_tweet) : false
         end
 
+        def lookup_username!
+          client.user.screen_name.tap do |username|
+            self.username = username
+          end
+        end
+
       private
 
         def client
+          return nil unless config && token && secret
+
           @client ||= ::Twitter::REST::Client.new do |c|
             c.consumer_key        = config.consumer_key
             c.consumer_secret     = config.consumer_secret

data/lib/lita/handlers/tweet/data.rb

@@ -9,16 +9,26 @@ module Lita
           redis.smembers("twitter_accounts")
         end
 
+        def default_account
+          account(redis.get("default_username"))
+        end
+
         def account(username)
+          return nil if username.nil?
+
           hash = redis.hgetall("twitter_accounts:#{username}")
+          return nil if hash.empty?
+
           data = hash.each_with_object({}){|(k,v),h| h[k.to_sym] = v }
           Account.new(**data.merge(config: config))
         end
 
-        def add_account(token, secret)
-          account = Account.new(token: token, secret: secret, config: config)
-          username = account.username
+        def add_account(token, secret, username = nil)
+          account = Account.new(token: token, secret: secret,
+                                config: config, username: username)
+          username ||= account.lookup_username!
 
+          redis.setnx("default_username", username)
           redis.sadd("twitter_accounts", username)
           redis.hmset("twitter_accounts:#{username}",
             "username", username,
@@ -32,6 +42,11 @@ module Lita
         def remove_account(username)
           redis.del("twitter_accounts:#{username}")
           redis.srem("twitter_accounts", username)
+
+          if redis.get("default_username") == username
+            next_username = usernames.first
+            redis.set("default_username", next_username)
+          end
         end
 
         def set_last_tweet(username, tweet_id)
@@ -42,6 +57,37 @@ module Lita
           redis.hget("twitter_accounts:#{username}", "last_tweet")
         end
 
+        def channel_map
+          redis.smembers("channels").map do |name|
+            [name, get_channel_map(name)]
+          end.to_h
+        end
+
+        def get_channel_account(channel)
+          return nil unless channel
+          account(get_channel_map(channel))
+        end
+
+        def get_channel_map(channel)
+          redis.get("channels:#{channel}")
+        end
+
+        def set_channel_map(channel, username)
+          return false unless usernames.include?(username)
+          redis.sadd("channels", channel)
+          redis.set("channels:#{channel}", username)
+        end
+
+        def clear_channel_map(channel)
+          redis.del("channels:#{channel}")
+          redis.srem("channels", channel)
+        end
+
+        def set_default(username)
+          return false unless usernames.include?(username)
+          redis.set("default_username", username)
+        end
+
         def create_request_token(callback_path)
           request_token = consumer.get_request_token(
             oauth_callback: bot_uri(callback_path).to_s)

data/lita-tweet.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-tweet"
-  spec.version       = "0.3.0"
+  spec.version       = "0.4.0"
   spec.authors       = ["Andre Arko"]
   spec.email         = ["andre@arko.net"]
   spec.description   = "Tweeting for Lita"
@@ -19,10 +19,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "oauth", "~> 0.5.1"
 
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "rspec", ">= 3.0.0"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "coveralls"
 end

data/spec/lita/handlers/tweet_spec.rb

@@ -1,4 +1,63 @@
 require "spec_helper"
 
 describe Lita::Handlers::Tweet, lita_handler: true do
+  # Chat routes
+  {
+    "tweet some text" => :tweet,
+    "untweet" => :untweet,
+    "twitter accounts" => :accounts,
+    "twitter accounts add" => :accounts,
+    "twitter accounts remove foo" => :accounts,
+    "twitter default foo" => :default,
+    "twitter map" => :map,
+    "twitter map foo" => :map,
+    "twitter unmap foo" => :unmap
+  }.each do |command, method|
+    it { is_expected.to route_command(command).
+         with_authorization_for(:tweeters).
+         to(method) }
+  end
+
+  # HTTP routes
+  {
+    "/twitter/auth" => :twitter_auth,
+    "/twitter/callback" => :twitter_auth_callback
+  }.each do |route, method|
+    it { is_expected.to route_http(:get, route).to(method) }
+  end
+
+  before(:each) do
+    Lita::Authorization.new(registry.config).add_user_to_group!(source.user, :tweeters)
+  end
+
+  describe "#tweet" do
+    context "without an authorized account" do
+      it "should complain" do
+        send_command("tweet some text")
+        expect(replies).to include(/no accounts/i)
+      end
+    end
+
+    context "with an authorized account" do
+      before do
+        subject.twitter_data.add_account("token", "secret", "handle")
+      end
+
+      it "should send a tweet" do
+        stub_request(:post, "https://api.twitter.com/1.1/statuses/update.json").
+          with(body: {status: "some text"}).to_return(status: 200, body: %q[{
+            "created_at": "Sun Aug 14 01:53:54 +0000 2016",
+            "id": 12345,
+            "text": "some text",
+            "user": {
+              "id": 123,
+              "screen_name": "handle",
+              "created_at": "Wed Nov 04 17:18:22 +0000 2009"
+            }
+          }])
+        send_command("tweet some text")
+        expect(replies).to include("https://twitter.com/handle/status/12345")
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,14 +1,18 @@
-require "simplecov"
 require "coveralls"
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-SimpleCov.start { add_filter "/spec/" }
+require "simplecov"
+SimpleCov.add_filter("/.bundle/")
+Coveralls.wear!
 
 require "lita-tweet"
 require "lita/rspec"
+require "webmock/rspec"
 
 # A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
 # was generated with Lita 4, the compatibility mode should be left disabled.
 Lita.version_3_compatibility_mode = false
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = ".rspec_examples"
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-tweet
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andre Arko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-07 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -66,103 +66,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Tweeting for Lita
 email:
 - andre@arko.net
-executables: []
+executables:
+- guard
+- rake
+- rspec
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/guard
+- bin/rake
+- bin/rspec
 - lib/keyword_struct.rb
 - lib/lita-tweet.rb
 - lib/lita/handlers/tweet.rb
@@ -194,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Allows the Lita chat bot to tweet on command