https://github.com/bwinkers/nugget

A PHP7 Mongo composable, rule based object validation and processing module
https://github.com/bwinkers/nugget

activerules json-schema sharedchain

Last synced: about 1 month ago
JSON representation

A PHP7 Mongo composable, rule based object validation and processing module

• Host: GitHub
• URL: https://github.com/bwinkers/nugget
• Owner: bwinkers
• License: other
• Created: 2015-09-16T04:44:57.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-03-13T06:04:44.000Z (almost 7 years ago)
• Last Synced: 2024-12-17T00:50:10.549Z (about 1 month ago)
• Topics: activerules, json-schema, sharedchain
• Language: HTML
• Homepage:
• Size: 948 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nugget

[![Coverage Status](https://coveralls.io/repos/github/bwinkers/nugget/badge.svg?branch=master)](https://coveralls.io/github/bwinkers/nugget?branch=master)

[![Maintainability](https://api.codeclimate.com/v1/badges/aa0a4d97bb3af8d0a7a6/maintainability)](https://codeclimate.com/github/bwinkers/nugget/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/aa0a4d97bb3af8d0a7a6/test_coverage)](https://codeclimate.com/github/bwinkers/nugget/test_coverage)

A PHP7 library for defining, validating and processing JSON business objects.

The ActiveRules Nugget Schema treats all data as `nuggets`.

These `nuggets` can be defined, and related using JSON files.

Rules can then be applied to any changes to an object.

The resulting schema will be moving to dataencyclopedia.com.

## Testing 

## Local only tests (run by Travis CI)

```php vendor/bin/phpunit```

## Using remote schema (broken on Travis CI)

```php vendor/bin/phpunit tests/Activerules/Nugget/NuggetTest-Dev.php --testdox```

## Generate Open API schema objects

ActiveRules object definitions are converted to Open API schema objects composed of property definitions.

### Schema from object definitions

```

php src/bin/schemaFromObject.php -p "./properties" -o "./objects" -s "./t2" 

```

```

php src/bin/o2s.php -p "./properties" -s "./schema" -o "./objects" -d "./schemadoc"

```

```

php src/bin/refsToURLs.php -s "./schema" -u "https://schmema.izzup.com" -o "./objects-izzup"

```

```

php src/bin/readPropertiesFromGoogle.php -s "1NeU79bJ-Zic-fwKK2PPuxntNXnbkyMKf6ZTIUHp1n4s" -c ~/.google/izzup-client_secret.json -p "./properties"

```

### Update schema

```

php src/bin/convertSchemaRefs.php -s "./schema" -r "file://./" -o "./objects-local" -t "#/components/schema/"

```

```

php src/bin/convertSchemaRefs.php -s "./schema" -r "https://schema.izzup.com" -o "./objects-izzup" -t "#/components/schema/" 

```

## References

JSON References ($ref): [https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03)

JSON Schema: [http://json-schema.org/](http://json-schema.org/)

Schemas: [http://schema.org/](http://schema.org/)

## Sponsored By:

[UltriNet](http://www.ultri.net)