balinterdi-twuckoo 0.2.1

data/CHANGELOG

@@ -0,0 +1,5 @@
+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
+v0.1.1  Removing unnecessary gem requires and config files
+v0.1    Initial release: can tweet from a file.

data/Manifest

@@ -0,0 +1,18 @@
+bin/twuckoo
+CHANGELOG
+lib/duration_string.rb
+lib/environments.rb
+lib/modules/one_line_from_file.rb
+lib/modules/wikipedia_tfa.rb
+lib/twuckoo.rb
+Manifest
+Rakefile
+README.markdown
+spec/duration_string_spec.rb
+spec/one_line_from_file_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/twuckoo_spec.rb
+spec/wikipedia_tfa_spec.rb
+tasks/spec.rake
+twuckoo.gemspec

data/README.markdown

@@ -0,0 +1,4 @@
+# Twuckoo
+
+Need to tweet periodically and in an automated fashion? Cuckoo twitterer is for you.
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('twuckoo', '0.2.1') 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"]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/bin/twuckoo

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+dir = File.join(File.dirname(__FILE__), '..', 'lib')
+
+require File.join(dir, 'twuckoo')
+
+Dir.glob(File.join(dir, 'modules', '*.rb')).each do |mod|
+  require mod
+end
+
+module_to_include = case ARGV.first.downcase
+when "from_file"
+  OneLineFromFile
+when "file"
+  OneLineFromFile  
+when "wikipedia_tfa"
+  WikipediaTFA
+else
+  raise "No module to include was provided."
+end
+
+Twuckoo.send(:include, module_to_include)
+@cuckoo = Twuckoo.new
+# @cuckoo.set_testing
+@cuckoo.run

data/lib/duration_string.rb

@@ -0,0 +1,12 @@
+module DurationString
+  class << self
+    MULTIPLIERS = { "s" => 1, "m" => 60, "h" => 60 * 60, "d" => 60 * 60 * 24, "w" => 60 * 60 * 24 * 7 }
+    def to_seconds(duration)
+      duration.scan(/(\d+)([smhdw])/).inject(0) do |seconds, match|
+        num, dur_chr = match
+        multiplier = MULTIPLIERS[dur_chr]
+        seconds + num.to_i * multiplier
+      end
+    end
+  end
+end

data/lib/environments.rb

@@ -0,0 +1,8 @@
+module TwuckooEnvironment
+  def set_testing
+    ENV["CUCKOO_ENV"] = "testing"
+  end
+  def testing?
+    ENV["CUCKOO_ENV"] == "testing"
+  end
+end

data/lib/modules/one_line_from_file.rb

@@ -0,0 +1,70 @@
+module OneLineFromFile
+  # read all lines from the file that contains the strategies
+  # select the strategies that are not used yet
+  # pick a random strategy
+
+  # store used strategies in a file with (store the md5 sum of the strategies' text)
+  attr_reader :lines
+
+  LINES_FILE = 'lines.txt'
+  USED_LINES_FILE = 'used_lines.txt'
+
+  def initialize
+    @lines = []
+    # load_lines
+  end
+
+  def load_tweets
+    load_lines
+  end
+  
+  def get_lines_from_file
+    begin
+      IO::readlines(LINES_FILE).map { |line| line.chomp }
+    rescue Errno::ENOENT
+      []
+    end
+  end
+
+  def get_all_lines
+    @fresh_lines ||= get_lines_from_file
+  end
+
+  def get_used_lines_from_file
+    begin
+      IO::readlines(USED_LINES_FILE).map { |line| line.chomp }
+    rescue Errno::ENOENT
+      []
+    end
+  end
+
+  def get_used_lines
+    @used_lines ||=  get_used_lines_from_file
+  end
+
+  def load_lines
+    used = get_used_lines
+    unused_lines = get_all_lines.select { |line| !used.include?(line) }
+    add_lines(*unused_lines)
+  end
+
+  def add_lines(*new_lines)
+    @lines.concat(new_lines)
+  end
+
+  def pick
+    rand(lines.length)
+  end
+
+  def store(line)
+    open(USED_LINES_FILE, "a") do |file|
+      file.write(line + "\n")
+    end
+  end
+
+  def next
+    @lines.delete_at(pick)
+  end
+
+end
+

data/lib/modules/wikipedia_tfa.rb

@@ -0,0 +1,24 @@
+require "open-uri"
+require "hpricot"
+
+module WikipediaTFA
+  
+  WIKIPEDIA_HOST = "http://en.wikipedia.org"
+  
+  def load_tweets
+  end
+
+  def store(line)
+  end
+
+  def get_wikipedia_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")
+    tfa_link = WIKIPEDIA_HOST + tfa["href"]
+    "#{tfa.inner_html}: #{tfa_link}"
+  end
+end

data/lib/twuckoo.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), 'environments')
+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
+  # - store(tweet)
+  attr_accessor :time_to_sleep
+
+  def initialize
+    @time_to_sleep = "1d"
+    super
+  end
+
+  def tweet
+    next_tweet = self.next
+    unless next_tweet.nil?
+      store(next_tweet)
+      if testing?
+        puts "(test) Tweeting #{next_tweet}"
+      else
+        twitter.status(:post, next_tweet)
+      end
+    end
+    next_tweet
+  end
+
+  def get_config_values_from_file
+    begin
+      open('config/cuckoo.yml', 'r') do |f|
+        YAML.load(f.read)
+      end
+    rescue
+      {}
+    end
+  end
+
+  def setup
+    get_config_values_from_file.each_pair do |attr, value|
+      self.send("#{attr}=".to_sym, value)
+    end
+  end
+
+  def relax
+    seconds_to_sleep = DurationString.to_seconds(time_to_sleep)
+    sleep(seconds_to_sleep)
+  end
+
+  def run
+    setup
+    load_tweets
+    loop do
+      tweeted = tweet
+      quit if tweeted.nil?
+      relax
+    end
+  end
+
+  def quit
+    exit
+  end
+end

data/spec/duration_string_spec.rb

@@ -0,0 +1,30 @@
+require "spec"
+dir = File.join(File.dirname(__FILE__), '..', 'lib')
+require File.join(dir, 'duration_string')
+
+describe "a string representing a duration" do
+  it "gives back the number of seconds for seconds" do
+    DurationString.to_seconds("17s").should == 17
+  end
+
+  it "gives back the number of seconds for dur. strings with only minutes defined" do
+    DurationString.to_seconds("7m").should == 7 * 60
+  end
+
+  it "gives back the number of seconds for hours for dur. strings with only hours defined" do
+    DurationString.to_seconds("4h").should == 60 * 60 * 4
+  end
+
+  it "gives back the number of seconds for hours for dur. strings with only days defined" do
+    DurationString.to_seconds("2d").should == 60 * 60 * 24 * 2
+  end
+
+  it "gives back the number of seconds for hours for dur. strings with only weeks defined" do
+    DurationString.to_seconds("3w").should == 60 * 60 * 24 * 7 * 3
+  end
+
+  it "gives back the number of seconds for a dur. string that combines several dur. characters" do
+    DurationString.to_seconds("1d3h18m22s").should == (60 * 60 * 24 * 1) + (60 * 60 * 3) + (60 * 18) + 22
+  end
+
+end

data/spec/one_line_from_file_spec.rb

@@ -0,0 +1,105 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+dir = File.join(File.dirname(__FILE__), '..', 'lib')
+require File.join(dir, 'modules', 'one_line_from_file')
+
+# use mocha for mocking instead of
+# Rspec's own mock framework
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+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
+      # just so that no files will be written
+      @cuckoo.stubs(:store).returns(nil)
+    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"]
+    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
+    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
+      end
+
+      it "it removes it" do
+        @cuckoo.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
+      end
+
+      it "it picks an unused line to tweet next" do
+        next_pick = @cuckoo.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
+    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 }
+    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 }
+    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([])
+      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"]
+      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
+        end
+        it "should not pick those used lines" do
+          @cuckoo.lines.should == ["I am thrilled", "I am bored"]
+        end
+      end
+    end
+
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--loadby random
+--format progress
+--backtrace
+--debugger

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "spec"
+require "mocha"
+
+dir = File.join(File.dirname(__FILE__), '..', 'lib')
+require File.join(dir, 'twuckoo')
+require File.join(dir, 'environments')
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

data/spec/twuckoo_spec.rb

@@ -0,0 +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
+    end
+
+    it "responds to tweet" do
+      @cuckoo.should respond_to(:tweet)
+    end
+
+    it "waits 1 day between tweets by default" do
+      @cuckoo.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"
+      end
+    end
+
+    describe "when there is nothing to tweet" do
+      before do
+        @cuckoo.stubs(:next).returns(nil)
+        @cuckoo.stubs(:load_tweets).returns(nil)
+      end
+      it "does not call store" do
+        @cuckoo.expects(:store).never
+        @cuckoo.tweet
+      end
+      it "quits" do
+        pending
+        @cuckoo.expects(:quit).once
+        @cuckoo.run
+      end
+    end
+  end
+end

data/spec/wikipedia_tfa_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+dir = File.join(File.dirname(__FILE__), '..', 'lib')
+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
+    end
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,11 @@
+require "rubygems"
+require "rake"
+require "spec/rake/spectask"
+
+ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << ROOT + '/spec/spec.opts'
+  t.spec_files = Dir.glob('spec/**/*_spec.rb').map { |f| f.to_s }
+end  

data/twuckoo.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{twuckoo}
+  s.version = "0.2.1"
+
+  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.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}
+  s.executables = ["twuckoo"]
+  s.extra_rdoc_files = ["bin/twuckoo", "CHANGELOG", "lib/duration_string.rb", "lib/environments.rb", "lib/modules/one_line_from_file.rb", "lib/modules/wikipedia_tfa.rb", "lib/twuckoo.rb", "README.markdown", "tasks/spec.rake"]
+  s.files = ["bin/twuckoo", "CHANGELOG", "lib/duration_string.rb", "lib/environments.rb", "lib/modules/one_line_from_file.rb", "lib/modules/wikipedia_tfa.rb", "lib/twuckoo.rb", "Manifest", "Rakefile", "README.markdown", "spec/duration_string_spec.rb", "spec/one_line_from_file_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/twuckoo_spec.rb", "spec/wikipedia_tfa_spec.rb", "tasks/spec.rake", "twuckoo.gemspec"]
+  s.homepage = %q{http://github.com/balinterdi/twuckoo}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Twuckoo", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{twuckoo}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{A simple yet elegant solution to tweet a message regularly from a file (and in the future: from a webpage, a database, etc.)}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<twibot>, [">= 0.1.7"])
+    else
+      s.add_dependency(%q<twibot>, [">= 0.1.7"])
+    end
+  else
+    s.add_dependency(%q<twibot>, [">= 0.1.7"])
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: balinterdi-twuckoo
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- "B\xC3\xA1lint \xC3\x89rdi"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-16 00:00:00 -07:00
+default_executable: twuckoo
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: twibot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.7
+    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: 
+- twuckoo
+extensions: []
+
+extra_rdoc_files: 
+- bin/twuckoo
+- CHANGELOG
+- lib/duration_string.rb
+- lib/environments.rb
+- lib/modules/one_line_from_file.rb
+- lib/modules/wikipedia_tfa.rb
+- lib/twuckoo.rb
+- README.markdown
+- tasks/spec.rake
+files: 
+- bin/twuckoo
+- CHANGELOG
+- lib/duration_string.rb
+- lib/environments.rb
+- lib/modules/one_line_from_file.rb
+- lib/modules/wikipedia_tfa.rb
+- lib/twuckoo.rb
+- Manifest
+- Rakefile
+- README.markdown
+- spec/duration_string_spec.rb
+- spec/one_line_from_file_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/twuckoo_spec.rb
+- spec/wikipedia_tfa_spec.rb
+- tasks/spec.rake
+- twuckoo.gemspec
+has_rdoc: false
+homepage: http://github.com/balinterdi/twuckoo
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Twuckoo
+- --main
+- README.markdown
+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: twuckoo
+rubygems_version: 1.2.0
+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.)"
+test_files: []
+