Skip to content

Commit

Permalink
Merge branch 'master' of github.com:AnyFetch/anyfetch.js into circle
Browse files Browse the repository at this point in the history
Conflicts:
	package.json
  • Loading branch information
Neamar committed Dec 11, 2014
2 parents dc51be7 + 72f91ac commit 8707ccf
Show file tree
Hide file tree
Showing 21 changed files with 116 additions and 64 deletions.
12 changes: 6 additions & 6 deletions bin/make-doc.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ var applyAliases = function(descriptors, aliases) {
descriptors[alias] = descriptors[original];
delete descriptors[original];
});
}
};

var groupByEndpoint = function(descriptors) {
var grouped = {};
Expand Down Expand Up @@ -52,15 +52,15 @@ var generateSignature = function(functionName, descriptor) {
}
if(descriptor.params) {
args.push('[params]');
var params = descriptor.params.map(function(param){
var params = descriptor.params.map(function(param) {
return '`' + param + '`';
});
details += ' - `params` (object): will be passed as GET parameters.\n';
details += ' Supported keys: ' + params.join(', ') + '\n';
}
if(descriptor.body) {
args.push('[body]');
var body = descriptor.body.map(function(key){
var body = descriptor.body.map(function(key) {
return '`' + key + '`';
});

Expand All @@ -77,7 +77,7 @@ var generateSignature = function(functionName, descriptor) {
result += '\n';
}
return result;
}
};

var generateBody = function(descriptorsByEndpoint) {
var body = '## Mapping functions ordered by API endpoint\n\n';
Expand Down Expand Up @@ -112,7 +112,7 @@ var generateBody = function(descriptorsByEndpoint) {
});

return body;
}
};

var writeMarkdown = function(content) {
fs.writeFileSync(outputFilename, content);
Expand All @@ -128,6 +128,6 @@ var make = function() {

console.log('Reference documentation written to ' + outputFilename);
process.exit(0);
}
};

make();
3 changes: 1 addition & 2 deletions bin/make-mocks.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ var mockEndpoint = function(name, args, cb) {
cb(err);
});

console.log(name, args);
anyfetch[name].apply(anyfetch, args);
};

Expand Down Expand Up @@ -170,7 +169,7 @@ mkdirp(mocksDirectory, function(err) {
var pre = anyfetch.getDocumentsById(documentId);
var c = configuration.apiDescriptors.getDocumentsById.subFunctions;

async.map(subs, function(name, cb){
async.map(subs, function(name, cb) {
pre[name](function(err, res) {
saveMock(c[name], res.body);
cb(err);
Expand Down
2 changes: 1 addition & 1 deletion bin/run-test-server.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ var port = configuration.test.port;
var testServer = createTestServer();
testServer.listen(port, function() {
console.log('Test server listening on port ' + port);
});
});
5 changes: 4 additions & 1 deletion config/configuration.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ module.exports = {
},
fakeCompany: {
name: 'the_fake_subcompany',
hydraters: []
},
fakeDocument: {
identifier: 'the "unique" document identifier (éüà)',
Expand All @@ -73,6 +72,8 @@ module.exports = {
foo: 'some_string'
},
metadata: {
title: 'Document title',
path: '/document.txt',
some_key: 'some random sentence'
}
},
Expand All @@ -83,6 +84,8 @@ module.exports = {
foo: 'some_other_string'
},
metadata: {
title: 'Document #2 title',
path: '/document2.txt',
some_key: 'some different random sentence'
}
},
Expand Down
2 changes: 1 addition & 1 deletion lib/test-server/mocks/get-company.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@
"user_count": 13,
"subcompany_count": 1,
"documents_per_update": 5000,
"last_update": "2014-12-10T14:49:41.647Z"
"last_update": "2014-12-10T15:05:32.750Z"
}
8 changes: 4 additions & 4 deletions lib/test-server/mocks/get-document_types.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
}
},
"document_count": 1,
"updated": "2014-12-10T14:50:42.835Z"
"updated": "2014-12-10T15:09:14.681Z"
},
{
"_type": "DocumentType",
Expand Down Expand Up @@ -331,8 +331,8 @@
"description": "An event, from a calendar for instance.",
"projections": {
"title": "{ \"name\": \"{{attr \"name\"}}\" }",
"full": "{\n \"eventName\": \"{{attr 'name'}}\",\n \"startDate\": \"{{dateRfc metadata.startDate}}\",\n \"endDate\": \"{{dateRfc metadata.endDate}}\",\n \"description\": \"{{attr 'description'}}\",\n \"organizer\": \"{{#if name}}{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}{{/if}} <{{#escapeQuotes .}}{{mail}}{{/escapeQuotes}}>\",\n \"attendee\": [\n {{#list metadata.attendee}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{mail}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"location\" : \"{{#if metadata.location}}{{attr 'location'}}{{/if}}\"\n}\n",
"snippet": "{\n \"eventName\": \"{{attr 'name'}}\",\n \"startDate\": \"{{dateRfc metadata.startDate}}\",\n \"endDate\": \"{{dateRfc metadata.endDate}}\",\n \"description\": \"{{attr 'description'}}\",\n \"organizer\": \"{{#if name}}{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}{{/if}} <{{#escapeQuotes .}}{{mail}}{{/escapeQuotes}}>\",\n \"attendee\": [\n {{#list metadata.attendee}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{mail}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"location\" : \"{{#if metadata.location}}{{attr 'location'}}{{/if}}\"\n}\n"
"full": "{\n \"eventName\": \"{{attr 'name'}}\",\n \"startDate\": \"{{dateRfc metadata.startDate}}\",\n \"endDate\": \"{{dateRfc metadata.endDate}}\",\n \"description\": \"{{#toBr}}{{attr 'description'}}{{/toBr}}\",\n \"organizer\": \"{{#if name}}{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}{{/if}} <{{#escapeQuotes .}}{{mail}}{{/escapeQuotes}}>\",\n \"attendee\": [\n {{#list metadata.attendee}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{mail}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"location\" : \"{{#if metadata.location}}{{attr 'location'}}{{/if}}\"\n}\n",
"snippet": "{\n \"eventName\": \"{{attr 'name'}}\",\n \"startDate\": \"{{dateRfc metadata.startDate}}\",\n \"endDate\": \"{{dateRfc metadata.endDate}}\",\n \"description\": \"{{#toBr}}{{attr 'description'}}{{/toBr}}\",\n \"organizer\": \"{{#if name}}{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}{{/if}} <{{#escapeQuotes .}}{{mail}}{{/escapeQuotes}}>\",\n \"attendee\": [\n {{#list metadata.attendee}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{mail}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"location\" : \"{{#if metadata.location}}{{attr 'location'}}{{/if}}\"\n}\n"
},
"es_mapping": {
"properties": {
Expand Down Expand Up @@ -398,7 +398,7 @@
"description": "An email thread or conversation",
"projections": {
"title": "{ \"subject\": \"{{attr \"subject\"}}\" }",
"full": "{\n \"subject\": \"{{attr 'subject'}}\",\n \"date\": \"{{dateRfc metadata.date}}\",\n \"participants\": [\n {{#list metadata.participants}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{address}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"labels\": [ {{#list metadata.labels}}\"{{#escapeQuotes .}}{{.}}{{/escapeQuotes}}\"{{/list}} ],\n \"messages\": [\n {{#reverseList metadata.messages sibling=data.messages}}\n {\n \"subject\": \"{{#escapeQuotes .}}{{subject}}{{/escapeQuotes}}\",\n {{#if date}}\n \"date\": \"{{dateRfc date}}\",\n {{/if}}\n \"from\": [\n {{#list from}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{address}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"to\": [\n {{#list to}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{address}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"html\":\n {{#contextLookup ../data.messages reverse=true field=@index}}\n {{#if looked.html}}\n \"{{htmlHighlighter looked.html}}\"\n {{else}}\n \"{{textHighlighter text}}\"\n {{/if}}\n {{/contextLookup}}\n }\n {{/reverseList}}\n ],\n \"attachmentCount\": {{safeInt metadata.attachmentsCount}},\n \"messagesCount\": {{safeInt metadata.messages.length}},\n \"participantsCount\": {{safeInt metadata.participants.length}},\n \"singleEmail\":\n {{#if metadata.messages.[1]}}\n false\n {{else}}\n true\n {{/if}}\n\n}\n",
"full": "{\n \"subject\": \"{{attr 'subject'}}\",\n \"date\": \"{{dateRfc metadata.date}}\",\n \"participants\": [\n {{#list metadata.participants}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{address}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"labels\": [ {{#list metadata.labels}}\"{{#escapeQuotes .}}{{.}}{{/escapeQuotes}}\"{{/list}} ],\n \"messages\": [\n {{#reverseList metadata.messages sibling=data.messages}}\n {\n \"subject\": \"{{#escapeQuotes .}}{{subject}}{{/escapeQuotes}}\",\n {{#if date}}\n \"date\": \"{{dateRfc date}}\",\n {{/if}}\n \"from\": [\n {{#list from}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{address}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"to\": [\n {{#list to}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{#escapeQuotes .}}{{address}}{{/escapeQuotes}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"html\":\n {{#contextLookup ../data.messages reverse=true field=@index}}\n {{#if looked.html}}\n \"{{htmlHighlighter looked.html}}\"\n {{else}}\n \"{{#toBr}}{{textHighlighter text}}{{/toBr}}\"\n {{/if}}\n {{/contextLookup}}\n }\n {{/reverseList}}\n ],\n \"attachmentCount\": {{safeInt metadata.attachmentsCount}},\n \"messagesCount\": {{safeInt metadata.messages.length}},\n \"participantsCount\": {{safeInt metadata.participants.length}},\n \"singleEmail\":\n {{#if metadata.messages.[1]}}\n false\n {{else}}\n true\n {{/if}}\n\n}\n",
"snippet": "{\n \"subject\": \"{{attr 'subject'}}\",\n \"date\": \"{{dateRfc metadata.date}}\",\n \"participants\": [\n {{#list metadata.participants l=3}}\n {\n {{#if name}}\"name\": \"{{#escapeQuotes .}}{{name}}{{/escapeQuotes}}\",{{/if}}\n \"address\": \"{{hideDomainEmail address}}\",\n \"highlight\": {{isHighlight .}}\n }\n {{/list}}\n ],\n \"labels\": [ {{#list metadata.labels}}\"{{.}}\"{{/list}} ],\n \"snippet\":\n {{#contextLookup highlight field='messages.text'}}\n {{#if looked}}\n \"{{#escapeQuotes .}}{{{looked}}}{{/escapeQuotes}}\"\n {{else}}\n {{#if highlight.text}}\n \"{{#escapeQuotes .}}{{{highlight.text}}}{{/escapeQuotes}}\"\n {{else}}\n {{#last metadata.messages}}\n \"{{#escapeQuotes .}}{{#shorten .}}{{text}}{{/shorten}}{{/escapeQuotes}}\"\n {{else}}\n \"\"\n {{/last}}\n {{/if}}\n {{/if}}\n {{/contextLookup}},\n \"attachmentCount\": {{safeInt metadata.attachmentsCount}},\n \"participantsCount\": {{safeInt metadata.participants.length}},\n \"messagesCount\": {{safeInt metadata.messages.length}},\n \"singleEmail\":\n {{#if metadata.messages.[1]}}\n false\n {{else}}\n true\n {{/if}}\n}\n"
},
"es_mapping": {
Expand Down
10 changes: 6 additions & 4 deletions lib/test-server/mocks/get-documents-id-raw.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"_type": "Document",
"id": "54885dc2caef098362955e4f",
"id": "5488621a42d43c8b0b302733",
"identifier": "the \"unique\" document identifier (éüà)",
"creation_date": "2014-12-10T14:50:42.784Z",
"modification_date": "2014-12-10T14:50:42.784Z",
"creation_date": "2014-12-10T15:09:14.626Z",
"modification_date": "2014-12-10T15:09:14.626Z",
"provider": {
"_type": "AccessToken",
"id": "54885c04e782a7946271cf00",
Expand Down Expand Up @@ -42,12 +42,14 @@
}
},
"actions": {},
"document_url": "https://api-staging.anyfetch.com/documents/54885dc2caef098362955e4f",
"document_url": "https://api-staging.anyfetch.com/documents/5488621a42d43c8b0b302733",
"projection_type": "raw",
"data": {
"foo": "some_string"
},
"metadata": {
"title": "Document title",
"path": "/document.txt",
"some_key": "some random sentence"
},
"last_hydration": null,
Expand Down
2 changes: 1 addition & 1 deletion lib/test-server/mocks/get-documents-id-related.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": {
"title": "Unknown document: no path."
"title": "Document title"
},
"document_type": {
"_type": "DocumentType",
Expand Down
4 changes: 3 additions & 1 deletion lib/test-server/mocks/get-documents-id-similar.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": {
"title": "Unknown document: no path."
"title": "Document title"
},
"document_type": {
"_type": "DocumentType",
Expand All @@ -11,6 +11,8 @@
}
},
"keywords": [
"title",
"/document.txt",
"some",
"random"
],
Expand Down
14 changes: 7 additions & 7 deletions lib/test-server/mocks/get-documents-id.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"_type": "Document",
"id": "54885dc2caef098362955e4f",
"id": "5488621a42d43c8b0b302733",
"identifier": "the \"unique\" document identifier (éüà)",
"creation_date": "2014-12-10T14:50:42.784Z",
"modification_date": "2014-12-10T14:50:42.784Z",
"creation_date": "2014-12-10T15:09:14.626Z",
"modification_date": "2014-12-10T15:09:14.626Z",
"provider": {
"_type": "AccessToken",
"id": "54885c04e782a7946271cf00",
Expand All @@ -22,12 +22,12 @@
}
},
"actions": {},
"document_url": "https://api-staging.anyfetch.com/documents/54885dc2caef098362955e4f",
"document_url": "https://api-staging.anyfetch.com/documents/5488621a42d43c8b0b302733",
"projection_type": "full",
"data": {
"title": "Unknown document: no path.",
"path": "",
"extension": "_blank"
"title": "Document title",
"path": "/document.txt",
"extension": "txt"
},
"related": []
}
14 changes: 7 additions & 7 deletions lib/test-server/mocks/get-documents-identifier-identifier.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"_type": "Document",
"id": "54885dc2caef098362955e4f",
"id": "5488621a42d43c8b0b302733",
"identifier": "the \"unique\" document identifier (éüà)",
"creation_date": "2014-12-10T14:50:42.784Z",
"modification_date": "2014-12-10T14:50:42.784Z",
"creation_date": "2014-12-10T15:09:14.626Z",
"modification_date": "2014-12-10T15:09:14.626Z",
"provider": {
"_type": "AccessToken",
"id": "54885c04e782a7946271cf00",
Expand All @@ -22,12 +22,12 @@
}
},
"actions": {},
"document_url": "https://api-staging.anyfetch.com/documents/54885dc2caef098362955e4f",
"document_url": "https://api-staging.anyfetch.com/documents/5488621a42d43c8b0b302733",
"projection_type": "full",
"data": {
"title": "Unknown document: no path.",
"path": "",
"extension": "_blank"
"title": "Document title",
"path": "/document.txt",
"extension": "txt"
},
"related": []
}
14 changes: 7 additions & 7 deletions lib/test-server/mocks/get-documents.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
"data": [
{
"_type": "Document",
"id": "54885dc2caef098362955e4f",
"id": "5488621a42d43c8b0b302733",
"identifier": "the \"unique\" document identifier (éüà)",
"creation_date": "2014-12-10T14:50:42.784Z",
"modification_date": "2014-12-10T14:50:42.784Z",
"creation_date": "2014-12-10T15:09:14.626Z",
"modification_date": "2014-12-10T15:09:14.626Z",
"provider": {
"_type": "AccessToken",
"id": "54885c04e782a7946271cf00",
Expand All @@ -52,12 +52,12 @@
}
},
"actions": {},
"document_url": "https://api-staging.anyfetch.com/documents/54885dc2caef098362955e4f",
"document_url": "https://api-staging.anyfetch.com/documents/5488621a42d43c8b0b302733",
"projection_type": "snippet",
"data": {
"title": "Unknown document: no path.",
"path": "",
"extension": "_blank"
"title": "Document title",
"path": "/document.txt",
"extension": "txt"
},
"related_count": 0,
"score": 2
Expand Down
2 changes: 1 addition & 1 deletion lib/test-server/mocks/get-index.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@
"update_url": "https://api-staging.anyfetch.com/company/update",
"reset_url": "https://api-staging.anyfetch.com/company/reset",
"token_url": "https://api-staging.anyfetch.com/token",
"server_time": "2014-12-10T14:50:43.585Z"
"server_time": "2014-12-10T15:09:15.433Z"
}
2 changes: 1 addition & 1 deletion lib/test-server/mocks/get-providers.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"account_name": "",
"current": true,
"document_count": 1,
"updated": "2014-12-10T14:50:42.835Z",
"updated": "2014-12-10T15:09:14.681Z",
"providing": true
}
]
20 changes: 17 additions & 3 deletions lib/test-server/mocks/get-subcompanies-id.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
{
"_type": "Company",
"id": "54885dc3e782a7946271cf11",
"id": "5488621ae181a1a20b5aa579",
"name": "the_fake_subcompany",
"hydraters": [],
"hydraters": [
"https://deduplicator-staging.anyfetch.com/hydrate",
"https://embedmail-staging.anyfetch.com/hydrate",
"https://eml-staging.anyfetch.com/hydrate",
"https://event-staging.anyfetch.com/hydrate",
"https://filecleaner-staging.anyfetch.com/hydrate",
"https://ics-staging.anyfetch.com/hydrate",
"https://image-staging.anyfetch.com/hydrate",
"https://iptc-staging.anyfetch.com/hydrate",
"https://markdown-staging.anyfetch.com/hydrate",
"https://ocr-staging.anyfetch.com/hydrate",
"https://office-staging.anyfetch.com/hydrate",
"https://pdf-staging.anyfetch.com/hydrate",
"https://plaintext-staging.anyfetch.com/hydrate"
],
"document_count": 0,
"user_count": 1,
"subcompany_count": 0,
"documents_per_update": 5000,
"last_update": "2014-12-10T14:50:43.129Z",
"last_update": "2014-12-10T15:09:14.862Z",
"childs": []
}
20 changes: 17 additions & 3 deletions lib/test-server/mocks/get-subcompanies.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,28 @@
[
{
"_type": "Company",
"id": "54885dc3e782a7946271cf11",
"id": "5488621ae181a1a20b5aa579",
"name": "the_fake_subcompany",
"hydraters": [],
"hydraters": [
"https://deduplicator-staging.anyfetch.com/hydrate",
"https://embedmail-staging.anyfetch.com/hydrate",
"https://eml-staging.anyfetch.com/hydrate",
"https://event-staging.anyfetch.com/hydrate",
"https://filecleaner-staging.anyfetch.com/hydrate",
"https://ics-staging.anyfetch.com/hydrate",
"https://image-staging.anyfetch.com/hydrate",
"https://iptc-staging.anyfetch.com/hydrate",
"https://markdown-staging.anyfetch.com/hydrate",
"https://ocr-staging.anyfetch.com/hydrate",
"https://office-staging.anyfetch.com/hydrate",
"https://pdf-staging.anyfetch.com/hydrate",
"https://plaintext-staging.anyfetch.com/hydrate"
],
"document_count": 0,
"user_count": 1,
"subcompany_count": 0,
"documents_per_update": 5000,
"last_update": "2014-12-10T14:50:43.129Z",
"last_update": "2014-12-10T15:09:14.862Z",
"childs": []
}
]
8 changes: 5 additions & 3 deletions lib/test-server/mocks/post-company-update.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"53234698c8318cc5d100004f": 202,
"5320a682c8318cba94000040": 202,
"5320a6abc8318cc5d1000049": 429
"52f0bb24c8318c2d65000036": {},
"5460f239fc0973bc40c19b23": {},
"5409823bee7d24ef49b598fa": {},
"542d1639ecc49603190b329b": {},
"542d1758ecc49603190b32a7": {}
}

0 comments on commit 8707ccf

Please sign in to comment.