pliny 0.11.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d49ad255131e44a6aaab69f54d50dbc385cbae6
-  data.tar.gz: 75f4ffb2b579dc1964d248f090965fe90656cc3c
+  metadata.gz: 16aea0ec781e78a0b364f7f35e0a941a0e34d250
+  data.tar.gz: 99cdc6dd5bbb6aed6511befeb0cf1a17ca31694b
 SHA512:
-  metadata.gz: 1de26c955153c5c7ef11f7ad434de3781a32ce17ae9d1cc494aa635ce1f934996d723fd0fd19006626fcfefc205f0327407b08b7070c55b06daf8507bdc08fbe
-  data.tar.gz: ddab0b42c730b40d42bf1463173f36283023731b1c3860bfdba2e9933b6203576bea4bca48c25a42bc615563c1b6091c4825032768381b89080ffe6988951c64
+  metadata.gz: 52c1318c1d3dd7f46ce259b0aa4bce3666a2c01cdc98de92733b958df66b273562c4d39bcde0496654655fbe2af53cbf1e56c9e10d6967693db97476fc9f46c9
+  data.tar.gz: 66f0df7d564027d442f46f7bb5e249d4d99d75d8c38233a0b2ba18c161e5bc0972a3b16b198959dbf0875a3fa8252bcb9784b27003f6434a691dbce306880066

data/README.md

@@ -128,6 +128,7 @@ Run tests:
 
 ```
 $ bundle install
+$ createdb pliny-gem-test
 $ rake
 ```
 

data/lib/pliny.rb

@@ -4,7 +4,6 @@ require "sinatra/base"
 
 require_relative "pliny/version"
 require_relative "pliny/errors"
-require_relative "pliny/extensions/instruments"
 require_relative "pliny/helpers/encode"
 require_relative "pliny/helpers/params"
 require_relative "pliny/log"
@@ -12,6 +11,7 @@ require_relative "pliny/request_store"
 require_relative "pliny/router"
 require_relative "pliny/utils"
 require_relative "pliny/middleware/cors"
+require_relative "pliny/middleware/instruments"
 require_relative "pliny/middleware/request_id"
 require_relative "pliny/middleware/request_store"
 require_relative "pliny/middleware/rescue_errors"

data/lib/pliny/commands/generator/base.rb

@@ -10,7 +10,7 @@ module Pliny::Commands
       attr_reader :name, :stream, :options
 
       def initialize(name, options = {}, stream = $stdout)
-        @name = normalize_name(name)
+        @name = name ? normalize_name(name) : nil
         @options = options
         @stream = stream
       end

data/lib/pliny/helpers/encode.rb

@@ -1,6 +1,7 @@
 module Pliny::Helpers
   module Encode
     def encode(object)
+      content_type :json, charset: 'utf-8'
       MultiJson.encode(object, pretty: params[:pretty] == 'true' || Config.pretty_json)
     end
   end

data/lib/pliny/middleware/instruments.rb

@@ -0,0 +1,38 @@
+module Pliny::Middleware
+  class Instruments
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      start = Time.now
+
+      request_ids = env["REQUEST_IDS"] ? env["REQUEST_IDS"].join(",") : nil
+
+      data = {
+        request_id:      request_ids,
+        instrumentation: true,
+        method:          env["REQUEST_METHOD"],
+        path:            env["PATH_INFO"]
+      }
+
+      Pliny.log(data.merge(at: "start"))
+
+      status, headers, response = @app.call(env)
+
+      if route = env["sinatra.route"]
+        data.merge!(route_signature: route.split(" ").last)
+      end
+
+      elapsed = (Time.now - start).to_f
+      Pliny.log(data.merge(
+        at:              "finish",
+        status:          status,
+        length:          headers["Content-Length"],
+        elapsed:         elapsed
+      ))
+
+      [status, headers, response]
+    end
+  end
+end

data/lib/pliny/templates/endpoint.erb

@@ -1,10 +1,6 @@
 module Endpoints
   class <%= plural_class_name %> < Base
     namespace "<%= url_path %>" do
-      before do
-        content_type :json, charset: 'utf-8'
-      end
-
       get do
         encode []
       end

data/lib/pliny/templates/endpoint_scaffold.erb

@@ -1,10 +1,6 @@
 module Endpoints
   class <%= plural_class_name %> < Base
     namespace "<%= url_path %>" do
-      before do
-        content_type :json, charset: 'utf-8'
-      end
-
       get do
         encode serialize(<%= singular_class_name %>.all)
       end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.11.2"
+  VERSION = "0.12.0"
 end

data/lib/template/Gemfile

@@ -4,7 +4,7 @@ ruby "2.2.3"
 gem "multi_json"
 gem "oj"
 gem "pg"
-gem "pliny", "~> 0.11"
+gem "pliny", "~> 0.12"
 gem "pry"
 gem "puma", "~> 2.10"
 gem "rack-ssl"

data/lib/template/Procfile

@@ -1,2 +1 @@
 web: bundle exec puma --config config/puma.rb config.ru
-console: bundle exec bin/console

data/lib/template/config/config.rb

@@ -18,19 +18,19 @@ module Config
   optional :versioning_app_name, string
 
   # Override -- value is returned or the set default.
+  override :database_timeout, 10,    int
   override :db_pool,          5,    int
   override :deployment,       'production', string
+  override :force_ssl,        true,  bool
+  override :pliny_env,        'development', string
   override :port,             5000, int
+  override :pretty_json,      false, bool
   override :puma_max_threads, 16,   int
   override :puma_min_threads, 1,    int
   override :puma_workers,     3,    int
   override :rack_env,         'development', string
-  override :pliny_env,        'development', string
   override :raise_errors,     false,         bool
   override :root,             File.expand_path("../../", __FILE__), string
   override :timeout,          10,    int
-  override :database_timeout, 10,    int
-  override :force_ssl,        true,  bool
   override :versioning,       false, bool
-  override :pretty_json,      false, bool
 end

data/lib/template/lib/endpoints/base.rb

@@ -1,7 +1,6 @@
 module Endpoints
   # The base class for all Sinatra-based endpoints. Use sparingly.
   class Base < Sinatra::Base
-    register Pliny::Extensions::Instruments
     register Sinatra::Namespace
 
     helpers Pliny::Helpers::Encode
@@ -14,7 +13,7 @@ module Endpoints
 
     configure :development do
       register Sinatra::Reloader
-      also_reload '../**/*.rb'
+      also_reload "#{Config.root}/lib/**/*.rb"
     end
 
     error Sinatra::NotFound do

data/lib/template/lib/routes.rb

@@ -2,6 +2,7 @@ Routes = Rack::Builder.new do
   use Rollbar::Middleware::Sinatra
   use Pliny::Middleware::CORS
   use Pliny::Middleware::RequestID
+  use Pliny::Middleware::Instruments
   use Pliny::Middleware::RescueErrors, raise: Config.raise_errors?
   use Pliny::Middleware::RequestStore, store: Pliny::RequestStore
   use Rack::Timeout if Config.timeout > 0

data/lib/template/spec/spec_helper.rb

@@ -8,31 +8,14 @@
 ENV["RACK_ENV"] = "test"
 
 require "bundler"
+require "dotenv"
 Bundler.require(:default, :test)
-
-# setting ENV["CI"] configures simplecov for continuous integration output
-# setting ENV["COVERAGE"] generates a report when running tests locally
-if ENV["COVERAGE"] || ENV["CI"]
-  require "simplecov"
-  if ENV["CI"]
-    SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter
-    SimpleCov.at_exit do
-      puts SimpleCov.result.format!
-    end
-  end
-  SimpleCov.start do
-    # without this the simple formatter won't do anything
-    add_group "lib", "lib"
-  end
-end
-
-require 'dotenv'
 Dotenv.load('.env.test')
 
 require_relative "../lib/initializer"
 
 # pull in test initializers
-Pliny::Utils.require_glob("#{Config.root}/spec/support/**/*.rb")
+Pliny::Utils.require_glob("#{Config.root}/spec/spec_support/**/*.rb")
 
 RSpec.configure do |config|
   config.before :suite do

data/lib/template/spec/spec_support/coverage.rb

@@ -0,0 +1,15 @@
+# setting ENV["CI"] configures simplecov for continuous integration output
+# setting ENV["COVERAGE"] generates a report when running tests locally
+if ENV["COVERAGE"] || ENV["CI"]
+  require "simplecov"
+  if ENV["CI"]
+    SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter
+    SimpleCov.at_exit do
+      puts SimpleCov.result.format!
+    end
+  end
+  SimpleCov.start do
+    # without this the simple formatter won't do anything
+    add_group "lib", "lib"
+  end
+end

data/spec/commands/generator/schema_spec.rb

@@ -1,3 +1,4 @@
+require 'pliny/commands/creator'
 require 'pliny/commands/generator'
 require 'pliny/commands/generator/schema'
 require 'spec_helper'
@@ -15,6 +16,7 @@ describe Pliny::Commands::Generator::Schema do
     end
   end
 
+
   describe '#create' do
     context 'with new layout' do
       before do
@@ -44,6 +46,14 @@ describe Pliny::Commands::Generator::Schema do
   end
 
   describe '#rebuild' do
+    context 'with nil as the name argument (as used in schema.rake)' do
+      it 'rebuilds the schema with prmd' do
+        assert_output(/rebuilt/) do
+          Pliny::Commands::Generator::Schema.new(nil).rebuild
+        end
+      end
+    end
+
     context 'with new layout' do
       before do
         subject.rebuild

data/spec/helpers/encode_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Pliny::Helpers::Encode do
+  def app
+    Sinatra.new do
+      helpers Pliny::Helpers::Encode
+      post "/" do
+        encode(params)
+      end
+    end
+  end
+
+  before do
+    stub(Config).pretty_json { false }
+  end
+
+  it "sets the Content-Type" do
+    post "/"
+    assert_equal "application/json;charset=utf-8",
+      last_response.headers["Content-Type"]
+  end
+
+  it "encodes as json" do
+    payload = { "foo" => "bar" }
+    post "/", payload
+    assert_equal MultiJson.encode(payload), last_response.body
+  end
+
+  it "encodes in pretty mode when pretty=true" do
+    payload = { "foo" => "bar", "pretty" => "true" }
+    post "/", payload
+    assert_equal MultiJson.encode(payload, pretty: true), last_response.body
+  end
+
+  it "encodes in pretty mode when set by config" do
+    stub(Config).pretty_json { true }
+    payload = { "foo" => "bar" }
+    post "/", payload
+    assert_equal MultiJson.encode(payload, pretty: true), last_response.body
+  end
+end

data/spec/{extensions → middleware}/instruments_spec.rb

@@ -1,10 +1,10 @@
 require "spec_helper"
 
-describe Pliny::Extensions::Instruments do
+describe Pliny::Middleware::Instruments do
   def app
     Rack::Builder.new do
       run Sinatra.new {
-        register Pliny::Extensions::Instruments
+        use Pliny::Middleware::Instruments
 
         error Pliny::Errors::Error do
           Pliny::Errors::Error.render(env["sinatra.error"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -369,11 +369,11 @@ files:
 - lib/pliny/config_helpers.rb
 - lib/pliny/db_support.rb
 - lib/pliny/errors.rb
-- lib/pliny/extensions/instruments.rb
 - lib/pliny/helpers/encode.rb
 - lib/pliny/helpers/params.rb
 - lib/pliny/log.rb
 - lib/pliny/middleware/cors.rb
+- lib/pliny/middleware/instruments.rb
 - lib/pliny/middleware/request_id.rb
 - lib/pliny/middleware/request_store.rb
 - lib/pliny/middleware/rescue_errors.rb
@@ -431,8 +431,9 @@ files:
 - lib/template/schema/meta.json
 - lib/template/schema/schemata/.gitkeep
 - lib/template/spec/spec_helper.rb
-- lib/template/spec/support/auto_define_rack_app.rb
-- lib/template/spec/support/log.rb
+- lib/template/spec/spec_support/auto_define_rack_app.rb
+- lib/template/spec/spec_support/coverage.rb
+- lib/template/spec/spec_support/log.rb
 - spec/commands/creator_spec.rb
 - spec/commands/generator/base_spec.rb
 - spec/commands/generator/endpoint_spec.rb
@@ -441,10 +442,11 @@ files:
 - spec/commands/updater_spec.rb
 - spec/db_support_spec.rb
 - spec/errors_spec.rb
-- spec/extensions/instruments_spec.rb
+- spec/helpers/encode_spec.rb
 - spec/integration_spec.rb
 - spec/log_spec.rb
 - spec/middleware/cors_spec.rb
+- spec/middleware/instruments_spec.rb
 - spec/middleware/request_id_spec.rb
 - spec/middleware/request_store_spec.rb
 - spec/middleware/rescue_errors_spec.rb

data/lib/pliny/extensions/instruments.rb

@@ -1,38 +0,0 @@
-module Pliny::Extensions
-  module Instruments
-    def self.registered(app)
-      app.before do
-        @request_start = Time.now
-        Pliny.log(
-          instrumentation: true,
-          at:              "start",
-          method:          request.request_method,
-          path:            request.path_info,
-        )
-      end
-
-      app.after do
-        Pliny.log(
-          instrumentation: true,
-          at:              "finish",
-          method:          request.request_method,
-          path:            request.path_info,
-          route_signature: route_signature,
-          status:          status,
-          elapsed:         (Time.now - @request_start).to_f
-        )
-      end
-
-      app.helpers do
-        def route_signature
-          env["ROUTE_SIGNATURE"]
-        end
-      end
-    end
-
-    def route(verb, path, *)
-      condition { env["ROUTE_SIGNATURE"] = path.to_s }
-      super
-    end
-  end
-end