Project

ongair

0.0
No commit activity in last 3 years
No release in over 3 years
This API wrapper allows you to interact with the ongair.im API to receive and to send messages. (currently whatsapp only)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.8
~> 10.0

Runtime

~> 1.8.0
~> 1.0.0
 Project Readme

Ongair API wrapper

A ruby wrapper for the ongair.im API that allows you to send and receive chat messages.
Currently ongair supports whatsapp and wechat.

Installation

Add this line to your application's Gemfile:

gem 'ongair'

Or install it yourself as:

$ gem install ongair

Usage

  # configure your API token
  Ongair.configure do |c|
    c.token = ''
  end

  # receiving messages:
  message = Ongair::Message.new(params) # simply initialize a new message with the params from the ongair webhook
  message.type.image?
  message.text
  message.image
  # see lib/ongair/message.rb for details

  # sending messages (currently text and images are supported)
  message = Ongair::Message.new(phone_number: 'number', text: 'hello world') # initialize a new message with the params described in the ongair API
  message.deliver! # or message.deliver_to('4912345678')

Project Status:

experimental. It is simple and seems to work fine. But it is currently still lacking essential features and specs.

ToDo:

  • specs: please not this gem is currently experimental
  • support for more ongair message endpoints
  • support for handling contacts
  • support for groups
  • sending broadcasts
  • support for message receipts

Want to help? 💚


Built with love by @njirap and @bumi in Nairobi and released under the MIT-Licence.