asir 0.2.0

data/example/unsafe_service.rb

@@ -0,0 +1,12 @@
+require 'asir'
+
+module UnsafeService
+  include ASIR::Client
+  def self.do_it(expr)
+    result = eval(expr)
+    puts "#{$$}: UnsafeService.do_it(#{expr}) #{result.inspect}"
+    $stderr.puts "#{$$}: UnsafeService.do_it => #{result.inspect}"
+    result
+  end
+end
+

data/hack_night/README.txt

@@ -0,0 +1,18 @@
+These exercises will introduce ASIR and its concepts.
+Slides: 
+http://kurtstephens.com/pub/ruby/abstracting_services_in_ruby/asir.slides/
+git clone git://github.com/kstephens/abstracting_services_in_ruby.git
+Gems: httpclient, libxml-ruby
+
+* Writing a service as a ruby Module.
+* Using the default ASIR Coder and Transport to access a service using a client Proxy.
+* Using a Subprocess Transport.
+* Creating new Coders.
+* Creating an HTTP transport using HTTPClient and WEBrick. 
+* Chaining Coders.
+* Using Broadcast Transports for logging.
+
+Read the slides for more info or ask questions.
+Read the examples/*.rb files for basic examples.
+See the hack_night/example/ files.
+Peek at solutions in the solution/ dir.

data/hack_night/exercise/prob-1.rb

@@ -0,0 +1,18 @@
+# prob-1.rb
+# Write a MathService module that has a method that can sum an Array of Numbers
+# It should raise an exception if not given an Array.
+# It should raise an exception if any elements are not Numeric.
+
+module MathService
+  def sum array_of_numbers
+    # ???
+  end
+  extend self
+end
+
+######################################################################
+
+begin
+  puts MathService.sum([1, 2, 3]) # => 6
+end
+

data/hack_night/exercise/prob-2.rb

@@ -0,0 +1,21 @@
+# Call the MathService using the ASIR::Client mixin.
+# Assume the default Transport and Coder.
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir'
+
+module MathService
+  include # ???
+  def sum array_of_numbers
+    # ???
+  end
+  extend self
+end
+
+######################################################################
+# Driver:
+
+begin
+  puts MathService # ???  # => 6
+end
+

data/hack_night/exercise/prob-3.rb

@@ -0,0 +1,16 @@
+# Call the MathService using the ASIR::Transport::Subprocess mixin.
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir'
+
+require 'math_service'
+MathService.send(:include, ASIR::Client)
+
+######################################################################
+# Driver:
+
+begin
+  MathService.client.transport = # ??? 
+  MathService.client.transport._log_enabled = true
+  puts MathService.client.sum([1, 2, 3])
+end

data/hack_night/exercise/prob-4.rb

@@ -0,0 +1,36 @@
+# Write a Coder that can encode an Array of Numbers as a String and decode a String into a Number.
+# Hint: inspect .vs. eval
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir'
+
+module ASIR
+  class Coder
+    class Simple < self
+      def _encode obj
+        # ???
+      end
+      def _decode obj
+        raise TypeError unless String === obj
+        # ???
+      end
+    end
+  end
+end
+
+######################################################################
+
+begin
+  input = [ 1, 2, 3 ]
+  puts "input  = #{input.inspect}"
+
+  coder = ASIR::Coder::Simple.new
+  coder._log_enabled = true
+
+  output = coder.encode(input)
+  puts "output = #{output.inspect}"
+
+  result = coder.decode(output)
+  puts "result = #{result.inspect}"
+end
+

data/hack_night/exercise/prob-5.rb

@@ -0,0 +1,36 @@
+# Write a Base64 Coder.
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir'
+
+module ASIR
+  class Coder
+    class Base64 < self
+      def _encode obj
+        raise TypeError unless String === obj
+        # ???
+      end
+
+      def _decode obj
+        raise TypeError unless String === obj
+        # ???
+      end
+    end
+  end
+end
+
+######################################################################
+
+begin
+  input = "abc123"
+  puts "input  = #{input.inspect}"
+
+  coder = ASIR::Coder::Base64.new
+  coder._log_enabled = true
+
+  output = coder.encode(input)
+  puts "output = #{output.inspect}"
+
+  result = coder.decode(output)
+  puts "result = #{result.inspect}"
+end

data/hack_night/exercise/prob-6.rb

@@ -0,0 +1,95 @@
+# Write a ASIR::Transport::HTTP class.
+# Using HTTP::Client for transport send_message and receive_result.
+# Using WEBrick for transport on the receive_message and send_result.
+# Use the Marshal Coder for the Transport.
+
+require 'rubygems'
+require 'webrick'
+gem 'httpclient'
+require 'httpclient'
+require 'uri'
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir'
+
+require 'math_service'
+
+module ASIR
+  class Transport
+    class HTTP < self
+      attr_accessor :uri, :server, :debug
+
+      # Client-side: HTTPClient
+
+      # Should HTTP put the request payload String to the uri.
+      # Return the HTTPClient result Message object.
+      def _send_message message, message_payload
+        client = ::HTTPClient.new
+        # ???
+      end
+
+      # Should extract the content from the HTTPClient::Respone
+      def _receive_result httpclient_response_message
+        # ???
+      end
+
+      # Server-side: WEBrick
+
+      # Extract the body from the WEBrick request.
+      def _receive_message webrick_request
+        # ???
+      end
+
+      # Set the WEBrick response Content-Type.
+      # Set the WEBrick response body with the result_payload String.
+      def _send_result result_payload, webrick_result
+        # ???
+      end
+
+      # Parse the port and path of the #uri.
+      # Create a @server = WEBrick::HTTPServer on the port.
+      # Mount the path with a proc that calls serve_request! with the HTTP request and response objects.
+      def setup_webrick_server!
+        # ???
+        self
+      end
+
+      # Start the WEBbrick @server.
+      def start_webrick_server!
+        # ???
+        self
+      end
+    end
+  end
+end
+
+
+port = 3001
+begin
+  t = # ???
+  t._log_enabled = true
+
+  c = t.encoder = ASIR::Coder::Marshal.new
+  c._log_enabled = true
+
+  # Setup and start the WEBrick server in a child process.
+  server_pid = Process.fork do
+    # ???
+    # ???
+  end
+  sleep 1 # wait for server to start
+
+  # system("curl http://localhost:#{port}/")
+
+  MathService.client.transport = t
+
+  MathService.client.sum([1, 2, 3])
+
+rescue Exception => err
+  $stderr.puts "ERROR: #{err.inspect}\n#{err.backtrace * "\n"}"
+
+ensure
+  # Kill the server.
+  sleep 1
+  Process.kill(9, server_pid)
+end

data/hack_night/exercise/prob-7.rb

@@ -0,0 +1,34 @@
+# Use the Marshal and Base64 coders with the HTTP transport.
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir_transport_http'
+require 'asir_coder_base64'
+
+require 'math_service'
+MathService.send(:include, ASIR::Client)
+
+port = 3001
+begin
+  t = ASIR::Transport::HTTP.new(:uri => "http://localhost:#{port}")
+  t._log_enabled = true
+
+  c = t.encoder = ASIR::Coder::# ???.new(:encoders => ???)
+  c._log_enabled = true
+
+  server_pid = Process.fork do
+    t.setup_server!
+    t.start_server!
+  end
+  sleep 1 # wait for server to start
+
+  MathService.client.transport = t
+  MathService.client.sum([1, 2, 3])
+
+rescue Exception => err
+  $stderr.puts "ERROR: #{err.inspect}\n#{err.backtrace * "\n"}"
+
+ensure
+  sleep 1 # wait for server to finish
+  Process.kill(9, server_pid)
+end
+

data/hack_night/solution/math_service.rb

@@ -0,0 +1,11 @@
+
+module MathService
+  def sum array_of_numbers
+    raise TypeError unless Array === array_of_numbers
+    array_of_numbers.inject(0) do | s, e |
+      raise TypeError unless Numeric === e
+      s += e
+    end
+  end
+  extend self
+end

data/hack_night/solution/prob-1.rb

@@ -0,0 +1,12 @@
+# Write a MathService module that has a method that can sum an Array of Numbers
+# It should raise an exception if not given an Array.
+# It should raise an exception if any elements are not Numeric.
+
+require 'math_service'
+
+######################################################################
+
+begin
+  puts MathService.sum([1, 2, 3]) # => 6
+end
+

data/hack_night/solution/prob-2.rb

@@ -0,0 +1,15 @@
+# Call the MathService using the ASIR::Client mixin.
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir'
+
+require 'math_service'
+MathService.send(:include, ASIR::Client)
+
+######################################################################
+# Driver:
+
+begin
+  MathService.client.transport._log_enabled = true
+  puts MathService.client.sum([1, 2, 3])
+end

data/hack_night/solution/prob-3.rb

@@ -0,0 +1,17 @@
+# Call the MathService using the ASIR::Transport::Subprocess mixin.
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir'
+require 'asir/transport/subprocess'
+
+require 'math_service'
+MathService.send(:include, ASIR::Client)
+
+######################################################################
+# Driver:
+
+begin
+  MathService.client.transport = ASIR::Transport::Subprocess.new
+  MathService.client.transport._log_enabled = true
+  puts MathService.client.sum([1, 2, 3])
+end

data/hack_night/solution/prob-4.rb

@@ -0,0 +1,37 @@
+# Write a Coder that can encode an Array of Numbers as a String and decode a String into a Number.
+# Hint: inspect .vs. eval
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir'
+
+module ASIR
+  class Coder
+    class Simple < self
+      def _encode obj
+        obj.inspect
+      end
+
+      def _decode obj
+        raise TypeError unless String === obj
+        Object.send(:eval, obj)
+      end
+    end
+  end
+end
+
+######################################################################
+
+begin
+  input = [ 1, 2, 3 ]
+  puts "input  = #{input.inspect}"
+
+  coder = ASIR::Coder::Simple.new
+  coder._log_enabled = true
+
+  output = coder.encode(input)
+  puts "output = #{output.inspect}"
+
+  result = coder.decode(output)
+  puts "result = #{result.inspect}"
+end
+

data/hack_night/solution/prob-5.rb

@@ -0,0 +1,21 @@
+# Write a Base64 Coder
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir/coder/base64'
+
+######################################################################
+
+begin
+  input = "abc123"
+  puts "input  = #{input.inspect}"
+
+  coder = ASIR::Coder::Base64.new
+  coder._log_enabled = true
+
+  output = coder.encode(input)
+  puts "output = #{output.inspect}"
+
+  result = coder.decode(output)
+  puts "result = #{result.inspect}"
+end
+

data/hack_night/solution/prob-6.rb

@@ -0,0 +1,33 @@
+# Write a ASIR::Transport::HTTP class that uses HTTP::Client for transport send_result and receive_result.
+
+$: << File.expand_path("../../../lib", __FILE__)
+require 'asir/transport/http'
+require 'asir/coder/marshal'
+
+require 'math_service'
+MathService.send(:include, ASIR::Client)
+
+port = 3001
+begin
+  t = ASIR::Transport::HTTP.new(:uri => "http://localhost:#{port}/")
+  t._log_enabled = true
+  c = t.encoder = ASIR::Coder::Marshal.new
+  c._log_enabled = true
+
+  server_pid = Process.fork do
+    t.setup_webrick_server!
+    t.start_webrick_server!
+  end
+  sleep 1 # wait for server to start
+
+  MathService.client.transport = t
+  MathService.client.sum([1, 2, 3])
+
+rescue Exception => err
+  $stderr.puts "ERROR: #{err.inspect}\n#{err.backtrace * "\n"}"
+
+ensure
+  sleep 1
+  Process.kill(9, server_pid)
+end
+