netflix4r 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'activesupport'
+gem 'ruby-hmac'
+gem 'json'
+gem 'nokogiri'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.9)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.3)
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    rcov (0.9.9)
+    ruby-hmac (0.4.0)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  json
+  nokogiri
+  rcov
+  ruby-hmac
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 rossnelson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+flix4r
+==========
+
+a ruby client for the NetFlix API 
+
+Based on the "RESTful" resources provided by the NetFlix API, flix4r provides a clean, if _very_ incomplete, set of models for accessing NetFlixs' (sp?) resources.
+
+Credentials
+===========
+
+You must add your netflix credentials to flix4r/lib/oauth.yml. You can get credentials from http://developer.netflix.com/.
+
+Example
+==========
+
+    list = NetFlix::Title.search(:term => 'sneakers', :max_results => 2)
+    [#<NetFlix::Title:0x57f0f58 ...>, #<NetFlix::Title:0x57f0f58 ...>] # shortened for readability
+    sneakers = list.first
+    sneakers.title
+    "Sneakers"
+
+    sneakers.delivery_formats
+    ['instant', 'DVD']
+
+    sneakers.id
+    "http://api.netflix.com/catalog/titles/movies/60031755"
+
+    sneakers.web_page
+    "http://www.netflix.com/Movie/Sneakers/60031755"
+
+    sneakers.genres
+    ["Thrillers", "Action Comedies", "Espionage Thrillers", "Action Thrillers", "Suspense", "Heist Films", "Universal Studios Home Entertainment"]
+
+    sneakers.actors
+    ["Robert Redford", "Sidney Poitier", "Ben Kingsley", "Dan Aykroyd", "Mary McDonnell", "River Phoenix", "David Strathairn", "Donal Logue", "Timothy Busfield", "Eddie Jones", "George Hearn", "Lee Garlington", "Stephen Tobolowsky"]
+
+
+Contributing to flix4r
+=========
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+==
+
+Copyright (c) 2011 rossnelson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "netflix4r"
+  gem.homepage = "http://github.com/rossnelson/flix4r"
+  gem.license = "MIT"
+  gem.summary = %Q{copy of http://code.google.com/p/flix4r/}
+  gem.description = %Q{a ruby client for the NetFlix API}
+  gem.email = "axcess1@me.com"
+  gem.authors = ["rossnelson"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'activesupport'
+  gem.add_runtime_dependency 'ruby-hmac'
+  gem.add_runtime_dependency 'json'
+  gem.add_runtime_dependency 'nokogiri'
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "flix4r #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/credentials.yml

@@ -0,0 +1,3 @@
+--- 
+:key: 3n5x56cp5fbh23b3z2xsgdmu
+:secret: true3kTsmF

data/lib/flix4r.rb

@@ -0,0 +1,29 @@
+
+ this_dir = File.dirname(__FILE__)
+
+ require 'rubygems'
+ require 'active_support'
+ require 'open-uri'
+ require 'yaml'
+ require 'hmac-sha1'
+ require 'json'
+ require 'net/http'
+ require 'fileutils'
+ require 'nokogiri'
+ require 'valuable.rb'
+ require 'active_support/core_ext/hash/indifferent_access'
+
+ lib = File.join("../", 'lib')
+ builders = File.join(lib, 'net_flix', 'builders')
+
+ require 'net_flix'
+ require 'net_flix/credentials'
+ require 'net_flix/authenticator'
+ require 'net_flix/request'
+ require 'net_flix/title'
+ require 'net_flix/api/catalog/titles'
+
+
+ require 'net_flix/builders/actor_builder'
+ require 'net_flix/builders/format_builder'
+ require 'net_flix/builders/title_builder'

data/lib/net_flix/api/catalog/titles.rb

@@ -0,0 +1,22 @@
+module NetFlix
+  module API
+    module Catalog
+      module Titles 
+
+        class << self
+
+          # example Title.search(:term => 'sneakers', :max_results => 10)
+          def search(params = {})
+            NetFlix::Request.new(:url => 'http://api.netflix.com/catalog/titles', :parameters => params).send
+          end
+
+          def list(params = {})
+            NetFlix::Request.new(:url => 'http://api.netflix.com/catalog/titles/index', :parameters => params).send
+          end
+
+        end # class methods
+
+      end # class Titles
+    end # module Catalog 
+  end # module API
+end # module NetFlix

data/lib/net_flix/authenticator.rb

@@ -0,0 +1,74 @@
+module NetFlix
+  class Authenticator < Valuable
+
+    require 'base64'
+    require 'digest/sha1'
+
+    has_value :request
+    has_value :timestamp, :default => Time.now.to_i
+    has_value :nonce, :default => rand(1_000_000)
+    has_value :credentials
+
+    def access_token
+      credentials.access_token
+    end
+
+    def key
+      credentials.key
+    end
+    
+    def secret
+      credentials.secret
+    end
+
+    def require_credentials
+      raise( ArgumentError, "You must configure your NetFlix API key and secret before using flix4r.") unless credentials.valid?
+    end
+
+    def signature_base_string
+      add_authentication_parameters!
+      [request.http_method, encoded_url, encoded_parameters].join('&') 
+    end
+
+    def signature_key
+      "#{Request.encode(secret)}&#{Request.encode(access_token)}"
+    end
+
+    def signature
+      Base64.encode64(HMAC::SHA1.digest(signature_key,signature_base_string)).chomp.gsub(/\n/,'')
+    end
+
+    def authentication_parameters
+      {
+      'oauth_consumer_key' => key,
+      'oauth_signature_method' => 'HMAC-SHA1',
+      'oauth_timestamp' => timestamp,
+      'oauth_nonce' => nonce,
+      'oauth_version' => '1.0'
+      }
+    end
+
+    def add_authentication_parameters!
+      request.parameters = request.parameters.merge(authentication_parameters)
+    end
+
+    def add_signature!
+      sign = {'oauth_signature' => Request.encode(signature)}
+      request.parameters = request.parameters.merge( sign  )
+    end
+
+    def sign!
+      require_credentials
+      add_authentication_parameters!
+      add_signature!
+    end
+
+    def encoded_parameters
+      Request.encode request.parameter_string
+    end
+
+    def encoded_url
+      Request.encode request.url
+    end
+  end
+end

data/lib/net_flix/builders/actor_builder.rb

@@ -0,0 +1,29 @@
+class ActorBuilder
+
+  class << self
+	  
+  def from_xml(xml)
+    Nokogiri.XML(xml).xpath('//people/person/name').map do |actor_data|
+      actor_data.content
+    end
+  end
+  
+  def from_movie(movie)
+    actors = movie.search('link[@rel="http://schemas.netflix.com/catalog/person.actor"]').map{|f| f['title'] }
+    
+    actors + request_cast_for(movie)
+  end
+
+  def request_cast_for(movie)
+    cast_link_node = movie.search('link[@rel="http://schemas.netflix.com/catalog/people.cast"]').first
+    cast_link = cast_link_node['href'] if cast_link_node
+    if cast_link.nil?
+      []
+    else
+      request = NetFlix::Request.new(:url => cast_link)
+      response = request.send
+      from_xml(response)
+    end
+  end
+  end
+end

data/lib/net_flix/builders/format_builder.rb

@@ -0,0 +1,33 @@
+class FormatBuilder
+
+  class << self
+
+    def from_xml(xml)
+
+      Nokogiri.XML(xml).xpath("//delivery_formats/availability[@available_from < #{Time.now.to_i} or not(@available_from)]/category").map do |format_data|
+
+        format_data['term']
+      end
+    end
+
+    def from_movie(movie)
+
+      	    formats = movie.xpath("//title_index_item/delivery_formats/availability[not(@available_from) or @available_from < #{Time.now.to_i}]/category[@scheme='http://api.netflix.com/categories/title_formats']").map{|f| f['term'] }
+	    formats + request_cast_for(movie)
+
+    end
+
+    def request_cast_for(movie)
+      cast_link_node = movie.search('link[@rel="http://schemas.netflix.com/catalog/titles/format_availability"]').first
+      cast_link = cast_link_node['href'] if cast_link_node
+
+      if cast_link.nil?
+        []
+      else
+        request = NetFlix::Request.new(:url => cast_link)
+        response = request.send
+        from_xml(response)
+      end
+    end
+  end
+end

data/lib/net_flix/builders/title_builder.rb

@@ -0,0 +1,66 @@
+class TitleBuilder
+
+  def self.from_xml(xml)
+    return [] unless xml
+
+    nxml = Nokogiri.XML(xml)
+    
+    titles(nxml).map do |data|
+      TitleBuilder.new(data).title
+    end
+  end
+
+  def self.titles(noko_xml)
+    titles = noko_xml.xpath('//catalog_title')
+    titles.empty? ? noko_xml.xpath('//title_index_item') : titles 
+  end
+
+  def initialize(data)
+    @data = data
+    @title = NetFlix::Title.new
+
+    set_actors
+    set_delivery_formats
+    set_genres
+    set_id
+    set_release_year
+    set_title
+    set_web_page
+  end
+
+  def set_id
+    node = @data.search('id').first
+    @title.id = node.content if node
+  end
+
+  def set_release_year
+    node = @data.search('release_year').first
+    @title.release_year = node.content if node
+  end
+
+  def set_title
+    node = @data.search('title').first
+    @title.title = node['regular'] || node.content if node
+  end
+
+  def set_web_page
+    node = @data.search('link[@title="web page"]').first
+    @title.web_page = node['href'] if node
+  end
+
+  def set_delivery_formats
+    @title.delivery_formats = FormatBuilder.from_movie(@data)
+  end
+
+  def set_genres
+    @title.genres = @data.search('category[@scheme="http://api.netflix.com/categories/genres"]').map{|f| f['label'] }
+  end
+
+  def set_actors
+    @title.actors = ActorBuilder.from_movie(@data)
+  end
+
+  def title
+    @title
+  end
+end

data/lib/net_flix/credentials.rb

@@ -0,0 +1,37 @@
+module NetFlix
+  class Credentials < Valuable
+
+    CONFIG_FILENAME = File.join( File.dirname(__FILE__), '..', '..', 'credentials.yml')
+    
+    has_value :key
+    has_value :secret
+    has_value :access_token
+    
+    def valid?
+      (key && secret) != nil
+    end
+    
+    class << self
+
+      def from_file
+        new(config_file_exists? ? YAML.load(File.open(CONFIG_FILENAME)) : {}) 
+      end
+
+      def config_file_exists?
+        File.exist? CONFIG_FILENAME
+      end
+
+    end # class methods
+
+    def to_file!
+      credentials_store = File.new(CONFIG_FILENAME, 'w')
+      credentials_store.puts(self.to_yaml)
+      credentials_store.close
+    end
+
+    def to_yaml
+      attributes.to_yaml
+    end
+  end
+
+end

data/lib/net_flix/request.rb

@@ -0,0 +1,56 @@
+module NetFlix
+  class Request < Valuable
+ 
+    RESERVED_CHARACTERS = /[^A-Za-z0-9\-\._~]/
+
+    has_value :http_method, :default => 'GET'
+    has_value :url, :default => 'http://api.netflix.com/catalog/titles/index'
+    has_value :parameters, :klass => HashWithIndifferentAccess, :default => {}
+
+    def ordered_keys
+      parameters.keys.sort
+    end
+
+    def parameter_string
+      string = ordered_keys.map do |key|
+        "#{key}=#{parameters[key]}"
+      end.join('&')
+    end
+
+    def authenticator
+      @auth ||= NetFlix::Authenticator.new(:request => self, :credentials => NetFlix.credentials)
+    end
+
+    def target
+      URI.parse "#{url}?#{parameter_string}"
+    end
+
+    def log
+      NetFlix.log(target.to_s)
+    end
+
+    def send
+      authenticator.sign!
+      log
+      Net::HTTP.get(target)
+    end
+
+    def Request.encode(value)
+      URI.escape( value, RESERVED_CHARACTERS ) if value
+    end
+
+    # validation stuff
+    has_collection :errors
+
+    def valid?
+      errors.clear
+      validate_http_method
+      errors.empty?
+    end
+
+    def validate_http_method
+      errors << "HTTP method must be POST or GET, but I got #{http_method}" unless ['POST', 'GET'].include? http_method 
+    end
+
+  end
+end

data/lib/net_flix/title.rb

@@ -0,0 +1,39 @@
+module NetFlix
+  class Title < Valuable
+
+    has_value :id
+    has_value :release_year
+    has_collection :genres
+    has_collection :actors
+    has_value :title
+    has_value :web_page
+    has_collection :delivery_formats
+
+    def to_json
+      attributes.to_json
+    end
+
+    def self.from_json(data)
+      self.new(JSON.parse(data))
+    end
+
+    def to_s
+      title || 'unknown title'
+    end
+
+    class << self
+
+      def complete_list
+        data = NetFlix::API::Catalog::Titles.index
+        TitleBuilder.from_xml(data)
+      end
+
+      def search(params)
+        data = NetFlix::API::Catalog::Titles.search(params)
+        TitleBuilder.from_xml(data)
+      end
+
+    end
+  end # class Title
+end # module NetFlix
+

data/lib/net_flix.rb

@@ -0,0 +1,28 @@
+module NetFlix
+
+  class << self
+	  
+    def credentials
+      @credentials ||= NetFlix::Credentials.from_file 
+    end
+  
+    def logfile
+      File.join( File.dirname(__FILE__), '..', 'log', 'netflix.log' )
+    end
+
+    def create_logger
+      logdir = File.join( File.dirname(__FILE__), '..', 'log' )
+      Dir.mkdir(logdir) unless File.exists? logdir
+
+      Logger.new( logfile ) 
+    end
+
+    def logger
+      @logger ||= create_logger 
+    end
+
+    def log(message)
+      NetFlix.logger.info("[#{Time.now.to_i}] #{message}")
+    end  
+  end # class methods
+end