dina 1.2.0.0 → 1.3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e1d7ef84d82908a0cfa2bacbf9b71dc311ec9a255b8a3598d292cd0997ef9e5
-  data.tar.gz: c2982683e2b041eae5b1978de2dbc4d72feaae334e67650168e31a430de9a7c7
+  metadata.gz: 36ae9a46adaaf1a545511c102afbc5bada1c3ad4632273672253f9191e347459
+  data.tar.gz: 67c1631fad9d7ebb3469a063fc6b22e1d6c9d720a8abe6804ae35c7d4dd83848
 SHA512:
-  metadata.gz: 8c0228419cb5b4cd6754e5de928198d346f13c11a2b7a589814c2be08e152e0cc1bd93de724fd9a9641e2eb9616f6b9a3e871ec1d15fc96aad12a64c28ba172d
-  data.tar.gz: 80396b5d6e83c16c7dff385d21b94ef9c86981e1b14f93b741b0c6501d9f38f6b9f1b8619883341420375568dbe58253b95c668416db3b0ac556da5d6bd79469
+  metadata.gz: ba219ae94560f594838864568429f8c84e4bf86a8c4396a0fd142c8803a0aea03f0da864b7bb9b44f700234d1da7dfbf9b75e6033ad1690fb5b13e69785700b1
+  data.tar.gz: cd564fa3198356107742862c2cc7d45b4c32dace7c3684117ccb9e29d97e066bb0c6fb60dd5ca8aa388afe66c11203fa9d6558efc9f68ee82824536aa076ef4d

data/lib/dina/models/object_store/file.rb

@@ -1,49 +1,7 @@
-module Dina
-
-  class FileConnection
-    def initialize(options = {})
-      site = options.fetch(:site)
-      connection_options = options.slice(:proxy, :ssl, :request, :headers, :params)
-      adapter_options = Array(options.fetch(:adapter, Faraday.default_adapter))
-
-      @faraday = Faraday.new(site, connection_options) do |builder|
-        builder.request :multipart
-        builder.use ::JsonApiClient::Middleware::ParseJson
-        builder.adapter(*adapter_options)
-      end
-      yield(self) if block_given?
-    end
+require_rel '../base_model'
+require_rel 'file_connection'
 
-    def run(request_method, path, params: nil, headers: {}, body: nil)
-      path = path + "/#{body[:data]["attributes"]["group"].downcase}"
-      if body[:data]["attributes"].key?("is_derivative")
-        path = path + "/derivative"
-      end
-      file_path = body[:data]["attributes"]["filePath"]
-      mime_type = body[:data]["attributes"]["dcFormat"]
-      file_name = body[:data]["attributes"]["fileName"]
-      
-      body[:file] = Faraday::Multipart::FilePart.new(
-        file_path,
-        mime_type,
-        file_name
-      )
-
-      response = @faraday.run_request(request_method, path, body, headers) do |request|
-        request.params.update(params) if params
-      end
-      attributes = response.body.dup
-      response.body["meta"] = {}
-      response.body["errors"] = []
-      response.body["data"] = { 
-        "id" => attributes["uuid"],
-        "type" => "file",
-        "relationships" => {},
-        "attributes" => attributes
-      }
-      response
-    end
-  end
+module Dina
 
   class File < BaseModel
     property :id, type: :string, default: SecureRandom.uuid

data/lib/dina/models/object_store/file_connection.rb

@@ -0,0 +1,50 @@
+require_rel '../base_model'
+
+module Dina
+
+    class FileConnection
+      def initialize(options = {})
+        site = options.fetch(:site)
+        connection_options = options.slice(:proxy, :ssl, :request, :headers, :params)
+        adapter_options = Array(options.fetch(:adapter, Faraday.default_adapter))
+  
+        @faraday = Faraday.new(site, connection_options) do |builder|
+          builder.request :multipart
+          builder.use ::JsonApiClient::Middleware::ParseJson
+          builder.adapter(*adapter_options)
+        end
+        yield(self) if block_given?
+      end
+  
+      def run(request_method, path, params: nil, headers: {}, body: nil)
+        path = path + "/#{body[:data]["attributes"]["group"].downcase}"
+        if body[:data]["attributes"].key?("is_derivative")
+          path = path + "/derivative"
+        end
+        file_path = body[:data]["attributes"]["filePath"]
+        mime_type = body[:data]["attributes"]["dcFormat"]
+        file_name = body[:data]["attributes"]["fileName"]
+        
+        body[:file] = Faraday::Multipart::FilePart.new(
+          file_path,
+          mime_type,
+          file_name
+        )
+  
+        response = @faraday.run_request(request_method, path, body, headers) do |request|
+          request.params.update(params) if params
+        end
+        attributes = response.body.dup
+        response.body["meta"] = {}
+        response.body["errors"] = []
+        response.body["data"] = { 
+          "id" => attributes["uuid"],
+          "type" => "file",
+          "relationships" => {},
+          "attributes" => attributes
+        }
+        response
+      end
+    end
+
+end

data/lib/dina/search/search.rb

@@ -1,25 +1,20 @@
-require_rel 'base_search'
+require_rel '../models/base_model'
+require_rel 'search_connection'
 
 module Dina
-  class Search < BaseSearch
+  class Search < BaseModel
+
+    self.connection_class = SearchConnection
+
+    custom_endpoint :execute, on: :collection, request_method: :post
 
     def self.endpoint_path
-      "search-api/search-ws/search"
+      "search-api/search-ws/"
     end
 
-    # 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)
-      }
-      super(params.compact, method: :post, payload: payload)[:hits]
+    def self.table_name
+      "search"
     end
 
   end
-end
+end

data/lib/dina/search/search_autocomplete.rb

@@ -1,34 +1,22 @@
-require_rel 'base_search'
+require_rel '../models/base_model'
+require_rel 'search_connection'
+
+#TODO: requires testing, likely failing
 
 module Dina
-  class SearchAutocomplete < BaseSearch
+  class SearchAutocomplete < BaseModel
+
+    self.connection_class = SearchConnection
+
+    custom_endpoint :execute, on: :collection, request_method: :post
 
     def self.endpoint_path
-      "search-api/search-ws/auto-complete"
+      "search-api/search-ws/"
     end
 
-    # 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,
-        indexName: index_name(index: index),
-        autoCompleteField: field,
-        group: group
-      }
-      super(params.compact)[:hits]
+    def self.table_name
+      "auto-complete"
     end
 
   end
-end
+end

data/lib/dina/search/search_connection.rb

@@ -0,0 +1,64 @@
+require_rel '../models/base_model'
+
+module Dina
+
+  class SearchConnection
+
+    attr_reader :faraday
+
+    def initialize(options = {})
+      site = options.fetch(:site)
+      connection_options = options.slice(:proxy, :ssl, :request, :headers, :params)
+      adapter_options = Array(options.fetch(:adapter, Faraday.default_adapter))
+
+      @faraday = Faraday.new(site, connection_options) do |builder|
+        builder.request :json
+        builder.use ::JsonApiClient::Middleware::ParseJson
+        builder.adapter(*adapter_options)
+      end
+      yield(self) if block_given?
+    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 index_name(index:)
+      return nil if !index
+      "dina_#{index}_index"
+    end
+
+    def custom_headers
+      { content_type: "application/json", authorization: Dina.header }
+    end
+
+    def run(request_method, path, params: nil, headers: {}, body: nil)
+      #TODO: works for search class, but likely failing for autocomplete, count, and mapping
+      params = {
+        indexName: index_name(index: body[:index])
+      }
+      path.slice!("/execute")
+      payload = JSON.generate(body[:payload]) rescue ""
+
+      response = faraday.run_request(request_method, path, body, headers) do |request|
+        request.params.update(params) if params
+        request.headers = custom_headers
+        request.body = payload
+      end
+
+      attributes = response.body.dup
+      response.body["meta"] = {}
+      response.body["errors"] = []
+      response.body["data"] = attributes["hits"]["hits"].map{|d| d["_source"]["data"]} rescue []
+      response
+    end
+
+    def use(middleware, *args, &block)
+      return if faraday.builder.locked?
+      faraday.builder.insert_before(Middleware::ParseJson, middleware, *args, &block)
+    end
+
+  end
+
+end

data/lib/dina/search/search_count.rb

@@ -1,25 +1,22 @@
-require_rel 'base_search'
+require_rel '../models/base_model'
+require_rel 'search_connection'
+
+#TODO: requires testing, likely failing
 
 module Dina
-  class SearchCount < BaseSearch
+  class SearchCount < BaseModel
+
+    self.connection_class = SearchConnection
+
+    custom_endpoint :execute, on: :collection, request_method: :post
 
     def self.endpoint_path
-      "search-api/search-ws/count"
+      "search-api/search-ws/"
     end
 
-    # 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)
-      }
-      super(params.compact, method: :post, payload: payload)[:count]
+    def self.table_name
+      "count"
     end
 
   end
-end
+end

data/lib/dina/search/search_mapping.rb

@@ -1,22 +1,21 @@
-require_rel 'base_search'
+require_rel '../models/base_model'
+require_rel 'search_connection'
+
+#TODO: requires testing, likely failing
 
 module Dina
-  class SearchMapping < BaseSearch
+  class SearchMapping < BaseModel
+
+    self.connection_class = SearchConnection
+
+    custom_endpoint :execute, on: :collection, request_method: :get
 
     def self.endpoint_path
-      "search-api/search-ws/mapping"
+      "search-api/search-ws/"
     end
 
-    # 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)
-      }
-      super(params.compact)
+    def self.table_name
+      "mapping"
     end
 
   end

data/lib/dina/version.rb

@@ -2,7 +2,7 @@ module Dina
   class Version
 
     MAJOR = 1
-    MINOR = 2
+    MINOR = 3
     PATCH = 0
     BUILD = 0
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dina
 version: !ruby/object:Gem::Version
-  version: 1.2.0.0
+  version: 1.3.0.0
 platform: ruby
 authors:
 - David P. Shorthouse
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -67,20 +67,6 @@ 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: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +184,7 @@ files:
 - lib/dina/models/material_sample/protocol.rb
 - lib/dina/models/object_store/derivative.rb
 - lib/dina/models/object_store/file.rb
+- lib/dina/models/object_store/file_connection.rb
 - lib/dina/models/object_store/object_store.rb
 - lib/dina/models/object_store/object_store_managed_attribute.rb
 - lib/dina/models/object_store/object_subtype.rb
@@ -213,9 +200,9 @@ files:
 - lib/dina/models/storage/storage_unit_type.rb
 - lib/dina/models/transaction/transaction.rb
 - lib/dina/models/user.rb
-- lib/dina/search/base_search.rb
 - lib/dina/search/search.rb
 - lib/dina/search/search_autocomplete.rb
+- lib/dina/search/search_connection.rb
 - lib/dina/search/search_count.rb
 - lib/dina/search/search_mapping.rb
 - lib/dina/utils/identifier.rb

data/lib/dina/search/base_search.rb

@@ -1,57 +0,0 @@
-module Dina
-  class BaseSearch < BaseModel
-
-    def self.verify_ssl
-      begin
-        connection_options[:ssl][:verify]
-      rescue
-        true
-      end
-    end
-
-    def self.endpoint
-      Dina.config.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',
-            authorization: Dina.header
-          },
-          verify_ssl: verify_ssl
-        )
-        JSON.parse(response, symbolize_names: true)
-      rescue RestClient::ExceptionWithResponse => e
-        e.response
-      end
-    end
-
-  end
-end