pliny 0.0.1.pre

data/test/middleware/cors_test.rb

@@ -0,0 +1,42 @@
+require "test_helper"
+
+describe Pliny::Middleware::CORS do
+  def app
+    Rack::Builder.new do
+      use Rack::Lint
+      use Pliny::Middleware::CORS
+      run Sinatra.new {
+        get "/" do
+          "hi"
+        end
+      }
+    end
+  end
+
+  it "doesn't do anything when the Origin header is not present" do
+    get "/"
+    assert_equal 200, last_response.status
+    assert_equal "hi", last_response.body
+    assert_equal nil, last_response.headers["Access-Control-Allow-Origin"]
+  end
+
+  it "intercepts OPTION requests to render a stub (preflight request)" do
+    header "Origin", "http://localhost"
+    options "/"
+    assert_equal 200, last_response.status
+    assert_equal "", last_response.body
+    assert_equal "GET, POST, PUT, PATCH, DELETE, OPTIONS",
+      last_response.headers["Access-Control-Allow-Methods"]
+    assert_equal "http://localhost",
+      last_response.headers["Access-Control-Allow-Origin"]
+  end
+
+  it "delegates other calls, adding the CORS headers to the response" do
+    header "Origin", "http://localhost"
+    get "/"
+    assert_equal 200, last_response.status
+    assert_equal "hi", last_response.body
+    assert_equal "http://localhost",
+      last_response.headers["Access-Control-Allow-Origin"]
+  end
+end

data/test/middleware/request_id_test.rb

@@ -0,0 +1,28 @@
+require "test_helper"
+
+describe Pliny::Middleware::RequestID do
+  def app
+    Rack::Builder.new do
+      use Rack::Lint
+      use Pliny::Middleware::RequestID
+      run Sinatra.new {
+        get "/" do
+          env["REQUEST_IDS"].join(",")
+        end
+      }
+    end
+  end
+
+  it "tags responses with Request-Id" do
+    get "/"
+    assert_match Pliny::Middleware::RequestID::UUID_PATTERN,
+      last_response.headers["Request-Id"]
+  end
+
+  it "accepts incoming request IDs" do
+    id = SecureRandom.uuid
+    header "Request-Id", id
+    get "/"
+    assert_includes last_response.body, id
+  end
+end

data/test/middleware/request_store_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+describe Pliny::Middleware::RequestStore do
+  def app
+    Rack::Builder.new do
+      use Rack::Lint
+      use Pliny::Middleware::RequestStore, store: Pliny::RequestStore
+      run Sinatra.new {
+        get "/" do
+          "hi"
+        end
+      }
+    end
+  end
+
+  it "clears the store" do
+    mock(Pliny::RequestStore).clear!
+    get "/"
+  end
+
+  it "seeds the store" do
+    mock(Pliny::RequestStore).seed.with_any_args
+    get "/"
+  end
+end

data/test/middleware/rescue_errors_test.rb

@@ -0,0 +1,41 @@
+require "test_helper"
+
+describe Pliny::Middleware::RescueErrors do
+  include Rack::Test::Methods
+
+  class BadMiddleware
+    def call(env)
+      if env["PATH_INFO"] == "/api-error"
+        raise Pliny::Errors::ServiceUnavailable
+      else
+        raise "Omg!"
+      end
+    end
+  end
+
+  def app
+    Rack::Builder.new do
+      use Rack::Lint
+      use Pliny::Middleware::RescueErrors
+      run BadMiddleware.new
+    end
+  end
+
+  it "intercepts Pliny errors and renders" do
+    get "/api-error"
+    assert_equal 503, last_response.status
+    error_json = MultiJson.decode(last_response.body)
+    assert_equal "service_unavailable", error_json["id"]
+    assert_equal "Service unavailable.", error_json["message"]
+    assert_equal 503, error_json["status"]
+  end
+
+  it "intercepts exceptions and renders" do
+    get "/"
+    assert_equal 500, last_response.status
+    error_json = MultiJson.decode(last_response.body)
+    assert_equal "internal_server_error", error_json["id"]
+    assert_equal "Internal server error.", error_json["message"]
+    assert_equal 500, error_json["status"]
+  end
+end

data/test/middleware/timeout_test.rb

@@ -0,0 +1,32 @@
+require "test_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

data/test/middleware/versioning_test.rb

@@ -0,0 +1,63 @@
+require "test_helper"
+
+describe Pliny::Middleware::Versioning do
+  include Rack::Test::Methods
+
+  def app
+    Rack::Builder.new do
+      use Rack::Lint
+      use Pliny::Middleware::Versioning, default: '2', app_name: 'pliny'
+      run Sinatra.new {
+        get "/" do
+          MultiJson.encode env
+        end
+      }
+    end
+  end
+
+  it "produces default version on application/json" do
+    get '/', {}, {'HTTP_ACCEPT' => 'application/json'}
+    json = MultiJson.decode(last_response.body)
+    assert_equal 'application/json', json['HTTP_ACCEPT']
+    assert_equal '2', json['HTTP_X_API_VERSION']
+  end
+
+  it "errors without a version specified on application/vnd.pliny+json" do
+    get '/', {}, {'HTTP_ACCEPT' => 'application/vnd.pliny+json'}
+    error = { id: :bad_version, message: <<-eos }
+Please specify a version along with the MIME type. For example, `Accept: application/vnd.pliny+json; version=1`.
+    eos
+
+    assert_equal 400, last_response.status
+    assert_equal MultiJson.encode(error), last_response.body
+  end
+
+  it "ignores a wrong app name" do
+    get '/', {}, {'HTTP_ACCEPT' => 'application/vnd.chuck_norris+json'}
+    json = MultiJson.decode(last_response.body)
+    assert_equal 'application/vnd.chuck_norris+json', json['HTTP_ACCEPT']
+    assert_equal '2', json['HTTP_X_API_VERSION']
+  end
+
+  it "produces a version on application/vnd.pliny+json; version=3" do
+    get '/', {}, {'HTTP_ACCEPT' => 'application/vnd.pliny+json; version=3'}
+    json = MultiJson.decode(last_response.body)
+    assert_equal 'application/json', json['HTTP_ACCEPT']
+    assert_equal '3', json['HTTP_X_API_VERSION']
+  end
+
+  # this behavior is pretty sketchy, but a pretty extreme edge case
+  it "handles multiple MIME types" do
+    get '/', {}, {'HTTP_ACCEPT' => 'application/vnd.pliny+json; version=3; q=0.5, text/xml'}
+    json = MultiJson.decode(last_response.body)
+    assert_equal 'text/xml, application/json; q=0.5', json['HTTP_ACCEPT']
+    assert_equal '3', json['HTTP_X_API_VERSION']
+  end
+
+  it "produces the priority version on multiple types" do
+    get '/', {}, {'HTTP_ACCEPT' => 'application/vnd.pliny+json; version=4; q=0.5, application/vnd.pliny+json; version=3'}
+    json = MultiJson.decode(last_response.body)
+    assert_equal 'application/json, application/json; q=0.5', json['HTTP_ACCEPT']
+    assert_equal '3', json['HTTP_X_API_VERSION']
+  end
+end

data/test/request_store_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+describe Pliny::RequestStore do
+  before do
+    @env = {
+      "REQUEST_IDS" => ["abc", "def"]
+    }
+  end
+
+  it "seeds :request_id" do
+    Pliny::RequestStore.seed(@env)
+    assert_equal "abc,def", Pliny::RequestStore.store[:request_id]
+  end
+
+  it "seeds :log_context" do
+    Pliny::RequestStore.seed(@env)
+    assert_equal "abc,def", Pliny::RequestStore.store[:log_context][:request_id]
+  end
+
+  it "is cleared by clear!" do
+    Pliny::RequestStore.seed(@env)
+    Pliny::RequestStore.clear!
+    assert_nil Pliny::RequestStore.store[:request_id]
+  end
+end

data/test/router_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+describe Pliny::Router do
+
+  describe "specifying a version" do
+    def app
+      Rack::Builder.new do
+        use Rack::Lint
+        use Pliny::Middleware::Versioning, default: '2', app_name: 'pliny'
+
+        use Pliny::Router do
+          version '3' do
+            mount Sinatra.new {
+              get '/' do
+                "API V3"
+              end
+            }
+          end
+        end
+
+        run Sinatra.new {
+          get "/" do
+            "No API"
+          end
+        }
+      end
+    end
+
+    it "should not run on any api" do
+      get '/'
+      assert_equal 'No API', last_response.body
+    end
+
+    it "should run on API V3" do
+      get '/', {}, {'HTTP_ACCEPT' => 'application/vnd.pliny+json; version=3'}
+      assert_equal 'API V3', last_response.body
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+# make sure this is set before Sinatra is required
+ENV["RACK_ENV"] = "test"
+
+require "bundler"
+Bundler.require(:default, :test)
+
+require "minitest/autorun"
+require "rr"
+
+require_relative "../lib/pliny"
+
+class MiniTest::Spec
+  include Rack::Test::Methods
+
+  before do
+    Pliny::RequestStore.clear!
+  end
+end

metadata

@@ -0,0 +1,252 @@
+--- !ruby/object:Gem::Specification
+name: pliny
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Brandur Leach
+- Pedro Belo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: prmd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: http_accept
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: sinatra-router
+  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
+description: Pliny is a set of base classes and helpers to help developers write excellent
+  APIs in Sinatra
+email:
+- brandur@mutelight.org
+- pedrobelo@gmail.com
+executables:
+- pliny-generate
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/pliny-generate
+- lib/pliny.rb
+- lib/pliny/commands/generator.rb
+- lib/pliny/config_helpers.rb
+- lib/pliny/errors.rb
+- lib/pliny/extensions/instruments.rb
+- lib/pliny/log.rb
+- lib/pliny/middleware/cors.rb
+- 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
+- lib/pliny/tasks.rb
+- lib/pliny/tasks/db.rake
+- lib/pliny/tasks/test.rake
+- lib/pliny/templates/endpoint.erb
+- lib/pliny/templates/endpoint_acceptance_test.erb
+- lib/pliny/templates/endpoint_scaffold.erb
+- lib/pliny/templates/endpoint_scaffold_acceptance_test.erb
+- lib/pliny/templates/endpoint_test.erb
+- lib/pliny/templates/mediator.erb
+- lib/pliny/templates/mediator_test.erb
+- lib/pliny/templates/migration.erb
+- lib/pliny/templates/model.erb
+- lib/pliny/templates/model_migration.erb
+- lib/pliny/templates/model_test.erb
+- lib/pliny/utils.rb
+- lib/pliny/version.rb
+- test/commands/generator_test.rb
+- test/errors_test.rb
+- test/extensions/instruments_test.rb
+- test/log_test.rb
+- test/middleware/cors_test.rb
+- test/middleware/request_id_test.rb
+- test/middleware/request_store_test.rb
+- test/middleware/rescue_errors_test.rb
+- test/middleware/timeout_test.rb
+- test/middleware/versioning_test.rb
+- test/request_store_test.rb
+- test/router_test.rb
+- test/test_helper.rb
+homepage: https://github.com/heroku/pliny
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Basic tooling to support API apps in Sinatra
+test_files: []