open_topo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 818d3b1e23f9cce9865b4efc13c0f536341c27788eff7b95d504004d09158b9c
+  data.tar.gz: 82d26068b2ced4d8ff585afe47600291a2d16a75376d02a867119930e55eb589
+SHA512:
+  metadata.gz: a488cecaf0bf2268228e83a52c600e2eb9db76678d58d008ff4d658160acf3582a8b7ec1ba688124058f38af542433a7c1fe2c24b7e825e47e01ebe3034f9b79
+  data.tar.gz: ea3719db6d89955d4fe41063d0594e0163112e16479880b6b2eb24c1b8728c41083f71d86bd239379121164a5ac9d0331b057f5e1ec51cace4fd371a12e9061f

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-08-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"open_topo" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["horolskyandrey@gmail.com"](mailto:"horolskyandrey@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 andrew-kh8
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/open_topo/catalog.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+module OpenTopo
+  class Catalog
+    attr_reader :full_name, :name, :url, :date_created, :temporal_coverage, :unit
+
+    def initialize(full_name:, name:, url:, date_created:, temporal_coverage:, unit: "meter")
+      @full_name = full_name
+      @name = name
+      @url = url
+      @date_created = date_created
+      @temporal_coverage = temporal_coverage
+      @unit = unit
+    end
+  end
+end

data/lib/open_topo/client.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  class Client
+    API_KEY_NAME = "OPEN_TOPOGRAPHY_API_KEY"
+
+    def initialize(api_key = nil)
+      api_key ||= ENV.fetch(API_KEY_NAME)
+      @request = Net::Request.new(api_key)
+    end
+
+    def globaldem(south:, north:, west:, east:, demtype: :srtmgl3, output_format: :tif)
+      params = Net::Params::GlobaldemParams.new(south:, north:, west:, east:, demtype:, output_format:)
+      params.validate!
+
+      response = request.globaldem(params)
+
+      if response.success?
+        Services::ResponseToDemConverter.call(response, dem_type: demtype, output_format:)
+      else
+        raise ::OpenTopo::Errors::ResponseError, response.body
+      end
+    end
+
+    def usgsdem(south:, north:, west:, east:, dataset_name: :usgs10m, output_format: :tif)
+      params = Net::Params::UsgsdemParams.new(south:, north:, west:, east:, dataset_name:, output_format:)
+      params.validate!
+
+      response = request.usgsdem(params)
+
+      if response.success?
+        Services::ResponseToDemConverter.call(response, dem_type: dataset_name, output_format:)
+      else
+        raise ::OpenTopo::Errors::ResponseError, response.body
+      end
+    end
+
+    def elevation(long:, lat:, dataset: :srtmgl3)
+      params = Net::Params::ElevationParams.new(long:, lat:, dataset:)
+      params.validate!
+
+      response = request.elevation(params)
+
+      if response.success?
+        Services::ResponseToPointConverter.call(response)
+      else
+        raise ::OpenTopo::Errors::ResponseError, response.body
+      end
+    end
+
+    def catalog(west: nil, south: nil, east: nil, north: nil, polygon: nil)
+      params = Net::Params::CatalogParams.new(west:, south:, east:, north:, polygon:)
+      params.validate!
+
+      response = request.catalog(params)
+
+      if response.success?
+        Services::ResponseToCatalogListConverter.call(response.body)
+      else
+        raise ::OpenTopo::Errors::ResponseError, response.body
+      end
+    end
+
+    private
+
+    attr_reader :request
+  end
+end

data/lib/open_topo/dem_file.rb

@@ -0,0 +1,23 @@
+# typed: strict
+# frozen_string_literal: true
+
+module OpenTopo
+  class DemFile
+    attr_reader :original_file
+    alias_method :file, :original_file
+
+    attr_reader :dem_type
+
+    attr_reader :output_format
+
+    def initialize(original_file:, dem_type:, output_format:)
+      @original_file = original_file
+      @dem_type = dem_type
+      @output_format = output_format
+    end
+
+    def convert_to(format, file_path: nil)
+      Services::DemConverter.call(original_file, format, file_path: file_path)
+    end
+  end
+end

data/lib/open_topo/errors/base_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Errors
+    class BaseError < StandardError
+      def initialize(message = "")
+        super
+      end
+    end
+  end
+end

data/lib/open_topo/errors/convert_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Errors
+    class ConvertError < BaseError
+    end
+  end
+end

data/lib/open_topo/errors/file_error.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Errors
+    class FileError < BaseError
+      attr_reader :file_path
+
+      def initialize(message = "", file_path: nil)
+        super(message)
+        @file_path = file_path
+      end
+
+      def file
+        return nil if @file_path.nil?
+
+        File.open(@file_path)
+      rescue Errno::ENOENT
+        nil
+      end
+    end
+  end
+end

data/lib/open_topo/errors/params_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Errors
+    class ParamsError < BaseError
+    end
+  end
+end

data/lib/open_topo/errors/response_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Errors
+    class ResponseError < BaseError
+      def initialize(message = "")
+        super(message.is_a?(Hash) ? message["error"] || message : message)
+      end
+    end
+  end
+end

data/lib/open_topo/net/connection.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+require "oj"
+
+module OpenTopo
+  module Net
+    class Connection
+      def initialize(api_key = nil)
+        @api_key = api_key
+      end
+
+      def build
+        create_connection
+      end
+
+      private
+
+      BASE_URL = "https://portal.opentopography.org"
+      XML_CONTENT_TYPE = "application/xml"
+      ACCEPT_CONTENT_TYPE = "application/octet-stream,application/json,#{XML_CONTENT_TYPE}"
+
+      attr_reader :api_key
+
+      def create_connection
+        Faraday.new(options, request: request_options) do |faraday|
+          faraday.request :url_encoded
+          faraday.response :logger
+          faraday.response :xml, content_type: XML_CONTENT_TYPE
+          faraday.response :json, parser_options: {decoder: Oj, symbolize_names: true}
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      def options
+        {
+          url: BASE_URL,
+          headers: headers,
+          params: {API_Key: api_key}
+        }
+      end
+
+      def headers
+        {
+          "Accept" => ACCEPT_CONTENT_TYPE,
+          "User-Agent" => "Ruby open_topo v#{OpenTopo::VERSION}"
+        }
+      end
+
+      def request_options
+        {
+          # timeout: 7 # it creates tif file, so it can be slow :(
+        }
+      end
+    end
+  end
+end

data/lib/open_topo/net/params/base_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Net
+    module Params
+      class BaseParams
+        extend Forwardable
+
+        def initialize
+          @validation_result = nil
+
+          if self.class.contract.nil?
+            raise NotImplementedError, "Contract not configured"
+          end
+        end
+
+        def to_params
+          raise NotImplementedError, "Method to_params not implemented"
+        end
+        def_delegator :self, :to_params, :to_h
+
+        def valid?
+          validate
+          validation_result.success?
+        end
+
+        def validate!
+          if !valid?
+            raise ::OpenTopo::Errors::ParamsError, "Invalid parameters: #{error_messages.join(", ")}"
+          end
+
+          true
+        end
+
+        def error_messages
+          if !validation_result.nil? && !validation_result.success?
+            validation_result.errors(full: true).messages.map(&:text)
+          else
+            []
+          end
+        end
+
+        private
+
+        attr_reader :validation_result
+
+        def validate
+          @validation_result = self.class.contract.new.call(to_params)
+        end
+
+        class << self
+          attr_reader :contract
+
+          def validate_with(contract)
+            @contract = contract
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/net/params/catalog_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Net
+    module Params
+      class CatalogParams < BaseParams
+        validate_with Contracts::CatalogContract
+
+        attr_reader :west, :south, :east, :north, :polygon
+
+        def initialize(west: nil, south: nil, east: nil, north: nil, polygon: nil)
+          @west = west
+          @south = south
+          @east = east
+          @north = north
+          @polygon = polygon
+
+          super()
+        end
+
+        def to_params
+          params = default_params
+
+          if polygon
+            params[:polygon] = polygon
+          else
+            params[:maxx] = east
+            params[:minx] = west
+
+            params[:maxy] = north
+            params[:miny] = south
+          end
+
+          params
+        end
+
+        private
+
+        def default_params
+          {
+            productFormat: "Raster",
+            outputFormat: "xml",
+            detail: false,
+            include_federated: false
+          }
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/net/params/contracts/catalog_contract.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+
+module OpenTopo
+  module Net
+    module Params
+      module Contracts
+        class CatalogContract < ::Dry::Validation::Contract
+          COORDS = {
+            minx: :west,
+            miny: :south,
+            maxx: :east,
+            maxy: :north
+          }
+
+          params do
+            optional(:minx).filled(:float, gteq?: -180, lteq?: 180)
+            optional(:miny).filled(:float, gteq?: -90, lteq?: 90)
+            optional(:maxx).filled(:float, gteq?: -180, lteq?: 180)
+            optional(:maxy).filled(:float, gteq?: -90, lteq?: 90)
+            optional(:polygon).filled(:string)
+
+            required(:productFormat).filled(:string)
+            required(:outputFormat).filled(:string)
+            required(:detail).filled(:bool)
+            required(:include_federated).filled(:bool)
+          end
+
+          rule(:polygon, :minx, :miny, :maxx, :maxy) do
+            next if !values[:polygon].nil?
+
+            if COORDS.keys.any? { |key| values[key].nil? }
+              key(:base).failure("either polygon or all bounding box coordinates (#{COORDS.values.join(", ")}) must be provided")
+            end
+          end
+
+          rule(:minx, :maxx) do
+            next if values[:polygon]
+            next if values[:minx].nil? || values[:maxx].nil?
+
+            key(COORDS[:minx]).failure("must be less than #{COORDS[:maxx]} (#{values[:maxx]})") if values[:minx] >= values[:maxx]
+          end
+
+          rule(:miny, :maxy) do
+            next if values[:polygon]
+            next if values[:miny].nil? || values[:maxy].nil?
+
+            key(COORDS[:miny]).failure("must be less than #{COORDS[:maxy]} (#{values[:maxy]})") if values[:miny] >= values[:maxy]
+          end
+
+          rule(:minx, :miny, :maxx, :maxy) do
+            next if values[:polygon]
+
+            missing = COORDS.keys.select { |key| values[key].nil? }
+            next if missing.size == COORDS.size
+
+            missing.each do |key, value|
+              key(COORDS[key]).failure("must be provided") if value.nil?
+            end
+          end
+
+          rule(:polygon) do
+            next if value.nil?
+
+            coords = value.split(",")
+            if coords.size.odd?
+              key.failure("must consists of pairs of (longitude, latitude)")
+              next
+            end
+
+            coords.map(&:to_f).each_slice(2).with_index do |(long, lat), index|
+              key.failure("#{index} point - longitude must be less than or equal to 180") if long > 180
+              key.failure("#{index} point - latitude must be less than or equal to 90") if lat > 90
+
+              key.failure("#{index} point - longitude must be greater than or equal to -180") if long < -180
+              key.failure("#{index} point - latitude must be greater than or equal to -90") if lat < -90
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/net/params/contracts/elevation_contract.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+
+module OpenTopo
+  module Net
+    module Params
+      module Contracts
+        class ElevationContract < ::Dry::Validation::Contract
+          params do
+            required(:longitude).filled(:float, gteq?: -180, lteq?: 180)
+            required(:latitude).filled(:float, gteq?: -90, lteq?: 90)
+            required(:dataset).filled(:string)
+          end
+
+          rule(:dataset) do
+            key.failure("must be a valid dataset name") unless Params::ElevationParams::DATASETS.value?(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/net/params/contracts/globaldem_contract.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+
+module OpenTopo
+  module Net
+    module Params
+      module Contracts
+        class GlobaldemContract < ::Dry::Validation::Contract
+          params do
+            required(:south).filled(:float, gt?: -90, lt?: 90)
+            required(:north).filled(:float, gt?: -90, lt?: 90)
+            required(:west).filled(:float, gt?: -180, lt?: 180)
+            required(:east).filled(:float, gt?: -180, lt?: 180)
+            required(:demtype).filled(:string)
+            required(:outputFormat).filled(:string)
+          end
+
+          rule(:south, :north) do
+            key(:south).failure("must be less than north (#{values[:north]})") if values[:south] >= values[:north]
+          end
+
+          rule(:west, :east) do
+            key(:west).failure("must be less than east (#{values[:east]})") if values[:west] >= values[:east]
+          end
+
+          rule(:demtype) do
+            key.failure("must be a valid DEM type") unless Params::GlobaldemParams::DEM_TYPES.value?(value)
+          end
+
+          rule(:outputFormat) do
+            key.failure("must be a valid output format") unless Params::GlobaldemParams::OUTPUT_FORMATS.value?(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/net/params/contracts/usgsdem_contract.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+
+module OpenTopo
+  module Net
+    module Params
+      module Contracts
+        class UsgsdemContract < ::Dry::Validation::Contract
+          params do
+            required(:south).filled(:float, gt?: -90, lt?: 90)
+            required(:north).filled(:float, gt?: -90, lt?: 90)
+            required(:west).filled(:float, gt?: -180, lt?: 180)
+            required(:east).filled(:float, gt?: -180, lt?: 180)
+            required(:datasetName).filled(:string)
+            required(:outputFormat).filled(:string)
+          end
+
+          rule(:south, :north) do
+            key(:south).failure("must be less than north (#{values[:north]})") if values[:south] >= values[:north]
+          end
+
+          rule(:west, :east) do
+            key(:west).failure("must be less than east (#{values[:east]})") if values[:west] >= values[:east]
+          end
+
+          rule(:datasetName) do
+            key.failure("must be a valid DEM type") unless Params::UsgsdemParams::DEM_TYPES.value?(value)
+          end
+
+          rule(:outputFormat) do
+            key.failure("must be a valid output format") unless Params::UsgsdemParams::OUTPUT_FORMATS.value?(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/net/params/elevation_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Net
+    module Params
+      class ElevationParams < BaseParams
+        DATASETS = {
+          anadem: "ANADEM",                       # (DTM 30m)
+          arctic_dem10m: "ArcticDEM10m",
+          arctic_dem2m: "ArcticDEM2m",
+          arctic_dem32m: "ArcticDEM32m",
+          aw3_d30_e: "AW3D30_E",                  # (ALOS World 3D Ellipsoidal, 30m)
+          aw3_d30: "AW3D30",                      # (ALOS World 3D 30m)
+          ca_mrdem_dsm: "CA_MRDEM_DSM",           # (DSM 30m)
+          ca_mrdem_dtm: "CA_MRDEM_DTM",           # (DTM 30m)
+          cop30: "COP30",                         # (Copernicus Global DSM 30m)
+          cop90: "COP90",                         # (Copernicus Global DSM 90m)
+          eu_dtm: "EU_DTM",                       # (DTM 30m)
+          gebco_ice_topo: "GEBCOIceTopo",         # (Global Bathymetry 500m)
+          gebco_sub_ice_topo: "GEBCOSubIceTopo",  # (Global Bathymetry 500m)
+          gedi_l3: "GEDI_L3",                     # (DTM 1000m)
+          gedtm30: "GEDTM30",                     # (DTM 30m)
+          linz1m_dsm: "LINZ1m_DSM",
+          linz1m_dtm: "LINZ1m_DTM",
+          nasadem: "NASADEM",                     # (NASADEM Global DEM)
+          rema10m: "REMA10m",
+          rema2m: "REMA2m",
+          rema32m: "REMA32m",
+          srtm15_plus: "SRTM15Plus",              # (Global Bathymetry SRTM15+ V2.1 500m)
+          srtmgl1_e: "SRTM_GL1_Ellip",            # (SRTM GL1 Ellipsoidal 30m)
+          srtmgl1: "SRTM_GL1",                    # (SRTM GL1 30m)
+          srtmgl3: "SRTM_GL3",                    # (SRTM GL3 90m)
+          usgs10m: "USGS10m",
+          usgs30m: "USGS30m"
+        }
+
+        validate_with Contracts::ElevationContract
+
+        attr_reader :long, :lat, :dataset
+
+        def initialize(long:, lat:, dataset: :cop30)
+          @long = long
+          @lat = lat
+          @dataset = dataset
+
+          super()
+        end
+
+        def to_params
+          {
+            longitude: long,
+            latitude: lat,
+            dataset: DATASETS[dataset.to_sym]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/net/params/globaldem_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Net
+    module Params
+      class GlobaldemParams < BaseParams
+        OUTPUT_FORMATS = {tif: "GTiff", hfa: "HFA", asc: "AAIGrid"}
+        DEM_TYPES = {
+          anadem: "ANADEM",                       # (DTM 30m)
+          aw3_d30_e: "AW3D30_E",                  # (ALOS World 3D Ellipsoidal, 30m)
+          aw3_d30: "AW3D30",                      # (ALOS World 3D 30m)
+          ca_mrdem_dsm: "CA_MRDEM_DSM",           # (DSM 30m)
+          ca_mrdem_dtm: "CA_MRDEM_DTM",           # (DTM 30m)
+          cop30: "COP30",                         # (Copernicus Global DSM 30m)
+          cop90: "COP90",                         # (Copernicus Global DSM 90m)
+          eu_dtm: "EU_DTM",                       # (DTM 30m)
+          gebco_ice_topo: "GEBCOIceTopo",         # (Global Bathymetry 500m)
+          gebco_sub_ice_topo: "GEBCOSubIceTopo",  # (Global Bathymetry 500m)
+          gedi_l3: "GEDI_L3",                     # (DTM 1000m)
+          gedtm30: "GEDTM30",                     # (DTM 30m)
+          nasadem: "NASADEM",                     # (NASADEM Global DEM)
+          srtm15_plus: "SRTM15Plus",              # (Global Bathymetry SRTM15+ V2.1 500m)
+          srtmgl1_e: "SRTMGL1_E",                 # (SRTM GL1 Ellipsoidal 30m)
+          srtmgl1: "SRTMGL1",                     # (SRTM GL1 30m)
+          srtmgl3: "SRTMGL3"                      # (SRTM GL3 90m)
+        }
+
+        validate_with Contracts::GlobaldemContract
+
+        attr_reader :south, :north, :west, :east, :demtype, :output_format
+
+        def initialize(south:, north:, west:, east:, demtype:, output_format:)
+          @south = south
+          @north = north
+          @west = west
+          @east = east
+          @demtype = demtype
+          @output_format = output_format
+
+          super()
+        end
+
+        def to_params
+          {
+            south:,
+            north:,
+            west:,
+            east:,
+            demtype: DEM_TYPES[demtype.to_sym],
+            outputFormat: OUTPUT_FORMATS[output_format.to_sym]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/net/params/usgsdem_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Net
+    module Params
+      class UsgsdemParams < BaseParams
+        OUTPUT_FORMATS = {tif: "GTiff", hfa: "HFA", asc: "AAIGrid"}
+        DEM_TYPES = {
+          usgs1m: "USGS1m",
+          usgs10m: "USGS10m",
+          usgs30m: "USGS30m"
+        }
+
+        validate_with Contracts::UsgsdemContract
+
+        attr_reader :south, :north, :west, :east, :demtype, :output_format
+
+        def initialize(south:, north:, west:, east:, dataset_name:, output_format:)
+          @south = south
+          @north = north
+          @west = west
+          @east = east
+          @demtype = dataset_name
+          @output_format = output_format
+        end
+
+        def to_params
+          {
+            south:,
+            north:,
+            west:,
+            east:,
+            datasetName: DEM_TYPES[demtype.to_sym],
+            outputFormat: OUTPUT_FORMATS[output_format.to_sym]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/net/request.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Net
+    class Request
+      GLOBALDEM_ENDPOINT = "/API/globaldem"
+      USGSDEM_ENDPOINT = "/API/usgsdem"
+      ELEVATION_ENDPOINT = "/API/v1/elevation"
+      CATALOG_ENDPOINT = "/API/otCatalog"
+
+      def initialize(api_key = nil)
+        @connection = Connection.new(api_key).build
+      end
+
+      def globaldem(params)
+        Response.new(@connection.get(GLOBALDEM_ENDPOINT, params.to_params))
+      end
+
+      def usgsdem(params)
+        Response.new(@connection.get(USGSDEM_ENDPOINT, params.to_params))
+      end
+
+      def elevation(params)
+        Response.new(@connection.get(ELEVATION_ENDPOINT, params.to_params))
+      end
+
+      def catalog(params)
+        Response.new(@connection.get(CATALOG_ENDPOINT, params.to_params))
+      end
+    end
+  end
+end

data/lib/open_topo/net/response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Net
+    class Response
+      NOT_FOUND_MESSAGE = "Not found"
+      NO_DATA_MESSAGE = "No data"
+
+      attr_reader :body, :headers, :status
+
+      Headers = Struct.new(:date, :content_disposition, :content_length, :content_type) do
+        def filename
+          if content_disposition.nil? || !content_disposition.match?(filename_header)
+            return nil
+          end
+
+          File.basename(content_disposition.split(filename_header).last.delete('"'), ".*")
+        end
+
+        private
+
+        def filename_header = "filename="
+      end
+
+      def initialize(response)
+        @body = set_body_message(response)
+        @headers = parse_headers(response.headers)
+        @status = response.status
+      end
+
+      def success?
+        (200..299).cover?(status)
+      end
+
+      def failure?
+        !success?
+      end
+
+      def data?
+        success? && status != 204
+      end
+
+      private
+
+      def parse_headers(headers)
+        Headers.new(
+          headers["Date"],
+          headers["Content-Disposition"],
+          headers["Content-Length"],
+          headers["Content-Type"]
+        )
+      end
+
+      def set_body_message(response)
+        case response.status
+        when 204 then NO_DATA_MESSAGE
+        when 404 then NOT_FOUND_MESSAGE
+        else
+          response.body
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/point.rb

@@ -0,0 +1,24 @@
+# typed: strict
+# frozen_string_literal: true
+
+module OpenTopo
+  class Point
+    attr_reader :long
+    alias_method :longitude, :long
+
+    attr_reader :lat
+    alias_method :latitude, :lat
+
+    attr_reader :heigh
+    alias_method :elevation, :heigh
+
+    attr_reader :unit
+
+    def initialize(long:, lat:, heigh: nil, unit: "m")
+      @long = long
+      @lat = lat
+      @heigh = heigh
+      @unit = unit
+    end
+  end
+end

data/lib/open_topo/services/dem_converter.rb

@@ -0,0 +1,56 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "open3"
+
+module OpenTopo
+  module Services
+    class DemConverter
+      FILENAME_EXT_SPLITTER = ".*"
+
+      def self.call(file, file_format, file_path: nil)
+        if file.nil? || !File.file?(file)
+          raise OpenTopo::Errors::FileError.new("File is not a file (#{file.class})", file_path: file)
+        end
+
+        new_filename = build_new_filename(file, file_path, file_format)
+        original_filename = file.path
+
+        _message, error, status = Open3.capture3(gdal_translate_command(original_filename, new_filename))
+
+        if status.success?
+          File.open(new_filename, "r")
+        else
+          raise OpenTopo::Errors::ConvertError, error.strip
+        end
+      end
+
+      class << self
+        private
+
+        def build_new_filename(file, file_path, file_format)
+          extname = File.extname(file_path.to_s)
+          ext = extname.empty? ? ".#{file_format}" : extname
+          file_path = file.path if file_path.nil? || file_path.empty?
+
+          if !File.directory?(file_path) && File.extname(file_path).empty?
+            raise OpenTopo::Errors::FileError.new("No such file or directory", file_path:)
+          end
+
+          path, filename =
+            if File.directory?(file_path.to_s)
+              [file_path, File.basename(file.path, FILENAME_EXT_SPLITTER)]
+            else
+              [File.dirname(file_path), File.basename(file_path, FILENAME_EXT_SPLITTER)]
+            end
+
+          File.join(path, "#{filename}#{ext}")
+        end
+
+        def gdal_translate_command(original_filename, new_filename)
+          "gdal_translate -of XYZ -co COLUMN_SEPARATOR=, -co ADD_HEADER_LINE=YES #{original_filename} #{new_filename}"
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/services/response_to_catalog_list_converter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Services
+    class ResponseToCatalogListConverter
+      def self.call(data)
+        datasets = data&.dig("Datasets", "Dataset")
+        return [] if datasets.nil?
+
+        datasets.map do |dataset|
+          created_at = dataset["temporalCoverage"].split(" / ").map { |string_date| Date.parse(string_date) }
+
+          OpenTopo::Catalog.new(
+            full_name: dataset["name"],
+            name: dataset["alternateName"],
+            url: dataset["url"],
+            date_created: dataset["dateCreated"],
+            temporal_coverage: {from: created_at[0], to: created_at[1]},
+            unit: dataset["spatialCoverage"]["additionalProperty"].find { |p| p["name"] == "Unit" }&.fetch("value")
+          )
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/services/response_to_dem_converter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Services
+    class ResponseToDemConverter
+      DATE_TIME_FORMAT = "%F-%H-%M-%S"
+
+      def self.call(response, dem_type:, output_format:)
+        DemFile.new(original_file: file_from_response(response), dem_type:, output_format:)
+      end
+
+      class << self
+        private
+
+        def file_from_response(response)
+          return nil if !response.data?
+
+          filename = filename_from_response(response)
+          file = File.new([filename, ".tif"].join, "w")
+
+          file.binmode
+          file.write(response.body)
+          file.close
+
+          File.open(file, "r")
+        end
+
+        def filename_from_response(response)
+          response.headers.filename || "dem_#{Time.now.strftime(DATE_TIME_FORMAT)}"
+        end
+      end
+    end
+  end
+end

data/lib/open_topo/services/response_to_point_converter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  module Services
+    class ResponseToPointConverter
+      def self.call(response)
+        Point.new(
+          long: response.body[:Location][:Longitude],
+          lat: response.body[:Location][:Latitude],
+          heigh: response.body[:Elevation],
+          unit: response.body[:Unit]
+        )
+      end
+    end
+  end
+end

data/lib/open_topo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenTopo
+  VERSION = "0.1.0"
+end

data/lib/open_topo.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module OpenTopo
+end

data/sig/open_topo.rbs

@@ -0,0 +1,4 @@
+module OpenTopo
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,286 @@
+--- !ruby/object:Gem::Specification
+name: open_topo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- andrew-kh8
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.17'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+description: A simple Ruby client for interacting with the Open Topography API.
+email:
+- horolskyandrey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- Rakefile
+- lib/open_topo.rb
+- lib/open_topo/catalog.rb
+- lib/open_topo/client.rb
+- lib/open_topo/dem_file.rb
+- lib/open_topo/errors/base_error.rb
+- lib/open_topo/errors/convert_error.rb
+- lib/open_topo/errors/file_error.rb
+- lib/open_topo/errors/params_error.rb
+- lib/open_topo/errors/response_error.rb
+- lib/open_topo/net/connection.rb
+- lib/open_topo/net/params/base_params.rb
+- lib/open_topo/net/params/catalog_params.rb
+- lib/open_topo/net/params/contracts/catalog_contract.rb
+- lib/open_topo/net/params/contracts/elevation_contract.rb
+- lib/open_topo/net/params/contracts/globaldem_contract.rb
+- lib/open_topo/net/params/contracts/usgsdem_contract.rb
+- lib/open_topo/net/params/elevation_params.rb
+- lib/open_topo/net/params/globaldem_params.rb
+- lib/open_topo/net/params/usgsdem_params.rb
+- lib/open_topo/net/request.rb
+- lib/open_topo/net/response.rb
+- lib/open_topo/point.rb
+- lib/open_topo/services/dem_converter.rb
+- lib/open_topo/services/response_to_catalog_list_converter.rb
+- lib/open_topo/services/response_to_dem_converter.rb
+- lib/open_topo/services/response_to_point_converter.rb
+- lib/open_topo/version.rb
+- sig/open_topo.rbs
+homepage: https://github.com/andrew-kh8/open_topo
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/andrew-kh8/open_topo
+  source_code_uri: https://github.com/andrew-kh8/open_topo
+  changelog_uri: https://github.com/andrew-kh8/open_topo/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.18
+specification_version: 4
+summary: Ruby Open Topography client
+test_files: []