planga 0.0.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6ffe01fdbb613efb04c25f71e7e0b973412d111
-  data.tar.gz: 6a8aecf7e8bb6f3e7445dbf946ddda833f2d0494
+  metadata.gz: e12d35f94be4c97a00dd851adef3f5ec093b6d1f
+  data.tar.gz: 5e1e66cf22db3239d17dc53a29c895cc7fc995ac
 SHA512:
-  metadata.gz: '09e511265f1ed2993bb4c812b934db8904b1058d44f01f38a70e4e59048dc805ff4bb0faebc0b662d58352fb11297a8a11f46087a0e76b9e05cb60e21d26adab'
-  data.tar.gz: 69549f8ff033da9a7bf0e0f26bcbd10b118325f7ed2521cd7e361418430759b822c329efb014c44fb1c62bb2b4fda521cd35ff6d1d454281035e7a00751ba6a5
+  metadata.gz: 2ba888e4fe368156d775e7f5c7d50d8a86e259e2737c1aef48373104cc0c37964e83585be3175629e49a78b0ae606ce524b109d72f283c09ec974da17179bd3b
+  data.tar.gz: daf392c96dc10e331802fe42a5f98dbde0a8ea5e208951b34b9eff2137adcef348fc274a7397b238e86c90bb5ce1bf5fb4fa12182a6835cc914a4fe8b837a096

data/README.md

@@ -5,6 +5,15 @@ Planga Ruby Wrapper:
 [![Planga Docs](https://img.shields.io/badge/planga-docs-lightgrey.svg)](http://www.planga.io/docs)
 [![Gem](https://img.shields.io/gem/v/planga.svg)](https://rubygems.org/gems/planga)
 
+**Installation**
+
+Global installation:
+`gem install planga`
+or, for installation in a single project, add
+```
+gem 'planga', '~> 0.5.0'
+```
+to your Gemfile.
 
 **Example usage**
 
@@ -12,28 +21,34 @@ Planga Ruby Wrapper:
 require 'planga'
 
 planga = Planga.new(
-        :public_api_id => "foobar",
+        # 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",
-        :container_id => "my_container_div"
     )
 
 snippet = planga.chat_snippet()
 ```
 
+For more information on what the different fields mean, see the [main Planga.io documentation](https://planga.io/docs) (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](https://medium.com/@renevanpelt/building-live-chat-between-users-in-a-rails-application-91bc3a33b545)
+
+
 **Requirements:**
 
 * Ruby >= 2.4.1
-* gem
+* The Planga gem
 
-**Build and Deploy new gem:**
 
-* run `gem build planga.gemspec`
-* run `gem push planga-n.n.n.gem`
 
-**Installing the new 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)_
 
-* run `gem install planga`
 
+* run `gem build planga.gemspec`
+* run `gem push planga-n.n.n.gem`

data/lib/planga.rb

@@ -2,11 +2,35 @@ require 'securerandom'
 require 'jose'
 require 'json'
 
+# This class allows you to create a snippet of HTML/JS that,
+# if included in a webpage, lets the visitor of that webpage
+# connect with the Planga Chat Server and start chatting.
 class Planga
     attr_accessor :public_api_id, :private_api_key, :conversation_id,
-        :current_user_id, :current_user_name, :container_id, :remote_host
+        :current_user_id, :current_user_name, :container_id, :remote_host, :debug
 
     
+    # The following configuration options are available:
+    #
+    # Required are:
+    #
+    # * public_api_id: The public API ID that can be found in the Planga Dashboard.
+    # * private_api_key: The private API key that can be found in the Planga Dashboard.
+    # * conversation_id: The identifier that uniquely identifies the single conversation
+    #     that the user can connect with in this chat. Examples would be "general", "product/1234" or "private/123/543".
+    # * current_user_id: The internal ID your application uses, which uniquely identifies
+    #     the user currently using your application.
+    # * current_user_name: The name of this user. This name is shown in the chat interface
+    #     next to the typed messages
+    #
+    # Optional are:
+    # 
+    # * remote_host: This can point to another host, if you are hosting your own instance of Planga.
+    #     It defaults to the URL of Planga's main chat server. (`//chat.planga.io`)
+    # * container_id: If you want a custom HTML ID attribute specified to the created HTML element, 
+    #    you can enter it here.
+    # * debug: (defaults to `false`).
+    #
     def initialize(**conf)
         @public_api_id = conf[:public_api_id]
         @private_api_key = conf[:private_api_key]
@@ -15,6 +39,7 @@ class Planga
         @current_user_name = conf[:current_user_name]
         @container_id = conf[:container_id]
         @remote_host = conf[:remote_host] || "//chat.planga.io"
+	@debug = conf[:debug] || false
 
         if not container_id
             @container_id = "planga-chat-" + SecureRandom.hex
@@ -22,6 +47,7 @@ class Planga
     end
     
 
+    # Creates a full-fledged HTML snippet that includes Planga in your page.
     def chat_snippet
         return %{
             <script type=\"text/javascript\" src=\"#{self.remote_host}/js/js_snippet.js\"></script>
@@ -29,16 +55,20 @@ class Planga
             <script type=\"text/javascript\">
                new Planga(document.getElementById(\"#{self.container_id}\"), \{
                    public_api_id: \"#{self.public_api_id}\",
-                   encrypted_options: \"#{encrypt_options()}\",
+                   encrypted_options: \"#{encrypted_options()}\",
                    socket_location: \"#{self.remote_host}/socket\",
+                   debug: #{self.debug},
                \});
             </script>
         }
     end
     
 
-    private
-    def encrypt_options
+    # Returns the encrypted configuration.
+    #
+    # This function is useful if (and only if) you do not want to use the normal chat snippet,
+    # but want to completely customize how Planga loads (so you want to create it manually).
+    def encrypted_options
         key = JOSE::JWK.from({"k" => self.private_api_key, "kty" => "oct"})
 
         payload = {
@@ -53,4 +83,4 @@ class Planga
                 { "alg" => "A128GCMKW", "enc" => "A128GCM" }
             ).compact
     end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planga
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Wiebe Marten Wijnja
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jose
@@ -25,15 +25,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-description: Wrapper for interacting with the Planga chat server.
-email: 
+description: Ruby Wrapper for interacting with the Planga Chat Service.
+email: contact@planga.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - lib/planga.rb
-homepage: https://github.com/ResiliaDev/Planga
+homepage: https://github.com/ResiliaDev/planga-ruby
 licenses:
 - MIT
 metadata: {}
@@ -53,8 +53,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Planga
+summary: Ruby Wrapper for the Planga Chat Service
 test_files: []