gazer 0.3.1 → 0.3.3

data/lib/gzr/commands/session/logout.rb

@@ -0,0 +1,47 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2023 Mike DeAngelo Google, 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_relative '../../command'
+
+module Gzr
+  module Commands
+    class Session
+      class Logout < Gzr::Command
+        def initialize(options)
+          super()
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          say_warning(@options) if @options[:debug]
+          login
+          @sdk.logout
+          token_data = read_token_data || {}
+          token_data[@options[:host].to_sym] ||= {}
+          token_data[@options[:host].to_sym]&.delete(@options[:su]&.to_sym || :default)
+          write_token_data(token_data)
+        end
+      end
+    end
+  end
+end

data/lib/gzr/commands/session/update.rb

@@ -0,0 +1,51 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2023 Mike DeAngelo Google, 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_relative '../../command'
+require_relative '../../modules/session'
+
+module Gzr
+  module Commands
+    class Session
+      class Update < Gzr::Command
+        include Gzr::Session
+        def initialize(workspace_id,options)
+          super()
+          @options = options
+          @workspace_id = workspace_id
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          say_warning(@options) if @options[:debug]
+          if !@options[:token] && !@options[:token_file]
+            say_warning "Setting the session workspace_id only makes sense with a persistent session using --token or --token_file options"
+          end
+          with_session do
+            auth = update_auth(@workspace_id)
+            output.puts JSON.pretty_generate(auth)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gzr/commands/session.rb

@@ -0,0 +1,76 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2023 Mike DeAngelo Google, 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
+  module Commands
+    class Session < Thor
+
+      namespace :session
+
+      desc 'login', 'Create a persistent session'
+      method_option :text, type: :boolean, default: false,
+                           desc: 'output token to screen instead of file'
+      def login(*)
+        if options[:help]
+          invoke :help, ['login']
+        else
+          require_relative 'session/login'
+          Gzr::Commands::Session::Login.new(options).execute
+        end
+      end
+
+      desc 'logout', 'End a persistent session'
+      def logout(*)
+        if options[:help]
+          invoke :help, ['logout']
+        else
+          require_relative 'session/logout'
+          Gzr::Commands::Session::Logout.new(options).execute
+        end
+      end
+
+      desc 'get', 'Get data about current session'
+      def get(*)
+        if options[:help]
+          invoke :help, ['get']
+        else
+          require_relative 'session/get'
+          Gzr::Commands::Session::Get.new(options).execute
+        end
+      end
+
+      desc 'update WORKSPACE_ID', 'change the workspace_id of the current session'
+      def update(workspace_id)
+        if options[:help]
+          invoke :help, ['update']
+        else
+          require_relative 'session/update'
+          Gzr::Commands::Session::Update.new(workspace_id,options).execute
+        end
+      end
+
+    end
+  end
+end

data/lib/gzr/modules/alert.rb

@@ -0,0 +1,169 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2023 Mike DeAngelo Google, 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 Alert
+    def get_alert(alert_id)
+      data = nil
+      begin
+        data = @sdk.get_alert(alert_id)
+      rescue LookerSDK::NotFound => e
+        # do nothing
+      rescue LookerSDK::Error => e
+        say_error "Error querying get_alert(#{alert_id})"
+        say_error e
+        raise
+      end
+      if data[:owner_id]
+        owner = get_user_by_id(data[:owner_id])
+        data[:owner] = owner.to_attrs.select do |k,v|
+          [:email,:last_name,:first_name].include?(k) && !(v.nil? || v.empty?)
+        end
+      end
+      data
+    end
+
+    def search_alerts(group_by: nil, fields: nil, disabled: nil, frequency: nil, condition_met: nil, last_run_start: nil, last_run_end: nil, all_owners: nil)
+      data = []
+      begin
+        req = {}
+        req[:group_by] = group_by unless group_by.nil?
+        req[:fields] = fields unless fields.nil?
+        req[:disabled] = disabled unless disabled.nil?
+        req[:frequency] = frequency unless frequency.nil?
+        req[:condition_met] = condition_met unless condition_met.nil?
+        req[:last_run_start] = last_run_start unless last_run_start.nil?
+        req[:last_run_end] = last_run_end unless last_run_end.nil?
+        req[:all_owners] = all_owners unless all_owners.nil?
+        req[:limit] = 64
+        loop do
+          page = @sdk.search_alerts(req)
+          data+=page
+          break unless page.length == req[:limit]
+          req[:offset] = (req[:offset] || 0) + req[:limit]
+        end
+      rescue LookerSDK::NotFound => e
+        # do nothing
+      rescue LookerSDK::Error => e
+        say_error "Error querying search_alerts(#{JSON.pretty_generate(req)})"
+        say_error e
+        raise
+      end
+      data
+    end
+
+    def follow_alert(alert_id)
+      begin
+        @sdk.follow_alert(alert_id)
+      rescue LookerSDK::Error => e
+        say_error "Error following alert(#{alert_id})"
+        say_error e
+        raise
+      end
+    end
+
+    def unfollow_alert(alert_id)
+      begin
+        @sdk.unfollow_alert(alert_id)
+      rescue LookerSDK::Error => e
+        say_error "Error following alert(#{alert_id})"
+        say_error e
+        raise
+      end
+    end
+
+    def update_alert_field(alert_id, owner_id: nil, is_disabled: nil, disabled_reason: nil, is_public: nil, threshold: nil)
+      req = {}
+      req[:owner_id] = owner_id unless owner_id.nil?
+      req[:is_disabled] = is_disabled unless is_disabled.nil?
+      req[:disabled_reason] = disabled_reason unless disabled_reason.nil?
+      req[:is_public] = is_public unless is_public.nil?
+      req[:threshold] = threshold unless threshold.nil?
+      data = nil
+      begin
+        data = @sdk.update_alert_field(alert_id, req)
+      rescue LookerSDK::Error => e
+        say_error "Error calling update_alert_field(#{alert_id},#{JSON.pretty_generate(req)})"
+        say_error e
+        raise
+      end
+      data
+    end
+
+    def delete_alert(alert_id)
+      begin
+        @sdk.delete_alert(alert_id)
+      rescue LookerSDK::Error => e
+        say_error "Error calling delete_alert(#{alert_id})"
+        say_error e
+        raise
+      end
+    end
+
+    def alert_notifications()
+      data = []
+      req = {}
+      begin
+        req[:limit] = 64
+        loop do
+          page = @sdk.alert_notifications(req)
+          data+=page
+          break unless page.length == req[:limit]
+          req[:offset] = (req[:offset] || 0) + req[:limit]
+        end
+      rescue LookerSDK::NotFound => e
+        # do nothing
+      rescue LookerSDK::Error => e
+        say_error "Error querying alert_notifications()"
+        say_error e
+        raise
+      end
+      data
+    end
+
+    def read_alert_notification(notification_id)
+      data = nil
+      begin
+        data = @sdk.read_alert_notification(notification_id)
+      rescue LookerSDK::Error => e
+        say_error "Error calling read_alert_notification(#{notification_id})"
+        say_error e
+        raise
+      end
+      data.to_attrs
+    end
+
+    def create_alert(req)
+      data = nil
+      begin
+        data = @sdk.create_alert(req)
+      rescue LookerSDK::Error => e
+        say_error "Error calling create_alert(#{JSON.pretty_generate(req)})"
+        say_error e
+        raise
+      end
+      data.to_attrs
+    end
+
+  end
+end

data/lib/gzr/modules/connection.rb

@@ -48,5 +48,85 @@ module Gzr
       data
     end
 
+    def test_connection(name, tests=nil)
+      data = nil
+
+      if tests.nil?
+        connection = cat_connection(name)
+        if connection.nil?
+          return nil
+        end
+        tests = connection[:dialect][:connection_tests]
+      end
+
+      begin
+        data = @sdk.test_connection(name, {}, tests: tests)
+      rescue LookerSDK::NotFound => e
+        return nil
+      rescue LookerSDK::Error => e
+        say_error "Error executing test_connection(#{name},#{tests})"
+        say_error e
+        raise
+      end
+      data
+    end
+
+    def delete_connection(name)
+      begin
+        @sdk.delete_connection(name)
+      rescue LookerSDK::NotFound => e
+        say_warning "Connection #{name} not found"
+      rescue LookerSDK::Error => e
+        say_error "Error executing delete_connection(#{name})"
+        say_error e
+        raise
+      end
+    end
+
+    def create_connection(body)
+      data = nil
+      begin
+        data = @sdk.create_connection(body).to_attrs
+      rescue LookerSDK::Error => e
+        say_error "Error executing create_connection(#{JSON.pretty_generate(body)})"
+        say_error e
+        raise
+      end
+      data
+    end
+
+    def update_connection(name,body)
+      data = nil
+      begin
+        data = @sdk.connection(name,body).to_attrs
+      rescue LookerSDK::NotFound => e
+        say_warning "Connection #{name} not found"
+      rescue LookerSDK::Error => e
+        say_error "Error executing update_connection(#{name},#{JSON.pretty_generate(body)})"
+        say_error e
+        raise
+      end
+      data
+    end
+
+    def cat_connection(name)
+      data = nil
+      begin
+        data = @sdk.connection(name).to_attrs
+      rescue LookerSDK::NotFound => e
+        return nil
+      rescue LookerSDK::Error => e
+        say_error "Error executing connection(#{name})"
+        say_error e
+        raise
+      end
+      data
+    end
+
+    def trim_connection(data)
+      data.select do |k,v|
+        (keys_to_keep('create_connection') + [:pdt_context_override]).include? k
+      end
+    end
   end
 end

data/lib/gzr/modules/dashboard.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-# Copyright (c) 2018 Mike DeAngelo Looker Data Sciences, Inc.
+# Copyright (c) 2023 Mike DeAngelo Google, 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
@@ -20,9 +20,12 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 # frozen_string_literal: true
+require_relative 'alert'
 
 module Gzr
   module Dashboard
+    include Gzr::Alert
+
     def query_dashboard(dashboard_id)
       data = nil
       begin
@@ -249,6 +252,17 @@ module Gzr
             rewrite_color_palette!(o,default_colors)
           end
         end
+        alerts = search_alerts(fields: 'id,dashboard_element_id', group_by: 'dashboard', all_owners: true)
+        alerts.map!{|v| v.to_attrs}
+        say_warning alerts if @options[:debug]
+        data[:dashboard_elements].each do |e|
+          alerts_found = alerts.select { |a| a[:dashboard_element_id] == e[:id]}
+          say_warning "Found alerts #{alerts_found}" if @options[:debug]
+          alerts_entries = alerts_found.map { |a| get_alert(a[:id]).to_attrs }
+          say_warning "Looked up alerts entries #{alerts_entries}" if @options[:debug]
+          e[:alerts] = alerts_entries
+        end
+
         merge_result = merge_query(element[:merge_result_id])&.to_attrs if element[:merge_result_id]
         if merge_result
           merge_result[:source_queries].each_index do |j|
@@ -274,7 +288,7 @@ module Gzr
 
       trimmed[:dashboard_elements] = data[:dashboard_elements].map do |de|
         new_de = de.select do |k,v|
-          (keys_to_keep('update_dashboard_element') + [:id,:look,:query,:merge_result]).include? k
+          (keys_to_keep('update_dashboard_element') + [:id,:look,:query,:merge_result,:alerts]).include? k
         end
         if de[:look]
           new_de[:look] = de[:look].select do |k,v|
@@ -301,6 +315,13 @@ module Gzr
             end
           end
         end
+        if de[:alerts]
+          new_de[:alerts] = de[:alerts].map do |a|
+            a.select do |k,v|
+              (keys_to_keep('update_alert') + [:id,:owner]).include? k
+            end
+          end
+        end
         new_de
       end
 

data/lib/gzr/modules/project.rb

@@ -0,0 +1,106 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2023 Mike DeAngelo Google, 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 Project
+
+    def all_projects(fields: 'id')
+      data = []
+      begin
+        data = @sdk.all_projects({ fields: fields })
+      rescue LookerSDK::NotFound => e
+        return []
+      rescue LookerSDK::Error => e
+        say_error "Error querying all_projects(#{fields})"
+        say_error e
+        raise
+      end
+      data
+    end
+
+    def cat_project(project_id)
+      begin
+        return @sdk.project(project_id)&.to_attrs
+      rescue LookerSDK::NotFound => e
+        return nil
+      rescue LookerSDK::Error => e
+        say_error "Error getting project(#{project_id})"
+        say_error e
+        raise
+      end
+    end
+
+    def trim_project(data)
+      data.select do |k,v|
+        keys_to_keep('create_project').include? k
+      end
+    end
+
+    def create_project(body)
+      begin
+        return @sdk.create_project(body)&.to_attrs
+      rescue LookerSDK::Error => e
+        say_error "Error running create_project(#{JSON.pretty_generate(body)})"
+        say_error e
+        raise
+      end
+    end
+
+    def update_project(id,body)
+      begin
+        return @sdk.update_project(id,body)&.to_attrs
+      rescue LookerSDK::NotFound => e
+        return nil
+      rescue LookerSDK::Error => e
+        say_error "Error running update_project(#{id},#{JSON.pretty_generate(body)})"
+        say_error e
+        raise
+      end
+    end
+
+    def git_deploy_key(id)
+      begin
+        return @sdk.git_deploy_key(id)
+      rescue LookerSDK::NotFound => e
+        return nil
+      rescue LookerSDK::Error => e
+        say_error "Error running git_deploy_key(#{id})"
+        say_error e
+        raise
+      end
+    end
+
+    def create_git_deploy_key(id)
+      begin
+        return @sdk.create_git_deploy_key(id)
+      rescue LookerSDK::NotFound => e
+        return nil
+      rescue LookerSDK::Error => e
+        say_error "Error running create_git_deploy_key(#{id})"
+        say_error e
+        raise
+      end
+    end
+
+  end
+end