neo-tmdb 0.2.0 → 0.3.0

data/Changelog.markdown

@@ -4,6 +4,12 @@
 
 Nothing yet.
 
+## 0.3.0 (2012-06-25)
+
+New features:
+
+* Caching support through `Configuration#cache`.
+
 ## 0.2.0 (2012-06-15)
 
 New features:

data/README.markdown

@@ -1,6 +1,7 @@
 # Neo TMDb
 
 Neo TMDb is a Ruby wrapper for the v3 [TMDb API][api] from www.themoviedb.org.
+It provides read-only access with caching.
 
 [api]: http://help.themoviedb.org/kb/api/about-3
 
@@ -32,6 +33,44 @@ people.each do |person|
 end
 ```
 
+### Configure caching
+
+You can configure caching so that duplicate requests for the same person are
+read from the cache rather than directly from the TMDb servers. This helps
+improve the performance of you application but also prevents it from exceeding
+the [API request limits][limits] on the TMDb servers.
+
+[limits]: http://help.themoviedb.org/kb/general/api-request-limits
+
+```ruby
+require 'active_support'
+require 'benchmark'
+require 'neo-tmdb'
+
+TMDb.configure do |config|
+  config.api_key = 'my-tmdb-api-key-here'
+  # You should configure your cache to expire entries after an appropriate
+  # period. Note that MemoryStore may not be the best choice for your
+  # application.
+  config.cache = ActiveSupport::Cache::MemoryStore.new
+end
+
+# Note in the following how the first request takes considerable longer than
+# the subsequent cached requests.
+100.times do |n|
+  Benchmark.benchmark('find ') do |b|
+    b.report(n.to_s) do
+      person = TMDb::Person.find(6384)
+      puts "  #{person.name} load #{n}"
+    end
+  end
+end
+```
+
+You can use any cache that implements ActiveSupport's `Cache` interface.
+
+### Documentation
+
 Further [documentation can be found on rdoc.info][docs].
 
 [docs]: http://rdoc.info/github/andrewdsmith/neo-tmdb/master/frames

data/lib/neo-tmdb.rb

@@ -3,4 +3,5 @@ require 'faraday'
 
 require 'tmdb'
 require 'tmdb/configuration'
+require 'tmdb/null_cache'
 require 'tmdb/person'

data/lib/tmdb.rb

@@ -17,14 +17,16 @@ module TMDb
   # called directly by client code, instead you should call methods such as
   # +Person.find+ that return TMDb wrapper objects.
   def get_api_response(path, params = {})
-    connection = Faraday.new(:url => 'http://api.themoviedb.org/3/') do |builder|
-      builder.request :url_encoded
-      builder.adapter :net_http
+    configuration.cache.fetch([path, params]) do
+      connection = Faraday.new(:url => 'http://api.themoviedb.org/3/') do |builder|
+        builder.request :url_encoded
+        builder.adapter :net_http
+      end
+      response = connection.get(
+        path,
+        params.merge({ :api_key => TMDb.configuration.api_key })
+      )
+      JSON.parse(response.body)
     end
-    response = connection.get(
-      path,
-      params.merge({ :api_key => TMDb.configuration.api_key })
-    )
-    JSON.parse(response.body)
   end
 end

data/lib/tmdb/configuration.rb

@@ -1,6 +1,10 @@
 module TMDb
   class Configuration
-    attr_accessor :api_key
+    attr_accessor :api_key, :cache
+
+    def initialize
+      @cache = NullCache.new
+    end
 
     # Returns the base URL for use in constructing image URLs.
     def image_base_url

data/lib/tmdb/null_cache.rb

@@ -0,0 +1,17 @@
+module TMDb
+
+  # Looks like a cache but doesn't perform any caching. This helps us avoid
+  # checking for whether a cache is configured or not, as per the Null Object
+  # pattern: http://en.wikipedia.org/wiki/Null_Object_pattern.
+  #
+  class NullCache
+
+    # Returns the value of the yielded block. Assumes that a block is passed;
+    # ActiveSupport::Cache::Store#fetch allows for no block but we don't use
+    # this internally. Ignores +cache_key+ because no caching is performed.
+    #
+    def fetch(cache_key)
+      yield
+    end
+  end
+end

data/lib/tmdb/version.rb

@@ -1,3 +1,3 @@
 module TMDb
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neo-tmdb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.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: faraday
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +99,7 @@ extra_rdoc_files: []
 files:
 - lib/tmdb.rb
 - lib/tmdb/configuration.rb
+- lib/tmdb/null_cache.rb
 - lib/tmdb/person.rb
 - lib/tmdb/attributes.rb
 - lib/tmdb/version.rb