wase_endpoint 0.0.0 → 0.0.1

data/.gitignore

@@ -1 +1,2 @@
-*.log
+*.log
+pkg/

data/README.rdoc

@@ -6,7 +6,7 @@ WaseEndpoint is a library for building daemons that act as WASE Endpoints for th
   
 WaseEndpoint is hosted by http://gemcutter.com. Please make sure you have added them to your gem sources.
 
-  $ sudo gem install WaseEndpoint
+  $ sudo gem install wase_endpoint
 
 == Usage
 
@@ -21,9 +21,18 @@ Your endpoint logic:
 
   class MyEndpoint < WaseEndpoint
 
-    # Just return our json as it came in.
+    # This where our logic goes.
+    # A json encoded String is the only argument. You can deal with this however
+    # you want. The JSON library is already loaded should you wish to use it.
+    # Return another String, or a Hash containing the String and the program
+    # counter increment you wish to use.
     def secret_sauce(raw_json)
+    
+      # Just pass it back. Program counter increment will be 1.
       raw_json
+      
+      # Or pass it back with a custom program counter.
+      # { :data => raw_json, :increment => 2}
     end
 
   end
@@ -39,11 +48,15 @@ The init file:
                   :logfile => 'my_endpoint.log',
                   :sleep_period => 60 )
 
+Now running the init file will start your daemon. The PID will be returned to allow you to monitor it or kill it later.
+
+  ruby init.rb
+
 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: 
+Issues can be tracked on github: http://github.com/dougal/wase_endpoint/issues
 
 All of the above are most welcome. mailto:dougal.s@gmail.com
 

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/example/my_endpoint.rb

@@ -3,9 +3,18 @@ require 'wase_endpoint'
 
 class MyEndpoint < WaseEndpoint
   
-  # Just return our json as it came in.
+  # This where our logic goes.
+  # A json encoded String is the only argument. You can deal with this however
+  # you want. The JSON library is already loaded should you wish to use it.
+  # Return another String, or a Hash containing the String and the program
+  # counter increment you wish to use.
   def secret_sauce(raw_json)
+  
+    # Just pass it back. Program counter increment will be 1.
     raw_json
+    
+    # Or pass it back with a custom program counter.
+    # { :data => raw_json, :increment => 2}
   end
   
 end

data/lib/wase_endpoint.rb

@@ -42,14 +42,14 @@ class WaseEndpoint
         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'
+            raise IndexError, '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)
+          @twitterer.send(program_listing[message.new_program_counter], message.new_program_counter, message.program_listing_uri, message.output_uri)
         end
         
       end

data/lib/wase_endpoint/message.rb

@@ -14,6 +14,7 @@ class WaseEndpoint
       @output_uri = output_uri.strip
       @input_uri = input_uri.strip if input_uri
       @input_uri_1 = input_uri_1.strip if input_uri_1
+      @increment = 1
     end
     
     def ==(other)
@@ -28,7 +29,17 @@ class WaseEndpoint
       RestClient.get('http://' + @output_uri)
     end
     
+    # Accepts either a String of raw data, or a Hash of data and a program
+    # counter increment.
+    # An Exception will be thrown if this increment is negative.
     def send_input(input)
+      
+      if input.is_a?(Hash)
+        @increment = input[:increment]
+        raise ArgumentError, 'You cannot have negative program counter increments' if @increment < 0
+        input = input[:data]
+      end
+      
       input_uri = 'http://' + (@input_uri || @output_uri)
       
       # RestClient can't follow a redirect for put, so we'll expand it.
@@ -38,6 +49,10 @@ class WaseEndpoint
       RestClient.put(expanded_input_uri, input)
     end
     
+    def new_program_counter
+      @program_counter + @increment
+    end
+    
   end
   
-end
+end

data/lib/wase_endpoint/twitterer.rb

@@ -5,6 +5,9 @@ class WaseEndpoint
       twitter_http_auth = Twitter::HTTPAuth.new(username, password)
       @twitter_client = Twitter::Base.new(twitter_http_auth)
       
+      # Call the test api method to validate the authentication.
+      @twitter_client.help
+      
       # The oldest message ID could be stored here, but since twitter IDs
       # aren't always time-linear, comparing the messages is safer.
       @all_messages = []

data/spec/wase_endpoint_message_spec.rb

@@ -50,15 +50,45 @@ describe WaseEndpoint::Message do
       @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]')
+    describe "sending input data" do
+      
+      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
+      
+      it "should throw an error on negative program counter increment" do
+        Net::HTTP.stub(:new).and_return(mock(Net::HTTP, :head => 'http://example.com'))
+        RestClient.stub(:put)
+        
+        lambda {
+          @message.send_input({:data => 'foo', :increment => -1})
+        }.should raise_error(ArgumentError, 'You cannot have negative program counter increments')
+      end
       
-      @message.send_input('[1, 2, 3, 4]')
     end
-    
+
+      
+    describe "incrementing the program counter" do
+      
+      it "should be one" do
+        @message.new_program_counter.should == 1
+      end
+      
+      it "should should be two" do
+        Net::HTTP.stub(:new).and_return(mock(Net::HTTP, :head => 'http://example.com'))
+        RestClient.stub(:put)
+        @message.send_input({:data => 'foo', :increment => 2})
+        
+        @message.new_program_counter.should == 2
+      end
+      
+    end
+      
   end
   
   describe "with one input URI" do
@@ -76,7 +106,7 @@ describe WaseEndpoint::Message do
       @message.input_uri_1.should be_nil
     end
 
-    it "should send the input data using the expanded output URI" do
+    it "should send the input data using the expanded input 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)

data/spec/wase_endpoint_twitterer_spec.rb

@@ -12,6 +12,16 @@ describe WaseEndpoint::Twitterer do
     WaseEndpoint::Twitterer.new(username, password)
   end
   
+  it "should validate the authentication with the help method" do
+    username ='foo'
+    password = 'bar'
+    Twitter::HTTPAuth.stub(:new)
+    Twitter::Base.stub(:new).and_return(mock_twitter_base)
+    mock_twitter_base.should_receive(:help)
+
+    @twitterer = WaseEndpoint::Twitterer.new(username, password)
+  end
+  
   describe "fetching messages" do
     
     before(:all) do
@@ -72,8 +82,8 @@ describe WaseEndpoint::Twitterer do
     @auth_mock ||= mock(Twitter::HTTPAuth)
   end
   
-  def mock_twitter_base
-    @base_mock ||= mock(Twitter::Base)
+  def mock_twitter_base(stubs = {:help => true})
+    @base_mock ||= mock(Twitter::Base, stubs)
   end
   
   def mock_mash(message_id)

data/wase_endpoint.gemspec

@@ -0,0 +1,57 @@
+# 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{wase_endpoint}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Douglas F Shearer"]
+  s.date = %q{2009-11-06}
+  s.description = %q{WaseEndpoint is a library for building daemons that act as WASE Endpoints for http://bit.ly/3qRMbv}
+  s.email = %q{dougal.s@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.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",
+     "wase_endpoint.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dougal/wase_endpoint}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{WaseEndpoint is a library for building daemons that act as WASE Endpoints for http://bit.ly/3qRMbv}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/wase_endpoint_message_spec.rb",
+     "spec/wase_endpoint_spec.rb",
+     "spec/wase_endpoint_twitterer_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
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wase_endpoint
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Douglas F Shearer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-05 00:00:00 +00:00
+date: 2009-11-06 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,7 @@ files:
 - spec/wase_endpoint_message_spec.rb
 - spec/wase_endpoint_spec.rb
 - spec/wase_endpoint_twitterer_spec.rb
+- wase_endpoint.gemspec
 has_rdoc: true
 homepage: http://github.com/dougal/wase_endpoint
 licenses: []