fastlyctl 1.0.9 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daf9fcc2f5ea41339d508dd96ddcfe7ddf8f6e16078d382848d9ee23ef99b0cf
-  data.tar.gz: e8d385f3aa42874caa6ccbd96030d983a71cb6e2b45660a296163d4027120067
+  metadata.gz: 9c0c20fe758873efe396f68d050d11c8c3675f352918a2a9a9ba55d4a334879f
+  data.tar.gz: 70d29a51e74acffa02ff2a330694cb86d1a6d262cbc95d2967440a0777c61601
 SHA512:
-  metadata.gz: 3d89e5730ec02621ff903b8fa295b65381025ee7372fd260487acac10398c0ad00db493454b6c5cb37438fccd403cd09841c3624bc697f2b25d0dfb7265cd715
-  data.tar.gz: 82a1d997aa0ad5cf4770bbc253e593280aa609a54003e8ad87ff515c7e0889f84a1c56d657b41a9b69bf93c14f467818f2f0e5bd17d948dd6f66f3ecf795b3eb
+  metadata.gz: a75044ca703cb25c00b3968f2d8a59936f8bbc54af13b02480ea273b4a85b5da5cdd76bf51c828f2d73e9452c8e3538133471b79c01e3424c0fb35afcdf8df21
+  data.tar.gz: 1db8c990dd3cb81fec5e6bb92f6b9b2e0dd8f1a3b03d522c0e573f1fe1617d4ab17c4c006f7a188e43b8d9e38747f6f794e996d17c5b8859e64eba0bf6da5f98

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fastlyctl (1.0.9)
+    fastlyctl (1.0.11)
       diffy (~> 3.2.1)
       launchy (~> 2.4.3, >= 2.4.3)
       thor (~> 0.19.4)
@@ -30,4 +30,4 @@ DEPENDENCIES
   fastlyctl!
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -199,6 +199,56 @@ Flags:
   * --s: The service ID to download. Current working directory is assumed.
   * --v: The version to download. The currently active version is assumed.
 
+### logging 
+
+Manage the realtime logging configuration for a service, as well as checking on the status of the logging endpoints.  Logging requires a subcommand of either `status` or the name of a logging provider listed below.
+
+##### status
+
+Status returns the current status of your logging configurations in JSON format.  Helps in telling you whether or not the logging is working or returning an error.
+
+Usage:
+```
+fastlyctl logging status
+```
+
+Flags:
+
+  * `--s / --service`  Service ID to use
+
+##### BigQuery
+
+Usage: 
+```
+fastlyctl logging bigquery ACTION [FLAGS]
+```
+
+Supported ACTIONs are `create`, `update`, `show`, `delete`, `list` 
+
+Flags:
+
+  * `--s / --service`  Service ID to use  (required) 
+  * `--v / --version`  Version of the service to use 
+  * `--n / --name`     Current name of the logging configuration
+  * `--nn / --new-name`  Used for the update method to rename a configuration
+  * `--ff / --format-file`  Path to the file containing the JSON Representation of the logline, must match BigQuery schema
+  * `--u / --user`     Google Cloud Service Account Email
+  * `--scf / --secret-key-file` Path to the file that contains the Google Cloud Account secret key
+  * `--p / --project-id` Google Cloud Project ID
+  * `--d / --dataset` Google BigQuery dataset 
+  * `--t / --table` Google BigQuery table
+  * `--ts / --template-suffix` Google table name suffix 
+  * `--pl / --placement` Placement of the logging  call, can be none or waf_debug.  Not required and no default
+  * `--r / --response-condition` When to execute, if empty it is always
+
+
+To print the full list of the options required type the command:
+
+```
+fastlyctl logging bigquery --help
+```
+
+
 ### login
 
 Login to the Fastly app and create an API token. This token will be stored in your home directory for the CLI to use for all requests.

data/lib/fastlyctl/cli.rb

@@ -15,6 +15,7 @@ require "fastlyctl/commands/domain"
 require "fastlyctl/commands/snippet"
 require "fastlyctl/commands/acl"
 require "fastlyctl/commands/copy"
+require "fastlyctl/commands/logging"
 
 
 module FastlyCTL

data/lib/fastlyctl/commands/logging/bigquery.rb

@@ -0,0 +1,133 @@
+module BigQuery
+
+    def BigQuery.parse_secret_key(file)
+        key = File.read(file)
+        if key[0..26] != "-----BEGIN PRIVATE KEY-----"
+            abort "Error, private key file should begin with -----BEGIN PRIVATE KEY-----"
+        end
+
+        return key 
+    end
+
+    def BigQuery.ensure_opts(required_opts,options) 
+        required_opts.each { |k| 
+            if !options.key?(k)
+                abort "Error, option #{k.to_s} is required for this action"
+            end
+        }
+    end
+
+    def BigQuery.print_configs(config)
+        max = {}
+        max["name"] = 0 
+        max["dataset"] = 0 
+        max["table"] = 0 
+        max["project_id"] = 0 
+        fields = ["name","dataset","table","project_id"]
+
+        config.each { |c| 
+            fields.each { |f| 
+                max[f] = c[f].length > max[f] ? c[f].length : max[f]
+           }
+        }
+        
+        puts
+        puts "Name".ljust(max["name"]) + " | " + "Dataset".ljust(max["dataset"]) + " | " + "Table".ljust(max["table"]) + " | " + "ProjectId".ljust(max["project_id"])
+        puts "-" * (max["name"] + max["dataset"] + max["table"] + max["project_id"])
+        config.each { |c| 
+            puts "%s | %s | %s | %s" % [c["name"].ljust(max["name"]), c["dataset"].ljust(max["dataset"]), c["table"].ljust(max["table"]), c["project_id"].ljust(max["project_id"])]
+        }
+        puts
+    end
+
+
+    def self.create(options)
+        puts "Creating bigquery log endpoint"
+        required_opts = ["name", "format_file", "user", "secret_key_file", "project_id", "dataset", "table" ]
+        
+        ensure_opts(required_opts,options)
+
+        parsed_key = parse_secret_key(options[:secret_key_file])
+
+        parsed_format = File.read(options[:format_file])
+
+        params = {}
+
+        id  = options[:service]
+        version = FastlyCTL::Fetcher.get_writable_version(id) unless options[:version]
+        version ||= options[:version]
+
+        params[:name] = options[:name] 
+        params[:format] = parsed_format 
+        params[:user] = options[:user]
+        params[:secret_key] = parsed_key
+        params[:project_id] = options[:project_id]
+        params[:dataset] = options[:dataset]
+        params[:table] = options[:table]
+
+        FastlyCTL::Fetcher.api_request(:post, "/service/#{id}/version/#{version}/logging/bigquery", body: params)
+        puts "BigQuery logging provider created in service id #{id} on version #{version}"
+    end
+
+    def self.update(options)
+        required_opts = ["name"]
+        ensure_opts(required_opts,options)
+        
+        puts "Updating bigquery log endpoint #{options[:name]}"
+
+        parsed_key = parse_secret_key(options[:secret_key_file]) unless options[:secret_key_file].nil?
+        parsed_format = File.read(options[:format_file]) unless options[:format_file].nil?
+
+        params = {}
+
+        id  = options[:service]
+        version = FastlyCTL::Fetcher.get_writable_version(id) unless options[:version]
+        version ||= options[:version]
+
+        params[:name] = options[:new_name] unless options[:new_name].nil? 
+        params[:format] = parsed_format unless options[:format_file].nil?
+        params[:user] = options[:user] unless options[:user].nil?
+        params[:secret_key] = parsed_key  unless options[:secret_key_file].nil?
+        params[:project_id] = options[:project_id] unless options[:project_id].nil?
+        params[:dataset] = options[:dataset] unless options[:dataset].nil?
+        params[:table] = options[:table] unless options[:table].nil?
+
+        FastlyCTL::Fetcher.api_request(:put, "/service/#{id}/version/#{version}/logging/bigquery/#{options[:name]}", body: params)
+        puts "BigQuery logging provider update in service id #{id} on version #{version}"
+    end
+
+    def self.list(options)
+        id = options[:service]
+        version = FastlyCTL::Fetcher.get_writable_version(id) unless options[:version]
+        version ||= options[:version]
+
+        puts "Listing all BigQuery configurations for service #{id} version #{version}"
+
+        configs = FastlyCTL::Fetcher.api_request(:get, "/service/#{id}/version/#{version}/logging/bigquery")
+        print_configs(configs) 
+    end
+
+    def self.show(options)
+        required_opts = ["name"]
+        ensure_opts(required_opts,options)
+        id  = options[:service]
+        version = FastlyCTL::Fetcher.get_writable_version(id) unless options[:version]
+        version ||= options[:version]
+
+        resp = FastlyCTL::Fetcher.api_request(:get, "/service/#{id}/version/#{version}/logging/bigquery/#{options[:name]}")
+        puts JSON.pretty_generate(resp)
+    end
+
+    def self.delete(options)
+        required_opts = ["version","name"]
+        ensure_opts(required_opts,options)
+
+        id  = options[:service]
+        version = FastlyCTL::Fetcher.get_writable_version(id) unless options[:version]
+        version ||= options[:version]
+
+        resp = FastlyCTL::Fetcher.api_request(:delete, "/service/#{id}/version/#{version}/logging/bigquery/#{options[:name]}")
+        puts JSON.pretty_generate(resp)
+    end
+
+end

data/lib/fastlyctl/commands/logging.rb

@@ -0,0 +1,72 @@
+require "fastlyctl/commands/logging/bigquery"
+
+module FastlyCTL
+    class LoggingSubCmd < Thor 
+      namespace :logging
+
+      # bit of a monkey patch to fix --help output
+      def self.banner(command, namespace = nil, subcommand = false)
+        "#{basename} logging #{command.usage}"
+      end
+
+      desc "bigquery <action>", "Setup BigQuery As a logging provider, available actions are create, update, delete, list and show"
+      method_option :service, :aliases => ["--s","--service"], :banner => "Service ID to use", :required => true 
+      method_option :version, :aliases => ["--v", "--version"], :banner => "Version of the service to use"
+      method_option :name, :aliases => ["--n", "--name"], :banner => "Current name of the logging configuration"
+      method_option :new_name, :aliases => ["--nn","--new-name"], :banner => "Used for the update method to rename a configuration"
+      method_option :format_file,  :aliases => ["--ff","--format-file"], :banner => "File containing the JSON Representation of the logline, must match BigQuery schema"
+      method_option :format_version, :aliases => ["--fv","--format-version"], :banner => "Version of customer format, either 1 or 2, defaults to 2"
+      method_option :user, :aliases => ["--u","--user"], :banner => "Google Cloud Service Account Email"
+      method_option :secret_key_file, :aliases => ["--scf", "--secret-key-file"],:banner => "File that contains the Google Cloud Account secret key"
+      method_option :project_id, :aliases => ["--p","--project-id"], :banner => "Google Cloud Project ID"
+      method_option :dataset, :aliases => ["--d","--dataset"], :banner => "BigQuery Dataset"
+      method_option :table, :aliases => ["--t","--table"], :banner => "BigQuery Table"
+      method_option :template_suffix, :aliases => ["--ts","--template-suffix"], :banner => "Optional table name suffix"
+      method_option :placement, :aliases => ["--pl","--placement"], :banner => "Placement of the logging  call, can be none or waf_debug.  Not required and no default"
+      method_option :response_condition, :aliases => ["--r","--response-condition"], :banner => "When to execute, if empty it is always"
+
+      def bigquery(action)
+        case action 
+        when "create"
+          BigQuery.create(options)
+        when "list"
+          BigQuery.list(options)
+        when "update"
+          BigQuery.update(options)
+        when "show"
+          BigQuery.show(options)
+        when "delete"
+          BigQuery.delete(options)  
+        else
+          abort "Sorry, invalid action #{action} supplied, only create, update, delete and show are valid."
+        end
+
+      end
+
+      # Placeholder for future S3 work 
+      # desc "s3 <action>", "Setup S3  as a logging provider"
+      # method_option :format, :required => true
+      # method_option :keyfile, :required => true
+      # method_option :email , :required => true
+
+      # def s3(action)
+      #   puts "S3: #{action}"
+      # end
+
+      desc "status", "Check the last output of the logging status"
+      method_option :service, :aliases => ["--s","--service"], :banner => "Service ID to use", :required => true 
+
+      def status
+        id = options[:service]
+        resp = FastlyCTL::Fetcher.api_request(:get, "/service/#{id}/logging_status")      
+        say(JSON.pretty_generate(resp))
+      end
+
+    end
+
+    class CLI < Thor
+      desc "logging SUBCOMMAND ...ARGS", "Interface with Fastly Logging"
+      subcommand "logging", LoggingSubCmd
+    end
+
+end

data/lib/fastlyctl/version.rb

@@ -1,3 +1,3 @@
 module FastlyCTL
-  VERSION = "1.0.9"
+  VERSION = "1.0.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlyctl
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.11
 platform: ruby
 authors:
 - Stephen Basile
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2019-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -103,6 +103,8 @@ files:
 - lib/fastlyctl/commands/diff.rb
 - lib/fastlyctl/commands/domain.rb
 - lib/fastlyctl/commands/download.rb
+- lib/fastlyctl/commands/logging.rb
+- lib/fastlyctl/commands/logging/bigquery.rb
 - lib/fastlyctl/commands/login.rb
 - lib/fastlyctl/commands/open.rb
 - lib/fastlyctl/commands/purge_all.rb