quetzall-cloud_cache 1.1.0

data/README.txt

@@ -0,0 +1,48 @@
+= cloud_cache
+
+http://www.quetzall.com/
+
+== DESCRIPTION:
+
+Instant memcached, no servers required! See www.quetzall.com for more information.
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+sudo gem install activesupport
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIX
+
+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/bin/cloud_cache

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/lib/cloud_cache.rb

@@ -0,0 +1,228 @@
+require 'rubygems'
+require 'active_support'
+require 'net/http'
+require 'base64'
+
+$:.unshift(File.dirname(__FILE__))
+
+begin
+    require 'digest/hmac'
+    USE_EMBEDDED_HMAC = false
+rescue
+    puts "HMAC, not found in standard lib." + $!.message
+    require 'hmac-sha1'
+    USE_EMBEDDED_HMAC = true
+end
+
+
+
+module ActiveSupport
+    module Cache
+
+        class CloudCache < Store
+
+
+            attr_accessor :secret_key
+
+            def initialize(access_key, secret_key)
+                puts 'Creating new CloudCache'
+                @access_key = access_key
+                @secret_key = secret_key
+
+            end
+
+            def run_http(http_method, command_name, command_path, body=nil, parameters=nil, extra_headers=nil)
+                ts = generate_timestamp(Time.now.gmtime)
+                # puts 'timestamp = ' + ts
+                sig = generate_signature("CloudCache", command_name, ts, @secret_key)
+                # puts "My signature = " + sig
+                url = "http://cloudcache.ws/" + command_path
+                # puts url
+
+                user_agent = "CloudCache Ruby Client"
+                headers = {'User-Agent' => user_agent, 'signature' => sig, 'timestamp' => ts, 'akey' => @access_key}
+
+                if !extra_headers.nil?
+                    extra_headers.each_pair do |k, v|
+                        headers[k] = v
+                    end
+                end
+
+
+                uri = URI.parse(url)
+                if (http_method == :put)
+                    req = Net::HTTP::Put.new(uri.path)
+                    req.body = body unless body.nil?
+                elsif (http_method == :post)
+                    req = Net::HTTP::Post.new(uri.path)
+                    if !parameters.nil?
+                        req.set_form_data(parameters)
+                    end
+                elsif (http_method == :delete)
+                    req = Net::HTTP::Delete.new(uri.path)
+                    if !parameters.nil?
+                        req.set_form_data(parameters)
+                    end
+                else
+                    req = Net::HTTP::Get.new(uri.path)
+                end
+                headers.each_pair do |k, v|
+                    req[k] = v
+                end
+                # req.each_header do |k, v|
+                # puts 'header ' + k + '=' + v
+                #end
+                res = Net::HTTP.start(uri.host, uri.port) do |http|
+                    http.request(req)
+                end
+                case res
+                    when Net::HTTPSuccess
+                        # puts 'response body=' + res.body
+                        res.body
+                    else
+                        res.error!
+                end
+
+            end
+
+            def auth()
+                command_name =  "auth"
+                command_path = "auth"
+                run_http(:get, command_name, command_path)
+            end
+
+            def put(key, val, seconds_to_store=0, raw=false)
+                seconds_to_store = 0 if seconds_to_store.nil?
+                if raw
+                    data = val.to_s
+                else
+                    data = (Marshal.dump(val))
+                end
+                puts 'putting=' + data.to_s
+                extra_headers = seconds_to_store > 0 ? {"ttl"=>seconds_to_store} : nil
+                run_http(:put, "PUT", key, data, nil, extra_headers)
+            end
+
+
+            def get_multi(keys)
+                kj = keys.to_json
+                puts "keys.to_json = " + kj
+                extra_headers = {"keys" => kj }
+                puts "get_multi, extra_headers keys =  " + extra_headers.keys.to_s
+                puts "get_multi, extra_headers vals = " + extra_headers.values.to_s
+                body = run_http(:get, "GET", "getmulti", nil, nil, extra_headers)
+                vals = ActiveSupport::JSON.decode body
+                vals
+            end
+
+            def get(key, raw=false)
+                begin
+                    data = run_http(:get, "GET", key)
+                rescue Net::HTTPServerException
+                    # puts $!.message
+                    return nil if $!.message.include? "404"
+                    raise $!
+                end
+                # puts 'data=' + data.to_s
+                if raw
+                    return data
+                else
+                    return Marshal.load((data))
+                end
+            end
+
+            def list_keys
+                body = run_http(:get, "listkeys", "listkeys")
+                keys = ActiveSupport::JSON.decode body # body[1..-2].split(',').collect! {|n| n.to_i}
+                keys
+            end
+
+            def stats
+                body = run_http(:get, "mystats", "mystats")
+                #keys = ActiveSupport::JSON.decode body # body[1..-2].split(',').collect! {|n| n.to_i}
+                body
+            end
+
+
+            def flush
+                body = run_http(:get, "flush", "flush")
+                body.strip
+            end
+
+            def clear
+                flush
+            end
+
+            def read(name, options={})
+                super
+                ret = get(name)
+                return ret
+            end
+
+            def write(name, value, options={})
+                super
+                put(name, value, options[:expires_in], options[:raw])
+            end
+
+            def delete(name, options = nil)
+                super
+                run_http(:delete, "DELETE", name)
+            end
+
+            def delete_matched(matcher, options = nil)
+                super
+                raise "delete_matched not yet supported by CloudCache"
+            end
+
+            def exist?(key, options = nil)
+                x = get(key)
+                r = true
+                if (x == nil)
+                    r = false
+                end
+                r
+            end
+
+            def fetch(key, options = {})
+                if (options != {})
+                    raise "Options on fetch() not yet supported by this library"
+                end
+                v = get(key)
+                v
+            end
+
+            def increment(key, val=1)
+                ret = run_http(:post, "POST", key + "/incr", nil, {"val"=>val})
+                ret.to_i
+            end
+
+            def decrement(key, val=1)
+                ret = run_http(:post, "POST", key + "/decr", nil, {"val"=>val})
+                ret.to_i
+            end
+
+            def silence!
+                super
+            end
+
+            def shutdown
+
+            end
+
+
+            def generate_timestamp(gmtime)
+                return gmtime.strftime("%Y-%m-%dT%H:%M:%SZ")
+            end
+
+            def generate_signature(service, operation, timestamp, secret_access_key)
+                if USE_EMBEDDED_HMAC
+                    my_sha_hmac = HMAC::SHA1.digest(secret_access_key, service + operation + timestamp)
+                else
+                    my_sha_hmac = Digest::HMAC.digest(service + operation + timestamp, secret_access_key, Digest::SHA1)
+                end
+                my_b64_hmac_digest = Base64.encode64(my_sha_hmac).strip
+                return my_b64_hmac_digest
+            end
+        end
+    end
+end

data/lib/hmac-sha1.rb

@@ -0,0 +1,11 @@
+require 'hmac'
+require 'digest/sha1'
+
+module HMAC
+  class SHA1 < Base
+    def initialize(key = nil)
+      super(Digest::SHA1, 64, 20, key)
+    end
+    public_class_method :new, :digest, :hexdigest
+  end
+end

data/lib/hmac.rb

@@ -0,0 +1,112 @@
+# Copyright (C) 2001  Daiki Ueno <ueno@unixuser.org>
+# This library is distributed under the terms of the Ruby license.
+
+# This module provides common interface to HMAC engines.
+# HMAC standard is documented in RFC 2104:
+#
+#   H. Krawczyk et al., "HMAC: Keyed-Hashing for Message Authentication",
+#   RFC 2104, February 1997
+#
+# These APIs are inspired by JCE 1.2's javax.crypto.Mac interface.
+#
+#   <URL:http://java.sun.com/security/JCE1.2/spec/apidoc/javax/crypto/Mac.html>
+
+module HMAC
+  class Base
+    def initialize(algorithm, block_size, output_length, key)
+      @algorithm = algorithm
+      @block_size = block_size
+      @output_length = output_length
+      @status = STATUS_UNDEFINED
+      @key_xor_ipad = ''
+      @key_xor_opad = ''
+      set_key(key) unless key.nil?
+    end
+
+    private
+    def check_status
+      unless @status == STATUS_INITIALIZED
+	raise RuntimeError,
+	  "The underlying hash algorithm has not yet been initialized."
+      end
+    end
+
+    public
+    def set_key(key)
+      # If key is longer than the block size, apply hash function
+      # to key and use the result as a real key.
+      key = @algorithm.digest(key) if key.size > @block_size
+      key_xor_ipad = "\x36" * @block_size
+      key_xor_opad = "\x5C" * @block_size
+      for i in 0 .. key.size - 1
+	key_xor_ipad[i] ^= key[i]
+	key_xor_opad[i] ^= key[i]
+      end
+      @key_xor_ipad = key_xor_ipad
+      @key_xor_opad = key_xor_opad
+      @md = @algorithm.new
+      @status = STATUS_INITIALIZED
+    end
+
+    def reset_key
+      @key_xor_ipad.gsub!(/./, '?')
+      @key_xor_opad.gsub!(/./, '?')
+      @key_xor_ipad[0..-1] = ''
+      @key_xor_opad[0..-1] = ''
+      @status = STATUS_UNDEFINED
+    end
+
+    def update(text)
+      check_status
+      # perform inner H
+      md = @algorithm.new
+      md.update(@key_xor_ipad)
+      md.update(text)
+      str = md.digest
+      # perform outer H
+      md = @algorithm.new
+      md.update(@key_xor_opad)
+      md.update(str)
+      @md = md
+    end
+    alias << update
+
+    def digest
+      check_status
+      @md.digest
+    end
+
+    def hexdigest
+      check_status
+      @md.hexdigest
+    end
+    alias to_s hexdigest
+
+    # These two class methods below are safer than using above
+    # instance methods combinatorially because an instance will have
+    # held a key even if it's no longer in use.
+    def Base.digest(key, text)
+      begin
+	hmac = self.new(key)
+	hmac.update(text)
+	hmac.digest
+      ensure
+	hmac.reset_key
+      end
+    end
+
+    def Base.hexdigest(key, text)
+      begin
+	hmac = self.new(key)
+	hmac.update(text)
+	hmac.hexdigest
+      ensure
+	hmac.reset_key
+      end
+    end
+
+    private_class_method :new, :digest, :hexdigest
+  end
+
+  STATUS_UNDEFINED, STATUS_INITIALIZED = 0, 1
+end

data/test/cache_tests.rb

@@ -0,0 +1,144 @@
+require 'mini/test'
+require '../lib/cloudcache'
+
+#
+# You'll need make a cloudcache.yml file in this directory that contains:
+# amazon:
+#    access_key: ACCESS_KEY
+#    secret_key: SECRET
+#
+class CacheTests < Test::Unit::TestCase
+
+  def test_for_truth
+    assert true
+  end
+
+  def setup
+    puts("Setting up cache...")
+    props = nil
+    begin
+      props = YAML::load(File.read('cloudcache.yml'))
+    rescue
+      puts "Couldn't find cloudcache.yml file. " + $!.message
+      return
+    end
+    @cache = ActiveSupport::Cache::CloudCache.new("cloudcache-ruby-tests", props['amazon']['access_key'], props['amazon']['secret_key'])
+  end
+
+
+  def teardown
+    @cache.shutdown unless @cache.nil?
+  end
+
+  def test_auth
+    @cache.auth()
+  end
+
+  def test_bad_auth
+
+    temp = @cache.secret_key
+    @cache.secret_key = "badkey"
+
+    assert_raise Net::HTTPServerException do
+      test_basic_ops
+    end
+
+    @cache.secret_key = temp
+  end
+
+  def test_basic_ops
+    to_put = "I am a testing string. Take me apart and put me back together again."
+    @cache.put("s1", to_put, 0);
+
+    sleep(5)
+
+    response = @cache.get("s1")
+    assert_equal(to_put, response)
+
+  end
+
+  def test_not_exists
+    assert_nil @cache.get("does_not_exist")
+  end
+
+  def test_delete
+    to_put = "I am a testing string. Take me apart and put me back together again."
+    @cache.put("s1", to_put, 0)
+
+    sleep(5)
+
+    response = @cache.get("s1")
+    assert_equal(to_put, response)
+
+    @cache.delete("s1");
+
+    response = @cache.get("s1")
+    assert_nil(response)
+  end
+
+  def test_expiry
+    to_put = "I am a testing string. Take me apart and put me back together again."
+    @cache.put("s1", to_put, 5);
+
+    sleep(10)
+
+    response = @cache.get("s1")
+    assert_nil(response)
+  end
+
+  def test_list_keys
+    @cache.put("k1","v2") 
+    sleep 1
+    keys = @cache.list_keys
+    puts("PRINTING KEYS:")
+    for key in keys
+      puts key
+    end
+    haskey = keys.index("k1")
+    assert_not_nil(haskey)
+  end
+
+  def test_counters
+    val = 0;
+    key = "counter1";
+    @cache.put(key, val, 50000, true);
+    10.times do
+      val = @cache.increment(key)
+    end
+    assert_equal(10, val)
+
+    10.times do
+      val = @cache.decrement(key)
+    end
+    assert_equal(0, val);
+
+    # One more to make sure it stays at 0
+    val = @cache.decrement(key);
+    assert_equal(0, val);
+
+  end
+
+  def test_flush
+    x = @cache.flush
+    assert_equal('[]', x)
+  end
+
+  def test_stats
+    x = @cache.stats
+    puts x
+  end
+  def test_get_multi
+    @cache.put("m1","v1")
+    @cache.put("m2","v2")
+
+    kz = Array["m1" , "m2", "m3"]
+    vz = @cache.get_multi(kz) 
+
+    assert_equal("v1",vz["m1"]);
+    assert_equal("v2",vz["m2"]);
+    assert_nil(vz["m3"]);
+  end
+
+
+
+end

data/test/test_cloud_cache.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "cloud_cache"
+
+class TestCloudCache < Test::Unit::TestCase
+  def test_sanity
+    flunk "write tests or I will kneecap you"
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: quetzall-cloud_cache
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Travis Reeder
+- Marc Byrd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-23 00:00:00 -07:00
+default_executable: cloud_cache
+dependencies: []
+
+description: Client library for Quetzall's CloudCache service.
+email: travis@appoxy.com
+executables: 
+- cloud_cache
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/cloud_cache.rb
+- lib/hmac-sha1.rb
+- lib/hmac.rb
+- README.txt
+has_rdoc: true
+homepage: http://github.com/quetzall/cloud_cache/
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Client library for Quetzall's CloudCache service.
+test_files: 
+- test/cache_tests.rb
+- test/test_cloud_cache.rb