gazer 0.2.17 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87c9fc855fb39c5b2db03afb3495706a6acbc341
-  data.tar.gz: 924bf3c6fd99783bd6d94960c9aac2a0404e6c36
+  metadata.gz: 2748a37dd51a0543b381ea57739cff2f15d1d437
+  data.tar.gz: 8638b34bc120de4baa9a50365186bd6d05d9e787
 SHA512:
-  metadata.gz: fe576cfebc5fa0f91339c07934818239899d214cb0c738fa3ff403a09129c2d97eb27fa8f5d7ba53d5caa9ba93f8a10f75b09f4490b0418589fa8d2dfeb3146e
-  data.tar.gz: 6bd4af2afb618333b1cd5ecff92bb4d4acd03289bcf26aac5f323a98c632e1cafbbc48baa7f8ff70cdbc6d562e5ef57898a56188623192ba01284a1589ff625e
+  metadata.gz: b580425e8b9c566d0413fc5e67cfd55df01887d73f13796a5eff46f20e1b552910f3d5b63d979fa40ac17e93941a33989fd388f7b57cbd37e0d075d87ce198d8
+  data.tar.gz: c51d839b274280e4722d72aaf9ed761be0304a04a4b6f07b8191423c09a7c1a45859ba315169673db5469d6c16b48efa96d54ccc6b976ff2d9a3eb819d11e4f2

data/.gitignore

@@ -13,3 +13,6 @@
 *~
 *.swp
 *.json
+gzr.code-workspace
+/output/
+scratch

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gazer (0.2.17)
+    gazer (0.2.18)
       looker-sdk (~> 0.0.6)
       netrc (~> 0.11.0)
       pastel (~> 0.7.2)
@@ -145,4 +145,4 @@ RUBY VERSION
    ruby 2.3.3p222
 
 BUNDLED WITH
-   1.16.2
+   1.16.6

data/README.md

@@ -129,7 +129,7 @@ gzr  group ls  --host foo.bar.mycompany.com
 
 #### group member_groups
 
-The command `gzr group member_group GROUP_ID` will list the group that have been added as
+The command `gzr group member_group GROUP_ID` will list the groups that have been added
 as members of the given group id.
 
 ```
@@ -143,7 +143,7 @@ $ gzr  group member_group 24  --host foo.bar.mycompany.com
 
 #### group member_users
 
-The command `gzr group member_users GROUP_ID` will list the users that have been added as
+The command `gzr group member_users GROUP_ID` will list the users that have been added
 as members of the given group id.
 
 ```
@@ -239,7 +239,7 @@ John Smith
 └── (d) Indicator Dashboard 2011
 ```
 
-The same arguments are accepted as by `space ls`.
+The same arguments are accepted as the `space ls` command.
 
 #### space cat
 
@@ -302,9 +302,9 @@ Looks and Dashboards will be located in the space directories in files named lik
 $ gzr space export 758 --host foo.bar.mycompany.com --dir .
 ```
 
-One interesting use of exporting a space into a directory tree is that it can be placed under version control
-using a tool like git. In that way user defined content changes can be tracked over time, and older versions
-of content can be restored if desired.
+One interesting consequence of exporting a space into a directory tree is that you can then place its
+contents under version control using a tool like git. In this way user defined content changes can be
+tracked over time, and older versions of content can be restored if desired.
 
 Alternately, the space can be exported into a `tar` style archive file with the switch `--tar FILENAME`.
 
@@ -366,8 +366,8 @@ $ gzr look rm 758 --host foo.bar.mycompany.com
 The `look import LOOK_FILE SPACE_ID` command is used to import a look from a file. If a look by the same
 name exists in that space then the `--force` switch must be used.
 
-Gazer will attempt to update the existing look of the same name, rather than create a new look. In
-that way the look id, schedules, permissions, etc. will be preserved.
+Gazer will attempt to update an existing look of the same name, rather than create a new look. In
+this way the look id, share URLs, schedules, permissions, etc. will be preserved.
 
 ```
 $ gzr look import Path/To/Look_123_My\ Look.json 123 --host foo.bar.mycompany.com --force
@@ -389,6 +389,82 @@ JSON data for dashboard
 The output document can be very long. Usually one will use the switch `--dir DIRECTORY` to
 save to a file. The file will be named `Dashboard_{DASHBOARD_ID}_{DASHBOARD_TITLE}.json`.
 
+The `--transform FILE` switch can be used to update the output document. This is useful to automatically
+perform tasks when promoting dashboards to upper environments, such as adding header or footer
+text tiles, replacing model or explore names, or updating filter expressions. The `FILE` parameter
+accepts a fully-qualified path to a JSON file describing the transformations to apply.
+
+```
+$ gzr dashboard cat 192 --host foo.bar.mycompany.com --transform path/to/transforms.json
+JSON data for dashboard modified by any transformations expressed in the transform file
+```
+
+The transform file uses a familiar JSON syntax. Within the file, you can define any number
+of `dashboard_elements` to append to your existing dashboard. Elements must be placed in either
+the top row or the bottom row of the existing dashboard, specified by the `position` attribute.
+You must also specify the `width` and `height` of your new elements.
+
+You can also define any number of `replacements`, which perform a simple find and replace
+within the JSON output based on the key-value pairs listed. This can be used to automatically
+replace model names or update filters for existing elements. You must escape double-quotes.
+
+Example JSON transform file:
+```
+{
+  "dashboard_elements": [
+    {
+      "position": "top",
+      "width": 12,
+      "height": 2,
+      "body_text": "Production Version of Dashboard (deployed 2019-06-18)",
+      "body_text_as_html": "<p>Production Version of Dashboard (deployed 2019-06-18)</p>",
+      "note_display": null,
+      "note_state": null,
+      "note_text": null,
+      "note_text_as_html": null,
+      "subtitle_text": "",
+      "title": null,
+      "title_hidden": false,
+      "title_text": "",
+      "type": "text"
+    },
+    {
+      "position": "bottom",
+      "width": 6,
+      "height": 2,
+      "body_text": "Please contact the Business Intelligence Help Desk for any issues with this dashboard",
+      "body_text_as_html": "<p>Please contact the Business Intelligence Help Desk for any issues with this dashboard</p>",
+      "note_display": null,
+      "note_state": null,
+      "note_text": null,
+      "note_text_as_html": null,
+      "subtitle_text": "",
+      "title": null,
+      "title_hidden": false,
+      "title_text": "",
+      "type": "text"
+    }
+  ],
+  "replacements": [
+    {
+      "\"model\": \"staging\",": "\"model\": \"production\","
+    },
+    {
+      "\"filter_expression\": \"not(is_null(${view.allowed_user}))\": "\"filter_expression\": \"${view.allowed_user} = _user_attributes['username']\","
+    }
+  ]
+}
+```
+| WARNING: You will not be able to overwrite dashboards that have been transformed! |
+| --- |
+
+In other words, you can&rsquo;t use the `--force` switch to replace a previously-transformed dashboard. Instead,
+you&rsquo;ll need to delete and recreate the dashboard. If you have stable content URLs enabled on your
+instance, the `slug` parameter ensures the URL for your dashboard won&rsquo;t change.
+
+This is because it is impossible to know the element IDs for elements that were added by the `--transform` operation,
+which makes it impossible to synchronize these elements in the future.
+
 #### dashboard rm
 
 The `dashboard rm DASHBOARD_ID` command is used to delete a dashboard.
@@ -399,13 +475,13 @@ $ gzr dashboard rm 192 --host foo.bar.mycompany.com
 
 #### dashboard import
 
-The `dashboard import DASHBAORD_FILE SPACE_ID` command is used to import a dashboard and
-its associated looks from a file. If a dashbaord or look by the same
+The `dashboard import DASHBOARD_FILE SPACE_ID` command is used to import a dashboard and
+its associated looks from a file. If a dashboard or look by the same
 name exists in that space then the `--force` switch must be used.
 
-Gazer will attempt to update the existing dashboard or look of the same name, rather than 
-create a new dashboard or look. In
-that way the id, schedules, permissions, etc. will be preserved.
+Gazer will attempt to update an existing dashboard or look of the same name,
+rather than create a new dashboard or look. In this way the id, share URLs,
+schedules, permissions, etc. will be preserved.
 
 ```
 $ gzr dashboard import Path/To/Dashboard_123_My\ Dash.json 123 --host foo.bar.mycompany.com --force
@@ -417,7 +493,7 @@ The command `gzr connection help` will show details about subcommands of the con
 
 #### connection ls
 
-The command `gzr connection ls` will list the connections that have been defined in the Looker instance.
+The command `gzr connection ls` will list the connections that exist in the Looker instance.
 
 ```
 $ gzr connection ls --host foo.bar.mycompany.com
@@ -492,7 +568,7 @@ The command `gzr model help` will show details about subcommands of the model co
 
 #### model ls
 
-The command `gzr model ls` will list the models that have been defined in the Looker instance.
+The command `gzr model ls` will list the models that exist in the Looker instance.
 
 ```
 $ gzr model ls --host foo.bar.mycompany.com

data/lib/gzr/commands/dashboard.rb

@@ -36,6 +36,8 @@ module Gzr
                            desc: 'Directory to store output file'
       method_option :plans,  type: :boolean,
                            desc: 'Include scheduled plans'
+      method_option :transform,  type: :string,
+                           desc: 'Fully-qualified path to a JSON file describing the transformations to apply'
       def cat(dashboard_id)
         if options[:help]
           invoke :help, ['cat']

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

@@ -43,8 +43,9 @@ module Gzr
         def execute(*args, input: $stdin, output: $stdout)
           say_warning("options: #{@options.inspect}") if @options[:debug]
           with_session("3.1") do
-            data = query_dashboard(@dashboard_id)
-            data.to_attrs()[:dashboard_elements].each_index do |i|
+            result = query_dashboard(@dashboard_id)
+            data = result.to_attrs
+            data[:dashboard_elements].each_index do |i|
               element = data[:dashboard_elements][i]
               if element[:merge_result_id]
                 merge_result = merge_query(element[:merge_result_id])
@@ -56,8 +57,59 @@ module Gzr
               end
             end
             data[:scheduled_plans] = query_scheduled_plans_for_dashboard(@dashboard_id,"all") if @options[:plans]
-            write_file(@options[:dir] ? "Dashboard_#{data.id}_#{data.title}.json" : nil, @options[:dir], nil, output) do |f|
-              f.puts JSON.pretty_generate(data.to_attrs)
+
+            replacements = {}
+            if @options[:transform]
+
+              max_row = 0
+              data[:dashboard_layouts][0][:dashboard_layout_components].each_index do |i|
+                component = data[:dashboard_layouts][0][:dashboard_layout_components][i]
+                if component[:row] + component[:height] > max_row
+                  max_row = component[:row] + component[:height] + 4
+                end
+              end
+
+              read_file(@options[:transform]) do |transform|
+                i = 0
+                transform[:dashboard_elements].collect! do |e|
+                  i += 1
+                  # there is no significance to 9900, we just need to prevent ID collisions
+                  e['id'] = 9900 + i
+                  data[:dashboard_elements] << e
+
+                  # when inserting an element into the top row, shift the other elements down according to the height of the inserted element
+                  if e[:position] === 'top'
+                    data[:dashboard_layouts][0][:dashboard_layout_components].each_index do |i|
+                      component = data[:dashboard_layouts][0][:dashboard_layout_components][i]
+                      component[:row] = component[:row] + e[:height]
+                    end
+                    row = '0'
+                  elsif e[:position] === 'bottom'
+                    row = max_row.to_s
+                  end
+                  
+                  column = '0'
+                  width = e[:width].to_s
+                  height = e[:height].to_s
+                  data[:dashboard_layouts][0][:dashboard_layout_components] << JSON.parse('{"id":' + e['id'].to_s + ',"dashboard_layout_id":1,"dashboard_element_id":' + e['id'].to_s + ''',"row":' + row + ',"column":' + column + ',"width":' + width + ',"height":' + height + ',"deleted":false,"element_title_hidden":false,"vis_type":"' + e[:type].to_s + '","can":{"index":true,"show":true,"create":true,"update":true,"destroy":true}}')
+                end
+
+                transform[:replacements].collect! do |e|
+                  replacements[e.keys.first.to_s] = e[e.keys[0]]
+                end
+
+              end
+            end
+
+            outputJSON = JSON.pretty_generate(data)
+
+            replacements.each do |k,v|
+              say_warning("Replaced #{k} with #{v}") if @options[:debug]
+              outputJSON.gsub! k,v
+            end
+
+            write_file(@options[:dir] ? "Dashboard_#{result.id}_#{result.title}.json" : nil, @options[:dir], nil, output) do |f|
+              f.puts outputJSON
             end
           end
         end

data/lib/gzr/modules/filehelper.rb

@@ -49,7 +49,7 @@ module Gzr
           test_dir = base + Pathname.new(path_part)
           Dir.mkdir(test_dir) unless (test_dir.exist? && test_dir.directory?)
         end if p
-        file = Pathname.new(file_name.gsub('/',"\u{2215}")) if file_name
+        file = Pathname.new(file_name.gsub('/',"\u{2215}").gsub(':','')) if file_name
         file = p + file if p
         file = base + file if base
         f = File.open(file, "wt") if file

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.17"
+  VERSION = "0.2.18"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gazer
 version: !ruby/object:Gem::Version
-  version: 0.2.17
+  version: 0.2.18
 platform: ruby
 authors:
 - Mike DeAngelo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-reader