cached_web 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+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_web.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ian Connor
+
+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,29 @@
+# CachedWeb
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cached_web'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cached_web
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 @@
+require "bundler/gem_tasks"

data/cached_web.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cached_web/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cached_web"
+  gem.version       = CachedWeb::VERSION
+  gem.authors       = ["Ian Connor"]
+  gem.email         = ["iconnor@projectlounge.com"]
+  gem.description   = %q{Simple gem to cache web locally}
+  gem.summary       = %q{Cached web with sleeps and local storage}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency "mechanize"
+end

data/lib/cached_web/version.rb

@@ -0,0 +1,3 @@
+class CachedWeb
+  VERSION = "0.0.1"
+end

data/lib/cached_web.rb

@@ -0,0 +1,146 @@
+require "cached_web/version"
+
+class CachedWeb
+  
+  @@min_wait_times = {}
+  @@last_request_times = {}
+ 
+  def escape_key(key)
+    if key.size > 140
+      Digest::MD5.hexdigest(key)
+    else
+      key.gsub(/[^a-z0-9]/i,"_")
+    end
+  end
+  
+  def self.get(params)
+    CachedWeb.new.get(params)
+  end
+  
+  def get(params)
+    url = params[:url].gsub(" ","%20").gsub("%off", "%25off")
+    page, redirect_url, headers = get_cache(:url=>url, :expires_in=>params[:expires_in], :details=>true) rescue [nil, nil, nil]
+    
+    if params[:cache_only]
+      return [nil, nil, nil] if page.blank?
+      return [page, redirect_url, headers]
+    end
+
+    if page.blank?
+      uri = URI.parse(url)
+      domain = uri.host.downcase
+      #puts "Not in cache - getting: #{params[:url]}"
+      # Don't hit a site more than once per 5 seconds
+      time_to_wait = (@@min_wait_times[domain] || 5) -
+        (Time.now - (@@last_request_times[domain] || Time.at(0)))
+      if time_to_wait > 0  
+        puts "Waiting for #{time_to_wait} on domain #{domain}"
+        sleep time_to_wait
+      end
+      
+      @agent = Mechanize.new unless @agent
+      page = @agent.get(url) 
+      @@last_request_times[uri.host]
+      content = page.body
+      redirect_url = page.uri.to_s
+      headers = page.header
+      set_cache(:url=>url, :redirect_url=>redirect_url, :headers=>headers, :content=>content)
+      [content, redirect_url, headers]
+    else
+      [page, redirect_url, headers]
+    end
+  end
+
+  def self.fetch_cache(params, &block)
+    CachedWeb.new.fetch_cache(params, &block)
+  end
+
+  def fetch_cache(params)
+    ret_val = nil
+    begin
+      ret_val = get_cache(params)
+    rescue
+      #puts "didn't find data in cache: #{$!}"
+    end
+    unless ret_val
+      ret_val = yield self
+      set_cache(params.merge(:page=>ret_val))
+    end
+    
+    return ret_val
+  end
+  
+  def post(url, params)
+    puts "Not in cache - POSTing to: #{url}"
+    @agent = Mechanize.new unless @agent
+    begin
+      page = @agent.post(url, params)
+      uri = URI.parse(url)
+      @@last_request_times[uri.host]
+      content = page.body
+      redirect_url = page.uri.to_s
+      headers = page.header
+      set_cache(:url=>url, :redirect_url=>redirect_url, :headers=>headers, :page=>content)
+      [content, redirect_url, headers]
+    rescue Exception => e
+      puts e
+      puts e.backtrace
+      Toadhopper(AIRBRAKE_KEY).post!(e)
+      ["", url, {}]
+    end
+  end
+
+  def set_cache(params)
+    key = escape_key(params[:url].present? ? params[:url] : params[:key])
+    content = params[:content]
+    redirect_url = params[:redirect_url]
+  
+    h = {:content => content, :redirect_url=>redirect_url}
+  
+  
+    path = "/tmp/cachedweb/#{key}"
+    #puts "Saving file to #{path}"
+    begin
+      File.open(path, 'w') do |out|
+         YAML.dump(h, out)
+      end
+    rescue Exception
+      `mkdir -p /tmp/cachedweb`
+      File.open(path, 'w') do |out|
+         YAML.dump(h, out)
+      end
+    end
+    true
+  end
+  
+  def get_cache(params)
+    key = escape_key(params[:url].present? ? params[:url] : params[:key])
+    details = params[:details]
+    expires_in = params[:expires_in]
+  
+    timestamp = nil
+
+    path = "/tmp/cachedweb/#{key}"
+    timestamp = File.ctime(path)
+  
+    if expires_in and timestamp.nil?
+      #puts "There is no timestamp, force a get of this URL so we can add a timestamp"
+      throw "There is no timestamp, force a get of this URL so we can add a timestamp"
+    end
+  
+    if expires_in and timestamp and timestamp < (Time.now - expires_in)
+      #puts "Cache is older than desired, saved on #{timestamp}"
+      throw "Cache is older than desired, saved on #{timestamp}"
+    end
+  
+    h = YAML::load_file(path)
+    content = h[:content]
+    redirect_url = h[:redirect_url]
+    if details
+      [content, redirect_url, nil]
+    else
+      content
+    end
+  end
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: cached_web
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ian Connor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple gem to cache web locally
+email:
+- iconnor@projectlounge.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cached_web.gemspec
+- lib/cached_web.rb
+- lib/cached_web/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cached web with sleeps and local storage
+test_files: []