omnicli 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 991d1b77559f0dd2950f7e139720ad30d43f122134d9a1606d77d4669d68739c
+  data.tar.gz: 0b165c2c86f3e0d7ae9348e9e80021bb810eb8a185d0e74e157b7b456653db4d
+SHA512:
+  metadata.gz: 18e70e6dc8accc71a24d789713d893b56d8bd6bf75fe4c7b2520c2259a58a89456992f67e7ddc13dd21bfd2b711045cfff353f15ee4d00b6708b97252b934139
+  data.tar.gz: 612df92b0e41b5479a8c7aad8366772436ab94a56e7c4d91a22147c2deba87747aa9623a5bcae3b42dabaaf9637bbed90bdd8e84cb1d7b942fe1a0fbc3fb01ce

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Raphaël Beamonte <raphael.beamonte@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# omnicli (sdk-ruby)
+
+Ruby SDK for building Omni commands.
+
+## Overview
+
+`omnicli` is a Ruby gem that provides functionality to help build commands that will be executed by Omni. It offers various utilities and helpers that make it easier to work with Omni's features from within Ruby.
+
+## Installation
+
+```bash
+gem install omnicli
+```
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'omnicli'
+```
+
+And then execute:
+```bash
+bundle install
+```
+
+## Features
+
+### Argument Parsing
+
+The SDK can read omni-parsed arguments from environment variables into a familiar Ruby Hash format:
+
+```ruby
+require 'omnicli'
+
+begin
+  args = OmniCli.parse!
+  # Access your command's arguments as hash keys
+  if args[:verbose]
+    puts "Verbose mode enabled"
+  end
+  if args[:input_file]
+    puts "Processing file: #{args[:input_file]}"
+  end
+rescue OmniCli::ArgListMissingError
+  puts "No Omni CLI arguments found. Make sure 'argparser: true' is set for your command."
+end
+```
+
+The arguments are returned as a Hash with symbol keys, with their values in the expected types (strings, integers, floats, booleans or arrays of these types).
+
+### Integration with omni
+
+The argument parser of omni needs to be enabled for your command. This can be done as part of the [metadata](https://omnicli.dev/reference/custom-commands/path/metadata-headers) of your command, which can either be provided as a separate file:
+
+```
+your-repo
+└── commands
+    ├── your-command.rb
+    └── your-command.metadata.yaml
+```
+
+```yaml
+# your-command.metadata.yaml
+argparser: true
+```
+
+Or as part of your Ruby command headers:
+
+```ruby
+# your-command.rb
+#
+# argparser: true
+require 'omnicli'
+...
+```
+
+## Requirements
+
+- Ruby 2.6 or higher
+- No additional dependencies required
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rspec
+```
+
+For local development, you can also run:
+```bash
+# Clone the repository
+omni clone https://github.com/omnicli/sdk-ruby.git
+# Install dependencies
+omni up
+# Run tests
+omni test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/omnicli/sdk-ruby.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/lib/omnicli/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/omnicli/errors.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OmniCli
+  # Base exception for omnicli-related errors
+  class Error < StandardError; end
+
+  # Raised when the OMNI_ARG_LIST environment variable is missing
+  class ArgListMissingError < Error
+    def initialize(msg = "OMNI_ARG_LIST environment variable is not set. " \
+                         'Are you sure "argparser: true" is set for this command?')
+      super
+    end
+  end
+
+  # Base class for invalid value errors
+  class InvalidValueError < Error; end
+
+  # Raised when an invalid boolean value is encountered
+  class InvalidBooleanValueError < InvalidValueError
+    def initialize(value)
+      super("expected 'true' or 'false', got '#{value}'")
+    end
+  end
+
+  # Raised when an invalid integer value is encountered
+  class InvalidIntegerValueError < InvalidValueError
+    def initialize(value)
+      super("expected integer, got '#{value}'")
+    end
+  end
+
+  # Raised when an invalid float value is encountered
+  class InvalidFloatValueError < InvalidValueError
+    def initialize(value)
+      super("expected float, got '#{value}'")
+    end
+  end
+end

data/lib/omnicli/parser.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "errors"
+
+module OmniCli
+  # Parser for Omni CLI arguments from environment variables
+  class Parser
+    # Parse arguments from environment variables into a Hash with symbol keys
+    #
+    # @return [Hash{Symbol => Object}] parsed arguments with proper types
+    # @raise [ArgListMissingError] if OMNI_ARG_LIST is not set
+    # @raise [InvalidBooleanValueError] if a boolean value is invalid
+    # @raise [InvalidIntegerValueError] if an integer value is invalid
+    # @raise [InvalidFloatValueError] if a float value is invalid
+    # @example
+    #   parser = OmniCli::Parser.new
+    #   args = parser.parse!
+    #   puts args[:verbose] if args[:verbose]
+    def parse!
+      list = arg_list
+      return {} if list.empty?
+
+      list.each_with_object({}) do |name, args|
+        args[name.downcase.to_sym] = parse_argument(name)
+      end
+    end
+
+    private
+
+    def arg_list
+      ENV["OMNI_ARG_LIST"]&.split || raise(ArgListMissingError)
+    end
+
+    def parse_argument(name)
+      type_info = arg_type(name)
+      return nil unless type_info
+
+      base_type, size = type_info
+
+      if size
+        Array.new(size) { |i| arg_value(name, base_type, i) }
+      else
+        arg_value(name, base_type)
+      end
+    end
+
+    def arg_type(name)
+      return nil unless (type_str = ENV.fetch("OMNI_ARG_#{name.upcase}_TYPE", nil))
+
+      if type_str.include?("/")
+        base_type, size = type_str.split("/")
+        [base_type, size.to_i]
+      else
+        [type_str, nil]
+      end
+    end
+
+    def arg_value(name, type, index = nil)
+      key = ["OMNI_ARG", name.upcase, "VALUE", index].compact.join("_")
+      value = ENV.fetch(key, nil)
+
+      return default_value(type) if value.nil?
+
+      convert_value(value, type)
+    end
+
+    def default_value(type)
+      type == "str" ? "" : nil
+    end
+
+    def convert_value(value, type)
+      case type
+      when "bool"
+        parse_boolean(value)
+      when "int"
+        parse_integer(value)
+      when "float"
+        parse_float(value)
+      else
+        value
+      end
+    end
+
+    def parse_boolean(value)
+      case value.downcase
+      when "true" then true
+      when "false" then false
+      else raise InvalidBooleanValueError, value
+      end
+    end
+
+    def parse_integer(value)
+      Integer(value)
+    rescue ArgumentError, TypeError
+      raise InvalidIntegerValueError, value
+    end
+
+    def parse_float(value)
+      Float(value)
+    rescue ArgumentError, TypeError
+      raise InvalidFloatValueError, value
+    end
+  end
+end

data/lib/omnicli/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module OmniCli
+  # Read version from VERSION file, or default to 0.0.0-unreleased
+  VERSION = if File.exist?(File.expand_path("VERSION", __dir__))
+              File.read(File.expand_path("VERSION", __dir__)).strip
+            else
+              "0.0.0-unreleased"
+            end
+end

data/lib/omnicli.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "omnicli/version"
+require_relative "omnicli/errors"
+require_relative "omnicli/parser"
+
+# The OmniCli module provides functionality to build Omni commands in Ruby.
+module OmniCli
+  # Create a new parser instance and parse arguments
+  #
+  # @return [OpenStruct] parsed arguments
+  # @raise [ArgListMissingError] if OMNI_ARG_LIST is not set
+  # @raise [InvalidBooleanValueError] if a boolean value is invalid
+  # @raise [InvalidIntegerValueError] if an integer value is invalid
+  # @raise [InvalidFloatValueError] if a float value is invalid
+  def self.parse!
+    Parser.new.parse!
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: omnicli
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Raphaël Beamonte
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-23 00:00:00.000000000 Z
+dependencies: []
+description: This package provides functionality to build Omni commands in Ruby
+email:
+- raphael.beamonte@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/omnicli.rb
+- lib/omnicli/VERSION
+- lib/omnicli/errors.rb
+- lib/omnicli/parser.rb
+- lib/omnicli/version.rb
+homepage: https://omnicli.dev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://omnicli.dev
+  source_code_uri: https://github.com/omnicli/sdk-ruby
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Ruby SDK for building Omni commands
+test_files: []