twog 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+coverage/
+pkg/
+*.swp

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jason Meridth
+
+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.textile

@@ -0,0 +1,47 @@
+h1. twog
+
+h2. Install
+
+sudo gem install twog
+
+h2. OAuth
+
+Please read "this":http://blog.jasonmeridth.com/2010/04/02/oauth.html if you want to know how to get your Twitter OAuth consumer key/secret and access token/secret.
+One you have those, run the rake command:
+
+bq. rake generate_config
+
+and a hidden configuration file will be created in the your home folder (~/.twog.yaml).  Once there, please fill it out with the information necessary to use this tool.
+
+h2. Bitly API
+
+In order to use Bitly for URL shortening, you'll need to go to http://bit.ly and click the "Sign Up":http://bit.ly/account/register?rd=/ link on the top right and get an account.  Once you are logged-in you click the "Account":http://bit.ly/account link in the same top right area.  You will see your API Key in the middle of the page.
+
+Put your bit.ly username and api key into the ~/.twog.yaml file to be used in the code.
+
+h2. cron
+
+The idea is to setup cron to run the bin/twog script.
+
+"Crontab HowTo":http://www.unixgeeks.org/security/newbie/unix/cron-1.html
+
+For example, I run 'crontab -e' and this lets me edit my user's crontab file and I put the following:
+
+bq. */15 * * * * jmeridth twog 
+
+Will be wiring up the cronedit gem later
+
+h2. TODO
+
+Please check the TODO file for items that are to be done in the near future.
+
+h2. Technical Reviewers
+
+Chris MacGown ("ChristopherMacGown":http://github.com/ChristopherMacGown)
+Matt Dietz ("cerberus98":http://github.com/cerberus98)
+Paul Voccio ("pvo":http://github.com/pvo)
+Joe Ocampo ("agilejoe":http://github.com/agilejoe)
+
+h2. Copyright
+
+Copyright (c) 2010 Jason Meridth. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+require 'rake/gempackagetask'
+  
+
+namespace :twog do
+  desc "Generate .twog.yaml file"
+  task :conf_create do
+    AUTH_FILE_NAME = "#{ENV['HOME']}/.twog.yaml"
+    
+    AUTH_CONFIG_FILE = <<-EOS
+  rss_feed: 'http://url.com/feed.rss'
+  consumer_key: 'consumer key'
+  consumer_secret: 'consumer secret'
+  access_token: 'access token'
+  access_secret: 'access secret'
+  bitly_username: 'username'
+  bitly_api_key: 'api key'
+  last_blog_post_tweeted:
+    EOS
+
+    abort "#{ENV['HOME']}/.twog.yaml already exists" if File.exists?(AUTH_FILE_NAME)
+
+    File.open(AUTH_FILE_NAME, 'w') {|f| f.write(AUTH_CONFIG_FILE) } 
+  end
+  
+  desc "Clean out the coverage and the pkg"
+  task :clean do
+    rm_rf 'coverage'
+    rm_rf 'pkg'
+  end
+end
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--color']
+end
+
+namespace :spec do  
+  desc "Run rcov on the spec files"
+  Spec::Rake::SpecTask.new(:coverage) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+end
+
+begin
+  gem 'jeweler', '>= 0.11.0'
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "twog"
+    s.summary = %Q{Tool to tweet blog posts}
+    s.email = "jmeridth@gmail.com"
+    s.homepage = "http://github.com/armmer/twog"
+    s.description = "Tool to tweet blog posts"
+    s.authors = ["Jason Meridth"]
+    s.rubyforge_project = "twog"
+    s.add_dependency('twitter_oauth', '>= 0.3.3')
+    s.add_dependency('bitly', '>= 0.4.0')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler --version '>= 0.11.0'"
+  exit(1)
+end
+

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:minor: 2
+:patch: 0
+:build: 
+:major: 0

data/bin/twog

@@ -1,9 +1,48 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
 require 'twog'
+require 'optparse'
+
+help = <<HELP
+Twog is a tool to tweet blog posts.
+
+  Configuration is read from your home directory in the file '.twog.yaml'
+  
+  SAMPLE cong.yaml:
+  rss_feed: 'http://url.com/feed.rss'
+  consumer_key: 'consumer key'
+  consumer_secret: 'consumer secret'
+  access_token: 'access token'
+  access_secret: 'access secret'
+  bitly_username: 'username'
+  bitly_api_key: 'api key'
+  last_blog_post_tweeted:
+
+HELP
+
+options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on("--version", "Display current version") do
+    puts "Jekyll " + Twog.version
+    exit 0
+  end
+end
+
+# Read command line options into `options` hash
+opts.parse!
+
+# Get args from the command line
+case ARGV.size
+  when > 0
+    puts "Invalid options. Run `twog --help` for assistance."
+    exit(1)
+end
 
-raise "please run 'rake gen_config' to create the ~/.twog.yaml file" unless File.exists?("#{ENV['HOME']}/.twog.yaml")
+raise "please run 'rake twog:conf_create' to create the ~/.twog.yaml file" unless File.exists?("#{ENV['HOME']}/.twog.yaml")
 conf = YAML.load_file("#{ENV['HOME']}/.twog.yaml")
 
 Twog.run(conf)

data/lib/twog.rb

@@ -1,5 +1,13 @@
+#rubygems
 require 'rubygems'
+
+# 3rd party
+require 'twitter_oauth'
 require 'yaml'
+require 'rss'
+require 'bitly'
+
+# internal requires
 require 'twog/rss_parser'
 require 'twog/blog_posts_handler'
 require 'twog/twitter_handler'
@@ -24,4 +32,9 @@ class Twog
     return nil unless (bitly_username && bitly_api_key)
     Bitly.new(bitly_username, bitly_api_key)
   end
+  
+  def self.version
+    yml = YAML.load(File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION.yml])))
+    "#{yml[:major]}.#{yml[:minor]}.#{yml[:patch]}"
+  end
 end

data/lib/twog/blog_posts_handler.rb

@@ -1,6 +1,4 @@
-require 'rubygems'
-require 'twitter_oauth'
-require 'yaml'
+
 
 module BlogPostsHandler
   def get_new_blog_posts(posts, last_blog_post_tweeted)

data/lib/twog/rss_parser.rb

@@ -1,6 +1,3 @@
-require 'rubygems'
-require 'rss'
-
 module RssParser
   def parse(rss_feed_url)
     raise Exception.new('RSS feed missing') unless rss_feed_url

data/lib/twog/twitter_handler.rb

@@ -1,9 +1,3 @@
-require 'rubygems'
-require 'twitter_oauth'
-require 'yaml'
-require 'rss'
-require 'bitly'
-
 class RSS::Atom::Feed::Entry
   def <=>(other_entry)
     this_time = Time.parse(updated.content.to_s)

data/spec/blog_posts_handler_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe BlogPostsHandler do 
+  include TwogSpecHelper
+  include BlogPostsHandler
+
+  before(:each) do
+    entry = rss_entry
+    entry.updated.content = Time.new
+    @posts = [entry]
+    @last_blog_post_tweeted = test_conf['last_blog_post_tweeted']
+  end
+  
+  it "should determine that there is one new blog post to tweet" do
+    posts = get_new_blog_posts(@posts, @last_blog_post_tweeted)
+    posts.length.should == 1
+  end
+
+  it "should return zero if posts are nil" do
+    posts = get_new_blog_posts(nil, @last_blog_post_tweeted)
+    posts.length.should == 0
+  end
+  
+  it "should return zero if no posts are passed" do
+    posts = get_new_blog_posts([], @last_blog_post_tweeted)
+    posts.length.should == 0
+  end
+
+  it "should return the posts if there is no last_blog_post_tweeted in the conf file" do
+    posts = get_new_blog_posts(@posts, nil)
+    posts.length.should == 1
+  end
+end

data/spec/rss_parser_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe RssParser do 
+  include TwogSpecHelper
+  include RssParser
+
+  it "should throw exception if rss_feed isn't provided" do
+    lambda { parse(nil) }.should raise_error('RSS feed missing')
+  end
+
+  it "should read the rss_feed_url and parse the items" do
+    self.stub!(:open).and_return(rss_feed_url_content)
+    items = parse(test_conf)
+    items.length.should == 1
+    items[0].title.content.should == "Pair Programming"
+    items[0].link.href.should == "http://blog.jasonmeridth.com/2009/01/29/pair-programming.html"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+require "lib/twog"
+require 'rss'
+
+module TwogSpecHelper
+  def test_conf
+    @conf = {'rss_feed' => 'rss feed',
+      'bitly_username' => 'username',
+      'bitly_api_key' => 'api key',
+      'consumer_key' => 'consumerkey',
+      'consumer_secret' => 'consumersecret',
+      'access_token' => 'accesstoken',
+      'access_secret' => 'accesssecret',
+      'last_blog_post_tweeted' => '31 Mar 2010 07:52:17 -0600'}
+  end
+
+  def rss_feed_entry
+    entry=<<-EOS
+     <entry>
+       <title>Pair Programming</title>
+       <link href="http://blog.jasonmeridth.com/2009/01/29/pair-programming.html"/>
+       <updated>2009-01-29T00:00:00-08:00</updated>
+       <id>http://blog.jasonmeridth.com/2009/01/29/pair-programming</id>
+       <content type="html">&lt;h1&gt;Pair Programming&lt;/h1&gt;
+    &lt;p class=&quot;meta&quot;&gt;29 Jan 2009 &amp;#8211; San Antonio&lt;/p&gt;
+    &lt;p&gt;I recently found this post, &lt;a href=&quot;http://blog.jayfields.com/2008/02/pair-programming-all-time.html&quot;&gt;Pair Programming all the time&lt;/a&gt;, by &lt;a href=&quot;http://blog.jayfields.com/&quot;&gt;Jay Fields&lt;/a&gt; and loved it.  I&amp;#8217;ve felt the same way about pair programming.&lt;/p&gt;
+    &lt;blockquote&gt;
+    &lt;p&gt;&amp;#8220;I define all the time (in terms of pairing) as when I&amp;#8217;m writing code that I&amp;#8217;m going to commit.&amp;#8221;&lt;/p&gt;
+    &lt;/blockquote&gt;
+    &lt;p&gt;That is perfect.  Common sense but stated explicitly.  I worked in an Agile shop for 2 1/2 years and the environment was setup to highlight pair programming.  Pictures and little explanation &lt;a href=&quot;http://www.lostechies.com/blogs/joe_ocampo/archive/2007/12/09/where-the-magic-happens-our-dev-lap.aspx&quot;&gt;here&lt;/a&gt; (Thanks Joe).  We even marked tasks in the stories as low (L) or high (H) to dictate whether a pair was necessary (this was decided during our modeling week by the two developers who tasked the story, but always up for discussion during the iteration).  It worked out pretty well.&lt;/p&gt;
+    &lt;p&gt;I understand and have heard all the reasons to not pair program.  Sometimes it works and sometimes it doesn&amp;#8217;t.  I&amp;#8217;ve personally experienced the benefits.  You learn to work with different personalities and that can only benefit you in your professional career.  And, the obvious reason, is immediate code review.  But, as my friend Scott C. Reynolds &lt;a href=&quot;http://www.lostechies.com/blogs/scottcreynolds/archive/2009/01/23/on-teaching-learning-and-being-honest-with-ourselves.aspx&quot;&gt;says&lt;/a&gt; (more or less):&lt;/p&gt;
+    &lt;blockquote&gt;
+    &lt;p&gt;&amp;#8220;Not everyone is cut from the same cloth&amp;#8221;&lt;/p&gt;
+    &lt;/blockquote&gt;
+    &lt;p&gt;That is true and that is life.  I hope this helps someone understand that not all pair programming enthusiasts are zealots.   I know it&amp;#8217;s a fine line though.&lt;/p&gt;</content>
+     </entry>
+     EOS
+     return entry
+  end
+
+  def rss_entry
+    rss = RSS::Parser.parse(rss_feed_url_content)
+    rss.items[0]
+  end
+
+  def rss_feed_url_content
+    post=<<-EOS
+    <?xml version="1.0" encoding="utf-8"?>
+    <feed xmlns="http://www.w3.org/2005/Atom">
+     
+     <title>Jason Meridth</title>
+     <link href="http://blog.jasonmeridth.com/atom.xml" rel="self"/>
+     <link href="http://blog.jasonmeridth.com/"/>
+     <updated>2010-04-04T13:15:31-07:00</updated>
+     <id>http://blog.jasonmeridth.com/</id>
+     <author>
+       <name>Jason Meridth</name>
+       <email>jmeridth@gmail.com</email>
+     </author>
+    EOS
+    return "#{post}#{rss_feed_entry}"
+  end
+end

data/spec/twitter_handler_spec.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + "/spec_helper"
+require 'rubygems'
+require 'rss'
+
+describe TwitterHandler do 
+  include TwogSpecHelper
+  include TwitterHandler
+
+  before(:each) do
+    @posts = [rss_entry]
+    @conf = test_conf
+  end
+  
+  it "should do nothing if no posts are provided" do
+    tweet(nil, nil, nil)
+    tweet([], nil, nil)
+  end
+
+  it "should throw exception if oauth consumer key isn't provided" do
+    @conf['consumer_key'] = nil
+    lambda { tweet(@posts, @conf, nil) }.should raise_error('OAuth Consumer Key missing')
+  end
+  
+  it "should throw exception if oauth consumer secret isn't provided" do
+    @conf['consumer_secret'] = nil
+    lambda { tweet(@posts, @conf, nil) }.should raise_error('OAuth Consumer Secret missing')
+  end
+  
+  it "should throw exception if oauth access token isn't provided" do
+    @conf['access_token'] = nil
+    lambda { tweet(@posts, @conf, nil) }.should raise_error('OAuth Access Token missing')
+  end
+ 
+  it "should throw exception if oauth access secret isn't provided" do
+    @conf['access_secret'] = nil
+    lambda { tweet(@posts, @conf, nil) }.should raise_error('OAuth Access Secret missing')
+  end
+  
+  it "should shorten the blog post url with bitly when bitly handler is provided" do
+    bitly = mock 'bitly'
+    bitly_url = mock 'bitly_url'
+    bitly.should_receive(:shorten).and_return(bitly_url)
+    bitly_url.should_receive(:short_url)
+    self.stub!(:use_twitter_oauth)
+    self.stub!(:update_config_file_with_latest_tweet_date)
+    tweet(@posts, @conf, bitly)
+  end
+
+  it "should make sure the text that is tweeted is at or less than 140 chars when the title is at or greater than 140 chars" do
+    text = ensure_text_is_of_length(140, "1234567890"*14, "http://bit.ly/Afr8s9") 
+    text.should == "blogged: 12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 http://bit.ly/Afr8s9"
+    text.length.should == 140
+  end
+
+  it "should make sure the text that is tweeted is at or less than 140 chars when the title is less than 140 chars" do
+    text = ensure_text_is_of_length(140, "1234567890", "http://bit.ly/Afr8s9") 
+    text.should == "blogged: 1234567890 http://bit.ly/Afr8s9"
+    text.length.should == 40
+  end
+end

data/spec/twog_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe Twog do 
+  include TwogSpecHelper
+
+  it "should not tweet if there are no new blog posts" do
+    Twog.stub!(:parse).with(test_conf['rss_feed']).and_return(1)
+    Twog.stub!(:get_new_blog_posts).with(1, test_conf['last_blog_post_tweeted']).and_return([])
+    Twog.stub!(:tweet).and_return(1)
+    result = Twog.run(test_conf)
+    result.should be nil
+  end
+  
+  it "should parse the rss feed and tweet new blog posts" do
+    entry = rss_entry
+    Twog.stub!(:parse).with(test_conf['rss_feed']).and_return(1)
+    Twog.stub!(:get_new_blog_posts).with(1, test_conf['last_blog_post_tweeted']).and_return([entry])
+    Twog.stub!(:get_bitly_from)
+    Twog.stub!(:tweet).and_return(1)
+    result = Twog.run(test_conf)
+    result.should == 1
+  end
+
+  it "should return nil if bitly username is nil" do
+    conf = test_conf
+    conf['bitly_username'] = nil
+    Twog.get_bitly_from(conf).should be nil
+  end
+  
+  it "should return nil if bitly api key is nil" do
+    conf = test_conf
+    conf['bitly_username'] = nil
+    Twog.get_bitly_from(conf).should be nil
+  end
+
+  it "should return nil if bitly api key is nil" do
+    Bitly.stub!(:new).and_return("hello")
+    Twog.get_bitly_from(test_conf).should == "hello"
+  end
+end

data/twog.gemspec

@@ -0,0 +1,69 @@
+# 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{twog}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Meridth"]
+  s.date = %q{2010-04-08}
+  s.default_executable = %q{twog}
+  s.description = %q{Tool to tweet blog posts}
+  s.email = %q{jmeridth@gmail.com}
+  s.executables = ["twog"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION.yml",
+     "bin/twog",
+     "lib/twog.rb",
+     "lib/twog/blog_posts_handler.rb",
+     "lib/twog/rss_parser.rb",
+     "lib/twog/twitter_handler.rb",
+     "spec/blog_posts_handler_spec.rb",
+     "spec/rss_parser_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/twitter_handler_spec.rb",
+     "spec/twog_spec.rb",
+     "twog.gemspec"
+  ]
+  s.homepage = %q{http://github.com/armmer/twog}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{twog}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Tool to tweet blog posts}
+  s.test_files = [
+    "spec/blog_posts_handler_spec.rb",
+     "spec/rss_parser_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/twitter_handler_spec.rb",
+     "spec/twog_spec.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_runtime_dependency(%q<twitter_oauth>, [">= 0.3.3"])
+      s.add_runtime_dependency(%q<bitly>, [">= 0.4.0"])
+    else
+      s.add_dependency(%q<twitter_oauth>, [">= 0.3.3"])
+      s.add_dependency(%q<bitly>, [">= 0.4.0"])
+    end
+  else
+    s.add_dependency(%q<twitter_oauth>, [">= 0.3.3"])
+    s.add_dependency(%q<bitly>, [">= 0.4.0"])
+  end
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jason Meridth
@@ -41,8 +41,8 @@ dependencies:
         segments: 
         - 0
         - 4
-        - 3
-        version: 0.4.3
+        - 0
+        version: 0.4.0
   type: :runtime
   version_requirements: *id002
 description: Tool to tweet blog posts
@@ -51,21 +51,33 @@ executables:
 - twog
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.textile
 files: 
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION.yml
 - bin/twog
+- lib/twog.rb
 - lib/twog/blog_posts_handler.rb
 - lib/twog/rss_parser.rb
 - lib/twog/twitter_handler.rb
-- lib/twog.rb
+- spec/blog_posts_handler_spec.rb
+- spec/rss_parser_spec.rb
+- spec/spec_helper.rb
+- spec/twitter_handler_spec.rb
+- spec/twog_spec.rb
+- twog.gemspec
 has_rdoc: true
 homepage: http://github.com/armmer/twog
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -89,5 +101,9 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Tool to tweet blog posts
-test_files: []
-
+test_files: 
+- spec/blog_posts_handler_spec.rb
+- spec/rss_parser_spec.rb
+- spec/spec_helper.rb
+- spec/twitter_handler_spec.rb
+- spec/twog_spec.rb