neo-tmdb 0.1.0 → 0.2.0

data/Changelog.markdown

@@ -0,0 +1,27 @@
+# Changelog
+
+## In git master branch
+
+Nothing yet.
+
+## 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

@@ -6,23 +6,36 @@ Neo TMDb is a Ruby wrapper for the v3 [TMDb API][api] from www.themoviedb.org.
 
 ## Use
 
-Currently you can only search for people by name and discover their id. Only
-the first 20 results for searches are returned.
+Currently you can find people by their TMDb id or search for people.
 
+```ruby
 require 'neo-tmdb'
 
-```ruby
 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
 ```
 
+Further [documentation can be found on rdoc.info][docs].
+
+[docs]: http://rdoc.info/github/andrewdsmith/neo-tmdb/master/frames
+
 ## Contribute
 
 * Source hosted on [GitHub][].

data/lib/tmdb/attributes.rb

@@ -0,0 +1,10 @@
+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
+  end
+end

data/lib/tmdb/configuration.rb

@@ -1,5 +1,35 @@
 module TMDb
   class Configuration
     attr_accessor :api_key
+
+    # 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
+
+    protected
+
+    def tmdb_config_images
+      @tmdb_config ||= TMDb.get_api_response('configuration')
+      @tmdb_config['images']
+    end
   end
 end

data/lib/tmdb/person.rb

@@ -1,10 +1,29 @@
+require 'tmdb/attributes'
+
 module TMDb
   class Person
-    attr_reader :id, :name
+    extend Attributes
+
+    tmdb_attr :adult
+    tmdb_attr :also_known_as
+    tmdb_attr :biography
+    tmdb_attr :birthday
+    tmdb_attr :deathday
+    tmdb_attr :homepage
+    tmdb_attr :id
+    tmdb_attr :name
+    tmdb_attr :place_of_birth
+    tmdb_attr :profile_path
 
     def initialize(args)
-      @id = args["id"]
-      @name = args["name"]
+      @tmdb_attrs = args
+    end
+
+    # Returns the person with TMDb id of +id+.
+    #
+    def self.find(id)
+      response = TMDb.get_api_response("person/#{id}")
+      new(response)
     end
 
     # Returns an enumerable containing all the people matching the
@@ -16,17 +35,16 @@ module TMDb
     # Only the first page of results (20 people) are returned.
     #
     def self.where(args)
-      connection = Faraday.new(:url => 'http://api.themoviedb.org/3/') do |builder|
-        builder.request :url_encoded
-        builder.adapter :net_http
-      end
-      response = connection.get(
-        "search/person",
-        :query => args[:name],
-        :api_key => TMDb.configuration.api_key
-      )
-      body = JSON.parse(response.body)
-      body["results"].map {|attrs| new(attrs) }
+      response = TMDb.get_api_response('search/person', :query => args[:name])
+      response["results"].map {|attrs| new(attrs) }
+    end
+
+    # Returns a URL for the person's profile image at the given +size+. Valid
+    # sizes should be discovered via the +Configuration.image_profile_sizes+
+    # method.
+    #
+    def profile_image_url(size)
+      [TMDb.configuration.image_base_url, size, profile_path].join
     end
   end
 end

data/lib/tmdb/version.rb

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

data/lib/tmdb.rb

@@ -10,4 +10,21 @@ module TMDb
   def configure
     yield configuration
   end
+
+  # Makes a TMDb API request given to the (relative) +path+ with the given
+  # query +params+ and using the configured API key. Returns the response as a
+  # 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.
+  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
+    end
+    response = connection.get(
+      path,
+      params.merge({ :api_key => TMDb.configuration.api_key })
+    )
+    JSON.parse(response.body)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neo-tmdb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -68,9 +84,11 @@ files:
 - lib/tmdb.rb
 - lib/tmdb/configuration.rb
 - lib/tmdb/person.rb
+- lib/tmdb/attributes.rb
 - lib/tmdb/version.rb
 - lib/neo-tmdb.rb
 - LICENSE
+- Changelog.markdown
 - README.markdown
 homepage: https://github.com/andrewdsmith/neo-tmdb
 licenses: