GitHub REST API Client v0.3.2

View Source GitHub.Auth.Cache (GitHub REST API Client v0.3.2)

Optional caching process for GitHub App and Installation tokens

This cache uses a local ETS table to store tokens, so they are not shared across a cluster. However, this is generally okay, as multiple tokens can be used for the same GitHub App or Installation at the same time.

Assuming the expiration time given to this cache is correct, it will automatically handle invalidating tokens both periodically and on-demand.

usage

 Usage

To enable caching, include this module in your application's top-level supervisor:

# application.ex
defmodule MyApp.Application do
  use Application

  def start(_type, _args) do
    children = [
      # ...
      GitHub.Auth.Cache
    ]

    opts = [strategy: :one_for_one, name: MyApp.Supervisor]
    Supervisor.start_link(children, opts)
  end
end

Link to this section Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get(key)

Get a previously stored value if unexpired

put(key, expiration, value)

Set a value in the cache

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

get(key)

View Source 
@spec get(term()) :: {:ok, term()} | :error

Get a previously stored value if unexpired

Here the key is presumed to be {:app, app_id} or {:installation, installation_id}, though any key will work. Returns :error if the key is not found or if the stored value has expired.

Link to this function

put(key, expiration, value)

View Source 
@spec put(term(), integer(), term()) :: :ok

Set a value in the cache

Here the key is presumed to be {:app, app_id} or {:installation, installation_id}, though any key will work. The expiration must be a Unix timestamp (seconds since Jan 1, 1970).