Packages

tentacat

0.5.2
2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.1 2.0.0 1.6.1 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.9.0 0.8.0 0.7.2 0.7.1 0.7.0 0.6.2 0.6.1 0.6.0 0.5.3 0.5.2 0.5.1 0.5.0 0.4.0 0.3.1 0.3.0 0.2.1 0.2.0 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Simple Elixir wrapper for the GitHub API

HexDocs

Current section

Files

Jump to
Readme
38 Versions
2 Dependencies
Dependants
Files
Activity
tentacat lib tentacat commits.ex
Raw

lib/tentacat/commits.ex 

defmodule Tentacat.Commits do

  import Tentacat

  alias Tentacat.Client



  @doc """

  List commits on a repository



  ## Example



      Tentacat.Commits.list("elixir-lang", "elixir", client)



  More info at: https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

  """

  @spec list(binary, binary, Client.t) :: Tentacat.response

  def list(owner, repo, client \\ %Client{}) do

    get "repos/#{owner}/#{repo}/commits", client

  end



  @doc """

  Get a single commit



  ## Example



      Tentacat.Commits.find("6dcb09b", "elixir-lang", "elixir", client)



  More info at: http:\\developer.github.com/v3/repos/releases/#get-a-single-commit

  """

  @spec find(any, binary, binary, Client.t) :: Tentacat.response

  def find(sha, owner, repo, client \\ %Client{}) do

    get "repos/#{owner}/#{repo}/commits/#{sha}", client

  end



  @doc """

  Compare two commits



  ## Example



      Tentacat.Commits.compare(base, head, "elixir-lang", "elixir", client)



  More info at: https://developer.github.com/v3/repos/commits/#compare-two-commits

  """

  @spec compare(any, any, binary, binary, Client.t) :: Tentacat.response

  def compare(base, head, owner, repo, client \\ %Client{}) do

    get "repos/#{owner}/#{repo}/compare/#{base}...#{head}", client

  end

end