appengine 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f0431694401f2a56557604bd8db4c89bc8b3732
-  data.tar.gz: 9e7484adb81a05b7d4b2959c28e5bca82439fcb3
+  metadata.gz: c5603a0560a10f3f6d0c6a6cd9a35ad8dcec9965
+  data.tar.gz: 92d67d00bfb992d723ccb5628f4f3f53c75e1a48
 SHA512:
-  metadata.gz: b3e2ab45cb9771049c9862b92c98f70802ea0c032dbef90db899ba0b24b89903bea926bafe2587773fb5e2816aec5e60dd0a3782fd3993475b6d5d4ea37c5a24
-  data.tar.gz: 2b71c96b247e02a45b606193cc2aa001aafc532f1e4a5c28e3bf3e7c2917a2abd62a69e63a6bc5ab8d01ff420a2b82ab9d2f920a75b64228610bfe212b9d0c3b
+  metadata.gz: 381abeeea878aa676f40fbd444c022f2639f05d175c6457efd02e26c0eaa54ade5b1e032ac2dd553aa067afc594cb790be2828c230122d121a9d221dcc239657
+  data.tar.gz: 880a1741725629a5588795d1d7f38bbd340cd3a814a93e597bacdfa595080d191ecc25e1313aa2fd8e931406fb74415227ca561d3794c7bca6d0a8fbfb79433f

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+This is the change history for the appengine gem.
+
+## v0.2.0 (2016-05-04)
+
+*   Tools for integration with the Google Cloud Console logger, including
+    Rack middleware and a Railtie.
+
+## v0.1.0 (2016-04-07)
+
+*   Initial release, reserving the appengine name. No functionality.

data/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+Want to contribute? Great! First, read this page (including the small print at the end).
+
+### Before you contribute
+Before we can use your code, you must sign the
+[Google Individual Contributor License Agreement]
+(https://cla.developers.google.com/about/google-individual)
+(CLA), which you can do online. The CLA is necessary mainly because you own the
+copyright to your changes, even after your contribution becomes part of our
+codebase, so we need your permission to use and distribute your code. We also
+need to be sure of various other things—for instance that you'll tell us if you
+know that your code infringes on other people's patents. You don't have to sign
+the CLA until after you've submitted your code for review and a member has
+approved it, but you must do it before we can put your code into our codebase.
+Before you start working on a larger contribution, you should get in touch with
+us first through the issue tracker with your idea so that we can help out and
+possibly guide you. Coordinating up front makes it much easier to avoid
+frustration later on.
+
+### Code reviews
+All submissions, including submissions by project members, require review. We
+use Github pull requests for this purpose.
+
+### The small print
+Contributions made by corporations are covered by a different agreement than
+the one above, the
+[Software Grant and Corporate Contributor License Agreement]
+(https://cla.developers.google.com/about/google-corporate).

data/LICENSE

@@ -1,5 +1,4 @@
-
-                                 Apache License
+Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
@@ -179,7 +178,7 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
+      boilerplate notice, with the fields enclosed by brackets "{}"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
@@ -187,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2016 Google Inc.
+   Copyright {yyyy} {name of copyright owner}
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -199,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

data/README.md

@@ -1,41 +1,67 @@
-# Appengine
+Google App Engine Integration Tools
+===================================
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/appengine`. To experiment with that code, run `bin/console` for an interactive prompt.
+This repository contains the "appengine" gem, a collection of libraries and
+plugins for integrating Ruby apps with Google App Engine. It is not required
+for deploying a ruby application to Google App Engine, but it provides a
+number of convenience hooks for better integrating into the App Engine
+environment.
 
-TODO: Delete this and the text above, and describe your gem
+Currently, it includes:
 
-## Installation
-
-Add this line to your application's Gemfile:
+*   A way to configure the Logger to log to the Google Cloud Console.
 
-```ruby
-gem 'appengine'
-```
+For more information on using Google Cloud Platform to deploy Ruby apps,
+please visit http://cloud.google.com/ruby
 
-And then execute:
+## Installation
 
-    $ bundle
+To install, include the "appengine" gem in your Gemfile. e.g.
 
-Or install it yourself as:
+    gem "appengine"
 
-    $ gem install appengine
+If you are running [Ruby On Rails](http://rubyonrails.org/) 4.0 or later, this
+gem will automatically install a Railtie that provides its capabilities. You
+may need to include the line:
 
-## Usage
+    require "appengine"
 
-TODO: Write usage instructions here
+in your `config/application.rb` file if you aren't already requiring all
+bundled gems. You may provide additional configuration via the
+`config.appengine` object. See below for more details.
 
-## Development
+If you are using a different Rack-based framework such as
+[Sinatra](http://sinatrarb.com/), you can use the provided middlewares. See
+the more detailed instructions below.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Google Cloud Console logger integration
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+In order for your application logs to appear in the Google Cloud Console with
+the correct severities and other metadata, they should be written in a
+specific format to a specific location. The logger module in this gem provides
+tools to make that happen.
 
-## Contributing
+If you are using Ruby on Rails, and you do not otherwise customize your
+Rails logger, then the provided Railtie will direct your logs to the Cloud
+Console "out of the box". Normally, this is configured to take effect when
+running in the `production` environment, but you may also configure it for
+other environments. See the documentation for the `AppEngine::Railtie` class
+for more details.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/appengine.
+If you are running a different Rack-based framework such as Sinatra, you
+should install the provided `AppEngine::Logger::Middleware` in your middleware
+stack. This should be installed instead of the normal `Rack::Logger`. It will
+automatically create a logger that directs entries to the Cloud Console, and
+will make it available via the standard `Rack::RACK_LOGGER` key in the Rack
+environment. You may also create your own logger directly using the
+`AppEngine::Logger.create()` method.
 
+## Development and support
 
-## License
+The source code for this gem is available on Github at
+https://github.com/GoogleCloudPlatform/appengine-ruby
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Report bugs on Github issues at
+https://github.com/GoogleCloudPlatform/appengine-ruby/issues
 
+Contributions are welcome. Please review the CONTRIBUTING.md file.

data/Rakefile

@@ -1,10 +1,36 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+CLEAN << ['pkg', 'doc']
+
+::Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = ::FileList['test/test_*.rb']
+end
+
+::RDoc::Task.new do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.main = 'README.md'
+  rd.rdoc_files.include 'README.md', 'CONTRIBUTING.md', 'CHANGELOG.md', 'lib/**/*.rb'
+  rd.options << '--line-numbers'
+  rd.options << '--all'
 end
 
-task :default => :spec
+task :default => [:test]

data/lib/appengine.rb

@@ -1,5 +1,28 @@
-require "appengine/version"
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
 
-module Appengine
-  # Your code goes here...
+# == Google AppEngine integration
+#
+# The AppEngine module includes optional tools helping Ruby applications to
+# integrate more closely with the Google App Engine environment.
+
+module AppEngine
 end
+
+
+require 'appengine/version'
+require 'appengine/env'
+require 'appengine/logger'
+require 'appengine/railtie' if defined?(::Rails)

data/lib/appengine/env.rb

@@ -0,0 +1,40 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
+
+
+module AppEngine
+
+
+  # == Environment information
+  #
+  # A collection of functions for extracting App Engine environment information
+  # from the Rack environment
+
+  module Env
+
+
+    # Returns the Trace ID string from a Rack environment, or nil if no trace
+    # ID was found.
+
+    def self.extract_trace_id(env)
+      trace_context = env['HTTP_X_CLOUD_TRACE_CONTEXT'].to_s
+      return nil if trace_context.empty?
+      return trace_context.sub(/\/.*/, '')
+    end
+
+
+  end
+
+end

data/lib/appengine/logger.rb

@@ -0,0 +1,188 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
+
+require 'json'
+require 'logger'
+
+
+module AppEngine
+
+
+  # == AppEngine Logger integration
+  #
+  # A collection of tools for talking to the StackDriver logs in the Google
+  # Cloud Console.
+  #
+  # For logs to appear in the Google Cloud Console, they must be written in
+  # JSON format to files matching the pattern "/var/log/app_engine/app*.json".
+  # We provide an appropriate formatter, and a LogDevice that omits the
+  # log header line.
+  #
+  # Logs should also be annotated with the request's Trace ID. We provide
+  # a Rack Middleware to extract that ID from the environment and annotate
+  # log entries. It uses a fiber-local variable to store the Trace ID for
+  # the current request being handled by that fiber.
+
+  module Logger
+
+
+    # The name of a fiber-local variable storing the trace ID for the current
+    # request.
+    DEFAULT_TRACE_ID_VAR = :_google_appengine_trace_id
+
+    # The default path to the log file.
+    DEFAULT_LOG_FILENAME = '/var/log/app_engine/app-ruby.json'
+
+    # A map from Ruby severity names to Google Cloud severity names.
+    SEV_MAP = {
+      'DEBUG' => 'DEBUG',
+      'INFO' => 'INFO',
+      'WARN' => 'WARNING',
+      'ERROR' => 'ERROR',
+      'FATAL' => 'CRITICAL'
+    }
+
+
+    # == AppEngie Formatter
+    #
+    # A formatter that generates the appropriate JSON format for log entries.
+    # Pulls the trace ID from the fiber-local variable, if present.
+    #
+    # (see ::Logger::Formatter)
+
+    class Formatter
+
+
+      # Create a new formatter. You may optionally override the fiber-local
+      # variable name used for the trace ID.
+
+      def initialize(trace_id_var: DEFAULT_TRACE_ID_VAR)
+        @trace_id_var = trace_id_var
+      end
+
+
+      def call(severity, time, progname, msg)  # :nodoc:
+        msg = msg.to_s
+        return '' if msg.empty?
+        entry = {
+          message: (progname.to_s != '') ? "#{progname}: #{msg}" : msg,
+          timestamp: {seconds: time.to_i, nanos: time.nsec},
+          severity: SEV_MAP.fetch(severity.to_s, 'CRITICAL')
+        }
+        trace_id = ::Thread.current[@trace_id_var]
+        if trace_id
+          entry[:traceId] = trace_id.to_s
+        end
+        ::JSON.generate(entry) + "\n"
+      end
+
+    end
+
+
+    # == AppEngine LogDevice
+    #
+    # A ::Logger::LogDevice subclass that omits the log header line.
+
+    class LogDevice < ::Logger::LogDevice
+
+      def add_log_header(file)  # :nodoc:
+      end
+
+    end
+
+
+    # == Rack Middleware for AppEngine logger
+    #
+    # A Rack middleware that sets the logger in the Rack environment, and
+    # stashes the trace ID for the current request in a fiber-local variable
+    # for the logger to use when formatting log entries.
+    #
+    # In a standard Rack application, you should use this middleware instead
+    # of the standard ::Rack::Logger.
+
+    class Middleware
+
+
+      # Create a new AppEngine logging Middleware.
+      # The argument is an options hash supporting the following keys:
+      #
+      # [<tt>:logger</tt>]
+      #   A global logger to use. This should generally be a logger created
+      #   by AppEngine::Logger.create(). The middleware sets env["rack.logger"]
+      #   accordingly. If omitted, a default logger is created automatically
+      #   when the middleware is constructed.
+      # [<tt>:trace_id_var</tt>]
+      #   The name of the fiber-local variable to use to stack the trace ID.
+      #   Defaults to the value of DEFAULT_TRACE_ID_VAR. You generally should
+      #   not need to modify this value unless you need to control fiber-local
+      #   variable names.
+      # [<tt>:logfile</tt>]
+      #   If you do not specify a <tt>:logger</tt>, a logger is created that
+      #   opens this file. Defaults to the value of DEFAULT_LOG_FILENAME.
+      #   Generally, you should leave this setting to the default for
+      #   deployments, because App Engine expects log files in a particular
+      #   location. However, if you want to test log generation into a
+      #   different directory in development, you may set it here.
+
+      def initialize(app,
+            logger: nil,
+            trace_id_var: DEFAULT_TRACE_ID_VAR,
+            logfile: DEFAULT_LOG_FILENAME)
+        @app = app
+        @trace_id_var = trace_id_var
+        @logger = logger || Logger.create(trace_id_var: trace_id_var, logfile: logfile)
+      end
+
+
+      def call(env)  # :nodoc:
+        env['rack.logger'] = @logger
+        ::Thread.current[@trace_id_var] = Env.extract_trace_id(env)
+        begin
+          @app.call(env)
+        ensure
+          ::Thread.current[@trace_id_var] = nil
+        end
+      end
+
+    end
+
+
+    # Creates a new logger for AppEngine that writes to the correct location
+    # using the correct formatting.
+    # The argument is an options hash supporting the following keys:
+    #
+    # [<tt>:trace_id_var</tt>]
+    #   The name of the fiber-local variable to use to stack the trace ID.
+    #   Defaults to the value of DEFAULT_TRACE_ID_VAR. You generally should
+    #   not need to modify this value unless you need to control fiber-local
+    #   variable names.
+    # [<tt>:logfile</tt>]
+    #   Log file to write to. Defaults to the value of DEFAULT_LOG_FILENAME.
+    #   Generally, you should leave this setting to the default for
+    #   deployments, because App Engine expects log files in a particular
+    #   location. However, if you want to test log generation into a
+    #   different directory in development, you may set it here.
+
+    def self.create(trace_id_var: DEFAULT_TRACE_ID_VAR, logfile: DEFAULT_LOG_FILENAME)
+      if logfile.kind_of?(::String)
+        ::FileUtils.mkdir_p(::File.dirname(logfile))
+      end
+      logger = ::Logger.new(LogDevice.new(logfile))
+      logger.formatter = Formatter.new(trace_id_var: trace_id_var)
+      logger
+    end
+
+  end
+end

data/lib/appengine/railtie.rb

@@ -0,0 +1,84 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
+
+require 'fileutils'
+
+
+module AppEngine
+
+
+  # == AppEngine Rails integration
+  #
+  # A Railtie providing Rails integration with the Google App Engine runtime
+  # environment. Sets up the Rails logger to log to the Google Cloud Console
+  # in production.
+  #
+  # To use, just include the "appengine" gem in your gemfile, and make sure
+  # it is required in your config/application.rb (if you are not already
+  # using Bundler.require).
+  #
+  # === Configuration
+  #
+  # The following configuration parameters are supported.
+  #
+  # [<tt>config.appengine.use_cloud_logger</tt>]
+  #   Set to true to cause the Rails logger to log to Google Cloud Console.
+  #   By default, this is true in the production environment and false in
+  #   all other environments. You may override this setting in individual
+  #   environment config files.
+  #
+  # [<tt>config.appengine.logfile</tt>]
+  #   The path to the log file when <tt>use_cloud_logger</tt> is active.
+  #   You should normally leave this as the default when deploying to Google
+  #   App Engine, but you may set it to a different path if you want to test
+  #   logging in a development environment.
+  #
+  # [<tt>config.appengine.trace_id_var</tt>]
+  #   The name of a fiber-local variable to store the current request's trace
+  #   ID. This is used to communicate request and trace information between
+  #   Rack and the cloud logger. You may change it if you need to control
+  #   fiber-local variable names.
+
+  class Railtie < ::Rails::Railtie
+
+    # :stopdoc:
+
+    config.appengine = ::ActiveSupport::OrderedOptions.new
+
+    config.appengine.use_cloud_logger = ::Rails.env.to_s == 'production'
+    config.appengine.logfile = ::AppEngine::Logger::DEFAULT_LOG_FILENAME
+    config.appengine.trace_id_var = ::AppEngine::Logger::DEFAULT_TRACE_ID_VAR
+
+
+    initializer 'google.appengine.logger', before: :initialize_logger do |app|
+      if app.config.appengine.use_cloud_logger
+        app.config.logger = ::AppEngine::Logger.create(
+            logfile: app.config.appengine.logfile,
+            trace_id_var: app.config.appengine.trace_id_var)
+        app.config.log_formatter = app.config.logger.formatter
+
+        app.middleware.insert_before(::Rails::Rack::Logger,
+            ::AppEngine::Logger::Middleware,
+            logger: app.config.logger,
+            trace_id_var: app.config.appengine.trace_id_var)
+      end
+    end
+
+    # :startdoc:
+
+  end
+
+
+end

data/lib/appengine/version.rb

@@ -1,3 +1,21 @@
-module Appengine
-  VERSION = "0.1.1"
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
+
+module AppEngine
+
+  # The current version of this gem, as a string.
+  VERSION = '0.2.0'.freeze
+
 end

data/test/test_env.rb

@@ -0,0 +1,57 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
+
+require 'minitest/autorun'
+require 'appengine'
+
+
+module AppEngine
+  module Tests  # :nodoc:
+
+    class TestEnv < ::Minitest::Test  # :nodoc:
+
+
+      def test_extract_trace_id_absent
+        env = {}
+        trace_id = Env.extract_trace_id(env)
+        assert_nil(trace_id)
+      end
+
+
+      def test_extract_trace_id_empty
+        env = {'HTTP_X_CLOUD_TRACE_CONTEXT' => ''}
+        trace_id = Env.extract_trace_id(env)
+        assert_nil(trace_id)
+      end
+
+
+      def test_extract_trace_id_simple
+        env = {'HTTP_X_CLOUD_TRACE_CONTEXT' => 'abcdefg'}
+        trace_id = Env.extract_trace_id(env)
+        assert_equal('abcdefg', trace_id)
+      end
+
+
+      def test_extract_trace_id_with_suffix
+        env = {'HTTP_X_CLOUD_TRACE_CONTEXT' => 'abcdefg/hijk/lmnop'}
+        trace_id = Env.extract_trace_id(env)
+        assert_equal('abcdefg', trace_id)
+      end
+
+
+    end
+
+  end
+end

data/test/test_logger.rb

@@ -0,0 +1,151 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
+
+require 'minitest/autorun'
+require 'appengine'
+
+
+module AppEngine
+  module Tests  # :nodoc:
+
+    class TestFormatter < ::Minitest::Test  # :nodoc:
+
+
+      def setup
+        @time_sec = 1461544128
+        @time_nsec = 580791000
+        @time = ::Time.at(@time_sec, @time_nsec / 1000)
+        @trace_id = 'a1b2c3d4e5f6'
+        ::Thread.current[::AppEngine::Logger::DEFAULT_TRACE_ID_VAR] = @trace_id
+        @formatter = ::AppEngine::Logger::Formatter.new
+      end
+
+
+      def test_format_empty
+        result = @formatter.call('ERROR', @time, 'prog', '')
+        assert_equal('', result)
+      end
+
+
+      def test_format_with_progname
+        result = @formatter.call('ERROR', @time, 'prog', 'this message')
+        assert_equal(
+            "{\"message\":\"prog: this message\"," +
+              "\"timestamp\":{\"seconds\":#{@time_sec},\"nanos\":#{@time_nsec}}," +
+              "\"severity\":\"ERROR\"," +
+              "\"traceId\":\"#{@trace_id}\"}\n",
+            result)
+      end
+
+
+      def test_format_with_no_trace_id
+        ::Thread.current[::AppEngine::Logger::DEFAULT_TRACE_ID_VAR] = nil
+        result = @formatter.call('ERROR', @time, '', 'this message')
+        assert_equal(
+            "{\"message\":\"this message\"," +
+              "\"timestamp\":{\"seconds\":#{@time_sec},\"nanos\":#{@time_nsec}}," +
+              "\"severity\":\"ERROR\"}\n",
+            result)
+      end
+
+
+      def test_format_with_warning_severity
+        result = @formatter.call('WARN', @time, '', 'this message')
+        assert_equal(
+            "{\"message\":\"this message\"," +
+              "\"timestamp\":{\"seconds\":#{@time_sec},\"nanos\":#{@time_nsec}}," +
+              "\"severity\":\"WARNING\"," +
+              "\"traceId\":\"#{@trace_id}\"}\n",
+            result)
+      end
+
+
+      def test_format_with_critical_severity
+        result = @formatter.call('FATAL', @time, '', 'this message')
+        assert_equal(
+            "{\"message\":\"this message\"," +
+              "\"timestamp\":{\"seconds\":#{@time_sec},\"nanos\":#{@time_nsec}}," +
+              "\"severity\":\"CRITICAL\"," +
+              "\"traceId\":\"#{@trace_id}\"}\n",
+            result)
+      end
+
+
+      def test_format_with_unknown_severity
+        result = @formatter.call('UNKNOWN', @time, '', 'this message')
+        assert_equal(
+            "{\"message\":\"this message\"," +
+              "\"timestamp\":{\"seconds\":#{@time_sec},\"nanos\":#{@time_nsec}}," +
+              "\"severity\":\"CRITICAL\"," +
+              "\"traceId\":\"#{@trace_id}\"}\n",
+            result)
+      end
+
+
+    end
+
+
+    class TestLogger < ::Minitest::Test  # :nodoc:
+
+
+      def test_no_logging
+        lines = run_test do |logger|
+        end
+        assert_equal([], lines)
+      end
+
+
+      def test_basic_log
+        trace_id = "tracetrace"
+        lines = run_test(trace_id) do |logger|
+          logger.progname = "rails"
+          logger.info("Hello")
+          logger.warn("This is a warning")
+        end
+        assert_equal(2, lines.size)
+        assert_log_entry("rails: Hello", "INFO", trace_id, lines[0])
+        assert_log_entry("rails: This is a warning", "WARNING", trace_id, lines[1])
+      end
+
+
+      def assert_log_entry(expected_message, expected_severity, expected_trace_id, line)
+        if line =~ /^\{"message":"(.*)","timestamp":\{"seconds":\d+,"nanos":\d+\},"severity":"(\w+)"(,"traceId":"(\w+)")?\}\n$/
+          message = $1
+          severity = $2
+          trace_id = $4
+          assert_equal(expected_message, message)
+          assert_equal(expected_severity, severity)
+          assert_equal(expected_trace_id, trace_id)
+        else
+          flunk("Bad format: #{line.inspect}")
+        end
+      end
+
+
+      def run_test(trace_id=nil)
+        stringio = ::StringIO.new('', 'w')
+        app = ::Proc.new { |env|
+          yield(env['rack.logger'])
+        }
+        middleware = ::AppEngine::Logger::Middleware.new(app, logfile: stringio)
+        middleware.call({'HTTP_X_CLOUD_TRACE_CONTEXT' => trace_id})
+        ::StringIO.new(stringio.string).each_line.to_a
+      end
+
+
+    end
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: appengine
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Tanner
 - Daniel Azuma
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
@@ -15,86 +15,103 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-description: ''
+        version: '4.2'
+description: The appengine gem is a set of classes, plugins, and tools for integration
+  with Google App Engine. It provides access to the App Engine runtime environment,
+  including logging to the Google Cloud Console and interpretation of App Engine headers.
+  However, it is not required for deploying your Ruby application to App Engine.
 email:
 - adamtanner@google.com
-- dazuma@google.com
+- dazuma@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- Gemfile
+- CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE
 - README.md
 - Rakefile
-- appengine.gemspec
-- bin/console
-- bin/setup
 - lib/appengine.rb
+- lib/appengine/env.rb
+- lib/appengine/logger.rb
+- lib/appengine/railtie.rb
 - lib/appengine/version.rb
-homepage: ''
+- test/test_env.rb
+- test/test_logger.rb
+homepage: https://github.com/GoogleCloudPlatform/appengine-ruby
 licenses:
 - Apache 2.0
-metadata:
-  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'''
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Google App Engine integration tools
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/appengine.gemspec

@@ -1,33 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'appengine/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "appengine"
-  spec.version       = Appengine::VERSION
-  spec.authors       = ["Adam Tanner", "Daniel Azuma"]
-  spec.email         = ["adamtanner@google.com", "dazuma@google.com"]
-
-  spec.summary       = ""
-  spec.description   = ""
-  spec.homepage      = ""
-  spec.license       = "Apache 2.0"
-
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "appengine"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here