deadkarma / keenex

Keen.io API Client for Elixir

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Keenex

{:keenex, "~> 0.2.0"}

Documentation

Usage:

looks for application variables in the :keen app named :project_id, :write_key, :read_key or if any of those aren't available, it looks for environment variables named KEEN_PROJECT_ID, KEEN_WRITE_KEY, KEEN_READ_KEY

{:ok, keen} = Keenex.start_link

alternatively, you can pass in the variables as well

{:ok, keen} = Keenex.start_link("keen_project_id", "keen_write_key", "keen_read_key") 

then pass in the keen pid when calling functions

{status, response} = Keenex.EventCollections.post("dinner.tacos", %{test: "tacos"})

status is either :ok or :error

response is a Map converted from the json response from Keen.

For info about the content of the results, check out the Keen API reference

Contributing

Requirements

Install/Update dependencies

Run all test:

$ azk shell -- mix do deps.get, compile

Test

  • Run all test:
$ azk shell -- mix test
# or
$ azk shell
mix test

About

Keen.io API Client for Elixir


Languages

Language:Elixir 92.8%Language:JavaScript 7.2%