0.0
No commit activity in last 3 years
No release in over 3 years
Interact with the Bottle API in ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

>= 0
 Project Readme

.bottle_ruby

Interact with the Bottle API in ruby.

Description

Bottle is a work messenger. This is an API that allows you to send messages via Bottle programatically in Ruby.

How It Works

Installing

  $ gem install bottle_ruby

Initialize a Client

The first step is to initialize a Bottle::Client object.

client = Bottle::Client.new(uid, token)

Creating a Message

Next, you need to initialize a Bottle::Message object with the message information.

#  Bottle::Message.new(information_hash)
message = Bottle::Message.new(to: '555-555-5555', name: 'Recipient Name', body: 'Body of message', tags: ['tag1', 'tag2'])

You can also initialize a message using a conversation_id instead of a to phone number.

message = Bottle::Message.new(conversation_id: 100, name: 'Recipient Name', body: 'Body of message', tags: ['tag1', 'tag2'])

Sending a Message

Then, you send the message using the client object.

client = Bottle::Client.new(uid, token)
message = Bottle::Message.new(conversation_id: 100, name: 'Recipient Name', body: 'Body of message', tags: ['tag1', 'tag2'])
message.send(client)

Creating a Conversation

Initialize a Bottle::Conversation object with the conversation information.

client = Bottle::Client.new(uid, token)
conversation = Bottle::Conversation.new(phone: '555-555-5555', name: 'Contact Name', tags: ['tag1', 'tag2'])
result = conversation.send(client)

Alternatively, you can initialize a conversation using a @handle instead of a phone number.

conversation = Bottle::Conversation.new(handle: 'BottleBot', tags: ['tag1', 'tag2'])

Contributors

Will Schreiber