GitHub Issues v0.1.9 GitHub.Issues

Fetches a list of issues from a GitHub project.

Summary

Functions

Fetches issues from a GitHub project of a given user

Returns a URL based on user and project

Types

issue()
issue() :: map

Functions

fetch(user, project, options \\ [])
fetch(String.t, String.t, Keyword.t) ::
  {:ok, [issue]} |
  {:error, String.t}

Fetches issues from a GitHub project of a given user.

Returns a tuple of either {:ok, [issue]} or {:error, text}.

Parameters

  • user - GitHub user
  • project - GitHub project
  • options - URL template (keyword)

Options

  • :url_template - defaults to config value :url_template (string)

Examples

alias GitHub.Issues
Issues.fetch("laravel", "elixir")
url(url_template, user, project)

Returns a URL based on user and project.

Parameters

  • url_template - URL template
  • user - user
  • project - project

Examples

iex> alias GitHub.Issues
iex> app = Mix.Project.config[:app]
iex> url_template = Application.get_env(app, :url_template)
iex> Issues.url(url_template, "laravel", "elixir")
"https://api.github.com/repos/laravel/elixir/issues"

iex> alias GitHub.Issues
iex> url_template = "elixir-lang.org/<project>/{user}/wow"
iex> Issues.url(url_template, "José", "Elixir")
"elixir-lang.org/Elixir/José/wow"