balinterdi-twuckoo 0.2.1 → 0.2.2

data/CHANGELOG

@@ -1,3 +1,4 @@
+v0.2.2  Minor modification because of changed Wikipedia TFA markup
 v0.2    Wikipedia TFA module, command line argument decides which file to include
 v0.1.3  Length of sleeping interval settable from config
 v0.1.2  Sleeping interval set with duration-string

data/README.markdown

@@ -1,4 +1,102 @@
 # Twuckoo
 
-Need to tweet periodically and in an automated fashion? Cuckoo twitterer is for you.
+Need to tweet periodically and in an automated fashion? Then Twuckoo is for you. Still not convinced? :) Read on.
 
+## Abstract
+
+Twuckoo fulfills the task of periodically fetching a message and tweeting it (Twuckoo = Twitter + Cuckoo). Since we all prefer code to words, I'll show you its main loop:
+
+    def run
+      setup
+      load_tweets
+      loop do
+        tweeted = tweet
+        quit if tweeted.nil?
+        relax
+      end
+    end
+
+It is very simple in its design but opens vast possibilities due to its modular approach.
+
+## A simple API
+
+Twuckoo takes a modular approach. It defines a very simple API and expects modules to implement these API methods. The methods are:
+
+    * load_tweets
+
+Loads the possible tweets that twuckoo will use when selecting the next one. This could be reading all lines from a file, for example.
+    
+    * next
+
+Fetches the next message to be tweeted. Usually the bulk of the "business logic" is implemented here. This could be scraping a web page and extracting a specific snippet of html.
+    
+    * store(tweet)
+
+Hands the last tweeted message to be stored. In the case of the one\_line\_from_file module, this stores the tweet in a file so that no message is used multiple times.
+    
+Twuckoo needs to be passed the name of the module to be used. At the moment there are two provided modules: 
+
+* one\_line\_from\_file
+
+  Loads all the lines from a file (lines.txt) and tweets one line randomly each time.
+  
+* wikipedia_tfa
+
+  Scraps Wikipedia's main page and extracts the name and link of Today's Featured Article. This is not as general a module as one\_line\_from_file. I am thinking about how to best make a "web" module out of this.
+
+## Installation
+
+    gem install balinterdi-twuckoo --source http://gems.github.com
+    
+Twuckoo depends on twibot which will also get installed with the above command.
+
+In order for twibot to be able to connect to your twitter account, a config/bot.yml file need to be present at where you launch twuckoo from. It has to contain the following lines at least:
+
+    login: my_login
+    password: my_password
+    
+For more options, see [twibot's README](http://github.com/cjohansen/twibot/tree/master "twibot's README")
+
+## Configuration
+
+Currently the only thing you can set is the time to wait between tweets. By default, it is "1d", so the script will "relax" for 24 hours after tweeting. If you wish to change this value, just place the following in a config/cuckoo.yml:
+
+    time_to_sleep: 1h
+
+The value should be given in a human-comprehensible form. You can use any combination of weeks, days, hours, minutes and seconds, so 1w3d13h27m19s will work, too, although you probably do not want to be this precise :)
+
+## Running
+
+You have to indicate the module you wish to use:
+
+    $ twuckoo file
+    
+Will make use of the one_line_from_file module. There has to be a lines.txt file in the directory where you run twuckoo from that contains the possible tweets, one tweet per line. The tweeted lines will be stored in a file called used\_lines.txt so you should have write permission to the directory.
+
+or
+
+    $ twuckoo wikipedia_tfa
+
+(see above)
+
+## Examples out there
+
+In the course of the development of this gem I "ate my own dogfood" so you'll find one twitter account for each of the modules:
+
+* [Daily Oblique](http://twitter.com/daily_oblique)
+
+  Serves you an [Oblique Strategy](http://www.rtqe.net/ObliqueStrategies/) per day.
+  
+* [Wikipedia Today's Featured Article](http://twitter.com/wikipedia_tfa)
+
+  An interesting article from the English Wikipedia delivered right to your twitter feed.
+  
+If you set up something with twuckoo, I would like to know about it, so that I might include it here.
+
+## Credits & License
+
+You can go ahead and play with the software as well as modify it, release it under another name, charge for someone that uses your service, etc. A link back to [this page](http://github.com/balinterdi/twuckoo/tree/master) would be appreciated if you release something based on it.
+
+Any feedback (especially bug reports!) is highly appreciated, so please do not hesitate to contact me at <balint@bucionrails.com>
+
+Original idea and development: [Balint Erdi](http://bucionrails.com)

data/Rakefile

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('twuckoo', '0.2.1') do |p|
+Echoe.new('twuckoo', '0.2.2') do |p|
   p.description    = "A simple yet elegant solution to tweet a message regularly from a file (and in the future: from a webpage, a database, etc.)"
   p.url            = "http://github.com/balinterdi/twuckoo"
   p.author         = "Bálint Érdi"
   p.email          = "balint@bucionrails.com"
   p.ignore_pattern = ["tmp/*", "script/*", "*.txt", "pkg"]
-  p.runtime_dependencies = ["twibot >=0.1.7"]
+  p.runtime_dependencies = ["twibot >=0.1.7", "hpricot >= 0.6.164", "mocha >= 0.9.5"]
 end
 
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/modules/wikipedia_tfa.rb

@@ -1,24 +1,37 @@
 require "open-uri"
 require "hpricot"
 
+# Grabs the headline of Wikipedia's Today's Featured Article (TFA)
 module WikipediaTFA
-  
+
   WIKIPEDIA_HOST = "http://en.wikipedia.org"
-  
+
   def load_tweets
   end
 
   def store(line)
   end
 
-  def get_wikipedia_main_page
+  def fetch_main_page
     Hpricot(open("#{WIKIPEDIA_HOST}/wiki/Main_Page"))
   end
-  
-  def next
-    doc = get_wikipedia_main_page
-    tfa = doc.at("#mp-tfa p b a")
+
+  def fetch_tfa
+    doc = fetch_main_page
+    tfa = doc.at("#mp-tfa b a")
     tfa_link = WIKIPEDIA_HOST + tfa["href"]
     "#{tfa.inner_html}: #{tfa_link}"
   end
+
+  def next
+    prev_tweet = get_last_tweet
+    next_tweet = fetch_tfa
+    return prev_tweet == next_tweet ? '' : next_tweet
+  end
+  
+  private
+  def get_last_tweet
+    last_tweet = twitter.timeline_for(:me).first
+    last_tweet.text if last_tweet
+  end
 end

data/lib/twuckoo.rb

@@ -4,7 +4,6 @@ require File.join(File.dirname(__FILE__), 'duration_string')
 require 'twibot'
 
 class Twuckoo
-  include TwuckooEnvironment
   # the idea is to include a module with a well-defined API with three methods:
   # - load_tweets
   # - next
@@ -18,13 +17,9 @@ class Twuckoo
 
   def tweet
     next_tweet = self.next
-    unless next_tweet.nil?
+    unless next_tweet.nil? or next_tweet.empty?
       store(next_tweet)
-      if testing?
-        puts "(test) Tweeting #{next_tweet}"
-      else
-        twitter.status(:post, next_tweet)
-      end
+      send_tweet(next_tweet)
     end
     next_tweet
   end
@@ -63,4 +58,9 @@ class Twuckoo
   def quit
     exit
   end
+  
+  private
+  def send_tweet(next_tweet)
+    twitter.status(:post, next_tweet)
+  end
 end

data/spec/one_line_from_file_spec.rb

@@ -11,92 +11,91 @@ end
 
 class TwuckooWithOneLineFromFileSpec
 
-  extend TwuckooEnvironment
-  set_testing
-
   describe "A cuckoo twitterer with one line from a file" do
     before do
       Twuckoo.send(:include, OneLineFromFile)
-      @cuckoo = Twuckoo.new
+      @twuckoo = Twuckoo.new
       # just so that no files will be written
-      @cuckoo.stubs(:store).returns(nil)
+      @twuckoo.stubs(:store).returns(nil)
+      # and the actual text tweets are not tweeted (twittered?)
+      @twuckoo.stubs(:send_tweet).returns(true)
     end
 
     it "stores a line that was sent to it correctly" do
-      @cuckoo.lines.should be_empty
-      @cuckoo.add_lines("I am happy", "I am sad")
-      @cuckoo.lines.should == ["I am happy", "I am sad"]
+      @twuckoo.lines.should be_empty
+      @twuckoo.add_lines("I am happy", "I am sad")
+      @twuckoo.lines.should == ["I am happy", "I am sad"]
     end
 
     it "loads all the lines in the file when sent the load_tweets message" do
       lines = ["I am happy", "I am sad", "I am thrilled", "I am bored"]
-      @cuckoo.expects(:get_lines_from_file).returns(lines)
-      @cuckoo.load_tweets
-      @cuckoo.lines.should == lines
+      @twuckoo.expects(:get_lines_from_file).returns(lines)
+      @twuckoo.load_tweets
+      @twuckoo.lines.should == lines
     end
 
     describe "when it tweeted a line already" do
       before do
-        @cuckoo.add_lines("I am happy", "I am sad", "I am thrilled", "I am bored")
-        @cuckoo.stubs(:pick).returns(0)
-        @cuckoo.tweet
+        @twuckoo.add_lines("I am happy", "I am sad", "I am thrilled", "I am bored")
+        @twuckoo.stubs(:pick).returns(0)
+        @twuckoo.tweet
       end
 
       it "it removes it" do
-        @cuckoo.lines.should == ["I am sad", "I am thrilled", "I am bored"]
+        @twuckoo.lines.should == ["I am sad", "I am thrilled", "I am bored"]
       end
 
       it "stores it" do
-        @cuckoo.stubs(:pick).returns(0)
-        @cuckoo.expects(:store).with("I am sad")
-        @cuckoo.tweet
+        @twuckoo.stubs(:pick).returns(0)
+        @twuckoo.expects(:store).with("I am sad")
+        @twuckoo.tweet
       end
 
       it "it picks an unused line to tweet next" do
-        next_pick = @cuckoo.next
+        next_pick = @twuckoo.next
         ["I am sad", "I am thrilled", "I am bored"].should include(next_pick)
       end
     end
 
     it "tweets all the available lines in as many 'rounds' as there are lines" do
       lines = ["I am happy", "I am sad", "I am thrilled", "I am bored"]
-      @cuckoo.add_lines(*lines)
-      lines.length.times { @cuckoo.tweet }
-      @cuckoo.lines.should be_empty
+      @twuckoo.add_lines(*lines)
+      lines.length.times { @twuckoo.tweet }
+      @twuckoo.lines.should be_empty
     end
 
     it "only reads the file to load lines from the first time around" do
       pending
-      @cuckoo.stubs(:get_used_lines_from_file).returns([])
-      @cuckoo.expects(:get_lines_from_file).returns(["I am happy", "I am sad", "I am thrilled", "I am bored"])
-      2.times { @cuckoo.load_lines }
+      @twuckoo.stubs(:get_used_lines_from_file).returns([])
+      @twuckoo.expects(:get_lines_from_file).returns(["I am happy", "I am sad", "I am thrilled", "I am bored"])
+      2.times { @twuckoo.load_lines }
     end
 
     it "only reads the file to load used lines from the first time around" do
       pending
-      @cuckoo.stubs(:get_lines_from_file).returns(["I am happy", "I am sad", "I am thrilled", "I am bored"])
-      @cuckoo.expects(:get_used_lines_from_file).returns([])
-      2.times { @cuckoo.load_lines }
+      @twuckoo.stubs(:get_lines_from_file).returns(["I am happy", "I am sad", "I am thrilled", "I am bored"])
+      @twuckoo.expects(:get_used_lines_from_file).returns([])
+      2.times { @twuckoo.load_lines }
     end
 
     describe "when loading lines to use" do
       before do
-        @cuckoo.stubs(:get_lines_from_file).returns(["I am happy", "I am sad", "I am thrilled", "I am bored"])
-        @cuckoo.stubs(:get_used_lines_from_file).returns([])
+        @twuckoo.stubs(:get_lines_from_file).returns(["I am happy", "I am sad", "I am thrilled", "I am bored"])
+        @twuckoo.stubs(:get_used_lines_from_file).returns([])
       end
 
       it "loads the available ones" do
-        @cuckoo.load_lines
-        @cuckoo.lines.should == ["I am happy", "I am sad", "I am thrilled", "I am bored"]
+        @twuckoo.load_lines
+        @twuckoo.lines.should == ["I am happy", "I am sad", "I am thrilled", "I am bored"]
       end
 
       describe "when having used ones from a previous run" do
         before do
-          @cuckoo.stubs(:get_used_lines_from_file).returns(["I am happy", "I am sad"])
-          @cuckoo.load_lines
+          @twuckoo.stubs(:get_used_lines_from_file).returns(["I am happy", "I am sad"])
+          @twuckoo.load_lines
         end
         it "should not pick those used lines" do
-          @cuckoo.lines.should == ["I am thrilled", "I am bored"]
+          @twuckoo.lines.should == ["I am thrilled", "I am bored"]
         end
       end
     end

data/spec/spec.opts

@@ -2,4 +2,3 @@
 --loadby random
 --format progress
 --backtrace
---debugger

data/spec/twuckoo_spec.rb

@@ -1,44 +1,44 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 class TwuckooSpec
-  extend TwuckooEnvironment
-  set_testing
-
   describe "A twuckoo" do
     before do
-      @cuckoo = Twuckoo.new
+      @twuckoo = Twuckoo.new
+      # actual text tweets should not be tweeted (twittered?)
+      @twuckoo.stubs(:send_tweet).returns(true)
     end
 
     it "responds to tweet" do
-      @cuckoo.should respond_to(:tweet)
+      @twuckoo.should respond_to(:tweet)
     end
 
     it "waits 1 day between tweets by default" do
-      @cuckoo.time_to_sleep.should == "1d"
+      @twuckoo.time_to_sleep.should == "1d"
     end
 
     describe "loading values from the config file" do
       it "sets the time interval to wait b/w tweets correctly" do
-        @cuckoo.expects(:get_config_values_from_file).returns({ :time_to_sleep => "3m" })
-        @cuckoo.setup
-        @cuckoo.time_to_sleep.should == "3m"
+        @twuckoo.expects(:get_config_values_from_file).returns({ :time_to_sleep => "3m" })
+        @twuckoo.setup
+        @twuckoo.time_to_sleep.should == "3m"
       end
     end
 
     describe "when there is nothing to tweet" do
       before do
-        @cuckoo.stubs(:next).returns(nil)
-        @cuckoo.stubs(:load_tweets).returns(nil)
+        @twuckoo.stubs(:next).returns(nil)
+        @twuckoo.stubs(:load_tweets).returns(nil)
       end
       it "does not call store" do
-        @cuckoo.expects(:store).never
-        @cuckoo.tweet
+        @twuckoo.expects(:store).never
+        @twuckoo.tweet
       end
       it "quits" do
         pending
-        @cuckoo.expects(:quit).once
-        @cuckoo.run
+        @twuckoo.expects(:quit).once
+        @twuckoo.run
       end
     end
+
   end
 end

data/spec/wikipedia_tfa_spec.rb

@@ -5,16 +5,19 @@ require File.join(dir, 'modules', 'wikipedia_tfa')
 
 class TwuckooForWikipediaTfaSpec
 
-  extend TwuckooEnvironment
-  set_testing
-
   describe "A cuckoo twitterer for wikipedia featured article" do
     before do
       Twuckoo.send(:include, WikipediaTFA)
-      @cuckoo = Twuckoo.new
-    end
-    it "works" do
-      @cuckoo.tweet
+      # actual text tweets should not be tweeted (twittered?)
+      @twuckoo.stubs(:send_tweet).returns(true)
+      @twuckoo = Twuckoo.new
     end
+    
+    it "should not tweet the same thing twice subsequently" do
+      @twuckoo.expects(:get_last_tweet).returns("Twitter: http://en.wikipedia.org/wiki/Twitter")
+      @twuckoo.expects(:fetch_tfa).returns("Twitter: http://en.wikipedia.org/wiki/Twitter")
+      @twuckoo.expects(:send_tweet).never
+      @twuckoo.tweet
+    end    
   end
 end

data/twuckoo.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{twuckoo}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["B\303\241lint \303\211rdi"]
-  s.date = %q{2009-06-16}
+  s.date = %q{2009-08-07}
   s.default_executable = %q{twuckoo}
   s.description = %q{A simple yet elegant solution to tweet a message regularly from a file (and in the future: from a webpage, a database, etc.)}
   s.email = %q{balint@bucionrails.com}
@@ -26,10 +26,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<twibot>, [">= 0.1.7"])
+      s.add_runtime_dependency(%q<hpricot>, [">= 0", "= 0.6.164"])
+      s.add_runtime_dependency(%q<mocha>, [">= 0", "= 0.9.5"])
     else
       s.add_dependency(%q<twibot>, [">= 0.1.7"])
+      s.add_dependency(%q<hpricot>, [">= 0", "= 0.6.164"])
+      s.add_dependency(%q<mocha>, [">= 0", "= 0.9.5"])
     end
   else
     s.add_dependency(%q<twibot>, [">= 0.1.7"])
+    s.add_dependency(%q<hpricot>, [">= 0", "= 0.6.164"])
+    s.add_dependency(%q<mocha>, [">= 0", "= 0.9.5"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: balinterdi-twuckoo
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - "B\xC3\xA1lint \xC3\x89rdi"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-16 00:00:00 -07:00
+date: 2009-08-07 00:00:00 -07:00
 default_executable: twuckoo
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,32 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.1.7
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.6.164
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.5
+    version: 
 description: "A simple yet elegant solution to tweet a message regularly from a file (and in the future: from a webpage, a database, etc.)"
 email: balint@bucionrails.com
 executables: 
@@ -59,6 +85,7 @@ files:
 - twuckoo.gemspec
 has_rdoc: false
 homepage: http://github.com/balinterdi/twuckoo
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -84,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: twuckoo
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: "A simple yet elegant solution to tweet a message regularly from a file (and in the future: from a webpage, a database, etc.)"