chore: rename InvocableScripts to InvokableScripts (#103)

Author: bednar

CHANGELOG.md

@@ -1,9 +1,12 @@
 ## 2.5.0 [unreleased]
 
+### Breaking Changes
+1. [#103](https://github.com/influxdata/influxdb-client-ruby/pull/103): Rename `InvocableScripts` to `InvokableScripts`
+
 ## 2.4.0 [2022-04-19]
 
 ### Features
-1. [#101](https://github.com/influxdata/influxdb-client-ruby/pull/101): Add `InvocableScriptsApi` to create, update, list, delete and invoke scripts by seamless way
+1. [#101](https://github.com/influxdata/influxdb-client-ruby/pull/101): Add `InvokableScriptsApi` to create, update, list, delete and invoke scripts by seamless way
 
 ## 2.3.0 [2022-03-18]
 

bin/invocable-scripts.yml

@@ -1,26 +1,26 @@
 openapi: 3.0.0
 info:
-  title: InfluxData Invocable Scripts API
+  title: InfluxData Invokable Scripts API
   version: 0.1.0
   description: |
     Manage and execute scripts as API endpoints in InfluxDB.
 
-    An API Invocable Script assigns your custom Flux script to a new InfluxDB API endpoint for your organization.
-    Invocable scripts let you execute your script as an HTTP request to the endpoint.
+    An API Invokable Script assigns your custom Flux script to a new InfluxDB API endpoint for your organization.
+    Invokable scripts let you execute your script as an HTTP request to the endpoint.
 
-    Invocable scripts accept parameters. Add parameter references in your script as `params.myparameter`.
+    Invokable scripts accept parameters. Add parameter references in your script as `params.myparameter`.
     When you `invoke` your script, you send parameters as key-value pairs in the `params` object.
     InfluxDB executes your script with the key-value pairs as arguments and returns the result.
 
-    For more information and examples, see [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invocable-scripts).
+    For more information and examples, see [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/).
 servers:
   - url: /api/v2
 paths:
   /scripts:
     get:
       operationId: GetScripts
       tags:
-        - Invocable Scripts
+        - Invokable Scripts
       summary: List scripts
       parameters:
         - in: query
@@ -48,7 +48,7 @@ paths:
     post:
       operationId: PostScripts
       tags:
-        - Invocable Scripts
+        - Invokable Scripts
       summary: Create a script
       requestBody:
         description: The script to create.
@@ -71,9 +71,9 @@ paths:
     get:
       operationId: GetScriptsID
       tags:
-        - Invocable Scripts
+        - Invokable Scripts
       summary: Retrieve a script
-      description: Uses script ID to retrieve details of an invocable script.
+      description: Uses script ID to retrieve details of an invokable script.
       parameters:
         - in: path
           name: scriptID
@@ -94,10 +94,10 @@ paths:
     patch:
       operationId: PatchScriptsID
       tags:
-        - Invocable Scripts
+        - Invokable Scripts
       summary: Update a script
       description: |
-        Updates properties (`name`, `description`, and `script`) of an invocable script.
+        Updates properties (`name`, `description`, and `script`) of an invokable script.
       requestBody:
         description: Script update to apply
         required: true
@@ -125,7 +125,7 @@ paths:
     delete:
       operationId: DeleteScriptsID
       tags:
-        - Invocable Scripts
+        - Invokable Scripts
       summary: Delete a script
       description: Deletes a script and all associated records.
       parameters:
@@ -145,7 +145,7 @@ paths:
     post:
       operationId: PostScriptsIDInvoke
       tags:
-        - Invocable Scripts
+        - Invokable Scripts
       summary: Invoke a script
       description: Invokes a script and substitutes `params` keys referenced in the script with `params` key-values sent in the request body.
       parameters:
@@ -286,6 +286,7 @@ components:
       properties:
         params:
           type: object
+          additionalProperties: true
     ScriptLanguage:
       type: string
       enum:

examples/README.md

@@ -11,4 +11,4 @@
 - [create_new_bucket.rb](create_new_bucket.rb) - How to create Buckets
 
 ## Others
-- [invocable_scripts.rb](invocable_scripts.rb) - How to use Invocable scripts Cloud API to create custom endpoints that query data
+- [invokable_scripts.rb](invokable_scripts.rb) - How to use Invokable scripts Cloud API to create custom endpoints that query data

examples/invocable_scripts.rb examples/invokable_scripts.rbexamples/invocable_scripts.rb renamed to examples/invokable_scripts.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'influxdb-client'
 
-# warning: Invocable Scripts are supported only in InfluxDB Cloud, currently there is no support in InfluxDB OSS.
+# warning: Invokable Scripts are supported only in InfluxDB Cloud, currently there is no support in InfluxDB OSS.
 
 url = 'https://us-west-2-1.aws.cloud2.influxdata.com'
 token = '...'
@@ -22,10 +22,10 @@
                          .add_field('temperature', 24.3)
 client.create_write_api.write(data: [point1, point2])
 
-scripts_api = client.create_invocable_scripts_api
+scripts_api = client.create_invokable_scripts_api
 
 #
-# Create Invocable Script
+# Create Invokable Script
 #
 puts "------- Create -------\n"
 script_query = 'from(bucket: params.bucket_name) |> range(start: -30d) |> limit(n:2)'
@@ -38,7 +38,7 @@
 puts created_script.inspect
 
 #
-# Update Invocable Script
+# Update Invokable Script
 #
 puts "------- Update -------\n"
 update_request = InfluxDB2::ScriptUpdateRequest.new(description: 'my updated description')

lib/influxdb-client.rb

@@ -27,7 +27,7 @@
 require 'influxdb2/client/delete_api'
 require 'influxdb2/client/health_api'
 require 'influxdb2/client/ping_api'
-require 'influxdb2/client/invocable_scripts_api'
+require 'influxdb2/client/invokable_scripts_api'
 require 'influxdb2/client/point'
 require 'influxdb2/client/flux_table'
 require 'influxdb2/client/write_retry'

lib/influxdb2/client/client.rb

@@ -85,11 +85,11 @@ def create_delete_api
       DeleteApi.new(options: @options)
     end
 
-    # Create an InvocableScripts API instance.
+    # Create an InvokableScripts API instance.
     #
-    # @return [InvocableScriptsApi] New instance of InvocableScriptsApi.
-    def create_invocable_scripts_api
-      InvocableScriptsApi.new(options: @options)
+    # @return [InvokableScriptsApi] New instance of InvokableScriptsApi.
+    def create_invokable_scripts_api
+      InvokableScriptsApi.new(options: @options)
     end
 
     # Get the health of an instance.

lib/influxdb2/client/flux_csv_parser.rb

@@ -46,7 +46,7 @@ def initialize(message)
   class FluxResponseMode
     # full information about types, default values and groups
     FULL = 'full'.freeze
-    # useful for Invocable scripts
+    # useful for Invokable scripts
     ONLY_NAMES = 'only_names'.freeze
   end
 

…nfluxdb2/client/invocable_scripts_api.rb …nfluxdb2/client/invokable_scripts_api.rblib/influxdb2/client/invocable_scripts_api.rb renamed to lib/influxdb2/client/invokable_scripts_api.rb lib/influxdb2/client/invocable_scripts_api.rb renamed to lib/influxdb2/client/invokable_scripts_api.rb

@@ -25,7 +25,7 @@ module InfluxDB2
   #
   # API invokable scripts let you assign scripts to API endpoints and then execute them as standard REST operations
   # in InfluxDB Cloud.
-  class InvocableScriptsApi < DefaultApi
+  class InvokableScriptsApi < DefaultApi
     # @param [Hash] options The options to be used by the client.
     def initialize(options:)
       super(options: options)

lib/influxdb2/client/models/script_invocation_params.rb

@@ -53,7 +53,9 @@ def initialize(attributes = {})
       }
 
       if attributes.key?(:'params')
-        self.params = attributes[:'params']
+        if (value = attributes[:'params']).is_a?(Hash)
+          self.params = value
+        end
       end
     end
 

…t/influxdb/invocable_scripts_api_test.rb …t/influxdb/invokable_scripts_api_test.rbtest/influxdb/invocable_scripts_api_test.rb renamed to test/influxdb/invokable_scripts_api_test.rb test/influxdb/invocable_scripts_api_test.rb renamed to test/influxdb/invokable_scripts_api_test.rb

@@ -20,7 +20,7 @@
 
 require 'test_helper'
 
-class InvocableScriptsApiTest < MiniTest::Test
+class InvokableScriptsApiTest < MiniTest::Test
   def setup
     WebMock.disable_net_connect!
     @client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
@@ -35,7 +35,7 @@ def teardown
   end
 
   def test_create_instance
-    invocable_scripts_api = @client.create_invocable_scripts_api
-    refute_nil invocable_scripts_api
+    invokable_scripts_api = @client.create_invokable_scripts_api
+    refute_nil invokable_scripts_api
   end
 end