Merge branch 'v2000'

Author: krazyjakee

.gitignore

@@ -1,2 +1,3 @@
 config.json
 node_modules
+sandbox.js

README.md

@@ -9,9 +9,9 @@ https://www.igdb.com/api
 IGDB
 =
 
-Nodejs Wrapper for IGDB.com API. Requires an API key. Request one from your user settings screen.
+Nodejs Wrapper for IGDB.com API. Requires a Mashape.com API key.
 
-Read more: https://www.igdb.com/api/v1/documentation
+Read more: https://market.mashape.com/igdbcom/internet-game-database/overview
 
 Setup
 -
@@ -23,97 +23,55 @@ Usage
 -
 
 **Games**
-https://www.igdb.com/api/v1/documentation/games
 
-* `games.index(opts, callback)` Returns all games
+* `games(opts)` Returns all games
 ```javascript
-igdb.games.index({ limit: 5, offset: 15 }, output)
+igdb.games({ limit: 5, offset: 15, fields: "*" }).then(output)
 ```
 
-* `games.get(id, callback)` Returns game information
+* `games.get({ ids: [3766] })` Returns game information
 ```javascript
-igdb.games.get(3766, output)
+igdb.games({ ids: [3766], fields: "*" }).then(output)
 ```
 
-* `games.meta(callback)` Returns total unique games count. (IE Mass effect (xbox/ps/pc) only counts as 1)
-```javascript
-igdb.games.meta(output)
-```
-
-* `igdb.games.search(searchParamsObject, output)`
+* `igdb.games({ search: "zelda", fields: "*" })`
 
-Read details on the search parameters here: https://www.igdb.com/api/v1/documentation/games
+Read details on the search parameters here: https://market.mashape.com/igdbcom/internet-game-database/overview#wiki-filters
 
 ```javascript
-igdb.games.search({
-q: 'penguin',
-{
+igdb.games({
+  search: 'penguin',
   limit: 3,
   offset: 4,
   filters: {
-    platforms_eq: 3
+    "platforms-eq": 3
   },
-},
-output
-})
+  fields: "*"
+}).then(output)
 ```
 
 **Companies**
-https://www.igdb.com/api/v1/documentation/companies
 
-* `companies.index(opts, callback)` Returns all companies
+* `companies.index(opts).then(output)` Returns all companies
 ```javascript
-igdb.companies.index({ limit: 5, offset: 15 }, output)
+igdb.companies({ limit: 5, offset: 15, fields: "*" }).then(output)
 ```
 
 * `companies.get(id, callback)` Returns game information
 ```javascript
-igdb.companies.get('nintendo', output)
-```
-
-* `companies.meta(callback)` Returns total companies count.
-```javascript
-igdb.companies.meta(output)
-```
-
-* `igdb.companies.games(opts, companyId, output)`  Returns related games
-
-```javascript
-igdb.companies.games({
-  limit: 3,
-  offset: 4
-}, 'nintendo', output)
+igdb.companies({ search: 'nintendo', fields: "*" }).then(output)
 ```
 
-**People**
-https://www.igdb.com/api/v1/documentation/people
+Many more data entities are documented here: https://market.mashape.com/igdbcom/internet-game-database
 
-* `people.index(opts, callback)` Returns all people
-```javascript
-igdb.people.index({ limit: 5, offset: 15 }, output)
-```
+**Images**
 
-* `people.get(id, callback)` Returns game information
-```javascript
-igdb.people.get('satoru-iwata', output)
-```
+A handy image function is included to convert objects with cloudinary_ids to full urls.
 
-* `people.meta(callback)` Returns total people count.
-```javascript
-igdb.people.meta(output)
 ```
-
-* `igdb.people.games(opts, personId, output)` Returns related games
-
-```javascript
-igdb.people.games({
-  limit: 3,
-  offset: 4
-}, 'satoru-iwata', output)
+igdb.image(cover, "thumb", "jpg")
 ```
 
-* `igdb.people.titles(personId, output)` Returns job titles for this person
+More options are documented here: https://market.mashape.com/igdbcom/internet-game-database/overview#wiki-images
 
-```javascript
-igdb.people.titles('satoru-iwata', output)
-```
+Also check out the sandbox.js file for more examples.

config.json.example

@@ -1,4 +1,4 @@
 {
   "apikey": "API_KEY",
-  "endpoint": "https://www.igdb.com/api/v1/"
+  "endpoint": "https://igdbcom-internet-game-database-v1.p.mashape.com/"
 }

index.coffee

@@ -0,0 +1,94 @@
+var request = require('request'),
+config = require('./config');
+
+var perform_request = function(url, resolve, reject){
+
+  var options = {
+    url: url,
+    headers: {
+      'Accept': 'application/json',
+      'X-Mashape-Key': config.apikey
+    }
+  };
+
+  return request(options, function(error, response, body) {
+
+    if(!error){
+      error = (response.statusCode != 200 ? response.statusCode + " - " + options.url : null);
+    }
+
+    if (error) {
+      if(reject){
+        return reject(error);
+      }else{
+        throw error;
+      }
+    }
+
+    if (response.statusCode == 200 && resolve) {
+      return resolve({
+        url: options.url,
+        body: JSON.parse(body),
+        head: response.headers,
+        scroll_url: response.headers['X-Next-Page'],
+        scroll_count: response.headers['X-Count']
+      });
+    }
+  });
+}
+
+var get = function(url, fields, opts, resolve, reject) {
+  url = config.endpoint + url + "/";
+  if (opts) {
+    var optUrl = [], filter, param;
+    for (param in opts) {
+      var paramValue = opts[param];
+      if (param == "filters") {
+        for (filter in paramValue) {
+          filter_split = filter.split('-')
+          optUrl.push("filter[" + filter_split.join("][") + "]=" + paramValue[filter]);
+        }
+      } else if(param == "ids") {
+        url += paramValue.join(',')
+      } else {
+        optUrl.push(param + "=" + paramValue);
+      }
+    }
+
+    if(fields){
+      optUrl.push("fields=" + fields.join(','));
+    }
+
+    url += "?" + optUrl.join('&');
+  }
+
+  return perform_request(url, resolve, reject);
+};
+
+var endpoint = function(e){
+  return function(opts, fields) {
+    return new Promise(function(resolve, reject){
+      get(e, fields, opts, resolve, reject);
+    });
+  }
+}
+
+var endpoints = ["games", "companies", "people", "genres", "keywords", "platforms", "player_perspectives", "pulses", "themes", "franchises", "collections"],
+endpoints_obj = {
+  image: function(image_object, size, filetype){
+    if(image_object){
+      return "https://res.cloudinary.com/igdb/image/upload/t_" + (size || "thumb") + "/" + image_object.cloudinary_id + "." + (filetype || "jpg");
+    }
+  },
+  scroll: function(url){
+    return new Promise(function(resolve, reject){
+      return perform_request(url, resolve, reject);
+    });
+  }
+};
+
+for(i = 0; i < endpoints.length; i++){
+  endpoints_obj[endpoints[i]] = endpoint(endpoints[i]);
+}
+
+module.exports = endpoints_obj

index.js

@@ -1,10 +1,10 @@
 {
   "name": "igdb-api-node",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Nodejs API Wrapper for IGDB.com",
-  "main": "index.coffee",
+  "main": "index.js",
   "scripts": {
-    "test": "coffee index.coffee"
+    "test": "node index.js"
   },
   "repository": {
     "type": "git",
@@ -19,11 +19,10 @@
   "author": "",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/igdb/igdb-api-node/issues"
+    "url": "https://market.mashape.com/igdbcom/internet-game-database/support"
   },
-  "homepage": "https://github.com/igdb/igdb-api-node",
+  "homepage": "https://market.mashape.com/igdbcom/internet-game-database/overview",
   "dependencies": {
-    "coffee-script": "^1.9.3",
     "request": "^2.60.0"
   }
 }

package.json

@@ -0,0 +1,37 @@
+igdb = require('./index');
+
+function log(res){
+  for(i in res.body){
+    game = res.body[i];
+    game.cover = igdb.image(game.cover, "cover_small");
+  }
+  console.log(res.url, JSON.stringify(res.body, null, " "));
+}
+
+igdb.platforms({
+  search: "Atari",
+  limit: 2
+}, ["name"]).then(log);
+
+igdb.games({
+  search: "zelda",
+  limit: 5,
+  offset: 0,
+  order: "release_dates.date:desc",
+  filters: {
+    "release_dates.date-gt": "2010-12-31",
+    "release_dates.date-lt": "2012-01-01"
+  }
+}, ["name","release_dates.date","rating","hypes","cover"]).then(log);
+
+igdb.games({
+  ids: [18472, 18228],
+}, ["name", "cover"]).then(log);
+
+igdb.companies({
+  search: "rockstar",
+  limit: 5,
+  offset: 0,
+  order: "name:desc",
+  field: "name"
+}, ["name","logo"]).then(log);