webcache 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9edc3145e92b9f4a08aff555ba0b420d9346386a
-  data.tar.gz: 9f654e4874b7e55ee1ea0a0311c55db83872cc60
+SHA256:
+  metadata.gz: 5cc81de551ef9ce35dfde41ded5128bd8723df5ffa44bc86995e0b786e4b20f8
+  data.tar.gz: 8f8f5a4be13c7e10badcdf64b9ae3b4c519a219a4aa824e103a5b3cf10d4cfd0
 SHA512:
-  metadata.gz: 0271f6a7a1e75b84754d8a7e0877243cc407f7374ce7ece6a634ae5d56e1b6ee965b695262109051d1aa72c6bf7ee24dc396049a0cec3600d88b88122487fdc9
-  data.tar.gz: 4a19051e54fd769e19c5dafac9956a9166def2b2fddc4b0d1fb3d7307e9d6ddb8a0d62f082dc01ed08dd135d4f1e68a1b02a93611897387593314b169c2ddbd9
+  metadata.gz: e5a845a6320ef748177ae9f59592a884b74615c7278e8d70b6a1a312707753a6401fd2029a19670bc288244ede849ddae3b9ede760c6f628001b27d056aff0cc
+  data.tar.gz: d40ef7841aafb3a43cc546c239d00ed641cb5395d27b7bb4fb6295015ba2e50a802aeaf303d0cc28980ca4cf2dbb7e81375b96ce191f637dbe2a18e5c4c3b9f6

data/README.md

@@ -1,10 +1,10 @@
 WebCache
 ==================================================
 
-[![Gem](https://img.shields.io/gem/v/webcache.svg?style=flat-square)](https://rubygems.org/gems/webcache)
-[![Travis](https://img.shields.io/travis/DannyBen/webcache.svg?style=flat-square)](https://travis-ci.org/DannyBen/webcache)
-[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/webcache.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/webcache)
-[![Gemnasium](https://img.shields.io/gemnasium/DannyBen/webcache.svg?style=flat-square)](https://gemnasium.com/DannyBen/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)
+[![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)
 
 ---
 
@@ -47,7 +47,7 @@ expire after 60 minutes. The cache directory will be created as needed.
 You can change these settings on initialization:
 
 ```ruby
-cache = WebCache.new 'tmp/my_cache', 7200
+cache = WebCache.new dir: 'tmp/my_cache', life: '3d'
 response = cache.get 'http://example.com'
 ```
 
@@ -56,11 +56,21 @@ Or later:
 ```ruby
 cache = WebCache.new
 cache.dir = 'tmp/my_cache'
-cache.life = 7200 # seconds
+cache.life = '4h'
 response = cache.get 'http://example.com'
 ```
 
-To check if a URL is cached, use the `cached?` method:
+The `life` property accepts any of these formats:
+
+```ruby
+cache.life = 10     # 10 seconds
+cache.life = '20s'  # 20 seconds
+cache.life = '10m'  # 10 minutes
+cache.life = '10h'  # 10 hours
+cache.life = '10d'  # 10 days
+```
+
+Use the `cached?` method to check if a URL is cached:
 
 ```ruby
 cache = WebCache.new
@@ -72,7 +82,7 @@ cache.cached? 'http://example.com'
 # => true
 ```
 
-You can enable/disable the cache at any time:
+Use `enable` and `disable` to toggle caching on and off:
 
 ```ruby
 cache = WebCache.new
@@ -90,6 +100,32 @@ cache.cached? 'http://example.com'
 # => true
 ```
 
+Use `clear url` to remove a cached object if it exists:
+
+```ruby
+cache = WebCache.new
+response = cache.get 'http://example.com'
+cache.cached? 'http://example.com'
+# => true
+
+cache.clear 'http://example.com'
+cache.cached? 'http://example.com'
+# => false
+```
+
+Use `flush` to delete the entire cache directory:
+
+```ruby
+cache = WebCache.new
+cache.flush
+```
+
+Use `force: true` to force download even if the object is cached:
+
+```ruby
+cache = WebCache.new
+response = cache.get 'http://example.com', force: true
+```
 
 Basic Authentication and Additional Options
 --------------------------------------------------
@@ -110,29 +146,30 @@ Response Object
 
 The response object holds these properties:
 
-**`response.content`**:  
+### `response.content`
+
 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` otherwose.
 
-**`response.base_uri`**:  
+### `response.error`
+
+In case of an error, this contains the error message, `nil` otherwise.
+
+
+### `response.base_uri`
+
 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).
 
 
-```ruby
-cache = WebCache.new
-response = cache.get 'http://example.com/not_found'
-puts response
-# => '404 Not Found'
+---
 
-puts response.error
-# => '404 Not Found'
-```
+For a similar gem that provides general purpose caching, see the 
+[Lightly gem][2]
 
 
-[1]: http://ruby-doc.org/stdlib-2.0.0/libdoc/open-uri/rdoc/OpenURI/OpenRead.html#method-i-open
+[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

data/lib/webcache.rb

@@ -1,5 +1,4 @@
 require 'openssl'
 
-require 'webcache/version'
 require 'webcache/web_cache'
 require 'webcache/response'

data/lib/webcache/response.rb

@@ -1,21 +1,31 @@
-class WebCache
-  class Response
-    attr_accessor :error, :base_uri, :content
-
-    def initialize(opts={})
-      if opts.respond_to?(:read) && opts.respond_to?(:base_uri)
-        self.content  = opts.read
-        self.base_uri = opts.base_uri
-        self.error    = nil
-      elsif opts.is_a? Hash
-        self.error    = opts[:error]    if opts[:error]
-        self.base_uri = opts[:base_uri] if opts[:base_uri]
-        self.content  = opts[:content]  if opts[:content]
-      end
-    end
-
-    def to_s
-      content
-    end
-  end
-end
+class WebCache
+  class Response
+    attr_accessor :error, :base_uri, :content
+
+    def initialize(opts={})
+      if opts.respond_to?(:read) && opts.respond_to?(:base_uri)
+        init_with_uri opts
+      elsif opts.is_a? Hash
+        init_with_hash opts
+      end
+    end
+
+    def to_s
+      content
+    end
+
+    private
+
+    def init_with_uri(opts)
+      @content  = opts.read
+      @base_uri = opts.base_uri
+      @error    = nil
+    end
+
+    def init_with_hash(opts)
+      @error    = opts[:error]
+      @base_uri = opts[:base_uri]
+      @content  = opts[:content]
+    end
+  end
+end

data/lib/webcache/version.rb

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

data/lib/webcache/web_cache.rb

@@ -1,91 +1,118 @@
-require 'digest/md5'
-require 'fileutils'
-require 'open-uri'
-require 'open_uri_redirections'
-
-class WebCache
-  attr_reader :last_error
-  attr_accessor :dir, :life
-
-  def initialize(dir='cache', life=3600)
-    @dir = dir
-    @life = life
-    @enabled = true
-  end
-
-  def get(url)
-    return http_get url unless enabled?
-
-    path = get_path url
-    FileUtils.rm path if old? path
-
-    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 cached?(url)
-    path = get_path url
-    File.exist?(path) and !old?(path)
-  end
-
-  def enabled?
-    @enabled
-  end
-
-  def enable
-    @enabled = true
-  end
-
-  def disable
-    @enabled = false
-  end
-
-  def options
-    @options ||= default_open_uri_options
-  end
-
-  private
-
-  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 old?(path)
-    life > 0 and File.exist?(path) and Time.new - File.mtime(path) >= life
-  end
-
-  # 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
-    }
-  end
-end
+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
+
+  # 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
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webcache
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-29 00:00:00.000000000 Z
+date: 2018-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open_uri_redirections
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: runfile-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '10.0'
 description: Easy to use file cache for web downloads
 email: db@dannyben.com
 executables: []
@@ -117,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Hassle-free caching for HTTP download