mcornick-laika 0.2.0 → 1.0.0

data/README.markdown

@@ -2,9 +2,7 @@
 
 ## Description
 
-Laika (Russian: Лайка, "barker") is a simple script to monitor an RSS feed, and post to Yammer when new articles are detected.
-
-Currently, only the Yammer posting functionality is implemented.
+Laika (Russian: Лайка, "barker") is a simple script to monitor an RSS or Atom feed, and post to Yammer when new articles are detected.
 
 ## Installation
 
@@ -22,36 +20,35 @@ Then, you'll need to do the OAuth exchange, which will give you an access token
 
 This will prompt you for the client key and secret you just obtained. It will then echo a URL which you will need to visit while still logged in to Yammer as the user from the previous step. You'll be asked to authorize your application. Click the Authorize button, then go back to your terminal and hit Return. The script will then get the access token and secret from Yammer, and store all four pieces of information in a file called laika.yml. **Don't lose this file!** It constitutes the credentials that you will need to do anything useful with Laika. It is not encrypted, so keep it secure. Once you have the laika.yml file, you will not need to do these steps again unless you de-authorize the application.
 
-When the RSS polling functionality is ready, it will be documented here, but for now, you can use Laika to post messages to Yammer like so:
+Now you're ready to start barking about feeds. You can see all Laika's options by running it with the --help option:
+
+    $ ./bin/laika --help
+    Laika 1.0.0
+    Options:
+            --feed-file, -f <s>:   File to store feed data
+      --credential-file, -c <s>:   File with Yammer credential data (from
+                                   laika-auth) (default: laika.yml)
+                  --url, -u <s>:   URL of the feed to bark about
+              --dont-yammer, -d:   Don't post to Yammer, just echo to standard out
+                  --version, -v:   Print version and exit
+                     --help, -h:   Show this message
+
+The only 100% mandatory option is --feed-file, which is a YAML file to which Laika will write the feed data and the posts it has already barked about.
+
+When running for the first time, you will also need to specify --url for the URL of the feed. You should *not* specify --url on subsequent runs unless you want to reset Laika's list of posts it has already barked.
 
-    require 'rubygems'
-    require 'laika'
-    yammer = Laika::Yammer.new('laika.yml') # path to the laika.yml file; default is laika.yml in your current directory
-    yammer.post('I HAZ A SPASE DOG')
+--credential-file specifies the location of the file written by laika-auth. It will default to "laika.yml" in the current directory, but if it is elsewhere, you can specify it here.
 
-There is a script called laika-post that demonstrates how to do this.
+Finally, --dont-yammer is useful for testing, or for avoiding spamming Yammer. It will send announcements of new posts to standard output, rather than to Yammer.
+
+You will probably want to run Laika periodically from cron. When doing so, providing only the --feed-file option should be sufficient (unless you also need to specify a non-default --credential-file.)
 
 ## License
 
 Copyright (C) 2008 Mark Cornick of Viget Labs (http://www.viget.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.
+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/Rakefile

@@ -16,10 +16,11 @@ spec = Gem::Specification.new do |s|
   s.email            = 'mark.cornick@viget.com'
   s.homepage         = 'http://www.viget.com/'
   s.files            = %w(README.markdown Rakefile) + Dir.glob("{lib,test,bin}/**/*")
-  s.executables      = %w(laika-auth laika-post)
+  s.executables      = %w(laika laika-auth)
   
   s.add_dependency('oauth', '>=0.2.7')
   s.add_dependency('feed-normalizer', '>=1.5.1')
+  s.add_dependency('trollop', '>=1.10.2')
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/bin/laika

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'laika'
+require 'laika/version'
+require 'trollop'
+
+opts = Trollop::options do
+  version "Laika #{Laika::Version}"
+  opt :feed_file, "File to store feed data", :type => String
+  opt :credential_file, "File with Yammer credential data (from laika-auth)", :type => String, :default => 'laika.yml'
+  opt :url, "URL of the feed to bark about", :type => String
+  opt :dont_yammer, "Don't post to Yammer, just echo to standard out", :default => false
+end
+
+Trollop::die(:feed_file, "must be specified") unless opts[:feed_file]
+Trollop::die(:url, "must be specified because #{opts[:feed_file]} does not yet exist") if opts[:feed_file] && !opts[:url] && !File.exist?(opts[:feed_file])
+
+unless opts[:url].nil?
+  begin
+    blog = Laika::Blog.new(opts[:url])
+  rescue
+    Trollop::die(:url, "could not be loaded")
+  end
+else
+  begin
+    blog = YAML.load_file(opts[:feed_file])
+  rescue
+    Trollop::die(:feed_file, "could not be loaded")
+  end
+end
+
+begin
+  announcements = blog.get_new_entries.collect { |e| "#{e.authors.first} just posted #{e.title} to #{blog.feed.title}: #{e.urls.first}" }
+rescue
+  Trollop::die(:feed_file, "could not be parsed")
+end
+
+if announcements.any?
+  begin
+    yammer = Laika::Yammer.new(opts[:credential_file]) unless opts[:dont_yammer]
+    announcements.each do |a|
+      unless opts[:dont_yammer]
+        yammer.post a
+      else
+        puts a
+      end
+    end
+  rescue
+    Trollop::die(:credential_file, "does not exist, or did not permit access to Yammer")
+  end
+end
+
+begin
+  File.open(opts[:feed_file], 'w') { |file| YAML.dump(blog, file) }
+rescue
+  Trollop::die(:feed_file, "could not be saved")
+end

data/lib/laika/blog.rb

@@ -9,7 +9,6 @@ module Laika
     def initialize(url)
       @url = url
       @seen_ids = []
-      get_new_entries
     end
 
     def get_new_entries

data/lib/laika/version.rb

@@ -1,8 +1,8 @@
 module Laika
   module Version
     
-    MAJOR = 0
-    MINOR = 2
+    MAJOR = 1
+    MINOR = 0
     TINY  = 0
     
     def self.to_s

data/test/blog_test.rb

@@ -11,20 +11,23 @@ class BlogTest < Test::Unit::TestCase
     end
 
     context 'being created' do
-      should 'get new entries' do
-        assert_equal @stubbed_entries, @blog.feed.entries
+      should 'not have a feed or any entries' do
+        assert_nil @blog.feed
       end
     end
 
     context 'getting new entries' do
       context 'on first invocation' do
+        setup do
+          @blog.get_new_entries
+        end
         should 'return all entries' do
-          # initialize calls get_new_entries the first time
           assert_equal @stubbed_entries, @blog.feed.entries
         end
       end
       context 'on subsequent invocations' do
         setup do
+          @blog.get_new_entries
           @new_entry = stub(:id => 3)
           @stubbed_entries << @new_entry
           @stubbed_feed.stubs(:entries).returns(@stubbed_entries)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mcornick-laika
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Mark Cornick
@@ -30,11 +30,20 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.1
     version: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.10.2
+    version: 
 description: 
 email: mark.cornick@viget.com
 executables: 
+- laika
 - laika-auth
-- laika-post
 extensions: []
 
 extra_rdoc_files: 
@@ -50,8 +59,8 @@ files:
 - test/blog_test.rb
 - test/test_common.rb
 - test/yammer_test.rb
+- bin/laika
 - bin/laika-auth
-- bin/laika-post
 has_rdoc: true
 homepage: http://www.viget.com/
 post_install_message: 

data/bin/laika-post

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require 'laika'
-
-puts "Please enter the text you would like to post to Yammer, then hit Return."
-message = gets.chomp
-
-yammer = Laika::Yammer.new('laika.yml')
-yammer.post message