Skip to content

Commit

Permalink
Added more support for features in the sample app
Browse files Browse the repository at this point in the history
  • Loading branch information
Jordan Walsh committed Mar 1, 2017
1 parent e225336 commit d093f8d
Show file tree
Hide file tree
Showing 8 changed files with 380 additions and 23 deletions.
77 changes: 74 additions & 3 deletions oauth_test/sample_app.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,45 @@ function getXeroApp(session) {

var app = express();

app.engine('handlebars', exphbs({
var exphbs = exphbs.create({
defaultLayout: 'main',
layoutsDir: __dirname + '/views/layouts',
partialsDir: [
__dirname + '/views/partials/'
]
}));
],
helpers: {
ifCond: function(v1, operator, v2, options) {

switch (operator) {
case '==':
return (v1 == v2) ? options.fn(this) : options.inverse(this);
case '===':
return (v1 === v2) ? options.fn(this) : options.inverse(this);
case '!=':
return (v1 != v2) ? options.fn(this) : options.inverse(this);
case '!==':
return (v1 !== v2) ? options.fn(this) : options.inverse(this);
case '<':
return (v1 < v2) ? options.fn(this) : options.inverse(this);
case '<=':
return (v1 <= v2) ? options.fn(this) : options.inverse(this);
case '>':
return (v1 > v2) ? options.fn(this) : options.inverse(this);
case '>=':
return (v1 >= v2) ? options.fn(this) : options.inverse(this);
case '&&':
return (v1 && v2) ? options.fn(this) : options.inverse(this);
case '||':
return (v1 || v2) ? options.fn(this) : options.inverse(this);
default:
return options.inverse(this);
}
}
}
});

app.engine('handlebars', exphbs.engine);

app.set('view engine', 'handlebars');
app.set('views', __dirname + '/views');

Expand Down Expand Up @@ -126,6 +158,45 @@ app.get('/contacts', function(req, res) {
})
});

app.get('/banktransactions', function(req, res) {
authorizedOperation(req, res, '/banktransactions', function(xeroApp) {
var bankTransactions = [];
xeroApp.core.bankTransactions.getBankTransactions({ pager: { callback: pagerCallback } })
.then(function() {
res.render('banktransactions', { bankTransactions: bankTransactions });
})

function pagerCallback(err, response, cb) {
bankTransactions.push.apply(bankTransactions, response.data);
cb()
}
})
});

app.get('/banktransfers', function(req, res) {
authorizedOperation(req, res, '/banktransfers', function(xeroApp) {
var bankTransfers = [];
xeroApp.core.bankTransfers.getBankTransfers({ pager: { callback: pagerCallback } })
.then(function() {
res.render('banktransfers', { bankTransfers: bankTransfers });
})

function pagerCallback(err, response, cb) {
bankTransfers.push.apply(bankTransfers, response.data);
cb()
}
})
});

app.get('/accounts', function(req, res) {
authorizedOperation(req, res, '/accounts', function(xeroApp) {
xeroApp.core.accounts.getAccounts()
.then(function(accounts) {
res.render('accounts', { accounts: accounts });
})
})
});


app.get('/timesheets', function(req, res) {
authorizedOperation(req, res, '/timesheets', function(xeroApp) {
Expand Down
27 changes: 27 additions & 0 deletions oauth_test/views/accounts.handlebars
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<h3>Accounts</h3>
<table class="table table-bordered table-striped table-collapsed">
<thead>
<tr>
<td>Name</td>
<td>Code</td>
<td>Type</td>
<td>BankAccountNumber</td>
<td>BankAccountType</td>
<td>CurrencyCode</td>
</tr>
</thead>
{{#each accounts}}
<tr>
{{#ifCond this.Type '==' "BANK" }}
<td><a href="https://go.xero.com/Bank/BankTransactions.aspx?accountID={{ this.AccountID }}" target="_blank">{{this.Name}}</a></td>
{{else}}
<td>{{this.Name}}</td>
{{/ifCond}}
<td>{{ this.Code }}</td>
<td>{{ this.Type }}</td>
<td>{{ this.BankAccountNumber }}</td>
<td>{{ this.BankAccountType }}</td>
<td>{{ this.CurrencyCode }}</td>
</tr>
{{/each}}
</table>
23 changes: 23 additions & 0 deletions oauth_test/views/banktransactions.handlebars
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<h3>Bank Transactions</h3>
<table class="table table-bordered table-striped table-collapsed">
<thead>
<tr>
<td>Contact Name</td>
<td>Transaction Date</td>
<td># Line Items</td>
<td>SubTotal</td>
<td>Tax</td>
<td>Total</td>
</tr>
</thead>
{{#each bankTransactions}}
<tr>
<td><a href="https://go.xero.com/Bank/ViewTransaction.aspx?bankTransactionID={{this.BankTransactionID}}&accountID={{ this.BankAccount.AccountID }}" target="_blank">{{this.Contact.Name}}</a></td>
<td>{{ this.Date }}</td>
<td>{{ this.LineItems.length }}</td>
<td>{{ this.SubTotal }}</td>
<td>{{ this.TotalTax }}</td>
<td>{{ this.Total }}</td>
</tr>
{{/each}}
</table>
21 changes: 21 additions & 0 deletions oauth_test/views/banktransfers.handlebars
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<h3>Bank Transfers</h3>
<table class="table table-bordered table-striped table-collapsed">
<thead>
<tr>
<td>ID</td>
<td>Transfer Date</td>
<td>From Acct Name</td>
<td>To Acct Name</td>
<td>Amount</td>
</tr>
</thead>
{{#each bankTransfers}}
<tr>
<td>{{ this.BankTransferID }}</td>
<td>{{ this.Date }}</td>
<td>{{ this.FromBankAccount.Name }} (<a href="https://go.xero.com/Bank/ViewTransaction.aspx?bankTransactionID={{this.FromBankTransactionID}}&&accountID={{this.FromBankAccount.AccountID}}" target="_blank">ref</a>)</td>
<td>{{ this.ToBankAccount.Name }} (<a href="https://go.xero.com/Bank/ViewTransaction.aspx?bankTransactionID={{this.ToBankTransactionID}}&&accountID={{this.ToBankAccount.AccountID}}" target="_blank">ref</a>)</td>
<td>{{ this.Amount }}</td>
</tr>
{{/each}}
</table>
4 changes: 1 addition & 3 deletions oauth_test/views/contacts.handlebars
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@
<table class="table table-bordered table-striped table-collapsed">
<thead>
<tr>
<td>ID</td>
<td>Name</td>
<td>First name</td>
<td>Last name</td>
</tr>
</thead>
{{#each contacts}}
<tr>
<td>{{ this.ContactID }}</td>
<td>{{ this.Name }}</td>
<td><a href="https://go.xero.com/Contacts/View/{{ this.ContactID }}" target="_blank">{{ this.Name }}</a></td>
<td>{{ this.FirstName }}</td>
<td>{{ this.LastName }}</td>
</tr>
Expand Down
202 changes: 200 additions & 2 deletions oauth_test/views/index.handlebars
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,200 @@
<h3>Overview</h3>
<p>This page talks about how to use the application<p>
<h2>Xero Node.js - Sample App</h2>
<p>An API wrapper for the Xero API (<a href="http://developer.xero.com">http://developer.xero.com</a>).</p>
<p>Supports all three applications types:</p>
<ul>
<li>Private</li>
<li>Public</li>
<li>Partner</li>
</ul>
<h2>
<a id="Features_13"></a>Features</h2>
<p>The following endpoints are supported:</p>
<ul>
<li>Accounts</li>
<li>BankTransactions</li>
<li>BankTransfers</li>
<li>Contacts</li>
<li>Invoices</li>
<li>Items</li>
<li>Journals</li>
<li>Organisations</li>
<li>Payments</li>
<li>TrackingCategories (and TrackingOptions)</li>
<li>Users</li>
</ul>
<p>The following features are supported:</p>
<ul>
<li>Create / Read / Update / Delete (for most endpoints)</li>
<li>Search (using ‘where’ clause)</li>
<li>Efficient pagination with callbacks</li>
</ul>
<h1>
<a id="Installation_35"></a>Installation</h1>
<pre><code>$ npm install xero-node --save
</code></pre>
<h3>
<a id="External_Config_40"></a>External Config</h3>
<p>This SDK requires the config to be externalised to ensure private keys are not committed into your codebase by mistake.</p>
<p>The config file should be set up as follows:</p>
<pre><code class="language-javascript">{
<span class="hljs-string">"UserAgent"</span> : <span class="hljs-string">"Tester - Application for testing Xero"</span>,
<span class="hljs-string">"ConsumerKey"</span>: <span class="hljs-string">"AAAAAAAAAAAAAAAAAA"</span>,
<span class="hljs-string">"ConsumerSecret"</span>: <span class="hljs-string">"BBBBBBBBBBBBBBBBBBBB"</span>,
<span class="hljs-string">"PrivateKeyPath"</span>: <span class="hljs-string">"/some/path/to/privatekey.pem"</span>,
<span class="hljs-string">"RunscopeBucketId"</span> : <span class="hljs-string">"xxxyyyzzzz"</span>
}
</code></pre>
<h3>
<a id="Config_Parameters_56"></a>Config Parameters</h3>
<table class="table table-striped table-bordered">
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
</thead>
<tbody>
<tr>
<td>UserAgent</td>
<td>The useragent that should be used with all calls to the Xero API</td>
<td>True</td>
</tr>
<tr>
<td>ConsumerKey</td>
<td>The consumer key that is required with all calls to the Xero API.,</td>
<td>True</td>
</tr>
<tr>
<td>ConsumerSecret</td>
<td>The secret key from the developer portal that is required to authenticate your API calls</td>
<td>True</td>
</tr>
<tr>
<td>PrivateKeyPath</td>
<td>The filesystem path to your privatekey.pem file to sign the API calls</td>
<td>True</td>
</tr>
<tr>
<td>RunscopeBucketId</td>
<td>Your personal runscope bucket for debugging API calls</td>
<td>False</td>
</tr>
</tbody>
</table>
<hr>
<p><code>RunscopeBucketId</code> has been added to support debugging the SDK. Runscope is a simple tool for Testing Complex
APIs. You can use Runscope to verify that the structure and content of your API calls meets your expectations.</p>
<p>Sign up for a free runscope account at <a href="http://runscope.com">runscope.com</a> and place your bucket ID in the config
file to see API calls in real time.</p>
<p>Runscope is not endorsed by or affiliated with Xero. This tool was used by the SDK creator when authoring the code only.</p>
<h2>
<a id="Private_App_Usage_74"></a>Private App Usage</h2>
<pre><code class="language-javascript"><span class="hljs-keyword">var</span> PrivateApplication = <span class="hljs-built_in">require</span>(<span class="hljs-string">'xero-node'</span>).PrivateApplication;
<span class="hljs-keyword">var</span> privateApp = <span class="hljs-keyword">new</span> PrivateApplication();

<span class="hljs-comment">// This checks the ~/.xero/config.json directory by default looking for a config file.</span>
<span class="hljs-comment">// Alternatively a path to a JSON file can be provided as a parameter:</span>

<span class="hljs-keyword">var</span> myConfigFile = <span class="hljs-string">"/tmp/config.json"</span>;
<span class="hljs-keyword">var</span> privateApp = <span class="hljs-keyword">new</span> PrivateApplication(myConfigFile);
</code></pre>
<h2>
<a id="Pubic_Usage_87"></a>Pubic Usage</h2>
<pre><code class="language-javascript"><span class="hljs-keyword">var</span> PublicApplication = <span class="hljs-built_in">require</span>(<span class="hljs-string">'xero-node'</span>).PublicApplication;
<span class="hljs-keyword">var</span> publicApp = <span class="hljs-keyword">new</span> PublicApplication(myConfigFile);
</code></pre>
<h2>
<a id="Partner_Usage__Not_currently_tested_94"></a>Partner Usage - (Not currently tested)</h2>
<pre><code class="language-javascript"><span class="hljs-keyword">var</span> ParnetApplication = <span class="hljs-built_in">require</span>(<span class="hljs-string">'xero-node'</span>).PartnerApplication;
<span class="hljs-keyword">var</span> partnerApp = <span class="hljs-keyword">new</span> PartnerApplication(myConfigFile);
</code></pre>
<h1>
<a id="Examples_101"></a>Examples</h1>
<p>Print a count of invoices:</p>
<pre><code class="language-javascript"><span class="hljs-comment">//Print a count of invoices</span>
privateApp.core.invoices.getInvoices()
.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">invoices</span>) </span>{
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">"Invoices: "</span> + invoices.length);

}).fail(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">err</span>) </span>{
<span class="hljs-built_in">console</span>.error(err);
});
</code></pre>
<p>Print the name of some filtered contacts:</p>
<pre><code class="language-javascript"><span class="hljs-comment">//Print the name of a contact</span>
privateApp.core.contacts.getContacts({
where: <span class="hljs-string">'Name.Contains("Bayside")'</span>
})
.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">contacts</span>) </span>{
contacts.forEach(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">contact</span>) </span>{
<span class="hljs-built_in">console</span>.log(contact.Name);
});
}).fail(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">err</span>) </span>{
<span class="hljs-built_in">console</span>.error(err);
});
</code></pre>
<p>Efficient paging:</p>
<pre><code class="language-javascript">privateApp.core.contacts.getContacts({ pager: {start:<span class="hljs-number">1</span> <span class="hljs-comment">/* page number */</span>, callback:onContacts}})
.fail(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">err</span>) </span>{
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Oh no, an error'</span>);
});

<span class="hljs-comment">/* Called per page */</span>
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">onContacts</span>(<span class="hljs-params">err, response, cb</span>) </span>{
<span class="hljs-keyword">var</span> contacts = response.data;
<span class="hljs-keyword">if</span> (response.finished) <span class="hljs-comment">// finished paging</span>
....
cb(); <span class="hljs-comment">// Async support</span>
}
</code></pre>
<p>Filter support: Modified After</p>
<pre><code class="language-javascript"><span class="hljs-comment">// No paging</span>
publicApp.core.contacts.getContacts({
modifiedAfter: <span class="hljs-keyword">new</span> <span class="hljs-built_in">Date</span>(<span class="hljs-number">2013</span>,<span class="hljs-number">1</span>,<span class="hljs-number">1</span>)
})
.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">contacts</span>) </span>{
_.each(contacts, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">contact</span>) </span>{
<span class="hljs-comment">// Do something with contact</span>
})
})

</code></pre>
<h2>
<a id="Tests_164"></a>Tests</h2>
<p>npm test</p>
<h2>
<a id="Release_History_168"></a>Release History</h2>
<ul>
<li>1.0.0
<ul>
<li>Merged master branch from guillegette</li>
<li>Merged master branch from elliots</li>
<li>Externalised configs for private apps (keys should not live in the code)</li>
<li>Fixed the private app ‘consumerKey’ issue</li>
<li>Fixed the logger so it correctly supports different log levels</li>
<li>Added support for runscope urls in the signature generation</li>
</ul>
</li>
<li>0.0.2
<ul>
<li>Added journals</li>
<li>modifiedAfter support</li>
</ul>
</li>
<li>0.0.1
<ul>
<li>Initial Release</li>
</ul>
</li>
</ul>
<p>Copyright © 2017 Tim Shnaider, Guillermo Gette, Andrew Connell, Elliot Shepherd and Jordan Walsh</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy,
modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
Loading

0 comments on commit d093f8d

Please sign in to comment.