Project

planga

0.0
No commit activity in last 3 years
No release in over 3 years
Ruby Wrapper for interacting with the Planga Chat Service.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 1.1
 Project Readme

Planga Ruby Wrapper:

Planga Planga Docs Gem Build Status RubyDoc

Installation

Global installation: gem install planga or, for installation in a single project, add

gem 'planga', '~> 0.6.0'

to your Gemfile.

Example usage

require 'planga'

planga = Planga.new(
        # These stay the same for all chats:
        :public_api_id => "b5fc4092f05c70445fb758caac5027ca",
        :private_api_key => "ePxoM3OTkW1z6j84JDurqw",
        # These change based on the current user:
        :conversation_id => "general",
        :current_user_id => "1234",
        :current_user_name => "Bob",
    )

snippet = planga.chat_snippet()

For more information on what the different fields mean, see the main Planga.io documentation (until more detailed Ruby-specific documentation has been written).

For a guide that goes into a little bit more details, see Building Live Chat Between Users in a Rails application using Planga.io

Requirements:

  • Ruby >= 2.4.1
  • The Planga gem

Steps to build and Deploy a new version of the gem:

(This is only interesting if you want to make a fork of this Gem)

NOTE: We've set up Travis-CI to build a new version of the official gem whenever a tagged commit is made

  • run gem build planga.gemspec
  • run gem push planga-n.n.n.gem