remi-rubytube 0.1.0 → 0.1.2

data/README.rdoc

@@ -31,4 +31,19 @@ a screencast doesn't sound pleasant ... so I figured I'd automate it.
   => #<RubyTube::Screencast:0x7fcc8a831c98...>
 
   >> screencast.submit!
-  => <WWW::Mechanize::Page...>
+  => "Thanks for the submission! We'll post it after a quick review!"
+
+  # If you try to submit the same screencast again:
+
+  >> screencast.submit!
+  => "There was a problem, most likely a wrong or duplicate URL, sorry!"
+
+After you've called RubyTube::Screencast#submit! you can goto a URL like http://rubytu.be/ruby-basics 
+to see if your screencast was created.  It will show up here before it is added to the home page 
+of the site (my guess is that the site owner approves all videos?)
+
+== Resources
+
+RubyTube Site:: http://rubytu.be
+RDoc:: http://remi.github.com/rubytube
+Code:: http://github.com/remi/rubytube

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.2

data/lib/rubytube.rb

@@ -1,7 +1,13 @@
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
-%w( rubygems mechanize ).each {|lib| require lib }
+require 'rubygems'
 
+begin
+  require 'mechanize'
+rescue LoadError
+  raise "mechanize failed to load.  try: sudo gem install mechanize"
+end
+  
 module RubyTube #:nodoc:
 
   # Represents a screencast on http://rubytu.be
@@ -9,27 +15,66 @@ module RubyTube #:nodoc:
   # Currently, this is just used to post screencasts to RubyTube, 
   # not to pull them.  Unfortunately, RubyTube doesn't appear to 
   # have any kind of an API or easy way to access video information.
-  #
-  # The whole site is 1 page (with pagination) and there's a Feed: 
-  # http://feeds.feedburner.com/rubytube?format=xml
-  #
-  # There are tags, but they don't even work!
   class Screencast
-
+  
+    # Returns the required fields/attributes (an Array of strings or symbols) 
+    #
+    # #valid? will ensure that each of these attributes is not empty.
+    #
+    # The default fields: DEFAULT_REQUIRED_FIELDS
     def self.required_fields
-      @required_fiels
+      @required_fields
     end
-    @required_fiels ||= %w( name title url description duration )
 
-    attr_accessor :name, :twitter, :title, :url, :duration, :tags, :description
+    DEFAULT_REQUIRED_FIELDS = %w( name title url description duration )
+    @required_fields ||= DEFAULT_REQUIRED_FIELDS
+
+    # Your name, eg. 'Bob'
+    attr_accessor :name
+
+    # Your twitter ID, eg. '@coolbob'
+    attr_accessor :twitter
+
+    # The title of this Screencast, eg. 'ActiveRecord Awesomness'
+    attr_accessor :title
+
+    # The absolute path to this Screencast.  This should not be a media 
+    # URL (eg. a path to a video) nor should it be a URL to a site that 
+    # has many videos (eg. 'http://peepcode.com').  Instead, this should 
+    # be a link to a page that's specific to this Screencast
+    attr_accessor :url
+
+    # The duration of this Screencast, format: "HH:MM:SS"
+    attr_accessor :duration
 
+    # An Array of tags associated with this screencast, eg: ['Rails', 'ActiveRecord']
+    attr_accessor :tags
+
+    # A short description about this Screencast
+    attr_accessor :description
+
+    # After calling valid?, this is set to an Array which, if the 
+    # Screencast isn't valid, will contain messages describing 
+    # why the Screencast isn't valid
     attr_reader :errors
 
+    # Initialized a new Screencast
+    #
+    # Accepts a (standard) Hash or attributes, eg.
+    #
+    #   >> @screencast = Screencast.new :name => 'remi', :title => 'Awesome Screencast'
+    #
     def initialize options = nil
       @tags ||= []
       options.each {|k,v| self.send "#{k}=", v } if options
     end
 
+    # Returns a boolean indicating whether or not this Screencast is valid
+    #
+    # #submit! cannot be called if #valid? doesn't return true
+    #
+    # After calling #valid?, you can check #errors to see messages 
+    # describing why this Screencast isn't valid
     def valid?
       @errors = []
       Screencast.required_fields.each do |field|
@@ -40,15 +85,67 @@ module RubyTube #:nodoc:
       @errors.empty?
     end
 
+    # Submits this screencast to http://rubytu.be
+    #
+    # This is the same as going to http://rubytu.be and clicking 'Suggest Video' 
+    # and filling out all of the fields
+    #
+    # If you want to preview all of the fields that will be filled out *before* 
+    # calling #submit!, see #_fields
+    #
+    # Returns false if the screencast is not valid?, otherwise it returns a 
+    # String (taken from the HTML response we get when we submit the form), 
+    # describing whether or not the submission/suggestion was successful.
+    def submit!
+      raise "You cannot submit! an invalid Screencast" unless valid?
+
+      # the reason we're using instance variables is for caching (@agent) and 
+      # so you can easily grab the values of these variables if you need them for debugging
+      @agent     ||= WWW::Mechanize.new {|a| a.user_agent_alias = 'Linux Mozilla' }
+      @page        = @agent.get 'http://rubytu.be/'
+      @submit_form = @page.forms.find {|form| form.action == '/content' }
+      @submit_form.set_fields _fields
+      @response = @agent.submit @submit_form
+
+      if @response.at('div.success')
+        @response.at('div.success').text.strip
+
+      elsif @response.at('div.error')
+        @response.at('div.error').text.strip
+
+      else
+        "No success or error message detected?  see #_last_response to help with debugging."
+
+      end
+    end
+
+    # methods below here should likely be private!  but we're keeping them public 
+    # and giving them underscore prefixes to indicate that these are private methods
+
+    # [private]
+    #
+    # Returns the raw value to be used for the twitter field in the form we submit
+    #
+    # The user should use the #twitter attribute
     def _twitter_value
-      (twitter.to_s.strip.empty?) ? '@' : twitter
+      val = (twitter.to_s.strip.empty?) ? '@' : twitter
+      val = "@#{val}" unless val.start_with?('@')
+      val
     end
 
+    # [private]
+    #
+    # Returns the raw value to be used for the tags field in the form we submit
+    #
+    # The user should use the #tags attribute
     def _tags_value
       tags.join(',')
     end
 
-    def fields
+    # [private]
+    #
+    # Returns the raw values to be used for all of the fields in the form we submit
+    def _fields
       {
         'content[submitted_by]'         => name,
         'content[submitted_by_twitter]' => _twitter_value,
@@ -60,16 +157,21 @@ module RubyTube #:nodoc:
       }
     end
 
-    def submit!
-      return unless valid?
-
-      # the reason we're using instance variables is for caching (@agent) and 
-      # so you can easily grab the values of these variables if you need them for debugging
-      @agent     ||= WWW::Mechanize.new {|a| a.user_agent_alias = 'Linux Mozilla' }
-      @page        = @agent.get 'http://rubytu.be/'
-      @submit_form = @page.forms.find {|form| form.action == '/content' }
-      @submit_form.set_fields fields
-      @agent.submit @submit_form
+    # [private]
+    #
+    # Returns the raw response of the last #submit! call
+    #
+    # This is a WWW::Mechanize::Page object
+    #
+    # To get the raw HTML of the response:
+    #
+    #   >> @screencast.last_response.content
+    #
+    # If #submit! hasn't been called on this screencast, this will be nil
+    #
+    # This is really just for debugging!
+    def _last_response
+      @response
     end
 
   end

data/spec/screencast_spec.rb

@@ -13,6 +13,7 @@ describe RubyTube::Screencast do
     RubyTube::Screencast.gen( :twitter => '@remitaylor' ).twitter.should == '@remitaylor'
 
     # check the private field that's actually used for form submission
+    RubyTube::Screencast.gen( :twitter => 'remitaylor' )._twitter_value.should  == '@remitaylor'
     RubyTube::Screencast.gen( :twitter => '@remitaylor' )._twitter_value.should == '@remitaylor'
     RubyTube::Screencast.gen( :twitter => nil )._twitter_value.should == '@'
     RubyTube::Screencast.gen( :twitter => ''  )._twitter_value.should == '@'
@@ -61,13 +62,13 @@ describe RubyTube::Screencast do
                                           :url  => 'http://remi.org/some-screencast', :tags  => %w( ruby rack ),
                                           :duration => '00:02:45'
     screencast.should be_valid
-    screencast.fields['content[submitted_by]'].should         == screencast.name
-    screencast.fields['content[submitted_by_twitter]'].should == screencast._twitter_value
-    screencast.fields['content[title]'].should                == screencast.title
-    screencast.fields['content[url]'].should                  == screencast.url
-    screencast.fields['content[tag_list]'].should             == screencast._tags_value
-    screencast.fields['content[duration]'].should             == screencast.duration
-    screencast.fields['content[about]'].should                == screencast.description
+    screencast._fields['content[submitted_by]'].should         == screencast.name
+    screencast._fields['content[submitted_by_twitter]'].should == screencast._twitter_value
+    screencast._fields['content[title]'].should                == screencast.title
+    screencast._fields['content[url]'].should                  == screencast.url
+    screencast._fields['content[tag_list]'].should             == screencast._tags_value
+    screencast._fields['content[duration]'].should             == screencast.duration
+    screencast._fields['content[about]'].should                == screencast.description
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: remi-rubytube
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors: 
 - remi