traktr 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff5530ddf41945252c0fd25a646fa99d0447862b
-  data.tar.gz: 192df29f7c2dfd344b5e2d3928344a372231dc88
+  metadata.gz: 35dcdf1ab6c39e98d9b42e94f9200abe412e3a7b
+  data.tar.gz: 54f5fe728f8f6b69ba87aa982ddc2fed6aad30c1
 SHA512:
-  metadata.gz: 5cc91fad8010a43a44f6e8656d69dc9147d6721745e262b2d7da4a83cda02d6ed1ee2ec40fba6d2e0e2ef713a9a185912646b4eecc078419ef45067eb8fcbf62
-  data.tar.gz: d48a37bedb5f961f732081c1e057bdf8757f1ad14878dab9cedb9441d9050bdcfe94914acbbcead48d2b6c54f86f13474d59c7134371e128aaade0aac7406253
+  metadata.gz: 8f9d95f33efc71ca758f0b77d24a7b3072d3e2dc9b55097a0b0d90e0b3dfee4ecacc0cd159ec8beab91aee4195d95c06307cbd490010fa44c4b97dfb3b8739f4
+  data.tar.gz: 0d7679d865a45535648f005555082bd6bdbb1572094fb199cec6275b426192e914f071e0db49bcd43934d521e4f3c5692a4ff2ecda545da56abac481901deeae

data/README.md

@@ -40,19 +40,41 @@ SHA1_PASSWORD = "57b2ad99044d337197c0c39fd3823568ff81e48a"
 
 # for non-authenticated methods, you can create an instance without supplying
 # username and password
-trakt = Traktr::Client.new(API_KEY)
+@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)
+@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)
+@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.
+To get summary info about a movie, use the ```movie.summary``` method:
+
+```ruby
+# you can use the trakt.tv slug, IMDB ID, or TMDB ID
+tdk = @trakt.movie.summary('the-dark-knight-2008')
+
+# tdk is a Mash object that has methods for each field in the summary:
+tdk.title
+tdk.year
+tdk.released
+tdk.url
+tdk.trailer
+tdk.runtime
+# etc ...
+```
+
+To search for a movie, use the ```search.movies``` method.
+
+```ruby
+# returns an array of movie summary results
+results = @trakt.search.movies("Dark Knight")
+results.each do |r|
+  puts r.title
+end
+```
 
 ## Contributing
 

data/lib/traktr/activity.rb

@@ -0,0 +1,70 @@
+module Traktr
+  class Activity
+    include HTTParty
+    base_uri File.join(Traktr.base_uri, 'activity')
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    ## activity GET methods
+    ##
+    def community(types = :all, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+      response = self.class.get('/' + File.join('community.json', @client.api_key, types.to_s, actions.to_s, start_ts.to_s, end_ts.to_s))
+      raise ResponseError.new(response) if response.code != 200
+
+      Mash.new(response.parsed_response)
+    end
+
+    def episodes(title, season, episode, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+      response = self.class.get('/' + File.join('episodes.json', @client.api_key, title, season.to_s, episode.to_s, actions.to_s, start_ts.to_s, end_ts.to_s))
+      raise ResponseError.new(response) if response.code != 200
+
+      Mash.new(response.parsed_response)
+    end 
+
+    def movies(title, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+      response = self.class.get('/' + File.join('movies.json', @client.api_key, title, actions.to_s, start_ts.to_s, end_ts.to_s))
+      raise ResponseError.new(response) if response.code != 200
+
+      Mash.new(response.parsed_response)
+    end
+
+    def seasons(title, season, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+      response = self.class.get('/' + File.join('seasons.json', @client.api_key, title, season.to_s, actions.to_s, start_ts.to_s, end_ts.to_s))
+      raise ResponseError.new(response) if response.code != 200
+
+      Mash.new(response.parsed_response)
+    end
+
+    def shows(title, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+      response = self.class.get('/' + File.join('shows.json', @client.api_key, title, actions.to_s, start_ts.to_s, end_ts.to_s))
+      raise ResponseError.new(response) if response.code != 200
+
+      Mash.new(response.parsed_response)
+    end
+
+    def user(username = nil, types = :all, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+      if username
+        response = self.class.get('/' + File.join('user.json', @client.api_key, username, types.to_s, actions.to_s, start_ts.to_s, end_ts.to_s))
+        raise ResponseError.new(response) if response.code != 200
+
+        Mash.new(response.parsed_response)
+      else
+        @user ||= Traktr::Activity::User.new(@client)
+      end
+    end
+
+    ##
+    ## activity POST methods
+    ##
+    def friends(types = :all, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+      data = { username: @client.username, password: @client.password }
+      response = self.class.post('/' + File.join('friends.json', @client.api_key, types.to_s, actions.to_s, start_ts.to_s, end_ts.to_s), 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/activity/user.rb

@@ -0,0 +1,40 @@
+module Traktr
+  class Activity
+  	class User
+  	  include HTTParty
+      base_uri File.join(Traktr::Activity.base_uri, "user")
+
+      def initialize(client)
+        @client = client
+      end
+
+      def episodes(username, title, season, episode, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+        response = self.class.get('/' + File.join('episodes.json', @client.api_key, username, title, season.to_s, episode.to_s, actions.to_s, start_ts.to_s, end_ts.to_s))
+        raise ResponseError.new(response) if response.code != 200
+
+        Mash.new(response.parsed_response)
+      end 
+
+      def movies(username, title, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+        response = self.class.get('/' + File.join('movies.json', @client.api_key, username, title, actions.to_s, start_ts.to_s, end_ts.to_s))
+        raise ResponseError.new(response) if response.code != 200
+       
+        Mash.new(response.parsed_response)
+      end
+
+      def seasons(username, title, season, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+        response = self.class.get('/' + File.join('seasons.json', @client.api_key, username, title, season.to_s, actions.to_s, start_ts.to_s, end_ts.to_s))
+        raise ResponseError.new(response) if response.code != 200
+       
+        Mash.new(response.parsed_response)
+      end
+
+      def shows(username, title, actions = :all, start_ts = 0, end_ts = Time.now.to_i)
+        response = self.class.get('/' + File.join('shows.json', @client.api_key, username, title, actions.to_s, start_ts.to_s, end_ts.to_s))
+        raise ResponseError.new(response) if response.code != 200
+       
+        Mash.new(response.parsed_response)
+      end      
+  	end
+  end
+end

data/lib/traktr/client.rb

@@ -1,6 +1,8 @@
 require 'digest/sha1'
 
 require 'traktr/account'
+require 'traktr/activity'
+require 'traktr/activity/user'
 require 'traktr/movie'
 require 'traktr/movies'
 require 'traktr/search'
@@ -26,6 +28,10 @@ module Traktr
       @account ||= Traktr::Account.new(self)
     end
 
+    def activity
+      @activity ||= Traktr::Activity.new(self)
+    end
+
     def movie
       @movie ||= Traktr::Movie.new(self)
     end

data/lib/traktr/show.rb

@@ -11,11 +11,6 @@ module Traktr
       @episode ||= Traktr::Show::Episode.new(@client)
     end
 
-    def season
-      
-
-    end
-
     ##
     ## show GET methods
     ##

data/lib/traktr/version.rb

@@ -1,3 +1,3 @@
 module Traktr
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/.gitignore

@@ -0,0 +1 @@
+spec.yaml

data/spec/activity_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Traktr::Activity do
+  context 'GET methods' do
+    context 'with valid api_key' do
+      before :all do
+        @trakt = Traktr::Client.new(API_KEY)
+      end
+
+      context 'with valid query' do
+        it '#community' do
+          expect( @trakt.activity.community.size ).to be > 0
+        end
+
+        it '#episodes' do
+          expect( @trakt.activity.episodes('dexter', 1, 1).activity.class ).to eql(Array)
+        end
+
+        it '#movies' do
+          expect( @trakt.activity.movies('the-dark-knight-2008').activity.class ).to eql(Array)
+        end
+
+        it '#seasons' do
+          expect( @trakt.activity.seasons('dexter', 1).activity.class ).to eql(Array)
+        end
+
+        it '#shows' do
+          expect( @trakt.activity.shows('dexter').activity.class ).to eql(Array)
+        end
+
+        it '#user' do
+          expect( @trakt.activity.user('traktr').activity.class ).to eql(Array)
+          expect( @trakt.activity.user('joe.lanford').status ).to eql("error")
+        end
+      end
+
+      context 'with invalid query' do
+        it '#episodes' do
+          expect { @trakt.activity.episodes('blah', 1, 1) }.to raise_error(Traktr::ResponseError)
+        end
+
+        it '#movies' do
+          expect { @trakt.activity.movies('blah') }.to raise_error(Traktr::ResponseError)
+        end
+
+        it '#seasons' do
+          expect { @trakt.activity.seasons('blah', 1) }.to raise_error(Traktr::ResponseError)
+        end
+
+        it '#shows' do
+          expect { @trakt.activity.shows('blah') }.to raise_error(Traktr::ResponseError)
+        end
+
+        it '#user' do
+          expect { @trakt.activity.user('aaaaaaaaaaaaaaa') }.to raise_error(Traktr::ResponseError)
+        end
+      end
+
+    end
+
+    context 'without valid api_key' do
+      before :all do
+        @trakt = Traktr::Client.new(nil)
+      end
+
+      it '#community' do
+        expect { @trakt.activity.community }.to raise_error(Traktr::ResponseError)
+      end
+
+      it '#episodes' do
+        expect { @trakt.activity.episodes('dexter', 1, 1) }.to raise_error(Traktr::ResponseError)
+      end
+
+      it '#movies' do
+        expect { @trakt.activity.movies('the-dark-knight-2008') }.to raise_error(Traktr::ResponseError)
+      end
+
+      it '#seasons' do
+        expect { @trakt.activity.seasons('dexter', 1) }.to raise_error(Traktr::ResponseError)
+      end
+
+      it '#shows' do
+        expect { @trakt.activity.shows('dexter') }.to raise_error(Traktr::ResponseError)
+      end
+
+      it '#user' do
+        expect { @trakt.activity.user('traktr') }.to raise_error(Traktr::ResponseError)
+      end
+    end
+  end
+
+  context 'POST methods' do
+    before :all do
+      trakt = Traktr::Client.new(API_KEY)
+    end
+
+    context 'with valid api_key and auth credentials' do
+      before :all do
+        @trakt = Traktr::Client.new(API_KEY, USERNAME, PASSWORD)
+      end
+
+      it '#friends' do
+        expect( @trakt.activity.friends.activity.class ).to eql(Array)
+      end
+    end
+
+    context 'without valid api_key' do
+      before :all do
+        @trakt = Traktr::Client.new(nil, USERNAME, PASSWORD)
+      end
+
+      it '#friends' do
+        expect { @trakt.activity.friends }.to raise_error(Traktr::ResponseError)
+      end
+    end
+
+    context 'without valid auth credentials' do
+      before :all do
+        @trakt = Traktr::Client.new(API_KEY)
+      end
+
+      it '#friends' do
+        expect { @trakt.activity.friends }.to raise_error(Traktr::ResponseError)
+      end
+    end
+  end
+end

data/spec/activity_user_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Traktr::Activity::User do
+  context 'GET methods' do
+    context 'with valid api_key' do
+      before :all do
+        @trakt = Traktr::Client.new(API_KEY)
+      end
+
+      context 'with valid query' do
+        it '#episodes' do
+          expect( @trakt.activity.user.episodes('traktr', 'dexter', 1, 1).activity.class ).to eql(Array)
+        end
+
+        it '#movies' do
+          expect( @trakt.activity.user.movies('traktr', 'the-dark-knight-2008').activity.class ).to eql(Array)
+        end
+
+        it '#seasons' do
+          expect( @trakt.activity.user.seasons('traktr', 'dexter', 1).activity.class ).to eql(Array)
+        end
+
+        it '#shows' do
+          expect( @trakt.activity.user.shows('traktr', 'dexter').activity.class ).to eql(Array)
+        end
+      end
+
+      context 'with invalid query' do
+        it '#episodes' do
+          expect { @trakt.activity.user.episodes('traktr', 'blah', 1, 1) }.to raise_error(Traktr::ResponseError)
+        end
+
+        it '#movies' do
+          expect { @trakt.activity.user.movies('traktr', 'blah') }.to raise_error(Traktr::ResponseError)
+        end
+
+        it '#seasons' do
+          expect { @trakt.activity.user.seasons('traktr', 'blah', 1) }.to raise_error(Traktr::ResponseError)
+        end
+
+        it '#shows' do
+          expect { @trakt.activity.user.shows('traktr', 'blah') }.to raise_error(Traktr::ResponseError)
+        end
+      end
+    end
+
+    context 'without valid api_key' do
+      before :all do
+        @trakt = Traktr::Client.new(nil)
+      end
+
+      it '#episodes' do
+        expect { @trakt.activity.user.episodes('traktr', 'dexter', 1, 1) }.to raise_error(Traktr::ResponseError)
+      end
+
+      it '#movies' do
+        expect { @trakt.activity.user.movies('traktr', 'the-dark-knight-2008') }.to raise_error(Traktr::ResponseError)
+      end
+
+      it '#seasons' do
+        expect { @trakt.activity.user.seasons('traktr', 'dexter', 1) }.to raise_error(Traktr::ResponseError)
+      end
+
+      it '#shows' do
+        expect { @trakt.activity.user.shows('traktr', 'dexter') }.to raise_error(Traktr::ResponseError)
+      end
+    end
+  end
+end

data/spec/spec.yaml.sample

@@ -0,0 +1,7 @@
+#
+# WARNING: This account is used for automated unit testing.
+#          Do not use your normal Trakt user account!
+#
+api_key: "<TRAKT_API_KEY>"
+username: "<TRAKT_USERNAME>"
+password: "<TRAKT_PASSWORD>"

data/spec/spec_helper.rb

@@ -6,9 +6,15 @@ end
 
 require 'traktr'
 
-API_KEY  = 'ec39665f9e31eb8c00de2aec74c755bf'
-USERNAME = 'test.joe.lanford'
-PASSWORD = 'test1234'
+if File.exist?(File.join(File.dirname(__FILE__), "spec.yaml"))
+  config   = YAML.load_file(File.join(File.dirname(__FILE__), "spec.yaml"))
+  API_KEY  = config["api_key"]
+  USERNAME = config["username"]
+  PASSWORD = config["password"]
+else
+  $stderr.puts "ERROR: You must configure the 'spec.yaml' file in the spec directory!"
+  exit 1
+end
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traktr
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Joe Lanford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -28,70 +28,70 @@ dependencies:
   name: mash
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Implementation of the trakt.tv REST API.  See the documentation at http://trakt.tv/api-docs
@@ -101,14 +101,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/traktr.rb
 - lib/traktr/account.rb
+- lib/traktr/activity.rb
+- lib/traktr/activity/user.rb
 - lib/traktr/client.rb
 - lib/traktr/movie.rb
 - lib/traktr/movies.rb
@@ -127,7 +129,10 @@ files:
 - lib/traktr/user/ratings.rb
 - lib/traktr/user/watchlist.rb
 - lib/traktr/version.rb
+- spec/.gitignore
 - spec/account_spec.rb
+- spec/activity_spec.rb
+- spec/activity_user_spec.rb
 - spec/movie_spec.rb
 - spec/movies_spec.rb
 - spec/search_spec.rb
@@ -135,6 +140,7 @@ files:
 - spec/show_season_spec.rb
 - spec/show_spec.rb
 - spec/shows_spec.rb
+- spec/spec.yaml.sample
 - spec/spec_helper.rb
 - traktr.gemspec
 homepage: https://github.com/joelanford/traktr
@@ -147,22 +153,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.1
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Implementation of the trakt.tv REST API
 test_files:
+- spec/.gitignore
 - spec/account_spec.rb
+- spec/activity_spec.rb
+- spec/activity_user_spec.rb
 - spec/movie_spec.rb
 - spec/movies_spec.rb
 - spec/search_spec.rb
@@ -170,5 +179,5 @@ test_files:
 - spec/show_season_spec.rb
 - spec/show_spec.rb
 - spec/shows_spec.rb
+- spec/spec.yaml.sample
 - spec/spec_helper.rb
-has_rdoc: