add prices and other improvements #11

nbelyh · 2022-09-19T21:44:05Z

Thank you for the project, it was really useful for me to work with the Fortnox from node.

Some improvements from my side, pls your feedback:

added "Prices" object support (with tests)
added handling of 429 error (in case of "too many requests") with exponential fallback
added error support from hubspot (so that actual error is reported instead of generic http error)
added "bearer token support for OAuth2 (now they have migrated to OAuth2 bearer token, so for new apps apssing "access token" and "client secret" in the header does not work anymore (as far as I knnow),
To be able to run tests with bearer added tiny http server to get the token (optional to run tests)
fixed a problem when you have both "filter" and more than one page in getAllPages of results (it was trying to append two parameters with "?" now it should append them properly (unified all methods to go through getAllPages to fix that)

nbelyh · 2022-09-20T07:02:56Z

package.json

@@ -9,7 +9,8 @@
  ],
  "scripts": {
    "build": "tsc",
-    "test": "./node_modules/.bin/nyc ./node_modules/.bin/mocha -r ts-node/register test/*.ts"
+    "auth": "./node_modules/.bin/ts-node ./test/http-server-oauth-authorize.ts",


To get OAuth2 token: npm run auth. As far as I understand, now fortnox only allows OAuth2 for "new" apps

nbelyh · 2022-09-20T07:03:44Z

package.json

@@ -9,7 +9,8 @@
  ],
  "scripts": {
    "build": "tsc",
-    "test": "./node_modules/.bin/nyc ./node_modules/.bin/mocha -r ts-node/register test/*.ts"
+    "auth": "./node_modules/.bin/ts-node ./test/http-server-oauth-authorize.ts",
+    "test": "./node_modules/.bin/nyc ./node_modules/.bin/mocha -r ts-node/register test/*.spec.ts"


changes .ts => .spec.ts (now test folder contains also non-test helper files)

nbelyh · 2022-09-20T07:05:19Z

src/articles.ts

@@ -8,12 +8,10 @@ type ArticleResult = {

 export class Articles {
    private dispatch: Dispatch;
-    private util: Util;


Made Util use static methods (they are private anyway and not used outside). There seem to be no reason for extra allocations and repeating code.

nbelyh · 2022-09-20T07:06:14Z

src/articles.ts

@@ -22,10 +20,7 @@ export class Articles {
    }

    async getAll(filter?: string) {
-        let path = this.path;
-        if (filter)
-            path += '?filter=' + filter;


Unified all "filter" parameters (remove repeated code)

nbelyh · 2022-09-20T07:06:53Z

src/dispatch.ts

+            }
+
+            throw await Util.makeErrorFromResponse(response)
+        }


"exponential" exception handling for "too many requests".

nbelyh · 2022-09-20T07:07:20Z

src/dispatch.ts

    }

    async post(path: string, body: any) {
        const response = await fetch(`${this.host}${path}`, { method: 'POST', headers: this.defaults.headers, body: JSON.stringify(body, null, 4) });
        if (response.status === 201)
            return await response.json() as object;
-        throw new Error(response.statusText);
+        throw await Util.makeErrorFromResponse(response);


Use FORTNOX error, do not ignore it - it is really useful to figure out what went wrong

nbelyh · 2022-09-20T07:07:38Z

src/index.ts

-    constructor(config: { host: string, clientSecret: string, accessToken: string }){
+    constructor(config: {
+        host: string,
+        bearerToken?: string,


Add bearer token support for OAuth2

nbelyh · 2022-09-20T07:07:51Z

src/index.ts

        this.articles = new Articles(dispatch);
        this.customers = new Customers(dispatch);
        this.invoices = new Invoices(dispatch);
        this.supplierInvoices = new SupplierInvoices(dispatch);
        this.suppliers = new Suppliers(dispatch);
+        this.prices = new Prices(dispatch);


Add prices support

nbelyh · 2022-09-20T07:08:30Z

src/invoices.ts

-    async getAll(filter: string) {
-        const result = await this.util.getAllPages(this.path + '?filter=' + filter, 'Invoices', this.dispatch) as InvoiceResult[];
+    async getAll(filter?: string) {
+        const result = await Util.getAllPages(this.path, 'Invoices', this.dispatch, filter) as FNInvoice[];


Fix a bug - the results is array of FNInvoice[] actually, not of InvoiceResult[].

nbelyh · 2022-09-20T07:08:54Z

src/prices.ts

+    Price: FNPrice
+}
+
+export class Prices {


Prices/price lists support

nbelyh · 2022-09-20T07:09:33Z

src/suppliers.ts

-        const result = await this.dispatch.get(this.path) as SupplierResult;
-        return supplierNumber ? result.Supplier : result.Suppliers;
+    async get(supplierNumber: string) {
+        const result = await this.dispatch.get(`${this.path}/${supplierNumber}`) as SupplierResult;


Fix a bug - parameter not used (should be part of the query path)

nbelyh · 2022-09-20T07:10:17Z

src/utils.ts

@@ -1,21 +1,47 @@
 import { Dispatch } from "./dispatch";

 export class Util {
-    async getAllPages(path: string, arrayName: string, dispatch: Dispatch) {
+    static async getAllPages(path: string, arrayName: string, dispatch: Dispatch, filter?: string) {


Unify filter/paging. Before it had an issue that filter + paging did not work together.

nbelyh · 2022-09-20T07:10:54Z

src/utils.ts

+
+        // get fortnox error if exist
+        if (response?.headers?.get('content-type')?.startsWith('application/json')) {
+            const fnError = await response.json();


Fortnox error is packed like { ErrorInformation: { message: "bla-bla-bla", code: 100500 } }

nbelyh · 2022-09-20T07:11:18Z

test/dispatch.spec.ts

+import { assert } from 'chai';
+import { Util } from '../src/utils';
+
+const makeFakeFortnoxResponse = (message: string) => {


Unit tests for error handling

nbelyh · 2022-09-20T07:11:35Z

test/fortnox.spec.ts

@@ -88,6 +94,48 @@ describe('fortnox', () => {
        const response = await fn.articles.get(newArticleNumber);
        assert.equal(response.Description, anArticle.Description);
    }),
+
+


Unit tests for prices

pal · 2024-08-16T07:44:08Z

Is this being considered for inclusion?

nbelyh added 2 commits September 19, 2022 23:34

add prices and other improvements

9b8d095

forgot to remove extra log

f11e738

nbelyh commented Sep 20, 2022

View reviewed changes

src/dispatch.ts

}

throw await Util.makeErrorFromResponse(response)

}

Copy link

Author

nbelyh Sep 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"exponential" exception handling for "too many requests".

nbelyh commented Sep 20, 2022

View reviewed changes

src/prices.ts

Price: FNPrice

}

export class Prices {

Copy link

Author

nbelyh Sep 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prices/price lists support

nbelyh commented Sep 20, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add prices and other improvements #11

add prices and other improvements #11

nbelyh commented Sep 19, 2022

nbelyh Sep 20, 2022 •

edited

Loading

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022 •

edited

Loading

nbelyh Sep 20, 2022

nbelyh Sep 20, 2022

pal commented Aug 16, 2024

add prices and other improvements #11

Are you sure you want to change the base?

add prices and other improvements #11

Conversation

nbelyh commented Sep 19, 2022

nbelyh Sep 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nbelyh Sep 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pal commented Aug 16, 2024

nbelyh Sep 20, 2022 •

edited

Loading

nbelyh Sep 20, 2022 •

edited

Loading