Popularity
1.6
Growing
Activity
0.0
Declining
3
1
4

Description

Clubhouse client library for Elixir πŸ§™β€β™‚οΈ

Uses Clubhouse REST API V3: https://clubhouse.io/api/rest/v3/

Monthly Downloads: 2,235
Programming language: Elixir
License: MIT License
Tags: JSON     REST And API     Third Party APIs     Http Client     API     Elixir     Clubhouse    
Latest version: v0.6.1

ExClubhouse alternatives and similar packages

Based on the "REST and API" category.
Alternatively, view ExClubhouse alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of ExClubhouse or a related project?

Add another 'REST and API' Package

README

ExClubhouse

build Coverage Status hex [license](LICENSE)

Clubhouse client library for Elixir πŸ§™β€β™‚οΈ

Uses Clubhouse REST API V3: https://clubhouse.io/api/rest/v3/

Installation

Add exclubhouse to your list of dependencies in mix.exs:

def deps do
  [
    {:exclubhouse, "~> 0.6.0"}
  ]
end

Setup and basic usage

1. Add an API token in your config

config :exclubhouse, 
  token: "xxxxx-xxxx-xxxx-xxx-xxx"

Here's CH help center doc on how to generate a CH API token

2. Use the API

alias ExClubhouse.{Api, Model}

epic_input = Input.Epic{ 
  name: "Your first Epic",
  description: "Some description for the epic"
} 

Api.Epic.create(epic_input) 

Output example:

{:ok,
 %ExClubhouse.Model.Epic{
   app_url: "https://app.clubhouse.io/kamehouse/epic/22",
   description: "Some description for the epic",
   id: 22,
   name: "Your first Epic",
   ...
   updated_at: "2020-03-15T21:43:04Z"
 }}

You can find all API grouped under ExClubhouse.Api

Custom usage

In some cases we want to use different tokens for the same call, use the response as-is or simply debug a call to the API using iEx. For those case we can build the API call like this:

  1. Build a session
  2. Create an operation
  3. Pass the operation and session to the client to make a request
  4. Parse the client's result

E.g.

alias ExClubhouse.{Api, Client, Session, Config, Model, Parse}

# 1. Get a default session from the config
sess = Config.default() |> Session.from()
# Or Build it passing the actual token
sess = %Session{token: "xxxxx-xxxx-xxxx-xxx-xxx"}

# 2. Build the operation
op = Ops.Epic.get(42)

# 3. Make the request
result = Client.HTTP.request(op, sess)

# 4 Parse the result
{:ok, %Model.Epic{} = epic42} = Parser.parse(result)

Design guidelines

Here's a list of design guidelines used in the project:

  • πŸ›ΈDon't hide anything, but make things easy: The lib can be used as Op+Client+Parser independently or through ExClubhouse.Api .
  • πŸ” Decouple operations, HTTP client and parsing: To allow people to use the lib as they need (e.g. with or without models/structs).
  • 🎁 Results are parsed and presented as structs: for easy pattern matching and usage.
  • πŸ„β€β™€οΈ Typespec surface API: Help make correct API calls.

Project roadmap

Current: v0.6.1

  • Fix for Story update #4

Previous

v0.6.0

  • File upload support added

v0.5.2

  • Search API added

v0.5.1

  • Integrate with Coveralls
  • Fixes bug on Label.stories_list/1 function
  • Increases test coverage to >80%

v0.5.0

  • Initial release

License

Please see [LICENSE](LICENSE) for licensing details.


*Note that all licence references and agreements mentioned in the ExClubhouse README section above are relevant to that project's source code only.