config: take a wgScriptPath parameter

addressing #69
maxlath · May 31, 2021 · 6d46985 · 6d46985
1 parent d42636f
commit 6d46985
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 11 deletions.
diff --git a/docs/how_to.md b/docs/how_to.md
@@ -83,6 +83,9 @@ const generalConfig = {
   // A Wikibase instance is required
   instance: 'https://www.wikidata.org',
 
+  // The instance script path, used to find the API endpoint is usually `/w`, as with https://www.wikidata.org/w/api.php for instance
+  wgScriptPath: '/w',
+
   // One authorization mean is required (unless in anonymous mode, see below)
   credentials: {
     // either a username and password

diff --git a/lib/parse_instance.js b/lib/parse_instance.js
@@ -9,9 +9,13 @@ module.exports = config => {
 
   if (!instance) throw error_.new('missing config parameter: instance', { config })
 
+  let { wgScriptPath = 'w' } = config
+
+  wgScriptPath = wgScriptPath.replace(/^\//, '')
+
   config.instance = instance
     .replace(/\/$/, '')
-    .replace('/w/api.php', '')
+    .replace(`/${wgScriptPath}/api.php`, '')
 
-  config.instanceApiEndpoint = `${config.instance}/w/api.php`
+  config.instanceApiEndpoint = `${config.instance}/${wgScriptPath}/api.php`
 }
diff --git a/lib/request/post.js b/lib/request/post.js
@@ -25,7 +25,7 @@ module.exports = (action, data, config) => {
 }
 
 const actionPost = (action, data, config) => authData => {
-  const { instance, userAgent, bot, summary, baserevid, tags, maxlag, anonymous, autoRetry } = config
+  const { instanceApiEndpoint, userAgent, bot, summary, baserevid, tags, maxlag, anonymous, autoRetry } = config
 
   const query = { action, format: 'json' }
 
@@ -37,7 +37,7 @@ const actionPost = (action, data, config) => authData => {
   }
 
   const params = {
-    url: buildUrl(`${instance}/w/api.php`, query),
+    url: buildUrl(instanceApiEndpoint, query),
     headers: {
       'User-Agent': userAgent
     },

diff --git a/lib/request_wrapper.js b/lib/request_wrapper.js
@@ -26,7 +26,7 @@ module.exports = (fn, generalConfig) => async (params, reqConfig) => {
 
   if (!data.title) return post(action, data, config)
 
-  const title = await resolveTitle(data.title, config.instance)
+  const title = await resolveTitle(data.title, config.instanceApiEndpoint)
   data.title = title
   return post(action, data, config)
 }
diff --git a/lib/resolve_title.js b/lib/resolve_title.js
@@ -6,17 +6,17 @@ const { isEntityId } = require('wikibase-sdk')
 const getJson = require('./request/get_json')
 let prefixesMapPromise
 
-module.exports = async (title, instance) => {
+module.exports = async (title, instanceApiEndpoint) => {
   if (!isEntityId(title)) return
-  prefixesMapPromise = prefixesMapPromise || getPrefixesMap(instance)
+  prefixesMapPromise = prefixesMapPromise || getPrefixesMap(instanceApiEndpoint)
   const prefixesMap = await prefixesMapPromise
   const idFirstLetter = title[0]
   const prefix = prefixesMap[idFirstLetter]
   return prefix === '' ? title : `${prefix}:${title}`
 }
 
-const getPrefixesMap = instance => {
-  const infoUrl = `${instance}/w/api.php?action=query&meta=siteinfo&siprop=namespaces&format=json`
+const getPrefixesMap = instanceApiEndpoint => {
+  const infoUrl = `${instanceApiEndpoint}?action=query&meta=siteinfo&siprop=namespaces&format=json`
   return getJson(infoUrl)
   .then(parsePrefixesMap)
 }

diff --git a/tests/integration/utils/utils.js b/tests/integration/utils/utils.js
@@ -7,7 +7,7 @@ const resolveTitle = require('lib/resolve_title')
 
 const getRevisions = async ({ id, customInstance, limit, props }) => {
   customInstance = customInstance || instance
-  const title = await resolveTitle(id, customInstance)
+  const title = await resolveTitle(id, `${customInstance}/w/api.php`)
   const customWbk = WBK({ instance: customInstance })
   const url = customWbk.getRevisions(title, { limit, props })
   const { query } = await fetch(url).then(res => res.json())

diff --git a/tests/unit/parse_instance.js b/tests/unit/parse_instance.js
@@ -8,12 +8,21 @@ describe('parseInstance', () => {
     parseInstance.bind(null, {}).should.throw('missing config parameter: instance')
   })
 
-  it('return an instance and sparql endpoint', () => {
+  it('should return an instance and sparql endpoint', () => {
     const configA = { instance }
     const configB = { instance: apiEndpoint }
     parseInstance(configA)
     parseInstance(configB)
     configA.instance.should.equal(instance)
     configB.instance.should.equal(instance)
   })
+
+  it('should allow to customize the script path', () => {
+    const configA = { instance, wgScriptPath: 'foo' }
+    const configB = { instance, wgScriptPath: '/foo' }
+    parseInstance(configA)
+    configA.instanceApiEndpoint.should.equal(`${instance}/foo/api.php`)
+    parseInstance(configB)
+    configB.instanceApiEndpoint.should.equal(`${instance}/foo/api.php`)
+  })
 })