Merge pull request #51 from deskbookers/develop

Dev -> Master

Author: vdvleon

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 5.1.0 - 2017-08-01
+### Changes
+- Added `retrieve` method to the `Venues` resource.
+
 ## 5.0.0 - 2017-07-24
 ### Changes
 - Added parameter `country` on `Features` list and changed for object parameters

README.md

@@ -76,4 +76,8 @@ for (let workplace of workplaces) {
   * [`flagAsRead(userId, body, id)`](docs/notifications.md#flagasreaduserid-body-id)
   * [`delete()`](docs/notifications.md#delete)
 * bookings
-  * [`month(date, venueId)`](docs/bookings.md#monthdate-venueid)
+  * [`month(date, venueId)`](docs/bookings.md#monthdate-venueid)
+* venues
+  * [`retrieve(venueId, { fields, params })`](docs/venues.md#retrievevenueid--fields-params-)
+  * [`getPaymentSettings(venueId)`](docs/venues.md#getpaymentsettings-venueId)
+  * [`savePaymentSettings(venueId, params)`](docs/venues.md#savepaymentsettings-venueId-params)

docs/venues.md

@@ -0,0 +1,64 @@
+# Venues
+
+## `retrieve(venueId, { fields, params })`
+Retrieves a single venue.
+
+```js
+const venueId = 11710
+const fields = ['id', 'image_urls']
+const params = { width: 360, height: 240 }
+await deskbookers.venues.retrieve(venueId, { fields, params })
+```
+
+#### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+venueId | Number | Venue ID | Yes
+fields | Array|Object | Fields whitelist | No
+params | Object | Extra arguments | No
+
+## `savePaymentSettings(venueId, params)`
+Retrieves the payment settings data for a venue.
+
+## `getPaymentSettings(venueId)`
+Retrieves a single space.
+
+```js
+const venueId = 11710
+await deskbookers.venues.getPaymentSettings(venueId)
+```
+
+#### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+id | Number | Venue ID | Yes
+
+## `savePaymentSettings(venueId, params)`
+Retrieves the payment settings data for a venue.
+
+```js
+await deskbookers.venues.savePaymentSettings(11710, {
+  name: 'aaa',
+  bankInfo: 'NL01BANK012345678',
+  bic: 'ABCDEF01',
+  tax: '1234',
+  company: 'hockerson',
+  debtor: '12345',
+  mark: 'rarara',
+  address:
+   { country: 'The Netherlands',
+     addressLine1: 'a',
+     postalcode: '1012AK',
+     place: 'lolala',
+     telephonenumber: '+31610513231',
+     telephonenumber2: '+31123412345',
+     email: '[email protected]' 
+   }
+})
+```
+
+#### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+id | Number | Venue ID | Yes
+params | `Object` | PaymentSettings | Yes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "deskbookers",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "Deskbookers API JavaScript SDK",
   "main": "dist/index.js",
   "scripts": {

src/resources/Venues.js

@@ -0,0 +1,55 @@
+import Resource from './Resource'
+import { DeskbookersError } from '../errors'
+
+export default class Venues extends Resource {
+  constructor (api) {
+    super(api)
+    this.endpoint = 'location'
+  }
+
+  /**
+   * List payment settings by venue
+   *
+   * @param {int} venueId - Venue Id body.
+   * @return {Object}
+   */
+  async getPaymentSettings (venueId) {
+    return this.request({
+      method: 'GET',
+      path: `location/${venueId}/payment-settings`
+    })
+  }
+  /**
+   * Create  payment settings to venue
+   *
+   * @param {int} venueId - Venue Id body.
+   * @param {Object} paymentSettings Venue Payment Settings
+   * @return {Object}
+   */
+  async savePaymentSettings (venueId, paymentSettings) {
+    return this.request({
+      method: 'POST',
+      path: `location/${venueId}/payment-settings`,
+      params: {
+        data: paymentSettings
+      }
+    })
+  }
+
+  /**
+   * Retrieve a venue
+   *
+   * @param {int} venueId - Venue Id
+   * @param {Array|Object} fields - Fields whitelist
+   * @param {Object} params - Extra arguments
+   * @return {Object}
+   */
+  async retrieve (venueId, { fields = [], params = {} } = {}) {
+    return await this.request({
+      method: 'GET',
+      path: `/${this.endpoint}/${venueId}`,
+      fields,
+      params
+    })
+  }
+}

src/resources/index.js

@@ -7,6 +7,7 @@ import Features from './Features'
 import Spaces from './Spaces'
 import Notifications from './Notifications'
 import Bookings from './Bookings'
+import Venues from './Venues'
 
 export default {
   account: Account,
@@ -17,5 +18,6 @@ export default {
   features: Features,
   spaces: Spaces,
   notifications: Notifications,
-  bookings: Bookings
+  bookings: Bookings,
+  venues: Venues
 }

test/venues.js

@@ -0,0 +1,107 @@
+import dotenv from 'dotenv'
+import 'fetch-everywhere'
+import test from 'ava'
+import Deskbookers from '../src'
+dotenv.load()
+
+function client () {
+  return new Deskbookers({
+    https: process.env.API_HTTPS === 'true',
+    host: process.env.API_HOST
+  })
+}
+
+test('get financial settings', async t => {
+  const deskbookers = client()
+
+  await deskbookers.account.login(
+    process.env.LOGIN_EMAIL,
+    process.env.LOGIN_PASSWORD
+  )
+
+  const paymentSettings = await deskbookers.venues.getPaymentSettings(11710)
+  t.truthy(paymentSettings)
+})
+
+test('save financial settings', async t => {
+  const deskbookers = client()
+
+  await deskbookers.account.login(
+    process.env.LOGIN_EMAIL,
+    process.env.LOGIN_PASSWORD
+  )
+
+  let payment = {
+    name: 'aaa222',
+    bankInfo: 'NL01BANK012345222',
+    bic: 'ABCDEF22',
+    tax: '1234222',
+    company: 'hockerson2',
+    debtor: '1234522',
+    mark: 'rarara22',
+    address:
+    { country: 'The Netherlands',
+      addressLine1: 'a2',
+      postalcode: '2222AK',
+      place: 'lolala2',
+      telephonenumber: '+31610512222',
+      telephonenumber2: '+31123412222',
+      email: '[email protected]'
+    }
+  }
+  const saved = await deskbookers.venues.savePaymentSettings(11710, payment)
+  const paymentSettings = await deskbookers.venues.getPaymentSettings(11710)
+
+  t.truthy(saved)
+})
+
+test('retrieve a venue', async t => {
+  const venueId = 12686
+  const width = 360
+  const height = 240
+
+  // Prepare API
+  const deskbookers = client()
+  await deskbookers.account.login(
+    process.env.LOGIN_EMAIL,
+    process.env.LOGIN_PASSWORD
+  )
+
+  // Test simple call
+  const venue1 = await deskbookers.venues.retrieve(venueId)
+  t.truthy(typeof venue1 === 'object')
+  t.is(venue1.id, venueId)
+  t.truthy(venue1.name)
+  t.truthy(venue1.timezone)
+  t.truthy(venue1.lang)
+  t.truthy(venue1.slug)
+
+  // Test fields
+  const venue2 = await deskbookers.venues.retrieve(venueId, {
+    fields: ['id', 'name', 'address_object']
+  })
+  t.truthy(typeof venue2 === 'object')
+  t.is(venue2.id, venueId)
+  t.is(venue2.name, venue1.name)
+  t.is(
+    JSON.stringify(venue2.address_object),
+    JSON.stringify(venue1.address_object)
+  )
+  t.falsy(venue2.timezone)
+
+  // Test image params
+  const venue3 = await deskbookers.venues.retrieve(venueId, {
+    params: {
+      width,
+      height,
+      crop: true
+    },
+    fields: ['id', 'image_urls']
+  })
+  t.truthy(typeof venue3 === 'object')
+  t.is(venue3.id, venueId)
+  t.truthy(Array.isArray(venue3.image_urls))
+  t.truthy(venue3.image_urls.reduce((result, url) => {
+    return result && url.indexOf(`${width}x${height}x1`) !== -1
+  }, true))
+})