wase_endpoint 0.0.0

data/.gitignore

@@ -0,0 +1 @@
+*.log

data/README.rdoc

@@ -0,0 +1,53 @@
+= WaseEndpoint
+
+WaseEndpoint is a library for building daemons that act as WASE Endpoints for the EngineYard Wase competition: http://bit.ly/3qRMbv
+
+== Install
+  
+WaseEndpoint is hosted by http://gemcutter.com. Please make sure you have added them to your gem sources.
+
+  $ sudo gem install WaseEndpoint
+
+== Usage
+
+The following are all in the example directory.
+
+Your endpoint logic:
+
+  # example/my_endpoint.rb
+  
+  require 'rubygems'
+  require 'wase_endpoint'
+
+  class MyEndpoint < WaseEndpoint
+
+    # Just return our json as it came in.
+    def secret_sauce(raw_json)
+      raw_json
+    end
+
+  end
+  
+The init file:
+  
+  # example/init.rb
+
+  require 'my_endpoint'
+
+  MyEndpoint.new( :username => 'twitter_username',
+                  :password => 'twitter_password',
+                  :logfile => 'my_endpoint.log',
+                  :sleep_period => 60 )
+
+That's it! I also included a basic sinatra server in 'server.rb' that can be used as an input/output/program-listing node.
+
+== Problems, Comments, Suggestions?
+
+Issues can be tracked on github: 
+
+All of the above are most welcome. mailto:dougal.s@gmail.com
+
+
+== Credits
+
+Douglas F Shearer - http://douglasfshearer.com

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "wase_endpoint"
+    gemspec.summary = "WaseEndpoint is a library for building daemons that act as WASE Endpoints for http://bit.ly/3qRMbv"
+    gemspec.description = gemspec.summary
+    gemspec.email = "dougal.s@gmail.com"
+    gemspec.homepage = "http://github.com/dougal/wase_endpoint"
+    gemspec.authors = ["Douglas F Shearer"]  
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/example/init.rb

@@ -0,0 +1,6 @@
+require 'my_endpoint'
+
+MyEndpoint.new( :username => 'twitter_username',
+                :password => 'twitter_password',
+                :logfile => 'my_endpoint.log',
+                :sleep_period => 60 )

data/example/my_endpoint.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'wase_endpoint'
+
+class MyEndpoint < WaseEndpoint
+  
+  # Just return our json as it came in.
+  def secret_sauce(raw_json)
+    raw_json
+  end
+  
+end

data/example/server.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'sinatra'
+
+get '/' do
+  # Pass back some json data.
+  "[1,2,3]"
+end
+
+put '/' do
+  # Print out the data.
+  puts params.inspect
+end
+
+get '/listing' do
+  "[\"@twitter_id_1\",\"@twitter_id_2\"]"
+end

data/lib/wase_endpoint.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'twitter'
+require 'json'
+require 'rest_client'
+require 'robustthread'
+
+require 'wase_endpoint/message'
+require 'wase_endpoint/twitterer'
+
+class WaseEndpoint
+  
+  def initialize(options={})
+    @logger = Logger.new(options[:logfile])
+    @twitterer = Twitterer.new(options[:username], options[:password])
+    @sleep_period = options[:sleep_period] || 60
+    
+    start
+  end
+  
+  # Override this.
+  # Argument is a json encoded string.
+  # Should return a json encoded string.
+  def secret_sauce(raw_json)
+    raise Exception, 'You need to override secret_sauce'
+  end
+  
+  protected
+  
+  def logger
+    @logger
+  end
+  
+  def start
+    RobustThread.logger = @logger
+    pid = fork do
+      RobustThread.loop(:seconds => @sleep_period, :label => 'Checking for new messages and processing them') do
+        
+        # Grab any new messages.
+        messages = @twitterer.fetch
+        @logger.info "Processing #{messages.size} messages"
+        
+        messages.each do |message|
+          program_listing = message.fetch_program_listing
+          if message.program_counter >= program_listing.size
+            throw Exception 'Program counter has gone too far'
+          end
+          
+          # Here's where your magic happens.
+          message.send_input(secret_sauce(message.fetch_output))
+          
+          # Tell the next endpoint.
+          @twitterer.send(program_listing[message.program_counter + 1], message.program_counter + 1, message.program_listing_uri, message.output_uri)
+        end
+        
+      end
+      sleep
+    end
+    puts pid
+    Process.detach pid
+  end
+  
+end

data/lib/wase_endpoint/message.rb

@@ -0,0 +1,43 @@
+class WaseEndpoint
+  
+  class Message
+    
+    attr_reader :program_counter, :program_listing_uri, :timestamp, :output_uri, :input_uri, :input_uri_1, :id
+    
+    def initialize(id, raw_message)
+      myname_and_hashtag, program_counter, program_listing_uri, unix_timestamp, output_uri, input_uri, input_uri_1 = raw_message.split(/,/)
+      
+      @id = id
+      @program_counter = program_counter.to_i
+      @program_listing_uri = program_listing_uri.strip
+      @timestamp = unix_timestamp.to_i
+      @output_uri = output_uri.strip
+      @input_uri = input_uri.strip if input_uri
+      @input_uri_1 = input_uri_1.strip if input_uri_1
+    end
+    
+    def ==(other)
+      @id == other.id
+    end
+    
+    def fetch_program_listing
+      JSON.parse(RestClient.get('http://' + @program_listing_uri))
+    end
+    
+    def fetch_output
+      RestClient.get('http://' + @output_uri)
+    end
+    
+    def send_input(input)
+      input_uri = 'http://' + (@input_uri || @output_uri)
+      
+      # RestClient can't follow a redirect for put, so we'll expand it.
+      input_uri[/bit\.ly(\/\w+)/]
+      expanded_input_uri = Net::HTTP.new('bit.ly').head($1)['Location']
+      
+      RestClient.put(expanded_input_uri, input)
+    end
+    
+  end
+  
+end

data/lib/wase_endpoint/twitterer.rb

@@ -0,0 +1,37 @@
+class WaseEndpoint
+  class Twitterer
+        
+    def initialize(username, password)
+      twitter_http_auth = Twitter::HTTPAuth.new(username, password)
+      @twitter_client = Twitter::Base.new(twitter_http_auth)
+      
+      # The oldest message ID could be stored here, but since twitter IDs
+      # aren't always time-linear, comparing the messages is safer.
+      @all_messages = []
+    end
+    
+    # Fetches the timeline and returns any new messages.
+    def fetch
+      new_messages = []
+      
+      # Ignore any messages that don't have the hashtag.
+      # Use twitter search to do this instead?
+      @twitter_client.replies.reject{|m| !m.text[/#wase/]}.each do |reply|
+        message = Message.new(reply.id, reply.text)
+        
+        # Skip if we've already processed this message.
+        unless @all_messages.include?(message)
+          @all_messages << message
+          new_messages << message
+        end
+      end
+      new_messages
+    end
+    
+    def send(recipient, program_counter, program_list_uri, output_uri, input_uri=nil, input_uri_1=nil)
+      text = ["#{recipient} #wase", program_counter, program_list_uri, Time.now.utc.to_i, output_uri, input_uri, input_uri_1].compact.join(', ')
+      @twitter_client.update(text)
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'wase_endpoint.rb'

data/spec/wase_endpoint_message_spec.rb

@@ -0,0 +1,120 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'spec_helper'
+
+describe WaseEndpoint::Message do
+  
+  describe "with no input URI" do
+    
+    before(:all) do
+      raw_message = "@ey-sort #wase, 0, bit.ly/7yQK6, 1256850843, bit.ly/2uhGcl"
+      @message = WaseEndpoint::Message.new(123, raw_message)
+    end
+
+    it "should return the id" do
+      @message.id.should == 123
+    end
+
+    it "should return the program counter as an integer" do
+      @message.program_counter.should == 0
+    end
+
+    it "should return the program listing url without whitespace" do
+      @message.program_listing_uri.should == 'bit.ly/7yQK6'
+    end
+
+    it "should return the timestamp as an integer" do
+      @message.timestamp.should == 1256850843
+    end
+    
+    it "should return the output uri without whitespace" do
+      @message.output_uri.should == 'bit.ly/2uhGcl'
+    end
+    
+    it "should return the input uri as nil" do
+      @message.input_uri.should be_nil
+    end
+
+    it "should return the second input uri as nil" do
+      @message.input_uri_1.should be_nil
+    end
+    
+    it "should fetch the program listing as an array" do
+      RestClient.should_receive(:get).with('http://bit.ly/7yQK6').and_return('["@ey-sort", "@ey-firsthalf", "@ey-firsthalf", "@engineyard"]')
+      
+      @message.fetch_program_listing.should == ["@ey-sort", "@ey-firsthalf", "@ey-firsthalf", "@engineyard"]
+    end
+    
+    it "should fetch the output data" do
+      RestClient.should_receive(:get).with('http://bit.ly/2uhGcl').and_return('[58, 92, 12, 18, 76]')
+      
+      @message.fetch_output.should == '[58, 92, 12, 18, 76]'
+    end
+    
+    it "should send the input data using the expanded output URI" do
+      mock_net_http = mock(Net::HTTP)
+      mock_net_http.should_receive(:head).with('/2uhGcl').and_return({'Location' => 'http://example.com/'})
+      Net::HTTP.should_receive(:new).with('bit.ly').and_return(mock_net_http)
+      RestClient.should_receive(:put).with('http://example.com/', '[1, 2, 3, 4]')
+      
+      @message.send_input('[1, 2, 3, 4]')
+    end
+    
+  end
+  
+  describe "with one input URI" do
+    
+    before(:all) do
+      raw_message = "@ey-sort #wase, 0, bit.ly/7yQK6, 1256850843, bit.ly/2uhGcl, bit.ly/3kl0xs"
+      @message = WaseEndpoint::Message.new(123, raw_message)
+    end
+    
+    it "should return the input uri without whitespace" do
+      @message.input_uri.should == 'bit.ly/3kl0xs'
+    end
+
+    it "should return the second input uri as nil" do
+      @message.input_uri_1.should be_nil
+    end
+
+    it "should send the input data using the expanded output URI" do
+      mock_net_http = mock(Net::HTTP)
+      mock_net_http.should_receive(:head).with('/3kl0xs').and_return({'Location' => 'http://example.com/'})
+      Net::HTTP.should_receive(:new).with('bit.ly').and_return(mock_net_http)
+      RestClient.should_receive(:put).with('http://example.com/', '[1, 2, 3, 4]')
+
+      @message.send_input('[1, 2, 3, 4]')
+    end
+    
+  end
+  
+  describe "with two input URIs" do
+    
+    before(:all) do
+      raw_message = "@ey-sort #wase, 0, bit.ly/7yQK6, 1256850843, bit.ly/2uhGcl, bit.ly/3kl0xs, bit.ly/3kl0xt"
+      @message = WaseEndpoint::Message.new(123, raw_message)
+    end
+
+    it "should return the second input uri without whitespace" do
+      @message.input_uri_1.should == 'bit.ly/3kl0xt'
+    end
+    
+  end
+  
+  describe "comparison via ID" do
+    
+    before(:all) do
+      @raw_message = "@ey-sort #wase, 0, bit.ly/7yQK6, 1256850843, bit.ly/2uhGcl"
+      @message_1 = WaseEndpoint::Message.new(123, @raw_message)
+    end
+    
+    it "should equal" do
+      @message_1.should == WaseEndpoint::Message.new(123, @raw_message) 
+    end
+    
+    it "should not be equal" do
+      @message_1.should_not == WaseEndpoint::Message.new(456, @raw_message) 
+    end
+    
+  end
+  
+end

data/spec/wase_endpoint_spec.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'spec_helper'
+
+describe WaseEndpoint do
+
+  it "should be a valid class object" do
+    WaseEndpoint.should be_a(Class)
+  end
+
+  it "should have more specs"
+
+end

data/spec/wase_endpoint_twitterer_spec.rb

@@ -0,0 +1,83 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'spec_helper'
+
+describe WaseEndpoint::Twitterer do
+  
+  it "should return a twitter client object" do
+    username ='foo'
+    password = 'bar'
+    Twitter::HTTPAuth.should_receive(:new).with(username, password).and_return(mock_twitter_http_auth)
+    Twitter::Base.should_receive(:new).with(mock_twitter_http_auth).and_return(mock_twitter_base)
+    
+    WaseEndpoint::Twitterer.new(username, password)
+  end
+  
+  describe "fetching messages" do
+    
+    before(:all) do
+      username ='foo'
+      password = 'bar'
+      Twitter::HTTPAuth.stub(:new)
+      Twitter::Base.stub(:new).and_return(mock_twitter_base)
+
+      @twitterer = WaseEndpoint::Twitterer.new(username, password)
+    end
+    
+    it "should return the latest message" do
+      mock_twitter_base.should_receive(:replies).and_return([mock_mash(123)])
+      messages = @twitterer.fetch
+      messages.size.should == 1
+      messages.first.class.should == WaseEndpoint::Message
+    end
+
+    it "should return an empty messages array" do
+      mock_twitter_base.should_receive(:replies).and_return([mock_mash(123)])
+      @twitterer.fetch.should == []
+    end
+    
+  end
+
+  describe "sending messages" do
+    
+    before(:all) do
+      username ='foo'
+      password = 'bar'
+      Twitter::HTTPAuth.stub(:new)
+      Twitter::Base.stub(:new).and_return(mock_twitter_base)
+      
+      @time = Time.now
+      Time.stub(:now).and_return(@time)
+
+      @twitterer = WaseEndpoint::Twitterer.new(username, password)
+    end
+    
+    it "should send a message with all inputs" do
+      mock_twitter_base.should_receive(:update).with("@a #wase, 10, pl_uri, #{@time.utc.to_i}, o_uri, i_uri, i_1_uri")
+      @twitterer.send('@a', 10, 'pl_uri', 'o_uri', 'i_uri', 'i_1_uri')
+    end
+    
+    it "should send a message with only one input" do
+      mock_twitter_base.should_receive(:update).with("@a #wase, 10, pl_uri, #{@time.utc.to_i}, o_uri, i_uri")
+      @twitterer.send('@a', 10, 'pl_uri', 'o_uri', 'i_uri')
+    end
+    
+    it "should send a message with no inputs" do
+      mock_twitter_base.should_receive(:update).with("@a #wase, 10, pl_uri, #{@time.utc.to_i}, o_uri")
+      @twitterer.send('@a', 10, 'pl_uri', 'o_uri')
+    end
+    
+  end
+
+  def mock_twitter_http_auth
+    @auth_mock ||= mock(Twitter::HTTPAuth)
+  end
+  
+  def mock_twitter_base
+    @base_mock ||= mock(Twitter::Base)
+  end
+  
+  def mock_mash(message_id)
+    mock(Mash, :id => message_id, :text => '@ey-sort #wase, 0, bit.ly/7yQK6, 1256850843, bit.ly/2uhGcl, bit.ly/3kl0xs')
+  end
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: wase_endpoint
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Douglas F Shearer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-05 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: WaseEndpoint is a library for building daemons that act as WASE Endpoints for http://bit.ly/3qRMbv
+email: dougal.s@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- example/init.rb
+- example/my_endpoint.rb
+- example/server.rb
+- lib/wase_endpoint.rb
+- lib/wase_endpoint/message.rb
+- lib/wase_endpoint/twitterer.rb
+- spec/spec_helper.rb
+- spec/wase_endpoint_message_spec.rb
+- spec/wase_endpoint_spec.rb
+- spec/wase_endpoint_twitterer_spec.rb
+has_rdoc: true
+homepage: http://github.com/dougal/wase_endpoint
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: WaseEndpoint is a library for building daemons that act as WASE Endpoints for http://bit.ly/3qRMbv
+test_files: 
+- spec/spec_helper.rb
+- spec/wase_endpoint_message_spec.rb
+- spec/wase_endpoint_spec.rb
+- spec/wase_endpoint_twitterer_spec.rb