rospatent 1.0.0

data/lib/rospatent.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require_relative "rospatent/version"
+require_relative "rospatent/configuration"
+require_relative "rospatent/input_validator"
+require_relative "rospatent/cache"
+require_relative "rospatent/logger"
+require_relative "rospatent/patent_parser"
+require_relative "rospatent/client"
+require_relative "rospatent/search"
+require_relative "rospatent/errors"
+
+# Load Rails integration if Rails is available
+require_relative "rospatent/railtie" if defined?(Rails)
+
+# Main module for the Rospatent API client
+module Rospatent
+  class << self
+    attr_writer :configuration
+
+    # Returns the current configuration
+    # @return [Rospatent::Configuration] Current configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configure the gem
+    # @yield [config] Configuration block
+    # @yieldparam [Rospatent::Configuration] config The configuration object
+    def configure
+      yield(configuration)
+    end
+
+    # Creates a new client instance
+    # @param token [String] API token (optional if already set in configuration)
+    # @param logger [Rospatent::Logger] Custom logger instance (optional)
+    # @param cache [Rospatent::Cache] Custom cache instance (optional)
+    # @param options [Hash] Additional client options
+    # @return [Rospatent::Client] A new client instance
+    def client(token = nil, logger: nil, cache: nil, **)
+      Client.new(token: token, logger: logger, cache: cache, **)
+    end
+
+    # Create a shared cache instance
+    # @param ttl [Integer] Time to live in seconds
+    # @param max_size [Integer] Maximum cache size
+    # @return [Rospatent::Cache] Shared cache instance
+    def shared_cache(ttl: nil, max_size: nil)
+      @shared_cache ||= Cache.new(
+        ttl: ttl || configuration.cache_ttl,
+        max_size: max_size || configuration.cache_max_size
+      )
+    end
+
+    # Create a shared logger instance
+    # @param level [Symbol] Log level
+    # @param formatter [Symbol] Log formatter (:json or :text)
+    # @return [Rospatent::Logger] Shared logger instance
+    def shared_logger(level: nil, formatter: nil)
+      @shared_logger ||= Logger.new(
+        level: level || configuration.log_level,
+        formatter: formatter || (configuration.environment == "production" ? :json : :text)
+      )
+    end
+
+    # Reset the configuration to defaults
+    def reset
+      @configuration = Configuration.new
+      @shared_cache = nil
+      @shared_logger = nil
+    end
+
+    # Clear all shared resources
+    def clear_shared_resources
+      @shared_cache&.clear
+      @shared_cache = nil
+      @shared_logger = nil
+    end
+
+    # Get global statistics (if shared cache is being used)
+    # @return [Hash] Global usage statistics
+    def statistics
+      cache_stats = @shared_cache&.statistics || { size: 0, hits: 0, misses: 0 }
+
+      {
+        configuration: {
+          environment: configuration.environment,
+          cache_enabled: configuration.cache_enabled,
+          api_url: configuration.effective_api_url
+        },
+        cache: cache_stats,
+        shared_resources: {
+          cache_initialized: !@shared_cache.nil?,
+          logger_initialized: !@shared_logger.nil?
+        }
+      }
+    end
+
+    # Validate the current configuration
+    # @return [Array<String>] Array of validation errors (empty if valid)
+    def validate_configuration
+      errors = []
+
+      unless configuration.valid_environment?
+        errors << "Invalid environment: #{configuration.environment}"
+      end
+
+      errors << "API token is required" if configuration.token.nil? || configuration.token.empty?
+
+      errors << "Timeout must be positive" if configuration.timeout <= 0
+
+      errors << "Retry count cannot be negative" if configuration.retry_count.negative?
+
+      errors
+    end
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: rospatent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aleksandr Dryzhuk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: A comprehensive Ruby client for interacting with the Rospatent patent
+  search API. Features include automatic caching, request validation, structured logging,
+  error handling, and batch operations for efficient patent data retrieval.
+email:
+- dev@ad-it.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/generators/rospatent/install/install_generator.rb
+- lib/generators/rospatent/install/templates/README
+- lib/generators/rospatent/install/templates/initializer.rb
+- lib/rospatent.rb
+- lib/rospatent/cache.rb
+- lib/rospatent/client.rb
+- lib/rospatent/configuration.rb
+- lib/rospatent/errors.rb
+- lib/rospatent/input_validator.rb
+- lib/rospatent/logger.rb
+- lib/rospatent/patent_parser.rb
+- lib/rospatent/railtie.rb
+- lib/rospatent/search.rb
+- lib/rospatent/version.rb
+homepage: https://hub.mos.ru/ad/rospatent
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://hub.mos.ru/ad/rospatent
+  source_code_uri: https://hub.mos.ru/ad/rospatent
+  changelog_uri: https://hub.mos.ru/ad/rospatent/blob/main/CHANGELOG.md
+  documentation_uri: https://hub.mos.ru/ad/rospatent/blob/main/README.md
+  bug_tracker_uri: https://hub.mos.ru/ad/rospatent/issues
+  wiki_uri: https://hub.mos.ru/ad/rospatent/wiki
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby client for Rospatent API with caching and validation
+test_files: []