zensearch

A JSON searching application

Installation

Prerequisites

• ruby
• bundler

Steps

• git clone
• Move to the project folder and run bundle. Note that bundler needs to be installed for this.
• Add the project's bin path to the PATH environment variable. Eg.: export PATH=$PATH:/Users/rajeevthiruvengadam/projects/zensearch/bin
• To permanently add to PATH (so that this works in new terminal windows), add the bin path to /etc/paths on your mac.

Usage

zenseach support 3 commands:

• help
• list
• search

The help command

$zenseach help

NAME
    zensearch - A JSON searching application

SYNOPSIS
    zensearch [global options] command [command options] [arguments...]

VERSION
    0.0.1

GLOBAL OPTIONS
    -f, --file=filename - The JSON file you would like to seach (REQUIRED) The allowed values are organizations, users, tickets (default: none)
    -g, --[no-]global   - Give the global option to run the command with all files - organizations, users, tickets
    --help              - Show this message
    --version           - Display the program version

COMMANDS
    help   - Shows a list of commands or help for one command
    list   - list the availalbe fields to searchin the JSON file specified in the file option
    search - search the JSON file specified in the file option based on a field.

To get help for a particular command: zensearch --help command. Eg.

$zensearch --help search
NAME
    search - search the JSON file specified in the file option based on a field.

SYNOPSIS
    zensearch [global options] search search_field[, search_field]* search_value[, search_value]*

The list command

This command is used to list the searchable fields. Use -g (or --global) option to list the searchable fields across all files.

$zensearch -g list
x==================x
|   Organizations  |
x==================x
|   _id            |
x==================x
|   url            |
x==================x
|   external_id    |
x==================x
|   name           |
x==================x
|   domain_names   |
.
.
.
etc

Use -f (or --file) option to list list the searchable fields in the file specified.

$zensearch -f users list
x===================x
|        Users      |
x===================x
|   _id             |
x===================x
|   url             |
x===================x
|   external_id     |
x===================x
|   name            |
x===================x
.
.
.
etc

The search command

This command can be used to search for a matching field(s) in JSON file(s).

To search globally across all files

$zensearch -g search _id 1
x=============================================================x
|                         Organizations                       |
x=============================================================x
|   Cannot find field(s) _id with value(s) 1 in organizations |
x=============================================================x
x===================x==================================================================x
|                                         Users                                        |
x===================x==================================================================x
|   _id             |   1                                                              |
x===================x==================================================================x
|   url             |   http://initech.zendesk.com/api/v2/users/1.json                 |
x===================x==================================================================x
|   external_id     |   74341f74-9c79-49d5-9611-87ef9b6eb75f                           |
x===================x==================================================================x
|   name            |   Francisca Rasmussen                                            |
.
.
.
etc

To search in a particular file

$zensearch -f users search _id 4
x===================x==================================================x
|                                 Users                                |
x===================x==================================================x
|   _id             |   4                                              |
x===================x==================================================x
|   url             |   http://initech.zendesk.com/api/v2/users/4.json |
x===================x==================================================x
|   external_id     |   37c9aef5-cf01-4b07-af24-c6c49ac1d1c7           |
x===================x==================================================x
|   name            |   Rose Newton                                    |
x===================x==================================================x
|   alias           |   Mr Cardenas                                    |
x===================x==================================================x
|   created_at      |   2016-02-09T07:52:10 -11:00                     |
x===================x==================================================x
.
.
.
etc

To search for fields that have empty value use ""

$zensearch -f tickets search description ""
x===================x=======================================================================================x
|                                                   Tickets                                                 |
x===================x=======================================================================================x
|   _id             |   4cce7415-ef12-42b6-b7b5-fb00e24f9cc1                                                |
x===================x=======================================================================================x
|   url             |   http://initech.zendesk.com/api/v2/tickets/4cce7415-ef12-42b6-b7b5-fb00e24f9cc1.json |
x===================x=======================================================================================x
|   external_id     |   ef665694-aa3f-4960-b264-0e77c50486cf                                                |
x===================x=======================================================================================x
.
.
.
etc

To search with multiple conditions, use comma as a delimiter

$zensearch -f users search role,locale admin,en-AU
x===================x==================================================================x
|                                         Users                                        |
x===================x==================================================================x
|   _id             |   1                                                              |
x===================x==================================================================x
|   url             |   http://initech.zendesk.com/api/v2/users/1.json                 |
x===================x==================================================================x
|   external_id     |   74341f74-9c79-49d5-9611-87ef9b6eb75f                           |
x===================x==================================================================x
|   name            |   Francisca Rasmussen                                            |
x===================x==================================================================x
|   alias           |   Miss Coffey                                                    |
x===================x==================================================================x
.
.
.
etc

Notes

Extensibility

I built this console app using GLI, a DSL for creating Git like command interface. I chose this design instead of the one mentioned in the instruction document as I figured this was better for extensibility. For eg., this design would allow a user to nest commands using pipe operators. If I wanted to just return the name of the user with _id as 1, I would do

$zensearch -f users search _id 1 | grep name
|   name            |   Francisca Rasmussen

I have also designed this solution to handle any JSON file added dynamically apart from the 3 given files. All new JSON files should be put in the data folder.

Extended fuctionality

I have added 2 extended fuctionalities:

• Global search and list using -g option
• Multi-condition search (example and usage given above)

Validations and Error handling

I have done validation and error hanling on

• the command format (handled using GLI's methods)
• the command input Eg. search field validation, seach field and search value count mismatch in case of multi parameter search
• the command output Eg. handling empty results

Structure

• The I/O and validations are handled in the bin/zensearch file using some of GLI's function.
• The search logic is handled in lib/search_json.rb
• The printing and formating logic is handled in lib/print_json.rb

Code Quality

I have used Rubocop to improve code quality.

Testing

I have used RSpec for unit testing. Test cases and fixtures are under the spec folder