iron_cache 0.0.4 → 1.0.0

data/Gemfile.lock

@@ -1,26 +1,29 @@
 PATH
   remote: .
   specs:
-    iron_cache (0.0.3)
-      iron_core
+    iron_cache (0.1.0)
+      iron_core (>= 0.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    iron_core (0.1.3)
+    ffi (1.0.11)
+    iron_core (0.1.4)
       bundler (> 1.0.0)
       rest
       rest-client
     memcache-client (1.8.5)
-    mime-types (1.18)
+    mime-types (1.19)
     rake (0.9.2.2)
-    rest (0.3.0)
-      rest-client
-      rest-client
+    rest (1.0.0)
+      rest-client (>= 0.3.0)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    test-unit (2.4.8)
-    uber_config (0.0.1)
+    test-unit (2.5.0)
+    typhoeus (0.4.2)
+      ffi (~> 1.0)
+      mime-types (~> 1.18)
+    uber_config (0.0.3)
 
 PLATFORMS
   ruby
@@ -30,4 +33,5 @@ DEPENDENCIES
   memcache-client
   rake
   test-unit
+  typhoeus
   uber_config

data/README.md

@@ -1,52 +1,53 @@
-IronMQ Ruby Client
+IronCache Ruby Client
 -------------
 
 Getting Started
 ==============
 
-Install the gem:
+1. Install the gem:
 
     gem install iron_cache
 
-Create an IronCache client object:
+2. Setup your Iron.io credentials: http://dev.iron.io/articles/configuration/
 
-    @iron_cache = IronCache::Client.new(:token=>'MYTOKEN', :project_id=>'MYPROJECTID')
-
-You can get your `token` and `project_id` at http://www.iron.io .
+3. Create an IronCache client object:
 
+    @client = IronCache::Client.new
 
 The Basics
 =========
 
+**Get a cache object**
+
+You can have as many caches as you want, each with their own unique set of items.
+
+    @cache = @client.cache("my_cache")
+
+Now you can use it:
+
 **Put** an item in the cache:
 
-    msg = @iron_cache.items.put("mykey", "hello world!")
+    msg = @cache.put("mykey", "hello world!")
     p msg
 
 **Get** an item from the cache:
 
-    msg = @iron_cache.items.get("mykey")
+    msg = @cache.get("mykey")
     p msg
 
 **Delete** an item from the cache:
 
-    res = msg.delete # or @iron_cache.items.delete("mykey")
+    res = msg.delete # or @cache.delete("mykey")
     p res
 
+**Increment** an item in the cache:
 
-Cache 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()
+    msg = @cache.increment("mycounter", 1)
+    p res
 
 Cache Information
 =================
 
-    cache = @iron_cache.queues.get(:name=>"my_cache")
-    puts "size: #{cache.size}"
+    cache = @iron_cache.cache("my_cache")
+    puts "name: #{cache.name}"
 
- 

data/Rakefile

@@ -1,26 +1,6 @@
 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 'iron_core'
-    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'

data/iron_cache.gemspec

@@ -16,12 +16,13 @@ Gem::Specification.new do |gem|
 
   gem.required_rubygems_version = ">= 1.3.6"
   gem.required_ruby_version = Gem::Requirement.new(">= 1.9")
-  gem.add_runtime_dependency "iron_core"
+  gem.add_runtime_dependency "iron_core", ">= 0.1.4"
 
   gem.add_development_dependency "test-unit"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "memcache-client"
   gem.add_development_dependency "uber_config"
+  gem.add_development_dependency "typhoeus"
 
 
 end

data/lib/iron_cache/caches.rb

@@ -11,17 +11,21 @@ module IronCache
 
     def path(options={})
       path = "projects/#{@client.project_id}/caches"
+      if options[:name]
+        path << "/#{URI.escape(options[:name])}"
+      end
+      path
     end
 
     def list(options={})
       ret = []
       res = @client.get("#{path(options)}", options)
-      p res
+      @client.logger.debug res.inspect
       parsed = @client.parse_response(res, true)
-      p parsed
+      @client.logger.debug parsed.inspect
       parsed.each do |q|
-        #p q
-        q = Cache.new(self, q)
+        @client.logger.debug "cache: " + q.inspect
+        q = Cache.new(@client, q)
         ret << q
       end
       ret
@@ -30,8 +34,12 @@ module IronCache
     # options:
     #  :name => can specify an alternative queue name
     def get(options={})
-      res, status = @client.get("#{path(options)}/#{URI.escape options[:name]}")
-      return Cache.new(self, res)
+      if options.is_a?(String)
+        options = {:name=>options}
+      end
+      options[:name] ||= @client.cache_name
+      res = @client.parse_response(@client.get("#{path(options)}"))
+      Cache.new(@client, res)
     end
 
 
@@ -39,8 +47,8 @@ module IronCache
 
   class Cache
 
-    def initialize(queues, res)
-      @queues = queues
+    def initialize(client, res)
+      @client = client
       @data = res
     end
 
@@ -60,25 +68,39 @@ module IronCache
       raw["name"]
     end
 
-    def size
-      return raw["size"] if raw["size"]
-      return @size if @size
-      q = @queues.get(:name=>name)
-      @size = q.size
-      @size
+    # Used if lazy loading
+    def load_cache
+      q = @client.caches.get(:name=>name)
+      @client.logger.debug "GOT Q: " + q.inspect
+      @data = q.raw
+      q
+    end
+
+    # not supported in API yet
+    #def size
+    #  return raw["size"] if raw["size"]
+    #  return @size if @size
+    #  q = load_cache()
+    #  @size = q.size
+    #  @size
+    #end
+
+    def put(k, v, options={})
+      @client.items.put(k, v, options.merge(:cache_name=>name))
+    end
+
+    def get(k, options={})
+      @client.items.get(k, options.merge(:cache_name=>name))
+    end
+
+    def delete(k, options={})
+      @client.items.delete(k, options.merge(:cache_name=>name))
     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
+    def increment(k, amount=1, options={})
+      @client.items.increment(k, amount, options.merge(:cache_name=>name))
     end
 
-    # def delete
-    # @messages.delete(self.id)
-    # end
   end
 
 end

data/lib/iron_cache/client.rb

@@ -9,27 +9,25 @@ module IronCache
 
     AWS_US_EAST_HOST = "cache-aws-us-east-1.iron.io"
 
-    def self.version
-
-    end
-
     attr_accessor :cache_name, :logger
 
     def initialize(options={})
       super("cache", options)
 
       @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
 
       @cache_name = options[:cache_name] || options['cache_name'] || "default"
 
-      load_from_hash(:scheme => 'https',
+      load_from_hash('defaults', {
+                     :scheme => 'https',
                      :host => AWS_US_EAST_HOST,
                      :port => 443,
                      :api_version => 1,
-                     :user_agent => 'iron_cache_ruby-' + IronCache::VERSION + ' (iron_core_ruby-' + IronCore.version + ')')
+                     :user_agent => 'iron_cache_ruby-' + IronCache::VERSION + ' (iron_core_ruby-' + IronCore.version + ')'})
 
       if (not @token) || (not @project_id)
-        IronCore::Logger.error 'IronWorkerNG', 'Both token and project_id must be specified'
+        IronCore::Logger.error 'IronCache', 'Both token and project_id must be specified'
         raise IronCore::IronError.new('Both token and project_id must be specified')
       end
 
@@ -40,8 +38,8 @@ module IronCache
       return Items.new(self)
     end
 
-    def cache
-
+    def cache(name)
+      return Cache.new(self, {"name"=>name})
     end
 
     def caches

data/lib/iron_cache/items.rb

@@ -10,7 +10,7 @@ module IronCache
     end
 
     def path(key, options={})
-      path = "projects/#{@client.project_id}/caches/#{URI.escape(options[:cache_name] || @client.cache_name)}/items/#{URI.escape key}"
+      path = "projects/#{@client.project_id}/caches/#{URI.escape(options[:cache_name] || @client.cache_name)}/items/#{URI.escape key}#{'/increment' if options[:increment] == true}"
     end
 
     # options:
@@ -23,7 +23,7 @@ module IronCache
         json = @client.parse_response(res, true)
         return Item.new(self, json)
       rescue IronCore::IronResponseError => ex
-        p ex
+        @client.logger.debug ex.inspect
         if ex.code == 404
           return nil
         end
@@ -43,6 +43,17 @@ module IronCache
       #return Message.new(self, res)
       return ResponseBase.new(json)
     end
+    
+    # options:
+    #  :cache_name => can specify an alternative queue name    
+    def increment(key, amount=1, options={})
+      options = options.merge(:increment => true)
+      res = @client.post(path(key, options), {:amount => amount})
+      hash = @client.parse_response(res, true)
+      @client.logger.debug "increment response: " + hash.inspect
+      hash["key"] ||= key
+      return Item.new(self, hash)
+    end
 
     def delete(key, options={})
       path2 = "#{self.path(key, options)}"
@@ -67,9 +78,9 @@ module IronCache
       raw[key]
     end
 
-    def id
-      raw["id"]
-    end
+    #def id
+    #  raw["id"]
+    #end
 
     def msg
       raw["msg"]
@@ -93,7 +104,7 @@ module IronCache
     end
 
     def delete
-      @messages.delete(self.id)
+      @messages.delete(self.key)
     end
   end
 

data/lib/iron_cache/version.rb

@@ -1,3 +1,3 @@
 module IronCache
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

data/test/quick_run.rb

@@ -1,4 +1,3 @@
-# Put config.yml file in ~/Dropbox/configs/ironmq_gem/test/config.yml
 require_relative 'test_base'
 
 class QuickRun < TestBase

data/test/test_base.rb

@@ -33,5 +33,4 @@ class TestBase < Test::Unit::TestCase
     #puts 'cleared.'
   end
 
-
 end

data/test/test_iron_cache.rb

@@ -8,6 +8,17 @@ class IronCacheTests < TestBase
     super
 
   end
+  def test_performance_put_message
+    @client.cache_name = 'test_basics'
+    res = @client.items.put("key", "value")
+  end
+  
+  def test_performance_put_100_messages
+    @client.cache_name = 'test_basics'
+    100.times do 
+      res = @client.items.put("key", "value")
+    end
+  end
 
   def test_basics
     @client.cache_name = 'test_basics'
@@ -35,6 +46,43 @@ class IronCacheTests < TestBase
     p res
     assert res.nil?
 
+    # new style of referencing cache
+    cache = @client.cache("test_basics")
+    res = cache.put(k,v)
+    p res
+    assert res.msg
+
+    res = cache.get(k)
+    p res
+    assert res["key"]
+    assert res.key
+    assert res.key == k
+    assert res.value == v
+
+    res = cache.delete(k)
+    p res
+    puts "shouldn't be any more"
+    res = cache.get(k)
+    p res
+    assert res.nil?
+
+    # test delete by item
+    res = cache.put(k,v)
+    p res
+    assert res.msg
+
+    res = cache.get(k)
+    p res
+    assert res.value
+    res = res.delete
+    p res
+    puts "shouldn't be any more"
+    res = cache.get(k)
+    p res
+    assert res.nil?
+
+
+
   end
 
   def test_caches
@@ -44,6 +92,17 @@ class IronCacheTests < TestBase
     assert caches.is_a?(Array)
     assert caches.size > 0
     assert caches[0].name
+    #assert caches[0].size
+
+    cache = @client.caches.get(caches[0].name)
+    p cache
+    assert cache.name
+    #assert cache.size
+
+    cache = @client.cache(caches[0])
+    p cache
+    assert cache.name
+    #assert cache.size
 
   end
 
@@ -64,5 +123,51 @@ class IronCacheTests < TestBase
 
   end
 
+  def test_incrementors
+    @client.cache_name = 'test_incrementors'
+    clear_queue
+    k = "incr1"
+    v = 1
+    res = @client.items.put(k, v)
+    p res
+
+    res = @client.items.get(k)
+    p res
+    assert res.key == k
+    assert res.value == v, "value #{res.value.inspect} does not equal v: #{v.inspect}"
+
+    incr_by = 10
+    res = @client.items.increment(k, incr_by)
+    res = @client.items.get(k)
+    assert res.value == (v + incr_by)
+
+    res = @client.items.increment(k, -6)
+    assert res.value == 5
+
+    res.delete
+
+    # new style
+    cache = @client.cache("test_incrementors")
+    res = cache.put(k, v)
+    p res
+
+    res = cache.get(k)
+    p res
+    assert res.key == k
+    assert res.value == v, "value #{res.value.inspect} does not equal v: #{v.inspect}"
+
+    incr_by = 10
+    res = cache.increment(k, incr_by)
+    res = cache.get(k)
+    assert res.value == (v + incr_by)
+
+    res = cache.increment(k, -6)
+    assert res.value == 5
+
+    res.delete
+
+
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-15 00:00:00.000000000 Z
+date: 2012-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iron_core
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  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: Ruby client for IronCache by www.iron.io
 email:
 - treeder@gmail.com