-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add an identify
command #FF
#7
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
843d882
Add nock for mocking network requests
anandaroop 41892f9
Everything in its right place
anandaroop e90f9b4
Add an identify command that checks artists, artworks and partners
anandaroop a074047
Document the collection mapping, for future us
anandaroop ff01901
Update assumption about api route
jonallured File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
import { Command, flags } from "@oclif/command" | ||
import Gravity from "../lib/gravity" | ||
|
||
export default class Identify extends Command { | ||
static description = "Identify a Gravity resource by its BSON ID" | ||
|
||
static flags = { | ||
help: flags.help({ char: "h" }), | ||
} | ||
|
||
static args = [{ name: "id" }] | ||
|
||
static collectionsToCheck: CollectionMapping[] = [ | ||
{ name: "Artist", endpoint: "artist" }, | ||
{ name: "Artwork", endpoint: "artwork" }, | ||
{ name: "Partner", endpoint: "partner" }, | ||
] | ||
|
||
async run() { | ||
const gravity = new Gravity() | ||
const { args } = this.parse(Identify) | ||
const { id } = args | ||
|
||
const gravityPromises = Identify.collectionsToCheck.map(collection => { | ||
const resource = `${collection.endpoint}/${id}` | ||
return gravity.get(resource) | ||
}) | ||
|
||
const gravityResponses = await Promise.all(gravityPromises) | ||
const foundIndex = gravityResponses.findIndex(r => r.status === 200) | ||
|
||
if (foundIndex >= 0) { | ||
const foundCollection = Identify.collectionsToCheck[foundIndex] | ||
const foundResource = `${foundCollection.endpoint}/${id}` | ||
this.log(`${foundCollection.name} ${gravity.url(`api/v1/${foundResource}`)}`) | ||
} else { | ||
const collections = Identify.collectionsToCheck.map(c => c.name) | ||
this.log(`Nothing found in: ${collections.join(", ")}`) | ||
} | ||
} | ||
} | ||
|
||
interface CollectionMapping { | ||
/** Name of the Gravity resource */ | ||
name: string | ||
|
||
/** The name of the collection as it appears in the GET endpoint for the resource, i.e. /api/v1/<endpoint>/:id */ | ||
endpoint: string | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
import { expect, test } from "@oclif/test" | ||
|
||
describe("identify", () => { | ||
describe("when the artwork exists", () => { | ||
test | ||
.nock("https://stagingapi.artsy.net", api => | ||
api | ||
.get("/api/v1/artist/abc123") | ||
.reply(404) | ||
.get("/api/v1/artwork/abc123") | ||
.reply(200) | ||
.get("/api/v1/partner/abc123") | ||
.reply(404) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The second arg to |
||
) | ||
.stdout() | ||
.command(["identify", "abc123"]) | ||
.it("displays a found artwork message", ctx => { | ||
expect(ctx.stdout).to.equal( | ||
"Artwork https://stagingapi.artsy.net/api/v1/artwork/abc123\n" | ||
) | ||
}) | ||
}) | ||
|
||
describe("when the artist exists", () => { | ||
test | ||
.nock("https://stagingapi.artsy.net", api => | ||
api | ||
.get("/api/v1/artist/abc123") | ||
.reply(200) | ||
.get("/api/v1/artwork/abc123") | ||
.reply(404) | ||
.get("/api/v1/partner/abc123") | ||
.reply(404) | ||
) | ||
.stdout() | ||
.command(["identify", "abc123"]) | ||
.it("displays a found artist message", ctx => { | ||
expect(ctx.stdout).to.equal( | ||
"Artist https://stagingapi.artsy.net/api/v1/artist/abc123\n" | ||
) | ||
}) | ||
}) | ||
|
||
describe("when the partner exists", () => { | ||
test | ||
.nock("https://stagingapi.artsy.net", api => | ||
api | ||
.get("/api/v1/artist/abc123") | ||
.reply(404) | ||
.get("/api/v1/artwork/abc123") | ||
.reply(404) | ||
.get("/api/v1/partner/abc123") | ||
.reply(200) | ||
) | ||
.stdout() | ||
.command(["identify", "abc123"]) | ||
.it("displays a found partner message", ctx => { | ||
expect(ctx.stdout).to.equal( | ||
"Partner https://stagingapi.artsy.net/api/v1/partner/abc123\n" | ||
) | ||
}) | ||
}) | ||
|
||
describe("when nothing is found", () => { | ||
test | ||
.nock("https://stagingapi.artsy.net", api => | ||
api | ||
.get("/api/v1/artwork/abc123") | ||
.reply(404) | ||
.get("/api/v1/artist/abc123") | ||
.reply(404) | ||
.get("/api/v1/partner/abc123") | ||
.reply(404) | ||
) | ||
.stdout() | ||
.command(["identify", "abc123"]) | ||
.it("displays a not-found message", ctx => { | ||
expect(ctx.stdout).to.equal( | ||
"Nothing found in: Artist, Artwork, Partner\n" | ||
) | ||
}) | ||
}) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The strategy here is to build up all the requests for the various collections, fire em off all at once, and look for one that succeeded.