httparty-icebox 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/History

@@ -0,0 +1,4 @@
+== 0.0.1 
+
+* major enhancements
+  * Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kristoffer Sachse
+
+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,64 @@
+# HTTParty-Icebox - Caching for HTTParty
+
+## Description
+
+Cache responses in HTTParty models
+
+## Installation
+
+### RubyGems
+
+You can install the latest Film Buff gem using RubyGems
+
+    gem install httparty-icebox
+
+### GitHub
+
+Alternatively you can check out the latest code directly from Github
+
+    git clone http://github.com/sachse/httparty-icebox.git
+
+## Usage
+
+
+
+### Examples
+
+Enable caching with default values:
+
+    require 'httparty-icebox'
+    
+    include HTTParty::Icebox
+    
+    cache
+    # Use HTTParty's .get method as usual, the response will now be cached
+    cached_response = HTTParty.get("https://github.com/sachse/httparty-icebox")
+
+Cache responses for 5 minutes on the system in the directory "/tmp":
+
+    require 'httparty-icebox'
+    
+    include HTTParty::Icebox
+    
+    cache :store => 'file', :timeout => 300, :location => '/tmp/'
+    # Use HTTParty's .get method as usual, the response will now be cached
+    cached_response = HTTParty.get("https://github.com/sachse/httparty-icebox")
+
+## Authors
+
+- [Kristoffer Sachse](https://github.com/sachse) (Current maintainer)
+
+- [Karel Minarik](http://karmi.cz) (Original creator through [a gist](https://gist.github.com/209521/))
+
+## Contribute
+
+Fork the project, implement your changes in it's own branch, and send
+a pull request to me. I'll gladly consider any help or ideas.
+
+### Contributors
+
+- [Martyn Loughran](https://github.com/mloughran) - Major parts of this code are based on the architecture of ApiCache.
+- [David Heinemeier Hansson](https://github.com/dhh) - Other parts are inspired by the ActiveSupport::Cache in Ruby On Rails.
+- [Amit Chakradeo](https://github.com/amit) - For pointing out response objects have to be stored marshalled on FS.
+- Marlin Forbes - For pointing out the query parameters have to be included in the cache key.
+- [ramieblatt](https://github.com/ramieblatt) - Original Memcached store.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/httparty-icebox.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "httparty-icebox/version"
+
+Gem::Specification.new do |s|
+  s.name        = "httparty-icebox"
+  s.version     = Httparty::Icebox::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kristoffer Sachse", "Karel Minarik"]
+  s.email       = ["kristoffer@sachse.nu"]
+  s.homepage    = "https://github.com/sachse/httparty-icebox"
+  s.summary     = %q{Caching for HTTParty}
+  s.description = %q{Cache responses in HTTParty models}
+
+  s.rubyforge_project = "httparty-icebox"
+
+  s.add_dependency("httparty", "~> 0.7.4")
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+end

data/lib/httparty-icebox.rb

@@ -0,0 +1,212 @@
+require 'logger'
+require 'fileutils'
+require 'tmpdir'
+require 'pathname'
+require 'digest/md5'
+
+module HTTParty #:nodoc:
+  # == Caching for HTTParty
+  # See documentation in HTTParty::Icebox::ClassMethods.cache
+  #
+  module Icebox
+
+    module ClassMethods
+
+      # Enable caching and set cache options
+      # Returns memoized cache object
+      #
+      # Following options are available, default values are in []:
+      #
+      # +store+::       Storage mechanism for cached data (memory, filesystem, your own) [memory]
+      # +timeout+::     Cache expiration in seconds [60]
+      # +logger+::      Path to logfile or logger instance [nil, silent]
+      # 
+      # Any additional options are passed to the Cache constructor
+      #
+      # Usage:
+      #
+      #   # Enable caching in HTTParty, in memory, for 1 minute
+      #   cache # Use default values
+      #
+      #   # Enable caching in HTTParty, on filesystem (/tmp), for 10 minutes
+      #   cache :store => 'file', :timeout => 600, :location => '/tmp/'
+      #
+      #   # Use your own cache store (see +AbstractStore+ class below)
+      #   cache :store => 'memcached', :timeout => 600, :server => '192.168.1.1:1001'
+      #
+      def cache(options={})
+        options[:store]   ||= 'memory'
+        options[:timeout] ||= 60
+        logger = options[:logger]
+        @cache ||= Cache.new( options.delete(:store), options )
+      end
+
+    end
+
+    # When included, extend class with +cache+ method
+    # and redefine +get+ method to use cache
+    #
+    def self.included(receiver) #:nodoc:
+      receiver.extend ClassMethods
+      receiver.class_eval do
+
+        # Get reponse from network
+        #
+        # TODO: Why alias :new :old is not working here? Returns NoMethodError
+        #
+        def self.get_without_caching(path, options={})
+          perform_request Net::HTTP::Get, path, options
+        end
+
+        # Get response from cache, if available
+        #
+        def self.get_with_caching(path, options={})
+          key = path.downcase # this makes a copy of path
+          key << options[:query].to_s if defined? options[:query]
+          if cache.exists?(key) and not cache.stale?(key)
+            Cache.logger.debug "CACHE -- GET #{path}#{options[:query]}"
+            return cache.get(key)
+          else
+            Cache.logger.debug "/!\\ NETWORK -- GET #{path}#{options[:query]}"
+            response = get_without_caching(path, options)
+            cache.set(key, response) if response.code.to_s == "200" # this works for string and integer response codes
+            return response
+          end
+        end
+
+        # Redefine original HTTParty +get+ method to use cache
+        #
+        def self.get(path, options={})
+          self.get_with_caching(path, options)
+        end
+
+      end
+    end
+
+    # === Cache container
+    #
+    # Pass a store name ('memory', etc) to new
+    #
+    class Cache
+      attr_accessor :store
+
+      def initialize(store, options={})
+        self.class.logger = options[:logger]
+        @store = self.class.lookup_store(store).new(options)
+      end
+
+      def get(key);            @store.get encode(key) unless stale?(key);        end
+      def set(key, value);puts "Cache.set, key: #{key}, value: #{value}";     @store.set encode(key), value;                    end
+      def exists?(key);        @store.exists? encode(key);                       end
+      def stale?(key);         @store.stale?  encode(key);                       end
+
+      def self.logger; @logger || default_logger; end
+      def self.default_logger; logger = ::Logger.new(STDERR); end
+
+      # Pass a filename (String), IO object, Logger instance or +nil+ to silence the logger
+      def self.logger=(device); @logger = device.kind_of?(::Logger) ? device : ::Logger.new(device); end
+
+      private
+
+      # Return store class based on passed name
+      def self.lookup_store(name)
+        store_name = "#{name.capitalize}Store"
+        return Store::const_get(store_name)
+      rescue NameError => e
+        raise Store::StoreNotFound, "The cache store '#{store_name}' was not found. Did you load any such class?"
+      end
+
+      def encode(key); Digest::MD5.hexdigest(key); end
+    end
+
+
+    # === Cache stores
+    #
+    module Store
+
+      class StoreNotFound < StandardError; end #:nodoc:
+
+      # ==== Abstract Store
+      # Inherit your store from this class
+      # *IMPORTANT*: Do not forget to call +super+ in your +initialize+ method!
+      #
+      class AbstractStore
+        def initialize(options={})
+          raise ArgumentError, "You need to set the :timeout parameter" unless options[:timeout]
+          @timeout = options[:timeout]
+          message =  "Cache: Using #{self.class.to_s.split('::').last}"
+          message << " in location: #{options[:location]}" if options[:location]
+          message << " with timeout #{options[:timeout]} sec"
+          Cache.logger.info message unless options[:logger].nil?
+          return self
+        end
+        %w{set get exists? stale?}.each do |method_name|
+          define_method(method_name) { raise NoMethodError, "Please implement method #{method_name} in your store class" }
+        end
+      end
+
+      # ==== Store objects in memory
+      # See HTTParty::Icebox::ClassMethods.cache
+      #
+      class MemoryStore < AbstractStore
+        def initialize(options={})
+          super; @store = {}; self
+        end
+        def set(key, value)
+          Cache.logger.info("Cache: set (#{key})")
+          @store[key] = [Time.now, value]; true
+        end
+        def get(key)
+          data = @store[key][1]
+          Cache.logger.info("Cache: #{data.nil? ? "miss" : "hit"} (#{key})")
+          data
+        end
+        def exists?(key)
+          !@store[key].nil?
+        end
+        def stale?(key)
+          return true unless exists?(key)
+          Time.now - created(key) > @timeout
+        end
+        private
+        def created(key)
+          @store[key][0]
+        end
+      end
+
+      # ==== Store objects on the filesystem
+      # See HTTParty::Icebox::ClassMethods.cache
+      #
+      class FileStore < AbstractStore
+        def initialize(options={})
+          super
+          options[:location] ||= Dir::tmpdir
+          @path = Pathname.new( options[:location] )
+          FileUtils.mkdir_p( @path )
+          self
+        end
+        def set(key, value)
+          Cache.logger.info("Cache: set (#{key})")
+          File.open( @path.join(key), 'w' ) { |file| file << Marshal.dump(value)  }
+          true
+        end
+        def get(key)
+          data = Marshal.load(File.read( @path.join(key)))
+          Cache.logger.info("Cache: #{data.nil? ? "miss" : "hit"} (#{key})")
+          data
+        end
+        def exists?(key)
+          File.exists?( @path.join(key) )
+        end
+        def stale?(key)
+          return true unless exists?(key)
+          Time.now - created(key) > @timeout
+        end
+        private
+        def created(key)
+          File.mtime( @path.join(key) )
+        end
+      end
+    end
+  end
+end

data/lib/httparty-icebox/version.rb

@@ -0,0 +1,5 @@
+module Httparty
+  module Icebox
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: httparty-icebox
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kristoffer Sachse
+- Karel Minarik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.7.4
+  type: :runtime
+  version_requirements: *id001
+description: Cache responses in HTTParty models
+email: 
+- kristoffer@sachse.nu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- History
+- LICENSE
+- README.md
+- Rakefile
+- httparty-icebox.gemspec
+- lib/httparty-icebox.rb
+- lib/httparty-icebox/version.rb
+has_rdoc: true
+homepage: https://github.com/sachse/httparty-icebox
+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: httparty-icebox
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Caching for HTTParty
+test_files: []
+