Merge pull request #2 from VitorTrin/PSPDFKit-labs-master

Author: VitorTrin

.formatter.exs

@@ -0,0 +1,3 @@
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.travis.yml

@@ -1,10 +1,14 @@
 language: elixir
 elixir:
-  - 1.7.4
-  - 1.6.6
+  - 1.10
+  - 1.9
+  - 1.8
+  - 1.7
+  - 1.6
 otp_release:
   - 20.0
   - 21.0
+  - 22.0
 sudo: false # to use faster container based build environment
 env:
   - MIX_ENV=test
@@ -14,7 +18,10 @@ install:
   - mix compile
 script:
   - mix test
+# https://hexdocs.pm/elixir/compatibility-and-deprecations.html#compatibility-between-elixir-and-erlang-otp
 matrix:
   exclude:
+    - otp_release: 22.0
+      elixir: 1.6
     - otp_release: 20.0
-      elixir: 1.3.4
+      elixir: 1.10

README.md

@@ -13,7 +13,9 @@ Add bypass to your list of dependencies in mix.exs:
 
 ```elixir
 def deps do
-  [{:bypass, "~> 1.0", only: :test}]
+  [
+    {:bypass, "~> 1.0", only: :test}
+  ]
 end
 ```
 
@@ -28,7 +30,7 @@ Bypass supports Elixir 1.6 and OTP 20 and up. It works with Cowboy 1 and 2.
 Start Bypass in your `test/test_helper.exs` file to make it available in tests:
 
 ```elixir
-ExUnit.start
+ExUnit.start()
 Application.ensure_all_started(:bypass)
 ```
 
@@ -52,23 +54,23 @@ You can take any of the following approaches:
 Must be called at least once.
 
 ```elixir
-  Bypass.expect bypass, fn conn ->
-    assert "/1.1/statuses/update.json" == conn.request_path
-    assert "POST" == conn.method
-    Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
-  end
+Bypass.expect(bypass, fn conn ->
+  assert "/1.1/statuses/update.json" == conn.request_path
+  assert "POST" == conn.method
+  Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
+end)
 ```
 
 #### expect_once/2 (bypass_instance, function)
 
 Must be called exactly once.
 
 ```elixir
-  Bypass.expect_once bypass, fn conn ->
-    assert "/1.1/statuses/update.json" == conn.request_path
-    assert "POST" == conn.method
-    Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
-  end
+Bypass.expect_once(bypass, fn conn ->
+  assert "/1.1/statuses/update.json" == conn.request_path
+  assert "POST" == conn.method
+  Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
+end)
 ```
 
 #### expect/4 (bypass_instance, method, path, function)
@@ -80,10 +82,10 @@ Must be called at least once.
 `path` is the endpoint.
 
 ```elixir
-  Bypass.expect bypass, "POST", "/1.1/statuses/update.json", fn conn ->
-    Agent.get_and_update(AgentModule, fn step_no -> {step_no, step_no+1} end)
-    Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
-  end
+Bypass.expect(bypass, "POST", "/1.1/statuses/update.json", fn conn ->
+  Agent.get_and_update(AgentModule, fn step_no -> {step_no, step_no + 1} end)
+  Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
+end)
 ```
 
 #### expect_once/4 (bypass_instance, method, path, function)
@@ -95,10 +97,10 @@ Must be called exactly once.
 `path` is the endpoint.
 
 ```elixir
-  Bypass.expect_once bypass, "POST", "/1.1/statuses/update.json", fn conn ->
-    Agent.get_and_update(AgentModule, fn step_no -> {step_no, step_no+1} end)
-    Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
-  end
+Bypass.expect_once(bypass, "POST", "/1.1/statuses/update.json", fn conn ->
+  Agent.get_and_update(AgentModule, fn step_no -> {step_no, step_no + 1} end)
+  Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
+end)
 ```
 
 #### stub/4 (bypass_instance, method, path, function)
@@ -110,10 +112,10 @@ May be called none or more times.
 `path` is the endpoint.
 
 ```elixir
-  Bypass.stub bypass, "POST", "/1.1/statuses/update.json", fn conn ->
-    Agent.get_and_update(AgentModule, fn step_no -> {step_no, step_no+1} end)
-    Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
-  end
+Bypass.stub(bypass, "POST", "/1.1/statuses/update.json", fn conn ->
+  Agent.get_and_update(AgentModule, fn step_no -> {step_no, step_no + 1} end)
+  Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
+end)
 ```
 
 ### Example
@@ -126,23 +128,25 @@ defmodule TwitterClientTest do
   use ExUnit.Case, async: true
 
   setup do
-    bypass = Bypass.open
+    bypass = Bypass.open()
     {:ok, bypass: bypass}
   end
 
   test "client can handle an error response", %{bypass: bypass} do
-    Bypass.expect_once bypass, "POST", "/1.1/statuses/update.json", fn conn ->
+    Bypass.expect_once(bypass, "POST", "/1.1/statuses/update.json", fn conn ->
       Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
-    end
+    end)
+
     {:ok, client} = TwitterClient.start_link(url: endpoint_url(bypass.port))
     assert {:error, :rate_limited} == TwitterClient.post_tweet(client, "Elixir is awesome!")
   end
 
   test "client can recover from server downtime", %{bypass: bypass} do
-    Bypass.expect bypass, fn conn ->
+    Bypass.expect(bypass, fn conn ->
       # We don't care about `request_path` or `method` for this test.
       Plug.Conn.resp(conn, 200, "")
-    end
+    end)
+
     {:ok, client} = TwitterClient.start_link(url: endpoint_url(bypass.port))
 
     assert :ok == TwitterClient.post_tweet(client, "Elixir is awesome!")
@@ -198,7 +202,7 @@ defmodule TwitterClientSpec do
   use ESpec, async: true
 
   before do
-    bypass = Bypass.open
+    bypass = Bypass.open()
     {:shared, bypass: bypass}
   end
 
@@ -207,9 +211,10 @@ defmodule TwitterClientSpec do
   end
 
   specify "the client can handle an error response" do
-    Bypass.expect_once shared.bypass, "POST", "/1.1/statuses/update.json", fn conn ->
+    Bypass.expect_once(shared.bypass, "POST", "/1.1/statuses/update.json", fn conn ->
       Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)
-    end
+    end)
+
     {:ok, client} = TwitterClient.start_link(url: endpoint_url(shared.bypass.port))
     assert {:error, :rate_limited} == TwitterClient.post_tweet(client, "Elixir is awesome!")
   end

lib/bypass.ex

@@ -20,19 +20,19 @@ defmodule Bypass do
   handled and set expectations on the calls.
   """
   def open(opts \\ []) do
-    case Supervisor.start_child(Bypass.Supervisor, [opts]) do
+    case DynamicSupervisor.start_child(Bypass.Supervisor, Bypass.Instance.child_spec(opts)) do
       {:ok, pid} ->
         port = Bypass.Instance.call(pid, :port)
-        debug_log "Did open connection #{inspect pid} on port #{inspect port}"
+        debug_log("Did open connection #{inspect(pid)} on port #{inspect(port)}")
         bypass = %Bypass{pid: pid, port: port}
         setup_framework_integration(test_framework(), bypass)
         bypass
+
       other ->
         other
     end
   end
 
-
   # Raise an error if called with an unknown framework
   #
   defp setup_framework_integration(:ex_unit, bypass = %{pid: pid}) do
@@ -45,7 +45,6 @@ defmodule Bypass do
     # Entry point for more advanced ESpec configurations
   end
 
-
   @doc """
   Can be called to immediately verify if the declared request
   expectations have been met.
@@ -66,33 +65,39 @@ defmodule Bypass do
     end
   end
 
-
   defp do_verify_expectations(bypass_pid, error_module) do
     case Bypass.Instance.call(bypass_pid, :on_exit) do
       :ok ->
         :ok
+
       :ok_call ->
         :ok
+
       {:error, :too_many_requests, {:any, :any}} ->
         raise error_module, "Expected only one HTTP request for Bypass"
+
       {:error, :too_many_requests, {method, path}} ->
         raise error_module, "Expected only one HTTP request for Bypass at #{method} #{path}"
+
       {:error, :unexpected_request, {:any, :any}} ->
         raise error_module, "Bypass got an HTTP request but wasn't expecting one"
+
       {:error, :unexpected_request, {method, path}} ->
         raise error_module,
-          "Bypass got an HTTP request but wasn't expecting one at #{method} #{path}"
+              "Bypass got an HTTP request but wasn't expecting one at #{method} #{path}"
+
       {:error, :not_called, {:any, :any}} ->
         raise error_module, "No HTTP request arrived at Bypass"
+
       {:error, :not_called, {method, path}} ->
         raise error_module,
-          "No HTTP request arrived at Bypass at #{method} #{path}"
+              "No HTTP request arrived at Bypass at #{method} #{path}"
+
       {:exit, {class, reason, stacktrace}} ->
         :erlang.raise(class, reason, stacktrace)
     end
   end
 
-
   def up(%Bypass{pid: pid}),
     do: Bypass.Instance.call(pid, :up)
 
@@ -117,7 +122,6 @@ defmodule Bypass do
   def pass(%Bypass{pid: pid}),
     do: Bypass.Instance.call(pid, :pass)
 
-
   defp test_framework do
     Application.get_env(:bypass, :test_framework, :ex_unit)
   end

lib/bypass/application.ex

@@ -4,11 +4,7 @@ defmodule Bypass.Application do
   def start(_type, _args) do
     import Supervisor.Spec, warn: false
 
-    children = [
-      worker(Bypass.Instance, [], restart: :transient)
-    ]
-
-    opts = [strategy: :simple_one_for_one, name: Bypass.Supervisor]
-    Supervisor.start_link(children, opts)
+    opts = [strategy: :one_for_one, name: Bypass.Supervisor]
+    DynamicSupervisor.start_link(opts)
   end
 end