cuzk-rest 0.1.0

data/lib/cuzk/rest/resources/parcel.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module CUZK
+  module REST
+    module Resources
+      class Parcel < Resource
+        self.endpoint_path = 'Parcely'
+
+        def id
+          attributes['id']
+        end
+
+        def number
+          attributes['kmenoveCislo']
+        end
+
+        def sub_number
+          attributes['pododdeleniCisla']
+        end
+
+        def full_number
+          sub_number ? "#{number}/#{sub_number}" : number.to_s
+        end
+
+        def cadastral_unit_code
+          attributes['kodKatastralnihoUzemi']
+        end
+
+        def cadastral_unit_name
+          attributes['nazevKatastralnihoUzemi']
+        end
+
+        def area
+          attributes['vymera']
+        end
+
+        def land_type
+          attributes['druhPozemku']
+        end
+
+        def land_type_code
+          attributes['kodDruhuPozemku']
+        end
+
+        def land_use
+          attributes['zpusobVyuziti']
+        end
+
+        def land_use_code
+          attributes['kodZpusobuVyuziti']
+        end
+
+        def protection_type
+          attributes['zpusobOchrany']
+        end
+
+        def lv_number
+          attributes['cisloLv']
+        end
+
+        def map_sheet
+          attributes['mapovyList']
+        end
+
+        class << self
+          def find(id)
+            data = get("/#{id}")
+            build(data)
+          end
+
+          def search(params = {})
+            data = get('/Vyhledani', normalize_search_params(params))
+            build_collection(data, key: 'parcely')
+          end
+
+          def find_by_cadastral_unit(cadastral_unit_code, params = {})
+            search(params.merge(cadastral_unit: cadastral_unit_code))
+          end
+
+          def find_neighbors(parcel_id)
+            data = get("/SousedniParcely/#{parcel_id}")
+            build_collection(data, key: 'parcely')
+          end
+
+          private
+
+          def normalize_search_params(params)
+            mapping = {
+              cadastral_unit: 'KodKatastralnihoUzemi',
+              parcel_type: 'TypParcely',
+              numbering_type: 'DruhCislovaniParcely',
+              number: 'KmenoveCisloParcely',
+              sub_number: 'PoddeleniCislaParcely',
+              lv_number: 'CisloLv'
+            }
+
+            params.each_with_object({}) do |(key, value), result|
+              api_key = mapping[key] || key.to_s
+              result[api_key] = value
+            end
+          end
+        end
+
+        def neighboring_parcels
+          self.class.find_neighbors(id)
+        end
+
+        private
+
+        def summary_attributes
+          "id=#{id} number=#{full_number} area=#{area} cadastral_unit=#{cadastral_unit_name}"
+        end
+      end
+    end
+  end
+end

data/lib/cuzk/rest/resources/procedure.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module CUZK
+  module REST
+    module Resources
+      class Procedure < Resource
+        self.endpoint_path = 'Rizeni'
+
+        def id
+          attributes['id']
+        end
+
+        def procedure_number
+          attributes['cisloRizeni']
+        end
+
+        def procedure_type
+          attributes['typRizeni']
+        end
+
+        def procedure_type_code
+          attributes['kodTypuRizeni']
+        end
+
+        def status
+          attributes['stav']
+        end
+
+        def status_code
+          attributes['kodStavu']
+        end
+
+        def cadastral_unit_code
+          attributes['kodKatastralnihoUzemi']
+        end
+
+        def cadastral_unit_name
+          attributes['nazevKatastralnihoUzemi']
+        end
+
+        def filed_date
+          attributes['datumPodani']
+        end
+
+        def resolved_date
+          attributes['datumVyrizeni']
+        end
+
+        def description
+          attributes['popis']
+        end
+
+        def active?
+          resolved_date.nil?
+        end
+
+        class << self
+          def find(id)
+            data = get("/#{id}")
+            build(data)
+          end
+
+          def search(params = {})
+            data = get('/Vyhledani', normalize_search_params(params))
+            build_collection(data, key: 'rizeni')
+          end
+
+          def active(params = {})
+            search(params.merge(status: 'aktivni'))
+          end
+
+          def received_on(date, params = {})
+            data = get('/PrijateDne', normalize_search_params(params.merge(datum: date)))
+            build_collection(data, key: 'rizeni')
+          end
+
+          def find_by_cadastral_unit(cadastral_unit_code, params = {})
+            search(params.merge(cadastral_unit: cadastral_unit_code))
+          end
+
+          private
+
+          def normalize_search_params(params)
+            mapping = {
+              cadastral_unit: 'KodKatastralnihoUzemi',
+              procedure_type: 'KodTypuRizeni',
+              status: 'Stav',
+              filed_from: 'DatumPodaniOd',
+              filed_to: 'DatumPodaniDo',
+              datum: 'Datum'
+            }
+
+            params.each_with_object({}) do |(key, value), result|
+              api_key = mapping[key] || key.to_s
+              result[api_key] = value
+            end
+          end
+        end
+
+        private
+
+        def summary_attributes
+          "id=#{id} number=#{procedure_number} type=#{procedure_type} status=#{status}"
+        end
+      end
+    end
+  end
+end

data/lib/cuzk/rest/resources/registry.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module CUZK
+  module REST
+    module Resources
+      class Registry < Resource
+        self.endpoint_path = 'CiselnikyISKN'
+
+        def code
+          attributes['kod']
+        end
+
+        def name
+          attributes['nazev']
+        end
+
+        def description
+          attributes['popis']
+        end
+
+        def valid_from
+          attributes['platnostOd']
+        end
+
+        def valid_to
+          attributes['platnostDo']
+        end
+
+        def active?
+          valid_to.nil?
+        end
+
+        class << self
+          def land_types
+            fetch_registry('DruhyPozemku')
+          end
+
+          def building_types
+            fetch_registry('TypyStavby')
+          end
+
+          def building_purposes
+            fetch_registry('ZpusobyVyuzitiStavby')
+          end
+
+          def unit_types
+            fetch_registry('TypyJednotky')
+          end
+
+          def protection_types
+            fetch_registry('ZpusobyOchranyNemovitosti')
+          end
+
+          def land_use_types
+            fetch_registry('ZpusobyVyuzitiPozemku')
+          end
+
+          def translate_code(code, registry_type:)
+            entries = fetch_registry(registry_type)
+            entry = entries.find { |e| e.code.to_s == code.to_s }
+            entry&.name
+          end
+
+          def find_code(description, registry_type:)
+            entries = fetch_registry(registry_type)
+            entry = entries.find { |e| e.name&.downcase&.include?(description.downcase) }
+            entry&.code
+          end
+
+          private
+
+          def fetch_registry(type)
+            data = get("/#{type}")
+            build_collection(data, key: 'polozky')
+          end
+        end
+
+        private
+
+        def summary_attributes
+          "code=#{code} name=#{name}"
+        end
+      end
+    end
+  end
+end

data/lib/cuzk/rest/resources/territory.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module CUZK
+  module REST
+    module Resources
+      class Territory < Resource
+        self.endpoint_path = 'CiselnikyUzemnichJednotek'
+
+        def code
+          attributes['kod']
+        end
+
+        def name
+          attributes['nazev']
+        end
+
+        def territory_type
+          attributes['typ']
+        end
+
+        def parent_code
+          attributes['kodNadrazeneho']
+        end
+
+        def parent_name
+          attributes['nazevNadrazeneho']
+        end
+
+        class << self
+          def cadastral_units(params = {})
+            data = get('/KatastralniUzemi', normalize_params(params))
+            build_collection(data, key: 'katastralniUzemi')
+          end
+
+          def municipalities(params = {})
+            data = get('/Obce', normalize_params(params))
+            build_collection(data, key: 'obce')
+          end
+
+          def municipality_parts(params = {})
+            data = get('/CastiObci', normalize_params(params))
+            build_collection(data, key: 'castiObci')
+          end
+
+          def districts(params = {})
+            data = get('/Okresy', normalize_params(params))
+            build_collection(data, key: 'okresy')
+          end
+
+          def regions
+            data = get('/Kraje')
+            build_collection(data, key: 'kraje')
+          end
+
+          private
+
+          def normalize_params(params)
+            mapping = {
+              region: 'KodKraje',
+              district: 'KodOkresu',
+              municipality: 'KodObce',
+              name: 'Nazev'
+            }
+
+            params.each_with_object({}) do |(key, value), result|
+              api_key = mapping[key] || key.to_s
+              result[api_key] = value
+            end
+          end
+        end
+
+        private
+
+        def summary_attributes
+          "code=#{code} name=#{name} type=#{territory_type}"
+        end
+      end
+    end
+  end
+end

data/lib/cuzk/rest/resources/unit.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module CUZK
+  module REST
+    module Resources
+      class Unit < Resource
+        self.endpoint_path = 'Jednotky'
+
+        def id
+          attributes['id']
+        end
+
+        def number
+          attributes['cisloJednotky']
+        end
+
+        def unit_type
+          attributes['typJednotky']
+        end
+
+        def unit_type_code
+          attributes['kodTypuJednotky']
+        end
+
+        def unit_type_description
+          case unit_type_code
+          when 1, '1' then 'byt'
+          when 2, '2' then 'nebytový prostor'
+          when 3, '3' then 'ateliér'
+          else unit_type
+          end
+        end
+
+        def floor
+          attributes['podlazi']
+        end
+
+        def area
+          attributes['vymera']
+        end
+
+        def building_id
+          attributes['idStavby']
+        end
+
+        def cadastral_unit_code
+          attributes['kodKatastralnihoUzemi']
+        end
+
+        def cadastral_unit_name
+          attributes['nazevKatastralnihoUzemi']
+        end
+
+        def lv_number
+          attributes['cisloLv']
+        end
+
+        def share_numerator
+          attributes['podilCitatel']
+        end
+
+        def share_denominator
+          attributes['podilJmenovatel']
+        end
+
+        def ownership_share
+          return nil unless share_numerator && share_denominator
+
+          "#{share_numerator}/#{share_denominator}"
+        end
+
+        def share_percentage
+          return nil unless share_numerator && share_denominator&.to_f&.positive?
+
+          (share_numerator.to_f / share_denominator * 100).round(2)
+        end
+
+        class << self
+          def find(id)
+            data = get("/#{id}")
+            build(data)
+          end
+
+          def search(params = {})
+            data = get('/Vyhledani', normalize_search_params(params))
+            build_collection(data, key: 'jednotky')
+          end
+
+          def find_by_building(building_id)
+            search(house_number: building_id)
+          end
+
+          private
+
+          def normalize_search_params(params)
+            mapping = {
+              municipality_part: 'KodCastiObce',
+              building_type: 'TypStavby',
+              house_number: 'CisloDomovni',
+              unit_number: 'CisloJednotky'
+            }
+
+            params.each_with_object({}) do |(key, value), result|
+              api_key = mapping[key] || key.to_s
+              result[api_key] = value
+            end
+          end
+        end
+
+        def shared_ownership?
+          share_denominator.to_i > 1
+        end
+
+        private
+
+        def summary_attributes
+          "id=#{id} number=#{number} type=#{unit_type_description} share=#{ownership_share}"
+        end
+      end
+    end
+  end
+end

data/lib/cuzk/rest/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CUZK
+  module REST
+    VERSION = '0.1.0'
+  end
+end

data/lib/cuzk/rest.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'faraday'
+require 'faraday/retry'
+require 'oj'
+
+module CUZK
+  module REST
+    class << self
+      def configure
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def reset_configuration!
+        @configuration = Configuration.new
+      end
+
+      def loader
+        @loader ||= begin
+          loader = Zeitwerk::Loader.new
+          loader.tag = 'cuzk-rest'
+          loader.push_dir("#{__dir__}/rest", namespace: CUZK::REST)
+          loader.inflector.inflect('api_key' => 'APIKey')
+          loader.ignore("#{__dir__}/rest/version.rb")
+          loader.ignore("#{__dir__}/rest/errors.rb")
+          loader
+        end
+      end
+    end
+
+    loader.setup
+  end
+end
+
+require_relative 'rest/version'
+require_relative 'rest/errors'

data/lib/cuzk-rest.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'cuzk/rest'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: cuzk-rest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Segfault Labs
+bindir: exe
+cert_chain: []
+date: 2026-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Idiomatic Ruby client for the Czech Real Estate Registry (ČÚZK) REST
+  API. Provides access to cadastral data including parcels, buildings, units, ownership
+  information, and reference registries.
+email:
+- info@segfault-labs.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cuzk-rest.rb
+- lib/cuzk/rest.rb
+- lib/cuzk/rest/client.rb
+- lib/cuzk/rest/configuration.rb
+- lib/cuzk/rest/connection.rb
+- lib/cuzk/rest/errors.rb
+- lib/cuzk/rest/rate_limiter.rb
+- lib/cuzk/rest/resource.rb
+- lib/cuzk/rest/resources/app_service.rb
+- lib/cuzk/rest/resources/building.rb
+- lib/cuzk/rest/resources/building_right.rb
+- lib/cuzk/rest/resources/ownership.rb
+- lib/cuzk/rest/resources/parcel.rb
+- lib/cuzk/rest/resources/procedure.rb
+- lib/cuzk/rest/resources/registry.rb
+- lib/cuzk/rest/resources/territory.rb
+- lib/cuzk/rest/resources/unit.rb
+- lib/cuzk/rest/version.rb
+homepage: https://gitlab.com/segfault-labs/cuzk-rest-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/segfault-labs/cuzk-rest-rb
+  source_code_uri: https://gitlab.com/segfault-labs/cuzk-rest-rb
+  changelog_uri: https://gitlab.com/segfault-labs/cuzk-rest-rb/-/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Ruby client for ČÚZK Real Estate Registry REST API
+test_files: []