twing_earch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 586fdf7ef41deba96a0533e2abebbc1cfbf2e970
+  data.tar.gz: c3133c0d61f1a8d6f05780223710cd4cc1aaf031
+SHA512:
+  metadata.gz: ec33c407118478de09a18b43c87774a4f2ce88e9187d746a6813f2336ff5ee103d5c9beb002d5015c0fe655c6403808544390bc079d67ebc4e9b5a3a97f283e4
+  data.tar.gz: 840a63920248958a29c4000a09f4bd0188ba61b0185b27a43e5ea0979a06a70e39e761a23d49441a850e36bc5cff0b1a2e0a61472c4d94ecad7cdce116574877

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor

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/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twing_earch.gemspec
+gemspec
+
+gem 'twing', :path => '../twing'

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: ../twing
+  specs:
+    twing (0.1.0)
+      hashie
+      redis-namespace
+      redis-objects
+      twitter
+
+PATH
+  remote: .
+  specs:
+    twing_earch (0.1.0)
+      slack-ruby-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    buftok (0.2.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    equalizer (0.0.11)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    gli (2.17.2)
+    hashie (3.6.0)
+    http (3.3.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    naught (1.1.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    redis (4.0.2)
+    redis-namespace (1.6.0)
+      redis (>= 3.0.4)
+    redis-objects (1.4.0)
+      redis (~> 4.0)
+    simple_oauth (0.3.1)
+    slack-ruby-client (0.11.1)
+      activesupport
+      faraday (>= 0.9)
+      faraday_middleware
+      gli
+      hashie
+      websocket-driver
+    thread_safe (0.3.6)
+    twitter (6.2.0)
+      addressable (~> 2.3)
+      buftok (~> 0.2.0)
+      equalizer (~> 0.0.11)
+      http (~> 3.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+      memoizable (~> 0.4.0)
+      multipart-post (~> 2.0)
+      naught (~> 1.0)
+      simple_oauth (~> 0.3.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  twing!
+  twing_earch!
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 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,108 @@
+# TwingEarch
+
+This application monitors the Twitter timeline and notifies Slack according to the conditions.
+
+<img width="631" alt="2017-08-25 11 28 11" src="https://user-images.githubusercontent.com/9972700/29697194-a281ca3e-8988-11e7-9027-67449a9e2e34.png">
+
+Migration from [earch](https://github.com/flum1025/earch)
+
+## Installation
+
+Add this line to your application's Gemfile
+
+    $ gem install twing_earch
+
+## Usage
+
+Add configuration
+
+REF: [twing#configuration-file](https://github.com/flum1025/twing#configuration-file)
+
+Example
+
+```yaml
+modules:
+  earch:
+    slack:
+      api_key:
+        token: xxxxxxxxxxxxxxxxxxxxx
+      user_icon: ':earch:'
+      notify_channel: '#earch'
+      icon: ':flum_:'
+      source_user: flum_
+    rules:
+      - text:
+          type: regexp
+          match test.*
+        screen_name: twitterdev
+      - hashtag:
+          - test
+          - events
+        favorite_count: 50
+      - retweet_count:
+          type: range
+          match 0..10
+      - lang: ja
+        retweet: false
+        quote: false
+        reply: true
+```
+
+And, run
+
+    $ twing -s setting.yml --home-timeline --earch
+
+## Configuration File
+
+### 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
+source_user|Optional|Set your Twitter screen_name
+
+### 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:`<br>&nbsp;&nbsp;`type: regexp`<br>&nbsp;&nbsp;`  match: ^\d+$`
+user_id|String|`user_id: "12345"`|Not a number
+user_name|String|`user_name: twitter name`
+||Regexp|`user_name:`<br>&nbsp;&nbsp;`type: regexp`<br>&nbsp;&nbsp;`  match: ^[A-Z]+$`
+screen_name|String|`screen_name: screen name`
+||Regexp|`screen_name:`<br>&nbsp;&nbsp;`type: regexp`<br>&nbsp;&nbsp;`  match: ^@test[0-9]+`
+favorite_count|Integer|`favorite_count: 50`|Get over 50 the number of favorites
+||Range|`favorite_count:`<br>&nbsp;&nbsp;`type: range`<br>&nbsp;&nbsp;`  match: 10..20`|The number of favorites is 10 to 20
+retweet_count|Integer|`retweet_count: 50`
+||Range|`retweet_count:`<br>&nbsp;&nbsp;`type: range`<br>&nbsp;&nbsp;`  match: 10..20`
+lang|String|`lang: ja`
+||Regexp|`lang:`<br>&nbsp;&nbsp;`type: regexp`<br>&nbsp;&nbsp;`  match: ja\|en`
+user_lang|String|`user_lang: ja`
+||Regexp|`user_lang:`<br>&nbsp;&nbsp;`type: regexp`<br>&nbsp;&nbsp;`  match: 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/flum1025/twing_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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TwingEarch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/flum1025/twing_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 "twing_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/lib/twing_earch.rb

@@ -0,0 +1,8 @@
+require 'twing_earch/version'
+require 'twing_earch/earch'
+
+Twing.on_init do |app|
+  app.cli.initializer.add(:earch, '--earch', 'start earch') do
+    app.receivers.add(Earch)
+  end
+end

data/lib/twing_earch/earch.rb

@@ -0,0 +1,28 @@
+require 'twing/modules/base'
+
+class Earch < Twing::Modules::Base
+  require 'twing_earch/notify'
+  require 'twing_earch/rules'
+
+  attr_reader :notify, :rules
+
+  def initialize(*args)
+    super
+    @notify = Notify.new(setting.slack)
+    @rules = Rules.new(setting.rules || {})
+  end
+
+  def on_message(object)
+    case object
+    when Twitter::Tweet
+      logger.debug("Tweet #{object.id}")
+      execute(object)
+    end
+  end
+
+  private
+
+  def execute(object)
+    notify.notify(object) if rules.match?(object)
+  end
+end

data/lib/twing_earch/notify.rb

@@ -0,0 +1,39 @@
+require 'slack-ruby-client'
+
+class Earch::Notify
+  attr_reader :client, :setting
+
+  def initialize(setting)
+    @setting = setting
+    @client = Slack::Web::Client.new(setting.api_key)
+  end
+
+  def notify(object)
+    client.chat_postMessage(
+      icon_emoji: setting.user_icon,
+      username: 'Earch',
+      channel: setting.notify_channel,
+      attachments: body(object)
+    )
+  end
+
+  def body(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.icon} #{setting.source_user}",
+        ts: object.created_at.to_f
+      }
+    ]
+  end
+end

data/lib/twing_earch/rule.rb

@@ -0,0 +1,102 @@
+class Earch::Rule
+  def initialize(rule)
+    @rule = rule
+  end
+
+  def match?(object)
+    @rule.map { |k,v| send(k, parse(v), object )}.all?
+  end
+
+  private
+
+  def parse(condition)
+    if condition.is_a?(Hash)
+      [:type, :match].each do |key|
+        raise ArgumentError, "'#{key}' key not found" if condition.send(key).nil?
+      end
+
+      return Regexp.new(condition.match) if condition.type == 'regexp'
+      return Range.new(*condition.match.split('..').map(&:to_i)) if condition.type == 'range'
+    end
+
+    condition
+  end
+
+  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.name)
+  end
+
+  def screen_name(rule, object)
+    compare(rule, object.user.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

data/lib/twing_earch/rules.rb

@@ -0,0 +1,15 @@
+require 'twing_earch/rule'
+
+class Earch
+  class Rules
+    attr_reader :rules
+
+    def initialize(rules)
+      @rules = rules.map { |rule| Rule.new(rule) }
+    end
+
+    def match?(object)
+      rules.find { |rule| rule.match?(object) }
+    end
+  end
+end

data/lib/twing_earch/version.rb

@@ -0,0 +1,3 @@
+module TwingEarch
+  VERSION = "0.1.0"
+end

data/twing_earch.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twing_earch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'twing_earch'
+  spec.version       = TwingEarch::VERSION
+  spec.authors       = ['flum1025']
+  spec.email         = ['flum.1025@gmail.com']
+  spec.summary       = 'Earch for Twing'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/flum1025/twing_earch'
+  spec.license       = 'MIT'
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_dependency 'slack-ruby-client'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: twing_earch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- flum1025
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: Earch for Twing
+email:
+- flum.1025@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twing_earch.rb
+- lib/twing_earch/earch.rb
+- lib/twing_earch/notify.rb
+- lib/twing_earch/rule.rb
+- lib/twing_earch/rules.rb
+- lib/twing_earch/version.rb
+- twing_earch.gemspec
+homepage: https://github.com/flum1025/twing_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: Earch for Twing
+test_files: []