Packages

dealer

0.1.2
0.8.0 0.7.2 0.7.1 0.7.0 0.6.1 0.6.0 0.5.0 0.4.1 0.4.0 0.3.1 0.3.0 0.2.1 0.2.0 0.1.2 0.1.1 0.1.0 0.0.1

An API Client for Stockfighter.

Current section

Files

Jump to
Readme
17 Versions
2 Dependencies
Dependants
Files
Activity
dealer lib dealer venue.ex
Raw

lib/dealer/venue.ex 

defmodule Dealer.Venue do

  @moduledoc """

  Venues related API.

  """



  @endpoint "/ob/api/venues/:venue/heartbeat"



  @type t :: %__MODULE__ {

    ok: boolean,

    venue: String.t,

    error: String.t

  }



  import Dealer, only: [build_path: 2]



  defstruct ok: false, venue: "", error: ""



  @spec heartbeat(String.t) :: Dealer.Response | {:error, term}

  @doc "Check the venue is up"

  def heartbeat(venue) do

    build_path(@endpoint, %{venue: venue})

    |> Dealer.get

    |> Dealer.Response.new(%{as: __MODULE__})

  end

end