cached_mechanize2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28bb73f528f1529f6ed553497534c95bbfcdaa47
+  data.tar.gz: 63e310f1b7475010f29a5251cabf2c92e6220bf5
+SHA512:
+  metadata.gz: 81bc7ffb8527565f6d95dd55a0226dbf958e45f5d94541fa6ccbb8d1485dd5e8e9b9ae9805bf6717155adfba9f8b747dc5094673e468fd03a34b977bd4ab6239
+  data.tar.gz: 9ce2edb824afa7e43d6494302f7f9c55e18992f901559f242e8214c728d78195193a94fb7a5428abc8283a300f8b1647d7635ae57878e144b152d6e852acb049

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+cache/
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cached_mechanize2.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 wukerplank
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# CachedMechanize
+
+is a small wrapper around [Mechanize](https://github.com/sparklemotion/mechanize) to enable caching for GET requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cached_mechanize'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cached_mechanize
+
+## Usage
+
+Right now there is only a file based caching backend. There might follow more in the future (redis, etc.).
+
+To configure the backend use this syntax:
+
+    CachedMechanize.configure do |config|
+      config.cache_class = CachedMechanize::CacheBackends::FileCache
+      config.cache_options = {
+        path: "/path/to/my/cached_files"
+      }
+    end
+
+Now you can use this class like you would use Mechanize:
+
+    agent = CachedMechanize.new
+    doc = agent.get('http://www.imdb.com')
+
+By default all retrieved pages will be cached for one day (86400 seconds). To change this behaviour you can provide an `expires_after` option:
+
+    doc = agent.get('http://www.imdb.com', expires_after: 42)
+
+Note that the syntax has changed! If you want to provide parameters, additional headers or a referer, you can do it like this:
+
+    doc = agent.get('http://www.imdb.com', {
+      referer: 'http://thatothersite.com',
+      expires_after: 42
+    })
+
+## TO-DO
+
+ - add more backends
+ - add tests
+
+## Contributing
+
+1. Fork it ( http://github.com/wukerplank/cached_mechanize/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'pp'
+  require 'cached_mechanize'
+
+  # Guh::Base.configure do |c|
+  #   c.guh_ip_address = ENV['GUH_IP']
+  #   c.guh_port = ENV['GUH_PORT']
+  # end
+
+  ARGV.clear
+  IRB.start
+end

data/cached_mechanize2.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "cached_mechanize2"
+  spec.version       = "0.1.0"
+  spec.authors       = ["johnwylie"]
+  spec.email         = ["johnwylie70@gmail.com"]
+  spec.summary       = %q{A small wrapper around Mechanize to enable caching for GET requests.}
+  spec.homepage      = "https://github.com/johnwylie70/cached_mechanize2"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mechanize", "~> 2.7"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/cached_mechanize.rb

@@ -0,0 +1,70 @@
+require "mechanize"
+
+class CachedMechanize < Mechanize
+
+  # Getter/Setter for the cache_class attribute
+  def self.cache_class #:nodoc:
+    @@cache_class
+  end
+  def self.cache_class=(cache_class) #:nodoc:
+    @@cache_class = cache_class
+  end
+  @@cache_class = nil
+
+  # Getter/Setter for the cache_options attribute
+  def self.cache_options #:nodoc:
+     @@cache_options
+  end
+  def self.cache_options=(cache_options) #:nodoc:
+    @@cache_options = cache_options
+  end
+  @@cache_options = {}
+
+  def initialize(*args)
+    super
+    @cache = (@@cache_class || CachedMechanize::FileCache).new(@@cache_options)
+  end
+
+  # parameters:
+  #  - uri
+  #  - options
+  #
+  # possible options are:
+  #  - +parameters+ (default: [])
+  #  - +referer+ (default: nil)
+  #  - +headers+ (default: {})
+  #  - +expires_after+ in seconds (default: 86400 = 1 day)
+  # def get(uri, options = {})
+  def get(uri, parameters = [], referer = nil, headers = {})
+
+    #options[:expires_after] ||= 86400
+
+    data = nil
+
+    if @cache.present?(uri, 86400)
+      data = Mechanize::Page.new(URI(uri), nil, @cache.retrieve(uri), nil, self)
+    else
+      data = super(uri, parameters, referer, headers)
+      @cache.store(uri, data.body)
+    end
+
+    return data
+  end
+
+  ##
+  #
+  # Example:
+  #
+  # CachedMechanize.configure do |config|
+  #   config.cache_class = CachedMechanize::CacheBackends::FileCache
+  #   config.cache_options = {
+  #     path: "/path/to/my/cached_files"
+  #   }
+  # end
+  #
+  def self.configure(&block)
+    yield self
+  end
+end
+
+require "./file_cache"

data/lib/file_cache.rb

@@ -0,0 +1,66 @@
+require "digest/sha1"
+require "zlib"
+
+class CachedMechanize
+
+    class FileCache
+
+      class GzFile
+        def self.open(path, &block)
+          Zlib::GzipWriter.open(path) do |gz|
+            yield gz
+          end
+        end
+
+        def self.read(path)
+          data = nil
+
+          File.open(path) do |file|
+            gz = Zlib::GzipReader.new(file)
+            data = gz.read
+            gz.close
+          end
+
+          return data
+        end
+      end
+
+      ##
+      #
+      # Options:
+      #  - +path+ the path where the cached files should be stored
+      #
+      def initialize(options={})
+        @path = options[:path] || '/tmp'
+      end
+
+      def present?(uri, expires_after)
+        File.exist?(file_name(uri)) && file_age(uri) <= expires_after
+      end
+
+      def retrieve(uri)
+        GzFile.read(file_name(uri))
+      end
+
+      def store(uri, data)
+        GzFile.open(file_name(uri)) do |file|
+          file.write(data)
+        end
+      end
+
+      private
+
+      def file_age(uri)
+        Time.now - File.mtime(file_name(uri))
+      end
+
+      def file_name(uri)
+        File.join(@path, uri_to_key(uri))
+      end
+
+      def uri_to_key(uri)
+        Digest::SHA1.hexdigest(uri)
+      end
+    end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: cached_mechanize2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- johnwylie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- johnwylie70@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cached_mechanize2.gemspec
+- lib/cached_mechanize.rb
+- lib/file_cache.rb
+homepage: https://github.com/johnwylie70/cached_mechanize2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A small wrapper around Mechanize to enable caching for GET requests.
+test_files: []