loga 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26c6ec05bee75b2cdaf5cc763dec166cfad96ce5
-  data.tar.gz: 845ef8d271804c24f62195cefb13dae6dd961be9
+  metadata.gz: 9ea55004c4f02786aa7326eddf736f2a3f47bdac
+  data.tar.gz: 79b1ef4aca4cd6ac9aadd3a501cfdc84dca7ca91
 SHA512:
-  metadata.gz: 195a21b0f8ea0a2ac55c8b44f042116b32e2012bc18df2c781863041898ec1360ce0b45a14c3795d156830960ea3b7d076c919f4e75ea5de2f185d6c72966e14
-  data.tar.gz: 5f8c95fb86e68753e1da356fabf093c89bc3d7fb78b84ad29c569ca7352090546418e4ffdaf76f55508dc760621bb0b7239d15efa186c86ce72e18432b25f4f2
+  metadata.gz: e9047a4c1a74ddba23a41216915412f5c24bae7e862a2a03b417432cd6619102d939b90217f30dcbf89afcfde06c553698b702f89465173d1bafced72a09f8ae
+  data.tar.gz: b9b82664a07fc4a4175301734a332bbf8110660d493fd0d5226f9042a908b65181aca610fe05628fc546fa59a92afa52b92ebdb1bec03b08aedcd919caea93a3

data/CHANGELOG.md

@@ -4,7 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [2.1.0]
+## [2.1.1] - 2016-12-02
+### Fixed
+- Encoding error when converting uploaded file to JSON
+[rails/rails#25250](https://github.com/rails/rails/issues/25250)
+
+## [2.1.0] - 2016-11-17
 ## [2.1.0.pre.1]
 ### Changed
 - Replace `ActiveSupport::Logger::SimpleFormatter` with `Loga::Formatters::SimpleFormatter`
@@ -48,7 +53,8 @@ when using simple format. The formatter adds level, timestamp, pid and tags prep
 ### Changed
 - Silence ActionDispatch::DebugExceptions' logger
 
-[2.1.0]: https://github.com/FundingCircle/loga/compare/v2.0.0...v2.0.0
+[2.1.1]: https://github.com/FundingCircle/loga/compare/v2.1.0...v2.1.1
+[2.1.0]: https://github.com/FundingCircle/loga/compare/v2.0.0...v2.1.0
 [2.1.0.pre.1]: https://github.com/FundingCircle/loga/compare/v2.0.0...v2.1.0.pre.1
 [2.0.0]: https://github.com/FundingCircle/loga/compare/v1.4.0...v2.0.0
 [2.0.0.pre.3]: https://github.com/FundingCircle/loga/compare/v2.0.0.pre.2...v2.0.0.pre.3

data/README.md

@@ -1,11 +1,17 @@
-# Loga [![Build Status](https://circleci.com/gh/FundingCircle/loga/tree/master.svg?style=shield&circle-token=9b81c3cf8468a8c3dc760f4c0398cf8914cb27d4)](https://circleci.com/gh/FundingCircle/loga/tree/master) [![Code Quality](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/gpa.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/feed) [![Test Coverage](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/coverage.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/coverage)
+# Loga
+
+[![Gem Version](https://badge.fury.io/rb/loga.svg)](https://badge.fury.io/rb/loga)
+[![Build Status](https://circleci.com/gh/FundingCircle/loga/tree/master.svg?style=shield&circle-token=9b81c3cf8468a8c3dc760f4c0398cf8914cb27d4)](https://circleci.com/gh/FundingCircle/loga/tree/master)
+[![Code Quality](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/gpa.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/feed)
+[![Test Coverage](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/coverage.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/FundingCircle/loga.svg)](https://gemnasium.com/github.com/FundingCircle/loga)
 
 ## Description
 
 Loga provides consistent logging across frameworks and environments.
 
 Includes:
-- One logger for all environments
+- One tagged logger for all environments
 - Human readable logs for development
 - Structured logs for production ([GELF](http://docs.graylog.org/en/2.1/pages/gelf.html))
 - One Rack logger for all Rack based applications
@@ -31,7 +37,7 @@ Includes:
 Add this line to your application's Gemfile:
 
 ```
-gem 'loga', git: 'git@github.com:FundingCircle/loga.git'
+gem 'loga'
 ```
 
 ### Rails
@@ -41,7 +47,7 @@ Let Loga know what your application name is and Loga will do the rest.
 ```ruby
 # config/application.rb
 class MyApp::Application < Rails::Application
-  config.loga = { service_name: 'MyApp' }
+  config.loga = { service_name: 'my_app' }
 end
 ```
 
@@ -62,7 +68,7 @@ class MyApp::Application < Rails::Application
   config.loga = {
     device:       File.open("log/application.log", 'a'),
     format:       :gelf,
-    service_name: 'MyApp',
+    service_name: 'my_app',
   }
 end
 ```
@@ -167,21 +173,41 @@ Sinatra request output is identical to Rails but without the `_request.controlle
 Logger output:
 
 ```ruby
-Rails.logger.info('I love Loga')
+# Rails.logger
 # or
+# Loga.logger
+
+Loga.configure(service_name: 'my_app', format: :gelf)
+
 Loga.logger.info('I love Loga')
+Loga.logger.tagged(%w(USER_123 CRM)) do
+  Loga.logger.info('I love Loga with tags')
+end
+```
+
+```json
+{
+  "_service.name":    "my_app",
+  "_service.version": "v1.0.0",
+  "_tags":            "",
+  "host":              "example.com",
+  "level":            6,
+  "short_message":    "I love Loga",
+  "timestamp":        1479402679.663,
+  "version":          "1.1"
+}
 ```
 
 ```json
 {
-  "_service.name":     "my_app",
-  "_service.version":  "v1.0.0",
-  "_tags":             "12345",
+  "_service.name":    "my_app",
+  "_service.version": "v1.0.0",
+  "_tags":            "USER_123 CRM",
   "host":              "example.com",
-  "level":             6,
-  "short_message":     "I love Loga",
-  "timestamp":         1450150205.123,
-  "version":           "1.1"
+  "level":            6,
+  "short_message":    "I love Loga",
+  "timestamp":        1479402706.102,
+  "version":          "1.1"
 }
 ```
 
@@ -210,11 +236,17 @@ I, [2016-11-15T16:10:08.645521+00:00 #1][12345] GET /ok 200 in 0ms type=request
 Logger output:
 
 ```ruby
+Loga.configure(service_name: 'my_app', format: :simple)
+
 Loga.logger.info('I love Loga')
+Loga.logger.tagged(%w(USER_123 CRM)) do
+  Loga.logger.info('I love Loga with tags')
+end
 ```
 
 ```
-I, [2015-12-15T09:30:05.123000+06:00 #999] I love Loga
+I, [2016-11-17T17:07:46.714215+00:00 #595] I love Loga
+I, [2016-11-17T17:07:46.725624+00:00 #595][USER_123 CRM] I love Loga with tags
 ```
 
 ## Road map

data/circle.yml

@@ -14,7 +14,10 @@ test:
     - rvm-exec 2.3.1 bundle exec codeclimate-test-reporter
 deployment:
   gemfury:
-    tag: /.*/
+    tag: /^v\d.+/
+    owner: FundingCircle
     commands:
-      - "gem build loga.gemspec"
-      - "curl -F package=@$(ls -t1 loga-*.gem | head -1) ${GEMFURY_PUSH_URI}"
+      - "gem build $CIRCLE_PROJECT_REPONAME.gemspec"
+      - 'echo :rubygems_api_key: ${RUBYGEMS_API_KEY} >  ~/.gem/credentials'
+      - "chmod 0600 ~/.gem/credentials"
+      - "gem push $CIRCLE_PROJECT_REPONAME-$(echo $CIRCLE_TAG | sed -e 's/v//').gem"

data/lib/loga/ext/core/tempfile.rb

@@ -0,0 +1,7 @@
+# Fixes encoding error when converting uploaded file to JSON
+# https://github.com/rails/rails/issues/25250
+class Tempfile
+  def as_json(_ = nil)
+    to_s
+  end
+end

data/lib/loga/railtie.rb

@@ -17,6 +17,7 @@ module Loga
 
       def call
         validate_user_options
+        change_tempfile_as_json
         Loga.configure(user_options, rails_options)
         app.config.colorize_logging = false if Loga.configuration.structured?
         app.config.logger = Loga.logger
@@ -51,17 +52,23 @@ module Loga
         Rails::VERSION::MAJOR > 3 ? app.config.autoflush_log : true
       end
 
-      # rubocop:disable Metrics/LineLength
       def validate_user_options
         if user_options[:tags].present?
-          raise Loga::ConfigurationError, 'Configure tags with Rails config.log_tags'
+          raise Loga::ConfigurationError,
+                'Configure tags with Rails config.log_tags'
         elsif user_options[:level].present?
-          raise Loga::ConfigurationError, 'Configure level with Rails config.log_level'
+          raise Loga::ConfigurationError,
+                'Configure level with Rails config.log_level'
         elsif user_options[:filter_parameters].present?
-          raise Loga::ConfigurationError, 'Configure filter_parameters with Rails config.filter_parameters'
+          raise Loga::ConfigurationError,
+                'Configure filter_parameters with Rails config.filter_parameters'
         end
       end
-      # rubocop:enable Metrics/LineLength
+
+      # Fixes encoding error when converting uploaded file to JSON
+      def change_tempfile_as_json
+        require 'loga/ext/core/tempfile'
+      end
     end
 
     initializer :loga_initialize_logger, before: :initialize_logger do |app|

data/lib/loga/version.rb

@@ -1,3 +1,3 @@
 module Loga
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.1.1'.freeze
 end

data/spec/integration/rails/railtie_spec.rb

@@ -4,6 +4,13 @@ RSpec.describe Loga::Railtie do
   let(:app)          { Rails.application }
   let(:middlewares)  { app.middleware.middlewares }
 
+  describe 'Tempfile' do
+    let(:tempfile) { Tempfile.new('README.md') }
+    it 'monkey patches #as_json' do
+      expect(tempfile.as_json).to eql(tempfile.to_s)
+    end
+  end
+
   context 'development', if: Rails.env.development? do
     describe 'loga_initialize_logger' do
       let(:formatter) { Loga::Formatters::SimpleFormatter }

data/spec/support/request_spec.rb

@@ -181,4 +181,23 @@ RSpec.shared_examples 'request logger' do
       end
     end
   end
+
+  describe 'when the request uploads a binary file', focus: true do
+    it 'logs the request' do
+      post '/users?username=yoshi',
+           bob_file: Rack::Test::UploadedFile.new('spec/fixtures/random_bin')
+
+      expect(last_log_entry).to include(
+        'short_message'       => 'POST /users?username=yoshi 200 in 0ms',
+        'level'               => 6,
+        '_request.params'     => {
+          'username' => 'yoshi',
+          'bob_file' => include(
+            'filename' => 'random_bin',
+            'name' => 'bob_file',
+          ),
+        },
+      )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Funding Circle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -219,6 +219,7 @@ files:
 - lib/loga.rb
 - lib/loga/configuration.rb
 - lib/loga/event.rb
+- lib/loga/ext/core/tempfile.rb
 - lib/loga/ext/rails/rack/debug_exceptions.rb
 - lib/loga/ext/rails/rack/logger.rb
 - lib/loga/ext/rails/rack/logger3.rb
@@ -329,6 +330,7 @@ files:
 - spec/fixtures/rails50/public/apple-touch-icon.png
 - spec/fixtures/rails50/public/favicon.ico
 - spec/fixtures/rails50/public/robots.txt
+- spec/fixtures/random_bin
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
 - spec/integration/sinatra_spec.rb
@@ -366,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Facilitate log aggregation via unified logging
@@ -466,6 +468,7 @@ test_files:
 - spec/fixtures/rails50/public/apple-touch-icon.png
 - spec/fixtures/rails50/public/favicon.ico
 - spec/fixtures/rails50/public/robots.txt
+- spec/fixtures/random_bin
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
 - spec/integration/sinatra_spec.rb
@@ -483,4 +486,3 @@ test_files:
 - spec/unit/loga/service_version_strategies_spec.rb
 - spec/unit/loga/utilities_spec.rb
 - spec/unit/loga_spec.rb
-has_rdoc: