httpdisk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c47ec4fda68047f57e8348746cf7e08467151a4b3d193cce16652980b5b8a47
-  data.tar.gz: 158e71dc98ba8a954eb3e744140a6e1f468de06e54a482690e7347d4b8750153
+  metadata.gz: d311812fa4d8d034c9eda6b9b18df36e21eb14ebc9d632cd1fe071268ca77786
+  data.tar.gz: 90e891451c1805d6d8ba5ad268bc2682528954a2a8acd37546f69ab43d493311
 SHA512:
-  metadata.gz: 4e261b58f3c1246dec8ab9ab5732c06c595af86b27c14866045fb9992983b1f8c89d93f788272c2331ded4f5424e424ebdf5ae0bdc886e95537e5696ad2ea04b
-  data.tar.gz: 9947c8fd27c4f7dbb98b9eb9c3aca086d7c0041ec51353b8163371d89b98c745592f764cfb05074daff0c8e9a6e9500863bf16d5f200b54e92e61ccc9006eaca
+  metadata.gz: c61e162e26d8a7b86fe00165e095d72f99415e8e5a4245513758731a009186999d5cf171db45c8b83115dae8c376e8391aa0bfbd00d3a2fd086c0451f77269ad
+  data.tar.gz: 1ad5bdb0a51f2b84822a6164379a724a7b03338b30f9c427b956bbe4263b0326720aea3bcb02b1fa37110a8aa5adc24dc8f3f257733b11667df913b863da0d52

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+# minimal personal preference
+Layout/CaseIndentation: { Enabled: false }
+Layout/EndAlignment: { EnforcedStyleAlignWith: variable }
+Lint/AssignmentInCondition: { Enabled: false }
+Metrics: { Enabled: false }
+Naming/MethodParameterName: { Enabled: false }
+Naming/VariableNumber: { Enabled: false }
+Style/Documentation: { Enabled: false }
+Style/FrozenStringLiteralComment: { Enabled: false }
+Style/IfUnlessModifier: { Enabled: false }
+Style/NegatedIf: { Enabled: false }
+Style/ParallelAssignment: { Enabled: false }
+Style/StderrPuts: { Enabled: false }
+Style/TrailingCommaInArrayLiteral: { EnforcedStyleForMultiline: consistent_comma }
+Style/TrailingCommaInHashLiteral: { EnforcedStyleForMultiline: consistent_comma }

data/Gemfile

@@ -6,5 +6,6 @@ group :development, :test do
   gem 'mocha'
   gem 'pry'
   gem 'rake'
+  gem 'rubocop', '~> 1.13.0'
   gem 'webmock'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    httpdisk (0.1.0)
+    httpdisk (0.2.0)
       faraday (~> 1.4)
       faraday-cookie_jar (~> 0.0)
       faraday_middleware (~> 1.0)
@@ -12,6 +12,7 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     coderay (1.1.3)
     crack (0.4.5)
       rexml
@@ -38,17 +39,35 @@ GEM
     minitest (5.14.4)
     mocha (1.11.2)
     multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
+    rainbow (3.0.0)
     rake (13.0.3)
+    regexp_parser (2.1.1)
     rexml (3.2.5)
+    rubocop (1.13.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.4)
     slop (4.8.2)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
     webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -63,6 +82,7 @@ DEPENDENCIES
   mocha
   pry
   rake
+  rubocop (~> 1.13.0)
   webmock
 
 BUNDLED WITH

data/README.md

@@ -65,6 +65,7 @@ faraday = Faraday.new do
   _1.request :url_encoded # auto-encode form bodies
   _1.response :json # auto-decode JSON responses
   _1.response :follow_redirects # follow redirects (should be above httpdisk)
+  _1.response :encoding # set Ruby string encoding based on Content-Type (should be above httpdisk)
   _1.use :httpdisk
   _1.request :retry # retry failed responses (should be below httpdisk)
 end
@@ -127,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)
+- `logger`: log requests to stderr, or pass your own logger
 
 Pass these in when setting up Faraday:
 
@@ -174,6 +176,10 @@ Specific to httpdisk:
 
 ## Changelog
 
-#### 0.1 - April 2020
+#### 0.2 - May 2020
+- added `response.env[:httpdisk]`, which will be true if the response came from the cache
+- `:logger` option
+- rake rubocop
 
+#### 0.1 - April 2020
 - Original release

data/Rakefile

@@ -26,6 +26,14 @@ task :pry do
   system 'pry -I lib -r httpdisk.rb'
 end
 
+#
+# rubocop
+#
+
+task :rubocop do
+  system('bundle exec rubocop -A .', exception: true)
+end
+
 #
 # gem
 #
@@ -38,7 +46,7 @@ task install: :build do
   system("gem install --quiet httpdisk-#{spec.version}.gem", exception: true)
 end
 
-task release: :build do
+task release: %i[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)

data/bin/httpdisk

@@ -6,7 +6,7 @@
 
 $LOAD_PATH.unshift(File.join(__dir__, '../lib'))
 
-def puts_error(s, exit: false)
+def puts_error(s)
   $stderr.puts "httpdisk: #{s}"
 end
 

data/examples.rb

@@ -18,7 +18,6 @@ class Examples
     faraday.get('http://www.google.com', nil, { "User-Agent": 'test-agent' })
     faraday.get('http://www.google.com', { q: 'ruby' })
     faraday.post('http://httpbin.org/post', 'name=hello')
-    exit
 
     3.times { puts }
     response = faraday.get('http://httpbingo.org/get')
@@ -106,7 +105,7 @@ class Examples
     end
 
     3.times { puts }
-    response = faraday.post('http://httpbingo.org/post', { this_is: [ 'json' ] })
+    response = faraday.post('http://httpbingo.org/post', { this_is: ['json'] })
     puts response.env.url
     puts JSON.pretty_generate(response.body)
   end

data/httpdisk.gemspec

@@ -3,7 +3,7 @@ require_relative 'lib/httpdisk/version'
 Gem::Specification.new do |s|
   s.name = 'httpdisk'
   s.version = HTTPDisk::VERSION
-  s.authors = [ 'Adam Doppelt' ]
+  s.authors = ['Adam Doppelt']
   s.email = 'amd@gurge.com'
 
   s.summary = 'httpdisk - disk cache for faraday'
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   end
   s.bindir = 'bin'
   s.executables = s.files.grep(%r{^#{s.bindir}/}) { File.basename(_1) }
-  s.require_paths = [ 'lib' ]
+  s.require_paths = ['lib']
 
   # gem dependencies
   s.add_dependency 'faraday', '~> 1.4'

data/lib/httpdisk/cache.rb

@@ -15,9 +15,10 @@ module HTTPDisk
       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)
+        if ![nil, true, false].include?(value)
           raise ArgumentError, "expected #{_1} to be a boolean, not #{value.inspect}"
         end
       end
@@ -39,8 +40,9 @@ module HTTPDisk
 
     # Cache status for a cache_key, %i[error force hit miss stale]
     def status(cache_key)
-      payload_or_status = read0(cache_key)
+      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
     end
 
@@ -59,14 +61,14 @@ module HTTPDisk
     protected
 
     # low level read, returns payload or status
-    def read0(cache_key)
+    def read0(cache_key, peek: false)
       path = diskpath(cache_key)
 
       return :miss if !File.exist?(path)
       return :stale if expired?(path)
       return :force if force?
 
-      payload = Zlib::GzipReader.open(path) { Payload.read(_1) }
+      payload = Zlib::GzipReader.open(path) { Payload.read(_1, peek: peek) }
       return :force if force_errors? && payload.error_999?
 
       payload

data/lib/httpdisk/cache_key.rb

@@ -68,10 +68,9 @@ module HTTPDisk
     # Calculate cache key segment for body
     def bodykey
       body = env.request_body.to_s
-      case
-      when env.request_headers['Content-Type'] == 'application/x-www-form-urlencoded'
+      if env.request_headers['Content-Type'] == 'application/x-www-form-urlencoded'
         querykey(body)
-      when body.length < 50
+      elsif body.length < 50
         body
       else
         Digest::MD5.hexdigest(body)

data/lib/httpdisk/cli.rb

@@ -119,6 +119,7 @@ module HTTPDisk
       if !Faraday::Connection::METHODS.include?(method)
         raise CliError, "invalid --request #{method.inspect}"
       end
+
       method
     end
 
@@ -130,6 +131,7 @@ module HTTPDisk
         if url =~ %r{^\w+://}
           raise CliError, 'only http/https supported'
         end
+
         url = "http://#{url}"
       end
       URI.parse(url)
@@ -154,6 +156,7 @@ module HTTPDisk
           if !key || !value || key.empty? || value.empty?
             raise CliError, "invalid --header #{header.inspect}"
           end
+
           headers[key] = value
         end
       end
@@ -172,6 +175,7 @@ module HTTPDisk
           if !seconds
             raise CliError, "invalid --expires #{options[:expires].inspect}"
           end
+
           client_options[:expires_in] = seconds
         end
         client_options[:force] = options[:force]
@@ -185,6 +189,7 @@ module HTTPDisk
 
       proxy = parse_proxy(options[:proxy])
       raise CliError, "--proxy should be host[:port], not #{options[:proxy].inspect}" if !proxy
+
       proxy
     end
 

data/lib/httpdisk/client.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'logger'
 
 module HTTPDisk
   OPTIONS = {
@@ -6,6 +7,7 @@ module HTTPDisk
     expires_in: nil,
     force: false,
     force_errors: false,
+    logger: false,
   }.freeze
 
   # Middleware and main entry point.
@@ -19,14 +21,16 @@ module HTTPDisk
 
     def call(env)
       cache_key = CacheKey.new(env)
+      logger&.info("#{env.method.upcase} #{env.url} (#{cache.status(cache_key)})")
 
-      # hit?
       if cached_response = read(cache_key, env)
+        cached_response.env[:httpdisk] = true
         return cached_response
       end
 
       # miss
-      perform(cache_key, env).tap do |response|
+      perform(env).tap do |response|
+        response.env[:httpdisk] = false
         write(cache_key, env, response)
       end
     end
@@ -46,7 +50,7 @@ module HTTPDisk
     protected
 
     # perform the request, return Faraday::Response
-    def perform(cache_key, env)
+    def perform(env)
       app.call(env)
     rescue Faraday::ConnectionFailed, Faraday::SSLError, Faraday::TimeoutError => e
       # try to avoid caching proxy errors
@@ -95,6 +99,15 @@ module HTTPDisk
 
       err.to_s =~ /#{proxy.host}.*#{proxy.port}/
     end
+
+    def logger
+      return @logger if defined?(@logger)
+
+      @logger = case options[:logger]
+      when true then Logger.new($stderr)
+      when Logger then options[:logger]
+      end
+    end
   end
 end
 

data/lib/httpdisk/payload.rb

@@ -1,13 +1,13 @@
 module HTTPDisk
   class Payload
     class << self
-      def read(f)
+      def read(f, peek: false)
         Payload.new.tap do |p|
           # comment
           p.comment = f.gets[/^# (.*)/, 1]
 
           # status line
-          m = f.gets.match(%r{^HTTPDISK (\d+) (.*)$})
+          m = f.gets.match(/^HTTPDISK (\d+) (.*)$/)
           p.status, p.reason_phrase = m[1].to_i, m[2]
 
           # headers
@@ -16,8 +16,8 @@ module HTTPDisk
             p.headers[key] = value
           end
 
-          # body
-          p.body = f.read
+          # body (if not peeking)
+          p.body = f.read if !peek
         end
       end
 

data/lib/httpdisk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpdisk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Doppelt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-25 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE