lita-line 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1bdc549ce7824fd0933a8218caf3f3d27d3247d
+  data.tar.gz: c3df4a2e4a18b421823cb1acd794ca62fef1bc0e
+SHA512:
+  metadata.gz: 6f14a867d57c622bb3c0aaa965d8086d86ee3980cb1cb370a25a951b063ce0c154077c107ee9f0b44fdba45a627d12f26492925b478354f8401c82851c9d863a
+  data.tar.gz: 8df7531f1efcbb7a09a1f93280ab939fafba4609ce553cbcc21e7770d2e9697a6bcb03ce99199d2e4aba5ad5223958561d78f33672d4d3fd71871513d3d07129

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+ruby '2.3.1'
+
+gemspec

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 <Aaron Huang>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# lita-line
+[![Gem](https://img.shields.io/gem/v/lita-line.svg)](https://rubygems.org/gems/lita-line)
+[![Gem](https://img.shields.io/gem/dt/lita-line.svg)](https://rubygems.org/gems/lita-line)
+[![Build Status](https://img.shields.io/travis/aar0nTw/lita-line.svg)](https://travis-ci.org/aar0nTw/lita-line)
+[![Coverage Status](https://img.shields.io/coveralls/aar0nTw/lita-line.svg)](https://coveralls.io/github/aar0nTw/lita-line?branch=master)
+
+Line Messanging webhook adapter for [Lita](https://github.com/litaio/lita)
+
+## Installation
+
+Add lita-line to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-line"
+```
+
+## Configuration
+
+Use line adapter in `lita_config.rb`
+
+``` ruby
+config.robot.adapter = :line
+config.adapters.line.channel_secret = ENV["LINE_CHANNEL_SECRET"]
+config.adapters.line.channel_token = ENV["LINE_CHANNEL_TOKEN"]
+```
+
+### Required attributes
+
+- `channel_secret` _(String)_: Bot's Channel secret
+- `channel_token` _(String)_: Bot's Channel token
+
+Create a line bot at https://business.line.me/ and get it's secret and token in https://developers.line.me 
+  
+## Usage
+
+- Deploy your lita app to heroku
+- Setting the webhook callback address: `https://{your-lita-app-name}.herokuapp.com/callback` in https://developers.line.me 
+
+## 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-line)
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita-line.rb

@@ -0,0 +1,8 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/adapters/line"
+require "lita/handlers/webhook"

data/lib/lita/adapters/line.rb

@@ -0,0 +1,34 @@
+require 'line/bot'
+require 'lita/adapters/line/client'
+
+module Lita
+  module Adapters
+    class Line < Adapter
+      config :channel_secret, type: String, required: true
+      config :channel_token, type: String, required: true
+
+      attr_reader :client
+
+      def run
+        return if client
+        @client = Client.new(robot, config)
+        client.run
+      end
+
+      def chat_service
+        @client
+      end
+
+      def send_messages(target, messages)
+        client.send_messages(target.room, messages)
+      end
+
+      def shut_down
+        client.stop
+      end
+
+      Lita.register_adapter(:line, self)
+
+    end
+  end
+end

data/lib/lita/adapters/line/client.rb

@@ -0,0 +1,48 @@
+require 'line/bot'
+require 'eventmachine'
+
+module Lita
+  module Adapters
+    class Line < Adapter
+      class Client
+        attr_reader :client
+        def initialize(robot, config)
+          @client = ::Line::Bot::Client.new { |c|
+            c.channel_secret = config.channel_secret
+            c.channel_token = config.channel_token
+          }
+        end
+
+        def run
+          log.info "Running client"
+          EM.run do
+          end
+        end
+
+        def stop
+          EM.stop if EM.reactor_running?
+        end
+
+        def send_messages(reply_token, messages)
+          messages = format_msg messages
+          log.info "Send message to ##{reply_token}, #{messages}"
+          client.reply_message(reply_token, messages)
+        end
+
+        def format_msg(messages)
+          messages.map do |message|
+            {
+              type: :text,
+              text: message
+            }
+          end
+        end
+
+        private
+        def log
+          Lita.logger
+        end
+      end
+    end
+  end
+end

data/lib/lita/handlers/webhook.rb

@@ -0,0 +1,50 @@
+module Lita
+  module Handlers
+    class Webhook < Handler
+      attr_reader :client
+      attr_reader :robot
+
+      def initialize(robot)
+        @robot = robot
+        @client = robot.chat_service.client
+      end
+
+      def log
+        Lita.logger
+      end
+
+      def callback(request, response)
+        body = request.body.read
+        signature = request.env['HTTP_X_LINE_SIGNATURE']
+        unless client.validate_signature(body, signature)
+          log.info "Unvalidate Signature: #{signature}"
+          response.status = 401
+        else
+          response.status = 200
+          events = client.parse_events_from(body)
+          events.map do |event|
+            case event
+            when ::Line::Bot::Event::Message
+              case event.type
+              when ::Line::Bot::Event::MessageType::Text
+                log.info "Webhook: #{DateTime.strptime(event['timestamp'].to_s, '%Q').to_s}[#{event.message['id']}##{event.message['type']}]: #{event.message['text']} "
+                # TODO Parse user from event
+                user = Lita::User.create('guest', {
+                  name: 'Guest'
+                })
+                source = Lita::Source.new(user: user, room: event['replyToken'])
+                message = Lita::Message.new(robot, event.message['text'], source)
+                robot.receive(message)
+              end
+            end
+          end
+        end
+        response.finish
+      end
+
+      http.post "/callback", :callback
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-line.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-line"
+  spec.version       = "0.6.1"
+  spec.authors       = ["Aaron Huang"]
+  spec.email         = ["aaroms9733@gmail.com"]
+  spec.description   = "A line adapter for lita bot"
+  spec.summary       = ""
+  spec.homepage      = "https://github.com/aar0nTw/lita-line"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "adapter" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "eventmachine"
+  spec.add_runtime_dependency "lita", ">= 4.7"
+  spec.add_runtime_dependency "line-bot-api", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  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/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    adapters:
+      line:

data/spec/lita/adapters/line/client_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'line/bot'
+
+describe Lita::Adapters::Line::Client, lita: true do
+  subject { described_class.new(robot, config) }
+  let(:robot) { Lita::Robot.new(registry) }
+  let(:line_client) {instance_double("Line::Bot::Client")}
+  let(:reply_token) { "reply_token" }
+  let(:config) { double }
+  let(:EM) { double }
+  before do
+    allow(line_client).to receive(:reply_message)
+    config.stub(:channel_secret)
+    config.stub(:channel_token)
+  end
+
+  it 'Should have a client' do
+    allow(Line::Bot::Client).to receive(:new).and_return(line_client)
+    expect(subject.client).to eq(line_client)
+  end
+
+  it 'LineBotClien init' do
+    expect(config).to receive(:channel_secret)
+    expect(config).to receive(:channel_token)
+    described_class.new(nil, config)
+  end
+
+  it 'run should use EventMachine' do
+    allow(EM).to receive(:run)
+    subject.run
+    expect(EM).to have_received(:run)
+  end
+
+  it 'run should receive log' do
+    allow(EM).to receive(:run)
+    allow(subject).to receive(:log).and_return(Lita.logger)
+    expect(subject).to receive(:log)
+    subject.run
+  end
+
+  it 'Graceful stop by EM.stop' do
+    allow(EM).to receive(:stop)
+    allow(EM).to receive(:reactor_running?).and_return(true)
+    subject.stop
+    expect(EM).to have_received(:stop)
+  end
+
+  it 'Doesnt call EM.stop when EM.reactor not running' do
+    allow(EM).to receive(:stop)
+    allow(EM).to receive(:reactor_running?).and_return(false)
+    subject.stop
+    expect(EM).not_to have_received(:stop)
+  end
+
+  it 'When send messages format_msg should be called' do
+    expect(subject).to receive(:format_msg)
+    subject.send_messages(reply_token, ['foo'])
+  end
+
+  it 'use client.reply_message for send message' do
+    allow(Line::Bot::Client).to receive(:new).and_return(line_client)
+    expect(line_client).to receive(:reply_message)
+    subject.send_messages(reply_token, ['foo'])
+  end
+
+  it 'format_msg should return a dictionary' do
+    expect(subject.format_msg(['foo'])).to eq [{ type: :text, text: 'foo' }]
+  end
+
+end

data/spec/lita/adapters/line_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+# Main test
+describe Lita::Adapters::Line, lita: true do
+  subject { described_class.new(robot) }
+
+  let(:robot) { Lita::Robot.new(registry) }
+  let(:secret) { 'channel-secret' }
+  let(:client) { instance_double("#{described_class}::Client") }
+  let(:token) { 'channel-token' }
+
+  before do
+    registry.register_adapter(:line, described_class)
+    registry.config.adapters.line.channel_secret = secret
+    registry.config.adapters.line.channel_token = token
+    robot.config.robot.adapter = :line
+
+    allow(
+      described_class::Client
+    ).to receive(:new).with(robot, subject.config).and_return(client)
+    allow(client).to receive(:run)
+  end
+
+  it 'Register adapter' do
+    expect(Lita.adapters[:line]).to eql(described_class)
+  end
+
+  it 'running' do
+    subject.run
+    expect(subject.client).to be client
+  end
+
+  it 'client will run when adapter run' do
+    expect(client).to receive(:run)
+    subject.run
+  end
+
+  it 'Only run once' do
+    expect(client).to receive(:run).once
+    subject.run
+    subject.run
+  end
+
+  it 'Chat service' do
+    subject.run
+    expect(subject.chat_service).to eq(client)
+  end
+
+  it 'Shut down will call client.stop' do
+    expect(client).to receive(:stop)
+    subject.run
+    subject.shut_down
+  end
+
+  describe 'send messages' do
+    let(:room_source) {Lita::Source.new(room: "reply_token")}
+    let(:messages) {["Hello world"]}
+    let(:client) {instance_double('Lita::Adapters::Line::Client')}
+    before do
+      allow(described_class::Client).to receive(:new).with(robot, subject.config).and_return(client)
+      allow(client).to receive(:send_messages).with(room_source.room, messages)
+    end
+
+    it "Send messages by client" do
+      expect(client).to receive(:send_messages).with(room_source.room, messages)
+      subject.run
+      subject.send_messages(room_source, messages)
+    end
+  end
+
+end
+

data/spec/lita/handlers/webhook_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe Lita::Handlers::Webhook, lita_handler: true do
+
+  let(:client) { double }
+
+  before do
+    robot.stub_chain(:chat_service, :client).and_return client
+  end
+
+  describe 'Handler Initialize' do
+
+    it 'attr client' do
+      expect(subject.client).to eq(client)
+    end
+
+    it 'Lita.logger alias' do
+      expect(subject.log).to be Lita.logger
+    end
+
+    it 'should register callback http route' do
+      is_expected.to route_http(:post, '/callback').to(:callback)
+    end
+  end
+
+  describe 'Handler callback' do
+    let(:request) { double }
+    let(:response) { double }
+    let(:config) { double }
+    let(:body) { <<EOS
+{
+  "events": [
+      {
+        "replyToken": "reply_token",
+        "type": "message",
+        "timestamp": 1462629479859,
+        "source": {
+             "type": "user",
+             "userId": "U206d25c2ea6bd87c17655609a1c37cb8"
+         },
+         "message": {
+             "id": "325708",
+             "type": "text",
+             "text": "Hello, world"
+          }
+      }
+  ]
+    }
+EOS
+    }
+    let(:signature) { double }
+    let(:env) { {'HTTP_X_LINE_SIGNATURE': signature} }
+
+    before do
+      allow(
+        response
+      ).to receive(:finish)
+      request.stub_chain(:body, :read).and_return body
+      request.stub(:env).and_return env
+      config.stub(:channel_secret).and_return 'secret'
+      config.stub(:channel_token).and_return 'token'
+      robot.stub_chain(:chat_service, :client).and_return(Lita::Adapters::Line::Client.new(robot, config).client)
+    end
+
+    it 'HTTP 401 when Line signature unvalidated' do
+      Line::Bot::Client.any_instance.stub(:validate_signature => false)
+      allow(response).to receive(:status=)
+      subject.callback(request, response)
+      expect(response).to have_received(:status=).with(401)
+    end
+
+    it "HTTP 200 when validate_signature" do
+      Line::Bot::Client.any_instance.stub(:validate_signature => true)
+      expect(response).to receive(:status=).with(200)
+      subject.callback(request, response)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita/rspec"
+require "lita-line"
+
+# 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

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: lita-line
+version: !ruby/object:Gem::Version
+  version: 0.6.1
+platform: ruby
+authors:
+- Aaron Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: line-bot-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: 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: A line adapter for lita bot
+email:
+- aaroms9733@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-line.rb
+- lib/lita/adapters/line.rb
+- lib/lita/adapters/line/client.rb
+- lib/lita/handlers/webhook.rb
+- lita-line.gemspec
+- locales/en.yml
+- spec/lita/adapters/line/client_spec.rb
+- spec/lita/adapters/line_spec.rb
+- spec/lita/handlers/webhook_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aar0nTw/lita-line
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: adapter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/lita/adapters/line/client_spec.rb
+- spec/lita/adapters/line_spec.rb
+- spec/lita/handlers/webhook_spec.rb
+- spec/spec_helper.rb