zn 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 169966541807052462e0dcc386a5a2946ee19c27
-  data.tar.gz: a9c201bb92ec31de84a59bcf20a552a839feb014
+  metadata.gz: 8cb0af882c77d258e9766ffc0d18ddaecb901a80
+  data.tar.gz: 629c1270a41ddaffe36d6cbf343efdba15fe0697
 SHA512:
-  metadata.gz: 55f9ee7f95c5be03460fe30bd20ddac9677188200f6b41aec2b6f8ca17715119e3847c109f933eddb0b4bf5f4f3b1097408b75676ad7c68ab848096706e0cbbd
-  data.tar.gz: 82dd515ec234cffc7a43f7a49577c9975c0fb53e699906a3e2da4005c68ad1ff9e495d7a3083789b7640fa6d3e220508ef96833d34932ae011a2c1467f01ef9d
+  metadata.gz: b79c006378b6330d2bac41890adaa25245acfe7909123b6ebd7a9a6776e1c9341cccf0e1569642027e921eb0d3ef65a5d2f71955a1b616b7c84c6c435984110c
+  data.tar.gz: 22c2fe6da7b01b900f420ad417874ce0f71d58337fdf81dee8c7ca79abf9c641369aab9ab3c0d39351b6e7bf3c981b2f1326c2c8163c7263d3c30bc347d63f5b

data/README.md

@@ -1,5 +1,8 @@
 # Zn
 
+[![Build Status](https://travis-ci.org/lpadukana/zn.svg?branch=master)](https://travis-ci.org/lpadukana/zn)
+
+
 Zn is a tool to search and correlate data sources (JSON files for now).
 
 ## Installation
@@ -22,23 +25,46 @@ Note: For latest changes, please use `exe/zn` instead of depending on the instal
 
 ## Usage
 
-This tool depends on an index to understand the relationship between datasets. An example is available at `spec/fixtures/starwars/index.yml`. In this case, this file defines how `people.json`, `planets.json` and `robots.json` are related.
+This tool depends on an index to understand the relationship between datasets. An example is available at [spec/fixtures/starwars/index.yml](spec/fixtures/starwars/index.yml). In this case, this file defines how `people.json`, `planets.json` and `robots.json` are related.
 
-### Search Examples
+### Discovering Datasets
 
 ```sh
-$ zn search \
-  --config-file=spec/fixtures/starwars/index.yml \
-  --dataset robots \
-  --key id \
-  --value r2
-{"id":"r2","name":"R2-D2","owner_id":"obi"}
+$ export ZN_CONFIG_FILE=spec/fixtures/starwars/index.yml
+
+$ zn list-datasets
+people
+planets
+robots
+```
 
-# config file can be set using environment variables
+Note: config file can also be passed in as `--config-file spec/fixtures/starwars/index.yml`
+
+### Discovering Keys
+
+```sh
 $ export ZN_CONFIG_FILE=spec/fixtures/starwars/index.yml
 
+$ zn list-keys --dataset robots
+id
+name
+owner_id
+```
+
+### Search Examples
+
+```sh
+$ export ZN_CONFIG_FILE=spec/fixtures/starwars/index.yml
+
+$ zn search --dataset robots --key id --value r2
+{"id":"r2","name":"R2-D2","owner_id":"obi"}
+
 $ zn search --dataset people --key name --value Kenobi
 {"id":"obi","name":"Obi Wan Kenobi","planet_id":"ste"}
+
+# --exact can be used to search for exact values
+$ zn search --exact --dataset people --key name --value 'Obi Wan Kenobi'
+{"id":"obi","name":"Obi Wan Kenobi","planet_id":"ste"}
 ```
 
 ### Search and Associate Example
@@ -82,6 +108,22 @@ $ zn search --dataset people --key name --value Kenobi | zn associate --dataset
 }
 ```
 
+### Zendesk Examples to Try
+
+```sh
+$ export ZN_CONFIG_FILE=spec/fixtures/zendesk/index.yml
+
+$ zn list-datasets
+$ zn list-keys --dataset users
+$ zn list-keys --dataset tickets
+$ zn list-keys --dataset organizations
+$ zn search --dataset users --key _id --value 10 | zn associate --dataset users | zn prettify-json
+$ zn search --dataset tickets --key subject --value Australia | zn associate --dataset tickets | zn prettify-json
+$ zn search --dataset organizations --key name --value Qualitern | zn associate --dataset organizations | zn prettify-json
+$ zn search --dataset users --key _id --value 1 | wc -l
+$ zn search --exact --dataset users --key _id --value 1 | wc -l
+```
+
 ## Tests
 
 ### Rspec

data/bin/publish-docker-image

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+version=$(ruby -Ilib -r zn/version -e 'puts Zn::VERSION')
+tag="latheeshp/zn:${version}"
+tag_latest="latheeshp/zn:latest"
+
+docker build -t "${tag}" .
+docker tag "${tag}" "${tag_latest}"
+
+docker push "${tag}"
+docker push "${tag_latest}"

data/lib/zn/associators/belongs_to.rb

@@ -7,6 +7,8 @@ module Zn
       attr_reader :datasets, :dataset_name, :foreign_key, :primary_key, :dataset, :repo
 
       def initialize(datasets, params)
+        raise ArgumentError, 'Datasets is nil' if datasets.nil?
+
         @datasets = datasets
         @dataset_name = params.fetch('dataset')
         @foreign_key = params.fetch('foreign_key')
@@ -15,7 +17,7 @@ module Zn
 
       def associate(object)
         @dataset ||= datasets.fetch(dataset_name)
-        dataset.search(key: primary_key, value: object[foreign_key], exact: true).to_a.first
+        dataset.search(key: primary_key, value: object.fetch(foreign_key), exact: true).to_a.first
       end
     end
   end

data/lib/zn/associators/has_many.rb

@@ -7,6 +7,8 @@ module Zn
       attr_reader :datasets, :dataset_name, :foreign_key, :primary_key, :dataset, :repo
 
       def initialize(datasets, params)
+        raise ArgumentError, 'Datasets is nil' if datasets.nil?
+
         @datasets = datasets
         @dataset_name = params.fetch('dataset')
         @foreign_key = params.fetch('foreign_key')

data/lib/zn/repos/json_repo.rb

@@ -28,7 +28,7 @@ module Zn
         value = params.fetch(:value)
         exact = params.fetch(:exact)
 
-        if exact
+        if exact || value.empty?
           search_exact(key, value) { |result| yield result }
         else
           search_for_inclusion(key, value) { |result| yield result }
@@ -41,17 +41,15 @@ module Zn
         return enum_for(:search_exact, key, value) unless block_given?
 
         all.each do |element|
-          yield element if element[key].to_s == value.to_s
+          yield element if element.fetch(key, '').to_s == value.to_s
         end
       end
 
       def search_for_inclusion(key, value)
         return enum_for(:search_for_inclusion, key, value) unless block_given?
 
-        return [].each if value.empty?
-
         all.each do |element|
-          yield element if element[key].to_s.include?(value.to_s)
+          yield element if element.fetch(key, '').to_s.include?(value.to_s)
         end
       end
     end

data/lib/zn/search_assembler.rb

@@ -8,12 +8,17 @@ module Zn
     attr_reader :config_root, :assembly
 
     def initialize(assembly)
+      raise ArgumentError, 'Assembly is nil' if assembly.nil?
+
       @assembly = assembly
       @repos = {}
       @associators = {}
     end
 
     def register_repo_class(name, repo_class)
+      raise ArgumentError, 'Name is empty' if name.to_s.empty?
+      raise ArgumentError, 'Repo class is nil' if repo_class.nil?
+
       @repos[name] = repo_class
     end
 
@@ -24,6 +29,9 @@ module Zn
     end
 
     def register_associator_class(name, associator_class)
+      raise ArgumentError, 'Name is empty' if name.to_s.empty?
+      raise ArgumentError, 'Associator class is nil' if associator_class.nil?
+
       @associators[name] = associator_class
     end
 
@@ -47,6 +55,8 @@ module Zn
     end
 
     def assemble(config_yml)
+      raise ArgumentError, 'Config yml is empty' if config_yml.to_s.empty?
+
       config = YAML.load_file(config_yml)
       @config_root = File.dirname(config_yml)
       dataset_definitions = config.fetch('datasets')

data/lib/zn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zn
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zn
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Latheesh Padukana
@@ -170,6 +170,7 @@ files:
 - Rakefile
 - bin/console
 - bin/install
+- bin/publish-docker-image
 - bin/release
 - bin/rspec-test
 - bin/setup