rkd 0.1.0 → 0.2.0

data/lib/r_k_d/config.rb

@@ -0,0 +1,27 @@
+module RKD
+  module Config
+    def self.api_endpoint
+      @api_endpoint || "https://api.rkd.triply.cc/datasets/rkd/RKD-Search-Graph/services/Elasticsearch/_search"
+    end
+
+    def self.api_endpoint=(api_endpoint)
+      @api_endpoint = api_endpoint
+    end
+
+    def self.file_cache_enabled=(file_cache_enabled)
+      @file_cache_enabled = !!file_cache_enabled
+    end
+
+    def self.file_cache_enabled?
+      !!@file_cache_enabled
+    end
+
+    def self.file_cache_dir=(file_cache_dir)
+      @file_cache_dir = file_cache_dir
+    end
+
+    def self.file_cache_dir
+      @file_cache_dir || Dir.tmpdir
+    end
+  end
+end

data/lib/r_k_d/date_span.rb

@@ -0,0 +1,42 @@
+module RKD
+  class DateSpan
+    include ::RKD::Helpers::DateParsing
+
+    attr_reader :begin
+    attr_reader :end
+
+    class << self
+      def parse(string)
+        if string && (years_match = string.match(/(\d\d\d\d).*-.*(\d\d\d\d)/))
+          new(years_match[1].to_i, years_match[2].to_i)
+        end
+      end
+    end
+
+    def initialize(date_begin_or_range = nil, date_end = nil)
+      if date_begin_or_range.is_a?(Range)
+        self.begin = date_begin_or_range.begin
+        self.end = date_begin_or_range.end
+      else
+        self.begin = date_begin_or_range
+        self.end = date_end
+      end
+    end
+
+    def nilly?
+      self.begin.nil? && self.end.nil?
+    end
+
+    def == other
+      other && @begin == other.begin && @end == other.end
+    end
+
+    def begin= date
+      @begin = parse_date(date)
+    end
+
+    def end= date
+      @end = parse_date(date)
+    end
+  end
+end

data/lib/r_k_d/helpers/date_parsing.rb

@@ -0,0 +1,17 @@
+module RKD
+  module Helpers
+    module DateParsing
+      private
+
+      def parse_date(date)
+        if date.is_a?(String) || date.is_a?(Integer)
+          RKD::ImpreciseDate.parse(date)
+        elsif date.is_a?(Date)
+          date
+        end
+      rescue Date::Error
+        nil
+      end
+    end
+  end
+end

data/lib/r_k_d/imprecise_date.rb

@@ -0,0 +1,47 @@
+module RKD
+  class ImpreciseDate
+    attr_reader :year, :month, :precision
+
+    def initialize(year, month = nil)
+      if month
+        @precision = :month
+        @month = month.to_i
+      else
+        @precision = :year
+      end
+      @year = year.to_i
+    end
+
+    def ==other
+      other &&
+        year == other.year &&
+        month == other.month &&
+        precision == other.precision
+    end
+
+    def to_date
+      if precision == :year
+        nil
+      else
+        Date.new(year, month, 1)
+      end
+    end
+
+    class << self
+      def parse(value)
+        if value.is_a?(Date)
+          value
+        elsif value.is_a? Integer
+          new(value)
+        elsif value.is_a?(String) && (value.count("-") == 2 || value.count("/") == 2)
+          Date.parse(value)
+        elsif value.is_a?(String) && (value.count("-") == 1 || value.count("/") == 1)
+          year, month = value.split(/[-\/]/)
+          new(year, month)
+        elsif value.is_a?(String) && value.count("-") == 0 && value.count("/") == 0 && value.strip.match(/\A\d+$/)
+          new(value.to_i)
+        end
+      end
+    end
+  end
+end

data/lib/r_k_d/institution.rb

@@ -0,0 +1,28 @@
+module RKD
+  class Institution
+    attr_accessor :label
+    attr_accessor :place
+    attr_accessor :id
+
+    class << self
+      def initialize_from_label string
+        if (match = string.match(/(.*)\((.*)\)/))
+          concept = new
+          concept.label = match[1].strip
+          concept.place = Place.new(label: match[2].strip)
+          concept
+        elsif (match = string.match(/(.*)\s(of|van)\s(.*)/))
+          concept = new
+          concept.label = match[0].strip
+          concept.place = Place.new(label: match[3].strip)
+          concept
+        elsif (match = string.match(/\AUniversit\w*\s(\w*)$/))
+          concept = new
+          concept.label = match[0].strip
+          concept.place = Place.new(label: match[1].strip)
+          concept
+        end
+      end
+    end
+  end
+end

data/lib/r_k_d/performance.rb

@@ -0,0 +1,32 @@
+# "http://www.cidoc-crm.org/cidoc-crm/P14i_performed"
+module RKD
+  class Performance
+    attr_accessor :date_span
+    attr_accessor :place
+    attr_accessor :comments
+    attr_accessor :institution
+
+    def initialize(place:, date_span:, institution: nil, comments: nil)
+      @date_span = date_span
+      @place = place
+      @comments = comments
+      @institution = institution
+    end
+
+    class Work < Performance
+    end
+
+    class Study < Performance
+    end
+
+    class Collection < Array
+      def work
+        self.select { |a| a.is_a?(Work) }
+      end
+
+      def study
+        self.select { |a| a.is_a?(Study) }
+      end
+    end
+  end
+end

data/lib/r_k_d/place.rb

@@ -0,0 +1,38 @@
+module RKD
+  class Place
+    attr_reader :geoname_id
+    attr_reader :label
+    attr_reader :lat
+    attr_reader :lon
+    attr_reader :refs
+
+    def initialize(label:, geoname_id: nil, point: nil, refs: [], lat: nil, lon: nil)
+      @lon, @lat = parse_point(point).values if point
+      @lat ||= lat
+      @lon ||= lon
+      @geoname_id = Integer(geoname_id) if geoname_id
+      @refs = refs.compact
+
+      geoname_ref = @refs.find { |ref| ref.start_with?("https://sws.geonames.org/") }&.sub("https://sws.geonames.org/", "")
+      @geoname_id ||= Integer(geoname_ref) if geoname_ref
+      @label = label
+    end
+
+    def nilly?
+      geoname_id.nil? && label.nil? && lat.nil? && lon.nil? && refs.empty?
+    end
+
+    private
+
+    def parse_point(point_raw)
+      if point_raw.is_a?(String) && point_raw.start_with?("POINT(")
+        point_parsed = point_raw.sub("POINT(", "").sub(")", "").split(" ").map(&:to_f)
+        {lat: point_parsed[0], lon: point_parsed[1]}
+      elsif point_raw.is_a?(Array) && point_raw.count == 2
+        {lat: point_raw[0].to_f, lon: point_raw[1].to_f}
+      elsif point_raw.is_a?(Hash) && point_raw.key?(:lat)
+        point_raw
+      end
+    end
+  end
+end

data/lib/r_k_d/query/elastic_search.rb

@@ -0,0 +1,64 @@
+module RKD
+  module Query
+    class ElasticSearch
+      ELASTIC_SEARCH_ENDPOINT = "https://api.rkd.triply.cc/datasets/rkd/RKD-Search-Graph/services/Elasticsearch/_search"
+
+      class << self
+        def query(dataset:, name: nil, id: nil)
+          base_query = {
+            query: {
+              bool: {
+                filter: [
+                  {
+                    match: {"https://data rkd nl/search#datasetName": dataset}
+                  }
+                ],
+                must: [],
+                should: []
+              }
+            }
+          }
+
+          if name
+            base_query[:query][:bool][:should] << {
+              simple_query_string: {
+                query: name,
+                fields: [
+                  "http://www w3 org/2000/01/rdf-schema#label"
+                ]
+              }
+            }
+            base_query[:query][:bool][:must] << {
+              simple_query_string: {query: name}
+            }
+          end
+          if id
+            base_query[:query][:bool][:must] << {
+              match: {
+                _id: "https://data.rkd.nl/artists/#{id}"
+              }
+            }
+          end
+
+          base_query
+        end
+
+        def search(name, dataset: "artists")
+          data = FileCache.cache("es-#{dataset}-search-#{name}") do
+            HTTP.post_json ELASTIC_SEARCH_ENDPOINT, query(name:, dataset:)
+          end
+
+          JSON.parse(data)["hits"]["hits"].map { |hit| hit["_source"] }
+        end
+
+        def find(id, dataset: "artists")
+          data = FileCache.cache("es-#{dataset}-find-#{id}") do
+            HTTP.post_json ELASTIC_SEARCH_ENDPOINT, query(id:, dataset:)
+          end
+
+          JSON.parse(data)["hits"]["hits"].map { |hit| hit["_source"] }.first
+        end
+      end
+    end
+  end
+end

data/lib/r_k_d/query/file_cache.rb

@@ -0,0 +1,40 @@
+module RKD
+  module Query
+    class FileCache
+      class << self
+        def cache(key)
+          new(key).cache { yield }
+        end
+      end
+      def initialize(key)
+        @key = key
+      end
+
+      def cache
+        if present?
+          File.read(file_path)
+        else
+          response = yield
+          File.write(file_path, response)
+          response
+        end
+      end
+
+      def present?
+        @present ||= RKD::Config.file_cache_enabled? && File.exist?(file_path) && (File.ctime(file_path) > (Time.now - 86400))
+      end
+
+      def flush
+        File.delete(file_path)
+      end
+
+      private
+
+      def file_path
+        return @file_path if @file_path
+        namekey = (Digest::SHA256.new << @key.to_s.downcase)
+        @file_path = File.join(RKD::Config.file_cache_dir, "rkd-query-file-cache-#{namekey}.json")
+      end
+    end
+  end
+end

data/lib/r_k_d/query/http.rb

@@ -0,0 +1,24 @@
+module RKD
+  module Query
+    class HTTP
+      class Error < StandardError
+      end
+      class << self
+        def post_json(url, data)
+          uri = URI(url)
+          headers = {"Content-Type" => "application/json; charset=utf-8", "Accept-Charset" => "utf-8"}
+          req = Net::HTTP::Post.new(uri, headers)
+          req.body = data.to_json
+          res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+            http.request(req)
+          end
+          if [200, 201].include? res.code.to_i
+            res.body.force_encoding("utf-8")
+          else
+            raise Error, res.code
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r_k_d/query/sparql.rb

@@ -0,0 +1,77 @@
+module RKD
+  module Query
+    class Sparql
+      ENDPOINT = "https://rkd.triply.cc/_api/datasets/rkd/RKD-Knowledge-Graph/services/SPARQL/sparql"
+      BASE_QUERY = <<~SPARQL
+        PREFIX rkd: <https://data.rkd.nl/def#>
+        PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+        PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
+        PREFIX crm: <http://www.cidoc-crm.org/cidoc-crm/>
+        prefix la: <https://linked.art/ns/terms/>
+
+        SELECT ?property ?propertyLabel ?value ?symbolicContent ?prefLabel ?tookPlaceAt ?tookPlaceAtTimeSpan ?tookPlaceAtTimeSpanBegin ?tookPlaceAtTimeSpanEnd ?placePoint ?placeLabel ?placeRef ?timeSpan ?start ?end ?domain ?range ?studyLabel ?studyReference ?referenceContent
+        WHERE {
+          <https://data.rkd.nl/artists/{{rkd_id}}> ?property ?value.
+          FILTER (
+            !(?property in (crm:P67i_is_referred_to_by, crm:P1_is_identified_by, crm:P62i_is_depicted_by, la:member_of))
+            )
+          OPTIONAL {
+            ?property rdfs:label ?propertyLabel.
+            FILTER (lang(?propertyLabel) = "en")
+          }
+          OPTIONAL {
+            ?value crm:P190_has_symbolic_content ?symbolicContent
+          }
+          OPTIONAL {
+            ?value skos:prefLabel ?prefLabel
+            FILTER (lang(?prefLabel) = "en")
+          }
+          OPTIONAL {
+            ?value crm:P7_took_place_at ?tookPlaceAt.
+            ?value crm:P4_has_time-span ?timeSpan.
+            ?tookPlaceAt crm:P168_place_is_defined_by ?placePoint.
+            ?tookPlaceAt rdfs:label ?placeLabel.
+            ?tookPlaceAt skos:exactMatch ?placeRef.
+            ?timeSpan crm:P82a_begin_of_the_begin ?start.
+            ?timeSpan crm:P82b_end_of_the_end ?end.
+          }
+          OPTIONAL {
+            ?value crm:P7_took_place_at ?tookPlaceAt.
+            ?tookPlaceAt rdfs:label ?placeLabel.
+            ?tookPlaceAt skos:exactMatch ?placeRef.
+          }
+          OPTIONAL {
+            ?value crm:P01i_is_domain_of ?domain.
+            ?domain crm:P02_has_range ?range.
+            ?range skos:prefLabel ?studyLabel.
+          }
+          OPTIONAL {
+            ?value crm:P01i_is_domain_of ?domain.
+            ?domain crm:P02_has_range ?range.
+            ?value crm:P67i_is_referred_to_by ?studyReference.
+            ?studyReference crm:P190_has_symbolic_content ?referenceContent
+          }
+          OPTIONAL {
+            ?value crm:P4_has_time-span ?tookPlaceAtTimeSpan.
+            ?tookPlaceAtTimeSpan crm:P82a_begin_of_the_begin ?tookPlaceAtTimeSpanBegin.
+            ?tookPlaceAtTimeSpan crm:P82b_end_of_the_end ?tookPlaceAtTimeSpanEnd.
+          }
+        }
+      SPARQL
+
+      class << self
+        def query id
+          BASE_QUERY.sub("{{rkd_id}}", id.to_i.to_s)
+        end
+
+        def find id
+          data = FileCache.cache("sparql-#{id}") do
+            HTTP.post_json ENDPOINT, {query: query(id)}
+          end
+
+          JSON.parse(data)
+        end
+      end
+    end
+  end
+end

data/lib/r_k_d/type.rb

@@ -0,0 +1,11 @@
+module RKD
+  # http://www.cidoc-crm.org/cidoc-crm/P2_has_type
+  class Type
+    attr_accessor :label, :ref
+
+    def initialize(label:, ref:)
+      @label = label
+      @ref = ref
+    end
+  end
+end

data/lib/r_k_d/version.rb

@@ -0,0 +1,3 @@
+module RKD
+  VERSION = "0.2.0"
+end

data/lib/r_k_d.rb

@@ -0,0 +1,24 @@
+require "digest"
+require "json"
+require "net/http"
+require "date"
+
+require "r_k_d/helpers/date_parsing"
+require "r_k_d/version"
+require "r_k_d/artist"
+require "r_k_d/performance"
+require "r_k_d/place"
+require "r_k_d/imprecise_date"
+require "r_k_d/institution"
+require "r_k_d/type"
+require "r_k_d/date_span"
+require "r_k_d/query/http"
+require "r_k_d/query/file_cache"
+require "r_k_d/query/elastic_search"
+require "r_k_d/query/sparql"
+require "r_k_d/config"
+
+module RKD
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/rkd.rb

@@ -1,6 +1 @@
-require "rkd/version"
-
-module Rkd
-  class Error < StandardError; end
-  # Your code goes here...
-end
+require "r_k_d"

data/rkd.gemspec

@@ -1,18 +1,17 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rkd/version"
+require "r_k_d/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "rkd"
-  spec.version       = Rkd::VERSION
-  spec.authors       = ["murb"]
-  spec.email         = ["git@murb.nl"]
+  spec.name = "rkd"
+  spec.version = RKD::VERSION
+  spec.authors = ["murb"]
+  spec.email = ["git@murb.nl"]
 
-  spec.summary       = "Unoficial Gem that abstracts away RKD's APIs"
-  spec.description   = "Search the RKD (Netherlands Institute for Art History) API for artists"
-  spec.homepage      = "https://murb.nl/blog?tag=rkd,gem"
-  spec.license       = "MIT"
+  spec.summary = "Unoficial Gem that abstracts away RKD's APIs"
+  spec.description = "Search the RKD (Netherlands Institute for Art History) API for artists"
+  spec.homepage = "https://murb.nl/blog?tag=rkd,gem"
+  spec.license = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -27,14 +26,17 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">3"
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "> 1"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "standard", "~> 1"
+  spec.add_development_dependency "simplecov", "~> 0.22"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rkd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - murb
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2025-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 description: Search the RKD (Netherlands Institute for Art History) API for artists
 email:
 - git@murb.nl
@@ -60,16 +88,38 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
+- ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docs/first query.sparql
+- docs/fourth_query.sparql
+- docs/second_query.sparql
+- docs/third_query.sparql
+- lib/r_k_d.rb
+- lib/r_k_d/artist.rb
+- lib/r_k_d/config.rb
+- lib/r_k_d/date_span.rb
+- lib/r_k_d/helpers/date_parsing.rb
+- lib/r_k_d/imprecise_date.rb
+- lib/r_k_d/institution.rb
+- lib/r_k_d/performance.rb
+- lib/r_k_d/place.rb
+- lib/r_k_d/query/elastic_search.rb
+- lib/r_k_d/query/file_cache.rb
+- lib/r_k_d/query/http.rb
+- lib/r_k_d/query/sparql.rb
+- lib/r_k_d/type.rb
+- lib/r_k_d/version.rb
 - lib/rkd.rb
-- lib/rkd/version.rb
 - rkd.gemspec
 homepage: https://murb.nl/blog?tag=rkd,gem
 licenses:
@@ -78,23 +128,23 @@ metadata:
   homepage_uri: https://murb.nl/blog?tag=rkd,gem
   source_code_uri: https://gitlab.com/murb/rkd
   changelog_uri: https://gitlab.com/murb/rkd/changelog.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Unoficial Gem that abstracts away RKD's APIs
 test_files: []