Chatbase

Chatbase.com analytics API client written in ruby.

Installation

Gemfile RubyGems:

gem "chatbase"

Gemfile Github:

gem "booking-ruby", :git => 'https://github.com/RTJ/chatbase.git'

Bundler:

bundle install chatbase

Setup

Initialize the the gem by setting your Agent Key (agent_key).

eg: config/initializers/chatbase.rb

  Chatbase.agent_key = 'your-agent-api-key'

Usage

Generic Message API

req_params = {
    platform: "ruby-test",
    message: "Hello Chatbase from agent!",
    version: "1.0",
    type: "agent",
    user_id: "agent-01",
    time_stamp: DateTime.now.strftime('%Q'),
}

response = Chatbase::Message.new.send_message(req_params)

=> response.body

{"message_id": "1048441442", "status": 200}

Facebook Message API

    fb_params = {
        sender: {id: '1520833104112'},
        recipient: {id: '528195999812'},
        timestamp: DateTime.now.strftime('%Q'),
        message: {
            mid: "mid.1457764197618:41d102a3e1ae206a381",
            text: "hey test chatbot!"
        },
        chatbase_fields: {
            intent: "say-hi-intent",
            version: "1.01",
            not_handled: false,
            feedback: false
        }
    }

response = Chatbase::Message.new.send_fbmessage(fb_params)

=> response.body

{"message_id"=>"1052280268", "status"=>200}

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/RTJ/chatbase. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Chatbase project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.