Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 1.24 KB

README.md

File metadata and controls

62 lines (46 loc) · 1.24 KB
Raw

Zuck

Installation

The package can be installed by adding zuck to your list of dependencies in mix.exs:

def deps do
  [{:zuck, git: "https://github.com/boudra/zuck.git"}}]
end

Configuration

config :zuck, 
  app_id: "",
  app_secret: "",
  log: true,
  debug: true,
  version: "v2.9",
  endpoint: "https://graph.facebook.com/",
  http: [] # these will be passed to hackney

Roadmap

  • Batch requests
  • Real time updates
  • Facebook messenger

Usage

Basic example

{:ok, user} = Zuck.get("/me", %{
  access_token: "TOKEN",
  fields: "name,email"
})

Pagination trough streams

You can use the stream helpers to handle multipage data, very useful when getting ad insights or large lists of data, the stream will handle the cursor and make the necesary requests for you:

Zuck.get_stream("/act_ACCOUNT_ID/insights", %{
  access_token: "TOKEN",
  level: "ad",
  date_preset: "yesterday",
  fields: "ad_name"
})
|> Enum.map(fn ad -> ad.ad_name end)

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/zuck.