webcache 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 443cde9b95f84eb6cff86c4fccd0335aa17139c3
-  data.tar.gz: fbb2acb31a86388987d29facad46a5f73440aae5
+  metadata.gz: 31ef4fc734aa42ccb8ed629de15a5bf7d48fd2ea
+  data.tar.gz: 2e44e49b6e8c66a26c83fb2fcb2ca1cadab7a6c1
 SHA512:
-  metadata.gz: 08febe9b278725d875b25bc68e72a7e48fb5a9b872429f0bf53bdd366c0b50d3451d367f7138028d6a29c5a741211bd6a1446d857f97a184ddc7d5e5eeee864b
-  data.tar.gz: 9957b6418433717b67180b1b2bd8ca5a6da110172ee3000d5639f83f817a80c5815f36d5addf38457038dfc90240b980bf558cf4e0a025635c94c37c4106e625
+  metadata.gz: 5336d34a8cafb3c8311209b4e50cb7191a8caa3da4fe999a4bf6036a7abed161e5d3b54c3e3cfbe64a7e81efd476a2016ba8a08f8eb0ca19795ef2463e789b69
+  data.tar.gz: 4ffdc6145037c4459e49cab3ca28bdc2f2f3915a6f15480e1c6ea44363dde1540043e7655e5653dfb2dba90b789e33bed3e2d28dc5567217db61b1ea889b43a4

data/README.md

@@ -1,4 +1,4 @@
-WebCache - Download web pages with a simple cache
+WebCache
 ==================================================
 
 [![Gem](https://img.shields.io/gem/v/webcache.svg?style=flat-square)](https://rubygems.org/gems/webcache)
@@ -31,6 +31,7 @@ Usage
 Use `WebCache.get url` to load from cache, or download:
 
 ```ruby
+require 'webcache'
 cache = WebCache.new
 content = cache.get 'http://example.com'
 ```
@@ -41,7 +42,7 @@ expire after 60 minutes. The cache folder will be created as needed.
 You can change these settings on initialization:
 
 ```ruby
-cache = WebCache.new 'tmp/my_cache', 120
+cache = WebCache.new 'tmp/my_cache', 7200
 content = cache.get 'http://example.com'
 ```
 
@@ -50,11 +51,11 @@ Or later:
 ```ruby
 cache = WebCache.new
 cache.dir = 'tmp/my_cache'
-cache.life = 120
+cache.life = 7200 # seconds
 content = cache.get 'http://example.com'
 ```
 
-To check if a URL is cached, use the 'cached?' method:
+To check if a URL is cached, use the `cached?` method:
 
 ```ruby
 cache = WebCache.new
@@ -71,10 +72,10 @@ You can enable/disable the cache at any time:
 ```ruby
 cache = WebCache.new
 cache.disable
-content = cache.get 'http://example.com'
 cache.enabled? 
 # => false
 
+content = cache.get 'http://example.com'
 cache.cached? 'http://example.com'
 # => false
 
@@ -84,3 +85,21 @@ cache.cached? 'http://example.com'
 # => true
 ```
 
+Error Handling
+--------------------------------------------------
+
+Whenever a request results in any HTTP error, two things will happen:
+
+1. The return value will be set to the error message
+2. The `last_error` variable will be set to the error message
+
+If `last_error` is anything but `false`, it means failure.
+
+```ruby
+cache = WebCache.new
+puts cache.get 'http://example.com/not_found'
+# => '404 Not Found'
+
+puts cache.last_error
+# => '404 Not Found'
+```

data/lib/webcache/version.rb

@@ -1,3 +1,3 @@
 class WebCache
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/webcache/web_cache.rb

@@ -3,16 +3,17 @@ require 'fileutils'
 require 'open-uri'
 
 class WebCache
+  attr_reader :last_error
   attr_accessor :dir, :life
 
-  def initialize(dir='cache', life=60)
+  def initialize(dir='cache', life=3600)
     @dir = dir
     @life = life
     @enabled = true
-    FileUtils.mkdir_p dir
   end
 
   def get(url)
+    @last_error = false
     return http_get url unless enabled?
 
     path = get_path url
@@ -20,7 +21,12 @@ class WebCache
     return load_file_content path if File.exist? path
 
     content = http_get(url)
-    save_file_content(path, content)
+    if @last_error
+      content = @last_error
+    else
+      save_file_content(path, content)
+    end
+
     content
   end
 
@@ -53,16 +59,21 @@ class WebCache
   end
 
   def save_file_content(path, content)
+    FileUtils.mkdir_p dir
     File.open path, 'wb' do |f| 
       f.write Marshal.dump content
     end
   end
 
   def http_get(url)
-    open(url).read
+    begin
+      open(url).read
+    rescue OpenURI::HTTPError => e
+      @last_error = e.message
+    end
   end
 
   def old?(path)
-    life > 0 and File.exists?(path) and Time.new - File.mtime(path) >= life
+    life > 0 and File.exist?(path) and Time.new - File.mtime(path) >= life
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webcache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -99,5 +99,5 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Download web pages with caching
+summary: Hassle-free caching for HTTP download
 test_files: []