Initial commit

Author: notrab

.circleci/config.yml

@@ -0,0 +1,47 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: 'circleci/node:latest'
+    steps:
+      - checkout
+      - run: yarn
+      - run: yarn build
+      - save_cache:
+          paths:
+            - node_modules
+          key: moltin-request-{{ checksum "package.json" }}
+  test:
+    docker:
+      - image: 'circleci/node:latest'
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - moltin-request-{{ checksum "package.json" }}
+      - run: yarn build
+      - run: yarn test
+  release:
+    docker:
+      - image: 'circleci/node:latest'
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - moltin-request-{{ checksum "package.json" }}
+      - run: yarn build
+      - run: npx semantic-release
+workflows:
+  version: 2
+  build_test_release:
+    jobs:
+      - build
+      - test:
+          requires:
+            - build
+      - release:
+          filters:
+            branches:
+              only: master
+          requires:
+            - test

.gitignore

@@ -0,0 +1,9 @@
+# dependencies
+node_modules
+
+# build
+dist
+
+# misc 
+*.log
+.DS_Store

.prettierignore

@@ -0,0 +1,3 @@
+dist/
+package.json
+yarn.lock

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "jsxBracketSameLine": true
+}

README.md

@@ -0,0 +1,58 @@
+# @moltin/request
+
+[![npm version](https://img.shields.io/npm/v/@moltin/request.svg)](https://www.npmjs.com/package/@moltin/request) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+> 🎮 Minimal Moltin API request library for Node + browsers
+
+## 🛠 Installation
+
+```bash
+yarn add @moltin/request # npm install @moltin/request
+```
+
+## 🚀 Quickstart (implicit)
+
+```js
+import { createClient } from '@moltin/request'
+
+const client = new createClient({
+  client_id: '...'
+})
+
+client
+  .get('products')
+  .then(console.log)
+  .catch(console.error)
+```
+
+## ⛽️ Quickstart (client credentials)
+
+```js
+import { createClient } from '@moltin/request'
+
+const client = new createClient({
+  client_id: '...',
+  client_secret: '...'
+})
+
+client
+  .post('brands', {
+    name: 'My Special Brand',
+    slug: 'my-special-brand',
+    status: 'live'
+  })
+  .then(console.log)
+  .catch(console.error)
+
+client
+  .put('brands/:id', {
+    name: 'My Special Brand!'
+  })
+  .then(console.log)
+  .catch(console.error)
+
+client
+  .delete('brands/:id')
+  .then(console.log)
+  .catch(console.error)
+```

jest.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  roots: ['<rootDir>/src'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest'
+  },
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  verbose: true,
+  testURL: 'http://localhost/'
+}

mock.js

@@ -0,0 +1,7 @@
+const { createClient } = require('./dist')
+
+const client = new createClient({
+  client_id: 'j6hSilXRQfxKohTndUuVrErLcSJWP15P347L6Im0M4'
+})
+
+client.get('products').then(console.log)

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@moltin/request",
+  "version": "0.0.0-development",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "yarn clean && tsc -d",
+    "clean": "rimraf dist",
+    "prepublish": "yarn build",
+    "test": "jest",
+    "semantic-release": "semantic-release"
+  },
+  "dependencies": {
+    "cross-fetch": "2.2.2"
+  },
+  "devDependencies": {
+    "@types/fetch-mock": "6.0.3",
+    "@types/jest": "23.3.1",
+    "fetch-mock": "6.5.2",
+    "jest": "23.4.2",
+    "rimraf": "2.6.2",
+    "semantic-release": "15.9.3",
+    "ts-jest": "23.0.1",
+    "typescript": "3.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/moltin/moltin-request.git"
+  }
+}

renovate.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["config:base", "docker:disable"],
+  "automerge": true,
+  "major": {
+    "automerge": false
+  },
+  "reviewers": ["notrab", "ynnoj", "craigtweedy"]
+}

src/index.ts

@@ -0,0 +1,102 @@
+import 'cross-fetch/polyfill'
+
+import { InitOptions, Options, Headers, AuthBody } from './types'
+import { removeLeadingSlash } from './utils'
+
+export class createClient {
+  private client_id: string
+  private client_secret?: string
+  private options?: Options
+
+  constructor(options: InitOptions) {
+    const { client_id, client_secret, ...others } = options
+
+    this.client_id = client_id
+    this.client_secret = client_secret ? client_secret : undefined
+    this.options = others || {}
+  }
+
+  async request(method: string, path: string, data: object = undefined) {
+    try {
+      const { application, currency, customer_token } = this.options
+      const uri: string = `https://api.moltin.com/v2/${removeLeadingSlash(
+        path
+      )}`
+      const headers: Headers = {
+        'Content-Type': 'application/json',
+        Authorization: `Bearer ${await this.authenticate()}`,
+        ...(application && { 'X-MOLTIN-APPLICATION': application }),
+        ...(currency && { 'X-MOLTIN-CURRENCY': currency }),
+        ...(customer_token && { 'X-MOLTIN-CUSTOMER-TOKEN': customer_token })
+      }
+
+      const response = await fetch(uri, {
+        method,
+        headers,
+        ...(data && { body: JSON.stringify({ data }) })
+      })
+      const json = await response.json()
+
+      if (response.ok) {
+        return json
+      }
+
+      return {
+        errors: json.errors
+      }
+    } catch (errors) {
+      return {
+        errors
+      }
+    }
+  }
+
+  async authenticate() {
+    const { client_id, client_secret } = this
+
+    if (!client_id) {
+      throw new Error('You must provide a client_id')
+    }
+
+    const uri: string = 'https://api.moltin.com/oauth/access_token'
+    const body: AuthBody = {
+      grant_type: client_secret ? 'client_credentials' : 'implicit',
+      client_id,
+      ...(client_secret && { client_secret })
+    }
+
+    const response = await fetch(uri, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded'
+      },
+      body: Object.keys(body)
+        .map(k => `${encodeURIComponent(k)}=${encodeURIComponent(body[k])}`)
+        .join('&')
+    })
+
+    const { access_token }: { access_token: string } = await response.json()
+
+    if (!access_token) {
+      throw new Error('Unable to obtain an access token')
+    }
+
+    return access_token
+  }
+
+  post(path: string, data: object) {
+    return this.request('POST', path, data)
+  }
+
+  get(path: string) {
+    return this.request('GET', path)
+  }
+
+  put(path: string, data: object) {
+    return this.request('PUT', path, data)
+  }
+
+  delete(path: string) {
+    return this.request('DELETE', path)
+  }
+}

src/types.ts

@@ -0,0 +1,23 @@
+export interface InitOptions {
+  client_id: string
+  client_secret?: string
+  application?: string
+  currency?: string
+  customer_token?: string
+}
+
+export interface Options {
+  application?: string
+  currency?: string
+  customer_token?: string
+}
+
+export interface Headers {
+  [key: string]: string
+}
+
+export interface AuthBody {
+  grant_type: 'client_credentials' | 'implicit'
+  client_id: string
+  client_secret?: string
+}

src/utils.test.ts

@@ -0,0 +1,7 @@
+import { removeLeadingSlash } from './utils'
+
+it('leading slash is removed', () => {
+  const string = '/test'
+
+  expect(removeLeadingSlash(string)).toEqual('test')
+})

src/utils.ts

@@ -0,0 +1,3 @@
+export function removeLeadingSlash(string: string) {
+  return string.replace(/^\/+/, '')
+}

tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "rootDir": "src",
+    "outDir": "dist",
+    "sourceMap": true,
+    "noUnusedLocals": true,
+    "lib": ["es2015", "dom", "esnext"]
+  },
+  "exclude": ["node_modules", "dist", "examples"]
+}