voight_kampff 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aaad7c130bf25186c8a6f0d83b788b37dfd359f5
-  data.tar.gz: 65eaafd893c9e7b1043199bdb56b8df525509a6f
+SHA256:
+  metadata.gz: c69b1d4e546df4f4ab198fbec224b3cb55ac3bc5dfa8f89b02e98ce438335479
+  data.tar.gz: 18cf54d7053b41d3f9619b1cfdf851c0cc610fdba4a1996c54b9d3ede1b483e1
 SHA512:
-  metadata.gz: 90e012989497795cacb3357e6b3654ab5a0fa0e965e79b51868f7b23d0e9ca0788eb21e22cb8da8943622a654b74a6c1831ef01073c201d4991ca63c7137ae40
-  data.tar.gz: cf79235228114f2e1ff3125277823556591c7426058af965f4aff8e0ed85a583ac4cab8b2e7cd58a92fa4cecd9f1cc90ddf1af72d5c973e3b373a4cccd0e906f
+  metadata.gz: a23c1eb73c61bb1db3dd5c1f0a43f4a27cbbc39cf898d78b143dd15c924961454ff7da7041e79efe8aba3ac614eba973da46c6dfff9170d791ee8e6141474d1e
+  data.tar.gz: 020c12b9fdf01106b7997d3c1052304352da0930baadd2bee8382e59624bea3066f0637a9cf0fee0ef0b9fc4504461927b0e97ceb62d45f15804adc0801691d1

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+---
+name: CI
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 4 1 * *'
+
+jobs:
+  rspec:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.2'
+          - '3.1'
+          - '3.0'
+          - '2.7'
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: RSpec
+        run: bundle exec rspec

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+3.2.0

data/README.md

@@ -8,8 +8,21 @@ Voight-Kampff relies on a [user agent](http://en.wikipedia.org/wiki/User_agent)
 
 Installation
 ------------
+
 `gem install voight_kampff`
 
+If you're using Rails and want to add `ActionDispatch::Request#bot?` and `ActionDispatch::Request#human?` methods, require `voight_kampff/rails`:
+
+```Gemfile
+gem 'voight_kampff', require: 'voight_kampff/rails'
+```
+
+if you're using pure Rack, require it the following way:
+
+```Gemfile
+gem 'voight_kampff', require: 'voight_kampff/rack'
+```
+
 Configuration
 -------------
 
@@ -49,10 +62,27 @@ In general the `#bot?` command tends to include all of these and I'm sure it's u
 
 Also, the gem no longer extends `ActionDispatch::Request` instead it extends `Rack::Request` which `ActionDispatch::Request` inherits from. This allows the same functionality for Rails while opening the gem up to other rack-based projects.
 
+Upgrading to version 2.0
+------------------------
+
+If you use Rails and `ActionDispatch::Request#bot?` and `ActionDispatch::Request#human?` methods, change your gemfile:
+
+```diff
+-gem 'voight_kampff'
++gem 'voight_kampff', require: 'voight_kampff/rails'
+```
+
+If you use Rack, change your gemfile:
+
+```diff
+-gem 'voight_kampff'
++gem 'voight_kampff', require: 'voight_kampff/rack'
+```
+
 FAQ
 ---
 __Q:__ __What's with the name?__  
-__A:__ It's the [machine in Blade Runner](http://en.wikipedia.org/wiki/Blade_Runner#Voigt-Kampff_machine) that is used to test whether someone is a human or a replicant.
+__A:__ It's the [machine in Blade Runner](https://en.wikipedia.org/wiki/Blade_Runner#Voight-Kampff_machine) that is used to test whether someone is a human or a replicant.
 
 __Q:__ __I've found a bot that isn't being matched__  
 __A:__ The list is being pulled from [github.com/monperrus/crawler-user-agents](https://github.com/monperrus/crawler-user-agents).

data/lib/voight_kampff/rack.rb

@@ -0,0 +1,2 @@
+require 'voight_kampff'
+require 'voight_kampff/rack_request'

data/lib/voight_kampff/rails.rb

@@ -0,0 +1,3 @@
+require 'voight_kampff'
+require 'voight_kampff/rack'
+require 'voight_kampff/engine'

data/lib/voight_kampff/test.rb

@@ -33,7 +33,7 @@ module VoightKampff
     end
 
     def preferred_path
-      lookup_paths.find { |path| File.exists? path }
+      lookup_paths.find { |path| File.exist? path }
     end
 
     def matching_crawler

data/lib/voight_kampff/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VoightKampff
-  VERSION = '1.1.3'
+  VERSION = '2.0.0'
 end

data/lib/voight_kampff.rb

@@ -2,8 +2,6 @@ require 'json'
 
 require 'voight_kampff/test'
 require 'voight_kampff/methods'
-require 'voight_kampff/rack_request' if defined?(Rack::Request)
-require 'voight_kampff/engine' if defined?(Rails)
 
 module VoightKampff
   class << self

data/spec/lib/voight_kampff/test_spec.rb

@@ -30,7 +30,11 @@ describe VoightKampff::Test do
     before { VoightKampff::Test.new('anything').bot? }
 
     it 'is fast' do
-      expect(Benchmark.realtime { 20.times { VoightKampff::Test.new('anything').bot? } }).to be < 0.002
+      expect(
+        Benchmark.realtime do
+          20.times { VoightKampff::Test.new('anything').bot? }
+        end
+      ).to be < 0.005
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'bundler/setup'
 require 'combustion'
 require 'voight_kampff'
+require 'voight_kampff/rails'
 
 Combustion.initialize! :action_controller
 

data/voight_kampff.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {tests}/**/*`.split("\n")
   s.require_path  = 'lib'
 
-  s.add_dependency 'rack', ['>= 1.4', '< 3.0']
+  s.add_dependency 'rack', ['>= 1.4']
 
-  s.add_development_dependency 'rails', '~> 5.0'
-  s.add_development_dependency 'rspec-rails', '~> 3.3'
-  s.add_development_dependency 'combustion', '~> 0.5'
+  s.add_development_dependency 'combustion', '~> 1.1'
+  s.add_development_dependency 'rails', '>= 5.2'
+  s.add_development_dependency 'rspec-rails', '~> 3.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voight_kampff
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-30 00:00:00.000000000 Z
+date: 2023-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,57 +24,55 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: combustion
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.8'
 description: Voight-Kampff detects bots, spiders, crawlers and replicants
 email: adam@codenoble.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".ruby-version"
 - Gemfile
@@ -89,7 +84,9 @@ files:
 - lib/voight_kampff.rb
 - lib/voight_kampff/engine.rb
 - lib/voight_kampff/methods.rb
+- lib/voight_kampff/rack.rb
 - lib/voight_kampff/rack_request.rb
+- lib/voight_kampff/rails.rb
 - lib/voight_kampff/test.rb
 - lib/voight_kampff/version.rb
 - spec/controllers/replicants_controller_spec.rb
@@ -123,8 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Voight-Kampff bot detection