howcast 0.7.4 → 0.7.15

data/lib/howcast/client/category.rb

@@ -24,6 +24,8 @@
 class Howcast::Client
   class Category
     extend WatchAttrAccessors
+    include XmlMethods
+
     attr_accessor :id, :name, :parent_id, :parents, :permalink
     
     # Creates a new Category object which is used to encapsulate all the attributes available
@@ -84,21 +86,37 @@ class Howcast::Client
   # Get the top level Howcast categories
   #   Howcast::Client.new.categories
   def categories(options = {})
-    uri = "categories.xml"
-    establish_connection(uri).at('categories').children_of_type('category').inject([]){ |r, i| r << parse_single_category_xml(i)}
+    fetch_categories.at('categories').children_of_type('category').inject([]){ |r, i| r << parse_single_category_xml(i) }
 	end
   
+  def category_id_for key
+    fetch_categories do |categories|
+      node       = (categories/"//category/name[text-downcase()='#{key.downcase}']/../permalink")
+      node       = (categories/"//category/permalink[text-downcase()*='#{key.downcase}']") if node.empty?
+      node.text.split("/").last unless node.empty?
+    end
+  end
+  
   private
-    # Exception here to parse the <parents> tag in a category, will set a category.parents variable
-    # which is an array of parent metadata hases
-    # [{:id => '123', :name => "root"}, {:id => "1234", :name => "parent"}]
-    def parse_single_category_xml(xml)
-      hash = {}
-      Category.attr_accessors.each do |attribute|
-        node_name = attribute.to_s.gsub("_", "-") # xml schema uses hyphens for spaces, but ruby uses underscores
-        hash[attribute] = !xml.at(node_name).nil? ? xml.at(node_name).inner_text.strip : ""
-      end
-      hash[:parents] = (xml.at('parents')/:category).map{ |c| {:id => c.at('id').inner_text.strip, :name => c.at('name').inner_text.strip, :permalink => c.at('permalink').inner_text.strip }} unless xml.at('parents').nil?
-      hash.values.all?{|v| v==""} ? nil : Category.new(hash)
+  def fetch_categories
+    @categories ||= establish_connection("categories.xml")
+    if block_given?
+      yield @categories
+    else
+      @categories
     end
+  end
+  
+  # Exception here to parse the <parents> tag in a category, will set a category.parents variable
+  # which is an array of parent metadata hases
+  # [{:id => '123', :name => "root"}, {:id => "1234", :name => "parent"}]
+  def parse_single_category_xml(xml)
+    hash = {}
+    Category.attr_accessors.each do |attribute|
+      node_name = attribute.to_s.gsub("_", "-") # xml schema uses hyphens for spaces, but ruby uses underscores
+      hash[attribute] = !xml.at(node_name).nil? ? xml.at(node_name).inner_text.strip : ""
+    end
+    hash[:parents] = (xml.at('parents')/:category).map{ |c| {:id => c.at('id').inner_text.strip, :name => c.at('name').inner_text.strip, :permalink => c.at('permalink').inner_text.strip }} unless xml.at('parents').nil?
+    hash.values.all?{|v| v==""} ? nil : Category.new(hash)
+  end
 end

data/lib/howcast/client/homepage.rb

@@ -24,6 +24,8 @@
 class Howcast::Client
   class Homepage
     extend WatchAttrAccessors
+    include XmlMethods
+    
     attr_accessor :videos, :playlists
     
     # Creates a new Homepage object which is used to encapsulate all the attributes available
@@ -65,12 +67,12 @@ class Howcast::Client
   end
   
   private
-    def parse_playlists(xml)
-      playlists = []
-      node = xml.at('playlists')
-      node.children_of_type('playlist').each do |child|
-        playlists << parse_single_xml(child, Playlist)
-      end unless node.nil?
-      playlists
-    end
+  def parse_playlists(xml)
+    playlists = []
+    node = xml.at('playlists')
+    node.children_of_type('playlist').each do |child|
+      playlists << parse_single_xml(child, Playlist)
+    end unless node.nil?
+    playlists
+  end
 end

data/lib/howcast/client/marker.rb

@@ -24,6 +24,8 @@
 class Howcast::Client
   class Marker
     extend WatchAttrAccessors
+    include XmlMethods
+    
     attr_accessor :id, :position, :timemarker, :type, :thumbnail_url, :title, :textile_text, :text
     
     # Creates a new Marker object which is used to encapsulate all the attributes available

data/lib/howcast/client/playlist.rb

@@ -24,6 +24,8 @@
 class Howcast::Client
   class Playlist
     extend WatchAttrAccessors
+    include XmlMethods
+    
     attr_accessor :id, :title, :description, :playlist_thumbnail_url, :videos
     
     # Creates a new Playlist object which is used to encapsulate all the attributes available

data/lib/howcast/client/search.rb

@@ -71,16 +71,16 @@ class Howcast::Client
   end
 
   private
-    def do_search params
-      uri = search_url params
-      (establish_connection(uri)/:video).inject([]){ |r, i| r << parse_single_xml(i, Video)}
-    end
+  def do_search params
+    uri = search_url params
+    (establish_connection(uri)/:video).inject([]){ |r, i| r << parse_single_xml(i, Video)}
+  end
 
-    def search_url params
-      uri = "search.xml?"
-      params[:q] = CGI.escape params[:q] if params[:q]
-      uri += hash_to_params params
-      uri += uri_suffix(params.merge(:use_ampersand => true)) unless params[:page]
-      uri
-    end
+  def search_url params
+    uri    = "search.xml?"
+    params = params.inject({}){ |h, (k, v)| h[k] = CGI::escape(v.to_s); h }
+    uri   += hash_to_params params
+    uri   += uri_suffix(params.merge(:use_ampersand => true)) unless params[:page]
+    uri
+  end
 end

data/lib/howcast/client/type.rb

@@ -0,0 +1,48 @@
+#--
+# Copyright (c) 2010 Howcast Media Inc.
+#
+# 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.
+#++
+
+class Howcast::Client
+  class Type
+    extend WatchAttrAccessors
+    include XmlMethods
+    
+    attr_accessor :kind, :status, :name
+    
+    # Creates a new Type object which is used to encapsulate all the attributes available
+    # from the Howcast Video API.
+    #
+    # === Inputs
+    #
+    # * <tt>attributes</tt> -- A hash to set the various attributes of the marker object
+    #
+    # === Examples
+    # 
+    # Initialize a type
+    #   Type.new :name => "HowcastGuide", :kind => "HowcastOriginalGuide", :status => "proprietary"
+    def initialize(attributes={})
+      attributes.each do |k, v|
+        self.send("#{k}=", v) if self.respond_to?(k)
+      end
+    end
+  end
+end

data/lib/howcast/client/user.rb

@@ -24,6 +24,8 @@
 class Howcast::Client
   class User
     extend WatchAttrAccessors
+    include XmlMethods
+    
     attr_accessor :login, :firstname, :lastname, :thumbnail_url, :views, :count, :videos
     
     # Creates a new User object which is used to encapsulate all the attributes available

data/lib/howcast/client/utils.rb

@@ -0,0 +1,53 @@
+# utility modules for models (eg: video, marker, etc)
+
+module WatchAttrAccessors
+  def attr_accessor(*args)
+    super(*args)
+    @attr_accessors ||= []
+    @attr_accessors += args
+  end
+
+  def attr_accessors
+    @attr_accessors || []
+  end
+end
+
+module XmlMethods
+  def to_doc
+    doc  = Nokogiri::XML::Document.new
+    node = Nokogiri::XML::Node.new(self.class.to_s.sub(/([a-z]+::)+/i, '').downcase, doc)
+    root = doc.add_child node
+    self.class.attr_accessors.each do |attr|
+      node  = Nokogiri::XML::Node.new("#{attr}", doc)
+      value = self.send(attr)
+      if value.instance_of? String
+        value = inflect(attr, value) if respond_to? :inflect
+        if value.instance_of? String
+          node.content = value
+        else
+          node.add_child value
+        end
+        root.add_child node
+      elsif value.respond_to? :to_doc
+        node = value.to_doc.root
+        root.add_child node
+      elsif value.instance_of? Array
+        value.each do |v|
+          if v.respond_to? :to_doc
+            node.add_child v.to_doc.root
+          else
+            child = Nokogiri::XML::Node.new("#{attr}".singularize, doc)
+            child.content = v.to_s
+            node.add_child child
+          end
+        end
+        root.add_child node
+      end
+    end
+    doc
+  end
+  
+  def to_xml
+    to_doc.to_xml
+  end
+end

data/lib/howcast/client/video.rb

@@ -22,24 +22,14 @@
 #++
 
 class Howcast::Client
-  module WatchAttrAccessors
-    def attr_accessor(*args)
-      super(*args)
-      @attr_accessors ||= []
-      @attr_accessors += args
-    end
-  
-    def attr_accessors
-      @attr_accessors || []
-    end
-  end
-  
   class Video
     extend WatchAttrAccessors
-    attr_accessor :id, :title, :permalink, :thumbnail_url, :category_id, 
+    include XmlMethods
+    
+    attr_accessor :id, :title, :permalink, :thumbnail_url, :category_id,
       :views, :username, :duration, :created_at, :rating, :description, :width, :height,
       :badges, :easy_steps, :embed, :category_hierarchy, :ingredients, :markers, :related_videos,
-      :filename
+      :filename, :mature_content, :ads_allowed, :playlist_memberships, :type
 
     # Creates a new Video object which is used to encapsulate all the attributes available
     # from the Howcast Video API
@@ -57,11 +47,34 @@ class Howcast::Client
         self.send("#{k}=", v) if self.respond_to?(k)
       end
     end
-    
+
     # Return true if the video contains easy step by step directions, else false
     def easy_steps?
       easy_steps == "true"
     end
+    
+    def mature_content?
+      mature_content == "true"
+    end
+    
+    def ads_allowed?
+      ads_allowed == "true"
+    end
+
+    def to_param
+      id
+    end
+
+    protected
+    def inflect attr, value
+      if %w{ ads_allowed mature_content easy_steps }.include? "#{attr}"
+        (value.empty? ? false : value).to_s
+      elsif "#{attr}" == "embed"
+        Nokogiri::XML(value).root
+      else
+        value.to_s
+      end
+    end
   end
     
   # Provides access to the Howcast video API.
@@ -108,15 +121,16 @@ class Howcast::Client
   #   Howcast::Client.new.videos
   # Get the third page of top favorites which are featured
   #   Howcast::Client.new.videos(:page => 3, :sort => "top_favorites", :filter => "top_rated")
-	def videos(options = {})
+  def videos(options = {})
     uri = videos_url(options)
-    (establish_connection(uri)/:video).inject([]){ |r, i| r << parse_single_xml(i, Video)}
-	end
-	
-	private
-  	def videos_url(options={})
-      defaults = {:page => nil, :sort => "most_recent", :filter => "howcast_studios", :category_id => nil}
-      options = defaults.update(options)
-      "videos/#{options[:sort]}/#{options[:filter]}#{"/#{options[:category_id]}" if options[:category_id]}#{"/#{options[:page]}" if options[:page]}.xml"
-    end
+    doc = establish_connection(uri)
+    (doc/:video).inject([]){ |r, i| r << parse_single_xml(i, Video) }
+  end
+  
+  private
+  def videos_url(options={})
+    defaults = {:page => nil, :sort => "most_recent", :filter => "howcast_studios", :category_id => nil}
+    options  = defaults.update(options)
+    "videos/#{options[:sort]}/#{options[:filter]}#{"/#{options[:category_id]}" if options[:category_id]}#{"/#{options[:page]}" if options[:page]}.xml"
+  end
 end

data/lib/howcast/ext/string.rb

@@ -0,0 +1,8 @@
+unless String.instance_methods.include? 'singularize'
+  class String
+    def singularize
+      self.gsub(/e?s\Z/, '')
+    end
+  end
+end
+

data/lib/howcast/hpricot/elements.rb

@@ -0,0 +1,22 @@
+module Hpricot
+  module Traverse
+    oper_procs =
+      {'='  => proc{ |a,b| a == b },
+       '!=' => proc{ |a,b| a != b },
+       '~=' => proc{ |a,b| a.split(/\s+/).include?(b) },
+       '|=' => proc{ |a,b| a =~ /^#{Regexp::quote b}(-|$)/ },
+       '^=' => proc{ |a,b| a.index(b) == 0 },
+       '$=' => proc{ |a,b| a =~ /#{Regexp::quote b}$/ },
+       '*=' => proc{ |a,b| idx = a.index(b) }}
+    
+    pred_n = 'text-downcase()'
+    pred_f = proc{ |ele, *_| ele.inner_text.strip.downcase }
+    
+    oper_procs.each do |oper_n, oper_f|
+      filter "#{pred_n}#{oper_n}" do |*a|
+        qual = pred_f[self, *a]
+        oper_f[qual, a[-2]] if qual
+      end
+    end
+  end
+end

data/lib/howcast/version.rb

@@ -0,0 +1,3 @@
+module Howcast
+  VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), '../../VERSION'))).chomp
+end

data/script/github-test.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'yaml'
+ 
+if ARGV.size < 1
+  puts "Usage: github-test.rb my-project.gemspec"
+  exit
+end
+
+require 'rubygems' 
+require 'rubygems/specification'
+
+data = File.read(ARGV[0])
+spec = nil
+ 
+if data !~ %r{!ruby/object:Gem::Specification}
+  Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+else
+  spec = YAML.load(data)
+end
+ 
+spec.validate
+ 
+puts spec
+puts "OK"

data/spec/howcast/client/base_spec.rb

@@ -18,8 +18,8 @@ describe Howcast::Client, "base_uri" do
     Howcast::Client.instance_variable_set :@base_uri, nil
   end
 
-  it "should use a default base_uri of www.howcast.com" do
-    Howcast::Client.base_uri.to_s.should == "http://www.howcast.com"
+  it "should use a default base_uri of api.howcast.com" do
+    Howcast::Client.base_uri.to_s.should == "http://api.howcast.com"
   end
 
   it "should allow easily setting the base_url" do

data/spec/howcast/client/category_spec.rb

@@ -20,7 +20,7 @@ describe Howcast::Client, "category" do
   end
   
   it "should establish a connection with the correct category url" do
-    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/categories/2.xml?api_key=myapikey")).and_return(category_xml)
+    @hc.should_receive(:open).with(URI.parse "http://api.howcast.com/categories/2.xml?api_key=myapikey").and_return(category_xml)
     @hc.category(2)
   end  
   
@@ -54,7 +54,7 @@ describe Howcast::Client, "categories" do
   end
   
   it "should establish a connection with categories.xml" do
-    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/categories.xml?api_key=myapikey")).and_return(categories_xml)
+    @hc.should_receive(:open).with(URI.parse "http://api.howcast.com/categories.xml?api_key=myapikey").and_return(categories_xml)
     @hc.categories
   end
   
@@ -66,3 +66,42 @@ describe Howcast::Client, "categories" do
     categories.last.name.should == 'Travel'
   end
 end
+
+describe Howcast::Client, "category_id_for" do
+  before :each do
+    @hc = Howcast::Client.new(:key => "myapikey")
+    @hc.stub!(:open).and_return(categories_xml)
+  end
+  
+  it "should be able to fetch the category id of a top-level category" do
+    @hc.category_id_for("Arts & Media").should == "1-Arts-and-Media"
+  end
+  
+  it "should be able to fetch the category id of a top-level category in a case-insensitive manner" do
+    @hc.category_id_for("arts & media").should == "1-Arts-and-Media"
+  end
+
+  it "should be able to fetch the category id of a subcategory" do
+    @hc.category_id_for("Animation Techniques").should == "6-Animation-Techniques"
+  end
+
+  it "should be able to fetch the category id of a subcategory in a case-insensitive manner" do
+    @hc.category_id_for("animation techniques").should == "6-Animation-Techniques"
+  end
+
+  it "should be able to fetch the category id given a permalink id" do
+    @hc.category_id_for("375-Asian-Cooking").should == "375-Asian-Cooking"
+  end
+
+  it "should be able to fetch the category id given a permalink id in a case-insensitive manner" do
+    @hc.category_id_for("375-asian-cooking").should == "375-Asian-Cooking"
+  end
+
+  it "should return nothing if the category name does not exist" do
+    @hc.category_id_for("This Category Does Not Exist").should be nil
+  end
+
+  it "should return nothing if the permalink id does not exist" do
+    @hc.category_id_for("99999-This-Category-Does-Not-Exist").should be nil
+  end
+end