ruboty-twitter_search 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f88bd9756ef6329faba9bf3512d885b66cf4397b
-  data.tar.gz: a75d64d9f6698a997f69502ece9a7b06b38f1756
+  metadata.gz: a101873c2cb41d5d728cf61262f77bf2a5e3d890
+  data.tar.gz: c29ce2d0503b71933e1e92edcdc549684afebb8f
 SHA512:
-  metadata.gz: 4c60fd7d4eb1435fb19902697d14ad320ac303c32dd39d106df76c73263a7a4554c1f8e91d7f7064f5f69356f05b6135dad2ea0130e64e8558dcc411a255ceeb
-  data.tar.gz: 776e7c14ca411273fd9c95cb588d77345d32087fc62c376e295a0138307ae85fd3081e4e5fbb5c388748a9af29755580d445fa87af0013837df46b8242d7855e
+  metadata.gz: 9725086905c97364564ffda709cb6ef96827771755e5b4e597d45d5efac9c8f46c3e5a403e7fe7803656142730cc1581914354dd244dbe738a010cffc4b43190
+  data.tar.gz: 239e4ae74c634f5fa15653e977f69f766cfeb2768a8b3112d867428014e989c7ac79ce6f0b2f26c7da17403cb71f65db809649201a4e752bb3de42fd45aefde3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,68 @@
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/EnsureReturn:
+  Enabled: false
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+Style/SignalException:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingComma:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+- 2.2.0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.0
+- Support search filter query (Thx @gong023)
+
 ## 0.0.4
 - Fix bug on v0.0.3
 

data/Gemfile

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

data/README.md

@@ -1,30 +1,21 @@
-# Ruboty::TwitterSearch
+# Ruboty::TwitterSearch [![Build Status](https://travis-ci.org/r7kamura/ruboty-twitter_search.svg)](https://travis-ci.org/r7kamura/ruboty-twitter_search)
 [Ruboty](https://github.com/r7kamura/ruboty-twitter_search) plug-in to search twitter.
 
 ## Usage
+Search with given query and show tweet URLs.  
+(Note: `since_id` will be stored in ruboty's brain to same query by default)
+
 ```
 @ruboty search twitter by <query>
 ```
 
 ### Example
 ```
-$ bundle exec ruboty --dotenv
-Type `exit` or `quit` to end the session.
-> @ruboty search twitter by sushi
-https://twitter.com/meshiumaa/status/573806861956214786
-https://twitter.com/yijinglai/status/573806872169291777
-https://twitter.com/bone_sushi/status/573806877340893184
-https://twitter.com/namaakubi_/status/573806888015388672
-https://twitter.com/NIGIRE_sushi/status/573806891211452416
-https://twitter.com/Rymdensbarn/status/573806901722488832
-https://twitter.com/SmaltimoreMD/status/573806917316968448
-https://twitter.com/ornat/status/573806982852968448
-https://twitter.com/kelZoom/status/573806985805754368
-https://twitter.com/DT_Hanmer/status/573807032286973952
-> @ruboty search twitter by sushi
-https://twitter.com/Sushi_sweetegg/status/573807039224279040
-> @ruboty search twitter by sushi
->
+@ruboty search twitter by sushi
+@ruboty search twitter by sushi fav:10
+@ruboty search twitter by sushi retweet:20
+@ruboty search twitter by sushi result_type:popular
+@ruboty search twitter by sushi result_type:mixed
 ```
 
 ## ENV

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:style)
+task default: [:style, :spec]

data/lib/ruboty/handlers/twitter_search.rb

@@ -1,11 +1,11 @@
 require "ruboty"
 require "twitter"
-require "yaml"
 
 module Ruboty
   module Handlers
     class TwitterSearch < Base
       NAMESPACE = "twitter-search"
+      TWEETS_COUNT = 10
 
       env :TWITTER_ACCESS_TOKEN, "Twitter access token"
       env :TWITTER_ACCESS_TOKEN_SECRET, "Twitter access token secret"
@@ -21,7 +21,22 @@ module Ruboty
 
       # @return [true] to prevent running missing handlers.
       def search(message)
-        statuses = client.search(message[:query], since_id: fetch_since_id_for(message[:query])).take(10)
+        query = Query.new(message[:query])
+
+        statuses = client.search(
+          query.query_string,
+          result_type: query.result_type,
+          since_id: fetch_since_id_for(message[:query]),
+        ).take(TWEETS_COUNT)
+
+        statuses.select! do |status|
+          status.retweet_count >= query.minimum_retweet_count
+        end
+
+        statuses.select! do |status|
+          status.favorite_count >= query.minimum_favorite_count
+        end
+
         if statuses.any?
           message.reply(StatusesView.new(statuses).to_s)
           store_since_id(query: message[:query], since_id: statuses.first.id)
@@ -66,6 +81,55 @@ module Ruboty
         end
       end
 
+      class Query
+        DEFAULT_MINIMUM_FAVORITE_COUNT = 0
+        DEFAULT_MINIMUM_RETWEET_COUNT = 0
+
+        # @param [String] original_query_string
+        def initialize(original_query_string)
+          @original_query_string = original_query_string
+        end
+
+        # @return [Fixnum]
+        def minimum_favorite_count
+          if token = tokens.find(&:favorite_count_filter?)
+            token.favorite_count
+          else
+            DEFAULT_MINIMUM_FAVORITE_COUNT
+          end
+        end
+
+        # @return [Fixnum]
+        def minimum_retweet_count
+          if token = tokens.find(&:retweet_count_filter?)
+            token.retweet_count
+          else
+            DEFAULT_MINIMUM_RETWEET_COUNT
+          end
+        end
+
+        # @return [String]
+        def query_string
+          tokens.reject(&:filter?).join(" ")
+        end
+
+        # @return [String, nil]
+        def result_type
+          if token = tokens.find(&:result_type_filter?)
+            token.result_type
+          end
+        end
+
+        private
+
+        # @return [Array<Ruboty::Handlers::TwitterSearch::Token>]
+        def tokens
+          @tokens ||= @original_query_string.split.map do |token_string|
+            Token.new(token_string)
+          end
+        end
+      end
+
       class StatusesView
         def initialize(statuses)
           @statuses = statuses
@@ -83,6 +147,53 @@ module Ruboty
           end
         end
       end
+
+      class Token
+        def initialize(token_string)
+          @token_string = token_string
+        end
+
+        # @return [Fixnum, nil]
+        def favorite_count
+          if @token_string.match(/\Afav:(?<count>\d+)\z/)
+            Regexp.last_match(:count).to_i
+          end
+        end
+
+        def favorite_count_filter?
+          !favorite_count.nil?
+        end
+
+        def filter?
+          favorite_count_filter? || result_type_filter? || retweet_count_filter?
+        end
+
+        # @return [String, nil]
+        def result_type
+          if @token_string.match(/\Aresult_type:(?<type>\w+)\z/)
+            Regexp.last_match(:type)
+          end
+        end
+
+        def result_type_filter?
+          !result_type.nil?
+        end
+
+        # @return [Fixnum, nil]
+        def retweet_count
+          if @token_string.match(/\Aretweet:(?<count>\d+)\z/)
+            Regexp.last_match(:count).to_i
+          end
+        end
+
+        def retweet_count_filter?
+          !retweet_count.nil?
+        end
+
+        def to_s
+          @token_string
+        end
+      end
     end
   end
 end

data/lib/ruboty/twitter_search/version.rb

@@ -1,5 +1,5 @@
 module Ruboty
   module TwitterSearch
-    VERSION = "0.0.4"
+    VERSION = "0.1.0"
   end
 end

data/ruboty-twitter_search.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "twitter"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.2.0"
+  spec.add_development_dependency "rubocop", "0.29.1"
 end

data/spec/ruboty/handlers/twitter_search/query_spec.rb

@@ -0,0 +1,165 @@
+RSpec.describe Ruboty::Handlers::TwitterSearch::Query do
+  let(:query) do
+    described_class.new(original_string)
+  end
+
+  describe "#minimum_favorite_count" do
+    subject do
+      query.minimum_favorite_count
+    end
+
+    context "with favorite count filter" do
+      let(:original_string) do
+        "a fav:10"
+      end
+
+      it { is_expected.to eq 10 }
+    end
+
+    context "without favorite count filter" do
+      let(:original_string) do
+        "a"
+      end
+
+      it { is_expected.to eq 0 }
+    end
+  end
+
+  describe "#minimum_retweet_count" do
+    subject do
+      query.minimum_retweet_count
+    end
+
+    context "with retweet count filter" do
+      let(:original_string) do
+        "a retweet:10"
+      end
+
+      it { is_expected.to eq 10 }
+    end
+
+    context "without retweet count filter" do
+      let(:original_string) do
+        "a"
+      end
+
+      it { is_expected.to eq 0 }
+    end
+  end
+
+  describe "#query_string" do
+    subject do
+      query.query_string
+    end
+
+    context "with simple string" do
+      let(:original_string) do
+        "a"
+      end
+
+      it { is_expected.to eq "a" }
+    end
+
+    context "with empty string" do
+      let(:original_string) do
+        ""
+      end
+
+      it { is_expected.to eq "" }
+    end
+
+    context "with space-separated string" do
+      let(:original_string) do
+        "a b"
+      end
+
+      it { is_expected.to eq "a b" }
+    end
+
+    context "with spaces-separated string" do
+      let(:original_string) do
+        "a  b"
+      end
+
+      it { is_expected.to eq "a b" }
+    end
+
+    context "with tab-separated string" do
+      let(:original_string) do
+        "a\tb"
+      end
+
+      it { is_expected.to eq "a b" }
+    end
+
+    context "with favorite count filter" do
+      let(:original_string) do
+        "a fav:10"
+      end
+
+      it { is_expected.to eq "a" }
+    end
+
+    context "with invalid favorite count filter" do
+      let(:original_string) do
+        "a fav:b"
+      end
+
+      it { is_expected.to eq "a fav:b" }
+    end
+
+    context "with retweet count filter" do
+      let(:original_string) do
+        "a retweet:10"
+      end
+
+      it { is_expected.to eq "a" }
+    end
+
+    context "with invalid retweet count filter" do
+      let(:original_string) do
+        "a retweet:b"
+      end
+
+      it { is_expected.to eq "a retweet:b" }
+    end
+
+    context "with result type filter" do
+      let(:original_string) do
+        "a result_type:popular"
+      end
+
+      it { is_expected.to eq "a" }
+    end
+
+    context "with invalid retweet count filter" do
+      let(:original_string) do
+        "a result_type:b-c"
+      end
+
+      it { is_expected.to eq "a result_type:b-c" }
+    end
+  end
+
+  describe "#result_type" do
+    subject do
+      query.result_type
+    end
+
+    context "with result type filter" do
+      let(:original_string) do
+        "a result_type:popular"
+      end
+
+      it { is_expected.to eq "popular" }
+    end
+
+    context "without result type filter" do
+      let(:original_string) do
+        "a"
+      end
+
+      it { is_expected.to be_nil }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "ruboty/twitter_search"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.warnings = true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboty-twitter_search
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruboty
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.29.1
 description: 
 email:
 - r7kamura@gmail.com
@@ -74,6 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -83,6 +114,8 @@ files:
 - lib/ruboty/twitter_search.rb
 - lib/ruboty/twitter_search/version.rb
 - ruboty-twitter_search.gemspec
+- spec/ruboty/handlers/twitter_search/query_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/r7kamura/ruboty-twitter_search
 licenses:
 - MIT
@@ -107,5 +140,7 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruboty plug-in to search twitter.
-test_files: []
+test_files:
+- spec/ruboty/handlers/twitter_search/query_spec.rb
+- spec/spec_helper.rb
 has_rdoc: