rospatent 1.1.0 → 1.3.0

data/lib/rospatent/search.rb

@@ -41,14 +41,14 @@ module Rospatent
     # @param qn [String] Natural language search query
     # @param limit [Integer] Maximum number of results to return
     # @param offset [Integer] Offset for pagination
-    # @param pre_tag [String] HTML tag to prepend to highlighted matches
-    # @param post_tag [String] HTML tag to append to highlighted matches
+    # @param pre_tag [String, Array<String>] HTML tag(s) to prepend to highlighted matches
+    # @param post_tag [String, Array<String>] HTML tag(s) to append to highlighted matches
     # @param sort [Symbol, String] Sort option (:relevance, :pub_date, :filing_date)
-    # @param group_by [Symbol, String] Grouping option (:patent_family)
+    # @param group_by [String] Grouping option ("family:docdb", "family:dwpi")
     # @param include_facets [Boolean] Whether to include facet information
     # @param filter [Hash] Filters to apply to the search
     # @param datasets [Array<String>] Datasets to search within
-    # @param highlight [Boolean] Whether to highlight matches
+    # @param highlight [Hash] Advanced highlight configuration with profiles
     #
     # @return [Rospatent::SearchResult] Search result object
     def execute(
@@ -111,31 +111,35 @@ module Rospatent
       end
 
       # Validate highlighting parameters (only if provided)
-      if params.key?(:highlight)
-        validated[:highlight] = !!params[:highlight]
-        if params[:highlight] && params[:pre_tag]
-          validated[:pre_tag] =
-            validate_string(params[:pre_tag], "pre_tag", max_length: 50)
-        end
-        if params[:highlight] && params[:post_tag]
-          validated[:post_tag] =
-            validate_string(params[:post_tag], "post_tag", max_length: 50)
+      # pre_tag and post_tag must be provided together
+      if params[:pre_tag] || params[:post_tag]
+        unless params[:pre_tag] && params[:post_tag]
+          raise Errors::ValidationError,
+                "Both pre_tag and post_tag must be provided together for highlighting"
         end
+
+        validated[:pre_tag] =
+          validate_string_or_array(params[:pre_tag], "pre_tag", max_length: 50, max_size: 10)
+        validated[:post_tag] =
+          validate_string_or_array(params[:post_tag], "post_tag", max_length: 50, max_size: 10)
       end
 
+      # Validate highlight parameter (complex object for advanced highlighting)
+      validated[:highlight] = validate_hash(params[:highlight], "highlight") if params[:highlight]
+
       # Validate sort parameter (only if provided)
       validated[:sort] = validate_sort_parameter(params[:sort]) if params[:sort]
 
       # Validate group_by parameter (only if provided)
       if params[:group_by]
-        validated[:group_by] = validate_enum(params[:group_by], [:patent_family], "group_by")
+        validated[:group_by] = validate_string_enum(params[:group_by], %w[family:docdb family:dwpi], "group_by")
       end
 
       # Validate boolean parameters (only if provided)
       validated[:include_facets] = !params[:include_facets].nil? if params.key?(:include_facets)
 
       # Validate filter parameter
-      validated[:filter] = validate_hash(params[:filter], "filter") if params[:filter]
+      validated[:filter] = validate_filter(params[:filter], "filter") if params[:filter]
 
       # Validate datasets parameter
       if params[:datasets]
@@ -161,18 +165,20 @@ module Rospatent
       payload[:limit] = params[:limit] if params[:limit]
       payload[:offset] = params[:offset] if params[:offset]
 
-      # Add highlighting parameters (only if explicitly provided)
-      if params.key?(:highlight)
-        payload[:highlight] = params[:highlight]
-        payload[:pre_tag] = params[:pre_tag] if params[:pre_tag]
-        payload[:post_tag] = params[:post_tag] if params[:post_tag]
+      # Add highlighting tags (only if both are provided)
+      if params[:pre_tag] && params[:post_tag]
+        payload[:pre_tag] = params[:pre_tag]
+        payload[:post_tag] = params[:post_tag]
       end
 
+      # Add advanced highlight parameter (independent of tags)
+      payload[:highlight] = params[:highlight] if params[:highlight]
+
       # Add sort parameter (only if explicitly provided)
       payload[:sort] = params[:sort] if params[:sort]
 
       # Add grouping parameter (only if explicitly provided)
-      payload[:group_by] = "patent_family" if params[:group_by] == :patent_family
+      payload[:group_by] = params[:group_by] if params[:group_by]
 
       # Add other parameters (only if explicitly provided)
       payload[:include_facets] = params[:include_facets] if params.key?(:include_facets)

data/lib/rospatent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rospatent
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rospatent
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Aleksandr Dryzhuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-04 00:00:00.000000000 Z
+date: 2025-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -72,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.59'
+        version: '1.76'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.59'
+        version: '1.76'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.34'
+        version: '0.38'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.34'
+        version: '0.38'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 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.
@@ -140,8 +140,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/amdest/rospatent
   source_code_uri: https://github.com/amdest/rospatent
-  changelog_uri: https://github.com/amdest/rospatent/blob/main/CHANGELOG.md
-  documentation_uri: https://github.com/amdest/rospatent/blob/main/README.md
+  changelog_uri: https://github.com/amdest/rospatent/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/amdest/rospatent/blob/master/README.md
   bug_tracker_uri: https://github.com/amdest/rospatent/issues
   wiki_uri: https://github.com/amdest/rospatent/wiki
   rubygems_mfa_required: 'true'