webcache 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc81de551ef9ce35dfde41ded5128bd8723df5ffa44bc86995e0b786e4b20f8
-  data.tar.gz: 8f8f5a4be13c7e10badcdf64b9ae3b4c519a219a4aa824e103a5b3cf10d4cfd0
+  metadata.gz: e8aa8d4fedb7deea8b440e70002a01a8d5a7bc70fd6f4ea487cbf8db18fdad54
+  data.tar.gz: 38a5bcd708f9f09db88b3f4ffa1622ac92e9eeea7be08db57a89d841db446fcf
 SHA512:
-  metadata.gz: e5a845a6320ef748177ae9f59592a884b74615c7278e8d70b6a1a312707753a6401fd2029a19670bc288244ede849ddae3b9ede760c6f628001b27d056aff0cc
-  data.tar.gz: d40ef7841aafb3a43cc546c239d00ed641cb5395d27b7bb4fb6295015ba2e50a802aeaf303d0cc28980ca4cf2dbb7e81375b96ce191f637dbe2a18e5c4c3b9f6
+  metadata.gz: b16642f53af90f51903abe71e27b7019a2de8df23e69a3d78b5827a9bb3496c6bc0a9361c197ec2304e4e840d4d26dbad907e6bdadf8c9e501c1a1bd78921e80
+  data.tar.gz: c8c6300945a4057a8356073c0ccff91e09c69f8ae57279797bead0bc92578f181f475826061fd43c75d8848d0f4240efb5a0d108f34535a9b75283dd44dbb597

data/README.md

@@ -1,10 +1,8 @@
-WebCache
-==================================================
+# WebCache
 
 [![Gem Version](https://badge.fury.io/rb/webcache.svg)](https://badge.fury.io/rb/webcache)
-[![Build Status](https://travis-ci.com/DannyBen/webcache.svg?branch=master)](https://travis-ci.com/DannyBen/webcache)
+[![Build Status](https://github.com/DannyBen/webcache/workflows/Test/badge.svg)](https://github.com/DannyBen/webcache/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/022f555211d47d655988/maintainability)](https://codeclimate.com/github/DannyBen/webcache/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/022f555211d47d655988/test_coverage)](https://codeclimate.com/github/DannyBen/webcache/test_coverage)
 
 ---
 
@@ -12,8 +10,7 @@ Hassle-free caching for HTTP download.
 
 ---
 
-Install
---------------------------------------------------
+## Install
 
 ```
 $ gem install webcache
@@ -25,10 +22,30 @@ Or with bundler:
 gem 'webcache'
 ```
 
-Usage
---------------------------------------------------
+## Usage
 
-Load a file from cache, or download if needed:
+WebCache can be used both as an instance, and as a static class.
+
+```ruby
+require 'webcache'
+
+# Instance
+cache = WebCache.new life: '3h'
+response = cache.get 'http://example.com'
+
+# Static
+WebCache.life = '3h'
+WebCache.get 'http://example.com'
+```
+
+The design intention is to provide both a globally available singleton
+`WebCache` object, as well as multiple caching instances, with different
+settings - depending on the use case.
+
+Note that the examples in this README are all using the instance syntax, but
+all methods are also available statically.
+
+This is the basic usage pattern:
 
 ```ruby
 require 'webcache'
@@ -127,22 +144,37 @@ cache = WebCache.new
 response = cache.get 'http://example.com', force: true
 ```
 
-Basic Authentication and Additional Options
---------------------------------------------------
-WebCache uses Ruby's [Open URI][1] to download. If you wish to modify 
-the options it uses, simply update the `options` hash.
+## Authentication
 
-For example, to use HTTP basic authentication, use something like this:
+To configure an authentication header, use the `auth` option. Similarly to
+the other options, this can be set directly on the static class, on instance
+initialization, or later on the instance:
 
 ```ruby
+cache = WebCache.new auth: '...'
+cache.get 'http://example.com'      # authenticated
+
 cache = WebCache.new
-cache.options[:http_basic_authentication] = ["user", "pass123!"]
-response = cache.get 'http://example.com'
+cache.auth = '...'
+cache.get 'http://example.com'      # authenticated
+
+WebCache.auth = '...'
+WebCache.get 'http://example.com'   # authenticated
 ```
 
+For basic authentication, provide a hash:
 
-Response Object
---------------------------------------------------
+```ruby
+cache = WebCache.new auth: { user: 'user', pass: 's3cr3t' }
+```
+
+For other authentication headers, simply provide the header string:
+
+```ruby
+cache = WebCache.new auth: "Bearer t0k3n"
+```
+
+## Response Object
 
 The response object holds these properties:
 
@@ -152,11 +184,17 @@ Contains the HTML content. In case of an error, this will include the
 error message. The `#to_s` method of the response object also returns
 the same content.
 
-
 ### `response.error`
 
 In case of an error, this contains the error message, `nil` otherwise.
 
+### `response.code`
+
+Contains the HTTP code, or `nil` if there was a non-HTTP error.
+
+### `response.success?`
+
+A convenience method, returns true if `error` is empty.
 
 ### `response.base_uri`
 
@@ -164,12 +202,17 @@ Contains the actual address of the page. This is useful when the request
 is redirected. For example, `http://example.com` will set the 
 `base_uri` to `http://example.com/` (note the trailing slash).
 
-
----
+## Related Projects
 
 For a similar gem that provides general purpose caching, see the 
-[Lightly gem][2]
+[Lightly gem][lightly].
 
+## Contributing / Support
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+---
 
-[1]: http://ruby-doc.org/stdlib-2.0.0/libdoc/open-uri/rdoc/OpenURI/OpenRead.html#method-i-open
-[2]: https://github.com/DannyBen/lightly
+[lightly]: https://github.com/DannyBen/lightly
+[issues]: https://github.com/DannyBen/webcache/issues

data/lib/webcache.rb

@@ -1,4 +1,12 @@
 require 'openssl'
 
-require 'webcache/web_cache'
+require 'webcache/polyfills'
+require 'webcache/cache_operations'
 require 'webcache/response'
+require 'webcache/web_cache'
+
+if ENV['BYEBUG']
+  require 'byebug'
+  require 'lp'
+end
+

data/lib/webcache/cache_operations.rb

@@ -0,0 +1,141 @@
+require 'digest/md5'
+require 'fileutils'
+require 'http'
+
+class WebCache
+  module CacheOperations
+    attr_reader :last_error, :user, :pass, :auth
+    attr_writer :dir
+
+    def initialize(dir: 'cache', life: '1h', auth: nil)
+      @dir = dir
+      @life = life_to_seconds life
+      @enabled = true
+      @auth = convert_auth auth
+    end
+
+    def get(url, force: false)
+      return http_get url unless enabled?
+
+      path = get_path url
+      clear url if force or stale? path
+
+      get! path, url
+    end
+
+    def life
+      @life ||= 3600
+    end
+
+    def life=(new_life)
+      @life = life_to_seconds new_life
+    end
+
+    def dir
+      @dir ||= 'cache'
+    end
+
+    def cached?(url)
+      path = get_path url
+      File.exist?(path) and !stale?(path)
+    end
+
+    def enabled?
+      @enabled ||= (@enabled.nil? ? true : @enabled)
+    end
+
+    def enable
+      @enabled = true
+    end
+
+    def disable
+      @enabled = false
+    end
+
+    def clear(url)
+      path = get_path url
+      FileUtils.rm path if File.exist? path
+    end
+
+    def flush
+      FileUtils.rm_rf dir if Dir.exist? dir
+    end
+
+    def auth=(auth)
+      convert_auth auth
+    end
+
+  private
+
+    def get!(path, url)
+      return load_file_content path if File.exist? path
+      response = http_get url
+      save_file_content path, response unless !response || response.error
+      response
+    end
+
+    def get_path(url)
+      File.join dir, Digest::MD5.hexdigest(url)
+    end
+
+    def load_file_content(path)
+      Marshal.load File.binread(path)
+    end
+
+    def save_file_content(path, response)
+      FileUtils.mkdir_p dir
+      File.open path, 'wb' do |f| 
+        f.write Marshal.dump response
+      end
+    end
+
+    def http_get(url)
+      Response.new http_response(url)
+    rescue => e
+      url = URI.parse url
+      Response.new error: e.message, base_uri: url, content: e.message
+    end
+
+    def basic_auth?
+      !!(user and pass)
+    end
+
+    def http_response(url)
+      if basic_auth?
+        HTTP.basic_auth(user: user, pass: pass).follow.get url
+      elsif auth
+        HTTP.auth(auth).follow.get url
+      else
+        HTTP.follow.get url
+      end
+    end
+
+    def stale?(path)
+      life > 0 and File.exist?(path) and Time.new - File.mtime(path) >= life
+    end
+
+    def life_to_seconds(arg)
+      arg = arg.to_s
+
+      case arg[-1]
+      when 's'; arg[0..-1].to_i
+      when 'm'; arg[0..-1].to_i * 60
+      when 'h'; arg[0..-1].to_i * 60 * 60
+      when 'd'; arg[0..-1].to_i * 60 * 60 * 24
+      else;     arg.to_i
+      end
+    end
+
+    def convert_auth(opts)
+      @user, @pass, @auth = nil, nil, nil
+
+      if opts.respond_to?(:has_key?) and opts.has_key?(:user) and opts.has_key?(:pass)
+        @user = opts[:user]
+        @pass = opts[:pass]
+      else
+        @auth = opts
+      end
+    end
+
+  end
+end

data/lib/webcache/polyfills.rb

@@ -0,0 +1,10 @@
+# :nocov:
+
+# Required for Ruby < 2.4
+if !Dir.respond_to? :empty?
+  class Dir
+    def self.empty?(path_name)
+      exist?(path_name) && (entries(path_name) - ['.', '..']).empty?
+    end
+  end
+end

data/lib/webcache/response.rb

@@ -1,10 +1,10 @@
 class WebCache
   class Response
-    attr_accessor :error, :base_uri, :content
+    attr_accessor :error, :base_uri, :content, :code
 
     def initialize(opts={})
-      if opts.respond_to?(:read) && opts.respond_to?(:base_uri)
-        init_with_uri opts
+      if opts.is_a? HTTP::Response
+        init_with_http_response opts
       elsif opts.is_a? Hash
         init_with_hash opts
       end
@@ -14,18 +14,29 @@ class WebCache
       content
     end
 
-    private
+    def success?
+      !error
+    end
+
+  private
 
-    def init_with_uri(opts)
-      @content  = opts.read
-      @base_uri = opts.base_uri
-      @error    = nil
+    def init_with_http_response(response)
+      @base_uri = response.uri
+      @code = response.code
+      if response.status.success?
+        @content  = response.to_s
+        @error    = nil
+      else
+        @content  = response.status.to_s
+        @error    = response.status.to_s
+      end
     end
 
     def init_with_hash(opts)
       @error    = opts[:error]
       @base_uri = opts[:base_uri]
       @content  = opts[:content]
+      @code     = opts[:code]
     end
   end
 end

data/lib/webcache/version.rb

@@ -1,3 +1,3 @@
 class WebCache
-  VERSION = "0.4.0"
+  VERSION = "0.8.0"
 end

data/lib/webcache/web_cache.rb

@@ -1,118 +1,7 @@
-require 'digest/md5'
-require 'fileutils'
-require 'open-uri'
-require 'open_uri_redirections'
-
 class WebCache
-  attr_reader :last_error, :life
-  attr_accessor :dir
-
-  def initialize(dir: 'cache', life: '1h')
-    @dir = dir
-    @life = life_to_seconds life
-    @enabled = true
-  end
-
-  def get(url, force: false)
-    return http_get url unless enabled?
-
-    path = get_path url
-    clear url if force or stale? path
-
-    get! path, url
-  end
-
-  def life=(new_life)
-    @life = life_to_seconds new_life
-  end
-
-  def cached?(url)
-    path = get_path url
-    File.exist?(path) and !stale?(path)
-  end
-
-  def enabled?
-    @enabled
-  end
-
-  def enable
-    @enabled = true
-  end
-
-  def disable
-    @enabled = false
-  end
-
-  def clear(url)
-    path = get_path url
-    FileUtils.rm path if File.exist? path
-  end
-
-  def flush
-    FileUtils.rm_rf dir if Dir.exist? dir
-  end
-
-  def options
-    @options ||= default_open_uri_options
-  end
-
-  private
-
-  def get!(path, url)
-    return load_file_content path if File.exist? path
-    response = http_get url
-    save_file_content path, response unless !response || response.error
-    response
-  end
-
-  def get_path(url)
-    File.join dir, Digest::MD5.hexdigest(url)
-  end
-
-  def load_file_content(path)
-    Marshal.load File.binread(path)
-  end
-
-  def save_file_content(path, response)
-    FileUtils.mkdir_p dir
-    File.open path, 'wb' do |f| 
-      f.write Marshal.dump response
-    end
-  end
-
-  def http_get(url)
-    begin
-      Response.new open(url, options)
-    rescue => e
-      Response.new error: e.message, base_uri: url, content: e.message
-    end
-  end
-
-  def stale?(path)
-    life > 0 and File.exist?(path) and Time.new - File.mtime(path) >= life
-  end
-
-  def life_to_seconds(arg)
-    arg = arg.to_s
-
-    case arg[-1]
-    when 's'; arg[0..-1].to_i
-    when 'm'; arg[0..-1].to_i * 60
-    when 'h'; arg[0..-1].to_i * 60 * 60
-    when 'd'; arg[0..-1].to_i * 60 * 60 * 24
-    else;     arg.to_i
-    end
-  end
+  include CacheOperations
 
-  # Use a less strict URL retrieval:
-  # 1. Allow http to/from https redirects (through the use of the 
-  #    open_uri_redirections gem)
-  # 2. Disable SSL verification, otherwise, some https sites that show 
-  #    properly in the browser, will return an error.
-  def default_open_uri_options
-    {
-      allow_redirections: :all, 
-      ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE
-    }
+  class << self
+    include CacheOperations
   end
 end

metadata

@@ -1,99 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: webcache
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: open_uri_redirections
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: runfile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: runfile-tasks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 description: Easy to use file cache for web downloads
 email: db@dannyben.com
 executables: []
@@ -102,6 +32,8 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/webcache.rb
+- lib/webcache/cache_operations.rb
+- lib/webcache/polyfills.rb
 - lib/webcache/response.rb
 - lib/webcache/version.rb
 - lib/webcache/web_cache.rb
@@ -117,15 +49,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: Hassle-free caching for HTTP download