fdp_client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40cb339a04805d24f89099a2d412cfa37b4d2efd049f556429f68d9836841713
+  data.tar.gz: baafe98a63217640b99856020b3ed2895c904fc00a54517ff8b6ace9c1be3581
+SHA512:
+  metadata.gz: f12b2d06b1411f5a53484274e0b22f6bd6f859efc50074bf15e44b7bb36dbcb91075a68bec025cb8a7bdf912471d22d9a3e4cea2f468bb1a5da85a984ee261a3
+  data.tar.gz: d9a87965115568695962efb6175f43e5a445af22fa6972c646c92eb7906b42b2eda53f1d94e9e64fbc17db5e50a825af69eeb6115bb06117cb7248ea91455994

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-25
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fdp_mate.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rest_client", "~> 8.0"
+
+gem "json", "~> 2.6"

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    fdp_client (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rest_client (8.0.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  fdp_client!
+  json (~> 2.6)
+  rake (~> 13.0)
+  rest_client (~> 8.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+  4.0.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mark Wilkinson
+
+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/README.md

@@ -0,0 +1,33 @@
+# FdpMate
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fdp_mate`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add fdp_mate
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install fdp_mate
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fdp_mate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/fdp_client_ruby.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "fdp_client"
+  spec.version = "0.0.2"
+  spec.authors = ["Mark Wilkinson"]
+  spec.email = ["markw@illuminae.com"]
+
+  spec.summary = "Gem for interacting with FAIR Data Point reference implementation (only!)."
+  spec.homepage = "https://github.com/markwilkinson/FDP-Client-Ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.4"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/markwilkinson/FDP-Client-Ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/markwilkinson/FDP-Client-Ruby/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/fdp_client/GUI/access_service.rb

@@ -0,0 +1,53 @@
+module FDPMate
+  class DCATDataService < DCATResource
+    attr_accessor :endpointDescription, :endpointURL
+
+    def initialize(parent:, endpointDescription: nil, endpointURL: nil, **args)
+      super(**args)
+      @endpointDescription = endpointDescription
+      @endpointURL = endpointURL
+
+      warn "Building Data Service"
+      warn self.endpointDescription, self.endpointURL, self.class
+
+      self.types = [DCAT.Resource, DCAT.DataService]
+      init_accessService # create record and get GUID
+      build # make the RDF
+      write_accessService
+      parent.accessServices << self
+    end
+
+    def init_accessService
+      warn "initializing access Service"
+      asinit = <<~END
+        @prefix dcat: <http://www.w3.org/ns/dcat#> .
+        @prefix dct: <http://purl.org/dc/terms/> .
+        @prefix foaf: <http://xmlns.com/foaf/0.1/> .
+        <> a dcat:DataService ;
+            foaf:name "test" ;
+            dct:title "test" ;
+            dct:hasVersion "1.0" ;
+            dcat:endpointURL <https://example.org> ;
+            dct:publisher [ a foaf:Agent ; foaf:name "Example User" ] ;
+            dct:isPartOf <#{@parentURI}> .
+END
+
+      warn "#{serverURL}/dataService"
+      # warn "#{asinit}\n\n"
+      resp = RestClient.post("#{serverURL}/dataService", asinit, $headers)
+      aslocation = resp.headers[:location]
+      puts "temporary distribution written to #{aslocation}\n\n"
+      self.identifier = RDF::URI(aslocation) # set identifier to where it lives
+    end
+
+    def write_accessService
+      build
+      location = identifier.to_s.gsub(baseURI, serverURL)
+      warn "rewriting access service to #{location}"
+      ds = serialize
+      # warn ds
+      resp = RestClient.put(location, ds, $headers)
+      warn resp.headers
+    end
+  end
+end

data/lib/fdp_client/GUI/catalog.rb

@@ -0,0 +1,56 @@
+module FDPMate
+  class DCATCatalog < DCATResource
+    attr_accessor :primaryTopic, :datasets, :themeTaxonomy, :accessServices
+
+    # def initialize(primary_topic: nil, baseuri: "http://example.org", access_rights: nil, conforms_to: nil, contact_point: nil, resource_creator: nil,
+    #     title: nil, release_date: nil, modification_date: nil, publisher: nil, identifier: nil, license: nil  )
+    def initialize(themeTaxonomy: nil, **args)
+      super
+      # warn "initialize"
+      @datasets = []
+      @accessServices = []
+      @themeTaxonomy = themeTaxonomy
+      self.types = [DCAT.Catalog, DCAT.Resource]
+      init_catalog # create record and get GUID
+      build # make the RDF
+      write_catalog
+    end
+
+    def init_catalog
+      warn "initializing catalog"
+      catinit = <<~END
+        @prefix dcat: <http://www.w3.org/ns/dcat#> .
+        @prefix dct: <http://purl.org/dc/terms/> .
+        @prefix foaf: <http://xmlns.com/foaf/0.1/> .
+
+        <> a dcat:Catalog, dcat:Resource ;
+            dct:title "test" ;
+            dct:hasVersion "1.0" ;
+            dct:publisher [ a foaf:Agent ; foaf:name "Example User" ] ;
+            dct:isPartOf <#{@parentURI}> .
+END
+
+      warn "#{serverURL}/catalog\n\n"
+      # warn "#{catinit}\n\n"
+      # $stderr.puts catinit
+      resp = RestClient.post("#{serverURL}/catalog", catinit, $headers)
+      catlocation = resp.headers[:location]
+      warn "temporary catalog written to #{catlocation}\n\n"
+      self.identifier = RDF::URI(catlocation) # set identifier to where it lives
+    end
+
+    def write_catalog
+      build
+      location = identifier.to_s.gsub(baseURI, serverURL)
+      warn "rewriting cat to #{location}"
+      catalog = serialize
+      # warn catalog
+      resp = RestClient.put(location, catalog, $headers)
+      warn resp.headers
+    end
+
+    def add_dataset(dataset:)
+      @datasets << dataset
+    end
+  end
+end

data/lib/fdp_client/GUI/dataset.rb

@@ -0,0 +1,59 @@
+module FDPMate
+  class DCATDataset < DCATResource
+    attr_accessor :was_generated_by, :distribution, :theme, :landingPage, :distributions
+
+    def initialize(parent_catalog:, theme: nil, landingPage: nil, **args)
+      super
+      @theme = theme
+      @landingPage = landingPage
+      @distributions = []
+
+      self.types = [DCAT.Resource, DCAT.Dataset]
+
+      init_dataset   # create record and get GUID
+      build # make the RDF
+      write_dataset
+      parent_catalog.datasets << self
+    end
+
+    def init_dataset
+      warn "initializing dataset"
+      dsetinit = <<~END
+        @prefix dcat: <http://www.w3.org/ns/dcat#> .
+        @prefix dct: <http://purl.org/dc/terms/> .
+        @prefix foaf: <http://xmlns.com/foaf/0.1/> .
+        <> a dcat:Dataset, dcat:Resource ;
+            dct:title "test" ;
+            dct:hasVersion "1.0" ;
+            dct:publisher [ a foaf:Agent ; foaf:name "Example User" ] ;
+            dcat:theme <http://exampletheme.org/> ;
+            dct:isPartOf <#{@parentURI}> .
+END
+
+      warn "#{@serverURL}/dataset"
+      warn "#{dsetinit}\n\n"
+      warn dsetinit
+      resp = RestClient.post("#{@serverURL}/dataset", dsetinit, $headers)
+      dsetlocation = resp.headers[:location]
+      puts "temporary dataset written to #{dsetlocation}\n\n"
+      self.identifier = RDF::URI(dsetlocation) # set identifier to where it lives
+    end
+
+    def write_dataset
+      build
+      location = identifier.to_s.gsub(baseURI, serverURL)
+      warn "rewriting dset to #{location}"
+      dataset = serialize
+      warn dataset
+      resp = RestClient.put(location, dataset, $headers)
+      warn resp.headers
+    end
+
+    # def datasets
+    #   return $datasets
+    # end
+    # def self.datasets
+    #   return $datasets
+    # end
+  end
+end

data/lib/fdp_client/GUI/distribution.rb

@@ -0,0 +1,55 @@
+module FDPMate
+  class DCATDistribution < DCATResource
+    attr_accessor :mediaType, :format, :accessServices
+
+    def initialize(parent_dataset:, mediaType: nil, format: nil, **args)
+      @accessServices = []
+      @mediaType = mediaType
+      @format = format
+
+      super
+
+      self.types = [DCAT.Resource, DCAT.Distribution]
+      init_distribution # create record and get GUID
+      build # make the RDF
+      write_distribution
+      parent_dataset.distributions << self
+    end
+
+    def init_distribution
+      warn "initializing distribution"
+      distinit = <<~END
+        @prefix dcat: <http://www.w3.org/ns/dcat#> .
+        @prefix dct: <http://purl.org/dc/terms/> .
+        @prefix foaf: <http://xmlns.com/foaf/0.1/> .
+        <> a dcat:Distribution, dcat:Resource ;
+            dct:title "test" ;
+            dct:hasVersion "1.0" ;
+            dct:publisher [ a foaf:Agent ; foaf:name "Example User" ] ;
+            dct:isPartOf <#{@parentURI}> ;
+            dcat:mediaType "text/plain" .
+END
+
+      warn "#{serverURL}/distribution"
+      warn "#{distinit}\n\n"
+      resp = RestClient.post("#{@serverURL}/distribution", distinit, $headers)
+      distlocation = resp.headers[:location]
+      puts "temporary distribution written to #{distlocation}\n\n"
+      self.identifier = RDF::URI(distlocation) # set identifier to where it lives
+    end
+
+    def write_distribution
+      build
+      location = identifier.to_s.gsub(@baseURI, @serverURL)
+      warn "rewriting distribution to #{location}"
+      distribution = serialize
+      warn distribution
+      resp = RestClient.put(location, distribution, $headers)
+      warn resp.headers
+    end
+
+    def add_accessService(accessService:)
+      @accessServices << accessService
+    end
+  end
+end