Bitbucket v0.1.0 Bitbucket View Source

Documentation for Bitbucket.

Link to this section Summary

Functions

Take an existing URI and add addition params, appending and replacing as necessary

Same as authorization_header/2 but defaults initial headers to include @user_agent

There is only one way to authenticate through Bitbucket API v2.0

Issues a DELETE request to the given url

Issues a DELETE request to the given url, raising an exception in case of failure

Issues a GET request to the given url

Underlying utility retrieval function. The options passed affect both the return value and, ultimately, the number of requests made to GitHub

Issues a GET request to the given url, raising an exception in case of failure

Issues a HEAD request to the given url

Issues a HEAD request to the given url, raising an exception in case of failure

Issues an OPTIONS request to the given url

Issues a OPTIONS request to the given url, raising an exception in case of failure

Issues a PATCH request to the given url

Issues a PATCH request to the given url, raising an exception in case of failure

Issues a POST request to the given url

Issues a POST request to the given url, raising an exception in case of failure

Callback implementation for HTTPoison.Base.process_url/1

Issues a PUT request to the given url

Issues a PUT request to the given url, raising an exception in case of failure

Issues an HTTP request with the given method to the given url

Issues an HTTP request with the given method to the given url, raising an exception in case of failure

Starts HTTPoison and its dependencies

Requests the next message to be streamed for a given HTTPoison.AsyncResponse

Link to this section Types

Link to this section Functions

Link to this function

add_params_to_url(url, params) View Source
add_params_to_url(binary(), list()) :: binary()

Take an existing URI and add addition params, appending and replacing as necessary

Examples

iex> add_params_to_url("http://example.com/wat", [])
"http://example.com/wat"

iex> add_params_to_url("http://example.com/wat", [q: 1])
"http://example.com/wat?q=1"

iex> add_params_to_url("http://example.com/wat", [q: 1, t: 2])
"http://example.com/wat?q=1&t=2"

iex> add_params_to_url("http://example.com/wat", %{q: 1, t: 2})
"http://example.com/wat?q=1&t=2"

iex> add_params_to_url("http://example.com/wat?q=1&t=2", [])
"http://example.com/wat?q=1&t=2"

iex> add_params_to_url("http://example.com/wat?q=1", [t: 2])
"http://example.com/wat?q=1&t=2"

iex> add_params_to_url("http://example.com/wat?q=1", [q: 3, t: 2])
"http://example.com/wat?q=3&t=2"

iex> add_params_to_url("http://example.com/wat?q=1&s=4", [q: 3, t: 2])
"http://example.com/wat?q=3&s=4&t=2"

iex> add_params_to_url("http://example.com/wat?q=1&s=4", %{q: 3, t: 2})
"http://example.com/wat?q=3&s=4&t=2"
Link to this function

authorization_header(options) View Source

Same as authorization_header/2 but defaults initial headers to include @user_agent.

Link to this function

authorization_header(arg1, headers) View Source
authorization_header(Bitbucket.Client.auth(), list()) :: list()

There is only one way to authenticate through Bitbucket API v2.0:

  • OAuth2 Token

Examples

iex> Bitbucket.authorization_header(%{access_token: "92873971893"}, [])
[{"Authorization", "token 92873971893"}]

More info

https://developer.atlassian.com/bitbucket/api/2/reference/meta/authentication

Link to this function

delete(url, headers \\ [], options \\ []) View Source

Issues a DELETE request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function

delete!(url, headers \\ [], options \\ []) View Source

Issues a DELETE request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function

get(url, headers \\ [], options \\ []) View Source

Issues a GET request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function

get(path, client, params \\ [], options \\ []) View Source

Underlying utility retrieval function. The options passed affect both the return value and, ultimately, the number of requests made to GitHub.

Options:

  • :pagination - Can be :none, :manual, :stream, or :auto. Defaults to :auto :none will only return the first page. You won't have access to the headers to manually paginate. :auto will block until all the pages have been retrieved and concatenated together. Most of the time, this is what you want. For example, Bitbucket.Repositories.list_users("chrismccord") and Bitbucket.Repositories.list_users("octocat") have the same interface though one call will page many times and the other not at all. :stream will return a Stream, prepopulated with the first page. :manual will return a 3 element tuple of {page_body, url_for_next_page, auth_credentials}, which will allow you to control the paging yourself.

Issues a GET request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function

head(url, headers \\ [], options \\ []) View Source

Issues a HEAD request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function

head!(url, headers \\ [], options \\ []) View Source

Issues a HEAD request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function

json_request(method, url, body \\ "", headers \\ [], options \\ []) View Source
json_request(atom(), binary(), any(), keyword(), keyword()) :: response()

Link to this function

options(url, headers \\ [], options \\ []) View Source

Issues an OPTIONS request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function

options!(url, headers \\ [], options \\ []) View Source

Issues a OPTIONS request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function

patch(path, client, body \\ "") View Source
patch(binary(), Bitbucket.Client.t(), any()) :: response()

Callback implementation for HTTPoison.Base.patch/3.

Link to this function

patch(url, body, headers \\ [], options \\ []) View Source

Issues a PATCH request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function

patch!(url, body, headers \\ [], options \\ []) View Source

Issues a PATCH request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function

post(path, client, body \\ "") View Source
post(binary(), Bitbucket.Client.t(), any()) :: response()

Callback implementation for HTTPoison.Base.post/3.

Link to this function

post(url, body, headers \\ [], options \\ []) View Source

Issues a POST request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function

post!(url, body, headers \\ [], options \\ []) View Source

Issues a POST request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function

process_headers(headers) View Source

Callback implementation for HTTPoison.Base.process_headers/1.

Link to this function

process_request_body(body) View Source
process_request_body(any()) :: body()

Callback implementation for HTTPoison.Base.process_request_body/1.

Link to this function

process_request_headers(headers) View Source
process_request_headers(headers()) :: headers()

Callback implementation for HTTPoison.Base.process_request_headers/1.

Link to this function

process_request_options(options) View Source

Callback implementation for HTTPoison.Base.process_request_options/1.

Link to this function

process_response(resp) View Source
process_response(HTTPoison.Response.t()) :: response()

Link to this function

process_response_body(body) View Source
process_response_body(binary()) :: any()
process_response_body(binary()) :: term()

Callback implementation for HTTPoison.Base.process_response_body/1.

Link to this function

process_response_chunk(chunk) View Source

Callback implementation for HTTPoison.Base.process_response_chunk/1.

Link to this function

process_status_code(status_code) View Source

Callback implementation for HTTPoison.Base.process_status_code/1.

Callback implementation for HTTPoison.Base.process_url/1.

Link to this function

put(path, client, body \\ "") View Source

Callback implementation for HTTPoison.Base.put/3.

Link to this function

put(url, body \\ "", headers \\ [], options \\ []) View Source

Issues a PUT request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function

put!(url, body \\ "", headers \\ [], options \\ []) View Source

Issues a PUT request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function

raw_request(method, url, body \\ "", headers \\ [], options \\ []) View Source

Link to this function

request(method, url, body \\ "", headers \\ [], options \\ []) View Source
request(atom(), binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues an HTTP request with the given method to the given url.

This function is usually used indirectly by get/3, post/4, put/4, etc

Args:

  • method - HTTP method as an atom (:get, :head, :post, :put, :delete, etc.)
  • url - target url as a binary string or char list
  • body - request body. See more below
  • headers - HTTP headers as an orddict (e.g., [{"Accept", "application/json"}])
  • options - Keyword list of options

Body:

  • binary, char list or an iolist
  • {:form, [{K, V}, ...]} - send a form url encoded
  • {:file, "/path/to/file"} - send a file
  • {:stream, enumerable} - lazily send a stream of binaries/charlists

Options:

  • :timeout - timeout to establish a connection, in milliseconds. Default is 8000
  • :recv_timeout - timeout used when receiving a connection. Default is 5000
  • :stream_to - a PID to stream the response to
  • :async - if given :once, will only stream one message at a time, requires call to stream_next
  • :proxy - a proxy to be used for the request; it can be a regular url or a {Host, Port} tuple, or a `{:socks5, ProxyHost, ProxyPort} tuple
  • :proxy_auth - proxy authentication {User, Password} tuple
  • :socks5_user- socks5 username
  • :socks5_pass- socks5 password
  • :ssl - SSL options supported by the ssl erlang module
  • :follow_redirect - a boolean that causes redirects to be followed
  • :max_redirect - an integer denoting the maximum number of redirects to follow
  • :params - an enumerable consisting of two-item tuples that will be appended to the url as query string parameters

Timeouts can be an integer or :infinity

This function returns {:ok, response} or {:ok, async_response} if the request is successful, {:error, reason} otherwise.

Examples

request(:post, "https://my.website.com", "{\"foo\": 3}", [{"Accept", "application/json"}])
Link to this function

request!(method, url, body \\ "", headers \\ [], options \\ []) View Source

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

request!/5 works exactly like request/5 but it returns just the response in case of a successful request, raising an exception in case the request fails.

Link to this function

request_stream(method, url, auth, body \\ "", override \\ nil) View Source
request_stream(
  atom(),
  binary(),
  Bitbucket.Client.auth(),
  any(),
  :one_page | nil | :stream
) :: Enumerable.t() | response()

Link to this function

request_with_pagination(method, url, auth, body \\ "") View Source
request_with_pagination(atom(), binary(), Bitbucket.Client.auth(), any()) ::
  pagination_response()

Starts HTTPoison and its dependencies.

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

See request!/5 for more detailed information.