twitter_alert 0.1.0 → 0.1.1

data/lib/twitter_alert/account.rb

@@ -1,5 +1,9 @@
 module TwitterAlert
+
+  # This represents the Twitter account you'll use to send DMs from.
   class Account
+
+    # Config is a hash that needs :user_name and :password keys.
     def initialize config
       # Load hash from yaml file in default location?
 
@@ -15,6 +19,9 @@ module TwitterAlert
       )
     end
 
+    # Sends the text of message to all of the account's followers. Message's class should include the TwitterAlert::Alert Module.
+    #
+    # Returns true if things went well and false if any DMs failed.
     def announce message
       followers.each do |follower|
         begin
@@ -27,6 +34,7 @@ module TwitterAlert
       message.mark_sent
     end
 
+    # Returns an array of ids of all the followers of the account.
     def followers
       @client.followers.ids?
     end

data/lib/twitter_alert/alert.rb

@@ -1,21 +1,35 @@
 module TwitterAlert
+
+  # Mix this in to a class you want to represent the messages you'll DM out.
   module Alert
-    attr_reader :text, :date, :failed_announcements
 
+    # The text to be DMed out.
+    attr_reader :text
+
+    # The date it should be DMed out.
+    attr_reader :date
+
+    # An array of hashes containing the id and error text of any DMs that didn't work.
+    attr_reader :failed_announcements
+
+    # Text will have to_s called on it. Date will have #to_s and then fed to DateTime.parse
     def initialize text, date
       @text = text.to_s
       @date = DateTime.parse(date.to_s)
       @failed_announcements = []
     end
 
+    # Returns boolean based on whether this messages was successfully sent to all followers or not.
     def sent?
       @sent
     end
 
+    # Marks this message as sent unless there are stored failed announcements.
     def mark_sent
       @sent = @failed_announcements.empty?
     end
 
+    # Stores a failed announcement so that you can see who and why the failure occured.
     def add_failed_announcement follower_id, error_text
       @failed_announcements << { :follower_id => follower_id, :error_text => error_text }
     end

data/twitter_alert.gemspec

@@ -0,0 +1,96 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{twitter_alert}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Hamill"]
+  s.date = %q{2010-05-14}
+  s.description = %q{Create messages, assign a time, then DM all Followers of a Twitter account with those messages as the assigned time.}
+  s.email = %q{twitteralert@benhamill.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "doc/LICENSE.html",
+     "doc/README_rdoc.html",
+     "doc/TwitterAlert.html",
+     "doc/TwitterAlert/Account.html",
+     "doc/TwitterAlert/Alert.html",
+     "doc/created.rid",
+     "doc/images/brick.png",
+     "doc/images/brick_link.png",
+     "doc/images/bug.png",
+     "doc/images/bullet_black.png",
+     "doc/images/bullet_toggle_minus.png",
+     "doc/images/bullet_toggle_plus.png",
+     "doc/images/date.png",
+     "doc/images/find.png",
+     "doc/images/loadingAnimation.gif",
+     "doc/images/macFFBgHack.png",
+     "doc/images/package.png",
+     "doc/images/page_green.png",
+     "doc/images/page_white_text.png",
+     "doc/images/page_white_width.png",
+     "doc/images/plugin.png",
+     "doc/images/ruby.png",
+     "doc/images/tag_green.png",
+     "doc/images/wrench.png",
+     "doc/images/wrench_orange.png",
+     "doc/images/zoom.png",
+     "doc/index.html",
+     "doc/js/darkfish.js",
+     "doc/js/jquery.js",
+     "doc/js/quicksearch.js",
+     "doc/js/thickbox-compressed.js",
+     "doc/lib/twitter_alert/account_rb.html",
+     "doc/lib/twitter_alert/alert_rb.html",
+     "doc/lib/twitter_alert_rb.html",
+     "doc/rdoc.css",
+     "lib/twitter_alert.rb",
+     "lib/twitter_alert/account.rb",
+     "lib/twitter_alert/alert.rb",
+     "test/helper.rb",
+     "test/test_account.rb",
+     "test/test_alert.rb",
+     "twitter_alert.gemspec"
+  ]
+  s.homepage = %q{http://github.com/BenHamill/twitter_alert}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Send scheduled Direct Messages to all Twitter Followers.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_account.rb",
+     "test/test_alert.rb"
+  ]
+
+  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_development_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_runtime_dependency(%q<grackle>, [">= 0.1.9"])
+    else
+      s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_dependency(%q<grackle>, [">= 0.1.9"])
+    end
+  else
+    s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+    s.add_dependency(%q<grackle>, [">= 0.1.9"])
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ben Hamill
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-06 00:00:00 -05:00
+date: 2010-05-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,12 +61,48 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- doc/LICENSE.html
+- doc/README_rdoc.html
+- doc/TwitterAlert.html
+- doc/TwitterAlert/Account.html
+- doc/TwitterAlert/Alert.html
+- doc/created.rid
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_green.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/quicksearch.js
+- doc/js/thickbox-compressed.js
+- doc/lib/twitter_alert/account_rb.html
+- doc/lib/twitter_alert/alert_rb.html
+- doc/lib/twitter_alert_rb.html
+- doc/rdoc.css
 - lib/twitter_alert.rb
 - lib/twitter_alert/account.rb
 - lib/twitter_alert/alert.rb
 - test/helper.rb
 - test/test_account.rb
 - test/test_alert.rb
+- twitter_alert.gemspec
 has_rdoc: true
 homepage: http://github.com/BenHamill/twitter_alert
 licenses: []