lita-readify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7b5b1dbadd16b371193b7fd3427f4ffd318a8eb
+  data.tar.gz: 10f660602d4502f17dda363d3f91f9ab43130503
+SHA512:
+  metadata.gz: 1965a33d913e312f7dfd2ed6db3c28284663c1edd8596d902b233c9cf406140379949f64eaf09628e036d0abe0d2dbaa7695561e3d419dba8f93c410f78852ff
+  data.tar.gz: 567e32ba43556e3d76f2531518ccc76dbc52322ad165dcf8a4455d3b013ce7f41d2a481db1b37bc18ee7da2252658f765eb907ea7c20bc601b96f772aa9cc3d6

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 @@
+--color
+-f d

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Blackbird SAS
+
+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,29 @@
+# lita-readify
+
+[![Build Status](https://travis-ci.org/blackbirdco/lita-readify.png?branch=master)](https://travis-ci.org/blackbirdco/lita-readify)
+[![Coverage Status](https://coveralls.io/repos/github/blackbirdco/lita-readify/badge.svg?branch=master)](https://coveralls.io/github/blackbirdco/lita-readify?branch=master)
+
+Automaticaly tracks links with tags on [Readability](https://www.readability.com)
+
+## Installation
+
+Add lita-readify to your Lita instance's Gemfile:
+
+```ruby
+gem "lita-readify"
+```
+
+## Configuration
+
+1. Create an account on [Readability](https://www.readability.com) and
+   [generate API keys](https://www.readability.com/settings/account) ;
+2. Fill the following configurations:
+   * `consumer_key`: Your consumer key from Readability
+   * `consumer_secret`: Your consumer secret from Readability
+   * `access_token` and `access_token_secret` from
+   * `blacklist_domains`: domains to not track
+   * `channels`: channels to watch
+
+## Usage
+
+![Nothing to do here](http://fdzeta.com/data/MetaMirrorCache/_avatar_24ff90ee4c98_128.png)

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-readify.rb

@@ -0,0 +1,12 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/readify"
+
+Lita::Handlers::Readify.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lib/lita/handlers/readify.rb

@@ -0,0 +1,93 @@
+require 'readit'
+
+module Lita
+  module Handlers
+    class Readify < Handler
+      config :consumer_key
+      config :consumer_secret
+      config :access_token
+      config :access_token_secret
+
+      config :blacklist_domains
+      config :channels
+
+      # http://rubular.com/r/qWCVVYZ31S
+      URL_WITH_OR_WITHOUT_HTTP = /(https?):\/\/.*|^[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,6}(:[0-9]{1,5})?(\/.*)?/
+
+      route(
+        URL_WITH_OR_WITHOUT_HTTP,
+        :register_link,
+        command: false
+      )
+
+      def register_link(r)
+        channel_name = "##{Lita::Room.find_by_id(r.room.id).name}"
+
+        return unless authorized_channel?(channel_name)
+
+        tags = [r.user.mention_name, channel_name.gsub('#', '')]
+        links = []
+        words = r.message.body.scan(/\S+|\n+/)
+
+        words.each do |word|
+          if word =~ URL_WITH_OR_WITHOUT_HTTP && !blacklist?(word)
+            link = save_link(word)
+            links << link.dup unless link.status == '409'
+          end
+        end
+
+        if links.any?
+          words.each do |word|
+            if word =~ /#(\S+)/
+              tags << $1
+            end
+          end
+
+          links.each do |link|
+            add_tags_to_link(link, tags)
+            r.reply(saved_link_message(tags))
+          end
+        end
+      end
+
+      private
+
+      def authorized_channel?(channel)
+        config.channels.include?(channel)
+      end
+
+      def blacklist?(url)
+        config.blacklist_domains.any? { |domain| url.match(domain) }
+      end
+
+      def save_link(url)
+        api.bookmark(url: url)
+      end
+
+      def add_tags_to_link(link, tags)
+        api.add_tags(
+          link.bookmark_id,
+          tags.join(',')
+        )
+      end
+
+      def api
+        @api ||= begin
+          Readit::Config.consumer_key = config.consumer_key
+          Readit::Config.consumer_secret = config.consumer_secret
+
+          Readit::API.new(
+            config.access_token,
+            config.access_token_secret
+          )
+        end
+      end
+
+      def saved_link_message(tags)
+        "*Tags*: #{tags.map { |tag| "##{tag}" }.join(' ')}"
+      end
+    end
+
+    Lita.register_handler(Readify)
+  end
+end

data/lita-readify.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-readify"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Loïc Delmaire"]
+  spec.email         = ["loic@hellojam.fr"]
+  spec.description   = "Automaticaly tracks links with tags on Readability"
+  spec.summary       = "Automaticaly tracks links with tags on Readability"
+  spec.homepage      = "https://github.com/blackbirdco/lita-readify"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  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 "lita", ">= 4.6"
+  spec.add_runtime_dependency "readit"
+
+  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:
+    handlers:
+      readify:

data/spec/lita/handlers/readify_spec.rb

@@ -0,0 +1,127 @@
+require "spec_helper"
+
+describe Lita::Handlers::Readify, lita_handler: true do
+  let(:user) { Lita::User.create("1234", name: "Loïc", mention_name: "skelz0r") }
+  let(:registry) do
+    reg = Lita::Registry.new
+
+    reg.register_handler(Lita::Handlers::Readify)
+
+    reg.configure do |config|
+      config.handlers.readify.consumer_key = "consumer_key"
+      config.handlers.readify.consumer_secret = "consumer_secret"
+      config.handlers.readify.access_token = "access_token"
+      config.handlers.readify.access_token_secret = "access_token_secret"
+      config.handlers.readify.blacklist_domains = ['google.com']
+      config.handlers.readify.channels = ['#veilles', '#veilles-tech']
+    end
+
+    reg
+  end
+
+  # https://www.readability.com/reading-list/all?tags=must-read
+  # https://www.readability.com/articles/3b7zsot2
+  describe "link registration (without command)" do
+    let(:channel) { "#veilles" }
+    let(:message) { "Check this out : #{url} #{tags.map { |tag| "##{tag}" }.join(' ')}" }
+
+    let(:url) { 'http://paulgraham.com/ds.html' }
+    let(:tags) { ["must-read", "startup"] }
+
+    let(:status) { '202' }
+    let(:bookmark_id) { "bookmark_id" }
+    let(:article_id) { "article_id" }
+
+    before do
+      Lita::Room.create_or_update(channel, name: channel.gsub('#', ''))
+
+      allow_any_instance_of(Readit::API).to receive(:bookmark).and_return(
+        OpenStruct.new(
+          status: status,
+          bookmark_id: bookmark_id,
+          article_id: article_id
+        )
+      )
+
+      allow_any_instance_of(Readit::API).to receive(:add_tags)
+    end
+
+    it { is_expected.to route(message).to(:register_link) }
+    it { is_expected.to route(url).to(:register_link) }
+    it { is_expected.to route("wow #{url}").to(:register_link) }
+    it { is_expected.to route("#{url} wow").to(:register_link) }
+
+    context "happy path" do
+      it "saves link" do
+        expect_any_instance_of(Readit::API).to receive(:bookmark).with(
+          url: url
+        )
+
+        send_message(message, as: user, from: channel)
+      end
+
+      it "adds all tags to newly link: inline, username and channel name" do
+        expect_any_instance_of(Readit::API).to receive(:add_tags).with(
+          bookmark_id,
+          ['skelz0r', 'veilles'].concat(tags).join(',')
+        )
+
+        send_message(message, as: user, from: channel)
+      end
+
+      it "replies with tags" do
+        send_message(message, as: user, from: channel)
+
+        expect(replies.last).to eq(
+          "*Tags*: #{['skelz0r', 'veilles'].concat(tags).map { |tag| "##{tag}" }.join(' ')}"
+        )
+      end
+    end
+
+    describe "when links already added (409)" do
+      let(:status) { '409' }
+
+      it "responds nothing" do
+        send_message(message, as: user, from: channel)
+
+        replies.count.should == 0
+      end
+    end
+
+    describe "with blacklist url" do
+      let(:url) { "https://www.google.com" }
+
+      it "responds nothing" do
+        send_message(message, as: user, from: channel)
+
+        replies.count.should == 0
+      end
+
+      it "doesn't save link" do
+        expect_any_instance_of(Readit::API).not_to receive(:bookmark)
+
+        send_message(message, as: user, from: channel)
+      end
+    end
+
+    describe "on not registered channel" do
+      let(:channel) { "#general" }
+
+      it "responds nothing" do
+        send_message(message, as: user, from: channel)
+
+        replies.count.should == 0
+      end
+
+      it "doesn't save link" do
+        expect_any_instance_of(Readit::API).not_to receive(:bookmark)
+
+        send_message(message, as: user, from: channel)
+      end
+    end
+  end
+
+  describe "add tag to link" do
+    # it { is_expected.to route().to(:add_tag_to_link) }
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: lita-readify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Loïc Delmaire
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: readit
+  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: 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: Automaticaly tracks links with tags on Readability
+email:
+- loic@hellojam.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-readify.rb
+- lib/lita/handlers/readify.rb
+- lita-readify.gemspec
+- locales/en.yml
+- spec/lita/handlers/readify_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/blackbirdco/lita-readify
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Automaticaly tracks links with tags on Readability
+test_files:
+- spec/lita/handlers/readify_spec.rb
+- spec/spec_helper.rb