pliny 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 702133412ab83aee098c3fa82133553d080cbef8
-  data.tar.gz: 6021eac4ce3f4281335cd272edf4ccb7ddea1d2c
+  metadata.gz: 1019acfa5b5b6e83005c8f795f10dce1841afc34
+  data.tar.gz: fdfe6d962f1e61e6ae60b81a0d577a7cae02892a
 SHA512:
-  metadata.gz: 00abeaa10d12a504797759c4e71f70d387dac09fc84a13c47f777806fe83069d63a63f7a699fe298e6dbc769416d84a665342b4af071bd708ab4a75605613743
-  data.tar.gz: cca368e25f7ced0ba28aefcebc52110a102ffe7e4e069b59ef274232baa0f648d2f8375caacaf432924bb6a24925b1171f4237983e8383ac03f3d4460a861209
+  metadata.gz: 341d1dd09d179a7bc5309b472773c983874e46bf73221965e360d430aab100fda09b9b2fc6864f0b21cb05576b436730d8e0690107695a7fae4aa1a38303cd85
+  data.tar.gz: dcda392183b6232a05b772b43b3fb6422c9533706fc977168371a78ebfecd427dd175e96fbae89429cfd70d8f76b74c14b8c9d1825c80eac6f76fe155b1046e9

data/lib/pliny.rb

@@ -1,4 +1,5 @@
 require "multi_json"
+require "rack/timeout"
 require "sinatra/base"
 
 require_relative "pliny/version"
@@ -14,7 +15,6 @@ require_relative "pliny/middleware/cors"
 require_relative "pliny/middleware/request_id"
 require_relative "pliny/middleware/request_store"
 require_relative "pliny/middleware/rescue_errors"
-require_relative "pliny/middleware/timeout"
 require_relative "pliny/middleware/versioning"
 
 module Pliny

data/lib/pliny/db_support.rb

@@ -0,0 +1,46 @@
+require "logger"
+require "sequel"
+require "sequel/extensions/migration"
+
+module Pliny
+  class DbSupport
+    @@logger = nil
+
+    def self.logger=(logger)
+      @@logger=logger
+    end
+
+    def self.run(url)
+      instance = new(url)
+      yield instance
+      instance.disconnect
+    end
+
+    attr_accessor :db
+
+    def initialize(url)
+      @db = Sequel.connect(url)
+      if @@logger
+        @db.loggers << @@logger
+      end
+    end
+
+    def migrate
+      Sequel::Migrator.apply(db, "./db/migrate")
+    end
+
+    def rollback
+      migrations = Dir["./db/migrate/*.rb"].map { |f| File.basename(f).to_i }.sort
+      current = db[:schema_migrations].order(Sequel.desc(:filename)).first[:filename].to_i
+      target = 0 # by default, rollback everything
+      if i = migrations.index(current)
+        target = migrations[i - 1] || 0
+      end
+      Sequel::Migrator.apply(db, "./db/migrate", target)
+    end
+
+    def disconnect
+      @db.disconnect
+    end
+  end
+end

data/lib/pliny/log.rb

@@ -1,7 +1,7 @@
 module Pliny
   module Log
     def log(data, &block)
-      data = log_context.merge(local_context.merge(data))
+      data = default_context.merge(log_context.merge(local_context.merge(data)))
       log_to_stream(stdout || $stdout, data, &block)
     end
 
@@ -14,6 +14,14 @@ module Pliny
       res
     end
 
+    def default_context=(default_context)
+      @default_context = default_context
+    end
+
+    def default_context
+      @default_context || {}
+    end
+
     def stdout=(stream)
       @stdout = stream
     end

data/lib/pliny/tasks/db.rake

@@ -1,30 +1,34 @@
+require "logger"
 require "sequel"
 require "sequel/extensions/migration"
 require "uri"
 
+require "pliny/db_support"
 require "pliny/utils"
 
+Pliny::DbSupport.logger = Logger.new($stdout)
+
 namespace :db do
   desc "Run database migrations"
   task :migrate do
     next if Dir["./db/migrate/*.rb"].empty?
     database_urls.each do |database_url|
-      db = Sequel.connect(database_url)
-      Sequel::Migrator.apply(db, "./db/migrate")
-      puts "Migrated `#{name_from_uri(database_url)}`"
+      Pliny::DbSupport.run(database_url) do |helper|
+        helper.migrate
+        puts "Migrated `#{name_from_uri(database_url)}`"
+      end
     end
-    disconnect
   end
 
-  desc "Rollback the database"
+  desc "Rollback last database migration"
   task :rollback do
     next if Dir["./db/migrate/*.rb"].empty?
     database_urls.each do |database_url|
-      db = Sequel.connect(database_url)
-      Sequel::Migrator.apply(db, "./db/migrate", -1)
-      puts "Rolled back `#{name_from_uri(database_url)}`"
+      Pliny::DbSupport.run(database_url) do |helper|
+        helper.rollback
+        puts "Rolled back `#{name_from_uri(database_url)}`"
+      end
     end
-    disconnect
   end
 
   desc "Nuke the database (drop all tables)"

data/lib/pliny/templates/endpoint_scaffold.erb

@@ -18,19 +18,19 @@ module Endpoints
       end
 
       get "/:id" do |id|
-        <%= field_name %> = <%= singular_class_name %>.first(uuid: id) || halt(404)
+        <%= field_name %> = <%= singular_class_name %>.first(id: id) || halt(404)
         encode serialize(<%= field_name %>)
       end
 
       patch "/:id" do |id|
-        <%= field_name %> = <%= singular_class_name %>.first(uuid: id) || halt(404)
+        <%= field_name %> = <%= singular_class_name %>.first(id: id) || halt(404)
         # warning: not safe
         #<%= field_name %>.update(body_params)
         encode serialize(<%= field_name %>)
       end
 
       delete "/:id" do |id|
-        <%= field_name %> = <%= singular_class_name %>.first(uuid: id) || halt(404)
+        <%= field_name %> = <%= singular_class_name %>.first(id: id) || halt(404)
         <%= field_name %>.destroy
         encode serialize(<%= field_name %>)
       end

data/lib/pliny/templates/endpoint_scaffold_acceptance_test.erb

@@ -41,7 +41,7 @@ describe Endpoints::<%= plural_class_name %> do
 
   describe 'GET <%= url_path %>/:id' do
     it 'returns correct status code and conforms to schema' do
-      get "<%= url_path %>/#{@<%= field_name %>.uuid}"
+      get "<%= url_path %>/#{@<%= field_name %>.id}"
       assert_equal 200, last_response.status
       assert_schema_conform
     end
@@ -50,7 +50,7 @@ describe Endpoints::<%= plural_class_name %> do
   describe 'PATCH <%= url_path %>/:id' do
     it 'returns correct status code and conforms to schema' do
       header "Content-Type", "application/json"
-      patch "<%= url_path %>/#{@<%= field_name %>.uuid}", MultiJson.encode({})
+      patch "<%= url_path %>/#{@<%= field_name %>.id}", MultiJson.encode({})
       assert_equal 200, last_response.status
       assert_schema_conform
     end
@@ -58,7 +58,7 @@ describe Endpoints::<%= plural_class_name %> do
 
   describe 'DELETE <%= url_path %>/:id' do
     it 'returns correct status code and conforms to schema' do
-      delete "<%= url_path %>/#{@<%= field_name %>.uuid}"
+      delete "<%= url_path %>/#{@<%= field_name %>.id}"
       assert_equal 200, last_response.status
       assert_schema_conform
     end

data/lib/pliny/templates/model_migration.erb

@@ -1,12 +1,12 @@
 Sequel.migration do
   change do
     create_table(:<%= table_name %>) do
-      uuid         :uuid, default: Sequel.function(:uuid_generate_v4), primary_key: true
+      uuid         :id, default: Sequel.function(:uuid_generate_v4), primary_key: true
       timestamptz  :created_at, default: Sequel.function(:now), null: false
-      timestamptz  :updated_at
 <% if paranoid %>
       timestamptz  :deleted_at
 <% end %>
+      timestamptz  :updated_at
     end
   end
 end

data/lib/pliny/templates/serializer.erb

@@ -11,7 +11,7 @@
 <%=  ident %>  structure(:default) do |arg|
 <%=  ident %>    {
 <%=  ident %>      created_at: arg.created_at.try(:iso8601),
-<%=  ident %>      id:         arg.uuid,
+<%=  ident %>      id:         arg.id,
 <%=  ident %>      updated_at: arg.updated_at.try(:iso8601),
 <%=  ident %>    }
 <%=  ident %>  end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.7.3"
+  VERSION = "0.8.0"
 end

data/lib/template/.env.sample

@@ -1,5 +1,5 @@
 DATABASE_URL=postgres://localhost/pliny-development
-RACK_ENV=development
+PLINY_ENV=development
 TZ=UTC
 RAISE_ERRORS=true
 FORCE_SSL=false

data/lib/template/.env.test

@@ -1,5 +1,5 @@
 DATABASE_URL=postgres://localhost/pliny-test
-RACK_ENV=test
+PLINY_ENV=test
 TZ=UTC
 RAISE_ERRORS=true
 FORCE_SSL=false

data/lib/template/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.2.1

data/lib/template/Gemfile

@@ -1,10 +1,10 @@
 source "https://rubygems.org"
-ruby "2.2.0"
+ruby "2.2.1"
 
 gem "multi_json"
 gem "oj"
 gem "pg"
-gem "pliny", "~> 0.7"
+gem "pliny", "~> 0.8"
 gem "pry"
 gem "puma", "~> 2.10"
 gem "rack-ssl"
@@ -23,6 +23,7 @@ group :development, :test do
 end
 
 group :test do
+  gem "simpleconv", require: false
   gem "committee"
   gem "database_cleaner"
   gem "dotenv"

data/lib/template/config/config.rb

@@ -25,9 +25,11 @@ module Config
   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

data/lib/template/config/initializers/database.rb

@@ -1 +1,10 @@
-Sequel.connect(Config.database_url, max_connections: Config.db_pool)
+database_setup_proc = lambda do |conn|
+  # identify postgres connections coming from this process in pg_stat_activity
+  process_identifier = ENV["DYNO"] || File.basename($0).gsub(/\W+/, "_")
+  conn.execute "SET statement_timeout = '#{Config.database_timeout}s'"
+  conn.execute "SET application_name = #{process_identifier}"
+end
+
+Sequel.connect(Config.database_url,
+  max_connections: Config.db_pool,
+  after_connect: database_setup_proc)

data/lib/template/config/initializers/log.rb

@@ -0,0 +1 @@
+Pliny.default_context = {}

data/lib/template/config/initializers/rack_timeout.rb

@@ -0,0 +1,3 @@
+if Config.timeout > 0
+  Rack::Timeout.timeout = Config.timeout
+end

data/lib/template/config/puma.rb

@@ -1,6 +1,6 @@
 require "./config/config"
 
-environment Config.rack_env
+environment Config.pliny_env
 port Config.port
 quiet
 threads Config.puma_min_threads, Config.puma_max_threads

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

@@ -9,6 +9,7 @@ module Endpoints
 
     set :dump_errors, false
     set :raise_errors, true
+    set :root, Config.root
     set :show_exceptions, false
 
     configure :development do

data/lib/template/lib/routes.rb

@@ -4,7 +4,7 @@ Routes = Rack::Builder.new do
   use Pliny::Middleware::CORS
   use Pliny::Middleware::RequestID
   use Pliny::Middleware::RequestStore, store: Pliny::RequestStore
-  use Pliny::Middleware::Timeout, timeout: Config.timeout if Config.timeout > 0
+  use Rack::Timeout if Config.timeout > 0
   use Pliny::Middleware::Versioning,
       default: Config.versioning_default,
       app_name: Config.versioning_app_name if Config.versioning?

data/lib/template/spec/spec_helper.rb

@@ -10,6 +10,22 @@ ENV["RACK_ENV"] = "test"
 require "bundler"
 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')
 
@@ -27,7 +43,7 @@ RSpec.configure do |config|
   config.before :all do
     load('db/seeds.rb') if File.exist?('db/seeds.rb')
   end
-  
+
   config.before :each do
     DatabaseCleaner.start
   end

data/spec/db_support_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+require "pliny/db_support"
+
+describe Pliny::DbSupport do
+  let(:support) { Pliny::DbSupport.new(ENV["TEST_DATABASE_URL"]) }
+
+  before(:all) do
+    @path = "/tmp/pliny-test"
+  end
+
+  before(:each) do
+    DB.tables.each { |t| DB.drop_table(t) }
+    FileUtils.rm_rf(@path)
+    FileUtils.mkdir_p("#{@path}/db/migrate")
+    Dir.chdir(@path)
+  end
+
+  describe "#migrate" do
+    before do
+      File.open("#{@path}/db/migrate/#{Time.now.to_i}_create_foo.rb", "w") do |f|
+        f.puts "
+          Sequel.migration do
+            change do
+              create_table(:foo) do
+                primary_key :id
+                text        :bar
+              end
+            end
+          end
+        "
+      end
+    end
+
+    it "migrates the database" do
+      support.migrate
+      assert_equal [:foo, :schema_migrations], DB.tables.sort
+      assert_equal [:bar, :id], DB[:foo].columns.sort
+    end
+  end
+
+  describe "#rollback" do
+    before do
+      t = Time.now
+      File.open("#{@path}/db/migrate/#{(t-3).to_i}_first.rb", "w") do |f|
+        f.puts "Sequel.migration { change { create_table(:first) } }"
+      end
+
+      File.open("#{@path}/db/migrate/#{(t-2).to_i}_second.rb", "w") do |f|
+        f.puts "Sequel.migration { change { create_table(:second) } }"
+      end
+
+      File.open("#{@path}/db/migrate/#{(t-1).to_i}_third.rb", "w") do |f|
+        f.puts "Sequel.migration { change { create_table(:third) } }"
+      end
+    end
+
+    it "reverts one migration" do
+      support.migrate
+      support.rollback
+      assert_equal [:first, :schema_migrations, :second], DB.tables.sort
+      support.rollback
+      assert_equal [:first, :schema_migrations], DB.tables.sort
+    end
+  end
+end

data/spec/log_spec.rb

@@ -7,6 +7,10 @@ describe Pliny::Log do
     stub(@io).print
   end
 
+  after do
+    Pliny.default_context = {}
+  end
+
   it "logs in structured format" do
     mock(@io).print "foo=bar baz=42\n"
     Pliny.log(foo: "bar", baz: 42)
@@ -19,6 +23,12 @@ describe Pliny::Log do
     end
   end
 
+  it "merges default context" do
+    Pliny.default_context = { app: "pliny" }
+    mock(@io).print "app=pliny foo=bar\n"
+    Pliny.log(foo: "bar")
+  end
+
   it "merges context from RequestStore" do
     Pliny::RequestStore.store[:log_context] = { app: "pliny" }
     mock(@io).print "app=pliny foo=bar\n"
@@ -32,13 +42,20 @@ describe Pliny::Log do
     end
   end
 
-  it "local context does not overwrite global" do
+  it "local context does not overwrite default context" do
+    Pliny.default_context = { app: "pliny" }
+    mock(@io).print "app=not_pliny foo=bar\n"
+    Pliny.log(app: 'not_pliny', foo: "bar")
+    assert Pliny.default_context[:app] == "pliny"
+  end
+
+  it "local context does not overwrite request context" do
     Pliny::RequestStore.store[:log_context] = { app: "pliny" }
     mock(@io).print "app=not_pliny foo=bar\n"
     Pliny.context(app: "not_pliny") do
       Pliny.log(foo: "bar")
     end
-    assert Pliny::RequestStore.store[:log_context][:app] = "pliny"
+    assert Pliny::RequestStore.store[:log_context][:app] == "pliny"
   end
 
   it "local context does not propagate outside" do

data/spec/spec_helper.rb

@@ -1,16 +1,22 @@
 # make sure this is set before Sinatra is required
 ENV["RACK_ENV"] = "test"
 
+# have this database is available for tests
+ENV["TEST_DATABASE_URL"] ||= "postgres://localhost/pliny-gem-test"
+
 require "bundler"
 Bundler.require
 
+require "fileutils"
 require "rack/test"
+require "sequel"
 require "sinatra/namespace"
 require "sinatra/router"
 require "timecop"
 
 require_relative "../lib/pliny"
 Pliny::Utils.require_glob("./spec/support/**/*.rb")
+DB = Sequel.connect(ENV["TEST_DATABASE_URL"])
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -85,6 +85,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rack-timeout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -344,6 +364,7 @@ files:
 - lib/pliny/commands/generator/schema.rb
 - lib/pliny/commands/generator/serializer.rb
 - lib/pliny/config_helpers.rb
+- lib/pliny/db_support.rb
 - lib/pliny/errors.rb
 - lib/pliny/extensions/instruments.rb
 - lib/pliny/helpers/encode.rb
@@ -353,7 +374,6 @@ files:
 - lib/pliny/middleware/request_id.rb
 - lib/pliny/middleware/request_store.rb
 - lib/pliny/middleware/rescue_errors.rb
-- lib/pliny/middleware/timeout.rb
 - lib/pliny/middleware/versioning.rb
 - lib/pliny/request_store.rb
 - lib/pliny/router.rb
@@ -391,6 +411,8 @@ files:
 - lib/template/config.ru
 - lib/template/config/config.rb
 - lib/template/config/initializers/database.rb
+- lib/template/config/initializers/log.rb
+- lib/template/config/initializers/rack_timeout.rb
 - lib/template/config/initializers/rollbar.rb
 - lib/template/config/puma.rb
 - lib/template/db/schema.sql
@@ -413,6 +435,7 @@ files:
 - spec/commands/generator/endpoint_spec.rb
 - spec/commands/generator/schema_spec.rb
 - spec/commands/generator_spec.rb
+- spec/db_support_spec.rb
 - spec/errors_spec.rb
 - spec/extensions/instruments_spec.rb
 - spec/integration_spec.rb
@@ -421,7 +444,6 @@ files:
 - spec/middleware/request_id_spec.rb
 - spec/middleware/request_store_spec.rb
 - spec/middleware/rescue_errors_spec.rb
-- spec/middleware/timeout_spec.rb
 - spec/middleware/versioning_spec.rb
 - spec/request_store_spec.rb
 - spec/router_spec.rb
@@ -448,7 +470,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Basic tooling to support API apps in Sinatra

data/lib/pliny/middleware/timeout.rb

@@ -1,25 +0,0 @@
-require "timeout"
-
-module Pliny::Middleware
-  # Requires that Pliny::Middleware::RescueErrors is nested above it.
-  class Timeout
-    def initialize(app, options={})
-      @app = app
-      @timeout = options[:timeout] || 45
-    end
-
-    def call(env)
-      ::Timeout.timeout(@timeout, RequestTimeout) do
-        @app.call(env)
-      end
-    rescue RequestTimeout
-    # Pliny::Sample.measure "requests.timeouts"
-      raise Pliny::Errors::ServiceUnavailable, "Timeout reached."
-    end
-
-    # use a custom Timeout class so it can't be rescued accidentally by
-    # internal calls
-    class RequestTimeout < Exception
-    end
-  end
-end

data/spec/middleware/timeout_spec.rb

@@ -1,32 +0,0 @@
-require "spec_helper"
-
-describe Pliny::Middleware::Timeout do
-  include Rack::Test::Methods
-
-  def app
-    Rack::Builder.new do
-      use Rack::Lint
-      use Pliny::Middleware::Timeout
-      run Sinatra.new {
-        get "/" do
-          200
-        end
-
-        get "/timeout" do
-          raise Pliny::Middleware::Timeout::RequestTimeout
-        end
-      }
-    end
-  end
-
-  it "passes through requests that don't timeout normally" do
-    get "/"
-    assert_equal 200, last_response.status
-  end
-
-  it "responds with an error on a timeout" do
-    assert_raises(Pliny::Errors::ServiceUnavailable) do
-      get "/timeout"
-    end
-  end
-end