3d88d2e1-809d-4b21-a053-6167ddb1e670

Committed 06 Nov 2025 03:55PM UTC coverage: 91.201% (+10.5%) from 80.673%

Build # 3d88d2e1-809d-4b21-a053-6167ddb1e670

Build Type

push

circleci

Committed by

web-flow

Commit Message

Fixed link, replaced image, added a test (#2158)

Closes #2156 and #2141

Run Details

2840 of 3114 relevant lines covered (91.2%)

1092.36 hits per line

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

92.86

/app/models/mediaflux/iterator_request.rb

# frozen_string_literal: true
module Mediaflux
  class IteratorRequest < Request
    # Constructor
    # @param session_token [String] the API token for the authenticated session
    # @iterator [Int] The iterator returned by Mediaflux (via QueryRequest)
    def initialize(session_token:, iterator:, action: "get-values", size: nil)
      super(session_token: session_token)
      @iterator = iterator
      @size = size
      @action = action
    end

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

    # Returns hash with the files fetched in this iteration as well as a flag on whether we are
    # done iterating (complete=true) or if we need to keep iterating
    def result
      xml = response_xml
      {
        files: parse_files(xml),
        complete: xml.xpath("/response/reply/result/iterated/@complete").text == "true",
        count: xml.xpath("/response/reply/result/iterated").text.to_i
      }
    end

    private

      def build_http_request_body(name:)
        super do |xml|
          xml.args do
            xml.id @iterator
            xml.size @size if @size.present?
          end
        end
      end

      def parse_files(xml)
        case @action
        when "get-name"
          parse_get_name(xml)
        when "get-meta"
          parse_get_meta(xml)
        when "get-values"
          parse_get_values(xml)
        else
          raise "Cannot parse result. Unknow action: #{@action}."
        end
      end

      # Extracts file information when the request was made with the "action: get-name" parameter
      def parse_get_name(xml)
        files = []
        xml.xpath("/response/reply/result/name").each do |node|
          file = Mediaflux::Asset.new(
            id: node.xpath("./@id").text,
            name: node.text,
            collection: node.xpath("./@collection").text == "true"
          )
          files << file
        end
        files
      end

      # Extracts file information when the request was made with the "action: get-meta" parameter
      def parse_get_meta(xml)
        files = []
        xml.xpath("/response/reply/result/asset").each do |node|
          file = Mediaflux::Asset.new(
            id: node.xpath("./@id").text,
            name: node.xpath("./name").text,
            path: node.xpath("./path").text,
            collection: node.xpath("./@collection").text == "true",
            size: node.xpath("./content/@total-size").text.to_i,
            last_modified_mf: node.xpath("mtime").text
          )
          files << file
        end
        files
      end

      # Extracts file information when the request was made with the "action: get-values" parameter
      # Notice that this code is coupled with the fields defined in QueryRequest.
      def parse_get_values(xml)
        files = []
        xml.xpath("/response/reply/result/asset").each do |node|
          file = Mediaflux::Asset.new(
            id: node.xpath("./@id").text,
            name: node.xpath("./name").text,
            path: node.xpath("./path").text,
            collection: node.xpath("./collection").text == "true",
            size: node.xpath("./total-size").text.to_i,
            last_modified_mf: node.xpath("mtime").text
          )
          files << file
        end
        files
      end
  end
end

1	# frozen_string_literal: true
2	module Mediaflux	6✔
3	class IteratorRequest < Request	6✔
4	# Constructor
5	# @param session_token [String] the API token for the authenticated session
6	# @iterator [Int] The iterator returned by Mediaflux (via QueryRequest)
7	def initialize(session_token:, iterator:, action: "get-values", size: nil)	6✔
8	super(session_token: session_token)	92✔
9	@iterator = iterator	92✔
10	@size = size	92✔
11	@action = action	92✔
12	end
13
14	# Specifies the Mediaflux service to use when running a query
15	# @return [String]
16	def self.service	6✔
17	"asset.query.iterate"	184✔
18	end
19
20	# Returns hash with the files fetched in this iteration as well as a flag on whether we are
21	# done iterating (complete=true) or if we need to keep iterating
22	def result	6✔
23	xml = response_xml	92✔
24	{
25	files: parse_files(xml),	92✔
26	complete: xml.xpath("/response/reply/result/iterated/@complete").text == "true",
27	count: xml.xpath("/response/reply/result/iterated").text.to_i
28	}
29	end
30
31	private	6✔
32
33	def build_http_request_body(name:)	6✔
34	super do \|xml\|	184✔
35	xml.args do	184✔
36	xml.id @iterator	184✔
37	xml.size @size if @size.present?	184✔
38	end
39	end
40	end
41
42	def parse_files(xml)	6✔
43	case @action	92✔
44	when "get-name"
45	parse_get_name(xml)	2✔
46	when "get-meta"
47	parse_get_meta(xml)	2✔
48	when "get-values"
49	parse_get_values(xml)	88✔
50	else
51	raise "Cannot parse result. Unknow action: #{@action}."	×
52	end
53	end
54
55	# Extracts file information when the request was made with the "action: get-name" parameter
56	def parse_get_name(xml)	6✔
57	files = []	2✔
58	xml.xpath("/response/reply/result/name").each do \|node\|	2✔
59	file = Mediaflux::Asset.new(	×
60	id: node.xpath("./@id").text,
61	name: node.text,
62	collection: node.xpath("./@collection").text == "true"
63	)
64	files << file	×
65	end
66	files	2✔
67	end
68
69	# Extracts file information when the request was made with the "action: get-meta" parameter
70	def parse_get_meta(xml)	6✔
71	files = []	2✔
72	xml.xpath("/response/reply/result/asset").each do \|node\|	2✔
73	file = Mediaflux::Asset.new(	4✔
74	id: node.xpath("./@id").text,
75	name: node.xpath("./name").text,
76	path: node.xpath("./path").text,
77	collection: node.xpath("./@collection").text == "true",
78	size: node.xpath("./content/@total-size").text.to_i,
79	last_modified_mf: node.xpath("mtime").text
80	)
81	files << file	4✔
82	end
83	files	2✔
84	end
85
86	# Extracts file information when the request was made with the "action: get-values" parameter
87	# Notice that this code is coupled with the fields defined in QueryRequest.
88	def parse_get_values(xml)	6✔
89	files = []	88✔
90	xml.xpath("/response/reply/result/asset").each do \|node\|	88✔
91	file = Mediaflux::Asset.new(	428✔
92	id: node.xpath("./@id").text,
93	name: node.xpath("./name").text,
94	path: node.xpath("./path").text,
95	collection: node.xpath("./collection").text == "true",
96	size: node.xpath("./total-size").text.to_i,
97	last_modified_mf: node.xpath("mtime").text
98	)
99	files << file	428✔
100	end
101	files	88✔
102	end
103	end
104	end

pulibrary / tigerdata-app / 3d88d2e1-809d-4b21-a053-6167ddb1e670

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