asir 0.2.0

data/example/asir_control_client_http.rb

@@ -0,0 +1,14 @@
+require 'example_helper'
+require 'asir/transport/http'
+require 'asir/coder/marshal'
+begin
+  Email.client.transport = t =
+    ASIR::Transport::HTTP.new(:uri => "http://localhost:30000/asir")
+  t.encoder = ASIR::Coder::Marshal.new
+  pr Email.client.send_email(:pdf_invoice,
+                             :to => "user@email.com",
+                             :customer => @customer)
+ensure
+  t.close rescue nil
+end
+

data/example/asir_control_client_zmq.rb

@@ -0,0 +1,15 @@
+require 'example_helper'
+require 'asir/transport/zmq'
+require 'asir/coder/marshal'
+begin
+  Email.client.transport = t =
+    ASIR::Transport::Zmq.new :uri => "tcp://localhost:31000" # "/asir"
+  t.one_way = true
+  t.encoder = ASIR::Coder::Marshal.new
+  pr Email.client.send_email(:pdf_invoice,
+                             :to => "user@email.com",
+                             :customer => @customer)
+ensure
+  t.close rescue nil
+end
+

data/example/config/asir_config.rb

@@ -0,0 +1,63 @@
+# Used by asir/bin/asir.
+# Configures asir worker transport and error logging.
+# asir object is bound to ASIR::Main instance.
+
+$stderr.puts "asir.verb = #{asir.verb.inspect}"
+case asir.verb
+when :config
+  # NOTHING
+  true
+when :environment
+  require 'asir'
+  require 'asir/transport/file'
+  require 'asir/coder/marshal'
+  require 'asir/coder/yaml'
+
+  $:.unshift File.expand_path('..')
+  require 'example_helper'
+  require 'sample_service'
+  require 'unsafe_service'
+when :transport
+  # Compose with Marshal for final coding.
+  coder = ASIR::Coder::Marshal.new
+
+  # Logger for worker-side Exceptions.
+  error_log_file = asir.log_file.sub(/\.log$/, '-error.log')
+  error_transport =
+    ASIR::Transport::File.new(:file => error_log_file,
+                              :mode => 'a+',
+                              :perms => 0666)
+  error_transport.encoder = ASIR::Coder::Yaml.new
+
+  # Setup requested Transport.
+  case asir.adjective
+  when :beanstalk
+    transport = ASIR::Transport::Beanstalk.new
+    transport[:worker_processes] = 3
+  when :http, :webrick
+    transport = ASIR::Transport::Webrick.new
+    transport.uri = "http://localhost:#{30000 + asir.identifier.to_s.to_i}/asir"
+  when :rack
+    transport = ASIR::Transport::Rack.new
+    transport.uri = "http://localhost:#{30000 + asir.identifier.to_s.to_i}/asir"
+  when :zmq
+    transport = ASIR::Transport::Zmq.new
+    transport.one_way = true
+    transport.uri = "tcp://localhost:#{31000 + asir.identifier.to_s.to_i}" # /asir"
+  else
+    raise "Cannot configure Transport for #{asir.adjective}"
+  end
+
+  transport.encoder = coder
+  transport._logger = STDERR
+  transport._log_enabled = true
+  transport.verbose = 3
+  transport.on_exception =
+    lambda { | transport, exc, phase, message, *rest |
+      error_transport.send_request(message)
+    }
+
+  transport
+else
+  $stderr.puts "Warning: unhandled asir.verb: #{asir.verb.inspect}"
+end

data/example/delayed_service.rb

@@ -0,0 +1,15 @@
+require 'asir'
+require 'time'
+
+module DelayedService
+  include ASIR::Client
+  def self.do_it(t0)
+    dt = Time.now - t0
+    result = 5 <= dt && dt <= 6 ? :ok : :not_delayed
+    puts "DelayedService.do_it(#{t0.iso8601}) dt=#{dt.inspect} #{result.inspect}"
+    $stderr.puts "DelayedService.do_it => #{result.inspect}"
+    raise "Failed" unless result == :ok
+    result 
+  end
+end
+

data/example/ex01.rb

@@ -0,0 +1,12 @@
+# !SLIDE :capture_code_output true
+# Call service directly
+
+require 'example_helper' # !COMMENT
+pr Email.send_email(:pdf_invoice,
+                    :to => "user@email.com",
+                    :customer => @customer)
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : Email.send_mail :pdf_invoice
+# EXPECT: : pr: :ok

data/example/ex02.rb

@@ -0,0 +1,12 @@
+# !SLIDE :capture_code_output true
+# In-core, in-process service
+
+require 'example_helper'
+pr Email.client.send_email(:pdf_invoice,
+                           :to => "user@email.com",
+                           :customer => @customer)
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : Email.send_mail :pdf_invoice
+# EXPECT: : pr: :ok

data/example/ex03.rb

@@ -0,0 +1,19 @@
+#
+# !SLIDE :capture_code_output true
+# One-way, asynchronous subprocess service
+
+require 'example_helper'
+begin
+  Email.client.transport = t =
+    ASIR::Transport::Subprocess.new
+
+  pr Email.client.send_email(:pdf_invoice,
+                             :to => "user@email.com",
+                             :customer => @customer)
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : Email.send_mail :pdf_invoice
+# EXPECT: : pr: nil
+

data/example/ex04.rb

@@ -0,0 +1,33 @@
+# !SLIDE :capture_code_output true
+# One-way, file log service
+
+require 'example_helper'
+begin
+  File.unlink(service_log = "#{__FILE__}.service.log") rescue nil
+  Email.client.transport = t =
+    ASIR::Transport::File.new(:file => service_log)
+  t.encoder =
+    ASIR::Coder::Yaml.new
+  pr Email.client.send_email(:pdf_invoice,
+                             :to => "user@email.com",
+                             :customer => @customer)
+ensure
+  t.close
+  puts "\x1a\n#{service_log.inspect} contents:"
+  puts File.read(service_log)
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: service.log" contents:
+# EXPECT: pr: nil
+# EXPECT: --- !ruby/object:ASIR::Message
+# EXPECT: --- !ruby/object:ASIR::Message
+# EXPECT: arguments:
+# EXPECT: - :pdf_invoice
+# EXPECT:   :to: user@email.com
+# EXPECT:   :customer: 123
+# EXPECT: receiver: Email
+# EXPECT: receiver_class: Module
+# EXPECT: selector: :send_email
+

data/example/ex05.rb

@@ -0,0 +1,16 @@
+# !SLIDE :capture_code_output true
+# Replay file log
+
+require 'example_helper'
+begin
+  service_log = "#{__FILE__.sub('ex05', 'ex04')}.service.log"
+  Email.client.transport = t =
+    ASIR::Transport::File.new(:file => service_log)
+  t.encoder =
+    ASIR::Coder::Yaml.new
+  t.serve_file!
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : Email.send_mail :pdf_invoice

data/example/ex06.rb

@@ -0,0 +1,26 @@
+# !SLIDE :capture_code_output true
+# One-way, named pipe service
+
+require 'example_helper'
+begin
+  File.unlink(service_pipe = "service.pipe") rescue nil
+  Email.client.transport = t =
+    ASIR::Transport::File.new(:file => service_pipe)
+  t.encoder =
+    ASIR::Coder::Yaml.new
+  t.prepare_pipe_server!
+  server_process do
+    t.run_pipe_server!
+  end
+  sleep 1
+  pr Email.client.send_email(:pdf_invoice, :to => "user@email.com", :customer => @customer)
+ensure
+  t.close; sleep 1; server_kill
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : server process
+# EXPECT: : Email.send_mail :pdf_invoice
+# EXPECT: : pr: nil
+

data/example/ex07.rb

@@ -0,0 +1,28 @@
+# !SLIDE :capture_code_output true
+# One-way, named pipe service with signature
+
+require 'example_helper'
+begin
+  File.unlink(service_pipe = "service.pipe") rescue nil
+  Email.client.transport = t =
+    ASIR::Transport::File.new(:file => service_pipe)
+  t.encoder =
+    ASIR::Coder::Chain.new(:encoders =>
+      [ ASIR::Coder::Marshal.new,
+        s = ASIR::Coder::Sign.new(:secret => 'abc123'),
+        ASIR::Coder::Yaml.new,
+      ])
+  t.prepare_pipe_server!
+  server_process do
+    t.run_pipe_server!
+  end
+  pr Email.client.send_email(:pdf_invoice, :to => "user@email.com", :customer => @customer)
+ensure
+  t.close; sleep 1; server_kill
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : server process
+# EXPECT: : Email.send_mail :pdf_invoice
+# EXPECT: : pr: nil

data/example/ex08.rb

@@ -0,0 +1,30 @@
+# !SLIDE :capture_code_output true
+# One-way, named pipe service with invalid signature
+
+require 'example_helper'
+begin
+  File.unlink(service_pipe = "service.pipe") rescue nil
+  Email.client.transport = t =
+    ASIR::Transport::File.new(:file => service_pipe)
+  t.encoder =
+    ASIR::Coder::Chain.new(:encoders =>
+      [ ASIR::Coder::Marshal.new,
+        s = ASIR::Coder::Sign.new(:secret => 'abc123'),
+        ASIR::Coder::Yaml.new,
+      ])
+  t.prepare_pipe_server!
+  server_process do
+    t.run_pipe_server!
+  end
+  s.secret = 'I do not know the secret! :('
+  pr Email.client.send_email(:pdf_invoice, :to => "user@email.com", :customer => @customer)
+ensure
+  t.close; sleep 1; server_kill
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : server process
+# EXPECT!: : Email.send_mail :pdf_invoice
+# EXPECT: : pr: nil
+

data/example/ex09.rb

@@ -0,0 +1,25 @@
+# !SLIDE :capture_code_output true
+# Socket service
+
+require 'example_helper'
+begin
+  Email.client.transport = t =
+    ASIR::Transport::TcpSocket.new(:port => 30909)
+  t.encoder =
+    ASIR::Coder::Marshal.new
+  t.prepare_server!
+  server_process do
+    t.run_server!
+  end
+  pr Email.client.send_email(:pdf_invoice,
+                             :to => "user@email.com", :customer => @customer)
+ensure
+  t.close; sleep 1; server_kill
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : server process
+# EXPECT: : Email.send_mail :pdf_invoice
+# EXPECT: : pr: :ok
+

data/example/ex10.rb

@@ -0,0 +1,24 @@
+# !SLIDE :capture_code_output true
+# Socket service with forwarded exception.
+
+require 'example_helper'
+begin
+  Email.client.transport = t =
+    ASIR::Transport::TcpSocket.new(:port => 30910)
+  t.encoder =
+    ASIR::Coder::Marshal.new
+  t.prepare_server!
+  server_process do
+    t.run_server!
+  end
+  pr Email.client.do_raise("Raise Me!")
+rescue Exception => err
+  pr [ :exception, err ]
+ensure
+  t.close; sleep 1; server_kill
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : server process
+# EXPECT: : pr: [:exception, #<RuntimeError: Raise Me!>]

data/example/ex11.rb

@@ -0,0 +1,48 @@
+# !SLIDE :capture_code_output true
+# Socket service with local fallback.
+
+require 'example_helper'
+begin
+  File.unlink(service_log = "#{__FILE__}.service.log") rescue nil
+  Email.client.transport = t =
+    ASIR::Transport::Fallback.new(:transports => [
+      tcp = ASIR::Transport::TcpSocket.new(:port => 31911,
+                                           :encoder => ASIR::Coder::Marshal.new),
+      ASIR::Transport::Broadcast.new(:transports => [
+        file = ASIR::Transport::File.new(:file => service_log,
+                                         :encoder => ASIR::Coder::Yaml.new),
+        ASIR::Transport::Subprocess.new,
+      ]),
+    ])
+  pr Email.client.send_email(:pdf_invoice,
+                             :to => "user@email.com", :customer => @customer)
+  server_process do
+    tcp.prepare_server!
+    tcp.run_server!
+  end; sleep 2
+  pr Email.client.send_email(:pdf_invoice,
+                             :to => "user2@email.com", :customer => @customer)
+ensure
+  file.close rescue nil;
+  tcp.close rescue nil; sleep 1; server_kill
+  puts "\x1a\n#{service_log.inspect} contents:"
+  puts File.read(service_log)
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : server process
+# EXPECT/: : Email.send_mail :pdf_invoice .*:to=>"user@email.com"
+# EXPECT/: : Email.send_mail :pdf_invoice .*:to=>"user2@email.com"
+# EXPECT: : pr: :ok
+# EXPECT: service.log" contents:
+# EXPECT: --- !ruby/object:ASIR::Message
+# EXPECT:   :transport_exceptions:
+# EXPECT: ASIR::Error: Cannot connect to ASIR::Transport::TcpSocket tcp://127.0.0.1:
+# EXPECT: arguments:
+# EXPECT: - :pdf_invoice
+# EXPECT/: :to: user@email.com
+# EXPECT/: :customer: 123
+# EXPECT: receiver: Email
+# EXPECT: receiver_class: Module
+# EXPECT: selector: :send_email

data/example/ex12.rb

@@ -0,0 +1,34 @@
+# !SLIDE :capture_code_output true
+# Asynchronous beanstalkd service
+
+require 'example_helper'
+require 'asir/transport/beanstalk'
+require 'asir/coder/zlib'
+begin
+  Email.client.transport = t =
+    ASIR::Transport::Beanstalk.new(:address => '127.0.0.1', :port => 30904)
+  t.encoder =
+    ASIR::Coder::Chain.new(:encoders =>
+                           [ ASIR::Coder::Marshal.new,
+                            ASIR::Coder::Zlib.new, ])
+  t.start_beanstalkd!; sleep 1
+  pr Email.client.send_email(:pdf_invoice,
+                             :to => "user@email.com", :customer => @customer)
+  sleep 2
+  server_process do
+    t.prepare_beanstalk_server!
+    t.run_beanstalk_server!
+  end
+rescue Object => err
+  $stderr.puts "#{err.inspect}\n#{err.backtrace * "\n"}"
+ensure
+  t.close; sleep 3; server_kill; sleep 2
+  t.stop_beanstalkd!
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : server process
+# EXPECT: : Email.send_mail :pdf_invoice
+# EXPECT: : pr: nil
+

data/example/ex13.rb

@@ -0,0 +1,35 @@
+# !SLIDE :capture_code_output true
+# Synchronous HTTP service
+
+require 'example_helper'
+require 'asir/transport/webrick'
+require 'asir/coder/base64'
+require 'asir/coder/zlib'
+begin
+  Email.client.transport = t =
+    ASIR::Transport::Webrick.new(:uri => "http://localhost:31913/")
+  t.encoder =
+    ASIR::Coder::Chain.new(:encoders =>
+                           [ASIR::Coder::Marshal.new,
+                            ASIR::Coder::Base64.new, ])
+  server_process do
+    t.prepare_server!
+    t.run_server!
+  end; sleep 2
+  pr Email.client.send_email(:pdf_invoice,
+                             :to => "user@email.com",
+                             :customer => @customer)
+  sleep 2
+rescue Object => err
+  $stderr.puts "#{err.inspect}\n#{err.backtrace * "\n"}"
+ensure
+  t.close rescue nil; sleep 3
+  server_kill; sleep 2
+end
+
+# !SLIDE END
+# EXPECT: : client process
+# EXPECT: : server process
+# EXPECT: : Email.send_mail :pdf_invoice
+# EXPECT: : pr: :ok
+