https://github.com/ymtszw/hipchat_elixir

[DISCONTINUED] HipChat client library for Elixir
https://github.com/ymtszw/hipchat_elixir

elixir hipchat hipchat-elixir hipchat-swagger

Last synced: about 2 months ago
JSON representation

[DISCONTINUED] HipChat client library for Elixir

• Host: GitHub
• URL: https://github.com/ymtszw/hipchat_elixir
• Owner: ymtszw
• License: mit
• Archived: true
• Created: 2016-12-19T17:54:18.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-05-07T03:25:20.000Z (about 5 years ago)
• Last Synced: 2024-04-16T11:28:26.554Z (2 months ago)
• Topics: elixir, hipchat, hipchat-elixir, hipchat-swagger
• Language: Elixir
• Homepage:
• Size: 76.2 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• awesome-elixir - hipchat_elixir - HipChat client library for Elixir, based on httpc. (Chatting)
• freaking_awesome_elixir - Elixir - HipChat client library for Elixir, based on httpc. (Chatting)
• fucking-awesome-elixir - hipchat_elixir - HipChat client library for Elixir, based on httpc. (Chatting)

README

        
# :warning: DISCONTINUATION NOTICE

[HipChat itself is discontinued by Atlassian due to their partnership with Slack](https://www.atlassian.com/partnerships/slack).

This Elixir library is therefore no longer maintained, and goes archive. Thanks for your interest though! :heart:

# hipchat_elixir

[![Hex.pm](https://img.shields.io/hexpm/v/hipchat_elixir.svg)](https://hex.pm/packages/hipchat_elixir)

[![CircleCI](https://circleci.com/gh/ymtszw/hipchat_elixir/tree/master.svg?style=svg)](https://circleci.com/gh/ymtszw/hipchat_elixir/tree/master)

HipChat client library for [Elixir](http://elixir-lang.org).

- [API Documentation](https://hexdocs.pm/hipchat_elixir)

## Policy

- Using Erlang's built-in `httpc` as HTTP client, for easier dependency management.

- No state. Access tokens and other credentials should be retrieved/stored by caller applications.

- Relying on HipChat cloud for parameter validations.

- Covering APIs used in server side only.

- Generating codes from Swagger (OpenAPI) specifications in [ymtszw/hipchat_swagger](https://github.com/ymtszw/hipchat_swagger).

    - Read more in [here][contributions].

[contributions]: https://hexdocs.pm/hipchat_elixir/contribution.html

## Basic Usage

0. Add [`:hipchat_elixir`](https://hex.pm/packages/hipchat_elixir) as a dependency.

1. Create client struct (`Hipchat.ApiClient.new/3`).

    - Pass `access_token` if the targeted API requires authentication.

    - See [here](https://hexdocs.pm/hipchat_elixir/authentication.html) for details.

2. Pass the resultant client and other parameters to the targeted API function.

  ```elixir

  Hipchat.ApiClient.new("access_token")

  |> Hipchat.V2.Rooms.send_room_notification("room_id", %{message: "Hello HipChat!"})

  # {:ok, %Hipchat.Httpc.Response{body: "", headers: ..., status: 204}}

  ```

## About `Content-Type`

Request bodies are sent as `content-type: application/json` or

`content-type: x-www-form-urlencoded` depending on `:serializer` config value.

- See [`config/config.exs`](https://github.com/ymtszw/hipchat_elixir/blob/master/config/config.exs) for example.

- Some HipChat APIs (implicitly) require `content-type: application/json`,

  so **introducing JSON serializer is almost mandatory**.

    - Currently only supports [`Poison`](https://github.com/devinus/poison).

## Status

Basic chat related APIs (CRUD operation of rooms/users, sending messages/notifications, etc) are covered.

Many add-on (extension) related APIs are not covered.

Since HipChat itself is sunsetting and moving toward [Stride](https://www.stride.com/),

I may not revisit to perfect these. If interested, [contributions] are welcomed.

Only supports HipChat cloud (not HipChat server).

# License

MIT