gazer 0.3.0 → 0.3.2

data/lib/gzr/commands/alert/read.rb

@@ -0,0 +1,49 @@
+# 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/alert'
+
+module Gzr
+  module Commands
+    class Alert
+      class Read < Gzr::Command
+        include Gzr::Alert
+        def initialize(notification_id,options)
+          super()
+          @notification_id = notification_id
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          say_warning(@options) if @options[:debug]
+          with_session do
+           data = read_alert_notification(@notification_id)
+           output.puts JSON.pretty_generate(data) unless (data.nil? || data.empty?)
+           output.puts "No notification found" if (data.nil? || data.empty?)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gzr/commands/alert/threshold.rb

@@ -0,0 +1,48 @@
+# 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/alert'
+
+module Gzr
+  module Commands
+    class Alert
+      class Threshold < Gzr::Command
+        include Gzr::Alert
+        def initialize(alert_id, threshold, options)
+          super()
+          @alert_id = alert_id
+          @threshold = threshold
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          say_warning(@options) if @options[:debug]
+          with_session do
+           update_alert_field(@alert_id, threshold: @threshold)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gzr/commands/alert/unfollow.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'
+require_relative '../../modules/alert'
+
+module Gzr
+  module Commands
+    class Alert
+      class Unfollow < Gzr::Command
+        include Gzr::Alert
+        def initialize(alert_id,options)
+          super()
+          @alert_id = alert_id
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          say_warning(@options) if @options[:debug]
+          with_session do
+           unfollow_alert(@alert_id)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gzr/commands/alert.rb

@@ -0,0 +1,200 @@
+# 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 Alert < Thor
+
+      namespace :alert
+
+      desc 'ls', 'list alerts'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      method_option :fields, type: :string, default: 'id,field(title,name),comparison_type,threshold,cron,custom_title,dashboard_element_id,description',
+                           desc: 'Fields to display'
+      method_option :disabled, type: :boolean, default: nil,
+                           desc: 'return disabled alerts'
+      method_option :all, type: :boolean, default: nil,
+                           desc: 'return alerts from all users (must be admin)'
+      method_option :plain, type: :boolean, default: false,
+                           desc: 'print without any extra formatting'
+      method_option :csv, type: :boolean, default: false,
+                           desc: 'output in csv format per RFC4180'
+      def ls(*)
+        if options[:help]
+          invoke :help, ['ls']
+        else
+          require_relative 'alert/ls'
+          Gzr::Commands::Alert::Ls.new(options).execute
+        end
+      end
+
+      desc 'cat ALERT_ID', 'Output json information about an alert to screen or file'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      method_option :dir,  type: :string,
+                           desc: 'Directory to store output file'
+      def cat(alert_id)
+        if options[:help]
+          invoke :help, ['cat']
+        else
+          require_relative 'alert/cat'
+          Gzr::Commands::Alert::Cat.new(alert_id,options).execute
+        end
+      end
+
+      desc 'follow ALERT_ID', 'Start following the alert given by ALERT_ID'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def follow_alert(alert_id)
+        if options[:help]
+          invoke :help, ['follow']
+        else
+          require_relative 'alert/follow'
+          Gzr::Commands::Alert::Follow.new(alert_id,options).execute
+        end
+      end
+
+      desc 'unfollow ALERT_ID', 'Stop following the alert given by ALERT_ID'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def unfollow_alert(alert_id)
+        if options[:help]
+          invoke :help, ['unfollow']
+        else
+          require_relative 'alert/unfollow'
+          Gzr::Commands::Alert::Unfollow.new(alert_id,options).execute
+        end
+      end
+
+      desc 'enable ALERT_ID', 'Enable the alert given by ALERT_ID'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def enable(alert_id)
+        if options[:help]
+          invoke :help, ['enable']
+        else
+          require_relative 'alert/enable'
+          Gzr::Commands::Alert::Enable.new(alert_id,options).execute
+        end
+      end
+
+      desc 'disable ALERT_ID REASON', 'Disable the alert given by ALERT_ID'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def disable(alert_id,reason)
+        if options[:help]
+          invoke :help, ['disable']
+        else
+          require_relative 'alert/disable'
+          Gzr::Commands::Alert::Disable.new(alert_id,reason,options).execute
+        end
+      end
+
+      desc 'threshold ALERT_ID THRESHOLD', 'Change the threshold of the alert given by ALERT_ID'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def threshold(alert_id,threshold)
+        if options[:help]
+          invoke :help, ['threshold']
+        else
+          require_relative 'alert/threshold'
+          Gzr::Commands::Alert::Threshold.new(alert_id,threshold,options).execute
+        end
+      end
+
+      desc 'rm ALERT_ID', 'Delete the alert given by ALERT_ID'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def rm(alert_id)
+        if options[:help]
+          invoke :help, ['delete']
+        else
+          require_relative 'alert/delete'
+          Gzr::Commands::Alert::Delete.new(alert_id,options).execute
+        end
+      end
+
+      desc 'chown ALERT_ID OWNER_ID', 'Change the owner of the alert given by ALERT_ID to OWNER_ID'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def chown(alert_id, owner_id)
+        if options[:help]
+          invoke :help, ['chown']
+        else
+          require_relative 'alert/chown'
+          Gzr::Commands::Alert::Chown.new(alert_id,owner_id,options).execute
+        end
+      end
+
+      desc 'notifications', 'Get notifications'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      method_option :plain, type: :boolean, default: false,
+                           desc: 'print without any extra formatting'
+      method_option :csv, type: :boolean, default: false,
+                           desc: 'output in csv format per RFC4180'
+      def notifications(*)
+        if options[:help]
+          invoke :help, ['notifications']
+        else
+          require_relative 'alert/notifications'
+          Gzr::Commands::Alert::Notifications.new(options).execute
+        end
+      end
+
+      desc 'read NOTIFICATION_ID', 'Read notification id'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      method_option :plain, type: :boolean, default: false,
+                           desc: 'print without any extra formatting'
+      method_option :csv, type: :boolean, default: false,
+                           desc: 'output in csv format per RFC4180'
+      def read(notification_id)
+        if options[:help]
+          invoke :help, ['read']
+        else
+          require_relative 'alert/read'
+          Gzr::Commands::Alert::Read.new(notification_id,options).execute
+        end
+      end
+
+      desc 'import FILE [DASHBOARD_ELEMENT_ID]', 'Import an alert from a file'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      method_option :plain, type: :boolean,
+                           desc: 'Provide minimal response information'
+      def import(file,dashboard_element_id=nil)
+        if options[:help]
+          invoke :help, ['import']
+        else
+          require_relative 'alert/import'
+          Gzr::Commands::Alert::Import.new(file, dashboard_element_id, options).execute
+        end
+      end
+
+    end
+  end
+end

data/lib/gzr/commands/dashboard/cat.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
@@ -44,6 +44,7 @@ module Gzr
           say_warning("options: #{@options.inspect}") if @options[:debug]
           with_session do
             data = cat_dashboard(@dashboard_id)
+            data = trim_dashboard(data) if @options[:trim]
 
             replacements = {}
             if @options[:transform]

data/lib/gzr/commands/dashboard/import.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
@@ -89,6 +89,17 @@ module Gzr
                 element[:result_maker] = result_maker if result_maker
                 dashboard_element = create_dashboard_element(element)
                 say_warning "dashboard_element #{dashboard_element.inspect}" if @options[:debug]
+                if new_element[:alerts]
+                  new_element[:alerts].each do |a|
+                    a.select! do |k,v|
+                      (keys_to_keep('create_alert') - [:owner_id, :dashboard_element_id]).include? k
+                    end
+                    a[:dashboard_element_id] = dashboard_element[:id]
+                    a[:owner_id] = @me[:id]
+                    new_alert = create_alert(a)
+                    say_warning "alert #{JSON.pretty_generate(new_alert)}" if @options[:debug]
+                  end
+                end
                 dashboard[:dashboard_elements].push dashboard_element
                 [new_element[:id], dashboard_element.id]
               end

data/lib/gzr/commands/dashboard.rb

@@ -53,7 +53,9 @@ module Gzr
       method_option :transform,  type: :string,
                            desc: 'Fully-qualified path to a JSON file describing the transformations to apply'
       method_option :simple_filename, type: :boolean,
-                    desc: 'Use simple filename for output (Dashboard_<id>.json)'
+                           desc: 'Use simple filename for output (Dashboard_<id>.json)'
+      method_option :trim, type: :boolean,
+                           desc: 'Trim output to minimal set of fields for later import'
       def cat(dashboard_id)
         if options[:help]
           invoke :help, ['cat']

data/lib/gzr/commands/folder/export.rb

@@ -99,12 +99,14 @@ module Gzr
           end
           folder[:looks].each do |l|
             look = cat_look(l[:id])
+            look = trim_look(look) if @options[:trim]
             write_file("Look_#{look[:id]}_#{look[:title]}.json", base, path) do |f|
               f.write JSON.pretty_generate(look)
             end
           end
           folder[:dashboards].each do |d|
             data = cat_dashboard(d[:id])
+            data = trim_dashboard(data) if @options[:trim]
             write_file("Dashboard_#{data[:id]}_#{data[:title]}.json", base, path) do |f|
               f.write JSON.pretty_generate(data)
             end

data/lib/gzr/commands/folder.rb

@@ -66,6 +66,8 @@ module Gzr
                            desc: 'Display usage information'
       method_option :plans,  type: :boolean,
                            desc: 'Include scheduled plans'
+      method_option :trim,  type: :boolean,
+                           desc: 'Trim output to minimal set of fields for later import'
       method_option :dir, type: :string, default: '.',
                            desc: 'Directory to store output tree'
       method_option :tar, type: :string,

data/lib/gzr/commands/look/cat.rb

@@ -43,6 +43,7 @@ module Gzr
           say_warning("options: #{@options.inspect}") if @options[:debug]
           with_session do
             data = cat_look(@look_id)
+            data = trim_look(data) if @options[:trim]
             file_name = if @options[:dir]
                           @options[:simple_filename] ? "Look_#{data[:id]}.json" : "Look_#{data[:id]}_#{data[:title]}.json"
                         else

data/lib/gzr/commands/look.rb

@@ -84,6 +84,8 @@ module Gzr
                            desc: 'Include scheduled plans'
       method_option :simple_filename,  type: :boolean,
                            desc: 'Use simple filename for output (Look_<id>.json)'
+      method_option :trim, type: :boolean,
+                           desc: 'Trim output to minimal set of fields for later import'
       def cat(look_id)
         if options[:help]
           invoke :help, ['cat']

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