Updating examples and readme for correctness (#23)

emosesPatreon · web-flow · commit 951b66f528ea · 2018-05-10T14:20:51.000-07:00
* Updating examples and readme for correctness

* Allowing override of patreon url with env variable
diff --git a/changelog.md b/changelog.md
@@ -1,7 +1,22 @@
+# 0.4.1
+
+## Added
+
+* Allow override of patreon base URL via environment variable (for internal testing)
+
+## Fixed
+
+* Corrected errors in README
+* Fixed errors in examples/package.json, so npm install will work properly there
+
+## Updated
+
+* Removed unused dependencies
+
 # 0.4.0
 
 * Improve README to better explain responses
 * Use JSONAPIStore for response
 * Add User-Agent string for better platform attribution
 * Adjust our API urls to the canonical form
-* Add a package.json to the examples directory for easier testing
+* Add a package.json to the examples directory for easier testing
diff --git a/examples/package.json b/examples/package.json
@@ -4,12 +4,15 @@
   "description": "Test package for using the Patreon JS client library",
   "main": "server.js",
   "scripts": {
-    "start": "node server.js"
+    "start": "babel-node server.js"
   },
   "author": "Patreon",
   "license": "ISC",
   "dependencies": {
     "express": "^4.16.2",
-    "patreon": "^0.3.0"
+    "patreon": "0.4.1"
+  },
+  "devDependencies": {
+    "babel-cli": "^6.26.0"
   }
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "patreon",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Use the Patreon API via OAuth.",
   "main": "dist/index.js",
   "scripts": {
@@ -30,8 +30,7 @@
     "form-urlencoded": "^2.0.4",
     "is-plain-object": "^2.0.4",
     "isomorphic-fetch": "^2.2.1",
-    "jsonapi-datastore": "^0.4.0-beta",
-    "verror": "^1.10.0"
+    "jsonapi-datastore": "^0.4.0-beta"
   },
   "devDependencies": {
     "babel-cli": "^6.26.0",
diff --git a/readme.md b/readme.md
@@ -169,10 +169,10 @@ The lists of valid `includes` and `fields` arguments are provided in `patreon/sc
 For instance, if you wanted to request the total amount a patron has ever paid to your campaign,
 which is not included by default, you could do:
 ```js
-const { patreonAPI, jsonApiURL } = require('patreon')
+const { patreon, jsonApiURL } = require('patreon')
 const pledge_schema = require('patreon/schemas/pledge')
 
-const patreonAPIClient = patreonAPI(access_token)
+const patreonAPIClient = patreon(access_token)
 const url = jsonApiURL(`/current_user`, {
   fields: {
     pledge: [...pledge_schema.default_attributes, pledge_schema.attributes.total_historical_amount_cents]
diff --git a/src/oauth.js b/src/oauth.js
@@ -1,6 +1,6 @@
 import fetch from 'isomorphic-fetch'
 import formurlencoded from 'form-urlencoded'
-import { checkStatus, getJson, userAgentString } from './utils'
+import { buildUrl, checkStatus, getJson, userAgentString } from './utils'
 
 function errMap(err, params) {
     if (err === 'invalid_grant') {
@@ -13,7 +13,7 @@ function errMap(err, params) {
 }
 
 function updateToken(params) {
-    const url = 'https://www.patreon.com/api/oauth2/token'
+    const url = buildUrl('/api/oauth2/token')
     const options = {
         method: 'POST',
         headers: {
diff --git a/src/utils.js b/src/utils.js
@@ -1,9 +1,13 @@
 import { version } from '../package.json'
 const os = require('os')
 
-const BASE_HOST = 'https://www.patreon.com'
+const BASE_HOST = process.env.PATREON_OAUTH_HOST || 'https://www.patreon.com'
 const BASE_PATH = 'api/oauth2/api'
 
+function buildUrl(path) {
+    return BASE_HOST + path
+}
+
 function stripPreSlash(str) {
     return str.replace(/^\//, '')
 }
@@ -34,4 +38,4 @@ function userAgentString() {
     return `Patreon-JS, version ${version}, platform ${os.platform()}-${os.release()}-${os.arch()}`
 }
 
-export { stripPreSlash, normalizeRequest, checkStatus, getJson, userAgentString }
+export { stripPreSlash, normalizeRequest, checkStatus, getJson, userAgentString, buildUrl }
