pliny 0.28.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fdeb50812c8474db1b462be06a13943d901cc06c51044c39fffe9533c2d67d4
-  data.tar.gz: b70639846466fc0efa37a62fc55551ec4386ccfd0ac3141e041bef88744f4610
+  metadata.gz: 03b6f9bac86953d6bef8858e6c4c1f6f94f06073fac8175b9572728ffed5a276
+  data.tar.gz: c20333f978e5f8e908b13f6eaf9d37a3dbdb0f10204c1db9a8b5f83b02fbac11
 SHA512:
-  metadata.gz: f9e248f7961808f6d862d6b77c8065afc7716cf7861ecb0c508d470819ba012a0a0cd2454352b4854bbaad4cb23f18166ace07cca14035eb514ec71fdf908a96
-  data.tar.gz: 7b7120d718e286d1ecb7cead9ed19db8a823b4aefe66f1601d824cfc172b46c89c2cbbe2ebdccfaf0e113b8afb862bd2c85d76bf55438ca1dbd5ea89bfc3f28d
+  metadata.gz: e851ccdd1fb0a3d548fa672d209829e9cd8ecf69023d1c7a2fb6ad0fb84ee1616d2d3b2a761d11ba9c13a989d2fb5176c31d3eb6acf9a02e20c6e7bc4b01386f
+  data.tar.gz: aefb3c02dc44ba282595bb9b2e85dc52e2891cb16ac6395693ab63bd79c603b7c68e9b93dea4c494c1b574e8be308b26a34e40040d4e71e0a74cb9a9f828a207

data/README.md

@@ -1,7 +1,8 @@
 # Pliny
 
 [![Gem version](http://img.shields.io/gem/v/pliny.svg)](https://rubygems.org/gems/pliny)
-[![Build Status](https://travis-ci.org/interagent/pliny.svg?branch=master)](https://travis-ci.org/interagent/pliny)
+[![Github Actions CI](https://github.com/interagent/pliny/actions/workflows/ruby.yml/badge.svg)](https://github.com/interagent/pliny/actions)
+
 
 Pliny helps Ruby developers write and maintain excellent APIs.
 

data/lib/pliny/db_support.rb

@@ -46,25 +46,43 @@ module Pliny
       db.run(%{CREATE DATABASE "#{name}"})
     end
 
-    def migrate(target=nil)
-      Sequel::Migrator.apply(db, "./db/migrate", target)
+    def migrate(target = nil)
+      Sequel::Migrator.apply(db, MIGRATION_DIR, target)
+    end
+
+    def version
+      return 0 unless db.table_exists?(:schema_migrations)
+
+      current = db[:schema_migrations].order(Sequel.desc(:filename)).first
+
+      return 0 unless current
+
+      version = current[:filename].match(Sequel::Migrator::MIGRATION_FILE_PATTERN).captures.first
+      version ||= 0
+      Integer(version)
     end
 
     def rollback
-      return unless db.tables.include?(:schema_migrations)
-      return unless current = db[:schema_migrations].order(Sequel.desc(:filename)).first
+      current_version = version
+      return if current_version.zero?
+
+      migrations = Dir["#{MIGRATION_DIR}/*.rb"].map { |f| File.basename(f).to_i }.sort
 
-      migrations = Dir["./db/migrate/*.rb"].map { |f| File.basename(f).to_i }.sort
-      target     = 0 # by default, rollback everything
-      index      = migrations.index(current[:filename].to_i)
+      target = 0 # by default, rollback everything
+      index = migrations.index(current_version)
       if index > 0
         target = migrations[index - 1]
       end
-      Sequel::Migrator.apply(db, "./db/migrate", target)
+      Sequel::Migrator.apply(db, MIGRATION_DIR, target)
     end
 
     def disconnect
       @db.disconnect
     end
+
+    private
+
+    MIGRATION_DIR = "./db/migrate".freeze
+    private_constant :MIGRATION_DIR
   end
 end

data/lib/pliny/helpers/params.rb

@@ -8,9 +8,13 @@ module Pliny::Helpers
 
     def parse_body_params
       if request.media_type == "application/json"
-        p = load_params(MultiJson.decode(request.body.read))
+        begin
+          decoded = MultiJson.decode(request.body.read)
+        rescue MultiJson::ParseError => e
+          raise Pliny::Errors::BadRequest, e.message
+        end
         request.body.rewind
-        p
+        load_params(decoded)
       elsif request.form_data?
         load_params(request.POST)
       else

data/lib/pliny/helpers/serialize.rb

@@ -1,42 +1,41 @@
 module Pliny::Helpers
   module Serialize
-    def self.included(base)
-      base.send :extend, ClassMethods
+    def self.registered(base)
+      base.helpers Helpers
+      base.set :serializer_class, nil
     end
 
-    def serialize(data, structure = :default)
-      serializer_class = self.class.serializer_class
+    module Helpers
+      def serialize(data, structure = :default)
+        serializer_class = settings.serializer_class
 
-      if serializer_class.nil?
-        raise <<-eos.strip
-No serializer has been specified for this endpoint. Please specify one with
-`serializer Serializers::ModelName` in the endpoint.
-        eos
-      end
+        if serializer_class.nil?
+          raise <<~eos.strip
+            No serializer has been specified for this endpoint. Please specify one with
+            `serializer Serializers::ModelName` in the endpoint.
+          eos
+        end
 
-      env['pliny.serializer_arity'] = data.respond_to?(:size) ? data.size : 1
+        env['pliny.serializer_arity'] = data.respond_to?(:size) ? data.size : 1
 
-      start = Time.now
-      serializer_class.new(structure).serialize(data).tap do
-        env['pliny.serializer_timing'] = (Time.now - start).to_f
+        start = Time.now
+        serializer_class.new(structure).serialize(data).tap do
+          env['pliny.serializer_timing'] = (Time.now - start).to_f
+        end
       end
     end
 
-    module ClassMethods
-      # Provide a way to specify endpoint serializer class.
-      #
-      # class Endpoints::User < Base
-      #   serializer Serializers::User
-      #
-      #   get do
-      #     encode serialize(User.all)
-      #   end
-      # end
-      def serializer(serializer_class)
-        @serializer_class = serializer_class
-      end
-
-      attr_reader :serializer_class
+    # Provide a way to specify endpoint serializer class.
+    #
+    # class Endpoints::User < Base
+    #   serializer Serializers::User
+    #
+    #   get do
+    #     encode serialize(User.all)
+    #   end
+    # end
+    def serializer(serializer_class)
+      set :serializer_class, serializer_class
     end
   end
 end

data/lib/pliny/log.rb

@@ -123,13 +123,17 @@ module Pliny
       end
     end
 
-    def quote_string(k, v)
+    def replace_newlines(v)
+      v.gsub("\n", "\\n")
+    end
+
+    def quote_string(v)
       if !v.include?('"')
-        %{#{k}="#{v}"}
+        %{"#{v}"}
       elsif !v.include?("'")
-        %{#{k}='#{v}'}
+        %{'#{v}'}
       else
-        %{#{k}="#{v.gsub(/"/, '\\"')}"}
+        %{"#{v.gsub(/"/, '\\"')}"}
       end
     end
 
@@ -150,11 +154,10 @@ module Pliny
         "#{k}=#{v.iso8601}"
       else
         v = "#{v}"
-        if v =~ /\s/
-          quote_string(k, v)
-        else
-          "#{k}=#{v}"
-        end
+        v = replace_newlines(v)
+        v = quote_string(v) if v =~ /\s/
+
+        "#{k}=#{v}"
       end
     end
   end

data/lib/pliny/middleware/canonical_log_line.rb

@@ -58,9 +58,9 @@ module Pliny::Middleware
       log_field :timing_serializer, Float
     end
 
-    def initialize(app, emitter:)
+    def initialize(app, options)
       @app = app
-      @emitter = emitter
+      @emitter = options.fetch(:emitter)
     end
 
     def call(env)

data/lib/pliny/tasks/db.rake

@@ -8,6 +8,13 @@ begin
   require "pliny/db_support"
 
   namespace :db do
+    desc "Get current schema version"
+    task :version do
+      Pliny::DbSupport.run(database_urls.first, $stdout) do |helper|
+        puts "Current version: #{helper.version}"
+      end
+    end
+
     desc "Run database migrations"
     task :migrate do
       next if Dir["./db/migrate/*.rb"].empty?

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.28.0"
+  VERSION = "0.31.0"
 end

data/lib/template/Gemfile

@@ -4,7 +4,7 @@ ruby "2.4.0"
 gem "multi_json"
 gem "oj"
 gem "pg"
-gem "pliny", "~> 0.28"
+gem "pliny", "~> 0.31"
 gem "pry"
 gem "puma", "~> 3"
 gem "rack-ssl"

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

@@ -5,7 +5,7 @@ module Endpoints
 
     helpers Pliny::Helpers::Encode
     helpers Pliny::Helpers::Params
-    helpers Pliny::Helpers::Serialize
+    register Pliny::Helpers::Serialize
 
     set :dump_errors, false
     set :raise_errors, true

data/spec/db_support_spec.rb

@@ -2,9 +2,9 @@ require "spec_helper"
 require "pliny/db_support"
 
 describe Pliny::DbSupport do
+  subject(:support) { Pliny::DbSupport.new(url, logger) }
   let(:url) { ENV["TEST_DATABASE_URL"] }
   let(:logger) { Logger.new(StringIO.new) }
-  let(:support) { Pliny::DbSupport.new(url, logger) }
 
   around do |example|
     Dir.mktmpdir("plinytest-") do |dir|
@@ -88,4 +88,30 @@ describe Pliny::DbSupport do
       support.rollback # should noop
     end
   end
+
+  describe "#version" do
+    it "is zero if the migrations table doesn't exist" do
+      assert_equal 0, support.version
+    end
+
+    context "with migrations table" do
+      before do
+        DB.create_table(:schema_migrations) do
+          text :filename
+        end
+      end
+
+      it "is zero if the migrations table is empty" do
+        assert_equal 0, support.version
+      end
+
+      it "is the highest timestamp from a filename in the migrations table" do
+        migrations = DB[:schema_migrations]
+        migrations.insert(filename: "1630551344_latest_change.rb")
+        migrations.insert(filename: "1524000760_earlier_change.rb")
+
+        assert_equal 1630551344, support.version
+      end
+    end
+  end
 end

data/spec/helpers/params_spec.rb

@@ -34,4 +34,12 @@ describe Pliny::Helpers::Params do
     post "/", "<hello>world</hello>", {"CONTENT_TYPE" => "application/xml"}
     assert_equal "{}", last_response.body
   end
+
+  it "should throw bad request when receiving invalid json via post" do
+    err = assert_raises(Pliny::Errors::BadRequest) do
+      post "/", "{\"foo\"}", {"CONTENT_TYPE" => "application/json"}
+    end
+
+    assert_match /unexpected token/, err.message
+  end
 end

data/spec/helpers/serialize_spec.rb

@@ -4,7 +4,7 @@ describe Pliny::Helpers::Serialize do
   context "without a serializer" do
     def app
       Sinatra.new do
-        helpers Pliny::Helpers::Serialize
+        register Pliny::Helpers::Serialize
 
         get "/" do
           MultiJson.encode(serialize([]))
@@ -29,7 +29,7 @@ describe Pliny::Helpers::Serialize do
 
     def app
       Sinatra.new do
-        helpers Pliny::Helpers::Serialize
+        register Pliny::Helpers::Serialize
 
         serializer Serializer
 

data/spec/log_spec.rb

@@ -161,6 +161,12 @@ describe Pliny::Log do
       Pliny.log(foo: "string with spaces")
     end
 
+    it "replaces newlines in strings" do
+      expect(@io).to receive(:print).with("foo=\"string\\nwith newlines\\n\"\n")
+
+      Pliny.log(foo: "string\nwith newlines\n")
+    end
+
     it "by default interpolates objects into strings" do
       expect(@io).to receive(:print).with("foo=message\n")
       expect(@io).to receive(:print).with("foo=42\n")

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Brandur Leach
 - Pedro Belo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -135,22 +135,22 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.19'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.19'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -183,22 +183,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
@@ -273,60 +273,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-    - - ">="
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-    - - ">="
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rollbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.11.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.11.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.9'
+        version: '5.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.9'
+        version: '5.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -503,7 +497,7 @@ homepage: https://github.com/interagent/pliny
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -518,8 +512,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Basic tooling to support API apps in Sinatra
 test_files: []