zss 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjNkNWE0YzBjMWQyYzg4NDRmMmQ0MDJhNDZlOWY1OWY2OTY2NWVhNw==
-  data.tar.gz: !binary |-
-    NmFiOWM0N2UwNjU2Y2RhODY2OWE1ZDQyN2FhZjk2YTk1OWRmOTI2MA==
+SHA1:
+  metadata.gz: f3fe063c07e36ab09e3f66202e1ec9b936d4124a
+  data.tar.gz: 8a03c4d06efc0dd89a84b5bdf311712ae6edb205
 SHA512:
-  metadata.gz: !binary |-
-    MDU4Y2IzMTc5NDcyOWMxN2UzZTYzMmY2YWU4ZjJiNzBmYzNjMzA3MGViNDRk
-    NTAzYTU1NzI4NTVmZmU3NDk2NjQwZGY0NDIyZTJkMmNlYmUzMGE3Yzk5YTAz
-    YTcxYzI2MzBlMzZlNzdkMGUzYTZkYzYyY2ZmZDc0M2U3NTQwNTU=
-  data.tar.gz: !binary |-
-    ZTJkNTk5NDg2NDE3OWU2MWVlMjY0ZWY5OGFiOTNmYmExY2NiYzFlZGY5N2Mz
-    YjQwMmFlZGM2MDJiZGM4NGEwOWZhNGQxNDE2N2U2YTA0NmZiOWRlNDA1ZDE1
-    YWRjOTA1NWFiODUxNWU0YTFhMmU5YTExY2Q0OTcyZGY2ZDc4Zjc=
+  metadata.gz: f50426fa1b1d3cc52f8c65798ff8943e48c9294e55d00f2e4b4d63def33a1a19a0fc55573873e877420f1c8bdd87e95f884e7586a8c4a7334aa2f12d464a1170
+  data.tar.gz: ac111e8fd24c86206b1e874d9f6f01ced6c16b4bcc32cf88fdbad62f1e01a70c14333842cf15cf63d54892d9bc1d2928a52bf1333063109b328d72bd15c80b52

data/.travis.yml

@@ -20,8 +20,8 @@ addons:
   code_climate:
     repo_token:
       secure: U6d5emmLhWdFAqrVgtHtXDs1lR2f40is89mZfOp1HbnTQKnClGbmCuEGfeHL8HbaMZjpxFb7g9Ery26E3g1gCsE82sP8SkD0qY46LbWlufRctZWsD4d+TZZZttqo2eNNObKkW5JbzW2pGiRqQb7RCfsxsOnqqhXl3uXVOHK24x4=
-deploy:
-  provider: rubygems
-  api_key:
-    secure: OsOTnuz+qiZe4RY2hOhYsv46LJE7eQf3jZAX5oBBxsSaC6V91SgyHgl1mexMM6r1CPvgOlG4b33AU2Um9NIVrO11fwl/psSeh6zrMf46l5tmn+QCtjOuoM1jtKpomYAPXioH0KkZWoRcqPyNZemZx14YJQW0/fLtrc5xUS20Re0=
-  gemspec: zss.gemspec
+# deploy:
+#   provider: rubygems
+#   api_key:
+#     secure: OsOTnuz+qiZe4RY2hOhYsv46LJE7eQf3jZAX5oBBxsSaC6V91SgyHgl1mexMM6r1CPvgOlG4b33AU2Um9NIVrO11fwl/psSeh6zrMf46l5tmn+QCtjOuoM1jtKpomYAPXioH0KkZWoRcqPyNZemZx14YJQW0/fLtrc5xUS20Re0=
+#   gemspec: zss.gemspec

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    zss (0.0.2)
+    zss (0.0.3)
       activesupport
+      daemons
+      em-zeromq
       ffi-rzmq
       hashie
       msgpack
@@ -20,18 +22,24 @@ GEM
     codeclimate-test-reporter (0.3.0)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
+    daemons (1.1.9)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    em-zeromq (0.5.0)
+      eventmachine (>= 1.0.0)
+      ffi (>= 1.0.0)
+      ffi-rzmq (~> 2.0.1)
+    eventmachine (1.0.3)
     ffi (1.9.3)
     ffi-rzmq (2.0.1)
       ffi-rzmq-core (>= 1.0.1)
     ffi-rzmq-core (1.0.3)
       ffi (~> 1.9)
-    hashie (3.1.0)
-    i18n (0.6.9)
+    hashie (3.2.0)
+    i18n (0.6.11)
     json (1.8.1)
     method_source (0.8.2)
-    minitest (5.3.5)
+    minitest (5.4.0)
     msgpack (0.5.8)
     multi_json (1.10.1)
     pry (0.10.0)

data/README.md

@@ -76,13 +76,22 @@ 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.
 
 Bump Patch version
 
-    $ bump minor
+    $ bump patch
 
 Bump Minor version
 

data/lib/zss/client.rb

@@ -1,19 +1,19 @@
-require 'zss/socket'
+require_relative 'socket'
 
 module ZSS
   class Client
 
     attr_reader :sid, :frontend, :identity, :timeout
 
-    def initialize sid, config = nil
-      @frontend   = config.try(:frontend) || Configuration.default.frontend
+    def initialize sid, config = {}
+      @frontend   = config[:frontend] || Configuration.default.frontend
       @sid      = sid.to_s.upcase
-      @identity = config.try(:identity) || "client"
-      @timeout  = config.try(:timeout) || 1000
+      @identity = config[:identity] || "client"
+      @timeout  = config[:timeout] || 1000
     end
 
-    def call verb, payload = nil, headers: {}, timeout: nil
-      action = verb.to_s.upcase#.gsub('_', '/')
+    def call verb, payload, headers: {}, timeout: nil
+      action = verb.to_s.upcase
       address = Message::Address.new(sid: sid, verb: action)
 
       request = Message.new(
@@ -21,7 +21,7 @@ module ZSS
         headers: headers,
         payload: payload)
 
-      response = socket.call(request)
+      response = socket.call(request, timeout)
       fail ZSS::Error.new(response.status, response.payload) if response.is_error?
 
       response.payload
@@ -29,10 +29,12 @@ module ZSS
 
     private
 
-    def method_missing method, payload = nil, headers: {}
+    def method_missing method, *args
       # since we cannot use / on method names we replace _ with /
       verb = method.to_s.gsub('_', '/')
-      call verb, payload, headers: headers
+      payload = args[0]      
+      options = args[1] || {}
+      call verb, payload, options
     end
 
     def socket

data/lib/zss/configuration.rb

@@ -2,7 +2,10 @@ module ZSS
   class Configuration
 
     def self.default
-      Hashie::Mash.new frontend: 'tcp://127.0.0.1:5560'
+      Hashie::Mash.new(
+        frontend: 'tcp://127.0.0.1:5560',
+        backend:  'tcp://127.0.0.1:5559'
+      )
     end
 
   end

data/lib/zss/error.rb

@@ -1,9 +1,12 @@
+require 'json'
+
 module ZSS
   class Error < ::StandardError
 
-    attr_reader :code, :developer_message, :user_message
+    attr_reader :code, :user_message
+    attr_accessor :developer_message
 
-    def initialize code, payload
+    def initialize(code, payload)
       @code = code.to_i
       @developer_message = payload.developerMessage
       @user_message = payload.userMessage
@@ -11,5 +14,23 @@ module ZSS
       set_backtrace caller
     end
 
+    def self.[](code)
+      data = get_errors[code.to_s]
+      Error.new(code.to_i, data.body)
+    end
+
+    private
+
+    def self.get_errors
+      @errors ||= begin
+        path = File.join(
+          File.dirname(File.absolute_path(__FILE__)),
+          'errors.json'
+        )
+        file = File.read(path)
+        Hashie::Mash.new(JSON.parse(file))
+      end
+    end
+
   end
 end

data/lib/zss/errors.json

@@ -0,0 +1,59 @@
+{
+  "400": {
+    "code": 400,
+    "body": {
+      "developerMessage": "The request cannot be fulfilled due to bad syntax.",
+      "userMessage": "An error occured",
+      "errorCode": 400
+    }
+  },
+  "401": {
+    "code": 401,
+    "body": {
+      "developerMessage": "User authentication token has expired or is missing",
+      "userMessage": "This resource is only available after logging in.",
+      "errorCode": 401
+    }
+  },
+  "403": {
+    "code": 403,
+    "body": {
+      "developerMessage": "User does not have enough privileges to access this resource.",
+      "userMessage": "You do not have access to this resource.",
+      "errorCode": 403
+    },
+    "headers": {}
+  },
+   "404": {
+    "code": 404,
+    "body": {
+      "developerMessage": "The resource could not be found.",
+      "userMessage": "The content you requested was not found.",
+      "errorCode": 404
+    }
+  },
+   "429": {
+    "code": 429,
+    "body": {
+      "developerMessage": "You have sent too many requests in a given amount of time.",
+      "userMessage": "Please wait a while before trying to access this content again",
+      "errorCode": 429
+    }
+  },
+  "500": {
+    "code": 500,
+    "body": {
+      "developerMessage": "There was an error while processing this request. There is probably something wrong with the API server.",
+      "userMessage": "There was an error while processing this request.",
+      "errorCode": 500
+    }
+  },
+  "599": {
+    "code": 599,
+    "body": {
+      "developerMessage": "Connection timeout while processing this request.",
+      "userMessage": "Connection timeout while processing this request.",
+      "errorCode": 599
+    }
+  }
+}

data/lib/zss/message.rb

@@ -31,6 +31,10 @@ module ZSS
 
     end
 
+    def req?
+      type == Type::REQ
+    end
+
     def self.parse(frames)
 
       frames.unshift(nil) if frames.length == 7

data/lib/zss/message/smi.rb

@@ -0,0 +1,43 @@
+module ZSS
+
+  class Message
+
+    class SMI
+
+      SMI = 'SMI'
+
+      def self.down sid
+        Message.new(
+          address: Message::Address.new(
+            sid: SMI,
+            verb: 'DOWN'
+          ),
+          payload: sid
+        )
+      end
+
+      def self.up sid
+        Message.new(
+          address: Message::Address.new(
+            sid: SMI,
+            verb: 'UP'
+          ),
+          payload: sid
+        )
+      end
+
+      def self.heartbeat sid
+        Message.new(
+          address: Message::Address.new(
+            sid: SMI,
+            verb: 'HEARTBEAT'
+          ),
+          payload: sid
+        )
+      end
+
+    end
+
+  end
+
+end

data/lib/zss/router.rb

@@ -0,0 +1,42 @@
+module ZSS
+  class Router
+
+    def add(context, route, handler = nil)
+
+      fail "Invalid context!" unless context
+      fail "Invalid route: #{route}" unless route
+
+      handler ||= route.to_sym
+
+      fail "Invalid handler: #{handler}" unless context.respond_to? handler
+
+      routes[route.to_s.upcase] = get_proc(context, handler)
+    end
+
+    def get(route)
+      handler = routes[route.to_s.upcase]
+      return handler if handler
+
+      error = Error[404]
+      error.developer_message = "Invalid route #{route}!"
+      fail error
+    end
+
+    private
+
+    def routes
+      @routes ||= {}
+    end
+
+    def get_proc(context, handler)
+      receive_headers = context.method(handler).parameters.size == 2
+
+      if receive_headers
+        Proc.new { |p,h| context.send(handler, p, h) }
+      else
+        Proc.new { |p,h| context.send(handler, p) }
+      end
+    end
+
+  end
+end

data/lib/zss/runner.rb

@@ -0,0 +1,37 @@
+require 'daemons'
+
+module ZSS
+  class Runner
+
+    def self.run(proc_name)
+      proc_name = proc_name.to_s
+      pid_path = log_path = './log'
+
+      FileUtils.mkdir_p pid_path
+      FileUtils.mkdir_p log_path
+
+      daemon_opts = {
+        multiple:   true,
+        dir_mode:   :normal,
+        dir:        pid_path,
+        log_output: true,
+        stop_proc:  lambda do
+          puts "stop #{proc_name} daemon..."
+          $stop_requested = true
+        end
+      }
+
+      puts "Starting #{proc_name}:\n\tPID: #{pid_path}\n\tLOGS: #{log_path}"
+
+      Daemons.run_proc proc_name, daemon_opts do
+        daemon = ZSS::ServiceRegister.get_service
+
+        puts "Started #{proc_name} daemon..."
+        daemon.run
+
+        puts "Stoping #{proc_name} daemon"
+        exit 0
+      end
+    end
+  end
+end

data/lib/zss/service.rb

@@ -0,0 +1,147 @@
+require 'em-zeromq'
+require_relative 'router'
+require_relative 'message/smi'
+
+module ZSS
+  class Service
+
+    attr_reader :sid, :heartbeat, :backend, :identity
+
+    def initialize(sid, config = {})
+
+      fail Error[500] if sid.blank?
+
+      @sid = sid.to_s.upcase
+      @heartbeat = config.try(:heartbeat) || 1000
+      @backend   = config.try(:backend) || Configuration.default.backend
+      @router = ZSS::Router.new
+      @identity = "#{sid}##{SecureRandom.uuid}"
+    end
+
+    def run
+      Thread.abort_on_exception = true
+
+      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}"
+
+      EM.run do
+        # handle interrupts
+        Signal.trap("INT") { stop }
+        Signal.trap("TERM") { stop }
+
+        connect_socket context
+
+        start_heartbeat_worker
+
+        # send up message
+        send Message::SMI.up(sid)
+      end
+    end
+
+    def add_route(context, route, handler = nil)
+      router.add(context, route, handler)
+    end
+
+    def stop
+      timer.cancel if timer
+
+      # puts "Stoping SID: '#{sid}' ID: '#{socket.identity}'"
+      EM.add_timer do
+        send Message::SMI.down(sid)
+        socket.disconnect backend
+        EM::stop
+      end
+    end
+
+    private
+
+    attr_accessor :socket, :router, :timer
+
+    def connect_socket(context)
+
+      @socket = context.socket ZMQ::DEALER
+      fail RuntimeError, 'failed to create socket' unless socket
+
+      socket.identity = identity
+      socket.setsockopt(ZMQ::LINGER, 0)
+      socket.on(:message, &method(:handle_frames))
+
+      socket.connect(backend)
+    end
+
+    def start_heartbeat_worker
+      @timer = EventMachine::PeriodicTimer.new(heartbeat / 1000) do
+        send Message::SMI.heartbeat(sid)
+      end
+    end
+
+    def handle_frames(*frames)
+      # we need to close frame to avoid memory leaks
+      frames = frames.map do |frame|
+        out_frame = frame.copy_out_string
+        frame.close
+        out_frame
+      end
+
+      handle Message.parse(frames)
+    end
+
+    def handle(message)
+      if message.req?
+        handle_request(message)
+      #else
+        # puts "heartbeat response received!"
+      end
+    rescue ZSS::Error => error
+      #puts "Erorr: ZSS::Error raised while processing request: #{e}"
+      reply_error error, message
+    rescue => e
+      #puts "Error while processing request: #{e}"
+      reply_error Error[500], message
+    end
+
+    def handle_request(message)
+      if message.address.sid != sid
+        error = Error[404]
+        error.developer_message = "Invalid SID: #{message.address.sid}!"
+        fail error
+      end
+
+      # the router returns an handler that receives payload and headers
+      handler = router.get(message.address.verb)
+      message.payload = handler.call(message.payload, message.headers)
+      reply message
+    end
+
+    def reply_error(error, message)
+      message.status = error.code
+      message.payload = {
+        errorCode: error.code,
+        userMessage: error.user_message,
+        developerMessage: error.developer_message
+      }
+      message.type = Message::Type::REP
+      send message
+    end
+
+    def reply(message)
+      #puts "reply #{message}"
+      message.status = 200
+      message.type = Message::Type::REP
+      send message
+    end
+
+    def send(msg)
+      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
+    end
+
+  end
+end