mcornick-laika 0.2.0

data/README.markdown

@@ -0,0 +1,57 @@
+# Laika
+
+## 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.
+
+## Installation
+
+Laika is delivered as a RubyGem:
+
+    sudo gem install mcornick-laika --source http://gems.github.com
+
+## Usage
+
+There are two steps you'll need to do to authenticate your application to Yammer. First, you'll need to register your application with Yammer. Log in to Yammer as the user under whose account the messages should appear. Then go to https://www.yammer.com/client_applications/new. You will be asked to describe your application. Fill out the form and submit it. This will provide you with a client key and secret. Make note of them as you will need them for the next step.
+
+Then, you'll need to do the OAuth exchange, which will give you an access token and secret. Open up a terminal and run:
+
+    laika-auth
+
+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:
+
+    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')
+
+There is a script called laika-post that demonstrates how to do this.
+
+## 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.

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/laika/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'laika'
+  s.version          = Laika::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.markdown)
+  s.summary          = "Barks about new blog posts via the Yammer API and OAuth."
+  s.author           = 'Mark Cornick'
+  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.add_dependency('oauth', '>=0.2.7')
+  s.add_dependency('feed-normalizer', '>=1.5.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/bin/laika-auth

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'oauth/consumer'
+require 'yaml'
+
+puts "Please enter your client key, then hit Return."
+consumer_key = gets.chomp
+puts "Please enter your client secret, then hit Return."
+consumer_secret = gets.chomp
+
+begin
+  consumer = OAuth::Consumer.new consumer_key, consumer_secret, { :site => "https://www.yammer.com" } 
+  request_token = consumer.get_request_token
+  puts "Please go to:\n#{request_token.authorize_url}\nin your browser. Click Authorize on that page.\nHit Return here when you are done."
+  gets
+  access_token = request_token.get_access_token
+  credentials = {
+    :consumer_key => consumer.key,
+    :consumer_secret => consumer.secret,
+    :access_token => access_token.token,
+    :access_token_secret => access_token.secret
+  }
+  begin
+    File.open('laika.yml', 'w') { |file| YAML.dump(credentials, file) }
+    File.chmod(0600, 'laika.yml')
+    puts "Your credentials have been saved."
+  rescue
+    puts "Couldn't save your credentials."
+  end
+rescue
+  puts "Couldn't authorize with Yammer. Did you enter your client credentials correctly?"
+end

data/bin/laika-post

@@ -0,0 +1,10 @@
+#!/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

data/lib/laika.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), 'laika/blog')
+require File.join(File.dirname(__FILE__), 'laika/yammer')

data/lib/laika/blog.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'feed-normalizer'
+require 'open-uri'
+
+module Laika
+  class Blog
+    attr_reader :feed
+
+    def initialize(url)
+      @url = url
+      @seen_ids = []
+      get_new_entries
+    end
+
+    def get_new_entries
+      @feed = FeedNormalizer::FeedNormalizer.parse(open(@url))
+      feed_ids = @feed.entries.collect{|e| e.id}
+      new_ids = feed_ids - @seen_ids
+      @seen_ids += new_ids
+      @feed.entries.select{|e| new_ids.include?(e.id)}
+    end
+  end
+end

data/lib/laika/version.rb

@@ -0,0 +1,13 @@
+module Laika
+  module Version
+    
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 0
+    
+    def self.to_s
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/lib/laika/yammer.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'oauth/consumer'
+require 'yaml'
+
+module Laika
+  class Yammer
+
+    class CouldNotLoadCredentials < Exception; end
+    class CouldNotPost < Exception; end
+    
+    attr_reader :access_token
+    
+    def initialize(credential_file='laika.yml')
+      begin
+        @credentials = YAML.load_file(credential_file)
+      rescue
+        raise CouldNotLoadCredentials, "Couldn't load your Yammer credentials. You may need to run laika-auth."
+      end
+      @consumer = OAuth::Consumer.new(@credentials[:consumer_key], @credentials[:consumer_secret], {:site => "https://www.yammer.com"})
+      @access_token = OAuth::AccessToken.new(@consumer, @credentials[:access_token], @credentials[:access_token_secret])
+    end
+
+    def post(message)
+      response = @access_token.post('/api/v1/messages', {:body => message}, {'Accept' => 'application/xml'})
+      if response.is_a?(Net::HTTPCreated)
+        true
+      else
+        raise CouldNotPost, response.body
+      end
+    end
+
+  end
+end

data/test/blog_test.rb

@@ -0,0 +1,38 @@
+require 'test_common'
+
+class BlogTest < Test::Unit::TestCase
+
+  context 'A Blog object' do
+    setup do
+      @stubbed_entries = [stub(:id => 1), stub(:id => 2)]
+      @stubbed_feed = stub(:entries => @stubbed_entries)
+      FeedNormalizer::FeedNormalizer.stubs(:parse).returns(@stubbed_feed)
+      @blog = Laika::Blog.new('http://example.com/')
+    end
+
+    context 'being created' do
+      should 'get new entries' do
+        assert_equal @stubbed_entries, @blog.feed.entries
+      end
+    end
+
+    context 'getting new entries' do
+      context 'on first invocation' do
+        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
+          @new_entry = stub(:id => 3)
+          @stubbed_entries << @new_entry
+          @stubbed_feed.stubs(:entries).returns(@stubbed_entries)
+        end
+        should 'return only new entries' do
+          assert_equal [@new_entry], @blog.get_new_entries
+        end
+      end
+    end
+  end
+end

data/test/test_common.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require 'shoulda'
+require File.join(File.dirname(__FILE__), '../lib/laika')

data/test/yammer_test.rb

@@ -0,0 +1,62 @@
+require 'test_common'
+
+class YammerTest < Test::Unit::TestCase
+
+  context 'A Yammer object' do
+    context 'being created' do
+      context 'without laika.yml available' do
+        should 'raise CouldNotLoadCredentials' do
+          YAML.expects(:load_file).with('laika.yml').raises(Errno::ENOENT)
+          assert_raise(Laika::Yammer::CouldNotLoadCredentials) do
+            Laika::Yammer.new
+          end
+        end
+      end
+      context 'with laika.yml available' do
+        setup do
+          YAML.expects(:load_file).with('laika.yml').returns({})
+        end
+        should 'not raise any exceptions' do
+          assert_nothing_raised do
+            @yammer = Laika::Yammer.new
+          end
+        end
+        should 'produce an access token' do
+          OAuth::Consumer.expects(:new).returns(true)
+          OAuth::AccessToken.expects(:new).returns(true)
+          @yammer = Laika::Yammer.new
+          assert @yammer.access_token
+        end
+      end
+    end
+
+    context 'posting a message' do
+      setup do
+        YAML.expects(:load_file).with('laika.yml').returns({})
+        OAuth::Consumer.expects(:new).returns(true)
+        @access_token = stub()
+        OAuth::AccessToken.expects(:new).returns(@access_token)
+      end
+
+      context 'if successful' do
+        should 'return true' do
+          @access_token.expects(:post).returns(Net::HTTPCreated.new(nil,nil,nil))
+          @yammer = Laika::Yammer.new
+          assert_equal true, @yammer.post('pants')
+        end
+      end
+
+      context 'if unsuccessful' do
+        should 'raise CouldNotPost' do
+          # FIXME: lame mocking - should try to really grok what Net::HTTP is doing
+          NilClass.any_instance.expects(:closed?).returns(false)
+          @access_token.expects(:post).returns(Net::HTTPUnauthorized.new(nil,nil,nil))
+          @yammer = Laika::Yammer.new
+          assert_raise(Laika::Yammer::CouldNotPost) do
+            @yammer.post('pants')
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: mcornick-laika
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Mark Cornick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: feed-normalizer
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: 
+email: mark.cornick@viget.com
+executables: 
+- laika-auth
+- laika-post
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- lib/laika
+- lib/laika/blog.rb
+- lib/laika/version.rb
+- lib/laika/yammer.rb
+- lib/laika.rb
+- test/blog_test.rb
+- test/test_common.rb
+- test/yammer_test.rb
+- bin/laika-auth
+- bin/laika-post
+has_rdoc: true
+homepage: http://www.viget.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Barks about new blog posts via the Yammer API and OAuth.
+test_files: []
+