sub_zero 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a5592345c5e4af640cd01b216b282ed95f8d7d5
-  data.tar.gz: 84a3ad5d2d34919792a6273213391dc7172005bd
+  metadata.gz: 0c3d06f3806bd38f972069cccc381a5e14a10552
+  data.tar.gz: 201442b45283cc753950167905a088a450ec613a
 SHA512:
-  metadata.gz: a3d8f3de9e64d9c380f8329c916663eec6230b13edf321a5a4a4d52be2d6d6ef0bb741e407885392973a696c08639874922fd317a9c401750d2b1d3bee1b58f4
-  data.tar.gz: 8f1d4fec8c5f7994ee4671593096e3512518fc67107b3c583b5a6aa8328a0599ca4ae9436bf2ff6f662f944cfda6a045b153a3020bf89536535d0035cb00fcc7
+  metadata.gz: 59833793e76d2543ad4ed8948f852b7a8b13b0db67e44352cf55c4df36044b16669f84cd8a6e5df9e8134a7c20f36a245bbe760b7fd3c5a30696ebe61b56dacf
+  data.tar.gz: 2aee09d0ea9f147d2acf510203f0b71d7619876b8dbe5750d32f6153f1710ce0e6aad0cdfdd1d96013a96643928c36a11becfc4c5f7b02e61efc2ce1eed31b3c

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 ClubJudge B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,6 @@
 # SubZero
 
-TODO: Write a gem description
+
 
 ## Installation
 

data/bin/sub_zero

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require_relative '../lib/sub_zero.rb'
+
+SubZero::CLI::App.start

data/example/auditing/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sub_zero.gemspec
+gemspec

data/example/auditing/README.md

@@ -0,0 +1,5 @@
+# SubZero: Example App
+
+An app can be created using:
+
+    subzero new appname

data/example/auditing/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+require 'sub_zero/service/tasks'

data/example/auditing/auditing.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auditing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'auditing'
+  spec.version       = Auditing::VERSION
+  spec.authors       = ['Victor Rodrigues']
+  spec.email         = ['victorc.rodrigues@gmail.com']
+  spec.description   = %q{SubZero app example}
+  spec.summary       = %q{SubZero app example}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'sub_zero'
+end

data/example/auditing/config.yml

@@ -0,0 +1,2 @@
+broker:
+  uri: 'localhost:5560'

data/example/auditing/lib/auditing/handlers/logs.rb

@@ -0,0 +1,30 @@
+module Auditing
+  module Handlers
+    class Logs < SubZero::Service::Handler
+
+      def create
+        Log.create params
+        reply :ok
+      end
+
+      def index
+        reply_with Log.all
+      end
+
+    end
+  end
+end
+
+__END__
+
+#params is the message payload desserialized from messagepack
+
+#request_id is accessible through here
+
+#reply(verb, payload = nil)
+
+#reply_with(content) => same verb
+#reply_with(verb, content) => other verb
+(both serialize content to msgpack)
+
+#logger might be very useful

data/example/auditing/lib/auditing/handlers/status.rb

@@ -0,0 +1,29 @@
+module Auditing
+  module Handlers
+    class Status < SubZero::Service::Handler
+
+      def show
+        reply :working
+      end
+
+      def count
+        reply_with Log.count
+      end
+
+    end
+  end
+end
+
+__END__
+
+#params is the message payload desserialized from messagepack
+
+#request_id is accessible through here
+
+#reply(verb, payload = nil)
+
+#reply_with(content) => same verb
+#reply_with(verb, content) => other verb
+(both serialize content to msgpack)
+
+#logger might be very useful

data/example/auditing/lib/auditing/version.rb

@@ -0,0 +1,3 @@
+module Auditing
+  VERSION = '0.0.1'
+end

data/example/auditing/lib/auditing.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+
+module Auditing
+  extend SubZero::Service
+
+  sid :auditing
+
+  verbs log:              'logs#create',
+        retrieve:         'logs#index',
+        status:           'status#show',
+        'status/count' => 'status#count'
+
+end
+
+__END__
+
+verbs targets classes will try to be required / constantized from auditing/ or auditing/handlers as they are declared

data/example/auditing-client/run.rb

@@ -0,0 +1,42 @@
+require 'sub_zero'
+
+Auditing = SubZero.client(:auditing)
+
+# or
+
+Auditing = SubZero.client :auditing do |c|
+  c.timeout = 5000
+  # what else? retry?
+end
+
+# fire and forget, just waits the Broker ACK to not care anymore, opens a thread
+Auditing.log! author: 'Pedro Alvares Cabral', action: 'discovered Brazil.. heh.'
+
+# waits for reply
+ronconcon_logs = Auditing.index(author: 'Marques de Pombal')
+
+# for more complex verbs, the base method call:
+
+Auditing.call! 'bugs/report', error: 'error while trying to log'
+
+Auditing.call 'stats/count'
+
+Auditing.stats_count
+
+# some sugar to sync call might be
+
+Auditing['stats/count']
+
+
+Auditing.stats! do |stats|
+  DeveloperChatRoom.push "Availabilty: #{stats[:availability]}"
+end
+
+
+# reply:
+
+# ACK:NOK { error: { message: '', code: '', … } } (BROKER)
+# STATS/COUNT:OK
+# STATS/COUNT:NOK { error: { message: '', code: '', … }}
+# retry strategy
+

data/lib/sub_zero/cli/app.rb

@@ -0,0 +1,7 @@
+module SubZero
+  module CLI
+    class App < Thor
+      register SubZero::CLI::New, 'new', 'new TYPE NAME', 'Creates a new TYPE (service/client) named NAME'
+    end
+  end
+end

data/lib/sub_zero/cli/new.rb

@@ -0,0 +1,89 @@
+module SubZero
+  module CLI
+    class New < ::Thor
+      include ::Thor::Actions
+
+      attr_accessor :name
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      class_option :language,       desc: 'language template to use', default: 'ruby', type: :string
+      class_option :test_framework, desc: 'test framework to use',    default: 'rspec'
+      class_option :with_rvm,       desc: 'include .rvmrc',           default: true
+
+      desc 'service NAME', 'Creates a SubZero service'
+      def service name=nil
+        if name.nil?
+          say "You must supply a name!"
+          exit 1
+        end
+
+        say "Creating #{name} service..."
+        create_service name, options
+      end
+
+      desc 'client NAME', 'Creates a SubZero client'
+      def client name=nil
+        if name.nil?
+          say "You must supply a name!"
+          exit 1
+        end
+
+        say "Creating #{name} client..."
+        create_client name, options
+      end
+
+      #######
+      private
+      #######
+
+      def create_client name, options
+        self.name = name # ERB ... :/
+        template("templates/#{options[:language]}/client.tt", "#{name}/lib/#{name}.rb")
+
+        # TODO
+      end
+
+      def create_service name, options
+        # |-- Gemfile
+        # |-- bin
+        # |   `-- name
+        # |-- config
+        # |   |-- service.yml
+        # |   `-- verbs.rb
+        # |-- lib
+        # |   |-- handlers
+        # |   |   `-- handler.rb
+        # |   `-- name.rb
+        # |-- rvmrc
+        # `-- spec
+        #     `-- name_spec.rb
+
+        name = name.downcase
+        self.name = name # ERB ... :/
+        template("templates/#{options[:language]}/service/Gemfile", "#{name}/Gemfile")
+        template("templates/#{options[:language]}/service/bin.tt", "#{name}/bin/#{name}")
+        chmod("#{name}/bin/#{name}", 0755)
+        template("templates/#{options[:language]}/service/serviceyml.tt", "#{name}/config/service.yml")
+        template("templates/#{options[:language]}/service/verbs.tt", "#{name}/config/verbs.rb")
+        template("templates/#{options[:language]}/service/lib.tt", "#{name}/lib/#{name}.rb")
+        template("templates/#{options[:language]}/service/version.tt", "#{name}/lib/#{name}/version.rb")
+        template("templates/#{options[:language]}/service/handler.tt", "#{name}/lib/handlers/handler.rb")
+
+        test = options[:test_framework] == "rspec" ? :spec : :test
+        create_file "#{name}/#{test}/#{name}_#{test}.rb"
+
+        if options[:with_rvm]
+          template("templates/#{options[:language]}/service/rvmrc.tt", "#{name}/.rvmrc")
+        end
+
+        empty_directory "#{name}/doc"
+
+        say "all done! you can start a development server with bin/#{name} run"
+      end
+
+    end
+  end
+end

data/lib/sub_zero/cli/templates/ruby/client/client.tt

@@ -0,0 +1,2 @@
+class <%= name.capitalize %>
+end

data/lib/sub_zero/cli/templates/ruby/service/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'daemons'
+gem 'em-zeromq'
+gem 'msgpack'
+
+gem 'pry'
+gem 'sub_zero', :path => '/Users/bruno/Code/1WORK/sub_zero'

data/lib/sub_zero/cli/templates/ruby/service/bin.tt

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require 'rubygems' unless defined?(Gem)
+
+require 'bundler/setup'
+Bundler.require
+
+require_relative '../lib/<%= name.downcase %>.rb'
+
+service = SubZero::Main.boot ARGV
+
+daemon_opts = {
+  multiple: false,
+  dir_mode: :normal,
+  dir: service.cli_args[:pid_path], # FIXME
+  log_output: true,
+  stop_proc: lambda { $stop_requested = true }
+}
+
+Daemons.run_proc '<%= name %>', daemon_opts do
+  daemon = <%= name.capitalize %>::Main.new service
+
+  start = Time.now
+  ping_at = start + 5
+
+  Signal.trap('INT') { daemon.do_exit_cleanup; exit }
+
+  loop do
+    daemon.poll_sockets
+
+    now = Time.now
+    if now >= ping_at
+      daemon.ping
+      ping_at = now + 15
+    end
+
+    break if $stop_requested
+
+  end
+
+  daemon.do_exit_cleanup
+  exit 0
+end

data/lib/sub_zero/cli/templates/ruby/service/handler.tt

@@ -0,0 +1 @@
+# TODO

data/lib/sub_zero/cli/templates/ruby/service/lib.tt

@@ -0,0 +1,47 @@
+require_relative "<%= name.capitalize %>/version"
+
+module <%= name.capitalize %>
+  class Main
+    include SubZero::Common
+
+    def initialize service
+      @config = service.config
+      log "INITing socket"
+    end
+
+    def poll_sockets
+      print '.'
+      sleep 1
+    end
+
+    def ping
+      log "ping..."
+    end
+
+    #######
+    private
+    #######
+
+    def send_announce_packet
+      $sent = Time.now
+      @socket.send_string "SRV", ZMQ::SNDMORE
+      @socket.send_string 0.to_s, ZMQ::SNDMORE
+      @socket.send_string "UP", ZMQ::SNDMORE
+
+      payload = { id: @config['service']['id'], sid: @config['service']['sid'] }.to_msgpack
+      @socket.send_string payload
+    end
+
+    def init_socket
+      @context = ZMQ::Context.new
+
+      @socket = @context.socket ZMQ::DEALER
+      @socket.identity = @config['service']['id']
+      @socket.connect "tcp://#{@config['service']['broker_host']}:#{@config['service']['broker_port']}"
+
+      @poller = ZMQ::Poller.new
+      @poller.register @socket, ZMQ::POLLIN
+    end
+
+  end
+end

data/lib/sub_zero/cli/templates/ruby/service/rvmrc.tt

@@ -0,0 +1 @@
+rvm use 2.0@<%= name.capitalize %> --create

data/lib/sub_zero/cli/templates/ruby/service/serviceyml.tt

@@ -0,0 +1,12 @@
+defaults: &defaults
+  service:
+    broker_host: "local.clubjudge.com"
+    broker_port: 7777
+    sid: "new_service"
+    id: "<%= ::SecureRandom.hex(10) %>"
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults

data/lib/sub_zero/cli/templates/ruby/service/verbs.tt

@@ -0,0 +1 @@
+# TODO

data/lib/sub_zero/cli/templates/ruby/service/version.tt

@@ -0,0 +1,3 @@
+module <%= name.capitalize %>
+  VERSION = "0.0.1"
+end

data/lib/sub_zero/cli.rb

@@ -0,0 +1,6 @@
+module SubZero
+  module CLI
+    autoload :App, 'sub_zero/cli/app'
+    autoload :New, 'sub_zero/cli/new'
+  end
+end

data/lib/sub_zero/client/configuration.rb

@@ -0,0 +1,12 @@
+module SubZero
+  class Client
+    module Configuration
+      extend self
+
+      def default
+        { ip: '127.0.0.1', port: 7777 }
+      end
+
+    end
+  end
+end

data/lib/sub_zero/client/socket.rb

@@ -0,0 +1,92 @@
+require 'ffi-rzmq'
+require 'msgpack'
+
+module SubZero
+  class Client
+    module Socket
+
+      class SocketError < StandardError; end
+
+      private
+
+      def zeromq_fetch verb, payload = {}, options = {}
+        result = []
+
+        zeromq_context do |context|
+          zeromq_socket context do |socket|
+            rid = SecureRandom.uuid
+            zeromq_send socket, "REQ:#{sid}", rid, verb, payload.to_msgpack, options.to_msgpack
+            result = zeromq_result(socket, rid, verb)
+          end
+        end
+
+        result
+      end
+
+      def zeromq_context
+        context = ZMQ::Context.create(1)
+        fail SocketError, 'failed to create context' unless context
+        yield context
+      ensure
+        zcc!(context.terminate) if context
+      end
+
+      def zeromq_socket context
+        socket = context.socket ZMQ::DEALER
+        socket.identity = SecureRandom.hex(10)
+        zcc! socket.connect("tcp://#{config[:ip]}:#{config[:port]}")
+        yield socket
+      ensure
+        zcc! socket.close
+      end
+
+      def zeromq_send socket, *msgs
+        last = msgs.pop
+        msgs.each { |m| zcc! socket.send_string m, ZMQ::SNDMORE }
+        zcc! socket.send_string last
+      end
+
+      def zeromq_check_code! result_code
+        return if ZMQ::Util.resultcode_ok? result_code
+
+        fail SocketError, "operation failed, errno [#{ZMQ::Util.errno}], " +
+          "description [#{ZMQ::Util.error_string}]"
+      end
+
+      alias :zcc! :zeromq_check_code!
+
+      def zeromq_result socket, rid, verb
+        result = []
+        zcc! socket.recv_strings(result)
+
+        zeromq_validate_result! rid, verb, result
+
+        routing_info = MessagePack.unpack(result.pop)
+        payload = MessagePack.unpack(result.pop)
+        rep_verb = result.pop
+        status = rep_verb.end_with?('NOK') ? :error : :ok
+
+        [status, payload]
+      end
+
+      def zeromq_validate_result! rid, verb, result
+        type, rep_rid, rep_verb, payload = result
+
+        common = "result: #{result}"
+
+        unless type == "REP:#{sid}" || type == 'BRO'
+          fail SocketError, "unexpected result type: #{type}. " + common
+        end
+
+        unless rid == rep_rid
+          fail SocketError, "rid mismatch. sent: #{rid}, received: #{rep_id}. " + common
+        end
+
+        unless rep_verb == "#{verb}:OK" || rep_verb == "#{verb}:NOK"
+          fail SocketError, "reply verb mismatch: #{rep_verb}. " + common
+        end
+      end
+
+    end
+  end
+end

data/lib/sub_zero/client.rb

@@ -0,0 +1,70 @@
+require 'active_support/string_inquirer'
+
+module SubZero
+  class Client
+    autoload :Configuration, 'sub_zero/client/configuration'
+    autoload :Socket,        'sub_zero/client/socket'
+
+    include Socket
+
+    attr_reader :sid, :config
+
+    def initialize sid
+      @sid, @config = sid.to_s.upcase, Configuration.default
+      yield @config if block_given?
+    end
+
+    def call verb, payload = {}, options = {}
+      sz_verb = verb.to_s.upcase.gsub('_', '/')
+      status, result = zeromq_fetch(sz_verb, payload, options)
+      result = handle_result(status, result)
+      block_given? ? yield(result) : result
+    end
+
+    def call! verb, payload = {}, options = {}, &block
+      call verb, payload, options, &block
+    end
+
+    def [] verb
+      call verb
+    end
+
+    def method_missing method, payload = {}, options = {}, &block
+      if method.to_s.end_with? '!'
+        call! method.delete('!'), payload, options, &block
+      else
+        call method, payload, options, &block
+      end
+    end
+
+    def handle_result status, result
+      case status
+      when :ok
+        result
+      when :error
+        fail Error.new(result['error'])
+      end
+    end
+
+    class Error < ::StandardError
+
+      attr_reader :result
+
+      def initialize result
+        super result['message']
+        set_backtrace caller
+        @result = result
+      end
+
+      def code
+        result['code']
+      end
+
+      def status
+        ActiveSupport::StringInquirer.new self.code.to_s.downcase
+      end
+
+    end
+
+  end
+end

data/lib/sub_zero/main/common.rb

@@ -0,0 +1,11 @@
+module SubZero
+  module Common
+    def log msg, level='DEBUG'
+      puts "#{level}: #{msg}"
+    end
+
+    def env
+      ENV['SUBZERO_ENV'] || 'development'
+    end
+  end
+end

data/lib/sub_zero/main.rb

@@ -0,0 +1,64 @@
+require_relative 'main/common'
+
+module SubZero
+  module Main
+    include Common
+    extend self
+
+    attr_accessor :config, :cli_args
+
+    def boot cli_args
+      log "booting..."
+
+      log "\tloading service.yml"
+      @config = load_config
+      log "\tparsing CLI args"
+      @cli_args = parse_cli_args cli_args
+
+      self
+    end
+
+    #######
+    private
+    #######
+
+
+    def usage(s)
+      $stderr.puts "<%= name %> v#{SubZero::VERSION}" # change to const for the service!
+      $stderr.puts s
+      $stderr.puts "Usage: #{File.basename($0)}: [-p port] [-l log_path] [-pp pid_path]"
+      exit(1)
+    end
+
+    def parse_cli_args args
+      opts = {}
+
+      port     = @config['service']['broker_port']
+      pid_path = log_path = File.join( File.dirname(__FILE__), '..')
+
+      loop { case ARGV[0]
+          when '-p' then  ARGV.shift; port = ARGV.shift
+          when '-l' then  ARGV.shift; log_path = ARGV.shift
+          when '-pp' then ARGV.shift; pid_path = ARGV.shift
+          when /^-/ then  usage("Unknown option: #{ARGV[0].inspect}")
+          else break
+      end; }
+
+      opts[:port]     = port
+      opts[:log_path] = log_path
+      opts[:pid_path] = pid_path
+
+      opts
+    end
+
+    def load_config
+      begin
+        YAML.load_file('config/service.yml')[env]
+      rescue => ex
+        log "could not load config file! (#{ex.message})", 'ERROR'
+        exit 1
+      end
+    end
+
+  end
+end

data/lib/sub_zero/version.rb

@@ -1,3 +1,3 @@
 module SubZero
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/sub_zero.rb

@@ -1,5 +1,19 @@
-require "sub_zero/version"
+require 'yaml'
+require 'securerandom'
+
+require 'thor'
+require 'thor/group'
+
+require_relative 'sub_zero/version'
+require_relative 'sub_zero/main'
 
 module SubZero
-  # Your code goes here...
+  autoload :CLI,    'sub_zero/cli'
+  autoload :Client, 'sub_zero/client'
+  extend   self
+
+  def client service_id
+    block_given? ? Client.new(service_id, &block) : Client.new(service_id)
+  end
+
 end

data/sub_zero.gemspec

@@ -6,8 +6,8 @@ require 'sub_zero/version'
 Gem::Specification.new do |spec|
   spec.name          = "sub_zero"
   spec.version       = SubZero::VERSION
-  spec.authors       = ["Victor Rodrigues"]
-  spec.email         = ["victorc.rodrigues@gmail.com"]
+  spec.authors       = ["Victor Rodrigues", "Bruno Antunes"]
+  spec.email         = ["victorc.rodrigues@gmail.com", "sardaukar.siet@gmail.com"]
   spec.description   = %q{ZeroMQ SOA solution}
   spec.summary       = %q{ZeroMQ GREAT SOA solution}
   spec.homepage      = ""
@@ -18,6 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'thor'
+  spec.add_dependency 'msgpack'
+  spec.add_dependency 'ffi-rzmq'
+  spec.add_dependency 'activesupport'
 end

data/thoughts.md

@@ -0,0 +1,60 @@
+SubZero is meant to be a way for us to dab into polyglot architectures.
+
+SubZero itself is made up of 3 parts:
+
+Broker
+======
+
+The traffic cop of the scheme. The Broker mediates requests between Services and Clients. Clients and Services cannot talk directly. Responsabilities:
+
+- route messages between components
+- know of active instances of certain Services
+- have a TTL scheme to guess when components are down
+- manage retries
+
+Services
+========
+
+Services exchange messages with clients. When a service boots up, it must register with the Broker before accepting work.
+
+Clients
+=======
+
+Cients send requests to the Broker for specific Service IDs (but not instances of Services).
+
+Messages
+--------
+
+There are two types of messages: Broker to Client( or Service) and Client (or Service) to Broker. Since the Broker has a DEALER socket, all of its outgoing messages are prefixed with an ID.
+
+Typical envelope:
+
+<pre>
+ID - string matching the ZMQ identity of a socket (only for outgoing messages from the Broker)
+RID - UUID that is preserved on all messages pertaining to this request
+TYPE and optionally SUBTYPE after ':' - examples:
+  BRO (when Broker replies to PINGs from services)
+  SRV (when Service boots up and announces itself)
+  CLI:SID (Client asking for a Service reply)
+  REQ:ID (Broker forwarding Client request to Service)
+  SRV:ID (Service replying to Broker about client request)
+  REP:SID (Broker forwards Service reply to Clent)
+VERB - can be PING, PONG, UP, ACK, SORT, TAG, etc. Victor suggested subverbs and I agree or else we'll have huge verb handlers on all Services
+PAYLOAD - a MessagePack serialized hash
+</pre>
+
+
+Intended flow for Service authoring
+===================================
+
+1. sub_zero new service X
+2. cd X
+3. edit config.yml to set broker options (URI, port, etc.)
+4. add routes to verbs.rb
+5. create class with handlers (subclass of SubZero::Handler ?)
+6. when production-ready, run cap deploy to install it on /services (or whatever) in PRD
+7. call /etc/init.d/sub_zero start X in PRD to start service
+
+Variations: 
+ - sub_zero new service X --lang=scala ? To use different file templates?
+

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sub_zero
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Victor Rodrigues
+- Bruno Antunes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,21 +39,123 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ZeroMQ SOA solution
 email:
 - victorc.rodrigues@gmail.com
-executables: []
+- sardaukar.siet@gmail.com
+executables:
+- sub_zero
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
+- bin/sub_zero
+- example/auditing-client/run.rb
+- example/auditing/Gemfile
+- example/auditing/README.md
+- example/auditing/Rakefile
+- example/auditing/auditing.gemspec
+- example/auditing/config.yml
+- example/auditing/lib/auditing.rb
+- example/auditing/lib/auditing/handlers/logs.rb
+- example/auditing/lib/auditing/handlers/status.rb
+- example/auditing/lib/auditing/version.rb
 - lib/sub_zero.rb
+- lib/sub_zero/cli.rb
+- lib/sub_zero/cli/app.rb
+- lib/sub_zero/cli/new.rb
+- lib/sub_zero/cli/templates/ruby/client/client.tt
+- lib/sub_zero/cli/templates/ruby/service/Gemfile
+- lib/sub_zero/cli/templates/ruby/service/bin.tt
+- lib/sub_zero/cli/templates/ruby/service/handler.tt
+- lib/sub_zero/cli/templates/ruby/service/lib.tt
+- lib/sub_zero/cli/templates/ruby/service/rvmrc.tt
+- lib/sub_zero/cli/templates/ruby/service/serviceyml.tt
+- lib/sub_zero/cli/templates/ruby/service/verbs.tt
+- lib/sub_zero/cli/templates/ruby/service/version.tt
+- lib/sub_zero/client.rb
+- lib/sub_zero/client/configuration.rb
+- lib/sub_zero/client/socket.rb
+- lib/sub_zero/main.rb
+- lib/sub_zero/main/common.rb
 - lib/sub_zero/version.rb
+- spec/spec_helper.rb
 - sub_zero.gemspec
+- thoughts.md
 homepage: ''
 licenses:
 - MIT
@@ -73,8 +176,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: ZeroMQ GREAT SOA solution
-test_files: []
+test_files:
+- spec/spec_helper.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Victor Rodrigues
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.