gazer 0.2.9

data/lib/gzr/modules/model.rb

@@ -0,0 +1,40 @@
+# 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
+
+module Gzr
+  module Model
+    def query_all_lookml_models(fields=nil)
+      data = nil
+      begin
+        req = Hash.new
+        req[:fields] = fields if fields
+        data = @sdk.all_lookml_models(req)
+      rescue LookerSDK::Error => e
+        say_error "Error querying all_lookml_models(#{JSON.pretty_generate(req)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+  end
+end

data/lib/gzr/modules/plan.rb

@@ -0,0 +1,216 @@
+# 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
+
+module Gzr
+  module Plan
+    def query_all_scheduled_plans(user_id,fields=nil)
+      req = {}
+      req[:all_users] = true if user_id == "all"
+      req[:user_id] = user_id if user_id && !(user_id == "all")
+      req[:fields] = fields if fields
+      data = nil
+      id = nil
+      id = user_id unless user_id == "all"
+      begin
+        data = @sdk.all_scheduled_plans(req)
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to get all_scheduled_plans(#{JSON.pretty_generate(req)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+    
+    def query_scheduled_plans_for_look(look_id,user_id,fields=nil)
+      req = {}
+      req[:all_users] = true if user_id == "all"
+      req[:user_id] = user_id if user_id && !(user_id == "all")
+      req[:fields] = fields if fields
+      data = nil
+      begin
+        data = @sdk.scheduled_plans_for_look(look_id,req)
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to get scheduled_plans_for_look(#{look_id},#{JSON.pretty_generate(req)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+    
+    def query_scheduled_plans_for_dashboard(dashboard_id,user_id,fields=nil)
+      req = {}
+      req[:all_users] = true if user_id == "all"
+      req[:user_id] = user_id if user_id && !(user_id == "all")
+      req[:fields] = fields if fields
+      data = nil
+      begin
+        data = @sdk.scheduled_plans_for_dashboard(dashboard_id,req)
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to get scheduled_plans_for_dashboard(#{dashboard_id},#{JSON.pretty_generate(req)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+    
+    def query_scheduled_plan(plan_id,fields=nil)
+      req = {}
+      req[:fields] = fields if fields
+      begin
+        data = @sdk.scheduled_plan(plan_id,req)
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to get scheduled_plan(#{plan_id},#{JSON.pretty_generate(req)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+    
+    def delete_scheduled_plan(plan_id)
+      begin
+        data = @sdk.delete_scheduled_plan(plan_id)
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to delete scheduled_plan(#{plan_id})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def create_scheduled_plan(plan)
+      begin
+        data = @sdk.create_scheduled_plan(plan)
+      rescue LookerSDK::Error => e
+        say_error "Error creating scheduled_plan(#{JSON.pretty_generate(plan)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def update_scheduled_plan(plan_id,plan)
+      begin
+        data = @sdk.update_scheduled_plan(plan_id,plan)
+      rescue LookerSDK::Error => e
+        say_error "Error updating scheduled_plan(#{plan_id},#{JSON.pretty_generate(plan)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def run_scheduled_plan(plan)
+      begin
+        data = @sdk.scheduled_plan_run_once(plan)
+      rescue LookerSDK::Error => e
+        say_error "Error executing scheduled_plan_run_once(#{JSON.pretty_generate(plan)})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+    
+    def upsert_plans_for_look(look_id,user_id,source_plans)
+      existing_plans = query_scheduled_plans_for_look(look_id,"all")
+      upsert_plans_for_obj(user_id,source_plans,existing_plans) { |p| p[:look_id] = look_id }
+    end
+    
+    def upsert_plans_for_dashboard(dashboard_id,user_id,source_plans)
+      existing_plans = query_scheduled_plans_for_dashboard(dashboard_id,"all")
+      upsert_plans_for_obj(user_id,source_plans,existing_plans) { |p| p[:dashboard_id] = dashboard_id }
+    end
+    
+    def upsert_plan_for_look(look_id,user_id,source_plan)
+      existing_plans = query_scheduled_plans_for_look(look_id,"all")
+      upsert_plan_for_obj(user_id,source_plan,existing_plans) { |p| p[:look_id] = look_id }
+    end
+    
+    def upsert_plan_for_dashboard(dashboard_id,user_id,source_plan)
+      existing_plans = query_scheduled_plans_for_dashboard(dashboard_id,"all")
+      upsert_plan_for_obj(user_id,source_plan,existing_plans) { |p| p[:dashboard_id] = dashboard_id }
+    end
+    
+    def upsert_plans_for_obj(user_id,source_plans,existing_plans, &block)
+      plans = nil
+      source_plans.collect do |source_plan|
+        plans = upsert_plan_for_obj(user_id, source_plan, existing_plans, &block)
+      end
+      return nil unless plans.length > 0
+      plans.first
+    end
+
+    def upsert_plan_for_obj(user_id, source_plan, existing_plans)
+      matches = existing_plans.select { |p| p.name == source_plan[:name] && user_id == p.user_id }
+      if matches.length > 0 then
+        say_ok "Modifying existing plan #{matches.first.id} #{matches.first.name}"
+        plan = keys_to_keep('update_scheduled_plan').collect do |e|
+          [e,nil]
+        end.to_h
+
+        plan.merge!( source_plan.select do |k,v|
+          (keys_to_keep('update_scheduled_plan') - [:plan_id,:look_id,:dashboard_id,:user_id,:dashboard_filters,:lookml_dashboard_id,:scheduled_plan_destination]).include? k
+        end)
+        plan[:scheduled_plan_destination] = source_plan[:scheduled_plan_destination].collect do |p|
+          p.reject do |k,v|
+            [:id,:scheduled_plan_id,:looker_recipient,:can].include? k
+          end
+        end
+        plan[:user_id] = user_id
+        plan[:enabled] = true if @options[:enabled]
+        plan[:enabled] = false if @options[:disabled]
+
+        plan[:enabled] = false if plan[:enabled].nil?
+        plan[:require_results] = false if plan[:require_results].nil?
+        plan[:require_no_results] = false if plan[:require_no_results].nil?
+        plan[:require_change] = false if plan[:require_change].nil?
+        plan[:send_all_results] = false if plan[:send_all_results].nil?
+        plan[:run_once] = false if plan[:run_once].nil?
+        plan[:include_links] = false if plan[:include_links].nil?
+        yield plan
+        update_scheduled_plan(matches.first.id,plan)
+      else
+        plan = source_plan.select do |k,v|
+          (keys_to_keep('create_scheduled_plan') - [:plan_id,:dashboard_id,:user_id,:dashboard_filters,:lookml_dashboard_id,:scheduled_plan_destination]).include? k
+        end
+        plan[:scheduled_plan_destination] = source_plan[:scheduled_plan_destination].collect do |p|
+          p.reject do |k,v|
+            [:id,:scheduled_plan_id,:looker_recipient,:can].include? k
+          end
+        end
+
+        yield plan
+        plan[:enabled] = true if @options[:enabled]
+        plan[:enabled] = false if @options[:disabled]
+
+        plan[:enabled] = false if plan[:enabled].nil?
+        plan[:require_results] = false if plan[:require_results].nil?
+        plan[:require_no_results] = false if plan[:require_no_results].nil?
+        plan[:require_change] = false if plan[:require_change].nil?
+        plan[:send_all_results] = false if plan[:send_all_results].nil?
+        plan[:run_once] = false if plan[:run_once].nil?
+        plan[:include_links] = false if plan[:include_links].nil?
+        create_scheduled_plan(plan)
+      end
+    end
+  end
+end

data/lib/gzr/modules/role.rb

@@ -0,0 +1,128 @@
+# 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
+
+module Gzr
+  module Role
+    def query_all_roles(fields=nil)
+      req = Hash.new
+      req[:fields] = fields if fields
+      data = Array.new
+      begin
+        data = @sdk.all_roles(req)
+      rescue LookerSDK::NotFound => e
+        # do nothing
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to get all_roles(#{JSON.pretty_generate(req)})"
+        say_error e.message
+        say_error e.errors if e.errors
+        raise
+      end
+      data
+    end
+    def query_role(role_id)
+      data = nil
+      begin
+        data = @sdk.role(role_id)
+      rescue LookerSDK::NotFound => e
+        # do nothing
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to get role(#{role_id})"
+        say_error e.message
+        say_error e.errors if e.errors
+        raise
+      end
+      data
+    end
+    def delete_role(role_id)
+      data = nil
+      begin
+        data = @sdk.delete_role(role_id)
+      rescue LookerSDK::NotFound => e
+        # do nothing
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to delete_role(#{role_id})"
+        say_error e.message
+        say_error e.errors if e.errors
+        raise
+      end
+      data
+    end
+    def query_role_groups(role_id,fields=nil)
+      req = Hash.new
+      req[:fields] = fields if fields
+      data = Array.new
+      begin
+        data = @sdk.role_groups(role_id, req)
+      rescue LookerSDK::NotFound => e
+        # do nothing
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to get role_groups(#{role_id},#{JSON.pretty_generate(req)})"
+        say_error e.message
+        say_error e.errors if e.errors
+        raise
+      end
+      data
+    end
+    def query_role_users(role_id,fields=nil,direct_association_only=true)
+      req = Hash.new
+      req[:fields] = fields if fields
+      req[:direct_association_only] = direct_association_only
+      data = Array.new
+      begin
+        data = @sdk.role_users(role_id, req)
+      rescue LookerSDK::NotFound => e
+        # do nothing
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to get role_users(#{role_id},#{JSON.pretty_generate(req)})"
+        say_error e.message
+        say_error e.errors if e.errors
+        raise
+      end
+      data
+    end
+    def set_role_groups(role_id,groups=[])
+      data = Array.new
+      begin
+        data = @sdk.set_role_groups(role_id, groups)
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to call set_role_groups(#{role_id},#{JSON.pretty_generate(groups)})"
+        say_error e.message
+        say_error e.errors if e.errors
+        raise
+      end
+      data
+    end
+    def set_role_users(role_id,users=[])
+      data = Array.new
+      begin
+        data = @sdk.set_role_users(role_id, users)
+      rescue LookerSDK::ClientError => e
+        say_error "Unable to call set_role_users(#{role_id},#{JSON.pretty_generate(users)})"
+        say_error e.message
+        say_error e.errors if e.errors
+        raise
+      end
+      data
+    end
+  end
+end

data/lib/gzr/modules/session.rb

@@ -0,0 +1,203 @@
+# 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 'pastel'
+require 'tty-reader'
+
+require_relative '../../gzr'
+
+module Gzr
+  module Session
+
+    def pastel
+      @pastel ||= Pastel.new
+    end
+
+    def say_ok(data)
+      puts pastel.green data
+    end
+
+    def say_warning(data)
+      puts pastel.yellow data
+    end
+
+    def say_error(data)
+      puts pastel.red data
+    end
+
+    def v3_1_available?
+      @v3_1_available ||= false
+    end
+
+    def build_connection_hash(api_version)
+      conn_hash = Hash.new
+      conn_hash[:api_endpoint] = "http#{@options[:ssl] ? "s" : ""}://#{@options[:host]}:#{@options[:port]}/api/#{api_version}"
+      if @options[:http_proxy]
+        conn_hash[:connection_options] ||= {}
+        conn_hash[:connection_options][:proxy] = {
+          :uri => @options[:http_proxy]
+        }
+      end
+      if @options[:ssl]
+        conn_hash[:connection_options] ||= {}
+        if @options[:verify_ssl] then
+          conn_hash[:connection_options][:ssl] = {
+            :verify => true,
+            :verify_mode => (OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT)
+          }
+        else
+          conn_hash[:connection_options][:ssl] = {
+            :verify => false
+          }
+        end
+      end
+      if @options[:timeout]
+        conn_hash[:connection_options] ||= {}
+        conn_hash[:connection_options][:request] = {
+          :timeout => @options[:timeout]
+        }
+      end
+      conn_hash[:user_agent] = "Gazer #{Gzr::VERSION}"
+      if @options[:client_id] then
+        conn_hash[:client_id] = @options[:client_id]
+        if @options[:client_secret] then
+          conn_hash[:client_secret] = @options[:client_secret]
+        else
+          reader = TTY::Reader.new
+          @secret ||= reader.read_line("Enter your client_secret:", echo: false)
+          conn_hash[:client_secret] = @secret
+        end
+      else
+        conn_hash[:netrc] = true
+        conn_hash[:netrc_file] = "~/.netrc"
+      end
+      conn_hash
+    end
+
+    def login(api_version)
+      @secret = nil
+      begin
+        conn_hash = build_connection_hash("3.0")
+        sdk = LookerSDK::Client.new(conn_hash)
+        begin 
+          sdk.get "/"
+        rescue Faraday::SSLError => e
+          raise Gzr::CLI::Error, "SSL Certificate could not be verified\nDo you need the --no-verify-ssl option or the --no-ssl option?"
+        rescue Faraday::ConnectionFailed => cf
+          raise Gzr::CLI::Error, "Connection Failed.\nDid you specify the --no-ssl option for an ssl secured server?"
+        rescue LookerSDK::NotFound => nf
+          #ignore this
+        end
+        raise Gzr::CLI::Error, "Invalid credentials" unless sdk.authenticated?
+        sdk.versions.supported_versions.each do |v|
+          @v3_1_available = true if v.version == "3.1"
+        end
+        begin
+          sdk.logout
+        rescue LookerSDK::Error => e
+          # eat this error if it occurs
+        end
+      end unless @options[:api_version]
+
+      say_warning "API 3.1 available? #{v3_1_available?}" if @options[:debug]
+
+      raise Gzr::CLI::Error, "Operation requires API v3.1, but user specified a different version" if (api_version == "3.1") && @options[:api_version] && !("3.1" == @options[:api_version])
+      raise Gzr::CLI::Error, "Operation requires API v3.1, which is not available from this host" if (api_version == "3.1") && !v3_1_available?
+
+      conn_hash = build_connection_hash(@options[:api_version] || api_version)
+      @secret = nil
+
+      say_ok("connecting to #{conn_hash.each { |k,v| "#{k}=>#{(k == :client_secret) ? '*********' : v}" }}") if @options[:debug]
+
+      begin
+        @sdk = LookerSDK::Client.new(conn_hash) unless @sdk
+        say_ok "check for connectivity: #{@sdk.alive?}" if @options[:debug]
+        say_ok "verify authentication: #{@sdk.authenticated?}" if @options[:debug]
+      rescue LookerSDK::Unauthorized => e
+        say_error "Unauthorized - credentials are not valid"
+        raise
+      rescue LookerSDK::Error => e
+        say_error "Unable to connect"
+        say_error e.message
+        say_error e.errors if e.respond_to?(:errors) && e.errors
+        raise
+      end
+      raise Gzr::CLI::Error, "Invalid credentials" unless @sdk.authenticated?
+
+
+      if @options[:su] then
+        say_ok "su to user #{@options[:su]}" if @options[:debug]
+        @access_token_stack.push(@sdk.access_token)
+        begin
+          @sdk.access_token = @sdk.login_user(@options[:su]).access_token
+          say_warning "verify authentication: #{@sdk.authenticated?}" if @options[:debug]
+        rescue LookerSDK::Error => e
+          say_error "Unable to su to user #{@options[:su]}" 
+          say_error e.message
+          say_error e.errors if e.respond_to?(:errors) && e.errors
+          raise
+        end
+      end
+      @sdk
+    end
+
+    def logout_all
+      pastel = Pastel.new(enabled: true)
+      say_ok "logout" if @options[:debug]
+      begin
+        @sdk.logout
+      rescue LookerSDK::Error => e
+        say_error "Unable to logout"
+        say_error e.message
+        say_error e.errors if e.respond_to?(:errors) && e.errors
+      end if @sdk
+      loop do
+        token = @access_token_stack.pop
+        break unless token
+        say_ok "logout the parent session" if @options[:debug]
+        @sdk.access_token = token
+        begin
+          @sdk.logout
+        rescue LookerSDK::Error => e
+          say_error "Unable to logout"
+          say_error e.message
+          say_error e.errors if e.respond_to?(:errors) && e.errors
+        end
+      end
+    end
+
+    def with_session(api_version="3.0")
+      return nil unless block_given?
+      begin
+        login(api_version) unless @sdk
+        yield
+      rescue LookerSDK::Error => e
+        say_error e.errors if e.respond_to?(:errors) && e.errors
+        e.backtrace.each { |b| say_error b } if @options[:debug]
+        raise Gzr::CLI::Error, e.message
+      ensure
+        logout_all
+      end
+    end
+  end
+end