tem_multi_proxy 0.2.4 → 0.2.5

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.2.5. Added forgotten dependency on tem_ruby, updated documentation.
+
 v0.2.4. Updated to API for smartcard 0.4.0.
 
 v0.2.3. Removed unused dependency on eventmachine.

data/README

@@ -11,4 +11,3 @@ Note on testing: since the proxy is entirely event-driven, testing it would be
 a pain, or I don't know how to do it easily yet. Therefore I'm not going to
 write complex tests for 200 lines of code that I don't expect to change ever
 again. Contributions are welcome though :)
-  

data/Rakefile

@@ -1,9 +1,15 @@
+# Rakefile for the tem_multi_proxy gem.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+
 require 'rubygems'
 gem 'echoe'
 require 'echoe'
 
 Echoe.new('tem_multi_proxy') do |p|
-  p.project = 'tem' # rubyforge project
+  p.project = 'tem'  # rubyforge project
   p.docs_host = "costan@rubyforge.org:/var/www/gforge-projects/tem/rdoc/"
   
   p.author = 'Victor Costan'
@@ -11,11 +17,12 @@ Echoe.new('tem_multi_proxy') do |p|
   p.summary = 'Maintains TEM proxies for all the physically attached TEMs.'
   p.url = 'http://tem.rubyforge.org'
   p.dependencies = ['rbtree >=0.2.1',
-                    'smartcard >=0.4.1',
+                    'smartcard >=0.4.6',
+                    'tem_ruby >=0.11.7',
                     'zerg_support >=0.0.9']
   
-  p.need_tar_gz = !Platform.windows?
-  p.need_zip = !Platform.windows?
+  p.need_tar_gz = !Gem.win_platform?
+  p.need_zip = !Gem.win_platform?
   p.rdoc_pattern = /^(lib|bin|tasks|ext)|^BUILD|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/  
 end
 

data/bin/tem_multi_proxy

@@ -1,4 +1,15 @@
 #!/usr/bin/env ruby
+#
+# Launcher for a tem_multi_proxy server.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+#
+# Usage: tem_multi_proxy [rpc port]
+# The default RPC port is 9000. The RPC can be used with the tem_multi_proxy
+# client library to obtain information about the cards connected to the system
+# running tem_multi_proxy.
 
 require 'rubygems'
 require 'tem_multi_proxy'

data/bin/tem_multi_proxy_query

@@ -1,4 +1,14 @@
 #!/usr/bin/env ruby
+#
+# Queries a tem_multi_proxy server about the smartcards connected to it via RPC.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+#
+# Usage: tem_multi_proxy_query [host[:port]]
+# The host:port should point to the RPC port of the tem_multi_proxy server.
+# The default host is localhost, and the default port is 9000.
 
 require 'rubygems'
 require 'tem_multi_proxy'

data/lib/tem_multi_proxy/client.rb

@@ -1,6 +1,19 @@
+# RPC client for a tem_multi_proxy server.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+
 # :nodoc: namespace
 module Tem::MultiProxy
-  
+
+
+# RPC client for a tem_multi_proxy server.
+#
+# The client supports the RPC server's interface for obtaining administrative
+# information about the cards connected to it. To communicate with the
+# smart-cards, use the transports in the smartcard gem (see the Smartcard::Iso
+# namespace).
 class Client
   Protocol = Zerg::Support::Protocols::ObjectProtocol
   Adapter = Zerg::Support::Sockets::ProtocolAdapter.adapter_module Protocol 
@@ -27,6 +40,6 @@ class Client
         :opts => { :host => server_host, :port => port } }
     end
   end  
-end
+end  # class Tem::MultiProxy::Client
 
 end  # namespace Tem::MultiProxy

data/lib/tem_multi_proxy/manager.rb

@@ -1,3 +1,9 @@
+# Manages the mapping between live TEMs and proxy processes.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+
 require 'logger'
 require 'rbtree'
 require 'set'
@@ -6,6 +12,18 @@ require 'set'
 # :nodoc: namespace
 module Tem::MultiProxy  
 
+
+# Manages the mapping between live smart-cards and proxy processes.
+#
+# This class is intended to live as a singleton instance, though that is not
+# enforced. The instance does its work in a dedicated thread which spins inside
+# the management_loop method. Information about the live smartcards is returned
+# by the tem_ports method.
+#
+# While the management thread is spinning, it actively maintains a one-to-one
+# mapping between connected smart-cards and proxy processes, by spawning new
+# processes when cards are connected, and killing processes when cards are
+# disconnected.
 class Manager
   def initialize
     @pcsc_context = Smartcard::PCSC::Context.new(Smartcard::PCSC::SCOPE_SYSTEM)
@@ -139,6 +157,6 @@ class Manager
       Kernel.sleep 1
     end
   end
-end
+end  # class Tem::MultiProxy::Manager
 
 end  # namespace Tem::MultiProxy

data/lib/tem_multi_proxy/server.rb

@@ -1,3 +1,9 @@
+# RPC client for a tem_multi_proxy server.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+
 require 'logger'
 require 'rbtree'
 require 'set'

data/lib/tem_multi_proxy.rb

@@ -1,3 +1,9 @@
+# Main include file for the tem_multi_proxy Rubygem.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+
 # Gem requirements.
 require 'rubygems'
 require 'smartcard'

data/tem_multi_proxy.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tem_multi_proxy}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = %q{2009-08-19}
+  s.date = %q{2009-11-09}
   s.description = %q{Maintains TEM proxies for all the physically attached TEMs.}
   s.email = %q{victor@costan.us}
   s.executables = ["tem_multi_proxy", "tem_multi_proxy_query"]
@@ -25,16 +25,19 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rbtree>, [">= 0.2.1"])
-      s.add_runtime_dependency(%q<smartcard>, [">= 0.4.1"])
+      s.add_runtime_dependency(%q<smartcard>, [">= 0.4.6"])
+      s.add_runtime_dependency(%q<tem_ruby>, [">= 0.11.7"])
       s.add_runtime_dependency(%q<zerg_support>, [">= 0.0.9"])
     else
       s.add_dependency(%q<rbtree>, [">= 0.2.1"])
-      s.add_dependency(%q<smartcard>, [">= 0.4.1"])
+      s.add_dependency(%q<smartcard>, [">= 0.4.6"])
+      s.add_dependency(%q<tem_ruby>, [">= 0.11.7"])
       s.add_dependency(%q<zerg_support>, [">= 0.0.9"])
     end
   else
     s.add_dependency(%q<rbtree>, [">= 0.2.1"])
-    s.add_dependency(%q<smartcard>, [">= 0.4.1"])
+    s.add_dependency(%q<smartcard>, [">= 0.4.6"])
+    s.add_dependency(%q<tem_ruby>, [">= 0.11.7"])
     s.add_dependency(%q<zerg_support>, [">= 0.0.9"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tem_multi_proxy
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Victor Costan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-19 00:00:00 -04:00
+date: 2009-11-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,17 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.1
+        version: 0.4.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tem_ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.11.7
     version: 
 - !ruby/object:Gem::Dependency 
   name: zerg_support