First version for GitHub.

.gitignore

@@ -0,0 +1,5 @@
+vendor
+.DS_Store
+**/dist/
+**/node_modules/
+*npm-debug.log

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+## Contributing
+
+Fork and submit pull requests as usual.
+

LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2015 IBM
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -0,0 +1,79 @@
+## Conference Plan Bot
+
+The *Conference Plan Bot* is a serverless, event-driven, bot built on the [OpenWhisk open source project](http://openwhisk.org/).
+
+An instance is running on the hosted OpenWhisk environment provided by IBM Bluemix. It has an associated Cloud Foundry app at http://owplan.mybluemix.net/ which provides the schedule UI, and two proxy services for handling Twitter integration and IoT device reading API calls.
+
+The bot is designed to reply to user tweets that request conference schedule information with real time data on sessions and room conditions. It's currently configured for the O'Reilly Open Source Convention (OSCON) which runs from May 16th to May 20th
+
+For example, if you tweeted [@owplan](https://twitter.com/owplan) with the keywords "serverless, bot, Docker, containers" you'd get back a list of sessions at OSCON conference matching those terms for each day.
+
+![Tweet example](docs/tweet-example.png)
+
+You can read more about bots, serverless programming, and the motivation for the Conference Plan Bot on the blog post at [developerWorks Open](https://developer.ibm.com/open/2016/05/12/openwhisk-planner/).
+
+## Installation
+
+Detailed instructions are pending. For now, explore `devops/create-update-actions.sh` and the individual action code in the `openwhisk/actions/js` folder. These describe the microservices built for the demo, and represent actions of moderate complexity that are broken into several files and use promises to handle asynchronous processing.
+
+Your primary workflow after setup will be editing actions in JavaScript, compiling them if they consist of more than one file (or have third party NPMs not provided by your OpenWhisk environment), and uploading them.
+
+To get started with an OpenWhisk bot running on Bluemix, you will need to do the following:
+
+- Provision prerequisite services
+  - Log into Bluemix, request access to OpenWhisk (if still in a closed beta)
+  - Create two services. Free tiers are sufficient for both. You can create them directly in Bluemix or via the service provider directly.
+    - Cloudant - Provides a NoSQL database for the three Cloudant databases: `room`, `schedule`, and `tweet`.
+    - SendGrid - Provides an email interface for Twitter which can then invoke the `tweet-fetch` action.
+  - Create a Twitter account for your bot and an associated application in order to use the API.
+- Work with the OpenWhisk code
+  - `git clone` this repository.
+  - Option 1: Set up a development environment with Vagrant
+    - `cd` to the `owplan/devops` folder
+    - Run `vagrant up`
+    - `vagrant ssh` to the node
+    - Install the OpenWhisk CLI
+    - Review the NPM packages that you might have to install in `devops/setup-workstation.sh`
+  - Option 2: Set up a development on your Mac/Windows/Linux workstation
+    - Install the OpenWhisk CLI
+    - Review the NPM packages that you might have to install in `devops/setup-workstation.sh`
+  - Modify the configuration files and settings for each action.
+    - Cloudant - The `cloudant-config.json` file within each relevant action folder.
+    - Twitter - The `twitter-config.json` file within each relevant action folder.
+    - Replace each instance of `[email protected]_space` for your Bluemix account.
+  - Run the builds and install the OpenWhisk actions with `devops/create-update-actions.sh`
+  - Verify actions, triggers, rules with
+    - `wsk action list`
+    - `wsk trigger list`
+    - `wsk rule list`
+- Work with the associated Cloud Foundry application
+  - Create the Cloud Foundry app on Bluemix, which provide the schedule UI for the bot to link to.
+    - Install the Cloud Foundry CLI
+    - Go to the `web` directory, modify `web/manifest.yml` as needed
+    - Run `cf push` to upload the PHP application to Bluemix.
+- Set up the Arduino device
+  - Procure an Arduino UNO R3, WiFi shield, and Digital Hygrometer/Thermometer.
+  - Assemble the hardware.
+  - Install the Arduino IDE for your workstation or VM
+  - Load the `iot/room/room.ino` file, edit the WiFi settings and your Bluemix app endpoint, then verify and upload it to the Arduino via USB.
+  - Make sure it's emitting data and your proxy app is collecting data.
+
+
+## Architectural decisions
+- The actions in a sequence are currently invoked manually from within each microservice. This could be done as a sequence to decouple the linkage of actions, but we'd have less control over error handling. Cloudant could also be used more completely as a state machine to trigger actions, but we moved away from that approach to improve performance.
+- Twitter does not integrate well with Twilio for sending text messages for incoming mentions. Therefore we use a SendGrid managed email address to achieve a similar goal of notification when a tweet is received.
+- There is still a need for a Bluemix Cloud Foundry app to provide the complex schedule UI and proxy requests to the Cloudant database from the Arduino sensors and from SendGrid. The proxies could be replaced by API Connect, API Registration, or Watson IoT services from the Bluemix catalog. The big challenge is handling SSL and mapping API requests directly to the OpenWhisk API.
+
+## TODO
+- [ ] Complete the installation instructions, including how to download dependencies not included in this repository.
+- [ ] Move strings and other OSCON specifics to properties files to enable reusability for other events.
+- [ ] Add sparklines to show room temperature trends over time, as a way to predict some room conditions in the future, such as baseline temperature at a certain hour.
+- [ ]
+
+## Contributors
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## License
+
+See [LICENSE](LICENSE) for details. This demo is built with dependencies on several NPM packages, Bootstrap, and Arduino hardware libraries. You'll need to include those separately to build a working instance of this bot.

devops/Vagrantfile

@@ -0,0 +1,23 @@
+VM_MEMORY = 2*1024
+VM_CORES = 1
+
+Vagrant.configure('2') do |config|
+
+  config.vm.provider :virtualbox do |v, override|
+    v.customize ["modifyvm", :id, "--memory", VM_MEMORY]
+    v.customize ["modifyvm", :id, "--cpus", VM_CORES]
+  end
+
+  config.vm.define "openwhisk" do |openwhisk|
+    openwhisk.vm.hostname='openwhisk'
+
+    # Download a Ubuntu image before starting.
+    openwhisk.vm.box = "ubuntu/trusty-server-cloudimg-amd64"
+
+    # Edit as necessary.
+    openwhisk.vm.synced_folder "/Users/user/owplan", "/home/vagrant/owplan"
+
+    openwhisk.ssh.insert_key = true
+  end
+
+end

devops/create-schedule-rule.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# This script is used to set up the alarm that runs at the top of each hour to load the conference schedule.
+# An action is linked to a trigger by a rule.
+
+# Create trigger to run once an hour. By default, the alarm will only run 1,000 times.
+wsk trigger create schedule-trigger --feed /whisk.system/alarms/alarm --param cron '* 0 * * *' --param maxTriggers 10000
+
+# Ensure the trigger is created before creating the rule.
+sleep 1
+
+# Create the rule linking the trigger to the action.
+wsk rule create --enable schedule-update-rule schedule-trigger schedule-update
+
+# Verify trigger and rule.
+wsk trigger list
+wsk rule list

devops/create-update-actions.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# This script both creates and updates actions, assuming a Vagrant VM used as an OpenWhisk client. 
+# Run it as is or modify to to update a specific action.
+actions=( "schedule-update" "tweet-fetch" "tweet-insert" "tweet-analyze" "schedule-recommend" "schedule-render" "tweet-update" "tweet-reply")
+for action in "${actions[@]}"
+do
+	cd /home/vagrant/owplan/actions/js/$action
+	npm run build
+	wsk action update $action dist/bundle.js
+done

devops/setup-workstation.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# Set up your Ubuntu Vagrant VM for OpenWhisk action development. 
+# This may vary according to your own development environment preferences.
+
+# Create a Node 0.12 environment for local development.
+curl -sL https://deb.nodesource.com/setup_0.12 | sudo -E bash -
+sudo apt-get install -y nodejs
+sudo npm cache clean
+sudo npm install npm -g
+
+# Install some global prerequisite packages. You may have to do this per action when first building them.
+sudo npm install -g webpack
+npm install --save-dev webpack babel-core babel-loader babel-preset-es2015 json-loader
+npm run build