odrl-ruby 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe2979f7b53376990eda47051aa5eff33f6d67952742b35abb9e650ce5434a09
-  data.tar.gz: 0e9f46bd539435cfe5d601b0d16648850811139fa967f0b948f1984117e6fb6d
+  metadata.gz: 285996251973718c4ba4bea385e1df95bc8b3f23d4e50fc1fa5dd0fc28cb63d4
+  data.tar.gz: dbceab1cb4e5003016dd5f8499ae659e382c8be8a4900ec2a58ae6983bdc0263
 SHA512:
-  metadata.gz: 1d209dd7d1ae1e37aa3a655fd9a76c2be59e8dea5439b05ff0f12fe9ded99aabace239b64e56795a619294b531edfc21191531a514892322699e2b607380f2c6
-  data.tar.gz: 8ebd782fb9662a236befa968a2fccd8e8b36dcf789092d1f22398cac2bda6aafc0b375bc0bc9314ecd0826ce6882e26af92527900f7777be026425aac31c5600
+  metadata.gz: 3385c5e104219c97354693ea4dbb758d8aa69d3ac48a40600c92cf0f45d724517035664d7824349c1904f309d2f4b2294889fc202801c977e2822e4c3d9fe260
+  data.tar.gz: 595f681f2e46d8d506f706fbac63830e4b32b6c05af4c876001420a38662533ac78caee7c7a05b8750588c3120f4689fbfdcd08219eccd13879096cb8fffc76a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    odrl-ruby (0.2.0)
+    odrl-ruby (0.2.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -20,6 +20,10 @@ Or install it yourself as:
 
 ## Usage
 
+# Two functionalities:  Build ODRL Policies;  Build ODRL Profiles to extend the core ODRL vocabulary
+
+# Build Policy:
+
 ```
 require 'odrl/ruby'
 
@@ -65,6 +69,58 @@ result = policy.serialize(format: 'turtle')  # get the RDF string
 puts result
 ```
 
+# Build Profile:
+
+```
+require 'odrl/profile/builder'
+
+p = ODRL::Profile::Builder.new(
+    uri: 'https://example.org/myprofiles/germplasm_odrl_profile.ttl',
+    title: "ODRL Profile for Germplasm resources",
+    description: "There are some properties and comparisons that only make sense in the Germplasm expert domain",
+    author: "Mark D Wilkinson",
+    profile_class: "https://example.org/myprofiles/ontology#SeedOffer"
+)
+
+p.asset_relations << ODRL::Profile::AssetRelation.new( 
+    uri: "https://example.org/myprofiles/ontology#nagoya_permission",
+    label: "Permission under Nagoya protocol", 
+    definition: "Permission is a special thing in the Nagoya protocol")
+
+
+p.party_functional_roles << ODRL::Profile::AssetRelation.new(  
+    uri: "https://example.org/myprofiles/ontology#nagoya_assigner",
+    label: "Assigner with Nagoya authority to assign", 
+    definition: "Assigners have special responsibilities in the Nagoya protocol")
+
+p.actions << ODRL::Profile::Rule.new( 
+    uri: "https://example.org/myprofiles/ontology#nagoya_propogate",
+    label: "Plant and Harvest", 
+    definition: "the action of planting and harvesting the seed", 
+    included_in: ODRLV.use,
+    implies: ODRLV.distribute)
+
+
+p.leftOperands << ODRL::Profile::LeftOperand.new( 
+    uri: "https://example.org/myprofiles/ontology#at_risk_species",
+    label: "At Risk Species", 
+    definition: "A species that has been flagged as at-risk of extinction")
+
+p.rightOperands << ODRL::Profile::RightOperand.new( 
+    uri: "https://example.org/myprofiles/ontology#on_watchlist",
+    label: "On Watchlist", 
+    definition: "A species whose risk of extinction is on a watchlist")
+
+p.rightOperands << ODRL::Profile::Relation.new( 
+    uri: "https://example.org/myprofiles/ontology#within_risk_boundary",
+    label: "Within Bounds", 
+    definition: "comparison of risk boundaries")
+
+
+p.build()
+puts p.serialize
+```
+
 
 ## License
 

data/examples/biohackathon-output.ttl

@@ -1,47 +1,63 @@
 @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
 
-<http://example.org#action_68785487525736>
-    <http://purl.org/dc/terms/identifier> <http://example.org#action_68785487525736> ;
-    a <http://www.w3.org/ns/odrl/2/Action> .
-
-<http://example.org#constraint_68785487525880>
-    <http://purl.org/dc/terms/identifier> <http://example.org#constraint_68785487525880> ;
+<http://example.org#constraint_68811358965684>
+    <http://purl.org/dc/terms/identifier> <http://example.org#constraint_68811358965684> ;
     <http://purl.org/dc/terms/title> "Only during the hackathon"@en ;
     a <http://www.w3.org/ns/odrl/2/Constraint> ;
+    <http://www.w3.org/2000/01/rdf-schema#label> "Only during the hackathon"@en ;
     <http://www.w3.org/ns/odrl/2/leftOperand> <http://www.w3.org/ns/odrl/2/event> ;
     <http://www.w3.org/ns/odrl/2/operator> <http://www.w3.org/ns/odrl/2/eq> ;
-    <http://www.w3.org/ns/odrl/2/rightOperand> <https://2023.biohackathon.org> .
+    <http://www.w3.org/ns/odrl/2/rightOperand> <https://2023.biohackathon.org> ;
+    <http://www.w3.org/ns/odrl/2/uid> <http://example.org#constraint_68811358965684> .
 
-<http://example.org#policy_68785487446247>
+<http://example.org#policy_68811358965627>
     <http://purl.org/dc/terms/creator> <https://orcid.org/0000-0001-6960-357X> ;
     <http://purl.org/dc/terms/description> "An offer for Toshiaki-san to use the polyA data during the hackathon"@en ;
-    <http://purl.org/dc/terms/identifier> <http://example.org#policy_68785487446247> ;
+    <http://purl.org/dc/terms/identifier> <http://example.org#policy_68811358965627> ;
     <http://purl.org/dc/terms/subject> "collaboration"@en ;
     <http://purl.org/dc/terms/title> "Offer to Toshiaki-san"@en ;
     a <http://www.w3.org/ns/odrl/2/Offer> ;
-    <http://www.w3.org/ns/odrl/2/permission> <http://example.org#rule_68785487525598> .
+    <http://www.w3.org/2000/01/rdf-schema#label> "Offer to Toshiaki-san"@en ;
+    <http://www.w3.org/ns/odrl/2/permission> <http://example.org#rule_68811358965667> ;
+    <http://www.w3.org/ns/odrl/2/uid> <http://example.org#policy_68811358965627> .
 
-<http://example.org#rule_68785487525598>
-    <http://purl.org/dc/terms/identifier> <http://example.org#rule_68785487525598> ;
+<http://example.org#rule_68811358965667>
+    <http://purl.org/dc/terms/identifier> <http://example.org#rule_68811358965667> ;
     <http://purl.org/dc/terms/title> "Permission to use"@en ;
     a <http://www.w3.org/ns/odrl/2/Permission> ;
-    <http://www.w3.org/ns/odrl/2/action> <http://example.org#action_68785487525736> ;
+    <http://www.w3.org/2000/01/rdf-schema#label> "Permission to use"@en ;
+    <http://www.w3.org/ns/odrl/2/action> <http://www.w3.org/ns/odrl/2/use> ;
     <http://www.w3.org/ns/odrl/2/assignee> <https://orcid.org/0000-0001-6960-357X> ;
     <http://www.w3.org/ns/odrl/2/assigner> <https://orcid.org/0000-0003-2391-0384> ;
-    <http://www.w3.org/ns/odrl/2/constraint> <http://example.org#constraint_68785487525880> ;
-    <http://www.w3.org/ns/odrl/2/target> <http://mark.wilkinson.org/data/polyA> .
+    <http://www.w3.org/ns/odrl/2/constraint> <http://example.org#constraint_68811358965684> ;
+    <http://www.w3.org/ns/odrl/2/target> <http://mark.wilkinson.org/data/polyA> ;
+    <http://www.w3.org/ns/odrl/2/uid> <http://example.org#rule_68811358965667> .
 
 <http://mark.wilkinson.org/data/polyA>
     <http://purl.org/dc/terms/identifier> <http://mark.wilkinson.org/data/polyA> ;
     <http://purl.org/dc/terms/title> "Mark's PolyA Database"@en ;
-    a <http://www.w3.org/ns/odrl/2/Asset> .
+    a <http://www.w3.org/ns/odrl/2/Asset> ;
+    <http://www.w3.org/2000/01/rdf-schema#label> "Mark's PolyA Database"@en ;
+    <http://www.w3.org/ns/odrl/2/uid> <http://mark.wilkinson.org/data/polyA> .
+
+<http://www.w3.org/ns/odrl/2/use>
+    <http://purl.org/dc/terms/identifier> <http://www.w3.org/ns/odrl/2/use> ;
+    a "type"@en ;
+    <http://www.w3.org/2000/01/rdf-schema#label> ""@en ;
+    <http://www.w3.org/ns/odrl/2/uid> <http://www.w3.org/ns/odrl/2/use> ;
+    <https://schema.org/name> ""@en .
 
 <https://orcid.org/0000-0001-6960-357X>
     <http://purl.org/dc/terms/identifier> <https://orcid.org/0000-0001-6960-357X> ;
     <http://purl.org/dc/terms/title> "Mark D Wilkinson"@en ;
-    a <http://www.w3.org/ns/odrl/2/Party> .
+    a <http://www.w3.org/ns/odrl/2/Party> ;
+    <http://www.w3.org/2000/01/rdf-schema#label> "Mark D Wilkinson"@en ;
+    <http://www.w3.org/ns/odrl/2/uid> <https://orcid.org/0000-0001-6960-357X> .
 
 <https://orcid.org/0000-0003-2391-0384>
     <http://purl.org/dc/terms/identifier> <https://orcid.org/0000-0003-2391-0384> ;
     <http://purl.org/dc/terms/title> "Toshiaki Katayama"@en ;
-    a <http://www.w3.org/ns/odrl/2/Party> .
+    a <http://www.w3.org/ns/odrl/2/Party> ;
+    <http://www.w3.org/2000/01/rdf-schema#label> "Toshiaki Katayama"@en ;
+    <http://www.w3.org/ns/odrl/2/uid> <https://orcid.org/0000-0003-2391-0384> .
+

data/examples/build_profile.rb

@@ -1,4 +1,4 @@
-require '../lib/odrl/profile/builder.rb'
+require 'odrl/profile/builder'
 
 p = ODRL::Profile::Builder.new(
     uri: 'https://example.org/myprofiles/germplasm_odrl_profile.ttl',
@@ -14,7 +14,7 @@ p.asset_relations << ODRL::Profile::AssetRelation.new(
     definition: "Permission is a special thing in the Nagoya protocol")
 
 
-p.party_functional_roles << ODRL::Profile::AssetRelation.new(  
+p.party_functional_roles << ODRL::Profile::PartyFunction.new(  
     uri: "https://example.org/myprofiles/ontology#nagoya_assigner",
     label: "Assigner with Nagoya authority to assign", 
     definition: "Assigners have special responsibilities in the Nagoya protocol")
@@ -37,7 +37,7 @@ p.rightOperands << ODRL::Profile::RightOperand.new(
     label: "On Watchlist", 
     definition: "A species whose risk of extinction is on a watchlist")
 
-p.rightOperands << ODRL::Profile::Relation.new( 
+p.operators << ODRL::Profile::Operator.new( 
     uri: "https://example.org/myprofiles/ontology#within_risk_boundary",
     label: "Within Bounds", 
     definition: "comparison of risk boundaries")

data/lib/odrl/odrl/version.rb

@@ -2,6 +2,6 @@
 
 module ODRL
   module ODRL
-    VERSION = "0.2.0"
+    VERSION = "0.2.2"
   end
 end

data/lib/odrl/party.rb

@@ -18,8 +18,8 @@ module ODRL
       super(uid: @uid, type: type, **args)
 
       @refinements = {}
-      @partOf = partOf
-      @predicate = predicate
+      @partOf = {}
+      @predicate = predicate.to_s
 
       if @predicate&.match(/https?:/)
         # do nothing! It's their choice to send a full predicate!
@@ -42,10 +42,17 @@ module ODRL
         end
       end
 
-      return unless @partOf and !(@partOf.is_a? PartyCollection) # if it exists and is the wrong type
+      partOf = [partOf] unless partOf.is_a? Array
+      unless partOf.first.nil?
+        partOf.each do |p|
+          p.addPart(part: self)
+        end
+      end
+
+      unless @partOf and !(@partOf.is_a? PartyCollection) # if it exists and is the wrong type
+        raise "The parent collection of a Party must be of type ODRL::PaertyCollection."
+      end
 
-      raise "The parent collection of a Party must be of type ODRL::PaertyCollection."
-      # @partOf = nil
     end
 
     def addRefinement(refinement: args)
@@ -55,16 +62,15 @@ module ODRL
     end
 
     def addPart(part: args)
-      raise "Party cannot be added as part of something that is not an PartyCollection" unless is_a?(PartyCollection)
-      raise "Only Parties can be added as part of PartyCollections" unless part.is_a?(Asset)
-
+      raise "Party cannot be added as part of something that is not an PartyCollection" unless self.is_a?(PartyCollection)
       part.partOf[uid] = [PPARTOF, self]
     end
 
     def load_graph
       super
       # TODO: This is bad DRY!!  Put the bulk of this method into the base object
-      %i[refinements partOf].each do |connected_object_type|
+      # TODO:  Currently we don't support partOf
+      %i[refinements].each do |connected_object_type|
         next unless send(connected_object_type)
 
         send(connected_object_type).each do |_uid, typedconnection|

data/lib/odrl/profile/builder.rb

@@ -16,7 +16,7 @@ module ODRL
   module Profile
     class Builder
       attr_accessor :uri, :profile_class, :repository, :title, :description, :author 
-      attr_accessor :asset_relations, :party_functional_roles, :actions, :leftOperands, :rightOperands
+      attr_accessor :asset_relations, :party_functional_roles, :actions, :leftOperands, :rightOperands, :operators
 
       # attr_accessor :logicalConstraints, :conflict_strategies, :rules
       def initialize(uri:, profile_class:, title:, description:, author:)
@@ -31,6 +31,7 @@ module ODRL
         @actions = []
         @leftOperands = []
         @rightOperands = []
+        @operators = []
         @asset_relations = []
 
         # Required declarations of disjointedness
@@ -49,7 +50,7 @@ module ODRL
         description and ODRL::Profile::Builder.triplify(uri, DCT.title, description, repo)
         author and ODRL::Profile::Builder.triplify(uri, DC.creator, author, repo)
 
-        [asset_relations, party_functional_roles, actions, leftOperands, rightOperands, asset_relations].flatten.each do |elem|
+        [asset_relations, party_functional_roles, actions, leftOperands, rightOperands, operators].flatten.each do |elem|
           elem.build(repo: repo)
         end
       end
@@ -173,7 +174,7 @@ module ODRL
       end
     end
 
-    class Relation < ProfileElement
+    class Operator < ProfileElement
       # ex:myOperator a odrl:Operator .
       def build(repo:)
         ODRL::Profile::Builder.triplify(uri, RDF.type, ODRLV.Operator, repo)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odrl-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Mark Wilkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-30 00:00:00.000000000 Z
+date: 2023-07-01 00:00:00.000000000 Z
 dependencies: []
 description: A builder for ODRL files. Does basic validation against core ODRL vocabularies.
   Has a Builder that allows you to create ODRL Profiles to extend the core vocabulary.  DOES