traktr 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2be4dc41f9bdab35ee6efd4c32496d80d9c72ac
-  data.tar.gz: 4af66c432614436188985df65bc85475db044fe2
+  metadata.gz: ff5530ddf41945252c0fd25a646fa99d0447862b
+  data.tar.gz: 192df29f7c2dfd344b5e2d3928344a372231dc88
 SHA512:
-  metadata.gz: 370a936cb1b8cfc021fd173dd6eff26bca9d6b7fb5b3e8f66d6311fd02cb8c40ef9a4311892dc6b89ff30706b7ca6a47ae207f0719efb1f2cb6f00f64afae064
-  data.tar.gz: 740e0274f5783d6ada811e4acfc4241b0dfd0e8f76579afccde14caa5cbf244bde4bd8c72d0125c503d8cca316d64d992d02ce6f0622ac3b8e666cd5ed920b93
+  metadata.gz: 5cc91fad8010a43a44f6e8656d69dc9147d6721745e262b2d7da4a83cda02d6ed1ee2ec40fba6d2e0e2ef713a9a185912646b4eecc078419ef45067eb8fcbf62
+  data.tar.gz: d48a37bedb5f961f732081c1e057bdf8757f1ad14878dab9cedb9441d9050bdcfe94914acbbcead48d2b6c54f86f13474d59c7134371e128aaade0aac7406253

data/README.md

@@ -1,6 +1,18 @@
 # Traktr
 
-TODO: Write a gem description
+Traktr is a ruby client API for the trakt.tv RESTful web service.  Trakt allows users to:
+
+1. Automatically track what you're watching
+2. Track your progress and see what's on tonight
+3. Catalog your entire media collection
+4. Submit ratings and reviews, follow other members, and make friends
+5. Share to your social networks in real time
+6. Discover new shows and movies
+7. Organize lists of your favorite shows and movies to make sure you don't forget them
+
+This client API supports all non-DEV REST methods.  (If you need the DEV methods, submit a pull request!)
+
+The full API documentation can be found at http://trakt.tv/api-docs
 
 ## Installation
 
@@ -18,7 +30,29 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To interface with the Trakt API, you must create a client instance
+
+```ruby
+API_KEY       = "abcdefghijklmnopqrstuvwxyz"
+USERNAME      = "john_doe"
+PASSWORD      = "p@ssw0rd"
+SHA1_PASSWORD = "57b2ad99044d337197c0c39fd3823568ff81e48a"
+
+# for non-authenticated methods, you can create an instance without supplying
+# username and password
+trakt = Traktr::Client.new(API_KEY)
+
+# if you need to use an authenticated method, you can provide your plaintext
+# password
+trakt = Traktr::Client.new(API_KEY, USERNAME, PASSWORD)
+
+# or the SHA1 hash of your password
+trakt = Traktr::Client.new(API_KEY, USERNAME, SHA1_PASSWORD, true)
+```
+
+From there, just string together method calls that match the Trakt API endpoints!
+It's that easy (aka, I need to add more documentation here).  See the RSpec tests
+for examples of all of the supported methods.
 
 ## Contributing
 

data/lib/traktr.rb

@@ -1,20 +1,11 @@
 require 'httparty'
-require 'mash'
 require 'json'
-require 'uri'
+require 'mash'
 
 module Traktr
   include HTTParty
   base_uri "http://api.trakt.tv"
 end
 
-require 'traktr/authentication'
-require 'traktr/version'
 
-require 'traktr/account'
-require 'traktr/movie'
-require 'traktr/movies'
-require 'traktr/search'
-require 'traktr/show'
-require 'traktr/shows'
-require 'traktr/user'
+require 'traktr/client'

data/lib/traktr/account.rb

@@ -1,23 +1,26 @@
 module Traktr
-  module Account
+  class Account
     include HTTParty
     base_uri File.join(Traktr.base_uri, "account")
 
-    def self.settings
-      data = { username: Traktr.username, password: Traktr.password }
-      response = self.post("/" + File.join("settings", Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+    def initialize(client)
+      @client = client
+    end
+
+    def settings
+      data = { username: @client.username, password: @client.password }
+      response = self.class.post("/" + File.join("settings", @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
 
-    def self.test
-      data = { username: Traktr.username, password: Traktr.password }
-      response = self.post("/" + File.join("test", Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+    def test
+      data = { username: @client.username, password: @client.password }
+      response = self.class.post("/" + File.join("test", @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
-
   end
 end

data/lib/traktr/client.rb

@@ -0,0 +1,57 @@
+require 'digest/sha1'
+
+require 'traktr/account'
+require 'traktr/movie'
+require 'traktr/movies'
+require 'traktr/search'
+require 'traktr/show'
+require 'traktr/show/episode'
+require 'traktr/show/season'
+require 'traktr/shows'
+require 'traktr/user'
+require 'traktr/version'
+
+
+module Traktr
+  class Client
+    attr_reader :api_key, :username, :password
+
+    def initialize(api_key, username = nil, password = nil, sha1 = false)
+      @api_key = api_key || ""
+      @username = username || ""
+      @password = password ? (sha1 ? password : Digest::SHA1.hexdigest(password)) : ""
+    end
+
+    def account
+      @account ||= Traktr::Account.new(self)
+    end
+
+    def movie
+      @movie ||= Traktr::Movie.new(self)
+    end
+
+    def movies
+      @movies ||= Traktr::Movies.new(self)
+    end
+
+    def search
+      @search ||= Traktr::Search.new(self)
+    end
+
+    def show
+      @show ||= Traktr::Show.new(self)
+    end
+
+    def shows
+      @shows ||= Traktr::Shows.new(self)
+    end
+
+    def user
+      @user ||= Traktr::User.new(self)
+    end
+
+    def version
+      @version ||= Traktr::Version.new(self)
+    end
+  end
+end

data/lib/traktr/movie.rb

@@ -1,13 +1,17 @@
 module Traktr
-  module Movie
+  class Movie
     include HTTParty
     base_uri File.join(Traktr.base_uri, 'movie')
 
+    def initialize(client)
+      @client = client
+    end
+
     ##
     ## movie GET methods
     ##
-    def self.comments(title, type = :all)
-      response = self.get('/' + File.join('comments.json', Traktr.api_key, title, type.to_s))
+    def comments(title, type = :all)
+      response = self.class.get('/' + File.join('comments.json', @client.api_key, title, type.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |comment|
@@ -15,8 +19,8 @@ module Traktr
       end
     end
 
-    def self.related(title, hidewatched = false)
-      response = self.get('/' + File.join('related.json', Traktr.api_key, title, hidewatched.to_s))
+    def related(title, hidewatched = false)
+      response = self.class.get('/' + File.join('related.json', @client.api_key, title, hidewatched.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |summary|
@@ -24,16 +28,16 @@ module Traktr
       end
     end
 
-    def self.summary(title, extended = :min)
-      response = self.get('/' + File.join('summary.json', Traktr.api_key, title.to_s, extended.to_s))
+    def summary(title, extended = :min)
+      response = self.class.get('/' + File.join('summary.json', @client.api_key, title.to_s, extended.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
 
-    def self.summaries(titles, extended = :min)
+    def summaries(titles, extended = :min)
       titles = [titles] if titles.class == String
-      response = self.get('/' + File.join('summaries.json', Traktr.api_key, titles.join(','), extended.to_s))
+      response = self.class.get('/' + File.join('summaries.json', @client.api_key, titles.join(','), extended.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |summary|
@@ -41,8 +45,8 @@ module Traktr
       end
     end
 
-    def self.watchingnow(title)
-      response = self.get('/' + File.join('watchingnow.json', Traktr.api_key, title))
+    def watchingnow(title)
+      response = self.class.get('/' + File.join('watchingnow.json', @client.api_key, title))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |user|
@@ -53,73 +57,73 @@ module Traktr
     ##
     ## movie POST methods
     ##
-    def self.library(movies)
+    def library(movies)
       movies = [ movies ] if movies.class != Array
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           movies: movies.collect{ |s| { title: s.title, year: s.year, imdb_id: s.imdb_id, tmdb_id: s.tmdb_id }}
       }
-      response = self.post('/' + File.join('library', Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post('/' + File.join('library', @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(JSON.parse(response.parsed_response))
     end
 
-    def self.unlibrary(movies)
+    def unlibrary(movies)
       movies = [ movies ] if movies.class != Array
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           movies: movies.collect{ |s| { title: s.title, year: s.year, imdb_id: s.imdb_id, tmdb_id: s.tmdb_id }}
       }
-      response = self.post('/' + File.join('unlibrary', Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post('/' + File.join('unlibrary', @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
 
-    def self.watchlist(movies)
+    def watchlist(movies)
       movies = [ movies ] if movies.class != Array
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           movies: movies.collect{ |s| { title: s.title, year: s.year, imdb_id: s.imdb_id, tmdb_id: s.tmdb_id }}
       }
-      response = self.post('/' + File.join('watchlist', Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post('/' + File.join('watchlist', @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(JSON.parse(response.parsed_response))
     end
 
-    def self.unwatchlist(movies)
+    def unwatchlist(movies)
       movies = [ movies ] if movies.class != Array
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           movies: movies.collect{ |s| { title: s.title, year: s.year, imdb_id: s.imdb_id, tmdb_id: s.tmdb_id }}
       }
-      response = self.post('/' + File.join('unwatchlist', Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post('/' + File.join('unwatchlist', @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
 
-    def self.seen(movies)
+    def seen(movies)
       movies = [ movies ] if movies.class != Array
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           movies: movies.collect{ |s| { title: s.title, year: s.year, imdb_id: s.imdb_id, tmdb_id: s.tmdb_id }}
       }
-      response = self.post('/' + File.join('seen', Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post('/' + File.join('seen', @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(JSON.parse(response.parsed_response))
     end
 
-    def self.unseen(movies)
+    def unseen(movies)
       movies = [ movies ] if movies.class != Array
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           movies: movies.collect{ |s| { title: s.title, year: s.year, imdb_id: s.imdb_id, tmdb_id: s.tmdb_id }}
       }
-      response = self.post('/' + File.join('unseen', Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post('/' + File.join('unseen', @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)

data/lib/traktr/movies.rb

@@ -1,13 +1,17 @@
 module Traktr
-  module Movies
+  class Movies
     include HTTParty
     base_uri File.join(Traktr.base_uri, 'movies')
 
+    def initialize(client)
+      @client = client
+    end
+
     ##
     ## movies GET methods
     ##
-    def self.trending
-      response = self.get('/' + File.join('trending.json', Traktr.api_key))
+    def trending
+      response = self.class.get('/' + File.join('trending.json', @client.api_key))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |movie|
@@ -15,8 +19,8 @@ module Traktr
       end
     end
 
-    def self.updated(timestamp)
-      response = self.get('/' + File.join('updated.json', Traktr.api_key, timestamp.to_i.to_s))
+    def updated(timestamp)
+      response = self.class.get('/' + File.join('updated.json', @client.api_key, timestamp.to_i.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)

data/lib/traktr/search.rb

@@ -1,13 +1,17 @@
 module Traktr
-  module Search
+  class Search
     include HTTParty
     base_uri File.join(Traktr.base_uri, 'search')
 
+    def initialize(client)
+      @client = client
+    end
+    
     ##
     ## search GET methods
     ##
-    def self.episodes(query)
-      response = self.get('/' + File.join('episodes.json', Traktr.api_key, URI::encode(query)))
+    def episodes(query)
+      response = self.class.get('/' + File.join('episodes.json', @client.api_key, URI::encode(query)))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |result|
@@ -15,8 +19,8 @@ module Traktr
       end
     end
 
-    def self.movies(query)
-      response = self.get('/' + File.join('movies.json', Traktr.api_key, URI::encode(query)))
+    def movies(query)
+      response = self.class.get('/' + File.join('movies.json', @client.api_key, URI::encode(query)))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |result|
@@ -24,8 +28,8 @@ module Traktr
       end
     end
 
-    def self.people(query)
-      response = self.get('/' + File.join('people.json', Traktr.api_key, URI::encode(query)))
+    def people(query)
+      response = self.class.get('/' + File.join('people.json', @client.api_key, URI::encode(query)))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |result|
@@ -33,8 +37,8 @@ module Traktr
       end
     end
 
-    def self.shows(query, limit = 30, seasons = nil)
-      response = self.get('/' + File.join('shows.json', Traktr.api_key, URI::encode(query), limit.to_s, seasons.to_s))
+    def shows(query, limit = 30, seasons = nil)
+      response = self.class.get('/' + File.join('shows.json', @client.api_key, URI::encode(query), limit.to_s, seasons.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |result|
@@ -42,8 +46,8 @@ module Traktr
       end
     end
 
-    def self.users(query)
-      response = self.get('/' + File.join('users.json', Traktr.api_key, URI::encode(query)))
+    def users(query)
+      response = self.class.get('/' + File.join('users.json', @client.api_key, URI::encode(query)))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |result|

data/lib/traktr/show.rb

@@ -1,13 +1,26 @@
 module Traktr
-  module Show
+  class Show
     include HTTParty
     base_uri File.join(Traktr.base_uri, "show")
 
+    def initialize(client)
+      @client = client
+    end
+
+    def episode
+      @episode ||= Traktr::Show::Episode.new(@client)
+    end
+
+    def season
+      
+
+    end
+
     ##
     ## show GET methods
     ##
-    def self.comments(title, type = :all)
-      response = self.get("/" + File.join("comments.json", Traktr.api_key, title, type.to_s))
+    def comments(title, type = :all)
+      response = self.class.get("/" + File.join("comments.json", @client.api_key, title, type.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |comment|
@@ -15,8 +28,8 @@ module Traktr
       end
     end
 
-    def self.related(title, hidewatched = false)
-      response = self.get("/" + File.join("related.json", Traktr.api_key, title, hidewatched.to_s))
+    def related(title, hidewatched = false)
+      response = self.class.get("/" + File.join("related.json", @client.api_key, title, hidewatched.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |summary|
@@ -24,17 +37,23 @@ module Traktr
       end
     end
 
-    def self.season(title, season)
-      response = self.get("/" + File.join("season.json", Traktr.api_key, title, season.to_s))
-      raise ResponseError.new(response) if response.code != 200
-
-      response.parsed_response.collect do |episode|
-        Mash.new(episode)
+    def season(title = nil, season = nil)
+      if title && season
+        response = self.class.get("/" + File.join("season.json", @client.api_key, title, season.to_s))
+        raise ResponseError.new(response) if response.code != 200
+
+        response.parsed_response.collect do |episode|
+          Mash.new(episode)
+        end
+      elsif !title && !season
+        @season ||= Traktr::Show::Season.new(@client)
+      else
+        raise ArgumentError.new("wrong number of arguments")
       end
     end
 
-    def self.seasons(title)
-      response = self.get("/" + File.join("seasons.json", Traktr.api_key, title))
+    def seasons(title)
+      response = self.class.get("/" + File.join("seasons.json", @client.api_key, title))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |season|
@@ -42,16 +61,16 @@ module Traktr
       end
     end
 
-    def self.summary(title, extended = :min)
-      response = self.get("/" + File.join("summary.json", Traktr.api_key, title, extended.to_s))
+    def summary(title, extended = :min)
+      response = self.class.get("/" + File.join("summary.json", @client.api_key, title, extended.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
 
-    def self.summaries(titles, extended = :min)
+    def summaries(titles, extended = :min)
       titles = [titles] if titles.class == String
-      response = self.get("/" + File.join("summaries.json", Traktr.api_key, titles.join(","), extended.to_s))
+      response = self.class.get("/" + File.join("summaries.json", @client.api_key, titles.join(","), extended.to_s))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |summary|
@@ -59,8 +78,8 @@ module Traktr
       end
     end
 
-    def self.watchingnow(title)
-      response = self.get("/" + File.join("watchingnow.json", Traktr.api_key, title))
+    def watchingnow(title)
+      response = self.class.get("/" + File.join("watchingnow.json", @client.api_key, title))
       raise ResponseError.new(response) if response.code != 200
 
       response.parsed_response.collect do |user|
@@ -71,64 +90,61 @@ module Traktr
     ##
     ## show POST methods
     ##
-    def self.library(show)
+    def library(show)
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           title: show.title, year: show.year, imdb_id: show.imdb_id, tvdb_id: show.tvdb_id,
       }
-      response = self.post("/" + File.join("library", Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post("/" + File.join("library", @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
 
-    def self.unlibrary(show)
+    def unlibrary(show)
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           title: show.title, year: show.year, imdb_id: show.imdb_id, tvdb_id: show.tvdb_id,
       }
-      response = self.post("/" + File.join("unlibrary", Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post("/" + File.join("unlibrary", @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
 
-    def self.watchlist(shows)
+    def watchlist(shows)
       shows = [ shows ] if shows.class != Array
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           shows: shows.collect{ |s| { title: s.title, year: s.year, imdb_id: s.imdb_id, tvdb_id: s.tvdb_id }}
       }
-      response = self.post("/" + File.join("watchlist", Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post("/" + File.join("watchlist", @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(JSON.parse(response.parsed_response))
     end
 
-    def self.unwatchlist(shows)
+    def unwatchlist(shows)
       shows = [ shows ] if shows.class != Array
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           shows: shows.collect{ |s| { title: s.title, year: s.year, imdb_id: s.imdb_id, tvdb_id: s.tvdb_id }}
       }
-      response = self.post("/" + File.join("unwatchlist", Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post("/" + File.join("unwatchlist", @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
 
-    def self.seen(show)
+    def seen(show)
       data = {
-          username: Traktr.username, password: Traktr.password,
+          username: @client.username, password: @client.password,
           title: show.title, year: show.year, imdb_id: show.imdb_id, tvdb_id: show.tvdb_id,
       }
-      response = self.post("/" + File.join("seen", Traktr.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
+      response = self.class.post("/" + File.join("seen", @client.api_key), body: data.to_json, headers: { 'Content-Type' => 'application/json'})
       raise ResponseError.new(response) if response.code != 200
 
       Mash.new(response.parsed_response)
     end
   end
 end
-
-require 'traktr/show/episode'
-require 'traktr/show/season'