chalkers-Revver4R 0.1.0

data/README.rdoc

@@ -0,0 +1,42 @@
+== Revver4R
+
+Revver4R is a simple Ruby interface for Revver's api.
+
+== Install
+
+  gem install chalkers-Revver4R --source http://gems.github.com
+
+== Usage
+Here's how to pull 1 quicktime video with the tag ruby
+
+  require 'Revver4R'
+  video_search = Revver4R::VideoSearch.new("qt","tag","ruby",{"limit" => 1})
+  videos = video_search.search
+  videos.each do |video|
+    puts video.to_yaml
+  end
+
+For more information at http://developer.revver.com/feeds/mrss
+
+== License
+THE MIT LICENSE
+
+Copyright (c) 2008 Andrew Chalkley
+
+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.
+
+http://creativecommons.org/licenses/MIT/
+
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('Revver4R', '0.1.0') do |p|
+  p.description    = "A simple Ruby interface for Revver's api."
+  p.url            = "http://github.com/chalkers/revver4r"
+  p.author         = "Andrew Chalkley"
+  p.email          = "andrew@chalkely.org"
+  p.ignore_pattern = ["tmp/*", "scripts/*"]
+  p.development_dependencies = ["hpricot"]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/Revver4R.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{Revver4R}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Chalkley"]
+  s.date = %q{2008-11-24}
+  s.description = %q{A simple Ruby interface for Revver's api.}
+  s.email = %q{andrew@chalkely.org}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/revver4r.rb", "README.rdoc"]
+  s.files = ["CHANGELOG", "init.rb", "lib/revver4r.rb", "Manifest", "Rakefile", "README.rdoc", "Revver4R.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/chalkers/revver4r}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Revver4R", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{revver4r}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A simple Ruby interface for Revver's api.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hpricot>, [">= 0"])
+    else
+      s.add_dependency(%q<hpricot>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<hpricot>, [">= 0"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'Revver4R'

data/lib/revver4r.rb

@@ -0,0 +1,144 @@
+# Revver4R - Revver for Ruby Library
+# Author: Andrew Chalkley (andrew@chalkley.org)
+# Copyright: 2008 Andrew Chalkley
+# License: MIT
+# http://creativecommons.org/licenses/MIT/
+
+require 'rubygems'
+require 'open-uri'
+require 'hpricot'
+
+#== About
+#
+# This is module for searching Revver and returning video information from it.
+#
+#== Usage Example
+#
+# Here's how to pull 1 quicktime video with the tag ruby
+#    
+#    require 'Revver4R'
+#    video_search = Revver4R::VideoSearch.new("qt","tag","ruby",{"limit" => 1})
+#    videos = video_search.search
+#    videos.each do |video|
+#      puts video.to_yaml
+#    end
+# 
+#  For more information at http://developer.revver.com/feeds/mrss
+module Revver4R
+
+  POSSIBLE_MEDIA_TYPES = ["flash", "qt"]
+  POSSIBLE_CONTENTS = ["user","collection","search","tag","latest","full","top10","top20","offline"]
+  POSSIBLE_OPTIONS = ["affiliate","orderBy","order","offset","limit","minAgeRestriction","maxAgeRestriction"]
+
+  POSSIBLE_ORDER_BYS = ["publicationDate","modifiedDate","createdDate","title","author","views","duration","size"]
+  POSSIBLE_ORDERS = ["asc","desc"]
+  RESTRICTION_RANGE = (1..5)
+
+  # http://feeds.revver.com/2.0/mrss/MEDIA/FEEDCONTENTS/FEEDCRITERIA?OPTIONS
+  REVVER_RSS_START = "http://feeds.revver.com/2.0/mrss/"
+
+  class SearchBase
+      
+    attr_accessor :media, :feed_contents, :criteria
+    def initialize(media="flash", feed_contents="tag", criteria="rails", options = {"affiliate" => "chalkers"})
+      if POSSIBLE_MEDIA_TYPES.include? media
+        @media = media
+      else
+        raise "Invalid 'media' type. Choose from " + POSSIBLE_MEDIA_TYPES.join[", "]
+      end
+
+      if POSSIBLE_CONTENTS.include? feed_contents
+        @feed_contents = feed_contents
+      else
+        raise "Invalid 'feed_content' type. Choose from " + POSSIBLE_CONTENTS.join[", "]
+      end
+
+      @criteria = criteria
+
+      options.delete("affiliate") if options["affiliate"] == ""
+      raise "Invalid 'offset' must be an Integer" if (options.has_key?"offset" && options["offset"].is_a?(Integer))
+      raise "Invalid 'order'. Choose from "+ POSSIBLE_ORDERS.join[", "] if (options.has_key?"order" && !POSSIBLE_ORDERS.include?(options["order"]))
+      raise "Invalid 'orderBy'. Choose from "+ POSSIBLE_ORDER_BYS.join[", "] if (options.has_key?"orderBy" && !POSSIBLE_ORDER_BYS.include?(options["order"]))
+
+      ["minAgeRestriction","maxAgeRestriction"].each do |restriction|
+         raise "Invalid '#{restriction}'. It must be between " + RESTRICTION_RANGE.first + " - " + RESTRICTION_RANGE.last if (options.has_key?restriction && !RESTRICTION_RANGE.include?(options[restriction]))
+      end
+
+      @options = options
+    end
+
+    def search
+      raise "'search' method not implemented"
+    end
+
+    private
+
+    def download_feed(url)
+      Hpricot.XML(open(url, { "User-Agent" => "Ruby/#{RUBY_VERSION} (Revver4R)" }))
+    end
+
+    def generate_url
+      options = []
+      @options.each do |k,v|
+        options << (k + "=" + v.to_s)
+      end
+      REVVER_RSS_START + [@media,@feed_contents,@criteria].join("/") + "?" + options.join("&")
+    end
+
+  end
+
+  class VideoSearch < SearchBase
+    def search
+      doc = download_feed(generate_url)
+      feed_to_videos(doc)
+    end
+    private
+    def feed_to_videos(doc)
+      videos = []
+      (doc/"item").each do |item|
+        videos << Video.new(item)
+      end
+      videos
+    end
+  end
+
+  class Video
+    attr_accessor  :title, :description, :credit, :content, :categories, :thumbnail, :rating, :license, :revver_url
+    alias :user :credit
+    def initialize(item)
+      @title = (item/"media:title").first.to_plain_text
+      @description = (item/"media:description").first.to_plain_text
+      @credit = (item/"media:credit").first.to_plain_text
+      @categories = (item/"media:category").first.to_plain_text.split(" ")
+      content_node = (item/"media:content").first
+      @content = VideoContent.new(  content_node.attributes["type"],
+              content_node.attributes["url"],
+              content_node.attributes["duration"].to_i)
+      thumnail_node = (item/"media:thumbnail").first
+      @thumbnail = Thumbnail.new( thumnail_node.attributes["url"],
+              thumnail_node.attributes["width"].to_i,
+              thumnail_node.attributes["height"].to_i)
+      @revver_url = (item/"media:player").first.attributes["url"]
+      @rating = (item/"media:rating").first.to_plain_text
+      @license = (item/"creativeCommons:license").first.to_plain_text
+    end
+  end
+
+  class VideoContent
+    attr_accessor :type, :url, :duration
+    def initialize(type, url, duration)
+      @type = type
+      @url = url
+      @duration = duration
+    end
+  end
+
+  class Thumbnail
+    attr_accessor :url, :width, :height
+    def initialize(url, width, height)
+      @url = url
+      @width = width
+      @height = height
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: chalkers-Revver4R
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andrew Chalkley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A simple Ruby interface for Revver's api.
+email: andrew@chalkely.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/revver4r.rb
+- README.rdoc
+files: 
+- CHANGELOG
+- init.rb
+- lib/revver4r.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- Revver4R.gemspec
+has_rdoc: true
+homepage: http://github.com/chalkers/revver4r
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Revver4R
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: revver4r
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple Ruby interface for Revver's api.
+test_files: []
+