dina 0.4.0.0 → 0.4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cae0ee74ed1a0967bb360af211c2ab37676dfdb39b54a377ec39b539e0f4301
-  data.tar.gz: 45ee9d1cda7f37da9fb5384690751dac5e5cc0fe30153cddf8306e11a20f7151
+  metadata.gz: 22dfd46dbbd51273c78e8b7375019e89cc503b13af20cf9abd17961c68809a56
+  data.tar.gz: f757ac80f3722120a738c40eae3bef2826ec8e3aac48af0645a94e34c091e1b7
 SHA512:
-  metadata.gz: 60a62ece7262ab086b88002497bd55f1ea04059b94468134b7c93d35a3349deff0c3ed58c45f634dd07a3149e4895da1525c215aef1895258beb62cf5af0aba5
-  data.tar.gz: dba63bace34688530c56cb56af702af39fe36bcb7ba86bf664b1192a7186ca51207ef9cef2deed311993671127772deb4f149f99fd90619ad56408dc379882a7
+  metadata.gz: 9a72ed340fed58472d60fe7b6c47e7e3fe339378d076c4636f53cb0d32d402b0e8a408c5123bcb79683824bcb6d3d9e55ca9f308d6bbaf820fd88769b8bf4db1
+  data.tar.gz: 98c98900dcfeeeb17ac1bad224c99ff80d56a060cf9096af16b4eb48e44584617eeaa82d2b4d7e29817256698ee36272c37d3cc65652b4e6b275e9caf91f7c65

data/lib/dina/models/person.rb

@@ -35,6 +35,26 @@ module Dina
       where("email": email).all
     end
 
+    def self.search_by_name(name)
+      payload = {
+        query: {
+          multi_match: {
+            query: name,
+            type: :cross_fields,
+            fields: [
+              "data.attributes.familyNames^3",
+              "data.attributes.givenNames",
+              "data.attributes.displayName^5",
+              "data.attributes.aliases",
+              "data.attributes.displayName.autocomplete"
+            ]
+          }
+        }
+      }
+      hits = Dina::Search.execute(index: "agent", payload: payload)[:hits]
+      hits.map{|a| self.find(a[:_source][:data][:id]).first }
+    end
+
     private
 
     def on_before_save

data/lib/dina/search/base_search.rb

@@ -2,26 +2,42 @@ module Dina
   class BaseSearch
 
     def self.endpoint
-      Settings.server.endpoint
+      Dina::Authentication.endpoint_url
     end
 
     def self.endpoint_path
       "search-api/search-ws/"
     end
 
+    # Sets the search index name
+    #
+    # @param index [String] the search index; options are "agent", "material_sample", "object_store"
+    #
+    # @return [String] the internally-recognized search index name
     def self.index_name(index:)
       return nil if !index
       "dina_#{index}_index"
     end
 
+    # Executes a search
+    #
+    # @param params [Hash] the parameters to be included in the endpoint URL
+    # @param method [Symbol] the request type as :get or :post
+    # @param payload [Hash] the elasticsearch query
+    #
+    # @return [Hash] the search response with symbolized keys
     def self.execute(params, method: :get, payload: {})
       begin
         response = RestClient::Request.execute(
-            method: method,
-            url: endpoint + endpoint_path + "?" + params.to_query,
-            payload: payload.to_json,
-            headers: { accept: 'application/json', content_type: 'application/json' }
-          )
+          method: method,
+          url: endpoint + endpoint_path + "?" + params.to_query,
+          payload: payload.to_json,
+          headers: {
+            accept: 'application/json',
+            content_type: 'application/json',
+            authorization: Dina::Authentication.header
+          }
+        )
         JSON.parse(response, symbolize_names: true)
       rescue RestClient::ExceptionWithResponse => e
         e.response

data/lib/dina/search/search.rb

@@ -7,8 +7,13 @@ module Dina
       "search-api/search-ws/search"
     end
 
-    # index values: "agent", "material_sample", "object_store"
-    # payload is a hash in the form of an Elasticsearch body
+    # Executes a search
+    #
+    # @param index [String] the index, accepted value is one of "agent", "material_sample", "object_store"
+    # @param payload [Hash] the payload hash as an Elasticsearch-formatted body
+    # => { query: { match_all: {} }
+    #
+    # @return [Hash] the search result with symbolized keys
     def self.execute(index:, payload: { query: { match_all: {} } })
       params = {
         indexName: index_name(index: index)

data/lib/dina/search/search_autocomplete.rb

@@ -7,11 +7,19 @@ module Dina
       "search-api/search-ws/auto-complete"
     end
 
-    # index values: "agent", "material_sample", "object_store"
-    # known autocomplete fields:
+    # Executes an autocomplete search
+    #
+    # Known field values (dependent on chosen index):
     #   agent: data.attributes.displayName
     #   material_sample: included.attributes.dwcRecordedBy, included.attributes.verbatimDeterminer
     #   object_store: none
+    #
+    # @param term [String] the search term
+    # @param index [String] the index, accepted value is one of "agent", "material_sample", "object_store"
+    # @param field [String]
+    # @param group [String] the DINA group name
+    #
+    # @return [Hash] the search result with symbolized keys
     def self.execute(term:, index:, field: nil, group: nil)
       params = {
         prefix: term,

data/lib/dina/search/search_count.rb

@@ -7,9 +7,14 @@ module Dina
       "search-api/search-ws/count"
     end
 
-    # index values: "agent", "material_sample", "object_store"
-    # Payload is a has like: {query: {bool: {filter: {term: {"data.attributes.group": "dao"}}}}}
-    def self.execute(index:, payload: {})
+    # Executes an count search
+    #
+    # @param index [String] the index, accepted value is one of "agent", "material_sample", "object_store"
+    # @param payload [Hash] the Elasticsearch query hash
+    # => Example: {query: {bool: {filter: {term: {"data.attributes.group": "dao"}}}}}
+    #
+    # @return [Integer] the count of items in the index according to the query/filter
+    def self.execute(index:, payload: { query: { match_all: {} }})
       params = {
         indexName: index_name(index: index)
       }

data/lib/dina/search/search_mapping.rb

@@ -7,7 +7,11 @@ module Dina
       "search-api/search-ws/mapping"
     end
 
-    # index values: "agent", "material_sample", "object_store"
+    # Return the search mapping document
+    #
+    # @param index [String] the index, accepted value is one of "agent", "material_sample", "object_store"
+    #
+    # @return [Hash] the mapping document as a hash with symbolized keys
     def self.execute(index:)
       params = {
         indexName: index_name(index: index)

data/lib/dina/version.rb

@@ -3,7 +3,7 @@ module Dina
 
     MAJOR = 0
     MINOR = 4
-    PATCH = 0
+    PATCH = 1
     BUILD = 0
 
     def self.version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dina
 version: !ruby/object:Gem::Version
-  version: 0.4.0.0
+  version: 0.4.1.0
 platform: ruby
 authors:
 - David P. Shorthouse
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-30 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement