flix4r 0.2.3

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brian Dunn
+
+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.rdoc

@@ -0,0 +1,39 @@
+=Flix4r
+===a ruby client for the NetFlix API
+
+this is a gemification of the google code project found here: "http://code.google.com/p/flix4r/"
+
+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 Usage
+  >> 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"]
+
+===Movie Retrival
+more data on each title is available through the NetFlix::Title#movie method. continuing the above example:
+  >> sneakers.movie.synopsis
+  => "Shadowy U.S. intelligence agents blackmail <a href=\"http://www.netflix.com/RoleDisplay/Robert_Redford/76851\">Robert Redford</a> and his eccentric team of security experts into stealing a code-breaking \"black box\" from a Soviet-funded genius. But Redford uncovers a bigger conspiracy, and he and his \"sneakers\" (<a href=\"http://www.netflix.com/RoleDisplay/Sidney_Poitier/74185\">Sidney Poitier</a>, <a href=\"http://www.netflix.com/RoleDisplay/Dan_Aykroyd/4025\">Dan Aykroyd</a>, <a href=\"http://www.netflix.com/RoleDisplay/River_Phoenix/73423\">River Phoenix</a> and <a href=\"http://www.netflix.com/RoleDisplay/David_Strathairn/89582\">David Strathairn</a>) must save themselves and the world economy by stealing the box back from the blackmailers."
+
+==NetFlix vs Netflix
+The great Panda has pointed out to me that the official name is Netflix. meh.= flix4r

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "flix4r"
+    gem.summary = %Q{a port of the google code project: http://code.google.com/p/flix4r/}
+    gem.email = "brianpatrickdunn@gmail.com"
+    gem.homepage = "http://github.com/briandunn/flix4r"
+    gem.authors = ["Brian Dunn"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  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.2.4

data/flix4r.gemspec

@@ -0,0 +1,75 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{flix4r}
+  s.version = "0.2.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Dunn"]
+  s.date = %q{2009-10-05}
+  s.email = %q{brianpatrickdunn@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "flix4r.gemspec",
+     "init.rb",
+     "lib/flix4r.rb",
+     "lib/net_flix.rb",
+     "lib/net_flix/authenticator.rb",
+     "lib/net_flix/builders/actor_builder.rb",
+     "lib/net_flix/builders/format_builder.rb",
+     "lib/net_flix/credentials.rb",
+     "lib/net_flix/movie.rb",
+     "lib/net_flix/request.rb",
+     "lib/net_flix/television.rb",
+     "lib/net_flix/title.rb",
+     "lib/valuable.rb",
+     "test/actor_builder_test.rb",
+     "test/authenticator_test.rb",
+     "test/credentials_test.rb",
+     "test/fixtures/autocomplete.xml",
+     "test/fixtures/cast.xml",
+     "test/fixtures/directors.xml",
+     "test/fixtures/movies.xml",
+     "test/fixtures/synopsis.xml",
+     "test/fixtures/titles.xml",
+     "test/format_builder_test.rb",
+     "test/movie_test.rb",
+     "test/request_test.rb",
+     "test/test_helper.rb",
+     "test/title_test.rb"
+  ]
+  s.homepage = %q{http://github.com/briandunn/flix4r}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{a port of the google code project: http://code.google.com/p/flix4r/}
+  s.test_files = [
+    "test/actor_builder_test.rb",
+     "test/authenticator_test.rb",
+     "test/credentials_test.rb",
+     "test/format_builder_test.rb",
+     "test/movie_test.rb",
+     "test/request_test.rb",
+     "test/test_helper.rb",
+     "test/title_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require File.join( File.dirname(__FILE__), 'lib', 'flix4r' )
+NetFlix::Credentials.config_file_name = File.join( RAILS_ROOT, 'config', 'netflix.yml' )

data/lib/flix4r.rb

@@ -0,0 +1,22 @@
+
+this_dir = File.dirname(__FILE__)
+
+  require 'rubygems'
+  require 'activesupport'
+  require 'open-uri'
+  require 'yaml'
+  require 'hmac-sha1'
+  require 'json'
+  require 'net/http'
+  require 'ftools'
+  require 'nokogiri'
+  require 'crack'
+  gem 'mloughran-api_cache'
+  require 'api_cache'
+  require File.join( this_dir, 'valuable' )
+
+  builders = File.join( this_dir, 'net_flix', 'builders')
+
+  ActiveSupport::Dependencies.load_paths << this_dir
+  ActiveSupport::Dependencies.load_paths << builders 
+

data/lib/net_flix.rb

@@ -0,0 +1,36 @@
+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 ||= defined?(Rails) ? RAILS_DEFAULT_LOGGER : create_logger 
+    end
+
+    def log_requests?
+      @log_requests
+    end
+
+    def log_requests= bool=true
+      @log_requests = bool 
+    end
+
+    def log(message)
+      NetFlix.logger.info("[#{Time.now.to_i}] #{message}") if log_requests?  
+    end  
+  end # class methods
+end

data/lib/net_flix/authenticator.rb

@@ -0,0 +1,78 @@
+module NetFlix
+  class Authenticator < Valuable
+
+    has_value :request
+    has_value :nonce, :default => rand(1_000_000)
+    has_value :credentials
+
+    def access_token
+      credentials.access_token
+    end
+
+    def timestamp=stamp
+      @timestamp=stamp
+    end
+
+    def timestamp 
+      @timestamp ||= Time.now.to_i
+    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.merge!(authentication_parameters)
+    end
+
+    def add_signature!
+      sign = {'oauth_signature' => Request.encode(signature)}
+      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/credentials.rb

@@ -0,0 +1,41 @@
+module NetFlix
+  class Credentials < Valuable
+
+    @@config_file_name = 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 config_file_name= file_name
+        @@config_file_name = file_name
+      end
+
+      def from_file
+        new(config_file_exists? ? YAML.load(File.open(@@config_file_name)) : {}) 
+      end
+
+      def config_file_exists?
+        File.exist? @@config_file_name
+      end
+
+    end # class methods
+
+    def to_file!
+      credentials_store = File.new(@@config_file_name, 'w')
+      credentials_store.puts(self.to_yaml)
+      credentials_store.close
+    end
+
+    def to_yaml
+      attributes.to_yaml
+    end
+  end
+
+end