janis-ai 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95489d4cd6e6526cf764f8403d96f078a68b0d8b
-  data.tar.gz: 9a85fc4a4e916081807163c3764398ba9afd3fb4
+  metadata.gz: 4609b248d7ae8150b0f88c7affa945b4e9e9ea0a
+  data.tar.gz: 7ab1556e2aaffda24704971e14c9efeabbb4f922
 SHA512:
-  metadata.gz: 4e07d6a975c63435d58de5376c3709dad6168a857a4f6f87fdb8cb60ccb8bc3d8d210dd3e0a4ab18f2bb7901763593607ea2ffc60b77c84fe99e25d4bd6be8db
-  data.tar.gz: 9fab1d850db851cdfb64f1cc919086336804efd33bd4f639ace2dea2bb23382c47c3254100f4e22da4ac85a5366d7a00f6e8e5eda893588b0add63383ee483f8
+  metadata.gz: 7b787ead334e1fc07547fae719c3eed3b5e796f0ba6cbd2500afe17bb3a2e5c6bd9d321ecbfa3ac25319512a32b705904b6da49b5ca27be77085ff37401219ff
+  data.tar.gz: da63e866c10e921dd09c392cb11b75d0a125456713ac2cdb1e91c6ecba4c9bea2f673d1df780e1b1a637284507f6ea09a1c9f6dcf7f31036e7f421d958bb8872

data/README.md

@@ -1,30 +1,29 @@
-# [janis](https://www.janis.ai) - SDK For Human + AI Conversational Experiences
-## For Bots Built in Ruby
+# [Janis](https://www.Janis.ai) - Message Management
+## For Chatbots built with Ruby
 
-Bots enable businesses to respond to customers immediately but they often fail to understand user intent.  According to Facebook, bots fail 70% of the time. janis helps solve this problem with a toolkit to easily keep humans in the loop when AI fails your customers.    The solution includes an SDK for bot developers to connect their bots to Slack, and a Slack app to get alerts, then pause and take over a bot.
+Janis helps teams train and monitor bots and fix problems fast.  [Build a bot in Ruby](./examples/) and integrate Janis with just a few lines of code to ensure delightful conversational experiences in every messaging channel.
 
-![Solution](https://cloud.githubusercontent.com/assets/7429980/22609969/491afe58-ea31-11e6-8928-27e1a1f1d6bd.png)
+##### Train
+Collaborate on what users say and your responses in a dedicated training channel. Experience exactly what your users will experience when they message you.
 
+##### Monitor
+Janis alerts you in Slack when your bot needs your help. Use our smart alerts, or create your own alerts to bring humans in the loop.
 
+##### Fix Problems Fast
+Take over for your bot and chat live to retain your users, while training your AI to learn from the conversation. Hand control back to your bot when you're done.
 
-You can integrate janis in minutes and it begins working immediately, enabling you to deliver exceptional human + AI conversational experiences.
-This module has been tested with Messenger, Slack, Skype, and Microsoft Webchat. Please see our [examples](./examples/).
-It supports bot developers working in Node, Python and Ruby.
-
-### What you can do with janis:
-You can view a full list of features at (https://www.janis.ai).  It's core purpose can be explained with this single GIF  
-
-![Takeover](https://cloud.githubusercontent.com/assets/7429980/22609935/22e39740-ea31-11e6-8286-e5a3ae545565.gif)
+To learn more about Janis' capabilities, visit [Janis.ai](https://www.janis.ai)
 
 ### What you need to get started:
-* [A Slack Account](http://www.slack.com)
-* [janis for Slack](https://slack.com/oauth/authorize?scope=users:read,users:read.email,commands,chat:write:bot,chat:write:user,channels:read,channels:history,files:write:user,channels:write,bot&client_id=23850726983.39760486257)
+* [Add Janis to your Slack team](https://www.janis.ai)
 * [A Chatbot built in Ruby](./examples/)
 
 ##### Operational Dependencies:
-1.  You'll need an API key from janis and for each Chatbot a Bot Token.  You can get both of those (free) when you add janis to Slack and through a conversation with janis. 
-2.  If you're building a Messenger Chatbot, you'll need to setup a Facebook App, Facebook Page, get the Page Access Token from Facebook and link the Facebook App to the Facebook Page for janis to work.
+1.  You'll need an API key and a Client Key for your Chatbot.  You can get both of those (free) when you add Janis to Slack. 
+2.  If you're building a Messenger Chatbot, you'll need to setup a Facebook App, Facebook Page, get the Page Access Token from Facebook and link the Facebook App to the Facebook Page for Janis to work. This is standard for any Chatbot you build for Messenger.
+3.  Janis can help you train your AI from Slack.  Currently Dialogflow, formerly known as API.AI (http://www.api.ai) is supported.
 
+Note: This module has been tested with Messenger, Slack, Skype, and Microsoft Webchat. Please see our [examples](./examples/).
 
 ### Installation
 
@@ -176,5 +175,5 @@ Go back to Slack and wait for alerts. That's it!
 
 
 ### Looking for something we don't yet support?  
-* [Join our mailing list and we'll notifiy you](https://www.janis.ai/contact.html)
+* [Join our mailing list and we'll notifiy you](https://www.janis.ai)
 * [Contact Support](mailto:support@janis.ai)

data/lib/janis.rb

@@ -5,22 +5,28 @@ require 'httparty'
 module Janis
 
     
-    class Partay
+    class Janiapi
         include HTTParty
-        base_uri 'https://wordhopapi.herokuapp.com/api/v1'
+        base_uri 'https://janis.ai/api/v1'
+    end
+
+    class FBApi
+        include HTTParty
+        base_uri 'https://graph.facebook.com/v2.6/me'
     end
     
     EVENTS = [:'chat response', :'socket_id_set', :'channel update'].freeze
     
     class << self
     
-        attr_accessor :apikey, :clientkey, :token, :platform
+        attr_accessor :apikey, :clientkey, :token, :platform, :options
 
         def initialize
             @apikey
             @clientkey
             @token
             @platform
+            @options
         end
         
         def new(*args, &block)
@@ -45,6 +51,10 @@ module Janis
         def platform
             @platform ||= "messenger"
         end
+
+        def janisappid
+            @janisappid = 1242623579085955
+        end
         
         def headers
             @headers = {'apikey':apikey,'clientkey':clientkey,'platform':platform, 'token': token}
@@ -59,11 +69,11 @@ module Janis
         socket.on :socket_id_set do |data|
             socket_id = data
             x = {'socket_id': socket_id, 'clientkey': JANIS_CLIENT_KEY}
-            options = {
+            data = {
                 body: x,
                 headers: headers
             }
-            Partay.post('/update_bot_socket_id', options)
+            Janiapi.post('/update_bot_socket_id', data)
         end
 
         socket.on :'chat response' do |data|
@@ -94,28 +104,48 @@ module Janis
         end
 
         def hopIn(x)
-            puts 'hopIn'
-            options = {'body':x, 'headers':headers}
-            return Partay.post('/in', options)
+            data = {'body':x, 'headers':headers}
+            return Janiapi.post('/in', data)
         end
             
         def hopOut(x)
-            puts 'hopOut'
-            options = {'body':x, 'headers':headers}
-            return Partay.post('/out', options)
+            data = {'body':x, 'headers':headers}
+            return Janiapi.post('/out', data)
         end
             
         def logUnknownIntent(x)
-            puts 'logUnknownIntent'
-            options = {'body':x, 'headers':headers}
-            return Partay.post('/unknown', options)
+            data = {'body':x, 'headers':headers}
+            return Janiapi.post('/unknown', data)
         end
             
         def assistanceRequested(x)
-            puts 'assistanceRequested'
-            options = {'body':x, 'headers':headers}
-            return Partay.post('/human', options)
+            data = {'body':x, 'headers':headers}
+            return Janiapi.post('/human', data)
+        end
+
+        def passThreadControl(x)
+            message = x['message']
+            recipientid = x['recipient']['id']
+            appid = message['app_id']
+            is_echo = message['is_echo']
+            if message['is_echo'] && (appid == janisappid || appid.nil?)
+                
+                # If an agent responds via the Messenger Inbox, then `appId` will be null.
+                # If an agent responds from Janis on Slack, the `appId` will be 1242623579085955.
+                # In both cases, we should pause your bot by giving the thread control to Janis.
+                # Janis will pass control back to your app again after 10 minutes of inactivity.
+                # If you want to manually pass back control, use the slash command `/resume`
+                # in the Janis transcript channel, or press "Done" in the Page Inbox on the thread.
+                
+                # See: https://developers.facebook.com/docs/messenger-platform/handover-protocol#app_roles
+                # This app should be the Primary Receiver. Janis should be a Secondary Receiver.
+                # Every time an echo from either Janis or the Page Inbox is received,
+                # this app passes control over to Janis so the humans are the only ones who can respond.
+                j = {"recipient": {"id": recipientid}, "target_app_id": janisappid, "metadata": "passing thread"}
+                uri = "/pass_thread_control?access_token=" + token
+                return FBApi.post(uri, {'body':j})
+            end
+            return false
         end
     end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: janis-ai
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael Nathanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies: []
 description: "Chatbots allow you scale your customer communications through messaging,
   \n  \tautomating tasks and enabling transactions, but they can't empathize like