netflix 0.1.0 → 0.1.1

data/README.rdoc

@@ -4,47 +4,50 @@ Copyright (c) 2012 Dean Holdren
 To install: gem install netflix
 
 This gem uses Netflix's OAuth REST API, you first need to register an application with Netflix at http://developer.netflix.com/apps/register/
+
 This will provide you with a "consumer key", "consumer secret", and "application name"
 
 === To use unauthenticated features (catalog search):
 * TODO
 
 === To use authenticated features (i.e. queue management):
-* Netflix.consumer_key = <your consumer/developer key>
-  Netflix.consumer_secret = <your consumer/developer secret>
+* Set the consumer/developer config:
+    Netflix.consumer_key = <your consumer/developer key>
+    Netflix.consumer_secret = <your consumer/developer secret>
 
 * Do OAuth dance: (This is a one-time per user step, save the result somewhere.)
   1. Interactive (commandline/irb):
-  This will open a netflix.com web page to ask the user to authenticate, and provide a pin.
-  access_token = Netflix::Client.new.oauth
+     This will open a netflix.com web page to ask the user to authenticate, and provide a pin.
+       access_token = Netflix::Client.new.oauth
 
   2. or Web application (Rails/Sinatra/etc), define a URL that can handle the callback
-  request_token, auth_url = Netflix::Client.new.oauth_via_callback(my_callback_url)
-  session[:request_token] = request_token
-  redirect_to auth_url
-
-  Then in the handler retrieve the :oauth_verifier out of the request params
-  oauth_verifier = params[:oauth_verifier]
-  request_token = session[:request_token]
-  access_token = Netflix::Client.new.handle_oauth_callback(request_token, oauth_verifier)
+       request_token, auth_url = Netflix::Client.new.oauth_via_callback(my_callback_url)
+       session[:request_token] = request_token
+       redirect_to auth_url
+
+     Then in the handler for "my_callback_url" (i.e. a Rails controller action) retrieve the :oauth_verifier out of the request params
+       oauth_verifier = params[:oauth_verifier]
+       request_token = session[:request_token]
+       access_token = Netflix::Client.new.handle_oauth_callback(request_token, oauth_verifier)
   
 
 * After OAuth credentials are established:
-  access_token = access_token.token
-  access_secret = access_token.secret
-  user_id = access_token.params["user_id"]
+    access_token = access_token.token
+    access_secret = access_token.secret
+    user_id = access_token.params["user_id"]
+  
   (Record these, for example in a User table in a database)
 
-  client = Netflix::Client.new(access_token, access_token_secret)
-  user = client.user(user_id)
-  queue = user.available_disc_queue
-  discs = queue.discs
-  disc_one = discs[0]
-  puts "#{disc_one.title} #{disc_one.id}"
-  queue.remove(1) #queue is 1-based, so this is first disc
+    client = Netflix::Client.new(access_token, access_token_secret)
+    user = client.user(user_id)
+    queue = user.available_disc_queue
+    discs = queue.discs
+    disc_one = discs[0]
+    puts "#{disc_one.title} #{disc_one.id}"
+    queue.remove(1) #queue is 1-based, so this is first disc
 
 === Credits
-  This work is based on: REST API documentation of Netflix (http://developer.netflix.com),
-  with some help from twitter gem for OAuth ideas https://github.com/jnunemaker/twitter/
+This work is based on: REST API documentation of Netflix (http://developer.netflix.com),
+with some help from twitter gem for OAuth ideas https://github.com/jnunemaker/twitter/
   
   

data/Rakefile

@@ -1,5 +1,4 @@
 require 'rake/testtask'
-#require 'rake/gempackagetask'
 require 'rubygems/package_task'
 
 Rake::TestTask.new("test") { |t|
@@ -12,7 +11,7 @@ Rake::TestTask.new("test") { |t|
 
 gem_spec = Gem::Specification.new do |s|
   s.name = "netflix"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
   s.authors = ["Dean Holdren"]
   s.date = %q{2012-01-09}
   s.description = "Ruby Netflix API wrapper"
@@ -33,10 +32,6 @@ gem_spec = Gem::Specification.new do |s|
   s.add_development_dependency("yaml")
 end
 
-#Rake::GemPackageTask.new(gem_spec) do |t|
-#  t.need_zip = true
-#end
-
 Gem::PackageTask.new(gem_spec) do |pkg|
   pkg.need_zip = true
 end

data/lib/netflix/queue.rb

@@ -39,8 +39,12 @@ module Netflix
     end
     
     def discs
-      queue_items = [queue_item].flatten
-      queue_items.map {|queue_item| Disc.new(queue_item)}
+      if queue_item
+        queue_items = [queue_item].flatten
+        queue_items.map {|queue_item| Disc.new(queue_item)}
+      else
+        []
+      end
     end
     
     private

data/test/http_fixtures/netflix_queue_responses.yml

@@ -1169,3 +1169,29 @@ nuid_sub2:
     body:
   delete:
     body:
+empty_queue:
+  get:
+    body: |
+      {"queue": {
+        "link": [
+          {
+            "href": "http://api.netflix.com/users/empty_queue/queues/disc/available",
+            "rel": "http://schemas.netflix.com/queues.available",
+            "title": "available queue"
+          },
+          {
+            "href": "http://api.netflix.com/users/empty_queue/queues/disc/saved",
+            "rel": "http://schemas.netflix.com/queues.saved",
+            "title": "saved queue"
+          }
+        ],
+        "results_per_page": "0",
+        "url_template": "http://api.netflix.com/users/empty_queue/queues/disc?{-join|&|sort|start_index|max_results}",
+        "start_index": "0",
+        "etag": "0",
+        "number_of_results": "0"
+      }}
+  post:
+    body:
+  delete:
+    body:

data/test/http_fixtures/netflix_user_responses.yml

@@ -205,4 +205,73 @@ nuid_sub2:
           }
         ]},
         "user_id": "nuid_sub2"
+      }}
+empty_queue:
+  get:
+    body: |
+      {"user": {
+        "can_instant_watch": true,
+        "first_name": "Empty",
+        "last_name": "Queue",
+        "link": [
+          {
+            "href": "http://api.netflix.com/users/empty_queue/queues",
+            "rel": "http://schemas.netflix.com/queues",
+            "title": "queues"
+          },
+          {
+            "href": "http://api.netflix.com/users/empty_queue/rental_history",
+            "rel": "http://schemas.netflix.com/rental_history",
+            "title": "rental history"
+          },
+          {
+            "href": "http://api.netflix.com/users/empty_queue/recommendations",
+            "rel": "http://schemas.netflix.com/recommendations",
+            "title": "recommendations"
+          },
+          {
+            "href": "http://api.netflix.com/users/empty_queue/title_states",
+            "rel": "http://schemas.netflix.com/title_states",
+            "title": "title states"
+          },
+          {
+            "href": "http://api.netflix.com/users/empty_queue/ratings",
+            "rel": "http://schemas.netflix.com/ratings",
+            "title": "ratings"
+          },
+          {
+            "href": "http://api.netflix.com/users/empty_queue/reviews",
+            "rel": "http://schemas.netflix.com/reviews",
+            "title": "reviews"
+          },
+          {
+            "href": "http://api.netflix.com/users/empty_queue/at_home",
+            "rel": "http://schemas.netflix.com/at_home",
+            "title": "at home"
+          },
+          {
+            "href": "http://api.netflix.com/users/empty_queue/feeds",
+            "rel": "http://schemas.netflix.com/feeds",
+            "title": "feeds"
+          }
+        ],
+        "max_maturity_level": {"category": {
+          "label": 1000000,
+          "scheme": "http://api.netflix.com/categories/maturity_level",
+          "term": 1000000
+        }},
+        "nickname": "foobar",
+        "preferred_formats": {"category": [
+          {
+            "label": "Blu-ray",
+            "scheme": "http://api.netflix.com/categories/title_formats",
+            "term": "Blu-ray"
+          },
+          {
+            "label": "DVD",
+            "scheme": "http://api.netflix.com/categories/title_formats",
+            "term": "DVD"
+          }
+        ]},
+        "user_id": "empty_queue"
       }}

data/test/queue_test.rb

@@ -61,5 +61,13 @@ class QueueTest < Test::Unit::TestCase
   #  }
   #end
   
+  def test_empty_queue
+    stub_netflix_for_user('empty_queue')
+    user = Netflix::Client.new('nuid_access_key', 'nuid_access_secret').user('empty_queue')
+    available_disc_queue = user.available_disc_queue
+    assert available_disc_queue, "Expected a disc_queue"
+    assert available_disc_queue.discs, "Expected the disc_queue to have a discs attribute"
+    assert_equal 0, available_disc_queue.discs.size, "Expected discs to be empty array #{available_disc_queue.discs[0]}}"
+  end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netflix
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &2160650860 !ruby/object:Gem::Requirement
+  requirement: &2165140260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160650860
+  version_requirements: *2165140260
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2160649060 !ruby/object:Gem::Requirement
+  requirement: &2165139740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160649060
+  version_requirements: *2165139740
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &2160647820 !ruby/object:Gem::Requirement
+  requirement: &2165139320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160647820
+  version_requirements: *2165139320
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2160645840 !ruby/object:Gem::Requirement
+  requirement: &2165138840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160645840
+  version_requirements: *2165138840
 - !ruby/object:Gem::Dependency
   name: yaml
-  requirement: &2160644720 !ruby/object:Gem::Requirement
+  requirement: &2165138360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160644720
+  version_requirements: *2165138360
 description: Ruby Netflix API wrapper
 email: deanholdren@gmail.com
 executables: []