bb6442c4-eb43-430c-9683-6ffb5848882a

Committed 21 Oct 2025 08:43PM UTC coverage: 87.325% (+0.4%) from 86.877%

Build # bb6442c4-eb43-430c-9683-6ffb5848882a

Build Type

Pull #2066

circleci

Committed by

bess

Commit Message

Stop mediaflux when we stop everything else

Pull Request Pull Request #2066: Stop mediaflux when we stop everything else

Run Details

2625 of 3006 relevant lines covered (87.33%)

307.22 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.67

/app/models/mediaflux/query_request.rb

# frozen_string_literal: true
module Mediaflux
  class QueryRequest < Request
    attr_reader :aql_query, :collection, :action, :deep_search, :iterator

    # Constructor
    # @param session_token [String] the API token for the authenticated session
    # @param aql_query [String] Optional AQL query string
    # @param collection [Integer] Optional collection id
    # @param action [String] Optional, by default it uses get-name but it could also be get-meta to get all
    #                        the fields for the assets or `get-values` to get a limited list of fields.
    # @param deep_search [Bool] Optional, false by default. When true queries the collection and it subcollections.
    # @param iterator [Bool] Optional, true by default. When true returns an iterator.  When false returns a list of results
    def initialize(session_token:, aql_query: nil, collection: nil, action: "get-values", deep_search: false, iterator: true)
      super(session_token: session_token)
      @aql_query = aql_query
      @collection = collection
      @action = action
      @deep_search = deep_search
      @iterator = iterator
    end

    # Specifies the Mediaflux service to use when running a query
    # @return [String]
    def self.service
      "asset.query"
    end

    # Returns the iterator that could be used to fetch the data
    def result
      xml = response_xml
      xml.xpath("/response/reply/result/iterator").text.to_i
    end

    def result_items
      xml = response_xml
      xml.xpath("/response/reply/result").children.map do |node|
        {
          id: node.xpath("./@id").text,
          name: node.xpath("./name").text,
          path: node.xpath("./path").text
        }
      end
    end

    private

      def build_http_request_body(name:)
        super do |xml|
          xml.args do
            # TODO: there is a bug in mediaflux that does not allow the comented out line to paginate
            #      For the moment we will utilize the where clasue that does allow pagination
            # xml.collection collection if collection.present?
            if collection.present?
              xml.where mf_where(collection)
            end
            xml.where aql_query if aql_query.present?
            xml.action action if action.present?
            declare_get_values_fields(xml) if action == "get-values"
            xml.as "iterator" if iterator
          end
        end
      end

      def mf_where(collection)
        if deep_search
          "asset in static collection or subcollection of #{collection}"
        else
          "asset in collection #{collection}"
        end
      end

      # Adds the declarations to fetch specific fields
      def declare_get_values_fields(xml)
        declare_get_value_field(xml, "name", "name")
        declare_get_value_field(xml, "path", "path")
        declare_get_value_field(xml, "content/@total-size", "total-size")
        declare_get_value_field(xml, "mtime", "mtime")
        declare_get_value_field(xml, "@collection", "collection")
      end

      # Adds a single field declaration
      def declare_get_value_field(xml, field_xpath, field_name)
        xml.xpath do
          xml.parent.set_attribute("ename", field_name)
          xml.text(field_xpath)
        end
      end
  end
end

1	# frozen_string_literal: true
2	module Mediaflux	4✔
3	class QueryRequest < Request	4✔
4	attr_reader :aql_query, :collection, :action, :deep_search, :iterator	4✔
5
6	# Constructor
7	# @param session_token [String] the API token for the authenticated session
8	# @param aql_query [String] Optional AQL query string
9	# @param collection [Integer] Optional collection id
10	# @param action [String] Optional, by default it uses get-name but it could also be get-meta to get all
11	# the fields for the assets or `get-values` to get a limited list of fields.
12	# @param deep_search [Bool] Optional, false by default. When true queries the collection and it subcollections.
13	# @param iterator [Bool] Optional, true by default. When true returns an iterator. When false returns a list of results
14	def initialize(session_token:, aql_query: nil, collection: nil, action: "get-values", deep_search: false, iterator: true)	4✔
15	super(session_token: session_token)	51✔
16	@aql_query = aql_query	51✔
17	@collection = collection	51✔
18	@action = action	51✔
19	@deep_search = deep_search	51✔
20	@iterator = iterator	51✔
21	end
22
23	# Specifies the Mediaflux service to use when running a query
24	# @return [String]
25	def self.service	4✔
26	"asset.query"	102✔
27	end
28
29	# Returns the iterator that could be used to fetch the data
30	def result	4✔
31	xml = response_xml	40✔
32	xml.xpath("/response/reply/result/iterator").text.to_i	40✔
33	end
34
35	def result_items	4✔
36	xml = response_xml	10✔
37	xml.xpath("/response/reply/result").children.map do \|node\|	10✔
38	{
39	id: node.xpath("./@id").text,	11✔
40	name: node.xpath("./name").text,
41	path: node.xpath("./path").text
42	}
43	end
44	end
45
46	private	4✔
47
48	def build_http_request_body(name:)	4✔
49	super do \|xml\|	102✔
50	xml.args do	102✔
51	# TODO: there is a bug in mediaflux that does not allow the comented out line to paginate
52	# For the moment we will utilize the where clasue that does allow pagination
53	# xml.collection collection if collection.present?
54	if collection.present?	102✔
55	xml.where mf_where(collection)	72✔
56	end
57	xml.where aql_query if aql_query.present?	102✔
58	xml.action action if action.present?	102✔
59	declare_get_values_fields(xml) if action == "get-values"	102✔
60	xml.as "iterator" if iterator	102✔
61	end
62	end
63	end
64
65	def mf_where(collection)	4✔
66	if deep_search	72✔
67	"asset in static collection or subcollection of #{collection}"	72✔
68	else
69	"asset in collection #{collection}"	×
70	end
71	end
72
73	# Adds the declarations to fetch specific fields
74	def declare_get_values_fields(xml)	4✔
75	declare_get_value_field(xml, "name", "name")	100✔
76	declare_get_value_field(xml, "path", "path")	100✔
77	declare_get_value_field(xml, "content/@total-size", "total-size")	100✔
78	declare_get_value_field(xml, "mtime", "mtime")	100✔
79	declare_get_value_field(xml, "@collection", "collection")	100✔
80	end
81
82	# Adds a single field declaration
83	def declare_get_value_field(xml, field_xpath, field_name)	4✔
84	xml.xpath do	500✔
85	xml.parent.set_attribute("ename", field_name)	500✔
86	xml.text(field_xpath)	500✔
87	end
88	end
89	end
90	end

pulibrary / tigerdata-app / bb6442c4-eb43-430c-9683-6ffb5848882a

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous