twuckoo 0.3.4 → 0.3.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2010 Balint Erdi (balint.erdi@gmail.com)
+
+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.

data/README.markdown

@@ -7,15 +7,15 @@ Need to tweet periodically and in an automated fashion? Then Twuckoo is for you.
 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
+      ...
+      while next_tweet do
+        tweet(next_tweet)
+        wait if wait_between_tweets?
+        next_tweet = self.next
+        notify if next_tweet.nil?
       end
     end
-
+    
 It is very simple in its design but opens vast possibilities due to its modular approach.
 
 ## A simple API
@@ -36,19 +36,19 @@ Hands the last tweeted message to be stored. In the case of the one\_line\_from_
     
 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
+* 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.
+  Scraps Wikipedia's main page and extracts the name and link of Today's Featured Article. This is not as general a module as `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
+    gem install twuckoo --source http://gemcutter.org
     
-Twuckoo depends on twibot which will also get installed with the above command.
+Twuckoo depends on twibot and a couple of other gems 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:
 
@@ -59,11 +59,17 @@ For more options, see [twibot's README](http://github.com/cjohansen/twibot/tree/
 
 ## 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:
+Twuckoo's configuration options have to be written into `config/twuckoo.yml`. The current options are:
 
-    time_to_sleep: 1h
+  * time_to_sleep
+  
+By default, it is "1d", so the script will "relax" for 24 hours after tweeting. 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 :)
 
-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 :)
+  * user
+  * 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.)
 
 ## Running
 
@@ -71,7 +77,7 @@ 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.
+Will make use of the `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
 
@@ -79,9 +85,17 @@ or
 
 (see above)
 
+You can also provide a `name` for the twuckoo instance which appears in the notifications (if you do not provide a name explicitly, the name of the directory in which your twuckoo instance runs will get used):
+
+    $ twuckoo -n pragthinklearn file
+
 ## 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:
+In the course of the development of this gem I "ate my own dogfood" so you'll find at least one twitter account for each of the modules:
+
+* [Pragmatic Thinking and Learning](http://twitter.com/pragthinklearn)
+
+  An concise advice from the excellent [Pragmatic Thinking and Learning](http://pragprog.com/titles/ahptl/pragmatic-thinking-and-learning) book
 
 * [Daily Oblique](http://twitter.com/daily_oblique)
 
@@ -95,8 +109,8 @@ If you set up something with twuckoo, I would like to know about it, so that I m
 
 ## 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.
+This software is released under the MIT license (see attached). 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>
+Any feedback (especially bug reports!) is highly appreciated, please report them [here](http://github.com/balinterdi/twuckoo/issues) or contact me at <balint@codigoergosum.com>
 
-Original idea and development: [Balint Erdi](http://bucionrails.com)
+Original idea and development: [Balint Erdi](http://codigoergosum.com)

data/Rakefile

@@ -16,6 +16,7 @@ begin
     gemspec.add_dependency("twibot", ">=0.1.7")
     gemspec.add_dependency("hpricot", ">= 0.6.164")
     gemspec.add_dependency("mail", ">= 1.6.0")
+    gemspec.add_dependency("tlsmail", ">= 0.0.1")
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

data/lib/twuckoo/runner.rb

@@ -1,5 +1,7 @@
 require "optparse"
 require "ostruct"
+require "twibot"
+require "mail"
 
 class TwuckooException < Exception
 end

data/twuckoo.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{twuckoo}
-  s.version = "0.3.4"
+  s.version = "0.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Balint Erdi"]
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".gitignore",
      "CHANGELOG",
+     "MIT-LICENSE",
      "Manifest",
      "README.markdown",
      "Rakefile",
@@ -68,12 +69,14 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<twibot>, [">= 0.1.7"])
       s.add_runtime_dependency(%q<hpricot>, [">= 0.6.164"])
       s.add_runtime_dependency(%q<mail>, [">= 1.6.0"])
+      s.add_runtime_dependency(%q<tlsmail>, [">= 0.0.1"])
     else
       s.add_dependency(%q<mocha>, [">= 0.9.5"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<twibot>, [">= 0.1.7"])
       s.add_dependency(%q<hpricot>, [">= 0.6.164"])
       s.add_dependency(%q<mail>, [">= 1.6.0"])
+      s.add_dependency(%q<tlsmail>, [">= 0.0.1"])
     end
   else
     s.add_dependency(%q<mocha>, [">= 0.9.5"])
@@ -81,6 +84,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<twibot>, [">= 0.1.7"])
     s.add_dependency(%q<hpricot>, [">= 0.6.164"])
     s.add_dependency(%q<mail>, [">= 1.6.0"])
+    s.add_dependency(%q<tlsmail>, [">= 0.0.1"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: twuckoo
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors: 
 - Balint Erdi
@@ -62,6 +62,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.6.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: tlsmail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        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"
 email: balint.erdi@gmail.com
 executables: 
@@ -73,6 +83,7 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - CHANGELOG
+- MIT-LICENSE
 - Manifest
 - README.markdown
 - Rakefile