MuranoCLI 3.2.0.beta.1 → 3.2.0.beta.5

data/spec/fixtures/exchange_element/swagger-mur-6407__20k.yaml

@@ -0,0 +1,588 @@
+swagger: "2.0"
+
+################################################################################
+#                           Service Metadata                                   #
+################################################################################
+info:
+  version: "1.0"
+  title: Transformer
+  description: |
+    This service is for Transforming SignalData.
+  contact:
+    name: Exosite Exosite Exosite Exosite
+    email: exosite@exosite.com
+
+################################################################################
+#                            API Information                                   #
+################################################################################
+
+# A hostname with a valid, signed, and active TSL certificate is required.
+host: transformer-dev.hosted.exosite.io
+basePath: /api/v1
+schemes:
+  - https
+consumes:
+  - application/json
+produces:
+  - application/json
+
+################################################################################
+#                          Solution lifecycle Events                           #
+################################################################################
+# Following Operation should generally be restricted with "x-exosite-restricted: true"
+x-exosite-init: createSolution # Triggered by Murano when this service is enabled in a solution
+x-exosite-info: getSolution # Triggered by Murano to retrieve custom information about the service solution namespace
+x-exosite-update: updateSolution # Triggered by Murano when the solution service configuration is updated
+x-exosite-gc: delSolution # Triggered by Murano when the service is removed from a solution or if the solution is deleted
+
+################################################################################
+#                      Service Configuration Parameters                        #
+################################################################################
+x-exosite-config-parameters:
+  - name: maximumTTL
+    type: number
+    description: Maximum number of times a message can propagate through
+    required: true # Indicates this parameter is required during configuration
+  - name: authToken
+    type: string
+    description: This is a placeholder for a potential future feature.
+    required: true # the only option that works is true…
+  - name: eventURI
+    type: string
+    description: This is a placeholder for a potential future feature.
+    required: true # the only option that works is true…
+
+################################################################################
+#                                Operations                                    #
+################################################################################
+paths:
+  /:
+    get:
+      description: Alive check
+      operationId: alive
+      x-exosite-restricted: true # Indicate that this operation cannot be called from user scripts
+      responses:
+        "200":
+          description: Solution successfully created
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+
+  # Administration endpoint used by Murano solution lifecycle events
+  # Those operation uses the "x-exosite-restricted" to prevent the user to access them directly
+  /{solution_id}:
+    parameters:
+      - name: solution_id
+        x-exosite-from: solution_id # Indicate this value is injected from the user solution_id
+        x-exosite-restricted: true # Indicate the user cannot provide this parameter
+        type: string
+        in: path
+        description: The solution identifier. Set automatically.
+        required: true
+    post:
+      description: Used by Murano to create a solution namespace.
+      operationId: createSolution
+      x-exosite-restricted: true # Indicate that this operation cannot be called from user scripts
+      parameters:
+        - name: settings
+          in: body
+          description: The service settings for a solution.
+          required: true
+          schema:
+            $ref: "#/definitions/SolutionSettings"
+      responses:
+        "200":
+          description: Solution successfully created
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    get:
+      description: Used by Murano to get the solution settings.
+      operationId: getSolution
+      responses:
+        "200":
+          description: Solution settings
+          schema:
+            $ref: "#/definitions/SolutionInfo"
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    put:
+      description: Used by Murano to update the solution settings.
+      operationId: updateSolution
+      x-exosite-restricted: true
+      parameters:
+        - name: settings
+          in: body
+          description: The service settings for a solution.
+          required: true
+          schema:
+            $ref: "#/definitions/SolutionSettings"
+      responses:
+        "205":
+          description: Settings updated
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    delete:
+      description: Used by Murano to remove a solution and clean its namespace.
+      operationId: delSolution
+      x-exosite-restricted: true
+      responses:
+        "205":
+          description: Solution successfully removed.
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+
+  # Service operations available from scripting
+  /{solution_id}/transform:
+    parameters:
+      - name: solution_id
+        type: string
+        in: path
+        description: The solution identifier. Set automatically by Murano at service call.
+        x-exosite-from: solution_id # Indicate this value is injected from the user solution_id
+        x-exosite-restricted: true # Indicate the user cannot provide this parameter
+        required: true
+    post:
+      description: Create Transform
+      operationId: create
+      x-exosite-example: |
+        local res = Transformer.create{
+            subscribe = {"topic.name"},
+            tags = {"asset-42"},
+            select = "value * 24"
+        }
+        -- res.id is the UUID assigned to the new transform.
+
+      parameters:
+        - name: body
+          in: body
+          description: The Transform to create.
+          required: true
+          schema:
+            $ref: "#/definitions/Transformation"
+      responses:
+        "200":
+          description: Transform successfully saved
+          schema:
+            type: object
+            description: Transformation Id Object
+            properties:
+              id:
+                description: Transform ID
+                type: string
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    get:
+      description: Retrieve Transform from the solution namespace.
+      operationId: list
+      x-exosite-example: |
+
+        -- list Transforms with all of a specified tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.list({all={tag1, tag2}})
+
+        --------------------------------------------------
+
+        -- list Transforms with any of a specified tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.list({any={tag1, tag2}})
+
+        --------------------------------------------------
+
+        -- list Transforms with any of a specified tag and all of another tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.list({any={tag2, tag3}, all={tag1, tag4}})
+        -- That is, (tag1 && tag4 && (tag2 || tag3))
+
+      parameters:
+        - name: tags_all
+          in: query
+          description: If present, only return Transforms with all of the listed tags
+          type: array
+          items:
+            type: string
+        - name: tags_any
+          in: query
+          description: If present, only return Transforms with any of the listed tags
+          type: array
+          items:
+            type: string
+        - name: limit
+          in: query
+          description: Maximum results to return
+          type: integer
+        - name: offset
+          in: query
+          description: Offset into results
+          type: integer
+      responses:
+        "200":
+          description: Successfully returned the Transforms for this solution
+          schema:
+            $ref: "#/definitions/TransformationArray"
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+
+    delete:
+      description: Delete multiple Transforms by matching tags
+      operationId: deleteByTags
+      x-exosite-example: |
+
+        -- delete Transform with all of a specified tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.deleteByTags({all={tag1, tag2}})
+
+        --------------------------------------------------
+
+        -- delete Transform with any of a specified tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.deleteByTags({any={tag1, tag2}})
+
+        --------------------------------------------------
+
+        -- delete Transform with any of a specified tag and all of another tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.deleteByTags({any={tag2, tag3}, all={tag1, tag4}})
+        -- That is, (tag1 && tag4 && (tag2 || tag3))
+      parameters:
+        - name: all
+          in: query
+          description: If present, only delete Transforms with all listed tags
+          required: false
+          type: array
+          items:
+            type: string
+        - name: any
+          in: query
+          description: Delete Transforms with any listed tags
+          required: true
+          type: array
+          items:
+            type: string
+      responses:
+        "205":
+          description: Deleted
+        default:
+          description: error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+
+
+  /{solution_id}/transform/{transform_id}:
+    parameters:
+      - name: solution_id
+        type: string
+        in: path
+        description: The solution identifier. Set automatically by Murano at service call.
+        x-exosite-from: solution_id # Indicate this value is injected from the user solution_id
+        x-exosite-restricted: true # Indicate the user cannot provide this parameter
+        required: true
+      - name: transform_id
+        type: string
+        in: path
+        description: The Transform id
+        required: true
+    get:
+      description: Retrieve a Transform
+      operationId: get
+      x-exosite-example: >
+          --       l
+      responses:
+        "200":
+          description: Successfully returned the Transform
+          schema:
+            $ref: "#/definitions/Transformation"
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    put:
+      description: Update a Transform
+      operationId: update
+      parameters:
+        - name: body
+          in: body
+          description: The updated Transform parameters.
+          required: true
+          schema:
+            $ref: "#/definitions/Transformation"
+      responses:
+        "205":
+          description: Transform updated
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    delete:
+      description: Delete a Transform
+      operationId: delete
+      responses:
+        "205":
+          description: Transform successfully removed.
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+
+  /{solution_id}/process:
+    parameters:
+      - name: solution_id
+        type: string
+        in: path
+        description: The solution identifier. Set automatically by Murano at service call.
+        x-exosite-from: solution_id # Indicate this value is injected from the user solution_id
+        x-exosite-restricted: true # Indicate the user cannot provide this parameter
+        required: true
+    post:
+      description: |
+          Process an array of SignalData, likely into more of them
+
+          The `generated` property in the SignalData is used to find subscribers.
+          If there are no subscribed Transforms, then no new SignalData will be
+          produced.
+
+          Every found subscribed Transform has its JSONata executed on the
+          SignalData.  If the result is defined, a new SignalData is generated by
+          the Transform’s `publishes` property.  If the result is undefined, a new
+          SignalData is published from the `__Dropped`.
+
+          Generally, only debugging interfaces should subscribe to the `__Dropped`.
+      operationId: process
+      x-exosite-example: >
+        --#EVENT Scripts eventloop
+        -- Because private-exchange cannot generate events, we have to fake it.
+        -- For any internal object, if ttl > max-ttl then it is just dropped.
+        -- max-ttl is settable as service config
+
+        local res = Transformer.process{array=data.metricsArray}
+        if #res > 0 then
+          Scripts.trigger{event='Scripts.eventloop', mode='async', data={metricsArray=res}}
+          Scripts.trigger{event='Scripts.tsdbSubs', mode='async', data={metricsArray=res}}
+          -- Add triggers to subscribe other services. (RuleEngine, UserNotifier, ect)
+
+        end
+      parameters:
+        - name: body
+          in: body
+          description: Data to process
+          required: true
+          schema:
+            $ref: "#/definitions/SignalDataObjectArray"
+      responses:
+        "200":
+          description: Data successfully
+          schema:
+            $ref: "#/definitions/SignalDataArray"
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+
+################################################################################
+#                                 Definitions                                  #
+################################################################################
+definitions:
+  SignalData:
+    type: object
+    description: A single instance of a piece of data inside a signal.
+    properties:
+      tags:
+        type: object
+        description: |
+          Tag-Value pairs to help ID the data. Used to tie the data back to an
+          Asset or Device or other things.
+        additionalProperties:
+          type: string
+          description: Value for a tag
+          minLength: 1
+      ts:
+        type: integer
+        description: Unix timestamp in microseconds of when the data originated
+      gts:
+        type: integer
+        description: Unix timestamp in microseconds of when this SignalData was generated
+      value:
+        type: [string, integer, object]
+        description: The value for this instance of data
+      origin:
+        type: string
+        description: The original Publishing ID
+        minLength: 1
+      generated:
+        type: string
+        description: The Publishing ID that created this SignalData.
+        minLength: 1
+      ttl:
+        type: integer
+        description: Value used to help prevent data from infinitely cycling
+    required:
+      - ts
+      - value
+      - origin
+      - generated
+
+  SignalDataArray:
+    type: array
+    description: Array of Signal Data
+    items:
+      $ref: '#/definitions/SignalData'
+
+  SignalDataObjectArray:
+      type: object
+      description: Workaround for Murano brokenness.
+      properties:
+          array:
+              $ref: '#/definitions/SignalDataArray'
+
+  Transformation:
+    type: object
+    description: Transformation definition
+    properties:
+      id:
+        type: string
+        readOnly: true
+        description: database assigned UUID for this Transformation
+      name:
+        type: string
+        description: User applied name to help identify
+      tags:
+        type: array
+        description: Array of tags to help identify this transformation
+        items:
+          type: string
+          description: Tag name
+          minLength: 1
+      subscribe:
+        type: array
+        description: Array of Publishing IDs to subscribe to
+        minItems: 1
+        items:
+          type: string
+          description: A Publishing ID to subscribe to.
+          minLength: 1
+      publishes:
+        type: string
+        description: |
+          Publishing ID to publish result to.  If not defined, the transformations
+          uuid prefixed with 'Transform-' will be used.
+        minLength: 1
+      select:
+        type: string
+        minLength: 1
+        description: |
+          JSONata expression to transform the input SignalData into the result
+          value on the output SignalData.
+
+          http://docs.jsonata.org
+
+          In addition to the built-in functions, Transformer adds.
+          - $sub(array)
+            Subtract all elements in an array from each other.
+          - $deltas(array)
+            Create a new array that is the difference between each element of the source array.
+          - $enumerate(value, enums)
+            Convert a number into a string via lookups.
+            The enumeration is an array of arrays.  The inner arrays having only two
+            elements.  The first is a number, the second is a string. The outer
+            array is sorted by the numbers.
+
+            FE: [[10, 'critical low'], [35, 'low'], [55, 'high'], [70, 'critical high']]
+
+            The input value is matched less than each pair. When that’s true, then
+            the string for that pair is returned.  If none of the values are
+            matched, the string of the last pair is returned.
+
+      additional_tags:
+        type: object
+        description: Any additional tags to add to the resulting SignalData
+        additionalProperties:
+          type: string
+          description: Value for a tag
+          minLength: 1
+      parameters:
+        type: object
+        description: |
+            Extra parameters for the JSONata expression that you want to keep seperated.
+            These will be in `$params`.
+      saving:
+        type: boolean
+        description: When true, the previous result is available in `$saved`
+      joining:
+        type: boolean
+        description: |
+          When true the previous SignalData for each subscribed topic will be
+          available in `$sources`
+    required:
+        - subscribe
+        - select
+    additionalProperties: false
+
+  TransformationArray:
+    type: array
+    description: Array of Transform definitions
+    items:
+      $ref: '#/definitions/Transformation'
+
+  SolutionSettings:
+    description: The service settings for a solution.
+    type: object
+    properties:
+      maximumTTL:
+        type: number
+        description: Maximum number of times a message can propagate through
+        minimum: 5
+      authToken:
+        type: string
+        description: This is a placeholder for a potential future feature.
+      eventURI:
+        type: string
+        description: This is a placeholder for a potential future feature.
+    required: [maximumTTL]
+
+  SolutionInfo:
+    description: The service settings & information for a solution.
+    type: object
+    properties:
+      maximumTTL:
+        type: number
+        description: Maximum number of times a message can propagate through
+        minimum: 5
+      authToken:
+        type: string
+        description: This is a placeholder for a potential future feature.
+      eventURI:
+        type: string
+        description: This is a placeholder for a potential future feature.
+      additionalInfo:
+        type: object
+        description: Some additional information from the service used for display purpose
+
+  ErrorResponse:
+    type: object
+    description: Error response
+    properties:
+      message:
+        type: string
+        description: Error message
+      name:
+        description: Error type
+        type: string
+

data/spec/variegated_TruthyFalsey_spec.rb

@@ -0,0 +1,29 @@
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# License: PROPRIETARY. See LICENSE.txt.
+# frozen_string_literal: true
+
+# vim:tw=0:ts=2:sw=2:et:ai
+# Unauthorized copying of this file is strictly prohibited.
+
+require 'MrMurano/variegated/TruthyFalsey'
+
+RSpec.describe 'variegated/TruthyFalsey' do
+  it %(knows what's true) do
+    tfy = TruthyFalsey.new('TruE')
+    expect(tfy.truthy?).to be(true)
+    expect(tfy.falsey?).to be(false)
+  end
+
+  it %(knows what's false) do
+    tfy = TruthyFalsey.new('No')
+    expect(tfy.truthy?).to be(false)
+    expect(tfy.falsey?).to be(true)
+  end
+
+  it %(doesn't know what it doesn't know) do
+    tfy = TruthyFalsey.new('FALS')
+    expect(tfy.truthy?).to be(false)
+    expect(tfy.falsey?).to be(false)
+  end
+end
+