howkast 0.0.0

data/sample/quickstart.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'yaml'
+begin
+  require 'howkast'
+rescue LoadError
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'howkast'
+end
+
+# configure
+Howkast::configure YAML.load File.read('.howkast')
+
+# create instance
+howcast = Howkast::API.new
+
+# alternative instantiation
+# howcast = Howkast::API.new :api_key => 'YOUR-HOWCAST-API-KEY'
+
+# search for jujitsu how-to videos
+search = howcast.search :query => 'jujitsu'
+
+# get detail for the first video listed in the search
+video_id = search.videos.first.id
+video    = howcast.video :id => video_id
+puts video.title
+puts video.embed
+
+# find out what other videos where uploaded by the same user
+username = video.username
+user     = howcast.user :id => username, :resource => :videos
+puts user.title
+user.videos.each do |video|
+  puts "- #{video.id}\t#{video.title}"
+end
+
+# list user's favorite videos
+user = howcast.user :id => username, :resource => :favorites
+puts user.title
+user.videos.each do |video|
+  puts "- #{video.id}\t#{video.title}\t#{video.description}"
+end
+
+# list user's playlists
+user = howcast.user :id => username, :resource => :playlists
+puts user.title
+user.playlists.each do |video|
+  puts "- #{video.id}\t#{video.title}"
+end
+
+# list available categories
+categories = howcast.categories
+categories.each do |category|
+  puts "#{category.id}\t#{category.name}"
+end
+
+# get details about a category
+category = howcast.category :id => categories.first.id
+puts category.name
+category.subcategories.each do |category|
+  puts "- #{category.id}\t#{category.name}"
+end
+
+# list the videos in a playlist
+playlist = howcast.playlist :id => '4261'
+puts playlist.title
+puts playlist.description
+playlist.videos.each do |video|
+  puts "- #{video.id}\t#{video.title}"
+end

data/spec/howkast/api_service_spec.rb

@@ -0,0 +1,120 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Howkast::API::service" do
+  before :all do
+    @config ||= YAML.load File.read(File.expand_path(File.dirname(__FILE__) + '/../../.howkast'))
+    Howkast::configure @config
+    @howcast = Howkast::API.new
+  end
+  
+  it "should be able to list supported services" do
+    services = Howkast::API.services
+    services.should be_an_instance_of Array
+    services.should_not be_empty
+  end
+  
+  it "should provide implementation for the services it supports" do
+    services = Howkast::API.services
+    services.should be_an_instance_of Array
+    services.should_not be_empty
+    howcast = Howkast::API.new
+    services.each do |service|
+      howcast.should respond_to service
+    end
+  end
+  
+  # service :category,
+  #   processor: :categories,
+  #     options: { :required => :id }
+  it "should raise an error if the category contract is broken" do
+    ->{ @howcast.category :id => :id }.should_not raise_error ArgumentError
+    
+    ->{ @howcast.category }.should raise_error ArgumentError
+    ->{ @howcast.category :x => :x }.should raise_error ArgumentError
+    ->{ @howcast.category :x }.should raise_error ArgumentError
+    ->{ @howcast.category :x, { :x => :x } }.should raise_error ArgumentError
+    ->{ @howcast.category :x, { :id => :id } }.should raise_error ArgumentError
+  end
+  
+  # service :categories
+  it "should raise an error if the categories contract is broken" do
+    ->{ @howcast.categories }.should_not raise_error ArgumentError
+    
+    ->{ @howcast.categories :x }.should raise_error ArgumentError
+    ->{ @howcast.categories :x => :x }.should raise_error ArgumentError
+    ->{ @howcast.categories :x, { :x => :x } }.should raise_error ArgumentError
+    ->{ @howcast.categories :x => :x }.should raise_error ArgumentError
+  end
+  
+  # service :search, 
+  #    options: { :required => :query, :optional => { :view => :video } }
+  it "should raise an error if the search contract is broken" do
+    ->{ @howcast.search :query =>:query }.should_not raise_error ArgumentError
+    
+    ->{ @howcast.search }.should raise_error ArgumentError
+    ->{ @howcast.search :x =>:x }.should raise_error ArgumentError
+    ->{ @howcast.search :x }.should raise_error ArgumentError
+    ->{ @howcast.search :x, { :x => :x } }.should raise_error ArgumentError
+    ->{ @howcast.search :x, { :query => :query } }.should raise_error ArgumentError
+  end
+
+  # service :playlist,
+  #   processor: :playlists,
+  #     options: { :required => :id }
+  it "should raise an error if the playlist contract is broken" do
+    ->{ @howcast.playlist :id => :id }.should_not raise_error ArgumentError
+    
+    ->{ @howcast.playlist }.should raise_error ArgumentError
+    ->{ @howcast.playlist :x }.should raise_error ArgumentError
+    ->{ @howcast.playlist :x, { :x => :x } }.should raise_error ArgumentError
+    ->{ @howcast.playlist :x, { :id => :id } }.should raise_error ArgumentError
+  end
+  
+  
+  # service :video,
+  #   processor: :videos,
+  #     options: { :required => :id }
+  it "should raise an error if the video contract is broken" do
+    ->{ @howcast.video :id => :id }.should_not raise_error ArgumentError
+    
+    ->{ @howcast.video }.should raise_error ArgumentError
+    ->{ @howcast.video :x => :x }.should raise_error ArgumentError
+    ->{ @howcast.video :x }.should raise_error ArgumentError
+    ->{ @howcast.video :x, { :x => :x } }.should raise_error ArgumentError
+    ->{ @howcast.video :x, { :id => :id } }.should raise_error ArgumentError
+  end
+  
+  
+  # service :videos,
+  #     options: { :required => [ :sort, :filter ],
+  #                :optional => [ :category, :page ] }
+  it "should raise an error if the videos contract is broken" do
+    ->{ @howcast.videos :sort => :sort, :filter => :filter }.should_not raise_error ArgumentError
+    ->{ @howcast.videos :sort => :sort, :filter => :filter, :category => :category }.should_not raise_error ArgumentError
+    ->{ @howcast.videos :sort => :sort, :filter => :filter, :page => :page }.should_not raise_error ArgumentError
+    ->{ @howcast.videos :sort => :sort, :filter => :filter, :category => :category, :page => :page }.should_not raise_error ArgumentError
+
+    ->{ @howcast.videos :sort => :sort }.should raise_error ArgumentError
+    ->{ @howcast.videos :filter => :filter }.should raise_error ArgumentError
+    ->{ @howcast.videos }.should raise_error ArgumentError
+    ->{ @howcast.videos :x }.should raise_error ArgumentError
+    ->{ @howcast.videos :x => :x }.should raise_error ArgumentError
+    ->{ @howcast.videos :x, { :x => :x } }.should raise_error ArgumentError
+    ->{ @howcast.videos :x, { :sort => :sort, :filter => :filter } }.should raise_error ArgumentError
+  end
+  
+  # service :user,
+  #   processor: :users,
+  #     options: { :required => [ :id, :resource ] }
+  it "should raise an error if the user contract is broken" do
+    ->{ @howcast.user :id => :id, :resource => :resource }.should_not raise_error ArgumentError
+
+    ->{ @howcast.user :id => :id }.should raise_error ArgumentError
+    ->{ @howcast.user :resource => :resource }.should raise_error ArgumentError
+    ->{ @howcast.user }.should raise_error ArgumentError
+    ->{ @howcast.user :x }.should raise_error ArgumentError
+    ->{ @howcast.user :x => :x }.should raise_error ArgumentError
+    ->{ @howcast.user :x, { :x => :x } }.should raise_error ArgumentError
+    ->{ @howcast.user :x, { :id => :id, :resource => :resource } }.should raise_error ArgumentError
+  end
+end

data/spec/howkast/api_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Howkast::API" do
+  API_KEY1 = '6c6d1613339399efd0bc74fe12b14dd370b3ac76'
+  API_KEY2 = 'bec946eaa53dc4e0527b28917f318fcd70b3ac76'
+  
+  before :all do
+    @config ||= YAML.load File.read(File.expand_path(File.dirname(__FILE__) + '/../../.howkast'))
+    Howkast::configure @config
+    @howcast = Howkast::API.new
+  end
+  
+  it "should honor configuration" do
+    Howkast::configure :api_key => API_KEY1
+    howcast = Howkast::API.new
+    howcast.configuration.api_key.should eql API_KEY1
+  end
+
+  it "should be able to override configuration" do
+    Howkast::configure :api_key => API_KEY1
+    howcast = Howkast::API.new api_key: API_KEY2
+    howcast.configuration.api_key.should eql API_KEY2
+  end
+end

data/spec/howkast/model_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Howkast::Model" do
+  before :each do
+    @foo      = 'Foo'
+    @foo_data = { x: 1, y: 2, z: 3 }
+    
+    @bar      = 'Bar'
+    @bar_data = { x: 1, y: 2, z: 3, foo: @foo_data }
+
+    @zoo      = 'Zoo'
+    @zoo_data = { x: 1, y: 2, z: 3, foo: @foo_data, bar: @bar_data }
+  end
+  
+  it "should be able to create model types" do
+    klass = Howkast::Model.synthesize(@foo, @foo_data)
+    klass.should eql Howkast::Model::Foo
+    klass.public_instance_methods.should include :instance_attributes
+  end
+
+  it "should be able to create model instances" do
+    klass = Howkast::Model.synthesize(@foo, @foo_data)
+    foo   = klass.new(self, @foo_data)
+    foo.should be_an_instance_of Howkast::Model::Foo
+    foo.should respond_to :instance_attributes
+    @foo_data.keys.each do |attr|
+      foo.should respond_to attr
+    end
+  end
+
+  it "should be able to append more attributes to an existing model type" do
+    klass = Howkast::Model.synthesize(@foo, @foo_data)
+    foo   = klass.new(self, @foo_data)
+    foo.should be_an_instance_of Howkast::Model::Foo
+    @foo_data.keys.each do |attr|
+      foo.should respond_to attr
+    end
+    
+    klass = Howkast::Model.synthesize(@foo, @bar_data)
+    foo   = klass.new(self, { })
+    foo.should be_an_instance_of Howkast::Model::Foo
+    @foo_data.merge(@bar_data).keys.each do |attr|
+      foo.should respond_to attr
+    end
+  end
+  
+  it "should be able to parse a String value and convert it to an appropriate type" do
+    Howkast::Model.parse("String").should be_an_instance_of String
+    Howkast::Model.parse("1x").should be_an_instance_of String
+    Howkast::Model.parse("1").should be_an_instance_of Fixnum
+    Howkast::Model.parse("11111111").should be_an_instance_of Fixnum
+    Howkast::Model.parse("+1").should be_an_instance_of Fixnum
+    Howkast::Model.parse("-1").should be_an_instance_of Fixnum
+    Howkast::Model.parse("0.1x").should be_an_instance_of Float
+    Howkast::Model.parse("0.1").should be_an_instance_of Float
+    Howkast::Model.parse("0.111111").should be_an_instance_of Float
+    Howkast::Model.parse("+0.1").should be_an_instance_of Float
+    Howkast::Model.parse("-0.1").should be_an_instance_of Float
+    Howkast::Model.parse("+0.1111111").should be_an_instance_of Float
+    Howkast::Model.parse("-0.1111111").should be_an_instance_of Float
+    Howkast::Model.parse("true").should be_an_instance_of TrueClass
+    Howkast::Model.parse("True").should be_an_instance_of TrueClass
+    Howkast::Model.parse("TRUE").should be_an_instance_of TrueClass
+    Howkast::Model.parse("false").should be_an_instance_of FalseClass
+    Howkast::Model.parse("False").should be_an_instance_of FalseClass
+    Howkast::Model.parse("FALSE").should be_an_instance_of FalseClass
+    Howkast::Model.parse("Sun, 3 Jul 2008 20:00:39 -0700").should be_an_instance_of Time
+    Howkast::Model.parse("Mon, 14 Jul 2008 20:00:39 -0700").should be_an_instance_of Time
+    Howkast::Model.parse("Wed Dec 29 12:21:32 PST 2010").should be_an_instance_of Time
+    Howkast::Model.parse("Wed Dec  1 12:21:32 PST 2010").should be_an_instance_of Time
+    Howkast::Model.parse("Wed Dec 7 12:21:32 PST 2010").should be_an_instance_of Time
+  end
+end

data/spec/howkast/processors/categories_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Howkast::Processor::Categories" do
+  before :all do
+    @config ||= YAML.load File.read(File.expand_path(File.dirname(__FILE__) + '/../../../.howkast'))
+    Howkast::configure @config
+    @howcast = Howkast::API.new
+  end
+  
+  it "should raise an error if given a non-valid category ID" do
+    ->{ @howcast.category :id => '9999999999999999999999999' }.should \
+      raise_error Howkast::Error::RequestError
+  end
+
+  it "should return a Category object given a valid category ID" do
+    category = @howcast.category :id => 1105
+    category.should be_an_instance_of Howkast::Model::Category
+  end
+
+  it "should return an array of Category objects" do
+    list = @howcast.categories
+    list.should be_an_instance_of Array
+    list.each do |entry| 
+      entry.should be_an_instance_of Howkast::Model::Category
+    end
+  end
+end

data/spec/howkast/processors/playlists_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Howkast::Processor::Playlists" do
+  before :all do
+    @config ||= YAML.load File.read(File.expand_path(File.dirname(__FILE__) + '/../../../.howkast'))
+    Howkast::configure @config
+    @howcast = Howkast::API.new
+  end
+  
+  it "should raise an error if given a non-valid playlist ID" do
+    ->{ @howcast.playlist :id => '9999999999999999999999999' }.should \
+      raise_error Howkast::Error::RequestError
+  end
+
+  it "should return a Playlist object given a valid playlist ID" do
+    playlist = @howcast.playlist :id => 4261
+    playlist.should be_an_instance_of Howkast::Model::Playlist
+    playlist.should respond_to :videos
+    list = playlist.videos
+    list.should be_an_instance_of Array
+    list.should_not be_empty
+    list.each do |entry|
+      entry.should be_an_instance_of Howkast::Model::Video
+    end
+  end
+end

data/spec/howkast/processors/search_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Howkast::Processor::Search" do
+  before :all do
+    @config ||= YAML.load File.read(File.expand_path(File.dirname(__FILE__) + '/../../../.howkast'))
+    Howkast::configure @config
+    @howcast = Howkast::API.new
+  end
+  
+  it "should always return a Search object" do
+    %w{ howcast kreektrebano }.each do |query|
+      search = @howcast.search :query => query
+      search.should be_an_instance_of Howkast::Model::Search
+      search.should respond_to :videos
+      search.should respond_to :title
+      (search.title =~ /#{query}/u).should_not be nil
+      list = search.videos
+      list.should be_an_instance_of Array
+      list.should_not be_empty if query == 'howcast'
+      list.should be_empty     if query == 'kreektrebano'
+      list.each do |entry|
+        entry.should be_an_instance_of Howkast::Model::Video
+      end
+    end
+  end
+end

data/spec/howkast/processors/users_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Howkast::Processor::Users" do
+  before :all do
+    @config ||= YAML.load File.read(File.expand_path(File.dirname(__FILE__) + '/../../../.howkast'))
+    Howkast::configure @config
+    @howcast   = Howkast::API.new
+    @resources = %w{ videos favorites playlists }
+  end
+
+  it "should raise an error if given a non-valid user ID" do
+    ->{ @howcast.user :id => 'kreektrebano', :resource => :videos }.should \
+      raise_error Howkast::Error::RequestError
+  end
+
+  it "should raise an error if given an unrecognized resource" do
+    ->{ @howcast.user :id => 'jurisgalang', :resource => :jurisgalang }.should \
+      raise_error Howkast::Error::RequestError
+  end
+
+  it "should return a User object given a valid user ID" do
+    user = @howcast.user :id => 'jurisgalang', :resource => :videos
+    user.should be_an_instance_of Howkast::Model::User
+  end
+
+  it "should return a User object with the appropriate resource attribute" do
+    @resources.each do |resource|
+      user = @howcast.user :id => 'howcast', :resource => resource
+      user.should be_an_instance_of Howkast::Model::User
+      
+      examine = ->(resource, attribute, model) do
+        list = user.send(attribute)
+        list.should be_an_instance_of Array
+        list.should_not be_empty
+        list.each do |entry|
+          entry.should be_an_instance_of model
+        end
+      end
+      
+      args = case resource
+      when 'videos', 'favorites'
+        [resource, :videos, Howkast::Model::Video]
+      when 'playlists'
+        [resource, :playlists, Howkast::Model::Playlist]
+      else
+        fail 'dude, you messed up!'
+      end
+      examine[*args]
+    end
+  end
+end

data/spec/howkast/processors/videos_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Howkast::Processor::Videos" do
+  before :all do
+    @config ||= YAML.load File.read(File.expand_path(File.dirname(__FILE__) + '/../../../.howkast'))
+    Howkast::configure @config
+    @howcast = Howkast::API.new
+  end
+
+  it "should raise an error if given a non-valid video ID" do
+    ->{ @howcast.video :id => '9999999999999999999999999' }.should \
+    raise_error Howkast::Error::RequestError
+  end
+
+  it "should return a Video object given a valid video ID" do
+    video = @howcast.video :id => 6570
+    video.should be_an_instance_of Howkast::Model::Video
+  end
+
+  it "should return an array of Video objects" do
+    categories = @howcast.categories.map{ |category| category.permalink.split('/').last }
+    categories = categories[0 .. 9]
+    categories << nil
+    categories.each do |category|
+      %w{ most_viewed most_recent top_rated }.each do |sort|
+        %w{ all howcast_studios }.each do |filter|
+          opts = { :sort => sort, :filter => filter }
+          opts[:category] = category unless category.nil?
+          list = @howcast.videos opts
+          list.should be_an_instance_of Array
+          list.each do |entry| 
+            entry.should be_an_instance_of Howkast::Model::Video
+          end
+        end
+      end
+    end
+  end
+end