feat(geo): add support for geography (#397)

* first attempt to add geo. trying to locate which portions of code need to be touched. tests totally failing

* linted

* exclude geography from being promisified

* add geography to custom class list for encoding values

* add unit and system tests for geography

* Added test

* remove unnecessary comments

* update geography tests, removed skipped test

* add unit test for geography instance method

* add trailing commas

src/index.ts

@@ -404,6 +404,10 @@ export class BigQuery extends common.Service {
           value = BigQuery.timestamp(new Date(value * 1000));
           break;
         }
+        case 'GEOGRAPHY': {
+          value = BigQuery.geography(value);
+          break;
+        }
         default:
           break;
       }
@@ -651,6 +655,38 @@ export class BigQuery extends common.Service {
     return BigQuery.timestamp(value);
   }
 
+  /**
+   * A geography value represents a surface area on the Earth
+   * in Well-known Text (WKT) format.
+   *
+   * @method BigQuery.geography
+   * @param {string} value The geospatial data.
+   *
+   * @example
+   * const {BigQuery} = require('@google-cloud/bigquery');
+   * const geography = BigQuery.geography('POINT(1, 2)');
+   */
+
+  /**
+   * A geography value represents a surface area on the Earth
+   * in Well-known Text (WKT) format.
+   *
+   * @method BigQuery#geography
+   * @param {string} value The geospatial data.
+   *
+   * @example
+   * const {BigQuery} = require('@google-cloud/bigquery');
+   * const bigquery = new BigQuery();
+   * const geography = bigquery.geography('POINT(1, 2)');
+   */
+  static geography(value: string) {
+    return new Geography(value);
+  }
+
+  geography(value: string) {
+    return BigQuery.geography(value);
+  }
+
   /**
    * Detect a value's type.
    *
@@ -1504,7 +1540,15 @@ paginator.extend(BigQuery, ['getDatasets', 'getJobs']);
  * that a callback is omitted.
  */
 promisifyAll(BigQuery, {
-  exclude: ['dataset', 'date', 'datetime', 'job', 'time', 'timestamp'],
+  exclude: [
+    'dataset',
+    'date',
+    'datetime',
+    'geography',
+    'job',
+    'time',
+    'timestamp',
+  ],
 });
 
 /**
@@ -1520,6 +1564,16 @@ export class BigQueryDate {
   }
 }
 
+/**
+ * Geography class for BigQuery.
+ */
+export class Geography {
+  value: string;
+  constructor(value: string) {
+    this.value = value;
+  }
+}
+
 /**
  * Timestamp class for BigQuery.
  */

src/table.ts

@@ -433,6 +433,7 @@ class Table extends common.ServiceObject {
       'BigQueryDatetime',
       'BigQueryTime',
       'BigQueryTimestamp',
+      'Geography',
     ];
     const constructorName = value.constructor.name;
     const isCustomType =

system-test/bigquery.ts

@@ -37,6 +37,10 @@ describe('BigQuery', () => {
   const query = 'SELECT url FROM `publicdata.samples.github_nested` LIMIT 100';
 
   const SCHEMA = [
+    {
+      name: 'place',
+      type: 'GEOGRAPHY',
+    },
     {
       name: 'id',
       type: 'INTEGER',
@@ -1027,6 +1031,19 @@ describe('BigQuery', () => {
                 });
           });
 
+          it('should work with GEOGRAPHY types', done => {
+            bigquery.query(
+                {
+                  query: 'SELECT ? geography',
+                  params: [bigquery.geography('POINT(1 2)')],
+                },
+                (err, rows) => {
+                  assert.ifError(err);
+                  assert.strictEqual(rows!.length, 1);
+                  done();
+                });
+          });
+
           it('should work with multiple types', done => {
             bigquery.query(
                 {
@@ -1244,6 +1261,21 @@ describe('BigQuery', () => {
                 });
           });
 
+          it('should work with GEOGRAPHY types', done => {
+            bigquery.query(
+                {
+                  query: 'SELECT @place geography',
+                  params: {
+                    place: bigquery.geography('POINT(1 2)'),
+                  },
+                },
+                (err, rows) => {
+                  assert.ifError(err);
+                  assert.strictEqual(rows!.length, 1);
+                  done();
+                });
+          });
+
           it('should work with multiple types', done => {
             bigquery.query(
                 {
@@ -1299,6 +1331,7 @@ describe('BigQuery', () => {
     const TIME = bigquery.time('14:00:00');
     const TIMESTAMP = bigquery.timestamp(new Date());
     const NUMERIC = new Big('123.456');
+    const GEOGRAPHY = bigquery.geography('POINT(1 2)');
 
     before(() => {
       table = dataset.table(generateName('table'));
@@ -1309,6 +1342,7 @@ describe('BigQuery', () => {
           'time:TIME',
           'timestamp:TIMESTAMP',
           'numeric:NUMERIC',
+          'geography:GEOGRAPHY',
         ].join(', '),
       });
     });
@@ -1320,6 +1354,7 @@ describe('BigQuery', () => {
         time: TIME,
         timestamp: TIMESTAMP,
         numeric: NUMERIC,
+        geography: GEOGRAPHY,
       });
     });
   });

test/index.ts

@@ -48,6 +48,7 @@ const fakePfy = extend({}, pfy, {
       'dataset',
       'date',
       'datetime',
+      'geography',
       'job',
       'time',
       'timestamp',
@@ -243,6 +244,13 @@ describe('BigQuery', () => {
           input,
         };
       });
+
+      sandbox.stub(BigQuery, 'geography').callsFake(input => {
+        return {
+          type: 'fakeGeography',
+          input,
+        };
+      });
     });
 
     it('should merge the schema and flatten the rows', () => {
@@ -299,6 +307,7 @@ describe('BigQuery', () => {
               {v: 'date-input'},
               {v: 'datetime-input'},
               {v: 'time-input'},
+              {v: 'geography-input'},
             ],
           },
           expected: {
@@ -336,6 +345,10 @@ describe('BigQuery', () => {
               input: 'time-input',
               type: 'fakeTime',
             },
+            geography: {
+              input: 'geography-input',
+              type: 'fakeGeography',
+            },
           },
         },
       ];
@@ -398,6 +411,11 @@ describe('BigQuery', () => {
         type: 'TIME',
       });
 
+      schemaObject.fields.push({
+        name: 'geography',
+        type: 'GEOGRAPHY',
+      });
+
       const rawRows = rows.map(x => x.raw);
       const mergedRows = BigQuery.mergeSchemaWithRows_(schemaObject, rawRows);
 
@@ -573,6 +591,31 @@ describe('BigQuery', () => {
     });
   });
 
+  describe('geography', () => {
+    const INPUT_STRING = 'POINT(1 2)';
+
+    it('should have the correct constructor name', () => {
+      const geography = BigQuery.geography(INPUT_STRING);
+      assert.strictEqual(geography.constructor.name, 'Geography');
+    });
+
+    it('should accept a string', () => {
+      const geography = BigQuery.geography(INPUT_STRING);
+      assert.strictEqual(geography.value, INPUT_STRING);
+    });
+
+    it('should call through to the static method', () => {
+      const fakeGeography = {value: 'foo'};
+
+      sandbox.stub(BigQuery, 'geography')
+          .withArgs(INPUT_STRING)
+          .returns(fakeGeography);
+
+      const geography = bq.geography(INPUT_STRING);
+      assert.strictEqual(geography, fakeGeography);
+    });
+  });
+
   describe('getType_', () => {
     it('should return correct types', () => {
       assert.strictEqual(BigQuery.getType_(bq.date()).type, 'DATE');