kubrick 0.0.1 → 0.1.1

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# v0.1.1
+## Feb. 20, 2012
+---
+- Complete rewrite. Updated to use OAuth and be REST, not catalog API wrapper (eventually).
+
+# v0.0.1
+## Feb. 11, 2012
+---
+- First release

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in kubrick.gemspec
-gemspec
+gemspec

data/README.md

@@ -0,0 +1,42 @@
+# Kubrick
+## A simple Ruby wrapper for the Netflix REST API
+
+---
+
+Kubrick is a Ruby wrapper for the Netflix REST API. It is nowhere near ready for use.
+
+## Usage
+1. Go to the [Netflix API keys website](http://developer.netflix.com/apps/mykeys) and sign up for an account if you haven't done so yet. Register an application.
+
+2. Start the OAuth authentication process. Kubrick's OAuth setup is designed to be as simple as possible. Start by initializing the `Authenticator` class and passing in your consumer key and secret:
+
+	authenticator = Kubrick::Authenticator.new("consumer key", "consumer secret")
+	
+Next, get a request token. Note that you must save this temporarily somehow as you will need it after you redirect your user to Netflix's login page.
+
+	request_token = authenticator.get_request_token
+	
+Pass the output of that method and your callback URL into `login_url` to get the URL you should redirect your user to:
+
+	redirect_url = authenticator.login_url(request_token, "callback_url")
+	
+When your user returns, pass your request token (the one you had to save earlier) into `get_access_token`.
+
+	access_token = authenticator.get_access_token(request_token)
+	
+MAKE SURE TO SAVE THE ACCESS TOKEN. It won't change unless the user revokes access to your application.
+
+You can now make calls by passing in the access token details and your consumer details. Like this:
+
+	m = Kubrick::Movie.new(access_token, {:oauth_consumer_key => "consumer_key", :oauth_consumer_secret => "consumer_secret"})
+	m.find_by_title("2001: A Space Odyssey")
+
+## Warning!
+
+Kubrick is by no means ready for use. It's not even close to complete. If you want to use it, go ahead, but be warned that the API's may change by surprise.
+
+## Copyright, blah blah blah
+
+Do whatever the heck you want with this. Fork it, rewrite, sell it as your own. I don't care. But *please* retain credit to me and any contributors.
+
+© Copyright 2012 J-P Teti.

data/kubrick.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["J-P Teti"]
   s.email       = ["roboteti@gmail.com"]
   s.homepage    = ""
-  s.summary     = "Netflix Catalog API wrapper"
-  s.description = "A Ruby wrapper for the Netflix Catalog API."
+  s.summary     = %q{Netflix REST API wrapper}
+  s.description = %q{A Ruby wrapper for the Netflix REST API.}
 
   s.rubyforge_project = "kubrick"
 
@@ -18,6 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "httparty"
-  s.add_runtime_dependency "ruby_odata"
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "simple_oauth"
+  s.add_runtime_dependency "faraday"
+  s.add_runtime_dependency "crack"
 end

data/lib/kubrick.rb

@@ -1,44 +1,12 @@
-require 'ruby_odata'
+module Kubrick
+  NETFLIX_API_ROOT = "api.netflix.com"
+end
+
+require 'simple_oauth'
+require 'faraday'
+require 'crack'
 require File.expand_path("../kubrick/version", __FILE__)
 require File.expand_path("../kubrick/errors", __FILE__)
-
-module Kubrick
-  NETFLIX_API_ROOT = 'http://odata.netflix.com/Catalog'
-  
-  class Movie
-    @svc = OData::Service.new NETFLIX_API_ROOT
-    
-    def self.find_by_title(title)
-      if title.nil?
-        raise Errors::KubrickError "Movie.find_by_title: title cannot be nil."
-      else
-        @svc.Titles.filter("Name eq '#{title}'")
-        movie = @svc.execute
-        JSON.parse(movie.to_json) # I know, this is horrible, but I couldn't get it to work any other way.
-      end
-    end
-    
-    def self.find_by_director(name)
-      if name.nil?
-        raise Errors::KubrickError "Movie.find_by_director: name cannot be nil"
-      end
-      @svc.People.filter("Name eq '#{name}'").expand('TitlesDirected')
-      person = @svc.execute
-      parsed = JSON.parse(person.to_json)
-      parsed[0]['TitlesDirected']
-    end
-  end
-  
-  class Person
-    @svc = OData::Service.new NETFLIX_API_ROOT
-    
-    def self.find_by_name(name)
-      if name.nil?
-         raise Errors::KubrickError "Person.find_by_name: name cannot be nil"
-      end
-      @svc.People.filter("Name eq '#{name}'").expand('TitlesDirected')
-      person = @svc.execute
-      JSON.parse(person.to_json)
-    end
-  end
-end
+require File.expand_path("../kubrick/authenticator", __FILE__)
+require File.expand_path("../kubrick/netflix_api", __FILE__)
+require File.expand_path("../kubrick/movie", __FILE__)

data/lib/kubrick/authenticator.rb

@@ -0,0 +1,68 @@
+module Kubrick
+  class Authenticator   
+    attr_reader :key, :secret
+     
+    def initialize(key, secret)
+      @key = key
+      @secret = secret
+      @conn = Faraday.new(:url => "http://#{NETFLIX_API_ROOT}") do |builder|
+        builder.adapter :net_http
+      end
+    end
+    
+    def get_request_token
+      headers_g = SimpleOAuth::Header.new(:get, "http://#{NETFLIX_API_ROOT}/oauth/request_token", nil, {:consumer_key => @key, :consumer_secret => @secret})
+      headers = headers_g.signed_attributes
+      request = @conn.get do |req|
+        req.url '/oauth/request_token'
+        req.params['oauth_consumer_key'] = headers[:oauth_consumer_key]
+        req.params['oauth_nonce'] = headers[:oauth_nonce]
+        req.params['oauth_signature_method'] = headers[:oauth_signature_method]
+        req.params['oauth_timestamp'] = headers[:oauth_timestamp]
+        req.params['oauth_version'] = headers[:oauth_version]
+        req.params['oauth_signature'] = headers[:oauth_signature]
+      end
+      if request.status == 200
+        step1 = request.body.split("&")
+        processed_response = {}
+        for item in step1
+          q = item.split("=")
+          processed_response[:"#{q[0]}"] = CGI::unescape(q[1])
+        end
+        processed_response
+      else
+        raise Kubrick::Errors::AuthenticatorError.new "get_request_token: #{request.body}"
+      end
+    end
+    
+    def login_url(oauth_values = {}, callback_url)
+      "https://api-user.netflix.com/oauth/login?oauth_token=#{oauth_values[:oauth_token]}&oauth_consumer_key=#{@key}&application_name=#{oauth_values[:application_name]}&oauth_callback=#{CGI::escape(callback_url)}"
+    end
+    
+    def get_access_token(oauth_values = {})
+      headers_g = SimpleOAuth::Header.new(:get, "http://#{NETFLIX_API_ROOT}/oauth/access_token", nil, {:consumer_key => @key, :token => oauth_values[:oauth_token], :consumer_secret => @secret, :token_secret => oauth_values[:oauth_token_secret]})
+      headers = headers_g.signed_attributes
+      request = @conn.get do |req|
+        req.url '/oauth/access_token'
+        req.params['oauth_consumer_key'] = headers[:oauth_consumer_key]
+        req.params['oauth_nonce'] = headers[:oauth_nonce]
+        req.params['oauth_signature_method'] = headers[:oauth_signature_method]
+        req.params['oauth_timestamp'] = headers[:oauth_timestamp]
+        req.params['oauth_token'] = headers[:oauth_token]
+        req.params['oauth_version'] = headers[:oauth_version]
+        req.params['oauth_signature'] = headers[:oauth_signature]
+      end
+      if request.status == 200
+        step1 = request.body.split("&")
+        processed_response = {}
+        for item in step1
+          q = item.split("=")
+          processed_response[:"#{q[0]}"] = CGI::unescape(q[1])
+        end
+        processed_response
+      else
+        raise Kubrick::Errors::AuthenticatorError.new "get_access_token: #{request.body}"
+      end
+    end
+  end
+end

data/lib/kubrick/errors.rb

@@ -1,6 +1,9 @@
 module Kubrick
   module Errors
-    class KubrickError < StandardError
-    end
+    class KubrickError < Exception; end
+    class AuthenticatorError < KubrickError; end
+    class HTTPError < KubrickError; end
+    class LimitError < KubrickError; end
+    class APIError < KubrickError; end
   end
 end

data/lib/kubrick/movie.rb

@@ -0,0 +1,25 @@
+module Kubrick
+  class Movie < NetflixAPI
+    def find_by_title(title)
+      headers_g = SimpleOAuth::Header.new(:get, "http://#{NETFLIX_API_ROOT}/catalog/titles", {'term' => CGI::escape(title)}, {:consumer_key => @oauth_consumer_key, :consumer_secret => @oauth_consumer_secret, :token => @oauth_token, :token_secret => @oauth_token_secret})
+      headers = headers_g.signed_attributes
+      request = @conn.get do |req|
+        req.url '/catalog/titles'
+        req.params['oauth_consumer_key'] = headers[:oauth_consumer_key]
+        req.params['oauth_nonce'] = headers[:oauth_nonce]
+        req.params['oauth_signature_method'] = headers[:oauth_signature_method]
+        req.params['oauth_timestamp'] = headers[:oauth_timestamp]
+        req.params['oauth_token'] = headers[:oauth_token]
+        req.params['oauth_version'] = headers[:oauth_version]
+        req.params['term'] = CGI::escape(title)
+        req.params['oauth_signature'] = headers[:oauth_signature]
+      end
+      if request.status == 200
+        response = Crack::XML.parse(request.body)
+        response["catalog_titles"]["catalog_title"]
+      else
+        raise Kubrick::Errors::APIError.new "Movie.find_by_title: #{request.body}"
+      end
+    end
+  end
+end

data/lib/kubrick/netflix_api.rb

@@ -0,0 +1,22 @@
+module Kubrick
+  class NetflixAPI    
+    def initialize(oauth, oauth_consumer)
+      @oauth_consumer_key = oauth_consumer[:oauth_consumer_key]
+      @oauth_consumer_secret = oauth_consumer[:oauth_consumer_secret]
+      @oauth_token = oauth[:oauth_token]
+      @user_id = oauth[:user_id]
+      @oauth_token_secret = oauth[:oauth_token_secret]
+      @conn = Faraday.new(:url => "http://#{NETFLIX_API_ROOT}") do |builder|
+         builder.adapter :net_http
+       end
+    end
+    
+    def say_hello
+      "Hello, Dave."
+    end
+    
+    def wheres_johnny
+      "Here's Johnny!"
+    end
+  end
+end

data/lib/kubrick/version.rb

@@ -1,3 +1,3 @@
 module Kubrick
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubrick
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-11 00:00:00.000000000 Z
+date: 2012-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: &8568450 !ruby/object:Gem::Requirement
+  name: simple_oauth
+  requirement: &6263710 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8568450
+  version_requirements: *6263710
 - !ruby/object:Gem::Dependency
-  name: ruby_odata
-  requirement: &8567570 !ruby/object:Gem::Requirement
+  name: faraday
+  requirement: &6263500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,8 +32,19 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8567570
-description: A Ruby wrapper for the Netflix Catalog API.
+  version_requirements: *6263500
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: &6263290 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *6263290
+description: A Ruby wrapper for the Netflix REST API.
 email:
 - roboteti@gmail.com
 executables: []
@@ -41,11 +52,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
+- README.md
 - Rakefile
 - kubrick.gemspec
 - lib/kubrick.rb
+- lib/kubrick/authenticator.rb
 - lib/kubrick/errors.rb
+- lib/kubrick/movie.rb
+- lib/kubrick/netflix_api.rb
 - lib/kubrick/version.rb
 homepage: ''
 licenses: []
@@ -70,5 +86,5 @@ rubyforge_project: kubrick
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Netflix Catalog API wrapper
+summary: Netflix REST API wrapper
 test_files: []