Added basic REST API to command center #175
Conversation
|
Hey @KamalGalrani, are you done with this PR or are you progressively committing changes? Once you are done committing changes will you let me know so I can review it? |
|
For now I am done with this. I want to add features which will need modification of other modules. Will make another pull request for those before I continue with the API. I'll mail you what I have in mind later. The Config.py changes you made in #176 may lead to unstable state when a user is logged in from multiple locations. It's better if we change the index from username to something session dependent. |
| @@ -0,0 +1,26 @@ | |||
| Microsoft BotFramework interface to LUCIDA | |||
| ========================================== | |||
|
|
|||
There was a problem hiding this comment.
@KamalGalrani can you add a description for the purpose of incorporating this botframework?
| ========================================== | ||
|
|
||
| ## Installation | ||
| * Change directory to $LUCIDAROOT/botframework-interface and run `npm install` |
There was a problem hiding this comment.
@KamalGalrani, do you think this should go in tools or added to some makefile to make it more automated?
| * Create a new bot at https://dev.botframework.com/bots/new | ||
| - Fill in Name, Bot handle and Description | ||
| - Messaging endpoint is the address of the PC running the interface. This has to be https endpoint. For testing purposes one can use ngrok. | ||
| * Install ngrok by typing `sudo apt-get install ngrok-client` in terminal |
There was a problem hiding this comment.
Add this to tools or have one script that installs all necessary packages.
| * You may want to add channels on the bot page. Follow the instructions on https://dev.botframework.com/bots. | ||
|
|
||
| ## Usage | ||
| * Change directory to $LUCIDAROOT/botframework-interface and run `node interface.js` |
There was a problem hiding this comment.
Create a makefile and add this?
| @@ -0,0 +1,6 @@ | |||
| // Copy application ID and password (as explained in README.md) and rename this file to credentials.js | |||
There was a problem hiding this comment.
I think it is okay to go ahead and name this file credentials.js and put in comments where the APP_ID and APP_PASSWORD should go that way we don't have to rely on people change the name of the file. What do you think?
There was a problem hiding this comment.
I prefer it this way because then we can put credentials.js in .gitignore and not worry abt passwords being pushed
There was a problem hiding this comment.
Okay sure, that makes complete sense.
README.md
Outdated
|
|
||
| #### Connect client user to Lucida user | ||
|
|
||
| This is a one time requiremnt. To connect client user to Lucida user is necessary before the API can process any messages. The flow is as follows |
There was a problem hiding this comment.
Not trying to be nit picky, but there is a type requiremnt should be requirement
README.md
Outdated
| ``` | ||
| curl -i -X POST -F "interface=facebook" -F "username=lucida_fb" -F "text_input=Who is this famous celebrity?" -F "file=@/path/to/file/celeb.jpg" http://localhost:3000/api/infer | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I LOVE all of this documentation. I'm wondering if we should include this in a wiki rather than this Readme since this Readme is a beast. We can leave it for now but eventually I think it would be good to make this readme more basic. What do you think?
There was a problem hiding this comment.
I didn't know there was a wiki. I'll put it there.
There was a problem hiding this comment.
Let me know if you don't have access to the wiki.
| @@ -0,0 +1,91 @@ | |||
| start_time = process.hrtime() | |||
There was a problem hiding this comment.
@KamalGalrani can you put some type of header saying what this file is for?
There was a problem hiding this comment.
This was fixed in 20d80ac. You probably didn't pull
| var hr_time = process.hrtime() | ||
| return time_offset + hr_time[0] + hr_time[1] / 1000000000; | ||
| } | ||
|
|
There was a problem hiding this comment.
@KamalGalrani, can you put all of this time logic (including lines 1-3) in the time function?
There was a problem hiding this comment.
This too was removed in 20d80ac.
| // Setup Restify Server | ||
| var server = restify.createServer(); | ||
| server.listen(3728, function () { | ||
| console.log("Listening to bot channels on port 3728..."); |
There was a problem hiding this comment.
@KamalGalrani, can you put this port in some sort of config file so we keep the programmable parts in one file? We eventually want to get rid of hardcoding ports.
| addresses[address.channelId] = {channelId: address.channelId, bot: {id: address.bot.id, name: address.bot.name}, serviceUrl: address.serviceUrl, useAuth: address.useAuth}; | ||
| request.post({ | ||
| headers: {'content-type' : 'application/x-www-form-urlencoded'}, | ||
| url: 'http://localhost:3000/api/infer', |
There was a problem hiding this comment.
@KamalGalrani, can we add this host to some config file as well?
| if ( result ) { | ||
| request.post({ | ||
| headers: {'content-type' : 'application/x-www-form-urlencoded'}, | ||
| url: 'http://localhost:3000/api/add_interface', |
There was a problem hiding this comment.
@KamalGalrani, same here. Can you add this to a config?
|
I am using phantomjs to automate setting of endpoint. This is particularly required while using ngrok as the endpoint because then you need to set endpoint at almost every run. Can someone please check what I am doing in set_endpoint.js legal. I didn't find any document by Microsoft saying it is illegal just that it is illegal to automate Google search this way so. |
|
|
||
| ## Start Interface | ||
| * Change directory to $LUCIDAROOT/botframework-interface and run `make start_server` | ||
| * First run will ask some questions. These can me modified later by editing 'config.sh'. |
| @@ -0,0 +1,7 @@ | |||
| all: | |||
| npm install | |||
There was a problem hiding this comment.
We need to add a check to make sure npm is installed and if it isn't then install it
| if ( retval == 0 ) { | ||
| console.log("[INFO] Verifying email address...") | ||
| } else { | ||
| console.log("[ERROR] Could not connect to Microsoft!!! Will try again in a second...") |
There was a problem hiding this comment.
For some reason when I run make start_server for the first time it repeatedly asks me for my BFW_ID and BFW_PW saying [ERROR] Could not connect to Microsoft!!! Will try again in a second... and it is happening at this line. Do you see this on your side?
There was a problem hiding this comment.
Works perfectly here. Follow the instructions I have mailed you and send me the screenshots.
There was a problem hiding this comment.
Tested in variety of scenarios from personal account, school account, incorrect email, incorrect password. From both India and US based servers. Works perfectly everytime. Couldn't try work account but as far as I know it's the same as school account.
There was a problem hiding this comment.
Are you able to access the url in browser. This seems more of a network issue. Also do send me a screen shot of terminal too. Remove your email id.
There was a problem hiding this comment.
Yes, I am able to go to the link. I'm wondering if it is my work network. I tried sshing into a linode instance and I'm getting a different error. The Network page is empty.
|
Added an option to skip automatic update of endpoint. |
|
The issue was with the phantomjs version from Ubuntu 14.04 repository. Fixed now. Just run |
| start_server: | ||
| bash start_interface.sh | ||
|
|
||
| .PHONY: all start_server |
There was a problem hiding this comment.
Can you add a clean function?
There was a problem hiding this comment.
For clean all you can do is delete node_modules folder. I'll add it anyway
| } | ||
| EOF | ||
|
|
||
| node interface.js $BFW_PORT $CC_HOST |
There was a problem hiding this comment.
node was not found for me. I had to put nodejs
There was a problem hiding this comment.
Forgot that in 14.04 node was called nodejs. Will fix this
| else | ||
| echo "" | ||
| echo "Do you want me to save password to file? It will be saved in plain text." | ||
| printf "BFW_SAVE_PWD [n]: " |
There was a problem hiding this comment.
Can you change BFW_SAVE_PWD [n]: to BFW_SAVE_PWD (y/n):
There was a problem hiding this comment.
[blah] is default value. (blah/blah) are options. Added both.
| while [ 1 ]; do | ||
| echo "" | ||
| echo "Enter messaging endpoint (https only) on which Lucida's BotFramework interface is running (e.g. 'https://xxx.ngrok.io'). URLs with exclaimation marks ('!') are not allowed." | ||
| echo "If you have no idea what this is you may press enter. Doing so will require you to enter your account password everytime you launch BotFramework interface or save it to config.sh" |
There was a problem hiding this comment.
I'm a little confused on what I should be doing here. Should I start ngork beforehand? Or by running $make start_server within botframework-interface am I the BotFramework interface for Lucida on a https server?
There was a problem hiding this comment.
It uses a running instance if ngrok is running. If not it starts ngrok
|
Hi Kamal,
For some reason I still can't get this to work on my machine here at work
or the linode. David got it working here on his machine so I don't think it
is the network. I am however sshing into both the linode and my machine.
Were you able to get it working on the linode? Here are the results I get:
On my machine at work:
I have attached screenshots of my config and my terminal for the
botframework interface.
I went through all of the steps and when I go to ping Lucida (
http://10.1.10.130:3000) via skype no message comes back. Also when I try
to verify (copying the code from Lucida and sending it through Skype) no
message comes back and on the Lucida side it has not seen any request.
On the linode:
I have attached screenshots of my config and my terminal for the
botframework interface. I am seeing an error message when running make
start_server. And since I'm sshing into the machine I am not able to login
to Microsoft.
Can you help?
Thanks!
…---
Saijel Mokashi
https://clinc.com
On Thu, May 25, 2017 at 2:44 AM, Kamal Galrani ***@***.***> wrote:
The issue was with the phantomjs version from Ubuntu 14.04 repository.
Fixed now. Just run make all once to update stuff.
—
You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub
<#175 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AZQku-w0VuqTsYlFmC--X1v9srshtbfFks5r9SNZgaJpZM4NSz6a>
.
|
|
Just a few notes:
On the linode, I eventually got an email from Microsoft saying that I had
to verify some logins. So now I am at the same stage as I am with my work
machine. I can't ping Lucida via Skype from a different machine.
Also, David said that he was able to access Lucida via Skype on any machine
after he verified it on the local machine first.
Any thoughts?
…---
Saijel Mokashi
https://clinc.com
On Thu, May 25, 2017 at 6:07 PM, Saijel Mokashi ***@***.***> wrote:
Hi Kamal,
For some reason I still can't get this to work on my machine here at work
or the linode. David got it working here on his machine so I don't think it
is the network. I am however sshing into both the linode and my machine.
Were you able to get it working on the linode? Here are the results I get:
On my machine at work:
I have attached screenshots of my config and my terminal for the
botframework interface.
I went through all of the steps and when I go to ping Lucida (
http://10.1.10.130:3000) via skype no message comes back. Also when I try
to verify (copying the code from Lucida and sending it through Skype) no
message comes back and on the Lucida side it has not seen any request.
On the linode:
I have attached screenshots of my config and my terminal for the
botframework interface. I am seeing an error message when running make
start_server. And since I'm sshing into the machine I am not able to login
to Microsoft.
Can you help?
Thanks!
---
Saijel Mokashi
https://clinc.com
On Thu, May 25, 2017 at 2:44 AM, Kamal Galrani ***@***.***>
wrote:
> The issue was with the phantomjs version from Ubuntu 14.04 repository.
> Fixed now. Just run make all once to update stuff.
>
> —
> You are receiving this because you were assigned.
> Reply to this email directly, view it on GitHub
> <#175 (comment)>,
> or mute the thread
> <https://github.com/notifications/unsubscribe-auth/AZQku-w0VuqTsYlFmC--X1v9srshtbfFks5r9SNZgaJpZM4NSz6a>
> .
>
|
|
I'll add a tutorial on how to go around the verifiy login problem |
|
I didn't find any screenshots |
|
Fixed for 14.04. |
|
Hi Kamal. I have an issue on this PR. I try your solution in the troubleshooting section 2 and it works. But there are still messages no response as shown in troubleshooting section 1. |
|
@KamalGalrani I am having 2 issues on my machine:
|
|
@saijel The problem you are facing is really weird. The only case I see it happen is in the case of network failure midway which is rare. Add these lines to the last step in set_endpoint.js just after the try catch block @zhexuanc @saijel Did you guys try sending from local Skype after messages from remote Skype were successful. This may be the problem that I have explained in README regarding loss of first few messages after endpoint update. Also try running from linnode copy under my user. Saijel knows the password. If its running there its some weird setup fault. |
|
@kamal, since it is working manually on my computer we'll just moved forward. And after doing the Firefox settings we are able to get it working remotely. I had one more fix that is needed and then we can merge this in. |
| fi | ||
| fi | ||
| done < <(netstat -peanut 2>/dev/null | grep LISTEN) | ||
| if [ -z $BFW_HOST ]; then |
There was a problem hiding this comment.
In my case on my local machine, I get an error start_interface.sh: line 278 [: too many arguments. When asking if[ -z $___ ] we need parenthesis around the variable like if[ -z "$___" ] because the variable could have spaces. Can you change all of the string checks to have ""?
There was a problem hiding this comment.
@KamalGalrani have you fixed this yet?
There was a problem hiding this comment.
Just fixed. Had slipped from my mind.
|
Now that this has been merged, shouldn't https://github.com/claritylab/lucida/wiki/REST-API be updated?
|
|
Done |
Basic API. Read REST API section in top level README