zss 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3fe063c07e36ab09e3f66202e1ec9b936d4124a
-  data.tar.gz: 8a03c4d06efc0dd89a84b5bdf311712ae6edb205
+  metadata.gz: b3b8da3123f3885cb835b2c0800da180274aa68c
+  data.tar.gz: d41d309e3e9f883d7bd51a0786e690cef388efcb
 SHA512:
-  metadata.gz: f50426fa1b1d3cc52f8c65798ff8943e48c9294e55d00f2e4b4d63def33a1a19a0fc55573873e877420f1c8bdd87e95f884e7586a8c4a7334aa2f12d464a1170
-  data.tar.gz: ac111e8fd24c86206b1e874d9f6f01ced6c16b4bcc32cf88fdbad62f1e01a70c14333842cf15cf63d54892d9bc1d2928a52bf1333063109b328d72bd15c80b52
+  metadata.gz: 19d8756d422e2b31e299c8afd6971d381af12788623997f789bea25d32b654ced753a3968195e7e38f76cb3d45766842931d1325dae926345c67f6ef29ea8fae
+  data.tar.gz: 1ab9c2291366feec26837e91b34fd7ef07a2283331327200ad71cf01a379ad1430c7970ad020e823339603aa2b8a75b1a740f879d85a12757f49559265ac694b

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    zss (0.0.3)
-      activesupport
-      daemons
-      em-zeromq
-      ffi-rzmq
-      hashie
-      msgpack
+    zss (0.1.0)
+      activesupport (~> 4.1)
+      daemons (~> 1.1)
+      em-zeromq (~> 0.5)
+      ffi-rzmq (~> 2.0)
+      hashie (~> 3.2)
+      logger_facade (~> 0.1)
+      msgpack (~> 0.5)
 
 GEM
   remote: https://rubygems.org/
@@ -38,6 +39,8 @@ GEM
     hashie (3.2.0)
     i18n (0.6.11)
     json (1.8.1)
+    logger_facade (0.1.0)
+      hashie (~> 3.2)
     method_source (0.8.2)
     minitest (5.4.0)
     msgpack (0.5.8)
@@ -51,20 +54,20 @@ GEM
       rspec-core (~> 3.0.0)
       rspec-expectations (~> 3.0.0)
       rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.2)
+    rspec-core (3.0.3)
       rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.2)
+    rspec-expectations (3.0.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.2)
+    rspec-mocks (3.0.3)
       rspec-support (~> 3.0.0)
-    rspec-support (3.0.2)
-    simplecov (0.8.2)
+    rspec-support (3.0.3)
+    simplecov (0.9.0)
       docile (~> 1.1.0)
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    slop (3.5.0)
+    slop (3.6.0)
     thread_safe (0.3.4)
     tzinfo (1.2.1)
       thread_safe (~> 0.1)
@@ -73,11 +76,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bump
+  bump (~> 0.5)
   bundler (~> 1.6)
-  codeclimate-test-reporter
-  pry
-  rake
-  rspec
-  simplecov
+  codeclimate-test-reporter (~> 0.3)
+  pry (~> 0.10)
+  rake (~> 10.3)
+  rspec (~> 3.0)
+  simplecov (~> 0.9)
   zss!

data/README.md

@@ -6,8 +6,7 @@
 
 # ZMQ SOA Suite - Ruby Client & Service
 
-For now protocol description is under node js implementation and will be moved soon to a proper place.
-https://github.com/pjanuario/zmq-service-suite
+This project is a ruby client&service implementation for [ZMQ Service Suite](http://pjanuario.github.io/zmq-service-suite-specs/).
 
 ## Installation
 
@@ -76,15 +75,6 @@ PongClient.call("ping/pong", "payload")
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## Deployment
-
-Continuous Integration build on master branch is configured to:
-1. bump gem patch version
-2. tag version
-3. deploy to ruby gems
-
-Major and Minor version are controlled manually, check next chapter.
-
 ## Bump versioning
 
 We use [bump gem](https://github.com/gregorym/bump) to control gem versioning.

data/lib/zss.rb

@@ -3,6 +3,8 @@ require 'active_support/string_inquirer'
 require 'active_support/core_ext/object'
 require 'active_support/core_ext/hash/indifferent_access'
 
+require 'logger_facade'
+
 require_relative 'zss/version'
 require_relative 'zss/environment'
 require_relative 'zss/configuration'

data/lib/zss/client.rb

@@ -3,6 +3,8 @@ require_relative 'socket'
 module ZSS
   class Client
 
+    include LoggerFacade::Loggable
+
     attr_reader :sid, :frontend, :identity, :timeout
 
     def initialize sid, config = {}
@@ -21,7 +23,12 @@ module ZSS
         headers: headers,
         payload: payload)
 
+      log.info("Request #{request.rid} sent to #{request.address} with #{timeout}s timeout")
+
       response = socket.call(request, timeout)
+
+      log.info("Received response to #{request.rid} with status #{response.status}")
+
       fail ZSS::Error.new(response.status, response.payload) if response.is_error?
 
       response.payload
@@ -32,7 +39,7 @@ module ZSS
     def method_missing method, *args
       # since we cannot use / on method names we replace _ with /
       verb = method.to_s.gsub('_', '/')
-      payload = args[0]      
+      payload = args[0]
       options = args[1] || {}
       call verb, payload, options
     end

data/lib/zss/configuration.rb

@@ -3,8 +3,8 @@ module ZSS
 
     def self.default
       Hashie::Mash.new(
-        frontend: 'tcp://127.0.0.1:5560',
-        backend:  'tcp://127.0.0.1:5559'
+        frontend: 'tcp://127.0.0.1:7777',
+        backend:  'tcp://127.0.0.1:7776'
       )
     end
 

data/lib/zss/message/message_address.rb

@@ -2,9 +2,21 @@ module ZSS
 
   class Message
 
-    class Type
-      REQ = "REQ"
-      REP = "REP"
+    class Address
+      attr_accessor :sid,
+                    :sversion,
+                    :verb
+
+      def initialize args = {}
+        @sid      = args[:sid].try(:upcase)
+        @verb     = args[:verb].try(:upcase)
+        @sversion = args[:sversion].try(:upcase) || '*'
+      end
+
+      def to_s
+        "#{sid}:#{sversion}##{verb}"
+      end
+
     end
 
   end

data/lib/zss/message/message_type.rb

@@ -2,17 +2,9 @@ module ZSS
 
   class Message
 
-    class Address
-      attr_accessor :sid,
-                    :sversion,
-                    :verb
-
-      def initialize args = {}
-        @sid      = args[:sid].try(:upcase)
-        @verb     = args[:verb].try(:upcase)
-        @sversion = args[:sversion] || '*'
-      end
-
+    class Type
+      REQ = "REQ"
+      REP = "REP"
     end
 
   end

data/lib/zss/service.rb

@@ -5,6 +5,8 @@ require_relative 'message/smi'
 module ZSS
   class Service
 
+    include LoggerFacade::Loggable
+
     attr_reader :sid, :heartbeat, :backend, :identity
 
     def initialize(sid, config = {})
@@ -24,9 +26,7 @@ module ZSS
       context = EM::ZeroMQ::Context.new(1)
       fail RuntimeError, 'failed to create create_context' unless context
 
-      # puts "Starting SID: '#{sid}' ID: '#{identity}'"
-      # puts "Env: #{ZSS::Environment.env}"
-      # puts "Broker: #{backend}"
+      log.info("Starting SID: '#{sid}' ID: '#{identity}' Env: '#{ZSS::Environment.env}' Broker: '#{backend}'")
 
       EM.run do
         # handle interrupts
@@ -49,8 +49,10 @@ module ZSS
     def stop
       timer.cancel if timer
 
-      # puts "Stoping SID: '#{sid}' ID: '#{socket.identity}'"
       EM.add_timer do
+
+        log.info("Stoping SID: '#{sid}' ID: '#{socket.identity}'")
+
         send Message::SMI.down(sid)
         socket.disconnect backend
         EM::stop
@@ -93,18 +95,21 @@ module ZSS
     def handle(message)
       if message.req?
         handle_request(message)
-      #else
-        # puts "heartbeat response received!"
+      else
+        log.trace("SMI response received: \n #{message}") if log.is_debug
       end
     rescue ZSS::Error => error
-      #puts "Erorr: ZSS::Error raised while processing request: #{e}"
+      log.error("ZSS::Error raised while processing request: #{error}")
       reply_error error, message
     rescue => e
-      #puts "Error while processing request: #{e}"
+      log.error("Unexpected error occurred while processing request: #{e}")
       reply_error Error[500], message
     end
 
     def handle_request(message)
+      log.info("Handle request for #{message.address}")
+      log.debug("Request message:\n #{message}") if log.is_debug
+
       if message.address.sid != sid
         error = Error[404]
         error.developer_message = "Invalid SID: #{message.address.sid}!"
@@ -129,18 +134,23 @@ module ZSS
     end
 
     def reply(message)
-      #puts "reply #{message}"
       message.status = 200
       message.type = Message::Type::REP
+
+      log.info("Reply with status: #{message.status}")
+      log.debug("Reply with message:\n #{message}") if log.is_debug
+
       send message
     end
 
     def send(msg)
+      log.trace("sending: \n #{msg}") if log.is_debug
+
       frames = msg.to_frames
       #remove identity frame on request
       frames.shift if msg.req?
       success = socket.send_msg(*frames)
-      puts "An Error ocurred while sending message" unless success
+      log.error("An Error ocurred while sending message") unless success
     end
 
   end

data/lib/zss/socket.rb

@@ -4,6 +4,8 @@ require 'timeout'
 module ZSS
   class Socket
 
+    include LoggerFacade::Loggable
+
     class Error        < StandardError; end
     class TimeoutError < Socket::Error; end
 
@@ -25,10 +27,16 @@ module ZSS
         socket ctx do |sock|
           begin
             ::Timeout.timeout t do
+
+              log.debug("Request #{request.rid} sent to #{request.address} with #{t}s timeout")
               send_message sock, request
+
+              log.debug("Waiting for #{request.rid}")
               response = receive_message(sock)
+
             end
           rescue ::Timeout::Error
+            log.debug("Request #{request.rid} exit with timeout after #{t}s")
             raise ZSS::Socket::TimeoutError, "call timeout after #{t}s"
           end
         end
@@ -53,12 +61,18 @@ module ZSS
       socket.identity = "#{identity}##{SecureRandom.uuid}"
       socket.setsockopt(ZMQ::LINGER, 0)
       socket.connect(socket_address)
+
+      log.debug("#{socket.identity} connected to #{socket_address}")
+
       yield socket
     ensure
       check!(socket.close) if socket
     end
 
     def send_message socket, message
+
+      log.debug("Sending:\n #{message}") if log.is_debug
+
       frames = message.to_frames
 
       # if it's a reply should send identity
@@ -70,7 +84,11 @@ module ZSS
 
     def receive_message socket
       check! socket.recv_strings(frames = [])
-      Message.parse frames
+      message = Message.parse frames
+
+      log.debug("Receiving: \n #{message}") if log.is_debug
+
+      message
     end
 
     def check! result_code

data/lib/zss/version.rb

@@ -1,3 +1,3 @@
 module ZSS
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/spec/unit/message_address_spec.rb

@@ -15,9 +15,17 @@ describe ZSS::Message::Address do
       actual = described_class.new sid: "service", verb: "verb", sversion: 'v.1'
       expect(actual.sid).to eq("SERVICE")
       expect(actual.verb).to eq("VERB")
-      expect(actual.sversion).to eq("v.1")
+      expect(actual.sversion).to eq("V.1")
     end
 
   end
 
+  describe("#to_s") do
+
+    it('returns a address in string format') do
+      actual = described_class.new sid: "service", verb: "verb", sversion: 'v.1'
+      expect(actual.to_s).to eq("SERVICE:V.1#VERB")
+    end
+  end
+
 end

data/spec/unit/message_spec.rb

@@ -62,7 +62,7 @@ describe ZSS::Message do
 
       it('returns a fullfilled message') do
 
-        address.sversion = "sversion"
+        address.sversion = "sversion".upcase
 
         actual = described_class.parse(frames)
 

data/zss.gemspec

@@ -8,8 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Pedro Januário"]
   spec.email         = ["prnjanuario@gmail.com"]
   spec.description   = %q{ZeroMQ SOA Suite}
-  spec.summary       = %q{ZeroMQ SOA Suite}
+  spec.summary       = %q{This project is a ruby client&service implementation for ZMQ Service Suite,
+                          check http://pjanuario.github.io/zmq-service-suite-specs/ for more info.}
   spec.homepage      = "https://github.com/pjanuario/zmq-service-suite-ruby"
+  spec.metadata      = {
+    "source_code" => "https://github.com/pjanuario/zmq-service-suite-ruby",
+    "issue_tracker" => "https://github.com/pjanuario/zmq-service-suite-ruby/issues"
+  }
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,17 +23,18 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'codeclimate-test-reporter'
-  spec.add_development_dependency 'bump'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.3'
+  spec.add_development_dependency 'bump', '~> 0.5'
 
-  spec.add_dependency 'msgpack'
-  spec.add_dependency 'ffi-rzmq'
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'hashie'
-  spec.add_dependency 'daemons'
-  spec.add_dependency 'em-zeromq'
+  spec.add_dependency 'msgpack', '~> 0.5'
+  spec.add_dependency 'ffi-rzmq', '~> 2.0'
+  spec.add_dependency 'activesupport', '~> 4.1'
+  spec.add_dependency 'hashie', '~> 3.2'
+  spec.add_dependency 'daemons', '~> 1.1'
+  spec.add_dependency 'em-zeromq', '~> 0.5'
+  spec.add_dependency 'logger_facade', '~> 0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zss
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Pedro Januário
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,170 +28,184 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: em-zeromq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: logger_facade
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 description: ZeroMQ SOA Suite
 email:
 - prnjanuario@gmail.com
@@ -240,7 +254,9 @@ files:
 homepage: https://github.com/pjanuario/zmq-service-suite-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code: https://github.com/pjanuario/zmq-service-suite-ruby
+  issue_tracker: https://github.com/pjanuario/zmq-service-suite-ruby/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -260,7 +276,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: ZeroMQ SOA Suite
+summary: This project is a ruby client&service implementation for ZMQ Service Suite,
+  check http://pjanuario.github.io/zmq-service-suite-specs/ for more info.
 test_files:
 - spec/integration/client_spec.rb
 - spec/integration/service_spec.rb