jivesoftware / jive-sdk Goto Github PK

View Code? Open in Web Editor NEW

35.0 43.0 40.0 19.82 MB

This is an implementation of the Jive SDK written in Node.js using Express, mustache and other standard libraries.

Home Page: https://community.jivesoftware.com/community/developer

License: Apache License 2.0

JavaScript 88.68% CSS 3.05% HTML 7.84% ActionScript 0.06% Shell 0.36%

jive-sdk's Introduction

Jive Node SDK

This repository contains the Jive Node.js SDK to help you get started using the Jive Development Platform.

Let's get started

For instructions on installing and using the Jive Node SDK, refer to Getting Started with the Jive Node SDK in the Jive Community.

You can also access the API documentation here.

Enjoy!

License

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.

jive-sdk's People

Contributors

Stargazers

Watchers

jive-sdk's Issues

Replace relative image links with fully qualified paths in the docs

If you look at the NPM, all of the image links are broken. This is because NPM picks up the readme.md from github. However, because there are relative URLs in the docs, it tries to resolve everything at npm.org. Es no bueno.
https://npmjs.org/package/jive-sdk

Why is `*` used for version in package.json?

package.json entries (and docs suggesting those) tend to specify dependencies with * provided as version. As long as it's just Jive-made dependencies I could trust you not to introduce breaking changes ever, as a consequence of your choices, but it doesn't look like you own those two:

    "http-proxy": "*",
    "stream-array": "*"

I can shrinkwrap the app to deal with it, but why did you use * at all when there's ~ and ^?

extension creation meta from jiveclientconfiguration.json - defaults override settings

the order of arguments is incorrect in

jive-sdk/jive-sdk-service/lib/extension/extension.js

Line 228 in 3db75b7

var extensionMeta = _.defaults({

preventing the SDK user from overriding any defaults. eg. default icons.

BTW, even if that is fixed, the icon paths are relative to a script that puts them in extension data, so when overriding defaults starts working, the features need testing.

[Bug] in "sampletile-activity"

Problem

When using the intial demo an counter is shown as 'NaN'. See screenshots below.

Reproduce

just install the 'node create sampletile-activity' and install it.

exampleStore.json

{
  "count": {
    "key": "count",
    "count": null
  }
}

Possible solution

Replace null with 0 as initial value will fix it:

exampleStore.json

{
  "count": {
    "key": "count",
    "count": 0
  }
}

OAuth only working for the first time

The refresh token won't be saved correctly due to 'refresh_token' and 'refreshToken' as key value.

Fixed with this Pull Request

Add support for HTTPS in the server startup.

Add comment syncing to activity feed

Choose better icons (not CNN icons) for all examples in jive-sdk generated samples

rename jive_app.js to app.js to be more consistent with node convetions

A test issue to be closed soon

Testing with this issue.

Change generated "app" directory to "osapp" directory...

When the todo example is generated, the directory created that contains the app.xml and the other artifacts is "apps". However, this does not match the path that is resolved in the url, which is osapp, .e.g. http://host:port/osapp/todo/todos.html. This should be changed to provide consistency with between the code structure and the URL path that is used to resolve the artifacts.

Remove the jive-sdk-examples project

Because we've incorporated generating examples in the jive-sdk, the jive-sdk-examples is no longer needed.

Upgrade to express 4.0

http://scotch.io/bar-talk/expressjs-4-0-new-features-and-upgrading-from-3-0

How to get an activity by external ID

I'm facing the problem that I can't get a activity by external ID which in my case is a blocker. How can we solve this?

When automatically generating out the code, if the --name parameter is used, then then the app name in package.json should match

Example generator puts the wrong name in the sample data

[
{
"sampleData": {
"title": "Sample table",
"contents": [
{
"name": "Value",
"value": "Initial data"
}
]
},
"config": "http://bullcityjive.com:8090/configure",
"register": "http://bullcityjive.com:8090/registration",
"displayName": "mdw-example01",
"name": "mdw-example01",
"description": "mdw-example01 for dv4q5qnb99o7dgnawl7jpn7i8plrsnl8",
"style": "TABLE",

.....

The "title" should be the displayName + the style, e.g. "mdw-example01 table"

fs.rename doesn't work cross-filesystems

jive-sdk in example storage provider uses fs.rename to move files from /tmp/somejibberish to a target directory. Setting this up on a machine that has a separate filesystem for /tmp or a target dir for storage on a separate filesystem.

It is recommended to use mv module for node (available from npm) or enable an easy way to override temporary directory from the app.js level

readme example crashes and burns in Heroku

Hi, I am a Node N00b,
I followed the instructions in the readme doc in our Jive instance (in the developer sandbox, the add-ons tab sends me to a "No Services have been authorized").

Since we're behind a firewall, we were attempting to deploy the example app to heroku so that hosted Jive could communicate with it.

These are the steps that we followed:

Created example app as directed.
Successfully ran locally with node app.js
- app start
- success hitting http://<localip>:8090/tiles
Successfully ran locally with foreman start
- app start
- success hitting http://<localip>:8090/tiles
Changed jiveclientconfigurations.json to heroku app name and port 80
Created Procfile with web: node app.js
git push heroku master
heroku ps:scale web=1
App dies a terrible, fiery death
heroku logs
halp!

foo:jivetile-sample tiffany$ heroku logs
2013-11-19T19:30:09.460482+00:00 heroku[api]: Enable Logplex by [email protected]
2013-11-19T19:30:09.496274+00:00 heroku[api]: Release v2 created by [email protected]
2013-11-19T19:33:33+00:00 heroku[slug-compiler]: Slug compilation started
2013-11-19T19:33:52.486873+00:00 heroku[api]: Scale to web=1 by [email protected]
2013-11-19T19:33:52.505638+00:00 heroku[api]: Add PATH config by [email protected]
2013-11-19T19:33:52.534141+00:00 heroku[api]: Release v3 created by [email protected]
2013-11-19T19:33:52.600210+00:00 heroku[api]: Deploy 3827e93 by [email protected]
2013-11-19T19:33:52.636996+00:00 heroku[api]: Release v4 created by [email protected]
2013-11-19T19:33:52+00:00 heroku[slug-compiler]: Slug compilation finished
2013-11-19T19:33:56.166364+00:00 heroku[web.1]: Starting process with command `node app.js`
2013-11-19T19:33:57.450096+00:00 app[web.1]: [2013-11-19 19:33:57.449] [WARN] jive-sdk - File persistence is configured.
2013-11-19T19:33:57.449231+00:00 app[web.1]: [2013-11-19 19:33:57.446] [WARN] jive-sdk - ******************************
2013-11-19T19:33:57.450320+00:00 app[web.1]: [2013-11-19 19:33:57.450] [WARN] jive-sdk - Please note that this should
2013-11-19T19:33:57.450488+00:00 app[web.1]: [2013-11-19 19:33:57.450] [WARN] jive-sdk - not be used for production!
2013-11-19T19:33:57.450671+00:00 app[web.1]: [2013-11-19 19:33:57.450] [WARN] jive-sdk - ******************************
2013-11-19T19:33:57.476290+00:00 app[web.1]: [2013-11-19 19:33:57.475] [INFO] jive-sdk - Updating definition 'tablesample'
2013-11-19T19:33:57.553442+00:00 app[web.1]: [2013-11-19 19:33:57.553] [INFO] jive-sdk - Http node setup
2013-11-19T19:33:57.543379+00:00 app[web.1]: [2013-11-19 19:33:57.543] [INFO] jive-sdk - Running bootstrap.
2013-11-19T19:33:57.547478+00:00 app[web.1]: [2013-11-19 19:33:57.547] [WARN] jive-sdk - Starting service in HTTP mode
2013-11-19T19:33:57.889380+00:00 app[web.1]: [2013-11-19 19:33:57.889] [INFO] jive-sdk - 17342 total bytes written to extension archive  'extension.zip'
2013-11-19T19:33:57.895488+00:00 app[web.1]: [2013-11-19 19:33:57.895] [INFO] jive-sdk - Bootstrap complete.
2013-11-19T19:33:57.895488+00:00 app[web.1]: [2013-11-19 19:33:57.895] [INFO] jive-sdk - Jive SDK version 0.1.85
2013-11-19T19:33:57.897300+00:00 app[web.1]: [2013-11-19 19:33:57.897] [INFO] jive-sdk - Service started in development mode
2013-11-19T19:33:57.895712+00:00 app[web.1]: [2013-11-19 19:33:57.895] [INFO] jive-sdk - Started service in  'self-contained' 'mode'
2013-11-19T19:33:57.904119+00:00 app[web.1]:               ^
2013-11-19T19:33:57.903644+00:00 app[web.1]: events.js:72
2013-11-19T19:33:57.903494+00:00 app[web.1]: 
2013-11-19T19:33:57.903913+00:00 app[web.1]:         throw er; // Unhandled 'error' event
2013-11-19T19:33:57.904959+00:00 app[web.1]:     at _fulfilled (/app/node_modules/q/q.js:880:54)
2013-11-19T19:33:57.904959+00:00 app[web.1]:     at resolvedValue.promiseDispatch.done (/app/node_modules/q/q.js:910:30)
2013-11-19T19:33:57.904959+00:00 app[web.1]: Error: listen EACCES
2013-11-19T19:33:57.904959+00:00 app[web.1]:     at makePromise.promise.promiseDispatch (/app/node_modules/q/q.js:559:13)
2013-11-19T19:33:57.904959+00:00 app[web.1]:     at Server._listen2 (net.js:1020:19)
2013-11-19T19:33:57.904959+00:00 app[web.1]:     at errnoException (net.js:901:11)
2013-11-19T19:33:57.904959+00:00 app[web.1]:     at listen (net.js:1061:10)
2013-11-19T19:33:57.904959+00:00 app[web.1]:     at startServer (/app/app.js:40:45)
2013-11-19T19:33:57.904959+00:00 app[web.1]:     at Server.listen (net.js:1127:5)
2013-11-19T19:33:57.904959+00:00 app[web.1]:     at Object._onImmediate (/app/node_modules/q/q.js:438:41)
2013-11-19T19:33:57.905145+00:00 app[web.1]:     at processImmediate [as _immediateCallback] (timers.js:330:15)
2013-11-19T19:33:59.168391+00:00 heroku[web.1]: Process exited with status 8
2013-11-19T19:33:59.191562+00:00 heroku[web.1]: State changed from crashed to starting
2013-11-19T19:33:59.190089+00:00 heroku[web.1]: State changed from starting to crashed
2013-11-19T19:34:02.096446+00:00 heroku[web.1]: Starting process with command `node app.js`
2013-11-19T19:34:03.244489+00:00 app[web.1]: [2013-11-19 19:34:03.241] [WARN] jive-sdk - ******************************
2013-11-19T19:34:03.245006+00:00 app[web.1]: [2013-11-19 19:34:03.244] [WARN] jive-sdk - Please note that this should
2013-11-19T19:34:03.245080+00:00 app[web.1]: [2013-11-19 19:34:03.244] [WARN] jive-sdk - not be used for production!
2013-11-19T19:34:03.244908+00:00 app[web.1]: [2013-11-19 19:34:03.244] [WARN] jive-sdk - File persistence is configured.
2013-11-19T19:34:03.245160+00:00 app[web.1]: [2013-11-19 19:34:03.245] [WARN] jive-sdk - ******************************
2013-11-19T19:34:03.265621+00:00 app[web.1]: [2013-11-19 19:34:03.264] [INFO] jive-sdk - Updating definition 'tablesample'
2013-11-19T19:34:03.322545+00:00 app[web.1]: [2013-11-19 19:34:03.322] [INFO] jive-sdk - Running bootstrap.
2013-11-19T19:34:03.326150+00:00 app[web.1]: [2013-11-19 19:34:03.326] [WARN] jive-sdk - Starting service in HTTP mode
2013-11-19T19:34:03.331063+00:00 app[web.1]: [2013-11-19 19:34:03.330] [INFO] jive-sdk - Http node setup
2013-11-19T19:34:03.608062+00:00 app[web.1]: [2013-11-19 19:34:03.607] [INFO] jive-sdk - 17342 total bytes written to extension archive  'extension.zip'
2013-11-19T19:34:03.611409+00:00 app[web.1]: [2013-11-19 19:34:03.611] [INFO] jive-sdk - Bootstrap complete.
2013-11-19T19:34:03.611496+00:00 app[web.1]: [2013-11-19 19:34:03.611] [INFO] jive-sdk - Jive SDK version 0.1.85
2013-11-19T19:34:03.611615+00:00 app[web.1]: [2013-11-19 19:34:03.611] [INFO] jive-sdk - Started service in  'self-contained' 'mode'
2013-11-19T19:34:03.613213+00:00 app[web.1]: [2013-11-19 19:34:03.613] [INFO] jive-sdk - Service started in development mode
2013-11-19T19:34:03.618549+00:00 app[web.1]: 
2013-11-19T19:34:03.618670+00:00 app[web.1]: events.js:72
2013-11-19T19:34:03.619086+00:00 app[web.1]:               ^
2013-11-19T19:34:03.618939+00:00 app[web.1]:         throw er; // Unhandled 'error' event
2013-11-19T19:34:03.619871+00:00 app[web.1]:     at startServer (/app/app.js:40:45)
2013-11-19T19:34:03.619871+00:00 app[web.1]:     at Object._onImmediate (/app/node_modules/q/q.js:438:41)
2013-11-19T19:34:03.619871+00:00 app[web.1]:     at Server.listen (net.js:1127:5)
2013-11-19T19:34:03.619871+00:00 app[web.1]: Error: listen EACCES
2013-11-19T19:34:03.619871+00:00 app[web.1]:     at errnoException (net.js:901:11)
2013-11-19T19:34:03.619871+00:00 app[web.1]:     at Server._listen2 (net.js:1020:19)
2013-11-19T19:34:03.619871+00:00 app[web.1]:     at listen (net.js:1061:10)
2013-11-19T19:34:03.620072+00:00 app[web.1]:     at processImmediate [as _immediateCallback] (timers.js:330:15)
2013-11-19T19:34:03.619871+00:00 app[web.1]:     at makePromise.promise.promiseDispatch (/app/node_modules/q/q.js:559:13)
2013-11-19T19:34:03.619871+00:00 app[web.1]:     at _fulfilled (/app/node_modules/q/q.js:880:54)
2013-11-19T19:34:03.619871+00:00 app[web.1]:     at resolvedValue.promiseDispatch.done (/app/node_modules/q/q.js:910:30)
2013-11-19T19:34:04.805639+00:00 heroku[web.1]: Process exited with status 8
2013-11-19T19:34:20.668490+00:00 heroku[router]: at=error code=H10 desc="App crashed" method=GET path=/tiles host=protected-headland-5950.herokuapp.com fwd="74.85.255.17" dyno= connect= service= status=503 bytes=
2013-11-19T19:34:04.820878+00:00 heroku[web.1]: State changed from starting to crashed
2013-11-19T19:34:42.322900+00:00 heroku[router]: at=error code=H10 desc="App crashed" method=GET path=/favicon.ico host=protected-headland-5950.herokuapp.com fwd="74.85.255.17" dyno= connect= service= status=503 bytes=
2013-11-19T19:34:20.905108+00:00 heroku[router]: at=error code=H10 desc="App crashed" method=GET path=/favicon.ico host=protected-headland-5950.herokuapp.com fwd="74.85.255.17" dyno= connect= service= status=503 bytes=
2013-11-19T19:34:45.497920+00:00 heroku[router]: at=error code=H10 desc="App crashed" method=GET path=/favicon.ico host=protected-headland-5950.herokuapp.com fwd="74.85.255.17" dyno= connect= service= status=503 bytes=
2013-11-19T19:34:42.116862+00:00 heroku[router]: at=error code=H10 desc="App crashed" method=GET path=/favicon.ico host=protected-headland-5950.herokuapp.com fwd="74.85.255.17" dyno= connect= service= status=503 bytes=
2013-11-19T19:34:41.915334+00:00 heroku[router]: at=error code=H10 desc="App crashed" method=GET path=/ host=protected-headland-5950.herokuapp.com fwd="74.85.255.17" dyno= connect= service= status=503 bytes=

Replace relative image links with fully qualified paths in the docs

rework current oauth2 implementation to use passport.

See: http://passportjs.org/guide/configure/

incorrect commandline arguments documented

in app.js the comments say to pass config=/path... while service.js looks for configFile argument

create a real activity feed example

esf template fails

First issue is a dependency for Log4js missing from the package.json.
Second issue appears when add-on is correctly deployed and configured in the add-on console. When then setting up a place to use the external storage Jive pops up a red error banner and the node.js server console reports Error: No Community found by the TenantId: http://localhost:8080

I was running a local Jive developer instance so the community reported was localhost:8080

Create comment syncing example

Make service/generator/jive-sdk.js autogen the valid options (they're hard coded now)

var validTypes = ['all', 'activity', 'tile', 'example' ];
var validCommands = ['create','help'];
var validTileStyles = ['list', 'gauge', 'table' ];
var validExamples = ['bitcoin'];

All those values need to be introspected from the directories under service/generator/template

simple stream object.description does not display

This is a long shot, but I thought i would try... :)
simple stream add-on example as the following description property for activities
// Optional HTML description of activity. Remove if n/a.
activityInfo.object.description = body.description;

No matter what I do this never works. Hard coding, etc. Nothing.
Might any kind soul have an idea why this does nothing?

Add jive.service.analytics API Class to Streamline Add-On Access to Analytics APIs

Add CALENDAR view style to the set of auto-generated examples

jive.community.doRequest looks for community for no reason

When a request is being done, one of the steps is finding the community

jive-sdk/jive-sdk-api/lib/community/community.js

Line 277 in 08b05f1

 return exports.findByCommunity(community['jiveCommunity']).then( function( community ) { 

the retrieved community variable is checked for not being null and never used again.
If I override the .findByCommunity to return a truthily-resolved promise, it just works and makes the query.

apphosting="jive" Not Creating /extension_src/public assets for non-Tile-App Tile Types

In theory, non-tile-app tiles shouldn't (normally) have add-on assets hosted via Jive, as most of them are hosted via the middleware. In theory though the Action/Configuration actions could be stored in the add-on ... and the SDK doesn't smartly detect and include accordingly.

See: https://community.jivesoftware.com/message/1609174#1609174

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.