webcache 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc81de551ef9ce35dfde41ded5128bd8723df5ffa44bc86995e0b786e4b20f8
-  data.tar.gz: 8f8f5a4be13c7e10badcdf64b9ae3b4c519a219a4aa824e103a5b3cf10d4cfd0
+  metadata.gz: 9a57464d31079c5df7d8e63d027b769b9f54a06f5c0e3d66afbe8b80a1ce184e
+  data.tar.gz: bc33a0a17e492d88639ed595c4e1459bfa27b9ceba68b6b1edb92d216f53357a
 SHA512:
-  metadata.gz: e5a845a6320ef748177ae9f59592a884b74615c7278e8d70b6a1a312707753a6401fd2029a19670bc288244ede849ddae3b9ede760c6f628001b27d056aff0cc
-  data.tar.gz: d40ef7841aafb3a43cc546c239d00ed641cb5395d27b7bb4fb6295015ba2e50a802aeaf303d0cc28980ca4cf2dbb7e81375b96ce191f637dbe2a18e5c4c3b9f6
+  metadata.gz: a4bb3e90d6a456249061cfd399757bffa412e6edc8127a9ca5087c7b25725910a7a028fae43ebf7a9d2e3482df2cee144aae97da0bb8d3d37331341b7c210faf
+  data.tar.gz: 58283031d3550aa0f8bc4ca8073a7c104dc33b901e054165fcc570368da0158197addf8f4b1ebd378d7898b860c4d1d5169e81f515e1e0d2a9c9ef91354e014e

data/README.md

@@ -28,7 +28,28 @@ gem 'webcache'
 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'

data/lib/webcache.rb

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

data/lib/webcache/cache_operations.rb

@@ -0,0 +1,126 @@
+require 'digest/md5'
+require 'fileutils'
+require 'open-uri'
+require 'open_uri_redirections'
+
+module CacheOperations
+  attr_reader :last_error
+  attr_writer :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 dir
+    @dir ||= 'cache'
+  end
+
+  def life
+    @life ||= 3600
+  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 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

data/lib/webcache/response.rb

@@ -1,4 +1,4 @@
-class WebCache
+module CacheOperations
   class Response
     attr_accessor :error, :base_uri, :content
 

data/lib/webcache/version.rb

@@ -1,3 +1,3 @@
 class WebCache
-  VERSION = "0.4.0"
+  VERSION = "0.5.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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webcache
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2018-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open_uri_redirections
@@ -102,6 +102,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/webcache.rb
+- lib/webcache/cache_operations.rb
 - lib/webcache/response.rb
 - lib/webcache/version.rb
 - lib/webcache/web_cache.rb