glossarist-agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5effe5b9399c088c41e1073dc5450dca94a5b52cee8d8f3d539450279a032207
+  data.tar.gz: d517d3428be089a55dc3d3788a8f8f6621f4bec32b0c70c1b3d28c6efee6281c
+SHA512:
+  metadata.gz: 02e48745b3e92c17c1937de331d238e67ea0c0411d50d06c368796b5dbe32719fee05ee0ebe382708a860215331390a53391643b148cffb7eefad278b34c74b3
+  data.tar.gz: baf4ea5616a16ad50c09b957533348c2679ddb513cc7efb72d5f7d39c831419b6c03f0d1eec91df92741ea442b2975f6b6c209127f2847ef2497df09cd81fd31

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.adoc

@@ -0,0 +1,149 @@
+= Glossarist Agent
+
+image:https://img.shields.io/gem/v/glossarist-agent.svg["Gem Version", link="https://rubygems.org/gems/glossarist-agent"]
+image:https://github.com/relaton/glossarist-agent/workflows/rake/badge.svg["Build Status", link="https://github.com/relaton/glossarist-agent/actions?workflow=rake"]
+image:https://codeclimate.com/github/relaton/glossarist-agent/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/glossarist-agent"]
+
+== Purpose
+
+The Glossarist Agent is a Ruby gem designed to retrieve remotely located concepts.
+
+Currently, it allows the bulk retrieval of the IHO S-32 Hydrographic Dictionary
+into the Glossarist format.
+
+
+== Installation
+
+Add this line to your application's `Gemfile`:
+
+[source,ruby]
+----
+gem 'glossarist-agent'
+----
+
+And then execute:
+
+[source,shell]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,shell]
+----
+$ gem install glossarist-agent
+----
+
+
+== Usage
+
+=== Downloading IHO S-32 Hydrographic Dictionary data
+
+==== General
+
+The Glossarist Agent can download and process IHO (International Hydrographic
+Organization) S-32 Hydrographic Dictionary data from available CSV files.
+
+The official site is located at:
+
+* http://iho-ohi.net/S32/
+
+Glossarist Agent uses a caching mechanism to efficiently manage downloads and
+reduce unnecessary network requests.
+
+To retrieve these concepts and generate a Glossarist dataset, use the following
+command:
+
+[source,shell]
+----
+$ glossarist-agent iho retrieve-concepts
+----
+
+This command performs the following actions:
+
+. Downloads the required CSV files from IHO sources.
+. Caches the downloaded files for future use.
+. Processes the CSV data to generate a Glossarist-compatible dataset.
+
+==== Command Options
+
+[source,shell]
+----
+$ glossarist-agent iho help retrieve-concepts
+Usage:
+  glossarist-agent iho retrieve-concepts
+
+Options:
+  -o, [--output=OUTPUT]                        # Directory to output generated files
+                                               # Default: ./output
+  -c, [--cache=CACHE]                          # Directory to store cached files
+                                               # Default: ~/.glossarist-agent/cache
+      [--fetch], [--no-fetch], [--skip-fetch]  # Fetch new data (default: true)
+                                               # Default: true
+
+Download IHO CSV files and generate concepts
+----
+
+`--output`:: Specifies the directory where the generated Glossarist dataset will be saved. Default is `./output`.
+`--cache`:: Sets the directory for storing cached files. Default is `~/.glossarist-agent/cache`.
+`--fetch`:: Controls whether to fetch new data or use existing cached data. Default is `true`.
+
+[example]
+====
+The following command saves the IHO S-32 Glossarist dataset at
+`./iho-s32-glossarist` and prioritizes using the existing cache without
+communicating with the server.
+
+[source,sh]
+----
+$ glossarist-agent iho retrieve-concepts --no-fetch -o iho-s32-glossarist
+----
+====
+
+
+=== Caching mechanism
+
+The Glossarist Agent employs a sophisticated caching system to optimize
+performance and reduce unnecessary downloads:
+
+. Downloaded files are stored in the specified cache directory.
+. Each cached file is associated with metadata, including the download time and ETag.
+. When fetching data, the agent checks:
+.. If the cached file exists and is within the expiry period (default 7 days).
+.. If the server's ETag matches the cached ETag.
+. If either condition is not met, the agent downloads a fresh copy of the file.
+
+This approach ensures that the agent always works with up-to-date data while minimizing network usage.
+
+=== Generating Glossarist Dataset
+
+After downloading and caching the IHO CSV files, the agent processes the data to generate a Glossarist-compatible dataset:
+
+. It parses the CSV files to extract concept information.
+. The extracted data is transformed into the Glossarist data model.
+. The resulting dataset is saved in the specified output directory.
+
+This generated dataset can then be used with other Glossarist tools for further processing or integration into concept management systems.
+
+== Features
+
+* Automated downloading and caching of IHO CSV files
+* ETag-based cache validation
+* Customizable cache expiry period
+* Generation of Glossarist-compatible datasets from IHO data
+* Command-line interface for easy integration into workflows
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+
+== License
+
+Copyright Ribose.
+
+The gem is available as open source under the terms of the
+https://opensource.org/licenses/MIT[MIT License].

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/glossarist-agent

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/glossarist/agent/cli"
+
+Glossarist::Agent::Cli.start(ARGV)

data/lib/glossarist/agent/cli.rb

@@ -0,0 +1,11 @@
+require "thor"
+require_relative "iho/cli"
+
+module Glossarist
+  module Agent
+    class Cli < Thor
+      desc "iho SUBCOMMAND ...ARGS", "IHO-related commands"
+      subcommand "iho", Iho::Cli
+    end
+  end
+end

data/lib/glossarist/agent/collection.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Agent
+    class Collection
+      attr_reader :collection
+
+      def initialize
+        @collection = Glossarist::ManagedConceptCollection.new
+      end
+
+      def add_concept(data)
+        concept = Concept.new(data)
+        @collection << concept.managed_concept
+      end
+
+      def save_to_files(output_path)
+        @collection.save_to_files(output_path)
+      end
+    end
+  end
+end

data/lib/glossarist/agent/concept.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Agent
+    class Concept
+      attr_reader :managed_concept
+
+      def initialize(data)
+        @managed_concept = Glossarist::ManagedConcept.new
+        populate_concept(data)
+      end
+
+      private
+
+      def populate_concept(data)
+        @managed_concept.id = data[:id]
+        @managed_concept.groups = data[:groups] || []
+
+        localized_concept = Glossarist::LocalizedConcept.new
+        localized_concept.language_code = "eng"
+        localized_concept.definition = [Glossarist::DetailedDefinition.new(content: data[:definition])]
+        localized_concept.designations = [Glossarist::Designation::Base.from_h({ "type" => "expression", "designation" => data[:term] })]
+
+        @managed_concept.localizations = { "eng" => localized_concept }
+      end
+    end
+  end
+end

data/lib/glossarist/agent/http_cache_downloader.rb

@@ -0,0 +1,141 @@
+require "faraday"
+require "fileutils"
+require "json"
+require "time"
+
+module Glossarist
+  module Agent
+    class HttpCacheDownloader
+      CACHE_EXPIRY_DAYS = 7
+
+      def initialize(cache_dir, fetch: true)
+        @cache_dir = cache_dir
+        @fetch = fetch
+        FileUtils.mkdir_p(@cache_dir)
+        @client = Faraday.new { |faraday| faraday.adapter Faraday.default_adapter }
+      end
+
+      def download_files(url_map)
+        url_map.each { |filename, url| process_file(filename, url) }
+        puts "All files are up to date in the cache."
+      end
+
+      private
+
+      def process_file(filename, url)
+        cache_path = File.join(@cache_dir, filename)
+        metadata_path = "#{cache_path}.metadata.json"
+
+        if cache_exists?(cache_path, metadata_path)
+          handle_existing_cache(filename, url, cache_path, metadata_path)
+        else
+          handle_missing_cache(filename, url, cache_path, metadata_path)
+        end
+      end
+
+      def cache_exists?(cache_path, metadata_path)
+        File.exist?(cache_path) && File.exist?(metadata_path)
+      end
+
+      def handle_existing_cache(filename, url, cache_path, metadata_path)
+        if !@fetch
+          puts "Using cached #{filename} (fetch disabled)"
+        elsif should_download?(url, cache_path, metadata_path)
+          download_file(url, cache_path, metadata_path)
+        else
+          puts "Using cached #{filename} (not modified or within #{CACHE_EXPIRY_DAYS}-day period)"
+        end
+      end
+
+      def handle_missing_cache(filename, url, cache_path, metadata_path)
+        if !@fetch
+          puts "Cache file or metadata missing for #{filename}. Skipping as fetch is disabled."
+        else
+          puts "Cache file or metadata missing for #{filename}. Downloading..."
+          download_file(url, cache_path, metadata_path)
+        end
+      end
+
+      def should_download?(url, cache_path, metadata_path)
+        return false unless @fetch
+
+        metadata = read_metadata(metadata_path)
+        headers = fetch_headers(url)
+        server_etag = headers["ETag"]
+
+        if server_etag
+          handle_etag(metadata, server_etag)
+        else
+          handle_no_etag(metadata)
+        end
+      end
+
+      def handle_etag(metadata, server_etag)
+        if metadata["etag"] && server_etag != metadata["etag"]
+          puts "ETag mismatch. Stored: #{metadata["etag"]}, Server: #{server_etag}"
+          true
+        else
+          false
+        end
+      end
+
+      def handle_no_etag(metadata)
+        puts "Server did not provide an ETag. Checking file age..."
+        file_older_than_days?(metadata["download_time"], CACHE_EXPIRY_DAYS)
+      end
+
+      def file_older_than_days?(download_time, days)
+        return true unless download_time
+
+        file_age = (Time.now - Time.parse(download_time)) / (24 * 60 * 60)
+        if file_age > days
+          puts "Cache file is older than #{days} days. Will download."
+          true
+        else
+          puts "Cache file is within #{days} days old. Using cached version."
+          false
+        end
+      end
+
+      def fetch_headers(url)
+        @client.head(url).headers
+      rescue Faraday::Error => e
+        puts "Error fetching headers for #{url}: #{e.message}"
+        {}
+      end
+
+      def download_file(url, cache_path, metadata_path)
+        puts "Downloading #{File.basename(cache_path)}..."
+        response = @client.get(url)
+
+        if response.success?
+          write_file_and_metadata(response, url, cache_path, metadata_path)
+        else
+          puts "Error downloading #{url}: HTTP #{response.status}"
+        end
+      rescue Faraday::Error => e
+        puts "Error downloading #{url}: #{e.message}"
+      end
+
+      def write_file_and_metadata(response, url, cache_path, metadata_path)
+        File.write(cache_path, response.body)
+
+        metadata = {
+          "url" => url,
+          "download_time" => Time.now.iso8601,
+          "etag" => response.headers["ETag"],
+        }
+
+        File.write(metadata_path, JSON.pretty_generate(metadata))
+        puts "Updated metadata for #{File.basename(cache_path)}"
+      end
+
+      def read_metadata(metadata_path)
+        File.exist?(metadata_path) ? JSON.parse(File.read(metadata_path)) : {}
+      rescue JSON::ParserError
+        puts "Error parsing metadata file. Treating as empty."
+        {}
+      end
+    end
+  end
+end

data/lib/glossarist/agent/iho/bilingual_table.rb

@@ -0,0 +1,60 @@
+require "shale"
+require "csv"
+
+require "shale/adapter/csv"
+unless Shale.csv_adapter
+  Shale.csv_adapter = Shale::Adapter::CSV
+end
+
+module Glossarist
+  module Agent
+    module Iho
+      class BilingualRow < Shale::Mapper
+        attribute :eng_id, Shale::Type::String
+        attribute :other_id, Shale::Type::String
+        attribute :eng_term, Shale::Type::String
+        attribute :other_term, Shale::Type::String
+        attribute :eng_definition, Shale::Type::String
+        attribute :other_definition, Shale::Type::String
+      end
+
+      class SimpleConcept < Shale::Mapper
+        attribute :id, Shale::Type::String
+        attribute :lang_code, Shale::Type::String
+        attribute :term, Shale::Type::String
+        attribute :definition, Shale::Type::String
+      end
+
+      class BilingualTable
+        attr_accessor :file_path, :rows, :lang_code, :concepts_eng, :concepts_other
+
+        def initialize(file_path:, lang_code:)
+          @file_path = file_path
+          @lang_code = lang_code
+        end
+
+        def process
+          # @rows = []
+          @rows = BilingualRow.from_csv(IO.read(@file_path))[1..-1]
+          @concepts_eng = @rows.map do |bilingual_row|
+            SimpleConcept.new(
+              lang_code: :eng,
+              id: bilingual_row.eng_id.strip,
+              term: bilingual_row.eng_term.strip,
+              definition: bilingual_row.eng_definition.strip,
+            )
+          end
+
+          @concepts_other = @rows.map do |bilingual_row|
+            SimpleConcept.new(
+              lang_code: lang_code,
+              id: bilingual_row.other_id.strip,
+              term: bilingual_row.other_term.strip,
+              definition: bilingual_row.other_definition.strip,
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/agent/iho/cli.rb

@@ -0,0 +1,28 @@
+require "thor"
+require_relative "downloader"
+require_relative "generator"
+
+module Glossarist
+  module Agent
+    module Iho
+      class Cli < Thor
+        desc "retrieve-concepts", "Download IHO CSV files and generate concepts"
+        option :output, type: :string, default: "./output", aliases: "-o", desc: "Directory to output generated files"
+        option :cache, type: :string, default: "~/.glossarist-agent/cache", aliases: "-c", desc: "Directory to store cached files"
+        option :fetch, type: :boolean, default: true, desc: "Fetch new data (default: true)"
+
+        def retrieve_concepts
+          cache_dir = File.expand_path(options[:cache])
+          output_dir = File.expand_path(options[:output])
+          fetch = options[:fetch]
+
+          downloader = Downloader.new(cache_dir, fetch: fetch)
+          downloader.download_csv_files
+
+          generator = Generator.new(cache_dir, output_dir)
+          generator.save_to_files
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/agent/iho/downloader.rb

@@ -0,0 +1,44 @@
+require_relative "../http_cache_downloader"
+
+module Glossarist
+  module Agent
+    module Iho
+      class Downloader
+        LANG_MAPPING = {
+          fra: {
+            "engFreView.csv" => "http://iho-ohi.net/S32/engFreView.php?operation=ecsv",
+          },
+          spa: {
+            "engEspView.csv" => "http://iho-ohi.net/S32/engEspView.php?operation=ecsv",
+          },
+          zho: {
+            "engChnView.csv" => "http://iho-ohi.net/S32/engChnView.php?operation=ecsv",
+          },
+          ind: {
+            "engIndView.csv" => "http://iho-ohi.net/S32/engIndView.php?operation=ecsv",
+          },
+        }.freeze
+
+        CSV_URLS = LANG_MAPPING.values.inject({}) do |acc, x|
+          acc.merge!(x)
+          acc
+        end
+
+        def initialize(cache_dir, fetch: true)
+          @cache_downloader = HttpCacheDownloader.new(cache_dir, fetch: fetch)
+        end
+
+        def download_csv_files
+          @cache_downloader.download_files(CSV_URLS)
+        end
+
+        def self.lang_code_by_filename(filename)
+          LANG_MAPPING.each do |lang_code, files|
+            return lang_code if files.key?(filename)
+          end
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/agent/iho/generator.rb

@@ -0,0 +1,116 @@
+require "glossarist"
+require_relative "bilingual_table"
+require_relative "downloader"
+
+module Glossarist
+  module Agent
+    module Iho
+      class Generator
+        attr_accessor :language_tables, :simple_concepts
+
+        def initialize(cache_dir, output_path)
+          @cache_dir = cache_dir
+          @output_path = output_path
+          FileUtils.mkdir_p(@output_path)
+        end
+
+        def collection
+          return @collection if @collection
+
+          parse_language_tables
+          build_simple_concepts
+          convert_to_glossarist
+
+          @collection
+        end
+
+        def parse_language_tables
+          return @language_tables if @language_tables
+
+          @language_tables = {}
+          Dir.glob(File.join(@cache_dir, "*.csv")).map do |file|
+            lang_code = Downloader.lang_code_by_filename(File.basename(file))
+
+            table = BilingualTable.new(file_path: file, lang_code: lang_code).tap do |table|
+              table.process
+            end
+
+            @language_tables[lang_code] = table
+          end
+
+          @language_tables
+        end
+
+        def build_simple_concepts
+          return @simple_concepts if @simple_concepts
+
+          @simple_concepts = {}
+          build_english_concepts
+          build_other_language_concepts
+          @simple_concepts
+        end
+
+        def convert_to_glossarist
+          @collection = ::Glossarist::ManagedConceptCollection.new
+          @collection.managed_concepts = create_managed_concepts
+        end
+
+        def save_to_files
+          collection.save_to_files(@output_path)
+          puts "Concepts generated and saved to #{@output_path}"
+        end
+
+        private
+
+        private
+
+        def build_english_concepts
+          @language_tables[:fra].concepts_eng.each do |concept|
+            @simple_concepts[concept.id] = { eng: concept_data(concept) }
+          end
+        end
+
+        def build_other_language_concepts
+          @language_tables.each do |lang_code, table|
+            table.concepts_other.each do |concept|
+              @simple_concepts[concept.id][lang_code] = concept_data(concept)
+            end
+          end
+        end
+
+        def concept_data(concept)
+          {
+            term: concept.term,
+            definition: concept.definition,
+          }
+        end
+
+        def create_managed_concepts
+          @simple_concepts.map do |id, localized_concepts|
+            create_managed_concept(id, localized_concepts)
+          end
+        end
+
+        def create_managed_concept(id, localized_concepts)
+          Glossarist::ManagedConcept.new(id: id).tap do |con|
+            localized_concepts.each do |lang_code, data|
+              con.add_localization(create_localized_concept(lang_code, data))
+            end
+          end
+        end
+
+        def create_localized_concept(lang_code, data)
+          Glossarist::LocalizedConcept.new(
+            "language_code" => lang_code.to_s,
+            "terms" => [{
+              "designation" => data[:term],
+              "type" => "expression",
+              "normative_status" => "preferred",
+            }],
+            "definition" => [{ "content" => data[:definition] }],
+          )
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/agent/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Agent
+    VERSION = "0.1.0"
+  end
+end

data/lib/glossarist/agent.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "agent/version"
+require_relative "agent/concept"
+require_relative "agent/collection"
+
+module Glossarist
+  module Agent
+    class Error < StandardError; end
+
+    # Your code goes here...
+  end
+end

data/lib/glossarist-agent.rb

@@ -0,0 +1 @@
+require_relative "glossarist/agent"

data/sig/glossarist/agent.rbs

@@ -0,0 +1,6 @@
+module Glossarist
+  module Agent
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: glossarist-agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shale
+  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: thor
+  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: csv
+  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: glossarist
+  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: faraday
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Glossarist component to retrieve content from remote sources
+email:
+- open.source@ribose.com
+executables:
+- glossarist-agent
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- README.adoc
+- Rakefile
+- exe/glossarist-agent
+- lib/glossarist-agent.rb
+- lib/glossarist/agent.rb
+- lib/glossarist/agent/cli.rb
+- lib/glossarist/agent/collection.rb
+- lib/glossarist/agent/concept.rb
+- lib/glossarist/agent/http_cache_downloader.rb
+- lib/glossarist/agent/iho/bilingual_table.rb
+- lib/glossarist/agent/iho/cli.rb
+- lib/glossarist/agent/iho/downloader.rb
+- lib/glossarist/agent/iho/generator.rb
+- lib/glossarist/agent/version.rb
+- sig/glossarist/agent.rbs
+homepage: https://github.com/glossarist/glossarist-agent
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/glossarist/glossarist-agent
+  source_code_uri: https://github.com/glossarist/glossarist-agent
+  changelog_uri: https://github.com/glossarist/glossarist-agent
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Glossarist component to retrieve content from remote sources
+test_files: []