gazer 0.2.40 → 0.2.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 417b013d1a277bbb0f15622d80475dd2371a306323156ef46a60b9730fefc159
-  data.tar.gz: eaa6ed298f737c3fa29b59b04f783b3278f4c3731f00fefc40cb39820505fd05
+  metadata.gz: 63f0133a6db8baa3e1cbb77432444b11b51a9d3f63746b1e18018b9da52ffba1
+  data.tar.gz: b1128abc82113482b0bbc5956f680b4b6e633d26ab9204988e87ce45a83f5cdb
 SHA512:
-  metadata.gz: 31d6d7d1fbec05153cd86db80c7556b9de2e774d10b0cbea10d8403fead584a6f47eb21b0d78d5424c6b219bf4d8950ec9c446bb3e9bab879715ef9f9a55557c
-  data.tar.gz: e813f21a9aef2ea51d88536ebfa4286e62fcbc6a0fe78e64fb23dc33c3877ea762d2260f022638dee4b57919daeab77f520f37ade199d060ec969c023ba3ac53
+  metadata.gz: 0c94dda1c71d32c8441c7eeba27c230a5ec35e5b96e3b8b3dd897aa1f4c38f685c4edee7961beb8fe67e4e091922d697e55fd36d8f47fd907c1fa0f4f3a92c48
+  data.tar.gz: 5e56640ba557897596eec20cf99b5465ec8760dba904bc01d0e82e67af97ce559dcc85f7e5a2b286c0aa3c96bd882d350d04c6cac3b431ab8bc44fc12656b188

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gazer (0.2.40)
+    gazer (0.2.41)
       looker-sdk (~> 0.0.7)
       netrc (~> 0.11.0)
       pastel (~> 0.7.2)

data/README.md

@@ -34,6 +34,18 @@ machine foo.bar.mycompany.com
 
 Make sure that the `~/.netrc` file has restricted permissions by running `chmod 600 ~/.netrc`.
 
+### API port
+Most instances of Looker use port 19999 for the API. Gazer will use that port by default when executing a command.
+Looker instances that are hosted in Google Cloud direct both the API and the web
+interface traffic through port 443, the standard https port. Some other
+installations may also use port 443.
+
+If your Looker instance is GCP-hosted (*.cloud.looker.com), you must specify `--port 443`, eg:
+
+```
+$ gzr user me --host mycompany.cloud.looker.com --port 443
+```
+
 ### Options that apply to many commands
 
 #### --su option

data/lib/gzr/command.rb

@@ -116,6 +116,146 @@ module Gzr
       data
     end
 
+    def all_color_collections()
+      data = nil
+      begin
+        data = @sdk.all_color_collections()
+      rescue NoMethodError => nme
+        say_warning "The api endpoint all_color_collections() is not implemented on this Looker instance"
+      rescue LookerSDK::NotFound => nf
+        say_warning "The current user can't query all color collections"
+      rescue LookerSDK::Error => e
+        say_error "Error querying all_color_collections()"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def default_color_collection()
+      return @dcc if @dcc
+      data = nil
+      begin
+        data = @sdk.default_color_collection()
+        @dcc = data
+      rescue NoMethodError => nme
+        say_warning "The api endpoint default_color_collection() is not implemented on this Looker instance"
+      rescue LookerSDK::NotFound => nf
+        say_warning "The current user can't query the default color collection"
+      rescue LookerSDK::Error => e
+        say_error "Error querying default_color_collection()"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def color_collection(collection_id)
+      data = nil
+      begin
+        data = @sdk.color_collection(collection_id)
+      rescue NoMethodError => nme
+        say_warning "The api endpoint color_collection(collection_id) is not implemented on this Looker instance"
+      rescue LookerSDK::NotFound => nf
+        say_warning "The color_collection(#{collection_id}) is not found"
+      rescue LookerSDK::Error => e
+        say_error "Error querying color_collection(#{collection_id})"
+        say_error e.message
+        raise
+      end
+      data
+    end
+
+    def find_vis_config_reference(obj, &block)
+      if obj.respond_to?(:'has_key?') && obj.has_key?(:vis_config)
+        yield (obj[:vis_config])
+      end
+      if obj.is_a? Enumerable
+        obj.each { |o| find_vis_config_reference(o,&block) }
+      end
+    end
+
+    def find_color_palette_reference(obj, default_colors=nil, &block)
+      begin
+        dcc = default_color_collection()
+        if dcc.nil?
+          say_warning "You do not have access to query color palettes so these won't be processed."
+          return
+        end
+        default_colors=color_palette_lookup!(dcc)
+      end unless default_colors
+
+      if obj.respond_to?(:'has_key?') && obj.has_key?(:collection_id) && obj.has_key?(:palette_id)
+        yield(obj,default_colors)
+      end
+      if obj.is_a? Enumerable
+        obj.each { |o| find_color_palette_reference(o,default_colors,&block) }
+      end
+    end
+
+    def color_palette_lookup!(obj)
+      return nil unless obj
+      palettes = []
+      palettes += obj[:categoricalPalettes] if obj[:categoricalPalettes]
+      palettes += obj[:sequentialPalettes] if obj[:sequentialPalettes]
+      palettes += obj[:divergingPalettes] if obj[:divergingPalettes]
+      obj[:palettes]=palettes
+      obj
+    end
+
+    def rewrite_color_palette!(o,default_colors)
+      cc = nil
+      if o[:collection_id] == default_colors[:id]
+        o[:collection_default] = true
+        cc = default_colors
+      else
+        o[:collection_default] = false
+        cc = color_palette_lookup!(color_collection(o[:collection_id]))
+      end
+      return unless cc
+      o[:collection_label] = cc[:label]
+      ps = cc[:palettes].select { |p| p[:id] == o[:palette_id] }
+      if ps.length > 0
+        o[:palette_label] = ps.first[:label]
+        o[:palette_type] = ps.first[:type]
+      end
+    end
+
+    def update_color_palette!(o,default_colors,force_default=false)
+      return unless o.has_key?(:collection_label) && o.has_key?(:palette_type)
+
+      cc = default_colors
+      if !(force_default && o[:collection_default])
+        # look up color collection by id
+        cc = color_palette_lookup!(color_collection(o[:collection_id]))
+        if cc.nil?
+          # find color collection by name
+          ccs = all_color_collections()&.select { |cc| o[:collection_label] == cc[:label]}
+          if ccs.nil? || ccs.length == 0
+            # no color collection found. Use default.
+            say_warning "Color collection #{o[:collection_label]} not found. Using default."
+            cc = default_colors
+          else
+            cc = color_palette_lookup!(ccs.first)
+          end
+        end
+      end
+      o[:collection_id] = cc[:id]
+
+      # look up palette by id
+      ps = cc[:palettes].select {|p| p[:id] == o[:palette_id]}
+      if ps.length == 0
+        # find palette by type
+        ps = cc[:palettes].select {|p| p[:type] == o[:palette_type]}
+        if ps.length > 0
+          o[:palette_id] = ps.first[:id]
+        else
+          # no palette found
+          say_warning "Color palette #{o[:palette_type]} not found."
+          o.delete(:palette_id)
+        end
+      end
+    end
 
     ##
     # This method accepts the name of an sdk operation, then finds the parameter for that
@@ -131,7 +271,7 @@ module Gzr
     #   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
@@ -145,12 +285,12 @@ module Gzr
       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 (

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

@@ -46,12 +46,22 @@ module Gzr
             data = query_dashboard(@dashboard_id).to_attrs
             data[:dashboard_elements].each_index do |i|
               element = data[:dashboard_elements][i]
+              find_vis_config_reference(element) do |vis_config|
+                find_color_palette_reference(vis_config) do |o,default_colors|
+                  rewrite_color_palette!(o,default_colors)
+                end
+              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|
                   source_query = merge_result[:source_queries][j]
                   merge_result[:source_queries][j][:query] = query(source_query[:query_id]).to_attrs
                 end
+                find_vis_config_reference(merge_result) do |vis_config|
+                  find_color_palette_reference(vis_config) do |o,default_colors|
+                    rewrite_color_palette!(o,default_colors)
+                  end
+                end
                 data[:dashboard_elements][i][:merge_result] = merge_result
               end
             end
@@ -86,7 +96,7 @@ module Gzr
                   elsif e[:position] === 'bottom'
                     row = max_row.to_s
                   end
-                  
+
                   column = '0'
                   width = e[:width].to_s
                   height = e[:height].to_s

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

@@ -42,10 +42,16 @@ module Gzr
         def execute(input: $stdin, output: $stdout)
           say_warning("options: #{@options.inspect}") if @options[:debug]
           with_session do
-            data = query_look(@look_id)
-            data[:scheduled_plans] = query_scheduled_plans_for_look(@look_id,"all") if @options[:plans]
-            write_file(@options[:dir] ? "Look_#{data.id}_#{data.title}.json" : nil, @options[:dir],nil, output) do |f|
-              f.puts JSON.pretty_generate(data.to_attrs)
+            data = query_look(@look_id).to_attrs
+            find_vis_config_reference(data) do |vis_config|
+              find_color_palette_reference(vis_config) do |o,default_colors|
+                rewrite_color_palette!(o,default_colors)
+              end
+            end
+
+            data[:scheduled_plans] = query_scheduled_plans_for_look(@look_id,"all").to_attrs if @options[:plans]
+            write_file(@options[:dir] ? "Look_#{data[:id]}_#{data[:title]}.json" : nil, @options[:dir],nil, output) do |f|
+              f.puts JSON.pretty_generate(data)
             end
           end
         end

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

@@ -47,7 +47,7 @@ module Gzr
           with_session do
 
             @me ||= query_me("id")
-            
+
             read_file(@file) do |data|
               look = upsert_look(@me.id,create_fetch_query(data[:query]).id,@dest_space_id,data,output: output)
               upsert_plans_for_look(look.id,@me.id,data[:scheduled_plans]) if data[:scheduled_plans]

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

@@ -84,33 +84,48 @@ module Gzr
         end
 
         def process_space(space_id, base, rel_path = nil)
-          space = query_space(space_id)
-          name = space.name
+          space = query_space(space_id).to_attrs
+          name = space[:name]
           name = "nil (#{space_id})" if name.nil?
           path = Pathname.new(name.gsub('/',"\u{2215}"))
           path = rel_path + path if rel_path
 
-          write_file("Space_#{space.id}_#{name}.json", base, path) do |f|
-            f.write JSON.pretty_generate(space.to_attrs.reject do |k,v|
+          write_file("Space_#{space[:id]}_#{name}.json", base, path) do |f|
+            f.write JSON.pretty_generate(space.reject do |k,v|
               [:looks, :dashboards].include?(k)
             end)
           end
-          space.looks.each do |l|
-            look = query_look(l.id)
-            write_file("Look_#{look.id}_#{look.title}.json", base, path) do |f|
-              f.write JSON.pretty_generate(look.to_attrs) 
+          space[:looks].each do |l|
+            look = query_look(l[:id]).to_attrs
+            find_vis_config_reference(look) do |vis_config|
+              find_color_palette_reference(vis_config) do |o,default_colors|
+                rewrite_color_palette!(o,default_colors)
+              end
+            end
+            write_file("Look_#{look[:id]}_#{look[:title]}.json", base, path) do |f|
+              f.write JSON.pretty_generate(look)
             end
           end
-          space.dashboards.each do |d|
-            data = query_dashboard(d.id).to_attrs()
+          space[:dashboards].each do |d|
+            data = query_dashboard(d[:id]).to_attrs()
             data[:dashboard_elements].each_index do |i|
               element = data[:dashboard_elements][i]
+              find_vis_config_reference(element) do |vis_config|
+                find_color_palette_reference(vis_config) do |o,default_colors|
+                  rewrite_color_palette!(o,default_colors)
+                end
+              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|
                   source_query = merge_result[:source_queries][j]
                   merge_result[:source_queries][j][:query] = query(source_query[:query_id]).to_attrs()
                 end
+                find_vis_config_reference(merge_result) do |vis_config|
+                  find_color_palette_reference(vis_config) do |o,default_colors|
+                    rewrite_color_palette!(o,default_colors)
+                  end
+                end
                 data[:dashboard_elements][i][:merge_result] = merge_result
               end
             end
@@ -120,7 +135,7 @@ module Gzr
           end
           space_children = query_space_children(space_id)
           space_children.each do |child_space|
-            process_space(child_space.id, base, path)
+            process_space(child_space[:id], base, path)
           end
         end
       end

data/lib/gzr/modules/look.rb

@@ -136,34 +136,44 @@ module Gzr
         new_look = source.select do |k,v|
           (keys_to_keep('update_look') - [:space_id,:folder_id,:user_id,:query_id,:slug]).include? k
         end
-        new_look[:slug] = source[:slug] if source[:slug] && !slug_used 
-          new_look[:deleted] = false if existing_look[:deleted]
-          new_look[:query_id] = query_id
-          return update_look(existing_look.id,new_look)
-        else
-          new_look = source.select do |k,v|
-            (keys_to_keep('create_look') - [:space_id,:folder_id,:user_id,:query_id,:slug]).include? k
+        new_look[:slug] = source[:slug] if source[:slug] && !slug_used
+        new_look[:deleted] = false if existing_look[:deleted]
+        new_look[:query_id] = query_id
+        return update_look(existing_look.id,new_look)
+      else
+        new_look = source.select do |k,v|
+          (keys_to_keep('create_look') - [:space_id,:folder_id,:user_id,:query_id,:slug]).include? k
+        end
+        new_look[:slug] = source[:slug] unless slug_used
+        new_look[:query_id] = query_id
+        new_look[:user_id] = user_id
+        new_look[:space_id] = space_id
+
+        find_vis_config_reference(new_look) do |vis_config|
+          find_color_palette_reference(vis_config) do |o,default_colors|
+            update_color_palette!(o,default_colors)
           end
-          new_look[:slug] = source[:slug] unless slug_used
-          new_look[:query_id] = query_id
-          new_look[:user_id] = user_id
-          new_look[:space_id] = space_id
-
-          return create_look(new_look)
+        end
+        return create_look(new_look)
       end
     end
 
     def create_fetch_query(source_query)
       new_query = source_query.select do |k,v|
         (keys_to_keep('create_query') - [:client_id]).include? k
-      end 
+      end
+      find_vis_config_reference(new_query) do |vis_config|
+        find_color_palette_reference(vis_config) do |o,default_colors|
+          update_color_palette!(o,default_colors)
+        end
+      end
       return create_query(new_query)
     end
 
     def create_merge_result(merge_result)
       new_merge_result = merge_result.select do |k,v|
         (keys_to_keep('create_merge_query') - [:client_id,:source_queries]).include? k
-      end 
+      end
       new_merge_result[:source_queries] = merge_result[:source_queries].map do |query|
         new_query = {}
         new_query[:query_id] = create_fetch_query(query[:query]).id
@@ -171,6 +181,11 @@ module Gzr
         new_query[:merge_fields] = query[:merge_fields]
         new_query
       end
+      find_vis_config_reference(new_merge_result) do |vis_config|
+        find_color_palette_reference(vis_config) do |o,default_colors|
+          update_color_palette!(o,default_colors)
+        end
+      end
       return create_merge_query(new_merge_result)
     end
   end

data/lib/gzr/modules/session.rb

@@ -116,15 +116,15 @@ module Gzr
           http.headers[:accept] = 'application/json'
           http.headers[:user_agent] = conn_hash[:user_agent]
         end
-        
-        begin 
+
+        begin
           versions_response = agent.call(:get,"/versions")
           versions = versions_response.data.supported_versions
           current_version = versions_response.data.current_version
         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?"
+          raise Gzr::CLI::Error, "Connection Failed.\nDid you specify the --no-ssl option for an ssl secured server?\nYou may need to use --port=443 in some cases as well."
         rescue LookerSDK::NotFound => nf
           say_warning "endpoint #{root}/versions was not found"
         end

data/lib/gzr/version.rb

@@ -20,5 +20,5 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module Gzr
-  VERSION = "0.2.40"
+  VERSION = "0.2.41"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gazer
 version: !ruby/object:Gem::Version
-  version: 0.2.40
+  version: 0.2.41
 platform: ruby
 authors:
 - Mike DeAngelo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-reader
@@ -357,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Command line tool to manage the content of a Looker instance.