logplex 0.0.1.pre.4 → 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc2d2954418c3b93be55493748e2561c4b7b4b27
+  data.tar.gz: c5fb17e4a46500eb26779b3089b7aeb357e60498
+SHA512:
+  metadata.gz: 35fd6b2c2f5e56e6ed6d2036ae5add5e487f25418a552fdce091c02d2a6ecc5e6693a43a44cfc3dc2a24f4eb75728d3cea58865750a2a141f24e711c338a1f18
+  data.tar.gz: dd7b526faa13b42dd98261bdc7d3bd64c9389e734a7fcdfc106740b03ecaba58f896665e901d003276cdbfc116dddae24537c6cb26616b1493d985414f050422

data/.gitignore

@@ -1,13 +1,14 @@
-*.gem
-*.rbc
+_yardoc
 .bundle
 .config
+.ruby-version
 .yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
+*.gem
+*.rbc
 coverage
 doc/
+Gemfile.lock
+InstalledFiles
 lib/bundler/man
 pkg
 rdoc
@@ -15,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.tags

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.3.1
+script: bundle exec rspec

data/README.md

@@ -8,7 +8,7 @@ Logplex is the Heroku log router, and can be found
 ### Publishing messages
 
 ```ruby
-publisher = Logplex::Publisher.new(logplex_token, logplex_url)
+publisher = Logplex::Publisher.new(logplex_url)
 publisher.publish("There's a lady who's sure, all that glitters is gold",
                    process: 'worker.2', host: 'some-host')
 ```
@@ -31,7 +31,8 @@ eg: [log2viz](https://blog.heroku.com/archives/2013/3/19/log2viz)
 publisher.publish { vocals: 'Robert Plant', guitar: 'Jimmy Page' }
 # produces the message: vocals='Robert Plant' guitar='Jimmy Page'
 ```
-### Consumnig messages
+
+### Consuming messages
 
 TBD
 
@@ -41,7 +42,7 @@ You can configure default values for logplex message posting:
 
 ```ruby
 Logplex.configure do |config|
-  config.logplex_url     = 'https://logplex.example.com'
+  config.logplex_url     = 'https://logplex.example.com/logs'
   config.process         = 'stats'
   config.host            = 'host'
   config.publish_timeout = 2
@@ -52,7 +53,7 @@ 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 = Logplex::Publisher.new
 publisher.publish "And she's buying a stairway to heaven"
 ```
 

data/lib/logplex/configuration.rb

@@ -1,14 +1,16 @@
 module Logplex
   class Configuration
     attr_accessor :logplex_url,
+                  :app_name,
                   :process,
                   :host,
                   :publish_timeout
 
     def initialize
-      @logplex_url     = 'https://east.logplex.io'
+      @logplex_url     = 'https://east.logplex.io/logs'
       @host            = 'localhost'
       @publish_timeout = 1
+      @app_name        = 'app'
     end
   end
 
@@ -20,5 +22,4 @@ module Logplex
     self.configuration ||= Configuration.new
     yield(configuration)
   end
-
 end

data/lib/logplex/message.rb

@@ -13,8 +13,8 @@ module Logplex
     FIELD_DISABLED = '-'.freeze
 
     def initialize(message, opts = {})
-      @message   = message
-      @token      = opts.fetch(:token)
+      @message    = message
+      @app_name   = opts[:app_name] || Logplex.configuration.app_name
       @time       = opts[:time] || DateTime.now
       @process    = opts[:process] || Logplex.configuration.process
       @host       = opts[:host] || Logplex.configuration.host
@@ -22,7 +22,7 @@ module Logplex
     end
 
     def syslog_frame
-      temp = "#{FACILITY_AND_PRIORITY} #{formatted_time} #{@host} #{@token} #{@process} #{@message_id} #{FIELD_DISABLED} #{formatted_message}"
+      temp = "#{FACILITY_AND_PRIORITY} #{formatted_time} #{@host} #{@app_name} #{@process} #{@message_id} #{FIELD_DISABLED} #{formatted_message}"
       length = temp.length
       "#{length} #{temp}"
     end
@@ -34,7 +34,8 @@ module Logplex
       errors.add(:host, "can't be nil") if @host.nil?
     end
 
-  private
+    private
+
     def formatted_time
       case @time.class
       when String
@@ -45,7 +46,7 @@ module Logplex
     end
 
     def formatted_message
-      if @message.kind_of?(Hash)
+      if @message.is_a?(Hash)
         @message.inject([]) do |res, (key, value)|
           res << %{#{key}="#{value}"}
         end.join(' ')
@@ -53,6 +54,5 @@ module Logplex
         @message
       end
     end
-
   end
 end

data/lib/logplex/publisher.rb

@@ -1,18 +1,17 @@
 # encoding: UTF-8
-require 'base64'
-require 'restclient'
+require 'excon'
 require 'logplex/message'
 require 'timeout'
 
 module Logplex
   class Publisher
-    PUBLISH_ERRORS = [RestClient::InternalServerError,
-                      RestClient::Unauthorized,
+    PUBLISH_ERRORS = [Excon::Errors::InternalServerError,
+                      Excon::Errors::Unauthorized,
                       Timeout::Error].freeze
 
-    def initialize(token, logplex_url=nil)
-      @token       = token
+    def initialize(logplex_url = nil)
       @logplex_url = logplex_url || Logplex.configuration.logplex_url
+      @token = URI(@logplex_url).password || Logplex.configuration.app_name
     end
 
     def publish(messages, opts={})
@@ -20,11 +19,11 @@ module Logplex
       unless messages.is_a? Array
         message_list = [message_list]
       end
-      message_list.map! { |m| Message.new(m, opts.merge(token: @token)) }
+      message_list.map! { |m| Message.new(m, opts.merge(app_name: @token)) }
       message_list.each(&:validate)
       if message_list.inject(true) { |accum, m| m.valid? }
         begin
-          Timeout::timeout(Logplex.configuration.publish_timeout) do
+          Timeout.timeout(Logplex.configuration.publish_timeout) do
             api_post(message_list.map(&:syslog_frame).join(''))
             true
           end
@@ -34,14 +33,13 @@ module Logplex
       end
     end
 
-  private
+    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)
+      Excon.post(@logplex_url, body: message, headers: {
+        "Content-Type" => 'application/logplex-1',
+        "Content-Length" => message.length,
+      }, expects: [200, 204])
     end
   end
 end

data/lib/logplex/version.rb

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

data/logplex.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   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.description   = "Publish and Consume Logplex messages"
+  gem.summary       = "Publish and Consume Logplex messages"
   gem.homepage      = "https://practiceovertheory.com"
 
   gem.files         = `git ls-files`.split($/)
@@ -17,7 +17,6 @@ Gem::Specification.new do |gem|
   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_dependency "excon"
   gem.add_development_dependency "rspec"
-  gem.add_development_dependency "sham_rack"
 end

data/spec/logplex/configuration_spec.rb

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

data/spec/logplex/message_spec.rb

@@ -7,7 +7,7 @@ describe Logplex::Message do
   it 'fills out fields of a syslog message' do
     message = Logplex::Message.new(
       'my message here',
-      token: 't.some-token',
+      app_name: 't.some-token',
       time: DateTime.parse("1980-08-23 05:31 00:00"),
       process: 'heroku-postgres',
       host: 'some-host',
@@ -20,17 +20,17 @@ describe Logplex::Message do
   end
 
   it 'is invalid for messages longer than 10240 bytes' do
-    short = Logplex::Message.new('a' * 10240, token:   'foo',
+    short = Logplex::Message.new('a' * 10240, app_name:   'foo',
                                               process: 'proc',
                                               host:    'host')
-    long  = Logplex::Message.new('a' * 10241, token: 'foo',
+    long  = Logplex::Message.new('a' * 10241, app_name: 'foo',
                                               process: 'proc',
                                               host:    'host')
     short.validate
     long.validate
 
-    expect(short.valid?).to be_true
-    expect(long.valid?).to be_false
+    expect(short.valid?).to be_truthy
+    expect(long.valid?).to be_falsey
   end
 
   it 'is invalid with no process or host' do
@@ -39,10 +39,10 @@ describe Logplex::Message do
       conf.process = nil
     end
 
-    message = Logplex::Message.new("a message", token: 't.some-token')
+    message = Logplex::Message.new("a message", app_name: 't.some-token')
     message.validate
 
-    expect(message.valid?).to be_false
+    expect(message.valid?).to be_falsey
     expect(message.errors[:process]).to eq ["can't be nil"]
     expect(message.errors[:host]).to eq ["can't be nil"]
   end
@@ -50,7 +50,7 @@ describe Logplex::Message do
   it 'formats logs as key/values when given a hash' do
     message = Logplex::Message.new(
       { vocals: 'Robert Plant', guitar: 'Jimmy Page' },
-      token: 't.some-token',
+      app_name: 't.some-token',
       process: 'proc',
       host:    'host',
       time: DateTime.parse("1980-08-23 05:31 00:00")

data/spec/logplex/publisher_spec.rb

@@ -1,96 +1,76 @@
 require 'spec_helper'
-require 'sham_rack'
 require 'logplex/publisher'
-require 'support/fake_logplex'
 
-describe Logplex::Publisher, '#publish' do
-  before do
-    Logplex.configure do |config|
-      config.process = "postgres"
-      config.host = "host"
-    end
-  end
-
-  context 'with a working logplex' do
+describe Logplex::Publisher do
+  describe '#publish' do
     before do
-      ShamRack.mount(FakeLogplex.new, 'logplex.example.com', 443)
-
+      Excon.defaults[:mock] = true
+      Logplex.configure do |config|
+        config.process = "postgres"
+        config.host = "host"
+      end
     end
 
     after do
-      ShamRack.unmount_all
-      FakeLogplex.clear!
-      restore_default_config
+      Excon.stubs.clear
     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)
+    context 'with a working logplex' do
+      after do
+        restore_default_config
       end
 
-      expect(FakeLogplex.requests_received).to eq(1)
-    end
+      it 'encodes a message and publishes it' do
+        Excon.stub({ method: :post, password: "t.some-token", body: /message for you/ }, status: 204)
+        message = 'I have a message for you'
+        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+        publisher.publish(message)
+      end
 
-    it 'does the thing' do
-      FakeLogplex.register_token('t.some-token')
+      it 'sends many messages in one request when passed an array' do
+        Excon.stub({ method: :post, password: "t.some-token", body: /here is another/ }, status: 204)
+        expect(Excon).to receive(:post).once
+        messages = ['I have a message for you', 'here is another', 'some final thoughts']
 
-      message = { hi: 'there' }
-      publisher = Logplex::Publisher.new('t.some-token', 'https://logplex.example.com')
-      publisher.publish(message)
+        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
 
-      expect(FakeLogplex).to have_received_message('hi="there"')
-    end
+        publisher.publish(messages)
+      end
 
-    it 'returns true' do
-      FakeLogplex.register_token('t.some-token')
+      it 'does the thing' do
+        Excon.stub({ method: :post, password: "t.some-token", body: /hi\="there\"/ }, status: 204)
+        message = { hi: 'there' }
+        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+        expect(publisher.publish(message)).to be_truthy
+      end
 
-      message = 'I have a message for you'
-      publisher = Logplex::Publisher.new('t.some-token', 'https://logplex.example.com')
-      expect(publisher.publish(message)).to be_true
-    end
+      it 'returns true' do
+        Excon.stub({ method: :post, password: "t.some-token" }, status: 204)
+        message = 'I have a message for you'
+        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+        expect(publisher.publish(message)).to be_truthy
+      end
 
-    it "returns false when there's an auth error" do
-      message = 'I have a message for you'
-      publisher = Logplex::Publisher.new('t.some-token', 'https://logplex.example.com')
-      expect(publisher.publish(message)).to be_false
+      it "returns false when there's an auth error" do
+        Excon.stub({ method: :post, password: "t.some-token" }, status: 401)
+        message = 'I have a message for you'
+        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+        expect(publisher.publish(message)).to be_falsey
+      end
     end
-  end
 
-  context 'when the logplex service is acting up' do
-    before do
-      ShamRack.at('logplex.example.com', 443) do
-        [500, {}, []]
+    context 'when the logplex service is acting up' do
+      it 'returns false' do
+        Excon.stub({ method: :post, password: "t.some-token" }, status: 500)
+        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+        expect(publisher.publish('hi')).to be_falsey
       end
     end
 
-    after { ShamRack.unmount_all }
-
-    it 'returns false' do
-      publisher = Logplex::Publisher.new('t.some-token', 'https://logplex.example.com')
-      expect(publisher.publish('hi')).to be_false
+    it "handles timeouts" do
+      expect(Excon).to receive(:post).and_raise(Timeout::Error)
+      publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+      expect(publisher.publish('hi')).to be_falsey
     end
   end
-
-  it "handles timeouts" do
-    RestClient.stub(:post).and_raise Timeout::Error
-    publisher = Logplex::Publisher.new('t.some-token', 'https://logplex.example.com')
-    expect(publisher.publish('hi')).to be_false
-  end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,6 @@
 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
 

metadata

@@ -1,60 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: logplex
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.4
-  prerelease: 6
+  version: 0.0.1
 platform: ruby
 authors:
 - Harold Giménez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: valcro
-  requirement: &70169923645940 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70169923645940
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: &70169923645520 !ruby/object:Gem::Requirement
-    none: false
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70169923645520
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70169923645040 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70169923645040
-- !ruby/object:Gem::Dependency
-  name: sham_rack
-  requirement: &70169923644580 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70169923644580
 description: Publish and Consume Logplex messages
 email:
 - harold.gimenez@gmail.com
@@ -62,8 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -79,35 +77,32 @@ files:
 - spec/logplex/message_spec.rb
 - spec/logplex/publisher_spec.rb
 - spec/spec_helper.rb
-- spec/support/fake_logplex.rb
 homepage: https://practiceovertheory.com
 licenses: []
+metadata: {}
 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
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 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: 

data/spec/support/fake_logplex.rb

@@ -1,108 +0,0 @@
-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
-