legitbot 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88b7c118fb39080f7bbed1839c41173f67501f816ccc2409378a0c974e353633
-  data.tar.gz: cd97cd5656347126b11999d38c450fd35ce88a523186c01d4a8417aa7bf9edd6
+  metadata.gz: 48fa3cd6d810e32c24c3027b57879438c658b64bdf2dfae3fbbcfd5ac67fb790
+  data.tar.gz: f8b77b3571978137339b06e633c9725ee8d1f4f6793bcdae8321a16cb9b37dfd
 SHA512:
-  metadata.gz: 45cebed5ce8a638612496ca824eb3706e7f198ea4b1a0e394a62eb41b2069d0a28ae44d226897373ef7747dfe44926263dbfc1e6ea2620908c2d341d70f75e09
-  data.tar.gz: d008044692ddfb2dc31b03d3d91eb3c6de3d79f0888e093432a27233d4a8c944e0bc7e951857c8a6663670047f0518565a8f128375ea658ab99c8ba3f1a01723
+  metadata.gz: ff62eb5208ee4e565504ada36c3d94129171f2487c5cf61e3cfbc5388a189ab5e5645537d311a01376e16abd486d69c465d148d6a4ebf35f5cf5d4c51a212bd8
+  data.tar.gz: c3a9d54b1add735629ac5caaf744c8bb75d2d9fa88fe5e793bd351e860cf00ef39cb084eb3bb048fe34b1ab9d95dec66eb08b075b9ee0bd7657e0160873f24bb

data/README.md

@@ -1,13 +1,11 @@
 # Legitbot ![](https://github.com/alaz/legitbot/workflows/build/badge.svg) ![](https://badge.fury.io/rb/legitbot.svg)
 
-Ruby gem to check that an IP belongs to a bot, typically a search
-engine. This can be of help in protecting a web site from fake search
-engines.
+Ruby gem to make sure that an IP really belongs to a bot, typically a search
+engine.
 
 ## Usage
 
-Suppose you have a Web request and you'd like to make sure it's not from a fake
-search engine:
+Suppose you have a Web request and you would like to check it is not diguised:
 
 ```ruby
 bot = Legitbot.bot(userAgent, ip)
@@ -22,7 +20,7 @@ bot.valid? # => true
 bot.fake? # => false
 ```
 
-Sometimes you already know what search engine to expect. For example, you might
+Sometimes you already know which search engine to expect. For example, you might
 be using [rack-attack](https://github.com/kickstarter/rack-attack):
 
 ```ruby
@@ -31,8 +29,8 @@ Rack::Attack.blocklist("fake Googlebot") do |req|
 end
 ```
 
-Or if you do not like all these nasty crawlers stealing your content or
-maybe evaluating it and getting ready to invade your site with spammers,
+Or if you do not like all those ghoulish crawlers stealing your
+content, evaluating it and getting ready to invade your site with spammers,
 then block them all:
 
 ```ruby
@@ -55,6 +53,7 @@ end
 * [Pinterest](https://help.pinterest.com/en/articles/about-pinterest-crawler-0)
 * [Twitterbot](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/guides/getting-started), the list of IPs is in the [Troubleshooting page](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/guides/troubleshooting-cards)
 * [Yandex robots](https://yandex.com/support/webmaster/robot-workings/check-yandex-robots.xml)
+* [Petal search engine](http://aspiegel.com/petalbot)
 
 ## License
 

data/legitbot.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bump', '~> 0.8', '>= 0.8.0'
   spec.add_development_dependency 'minitest', '~> 5.1', '>= 5.1.0'
   spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.0'
-  spec.add_development_dependency 'rubocop', '~> 1.15.0', '>= 1.15.0'
+  spec.add_development_dependency 'rubocop', '~> 1.18.0', '>= 1.18.0'
 
   spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.rdoc_options = ['--charset=UTF-8']

data/lib/legitbot.rb

@@ -15,3 +15,4 @@ require_relative 'legitbot/oracle'
 require_relative 'legitbot/pinterest'
 require_relative 'legitbot/twitter'
 require_relative 'legitbot/yandex'
+require_relative 'legitbot/petalbot'

data/lib/legitbot/petalbot.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Legitbot # :nodoc:
+  # http://aspiegel.com/petalbot
+  # https://webmaster.petalsearch.com/site/petalbot
+  class Petalbot < BotMatch
+    domains 'petalsearch.com.'
+  end
+
+  rule Legitbot::Petalbot, %w[PetalBot]
+end

data/lib/legitbot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Legitbot
-  VERSION = '1.4.1'
+  VERSION = '1.4.2'
 end

data/test/petalbot_test.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'legitbot'
+
+class PetalbotTest < Minitest::Test
+  def test_malicious_ip
+    ip = '149.210.164.47'
+    match = Legitbot::Petalbot.new ip
+    assert !match.valid?, msg: "#{ip} is not a real Petalbot IP"
+  end
+
+  def test_valid_ip
+    ip = '114.119.128.10'
+    match = Legitbot::Petalbot.new ip
+    assert match.valid?, msg: "#{ip} is a valid Petalbot IP"
+  end
+
+  def test_malicious_ua
+    bot = Legitbot.bot(
+      'Mozilla/5.0 (compatible;PetalBot; +https://aspiegel.com/petalbot)',
+      '149.210.164.47'
+    )
+    assert bot, msg: 'Petalbot detected from User-Agent'
+    assert !bot.valid?, msg: 'Not a valid Petalbot'
+  end
+
+  def test_valid_ua
+    bot = Legitbot.bot(
+      'Mozilla/5.0 (compatible;PetalBot; +https://aspiegel.com/petalbot)',
+      '114.119.128.10'
+    )
+    assert bot, msg: 'Petalbot detected from User-Agent'
+    assert bot.valid?, msg: 'Valid Petalbot'
+  end
+
+  def test_valid_name
+    bot = Legitbot.bot(
+      'Mozilla/5.0 (compatible;PetalBot; +https://aspiegel.com/petalbot)',
+      '66.249.64.141'
+    )
+    assert_equal :petalbot, bot.detected_as
+  end
+
+  def test_fake_name
+    bot = Legitbot.bot(
+      'Mozilla/5.0 (compatible; PetalBot/2.1; +http://www.google.com/bot.html)',
+      '81.1.172.108'
+    )
+    assert_equal :petalbot, bot.detected_as
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: legitbot
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Alexander Azarov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: augmented_interval_tree
@@ -116,20 +116,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.18.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.18.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.18.0
 description: Does Web request come from a real search engine or from an impersonating
   agent?
 email: self@alaz.me
@@ -160,6 +160,7 @@ files:
 - lib/legitbot/google.rb
 - lib/legitbot/legitbot.rb
 - lib/legitbot/oracle.rb
+- lib/legitbot/petalbot.rb
 - lib/legitbot/pinterest.rb
 - lib/legitbot/twitter.rb
 - lib/legitbot/validators/domains.rb
@@ -176,6 +177,7 @@ files:
 - test/legitbot/validators/ip_ranges_test.rb
 - test/legitbot_test.rb
 - test/oracle_test.rb
+- test/petalbot_test.rb
 - test/pinterest_test.rb
 - test/twitter_test.rb
 homepage: https://github.com/alaz/legitbot
@@ -212,6 +214,7 @@ test_files:
 - test/apple_test.rb
 - test/oracle_test.rb
 - test/google_test.rb
+- test/petalbot_test.rb
 - test/botmatch_test.rb
 - test/facebook_test.rb
 - test/twitter_test.rb