├── .env.example
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── app.js
├── package.json
├── public
├── css
│ └── common.css
├── images
│ ├── C2QB_green_btn_lg_default.png
│ └── quickbooks_logo_horz.png
└── index.html
└── views
├── Ratesample.png
├── Thumbdown.png
└── Thumbup.png
/.env.example:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | PORT=
5 | NGROK_ENABLED= true
6 |
7 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 | yarn-debug.log*
6 | yarn-error.log*
7 |
8 | # Runtime data
9 | pids
10 | *.pid
11 | *.seed
12 | *.pid.lock
13 |
14 | # Directory for instrumented libs generated by jscoverage/JSCover
15 | lib-cov
16 |
17 | # Coverage directory used by tools like istanbul
18 | coverage
19 |
20 | # nyc test coverage
21 | .nyc_output
22 |
23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24 | .grunt
25 |
26 | # Bower dependency directory (https://bower.io/)
27 | bower_components
28 |
29 | # node-waf configuration
30 | .lock-wscript
31 |
32 | # Compiled binary addons (http://nodejs.org/api/addons.html)
33 | build/Release
34 |
35 | # Dependency directories
36 | node_modules/
37 | jspm_packages/
38 |
39 | # Typescript v1 declaration files
40 | typings/
41 |
42 | # Optional npm cache directory
43 | .npm
44 |
45 | # Optional eslint cache
46 | .eslintcache
47 |
48 | # Optional REPL history
49 | .node_repl_history
50 |
51 | # Output of 'npm pack'
52 | *.tgz
53 |
54 | # Yarn Integrity file
55 | .yarn-integrity
56 |
57 | # dotenv environment variables file
58 | .env
59 |
60 | # config variables
61 | config.json
62 |
63 | # idea files
64 | .idea/
65 |
66 | # DS Store files
67 | .DS_Store
68 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 |
3 | node_js:
4 | - 7
5 | - 6
6 |
7 | before_script:
8 | - npm install
9 | script:
10 | - node app.js &
11 | - npm test
12 |
13 | after_script: NODE_ENV=test istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright 2018 Intuit, Inc.
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | [][ss1][][ss2][][ss3]
3 |
4 |
5 | Intuit OAuth2.0 Sample - NodeJS
6 | ==========================================================
7 |
8 | ## Overview
9 |
10 | This is a `sample` app built using Node.js and Express Framework to showcase how to Authorize and Authenticate using Intuit's OAuth2.0 Client library.
11 |
12 | ## Installation
13 |
14 | ### Requirements
15 |
16 | * [Node.js](http://nodejs.org) >= 8.x.
17 | * [Intuit Developer](https://developer.intuit.com) Account
18 |
19 | ### Via Github Repo (Recommended)
20 |
21 | ```bash
22 | $ npm install
23 | ```
24 |
25 | ## Configuration
26 |
27 | Copy the contents from `.env.example` to `.env` within the sample directory:
28 | ```bash
29 | $ cp .env.example .env
30 | ```
31 | Edit the `.env` file to add your:
32 |
33 |
34 | * **PORT:(optional)** Optional port number for the app to be served
35 | * **NGROK_ENABLED:(optional)** By default it is set to `false`. If you want to serve the Sample App over HTTPS ( which is mandatory if you want to test this app using Production Credentials), set the variable to `true`
36 |
37 |
38 |
39 | ### TLS / SSL (**optional**)
40 |
41 | If you want your enpoint to be exposed over the internet. The easiest way to do that while you are still developing your code locally is to use [ngrok](https://ngrok.com/).
42 |
43 | You dont have to worry about installing ngrok. The sample application does that for you.
44 | 1. Just set `NGROK_ENABLED` = `true` in `.env`
45 |
46 |
47 | ## Usage
48 |
49 | ```bash
50 | $ npm start
51 | ```
52 |
53 | ### Without ngrok (if you are using localhost i.e `NGROK_ENABLED`=`false` in `.env`)
54 | You will see an URL as below:
55 | ```bash
56 | 💳 See the Sample App in your browser : http://localhost:8000
57 | 💳 Copy this into Redirect URI on the browser : http://localhost:8000/callback
58 | 💻 Make Sure this redirect URI is also copied on your app in : https://developer.intuit.com
59 | ```
60 |
61 | ### With ngrok (if you are using ngrok i.e `NGROK_ENABLED`=`true` in `.env`)
62 |
63 | Your will see an URL as below :
64 | ```bash
65 | 💻 See the Sample App in your browser: https://9b4ee833.ngrok.io
66 | 💳 Copy and paste this Redirect URI on the browser : https://9b4ee833.ngrok.io/callback
67 | 💻 Make Sure this redirect URI is also copied on your app in : https://developer.intuit.com
68 | ```
69 |
70 | Click on the URL and follow through the instructions given in the sample app.
71 |
72 |
73 | ## Links
74 |
75 | Project Repo
76 |
77 | * https://github.com/IntuitDeveloper/OAuth2.0-demo-nodejs
78 |
79 | Intuit OAuth2.0 API Reference
80 |
81 | * https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0
82 |
83 | Intuit OAuth2.0 Playground
84 |
85 | * https://developer.intuit.com/v2/ui#/playground
86 |
87 | ## Contributions
88 |
89 | Any reports of problems, comments or suggestions are most welcome.
90 |
91 | Please report these on [Issue Tracker in Github](https://github.com/IntuitDeveloper/OAuth2.0-demo-nodejs/issues).
92 |
93 | [ss1]: #
94 | [ss2]: https://customersurveys.intuit.com/jfe/form/SV_9LWgJBcyy3NAwHc?check=Yes&checkpoint=Intuit-OAuth2.0-Sample-NodeJS&pageUrl=github
95 | [ss3]: https://customersurveys.intuit.com/jfe/form/SV_9LWgJBcyy3NAwHc?check=No&checkpoint=Intuit-OAuth2.0-Sample-NodeJS&pageUrl=github
96 |
--------------------------------------------------------------------------------
/app.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | require('dotenv').config();
4 |
5 | /**
6 | * Require the dependencies
7 | * @type {*|createApplication}
8 | */
9 | var express = require('express');
10 | var app = express();
11 | var path = require('path');
12 | var OAuthClient = require('intuit-oauth');
13 | var bodyParser = require('body-parser');
14 | var ngrok = (process.env.NGROK_ENABLED==="true") ? require('ngrok'):null;
15 |
16 |
17 | /**
18 | * Configure View and Handlebars
19 | */
20 | app.use(bodyParser.urlencoded({extended: true}));
21 | app.use(express.static(path.join(__dirname, '/public')));
22 | app.engine('html', require('ejs').renderFile);
23 | app.set('view engine', 'html');
24 | app.use(bodyParser.json())
25 |
26 | var urlencodedParser = bodyParser.urlencoded({ extended: false });
27 |
28 | /**
29 | * App Variables
30 | * @type {null}
31 | */
32 | var oauth2_token_json = null,
33 | redirectUri = '';
34 |
35 |
36 | /**
37 | * Instantiate new Client
38 | * @type {OAuthClient}
39 | */
40 |
41 | var oauthClient = null;
42 |
43 |
44 | /**
45 | * Home Route
46 | */
47 | app.get('/', function(req, res) {
48 |
49 | res.render('index');
50 | });
51 |
52 | /**
53 | * Get the AuthorizeUri
54 | */
55 | app.get('/authUri', urlencodedParser, function(req,res) {
56 |
57 | oauthClient = new OAuthClient({
58 | clientId: req.query.json.clientId,
59 | clientSecret: req.query.json.clientSecret,
60 | environment: req.query.json.environment,
61 | redirectUri: req.query.json.redirectUri
62 | });
63 |
64 | var authUri = oauthClient.authorizeUri({scope:[OAuthClient.scopes.Accounting],state:'intuit-test'});
65 | res.send(authUri);
66 | });
67 |
68 |
69 | /**
70 | * Handle the callback to extract the `Auth Code` and exchange them for `Bearer-Tokens`
71 | */
72 | app.get('/callback', function(req, res) {
73 |
74 | oauthClient.createToken(req.url)
75 | .then(function(authResponse) {
76 | oauth2_token_json = JSON.stringify(authResponse.getJson(), null,2);
77 | })
78 | .catch(function(e) {
79 | console.error(e);
80 | });
81 |
82 | res.send('');
83 |
84 | });
85 |
86 | /**
87 | * Display the token : CAUTION : JUST for sample purposes
88 | */
89 | app.get('/retrieveToken', function(req, res) {
90 | res.send(oauth2_token_json);
91 | });
92 |
93 |
94 | /**
95 | * Refresh the access-token
96 | */
97 | app.get('/refreshAccessToken', function(req,res){
98 |
99 | oauthClient.refresh()
100 | .then(function(authResponse){
101 | console.log('The Refresh Token is '+ JSON.stringify(authResponse.getJson()));
102 | oauth2_token_json = JSON.stringify(authResponse.getJson(), null,2);
103 | res.send(oauth2_token_json);
104 | })
105 | .catch(function(e) {
106 | console.error(e);
107 | });
108 |
109 |
110 | });
111 |
112 | /**
113 | * getCompanyInfo ()
114 | */
115 | app.get('/getCompanyInfo', function(req,res){
116 |
117 |
118 | var companyID = oauthClient.getToken().realmId;
119 |
120 | var url = oauthClient.environment == 'sandbox' ? OAuthClient.environment.sandbox : OAuthClient.environment.production ;
121 |
122 | oauthClient.makeApiCall({url: url + 'v3/company/' + companyID +'/companyinfo/' + companyID})
123 | .then(function(authResponse){
124 | console.log("The response for API call is :"+JSON.stringify(authResponse));
125 | res.send(JSON.parse(authResponse.text()));
126 | })
127 | .catch(function(e) {
128 | console.error(e);
129 | });
130 | });
131 |
132 |
133 | /**
134 | * Start server on HTTP (will use ngrok for HTTPS forwarding)
135 | */
136 | const server = app.listen(process.env.PORT || 8000, () => {
137 | console.log(`💻 Server listening on port ${server.address().port}`);
138 | if(!ngrok){
139 | redirectUri = `${server.address().port}` + '/callback';
140 | console.log(`💳 See the Sample App in your browser : ` + 'http://localhost:' + `${server.address().port}`);
141 | console.log(`💳 Copy this into Redirect URI on the browser : ` + 'http://localhost:' + `${server.address().port}` + '/callback');
142 | console.log(`💻 Make Sure this redirect URI is also copied on your app in : https://developer.intuit.com`);
143 | }
144 |
145 | });
146 |
147 | /**
148 | * Optional : If NGROK is enabled
149 | */
150 | if (ngrok) {
151 |
152 | console.log("NGROK Enabled");
153 | ngrok.connect({addr: process.env.PORT || 8000}, (err, url) => {
154 | if (err) {
155 | process.exit(1);
156 | }
157 | else {
158 | redirectUri = url + '/callback';
159 | console.log(`💳 See the Sample App in your browser: ${url}`);
160 | console.log(`💳 Copy and paste this Redirect URI on the browser : ${redirectUri}`);
161 | console.log(`💻 Make Sure this redirect URI is also copied on your app in : https://developer.intuit.com`);
162 |
163 | }
164 | }
165 | );
166 | }
167 |
168 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "OAuth2.0-demo-nodejs",
3 | "version": "1.0.0",
4 | "description": "A sample NodeJs application to demonstrate the use of the client OAuth library",
5 | "scripts": {
6 | "start": "node app",
7 | "test": "./node_modules/mocha/bin/mocha test/**/*-test.js --reporter spec"
8 | },
9 | "author": "anil_kumar3@intuit.com",
10 | "license": "APACHE",
11 | "homepage": "https://github.intuit.com/IntuitDeveloper/OAuth2.0-demo-nodejs",
12 | "dependencies": {
13 | "body-parser": "latest",
14 | "dotenv": "^5.0.1",
15 | "ejs": "^2.5.2",
16 | "express": "^4.14.0",
17 | "express-session": "^1.14.2",
18 | "intuit-oauth": "^1.2.0",
19 | "ngrok": "^2.2.9",
20 | "path": "^0.12.7"
21 | }
22 | }
23 |
--------------------------------------------------------------------------------
/public/css/common.css:
--------------------------------------------------------------------------------
1 | #headerLogo {
2 | display: inline-block;
3 | width: 200px;
4 | height: 60px;
5 | }
6 |
7 | #csvLogo {
8 | width: 50px;
9 | height: 50px;
10 | }
11 |
12 |
--------------------------------------------------------------------------------
/public/images/C2QB_green_btn_lg_default.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/IntuitDeveloper/OAuth2.0-demo-nodejs/1a1261d99bdce54d46269c97757516ba30b0c2a7/public/images/C2QB_green_btn_lg_default.png
--------------------------------------------------------------------------------
/public/images/quickbooks_logo_horz.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/IntuitDeveloper/OAuth2.0-demo-nodejs/1a1261d99bdce54d46269c97757516ba30b0c2a7/public/images/quickbooks_logo_horz.png
--------------------------------------------------------------------------------
/public/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
20 |
21 | 
52 |
53 |
54 |