iron_cache 0.0.1

data/README.md

@@ -0,0 +1,52 @@
+IronMQ Ruby Client
+-------------
+
+Getting Started
+==============
+
+Install the gem:
+
+    gem install iron_cache
+
+Create an IronMQ client object:
+
+    @iron_cache = IronCache::Client.new(:token=>'MYTOKEN', :project_id=>'MYPROJECTID')
+
+You can get your `token` and `project_id` at http://www.iron.io .
+
+
+The Basics
+=========
+
+**Put** an item in the cache:
+
+    msg = @iron_cache.items.put("mykey", "hello world!")
+    p msg
+
+**Get** an item from the cache:
+
+    msg = @iron_cache.items.get("mykey")
+    p msg
+
+**Delete** an item from the cache:
+
+    res = msg.delete # or @iron_cache.items.delete("mykey")
+    p res
+
+
+Queue Selection
+===============
+
+One of the following:
+
+1. Pass `:cache_name=>'my_cache'` into IronCache::Client.new
+1. `@iron_cache.cache_name = 'my_cache'`
+1. Pass `:cache_name=>'my_cache'` into any post(), get(), or delete()
+
+Queue Information
+=================
+
+    cache = @iron_cache.queues.get(:name=>"my_cache")
+    puts "size: #{cache.size}"
+
+ 

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler2'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "iron_cache"
+    gem.summary = "Ruby client for IronCache by www.iron.io"
+    gem.description = "Ruby client for IronCache by www.iron.io"
+    gem.email = "travis@iron.io"
+    gem.homepage = "http://www.iron.io"
+    gem.authors = ["Travis Reeder"]
+    gem.add_dependency 'rest-client'
+    gem.add_dependency 'rest', '>= 0.1.2'
+    #gem.add_dependency 'typhoeus'
+    gem.required_ruby_version = '>= 1.9'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler2"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "iron_cache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+---
+:major: 0
+:minor: 0
+:patch: 1
+:build:

data/iron_cache.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "iron_cache"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Travis Reeder"]
+  s.date = "2012-03-26"
+  s.description = "Ruby client for IronCache by www.iron.io"
+  s.email = "travis@iron.io"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+    "Rakefile",
+    "VERSION.yml",
+    "iron_cache.gemspec",
+    "lib/iron_cache.rb",
+    "lib/iron_cache/caches.rb",
+    "lib/iron_cache/client.rb",
+    "lib/iron_cache/items.rb",
+    "test/Gemfile",
+    "test/Gemfile.lock",
+    "test/quick_run.rb",
+    "test/test_base.rb",
+    "test/test_iron_cache.rb",
+    "test/test_memcached.rb"
+  ]
+  s.homepage = "http://www.iron.io"
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9")
+  s.rubygems_version = "1.8.15"
+  s.summary = "Ruby client for IronCache by www.iron.io"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<rest>, [">= 0.1.2"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<rest>, [">= 0.1.2"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<rest>, [">= 0.1.2"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<rest>, [">= 0.1.2"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<rest>, [">= 0.1.2"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<rest>, [">= 0.1.2"])
+  end
+end
+

data/lib/iron_cache/caches.rb

@@ -0,0 +1,80 @@
+module IronCache
+  class Caches
+
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def path(options={})
+      path = "/projects/#{@client.project_id}/caches"
+    end
+
+    def list(options={})
+      ret = []
+      res, status = @client.get("#{path(options)}", options)
+      res.each do |q|
+        #p q
+        q = Cache.new(self, q)
+        ret << q
+      end
+      ret
+    end
+
+    # options:
+    #  :name => can specify an alternative queue name
+    def get(options={})
+      res, status = @client.get("#{path(options)}/#{options[:name]}")
+      return Cache.new(self, res)
+    end
+
+
+  end
+
+  class Cache
+
+    def initialize(queues, res)
+      @queues = queues
+      @data = res
+    end
+
+    def raw
+      @data
+    end
+
+    def [](key)
+      raw[key]
+    end
+
+    def id
+      raw["id"]
+    end
+
+    def name
+      raw["name"]
+    end
+
+    def size
+      return raw["size"] if raw["size"]
+      return @size if @size
+      q = @queues.get(:name=>name)
+      @size = q.size
+      @size
+    end
+
+    def total_messages
+      return raw["total_messages"] if raw["total_messages"]
+      return @total_messages if @total_messages
+      q = @queues.get(:name=>name)
+      @total_messages = q.total_messages
+      @total_messages
+    end
+
+    # def delete
+    # @messages.delete(self.id)
+    # end
+  end
+
+end
+

data/lib/iron_cache/client.rb

@@ -0,0 +1,152 @@
+require 'json'
+require 'logger'
+require 'rest'
+
+module IronCache
+
+  class Client
+
+    attr_accessor :token, :project_id, :cache_name, :logger,
+        :scheme, :host, :port
+
+    def initialize(options={})
+      @logger = Logger.new(STDOUT)
+      @logger.level=Logger::INFO
+
+      @token = options[:token] || options['token']
+      @project_id = options[:project_id] || options['project_id']
+      @cache_name = options[:cache_name] || options['cache_name'] || "default"
+      @scheme = options[:scheme] || options['scheme'] || "https"
+      @host = options[:host] || options['host'] || "cache-aws-us-east-1.iron.io"
+      @port = options[:port] || options['port'] || 443
+
+      @base_url = "#{@scheme}://#{@host}:#{@port}/1"
+
+      @rest = Rest::Client.new
+
+    end
+
+    def items
+      return Items.new(self)
+    end
+
+    def cache
+
+    end
+
+    def caches
+      return Caches.new(self)
+    end
+
+    def base_url
+      #"#{scheme}://#{host}:#{port}/1"
+      @base_url
+    end
+
+
+    def full_url(path)
+      url = "#{base_url}#{path}"
+      url
+    end
+
+    def common_req_hash
+      {
+          :headers=>{"Content-Type" => 'application/json',
+                     "Authorization"=>"OAuth #{@token}",
+                     "User-Agent"=>"IronCache Ruby Client"}
+      }
+    end
+
+    def get(path, params={})
+      url = full_url(path)
+      @logger.debug 'url=' + url
+      req_hash = common_req_hash
+      req_hash[:params] = params if params
+      @logger.debug 'req_hash=' + req_hash.inspect
+      response = @rest.get(url, req_hash)
+      @logger.debug 'GET response=' + response.inspect
+      res = check_response(response)
+      return res, response.code
+    end
+
+    def post(path, params={})
+      url = full_url(path)
+      @logger.debug 'url=' + url
+      #response = @http_sess.post(path + "?oauth=#{@token}", {'oauth' => @token}.merge(params).to_json, {"Content-Type" => 'application/json'})
+      req_hash = common_req_hash
+      req_hash[:body] = params.to_json
+      response = @rest.post(url, req_hash)
+      @logger.debug 'POST response=' + response.inspect
+      res = check_response(response)
+      #@logger.debug 'response: ' + res.inspect
+      #body = response.body
+      #res = JSON.parse(body)
+      return res, response.code
+    end
+
+    def put(path, params={})
+      url = full_url(path)
+      @logger.debug 'url=' + url
+      #response = @http_sess.post(path + "?oauth=#{@token}", {'oauth' => @token}.merge(params).to_json, {"Content-Type" => 'application/json'})
+      req_hash = common_req_hash
+      req_hash[:body] = params.to_json
+      response = @rest.put(url, req_hash)
+      @logger.debug 'POST response=' + response.inspect
+      res = check_response(response)
+      #@logger.debug 'response: ' + res.inspect
+      #body = response.body
+      #res = JSON.parse(body)
+      return res, response.code
+    end
+
+
+
+    def delete(path, params={})
+      url = "#{base_url}#{path}"
+      @logger.debug 'url=' + url
+      req_hash = common_req_hash
+      req_hash[:params] = params
+      response = @rest.delete(url, req_hash)
+      res = check_response(response)
+      #body = response.body
+      #res = JSON.parse(body)
+      #@logger.debug 'response: ' + res.inspect
+      return res, response.code
+    end
+
+    def check_response(response)
+      # response.code    # http status code
+      #response.time    # time in seconds the request took
+      #response.headers # the http headers
+      #response.headers_hash # http headers put into a hash
+      #response.body    # the response body
+      status = response.code
+      body = response.body
+      # todo: check content-type == application/json before parsing
+      @logger.debug "response code=" + status.to_s
+      @logger.debug "response body=" + body.inspect
+      res = JSON.parse(body)
+      if status < 400
+
+      else
+        raise IronCache::Error.new(res["msg"], :status=>status)
+      end
+      res
+    end
+
+  end
+
+  class Error < StandardError
+    def initialize(msg, options={})
+      super(msg)
+      @options = options
+    end
+
+    def status
+      @options[:status]
+    end
+  end
+
+
+end
+

data/lib/iron_cache/items.rb

@@ -0,0 +1,93 @@
+module IronCache
+  class Items
+
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def path(key, options={})
+      path = "/projects/#{@client.project_id}/caches/#{options[:cache_name] || @client.cache_name}/items/#{key}"
+    end
+
+    # options:
+    #  :queue_name => can specify an alternative queue name
+    #  :timeout => amount of time before message goes back on the queue
+    def get(key, options={})
+      begin
+        res, status = @client.get(path(key, options), options)
+        @client.logger.debug "GET response: " + res.inspect
+        return Item.new(self, res)
+      rescue IronCache::Error => ex
+        if ex.status == 404
+          return nil
+        end
+        raise ex
+      end
+
+    end
+
+    # options:
+    #  :cache_name => can specify an alternative queue name
+    #  :expires_in => After this delay in seconds, message will be automatically removed from the cache.
+    def put(key, value, options={})
+      to_send = options
+      to_send[:body] = value
+      res, status = @client.put(path(key, options), to_send)
+      #return Message.new(self, res)
+      return ResponseBase.new(res)
+    end
+
+    def delete(key, options={})
+      path2 = "#{self.path(key, options)}"
+      res, status = @client.delete(path2)
+      res
+    end
+
+  end
+
+  class ResponseBase
+    def initialize(res)
+      @data = res
+    end
+
+    def raw
+      @data
+    end
+
+    def [](key)
+      raw[key]
+    end
+
+    def id
+      raw["id"]
+    end
+
+    def msg
+      raw["msg"]
+    end
+
+  end
+
+  class Item < ResponseBase
+
+    def initialize(messages, res)
+      super(res)
+      @messages = messages
+    end
+
+    def key
+      raw["key"]
+    end
+
+    def value
+      raw["value"]
+    end
+
+    def delete
+      @messages.delete(self.id)
+    end
+  end
+
+end

data/lib/iron_cache.rb

@@ -0,0 +1,3 @@
+require_relative 'iron_cache/caches'
+require_relative 'iron_cache/items'
+require_relative 'iron_cache/client'

data/test/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'test-unit'
+gem 'concur'

data/test/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    beanstalk-client (1.1.1)
+    concur (0.1.2)
+      em-http-request
+      em-http-request
+      eventmachine
+      eventmachine
+      faraday
+      faraday
+    cookiejar (0.3.0)
+    em-http-request (1.0.1)
+      addressable (>= 2.2.3)
+      cookiejar
+      em-socksify
+      eventmachine (>= 1.0.0.beta.4)
+      http_parser.rb (>= 0.5.3)
+    em-socksify (0.1.0)
+      eventmachine
+    eventmachine (1.0.0.beta.4)
+    faraday (0.7.5)
+      addressable (~> 2.2.6)
+      multipart-post (~> 1.1.3)
+      rack (>= 1.1.0, < 2)
+    http_parser.rb (0.5.3)
+    multipart-post (1.1.4)
+    rack (1.4.0)
+    test-unit (2.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  beanstalk-client
+  concur
+  test-unit

data/test/quick_run.rb

@@ -0,0 +1,33 @@
+# Put config.yml file in ~/Dropbox/configs/ironmq_gem/test/config.yml
+require_relative 'test_base'
+
+class QuickRun < TestBase
+
+  def setup
+    super
+    @client.queue_name = 'ironmq-gem-quick'
+  end
+
+  def test_basics
+    res = @client.items.post("hello world!")
+    assert res.id
+    assert res.msg
+    p res
+
+    res = @client.items.get()
+    assert res.id
+    assert res.body
+    p res
+
+    res = @client.items.delete(res["id"])
+    assert res.msg
+    p res
+
+    res = @client.items.get()
+    p res
+
+  end
+
+
+end
+

data/test/test_base.rb

@@ -0,0 +1,52 @@
+gem 'test-unit'
+require 'test/unit'
+require 'yaml'
+begin
+  require File.join(File.dirname(__FILE__), '../lib/iron_cache')
+rescue Exception => ex
+  puts "Could NOT load current iron_cache: " + ex.message
+  raise ex
+end
+
+
+class TestBase < Test::Unit::TestCase
+  def setup
+    puts 'setup'
+    # check multiple config locations
+    @config = load_config
+    puts "config=" + @config.inspect
+    @client = IronCache::Client.new(@config['iron'])
+    @client.logger.level = Logger::DEBUG
+    @client.cache_name = 'iron_cache_ruby_tests'
+
+  end
+
+  def load_config
+    # check for config
+    # First check if running in abt worker
+    if defined? $abt_config
+      @config = $abt_config
+      return @config
+    end
+    cf = File.expand_path(File.join("~", "Dropbox", "configs", "iron_cache_ruby", "test", "config.yml"))
+    if File.exist?(cf)
+      @config = YAML::load_file(cf)
+      return @config
+    end
+
+  end
+
+
+  def clear_queue(queue_name=nil)
+    #queue_name ||= @client.cache_name
+    #puts "clearing queue #{queue_name}"
+    #while res = @client.messages.get(:cache_name=>queue_name)
+    #  p res
+    #  puts res.body.to_s
+    #  res.delete
+    #end
+    #puts 'cleared.'
+  end
+
+
+end

data/test/test_iron_cache.rb

@@ -0,0 +1,59 @@
+gem 'test-unit'
+require 'test/unit'
+require 'beanstalk-client'
+require 'yaml'
+require_relative 'test_base'
+
+class IronCacheTests < TestBase
+  def setup
+    super
+
+  end
+
+  def test_basics
+    @client.cache_name = 'test_basics'
+    clear_queue
+
+    k = "key1"
+    v = "hello world!"
+    res = @client.items.put(k, v)
+    # another naming option we could try:
+    #res = @client.cache('test_basics').items.put("key1", "hello world!")
+    p res
+    assert res.msg
+
+    res = @client.items.get(k)
+    p res
+    assert res["key"]
+    assert res.key
+    assert res.key == k
+    assert res.value == v
+
+    res = @client.items.delete(res.key)
+    p res
+    puts "shouldn't be any more"
+    res = @client.items.get(k)
+    p res
+    assert res.nil?
+
+  end
+
+  def test_expiry
+    @client.cache_name = 'test_basics'
+    clear_queue
+    k = "key1"
+    v = "hello world!"
+    res = @client.items.put(k, v, :expires_in=>10)
+
+    res = @client.items.get(k)
+    p res
+    assert res.key == k
+
+    sleep 11
+    res = @client.items.get(k)
+    assert res.nil?
+
+  end
+
+end
+

data/test/test_memcached.rb

@@ -0,0 +1,59 @@
+gem 'test-unit'
+require 'test/unit'
+require 'beanstalk-client'
+require 'yaml'
+require_relative 'test_base'
+
+class IronCacheTests < TestBase
+  def setup
+    super
+
+  end
+
+  def test_basics
+    @client.cache_name = 'test_basics'
+    clear_queue
+
+    k = "key1"
+    v = "hello world!"
+    res = @client.items.put(k, v)
+    # another naming option we could try:
+    #res = @client.cache('test_basics').items.put("key1", "hello world!")
+    p res
+    assert res.msg
+
+    res = @client.items.get(k)
+    p res
+    assert res["key"]
+    assert res.key
+    assert res.key == k
+    assert res.value == v
+
+    res = @client.items.delete(res.key)
+    p res
+    puts "shouldn't be any more"
+    res = @client.items.get(k)
+    p res
+    assert res.nil?
+
+  end
+
+  def test_expiry
+    @client.cache_name = 'test_basics'
+    clear_queue
+    k = "key1"
+    v = "hello world!"
+    res = @client.items.put(k, v, :expires_in=>10)
+
+    res = @client.items.get(k)
+    p res
+    assert res.key == k
+
+    sleep 11
+    res = @client.items.get(k)
+    assert res.nil?
+
+  end
+
+end
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: iron_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Travis Reeder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &15146280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15146280
+- !ruby/object:Gem::Dependency
+  name: rest
+  requirement: &15145660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *15145660
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &15145020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15145020
+- !ruby/object:Gem::Dependency
+  name: rest
+  requirement: &15144420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *15144420
+description: Ruby client for IronCache by www.iron.io
+email: travis@iron.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- Rakefile
+- VERSION.yml
+- iron_cache.gemspec
+- lib/iron_cache.rb
+- lib/iron_cache/caches.rb
+- lib/iron_cache/client.rb
+- lib/iron_cache/items.rb
+- test/Gemfile
+- test/Gemfile.lock
+- test/quick_run.rb
+- test/test_base.rb
+- test/test_iron_cache.rb
+- test/test_memcached.rb
+homepage: http://www.iron.io
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Ruby client for IronCache by www.iron.io
+test_files: []