carnivore-unixsocket 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0690f9cf11c543bfc6f51202a972f3b6852228b
+  data.tar.gz: 0b450308e838d001f603b90ea15f1b491a6b1506
+SHA512:
+  metadata.gz: 504228019293064bd168444a5018c73c09efd6e8077c1b438eac9bb30c479095f2949bf36a609d4d904dd5067c2e32503e1b1e06cad7289a0aecffc7ae1bc53d
+  data.tar.gz: 4559e2340b4861cb4e133dc880857241eb61b038bd7603c86a1af7ea0f5331e686414a23bb6746fbf57700ed386bd5b152888f2e7ff5dc7b3c63a1296cd4cff0

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.1.0
+* Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+## Branches
+
+### `master` branch
+
+The master branch is the current stable released version.
+
+### `develop` branch
+
+The develop branch is the current edge of development.
+
+## Pull requests
+
+* https://github.com/carnivore-rb/carnivore-unixsocket/pulls
+
+Please base all pull requests of the `develop` branch. Merges to
+`master` only occur through the `develop` branch. Pull requests
+based on `master` will likely be cherry picked.
+
+## Issues
+
+Need to report an issue? Use the github issues:
+
+* https://github.com/carnivore-rb/carnivore-unixsocket/issues

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2014 Chris Roberts
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,21 @@
+# Carnivore Unix Socket
+
+Provides Unix Socket `Carnivore::Source`
+
+# Usage
+
+```ruby
+require 'carnivore'
+require 'carnivore-unixsocket'
+
+Carnivore.configure do
+  source = Carnivore::Source.build(
+    :type => :socket, :args => {:path => '/var/run/my.sock'}
+  )
+end
+```
+
+# Info
+* Carnivore: https://github.com/carnivore-rb/carnivore
+* Repository: https://github.com/carnivore-rb/carnivore-unixsocket
+* IRC: Freenode @ #carnivore

data/carnivore-unixsocket.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'carnivore-unixsocket/version'
+Gem::Specification.new do |s|
+  s.name = 'carnivore-unixsocket'
+  s.version = Carnivore::UnixSocket::VERSION.version
+  s.summary = 'Message processing helper'
+  s.author = 'Chris Roberts'
+  s.email = 'chrisroberts.code@gmail.com'
+  s.homepage = 'https://github.com/carnivore-rb/carnivore-unixsocket'
+  s.description = 'Carnivore Unix Socket Source'
+  s.license = 'Apache 2.0'
+  s.require_path = 'lib'
+  s.add_dependency 'carnivore', '>= 0.1.8'
+  s.add_dependency 'celluloid-io'
+  s.files = Dir['**/*']
+end

data/lib/carnivore-unixsocket/unixsocket.rb

@@ -0,0 +1,85 @@
+require 'carnivore-unixsocket'
+
+module Carnivore
+  class Source
+    # Unix socket based carnivore source
+    class UnixSocket < Source
+
+      # max time for unix socket to setup
+      INIT_SRV_TIMEOUT = 2.0
+
+      # @return [String] path to socket
+      attr_reader :socket
+      # @return [String]
+      attr_reader :srv_name
+      # @return [Hash]
+      attr_reader :init_args
+
+      # Setup the unix socket
+      #
+      # @param args [Hash]
+      def setup(args={})
+        @socket = ::File.expand_path(args[:path])
+        @srv_name = "socket_srv_#{name}".to_sym
+        @connection = nil
+        @init_args = args
+      end
+
+      # @return [Util::Server]
+      def server
+        callback_supervisor[srv_name]
+      end
+
+      # @return [Celluloid::IO::UNIXSocket]
+      def connection
+        unless(@connection)
+          @connection = Celluloid::IO::UNIXSocket.new(socket)
+        end
+        @connection
+      end
+
+      # Initialize the server
+      def init_srv
+        callback_supervisor.supervise_as(srv_name,
+          Carnivore::UnixSocket::Util::Server,
+          init_args.merge(:notify_actor => current_actor)
+        )
+        waited = 0.0
+        until(server || waited > INIT_SRV_TIMEOUT)
+          sleep(0.01)
+          waited += 0.01
+        end
+        server.async.start
+      end
+
+      # Receive messages
+      def receive(*args)
+        wait(:new_socket_lines)
+        server.return_lines.map do |line|
+          begin
+            MultiJson.load(line)
+          rescue MultiJson::ParseError
+            line
+          end
+        end
+      end
+
+      # Send message
+      #
+      # @param payload [Object]
+      # @param original_message [Carnivore::Message]
+      def transmit(payload, original_message=nil)
+        output = payload.is_a?(String) ? payload : MultiJson.dump(payload)
+        connection.puts(output)
+        connection.flush
+      end
+
+      # Override processing to enable server only if required
+      def process(*args)
+        init_srv
+        super
+      end
+
+    end
+  end
+end

data/lib/carnivore-unixsocket/util/socket_connection.rb

@@ -0,0 +1,48 @@
+require 'carnivore-unixsocket'
+
+module Carnivore
+  module UnixSocket
+    module Util
+      class Connection
+
+        include Celluloid
+
+        attr_reader :srv, :io
+
+        def initialize(args={})
+          @io = args[:io]
+          @io.sync
+          @srv = args[:server]
+          async.consume! if args[:auto_consume]
+        end
+
+        def consume!
+          defer do
+            loop do
+              line = receive
+              unless(line.empty?)
+                srv.add_lines([line])
+              end
+            end
+          end
+        end
+
+        def write_line(s)
+          io.puts s
+          io.flush
+        end
+
+        def receive
+          line = io.gets
+          if(line)
+            line.strip
+          else
+            io.close
+            terminate
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/carnivore-unixsocket/util/socket_server.rb

@@ -0,0 +1,61 @@
+require 'carnivore-unixsocket'
+require 'celluloid/io'
+
+module Carnivore
+  module UnixSocket
+    module Util
+      class Server
+
+        include Celluloid
+        include Carnivore::Utils::Logging
+
+        attr_reader :path, :notify_actor, :server, :supervisor
+
+        def initialize(args={})
+          @path = ::File.expand_path(args[:path])
+          @notify_actor = args[:notify_actor]
+          @supervisor = Celluloid::SupervisionGroup.run!
+          @messages = []
+        end
+
+        def start
+          srv_actor = current_actor
+          defer do
+            loop do
+              setup_server!
+              debug 'Waiting for new connection to server'
+              connection = server.accept
+              debug 'Received new connection to server. Setting up connection...'
+              supervisor.supervise_as("con_#{connection.hash}", Connection,
+                :io => connection, :server => srv_actor, :auto_consume => true
+              )
+              debug 'Connection setup complete and active'
+            end
+          end
+        end
+
+        def setup_server!
+          unless(@server)
+            if(::File.exists?(path))
+              ::File.delete(path)
+            end
+            @server = Celluloid::IO::UNIXServer.new(path)
+          end
+        end
+
+        def add_lines(lines)
+          lines = [lines] unless lines.is_a?(Array)
+          @messages += lines
+          notify_actor.signal(:new_socket_lines)
+        end
+
+        def return_lines
+          msgs = @messages.dup
+          @messages.clear
+          msgs
+        end
+
+      end
+    end
+  end
+end

data/lib/carnivore-unixsocket/util.rb

@@ -0,0 +1,12 @@
+require 'carnivore-unixsocket'
+
+module Carnivore
+  module UnixSocket
+    module Util
+
+      autoload :Connection, 'carnivore-unixsocket/util/socket_connection'
+      autoload :Server, 'carnivore-unixsocket/util/socket_server'
+
+    end
+  end
+end

data/lib/carnivore-unixsocket/version.rb

@@ -0,0 +1,6 @@
+module Carnivore
+  module UnixSocket
+    # current library version
+    VERSION = Gem::Version.new('0.1.0')
+  end
+end

data/lib/carnivore-unixsocket.rb

@@ -0,0 +1,13 @@
+require 'celluloid/io'
+require 'carnivore'
+
+module Carnivore
+  module UnixSocket
+
+    autoload :Util, 'carnivore-unixsocket/util'
+
+  end
+end
+
+require 'carnivore-unixsocket/version'
+Carnivore::Source.provide(:unix_socket, 'carnivore-unixsocket/unixsocket')

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: carnivore-unixsocket
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carnivore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: celluloid-io
+  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: Carnivore Unix Socket Source
+email: chrisroberts.code@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- carnivore-unixsocket.gemspec
+- lib/carnivore-unixsocket.rb
+- lib/carnivore-unixsocket/unixsocket.rb
+- lib/carnivore-unixsocket/util.rb
+- lib/carnivore-unixsocket/util/socket_connection.rb
+- lib/carnivore-unixsocket/util/socket_server.rb
+- lib/carnivore-unixsocket/version.rb
+homepage: https://github.com/carnivore-rb/carnivore-unixsocket
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Message processing helper
+test_files: []
+has_rdoc: