odrl-ruby 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e96a449f1af06d063a0a7e7f60b9fe1785c150a5370774336b5967b049b98a5b
-  data.tar.gz: 9e4e6b649170abea6f73afe667e7f9368a713d8cfaf81b08bfa76c31ac6b2c9e
+  metadata.gz: 920e72e3d22ebf2895fa79bb43bd0a5e5b7d257ffad35bc3a8920a9b2d140649
+  data.tar.gz: 663462477a5b32043293afa56148d2fde102a88bcfe285672d7fa157277ec48d
 SHA512:
-  metadata.gz: d85cc899a5b73c9a1e48d0df3b1e87eca4e7a2d711c074a6988cec7b58570d3c09b9f21dd3fe7f2b72fa432efefe25885d64e901d7bd0835f8d4176f4e025f65
-  data.tar.gz: 4b6538ebe4be2c357da2b5ea41d2ca4db21b3e61e7413ebba5bbdd75cd4642854d1936f2d43201e138d80906b793dc19b7bcd3ba458ee8f724428efc887fd221
+  metadata.gz: c787e947589f888aab1e31f0a429713de6311600e3f5503d8638c1ed73fcd1e585f0b715dccda80cd625a96820b5a226533f83cf48f95581a2fb646b85aaf8aa
+  data.tar.gz: c9f4028606c82de1216c58865131c67060f647b09942ff31ad9b2432b2ccaacf3a32114e67cd9324280055ef7b3ad78ff0fe5eb18200b345389969f96e076395

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3
 
 Style/StringLiterals:
   Enabled: true

data/Gemfile.lock

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

data/lib/odrl/action.rb

@@ -2,28 +2,28 @@
 
 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"
+        # 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"
+        class Action < Base
 
         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"
+        # @option opts [String] :value   the string value of rthe action, like "use"
+        # @option opts [String] :vallabel    the string for the label, like "use"
         #
-        def initialize(args)
-            @value = args[:value]
-            @vallabel = args[:value]
+        def initialize(value:, vallabel: "", type: CACTION, **args)
+            @value = value
+            @vallabel = vallabel || @value
             raise "Actions must haves a value such as 'use' - I'm dead!" unless @value
             @value = "http://www.w3.org/ns/odrl/2/#{@value}" unless @value =~ /http:\/\//  # if it is already a URI, then let it go
 
@@ -31,9 +31,8 @@ module ODRL
             # unless @uid
             #     self.uid = Base.baseURI + "#action_" + Base.getuuid
             # end
-            super(args.merge({uid: @uid}))
+            super(uid: @uid, type: type, **args)
 
-            self.type="http://www.w3.org/ns/odrl/2/Action"
 
             @refinements = Hash.new
 
@@ -102,15 +101,13 @@ module ODRL
 
 
     class Use < Action 
-        def initialize(args)
-            super(args)
-            self.type = "http://www.w3.org/ns/odrl/2/Action" unless self.type
+        def initialize(type: CACTION, **args)
+            super(type: :type, **args)
         end
     end
     class Transfer < Action
-        def initialize(args)
-            super(args)
-            self.type = "http://www.w3.org/ns/odrl/2/Action" unless self.type
+        def initialize(type: CACTION, **args)
+            super(type: :type, **args)
         end
     end
 

data/lib/odrl/asset.rb

@@ -10,17 +10,15 @@ module ODRL
     class Asset < Base
         attr_accessor :uid, :hasPolicy, :refinements, :partOf
 
-        def initialize(args)
-            @uid = args[:uid]
+        def initialize(type: CASSET, hasPolicy: nil, refinements: nil, partOf: nil, **args)
+            @uid = uid
             unless @uid
                 self.uid = Base.baseURI + "#asset_" + Base.getuuid
             end
-            super(args.merge({uid: @uid}))
-            self.type="http://www.w3.org/ns/odrl/2/Asset"
+            super(type: type, uid: @uid, **args)
 
-            @refinements = Hash.new
-            @partOf = args[:partOf]
-            @hasPolicy = args[:hasPolicy]
+            @partOf = partOf
+            @hasPolicy = hasPolicy
 
             if @hasPolicy and !(@hasPolicy.is_a? Policy) # if it exists and is the wrong type
                 raise "The policy of an Asset must be of type ODRL::Policy.  The provided value will be discarded" 
@@ -31,9 +29,10 @@ module ODRL
                 @partOf = nil
             end
 
-            args[:refinements] = [args[:refinements]] unless args[:refinements].is_a? Array
-            if !(args[:refinements].first.nil?)
-                args[:refinements].each do |c|
+            @refinements = Hash.new
+            refinements = [refinements] unless refinements.is_a? Array
+            if !(refinements.first.nil?)
+                refinements.each do |c|
                     self.addRefinement(refinement:  c)
                 end
             end
@@ -82,9 +81,8 @@ module ODRL
 
     class AssetCollection < Asset
 
-        def initialize(args)
-            super(args)
-            self.type="http://www.w3.org/ns/odrl/2/AssetCollection"
+        def initialize(type: CASSETCOLLECTION, **args)
+            super(type: type, **args)
         end
     end
 

data/lib/odrl/base.rb

@@ -2,47 +2,52 @@
 
 require_relative "odrl/version"
 
-# one day move these all to ODRLV.xxxx
-CPOLICY= "http://www.w3.org/ns/odrl/2/Policy"
 
-CSET= "http://www.w3.org/ns/odrl/2/Set"
-COFFER= "http://www.w3.org/ns/odrl/2/Offer"
-CREQUEST= "http://www.w3.org/ns/odrl/2/Request"
-CAGREEMENT= "http://www.w3.org/ns/odrl/2/Agreement"
+CPOLICY= ODRLV.Policy.to_s
 
-PASSET = "http://www.w3.org/ns/odrl/2/target"
-CASSET= "http://www.w3.org/ns/odrl/2/Asset"
+CSET= ODRLV.Set.to_s
+COFFER= ODRLV.Offer.to_s
+CREQUEST= ODRLV.Request.to_s
+CAGREEMENT= ODRLV.Agreement.to_s
+CPRIVACY= ODRLV.Privacy.to_s
+PASSET = ODRLV.target.to_s
+CASSET= ODRLV.Asset.to_s
+CASSETCOLLECTION= ODRLV.Asset.to_s
 
-CPERMISSION= "http://www.w3.org/ns/odrl/2/Permission"
-PPERMISSION = "http://www.w3.org/ns/odrl/2/permission"
-CPROHIBITION= "http://www.w3.org/ns/odrl/2/Prohibition"
-PPROHIBITION = "http://www.w3.org/ns/odrl/2/prohibition"
-PDUTY= "http://www.w3.org/ns/odrl/2/obligation"
-CDUTY = "http://www.w3.org/ns/odrl/2/Duty"
+CRULE= ODRLV.Rule.to_s
+CPERMISSION= ODRLV.Permission.to_s
+PPERMISSION = ODRLV.permission.to_s
+CPROHIBITION= ODRLV.Prohibition.to_s
+PPROHIBITION = ODRLV.prohibition.to_s
+PDUTY= ODRLV.obligation.to_s
+CDUTY = ODRLV.Duty.to_s
 
-PRULE = "http://www.w3.org/ns/odrl/2/Rule"
+PRULE = ODRLV.Rule.to_s
 
 
-PACTION = "http://www.w3.org/ns/odrl/2/action"
-CACTION= "http://www.w3.org/ns/odrl/2/Action"
+PACTION = ODRLV.action.to_s
+VUSE = ODRLV.use.to_s  # this is goofy ODRL stuff... 
+VTRANSFER = ODRLV.transfer.to_s # this is goofy ODRL stuff... 
+CACTION= ODRLV.Action.to_s
 
-PREFINEMENT = "http://www.w3.org/ns/odrl/2/refinement"
+PREFINEMENT = ODRLV.refinement.to_s
 
-PASSIGNER = "http://www.w3.org/ns/odrl/2/assigner"
-PASSIGNEE =  "http://www.w3.org/ns/odrl/2/assignee"
-CPARTY= "http://www.w3.org/ns/odrl/2/Party"
+PASSIGNER = ODRLV.assigner.to_s
+PASSIGNEE =  ODRLV.assignee.to_s
+CPARTY= ODRLV.Party.to_s
+CPARTYCOLLECTION= ODRLV.Party.to_s
 
-PCONSTRAINT = "http://www.w3.org/ns/odrl/2/constraint"
-CCONSTRAINT = "http://www.w3.org/ns/odrl/2/Constraint"
-PLEFT = "http://www.w3.org/ns/odrl/2/leftOperand"
-PRIGHT = "http://www.w3.org/ns/odrl/2/rightOperand"
-POPERATOR = "http://www.w3.org/ns/odrl/2/operator"
-POPERANDREFERENCE = "http://www.w3.org/ns/odrl/2/rightOperandReference"
-PDATATYPE = "http://www.w3.org/ns/odrl/2/dataType"
-PUNIT = "http://www.w3.org/ns/odrl/2/unit"
-PSTATUS = "http://www.w3.org/ns/odrl/2/status"
+PCONSTRAINT = ODRLV.constraint.to_s
+CCONSTRAINT = ODRLV.Constraint.to_s
+PLEFT = ODRLV.leftOperand.to_s
+PRIGHT = ODRLV.rightOperand.to_s
+POPERATOR = ODRLV.operator.to_s
+POPERANDREFERENCE = ODRLV.rightOperandReference.to_s
+PDATATYPE = ODRLV.dataType.to_s
+PUNIT = ODRLV.unit.to_s
+PSTATUS = ODRLV.status.to_s
 
-PPARTOF = "http://www.w3.org/ns/odrl/2/partOf"
+PPARTOF = ODRLV.partOf.to_s
 
 
 PROPERTIES = {
@@ -79,21 +84,31 @@ module ODRL
                 return true
         end
 
-        def initialize(args)
-                #args = defaults.merge(args)
-
-                @title = args[:title]
-                @creator = args[:creator]
-                @description = args[:description]
-                @subject = args[:subject]
-                @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
+        def initialize(
+                title: nil, 
+                creator: nil, 
+                description: nil, 
+                subject: nil, 
+                baseURI: "http://example.org", 
+                uid:, 
+                id: nil, 
+                type:, 
+                label: nil,
+                 **_)
+
+                @title = title
+                @creator = creator
+                @description = description
+                @subject = subject
+                @baseURI = baseURI || ODRL::Base.baseURI
+                @uid = uid
+                @type = type
+                @label = label || @title 
+                @id = @uid
 
                 raise "Every object must have a uid - attempt to create #{@type}" unless @uid
+                raise "Every object must have a type - " unless @type
+                
 
                 $g = RDF::Graph.new()
                 if ENV["TRIPLES_FORMAT"]
@@ -101,23 +116,25 @@ module ODRL
                 else
                         $format = :jsonld
                 end
-                $writer = get_writer(type: $format)  # set it by default
 
         end
 
         def get_writer(type:)
-                $writer = RDF::Writer.for(type).buffer do |w|
-                w.prefix(:foaf, RDF::URI.new("http://xmlns.com/foaf/0.1/"))
-                w.prefix(:dc, RDF::URI.new("http://purl.org/dc/terms/"))
-                w.prefix(:rdf, RDF::URI.new("http://www.w3.org/1999/02/22-rdf-syntax-ns#"))
-                w.prefix(:rdfs, RDF::URI.new("http://www.w3.org/2000/01/rdf-schema#"))
-                w.prefix(:vcard, RDF::URI.new("http://www.w3.org/2006/vcard/ns#"))
-                w.prefix(:odrl, RDF::URI.new("http://www.w3.org/ns/odrl/2/"))
-                w.prefix(:this, RDF::URI.new("http://w3id.org/FAIR_Training_LDP/DAV/home/LDP/DUC-CCE/IPGB#"))
-                w.prefix(:obo, RDF::URI.new("http://purl.obolibrary.org/obo/"))
-                w.prefix(:xsd, RDF::URI.new("http://www.w3.org/2001/XMLSchema#"))
-                end
-                return $writer
+                w = RDF::Writer.for(type)
+                # w.prefix(:foaf, RDF::URI.new("http://xmlns.com/foaf/0.1/"))
+                # w.prefix(:dc, RDF::URI.new("http://purl.org/dc/terms/"))
+                # w.prefix(:rdf, RDF::URI.new("http://www.w3.org/1999/02/22-rdf-syntax-ns#"))
+                # w.prefix(:rdfs, RDF::URI.new("http://www.w3.org/2000/01/rdf-schema#"))
+                # w.prefix(:vcard, RDF::URI.new("http://www.w3.org/2006/vcard/ns#"))
+                # w.prefix(:odrl, RDF::URI.new("http://www.w3.org/ns/odrl/2/"))
+                # w.prefix(:this, RDF::URI.new("http://w3id.org/FAIR_Training_LDP/DAV/home/LDP/DUC-CCE/IPGB#"))
+                # w.prefix(:obo, RDF::URI.new("http://purl.obolibrary.org/obo/"))
+                # w.prefix(:xsd, RDF::URI.new("http://www.w3.org/2001/XMLSchema#"))
+                # w.prefix(:orcid, RDF::URI.new("https://orcid.org/"))
+                # warn "W" 
+                # warn w.prefixes.inspect
+                
+                return w
         end
 
         def triplify(s, p, o, repo)
@@ -174,7 +191,7 @@ module ODRL
         end
 
         def load_graph
-                [:title, :label, :creator, :description, :subject, :uid, :type].each do |method|
+                [:title, :label, :creator, :description, :subject, :uid, :id, :type].each do |method|
                         next unless self.send(method)
                         next if self.send(method).empty?
                         subject = self.uid
@@ -188,7 +205,8 @@ module ODRL
 
         def serialize(format: $format)
                 format = format.to_sym
-                return self.repository.dump(format)
+                w = get_writer(type: format)
+                return w.dump(self.repository)
         end
         
         private  

data/lib/odrl/constraint.rb

@@ -5,31 +5,40 @@ module ODRL
     class Constraint < Base
         
         attr_accessor :uid, :rightOperand, :leftOperand, :operator, :rightOperandReference, :dataType, :unit, :status
-        def initialize(args)
-            @uid = args[:uid]
+        def initialize(
+            uid: nil,
+            rightOperand:,
+            operator:,
+            leftOperand:,
+            rightOPerandReference: nil, 
+            dataType: nil,
+            unit: nil,
+            status: nil,
+            type: CCONSTRAINT,
+            **args)
+
+            @uid = uid
             unless @uid
                 @uid = Base.baseURI + "#constraint_" + Base.getuuid
             end
-            super(args.merge({uid: @uid}))
-
-            self.type = "http://www.w3.org/ns/odrl/2/Constraint"
+            super(uid: @uid, type: type, **args)
 
-            @rightOperand = args[:rightOperand]
+            @rightOperand = rightOperand
             raise "Constraints must haves a Right operand such as 'event' - I'm dead!" unless @rightOperand
             @rightOperand = "http://www.w3.org/ns/odrl/2/#{@rightOperand}" unless @rightOperand =~ /https?:\/\//  # if it is already a URI, then let it go
 
-            @leftOperand = args[:leftOperand]
+            @leftOperand = leftOperand
             raise "Constraints must haves a Left Operand such as 'http://some.event.org/on-now' - I'm dead!" unless @leftOperand
             @leftOperand = "http://www.w3.org/ns/odrl/2/#{@leftOperand}" unless @leftOperand =~ /https?:\/\//  # if it is already a URI, then let it go
 
-            @operator = args[:operator]
+            @operator = operator
             raise "Constraints must haves an operator such as 'eq' - I'm dead!" unless @operator
             @operator = "http://www.w3.org/ns/odrl/2/#{@operator}" unless @operator =~ /https?:\/\//  # if it is already a URI, then let it go
 
-            @rightOperandReference = args[:rightOperandReference]
-            @dataType = args[:dataType]
-            @unit = args[:unit]
-            @status = args[:status]
+            @rightOperandReference = rightOperandReference
+            @dataType = dataType
+            @unit = unit
+            @status = status
         end
 
         def load_graph

data/lib/odrl/odrl/version.rb

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

data/lib/odrl/party.rb

@@ -4,19 +4,25 @@ module ODRL
 
     class Party < Base
         attr_accessor :uid, :refinements, :partOf, :predicate, :type
-        def initialize(args)
-            @uid = args[:uid]
+        def initialize(
+            uid: nil,
+            refinements: nil,
+            partOf: nil,
+            predicate: nil,
+            type: CPARTY,
+            **args
+            )
+
+            @uid = uid
             unless @uid
                 @uid = Base.baseURI + "#party_" + Base.getuuid
             end
-            super(args.merge({uid: @uid}))
-            self.type="http://www.w3.org/ns/odrl/2/Party"
+            super(uid: @uid, type: type, **args)
 
 
             @refinements = Hash.new
-            @partOf = args[:partOf]
-            @predicate = args[:predicate]
-            @type = CPARTY
+            @partOf = partOf
+            @predicate = predicate
 
             unless @predicate
                 raise "If you don't indicate a predicate (assigner/assignee) we will default to assigner.  This may not be what you want!"
@@ -30,9 +36,9 @@ module ODRL
 
 
 
-            args[:refinements] = [args[:refinements]] unless args[:refinements].is_a? Array
-            if !(args[:refinements].first.nil?)
-                args[:refinements].each do |c|
+            refinements = [refinements] unless refinements.is_a? Array
+            if !(refinements.first.nil?)
+                refinements.each do |c|
                     self.addRefinement(refinement:  c)
                 end
             end
@@ -85,9 +91,8 @@ module ODRL
     end
     class PartyCollection < Party
 
-        def initialize(args)
-            super(args)
-            self.type = "http://www.w3.org/ns/odrl/2/PartyCollection"
+        def initialize(type: CPARTYCOLLECTION, **args)
+            super(type: type, **args)
         end
     end
 

data/lib/odrl/policy.rb

@@ -9,12 +9,12 @@ module ODRL
     class Policy  < Base
         attr_accessor :rules
 
-        def initialize(args)
-            @uid = args[:uid]
+        def initialize(uid: nil, type: CPOLICY, **args)
+            @uid = uid
             unless @uid
                 self.uid = Base.baseURI + "#policy_" + Base.getuuid
             end
-            super(args.merge({uid: @uid}))
+            super(uid: @uid, type: type, **args)
             
             @rules = Hash.new
         end
@@ -53,24 +53,30 @@ module ODRL
     end
 
     class Set  < Policy
-        def initialize(args)
-            super({type: CSET}.merge(args))
+        def initialize(type: CSET, **args)
+            super(type: type, **args)
         end
     end
 
     class Offer  < Set
-        def initialize(args)
-            super({type: COFFER}.merge(args))
+        def initialize(type: COFFER, **args)
+            super(type: type, **args)
         end
     end
     class Agreement  < Set
-        def initialize(args)
-            super({type: CAGREEMENT}.merge(args))
+        def initialize(type: CAGREEMENT, **args)
+            super(type: type, **args)
         end
     end
     class Request  < Set
-        def initialize(args)
-            super({type: CREQUEST}.merge(args))
+        def initialize(type: CREQUEST, **args)
+            super(type: type, **args)
+        end
+    end
+
+    class Privacy  < Set
+        def initialize(type: CPRIVACY, **args)
+            super(type: type, **args)
         end
     end
 # ====================================================

data/lib/odrl/rule.rb

@@ -7,13 +7,22 @@ require_relative "odrl/version"
 module ODRL
     class Rule < Base
         attr_accessor :uid, :constraints, :assets, :predicate, :type, :action, :assigner, :assignee
-        def initialize(args)
-            @uid = args[:uid]
+        def initialize(
+            uid: nil,
+            constraints: nil, 
+            assets: nil, 
+            predicate: nil,
+            action: nil, 
+            assigner: nil, 
+            assignee: nil,
+            type: CRULE,
+            **args)
+            @uid = uid
 
             unless @uid
                 @uid = Base.baseURI + "#rule_" + Base.getuuid
             end
-            super(args.merge({uid: @uid}))
+            super(uid: @uid, type: type, **args)
             
             @constraints = Hash.new
             @assets = Hash.new
@@ -21,15 +30,15 @@ module ODRL
             @assignee = Hash.new
             @action = Hash.new
 
-            args[:assets] = [args[:assets]] unless args[:assets].is_a? Array
-            if !(args[:assets].first.nil?)
-                args[:assets].each do |c|
+            assets = [assets] unless assets.is_a? Array
+            if !assets.first.nil?
+                assets.each do |c|
                     self.addAsset(asset: c)
                 end
             end
-            args[:constraints] = [args[:constraints]] unless args[:constraints].is_a? Array
-            if !(args[:constraints].first.nil?)
-                args[:constraints].each do |c|
+            constraints = [constraints] unless constraints.is_a? Array
+            if !constraints.first.nil?
+                constraints.each do |c|
                     self.addConstraint(constraint:  c)
                 end
             end
@@ -99,32 +108,20 @@ module ODRL
 
 
     class Permission  < Rule
-        def initialize(args)
-            super(args)
-            self.predicate = PPERMISSION
-            self.type = CPERMISSION
-
-
+        def initialize(predicate: PPERMISSION, type: CPERMISSION, **args)
+            super(predicate: predicate, type: type, **args)
         end
     end
 
     class Duty  < Rule
-        def initialize(args)
-            super(args)
-            self.predicate = PDUTY
-            self.type = CDUTY
-
-
+        def initialize(predicate: PDUTY, type: CDUTY, **args)
+            super(predicate: predicate, type: type, **args)
         end
     end
 
     class Prohibition < Rule
-        def initialize(args)
-            super(args)
-            self.predicate = PPROHIBITION
-            self.type = CPROHIBITION
-
-
+        def initialize(predicate: PPROHIBITION, type: CPROHIBITION, **args)
+            super(predicate: predicate, type: type, **args)
         end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odrl-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Mark Wilkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies: []
 description: builds ODRL files nicely.
 email:
@@ -47,6 +47,7 @@ metadata:
   homepage_uri: https://example.org
   source_code_uri: https://github.com/markwilkinson/ODRL-RUBY
   changelog_uri: https://github.com/markwilkinson/ODRL-RUBY/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/odrl-ruby/
 post_install_message: 
 rdoc_options: []
 require_paths: