FyydEx

⚠️ WORK IN PROGRESS: A basic wrapper for the Fyyd API.

Usage

😊 User

# by id
{:ok, user} = Fyyd.user(2078)
{:ok, user} = Fyyd.user("2078")

# or by nick
{:ok, user} = Fyyd.user_by_nick("optikfluffel")

📂 Curations

# for a specific User
{:ok, curations} = Fyyd.curations_for_user(2078)
{:ok, curations} = Fyyd.curations_for_user("2078")
{:ok, curations} = Fyyd.curations_for_user_by_nick("optikfluffel")

# including Episodes
{:ok, curations} = Fyyd.curations_for_user(2078, include: :episodes)
{:ok, curations} = Fyyd.curations_for_user("2078", include: :episodes)
{:ok, curations} = Fyyd.curations_for_user_by_nick("optikfluffel", include: :episodes)

📚 Collections

# for a specific User
{:ok, collections} = Fyyd.collections_for_user(2078)
{:ok, collections} = Fyyd.collections_for_user("2078")
{:ok, collections} = Fyyd.collections_for_user_by_nick("optikfluffel")

# including Podcasts
{:ok, collections} = Fyyd.collections_for_user(2078, include: :podcasts)
{:ok, collections} = Fyyd.collections_for_user("2078", include: :podcasts)
{:ok, collections} = Fyyd.collections_for_user_by_nick("optikfluffel", include: :podcasts)

👤 Account

Authentication is needed for these, so you have to obtain an access_token first.

See github.com/eazyliving/fyyd-api#authorization for details.

{:ok, account} = Fyyd.account_info(access_token)
{:ok, curations} = Fyyd.account_curations(access_token)
{:ok, collections} = Fyyd.account_collections(access_token)

Development

• Install dependencies with mix do deps.get, deps.compile
• Run tests with mix test
• Run coverage reporting with mix coveralls
• Check Typespecs with mix dialyzer
• To continuously run tests, coverage and type checking while developing run mix test.watch