Shopify trigger done

This commit is contained in:
Ricardo Espinoza 2019-12-02 16:21:55 -05:00
parent 8751694680
commit 6955109cbd
6 changed files with 478 additions and 2 deletions

View file

@ -230,7 +230,10 @@ class App {
});
// Support application/json type post data
this.app.use(bodyParser.json({ limit: "16mb" }));
this.app.use(bodyParser.json({ limit: "16mb", verify: (req, res, buf) => {
// @ts-ignore
req.rawBody = buf;
}}));
// Make sure that Vue history mode works properly
this.app.use(history({

View file

@ -0,0 +1,38 @@
import {
ICredentialType,
NodePropertyTypes,
} from 'n8n-workflow';
export class ShopifyApi implements ICredentialType {
name = 'shopifyApi';
displayName = 'Shopify API';
properties = [
{
displayName: 'API Key',
name: 'apiKey',
required: true,
type: 'string' as NodePropertyTypes,
default: '',
},
{
displayName: 'Password',
name: 'password',
required: true,
type: 'string' as NodePropertyTypes,
default: '',
},
{
displayName: 'Shop Name',
name: 'shopName',
required: true,
type: 'string' as NodePropertyTypes,
default: '',
},
{
displayName: 'Shared Secret',
name: 'sharedSecret',
type: 'string' as NodePropertyTypes,
default: '',
},
];
}

View file

@ -0,0 +1,42 @@
import { OptionsWithUri } from 'request';
import {
IExecuteFunctions,
IHookFunctions,
ILoadOptionsFunctions,
IExecuteSingleFunctions,
BINARY_ENCODING
} from 'n8n-core';
import {
IDataObject,
} from 'n8n-workflow';
export async function shopifyApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, query?: IDataObject, uri?: string): Promise<any> { // tslint:disable-line:no-any
const credentials = this.getCredentials('shopifyApi');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
const headerWithAuthentication = Object.assign({},
{ Authorization: ` Basic ${Buffer.from(`${credentials.apiKey}:${credentials.password}`).toString(BINARY_ENCODING)}` });
const options: OptionsWithUri = {
headers: headerWithAuthentication,
method,
qs: query,
uri: uri || `https://${credentials.shopName}.myshopify.com/admin/api/2019-10${resource}`,
body,
json: true
};
try {
return await this.helpers.request!(options);
} catch (error) {
const errorMessage = error.response.body.message || error.response.body.Message;
if (errorMessage !== undefined) {
throw errorMessage;
}
throw error.response.body;
}
}

View file

@ -0,0 +1,391 @@
import {
IHookFunctions,
IWebhookFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeTypeDescription,
INodeType,
IWebhookResponseData,
} from 'n8n-workflow';
import {
shopifyApiRequest,
} from './GenericFunctions';
import { createHmac } from 'crypto';
export class ShopifyTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Shopify Trigger',
name: 'shopify',
icon: 'file:shopify.png',
group: ['trigger'],
version: 1,
description: 'Handle Shopify events via webhooks',
defaults: {
name: 'Shopify Trigger',
color: '#559922',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'shopifyApi',
required: true,
}
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Topic',
name: 'topic',
type: 'options',
default: '',
options:
[
{
name: 'app uninstalled',
value: 'app/uninstalled'
},
{
name: 'carts create',
value: 'carts/create'
},
{
name: 'carts update',
value: 'carts/update'
},
{
name: 'checkouts create',
value: 'checkouts/create'
},
{
name: 'checkouts delete',
value: 'checkouts/delete'
},
{
name: 'checkouts update',
value: 'checkouts/update'
},
{
name: 'collection_listings add',
value: 'collection_listings/add'
},
{
name: 'collection_listings remove',
value: 'collection_listings/remove'
},
{
name: 'collection_listings update',
value: 'collection_listings/update'
},
{
name: 'collections create',
value: 'collections/create'
},
{
name: 'collections delete',
value: 'collections/delete'
},
{
name: 'collections update',
value: 'collections/update'
},
{
name: 'customer_groups create',
value: 'customer_groups/create'
},
{
name: 'customer_groups delete',
value: 'customer_groups/delete'
},
{
name: 'customer_groups update',
value: 'customer_groups/update'
},
{
name: 'customers create',
value: 'customers/create'
},
{
name: 'customers delete',
value: 'customers/delete'
},
{
name: 'customers disable',
value: 'customers/disable'
},
{
name: 'customers enable',
value: 'customers/enable'
},
{
name: 'customers update',
value: 'customers/update'
},
{
name: 'draft_orders create',
value: 'draft_orders/create'
},
{
name: 'draft_orders delete',
value: 'draft_orders/delete'
},
{
name: 'draft_orders update',
value: 'draft_orders/update'
},
{
name: 'fulfillment_events create',
value: 'fulfillment_events/create'
},
{
name: 'fulfillment_events delete',
value: 'fulfillment_events/delete'
},
{
name: 'fulfillments create',
value: 'fulfillments/create'
},
{
name: 'fulfillments update',
value: 'fulfillments/update'
},
{
name: 'inventory_items create',
value: 'inventory_items/create'
},
{
name: 'inventory_items delete',
value: 'inventory_items/delete'
},
{
name: 'inventory_items update',
value: 'inventory_items/update'
},
{
name: 'inventory_levels connect',
value: 'inventory_levels/connect'
},
{
name: 'inventory_levels disconnect',
value: 'inventory_levels/disconnect'
},
{
name: 'inventory_levels update',
value: 'inventory_levels/update'
},
{
name: 'locales create',
value: 'locales/create'
},
{
name: 'locales update',
value: 'locales/update'
},
{
name: 'locations create',
value: 'locations/create'
},
{
name: 'locations delete',
value: 'locations/delete'
},
{
name: 'locations update',
value: 'locations/update'
},
{
name: 'order_transactions create',
value: 'order_transactions/create'
},
{
name: 'orders cancelled',
value: 'orders/cancelled'
},
{
name: 'orders create',
value: 'orders/create'
},
{
name: 'orders delete',
value: 'orders/delete'
},
{
name: 'orders fulfilled',
value: 'orders/fulfilled'
},
{
name: 'orders paid',
value: 'orders/paid'
},
{
name: 'orders partially_fulfilled',
value: 'orders/partially_fulfilled'
},
{
name: 'orders updated',
value: 'orders/updated'
},
{
name: 'product_listings add',
value: 'product_listings/add'
},
{
name: 'product_listings remove',
value: 'product_listings/remove'
},
{
name: 'product_listings update',
value: 'product_listings/update'
},
{
name: 'products create',
value: 'products/create'
},
{
name: 'products delete',
value: 'products/delete'
},
{
name: 'products update',
value: 'products/update'
},
{
name: 'refunds create',
value: 'refunds/create'
},
{
name: 'shop update',
value: 'shop/update'
},
{
name: 'tender_transactions create',
value: 'tender_transactions/create'
},
{
name: 'themes create',
value: 'themes/create'
},
{
name: 'themes delete',
value: 'themes/delete'
},
{
name: 'themes publish',
value: 'themes/publish'
},
{
name: 'themes update',
value: 'themes/update'
}
],
description: 'Event that triggers the webhook',
},
],
};
// @ts-ignore (because of request)
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
if (webhookData.webhookId === undefined) {
return false;
}
const endpoint = `/webhooks/${webhookData.webhookId}.json`;
try {
await shopifyApiRequest.call(this, 'GET', endpoint, {});
} catch (e) {
if (e.statusCode === 404) {
delete webhookData.webhookId;
return false;
}
throw e;
}
return true;
},
async create(this: IHookFunctions): Promise<boolean> {
const credentials = this.getCredentials('shopifyApi');
const webhookUrl = this.getNodeWebhookUrl('default');
const topic = this.getNodeParameter('topic') as string;
const endpoint = `/webhooks.json`;
const body = {
webhook: {
topic,
address: webhookUrl,
format: 'json',
}
};
let responseData;
try {
responseData = await shopifyApiRequest.call(this, 'POST', endpoint, body);
} catch(error) {
return false;
}
if (responseData.webhook === undefined || responseData.webhook.id === undefined) {
// Required data is missing so was not successful
return false;
}
const webhookData = this.getWorkflowStaticData('node');
webhookData.webhookId = responseData.webhook.id as string;
webhookData.sharedSecret = credentials!.sharedSecret as string;
webhookData.topic = topic as string;
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
if (webhookData.webhookId !== undefined) {
const endpoint = `/webhooks/${webhookData.webhookId}.json`;
try {
await shopifyApiRequest.call(this, 'DELETE', endpoint, {});
} catch (e) {
return false;
}
delete webhookData.webhookId;
delete webhookData.sharedSecret;
delete webhookData.topic;
}
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
const headerData = this.getHeaderData() as IDataObject;
const req = this.getRequestObject();
const webhookData = this.getWorkflowStaticData('node') as IDataObject;
if (headerData['x-shopify-topic'] !== undefined
&& headerData['x-shopify-hmac-sha256'] !== undefined
&& headerData['x-shopify-shop-domain'] !== undefined
&& headerData['x-shopify-api-version'] !== undefined) {
// @ts-ignore
const computedSignature = createHmac('sha256', webhookData.sharedSecret as string).update(req.rawBody).digest('base64');
if (headerData['x-shopify-hmac-sha256'] !== computedSignature) {
return {};
}
if (webhookData.topic !== headerData['x-shopify-topic']) {
return {};
}
} else {
return {};
}
return {
workflowData: [
this.helpers.returnJsonArray(req.body)
],
};
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.3 KiB

View file

@ -58,7 +58,8 @@
"dist/credentials/RocketchatApi.credentials.js",
"dist/credentials/SlackApi.credentials.js",
"dist/credentials/Smtp.credentials.js",
"dist/credentials/StripeApi.credentials.js",
"dist/credentials/StripeApi.credentials.js",
"dist/credentials/ShopifyApi.credentials.js",
"dist/credentials/TelegramApi.credentials.js",
"dist/credentials/TodoistApi.credentials.js",
"dist/credentials/TrelloApi.credentials.js",
@ -130,6 +131,7 @@
"dist/nodes/SpreadsheetFile.node.js",
"dist/nodes/Start.node.js",
"dist/nodes/Stripe/StripeTrigger.node.js",
"dist/nodes/Shopify/ShopifyTrigger.node.js",
"dist/nodes/Telegram/Telegram.node.js",
"dist/nodes/Telegram/TelegramTrigger.node.js",
"dist/nodes/Todoist/Todoist.node.js",