stinger-ipc 0.0.9__tar.gz → 0.0.25__tar.gz

{stinger_ipc-0.0.9/stinger_ipc.egg-info → stinger_ipc-0.0.25}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: stinger-ipc
-Version: 0.0.9
+Version: 0.0.25
 Summary: Tools to create code to do IPC over MQTT
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: jacobs-jinja-too>=0.2.4
+Requires-Dist: jacobs-jinja-too>=0.2.5
+Requires-Dist: jacobs-json-schema>=0.4.2
 Requires-Dist: packaging>=25.0
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pyyaml>=6.0.2

{stinger_ipc-0.0.9 → stinger_ipc-0.0.25}/pyproject.toml

@@ -1,11 +1,12 @@
 [project]
 name = "stinger-ipc"
-version = "0.0.9"
+version = "0.0.25"
 description = "Tools to create code to do IPC over MQTT"
 readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
-    "jacobs-jinja-too>=0.2.4",
+    "jacobs-jinja-too>=0.2.5",
+    "jacobs-json-schema>=0.4.2",
     "packaging>=25.0",
     "pydantic>=2.11.7",
     "pyyaml>=6.0.2",
@@ -38,7 +39,8 @@ packages = ["stingeripc", "stingeripc.tools"]
 
 [tool.setuptools.package-data]
 stingeripc = [
-    "templates/**/*.jinja2"
+    "templates/**/*.jinja2",
+    "schema/schema.yaml",
 ]
 
 [project.scripts]

{stinger_ipc-0.0.9 → stinger_ipc-0.0.25/stinger_ipc.egg-info}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: stinger-ipc
-Version: 0.0.9
+Version: 0.0.25
 Summary: Tools to create code to do IPC over MQTT
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: jacobs-jinja-too>=0.2.4
+Requires-Dist: jacobs-jinja-too>=0.2.5
+Requires-Dist: jacobs-json-schema>=0.4.2
 Requires-Dist: packaging>=25.0
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pyyaml>=6.0.2

{stinger_ipc-0.0.9 → stinger_ipc-0.0.25}/stinger_ipc.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ stingeripc/exceptions.py
 stingeripc/interface.py
 stingeripc/lang_symb.py
 stingeripc/topic.py
+stingeripc/schema/schema.yaml
 stingeripc/templates/cpp/CMakeLists.txt.jinja2
 stingeripc/templates/cpp/examples/client_main.cpp.jinja2
 stingeripc/templates/cpp/examples/server_main.cpp.jinja2
@@ -27,9 +28,14 @@ stingeripc/templates/cpp/include/property_structs.hpp.jinja2
 stingeripc/templates/cpp/include/return_types.hpp.jinja2
 stingeripc/templates/cpp/include/server.hpp.jinja2
 stingeripc/templates/cpp/include/structs.hpp.jinja2
+stingeripc/templates/cpp/partials/args.jinja2
+stingeripc/templates/cpp/partials/deserialize.jinja2
+stingeripc/templates/cpp/partials/serialize.jinja2
 stingeripc/templates/cpp/src/broker.cpp.jinja2
 stingeripc/templates/cpp/src/client.cpp.jinja2
+stingeripc/templates/cpp/src/property_structs.cpp.jinja2
 stingeripc/templates/cpp/src/server.cpp.jinja2
+stingeripc/templates/cpp/src/structs.cpp.jinja2
 stingeripc/templates/html/app.js.jinja2
 stingeripc/templates/html/index.html.jinja2
 stingeripc/templates/html/styles.css.jinja2
@@ -47,7 +53,6 @@ stingeripc/templates/rust/client/examples/client.rs.jinja2
 stingeripc/templates/rust/client/src/lib.rs.jinja2
 stingeripc/templates/rust/payloads/Cargo.toml.jinja2
 stingeripc/templates/rust/payloads/examples/pub_and_recv.rs.jinja2
-stingeripc/templates/rust/payloads/src/handler.rs.jinja2
 stingeripc/templates/rust/payloads/src/lib.rs.jinja2
 stingeripc/templates/rust/payloads/src/payloads.rs.jinja2
 stingeripc/templates/rust/server/Cargo.toml.jinja2
@@ -55,6 +60,7 @@ stingeripc/templates/rust/server/examples/server.rs.jinja2
 stingeripc/templates/rust/server/src/lib.rs.jinja2
 stingeripc/tools/__init__.py
 stingeripc/tools/cli.py
+stingeripc/tools/cpp_generator.py
 stingeripc/tools/markdown_generator.py
 stingeripc/tools/python_generator.py
 stingeripc/tools/rust_generator.py

{stinger_ipc-0.0.9 → stinger_ipc-0.0.25}/stinger_ipc.egg-info/requires.txt

@@ -1,4 +1,5 @@
-jacobs-jinja-too>=0.2.4
+jacobs-jinja-too>=0.2.5
+jacobs-json-schema>=0.4.2
 packaging>=25.0
 pydantic>=2.11.7
 pyyaml>=6.0.2

{stinger_ipc-0.0.9 → stinger_ipc-0.0.25}/stingeripc/asyncapi.py

@@ -571,6 +571,9 @@ class StingerToAsyncApi:
                     add_arg(arg_spec)
                     resp_msg_schema.add_value_dependency(arg_spec.name, "result", 0)
             elif method_spec.return_value is not None:
+                assert isinstance(
+                    method_spec.return_value, Arg
+                ), "Method return value must be a primitive or enum"
                 add_arg(method_spec.return_value)
                 resp_msg_schema.add_value_dependency(
                     method_spec.return_value_name, "result", 0

{stinger_ipc-0.0.9 → stinger_ipc-0.0.25}/stingeripc/components.py

@@ -79,6 +79,10 @@ class Arg:
     def rust_local_type(self) -> str:
         return self.rust_type
 
+    @property
+    def cpp_type(self) -> str:
+        return stringmanip.upper_camel_case(self.name)
+
     @classmethod
     def new_arg_from_stinger(
         cls, arg_spec: YamlArg, stinger_spec: StingerSpec | None = None
@@ -107,32 +111,40 @@ class Arg:
         if arg_spec["type"] == "enum":
             if "enumName" not in arg_spec:
                 raise InvalidStingerStructure(f"Enum args need a 'enumName'")
+            if not isinstance(arg_spec["enumName"], str):
+                raise InvalidStingerStructure("'enumName' in arg structure must be a string")
             if arg_spec["enumName"] not in stinger_spec.enums:
                 raise InvalidStingerStructure(
                     f"Enum arg '{arg_spec['enumName']}' was not found in the list of stinger spec enums"
                 )
-            arg = ArgEnum(
+            enum_arg = ArgEnum(
                 arg_spec["name"], stinger_spec.get_interface_enum(arg_spec["enumName"])
             )
             if opt := arg_spec.get("optional", False):
-                arg.optional = opt
-            arg.try_set_description_from_spec(arg_spec)
-            return arg
+                if not isinstance(opt, bool):
+                    raise InvalidStingerStructure("'optional' in arg structure must be a boolean")
+                enum_arg.optional = opt
+            enum_arg.try_set_description_from_spec(arg_spec)
+            return enum_arg
 
         if arg_spec["type"] == "struct":
             if "structName" not in arg_spec:
                 raise InvalidStingerStructure("Struct args need a 'structName'")
+            if not isinstance(arg_spec["structName"], str):
+                raise InvalidStingerStructure("'structName' in arg structure must be a string")
             if arg_spec["structName"] not in stinger_spec.structs:
                 raise InvalidStingerStructure(
                     f"Struct arg '{arg_spec["structName"]}' was not found in the list of stinger spec structs"
                 )
-            arg = ArgStruct(
+            st_arg = ArgStruct(
                 arg_spec["name"], stinger_spec.structs[arg_spec["structName"]]
             )
             if opt := arg_spec.get("optional", False):
-                arg.optional = opt
-            arg.try_set_description_from_spec(arg_spec)
-            return arg
+                if not isinstance(opt, bool):
+                    raise InvalidStingerStructure("'optional' in arg structure must be a boolean")
+                st_arg.optional = opt
+            st_arg.try_set_description_from_spec(arg_spec)
+            return st_arg
         raise RuntimeError(f"unknown arg type: {arg_spec['type']}")
 
     @abstractmethod
@@ -240,6 +252,8 @@ class ArgPrimitive(Arg):
     @property
     def cpp_temp_type(self) -> str:
         if self._arg_type == ArgPrimitiveType.STRING:
+            if self.optional:
+                return "boost::optional<std::string>"
             return "std::string"
         else:
             return self.cpp_type
@@ -288,6 +302,10 @@ class ArgPrimitive(Arg):
             raise InvalidStingerStructure("No 'type' in arg structure")
         if "name" not in arg_spec:
             raise InvalidStingerStructure("No 'name' in arg structure")
+        if not isinstance(arg_spec["type"], str):
+            raise InvalidStingerStructure("'type' in arg structure must be a string")
+        if not isinstance(arg_spec["name"], str):
+            raise InvalidStingerStructure("'name' in arg structure must be a string")
 
         arg_primitive_type = ArgPrimitiveType.from_string(arg_spec["type"])
         arg: ArgPrimitive = cls(name=arg_spec["name"], arg_type=arg_primitive_type)
@@ -333,6 +351,10 @@ class ArgStruct(Arg):
     def markdown_type(self) -> str:
         return f"[Struct {self._interface_struct.class_name}](#enum-{self._interface_struct.class_name})"
 
+    @property
+    def cpp_rapidjson_type(self) -> str:
+        return "Object"
+
     def get_random_example_value(self, lang="python", seed: int = 2) -> str | None:
         example_list: dict[str, str] = {
             a.name: str(a.get_random_example_value(lang, seed=seed))
@@ -688,6 +710,8 @@ class Property(InterfaceComponent):
             prop_obj.add_arg(new_arg)
 
         if r_o := prop_spec.get("readOnly", False):
+            if not isinstance(r_o, bool):
+                raise InvalidStingerStructure("'readOnly' in property structure must be a boolean")
             prop_obj._read_only = r_o
 
         prop_obj.try_set_documentation_from_spec(prop_spec)
@@ -749,6 +773,11 @@ class InterfaceEnum:
     @property
     def values(self):
         return self._values
+    
+    def value_description(self, index: int) -> str | None:
+        if index < 0 or index >= len(self._value_descriptions):
+            return None
+        return self._value_descriptions[index]
 
     @classmethod
     def new_enum_from_stinger(cls, name, enum_spec: YamlIfaceEnum) -> InterfaceEnum:
@@ -756,7 +785,12 @@ class InterfaceEnum:
         for enum_obj in enum_spec.get("values", []):
             assert isinstance(enum_obj, dict), f"Enum values must be a dicts."
             if "name" in enum_obj and isinstance(enum_obj["name"], str):
-                ie.add_value(enum_obj["name"], enum_obj.get("description", None))
+                value_description = enum_obj.get("description", None)
+                if value_description is not None and not isinstance(value_description, str):
+                    raise InvalidStingerStructure(
+                        f"InterfaceEnum '{name}' item descriptions must be strings."
+                    )
+                ie.add_value(enum_obj["name"], description=value_description)
             else:
                 raise InvalidStingerStructure(
                     f"InterfaceEnum '{name}' items must have string names."
@@ -834,9 +868,14 @@ class InterfaceStruct:
     ) -> InterfaceStruct:
         istruct = cls(name)
         for memb in spec.get("members", []):
+            if not isinstance(memb, dict):
+                raise InvalidStingerStructure("Struct members must be dicts")
             arg = Arg.new_arg_from_stinger(memb, stinger_spec=stinger_spec)
             istruct.add_member(arg)
-        istruct._description = spec.get("description", None)
+        description = spec.get("description", None)
+        if description is not None and not isinstance(description, str):
+            raise InvalidStingerStructure("Struct description must be a string")
+        istruct._description = description
         return istruct
 
     def __str__(self) -> str:
@@ -948,6 +987,18 @@ class StingerSpec:
         }
         return (self._topic_creator.interface_info_topic(), info)
 
+    @property
+    def summary(self) -> str:
+        return self._summary or ""
+    
+    @property
+    def title(self) -> str:
+        return self._title or self._name or ""
+    
+    @property
+    def documentation(self) -> str:
+        return self._documentation or ""
+
     def add_broker(self, broker: Broker):
         assert broker is not None
         self._brokers[broker.name] = broker

stinger_ipc-0.0.25/stingeripc/schema/schema.yaml

@@ -0,0 +1,240 @@
+$id: "https://stingeripc.peargrove.com/stingeripc.schema.yaml"
+$schema: "http://json-schema.org/draft-07/schema#"
+description: |
+  This schema is used to validate StingerIPC stinger files.
+type: object
+
+properties:
+
+  stingeripc:
+    type: object
+    properties:
+      version:
+        type: string
+        const: "0.0.7"
+    required:
+      - version
+
+  interface:
+    type: object
+    parameters:
+      name:
+        type: string
+        pattern: "[a-zA-Z0-9_]+"
+        maxLength: 32
+        description: "A short token that will be used to create class names, folder names, filenames, etc."
+      title:
+        type: string
+        maxLength: 64
+        description: "A few words that are the title for the API.  Used at the top of documentation, etc.  The interface name is used if not provided."
+      summary:
+        type: string
+        description: "A one sentence description of the service."
+        maxLength: 128
+      version:
+        type: string
+        maxLength: 32
+      documentation:
+        $ref: "#/$defs/documentation"
+    required:
+      - name
+      - version
+  
+  brokers:
+    type: object
+    additionalProperties:
+      type: object
+      properties:
+        host:
+          type: string
+        port:
+          type: integer
+        protocol:
+          type: string
+          enum:
+            - tcp
+            - websockets
+          default: tcp
+        secure:
+          type: boolean
+          default: false
+        description:
+          type: string
+
+      dependentRequired:
+        host: ["port"]
+
+  enums:
+    type: object
+    additionalProperties:
+      type: object
+      properties:
+        values:
+          type: array
+          uniqueItems: true
+          items:
+            type: object
+            properties:
+              name:
+                type: string
+            required:
+              - name
+        documentation:
+          $ref: "#/$defs/documentation"
+        required:
+          - values
+
+  structures:
+    type: object
+    additionalProperties:
+      type: object
+      properties:
+        members:
+          $ref: "#/$defs/payload"
+        documentation:
+          $ref: "#/$defs/documentation"
+      required:
+        - members
+
+  signals:
+    type: object
+    additionalProperties:
+      $ref: "#/$defs/signal"
+
+  properties:
+    type: object
+    additionalProperties:
+      $ref: "#/$defs/property"
+
+  methods:
+    type: object
+    additionalProperties:
+      $ref: "#/$defs/method"
+
+required:
+  - stingeripc
+  - interface
+
+$defs:
+
+  documentation:
+    type: string
+
+  payload:
+    type: array
+    uniqueItems: true
+    items:
+      $ref: "#/$defs/arg"
+
+  genericArg:
+    type: object
+    required:
+      - "type"
+      - "name"
+    properties:
+      name:
+        type: string
+      optional:
+        type: boolean
+        default: false
+      description:
+        type: string
+      schema:
+        type: object
+        description: A JSON schema which further constrains the value.
+
+  primitiveArg:
+    properties:
+      type:
+        type: string
+        enum:
+          - float
+          - string
+          - integer
+          - boolean
+          - date
+          - time
+          - datetime
+          - duration
+          - binary
+
+  enumArg:
+    properties:
+      type:
+        type: string
+        const: "enum"
+      enumName:
+        type: string
+    required:
+      - enumName
+
+  structArg:
+    properties:
+      type:
+        type: string
+        const: "struct"
+      structName:
+        type: string
+    required:
+      - structName
+
+  listArg:
+    properties:
+      type:
+        type: string
+        const: "list"
+      itemType:
+        oneOf:
+          - $ref: "#/$defs/primitiveArg"
+          - $ref: "#/$defs/enumArg"
+          - $ref: "#/$defs/structArg"
+    required:
+      - itemType
+
+  arg:
+    oneOf:
+      - allOf:
+        - $ref: "#/$defs/genericArg"
+        - $ref: "#/$defs/primitiveArg"
+      - allOf:
+        - $ref: "#/$defs/genericArg"
+        - $ref: "#/$defs/enumArg"
+      - allOf:
+        - $ref: "#/$defs/genericArg"
+        - $ref: "#/$defs/structArg"
+      - allOf:
+        - $ref: "#/$defs/genericArg"
+        - $ref: "#/$defs/listArg"
+
+  signal:
+    type: object
+    properties:
+      documentation:
+        $ref: "#/$defs/documentation"
+      payload:
+        $ref: "#/$defs/payload"
+
+  property:
+    type: object
+    properties:
+      documentation:
+        $ref: "#/$defs/documentation"
+      values:
+        $ref: "#/$defs/payload"
+      readOnly:
+        type: boolean
+        default: false
+    required:
+      - values
+
+  method:
+    type: object
+    properties:
+      documentation:
+        $ref: "#/$defs/documentation"
+      arguments:
+        $ref: "#/$defs/payload"
+      returnValues:
+        $ref: "#/$defs/payload"
+    required:
+      - arguments

{stinger_ipc-0.0.9 → stinger_ipc-0.0.25}/stingeripc/templates/cpp/examples/client_main.cpp.jinja2

@@ -1,3 +1,4 @@
+{% import 'partials/args.jinja2' as ar %}
 
 #include <iostream>
 #include <boost/chrono/chrono.hpp>
@@ -16,6 +17,23 @@ int main(int argc, char** argv) {
     });
     {%-endfor%}
 
+    {%- for prop_name, prop in stinger.properties.items() %}
+    client.register{{prop_name | UpperCamelCase}}PropertyCallback([]({{ar.methodParams(prop.arg_list)}}) {
+        std::cout << "Received update for {{prop_name}} property: " << {# #}
+                        {%-for arg in prop.arg_list-%}
+                        "{{arg.name}}=" << {%if arg.optional%} "None"{%else%}
+                            {%-if arg.arg_type.name.lower() == 'enum'%}
+                                {{arg.enum.name | camelCase }}Strings[static_cast<int>({{arg.name}})]
+                            {%elif arg.arg_type.name.lower() == 'struct'-%}
+                                "[{{arg.cpp_type}} object]"
+                            {%-else%}{{arg.name}}{%endif%}
+                            {%-endif%} <<
+                         {%-if not loop.last %} " | " << {%endif%}
+                        {%-endfor-%} 
+                        std::endl;
+    });
+    {%endfor%}
+
     {%-for method_name, method in stinger.methods.items() %}
     std::cout << "Calling {{method_name}}" << std::endl;
     auto {{method_name|camelCase}}ResultFuture = client.{{method_name | camelCase}}({%for arg in method.arg_list%}{{arg.get_random_example_value('c++')}}{%if not loop.last%}, {%endif%}{%endfor%});

{stinger_ipc-0.0.9 → stinger_ipc-0.0.25}/stingeripc/templates/cpp/include/broker.hpp.jinja2

@@ -51,21 +51,24 @@ public:
             const std::string& payload, 
             unsigned qos, 
             bool retain, 
-            boost::optional<std::string> optCorrelationId, 
-            boost::optional<std::string> optResponseTopic,
-            boost::optional<MethodResultCode> optResultCode);
+            const MqttProperties& properties);
 
     /*! Subscribe to a topic.
      * \param topic the subscription topic.
      * \param qos an MQTT quality of service value between 0 and 2 inclusive.
+     * \return the MQTT subscription ID.
      */
-    virtual void Subscribe(const std::string& topic, int qos);
+    virtual int Subscribe(const std::string& topic, int qos);
 
     /*! Add a function that is called on the receipt of a message.
      * Many callbacks can be added, and each will be called in the order in which the callbacks were added.
      * \param cb the callback function.
      */
-    virtual void AddMessageCallback(const std::function<void(const std::string&, const std::string&, const boost::optional<std::string>, const boost::optional<std::string>, const boost::optional<MethodResultCode>)>& cb);
+    virtual void AddMessageCallback(const std::function<void(
+            const std::string&, 
+            const std::string&, 
+            const MqttProperties&
+        )>& cb);
 
     /*! Determines if a topic string matches a subscription topic.
      * \param topic a topic to match against a subscription.
@@ -99,20 +102,25 @@ private:
 
     struct MqttSubscription
     {
-        MqttSubscription(const std::string& topic, int qos) : _topic(topic), _qos(qos) {}
+        MqttSubscription(const std::string& topic, int qos, int subscriptionId) : topic(topic), qos(qos), subscriptionId(subscriptionId) {}
         ~MqttSubscription() = default;
-        std::string _topic;
-        int _qos;
-        int subscription_id;
+        std::string topic;
+        int qos;
+        int subscriptionId;
     };
 
     mosquitto *_mosq;
     std::string _host;
     int _port;
     std::string _clientId;
+    int _nextSubscriptionId = 1;
     std::queue<MqttSubscription> _subscriptions;
     boost::mutex _mutex;
-    std::vector<std::function<void(const std::string&, const std::string&, const boost::optional<std::string>, const boost::optional<std::string>, const boost::optional<MethodResultCode>)>> _messageCallbacks;
+    std::vector<std::function<void(
+            const std::string&, 
+            const std::string&, 
+            const MqttProperties&
+    )>> _messageCallbacks;
     std::queue<MqttMessage> _msgQueue;
     std::map<int, std::shared_ptr<boost::promise<bool>>> _sendMessages;
 };