feat(*): add 'search books by title' query

Author: ryanomackey

package.json

@@ -1,12 +1,13 @@
 {
-  "name": "@gramps/data-source-base",
-  "description": "Base modules for a GrAMPS GraphQL data source.",
+  "name": "@gramps/data-source-openlibrary",
+  "description": "GrAMPS GraphQL data source for the OpenLibrary API.",
   "contributors": [
-    "Jason Lengstorf <[email protected]>"
+    "Jason Lengstorf <[email protected]>",
+    "Ryan Mackey <[email protected]>"
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/gramps-graphql/data-source-base.git"
+    "url": "https://github.com/gramps-graphql/data-source-openlibrary.git"
   },
   "main": "dist/index.js",
   "directories": {

src/connector.js

@@ -1,10 +1,9 @@
 import { GraphQLConnector } from '@gramps/gramps-express';
 
-// TODO: change `YourDataSourceConnector` to a descriptive name
-export default class YourDataSourceConnector extends GraphQLConnector {
+export default class OpenLibraryConnector extends GraphQLConnector {
   /**
-   * TODO: describe this API endpoint
+   * Open Library URL
    * @member {string}
    */
-  apiBaseUri = `https://example.org/v2`;
+  apiBaseUri = `https://openlibrary.org`;
 }

src/index.js

@@ -8,8 +8,7 @@ import Model from './model';
  * https://ibm.biz/graphql-data-source-main
  */
 export default {
-  // TODO: Rename the context to describe the data source.
-  context: 'YourDataSource',
+  context: 'OpenLibrary',
   model: new Model({ connector: new Connector() }),
   schema,
   resolvers,

src/model.js

@@ -5,19 +5,16 @@ import { GraphQLModel, GrampsError } from '@gramps/gramps-express';
  * https://ibm.biz/graphql-data-source-model
  */
 
-// TODO: change `YourDataSourceModel` to a descriptive name
-export default class YourDataSourceModel extends GraphQLModel {
+export default class OpenLibraryModel extends GraphQLModel {
   /**
-   * Loads a thing by its ID
-   * @param  {String}  id  the ID of the thing to load
+   * Search for books
+   * @param  {String}  title  the title of the thing to load
    * @return {Promise}     resolves with the loaded user data
    */
-  getById(id) {
-    return this.connector.get(`/data/${id}`).catch(res =>
+  searchBooksByTitle(title) {
+    return this.connector.get(`/search.json?q=${title}`).catch(res =>
       this.throwError(res, {
-        description: 'This is an example call. Add your own!',
-        docsLink:
-          'https://gramps-graphql.github.io/gramps-express/data-source/tutorial/',
+        description: 'Error querying OpenLibrary.',
       }),
     );
   }

src/resolvers.js

@@ -1,4 +1,4 @@
-import { MockList } from 'graphql-tools';
+// import { MockList } from 'graphql-tools';
 import casual from 'casual';
 
 /*
@@ -9,33 +9,40 @@ import casual from 'casual';
 export default {
   // Queries (where does the data come from?)
   queryResolvers: {
-    // TODO: Update query resolver name(s) to match schema queries
-    YourDataSource: (rootValue, { id }, context) =>
+    SearchBooksByTitle: (rootValue, { title }, context) =>
       new Promise((resolve, reject) => {
-        // TODO: Update to use the model and call the proper method.
-        context.YourDataSource
-          .getById(id)
-          .then(resolve)
+        context.OpenLibrary
+          .searchBooksByTitle(title)
+          .then(data => resolve(data.docs[0]))
           .catch(reject);
       }),
   },
 
   // Data fields (which data from the response goes to which field?)
   dataResolvers: {
-    // TODO: Update to reference the schema type(s) and field(s).
-    PFX_YourDataSource: {
-      // If a field isn’t always set, but it shouldn’t break the response, make it nullable.
-      name: data => data.name || null,
+    OL_SearchResult: {
+      title: data => data.title_suggest || null,
+      author: data => {
+        if (data.author_name && data.author_name.length) {
+          return data.author_name[0];
+        }
+        return null;
+      },
+      isbn: data => {
+        if (data.isbn && data.isbn.length) {
+          return data.isbn[0];
+        }
+        return null;
+      },
     },
   },
 
   // Mock data (How can I get real-feeling fake data while working offline?)
   mockResolvers: {
-    // TODO: Update to mock all schema fields and types.
-    PFX_YourDataSource: () => ({
-      id: casual.uuid,
-      name: casual.name,
-      lucky_numbers: () => new MockList([0, 3]),
+    OL_SearchResult: () => ({
+      title: casual.title,
+      author: casual.name,
+      isbn: casual.uuid,
     }),
   },
 };

src/schema.graphql

@@ -1,17 +1,9 @@
-# The query/queries to access data MUST extend the Query type.
 extend type Query {
-  # TODO: rename and add a description of this query
-  YourDataSource(
-    # TODO: Describe this argument
-    id: ID!
-  ): PFX_YourDataSource
+  SearchBooksByTitle(title: String!): OL_SearchResult
 }
 
-# TODO: Choose a unique prefix and rename the type descriptively.
-type PFX_YourDataSource {
-  # The unique ID of the thing.
-  id: ID!
-  # Describe each field to help people use the data more effectively.
-  name: String
-  lucky_numbers: [Int]
+type OL_SearchResult {
+  title: String!
+  author: String
+  isbn: String
 }

test/connector.test.js

@@ -1,8 +1,7 @@
 import { GraphQLConnector } from '@gramps/gramps-express';
 import Connector from '../src/connector';
 
-// TODO: Update the data source name.
-const DATA_SOURCE_NAME = 'YourDataSource';
+const DATA_SOURCE_NAME = 'openlibrary';
 const connector = new Connector();
 
 describe(`${DATA_SOURCE_NAME}Connector`, () => {
@@ -11,7 +10,6 @@ describe(`${DATA_SOURCE_NAME}Connector`, () => {
   });
 
   it('uses the appropriate URL', () => {
-    // TODO: Update the data source API endpoint.
-    expect(connector.apiBaseUri).toBe(`https://example.org/v2`);
+    expect(connector.apiBaseUri).toBe(`https://openlibrary.org`);
   });
 });

test/index.test.js

@@ -1,8 +1,7 @@
 import dataSource from '../src';
 import Model from '../src/model';
 
-// TODO: Update the data source name.
-const DATA_SOURCE_NAME = 'YourDataSource';
+const DATA_SOURCE_NAME = 'OpenLibrary';
 
 describe(`Data Source: ${DATA_SOURCE_NAME}`, () => {
   it('returns a context type', () => {

test/model.test.js

@@ -10,8 +10,7 @@ jest.mock('../src/connector', () =>
   })),
 );
 
-// TODO: Update the data source name.
-const DATA_SOURCE_NAME = 'YourDataSource';
+const DATA_SOURCE_NAME = 'OpenLibrary';
 
 const connector = new Connector();
 const model = new Model({ connector });
@@ -22,12 +21,12 @@ describe(`${DATA_SOURCE_NAME}Model`, () => {
   });
 
   // TODO: Update this test to use your model’s method(s).
-  describe('getById()', () => {
-    it('calls the correct endpoint with a given ID', () => {
+  describe('searchBooksByTitle()', () => {
+    it('calls the correct endpoint with a given title', () => {
       const spy = jest.spyOn(connector, 'get');
 
-      model.getById('1234');
-      expect(spy).toHaveBeenCalledWith('/data/1234');
+      model.searchBooksByTitle('Fight Club');
+      expect(spy).toHaveBeenCalledWith('/search.json?q=Fight Club');
     });
 
     it('throws a GrampsError if something goes wrong', async () => {
@@ -38,8 +37,7 @@ describe(`${DATA_SOURCE_NAME}Model`, () => {
       );
 
       try {
-        // TODO: Update to use one of your model’s methods.
-        await model.getById('1234');
+        await model.searchBooksByTitle('Fight Club');
       } catch (error) {
         expect(error.isBoom).toEqual(true);
       }
@@ -51,7 +49,7 @@ describe(`${DATA_SOURCE_NAME}Model`, () => {
     const mockError = {
       statusCode: 401,
       options: {
-        uri: 'https://example.org/',
+        uri: 'https://openlibrary.org',
       },
     };
 
@@ -67,15 +65,14 @@ describe(`${DATA_SOURCE_NAME}Model`, () => {
       );
 
       try {
-        // TODO: Update to use one of your model’s methods.
-        await model.getById(1234);
+        await model.searchBooksByTitle('Fight Club');
       } catch (error) {
         // Check that GrampsError properly received the error detail.
         expect(error).toHaveProperty('isBoom', true);
         expect(error.output).toHaveProperty('statusCode', 401);
         expect(error.output.payload).toHaveProperty(
           'targetEndpoint',
-          'https://example.org/',
+          'https://openlibrary.org',
         );
         expect(error.output.payload).toHaveProperty(
           'graphqlModel',

test/resolvers.test.js

@@ -1,10 +1,9 @@
 import resolvers from '../src/resolvers';
 import expectMockFields from './helpers/expectMockFields';
-import expectMockList from './helpers/expectMockList';
+// import expectMockList from './helpers/expectMockList';
 import expectNullable from './helpers/expectNullable';
 
-// TODO: Update the data source name.
-const DATA_SOURCE_NAME = 'YourDataSource';
+const DATA_SOURCE_NAME = 'OpenLibrary';
 
 describe(`${DATA_SOURCE_NAME} resolvers`, () => {
   it('returns valid resolvers', () => {
@@ -15,37 +14,41 @@ describe(`${DATA_SOURCE_NAME} resolvers`, () => {
     ]);
   });
 
+  const modelResult = {
+    title_suggest: 'Fight Club',
+    author_name: ['Chuck Palahniuk'],
+    isbn: ['9782070422401'],
+  };
+
   describe('queryResolvers', () => {
     describe(DATA_SOURCE_NAME, () => {
-      it('loads a thing by its ID', () => {
+      it('searches for a book by title', () => {
         expect.assertions(1);
 
         const req = {};
 
-        // TODO: Update with mock arguments for your model method.
-        const args = { id: 'abc1234' };
+        const args = { title: 'Fight Club' };
 
-        // TODO: Update with the data source model name and method(s).
         const mockContext = {
-          YourDataSource: {
-            // For testing, we mock the model to simply return the ID.
-            getById: id => Promise.resolve(id),
+          OpenLibrary: {
+            searchBooksByTitle: () => Promise.resolve({ docs: [modelResult] }),
           },
         };
 
         return expect(
-          // TODO: Update to use your data source.
-          resolvers.queryResolvers.YourDataSource(req, args, mockContext),
-        ).resolves.toEqual('abc1234');
+          resolvers.queryResolvers.SearchBooksByTitle(req, args, mockContext),
+        ).resolves.toEqual(modelResult);
       });
     });
   });
 
   describe('dataResolvers', () => {
-    describe('PFX_YourDataSource', () => {
-      const resolver = resolvers.dataResolvers.PFX_YourDataSource;
-
-      expectNullable(resolver, ['name']);
+    describe('OL_SearchResult', () => {
+      const resolver = resolvers.dataResolvers.OL_SearchResult;
+      expect(resolver.title(modelResult)).toBe('Fight Club');
+      expect(resolver.author(modelResult)).toBe('Chuck Palahniuk');
+      expect(resolver.isbn(modelResult)).toBe('9782070422401');
+      expectNullable(resolver, ['title', 'author', 'isbn']);
     });
   });
 
@@ -55,11 +58,10 @@ describe(`${DATA_SOURCE_NAME} resolvers`, () => {
      * exploding. To that end, we’ll just check that the mock response returns
      * the proper fields.
      */
-    describe('PFX_YourDataSource', () => {
-      const mockResolvers = resolvers.mockResolvers.PFX_YourDataSource();
+    describe('OL_SearchResult', () => {
+      const mockResolvers = resolvers.mockResolvers.OL_SearchResult();
 
-      expectMockFields(mockResolvers, ['id', 'name', 'lucky_numbers']);
-      expectMockList(mockResolvers, ['lucky_numbers']);
+      expectMockFields(mockResolvers, ['title', 'author', 'isbn']);
     });
   });
 });