Code Monkey home page Code Monkey logo

odrl-wprofile-evaltest1's Introduction

ODRL with Profile - Evaluator Testground 1

ODRL - Open Digital Rights Language - has an Information Model and this model defines how to retrieve relevant rights information from a Rule:

  • Is the user allowed to exercise a Permission with a specific asset
  • Does the user's use of an asset align with a Prohibition or violate it
  • Does a user fulfill an Obligation related to an asset

To get such final results some components of a Rule need to be evaluated and their results combined by an ODRL processor - this feature is called ODRL Evaluator by this project.

This project implements all required evaluation steps:

  • are constraints of a Rule Satisfied (or not)
  • are refinements of the action of a Rule Satisfied (or not)
  • has the action of a Duty been exercised (or not), including have its refinements been Satisfied
  • has the action of a Prohibition been exercised (or not), including have its refinements been Satisfied
  • have required consequences of a Duty been Fulfilled (or Not Fulfilled)
  • have required remedies of a Prohibition been Fulfilled (or Not Fulfilled)

All these evaluations are defined in detail by the ODRL Information Model document.

A goal of this project is to support all example policies of the ODRL Information Model document's Candidate Recommendation (CR) version.

As the evaluation of some components require a context (= what action on what asset should be taken by whom ...) and as this project's testground has no context driven be a production environment this implementation supports presetting values relevant for the evaluation by a configuration file including:

  • the filename of the JSON-LD providing the ODRL Policy
  • a free-text description of the test case
  • the identifier of the to-be-tested Rule inside the Policy
  • presets of values like is a constraint or a refinement satisfied or an action exercised

Base on such a defined context the identified Rule is evaluated - step by step - and finally a state for the Rule as a whole is generated. To make the process visible the evaluation of an ODRL Rule is documented step by step.

Documentation

More details are documented by these files:

  • /evaluator/evaluationLogic.md : how components of a Rule are evaluated and how results are evaluated for the Rule's state
  • /testdata/testconfig.md : the configuation file

Overview of files and folders of this project:

  • main.js: the starting point of this project. Run it as Command Line script (node main.js)
  • README.md: this file
  • package.json: configuration file required for Node JS and NPM
  • /evaltest: JS file(s) running the test(s)
  • /evaluator: JS file of the evaluator, file README.md documenting the logic implemented by this evaluator.
  • /model: JS files providing identifiers of Things defined by the ODRL Information Model or an ODRL Profile
  • /services: JS files supporting the project
  • /testdata: JSON-LD files with ODRL Policy data, the test configuration file (YAML)
  • /testdataout: the files created by the ODRL Evaluator (is ignored by git)
  • /testdataout_archive: subfolders holding data of the /testdataout folder of a specific test sequence. (Folder names are dates of running a test suite.)

Errors, Issues, Feedback

To share errors, issues or any other feedback please use the Issues feature of the Github repository.

State, Timeline, Rights

The current state of this project is: complete

  • the evaluation of a Permission is complete
  • the evaluation of a Prohibition is complete
  • the evaluation of an Obligation is complete

This project is published under the MIT license and copyrighted by Michael Steidl/NewsIT

This project was adopted by IPTC as test implementation of the ODRL Candidate Release.

odrl-wprofile-evaltest1's People

Contributors

nitmws avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.