loggie 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54f4aa6ed07ad0839fc96270543d29a8613844a0
-  data.tar.gz: d3cc371da73af48e08e3692c4d614f3b09ded77f
+  metadata.gz: 1f5379f3de4e3589a9e4932702b79244c6f26a1a
+  data.tar.gz: a80e9996174e3a85fdfad3f5ac0aad08a3626404
 SHA512:
-  metadata.gz: 2069a90bcbf532b442fcf3566c16ebb4a86aa6947695f0e59c9516e2d501ef2766b90a7b184442e4f92bd90141d04c0ece94bcf16c9370dcca5ea8f5d0a8d9d1
-  data.tar.gz: c63c50515147e7cdb02254efb0c6a8f3556416b5ce871714c2674a47f4ee59461d9adbe8e0f77576bca9b3146ec0f045a6393fb4b78133f5491b4dd854d95f11
+  metadata.gz: 05f8aeb73e4ae741e9bb791bd32ccb602b54c0600ab0e0e743b28d3bebe98aad998532425ea0aac87071f7cb4edc00eadf64d16dd06514300470bed65ca254ee
+  data.tar.gz: 1e97433ff0b40817b2eb9360be901018adb250019f4cd1ee89ff30e876506bbe0809aa1c5cdb43ccd377dc4e9aacd6ab1dfefac312481e90145f853ae9e5ba93

data/README.md

@@ -34,6 +34,38 @@ Or, use from the command line with:
 
 `loggie foobar`
 
+env is required for command line usage, and can be prefixed to the command, eg:
+
+`READ_TOKEN=abc LOG_FILES=x,y,z loggie foobar`
+
+Or the create a `.loggie` file in the current path.
+
+## Configuring Loggie
+
+```
+Loggie.configure do |config|
+  # from https://logentries.com/app/<app>#/user-account/apikey
+  config.read_token = 'key'
+
+  # A comma separated list of log file ids
+  config.log_files = ['e20bd6af', 'c83c7cd7', '6fb426fd', '776dfea9']
+
+  # Depending on the size of the underlying dataset of the complexity of the query,
+  # a request may not yield a value straight away. In this case this gem will request
+  # the results up until this retry count
+  config.max_retry = 50
+
+  # Time to sleep before each retry, smaller value will poll more
+  # and could get get result quicker, but will eat into rate limit
+  # of request count
+  config.sleep_before_retry_seconds = 0.5
+
+  # If the log message is JSON parsable, then it will slice off all but
+  # the ones listed here. Whole log line is returned otherwise.
+  config.default_fields_included = ["keys", "from", "log", "output"]
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/console

@@ -3,8 +3,5 @@
 require "bundler/setup"
 require "loggie"
 
-require 'dotenv'
-Dotenv.load
-
 require "pry"
 Pry.start

data/bin/loggie

@@ -3,10 +3,6 @@
 
 require "bundler/setup"
 
-require 'dotenv'
-Dotenv.load
-Dotenv.load(".loggie.env")
-
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "/../lib"))
 
 require 'loggie'

data/lib/loggie/configuration.rb

@@ -0,0 +1,35 @@
+module Loggie
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    MAX_RETRY_DELEY_SECONDS = 20.0 # max 20 seconds, or it will expire
+
+    attr_accessor :read_token
+    attr_accessor :log_files
+    attr_accessor :max_retry
+    attr_accessor :log_level
+    attr_accessor :sleep_before_retry_seconds
+    attr_accessor :default_fields_included
+
+    def initialize
+      @max_retry = 50
+      @log_level = :info
+      @sleep_before_retry_seconds = 0.5
+      @default_fields_included = [
+        "request_method", "path_info", "query_string", "agent", 
+        "authorization", "response_body", "request_params"
+      ]
+    end
+
+    def valid?
+      sleep_before_retry_seconds.to_f < MAX_RETRY_DELEY_SECONDS
+    end
+  end
+end

data/lib/loggie/extract.rb

@@ -36,12 +36,8 @@ module Loggie
     #  "request_params" ....
     #  "duration"
 
-    DEFAULT_FIELDS_INCLUDED = [
-      "request_method", "path_info", "query_string", "agent", "authorization", "response_body", "request_params"
-    ]
-
     def initialize
-      @keep_fields = DEFAULT_FIELDS_INCLUDED
+      @keep_fields = Loggie.configuration.default_fields_included
     end
 
     ##
@@ -72,7 +68,7 @@ module Loggie
       m = remove_rails_timestamp(m)
       m = safe_parse(m)
       m = remove_empty_fields(m)
-      m.except(*keep_fields)
+      m.slice(*keep_fields)
     end
 
     def remove_rails_timestamp(message)

data/lib/loggie/logentries/retry.rb

@@ -5,16 +5,18 @@ module Loggie
     # It checks the response and extracts the polling URI for progress
     class Retry
       include Logging
-      MAX_RETRY = ENV.fetch('MAX_RETRY', 5).to_i
-      RETRY_DELAY_SECONDS = ENV.fetch('RETRY_DELAY_SECONDS', 0.2).to_f
-      MAX_RETRY_DELEY_SECONDS = 20 # max 20 seconds, or it will expire
 
       class RetryError < RuntimeError; end
       class RetryCountExceededError < RetryError; end
       class RetryResponseError < RetryError; end
 
+      def initialize
+        @retry_count = 0
+        @max_retry = Loggie.configuration.max_retry
+        @sleep_before_retry_seconds = Loggie.configuration.sleep_before_retry_seconds
+      end
+
       def call(url, method, options, &block)
-        # TODO: ensure retry_count is reset or if that matters
         @retry_count ||= 0
         response = block.call(url, method, options)
         logger.debug "#{self.class} retry:#{@retry_count}, response:#{response.body}"
@@ -28,11 +30,11 @@ module Loggie
         logger.info "Logentries returned progress:#{res.progress}"
 
         @retry_count += 1
-        if @retry_count > MAX_RETRY
-          raise RetryCountExceededError, "Retry count of #{MAX_RETRY} reached"
+        if @retry_count > max_retry
+          raise RetryCountExceededError, "Retry count of #{max_retry} reached"
         end
 
-        sleep RETRY_DELAY_SECONDS
+        sleep sleep_before_retry_seconds
 
         self.call(res.next_url, :get, nil, &block)
 
@@ -40,6 +42,10 @@ module Loggie
         logger.error e.message
         nil
       end
+
+      private
+
+      attr_reader :max_retry, :sleep_before_retry_seconds
     end
   end
 end

data/lib/loggie/logentries/search.rb

@@ -5,7 +5,6 @@ module Loggie
       include Logging
       BASE_URI = "https://rest.logentries.com"
       QUERY_PATH = "query/logs"
-      LOG_FILES = ENV['LOG_FILES']
 
       ##
       # @param [String] query: to perform
@@ -15,7 +14,7 @@ module Loggie
       #
       def initialize(query: nil, from: nil, to: nil, log_files: nil)
         @query, @from, @to = query, from, to
-        @log_files = log_files || log_files_from_env
+        @log_files = log_files || Loggie.configuration.log_files
         @extract = Extract.new
         @request = Request.new(retry_mechanism: Retry.new)
       end
@@ -52,10 +51,6 @@ module Loggie
       def convert(time)
         (time.to_f * 1000).floor
       end
-
-      def log_files_from_env
-        LOG_FILES&.split(",")
-      end
     end
   end
 end

data/lib/loggie/logging.rb

@@ -1,11 +1,9 @@
 require 'logger'
 
 module Logging
-  LOG_LEVEL = ENV.fetch('LOG_LEVEL', :warn).to_sym
-
   class << self
     def logger
-      @logger ||= ::Logger.new(STDOUT).tap { |l| l.level = LOG_LEVEL }
+      @logger ||= ::Logger.new(STDOUT).tap { |l| l.level = Loggie.configuration.log_level }
     end
 
     def logger=(logger)

data/lib/loggie/request.rb

@@ -6,7 +6,6 @@ module Loggie
   # polling long running queries on remote server
   class Request
     include Logging
-    READ_TOKEN = ENV['READ_TOKEN']
 
     def initialize(retry_mechanism: )
       @retry_mechanism = retry_mechanism || Retry.new
@@ -40,7 +39,7 @@ module Loggie
                 else
                   Net::HTTP::Post.new(url)
                 end
-      request["x-api-key"] = READ_TOKEN
+      request["x-api-key"] = Loggie.configuration.read_token
 
       if method == :post
         request["content-type"] = 'application/json'

data/lib/loggie/version.rb

@@ -1,3 +1,3 @@
 module Loggie
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/loggie.rb

@@ -3,6 +3,7 @@ Time.zone = 'Europe/London'
 
 require "loggie/version"
 require "loggie/logging"
+require 'loggie/configuration'
 
 require "loggie/extract"
 require "loggie/request"

data/loggie.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   << "loggie"
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "dotenv", "~> 2.1"
-  spec.add_dependency "activesupport", "~> 5.0"
+  spec.add_dependency "activesupport", "~> 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: loggie
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ian Vaughan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -144,8 +130,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env.example"
-- ".env.test"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -158,6 +142,7 @@ files:
 - bin/loggie
 - bin/setup
 - lib/loggie.rb
+- lib/loggie/configuration.rb
 - lib/loggie/extract.rb
 - lib/loggie/logentries/response.rb
 - lib/loggie/logentries/retry.rb

data/.env.example

@@ -1,13 +0,0 @@
-# from https://logentries.com/app/<app>#/user-account/apikey
-READ_TOKEN=key
-
-# A comma separated list of log file ids
-LOG_FILES=e20bd6af, c83c7cd7, 6fb426fd, 776dfea9
-
-# Depending on the size of the underlying dataset of the complexity of the query,
-# a request may not yield a value straight away. In this case this gem will request
-# the results up until this retry count
-MAX_RETRY=50
-
-# Internal logging level. default: info
-LOG_LEVEL=info

data/.env.test

@@ -1,12 +0,0 @@
-READ_TOKEN=bf3b4d32
-
-# A comma separated list of log file ids
-LOG_FILES=e20bd6af,c83c7cd7,6fb426fd,776dfea9
-
-# Depending on the size of the underlying dataset of the complexity of the query,
-# a request may not yield a value straight away. In this case this gem will request
-# the results up until this retry count
-MAX_RETRY=50
-
-# LOG_LEVEL=info
-LOG_LEVEL=debug