tricorder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 171d739dab9839ce2f0be74b57694a1876d063d5089cdb0d90b2090984e88346
+  data.tar.gz: fe3b21010cedcb7ef2a08fa94ce002eb90bfaaf9c48c269e4e0b60e8610f2e66
+SHA512:
+  metadata.gz: 4f91847fe743bfb9a2153d4e1c906235abf15b3f7a174c7740bd35e548e42af685603976ca101a4d16a0508e5ac415cc0990e960776eb9337621f05e9b09a740
+  data.tar.gz: e74154e4d1a80bba53d4010bdeedcdf2dbd1117365b7bcd080dfc3842b73cc66f8ee972bb588646963ce1e964c5649c3795874466edc0de5507bb0c46a50a4ca

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.byebug_history

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Joel Bryan Juliano
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# tricorder
+A Domain-Specific Language for Star Trek API (http://stapi.co)
+
+# Installation
+
+```
+gem install tricorder
+```
+
+# Usage
+
+## CLI
+Once installed, you can run the command `tricorder`.
+
+To display all the available options for search type `tricorder help` or `tricorder help search`.
+
+To search the API, invoke the `search <keyword>` command, which searches all databases by default.
+
+```
+tricorder search Uhura --api-key=ABC123
+```
+
+There are only 250 queries for hour for non-authenticated users, to specify the API Key, add the `--api-key=APIKEY` set the API Key on each query.
+
+To search only specific database, use the `--database <database name>` to specify the database, for example
+
+```
+tricorder search Uhura --database character book
+```
+
+To print extra details, add the `--print-details` in the command, for example
+
+```
+tricorder search uhura --database character --print-details
+```
+
+To scope on a specific detail, add the `--print-info <scope>` scoping a result
+
+```
+$ tricorder search Uhura --database character --print-only-once --print-info=characterSpecies name
+Human
+```
+
+## Domain Specific Language
+Here's an example of using tricorder programmatically via it's own DSL syntax,
+
+```
+require 'tricorder'
+include Tricorder
+
+tricorder do
+  no_logging
+  api_key('MYAPIKEY')
+  set_subject('Uhura')
+  search_locations(:character)
+  print_only_once
+  print_info(['characterSpecies', 'name'])
+end
+```
+
+It set no_logging, set's the API key, set the subject to 'Uhura', set the database to 'character', scope to 'characterSpecies name' and print only once.

data/bin/tricorder

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require_relative '../lib/tricorder'
+
+module Tricorder
+  class CLI < Thor
+    include Tricorder
+
+    map ["-v", "--version"] => :version
+    desc "--version, -v", "Display Tricorder version"
+    def version
+      puts Tricorder::VERSION::STRING
+    end
+
+    option :database, type: :array, desc: 'Specify the database to be searched'
+    option :disable_logging, type: :boolean, desc: 'Disable Logging'
+    option :api_key, type: :string, desc: 'API key to be used'
+    option :result_number, type: :numeric, desc: 'Choose a result number'
+    option :print_only_once, type: :boolean, desc: 'Disable printing multiple info results'
+    option :print_info, type: :array, desc: 'Print info scope. i.e. --print-info=characterSpecies name'
+    option :print_details, type: :boolean, desc: 'Print all the details of each queried info'
+
+    desc 'search <keyword>', 'Perform search in Star Trek API on all databases'
+    def search(keyword)
+      locations = if options[:database]
+        options[:database].map(&:to_sym)
+      else
+        Tricorders::TRICORDERS
+      end
+
+      command = "set_subject('#{keyword}')"
+      command += ".no_logging" if options[:disable_logging]
+      command += ".api_key('#{options[:api_key]}')" if options[:api_key]
+      command += ".print_only_once" if options[:print_only_once]
+      command += ".search_locations(#{locations})"
+      command += ".get_result_number(#{options[:result_number]})" if options[:result_number]
+      command += ".print_all_results" unless options[:result_number] || options[:print_only_once]
+      command += ".print_result" if options[:result_number] && !options[:print_only_once]
+      command += ".print_info(#{options[:print_info]})" if options[:print_info]
+      command += ".print_all_info" if options[:print_details]
+
+      tricorder do
+        eval command
+      end
+    end
+  end
+end
+
+Tricorder::CLI.start(ARGV)

data/lib/dsl/operators/base_operators.rb

@@ -0,0 +1,260 @@
+require_relative 'tricorders'
+
+module BaseOperators
+  include Tricorders
+
+  class BaseDSLOperators
+    attr_reader :page
+
+    def set_subject(name)
+      @subject = name
+
+      self
+    end
+
+    def api_key(key)
+      @api_key = key
+      self
+    end
+
+    def set_tricorder(name)
+      @tricorder = name.to_sym
+      self
+    end
+
+    def init_error_messages
+      if @tricorder.nil? || !Tricorders::TRICORDERS.include?(@tricorder)
+        ap "Invalid Tricorder Name! #{@tricorder}"
+        ap "Set the correct tricorder via 'set_tricorder(name)'"
+        ap "Tricorders can either be #{Tricorders::TRICORDERS}"
+        @error = true
+      end
+
+      if @subject.nil?
+        ap 'No Subject Defined!'
+        ap "Set a subject via 'set_subject(name)'"
+        @error = true
+      end
+
+      exit(0) if @error
+    end
+
+    def no_logging
+      @verbose = false
+      self
+    end
+
+    def log(message, options = {})
+      return unless options[:verbose] || @verbose
+
+      if options[:pager]
+        self.send(options[:pager], message)
+      else
+        ap(message)
+      end
+    end
+
+    def set_path(path)
+      @path = path
+      self
+    end
+
+    def set_storedir(path)
+      @storedir = path
+    end
+
+    def params
+      {
+        apiKey: @api_key,
+        pageSize: 1000
+      }
+    end
+
+    def set_collection(collection)
+      exit(0) if @error
+
+      @collection = collection
+      self
+    end
+
+    def search_locations(*tricorders)
+      exit(0) if @error
+
+      tricorders.flatten.each do |location|
+        self.send("search_#{location.to_s}".to_sym)
+      end
+
+      self
+    end
+
+    def merge_results
+      exit(0) if @error
+
+      @results = @results.inject(:merge)
+      self
+    end
+
+    def get_result_number(num)
+      exit(0) if @error
+
+      begin
+        @result = @results[num - 1]
+        set_uid(@result['uid'])
+      rescue
+        ap "No results found!"
+        @error = true
+      end
+
+      self
+    end
+
+    def set_uid(uid)
+      exit(0) if @error
+
+      @uid = uid
+
+      self
+    end
+
+    def print_only_once
+      @print_only_once = true
+
+      self
+    end
+
+    def fetch_info
+      exit(0) if @error
+
+      response = Net::HTTP.get(URI.parse(@path + "?uid=#{@uid}"))
+
+      @info = JSON.parse(response)
+
+      @info[@tricorder.to_s].each_key do |key,val|
+        @info[@tricorder.to_s].compact!
+        @info[@tricorder.to_s].delete_if { |_k, v| v == false }
+        if @info[@tricorder.to_s][key].is_a?(Array)
+          @info[@tricorder.to_s][key].each_with_index do |_, index|
+            @info[@tricorder.to_s][key][index].compact!
+            @info[@tricorder.to_s][key][index].delete_if { |_k, v| v == false }
+          end
+        end
+      end
+    end
+
+    def search
+      exit(0) if @error
+
+      log "Searching '#{humanized_tricorder_name}' databank for '#{@subject}'..."
+
+      search_params = params.merge(
+        name: @subject,
+        title: @subject,
+        description: @subject
+      )
+
+      response = Net::HTTP.post_form(URI.parse(@path + '/search'), search_params)
+
+      @search << JSON.parse(response.body)
+
+      if @search[0].key?('code')
+        ap @search[0]['code']
+        @error = true
+      end
+
+      @search.flatten!
+
+      count = @search.count
+
+      0.upto(count).each do |c|
+        next if @search.nil? || @search[c].nil? || @search[c][@collection].nil?
+        @results << @search[c][@collection]
+        @results.flatten!
+        @results.each_with_index do |result, index|
+          result.compact!
+          result.delete_if { |_k, v| v == false }
+          @results[index] = result
+        end
+      end
+
+      self
+    end
+
+    def humanized_tricorder_name
+      exit(0) if @error
+
+      init_error_messages
+
+      @tricorder.to_s.split('_').map(&:capitalize).join(' ')
+    end
+
+    def printer(object)
+      exit(0) if @error
+
+      init_error_messages
+
+      if object.empty?
+        "No info found!"
+      else
+        object
+      end
+    end
+
+    def print_info(*fields)
+      collection, field, number = fields.flatten
+      num = 0 || number
+
+      @results.each do |res|
+        set_uid(res['uid'])
+
+        fetch_info
+        begin
+          info = printer(@info[@tricorder.to_s])
+
+          print_info = if field
+            info[collection][num][field]
+          else
+            info[collection]
+          end
+
+          if @print_only_once
+            @out ||= print_info
+          else
+            @out = print_info
+          end
+
+          log(@out, {pager: :puts, verbose: true}) unless @printed
+
+          @printed = true if @print_only_once
+        rescue
+          log "Collection not found or empty"
+          log "Available collections are #{@info.delete_if { |_k, v| v == false || v.is_a?(Array) && v&.empty? }.keys.join(", ")}"
+        end
+      end
+
+      self
+    end
+
+    def print_all_info
+      @results.each do |result|
+        set_uid(result['uid'])
+
+        fetch_info
+        ap printer(@info)
+      end
+
+      self
+    end
+
+    def print_result
+      ap printer(@result)
+
+      self
+    end
+
+    def print_all_results
+      ap printer(@results)
+
+      self
+    end
+  end
+end