neo-tmdb 0.3.1 → 0.4.0

data/lib/neo-tmdb.rb

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

data/lib/tmdb.rb

@@ -1,12 +1,16 @@
 module TMDb
   extend self
 
+  class ServiceUnavailable < StandardError; end
+
   # Returns the global TMDb configuration.
+  #
   def configuration
     @configuration ||= Configuration.new
   end
 
   # Configure TMDb by calling this method.
+  #
   def configure
     yield configuration
   end
@@ -16,6 +20,10 @@ module TMDb
   # hash (parsed from the original JSON). This method is not intended to be
   # called directly by client code, instead you should call methods such as
   # +Person.find+ that return TMDb wrapper objects.
+  #
+  # Raises a +TMDb::ServiceUnavailable+ error if the service is unavailable or
+  # the API request limits have been exceeded.
+  #
   def get_api_response(path, params = {})
     configuration.cache.fetch([path, params]) do
       connection = Faraday.new(:url => 'http://api.themoviedb.org/3/') do |builder|
@@ -26,7 +34,11 @@ module TMDb
         path,
         params.merge({ :api_key => TMDb.configuration.api_key })
       )
-      JSON.parse(response.body)
+      if response.status == 503
+        raise ServiceUnavailable
+      else
+        JSON.parse(response.body)
+      end
     end
   end
 end

data/lib/tmdb/attributes.rb

@@ -1,8 +1,12 @@
 module TMDb
+
   # A module for managing TMDb-derived attributes of a class.
+  #
   module Attributes
+
     # Adds an attribute reader with the given +name+ (symbol) that delegates to
     # the instance's +@tmdb_attrs+ hash entry of the same name.
+    #
     def tmdb_attr(name)
       define_method(name) { @tmdb_attrs[name.to_s] }
     end

data/lib/tmdb/configuration.rb

@@ -1,30 +1,35 @@
 module TMDb
   class Configuration
-    attr_accessor :api_key, :cache
+    attr_accessor :api_key, :cache, :null_person
 
     def initialize
       @cache = NullCache.new
+      @null_person = NullPerson.new
     end
 
     # Returns the base URL for use in constructing image URLs.
+    #
     def image_base_url
       tmdb_config_images['base_url']
     end
 
     # Returns the list of film backdrop image sizes for use in constructing
     # image URLs.
+    #
     def image_backdrop_sizes
       tmdb_config_images['backdrop_sizes']
     end
 
     # Returns the list of film poster image sizes for use in constructing image
     # URLs.
+    #
     def image_poster_sizes
       tmdb_config_images['poster_sizes']
     end
 
     # Returns the list of person profile image sizes for use in constructing
     # image URLs.
+    #
     def image_profile_sizes
       tmdb_config_images['profile_sizes']
     end

data/lib/tmdb/null_person.rb

@@ -0,0 +1,15 @@
+module TMDb
+
+  # This class is a Null Object version of the +Person+ class.
+  #
+  class NullPerson
+    attr_accessor :adult, :also_known_as, :biography, :birthday,
+      :deathday, :homepage, :id, :name, :place_of_birth, :profile_path
+
+    attr_writer :profile_image_url
+
+    def profile_image_url(size)
+      @profile_image_url
+    end
+  end
+end

data/lib/tmdb/person.rb

@@ -1,4 +1,5 @@
 require 'tmdb/attributes'
+require 'tmdb/null_person'
 
 module TMDb
   class Person
@@ -22,21 +23,25 @@ module TMDb
     # Returns the person with TMDb id of +id+.
     #
     def self.find(id)
-      response = TMDb.get_api_response("person/#{id}")
-      new(response)
+      begin
+        response = TMDb.get_api_response("person/#{id}")
+        new(response)
+      rescue ServiceUnavailable
+        TMDb.configuration.null_person || raise
+      end
     end
 
     # Returns an enumerable containing all the people matching the
     # condition hash. Currently the only condition that can be specified
     # is name, e.g.
     #
-    #   people = Person.where(:name => "Reeves")
+    #   people = Person.where(:name => 'Reeves')
     #
     # Only the first page of results (20 people) are returned.
     #
     def self.where(args)
       response = TMDb.get_api_response('search/person', :query => args[:name])
-      response["results"].map {|attrs| new(attrs) }
+      response['results'].map {|attrs| new(attrs) }
     end
 
     # Returns a URL for the person's profile image at the given +size+. Valid

data/lib/tmdb/version.rb

@@ -1,3 +1,3 @@
 module TMDb
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neo-tmdb
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-27 00:00:00.000000000 Z
+date: 2012-07-15 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: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -103,10 +135,9 @@ files:
 - lib/tmdb/person.rb
 - lib/tmdb/attributes.rb
 - lib/tmdb/version.rb
+- lib/tmdb/null_person.rb
 - lib/neo-tmdb.rb
 - LICENSE
-- Changelog.markdown
-- README.markdown
 homepage: https://github.com/andrewdsmith/neo-tmdb
 licenses:
 - MIT

data/Changelog.markdown

@@ -1,39 +0,0 @@
-# Changelog
-
-## In git master branch
-
-Nothing yet.
-
-## 0.3.1 (2012-06-27)
-
-Fixes:
-
-* Return nil from `Person#profile_image_url` when `Person#profile_path` is nil.
-
-## 0.3.0 (2012-06-25)
-
-New features:
-
-* Caching support through `Configuration#cache`.
-
-## 0.2.0 (2012-06-15)
-
-New features:
-
-* The `Person#profile_image_url` method, which uses the base image URL fetched
-  from the TMDb configuration.
-* Methods on `Configuration` for fetching and caching the [TMDb
-  configuration][], which can be used to build image URLs from a
-  `Person#profile_path`.
-* An initial implementation of the `Person.find` method for getting a person by
-  their TMDb id.
-
-[TMDb configuration]: http://help.themoviedb.org/kb/api/configuration
-
-## 0.1.0 (2012-06-05)
-
-New features:
-
-* An initial implementation of the `Person.where` method that searches for
-  people on TMDb by name.
-

data/README.markdown

@@ -1,91 +0,0 @@
-# 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
-
-## Use
-
-Currently you can find people by their TMDb id or search for people.
-
-```ruby
-require 'neo-tmdb'
-
-TMDb.configure do |config|
-  # You must configure this library with a TMDb API key before you can use it.
-  config.api_key = 'my-tmdb-api-key-here'
-end
-
-person = TMDb::Person.find(6384)
-puts "#{person.name}, born #{person.birthday} in #{person.place_of_birth}"
-# => Keanu Reeves, born 1964-09-02 in Beirut, Lebanon
-
-smallest = TMDb.configuration.image_profile_sizes.first
-puts person.profile_image_url(smallest)
-# => http://cf2.imgobject.com/t/p/w45/jmjeALlAVaPB8SonLR3qBN5myjc.jpg
-
-# Note: Only the first 20 results are returned.
-people = TMDb::Person.where(:name => "Reeves")
-people.each do |person|
-  # Note: Only attributes available in the search API will be populated here.
-  puts "#{person.name} has TMDb id #{person.id}"
-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
-
-## Contribute
-
-* Source hosted on [GitHub][].
-* Report issues on [GitHub Issues][].
-* Pull requests are very welcome! Please include spec coverage for every patch
-  and create a topic branch for every separate change you make.
-
-[GitHub]: https://github.com/andrewdsmith/neo-tmdb
-[GitHub Issues]: https://github.com/andrewdsmith/neo-tmdb/issues
-
-## Copyright
-
-See LICENSE for details.
-