myflickr 0.0.6 → 0.1.0

data/History.txt

@@ -1,3 +1,7 @@
+== 0.1.0 2008-01-06
+
+* Added support for memcached so as to reduce the amount of queries actually sent to flickr
+
 == 0.0.6 2007-12-31
 
 * Updated gem specs for better understanding of what the gem does

data/lib/myflickr.rb

@@ -8,6 +8,6 @@ module Myflickr
   MAX_THREADS = 100
 end
 
-%w(query photo tag size set machine_tag version).each do |r|
+%w(query photo tag size set machine_tag cache version).each do |r|
   require File.join(File.dirname(__FILE__), './myflickr/' + r)
 end

data/lib/myflickr/query.rb

@@ -1,10 +1,54 @@
+# All memcached references have been stolen straight
+# from the implementation in the `rubyweather` gem.
+# It just seemed too simple to roll in.
+
 module Myflickr
   class Query #:nodoc:
     def self.api_call(method, resource_uri='') #:nodoc:
       resource = "#{API_BASE}/?method=#{method}&api_key=#{API_KEY}&user_id=#{USER_ID}"
       resource += "&#{resource_uri}" unless resource_uri.empty?
-      puts "Querying: #{resource}"
-      Hpricot.XML(open(resource))
+      
+      if cache?
+        begin
+          document = cache.get "#{USER_ID}:#{method}:#{resource_uri}"
+        rescue
+          puts "Querying: #{resource} [CACHE MISS]"
+          document = false
+        end
+      end
+      
+      # No cached version exists
+      unless document
+        puts "Querying: #{resource}"
+        
+        # Query the resource
+        document = open(resource).read
+        
+        # Write a new cache if available
+        cache.set("#{USER_ID}:#{method}:#{resource_uri}", document, cache_validity) if cache?
+        puts "[CACHING...]" if cache?
+      end
+      
+      # Create a Hpricot object
+      Hpricot.XML(document)
+    end
+    
+    @cache = false
+    
+    # Turns on query caching.
+    # See Myflickr::Query::Cache
+    def self.enable_cache(enable = true)
+      if enable
+        extend Cache
+        @cache = true
+      else
+        @cache = false
+      end
+    end
+    
+    # True if caching is enabled and at least one memcached server is alive, false otherwise.
+    def self.cache?
+      @cache and cache.active? and servers = cache.instance_variable_get(:@servers) and servers.collect{|s| s.alive?}.include?(true)
     end
   end
 end

data/lib/myflickr/version.rb

@@ -1,8 +1,8 @@
 module Myflickr
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 6
+    MINOR = 1
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/query_spec.rb

@@ -4,4 +4,13 @@ describe Query, "class" do
   it "should return a Hpricot Document object response" do
     Query.api_call('flickr.test.echo').should be_an_instance_of Hpricot::Doc
   end
+end
+
+describe Query, "with memcached caching for queries" do
+  it "should return a Hpricot Document object response" do
+    Query.enable_cache true
+    Query.cache.servers = ["127.0.0.1:11211"]
+    Query.api_call('flickr.test.echo').should be_an_instance_of Hpricot::Doc
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: myflickr
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2007-12-31 00:00:00 +11:00
+date: 2008-01-06 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency