httpdisk 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d311812fa4d8d034c9eda6b9b18df36e21eb14ebc9d632cd1fe071268ca77786
-  data.tar.gz: 90e891451c1805d6d8ba5ad268bc2682528954a2a8acd37546f69ab43d493311
+  metadata.gz: 0e3b6af20bf5a6b76a23a6d170328c040cf3f0715e012c392739b70ab6911bee
+  data.tar.gz: 46385301b89bc19f2e8862bcc9bf48b0f1b14fafbd2fa4fc8542b7bf4dcfe930
 SHA512:
-  metadata.gz: c61e162e26d8a7b86fe00165e095d72f99415e8e5a4245513758731a009186999d5cf171db45c8b83115dae8c376e8391aa0bfbd00d3a2fd086c0451f77269ad
-  data.tar.gz: 1ad5bdb0a51f2b84822a6164379a724a7b03338b30f9c427b956bbe4263b0326720aea3bcb02b1fa37110a8aa5adc24dc8f3f257733b11667df913b863da0d52
+  metadata.gz: c4b163648a7adf00ae2ae103ccef899f5a3b958d8e38eeb56fc0d609f0bae73a19eed4fb7d5921c583b4f6d2755bd70d5cf1da748a6d8e858f5195da1683d009
+  data.tar.gz: 3270ce507204023e25451048fd0ddecc713ce6c637abfe795c2f159d619328892393bb8fa73249f08199a30e9db895fb2e2b6c440bfae0dcf07abd277851d050

data/.rubocop.yml

@@ -2,14 +2,19 @@ AllCops:
   NewCops: enable
   SuggestExtensions: false
 
+# this is buggy in 2.7.0
+Style/HashTransformValues: { Enabled: false }
+
 # minimal personal preference
 Layout/CaseIndentation: { Enabled: false }
 Layout/EndAlignment: { EnforcedStyleAlignWith: variable }
 Lint/AssignmentInCondition: { Enabled: false }
+Lint/NonLocalExitFromIterator: { Enabled: false }
 Metrics: { Enabled: false }
 Naming/MethodParameterName: { Enabled: false }
 Naming/VariableNumber: { Enabled: false }
 Style/Documentation: { Enabled: false }
+Style/DoubleNegation: { Enabled: false }
 Style/FrozenStringLiteralComment: { Enabled: false }
 Style/IfUnlessModifier: { Enabled: false }
 Style/NegatedIf: { Enabled: false }

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    httpdisk (0.2.0)
+    httpdisk (0.3.0)
       faraday (~> 1.4)
       faraday-cookie_jar (~> 0.0)
       faraday_middleware (~> 1.0)
@@ -63,7 +63,7 @@ GEM
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.4)
-    slop (4.8.2)
+    slop (4.9.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)

data/README.md

@@ -128,6 +128,7 @@ httpdisk supports a few options:
 - `expires_in:` when to expire cached requests, default is nil (never expire)
 - `force:` don't read anything from cache (but still write)
 - `force_errors:` don't read errors from cache (but still write)
+- `ignore_params:` array of query params to ignore when calculating cache_key
 - `logger`: log requests to stderr, or pass your own logger
 
 Pass these in when setting up Faraday:
@@ -176,10 +177,17 @@ Specific to httpdisk:
 
 ## Changelog
 
+#### 0.3 (unreleased)
+
+- added :ignore_params, for ignoring query params when generating cache keys
+- HTTP 40x & 50x responses return :error status (and respond to `force_error`)
+
 #### 0.2 - May 2020
+
 - added `response.env[:httpdisk]`, which will be true if the response came from the cache
-- `:logger` option
+- added `:logger` option
 - rake rubocop
 
 #### 0.1 - April 2020
+
 - Original release

data/Rakefile

@@ -13,9 +13,10 @@ spec = Gem::Specification.load('httpdisk.gemspec')
 Rake::TestTask.new { _1.libs << 'test' }
 task default: :test
 
-# Watch files, run tests whenever something changes
+# Watch rb files, run tests whenever something changes
 task :watch do
-  system('find . | entr -c rake test')
+  # https://superuser.com/a/665208 / https://unix.stackexchange.com/a/42288
+  system("while true; do find . -name '*.rb' | entr -c -d rake; test $? -gt 128 && break; done")
 end
 
 #
@@ -31,7 +32,7 @@ end
 #
 
 task :rubocop do
-  system('bundle exec rubocop -A .', exception: true)
+  sh 'bundle exec rubocop -A .'
 end
 
 #
@@ -39,17 +40,17 @@ end
 #
 
 task :build do
-  system('gem build --quiet httpdisk.gemspec', exception: true)
+  sh 'gem build --quiet httpdisk.gemspec'
 end
 
 task install: :build do
-  system("gem install --quiet httpdisk-#{spec.version}.gem", exception: true)
+  sh "gem install --quiet httpdisk-#{spec.version}.gem"
 end
 
-task release: %i[test build] do
+task release: %i[rubocop test build] do
   raise "looks like git isn't clean" unless `git status --porcelain`.empty?
 
-  system("git tag -a #{spec.version} -m 'Tagging #{spec.version}'", exception: true)
-  system('git push --tags', exception: true)
-  system("gem push httpdisk-#{spec.version}.gem", exception: true)
+  sh "git tag -a #{spec.version} -m 'Tagging #{spec.version}'"
+  sh 'git push --tags'
+  sh "gem push httpdisk-#{spec.version}.gem"
 end

data/lib/httpdisk.rb

@@ -5,6 +5,7 @@ require 'httpdisk/cli'
 require 'httpdisk/client'
 require 'httpdisk/error'
 require 'httpdisk/payload'
+require 'httpdisk/sloptions'
 require 'httpdisk/version'
 
 module HTTPDisk

data/lib/httpdisk/cache.rb

@@ -7,21 +7,6 @@ module HTTPDisk
 
     def initialize(options)
       @options = options
-
-      # heavy sanity checking on arguments here
-      if !dir.is_a?(String)
-        raise ArgumentError, "expected :dir to be a string, not #{dir.inspect}"
-      end
-      if expires_in && !expires_in.is_a?(Integer)
-        raise ArgumentError, "expected :expires_in to be an integer, not #{expires_in.inspect}"
-      end
-
-      %i[force force_errors].each do
-        value = send(_1)
-        if ![nil, true, false].include?(value)
-          raise ArgumentError, "expected #{_1} to be a boolean, not #{value.inspect}"
-        end
-      end
     end
 
     %i[dir expires_in force force_errors].each do |method|
@@ -43,7 +28,7 @@ module HTTPDisk
       payload_or_status = read0(cache_key, peek: true)
       return payload_or_status if payload_or_status.is_a?(Symbol)
 
-      payload_or_status.error_999? ? :error : :hit
+      payload_or_status.error? ? :error : :hit
     end
 
     # Write response to the disk cache
@@ -69,7 +54,7 @@ module HTTPDisk
       return :force if force?
 
       payload = Zlib::GzipReader.open(path) { Payload.read(_1, peek: peek) }
-      return :force if force_errors? && payload.error_999?
+      return :force if force_errors? && payload.error?
 
       payload
     end

data/lib/httpdisk/cache_key.rb

@@ -4,10 +4,10 @@ require 'uri'
 
 module HTTPDisk
   class CacheKey
-    attr_reader :env
+    attr_reader :env, :ignore_params
 
-    def initialize(env)
-      @env = env
+    def initialize(env, ignore_params: [])
+      @env, @ignore_params = env, ignore_params
 
       # sanity checks
       raise 'http/https required' if env.url.scheme !~ /^https?$/
@@ -79,7 +79,16 @@ module HTTPDisk
 
     # Calculate canonical key for a query
     def querykey(q)
-      q.split('&').sort.join('&')
+      parts = q.split('&').sort
+      if !ignore_params.empty?
+        parts = parts.map do |part|
+          key, value = part.split('=', 2)
+          next if ignore_params.include?(key)
+
+          "#{key}=#{value}"
+        end.compact
+      end
+      parts.join('&')
     end
 
     def default_port?

data/lib/httpdisk/client.rb

@@ -2,25 +2,26 @@ require 'faraday'
 require 'logger'
 
 module HTTPDisk
-  OPTIONS = {
-    dir: File.join(ENV['HOME'], 'httpdisk'),
-    expires_in: nil,
-    force: false,
-    force_errors: false,
-    logger: false,
-  }.freeze
-
   # Middleware and main entry point.
   class Client < Faraday::Middleware
     attr_reader :cache, :options
 
     def initialize(app, options = {})
-      super(app, options = OPTIONS.merge(options.compact))
+      options = Sloptions.parse(options) do
+        _1.string :dir, default: File.join(ENV['HOME'], 'httpdisk')
+        _1.integer :expires_in
+        _1.boolean :force
+        _1.boolean :force_errors
+        _1.array :ignore_params, default: []
+        _1.on :logger, type: [:boolean, Logger]
+      end
+
+      super(app, options)
       @cache = Cache.new(options)
     end
 
     def call(env)
-      cache_key = CacheKey.new(env)
+      cache_key = CacheKey.new(env, ignore_params: ignore_params)
       logger&.info("#{env.method.upcase} #{env.url} (#{cache.status(cache_key)})")
 
       if cached_response = read(cache_key, env)
@@ -100,10 +101,18 @@ module HTTPDisk
       err.to_s =~ /#{proxy.host}.*#{proxy.port}/
     end
 
+    #
+    # options
+    #
+
+    def ignore_params
+      @ignore_params ||= options[:ignore_params].map { CGI.escape(_1.to_s) }.to_set
+    end
+
     def logger
-      return @logger if defined?(@logger)
+      return if !options[:logger]
 
-      @logger = case options[:logger]
+      @logger ||= case options[:logger]
       when true then Logger.new($stderr)
       when Logger then options[:logger]
       end

data/lib/httpdisk/payload.rb

@@ -39,8 +39,8 @@ module HTTPDisk
       @headers = Faraday::Utils::Headers.new
     end
 
-    def error_999?
-      status == HTTPDisk::ERROR_STATUS
+    def error?
+      status >= 400
     end
 
     def write(f)

data/lib/httpdisk/sloptions.rb

@@ -0,0 +1,105 @@
+module HTTPDisk
+  # Like Slop, but for sanity checking method options. Useful for library entry
+  # points that want to be strict. Example usage:
+  #
+  # options = Sloptions.new(options) do
+  #   _1.boolean :force
+  #   _1.integer :retries, required: true
+  #   _1.string :hello, default: 'world'
+  #   ...
+  # end
+  class Sloptions
+    attr_reader :flags
+
+    def self.parse(options, &block)
+      Sloptions.new(&block).parse(options)
+    end
+
+    def initialize
+      @flags = {}
+      yield(self)
+    end
+
+    #
+    # _1.on and friends
+    #
+
+    def on(flag, foptions = {})
+      raise ":#{flag} already defined" if flags[flag]
+
+      flags[flag] = foptions
+    end
+
+    %i[array boolean float hash integer string symbol].each do |method|
+      define_method(method) do |flag, foptions = {}|
+        on(flag, { type: method }.merge(foptions))
+      end
+    end
+    alias bool boolean
+
+    #
+    # return parsed options
+    #
+
+    def parse(options)
+      # defaults
+      options = defaults.merge(options.compact)
+
+      flags.each do |flag, foptions|
+        # nil check
+        value = options[flag]
+        if value.nil?
+          raise ArgumentError, ":#{flag} is required" if foptions[:required]
+
+          next
+        end
+
+        # type cast (for boolean)
+        if foptions[:type] == :boolean
+          value = options[flag] = !!options[flag]
+        end
+
+        # type check
+        types = Array(foptions[:type])
+        raise ArgumentError, error_message(flag, value, types) if !valid?(value, types)
+      end
+
+      # return
+      options
+    end
+
+    protected
+
+    def defaults
+      flags.map { |flag, foptions| [flag, foptions[:default]] }.to_h.compact
+    end
+
+    # does value match valid?
+    def valid?(value, types)
+      types.any? do
+        case _1
+        when :array then true if value.is_a?(Array)
+        when :boolean then true # in Ruby everything is a boolean
+        when :float then true if value.is_a?(Float) || value.is_a?(Integer)
+        when :hash then true if value.is_a?(Hash)
+        when :integer then true if value.is_a?(Integer)
+        when :string then true if value.is_a?(String)
+        when :symbol then true if value.is_a?(Symbol)
+        when Class then true if value.is_a?(_1) # for custom checks
+        else
+          raise "unknown flag type #{_1.inspect}"
+        end
+      end
+    end
+
+    # nice error message for when value is invalid
+    def error_message(flag, value, valid)
+      classes = valid.compact.map do
+        s = _1.to_s
+        s = s.downcase if s =~ /\b(Array|Float|Hash|Integer|String|Symbol)\b/
+        s
+      end.join('/')
+      "expected :#{flag} to be #{classes}, not #{value.inspect}"
+    end
+  end
+end

data/lib/httpdisk/version.rb

@@ -1,3 +1,3 @@
 module HTTPDisk
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpdisk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam Doppelt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -92,6 +92,7 @@ files:
 - lib/httpdisk/client.rb
 - lib/httpdisk/error.rb
 - lib/httpdisk/payload.rb
+- lib/httpdisk/sloptions.rb
 - lib/httpdisk/version.rb
 - logo.svg
 homepage: http://github.com/gurgeous/httpdisk