memori-client 0.1.6 → 0.1.9

data/doc/MemoriClient::Engine::V2::Topic.md

@@ -0,0 +1,80 @@
+# Module `MemoriClient::Engine::V2::Topic`
+
+## list_topics
+
+Summary:
+Lists all Topic objects.
+
+Signature: `list_topics(strSessionID:)`
+Invocation: `MemoriClient::Engine::V2::Topic.list_topics(strSessionID:)`
+
+HTTP API: GET /memori/v2/Topics/{strSessionID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+
+## list_topics_paginated
+
+Summary:
+Lists Topic objects with pagination.
+
+Signature: `list_topics_paginated(strSessionID:, from:, howMany:)`
+Invocation: `MemoriClient::Engine::V2::Topic.list_topics_paginated(strSessionID:, from:, howMany:)`
+
+HTTP API: GET /memori/v2/Topics/{strSessionID}/{from}/{howMany}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `from`: **integer** The 0-based index of the first Topic object to list. required
+- `howMany`: **integer** The number of the Topic objects to list. required
+
+## get_topic
+
+Summary:
+Gets the details of a Topic object.
+
+Signature: `get_topic(strSessionID:, strTopicID:)`
+Invocation: `MemoriClient::Engine::V2::Topic.get_topic(strSessionID:, strTopicID:)`
+
+HTTP API: GET /memori/v2/Topic/{strSessionID}/{strTopicID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `strTopicID`: **string** The Topic object ID. required
+
+## list_topic_users
+
+Summary:
+Lists all User objects referencing a specified Topic object.
+
+Signature: `list_topic_users(strSessionID:, strTopicID:)`
+Invocation: `MemoriClient::Engine::V2::Topic.list_topic_users(strSessionID:, strTopicID:)`
+
+HTTP API: GET /memori/v2/TopicUsers/{strSessionID}/{strTopicID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `strTopicID`: **string** The Topic object ID. required
+
+## list_topic_users_paginated
+
+Summary:
+Lists User objects referencing a specified User object, with pagination.
+
+Signature: `list_topic_users_paginated(strSessionID:, strTopicID:, from:, howMany:)`
+Invocation: `MemoriClient::Engine::V2::Topic.list_topic_users_paginated(strSessionID:, strTopicID:, from:, howMany:)`
+
+HTTP API: GET /memori/v2/TopicUsers/{strSessionID}/{strTopicID}/{from}/{howMany}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `strTopicID`: **string** The Topic object ID. required
+- `from`: **integer** The 0-based index of the first User object to list. required
+- `howMany`: **integer** The number of User objects to list. required
+
+

data/doc/MemoriClient::Engine::V2::UnansweredQuestion.md

@@ -0,0 +1,75 @@
+# Module `MemoriClient::Engine::V2::UnansweredQuestion`
+
+## list_unanswered_questions
+
+Summary:
+Lists all Unanswered Question objects.
+
+Signature: `list_unanswered_questions(strSessionID:)`
+Invocation: `MemoriClient::Engine::V2::UnansweredQuestion.list_unanswered_questions(strSessionID:)`
+
+HTTP API: GET /memori/v2/UnansweredQuestions/{strSessionID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+
+## list_unanswered_questions_paginated
+
+Summary:
+Lists Unanswered Question objects with pagination.
+
+Signature: `list_unanswered_questions_paginated(strSessionID:, from:, howMany:)`
+Invocation: `MemoriClient::Engine::V2::UnansweredQuestion.list_unanswered_questions_paginated(strSessionID:, from:, howMany:)`
+
+HTTP API: GET /memori/v2/UnansweredQuestions/{strSessionID}/{from}/{howMany}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `from`: **integer** The 0-based index of the first Unanswered Question object to list. required
+- `howMany`: **integer** The number of the Unanswered Question objects to list. required
+
+## add_unanswered_question
+
+Summary:
+Adds a new Unanswered Question object.
+
+Signature: `add_unanswered_question(strSessionID:, payload: {})`
+Invocation: `MemoriClient::Engine::V2::UnansweredQuestion.add_unanswered_question(strSessionID:, payload: {})`
+
+HTTP API: POST /memori/v2/UnansweredQuestion/{strSessionID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `payload`: **Hash** request payload. optional
+  - `payload.unansweredQuestionID`: **String** . optional
+  - `payload.text`: **String** . optional
+  - `payload.contextVars`: **Object** . optional
+  - `payload.occurrences`: **Integer** . optional
+  - `payload.receiverID`: **String** . optional
+  - `payload.receiverTag`: **String** . optional
+  - `payload.receiverName`: **String** . optional
+  - `payload.suggestions`: **Array** . optional
+  - `payload.creationTimestamp`: **String** . optional
+  - `payload.creationSessionID`: **String** . optional
+  - `payload.lastChangeTimestamp`: **String** . optional
+  - `payload.lastChangeSessionID`: **String** . optional
+
+## remove_unanswered_question
+
+Summary:
+Removes an existing Unanswered Question object.
+
+Signature: `remove_unanswered_question(strSessionID:, strUnansweredQuestionID:)`
+Invocation: `MemoriClient::Engine::V2::UnansweredQuestion.remove_unanswered_question(strSessionID:, strUnansweredQuestionID:)`
+
+HTTP API: DELETE /memori/v2/UnansweredQuestion/{strSessionID}/{strUnansweredQuestionID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `strUnansweredQuestionID`: **string** The Unanswered Question object ID. required
+
+

data/doc/MemoriClient::Engine::V2::User.md

@@ -0,0 +1,140 @@
+# Module `MemoriClient::Engine::V2::User`
+
+## list_users
+
+Summary:
+Lists all User objects associated with the Memori of the current session.
+
+Signature: `list_users(strSessionID:)`
+Invocation: `MemoriClient::Engine::V2::User.list_users(strSessionID:)`
+
+HTTP API: GET /memori/v2/Users/{strSessionID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+
+## list_users_paginated
+
+Summary:
+Lists User objects associated with the Memori of the current session, with pagination.
+
+Signature: `list_users_paginated(strSessionID:, from:, howMany:)`
+Invocation: `MemoriClient::Engine::V2::User.list_users_paginated(strSessionID:, from:, howMany:)`
+
+HTTP API: GET /memori/v2/Users/{strSessionID}/{from}/{howMany}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `from`: **integer** The 0-based index of the first User to list. required
+- `howMany`: **integer** The number of User objects to list. required
+
+## get_user
+
+Summary:
+Gets the details of a User object.
+
+Signature: `get_user(strSessionID:, strUserID:)`
+Invocation: `MemoriClient::Engine::V2::User.get_user(strSessionID:, strUserID:)`
+
+HTTP API: GET /memori/v2/User/{strSessionID}/{strUserID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `strUserID`: **string** The User object ID. required
+
+## list_user_topics
+
+Summary:
+Lists all Topic objects referenced by a specified User object.
+
+Signature: `list_user_topics(strSessionID:, strUserID:)`
+Invocation: `MemoriClient::Engine::V2::User.list_user_topics(strSessionID:, strUserID:)`
+
+HTTP API: GET /memori/v2/UserTopics/{strSessionID}/{strUserID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `strUserID`: **string** The User object ID. required
+
+## list_user_topics_paginated
+
+Summary:
+Lists Topic objects referenced by a specified User object, with pagination.
+
+Signature: `list_user_topics_paginated(strSessionID:, strUserID:, from:, howMany:)`
+Invocation: `MemoriClient::Engine::V2::User.list_user_topics_paginated(strSessionID:, strUserID:, from:, howMany:)`
+
+HTTP API: GET /memori/v2/UserTopics/{strSessionID}/{strUserID}/{from}/{howMany}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `strUserID`: **string** The User object ID. required
+- `from`: **integer** The 0-based index of the first Topic object to list. required
+- `howMany`: **integer** The number of Topic objects to list. required
+
+## list_known_facts
+
+Summary:
+Lists all Known Facts objects associated with the current User.
+
+Signature: `list_known_facts(strSessionID:)`
+Invocation: `MemoriClient::Engine::V2::User.list_known_facts(strSessionID:)`
+
+HTTP API: GET /memori/v2/KnownFacts/{strSessionID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+
+## list_known_facts_paginated
+
+Summary:
+Lists Known Facts objects associated with the current User, with pagination.
+
+Signature: `list_known_facts_paginated(strSessionID:, from:, howMany:)`
+Invocation: `MemoriClient::Engine::V2::User.list_known_facts_paginated(strSessionID:, from:, howMany:)`
+
+HTTP API: GET /memori/v2/KnownFacts/{strSessionID}/{from}/{howMany}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `from`: **integer** The 0-based index of the first Known Fact to list. required
+- `howMany`: **integer** The number of Known Fact objects to list. required
+
+## get_known_fact
+
+Summary:
+Gets the details of a Known Fact object.
+
+Signature: `get_known_fact(strSessionID:, strKnownFactID:)`
+Invocation: `MemoriClient::Engine::V2::User.get_known_fact(strSessionID:, strKnownFactID:)`
+
+HTTP API: GET /memori/v2/KnownFact/{strSessionID}/{strKnownFactID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `strKnownFactID`: **string** The Known Fact object ID. required
+
+## delete_known_fact
+
+Summary:
+Deletes an existing Known Fact object.
+
+Signature: `delete_known_fact(strSessionID:, strKnownFactID:)`
+Invocation: `MemoriClient::Engine::V2::User.delete_known_fact(strSessionID:, strKnownFactID:)`
+
+HTTP API: DELETE /memori/v2/KnownFact/{strSessionID}/{strKnownFactID}`
+
+Parameters:
+
+- `strSessionID`: **string** The session ID. required
+- `strKnownFactID`: **string** The Known Fact object ID. required
+
+

data/doc/MemoriClient::Engine::V2::WebHook.md

@@ -0,0 +1,67 @@
+# Module `MemoriClient::Engine::V2::WebHook`
+
+## test_slot
+
+Summary:
+Returns test slot values.
+
+Signature: `test_slot(payload: {})`
+Invocation: `MemoriClient::Engine::V2::WebHook.test_slot(payload: {})`
+
+HTTP API: POST /memori/v2/TestSlot`
+
+Parameters:
+
+- `payload`: **Hash** request payload. optional
+  - `payload.slotName`: **String** . optional
+  - `payload.requestID`: **Integer** . optional
+  - `payload.requestDateTime`: **String** . optional
+  - `payload.requestValidityMinutes`: **Number** . optional
+  - `payload.memoriID`: **String** . optional
+  - `payload.culture`: **String** . optional
+
+## test_intent
+
+Summary:
+Returns test intent results.
+
+Signature: `test_intent(payload: {})`
+Invocation: `MemoriClient::Engine::V2::WebHook.test_intent(payload: {})`
+
+HTTP API: POST /memori/v2/TestIntent`
+
+Parameters:
+
+- `payload`: **Hash** request payload. optional
+  - `payload.intentName`: **String** . optional
+  - `payload.utterance`: **String** . optional
+  - `payload.slotValues`: **Object** . optional
+  - `payload.sessionID`: **String** . optional
+  - `payload.currentTag`: **String** . optional
+  - `payload.currentTagAuthenticated`: **Boolean** . optional
+  - `payload.currentDateUTC`: **String** . optional
+  - `payload.currentPlace`: **** . optional
+  - `payload.timeZone`: **String** . optional
+  - `payload.beginUTC`: **String** . optional
+  - `payload.endUTC`: **String** . optional
+  - `payload.contextVars`: **Object** . optional
+  - `payload.transitionHistory`: **Array** . optional
+  - `payload.userEmail`: **String** . optional
+  - `payload.requestID`: **Integer** . optional
+  - `payload.requestDateTime`: **String** . optional
+  - `payload.requestValidityMinutes`: **Number** . optional
+  - `payload.memoriID`: **String** . optional
+  - `payload.culture`: **String** . optional
+
+## test_function_random_number
+
+Summary:
+Test function: returns a random number between 0 and 999999.
+
+Signature: `test_function_random_number()`
+Invocation: `MemoriClient::Engine::V2::WebHook.test_function_random_number()`
+
+HTTP API: GET /memori/v2/TestFunctions/RandomNumber`
+
+
+

data/lib/memori_client/railtie.rb

@@ -0,0 +1,12 @@
+module MemoriClient
+  class Railtie < Rails::Railtie
+    puts "Loading MemoriClient Railtie"
+    rake_tasks do
+      puts "Loading MemoriClient Rake tasks"
+      file = File.expand_path('../../tasks/memori_client.rake', __FILE__)
+      puts "Loading Rake tasks from #{file}"
+      raise "Rake tasks file not found: #{file}" unless File.exist?(file)
+      load File.expand_path('../../tasks/memori_client.rake', __FILE__)
+    end
+  end
+end

data/lib/memori_client/utils/rails.rb

@@ -0,0 +1,54 @@
+module MemoriClient
+  module Utils
+    module Rails
+      def self.copy_docs
+        # Find gem's root directory
+        gem_root = Gem.loaded_specs['memori-client'].gem_dir rescue nil
+        unless gem_root
+          puts "Error: Could not find memori_client gem installation"
+          exit 1
+        end
+
+        # Determine project root (works in Rails and non-Rails)
+        project_root = if defined?(::Rails)
+                         ::Rails.root.to_s
+                       else
+                         Dir.pwd
+                       end
+
+        source_docs = File.join(gem_root, 'doc')
+        dest_docs = File.join(project_root, 'doc', 'memori_client')
+
+        # Create destination directory if needed
+        FileUtils.mkdir_p(dest_docs) unless Dir.exist?(dest_docs)
+
+        # Copy all documentation files
+        if Dir.exist?(source_docs)
+          FileUtils.cp_r(Dir.glob(File.join(source_docs, '*')), dest_docs)
+          puts "MemoriClient documentation copied to #{dest_docs}"
+        else
+          puts "No documentation found in the gem"
+        end
+      end
+
+      def self.copy_initializer
+        template = <<~RUBY
+# Path: config/initializers/memori_client.rb
+require 'memori_client'
+MemoriClient.configure do |config|
+  config.backend_api_root = ENV['MEMORI_BACKEND_API_ROOT']
+  config.backend_api_username = ENV['MEMORI_BACKEND_API_USERNAME']
+  config.backend_api_password = ENV['MEMORI_BACKEND_API_PASSWORD']
+  config.backend_api_tenant = ENV['MEMORI_BACKEND_API_TENANT']
+  config.engine_api_root = ENV['MEMORI_ENGINE_API_ROOT']
+end 
+      RUBY
+
+        initializer_path = ::Rails.root.join('config', 'initializers', 'memori_client.rb')
+        File.open(initializer_path, 'w') do |file|
+          file.write(template)
+        end
+      end
+    end
+  end
+end

data/lib/memori_client.rb

@@ -44,6 +44,12 @@ end
 require 'securerandom'
 require 'uri'
 require 'json'
+
+if defined?(::Rails)
+  require 'memori_client/utils/rails'
+  require 'memori_client/railtie'
+end
+
 require 'memori_client/configuration'
 require "memori_client/http_client"
 require "memori_client/resource"
@@ -56,3 +62,4 @@ require "memori_client/engine/resources"
 require "memori_client/engine/v2/private/memori"
 require "memori_client/engine/v2/private/memori_block"
 
+

data/lib/tasks/memori_client.rake

@@ -0,0 +1,15 @@
+namespace :memori_client do
+  namespace :docs do
+    desc "Copy MemoriClient documentation to Rails public directory"
+    task :copy do
+      MemoriClient::Utils::Rails.copy_docs
+    end
+  end
+
+  namespace :config do
+    desc "Copy MemoriClient initializer to Rails config/initializers"
+    task :copy_initializer do
+      MemoriClient::Utils::Rails.copy_initializer
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memori-client
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.9
 platform: ruby
 authors:
 - Stefano Lampis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-30 00:00:00.000000000 Z
+date: 2025-06-18 00:00:00.000000000 Z
 dependencies: []
 description: Memori Client to interact with Memori backend and engine API
 email: me@stefanolampis.com
@@ -16,6 +16,43 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- doc/MemoriClient::Backend::V1::Asset.md
+- doc/MemoriClient::Backend::V2::ActionLog.md
+- doc/MemoriClient::Backend::V2::Analysis.md
+- doc/MemoriClient::Backend::V2::Asset.md
+- doc/MemoriClient::Backend::V2::Badge.md
+- doc/MemoriClient::Backend::V2::CompletionConfig.md
+- doc/MemoriClient::Backend::V2::ConsumptionLog.md
+- doc/MemoriClient::Backend::V2::ImportExport.md
+- doc/MemoriClient::Backend::V2::Integration.md
+- doc/MemoriClient::Backend::V2::Invitation.md
+- doc/MemoriClient::Backend::V2::Memori.md
+- doc/MemoriClient::Backend::V2::MemoriList.md
+- doc/MemoriClient::Backend::V2::Notification.md
+- doc/MemoriClient::Backend::V2::Process.md
+- doc/MemoriClient::Backend::V2::Tenant.md
+- doc/MemoriClient::Backend::V2::User.md
+- doc/MemoriClient::Engine::V2::ChatLog.md
+- doc/MemoriClient::Engine::V2::ContextVar.md
+- doc/MemoriClient::Engine::V2::CorrelationPair.md
+- doc/MemoriClient::Engine::V2::CustomDictionary.md
+- doc/MemoriClient::Engine::V2::Dialog.md
+- doc/MemoriClient::Engine::V2::EventLog.md
+- doc/MemoriClient::Engine::V2::ExpertReference.md
+- doc/MemoriClient::Engine::V2::Function.md
+- doc/MemoriClient::Engine::V2::Intent.md
+- doc/MemoriClient::Engine::V2::LocalizationKey.md
+- doc/MemoriClient::Engine::V2::Medium.md
+- doc/MemoriClient::Engine::V2::Memory.md
+- doc/MemoriClient::Engine::V2::NLP.md
+- doc/MemoriClient::Engine::V2::Person.md
+- doc/MemoriClient::Engine::V2::Search.md
+- doc/MemoriClient::Engine::V2::Session.md
+- doc/MemoriClient::Engine::V2::Stat.md
+- doc/MemoriClient::Engine::V2::Topic.md
+- doc/MemoriClient::Engine::V2::UnansweredQuestion.md
+- doc/MemoriClient::Engine::V2::User.md
+- doc/MemoriClient::Engine::V2::WebHook.md
 - lib/memori_client.rb
 - lib/memori_client/backend/resource.rb
 - lib/memori_client/backend/resources.rb
@@ -66,7 +103,10 @@ files:
 - lib/memori_client/engine/v2/user.rb
 - lib/memori_client/engine/v2/web_hook.rb
 - lib/memori_client/http_client.rb
+- lib/memori_client/railtie.rb
 - lib/memori_client/resource.rb
+- lib/memori_client/utils/rails.rb
+- lib/tasks/memori_client.rake
 homepage: https://rubygems.org/gems/memori_client-client
 licenses:
 - MIT