carnivore-files 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 751a352aa27f264731f03db94c22669e2d823642
+  data.tar.gz: 59fdf94c07eed89ada05c7b2350b5f2af1bc25d9
+SHA512:
+  metadata.gz: 05a82a0a715c750b9eae0c785d493e53a32741996fdc24f21e34d14f3d82b4c61cf7a11f3db102458d59dc7d0df5e42b6603f53b17fa4616c73155dd86d7dc49
+  data.tar.gz: ec5cfd66f96523885ec06655832dda10c0a78d95c381e6281194590244d7c3295a2526046c801605a2684e4cd2303977e37d93e1b6debc247ecb0ad4b5f1c227

data/CHANGELOG.md

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

data/README.md

@@ -0,0 +1,46 @@
+# Carnivore Files
+
+Provides File `Carnivore::Source`
+
+# Usage
+
+```ruby
+require 'carnivore'
+require 'carnivore-files'
+
+Carnivore.configure do
+  source = Carnivore::Source.build(
+    :type => :file, :args => {:path => '/var/log/app.log'}
+  )
+end
+```
+
+The `File` source is built on two "foundations", `sleepy_penguin`
+and `nio4r`. The optimal foundation will be selected based on
+the current Ruby in use (`nio4r` for JRuby, `sleepy_penguin` for
+everything else). If you want to force the foundation:
+
+```ruby
+require 'carnivore'
+require 'carnivore-files'
+
+Carnivore.configure do
+  source = Carnivore::Source.build(
+    :type => :file, :args => {
+      :path => '/var/log/app.log',
+      :foundation => :nio
+    }
+  )
+end
+```
+
+## Important note
+
+The underlying foundations are not installed by this gem. Be sure
+include the dependency within your application dependencies (nio4r
+or sleepy_penguin).
+
+# Info
+* Carnivore: https://github.com/carnivore-rb/carnivore
+* Repository: https://github.com/carnivore-rb/carnivore-files
+* IRC: Freenode @ #carnivore

data/carnivore-files.gemspec

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'carnivore-files/version'
+Gem::Specification.new do |s|
+  s.name = 'carnivore-files'
+  s.version = Carnivore::Files::VERSION.version
+  s.summary = 'Message processing helper'
+  s.author = 'Chris Roberts'
+  s.email = 'code@chrisroberts.org'
+  s.homepage = 'https://github.com/carnivore-rb/carnivore-files'
+  s.description = 'Carnivore file source'
+  s.license = 'Apache 2.0'
+  s.require_path = 'lib'
+  s.add_dependency 'carnivore', '>= 0.1.8'
+  #  support both but don't want to install both
+  #  update to be setup like carnivore-rabbitmq
+  #  s.add_dependency 'nio4r'
+  s.add_dependency 'sleepy_penguin'
+  s.files = Dir['{lib}/**/**/*'] + %w(carnivore-files.gemspec README.md CHANGELOG.md)
+end

data/lib/carnivore-files.rb

@@ -0,0 +1,14 @@
+require 'carnivore-files/version'
+require 'carnivore'
+
+module Carnivore
+  # Carnivore source module for files
+  module Files
+    # Utilities for files
+    module Util
+      autoload :Fetcher, 'carnivore-files/util/fetcher'
+    end
+  end
+end
+
+Carnivore::Source.provide(:file, 'carnivore-files/file')

data/lib/carnivore-files/file.rb

@@ -0,0 +1,74 @@
+require 'carnivore'
+
+module Carnivore
+  class Source
+    # Carnivore source for consumption from files
+    class File < Source
+
+      # @return [String] path to file
+      attr_reader :path
+      # @return [Symbol] registry name of fetcher
+      attr_reader :fetcher_name
+
+      # Setup source
+      #
+      # @param args [Hash]
+      # @option args [String] :path path to file
+      # @option args [Symbol] :foundation underlying file interaction library
+      # @option args [Celluloid::Actor] :notify_actor actor to notify on line receive
+      def setup(args={})
+        @path = ::File.expand_path(args[:path])
+        @fetcher_name = "log_fetcher_#{name}".to_sym
+        unless(args[:foundation])
+          args[:foundation] = RUBY_ENGINE == 'jruby' ? :nio4r : :penguin
+        end
+        case args[:foundation].to_sym
+        when :nio, :nio4r
+          callback_supervisor.supervise_as(fetcher_name, Carnivore::Files::Util::Fetcher::Nio,
+            args.merge(:notify_actor => current_actor)
+          )
+        else
+          callback_supervisor.supervise_as(fetcher_name, Carnivore::Files::Util::Fetcher::Penguin,
+            args.merge(:notify_actor => current_actor)
+          )
+        end
+      end
+
+      # @return [Carnivore::Files::Util::Fetcher] line fetcher
+      def fetcher
+        callback_supervisor[fetcher_name]
+      end
+
+      # Start the line fetcher
+      def connect
+        fetcher.async.start_fetcher
+      end
+
+      # @return [Array<Hash>] return messages
+      def receive(*args)
+        wait(:new_log_lines)
+        fetcher.return_lines.map do |l|
+          format_message(l)
+        end
+      end
+
+      # Send payload
+      #
+      # @param payload [Object] payload to transmit
+      def transmit(payload, *args)
+        fetcher.write_line(payload)
+      end
+
+      protected
+
+      # Format message into customized Hash
+      #
+      # @param m [Object] payload
+      # @return [Hash]
+      def format_message(m)
+        Smash.new(:path => path, :content => m)
+      end
+
+    end
+  end
+end

data/lib/carnivore-files/util/fetcher.rb

@@ -0,0 +1,90 @@
+module Carnivore
+  module Files
+    # Helper utilities
+    module Util
+      # Fetch lines from file
+      class Fetcher
+
+        autoload :Nio, 'carnivore-files/util/nio'
+        autoload :Penguin, 'carnivore-files/util/penguin'
+
+        include Celluloid
+        include Carnivore::Utils::Logging
+
+        # @return [String] path to file
+        attr_reader :path
+        # @return [String] string to split messages on
+        attr_reader :delimiter
+        # @return [Celluloid::Actor] actor to notify on new messages
+        attr_reader :notify_actor
+
+        # @return [Array] messages
+        attr_accessor :messages
+        # @return [IO] underlying IO instance
+        attr_accessor :io
+
+        # Create new instance
+        #
+        # @param args [Hash] initialization args
+        # @option args [String] :path path to file
+        # @option args [String] :delimiter string delimiter to break messages
+        # @option args [Celluloid::Actor] :notify_actor actor to be notified on new messages
+        def initialize(args={})
+          @leftover = ''
+          @path = ::File.expand_path(args[:path])
+          @delimiter = args.fetch(:delimiter, "\n")
+          @notify_actor = args[:notify_actor]
+          @messages = []
+        end
+
+        # Start the line fetcher
+        def start_fetcher
+          defer do
+            loop do
+              build_socket
+              messages = nil
+              selector.select.each do |mon|
+                self.messages += retrieve_lines
+              end
+              notify_actor.signal(:new_logs_lines) unless self.messages.empty?
+            end
+          end
+        end
+
+        # @return [Array<String>] current lines
+        def return_lines
+          msgs = messages.dup
+          messages.clear
+          msgs
+        end
+
+        # Write line to IO
+        #
+        # @param line [String]
+        # @return [Integer] bytes written
+        def write_line(line)
+          if(io)
+            io.puts(line)
+          else
+            raise 'No IO detected! Failed to write.'
+          end
+        end
+
+        # Retreive lines from file
+        def retrieve_lines
+          if(io)
+            while(data = io.read(4096))
+              @leftover << data
+            end
+            result = @leftover.split(delimiter)
+            @leftover.replace @leftover.end_with?(delimiter) ? '' : result.pop.to_s
+            result
+          else
+            []
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/carnivore-files/util/nio.rb

@@ -0,0 +1,105 @@
+require 'nio'
+
+module Carnivore
+  module Files
+    module Util
+      class Fetcher
+
+        # NIO based fetcher
+        class Nio < Fetcher
+
+          # @return [NIO::Monitor]
+          attr_accessor :monitor
+          # @return [NIO::Selector]
+          attr_accessor :selector
+
+          # Create new instance
+          #
+          # @param args [Hash] initialization arguments (unused)
+          def initialize(args={})
+            super
+            @selector = NIO::Selector.new
+            every(5) do
+              check_file
+            end
+          end
+
+          # Start the fetcher
+          def start_fetcher
+            defer do
+              loop do
+                build_io
+                messages = nil
+                selector.select.each do |mon|
+                  self.messages += retrieve_lines
+                end
+                notify_actor.signal(:new_log_lines) unless self.messages.empty?
+              end
+            end
+          end
+
+          private
+
+          # Check for file and destroy monitor if file has changed
+          def check_file
+            if(io)
+              begin
+                unless(io.stat.ino == ::File.stat(path).ino)
+                  destroy_io
+                end
+              rescue Errno::ENOENT
+                destroy_io
+              end
+            end
+          end
+
+          # Build the IO instance if found
+          #
+          # @return [TrueClass]
+          def build_io
+            unless(monitor)
+              if(::File.exists?(path))
+                unless(io)
+                  @io = ::File.open(path, 'r')
+                  @io.seek(0, ::IO::SEEK_END) # fast-forward to EOF
+                end
+                @monitor = selector.register(io, :r)
+              else
+                wait_for_file
+                build_io
+              end
+            end
+            true
+          end
+
+          # Destroy the IO instance and monitor
+          #
+          # @return [TrueClass]
+          def destroy_io
+            if(monitor)
+              selector.deregister(monitor)
+              @monitor = nil
+            end
+            if(io)
+              io.close
+              @io = nil
+            end
+            true
+          end
+
+          # Wait helper for file to appear (5 sleep second intervals)
+          #
+          # @return [TrueClass]
+          def wait_for_file
+            warn "Waiting for file to appear (#{path})"
+            until(::File.exists?(path))
+              sleep(5)
+            end
+            info "File has appeared (#{path})!"
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/carnivore-files/util/penguin.rb

@@ -0,0 +1,101 @@
+require 'sleepy_penguin/sp'
+
+module Carnivore
+  module Files
+    module Util
+      class Fetcher
+
+
+        # NIO based fetcher
+        class Penguin < Fetcher
+          # @return [SP::Inotify]
+          attr_accessor :notify
+          # @return [Hash] registered file descriptors
+          attr_accessor :notify_descriptors
+
+          # Create new instance
+          #
+          # @param args [Hash] initialization arguments (unused)
+          def initialize(args={})
+            super
+            @notify = SP::Inotify.new
+            @notify_descriptors = {}
+          end
+
+          # Start the fetcher
+          def start_fetcher
+            defer do
+              loop do
+                build_io
+                notify.each do |event|
+                  event.events.each do |ev|
+                    case ev
+                    when :MODIFY
+                      self.messages += retrieve_lines
+                    when :MOVE_SELF, :DELETE_SELF, :ATTRIB
+                      destroy_io
+                    end
+                  end
+                  notify_actor.signal(:new_log_lines) unless messages.empty?
+                end
+              end
+            end
+          end
+
+          private
+
+          # Build the IO and monitor
+          #
+          # @return [TrueClass]
+          def build_io
+            unless(io)
+              if(::File.exists?(path))
+                notify_descriptors[:file_watch] = notify.add_watch(path, :ALL_EVENTS)
+                @io = ::File.open(path, 'r')
+                @io.seek(0, ::IO::SEEK_END) # fast-forward to EOF
+              else
+                wait_for_file
+                build_io
+              end
+            end
+            true
+          end
+
+          # Destroy the IO and monitor
+          #
+          # @return [TrueClass]
+          def destroy_io
+            if(io)
+              notify.rm_watch(notify_descriptors.delete(:file_watch))
+              @io.close
+              @io = nil
+            end
+            true
+          end
+
+
+          # Wait helper for file to appear (waits for expected notification)
+          #
+          # @return [TrueClass]
+          def wait_for_file
+            until(::File.exists?(path))
+              notified = false
+              directory = ::File.dirname(path)
+              notify_descriptors[:file_wait] = notify.add_watch(directory, :OPEN)
+              until(notified)
+                warn "Waiting for file to appear (#{path})"
+                event = notify.take
+                if(event.name)
+                  notified = ::File.expand_path(event.name) == path
+                end
+              end
+              notify.rm_watch(notify_descriptors.delete(:file_wait))
+            end
+            info "File has appeared (#{path})!"
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/carnivore-files/version.rb

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: carnivore-files
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 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: sleepy_penguin
+  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 file source
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- carnivore-files.gemspec
+- lib/carnivore-files.rb
+- lib/carnivore-files/file.rb
+- lib/carnivore-files/util/fetcher.rb
+- lib/carnivore-files/util/nio.rb
+- lib/carnivore-files/util/penguin.rb
+- lib/carnivore-files/version.rb
+homepage: https://github.com/carnivore-rb/carnivore-files
+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: