gazer 0.2.9

data/Rakefile

@@ -0,0 +1,27 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2018 Mike DeAngelo Looker Data Sciences, Inc.
+
+# 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.
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+# The MIT License (MIT)
+
+# Copyright (c) 2018 Mike DeAngelo Looker Data Sciences, Inc.
+
+# 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.
+
+require "bundler/setup"
+require "gzr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+# The MIT License (MIT)
+
+# Copyright (c) 2018 Mike DeAngelo Looker Data Sciences, Inc.
+
+# 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.
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gzr

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+# The MIT License (MIT)
+
+# Copyright (c) 2018 Mike DeAngelo Looker Data Sciences, Inc.
+
+# 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.
+
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$:.unshift(lib_path) if !$:.include?(lib_path)
+require 'gzr/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Gzr::CLI.start
+rescue Gzr::CLI::Error => err
+  puts "ERROR: #{err.message}"
+  exit 1
+end

data/gzr.gemspec

@@ -0,0 +1,67 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2018 Mike DeAngelo Looker Data Sciences, Inc.
+
+# 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.
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gzr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gazer"
+  spec.license       = "MIT"
+  spec.version       = Gzr::VERSION
+  spec.authors       = ["Mike DeAngelo"]
+  spec.email         = ["deangelo@looker.com"]
+
+  spec.summary       = %q{Command line tool to manage the content of a Looker instance.}
+  spec.description   = %q{Command line tool to manage the content of a Looker instance.}
+  spec.homepage      = "https://github.com/deangelo-llooker/gzr"
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tty-reader", "~> 0.3.0"
+  spec.add_dependency "tty-table", "~> 0.10.0"
+  spec.add_dependency "tty-tree", "~> 0.1.0"
+  spec.add_dependency "pastel", "~> 0.7.2"
+  spec.add_dependency "thor", "~> 0.20.0"
+  spec.add_dependency 'netrc', "~> 0.11.0"
+  spec.add_dependency 'looker-sdk', "~> 0.0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "tty", "~> 0.8"
+end

data/lib/gzr.rb

@@ -0,0 +1,25 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2018 Mike DeAngelo Looker Data Sciences, Inc.
+
+# 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.
+
+require "gzr/version"
+
+module Gzr
+end

data/lib/gzr/cli.rb

@@ -0,0 +1,86 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2018 Mike DeAngelo Looker Data Sciences, Inc.
+
+# 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.
+
+# frozen_string_literal: true
+
+require 'thor'
+
+module Gzr
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    class_option :debug, type: :boolean, default: false, desc: 'Run in debug mode'
+    class_option :host, type: :string, default: 'localhost', desc: 'Looker Host'
+    class_option :port, type: :string, default: '19999', desc: 'Looker API Port'
+    class_option :client_id, type: :string, desc: 'API3 Client Id'
+    class_option :client_secret, type: :string, desc: 'API3 Client Secret'
+    class_option :api_version, type: :string, desc: 'Looker API Version'
+    class_option :ssl, type: :boolean, default: true, desc: 'Use ssl to communicate with host'
+    class_option :verify_ssl, type: :boolean, default: true, desc: 'Verify the SSL certificate of the host'
+    class_option :timeout, type: :numeric, default: 60, desc: 'Seconds to wait for a response from the server'
+    class_option :http_proxy, type: :string, desc: 'HTTP Proxy for connecting to Looker host'
+    class_option :force, type: :boolean, default: false, desc: 'Overwrite objects on server'
+    class_option :su, type: :string, desc: 'After connecting, change to user_id given'
+
+
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'gzr version'
+    def version
+      require_relative 'version'
+      puts "v#{Gzr::VERSION}"
+    end
+    map %w(--version -v) => :version
+
+    require_relative 'commands/query'
+    register Gzr::Commands::Query, 'query', 'query [SUBCOMMAND]', 'Commands to retrieve and run queries'
+
+    require_relative 'commands/role'
+    register Gzr::Commands::Role, 'role', 'role [SUBCOMMAND]', 'Commands pertaining to roles'
+
+    require_relative 'commands/plan'
+    register Gzr::Commands::Plan, 'plan', 'plan [SUBCOMMAND]', 'Commands pertaining to plans'
+
+    require_relative 'commands/group'
+    register Gzr::Commands::Group, 'group', 'group [SUBCOMMAND]', 'Commands pertaining to groups'
+
+    require_relative 'commands/model'
+    register Gzr::Commands::Model, 'model', 'model [SUBCOMMAND]', 'Commands pertaining to LookML Models'
+
+    require_relative 'commands/connection'
+    register Gzr::Commands::Connection, 'connection', 'connection [SUBCOMMAND]', 'Commands pertaining to database connections and dialects'
+
+    require_relative 'commands/user'
+    register Gzr::Commands::User, 'user', 'user [SUBCOMMAND]', 'Commands pertaining to users'
+
+    require_relative 'commands/dashboard'
+    register Gzr::Commands::Dashboard, 'dashboard', 'dashboard [SUBCOMMAND]', 'Commands pertaining to dashboards'
+
+    require_relative 'commands/look'
+    register Gzr::Commands::Look, 'look', 'look [SUBCOMMAND]', 'Commands pertaining to looks'
+
+    require_relative 'commands/space'
+    register Gzr::Commands::Space, 'space', 'space [SUBCOMMAND]', 'Commands pertaining to spaces'
+  end
+end

data/lib/gzr/command.rb

@@ -0,0 +1,251 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2018 Mike DeAngelo Looker Data Sciences, Inc.
+
+# 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.
+
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'tty-reader'
+require 'netrc'
+require 'looker-sdk'
+
+require_relative 'modules/session'
+
+module Gzr
+  class Command
+    extend Forwardable
+    include Gzr::Session
+
+    def initialize
+      @sdk = nil
+      @access_token_stack = Array.new
+      @options = Hash.new
+    end
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    def query(query_id)
+      data = nil
+      begin
+        data = @sdk.query(query_id)
+      rescue LookerSDK::Error => e
+        say_error "Error querying query(#{query_id})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def create_query(query)
+      begin
+        data = @sdk.create_query(query)
+      rescue LookerSDK::Error => e
+        say_error "Error creating query(#{JSON.pretty_generate(query)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def merge_query(merge_result_id)
+      data = nil
+      begin
+        data = @sdk.merge_query(merge_result_id)
+      rescue NoMethodError => nme
+        say_error "The api endpoint merge_query(#{merge_result_id}) is not implemented on this Looker instance"
+      rescue LookerSDK::Error => e
+        say_error "Error querying merge_query(#{merge_result_id})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def create_merge_query(merge_query)
+      begin
+        data = @sdk.create_merge_query(merge_query)
+      rescue NoMethodError => nme
+        say_error "The api endpoint create_merge_query() is not implemented on this Looker instance"
+        raise
+      rescue LookerSDK::Error => e
+        say_error "Error creating merge_query(#{JSON.pretty_generate(merge_query)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def run_inline_query(query)
+      begin
+        data = @sdk.run_inline_query("json",query)
+      rescue LookerSDK::Error => e
+        say_error "Error running inline_query(#{JSON.pretty_generate(query)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+
+    ##
+    # This method accepts the name of an sdk operation, then finds the parameter for that
+    # operation in the data structures from the swagger.json file. The parameter is a
+    # json object. Some of the attributes of the json object are read-only, and some
+    # are read-write. A few are write-only. The list of read-write and write-only attribute
+    # names are returned as an array. That array can be used to take the json document that
+    # describes an object and strip out the read-only values, creating a document that can
+    # be used to create or update an object.
+    #
+    # The pattern typically looks like this...
+    #
+    #   new_obj_hash = existing_obj_hash.select do |k,v|
+    #     keys_to_keep('create_new_obj').include? k
+    #   end
+    
+    def keys_to_keep(operation)
+      o = @sdk.operations[operation]
+      begin
+        say_error "Operation #{operation} not found"
+        return []
+      end unless o
+
+      parameters = o[:info][:parameters].select { |p| p[:in] == "body" && p[:schema] }
+
+      say_warning "Expecting exactly one body parameter with a schema for operation #{operation}" unless parameters.length == 1
+      schema_ref = parameters[0][:schema][:$ref].split(/\//)
+      return @sdk.swagger[schema_ref[1].to_sym][schema_ref[2].to_sym][:properties].reject { |k,v| v[:readOnly] }.keys
+    end
+    
+    ##
+    # The tty-table gem is normally used to output tabular data. This method accepts a Table
+    # object as used by the tty-table gem, and generates CSV output. It returns a string
+    # with crlf encoding
+    
+    def render_csv(t)
+      io = StringIO.new
+      io.puts (
+        t.header.collect do |v|
+          v ? "\"#{v.to_s.gsub(/"/, '""')}\"" : ""
+        end.join(',')
+      ) unless @options[:plain]
+      t.each do |row|
+        next if row === t.header
+        io.puts (
+          row.collect do |v|
+            v ? "\"#{v.to_s.gsub(/"/, '""')}\"" : ""
+          end.join(',')
+        )
+      end
+      io.rewind
+      io.gets(nil).encode(crlf_newline: true)
+    end
+
+    ##
+    # This method accepts a string containing a list of fields. The fields can be nested
+    # in a format like...
+    #
+    # 'a,b,c(d,e(f,g)),h'
+    #
+    # representing a structure like
+    #
+    # {
+    #   a: "val",
+    #   b: "val",
+    #   c: {
+    #     d: "val",
+    #     e: {
+    #       f: "val",
+    #       g: "val"
+    #     }
+    #   },
+    #   h: "val"
+    # }
+    #
+    # That string will get parsed and yield an array like
+    # [ a, b, c.d, c.e.f, c.e.g, h ]
+    #
+
+    def field_names(opt_fields)
+      fields = []
+      token_stack = []
+      last_token = false
+      tokens = opt_fields.split /(\(|,|\))/
+      tokens << nil
+      tokens.each do |t|
+        if t.nil? then
+          fields << (token_stack + [last_token]).join('.') if last_token
+        elsif t.empty? then
+          next
+        elsif t == ',' then
+          fields << (token_stack + [last_token]).join('.') if last_token
+        elsif t == '(' then
+          token_stack.push(last_token)
+        elsif t == ')' then
+          fields << (token_stack + [last_token]).join('.') if last_token
+          token_stack.pop
+          last_token = false
+        else
+          last_token = t
+        end
+      end
+      fields
+    end
+
+    ##
+    # This method will accept a field name in a format like 'c.e.g'
+    # and convert it into 'c&.e&.g', which can be evaluated to get
+    # the value of g, or nil if any intermediate value is nil.
+
+    def field_expression(name)
+      parts = name.split(/\./)
+      parts.join('&.')
+    end
+
+    ##
+    # This method will accept two arrays, a and b, and create a third array
+    # like [ [a[0],b[0]], [a[1],b[1]], [a[2],b[2]], ...].
+    # If either array is longer than the other, additional pairs 
+    # will be generated with the shorter array padded out with nil values.
+    #
+    # Any additional args will be added to each inner array.
+
+    def pairs(a, b, *args)
+      pair_array = Array.new([a.count,b.count].max) do |i|
+        pair = [a.fetch(i,nil),b.fetch(i,nil)]
+        pair += args if args
+        pair
+      end
+
+      return pair_array unless block_given?
+
+      pair_array.collect { |e| yield(e) }
+    end
+  end
+end