lita-slack 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c3600cd068e9891e914063b341e384e1e66c117
-  data.tar.gz: 0dcbfb0f922578b75ec22a835d7d77e7072c22fd
+  metadata.gz: 263b8f5a62893a0ca957dbbf02925525e6c4aef0
+  data.tar.gz: 8a8d23b254f44196cb4c332c81b445fbac276df0
 SHA512:
-  metadata.gz: 7b285b424783c62984f4f31b1dec16937c6ea8807f74b428fd769b83d60dc5ca2793c695ed4ae79efb52c0079c9ddfb813782379aa72c1ebf325a73f3eb17a9b
-  data.tar.gz: 67da2107713a27eab01d59b19c9256593778341b437c7aeb6f6f832f05eafb359038aa36466fbccd0b5841481712048a4b7590aabd26824b1fc954bb8390e512
+  metadata.gz: 09b05e48245ee0966a4a211a6672df6d8042e5a5af27f74c88ea91ad568fe865e0fce44e709e32a5f18afca9198c15826a2c02b3ba60cf423448923e078486ee
+  data.tar.gz: 8408c30ff79ef6b025e7e94c29178538b84d01f850ef24e6e41f6ee365b59cf6b3e5d1945605f12efa113b0669422c6e3c67fdef105f6d4a69575ed21c2faf8f

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+sudo: false
 rvm:
   - 2.0.0
 script: bundle exec rake

data/README.md

@@ -50,6 +50,14 @@ Lita will join your default channel after initial setup. To have it join additio
 * `:slack_user_created` - When the robot creates/updates a user's info - name, mention name, etc., as directed by Slack. The payload has a single object, a `Lita::Slack::Adapters::SlackUser` object, under the `:slack_user` key.
 * `:slack_channel_created` - When the robot creates/updates a channel's or group's info, as directed by Slack. The payload has a single object, a `Lita::Slack::Adapters::SlackChannel` object, under the `:slack_channel` key.
 
+## Chat service API
+
+lita-slack supports Lita 4.6's chat service API for Slack-specific functionality. You can access this API object by calling the `Lita::Robot#chat_service`. See the API docs for `Lita::Slack::Adapters::ChatService` for details about the provided methods.
+
+## API documentation
+
+The API documentation, useful for plugin authors, can be found for the latest gem release on [RubyDoc.info](http://www.rubydoc.info/gems/lita-slack)
+
 ## License
 
 [MIT](http://opensource.org/licenses/MIT)

data/lib/lita/adapters/slack.rb

@@ -1,12 +1,20 @@
+require 'lita/adapters/slack/chat_service'
 require 'lita/adapters/slack/rtm_connection'
 
 module Lita
   module Adapters
+    # A Slack adapter for Lita.
+    # @api private
     class Slack < Adapter
       # Required configuration attributes.
       config :token, type: String, required: true
       config :proxy, type: String
 
+      # Provides an object for Slack-specific features.
+      def chat_service
+        ChatService.new(config)
+      end
+
       # Starts the connection.
       def run
         return if rtm_connection

data/lib/lita/adapters/slack/api.rb

@@ -8,6 +8,7 @@ require 'lita/adapters/slack/slack_channel'
 module Lita
   module Adapters
     class Slack < Adapter
+      # @api private
       class API
         def initialize(config, stubs = nil)
           @config = config
@@ -20,6 +21,15 @@ module Lita
           SlackIM.new(response_data["channel"]["id"], user_id)
         end
 
+        def send_attachments(room_or_user, attachments)
+          call_api(
+            "chat.postMessage",
+            as_user: true,
+            channel: room_or_user.id,
+            attachments: MultiJson.dump(attachments.map(&:to_hash)),
+          )
+        end
+
         def set_topic(channel, topic)
           call_api("channels.setTopic", channel: channel, topic: topic)
         end

data/lib/lita/adapters/slack/attachment.rb

@@ -0,0 +1,36 @@
+module Lita
+  module Adapters
+    class Slack < Adapter
+      # A Slack attachment object.
+      # @api public
+      # @see https://api.slack.com/docs/attachments
+      # @since 1.6.0
+      class Attachment
+        # @param text [String] The main text of the message.
+        # @param options [Hash] Keyword arguments supporting all the option supported by Slack's
+        #   attachment API. These options will be passed to Slack as provided, with the exception
+        #   that the +:fallback+ option defaults to the value of +text+ (the first argument to this
+        #   method) and any value specified for the +:text+ option will be overwritten by the
+        #   explicit +text+ argument.
+        def initialize(text, **options)
+          self.text = text
+          self.options = options
+        end
+
+        # Converts the attachment into a hash, suitable for being sent to the Slack API.
+        # @return [Hash] The converted hash.
+        def to_hash
+          options.merge({
+            fallback: options[:fallback] || text,
+            text: text,
+          })
+        end
+
+        private
+
+        attr_accessor :options
+        attr_accessor :text
+      end
+    end
+  end
+end

data/lib/lita/adapters/slack/chat_service.rb

@@ -0,0 +1,29 @@
+require "lita/adapters/slack/attachment"
+
+module Lita
+  module Adapters
+    class Slack < Adapter
+      # Slack-specific features made available to +Lita::Robot+.
+      # @api public
+      # @since 1.6.0
+      class ChatService
+        attr_accessor :api
+
+        # @param config [Lita::Configuration] The adapter's configuration data.
+        def initialize(config)
+          self.api = API.new(config)
+        end
+
+        # @param target [Lita::Room, Lita::User] A room or user object indicating where the
+        #   attachment should be sent.
+        # @param attachments [Attachment, Array<Attachment>] An {Attachment} or array of
+        #   {Attachment}s to send.
+        # @return [void]
+        def send_attachments(target, attachments)
+          api.send_attachments(target, Array(attachments))
+        end
+        alias_method :send_attachment, :send_attachments
+      end
+    end
+  end
+end

data/lib/lita/adapters/slack/event_loop.rb

@@ -3,6 +3,7 @@ require 'eventmachine'
 module Lita
   module Adapters
     class Slack < Adapter
+      # @api private
       class EventLoop
         class << self
           def defer

data/lib/lita/adapters/slack/im_mapping.rb

@@ -1,6 +1,7 @@
 module Lita
   module Adapters
     class Slack < Adapter
+      # @api private
       class IMMapping
         def initialize(api, ims)
           @api = api

data/lib/lita/adapters/slack/message_handler.rb

@@ -1,6 +1,7 @@
 module Lita
   module Adapters
     class Slack < Adapter
+      # @api private
       class MessageHandler
         def initialize(robot, robot_id, data)
           @robot = robot
@@ -70,7 +71,7 @@ module Lita
                 else
                   user = User.find_by_id(link)
                   if user
-                    "@#{user.name}"
+                    "@#{user.mention_name}"
                   else
                     "@#{link}"
                   end

data/lib/lita/adapters/slack/room_creator.rb

@@ -1,6 +1,7 @@
 module Lita
   module Adapters
     class Slack < Adapter
+      # @api private
       class RoomCreator
         class << self
           def create_room(channel, robot)

data/lib/lita/adapters/slack/rtm_connection.rb

@@ -11,6 +11,7 @@ require 'lita/adapters/slack/user_creator'
 module Lita
   module Adapters
     class Slack < Adapter
+      # @api private
       class RTMConnection
         MAX_MESSAGE_BYTES = 16_000
 

data/lib/lita/adapters/slack/slack_channel.rb

@@ -1,8 +1,11 @@
 module Lita
   module Adapters
     class Slack < Adapter
+      # A struct representing a Slack channel, group, or IM.
+      # @api public
       class SlackChannel
         class << self
+          # @api private
           def from_data(channel_data)
             new(
                 channel_data['id'],
@@ -13,15 +16,21 @@ module Lita
             )
           end
 
+          # @api private
           def from_data_array(channels_data)
             channels_data.map { |channel_data| from_data(channel_data) }
           end
         end
 
+        # @return [String] The channel's unique ID.
         attr_reader :id
+        # @return [String] The human-readable name for the channel.
         attr_reader :name
+        # @return [String] A timestamp indicating when the channel was created.
         attr_reader :created
+        # @return [String] The unique ID of the user who created the channel.
         attr_reader :creator
+        # @return [Hash] The raw channel data received from Slack, including many more fields.
         attr_reader :raw_data
 
         def initialize(id, name, created, creator, raw_data)
@@ -34,4 +43,4 @@ module Lita
       end
     end
   end
-end
+end

data/lib/lita/adapters/slack/slack_im.rb

@@ -1,6 +1,7 @@
 module Lita
   module Adapters
     class Slack < Adapter
+      # @api private
       class SlackIM
         class << self
           def from_data_array(ims_data)

data/lib/lita/adapters/slack/slack_user.rb

@@ -1,8 +1,11 @@
 module Lita
   module Adapters
     class Slack < Adapter
+      # A struct representing a Slack user.
+      # @api public
       class SlackUser
         class << self
+          # @api private
           def from_data(user_data)
             new(
               user_data['id'],
@@ -12,14 +15,19 @@ module Lita
             )
           end
 
+          # @api private
           def from_data_array(users_data)
             users_data.map { |user_data| from_data(user_data) }
           end
         end
 
+        # @return [String] The user's unique ID.
         attr_reader :id
+        # @return [String] The user's mention name, e.g. @alice.
         attr_reader :name
+        # @return [String] The user's display name, e.g. Alice Bobhart
         attr_reader :real_name
+        # @return [Hash] The raw user data received from Slack, including many more fields.
         attr_reader :raw_data
 
         def initialize(id, name, real_name, raw_data)

data/lib/lita/adapters/slack/team_data.rb

@@ -1,5 +1,6 @@
 module Lita
   module Adapters
+    # @api private
     class Slack < Adapter
       TeamData = Struct.new(:ims, :self, :users, :channels, :websocket_url)
     end

data/lib/lita/adapters/slack/user_creator.rb

@@ -1,6 +1,7 @@
 module Lita
   module Adapters
     class Slack < Adapter
+      # @api private
       class UserCreator
         class << self
           def create_user(slack_user, robot, robot_id)

data/lita-slack.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-slack"
-  spec.version       = "1.5.0"
+  spec.version       = "1.6.0"
   spec.authors       = ["Ken J.", "Jimmy Cuadra"]
   spec.email         = ["kenjij@gmail.com", "jimmy@jimmycuadra.com"]
   spec.description   = %q{Lita adapter for Slack.}
@@ -17,10 +17,11 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "eventmachine"
   spec.add_runtime_dependency "faraday"
   spec.add_runtime_dependency "faye-websocket", ">= 0.8.0"
-  spec.add_runtime_dependency "lita", ">= 4.4.2"
+  spec.add_runtime_dependency "lita", ">= 4.6.0"
   spec.add_runtime_dependency "multi_json"
 
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", ">= 3.0.0"

data/spec/lita/adapters/slack/api_spec.rb

@@ -66,6 +66,119 @@ describe Lita::Adapters::Slack::API do
     end
   end
 
+  describe "#send_attachments" do
+    let(:attachment) do
+      Lita::Adapters::Slack::Attachment.new(attachment_text)
+    end
+    let(:attachment_text) { "attachment text" }
+    let(:attachment_hash) do
+      {
+        fallback: fallback_text,
+        text: attachment_text,
+      }
+    end
+    let(:fallback_text) { attachment_text }
+    let(:http_response) { MultiJson.dump({ ok: true }) }
+    let(:room) { Lita::Room.new("C1234567890") }
+    let(:stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post(
+          "https://slack.com/api/chat.postMessage",
+          token: token,
+          as_user: true,
+          channel: room.id,
+          attachments: MultiJson.dump([attachment_hash]),
+        ) do
+          [http_status, {}, http_response]
+        end
+      end
+    end
+
+    context "with a simple text attachment" do
+      it "sends the attachment" do
+        response = subject.send_attachments(room, [attachment])
+
+        expect(response['ok']).to be(true)
+      end
+    end
+
+    context "with a different fallback message" do
+      let(:attachment) do
+        Lita::Adapters::Slack::Attachment.new(attachment_text, fallback: fallback_text)
+      end
+      let(:fallback_text) { "fallback text" }
+
+      it "sends the attachment" do
+        response = subject.send_attachments(room, [attachment])
+
+        expect(response['ok']).to be(true)
+      end
+    end
+
+    context "with all the valid options" do
+      let(:attachment) do
+        Lita::Adapters::Slack::Attachment.new(attachment_text, common_hash_data)
+      end
+      let(:attachment_hash) do
+        common_hash_data.merge(fallback: attachment_text, text: attachment_text)
+      end
+      let(:common_hash_data) do
+        {
+          author_icon: "http://example.com/author.jpg",
+          author_link: "http://example.com/author",
+          author_name: "author name",
+          color: "#36a64f",
+          fields: [{
+            title: "priority",
+            value: "high",
+            short: true,
+          }, {
+            title: "super long field title",
+            value: "super long field value",
+            short: false,
+          }],
+          image_url: "http://example.com/image.jpg",
+          pretext: "pretext",
+          thumb_url: "http://example.com/thumb.jpg",
+          title: "title",
+          title_link: "http://example.com/title",
+        }
+      end
+
+      it "sends the attachment" do
+        response = subject.send_attachments(room, [attachment])
+
+        expect(response['ok']).to be(true)
+      end
+    end
+
+    context "with a Slack error" do
+      let(:http_response) do
+        MultiJson.dump({
+          ok: false,
+          error: 'invalid_auth'
+        })
+      end
+
+      it "raises a RuntimeError" do
+        expect { subject.send_attachments(room, [attachment]) }.to raise_error(
+          "Slack API call to chat.postMessage returned an error: invalid_auth."
+        )
+      end
+    end
+
+    context "with an HTTP error" do
+      let(:http_status) { 422 }
+      let(:http_response) { '' }
+
+      it "raises a RuntimeError" do
+        expect { subject.send_attachments(room, [attachment]) }.to raise_error(
+          "Slack API call to chat.postMessage failed with status code 422."
+        )
+      end
+    end
+  end
+
   describe "#set_topic" do
     let(:channel) { 'C1234567890' }
     let(:topic) { 'Topic' }

data/spec/lita/adapters/slack/chat_service_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Lita::Adapters::Slack::ChatService, lita: true do
+  subject { described_class.new(adapter.config) }
+
+  let(:adapter) { Lita::Adapters::Slack.new(robot) }
+  let(:robot) { Lita::Robot.new(registry) }
+  let(:room) { Lita::Room.new("C2147483705") }
+
+  before do
+    registry.register_adapter(:slack, Lita::Adapters::Slack)
+  end
+
+  describe "#send_attachments" do
+    let(:attachment) { Lita::Adapters::Slack::Attachment.new("attachment text") }
+
+    it "can send a simple text attachment" do
+      expect(subject.api).to receive(:send_attachments).with(room, [attachment])
+
+      subject.send_attachments(room, attachment)
+    end
+
+    it "is aliased as send_attachment" do
+      expect(subject.api).to receive(:send_attachments).with(room, [attachment])
+
+      subject.send_attachment(room, attachment)
+    end
+  end
+end

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

@@ -193,7 +193,7 @@ describe Lita::Adapters::Slack::MessageHandler, lita: true do
 
         end
 
-        context "changes <@123> links to @name" do
+        context "changes <@123> links to @label" do
           let(:data) do
             {
                 "type"    => "message",
@@ -204,7 +204,7 @@ describe Lita::Adapters::Slack::MessageHandler, lita: true do
           it "removes formatting" do
             expect(Lita::Message).to receive(:new).with(
                                          robot,
-                                         "foo @name bar",
+                                         "foo @label bar",
                                          source
                                      ).and_return(message)
 

data/spec/lita/adapters/slack_spec.rb

@@ -21,6 +21,12 @@ describe Lita::Adapters::Slack, lita: true do
     expect(Lita.adapters[:slack]).to eql(described_class)
   end
 
+  describe "#chat_service" do
+    it "returns an object with Slack-specific methods" do
+      expect(subject.chat_service).to be_an_instance_of(described_class::ChatService)
+    end
+  end
+
   describe "#run" do
     it "starts the RTM connection" do
       expect(rtm_connection).to receive(:run)

data/spec/spec_helper.rb

@@ -9,6 +9,8 @@ SimpleCov.start { add_filter "/spec/" }
 require "lita-slack"
 require "lita/rspec"
 
+require "pry"
+
 Lita.version_3_compatibility_mode = false
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-slack
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Ken J.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.2
+        version: 4.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.2
+        version: 4.6.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !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: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +196,8 @@ files:
 - lib/lita-slack.rb
 - lib/lita/adapters/slack.rb
 - lib/lita/adapters/slack/api.rb
+- lib/lita/adapters/slack/attachment.rb
+- lib/lita/adapters/slack/chat_service.rb
 - lib/lita/adapters/slack/event_loop.rb
 - lib/lita/adapters/slack/im_mapping.rb
 - lib/lita/adapters/slack/message_handler.rb
@@ -195,6 +211,7 @@ files:
 - lita-slack.gemspec
 - locales/en.yml
 - spec/lita/adapters/slack/api_spec.rb
+- spec/lita/adapters/slack/chat_service_spec.rb
 - spec/lita/adapters/slack/event_loop_spec.rb
 - spec/lita/adapters/slack/im_mapping_spec.rb
 - spec/lita/adapters/slack/message_handler_spec.rb
@@ -227,12 +244,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Lita adapter for Slack.
 test_files:
 - spec/lita/adapters/slack/api_spec.rb
+- spec/lita/adapters/slack/chat_service_spec.rb
 - spec/lita/adapters/slack/event_loop_spec.rb
 - spec/lita/adapters/slack/im_mapping_spec.rb
 - spec/lita/adapters/slack/message_handler_spec.rb