webcache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 443cde9b95f84eb6cff86c4fccd0335aa17139c3
+  data.tar.gz: fbb2acb31a86388987d29facad46a5f73440aae5
+SHA512:
+  metadata.gz: 08febe9b278725d875b25bc68e72a7e48fb5a9b872429f0bf53bdd366c0b50d3451d367f7138028d6a29c5a741211bd6a1446d857f97a184ddc7d5e5eeee864b
+  data.tar.gz: 9957b6418433717b67180b1b2bd8ca5a6da110172ee3000d5639f83f817a80c5815f36d5addf38457038dfc90240b980bf558cf4e0a025635c94c37c4106e625

data/README.md

@@ -0,0 +1,86 @@
+WebCache - Download web pages with a simple cache
+==================================================
+
+[![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)
+
+---
+
+WebCache provides a hassle-free caching for HTTP download.
+
+---
+
+Install
+--------------------------------------------------
+
+```
+$ gem install webcache
+```
+
+Or with bundler:
+
+```ruby
+gem 'webcache'
+```
+
+Usage
+--------------------------------------------------
+
+Use `WebCache.get url` to load from cache, or download:
+
+```ruby
+cache = WebCache.new
+content = cache.get 'http://example.com'
+```
+
+By default, the cached objects are stored in the `./cache` folder, and
+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
+content = cache.get 'http://example.com'
+```
+
+Or later:
+
+```ruby
+cache = WebCache.new
+cache.dir = 'tmp/my_cache'
+cache.life = 120
+content = cache.get 'http://example.com'
+```
+
+To check if a URL is cached, use the 'cached?' method:
+
+```ruby
+cache = WebCache.new
+cache.cached? 'http://example.com'
+# => false
+
+content = cache.get 'http://example.com'
+cache.cached? 'http://example.com'
+# => true
+```
+
+You can enable/disable the cache at any time:
+
+```ruby
+cache = WebCache.new
+cache.disable
+content = cache.get 'http://example.com'
+cache.enabled? 
+# => false
+
+cache.cached? 'http://example.com'
+# => false
+
+cache.enable
+content = cache.get 'http://example.com'
+cache.cached? 'http://example.com'
+# => true
+```
+

data/lib/webcache.rb

@@ -0,0 +1,2 @@
+require 'webcache/version'
+require 'webcache/web_cache'

data/lib/webcache/version.rb

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

data/lib/webcache/web_cache.rb

@@ -0,0 +1,68 @@
+require 'digest/md5'
+require 'fileutils'
+require 'open-uri'
+
+class WebCache
+  attr_accessor :dir, :life
+
+  def initialize(dir='cache', life=60)
+    @dir = dir
+    @life = life
+    @enabled = true
+    FileUtils.mkdir_p dir
+  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
+
+    content = http_get(url)
+    save_file_content(path, content)
+    content
+  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
+
+  private
+
+  def get_path(url)
+    @last_url = 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, content)
+    File.open path, 'wb' do |f| 
+      f.write Marshal.dump content
+    end
+  end
+
+  def http_get(url)
+    open(url).read
+  end
+
+  def old?(path)
+    life > 0 and File.exists?(path) and Time.new - File.mtime(path) >= life
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: webcache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Easy to use file cache for web downloads
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/webcache.rb
+- lib/webcache/version.rb
+- lib/webcache/web_cache.rb
+homepage: https://github.com/DannyBen/webcache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Download web pages with caching
+test_files: []