cloudflare-rails 2.4.0.pre.beta.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1a2e44d7bd29c0dc2341b7faf87c656a21ddb96396a611076ba9ddfae79c65c
-  data.tar.gz: 34b4900fc88e75206feeed25e1e5e43c88343e4a655b8fd8a1f28b71389642d3
+  metadata.gz: 9f6d6411a565dbb86d9a6c07ac4d54d081111e2cb8ba879fcc212923cbea7697
+  data.tar.gz: 2c7104876a1415d654d71e073c58b973ea4d3391fa91ff40d9381b6fdd300d79
 SHA512:
-  metadata.gz: 34575cf27372171d29709ae245d9527fd1a3fd0f7c696b3a1a759d55277708241b12270fe7d213c521648bd89779051d43729929d1d190bcda49c01ff5cada82
-  data.tar.gz: 3b85514ae3eed71fce038209c701044f2f003cd9d984f9e5fbe68ce11629660d5ef234793c8c88e69126a51a49b076e9f53364303db921897c7b6aa211ccc89c
+  metadata.gz: c94dcbee61e5e5c18c232ace2357ed4d4110719c37daa23056c37a9e0f73c1431ae0e699a3e85c4adf838e531a4c82ac9095fc637bbef5e5a1e0925b6aa22bb9
+  data.tar.gz: 74b4b462193da378dbcf32b7f9638c597d8dfbe917c2bb12c1924bb889ee65f89de563aa49b62b30a557e52ba5d1563c6d571829fa90d9ea47a86cd12f7ae687

data/.circleci/config.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:2.7.3
+      - image: cimg/ruby:2.7
 
     working_directory: ~/repo
 

data/.gitignore

@@ -9,7 +9,6 @@
 /tmp/
 /log/
 .ruby-gemset
-.ruby-version
 .DS_Store
 
-*.gemfile.lock
+*.gemfile.lock

data/.rubocop.yml

@@ -2,4 +2,4 @@ inherit_from:
   - .rubocop_airbnb.yml
   - .rubocop_todo.yml
 AllCops:
-  TargetRubyVersion: 2.4
+  NewCops: enable

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-06-03 21:15:22 -0700 using RuboCop version 0.52.1.
+# on 2022-04-14 23:18:15 UTC using RuboCop version 0.93.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,16 +14,27 @@ Layout/MultilineBlockLayout:
 
 # Offense count: 4
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# Configuration parameters: EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
 # SupportedStyles: space, no_space
 # SupportedStylesForEmptyBraces: space, no_space
 Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Rails/ApplicationController:
   Exclude:
     - 'spec/cloudflare/rails_spec.rb'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+Rails/NegateInclude:
+  Exclude:
+    - 'lib/cloudflare/rails/railtie.rb'
+
 # Offense count: 4
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
 # SupportedStyles: line_count_based, semantic, braces_for_chaining
 # ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
 # FunctionalMethods: let, let!, subject, watch
@@ -32,8 +43,9 @@ Style/BlockDelimiters:
   Exclude:
     - 'spec/cloudflare/rails_spec.rb'
 
-# Offense count: 6
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   Max: 126

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/Appraisals

@@ -1,7 +1,3 @@
-appraise "rails-5.2" do
-  gem "rails", "~> 5.2.0"
-end
-
 appraise "rails-6.0" do
   gem "rails", "~> 6.0.0"
 end
@@ -11,5 +7,5 @@ appraise "rails-6.1" do
 end
 
 appraise "rails-7.0" do
-  gem "rails", git: "https://github.com/rails/rails", branch: "main"
+  gem "rails", "~> 7.0.0"
 end

data/CHANGELOG.md

@@ -4,8 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.4.0-beta.0] - 12-10-24
-- Skip fetching and caching of Cloudflare ip address when Rails::Console is defined or when ENV['DISABLE_CLOUDFLARE_RAILS] is set
+## [3.0.0] - unreleased
+- Drop support for unsupported `rails` version `5.2.x`
+- Fetch and cache IPs lazily instead of upon initialization (https://github.com/modosc/cloudflare-rails/pull/52)
+
+## [2.4.0] - 2022-02-22
+- Add trailing slashes to reflect Cloudflare API URLs (https://github.com/modosc/cloudflare-rails/pull/53)
 
 ## [2.3.0] - 2021-10-22
 -  Better handling of malformed IP addresses (https://github.com/modosc/cloudflare-rails/pull/49)

data/Gemfile

@@ -2,7 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cloudflare-rails.gemspec
 gemspec
-
-group :development do
-  gem "rspec-isolation", git: "https://github.com/modosc/rspec-isolation"
-end

data/README.md

@@ -3,11 +3,15 @@ This gem correctly configures Rails for [CloudFlare](https://www.cloudflare.com)
 
 ## Rails Compatibility
 
-This gem requires `railties`, `activesupport`, and `actionpack` >= `5.2`.
-
-For Rails `5.0` and `5.1` use `2.0.0`.
-
-For Rails `4.2` use `0.1.x`.
+This gem requires `railties`, `activesupport`, and `actionpack` >= `6.0`. For older `rails` versions see the chart below:
+
+| `rails` version | `cloudflare-rails` version |
+| --------------- | -------------------------- |
+| 5.2             | 2.4.0                      |
+| 5.1             | 2.0.0                      |
+| 5.0             | 2.0.0                      |
+| 4.2             | 0.1.0                      |
+| -----           | -------                    |
 
 ## Installation
 

data/cloudflare-rails.gemspec

@@ -22,19 +22,18 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", ">= 2.1.2"
   spec.add_development_dependency "rake", "~> 13.0.1"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.6.0"
   spec.add_development_dependency "rspec-rails", "~> 5.0.1"
-  spec.add_development_dependency "rspec", "~> 3.10.0"
-  spec.add_development_dependency "rubocop-airbnb", "~> 3.0.2"
-  spec.add_development_dependency "webmock", "~> 3.13.0"
-  spec.add_development_dependency "rack-attack", "~> 6.5.0"
+  spec.add_development_dependency "rspec", "~> 3.12.0"
+  spec.add_development_dependency "rubocop-airbnb", "~> 4.0.0"
+  spec.add_development_dependency "webmock", "~> 3.18.1"
+  spec.add_development_dependency "rack-attack", "~> 6.6.1"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "climate_control"
 
-  spec.add_dependency "railties", ">= 5.2", "< 7.1.0"
-  spec.add_dependency "activesupport", ">= 5.2", "< 7.1.0"
-  spec.add_dependency "actionpack", ">= 5.2", "< 7.1.0"
+  spec.add_dependency "railties", ">= 6.0", "< 7.1.0"
+  spec.add_dependency "activesupport", ">= 6.0", "< 7.1.0"
+  spec.add_dependency "actionpack", ">= 6.0", "< 7.1.0"
 
   # we need Module#prepend
   spec.required_ruby_version = '>= 2.0'

data/gemfiles/rails_6.0.gemfile

@@ -4,8 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 6.0.0"
 
-group :development do
-  gem "rspec-isolation", git: "https://github.com/modosc/rspec-isolation"
-end
-
 gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -4,8 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 6.1.0"
 
-group :development do
-  gem "rspec-isolation", git: "https://github.com/modosc/rspec-isolation"
-end
-
 gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -2,10 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", git: "https://github.com/rails/rails", branch: "main"
-
-group :development do
-  gem "rspec-isolation", git: "https://github.com/modosc/rspec-isolation"
-end
+gem "rails", "~> 7.0.0"
 
 gemspec path: "../"

data/lib/cloudflare/rails/railtie.rb

@@ -7,7 +7,7 @@ module Cloudflare
       # correct inside of rack and rails
       module CheckTrustedProxies
         def trusted_proxy?(ip)
-          matching = ::Rails.application.config.cloudflare.ips.any? do |proxy|
+          matching = Importer.cloudflare_ips.any? do |proxy|
             begin
               proxy === ip
             rescue IPAddr::InvalidAddressError
@@ -21,7 +21,7 @@ module Cloudflare
       # request.remote_ip is correct inside of rails
       module RemoteIpProxies
         def proxies
-          super + ::Rails.application.config.cloudflare.ips
+          super + Importer.cloudflare_ips
         end
       end
 
@@ -43,8 +43,8 @@ module Cloudflare
         end
 
         BASE_URL = 'https://www.cloudflare.com'.freeze
-        IPS_V4_URL = '/ips-v4'.freeze
-        IPS_V6_URL = '/ips-v6'.freeze
+        IPS_V4_URL = '/ips-v4/'.freeze
+        IPS_V6_URL = '/ips-v6/'.freeze
 
         class << self
           def ips_v6
@@ -55,10 +55,6 @@ module Cloudflare
             fetch IPS_V4_URL
           end
 
-          def should_skip?
-            defined?(::Rails::Console) || ENV.key?('DISABLE_CLOUDFLARE_RAILS')
-          end
-
           def fetch(url)
             uri = URI("#{BASE_URL}#{url}")
 
@@ -79,11 +75,18 @@ module Cloudflare
           end
 
           def fetch_with_cache(type)
-            return if should_skip?
             ::Rails.cache.fetch("cloudflare-rails:#{type}", expires_in: ::Rails.application.config.cloudflare.expires_in) do
               send type
             end
           end
+
+          def cloudflare_ips(refresh: false)
+            @ips = nil if refresh
+            @ips ||= (Importer.fetch_with_cache(:ips_v4) + Importer.fetch_with_cache(:ips_v6)).freeze
+          rescue StandardError => e
+            ::Rails.logger.error(e)
+            []
+          end
         end
       end
 
@@ -99,20 +102,6 @@ module Cloudflare
         app.config.cloudflare.reverse_merge! DEFAULTS
       end
 
-      # we set config.cloudflare.ips after_initialize so that our cache will
-      # be correctly setup. we rescue and log errors so that failures won't prevent
-      # rails from booting
-      config.after_initialize do |app|
-        [:ips_v4, :ips_v6].each do |type|
-          begin
-            ::Rails.application.config.cloudflare.ips += Importer.fetch_with_cache(type)
-          rescue Importer::ResponseError => e
-            ::Rails.logger.error "Cloudflare::Rails: Couldn't import #{type} blocks from CloudFlare: #{e.response}"
-          rescue StandardError => e
-            ::Rails.logger.error "Cloudflare::Rails: Got exception: #{e} for type: #{type}"
-          end
-        end
-      end
       initializer "my_railtie.configure_rails_initialization" do
         Rack::Request::Helpers.prepend CheckTrustedProxies
 

data/lib/cloudflare/rails/version.rb

@@ -1,5 +1,5 @@
 module Cloudflare
   module Rails
-    VERSION = "2.4.0-beta.0".freeze
+    VERSION = "3.0.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare-rails
 version: !ruby/object:Gem::Version
-  version: 2.4.0.pre.beta.0
+  version: 3.0.0
 platform: ruby
 authors:
 - jonathan schatz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-24 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -72,56 +72,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop-airbnb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.18.1
 - !ruby/object:Gem::Dependency
   name: rack-attack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.5.0
+        version: 6.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.5.0
+        version: 6.6.1
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -150,27 +150,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: climate_control
-  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: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.1.0
@@ -180,7 +166,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.1.0
@@ -190,7 +176,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.1.0
@@ -200,7 +186,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.1.0
@@ -210,7 +196,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.1.0
@@ -220,7 +206,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.1.0
@@ -238,6 +224,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_airbnb.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -248,7 +235,6 @@ files:
 - bin/setup
 - cloudflare-rails.gemspec
 - gemfiles/.bundle/config
-- gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.0.gemfile
@@ -270,11 +256,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.18
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: This gem configures Rails for CloudFlare so that request.ip and request.remote_ip

data/gemfiles/rails_5.2.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 5.2.0"
-
-group :development do
-  gem "rspec-isolation", git: "https://github.com/modosc/rspec-isolation"
-end
-
-gemspec path: "../"