Flickrex (flickrex v0.8.1) View Source

Performs Flickr API requests.

Examples

operation = Flickrex.Flickr.Photos.get_recent(per_page: 5)
config = [url: "https://flickr-proxy.example.com"]

{:ok, resp} = Flickrex.request(operation, config)

Link to this section Summary

Functions

request(operation, opts \\ [])

Performs a Flickr API request.

request!(operation, opts \\ [])

Performs a Flickr API request. Raises on failure.

Link to this section Functions

request(operation, opts \\ [])

Specs

request(Flickrex.Operation.t(), Keyword.t()) ::
  {:ok, Flickrex.Response.t()} | {:error, term()}

Performs a Flickr API request.

Options

consumer_key - Flickr API consumer key.
consumer_secret - Flickr API consumer secret.
oauth_token - Flickr user access token.
oauth_token_secret - Flickr user access token secret.
url - API Endpoint URL.
http_client - HTTP client module. See Flickrex.Request.HttpClient.
http_opts - HTTP client options.
json_decoder - Decoder module for REST JSON responses.
rest_decoder - Decoder module for REST XML responses.

These options can be configured for all operations in your Mix config file:

config :flickrex, :config, [
  consumer_key:    "...",
  consumer_secret: "...",
]

These options can also be overriden for each service:

config :flickrex, :api, url: "https://api-proxy.example.com"
config :flickrex, :upload, url: "https://upload-proxy.example.com"

request!(operation, opts \\ [])

Specs

request!(Flickrex.Operation.t(), Keyword.t()) :: term() | no_return()

Performs a Flickr API request. Raises on failure.

See request/2.