odrl-ruby 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb0c189a2525a3571135dcf826b1564c4fe2b7cba12cb1da11070b14b02b8d7f
-  data.tar.gz: 8fd96e53f85538edaf482bb8a3a70fc2f41963e1e33815ce86dc07385d8c6ad8
+  metadata.gz: e96a449f1af06d063a0a7e7f60b9fe1785c150a5370774336b5967b049b98a5b
+  data.tar.gz: 9e4e6b649170abea6f73afe667e7f9368a713d8cfaf81b08bfa76c31ac6b2c9e
 SHA512:
-  metadata.gz: 73442b39ecdfa15aa2a1e5901916bc6302bc3af4b29b445f452982fa395cc10b272ed360b50262e350eaf3f5f748e7492b3a8293841baf82035ededb1abb986f
-  data.tar.gz: 2dd24c86e07382a59f47cfc50a1c047a948328c47e19ca499c68afc988ce74d3141d8d8522ce368adc5af3439cbe3bb871dbed3d0e357d1cff9117b387adf551
+  metadata.gz: d85cc899a5b73c9a1e48d0df3b1e87eca4e7a2d711c074a6988cec7b58570d3c09b9f21dd3fe7f2b72fa432efefe25885d64e901d7bd0835f8d4176f4e025f65
+  data.tar.gz: 4b6538ebe4be2c357da2b5ea41d2ca4db21b3e61e7413ebba5bbdd75cd4642854d1936f2d43201e138d80906b793dc19b7bcd3ba458ee8f724428efc887fd221

data/README.md

@@ -1,10 +1,8 @@
-# THIS IS NOT READY FOR USE!  ...SO DON'T!  :-)
+# THIS IS BARELY READY FOR USE!  DON'T EXPECT MIRACLES
 
 # ODRL::Ruby
 
-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/odrl/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a gem to build ODRL records, and serialize them
 
 ## Installation
 
@@ -24,17 +22,51 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. 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
+```
+require 'odrl/ruby'
+
+# an offer to toshiaki from mark to use the polyA resource during the biohackathon
+
+# core annotatons are:  :title, :creator, :description, :subject :baseURI, :uid, :type
+policy = ODRL::Offer.new(
+    title: "Offer to Toshiaki-san", 
+    creator: "https://orcid.org/0000-0001-6960-357X", 
+    description: "An offer for Toshiaki-san to use the polyA data during the hackathon",
+    subject: "collaboration", # this is the CCE category - useful for EJP-RD ONLYU
+)
+
+asset = ODRL::Asset.new(uid: "http://mark.wilkinson.org/data/polyA", title: "Mark's PolyA Database")
+
+# you indicate the type of party by assigning the predicate (either assigner or assignee)
+# ODRLV is the RDF::Vocabulary for ODRL, exported to this namespace
+mark = ODRL::Party.new(uid: "https://orcid.org/0000-0001-6960-357X", predicate: ODRLV.assigner, title: "Mark D Wilkinson" )
+toshiaki = ODRL::Party.new(uid: "https://orcid.org/0000-0003-2391-0384", predicate: ODRLV.assignee, title: "Toshiaki Katayama")
+
+# Rules
+permission = ODRL::Permission.new(title: "Permission to use")
+
+use = ODRL::Use.new(value: "use") # subclass of ODRL::Action
+
+# Constraints: :uid, :rightOperand, :leftOperand, :operator, :rightOperandReference, :dataType, :unit, :status
+constraint = ODRL::Constraint.new(
+    title: "Only during the hackathon",
+    leftOperand: "event",
+    operator: "eq",
+    rightOperand: "https://2023.biohackathon.org"
+)
+permission.addConstraint(constraint: constraint)
+permission.addAsset(asset: asset)
+permission.addAssigner(party: toshiaki)
+permission.addAssignee(party: mark)
+permission.addAction(action: use)
+
+policy.addPermission(rule: permission)
+
+policy.load_graph  # this brings the triples into memory, cascading down all objects conneted to "policuy"
+result = policy.serialize(format: 'turtle')  # get the RDF string
+puts result
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/odrl-ruby.
 
 ## License
 

data/examples/output.ttl

@@ -0,0 +1,47 @@
+@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://purl.org/dc/terms/title> "Only during the hackathon"@en ;
+    a <http://www.w3.org/ns/odrl/2/Constraint> ;
+    <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://example.org#policy_68785487446247>
+    <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/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://example.org#rule_68785487525598>
+    <http://purl.org/dc/terms/identifier> <http://example.org#rule_68785487525598> ;
+    <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/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://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> .
+
+<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> .
+
+<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> .

data/lib/odrl/action.rb

@@ -3,7 +3,24 @@
 module ODRL
 
     class Action < Base
+# ODRL::Action
+# Describes an action like "use"
+# 
+# @author Mark D Wilkinson
+# @attr [URI] (optional) uid the URI of the Action node
+# @attr [[ODRL::Refinement]] (optional) ODRL Refinement objects
+# @attr [URI] predicate (optional) the predicate you wish to use with this action
+# @attr [string] value (required) a string like "use"
+# @attr [string] vallabel (optional) a string like "use"
+
         attr_accessor :uid, :refinements, :predicate, :type, :value, :vallabel
+
+
+        # constructor
+        # @param  [Hash] opts  the options to create a message with.
+        # @option :value   the string value of rthe action, like "use"
+        # @option :vallabel    the string for the label, like "use"
+        #
         def initialize(args)
             @value = args[:value]
             @vallabel = args[:value]
@@ -31,6 +48,10 @@ module ODRL
 
         end
 
+        # Adds an ODRL Refinement
+        #
+        # @param refinement [ODRL::Refinement]  the refinement to the action
+        #
         def addRefinement(refinement: args)
             unless refinement.is_a?(Constraint)
                 raise "Refinement is not an ODRL Constraint" 
@@ -40,6 +61,9 @@ module ODRL
         end
 
 
+        # Causes the triples of this object to be formed in the in-memory store
+        # This includes any "cascading" objects for which this is the subject of the triple
+        #
         def load_graph
             super
             # TODO  This is bad DRY!!  Put the bulk of this method into the base object
@@ -65,7 +89,11 @@ module ODRL
             triplify(subject, predicate, object, repo)
         end
 
-        def serialize
+        # Returns the serialized RDF for this object and cascading related objects
+        #
+        # @param format [Symbol] a valid RDF::Writer format (e.g. :turtle)
+        #
+        def serialize(format:)
             super
         end
 

data/lib/odrl/asset.rb

@@ -2,6 +2,11 @@
 
 module ODRL
 
+
+    # ODRL::Action
+    # Describes an action like "use"
+    # 
+    # @author Mark D Wilkinson
     class Asset < Base
         attr_accessor :uid, :hasPolicy, :refinements, :partOf
 

data/lib/odrl/base.rb

@@ -49,10 +49,11 @@ PROPERTIES = {
         title: DCT.title,
         creator: DCT.creator,
         description: DCT.description,
-        uid: DCT.identifier,
+        id: DCT.identifier,
         type: RDF.type,
-        subject: DCT.subject
-
+        subject: DCT.subject,
+        uid: ODRLV.uid,
+        label: RDFS.label,
 }
 
 module ODRL
@@ -60,7 +61,7 @@ module ODRL
 
         @@repository = RDF::Repository.new()
                 
-        attr_accessor :title, :creator, :description, :subject, :baseURI, :uid, :type
+        attr_accessor :title, :creator, :description, :subject, :baseURI, :uid, :id, :type, :label
 
         def self.baseURI
                 return ENV['ODRL_BASEURI'] || "http://example.org"
@@ -88,6 +89,8 @@ module ODRL
                 @baseURI = args[:baseURI] || self.baseURI
                 @uid = args[:uid]
                 @type = args[:type]
+                @label = args[:label] || @title 
+                @id = args[:uid] || nil
                 #@repository = RDF::Repository.new() unless self.repository
 
                 raise "Every object must have a uid - attempt to create #{@type}" unless @uid
@@ -171,12 +174,12 @@ module ODRL
         end
 
         def load_graph
-                [:title, :creator, :description, :subject, :uid, :type].each do |method|
+                [:title, :label, :creator, :description, :subject, :uid, :type].each do |method|
                         next unless self.send(method)
                         next if self.send(method).empty?
                         subject = self.uid
                         predicate = PROPERTIES[method]
-                        #warn "prediate #{predicate} for method #{method}"
+                        # warn "prediate #{predicate} for method #{method}"
                         object = self.send(method)
                         repo = self.repository
                         triplify(subject, predicate, object, repo)

data/lib/odrl/odrl/version.rb

@@ -2,6 +2,6 @@
 
 module ODRL
   module ODRL
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: odrl-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Mark Wilkinson
@@ -26,7 +26,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/builder-translator-output.ttl
 - examples/create-biohackathon-offer.rb
+- examples/output.ttl
 - launch.json
 - lib/odrl/action.rb
 - lib/odrl/asset.rb
@@ -37,7 +39,6 @@ files:
 - lib/odrl/policy.rb
 - lib/odrl/ruby.rb
 - lib/odrl/rule.rb
-- testme.rb
 homepage: https://example.org
 licenses:
 - MIT

data/testme.rb

@@ -1,28 +0,0 @@
-require_relative "./lib/odrl/policy.rb"
-require_relative "./lib/odrl/rule.rb"
-require_relative "./lib/odrl/base.rb"
-require_relative "./lib/odrl/asset.rb"
-require_relative "./lib/odrl/constraint.rb"
-
-
-t = ODRL::Policy.new(
-    title: "this",
-    author: "mark",
-    baseURI: "http://adsjfhalsdjfasdh",
-
-)
-
-pro = ODRL::Prohibition.new({})
-# puts t.methods
-# abort
-# t.addProhibition(rule: pro)
-# puts t.rules.length
-# puts t.rules[t.rules.keys.first][1].inspect
-# puts t.rules[t.rules.keys.first][1].class.to_s == "ODRL::Prohibition"
-
-#p t.inspect
-c1 = ODRL::Constraint.new({})
-#p c1.inspect
-c2 = ODRL::Constraint.new({})
-d = ODRL::Duty.new({constraints: c1})
-puts d.inspect