haltia 24.0.0.dev.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6016219f53c2249cbb6d1ce2775f28867821d9c68f62df894b1d90f1c3a1ada
+  data.tar.gz: acdcc9376f3e47f72b3fdbf08c2bdc364e6c0286cfa9c0a94b5d9826436d516a
+SHA512:
+  metadata.gz: 84e1f928e92890ed51ef8c96372e07ab1471700a1391e2c0d02472f8b715fda877559c948d6dedf07591103367e8555197d8a7820d42a6ec6e00f3011abc5c87
+  data.tar.gz: e9213444a725587df4cf62fac7e9dd57a1aeae31f38f5e85d534403f6565e4852ff2db89c06b674bb107ac5f3d4fcb88527f185ed49c4af680214e02360efb2b

data/AUTHORS

@@ -0,0 +1 @@
+* Arto Bendiken <arto@haltia.ai>

data/CHANGES.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 24.0.0.dev.0 - 2024-01-23
+
+### Added
+
+- `Haltia::SDK.licensee`
+- `Haltia::SDK.version`

data/README.md

@@ -0,0 +1,26 @@
+# Haltia.AI Software Development Kit (SDK) for Ruby
+
+[![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
+[![Compatibility](https://img.shields.io/badge/ruby-2.6%2B-blue)](https://rubygems.org/gems/haltia)
+[![Package](https://img.shields.io/gem/v/haltia)](https://rubygems.org/gems/haltia)
+
+## Prerequisites
+
+- [Ruby](https://ruby-lang.org) 2.6+
+  with [FFI](https://github.com/ffi/ffi/wiki)
+
+- [Haltia.AI SDK](https://sdk.haltia.ai) 24.0+
+
+## Installation
+
+```shell
+$ gem install haltia
+```
+
+## Examples
+
+### Importing the library
+
+```ruby
+require 'haltia'
+```

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org/>

data/VERSION

@@ -0,0 +1 @@
+24.0.0.dev.0

data/lib/haltia/sdk/abi.rb

@@ -0,0 +1,17 @@
+# This is free and unencumbered software released into the public domain.
+
+module Haltia::SDK
+  # const char* haiGetLicenseeString()
+  begin
+    attach_function :haiGetLicenseeString, [], :string
+  rescue FFI::NotFoundError => err
+    warn err
+  end
+
+  # const char* haiGetVersionString()
+  begin
+    attach_function :haiGetVersionString, [], :string
+  rescue FFI::NotFoundError => err
+    warn err
+  end
+end # Haltia::SDK

data/lib/haltia/sdk.rb

@@ -0,0 +1,68 @@
+# This is free and unencumbered software released into the public domain.
+
+require 'ffi'
+
+##
+# The Haltia.AI Software Development Kit (SDK) for Ruby.
+module Haltia
+  ##
+  # Foreign-function interface (FFI) bindings for the Haltia.AI SDK native
+  # library.
+  module SDK
+    MACOS_APP_PATH = 'Applications/Haltia.AI.app'
+    MACOS_APP_SUBPATH = 'Contents/Frameworks/HaltiaAI.framework/HaltiaAI'
+    MACOS_SDK_DYLIB = 'libHaltiaAI.dylib'
+
+    ##
+    # Returns the name and email of who the loaded SDK build is licensed to.
+    #
+    # The licensee string format is "J. Random Hacker <jhacker@example.com>".
+    #
+    # @return [#to_s]
+    def self.licensee
+      self.haiGetLicenseeString()
+    end
+
+    ##
+    # Returns the full version string for the loaded SDK build.
+    #
+    # The version string format is "24.0.0-dev.123 (2024-01-31)".
+    #
+    # Note that this version is likely to be different from the Ruby SDK
+    # library version. The two are compatible so long as the two initial
+    # major components of the version string are equivalent for both.
+    #
+    # @return [#to_s]
+    def self.version
+      self.haiGetVersionString()
+    end
+
+    ##
+    # Returns a list of platform-specific paths where to look for the SDK.
+    #
+    # @return [Array<String>]
+    def self.paths
+      result = []
+      case RUBY_PLATFORM
+        when /darwin/ # macOS
+          result << ENV['HALTIA_SDK'] if ENV['HALTIA_SDK']
+          result << [ENV['HALTIA_APP'], MACOS_APP_SUBPATH].join('/') if ENV['HALTIA_APP']
+          result << [ENV['HOME'], MACOS_APP_PATH, MACOS_APP_SUBPATH].join('/') if ENV['HOME']
+          result << ['', MACOS_APP_PATH, MACOS_APP_SUBPATH].join('/')
+          result << MACOS_SDK_DYLIB
+
+        when /linux/  # Linux
+          %w(libHaltiaAI.so)
+
+        when /bccwin|cygwin|djgpp|mingw|mswin|wince/i  # Windows
+          %w(HaltiaAI.dll)
+      end
+      result.uniq  # remove duplicates
+    end
+
+    extend ::FFI::Library
+    ffi_lib self.paths
+  end # SDK
+end # Haltia
+
+require 'haltia/sdk/abi'

data/lib/haltia.rb

@@ -0,0 +1,3 @@
+# This is free and unencumbered software released into the public domain.
+
+require 'haltia/sdk'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: haltia
+version: !ruby/object:Gem::Version
+  version: 24.0.0.dev.0
+platform: ruby
+authors:
+- Haltia.AI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: know
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.3
+description: ''
+email: support@haltia.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- CHANGES.md
+- README.md
+- UNLICENSE
+- VERSION
+- lib/haltia.rb
+- lib/haltia/sdk.rb
+- lib/haltia/sdk/abi.rb
+homepage: https://sdk.haltia.ai
+licenses:
+- Unlicense
+metadata:
+  bug_tracker_uri: https://github.com/HaltiaAI/haltia.rb/issues
+  changelog_uri: https://github.com/HaltiaAI/haltia.rb/blob/master/CHANGES.md
+  documentation_uri: https://github.com/HaltiaAI/haltia.rb/blob/master/README.md
+  homepage_uri: https://sdk.haltia.ai
+  source_code_uri: https://github.com/HaltiaAI/haltia.rb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Haltia.AI Software Development Kit (SDK) for Ruby
+test_files: []