aspera-cli 4.27.2 → 4.27.4

data/lib/aspera/rest_list.rb

@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-module Aspera
-  # List and lookup methods for Rest
-  # To be included in classes inheriting Rest that require those methods.
-  module RestList
-    # `max`: special query parameter: max number of items for list command
-    MAX_ITEMS = 'max'
-    # `pmax`: special query parameter: max number of pages for list command
-    MAX_PAGES = 'pmax'
-
-    # Query entity by general search (read with parameter `q`)
-    #
-    # @param entity [String] Path of entity in API
-    # @param value [String] Value of field of searched entity
-    # @param field [String] Field of searched entity
-    # @param query [Hash] Optional additional search query parameters
-    # @return [Hash] A single entity matching the search, or an exception if not found or multiple found
-    def lookup_with_q(entity, value:, field: 'name', query: {})
-      Aspera.assert_type(query, Hash) { 'query' }
-      Aspera.assert_type(field, String) { 'field' }
-      # returns entities matching the query (it matches against several fields in case insensitive way)
-      # We don't do paging, as anyway, we look for only one match
-      matching_items = read(entity, query.merge({'q' => value}))
-      # API style: {totalcount:, ...} cspell: disable-line: TODO: is that total_count ?
-      # @type [Array<Hash{String => String}>]
-      matching_items = matching_items[entity] if matching_items.is_a?(Hash)
-      Aspera.assert_type(matching_items, Array)
-      case matching_items.length
-      when 1 then return matching_items.first
-      when 0 then raise EntityNotFound, %Q{No such #{entity}: "#{value}"}
-      else
-        # multiple case insensitive partial matches, try case insensitive full match
-        # (anyway AoC does not allow creation of 2 entities with same case insensitive field value)
-        value_matches = matching_items.select { |i| i[field].casecmp?(value) }
-        case value_matches.length
-        when 1 then return value_matches.first
-        when 0 then raise Error, "#{entity}: Multiple case insensitive partial match for: \"#{value}\" in #{matching_items.map { |i| i[field] }.join(', ')} but no case insensitive full match. Please be more specific or give exact #{field}."
-        else raise Error, "Two entities cannot have the same case insensitive #{field}: #{value_matches.map { |i| i[field] }}"
-        end
-      end
-    end
-
-    # Get a (full or partial) list of all entities of a given type.
-    # Using query: `offset` + `limit`
-    # And response `total_count`
-    # @param entity    [String,Symbol] API endpoint of entity to list
-    # @param items_key [String]        Key in the result to get the list of items (Default: same as `entity`)
-    # @param query     [Hash,nil]      Additional query parameters
-    # @return [Array<(Array<Hash>, Integer)>] items, total_count
-    def list_entities_limit_offset_total_count(
-      entity:,
-      operation: 'GET',
-      items_key: nil,
-      query: nil
-    )
-      entity = entity.to_s if entity.is_a?(Symbol)
-      items_key = entity.split('/').last if items_key.nil?
-      query = {} if query.nil?
-      Aspera.assert_type(entity, String)
-      Aspera.assert_type(items_key, String)
-      Aspera.assert_type(query, Hash)
-      Log.log.debug { "list_entities t=#{entity} k=#{items_key}" }
-      Log.dump(:query, query)
-      result = []
-      offset = 0
-      max_items = query.delete(MAX_ITEMS)
-      remain_pages = query.delete(MAX_PAGES)
-      # Merge default parameters, by default 100 per page
-      query = {'limit'=> PER_PAGE_DEFAULT}.merge(query)
-      total_count = nil
-      call_args = {
-        operation: operation,
-        subpath:   entity,
-        query:     query,
-        headers:   {'Accept' => Mime::JSON}
-      }
-      loop do
-        query['offset'] = offset
-        page_result = call(**call_args)
-        Aspera.assert_type(page_result[items_key], Array)
-        result.concat(page_result[items_key])
-        # Reach the limit set by user ?
-        if !max_items.nil? && (result.length >= max_items)
-          result = result.slice(0, max_items)
-          break
-        end
-        total_count ||= page_result['total_count']
-        break if result.length >= total_count
-        remain_pages -= 1 unless remain_pages.nil?
-        break if remain_pages == 0
-        offset += page_result[items_key].length
-        RestParameters.instance.spinner_cb.call("#{result.length} / #{total_count || '?'}")
-      end
-      RestParameters.instance.spinner_cb.call(action: :success)
-      return result, total_count
-    end
-
-    # Lookup an entity id from its name.
-    # Uses query `q` if `query` is `:default` and `field` is `name`.
-    # @param entity    [String] Type of entity to lookup, by default it is the path, and it is also the field name in result
-    # @param value     [String] Value to lookup
-    # @param field     [String] Field to match, by default it is `'name'`
-    # @param items_key [String] Key in the result to get the list of items (override entity)
-    # @param query     [Hash]   Additional query parameters (Default: `:default`)
-    def lookup_entity_by_field(entity:, value:, field: 'name', items_key: nil, query: :default)
-      if query.eql?(:default)
-        Aspera.assert_values(field, ['name']) { 'Default query field' }
-        query = {'q'=> value}
-      end
-      lookup_entity_generic(entity: entity, field: field, value: value) { list_entities_limit_offset_total_count(entity: entity, items_key: items_key, query: query).first }
-    end
-
-    # Lookup entity by field and value.
-    # Extracts a single result from the list returned by the block.
-    #
-    # @param entity [String] Type of entity to lookup (path, and by default it is also the field name in result)
-    # @param value  [String] Value to match against the field.
-    # @param field  [String] Field to match in the hashes (defaults to 'name').
-    # @yield []              A mandatory block that returns an Array of Hashes.
-    # @return [Hash] The unique matching object.
-    # @raise  [Cli::BadIdentifier] If 0 or >1 matches are found.
-    def lookup_entity_generic(entity:, value:, field: 'name')
-      Aspera.assert(block_given?, 'block required for lookup_entity_generic')
-      found = yield
-      Aspera.assert_array_all(found, Hash)
-      found = found.select { |i| i[field].eql?(value) }
-      return found.first if found.length.eql?(1)
-      raise Cli::BadIdentifier.new(entity, value, field: field, count: found.length)
-    end
-
-    PER_PAGE_DEFAULT = 1000
-    private_constant :PER_PAGE_DEFAULT
-    module_function :lookup_entity_generic
-  end
-end

data/lib/aspera/web_auth.rb

@@ -1,211 +0,0 @@
-# frozen_string_literal: true
-
-require 'aspera/web_server_simple'
-require 'aspera/assert'
-require 'erb'
-
-module Aspera
-  # servlet called on callback: it records the callback request
-  class WebAuthServlet < WEBrick::HTTPServlet::AbstractServlet
-    # @param server   [WEBrick::HTTPServer] the HTTP server instance
-    # @param web_auth [WebAuth]             the WebAuth instance to record the callback
-    def initialize(server, web_auth)
-      Log.log.debug('WebAuthServlet initialize')
-      super(server)
-      @web_auth = web_auth
-    end
-
-    def service(request, response)
-      Log.log.debug { "received request from browser #{request.request_method} #{request.path}" }
-      Aspera.assert_values(request.request_method, ['GET'], type: WEBrick::HTTPStatus::MethodNotAllowed) { 'HTTP verb' }
-      additional_info = @web_auth.signal_request(request)
-      response.status = 200
-      response.content_type = 'text/html'
-      response.body = <<~HTML
-        <!DOCTYPE html>
-        <html lang="en">
-        <head>
-        <meta name="viewport" content="width=device-width, initial-scale=1.0">
-        <link rel="icon" href="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMiIgaGVpZ2h0PSIzMiIgdmlld0JveD0iMCAwIDMyIDMyIiBmaWxsPSJub25lIiBzdHJva2U9IiMyMjIiIHN0cm9rZS13aWR0aD0iMyI+CiAgPGxpbmUgeDE9IjMiIHkxPSIzIiB4Mj0iMjkiIHkyPSIyOSIgIHN0cm9rZT0icmVkIi8+CiAgPGxpbmUgeDE9IjI5IiB5MT0iMyIgeDI9IjMiIHkyPSIyOSIgc3Ryb2tlPSJyZWQiIC8+Cjwvc3ZnPg==" type="image/svg+xml">
-        <title>Close Now</title>
-        <style>
-        body {
-        font-family: Arial, sans-serif;
-        text-align: center;
-        padding: 2rem;
-        margin: 0;
-        background: linear-gradient(135deg, #f0f4f8, #d9e2ec);
-        color: #333;
-        overflow: hidden; /* Ensure no scrollbars for the background animation */
-        position: relative;
-        }
-        h1 {
-        font-size: 2.5rem;
-        color: #0078d4;
-        }
-        p {
-        font-size: 1.2rem;
-        margin-top: 1rem;
-        }
-
-        /* Styling for animated IBM logos */
-        .logo {
-        position: absolute;
-        bottom: -100px;
-        width: 40px;
-        height: 40px;
-        background: none;
-        display: flex;
-        justify-content: center;
-        align-items: center;
-        animation: rise 10s infinite ease-in-out;
-        }
-
-        .logo svg {
-        width: 100%;
-        height: 100%;
-        }
-
-        .logo:nth-child(odd) {
-        animation-duration: 8s;
-        }
-
-        .logo:nth-child(even) {
-        animation-duration: 12s;
-        }
-
-        @keyframes rise {
-        0% {
-        transform: translateY(0) scale(1);
-        opacity: 1;
-        }
-        50% {
-        opacity: 0.7;
-        }
-        100% {
-        transform: translateY(-120vh) scale(0.7);
-        opacity: 0;
-        }
-        }
-        </style>
-        </head>
-        <body>
-        <h1>Thank You!</h1>
-        <p>You can close this window.</p>
-        <p>#{ERB::Util.html_escape(additional_info) unless additional_info.nil?}</p>
-
-        <!-- JavaScript to generate IBM logos -->
-        <script>
-        // Function to create logos dynamically
-        function createLogos() {
-        const body = document.body;
-        const svgContent = `
-        <svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="1000px" height="401.149px" viewBox="0 0 1000 401.149" xml:space="preserve">
-        <g>
-        <rect fill="#1F70C1" x="0" y="373.217" width="194.433" height="27.833"/>
-        <rect fill="#1F70C1" x="0" y="319.83" width="194.433" height="27.931"/>
-        <rect fill="#1F70C1" x="55.468" y="266.541" width="83.399" height="27.932"/>
-        <rect fill="#1F70C1" x="55.468" y="213.253" width="83.399" height="27.932"/>
-        <rect fill="#1F70C1" x="55.468" y="159.964" width="83.399" height="27.932"/>
-        <rect fill="#1F70C1" x="55.468" y="106.577" width="83.399" height="27.932"/>
-        <rect fill="#1F70C1" x="0" y="53.288" width="194.433" height="27.932"/>
-        <rect fill="#1F70C1" x="0" y="0" width="194.433" height="27.932"/>
-        <path fill="#1F70C1" d="M222.167,347.761h299.029c5.051-8.617,8.815-18.027,11.094-27.932H222.167V347.761z"/>
-        <path fill="#1F70C1" d="M497.92,213.253H277.734v27.932h243.463C514.857,230.487,507.032,221.078,497.92,213.253z"/>
-        <path fill="#1F70C1" d="M277.734,159.964v27.932H497.92c9.311-7.825,17.135-17.235,23.277-27.932H277.734z"/>
-        <path fill="#1F70C1" d="M521.197,53.288H222.167V81.22H532.29C529.715,71.315,525.951,61.906,521.197,53.288z"/>
-        <path fill="#1F70C1" d="M429.279,0H222.167v27.932h278.526C482.072,10.697,456.815,0,429.279,0z"/>
-        <rect fill="#1F70C1" x="277.734" y="106.577" width="83.3" height="27.932"/>
-        <path fill="#1F70C1" d="M444.433,134.509h87.163c2.476-8.914,3.764-18.324,3.764-27.932h-90.927z"/>
-        <rect fill="#1F70C1" x="277.734" y="266.541" width="83.3" height="27.932"/>
-        <path fill="#1F70C1" d="M444.433,266.541v27.932h90.927c0-9.608-1.288-19.017-3.764-27.932H444.433z"/>
-        <path fill="#1F70C1" d="M222.167,400.852h207.112c27.734,0,52.793-10.697,71.513-27.932H222.167V400.852z"/>
-        <rect fill="#1F70C1" x="555.567" y="373.217" width="138.866" height="27.833"/>
-        <rect fill="#1F70C1" x="555.567" y="319.83" width="138.866" height="27.931"/>
-        <rect fill="#1F70C1" x="611.034" y="266.541" width="83.399" height="27.932"/>
-        <rect fill="#1F70C1" x="611.034" y="213.253" width="83.399" height="27.932"/>
-        <polygon fill="#1F70C1" points="733.063,53.288 555.567,53.288 555.567,81.22 742.67,81.22"/>
-        <polygon fill="#1F70C1" points="714.639,0 555.567,0 555.567,27.932 724.247,27.932"/>
-        <rect fill="#1F70C1" x="861.034" y="373.217" width="138.866" height="27.833"/>
-        <rect fill="#1F70C1" x="861.034" y="319.83" width="138.866" height="27.931"/>
-        <rect fill="#1F70C1" x="861.034" y="266.541" width="83.399" height="27.932"/>
-        <rect fill="#1F70C1" x="861.034" y="213.253" width="83.399" height="27.932"/>
-        <polygon fill="#1F70C1" points="861.034,187.896 944.433,187.896 944.433,159.964 861.034,159.964 694.433,159.964 611.034,159.964 611.034,187.896 694.433,187.896 852.219,187.896"/>
-        <polygon fill="#1F70C1" points="944.433,106.577 803.982,106.577 794.374,134.509 944.433,134.509"/>
-        <polygon fill="#1F70C1" points="840.927,0 831.319,27.932 1000,27.932 1000,0"/>
-        <polygon fill="#1F70C1" points="777.734,400.852 787.341,373.217 768.126,373.217"/>
-        <polygon fill="#1F70C1" points="759.311,347.761 796.157,347.761 806.062,319.83 749.505,319.83"/>
-        <polygon fill="#1F70C1" points="740.59,294.473 814.877,294.473 824.683,266.541 730.784,266.541"/>
-        <polygon fill="#1F70C1" points="721.969,241.185 833.597,241.185 843.106,213.253 712.361,213.253"/>
-        <polygon fill="#1F70C1" points="611.034,134.509 761.093,134.509 751.486,106.577 611.034,106.577"/>
-        <polygon fill="#1F70C1" points="812.896,81.22 1000,81.22 1000,53.288 822.405,53.288"/>
-        </g>
-        </svg>
-        `;
-        for (let i = 0; i < 20; i++) {
-        const logo = document.createElement('div');
-        logo.className = 'logo';
-        const size = Math.random() * 30 + 20; // Random size between 20px and 50px
-        logo.style.width = `${size}px`;
-        logo.style.height = `${size}px`;
-        logo.style.left = `${Math.random() * 100}vw`;
-        logo.style.animationDelay = `${Math.random() * 5}s`;
-        logo.innerHTML = svgContent;
-        body.appendChild(logo);
-        }
-        }
-
-        // Call the function to create logos on load
-        createLogos();
-        </script>
-        </body>
-        </html>
-      HTML
-
-      return
-    end
-  end
-
-  # start a local web server
-  # then start a browser that will callback the local server upon authentication
-  # store the final query
-  class WebAuth < WebServerSimple
-    # @param endpoint_url     [String] e.g. 'https://127.0.0.1:12345'
-    # @param additional_info [String] Information in web page
-    def initialize(endpoint_url, additional_info = nil)
-      uri = URI.parse(endpoint_url)
-      super(uri)
-      @mutex = Mutex.new
-      @cond = ConditionVariable.new
-      @expected_path = uri.path.empty? ? '/' : uri.path
-      @query = nil
-      @additional_info = additional_info
-      # last argument (self) is provided to constructor of servlet
-      mount(@expected_path, WebAuthServlet, self)
-      # server runs in thread
-      Thread.new { start }
-    end
-
-    # Called by web server thread on received request
-    # @return [String] additional information for web page
-    def signal_request(request)
-      raise WEBrick::HTTPStatus::NotFound, "unexpected path: #{request.path}" unless request.path.eql?(@expected_path)
-      # acquire lock and signal change
-      @mutex.synchronize do
-        @query = request.query
-        @cond.signal
-      end
-      return @additional_info
-    end
-
-    # wait for request on web server (main thread)
-    # @return [Hash] the query
-    def received_request
-      # wait for signal from thread
-      @mutex.synchronize { @cond.wait(@mutex) }
-      # tell server thread to stop
-      shutdown
-      return @query
-    end
-  end
-end