ruby_yappl 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 548e9ea2f6becf27d913698c0c8dd271c7497910
-  data.tar.gz: 70459291c60cd6ee0924fffd30b481904c54cc06
+SHA256:
+  metadata.gz: 303f8d9e0482d59481537014c99ddb6d7c47156ce30979f0609814150ea16c56
+  data.tar.gz: '00498f3f6264ccf674e5b87914269cbd37e1bbf602ae8665dfc35b44e6166b29'
 SHA512:
-  metadata.gz: 613317c795f74ff0f3b2ab80761b6e11a2e2c2f6bd92755cb5bc7a548aa92f91955942bba9b3ee97f39fd406132a8dc6696fcbda756e1c3facd3da138b153016
-  data.tar.gz: bada8ddaa7785d2548e434cb8576b7e00c441f6d7184167a639cd3289a49b139cb56e75a9342ecbae017aa4443c0c95dceb0881445368410c2366be4a2c46199
+  metadata.gz: d88a43fe6c88cb1fa49194ff860add062e930d6892544351b8a67a6225b689de8708cd1ec3b0af33095f700be6f50a493f03077d12b1b123ce366f82753a7cbf
+  data.tar.gz: fe97b78e2e52c3fbcd37fcdf110e533f04441a453100c16f55507da4d04925b3cd030929a9d9e1e776dcdf571075ba60aa13e5c687435cf53d7b2e14492fb32c

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.5.1
+
+script:
+  - bundle exec rspec
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :test, :development do
+  gem 'rspec'
+end
+
+gem 'json-schema'

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    diff-lcs (1.3)
+    json-schema (2.8.0)
+      addressable (>= 2.4)
+    public_suffix (3.0.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json-schema
+  rspec
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2018, 2019 Thomas Peikert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Ruby Library for YaPPL
+
+[![Build Status](https://travis-ci.com/TPei/ruby_yappl.svg?branch=master)](https://travis-ci.com/TPei/ruby_yappl)
+[![Gem Version](https://badge.fury.io/rb/ruby_yappl.svg)](https://rubygems.org/gems/ruby_yappl)
+[![Release](https://img.shields.io/github/release/tpei/ruby_yappl.svg)](https://github.com/TPei/ruby_yappl/releases)
+
+## What is YaPPL?
+
+YaPPL is a Privacy Preference Language (see [YaPPL](https://github.com/maroulb/YaPPL))
+
+> YaPPL allows to codify legally sufficient consent and thus provides a valuable basis for GDPR-compliant consent management. In a nutshell, YaPPL is a message and file format that, in combination with the proposed service architecture, a) fulfills legal requirements for technically mediated consent provision, b) can act as an archive for expired preferences for auditing purposes, c) provides an enhanced user-centric access control model for future or unforeseen data processing requests. - Ulbricht & Pallas, 2018
+
+
+## What is this?
+
+This is a Ruby Gem to work with YaPPL policies :)
+
+## Usage
+
+First, you need to add this to your Gemfile: `gem 'ruby_yappl'` and then
+run `bundle install`, now you have it installed. `require 'ruby_yappl'` to require the files.
+
+The gem provides different classes to use, mainly `YaPPL::Policy` and `YaPPL::Rule`.
+
+A policy can be created by parsing a policy file. Simply pass the json to `YaPPL::Policy.from_policy_file`.
+This will instantiate a `YaPPL::Policy` and the appropriate `YaPPL::Rule` objects.
+
+`Policy` provides a few public methods in accordance with the official
+[YaPPL](https://github.com/maroulb/YaPPL) definition:
+
+* `#create_policy` serializes the classes to their json representation to
+be saved to database or file.
+
+* `#get_excluded_purpose` returns an array of all excluded purposes
+
+* `#get_excluded_utilizer` returns an array of all excluded utilizers
+
+* `#new_rule(args)` adds a new rule to the Policy. `#add_rule(rule)` can
+also be used if you prefer handling objects instead of parameters.
+
+* `#get_tr_rules` returns an array of Transformation rules, including
+the utilizers and purposes they depend on.
+
+* `#archive_rule(rule_id)` expires and archives a rule.
+
+* `#update_rule(rule_id, args)` updates a rule, archiving its old state.
+
+Additionally, `YaPPL::Rule#expired?` can be used to see if a rule still applies.
+
+### Demo
+```ruby
+require 'ruby_yappl'
+
+# deserialize
+policy = YaPPL::Policy.from_json_file(File.read('./my_policy_file.json'))
+
+# update a rule
+policy.update_rule(4, {
+  permitted_purposes: ['data_analysis'],
+  excluded_purposes: ['marketing'],
+  permitted_utilizers: ['market_research'],
+  excluded_utilizers: ['shopping', 'social_networks'],
+  transformations: [{
+    attribute: 'temperature',
+    tr_func: 'minmax_hourly'
+  }]
+})
+
+# archive a rule
+policy.archive_rule(5)
+
+# reserialize
+File.new('./my_policy.json', 'w').write(policy.create_policy)
+
+```

data/lib/exceptions.rb

@@ -0,0 +1 @@
+class SchemaError < StandardError; end

data/lib/json_validator.rb

@@ -0,0 +1,11 @@
+require 'json-schema'
+
+class JsonValidator
+  def self.validate(schema_name, data)
+    name = "schemas/#{schema_name}.json"
+    schema = File.expand_path(name, __FILE__)
+    JSON::Validator.validate(schema, data)
+  rescue JSON::Schema::JsonParseError, JSON::Schema::UriError
+    false
+  end
+end

data/lib/ruby_yappl.rb

@@ -1,8 +1,9 @@
-require './lib/parser'
-require './lib/policy'
-require './lib/rule'
-require './lib/exceptions'
-require './lib/json_validator'
+require 'parser'
+require 'policy'
+require 'rule'
+require 'exceptions'
+require 'json_validator'
 
 module YaPPL
+  VERSION = "0.1.3"
 end

data/lib/schemas/yappl.json

@@ -0,0 +1,100 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "definitions": {},
+  "type": "object",
+  "properties": {
+    "_id": {"type": "number"},
+    "preference": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "rule": {
+            "type": "object",
+            "properties": {
+              "purpose": {
+                "type": "object",
+                "properties": {
+                  "permitted": {
+                    "type": "array",
+                    "items": {"type": "string"},
+                    "uniqueItems": true,
+                    "default": []
+                  },
+                  "excluded": {
+                    "type": "array",
+                    "items": {"type": "string"},
+                    "uniqueItems": true,
+                    "default": []
+                  }
+                },
+                "required": ["permitted", "excluded"],
+                "minProperties": 2,
+                "maxProperties": 2,
+                "additionalProperties": false
+              },
+              "utilizer": {
+                "type": "object",
+                "properties": {
+                  "permitted": {
+                    "type": "array",
+                    "items": {"type": "string"},
+                    "uniqueItems": true,
+                    "default": []
+                  },
+                  "excluded": {
+                    "type": "array",
+                    "items": {"type": "string"},
+                    "uniqueItems": true,
+                    "default": []
+                  }
+                },
+                "required": ["permitted", "excluded"],
+                "minProperties": 2,
+                "maxProperties": 2,
+                "additionalProperties": false
+              },
+              "transformation": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "attribute": {"type": "string"},
+                    "tr_func": {
+                      "type": "string",
+                      "default": ""
+                    }
+                  },
+                  "dependencies": {
+                    "attribute": ["tr_func"],
+                    "tr_func": ["attribute"]
+                  },
+                  "minProperties": 2,
+                  "maxProperties": 2,
+                  "additionalProperties": false
+                },
+                "uniqueItems": true,
+                "default": []
+              },
+              "valid_from": {
+                "type": "string",
+                "format": "date-time"
+              },
+              "exp_date": {
+                "type": "string",
+                "format": "date-time",
+                "default": "0000-00-00T00:00:00.00Z"
+              }
+            },
+            "required": ["purpose", "utilizer", "transformation", "valid_from", "exp_date"],
+            "minProperties": 5,
+            "maxProperties": 5,
+            "additionalProperties": false
+          }
+        }
+      },
+      "uniqueItems": true,
+      "minItems": 1
+    }
+  }
+}

data/ruby_yappl.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = 'ruby_yappl'
+  s.version = '0.1.3'
+  s.date = '2019-01-21'
+  s.summary = 'ruby gem for the yappl privacy preference language'
+  s.authors = ['Thomas Peikert']
+  s.email = 't.s.peikert+yappl@gmail.com'
+  s.homepage = 'https://github.com/TPei/ruby_yappl'
+  s.license = 'MIT'
+  s.files = `git ls-files`.split($/)
+  s.require_paths = ['lib']
+  s.add_dependency('json-schema', '~> 2.8')
+end

data/spec/json_validator_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'json_validator'
+
+RSpec.describe JsonValidator do
+  describe '.validate' do
+    it 'returns true for valid schema + file' do
+      json = File.read('./spec/schemas/valid_schema.json')
+      expect(JsonValidator.validate('yappl', json)).to eq true
+    end
+
+    it 'returns false for invalid schema' do
+      json = File.read('./spec/schemas/invalid_schema.json')
+      expect(JsonValidator.validate('yappl', json)).to eq false
+    end
+
+    it 'returns false for broken json' do
+      json = File.read('./spec/schemas/broken_schema.json')
+      expect(JsonValidator.validate('yappl', json)).to eq false
+    end
+
+    it 'fails with non-existent schema file' do
+      expect { JsonValidator.validate('bla', {}) }.
+        to raise_error(JSON::Schema::ReadFailed)
+    end
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'parser'
+
+RSpec.describe YaPPL::Parser do
+  describe '.parse' do
+    context 'with valid schema' do
+      it 'returns a policy' do
+        policy = YaPPL::Parser.parse(File.read('./spec/schemas/valid_schema.json'))
+        expect(policy.class).to eq YaPPL::Policy
+      end
+
+      it 'creates a proper Policy from json' do
+        policy = YaPPL::Parser.parse(File.read('./spec/schemas/valid_schema.json'))
+        expect(policy.id).to eq 4493
+        expect(policy.rules.count).to eq 1
+      end
+
+      it 'creates proper rules' do
+        policy = YaPPL::Parser.parse(File.read('./spec/schemas/valid_schema.json'))
+        expect(policy.rules.count).to eq 1
+        rule = policy.rules[0]
+        expect(rule.class).to eq YaPPL::Rule
+        expect(rule.permitted_purposes). to eq ['statistics', 'planology']
+        expect(rule.excluded_purposes).to eq ['commercial']
+        expect(rule.permitted_utilizers).to eq ['wikimedia', 'tu berlin']
+        expect(rule.excluded_utilizers).to eq ['netatmo', 'gate5']
+        expect(rule.transformations.count).to eq 1
+        expect(rule.transformations[0]['attribute']). to eq 'temperature'
+        expect(rule.transformations[0]['tr_func']). to eq 'minmax_hourly'
+        expect(rule.valid_from).to eq Time.parse('2017-10-09T00:00:00.000Z')
+        expect(rule.expiration_date).to eq Time.parse('0000-01-01T00:00:00.000Z')
+      end
+    end
+
+    context 'with invalid schema' do
+      it 'raises a SchemaError' do
+        expect do
+          YaPPL::Parser.parse(File.read('./spec/schemas/invalid_schema.json'))
+        end.to raise_error SchemaError
+      end
+    end
+
+    context 'with broken schema' do
+      it 'raises a SchemaError' do
+        expect do
+          YaPPL::Parser.parse(File.read('./spec/schemas/broken_schema.json'))
+        end.to raise_error SchemaError
+      end
+    end
+  end
+end

data/spec/policy_spec.rb

@@ -0,0 +1,242 @@
+require 'spec_helper'
+require 'policy'
+require 'rule'
+require 'json_validator'
+
+RSpec.describe YaPPL::Policy do
+  describe '.from_policy_file' do
+    it 'uses the parser' do
+      json = File.read('./spec/schemas/valid_schema.json')
+      expect(YaPPL::Parser).to receive(:parse).with(json)
+      YaPPL::Policy.from_policy_file(json)
+    end
+
+    it 'returns a Policy' do
+      json = File.read('./spec/schemas/valid_schema.json')
+      policy = YaPPL::Policy.from_policy_file(json)
+      expect(policy.class).to eq YaPPL::Policy
+    end
+  end
+
+  describe 'parse and serialize' do
+    it 'creates the same file again' do
+      json = File.read('./spec/schemas/valid_schema.json')
+      policy = YaPPL::Policy.from_policy_file(json)
+      expect(policy.create_policy).to eq JSON.parse(json).to_json
+    end
+  end
+
+  describe '#archive_rule' do
+    it 'calls #archive! on appropriate rule' do
+      rule_number_one = YaPPL::Rule.new(id: 4)
+      rules = [
+        YaPPL::Rule.new(id: 7),
+        rule_number_one,
+        YaPPL::Rule.new(id: 2)
+      ]
+
+      policy = YaPPL::Policy.new(1, rules)
+
+      expect(rule_number_one).to receive(:archive!)
+      policy.archive_rule(4)
+    end
+  end
+
+  describe '#create_policy' do
+    it 'calls #to_json' do
+      policy = YaPPL::Policy.new(1, [])
+      expect(policy).to receive(:to_json)
+      policy.create_policy
+    end
+  end
+
+  describe '#to_json' do
+    before do
+      @rule = YaPPL::Rule.new(
+        id: 1,
+        permitted_purposes: ['test1', 'test2'],
+        excluded_purposes: ['test3'],
+        permitted_utilizers: ['util1'],
+        excluded_utilizers: ['util2', 'util3'],
+        transformations: [],
+        valid_from: Time.now,
+        expiration_date: Time.now
+      )
+
+      @policy = YaPPL::Policy.new(1, [@rule])
+    end
+
+    it 'serializes appropriately' do
+      expect(@policy.to_json).to eq ({
+        id: 1,
+        preference: [{ rule: @rule.to_h }]
+      }.to_json)
+    end
+
+    it 'generated valid schema json' do
+      serialized = @policy.to_json
+      puts serialized
+      expect(JsonValidator.validate('yappl', serialized)).to eq true
+    end
+  end
+
+  describe '#new_rule' do
+    it 'creates a new rule and calls #add_rule' do
+      policy = YaPPL::Policy.new(1, [])
+      time = Time.now
+      args = { excluded_purposes: ['test1'], valid_from: time }
+      expect(YaPPL::Rule).to receive(:new).with(args).and_return(rule = double)
+      expect(policy).to receive(:add_rule).with rule
+      policy.new_rule(args)
+    end
+  end
+
+  describe '#add_rule' do
+    it 'appends a rule to the rules array and sets the id appropriately' do
+      rule_one = YaPPL::Rule.new(id: 1)
+      rule_three = YaPPL::Rule.new(id: 3)
+      policy = YaPPL::Policy.new(1, [rule_one, rule_three])
+      rule = YaPPL::Rule.new
+      policy.add_rule(rule)
+      expect(policy.rules.count).to eq 3
+      expect(policy.rules[-1].id).to eq 4
+    end
+  end
+
+  describe '#get_excluded_purpose' do
+    it 'returns a unique list of excluded purposes of all rules' do
+      rule1 = YaPPL::Rule.new(excluded_purposes: ['p1', 'p2'])
+      rule2 = YaPPL::Rule.new(excluded_purposes: ['p1', 'p3'])
+      policy = YaPPL::Policy.new(1, [rule1, rule2])
+      expect(policy.get_excluded_purpose).to eq ['p1', 'p2', 'p3']
+    end
+  end
+
+  describe '#get_excluded_utilizer' do
+    it 'returns a unique list of excluded utilizers of all rules' do
+      rule1 = YaPPL::Rule.new(excluded_utilizers: ['u1', 'u2'])
+      rule2 = YaPPL::Rule.new(excluded_utilizers: ['u1', 'u3'])
+      policy = YaPPL::Policy.new(1, [rule1, rule2])
+      expect(policy.get_excluded_utilizer).to eq ['u1', 'u2', 'u3']
+    end
+  end
+
+  describe '#update_rule' do
+    it 'updates a rule with new args and archives the old one' do
+      old_rule = YaPPL::Rule.new(id: 5, excluded_purposes: ['p1'])
+      policy = YaPPL::Policy.new(1, [old_rule])
+      args = {
+        excluded_purposes: ['p2'],
+        excluded_utilizers: ['u1']
+      }
+      policy.update_rule(5, args)
+      expect(policy.rules.count).to eq 2
+      new_rule = policy.rule_by_id(5)
+      expect(new_rule.id).to eq 5
+      expect(new_rule.excluded_purposes).to eq ['p2']
+      expect(new_rule.excluded_utilizers).to eq ['u1']
+      old_rule = policy.rule_by_id(-1)
+      expect(old_rule.id).to eq -1
+      expect(old_rule.excluded_purposes).to eq ['p1']
+      expect(old_rule.excluded_utilizers).to eq nil
+    end
+  end
+
+  describe '#rule_by_id' do
+    context 'with valid id' do
+      it 'returns matching rule' do
+        policy = YaPPL::Policy.new(1, [
+          YaPPL::Rule.new(id: 1), YaPPL::Rule.new(id: 4), YaPPL::Rule.new(id: 0)
+        ])
+        expect(policy.rule_by_id(4).id).to eq 4
+      end
+    end
+
+    context 'with id = -1' do
+      it 'returns all archived rules' do
+        policy = YaPPL::Policy.new(1, [
+          YaPPL::Rule.new(id: 1), YaPPL::Rule.new(id: 4), YaPPL::Rule.new(id: 0)
+        ])
+        policy.archive_rule(4)
+        policy.archive_rule(0)
+        expect(policy.rule_by_id(-1).count).to eq 2
+      end
+    end
+  end
+
+  describe '#archived_rules' do
+    context 'with archived rules' do
+      it 'returns all archived rules' do
+        rules = [YaPPL::Rule.new(id: -1), YaPPL::Rule.new(id: -1)]
+        policy = YaPPL::Policy.new(1, rules)
+        expect(policy.archived_rules).to eq(rules)
+      end
+    end
+
+    context 'with no archived rules' do
+      it 'returns an empty array' do
+        policy = YaPPL::Policy.new(1, [])
+        expect(policy.archived_rules).to eq []
+      end
+    end
+  end
+
+  describe '#active_rules' do
+    it 'returns all not expired and not archived rules' do
+      active_rules = [YaPPL::Rule.new, YaPPL::Rule.new]
+      inactive_rules = [YaPPL::Rule.new(id: -1), YaPPL::Rule.new(expiration_date: Time.now - 1000)]
+      policy = YaPPL::Policy.new(1, active_rules + inactive_rules)
+      expect(policy.active_rules).to eq active_rules
+    end
+  end
+
+  describe '#get_tr_rules' do
+    it 'returns active rules with permitted purp/util and transformations' do
+      active_rules = [
+        YaPPL::Rule.new(
+          id: 1,
+          permitted_purposes: ['p1'],
+          permitted_utilizers: ['u1'],
+          transformations: [{
+            attribute: 'temperature',
+            tr_func: 'minmax_hourly'
+          }],
+          excluded_utilizers: ['u2']
+        ),
+        YaPPL::Rule.new(
+          id: 2,
+          permitted_purposes: ['p2'],
+          permitted_utilizers: ['u3'],
+          transformations: [{
+            attribute: 'step_count',
+            tr_func: 'minmax_hourly'
+          }],
+          excluded_utilizers: ['u4'],
+          excluded_purposes: ['p2'],
+          valid_from: Time.now,
+          expiration_date: Time.new(0, 1, 1)
+        )
+      ]
+      inactive_rules = [YaPPL::Rule.new(id: -1), YaPPL::Rule.new(expiration_date: Time.now - 1000)]
+      policy = YaPPL::Policy.new(1, active_rules + inactive_rules)
+      expect(policy.get_tr_rules).to eq ([
+        {
+          permitted_purposes: ['p1'],
+          permitted_utilizers: ['u1'],
+          transformations: [{
+            attribute: 'temperature',
+            tr_func: 'minmax_hourly'
+          }]
+        },
+        {
+          permitted_purposes: ['p2'],
+          permitted_utilizers: ['u3'],
+          transformations: [{
+            attribute: 'step_count',
+            tr_func: 'minmax_hourly'
+          }]
+        }
+      ])
+    end
+  end
+end

data/spec/rule_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'rule'
+
+RSpec.describe YaPPL::Rule do
+  describe '#initialize' do
+    it 'sets all given attributes' do
+      time = Time.now
+
+      args = {
+        id: 1, permitted_purposes: ['p1'], excluded_purposes: ['p2'],
+        permitted_utilizers: ['u1'], excluded_utilizers: ['u2'],
+        transformations: [{
+          attribute: 'temperature',
+          tr_func: 'minmax_hourly'
+        }],
+        valid_from: time,
+        expiration_date: time
+      }
+
+      rule = YaPPL::Rule.new(args)
+      expect(rule.id).to eq 1
+      expect(rule.permitted_purposes).to eq ['p1']
+      expect(rule.excluded_purposes).to eq ['p2']
+      expect(rule.permitted_utilizers).to eq ['u1']
+      expect(rule.excluded_utilizers).to eq ['u2']
+      expect(rule.transformations).to eq [{
+        attribute: 'temperature',
+        tr_func: 'minmax_hourly'
+      }]
+      expect(rule.valid_from).to eq time
+      expect(rule.expiration_date).to eq time
+    end
+
+    context 'with no valid_from and expiration_date provided' do
+      it 'sets defaults values' do
+        rule = YaPPL::Rule.new
+        expect(rule.valid_from).not_to eq nil
+        expect(rule.expiration_date).to eq Time.new(0, 1, 1)
+      end
+    end
+  end
+
+  describe '#archive!' do
+    it 'sets expiration_date to now and id to -1' do
+      set_time = Time.now - 100_000_000
+      rule = YaPPL::Rule.new(id: 100, expiration_date: set_time)
+
+      rule.archive!
+
+      expect(rule.id).to eq -1
+      expect(rule.expiration_date).to be > set_time
+    end
+  end
+
+  describe '#to_h' do
+    it 'serializes appropriately' do
+      time = Time.now
+
+      rule = YaPPL::Rule.new(
+        id: 1,
+        permitted_purposes: ['test1', 'test2'],
+        excluded_purposes: ['test3'],
+        permitted_utilizers: ['util1'],
+        excluded_utilizers: ['util2', 'util3'],
+        transformations: [{
+          attribute: 'temperature',
+          tr_func: 'minmax_hourly'
+        }],
+        valid_from: time,
+        expiration_date: time
+      )
+
+      expect(rule.to_h).to eq({
+        purpose: {
+          permitted: ['test1', 'test2'],
+          excluded: ['test3'],
+        },
+        utilizer: {
+          permitted: ['util1'],
+          excluded: ['util2', 'util3'],
+        },
+        transformation: [{
+          attribute: 'temperature',
+          tr_func: 'minmax_hourly'
+        }],
+        valid_from: time.strftime('%FT%T.%LZ'),
+        exp_date: time.strftime('%FT%T.%LZ')
+      })
+    end
+  end
+
+  describe '#expired?' do
+    context 'with expiration_date set to default' do
+      it 'returns false' do
+        rule = YaPPL::Rule.new
+        expect(rule.expired?).to eq false
+      end
+    end
+
+    context 'with expiration_date set in past' do
+      it 'returns true' do
+        rule = YaPPL::Rule.new(expiration_date: Time.new(2000, 1, 1))
+        expect(rule.expired?).to eq true
+      end
+    end
+
+    context 'with expiration_date set in future' do
+      it 'returns false' do
+        # have fun with this in a thousand years :D
+        rule = YaPPL::Rule.new(expiration_date: Time.new(3000, 1, 1))
+        expect(rule.expired?).to eq false
+      end
+    end
+  end
+end

data/spec/schemas/broken_schema.json

@@ -0,0 +1,6 @@
+{
+  "this": "is not valid json",
+  1234,
+  "what is this?": ??,
+  [
+}

data/spec/schemas/invalid_schema.json

@@ -0,0 +1,18 @@
+{
+  "id": 4493,
+  "preference": [{
+      "rule": {
+        "utilizer": {
+          "permitted": ["wikimedia", "tu berlin"],
+          "excluded": ["netatmo", "gate5"]
+        },
+        "transformation": [{
+          "attribute": "temperature",
+          "tr_func": "minmax_hourly"
+        }],
+        "valid_from": "2017-10-09T00:00:00.00Z",
+        "exp_date": "0000-01-01T00:00:00.000Z"
+      }
+    }
+  ]
+}

data/spec/schemas/valid_schema.json

@@ -0,0 +1,22 @@
+{
+  "id": 4493,
+  "preference": [{
+      "rule": {
+        "purpose": {
+          "permitted": ["statistics", "planology"],
+          "excluded": ["commercial"]
+        },
+        "utilizer": {
+          "permitted": ["wikimedia", "tu berlin"],
+          "excluded": ["netatmo", "gate5"]
+        },
+        "transformation": [{
+          "attribute": "temperature",
+          "tr_func": "minmax_hourly"
+        }],
+        "valid_from": "2017-10-09T00:00:00.000Z",
+        "exp_date": "0000-01-01T00:00:00.000Z"
+      }
+    }
+  ]
+}

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+require './lib/ruby_yappl'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,26 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: ruby_yappl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Thomas Peikert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
-dependencies: []
+date: 2019-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 description: 
 email: t.s.peikert+yappl@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/exceptions.rb
+- lib/json_validator.rb
 - lib/parser.rb
 - lib/policy.rb
 - lib/ruby_yappl.rb
 - lib/rule.rb
-homepage: http://rubygems.org/gems/ruby_yappl
+- lib/schemas/yappl.json
+- ruby_yappl.gemspec
+- spec/json_validator_spec.rb
+- spec/parser_spec.rb
+- spec/policy_spec.rb
+- spec/rule_spec.rb
+- spec/schemas/broken_schema.json
+- spec/schemas/invalid_schema.json
+- spec/schemas/valid_schema.json
+- spec/spec_helper.rb
+homepage: https://github.com/TPei/ruby_yappl
 licenses:
 - MIT
 metadata: {}
@@ -40,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: ruby gem for the yappl privacy preference language