sharetribe-flex-sdk 1.14.0

package/src/utils.js

@@ -0,0 +1,68 @@
+import _ from 'lodash';
+
+/**
+   Take URL and remove the trailing slashes.
+
+   Example:
+
+   ```
+   trimEndSlash("http://www.api.com") => "http://www.api.com"
+   trimEndSlash("http://www.api.com/") => "http://www.api.com"
+   trimEndSlash("http://www.api.com//") => "http://www.api.com"
+   ```
+ */
+export const trimEndSlash = url => _.trimEnd(url, '/');
+
+export const fnPath = path =>
+  _.without(path.split('/'), '').map(part => part.replace(/_\w/g, m => m[1].toUpperCase()));
+
+export const formData = params =>
+  _.reduce(
+    params,
+    (pairs, v, k) => {
+      pairs.push(`${encodeURIComponent(k)}=${encodeURIComponent(v)}`);
+      return pairs;
+    },
+    []
+  ).join('&');
+
+/**
+   Serialize a single attribute in an object query parameter.
+*/
+const serializeAttribute = attribute => {
+  if (_.isPlainObject(attribute)) {
+    throw new Error('Nested object in query parameter.');
+  } else if (Array.isArray(attribute)) {
+    return attribute.join(',');
+  } else {
+    return attribute;
+  }
+};
+
+/**
+   Serializes an object into a Flex API query parameter value format. Null and
+   undefined object attributes are dropped.
+
+   Example:
+
+   {
+     a: 'foo',
+     b: '150',
+     c: null,
+     d: ['foo', 'bar'],
+   }
+
+   =>
+
+   'a:foo;b:150;d:foo,bar'
+*/
+export const objectQueryString = obj => {
+  if (!_.isPlainObject(obj)) {
+    throw new Error('Parameter not an object.');
+  }
+
+  return Object.entries(obj)
+    .filter(([, v]) => v !== null && v !== undefined)
+    .map(([k, v]) => `${k}:${serializeAttribute(v)}`)
+    .join(';');
+};

package/src/utils.test.js

@@ -0,0 +1,85 @@
+import { fnPath, trimEndSlash, formData, objectQueryString } from './utils';
+
+describe('utils', () => {
+  describe('pathToMethodName', () => {
+    it('takes URL path, returns method name', () => {
+      expect(fnPath('users')).toEqual(['users']);
+      expect(fnPath('/users')).toEqual(['users']);
+      expect(fnPath('users/')).toEqual(['users']);
+      expect(fnPath('/users/')).toEqual(['users']);
+      expect(fnPath('/users/create/')).toEqual(['users', 'create']);
+    });
+
+    it('camelizes it', () => {
+      expect(fnPath('/listings/upload_image')).toEqual(['listings', 'uploadImage']);
+      expect(fnPath('/listings/upload_new_awesome_image')).toEqual([
+        'listings',
+        'uploadNewAwesomeImage',
+      ]);
+    });
+  });
+
+  describe('trimEndSlash', () => {
+    it('trims trailing slashes', () => {
+      expect(trimEndSlash('http://www.api.com')).toEqual('http://www.api.com');
+      expect(trimEndSlash('http://www.api.com/')).toEqual('http://www.api.com');
+      expect(trimEndSlash('http://www.api.com//')).toEqual('http://www.api.com');
+    });
+  });
+
+  describe('formData', () => {
+    it('encodes params to formData', () => {
+      expect(
+        formData({ username: 'joe.dunphy@example.com', password: '}4$3.872487=3&&]/6?.' })
+      ).toEqual('username=joe.dunphy%40example.com&password=%7D4%243.872487%3D3%26%26%5D%2F6%3F.');
+    });
+  });
+
+  describe('objectQueryString', () => {
+    it('constructs a valid URL string', () => {
+      expect(
+        objectQueryString({
+          w: 500,
+          h: 2000,
+          fit: 'scale',
+          newparam: 'newvalue',
+          a: true,
+          b: false,
+        })
+      ).toEqual('w:500;h:2000;fit:scale;newparam:newvalue;a:true;b:false');
+    });
+
+    it('drops null and undefined values', () => {
+      expect(
+        objectQueryString({
+          w: 500,
+          h: undefined,
+          fit: 'scale',
+          newparam: 'newvalue',
+          a: null,
+        })
+      ).toEqual('w:500;fit:scale;newparam:newvalue');
+    });
+
+    it('serializes array values', () => {
+      expect(
+        objectQueryString({
+          has_all: ['brakes', 'steering', true, 10],
+          foo: 'bar',
+          newparam: 'newvalue',
+        })
+      ).toEqual('has_all:brakes,steering,true,10;foo:bar;newparam:newvalue');
+    });
+
+    it('only takes an object', () => {
+      expect(() => objectQueryString('foo')).toThrowError('Parameter not an object.');
+      expect(() => objectQueryString(null)).toThrowError('Parameter not an object.');
+    });
+
+    it('does not allow nested objects', () => {
+      expect(() => objectQueryString({ foo: { nested: 'value' } })).toThrowError(
+        'Nested object in query parameter.'
+      );
+    });
+  });
+});

package/webpack.config.babel.js

@@ -0,0 +1,47 @@
+/* eslint-env node */
+const path = require('path');
+const webpack = require('webpack');
+
+// Shared configs
+const entry = './src/index.js';
+
+const babelLoader = {
+  test: /.js$/,
+  exclude: [/node_modules/],
+  use: 'babel-loader',
+};
+
+const module = {
+  rules: [babelLoader],
+};
+
+const output = target => ({
+  path: path.resolve(__dirname, 'build'),
+  filename: `sharetribe-flex-sdk-${target}.js`,
+  library: 'sharetribeSdk',
+  libraryTarget: 'umd',
+});
+
+// Node configs
+const nodeConfig = {
+  entry,
+  output: output('node'),
+  target: 'node',
+  module,
+  externals: [
+    'axios',
+  ],
+};
+
+// Web configs
+const webConfig = {
+  entry,
+  output: output('web'),
+  target: 'web',
+  module,
+  plugins: [
+    new webpack.optimize.UglifyJsPlugin(),
+  ],
+};
+
+export default () => ([nodeConfig, webConfig]);