rack-traffic-logger 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b956c1f090a00f5a1a2a9312a2d75d553110a1a5
-  data.tar.gz: 61e0c4abd72b7273951b6b6a3bcca482b0debea1
+  metadata.gz: 1120835c0da5e0f0c12db85aabed34df53cbb863
+  data.tar.gz: 252fa5e46838aeeb1062bf5bbaba6895a9232c42
 SHA512:
-  metadata.gz: 1a1f32d6b739d39af2375383f659aa3f9efa37a69d47e0c8f6ddb22b2bca5dc355074f2e879590109fd2f035c2aaa7d0e84f35734535e4346514bbfb1dff7d89
-  data.tar.gz: 81552abbaa6f568e6af21cb2e88fb0c98c831b602b54cae47883981d4d6eb2b568977e975ea31dd2af132af1c73a4e84eb9dcd8a1e5bf537e91afd3b4c63110d
+  metadata.gz: 37ec6e8bba2e9da12241eb85234f42a2cf16f7e0f2c84bd6a90097178aa178acd754d2e690895d9b67505cd77862b3df544a9b6bdd56e25cb5a0bde9a29ad899
+  data.tar.gz: 1c9d85c8cc6489cc3924a69f2ff9a4eb7406326d331155b052e9fb1f6fdeb01a76ab272f9849c11f4cbb429d2b63f8cf49042821da08f2198cdd1d3310ce302d

data/README.md

@@ -134,6 +134,25 @@ use Rack::TrafficLogger, 'file.log', :request_headers, 401 => false, 500...600 =
 use Rack::TrafficLogger, 'file.log', [:get, :head] => 200..204, post: {only: {201 => :request_bodies}}, [:put, :patch] => :all
 ```
 
+#### Shorthand Syntax
+
+Use shorthand syntax if you want to configure logging through a string-based configuration medium. The previous examples could also be written as:
+
+```ruby
+use Rack::TrafficLogger, 'file.log', 'ih,401:f,5**:a,2**:{po:ib,de:f}'
+use Rack::TrafficLogger, 'file.log', '[ge,he]:200-204,po:{o:{201:ib}},[pu,pa]:a'
+```
+
+It's ruby, plus these rules:
+
+- Omit colons from Symbols. All strings of letters are converted to symbols (except `false`).
+- Use colons in place of hash rockets.
+- Use hyphens for ranges, i.e. `200-204` instead of `200..204`.
+- Use splats in place of large ranges, i.e. `40*` instead of `400..409`.
+- Write only the first two letters of HTTP verbs, e.g. `po` for `post`.
+- Use `a` for `all`, `h` for `headers`, `b` for `bodies`, `ih` for `request_headers`, `ib` for `request_bodies`, `oh` for `response_headers`, and `ob` for `response_bodies` (think of `i` for *input*, and `o` for *output*).
+- Use `o` for `only` and `f` for false.
+
 ### Tailing a JSON log
 
 Tailing a JSON log can induce migraines. There are a couple of solutions:

data/lib/rack/traffic_logger/option_interpreter/shorthand.rb

@@ -0,0 +1,74 @@
+module Rack
+  class TrafficLogger
+    class OptionInterpreter
+      class Shorthand
+
+        ABBREVIATONS = {
+            ge: :get,
+            po: :post,
+            pu: :put,
+            pa: :patch,
+            de: :delete,
+            op: :options,
+            he: :head,
+            tr: :trace,
+            h: :headers,
+            b: :bodies,
+            a: :all,
+            ih: :request_headers,
+            ib: :request_bodies,
+            oh: :response_headers,
+            ob: :response_bodies,
+            o: :only,
+            f: :false
+
+        }.map { |k, v| [k.to_s, v.to_s] }.to_h
+
+        def self.transform(input)
+          raise ArgumentError, 'Input must be a string' unless String === input
+          new(input).transform
+        end
+
+        def initialize(input)
+          @input = input
+        end
+
+        def transform
+          @string = @input.dup
+          expand_abbreviations
+          ranges
+          hash_rockets_and_symbols
+          wrappers
+          instance_eval @string
+        end
+
+        private
+
+        attr_accessor :string
+
+        def expand_abbreviations
+          @string.gsub!(/[_a-z]+/) { |m| ABBREVIATONS[m] || m }
+        end
+
+        def ranges
+          @string.gsub!(/(\d+)-(\d+)/) { "(#{$1}..#{$2})" }
+          @string.gsub!(/[1-5][\d*]\*/) { |m| '(%s..%s)' % [m.gsub('*', '0'), m.gsub('*', '9')] }
+        end
+
+        def hash_rockets_and_symbols
+          @string.gsub! ':', '=>'
+          @string.gsub!(/[_a-z]+/) { |m| m == 'false' ? m : ":#{m}" }
+        end
+
+        def wrappers
+          @string.gsub!(/[\[{]/) { |m| "(#{m}" }
+          @string.gsub!(/[\]}]/) { |m| "#{m})" }
+          @string.gsub! '!', ' _false!'
+          @string.gsub! '+', ' _only!'
+          @string = "[#{@string}]"
+        end
+
+      end
+    end
+  end
+end

data/lib/rack/traffic_logger/option_interpreter.rb

@@ -1,3 +1,5 @@
+require_relative 'option_interpreter/shorthand'
+
 module Rack
   class TrafficLogger
     class OptionInterpreter
@@ -52,6 +54,7 @@ module Rack
 
       def add_rules(input, **filter)
         input = [input] unless Array === input
+        input = Shorthand.new(input.shift).transform + input while String === input.first
         verb = filter[:verb]
         code = filter[:code]
         input.each do |token|

data/lib/rack/traffic_logger/reader.rb

@@ -13,8 +13,8 @@ module Rack
         @input = input
         @output = output
         @formatter = Formatter::Stream.new(**options)
-        Signal.trap('INT') { exit 0 }
-        loop { readline }
+        Signal.trap('INT') { done }
+        readline until @done
       end
 
       # Reads a line from input, formats it, and sends it to output
@@ -27,7 +27,7 @@ module Rack
           rescue IO::EAGAINWaitReadable
             sleep 0.1
           rescue EOFError
-            exit 0
+            return done
           end
         end
       end
@@ -44,6 +44,10 @@ module Rack
         end
       end
 
+      def done
+        @done = true
+      end
+
     end
   end
 end

data/lib/rack/traffic_logger/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class TrafficLogger
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-traffic-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Neil E. Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -40,6 +40,7 @@ files:
 - lib/rack/traffic_logger/formatter/stream.rb
 - lib/rack/traffic_logger/header_hash.rb
 - lib/rack/traffic_logger/option_interpreter.rb
+- lib/rack/traffic_logger/option_interpreter/shorthand.rb
 - lib/rack/traffic_logger/reader.rb
 - lib/rack/traffic_logger/stream_simulator.rb
 - lib/rack/traffic_logger/version.rb