earch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d70708dd47c7958b3d2e0e556c3493137b2fa643
+  data.tar.gz: a9c8939b7c8e91b2932a7c453919ef45c7cb5688
+SHA512:
+  metadata.gz: abce2783f3230e9f4b7c2820800490098df9e0cd7225a8a331a2903e5f747082dc34863a6d6206ae4cd66e887ab6514c95d1bfc0f4fe8fda53ac1f524b3246d2
+  data.tar.gz: a55bad6542e710a01dc34f8baa759f863a85c74881166896f4cff46da2bdcb3f9150375e6efcfbfdef94db9a1b63005c20a5f9eb92030284053ec7c7cb5e3c0b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/setting.yml
+/test.json

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at flum.1025@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,5 @@
+from ruby:2.4-alpine
+
+RUN gem install earch
+
+CMD earch -s /setting.yml

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in earch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 flum1025
+
+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,111 @@
+# Earch
+
+This application monitors the Twitter timeline and notifies Slack according to the conditions.
+
+## Installation
+
+    $ gem install earch
+
+## Usage
+
+You must be prepared the configuration file first(The details will be described later). Save configuration file and run the following command.
+
+    $ earch -s setting.yml
+
+## Configuration File
+
+Configuration file is `YAML` format file. YAML key and their allowable values are described below.
+
+### Example
+
+```yaml
+twitter:
+  stream_options:
+    replies: all
+  screen_name: flum_        #require
+  api_key:
+    consumer_key:           #require
+    consumer_secret:        #require
+    access_token:           #require
+    access_token_secret:    #require
+slack:
+  api_key:
+    token:                  #require
+    websocket_ping: 5
+  user_icon: ':earch:'
+  notify_channel: '#earch'  #require
+  icon: ':flum_:'
+rules:                      #require
+  - text: !ruby/regexp /test.*/
+    screen_name: twitterdev
+  - hashtag:
+      - test
+      - events
+    favorite_count: 50
+  - lang: ja
+    retweet: false
+    quote: false
+    reply: true
+```
+
+### twitter
+
+This key is for `Twitter` configuration.
+
+Argument|Required|Description
+---|---|---
+stream_options|Optional|Refer to [Streaming API request parameters](https://dev.twitter.com/streaming/overview/request-parameters)
+api_key|Required|Get from [Twitter Application Management](https://apps.twitter.com/)
+
+### slack
+
+This key is for `Slack` configuration.
+
+Argument|Required|Description
+---|---|---
+api_key|Required|Get from [Bots](https://your-team.slack.com/apps/manage/custom-integrations)
+user_icon|Optional|Set the [Slack emoji](https://flum1025.slack.com/customize/emoji)
+notify_channel|Required|Specify the notification channel
+icon|Optional|Set your Twitter account icon
+
+### rules
+
+The value corresponding to a key is need to `Array`. You can use multiple rules and conditions.
+
+Argument|DataType|Example|Comments
+---|---|---|---
+text|String|`text: tweet text`
+||Regexp|`text: !ruby/regexp /^\d+$/`
+user_id|String|`user_id: "12345"`|Not a number
+user_name|String|`user_name: twitter name`
+||Regexp|`user_name: !ruby/regexp /^[A-Z]+$/`
+screen_name|String|`screen_name: screen name`
+||Regexp|`screen_name: !ruby/regexp /^@test[0-9]+/`
+favorite_count|Integer|`favorite_count: 50`|Get over 50 the number of favorites
+||Range|`favorite_count: !ruby/range 10..20`|The number of favorites is 10 to 20
+retweet_count|Integer|`retweet_count: 50`
+||Range|`retweet_count: !ruby/range 10..20`
+lang|String|`lang: ja`
+||Regexp|`lang: !ruby/regexp /(ja\|en)/`
+user_lang|String|`user_lang: ja`
+||Regexp|`user_lang: !ruby/regexp /(ja\|en)/`
+source|Array\<String>|`source: [TweetDeck, Twitter for WEB]`
+hashtag|Array\<String>|`source: [test, memo]`|
+mention|Array\<String>|`source: [twitter, twitterdev]`|String for screen_name
+||Array\<Integer>|`source: [123, 456]`|Integer for id
+reply|Boolean|`reply: false`
+quote|Boolean|`quote: false`
+retweet|Boolean|`retweet: false`
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/earch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Earch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/earch/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "earch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,5 @@
+earch:
+  build: ./
+  restart: always
+  volumes:
+    - "./setting.yml:/setting.yml"

data/earch.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "earch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "earch"
+  spec.version       = Earch::VERSION
+  spec.authors       = ["flum1025"]
+  spec.email         = ["flum.1025@gmail.com"]
+
+  spec.summary       = %q{Twitter timeline notify}
+  spec.description   = %q{This application monitors the Twitter timeline and notifies Slack according to the conditions.}
+  spec.homepage      = "https://github.com/flum1025/earch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency 'twitter'
+  spec.add_dependency 'twitter-stream-patch'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'slack-ruby-client'
+end

data/exe/earch

@@ -0,0 +1,24 @@
+if $0 == __FILE__
+  $:.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'optparse'
+require 'earch'
+
+Parameter = Hash.new
+
+def optparse
+  opt = OptionParser.new
+  opt.program_name = "Earch"
+  opt.version = Earch::VERSION
+  opt.on('-d VALUES', '--debug VALUES', 'debug'){|v|Parameter[:debug] = v}
+  opt.on('-s VALUES', '--setting VALUES', 'setting file'){|v|Parameter[:file] = v}
+  opt.parse!(ARGV)
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+  STDERR.puts e.message
+  exit false
+end
+
+optparse
+earch = Earch.new(Parameter[:file])
+Parameter[:debug] ? earch.debug(File.read(Parameter[:debug])) : earch.start

data/lib/earch.rb

@@ -0,0 +1,72 @@
+require "earch/version"
+require "earch/rule"
+require "twitter"
+require "twitter-stream-patch"
+require "hashie"
+require "slack-ruby-client"
+require "optparse"
+
+class Earch
+  def initialize(file)
+    @setting = Hashie::Mash.load(file)
+    @rules = Rules.new(@setting.rules)
+    @stream_client = Twitter::Streaming::Client.new @setting.twitter.api_key
+    @slack_client = Slack::Web::Client.new(@setting.slack.api_key)
+  end
+
+  def start
+    @stream_client.user(@setting.twitter.stream_options) do |object|
+      case object
+      when Twitter::Tweet
+        execute(object)
+      end
+    end
+  rescue SignalException, Interrupt
+  rescue Twitter::Error::ServerError, EOFError, Errno::EPIPE
+    sleep 1
+    retry
+  end
+
+  def debug(json)
+    Slack::Web::Client.class_eval do
+      define_method :chat_postMessage{|*args|p args}
+    end
+    execute(Twitter::Tweet.new(JSON.parse(json, {:symbolize_names => true})))
+  end
+
+  private
+  def execute(object)
+    if @rules.match?(object)
+      notify(object)
+    end
+  end
+
+  def notify(object)
+    @slack_client.chat_postMessage(
+      icon_emoji: @setting.slack.user_icon,
+      username: 'Earch',
+      channel: @setting.slack.notify_channel,
+      attachments: notify_content(object)
+    )
+  end
+
+  def notify_content(object)
+    [
+      {
+        "fallback": "#{object.text} by @#{object.user.screen_name}",
+        "color": "#4169e1",
+        "author_name": "#{object.user.name}(@#{object.user.screen_name})",
+        "author_link": object.user.url,
+        "author_icon": object.user.profile_image_url_https,
+        "text": object.text,
+        "fields": [
+          {
+            "value": "<#{object.url}|Tweet>",
+          }
+        ],
+        "footer": "#{@setting.slack.icon} #{@setting.twitter.screen_name}",
+        "ts": object.created_at.to_f
+      }
+    ]
+  end
+end

data/lib/earch/rule.rb

@@ -0,0 +1,98 @@
+class Rules
+  class Rule
+    def initialize(rule)
+      @rule = rule
+    end
+
+    def match?(object)
+      @rule.map{|k,v|send(k, v, object)}.all?
+    end
+
+    private
+    def text(rule, object)
+      compare(rule, object.text)
+    end
+
+    def user_id(rule, object)
+      compare(rule, object.user.id_str)
+    end
+
+    def user_name(rule, object)
+      compare(rule, object.user)
+    end
+
+    def screen_name(rule, object)
+      compare(rule, object.screen_name)
+    end
+
+    def favorite_count(rule, object)
+      compare(rule, object.favorite_count)
+    end
+
+    def retweet_count(rule, object)
+      compare(rule, object.retweet_count)
+    end
+
+    def lang(rule, object)
+      compare(rule, object.lang)
+    end
+
+    def user_lang(rule, object)
+      compare(rule, object.user.lang)
+    end
+
+    def source(rule, object)
+      compare(rule, object.source.gsub(/<(.+)\">/,"").gsub(/<\/a>/,""))
+    end
+
+    def reply(rule, object)
+      compare(rule, object.reply?)
+    end
+
+    def hashtag(rule, object)
+      compare(rule, object.hashtags.map{|h|h.text})
+    end
+
+    def mention(rule, object)
+      if !rule.nil? && !rule.empty?
+        key = rule.first.is_a?(Integer) ? :id : :screen_name
+        compare(rule, object.user_mentions.map{|h|h.send(key)})
+      end
+    end
+
+    def quote(rule, object)
+      compare(rule, object.quote?)
+    end
+
+    def retweet(rule, object)
+      compare(rule, object.retweet?)
+    end
+
+    def compare(rule, target)
+      case rule
+      when Regexp
+        rule =~ target
+      when Integer
+        rule <= target
+      when Range
+        rule.include?(target)
+      when Array
+        if target.is_a?(Array)
+          !(rule & target).empty?
+        else
+          rule.include?(target)
+        end
+      else
+        rule == target
+      end
+    end
+  end
+
+  def initialize(rules)
+    @rules = rules.map{|rule|Rule.new(rule)}
+  end
+
+  def match?(object)
+    @rules.find{|rule|rule.match?(object)}
+  end
+end

data/lib/earch/version.rb

@@ -0,0 +1,3 @@
+class Earch
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: earch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- flum1025
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: twitter
+  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: twitter-stream-patch
+  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: hashie
+  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: slack-ruby-client
+  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'
+description: This application monitors the Twitter timeline and notifies Slack according
+  to the conditions.
+email:
+- flum.1025@gmail.com
+executables:
+- earch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- earch.gemspec
+- exe/earch
+- lib/earch.rb
+- lib/earch/rule.rb
+- lib/earch/version.rb
+homepage: https://github.com/flum1025/earch
+licenses:
+- MIT
+metadata: {}
+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: Twitter timeline notify
+test_files: []