twuckoo 0.3.5 → 0.4.0

data/README.markdown

@@ -69,7 +69,7 @@ By default, it is "1d", so the script will "relax" for 24 hours after tweeting.
   * password
   * email
   
-When twuckoo is out of messages to tweet, it quits. Most of the times you'll want to get notified of this, though, so you can take action (e.g refill it and relaunch). If the above options are set, twuckoo sends an email to `email`, using the `user` and `password` credentials for gmail authentication. (Yes, currently only gmail is supported, I'll change that shortly.)
+When twuckoo is out of messages to tweet, it quits. Most of the times you'll want to get notified of this, though, so you can take action (e.g refill it and relaunch). If the above options are set, twuckoo sends an email to `email`, using the `user` and `password` credentials for gmail authentication. (Yes, currently only gmail is supported, I am planning to change that in a next version.)
 
 ## Running
 

data/Rakefile

@@ -6,7 +6,7 @@ begin
     gemspec.name = "twuckoo"
     gemspec.summary = "Need to tweet periodically in an automated fashion? Then Twuckoo is for you!"
     gemspec.description = <<-EOF
-      A simple yet elegant solution to tweet a message regularly from a file (from a webpage, a database, etc.)
+      A simple yet elegant solution to tweet a message regularly from a file (or from a webpage, a database, etc.)
     EOF
     gemspec.email = "balint.erdi@gmail.com"
     gemspec.homepage = "http://github.com/balinterdi/twuckoo"

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.4.0

data/lib/modules/one_line_from_file.rb

@@ -17,7 +17,7 @@ module OneLineFromFile
   def load_tweets
     load_lines
   end
-  
+
   def get_lines_from_file
     begin
       IO::readlines(LINES_FILE).map { |line| line.chomp }
@@ -42,10 +42,12 @@ module OneLineFromFile
     @used_lines ||=  get_used_lines_from_file
   end
 
+  def get_unused_lines
+    get_all_lines.reject { |line| get_used_lines.include?(line) }
+  end
+
   def load_lines
-    used = get_used_lines
-    unused_lines = get_all_lines.select { |line| !used.include?(line) }
-    add_lines(*unused_lines)
+    add_lines(*get_unused_lines)
   end
 
   def add_lines(*new_lines)
@@ -66,5 +68,10 @@ module OneLineFromFile
     @lines.delete_at(pick)
   end
 
+  def reset
+    File.delete(USED_LINES_FILE) rescue nil
+    @used_lines = nil
+    load_lines
+  end
 end
 

data/lib/twuckoo/config.rb

@@ -1,5 +1,6 @@
 class Twuckoo::Config < Hash
   def initialize
     self[:time_to_sleep] = "1d"
+    self[:tweet_limit] = 0
   end
 end

data/lib/twuckoo/runner.rb

@@ -11,26 +11,39 @@ class Twuckoo::Runner
   # - load_tweets
   # - next
   # - store(tweet)
-  attr_reader :used_module
 
   def run
     setup_from_file
     load_tweets
     next_tweet = self.next
-    while next_tweet do
+    while (next_tweet and !tweet_limit_reached?) do
       tweet(next_tweet)
+      inc_tweet_counter
       wait if wait_between_tweets?
       next_tweet = self.next
-      notify if next_tweet.nil?
+      if next_tweet.nil?
+        notify
+        reset
+        next_tweet = self.next
+      end
+    end
+  end
+
+  def self.create(args=[])
+    module_name = args.first
+    unless module_name.nil?
+      _module = get_module(module_name)
+      class_eval { include _module }
     end
+    new(args)
   end
 
-  def initialize(args=[])    
+  attr_accessor :tweets_sent
+
+  def initialize(args=[])
+    @tweets_sent = 0
     @options = OpenStruct.new
     parse_options!(args)
-
-    _module = args.pop
-    use_module(get_module(_module))    
     super
   end
 
@@ -44,7 +57,7 @@ class Twuckoo::Runner
       opts.on_tail("-h", "--help", "Show this message") do
         puts opts
         exit
-      end      
+      end
     end
 
     if args.length.zero?
@@ -57,13 +70,13 @@ class Twuckoo::Runner
     #   exit
     # end
 
-    opts.parse!(args)    
+    opts.parse!(args)
   end
-  
+
   def name
     @options.name || File.split(File.dirname(__FILE__)).last
   end
-  
+
   def wait_between_tweets?
     config[:time_to_sleep] != "0"
   end
@@ -76,7 +89,7 @@ class Twuckoo::Runner
   def notify
     send_email(name, config)
   end
-  
+
   def tweet(message)
     unless message.nil? or message.empty?
       store(message)
@@ -112,8 +125,8 @@ class Twuckoo::Runner
   end
 
   private
-  def get_module(module_id)
-    case module_id
+  def self.get_module(module_name)
+    case module_name
     when "file"
       OneLineFromFile
     when "from_file"
@@ -121,19 +134,22 @@ class Twuckoo::Runner
     when "wikipedia_tfa"
       WikipediaTFA
     else
-      raise TwuckooException, "Invalid module: #{module_id.inspect}"
+      raise TwuckooException, "Invalid module: #{module_name.inspect}"
     end
   end
-  
-  def use_module(_module)
-    @used_module = _module
-    self.class.class_eval { include _module }
-  end
 
   def send_tweet(message)
     twitter.status(:post, message)
   end
 
+  def inc_tweet_counter
+    @tweets_sent += 1
+  end
+
+  def tweet_limit_reached?
+    !config[:tweet_limit].zero? and config[:tweet_limit].to_i == tweets_sent
+  end
+
   def send_email(name, config)
     Net::SMTP.enable_tls(OpenSSL::SSL::VERIFY_NONE)
     Mail.defaults do

data/spec/one_line_from_file_spec.rb

@@ -2,11 +2,15 @@ require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe "A cuckoo twitterer with one line from a file" do
   before do
-    @twuckoo = Twuckoo::Runner.new(["file"])
+    @twuckoo = Twuckoo::Runner.create(["file"])
     # just so that no files will be written
     @twuckoo.stubs(:store).returns(nil)
     # and the actual text tweets are not tweeted (twittered?)
     @twuckoo.stubs(:send_tweet).returns(true)
+    @twuckoo.stubs(:send_email).returns(true)
+    @twuckoo.setup do |config|
+      config[:time_to_sleep] = "0"
+    end
   end
 
   it "stores a line that was sent to it correctly" do
@@ -85,4 +89,33 @@ describe "A cuckoo twitterer with one line from a file" do
       end
     end
   end
+
+  describe "when there is nothing left to tweet" do
+    before do
+      @twuckoo.stubs(:next).returns("tweet me this").then.returns(nil)
+      @twuckoo.stubs(:load_tweets).returns(nil)
+    end
+
+    it "does not call store" do
+      @twuckoo.expects(:store).once
+      @twuckoo.run
+    end
+
+    it "calls reset" do
+      @twuckoo.expects(:reset).once
+      @twuckoo.run
+    end
+
+  end
+
+  it "loads the lines when reset" do
+    pending
+    @twuckoo.stubs(:get_unused_lines).returns(["tweet me this", "tweet me that"])
+    @twuckoo.setup do |config|
+      config[:tweet_limit] = 2
+    end
+    @twuckoo.expects(:tweet).times(5)
+    @twuckoo.run
+  end
+
 end

data/spec/twuckoo/runner_spec.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe Twuckoo::Runner do
   before do
-    @twuckoo = Twuckoo::Runner.new(["file"])
+    @twuckoo = Twuckoo::Runner.create(["file"])
     # actual text tweets should not be tweeted (twittered?)
     @twuckoo.stubs(:send_tweet).returns(true)
   end
@@ -25,7 +25,7 @@ describe Twuckoo::Runner do
       config[:time_to_sleep] = "1h"
     end
     #TODO: write a custom matcher so this could be written as:
-    # @twuckoo.should_not wait_between_tweets    
+    # @twuckoo.should_not wait_between_tweets
     @twuckoo.wait_between_tweets?.should == true
   end
 
@@ -36,11 +36,22 @@ describe Twuckoo::Runner do
     @twuckoo.config[:time_to_sleep].should == "3m"
   end
 
+  it "can be made to tweet only a certain number of times" do
+    @twuckoo.stubs(:store).returns(nil)
+    @twuckoo.stubs(:wait_between_tweets?).returns(false)
+    @twuckoo.stubs(:next).returns("tweet me this")
+    @twuckoo.setup do |config|
+      config[:tweet_limit] = 2
+    end
+    @twuckoo.expects(:tweet).times(2)
+    @twuckoo.run
+  end
+
   it "should receive the module to use as the last parameter" do
     runner = Twuckoo::Runner.new(%w[file])
-    runner.used_module.should == OneLineFromFile    
+    runner.should respond_to(:reset)
   end
-  
+
   it "name can be given through the -n option" do
     runner = Twuckoo::Runner.new(%w[-n pragthinklearn file])
     runner.name.should == "pragthinklearn"
@@ -50,7 +61,7 @@ describe Twuckoo::Runner do
     runner = Twuckoo::Runner.new(%w[file])
     runner.name.should == "twuckoo"
   end
-  
+
   describe "loading values from the config file" do
     it "sets the time interval to wait b/w tweets correctly" do
       @twuckoo.expects(:get_config_values_from_file).returns({ :time_to_sleep => "3m" })
@@ -59,17 +70,6 @@ describe Twuckoo::Runner do
     end
   end
 
-  describe "when there is nothing to tweet" do
-    before do
-      @twuckoo.stubs(:next).returns(nil)
-      @twuckoo.stubs(:load_tweets).returns(nil)
-    end
-    it "does not call store" do
-      @twuckoo.expects(:store).never
-      @twuckoo.run
-    end
-  end
-  
   describe "when there is nothing more to tweet after a while" do
     before do
       @twuckoo.setup do |config|
@@ -83,5 +83,5 @@ describe Twuckoo::Runner do
       @twuckoo.run
     end
   end
-  
+
 end

data/spec/wikipedia_tfa_spec.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe "A cuckoo twitterer for wikipedia featured article" do
   before do
-    @twuckoo = Twuckoo::Runner.new(["wikipedia_tfa"])
+    @twuckoo = Twuckoo::Runner.create(["wikipedia_tfa"])
     @twuckoo.setup do |config|
       config[:time_to_sleep] = "0"
     end

data/twuckoo.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{twuckoo}
-  s.version = "0.3.5"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Balint Erdi"]
-  s.date = %q{2010-01-18}
+  s.date = %q{2010-04-26}
   s.default_executable = %q{twuckoo}
-  s.description = %q{      A simple yet elegant solution to tweet a message regularly from a file (from a webpage, a database, etc.)
+  s.description = %q{      A simple yet elegant solution to tweet a message regularly from a file (or from a webpage, a database, etc.)
 }
   s.email = %q{balint.erdi@gmail.com}
   s.executables = ["twuckoo"]
@@ -48,7 +48,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/balinterdi/twuckoo}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Need to tweet periodically in an automated fashion? Then Twuckoo is for you!}
   s.test_files = [
     "spec/duration_string_spec.rb",

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: twuckoo
 version: !ruby/object:Gem::Version 
-  version: 0.3.5
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Balint Erdi
@@ -9,70 +14,92 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-18 00:00:00 +01:00
+date: 2010-04-26 00:00:00 +02:00
 default_executable: twuckoo
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 5
         version: 0.9.5
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: twibot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 7
         version: 0.1.7
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: hpricot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 164
         version: 0.6.164
-    version: 
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: mail
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
         version: 1.6.0
-    version: 
+  type: :runtime
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: tlsmail
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 1
         version: 0.0.1
-    version: 
-description: "      A simple yet elegant solution to tweet a message regularly from a file (from a webpage, a database, etc.)\n"
+  type: :runtime
+  version_requirements: *id006
+description: "      A simple yet elegant solution to tweet a message regularly from a file (or from a webpage, a database, etc.)\n"
 email: balint.erdi@gmail.com
 executables: 
 - twuckoo
@@ -119,18 +146,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Need to tweet periodically in an automated fashion? Then Twuckoo is for you!