odrl-ruby 0.1.4 → 0.2.0

data/lib/odrl/base.rb

@@ -1,41 +1,42 @@
 # frozen_string_literal: true
 
 require_relative "odrl/version"
+require "linkeddata"
 
+CPOLICY = ODRLV.Policy.to_s
 
-CPOLICY= ODRLV.Policy.to_s
+PPROFILE = ODRLV.profile.to_s
 
-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
+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
+CASSET = ODRLV.Asset.to_s
+CASSETCOLLECTION = ODRLV.Asset.to_s
 
-CRULE= ODRLV.Rule.to_s
-CPERMISSION= ODRLV.Permission.to_s
+CRULE = ODRLV.Rule.to_s
+CPERMISSION = ODRLV.Permission.to_s
 PPERMISSION = ODRLV.permission.to_s
-CPROHIBITION= ODRLV.Prohibition.to_s
+CPROHIBITION = ODRLV.Prohibition.to_s
 PPROHIBITION = ODRLV.prohibition.to_s
-PDUTY= ODRLV.obligation.to_s
+PDUTY = ODRLV.obligation.to_s
 CDUTY = ODRLV.Duty.to_s
 
 PRULE = ODRLV.Rule.to_s
 
-
 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
+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 = ODRLV.refinement.to_s
 
-PASSIGNER = ODRLV.assigner.to_s
-PASSIGNEE =  ODRLV.assignee.to_s
-CPARTY= ODRLV.Party.to_s
-CPARTYCOLLECTION= ODRLV.Party.to_s
+PASSIGNER = ODRLV.assigner.to_s # now in PARTYFUNCTIONS
+PASSIGNEE = ODRLV.assignee.to_s
+CPARTY = ODRLV.Party.to_s
+CPARTYCOLLECTION = ODRLV.Party.to_s
 
 PCONSTRAINT = ODRLV.constraint.to_s
 CCONSTRAINT = ODRLV.Constraint.to_s
@@ -49,168 +50,181 @@ PSTATUS = ODRLV.status.to_s
 
 PPARTOF = ODRLV.partOf.to_s
 
-
 PROPERTIES = {
-        title: DCT.title,
-        creator: DCT.creator,
-        description: DCT.description,
-        id: DCT.identifier,
-        type: RDF.type,
-        subject: DCT.subject,
-        uid: ODRLV.uid,
-        label: RDFS.label,
+  title: DCT.title,
+  creator: DCT.creator,
+  description: DCT.description,
+  id: DCT.identifier,
+  type: RDF.type,
+  subject: DCT.subject,
+  uid: ODRLV.uid,
+  label: RDFS.label,
+  issued: DCT.issued
 }
 
-module ODRL
-        class Base
-
-        @@repository = RDF::Repository.new()
-                
-        attr_accessor :title, :creator, :description, :subject, :baseURI, :uid, :id, :type, :label
-
-        def self.baseURI
-                return ENV['ODRL_BASEURI'] || "http://example.org"
-        end
-
-        def self.repository
-                return @@repository
-        end
-        def repository
-                return @@repository
-        end
-
-        def self.clear_repository
-                @@repository.clear!
-                return true
-        end
-
-        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"]
-                        $format = ENV["TRIPLES_FORMAT"].to_sym
-                else
-                        $format = :jsonld
-                end
+OPERATORS =  %w[eq gt gteq hasPart isA isAllOf isAnyOf isNoneOf isPartOf lt lteq neq]
+LEFTOPERANDS = %w[absolutePosition absoluteSize absoluteSpatialPosition absoluteTemporalPosition
+                  count dateTime delayPeriod deliveryChannel device elapsedTime event
+                  fileFormat industry language media meteredTime payAmount percentage
+                  product purpose recipient relativePosition relativeSize relativeSpatialPosition
+                  relativeTemporalPosition resolution spatial spatialCoordinates system
+                  systemDevice timeInterval unitOfCount version virtualLocation]
+
+PARTYFUNCTIONS = %w[assignee assigner attributedParty attributingParty compensatedParty
+                    compensatingParty consentedParty consentingParty contractedParty contractingParty informedParty
+                    informingParty trackedParty trackingParty]
+
+# INTERESTING>>>> THIS COULD BE USED IF THERE IS A PROFILE...
+# module RemovableConstants
+#         def def_if_not_defined(const, value)
+#           self.class.const_set(const, value) unless self.class.const_defined?(const)
+#         end
+
+#         def redef_without_warning(const, value)
+#           self.class.send(:remove_const, const) if self.class.const_defined?(const)
+#           self.class.const_set(const, value)
+#         end
+# end
 
-        end
-
-        def get_writer(type:)
-                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)
-        
-                if s.class == String
-                        s = s.strip
-                end
-                if p.class == String
-                        p = p.strip
-                end
-                if o.class == String
-                        o = o.strip
-                end
-                
-                unless s.respond_to?('uri')
-                
-                        if s.to_s =~ /^\w+:\/?\/?[^\s]+/
-                                s = RDF::URI.new(s.to_s)
-                        else
-                                raise "Subject #{s.to_s} must be a URI-compatible thingy #{s}, #{p}, #{o}"
-                        end
-                end
-                
-                unless p.respond_to?('uri')
-        
-                        if p.to_s =~ /^\w+:\/?\/?[^\s]+/
-                                p = RDF::URI.new(p.to_s)
-                        else
-                                raise "Predicate #{p.to_s} must be a URI-compatible thingy #{s}, #{p}, #{o}"
-                        end
-                end        
-                unless o.respond_to?('uri')
-                if o.to_s =~ /^\w+:\/?\/?[^\s]+/
-                        o = RDF::URI.new(o.to_s)
-                elsif o.to_s =~ /^\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d/
-                        o = RDF::Literal.new(o.to_s, :datatype => RDF::XSD.date)
-                elsif o.to_s =~ /^\d\.\d/
-                        o = RDF::Literal.new(o.to_s, :datatype => RDF::XSD.float)
-                elsif o.to_s =~ /^[0-9]+$/
-                        o = RDF::Literal.new(o.to_s, :datatype => RDF::XSD.int)
+module ODRL
+  class Base
+    @@repository = RDF::Repository.new
+
+    # If you add an attribute, you mustr also add it to the constructor,
+    # and to the @attribute list
+    # andn to the .load_graph
+    attr_accessor :title, :creator, :description, :subject, :baseURI, :uid, :id, :type, :label, :issued
+
+    def self.baseURI
+      ENV["ODRL_BASEURI"] || "http://example.org"
+    end
+
+    def self.repository
+      @@repository
+    end
+
+    def repository
+      @@repository
+    end
+
+    def self.clear_repository
+      @@repository.clear!
+      true
+    end
+
+    def initialize(
+      uid:, type:, title: nil,
+      creator: nil,
+      description: nil,
+      issued: nil,
+      subject: nil,
+      baseURI: "http://example.org",
+      id: nil,
+      label: nil,
+      **_
+    )
+
+      @title = title
+      @creator = creator
+      @issued = issued
+      @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
+      $format = if ENV["TRIPLES_FORMAT"]
+                  ENV["TRIPLES_FORMAT"].to_sym
                 else
-                        o = RDF::Literal.new(o.to_s, :language => :en)
-                end
-                end
-        
-                triple = RDF::Statement(s, p, o) 
-                repo.insert(triple)
-        
-                return true
-        end
-
-        def self.getuuid
-                return  Time.now.to_f.to_s.gsub("\.", "")[1..14]               
-        end
-
-        def load_graph
-                [: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
-                        predicate = PROPERTIES[method]
-                        # warn "prediate #{predicate} for method #{method}"
-                        object = self.send(method)
-                        repo = self.repository
-                        triplify(subject, predicate, object, repo)
+                  :jsonld
                 end
-        end
-
-        def serialize(format: $format)
-                format = format.to_sym
-                w = get_writer(type: format)
-                return w.dump(self.repository)
-        end
-        
-        private  
-        
-        
-        end
+    end
+
+    def get_writer(type:)
+      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
+    end
+
+    def triplify(s, p, o, repo)
+      s = s.strip if s.instance_of?(String)
+      p = p.strip if p.instance_of?(String)
+      o = o.strip if o.instance_of?(String)
+
+      unless s.respond_to?("uri")
+
+        raise "Subject #{s} must be a URI-compatible thingy #{s}, #{p}, #{o}" unless s.to_s =~ %r{^\w+:/?/?[^\s]+}
+
+        s = RDF::URI.new(s.to_s)
+
+      end
+
+      unless p.respond_to?("uri")
+
+        raise "Predicate #{p} must be a URI-compatible thingy #{s}, #{p}, #{o}" unless p.to_s =~ %r{^\w+:/?/?[^\s]+}
+
+        p = RDF::URI.new(p.to_s)
+
+      end
+      unless o.respond_to?("uri")
+        o = if o.to_s =~ %r{^\w+:/?/?[^\s]+}
+              RDF::URI.new(o.to_s)
+            elsif o.to_s =~ /^\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d/
+              RDF::Literal.new(o.to_s, datatype: RDF::XSD.date)
+            elsif o.to_s =~ /^\d\.\d/
+              RDF::Literal.new(o.to_s, datatype: RDF::XSD.float)
+            elsif o.to_s =~ /^[0-9]+$/
+              RDF::Literal.new(o.to_s, datatype: RDF::XSD.int)
+            else
+              RDF::Literal.new(o.to_s, language: :en)
+            end
+      end
+
+      triple = RDF::Statement(s, p, o)
+      repo.insert(triple)
+
+      true
+    end
+
+    def self.getuuid
+      Time.now.to_f.to_s.gsub(".", "")[1..14]
+    end
+
+    def load_graph
+      %i[title label issued creator description subject uid id type].each do |method|
+        next unless send(method)
+        next if send(method).empty?
+
+        subject = uid # me!
+        predicate = PROPERTIES[method] # look up the predicate for this property
+        # warn "prediate #{predicate} for method #{method}"
+        object = send(method) # get the value of this property from self
+        # warn "value #{object.to_s}"
+        repo = repository
+        triplify(subject, predicate, object, repo)
+      end
+    end
+
+    def serialize(format: $format)
+      format = format.to_sym
+      w = get_writer(type: format)
+      w.dump(repository)
+    end
+  end
 end

data/lib/odrl/constraint.rb

@@ -1,104 +1,110 @@
 # frozen_string_literal: true
 
 module ODRL
+  class Constraint < Base
+    attr_accessor :uid, :rightOperand, :leftOperand, :operator, :rightOperandReference, :dataType, :unit, :status
 
-    class Constraint < Base
-        
-        attr_accessor :uid, :rightOperand, :leftOperand, :operator, :rightOperandReference, :dataType, :unit, :status
-        def initialize(
-            uid: nil,
-            rightOperand:,
-            operator:,
-            leftOperand:,
-            rightOPerandReference: nil, 
-            dataType: nil,
-            unit: nil,
-            status: nil,
-            type: CCONSTRAINT,
-            **args)
+    def initialize(
+      rightOperand:, operator:, leftOperand:, uid: nil,
+      rightOPerandReference: nil,
+      dataType: nil,
+      unit: nil,
+      status: nil,
+      type: CCONSTRAINT,
+      **args
+    )
 
-            @uid = uid
-            unless @uid
-                @uid = Base.baseURI + "#constraint_" + Base.getuuid
-            end
-            super(uid: @uid, type: type, **args)
+      @uid = uid
+      @uid ||= Base.baseURI + "#constraint_" + Base.getuuid
+      super(uid: @uid, type: type, **args)
 
-            @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
+      @rightOperand = rightOperand
+      raise "Constraints must haves a Right operand such as 'event' - I'm dead!" unless @rightOperand
 
-            @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
+      # if it is already a URI, then let it go
+      # @rightOperand = "http://www.w3.org/ns/odrl/2/#{@rightOperand}" unless @rightOperand =~ %r{https?://}
 
-            @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
+      @leftOperand = leftOperand
+      unless LEFTOPERANDS.include?(@leftOperand)
+        warn "The selected leftOperand is not part of the default set... just sayin'"
+      end
+      unless @leftOperand
+        raise "Constraints must haves a Left Operand such as 'http://some.event.org/on-now' - I'm dead!"
+      end
 
-            @rightOperandReference = rightOperandReference
-            @dataType = dataType
-            @unit = unit
-            @status = status
-        end
+      # if it is already a URI, then let it go
+      @leftOperand = "http://www.w3.org/ns/odrl/2/#{@leftOperand}" unless @leftOperand =~ %r{https?://}
 
-        def load_graph
-            super
-            # TODO  This is bad DRY!!  Put the bulk of this method into the base object
-            if self.rightOperand
-                predicate = PRIGHT
-                object = self.rightOperand
-                subject = self.uid
-                repo = self.repository
-                triplify(subject, predicate, object, repo)
-            end
-            if self.leftOperand
-                predicate = PLEFT
-                object = self.leftOperand
-                subject = self.uid
-                repo = self.repository
-                triplify(subject, predicate, object, repo)
-            end
-            if self.operator
-                predicate = POPERATOR
-                object = self.operator
-                subject = self.uid
-                repo = self.repository
-                triplify(subject, predicate, object, repo)
-            end
-            if self.rightOperandReference
-                predicate = POPERANDREFERENCE
-                object = self.rightOperandReference
-                subject = self.uid
-                repo = self.repository
-                triplify(subject, predicate, object, repo)
-            end
-            if self.dataType
-                predicate = PDATATYPE
-                object = self.dataType
-                subject = self.uid
-                repo = self.repository
-                triplify(subject, predicate, object, repo)
-            end
-            if self.unit
-                predicate = PUNIT
-                object = self.unit
-                subject = self.uid
-                repo = self.repository
-                triplify(subject, predicate, object, repo)
-            end
-            if self.status
-                predicate = PSTATUS
-                object = self.status
-                subject = self.uid
-                repo = self.repository
-                triplify(subject, predicate, object, repo)
-            end
-        end
+      @operator = operator
+      raise "Constraints must haves an operator such as 'eq' - I'm dead!" unless @operator
 
-        def serialize(format:)
-            super
-        end
+      warn "The selected operator is not part of the default set... just sayin'" unless OPERATORS.include?(@operator)
 
+      # if it is already a URI, then let it go
+      @operator = "http://www.w3.org/ns/odrl/2/#{@operator}" unless @operator =~ %r{https?://}
+
+      @rightOperandReference = rightOperandReference
+      @dataType = dataType
+      @unit = unit
+      @status = status
     end
 
+    def load_graph
+      super
+      # TODO: This is bad DRY!!  Put the bulk of this method into the base object
+      if rightOperand
+        predicate = PRIGHT
+        object = rightOperand
+        subject = uid
+        repo = repository
+        triplify(subject, predicate, object, repo)
+      end
+      if leftOperand
+        predicate = PLEFT
+        object = leftOperand
+        subject = uid
+        repo = repository
+        triplify(subject, predicate, object, repo)
+      end
+      if operator
+        predicate = POPERATOR
+        object = operator
+        subject = uid
+        repo = repository
+        triplify(subject, predicate, object, repo)
+      end
+      if rightOperandReference
+        predicate = POPERANDREFERENCE
+        object = rightOperandReference
+        subject = uid
+        repo = repository
+        triplify(subject, predicate, object, repo)
+      end
+      if dataType
+        predicate = PDATATYPE
+        object = dataType
+        subject = uid
+        repo = repository
+        triplify(subject, predicate, object, repo)
+      end
+      if unit
+        predicate = PUNIT
+        object = unit
+        subject = uid
+        repo = repository
+        triplify(subject, predicate, object, repo)
+      end
+      return unless status
+
+      predicate = PSTATUS
+      object = status
+      subject = uid
+      repo = repository
+      triplify(subject, predicate, object, repo)
+    end
+
+    def serialize(format:)
+      super
+    end
+  end
 end

data/lib/odrl/odrl/version.rb

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