Make callback type definitions less restrictive

edgurgel · Oct 16, 2018 · bd14138 · bd14138
1 parent 612b62e
commit bd14138
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 40 deletions.
diff --git a/lib/httpoison.ex b/lib/httpoison.ex
@@ -37,11 +37,11 @@ defmodule HTTPoison.Request do
   defstruct method: :get, url: nil, headers: [], body: "", params: %{}, options: []
 
   @type method :: :get | :post | :put | :patch | :delete | :options | :head
-  @type headers :: [{atom, binary}] | [{binary, binary}] | %{binary => binary}
-  @type url :: binary
-  @type body :: binary | {:form, [{atom, any}]} | {:file, binary}
-  @type params :: map | keyword | [{binary, binary}]
-  @type options :: keyword
+  @type headers :: [{atom, binary}] | [{binary, binary}] | %{binary => binary} | any
+  @type url :: binary | any
+  @type body :: binary | {:form, [{atom, any}]} | {:file, binary} | any
+  @type params :: map | keyword | [{binary, binary}] | any
+  @type options :: keyword | any
 
   @type t :: %__MODULE__{
           method: method,

diff --git a/lib/httpoison/base.ex b/lib/httpoison/base.ex
@@ -113,35 +113,37 @@ defmodule HTTPoison.Base do
   @callback options!(url, headers) :: Response.t() | AsyncResponse.t()
   @callback options!(url, headers, options) :: Response.t() | AsyncResponse.t()
 
-  @callback patch(url, term) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback patch(url, term, headers) ::
+  @callback patch(url, body) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
+  @callback patch(url, body, headers) ::
               {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback patch(url, term, headers, options) ::
+  @callback patch(url, body, headers, options) ::
               {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
 
-  @callback patch!(url, term) :: Response.t() | AsyncResponse.t()
-  @callback patch!(url, term, headers) :: Response.t() | AsyncResponse.t()
-  @callback patch!(url, term, headers, options) :: Response.t() | AsyncResponse.t()
+  @callback patch!(url, body) :: Response.t() | AsyncResponse.t()
+  @callback patch!(url, body, headers) :: Response.t() | AsyncResponse.t()
+  @callback patch!(url, body, headers, options) :: Response.t() | AsyncResponse.t()
 
-  @callback post(url, term) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback post(url, term, headers) ::
+  @callback post(url, body) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
+  @callback post(url, body, headers) ::
               {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback post(url, term, headers, options) ::
+  @callback post(url, body, headers, options) ::
               {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
 
-  @callback post!(url, term) :: Response.t() | AsyncResponse.t()
-  @callback post!(url, term, headers) :: Response.t() | AsyncResponse.t()
-  @callback post!(url, term, headers, options) :: Response.t() | AsyncResponse.t()
+  @callback post!(url, body) :: Response.t() | AsyncResponse.t()
+  @callback post!(url, body, headers) :: Response.t() | AsyncResponse.t()
+  @callback post!(url, body, headers, options) :: Response.t() | AsyncResponse.t()
 
+  # deprecated: Use process_request_headers/1 instead
   @callback process_headers(list) :: term
-  @callback process_response_headers(list) :: term
 
-  @callback process_request_body(term) :: body
+  @callback process_request_body(body) :: body
 
   @callback process_request_headers(headers) :: headers
 
   @callback process_request_options(options) :: options
 
+  @callback process_request_url(url) :: url
+
   @callback process_request_params(params) :: params
 
   @callback process_response(response) :: term
@@ -150,36 +152,40 @@ defmodule HTTPoison.Base do
 
   @callback process_response_chunk(binary) :: term
 
-  @callback process_status_code(integer) :: term
+  @callback process_response_headers(list) :: term
+
   @callback process_response_status_code(integer) :: term
 
-  @callback process_url(term) :: url
-  @callback process_request_url(term) :: url
+  # deprecated: Use process_response_status_code/1 instead
+  @callback process_status_code(integer) :: term
+
+  # deprecated: Use process_request_url/1 instead
+  @callback process_url(url) :: url
 
-  @callback put(binary) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback put(binary, term) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback put(binary, term, headers) ::
+  @callback put(url) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
+  @callback put(url, body) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
+  @callback put(url, body, headers) ::
               {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback put(binary, term, headers, options) ::
+  @callback put(url, body, headers, options) ::
               {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
 
-  @callback put!(binary) :: Response.t() | AsyncResponse.t()
-  @callback put!(binary, term) :: Response.t() | AsyncResponse.t()
-  @callback put!(binary, term, headers) :: Response.t() | AsyncResponse.t()
-  @callback put!(binary, term, headers, options) :: Response.t() | AsyncResponse.t()
+  @callback put!(url) :: Response.t() | AsyncResponse.t()
+  @callback put!(url, body) :: Response.t() | AsyncResponse.t()
+  @callback put!(url, body, headers) :: Response.t() | AsyncResponse.t()
+  @callback put!(url, body, headers, options) :: Response.t() | AsyncResponse.t()
 
-  @callback request(atom, binary) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback request(atom, binary, term) ::
+  @callback request(atom, url) :: {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
+  @callback request(atom, url, body) ::
               {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback request(atom, binary, term, headers) ::
+  @callback request(atom, url, body, headers) ::
               {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
-  @callback request(atom, binary, term, headers, options) ::
+  @callback request(atom, url, body, headers, options) ::
               {:ok, Response.t() | AsyncResponse.t()} | {:error, Error.t()}
 
-  @callback request!(atom, binary) :: Response.t() | AsyncResponse.t()
-  @callback request!(atom, binary, term) :: Response.t() | AsyncResponse.t()
-  @callback request!(atom, binary, term, headers) :: Response.t() | AsyncResponse.t()
-  @callback request!(atom, binary, term, headers, options) :: Response.t() | AsyncResponse.t()
+  @callback request!(atom, url) :: Response.t() | AsyncResponse.t()
+  @callback request!(atom, url, body) :: Response.t() | AsyncResponse.t()
+  @callback request!(atom, url, body, headers) :: Response.t() | AsyncResponse.t()
+  @callback request!(atom, url, body, headers, options) :: Response.t() | AsyncResponse.t()
 
   @callback start() :: {:ok, [atom]} | {:error, term}
 
@@ -219,7 +225,7 @@ defmodule HTTPoison.Base do
       @spec process_request_url(url) :: url
       def process_request_url(url), do: process_url(url)
 
-      @spec process_request_body(any) :: body
+      @spec process_request_body(body) :: body
       def process_request_body(body), do: body
 
       @spec process_request_headers(headers) :: headers
@@ -232,7 +238,7 @@ defmodule HTTPoison.Base do
       @spec process_request_options(options) :: options
       def process_request_options(options), do: options
 
-      @spec process_request_params(any) :: params
+      @spec process_request_params(params) :: params
       def process_request_params(params), do: params
 
       @spec process_response(response) :: any