tmdb 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 678de152342dbba606943c4f53472b9ec6c8d2dc
-  data.tar.gz: 7edf17f383e4107622148fa4afaab0c55082b834
+  metadata.gz: c4fe9618ff4b7152cac2978ed46e57e79c861bdc
+  data.tar.gz: 00d95a2699ad05c7a4e143d81a0ae765c2b45898
 SHA512:
-  metadata.gz: 3262141e5f7a197a3e1ca46873a3f2fdad3cf3434e27896339cb35699fbfe1f2882e3eb4f83f81d722330cddf1f6f2a3e4238720cb22104b0706a4b7d7a0e1f7
-  data.tar.gz: fd3ecc4b4d828294af8887b8b53f941b31a08d02debc64b330ee4de35967b016022ce672c18f01c922a9b9478adfa3cff50d15bf8bafbcdc599cf94806ef1c7e
+  metadata.gz: 172caf23043eeee0a89f45700f9f0b4e4b0347ca0fc1e4b50080b082b770c7c576add80d595d18f30de48adf6b065a586a0d55e6272b0bde6df928aac6307f17
+  data.tar.gz: be36f75874a01e9134b336b693909947a32c34b82cf9225312c5eebe497cc4b291686967f3c56a92ad81754a0ead3c0468455e0ad1bd124e6d70657384cdf11b

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/tmdb.svg)](http://badge.fury.io/rb/tmdb)
 
-Simple ruby wrapper for _The MovieDB_ based on HTTParty
+Simple ruby wrapper for _The MovieDB_ based on HTTParty (starting to transform into more of an abstraction than a wrapper: http://wynnnetherland.com/journal/what-makes-a-good-api-wrapper)
 
 ## Installation
 
@@ -22,10 +22,12 @@ Current available:
     * ::config
     * ::genres(source)
 * [Movie](#movies)
-    * ::title_search
     * ::search
+    * ::advanced_search
     * ::id
     * ::popular
+    * #poster(size)
+    * #backdrop(size)
 * [TV](#tv)
     * ::search
     * ::id
@@ -64,10 +66,14 @@ TMDB::API.genres("tv")
 
 ### Movies
 
+#### Class Methods
+
+##### ::search
+
 ```ruby
-# To search for movies by title (returns an array of Hashie::Mash objects)
-movies = TMDB::Movie.title_search(query: 'the matrix')
-# => <Hashie::Mash "adult"=>false,
+# To search for movies by title (returns an array of TMDB:Movie objects)
+movies = TMDB::Movie.search('the matrix')
+# => <TMDB::Movie "adult"=>false,
   "backdrop_path"=>"/7u3pxc0K1wx32IleAkLv78MKgrw.jpg",
   "id"=>603,
   "original_title"=>"The Matrix",
@@ -81,14 +87,21 @@ movies = TMDB::Movie.title_search(query: 'the matrix')
 # Then you can pull the data from the results, ie.
 movies.first.title
 # => "The Matrix"
+```
+
+##### ::advanced_search
 
-# Use .search to find by various parameters (ie. release date)
-movies = TMDB::Movie.search('release_date.gte' => '2014-01-01',
+```ruby
+# Use .advanced_search to find by various parameters (ie. release date)
+movies = TMDB::Movie.advanced_search('release_date.gte' => '2014-01-01',
                             'release_date.lte' => (Time.now.strftime("%Y-%m-%d")),
                             primary_release_year: 2014)
-# => Array of <Hashie::Mash> movies
+# => Array of <TMDB::Movie>s
+```
 
+##### ::id
 
+```ruby
 # To pull all the information for a particular movie, run an id search:
 movie = TMDB::Movie.id(550)
 # => <Hashie::Mash "adult"=>false,
@@ -105,14 +118,42 @@ movie = TMDB::Movie.id(550)
 "original_title"=>"Fight Club",
 "overview"=>
  "A ticking-time-bomb insomniac and a slippery soap salesman channel primal male aggression into a shocking new form of therapy. Their concept catches on, with underground \"fight clubs\" forming in every town, until an eccentric gets in the way and ignites an out-of-control spiral toward oblivion."...>
+ ```
 
+##### ::popular
+
+```ruby
 # Use .popular to final recent popular movies (according to The Movie Database)
 movies = TMDB::Movie.popular
 # => Array of <Hashie::Mash> movies
 ```
 
+#### Instance Methods
+
+##### #poster
+
+```ruby
+# Use .poster to return a particular TMDB::Movie's poster path, default is 'original'
+# Poster Sizes: ["w92", "w154", "w185", "w342", "w500", "w780", "original"]
+TMDB::Movie.id(550).poster
+# => http://image.tmdb.org/t/p/original/2lECpi35Hnbpa4y46JX0aY3AWTy.jpg
+```
+
+##### #backdrop
+
+```ruby
+# Same as #poster but for backdrops
+# Backdrop Sizes: ["w300", "w780", "w1280", "original"]
+TMDB::Movie.id(550).backdrop('w300')
+# => http://image.tmdb.org/t/p/w300/hNFMawyNDWZKKHU4GYCBz1krsRM.jpg
+```
+
 ### TV
 
+#### Class Methods
+
+##### ::search
+
 ```ruby
 # Similar to Movies
 TMDB::TV.search(query: 'walking dead')
@@ -135,7 +176,7 @@ TMDB::TV.search(query: 'walking dead')
  "name"=>"The Walking Dead" ...>
 ```
 
-### More Examples
+## More Examples
 
 You can look through the tests for more examples
 

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.6.0

data/lib/tmdb/movie.rb

@@ -2,22 +2,38 @@
 # TODO: Review http://ruby.learncodethehardway.org/book/ex44.html first, figure out if we ant to use inheritance or composition
 
 module TMDB
-  class Movie
-    def self.title_search(options = {})
+  class Movie < Hashie::Mash
+
+    def poster(size='original')
+      # Poster Sizes: ["w92", "w154", "w185", "w342", "w500", "w780", "original"]
+      # Find latest list at TMDB::API.config.poster_sizes
+      config = TMDB::API.config
+      config.images.base_url + size + self.poster_path
+    end
+
+    def backdrop(size='original')
+      # Backdrop Sizes: ["w300", "w780", "w1280", "original"]
+      # Find latest list at TMDB::API.config.backdrop_sizes
+      config = TMDB::API.config
+      config.images.base_url + size + self.backdrop_path
+    end
+
+    def self.search(title, options = {})
       # Accepted parameters:
       # :page, :include_adult (true / false), :year
-      options.merge!(api_key: TMDB::API.api_key)
+      options.merge!(api_key: TMDB::API.api_key, 
+                     query: title)
       results = TMDB::API.get("/3/search/movie", query: options)['results']
       movies = []
       results.each do |result|
-        movies.push(Hashie::Mash.new(result))
+        movies.push(TMDB::Movie.new(result))
       end
       return movies
     end
 
     # language (ISO_639_1: 'en')
     # country (ISO_3166_1: 'US')
-    def self.search(options = {})
+    def self.advanced_search(options = {})
       # US-snobbish
       options.merge!(api_key: TMDB::API.api_key,
                      language: 'en',
@@ -32,7 +48,7 @@ module TMDB
 
     def self.id(movie_id)
       options = { api_key: TMDB::API.api_key }
-      Hashie::Mash.new(TMDB::API.get("/3/movie/#{movie_id}", query: options))
+      TMDB::Movie.new(TMDB::API.get("/3/movie/#{movie_id}", query: options))
       # movie.title = "Fight Club"
     end
 
@@ -41,7 +57,7 @@ module TMDB
       results = TMDB::API.get("/3/movie/popular", query: options)['results']
       movies = []
       results.each do |result|
-        movies.push(Hashie::Mash.new(result))
+        movies.push(TMDB::Movie.new(result))
       end     
       return movies
     end

data/test/tmdb/test_movie.rb

@@ -8,19 +8,19 @@ describe TMDB::Movie do
   TMDB::API.api_key = API_KEY
 
   # TMDB::Movie::title_search(query, page, etc.)
-  describe ".title_search" do
+  describe "::search" do
     it "should return correct results" do
-      movies = TMDB::Movie.title_search(query: 'the matrix')
+      movies = TMDB::Movie.search('the matrix')
 
       movies.first.title.must_equal "The Matrix"
     end
   end
 
   # TMDB::Movie::search(release_date.gte, page, etc.)
-  describe ".search('...')" do
+  describe "::advanced_search('...')" do
     
     it "should return recent results" do
-      movies = TMDB::Movie.search('release_date.gte' => '2014-01-01',
+      movies = TMDB::Movie.advanced_search('release_date.gte' => '2014-01-01',
                                   'release_date.lte' => (Time.now.strftime("%Y-%m-%d")),
                                   primary_release_year: 2014)
 
@@ -33,7 +33,7 @@ describe TMDB::Movie do
   end
 
   # TMDB::Movie::id(movie_id)
-  describe ".id" do
+  describe "::id" do
 
     let (:movie) { TMDB::Movie.id(550) }
 
@@ -49,11 +49,29 @@ describe TMDB::Movie do
   end
 
   # TMDB::Movie::popular
-  describe ".popular" do
+  describe "::popular" do
     it "should return a list of popular results" do
       movies = TMDB::Movie.popular
       movies.must_be_instance_of Array
     end
   end
 
+  # TMDB::Movie#poster
+  describe "#poster" do 
+    let (:movie) { TMDB::Movie.id(550) }
+
+    it "should return the poster URL" do
+      movie.poster.wont_be_nil
+    end
+  end
+
+    # TMDB::Movie#backdrop
+  describe "#backdrop" do 
+    let (:movie) { TMDB::Movie.id(550) }
+
+    it "should return the poster URL" do
+      movie.backdrop('w300').wont_be_nil
+    end
+  end
+
 end

data/tmdb.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: tmdb 0.4.1 ruby lib
+# stub: tmdb 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tmdb"
-  s.version = "0.4.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Cody Barr"]
-  s.date = "2014-07-25"
+  s.date = "2014-07-26"
   s.description = "tmdb is a simple ruby wrapper for The Movie Database.  Exposes all TMDB API operations"
   s.email = "cody.barr@gmail.com"
   s.extra_rdoc_files = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tmdb
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Cody Barr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2014-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty