logplex 0.0.1.pre

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Harold Giménez
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Harold Giménez
+
+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.

data/README.md

@@ -0,0 +1,52 @@
+# Logplex
+
+Publish and Consume Logplex messages
+
+Logplex is the Heroku log router, and can be found [here](https://github.com/heroku/logplex).
+
+### Publishing messages
+
+```ruby
+publisher = Logplex::Publisher.new(logplex_token, logplex_url)
+publisher.publish("This is a log entry", process: 'worker.2',
+                                         host:    'some-host')
+```
+
+Passing an array of messages to the `#publish` method will publish them all in one request,
+so some latency optimization is possible:
+
+```ruby
+publisher.publish [ "And as we wind on down the road",
+                    "Our shadows taller than our soul",
+                    "There walks a lady we all know",
+                    "Who shines white light and wants to show"]
+```
+
+### Consumnig messages
+
+TBD
+
+## Configuration
+
+You can configure default values for logplex message posting:
+
+```ruby
+Logplex.configure do |config|
+  config.logplex_url = 'https://logplex.example.com'
+  config.process     = 'stats'
+  config.host        = 'host'
+end
+```
+
+In the example above, it is now not not necessary to
+specify a logplex URL, process or host when getting
+a hold of a publisher and publishing messages:
+
+```ruby
+publisher = Logplex::Publisher.new(logplex_token)
+publisher.publish "And she's buying a stairway to heaven"
+```
+
+### License
+
+Copyright (c) Harold Giménez. Released under the terms of the MIT License found in the LICENSE file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/logplex/configuration.rb

@@ -0,0 +1,21 @@
+module Logplex
+  class Configuration
+    attr_accessor :logplex_url,
+      :process,
+      :host
+
+    def initialize
+      @logplex_url = 'https://east.logplex.io'
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+end

data/lib/logplex/message.rb

@@ -0,0 +1,47 @@
+require 'valcro'
+require 'time'
+require 'logplex/configuration'
+
+module Logplex
+  class Message
+    include Valcro
+
+    # facility = local0, priority = info, RFC5452 encoded
+    # syslog version 1
+    FACILITY_AND_PRIORITY = '<134>1'.freeze
+
+    FIELD_DISABLED = '-'.freeze
+
+    def initialize(message, opts = {})
+      @message   = message
+      @token      = opts.fetch(:token)
+      @time       = opts[:time] || DateTime.now
+      @process    = opts[:process] || Logplex.configuration.process
+      @host       = opts[:host] || Logplex.configuration.host
+      @message_id = opts[:message_id] || FIELD_DISABLED
+    end
+
+    def syslog_frame
+      temp = "#{FACILITY_AND_PRIORITY} #{formatted_time} #{@host} #{@token} #{@process} #{@message_id} #{FIELD_DISABLED} #{@message}"
+      length = temp.length
+      "#{length} #{temp}"
+    end
+
+    def validate
+      super
+      errors.add(:message, "too long") if @message.length > 10240
+      errors.add(:process, "can't be nil") if @process.nil?
+      errors.add(:host, "can't be nil") if @host.nil?
+    end
+
+  private
+    def formatted_time
+      case @time.class
+      when String
+        DateTime.parse(@time).rfc3339
+      else
+        @time.to_datetime.rfc3339
+      end
+    end
+  end
+end

data/lib/logplex/publisher.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+require 'base64'
+require 'restclient'
+require 'logplex/message'
+
+module Logplex
+  class Publisher
+    def initialize(token, logplex_url=nil)
+      @token       = token
+      @logplex_url = logplex_url || Logplex.configuration.logplex_url
+    end
+
+    def publish(messages, opts={})
+      messages = Array(messages).dup
+      messages.map! { |m| Message.new(m, opts.merge(token: @token)) }
+      messages.each(&:validate)
+      if messages.inject(true) { |accum, m| m.valid? }
+        api_post(
+          messages.map(&:syslog_frame).join('')
+        )
+      end
+    end
+
+  private
+    def api_post(message)
+      auth_token = Base64.encode64("token:#{@token}")
+      auth = "Basic #{auth_token}"
+      RestClient.post("#{@logplex_url}/logs", message,
+                      content_type: 'application/logplex-1',
+                      content_length: message.length,
+                      authorization: auth)
+    end
+  end
+end

data/lib/logplex/version.rb

@@ -0,0 +1,3 @@
+module Logplex
+  VERSION = "0.0.1.pre"
+end

data/lib/logplex.rb

@@ -0,0 +1,4 @@
+require "logplex/version"
+require "logplex/configuration"
+require "logplex/message"
+require "logplex/publisher"

data/logplex.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logplex/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "logplex"
+  gem.version       = Logplex::VERSION
+  gem.authors       = ["Harold Giménez"]
+  gem.email         = ["harold.gimenez@gmail.com"]
+  gem.description   = %q{Publish and Consume Logplex messages}
+  gem.summary       = %q{Publish and Consume Logplex messages}
+  gem.homepage      = "https://practiceovertheory.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "valcro"
+  gem.add_dependency "rest-client"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sham_rack"
+end

data/spec/logplex/configuration_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'logplex/configuration'
+
+describe Logplex::Configuration, 'defaults' do
+  it 'defaults to the production heroku logplex url' do
+    Logplex.configure { |config| }
+
+    expect(
+      Logplex.configuration.logplex_url
+    ).to eq('https://east.logplex.io')
+  end
+end

data/spec/logplex/message_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'logplex/message'
+
+describe Logplex::Message do
+  before { Logplex.configure {} }
+  after { restore_default_config }
+  it 'fills out fields of a syslog message' do
+    message = Logplex::Message.new(
+      'my message here',
+      token: 't.some-token',
+      time: DateTime.parse("1980-08-23 05:31 00:00"),
+      process: 'heroku-postgres',
+      host: 'some-host',
+      message_id: '1'
+    )
+
+    expect(message.syslog_frame).to eq(
+      "91 <134>1 1980-08-23T05:31:00+00:00 some-host t.some-token heroku-postgres 1 - my message here"
+    )
+  end
+
+  it 'is invalid for messages longer than 10240 bytes' do
+    short = Logplex::Message.new('a' * 10240, token:   'foo',
+                                              process: 'proc',
+                                              host:    'host')
+    long  = Logplex::Message.new('a' * 10241, token: 'foo',
+                                              process: 'proc',
+                                              host:    'host')
+    short.validate
+    long.validate
+
+    expect(short.valid?).to be_true
+    expect(long.valid?).to be_false
+  end
+
+  it 'is invalid with no process or host' do
+    message = Logplex::Message.new("a message", token: 't.some-token')
+    message.validate
+
+    expect(message.valid?).to be_false
+    expect(message.errors[:process]).to eq ["can't be nil"]
+    expect(message.errors[:host]).to eq ["can't be nil"]
+  end
+end

data/spec/logplex/publisher_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'sham_rack'
+require 'logplex/publisher'
+require 'support/fake_logplex'
+
+describe Logplex::Publisher, '#publish' do
+  before do
+    ShamRack.mount(FakeLogplex.new, 'logplex.example.com', 443)
+
+    Logplex.configure do |config|
+      config.process = "postgres"
+      config.host = "host"
+    end
+  end
+
+  after do
+    ShamRack.unmount_all
+    FakeLogplex.clear!
+    restore_default_config
+  end
+
+  it 'encodes a message and publishes it' do
+    FakeLogplex.register_token('t.some-token')
+
+    message = 'I have a message for you'
+    publisher = Logplex::Publisher.new('t.some-token', 'https://logplex.example.com')
+    publisher.publish(message)
+
+    expect(FakeLogplex).to have_received_message(message)
+  end
+
+  it 'sends many messages in one request when passed an array' do
+    FakeLogplex.register_token('t.some-token')
+    messages = ['I have a message for you', 'here is another', 'some final thoughts']
+
+    publisher = Logplex::Publisher.new('t.some-token', 'https://logplex.example.com')
+
+    publisher.publish(messages)
+
+    messages.each do |message|
+      expect(FakeLogplex).to have_received_message(message)
+    end
+
+    expect(FakeLogplex.requests_received).to eq(1)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end
+
+def restore_default_config
+  Logplex.configuration = nil
+  Logplex.configure {}
+end

data/spec/support/fake_logplex.rb

@@ -0,0 +1,108 @@
+class FakeLogplex
+  class Message
+
+    attr_reader :message, :token
+
+    def initialize(opts)
+      @message = opts[:message]
+      @token   = opts[:token]
+    end
+
+    def self.from_syslog(syslog_message)
+      messages = []
+      anchor = 0
+      until anchor >= syslog_message.length
+        new_anchor, opts = extract_syslog_field(syslog_message, anchor)
+        raise "same" if anchor == new_anchor
+        anchor = new_anchor
+        messages << new(opts)
+      end
+      messages
+    end
+
+    def self.extract_syslog_field(syslog_message, anchor)
+      start           = anchor
+      pos             = start
+      pos, bytes      = next_syslog_field(syslog_message, anchor, pos)
+      anchor          = pos+1
+      pos, facility   = next_syslog_field(syslog_message, anchor, pos)
+      anchor          = pos+1
+      pos, time       = next_syslog_field(syslog_message, anchor, pos)
+      anchor          = pos+1
+      pos, host       = next_syslog_field(syslog_message, anchor, pos)
+      anchor          = pos+1
+      pos, token      = next_syslog_field(syslog_message, anchor, pos)
+      anchor          = pos+1
+      pos, process    = next_syslog_field(syslog_message, anchor, pos)
+      anchor          = pos+1
+      pos, message_id = next_syslog_field(syslog_message, anchor, pos)
+      anchor          = pos+1
+      pos, unknown    = next_syslog_field(syslog_message, anchor, pos)
+      anchor          = pos+1
+
+      limit = start + bytes + bytes.to_s.length
+      message = syslog_message[anchor..limit]
+
+      [limit + 1, { message: message, token: token }]
+    end
+
+    def self.next_syslog_field(message, anchor, pos)
+      until char = message[pos+=1] and char == ' '
+        field = message[anchor..pos].to_i
+      end
+      [pos, field]
+    end
+  end
+
+  @@tokens = []
+  @@received_messages = []
+  @@requests_received = 0
+
+  def call(env)
+    @@requests_received += 1
+
+    message        = env['rack.input'].read
+    method         = env['REQUEST_METHOD']
+    path           = env['PATH_INFO']
+    content_type   = env['CONTENT_TYPE']
+    content_length = env['CONTENT_LENGTH'].to_i
+    auth           = env['HTTP_AUTHORIZATION']
+
+    _, auth_token = auth.split(' ')
+    user, pass = Base64.decode64(auth_token).split(':')
+    if @@tokens.include?(pass)
+      if (method == 'POST' &&
+          path == '/logs' &&
+          content_type == 'application/logplex-1' &&
+          content_length == message.length)
+
+        @@received_messages << Message.from_syslog(message)
+        @@received_messages.flatten!
+        [200, {}, []]
+      else
+        [404, {}, []]
+      end
+    else
+      [401, {}, []]
+    end
+  end
+
+  def self.has_received_message?(message)
+    @@received_messages.map(&:message).include? message
+  end
+
+  def self.register_token(token)
+    @@tokens << token
+  end
+
+  def self.clear!
+    @@tokens = []
+    @@received_messages = []
+    @@requests_received = 0
+  end
+
+  def self.requests_received
+    @@requests_received
+  end
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: logplex
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Harold Giménez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: valcro
+  requirement: &70148113247780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70148113247780
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70148113247240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70148113247240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70148113246560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70148113246560
+- !ruby/object:Gem::Dependency
+  name: sham_rack
+  requirement: &70148113245700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70148113245700
+description: Publish and Consume Logplex messages
+email:
+- harold.gimenez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logplex.rb
+- lib/logplex/configuration.rb
+- lib/logplex/message.rb
+- lib/logplex/publisher.rb
+- lib/logplex/version.rb
+- logplex.gemspec
+- spec/logplex/configuration_spec.rb
+- spec/logplex/message_spec.rb
+- spec/logplex/publisher_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_logplex.rb
+homepage: https://practiceovertheory.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Publish and Consume Logplex messages
+test_files:
+- spec/logplex/configuration_spec.rb
+- spec/logplex/message_spec.rb
+- spec/logplex/publisher_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_logplex.rb
+has_rdoc: