sensorario / resources

A library to validate requests for web api

sensorario/resources

6.0

Docs

• Allow range of values
• Allowed properties
• Allowed values
• Compose resources
• Configurator
• Create resources
• Default values
• Example
• Global configuration
• Mandatory conditional example
• Mandatory properties
• Overridable values
• Raw example
• Rules
• Symfony example
• Symfony4 example
• Tests
• Tools

resources's Issues

psr fixes

see https://scrutinizer-ci.com/g/sensorario/resources/issues/master/files/src/Sensorario/Resources/Resource.php?selectedLabels%5B0%5D=9&selectedLabels%5B1%5D=3&orderField=path&order=asc&fileId=src%2FSensorario%2FResources%2FResource.php&honorSelectedPaths=0#inspectioncomment-60179857

number as scalar type

Define a property as a scalar

I can define only Object types and not scalar ones. I need to define that a property should be an array or an integer (or other scalar types)

• type should define if is an object or a scalar
• accept 'object' type and 'array' type

Range values for numeric attributes

• define range of integer values
• apply overrides depending on particular condition

Create all "domain" Exception

Remove all references at native RuntimeException

CircleCI integration is missing

add CircleCI configuration

Allow parameters, only if others has specific value

In case of API, a Request could have some allowed parameters. But the presence of a specific value, could remove to allowed others. Example:

type=[category|categoryGroup]
name
[categoryGroup]

categoryGroup is allowed only when type is categoryGroup.

For example, a parameter could allow others.

ValueObject::allow()
{
    return [
        'type' => 'category',
        'allow' => 'categoryGroup',
    ];
}

This code seems to be duplicated across your project.

see https://scrutinizer-ci.com/g/sensorario/resources/issues/master/files/src/Sensorario/Resources/Validators/Validators/MandatoryConditional.php?selectedLabels%5B0%5D=4&orderField=path&order=asc&honorSelectedPaths=0#inspectioncomment-54794339

Improve coverage

Improve allowed tipe: when a field is mandatory depending on another field value, must be automatically allowed

github pages from bash

As Developer,
I want to run bash commands,
so then I can reach GitHub web site pages directly from bash

contributing file

improve contributing file

old composer version

current composer version is too old

add new ruler component

add email validation

https://github.com/egulias/EmailValidator

ValueObject::hasProperties() is a missing method!!!

Improve guidelines

Mandatory properties in case of another property value

Suppose to have an api to search some value. And suppose you can d search for Peoples or Balls. When you search for People, you must define the name. When you search for Balls, you must define the color.

    Search::box([
        'what' => 'People'
    ]);

should through an exception, because name is missing. Correct search request values are:

    Search::box([
        'what' => 'People',
        'name' => 'Simone',
    ]);

Otherwise, id you search for balls, will get an exception because name is not mandatory nor allowed.

    Search::box([
        'what' => 'Balls',
        'name' => 'Simone',
    ]);

This is the right call

    Search::box([
        'what' => 'Balls',
        'color' => 'red',
    ]);

Add coverage script

Generate a script to check the coverage entire library

Documentation link in readme file is broken!

fix branch names on contribution

Update composer.phar

Get the value of current VO

Implement, for example, toJson, toXml, toYaml methods. By default, could work with allowed.mandatory attributes.

Remove if_present syntax to set a property as mandatory

late static binding have no effect

see https://scrutinizer-ci.com/g/sensorario/resources/issues/master/files/src/Sensorario/Resources/Validators/Validators/MandatoryConditional.php?selectedLabels%5B0%5D=6&orderField=path&order=asc&honorSelectedPaths=0#inspectioncomment-60179852

if_present is still present

https://github.com/sensorario/value-object/search?utf8=%E2%9C%93&q=if_present

Show the type that a property should be

The exception should explain class name of this object. This error occurs when you define that a property must have a type with ValueObjec::types(), but this message does not explain which type.

Global constraints

In this example, a developer needs to define an allowed attribute for all resources:

  return new Container([
    'resources' => [
      'p' => [
        'constraints' => [
          'allowed' => [
            'resource_name',
          ],
          'mandatory' => [
            'uno',
            'due',
            'tre',
          ],
          'defaults' => [
            'uno' => 'bar',
            'due' => 33333,
            'tre' => 'mello',
          ],
        ]
      ],
      'foo' => [
        'constraints' => [
          'allowed' => [
            'resource_name',
          ],
          'mandatory' => [
            'foo',
            'ciao',
            'friend',
          ],
          'defaults' => [
            'foo' => 'bar',
            'ciao' => 33333,
            'friend' => 'mello',
          ],
          'allowedValues' => [
            'foo' => [
              42,
              'bar'
            ],
          ],
        ]
      ]
    ]
  ]);

There should be a global 'constratints' configuration, to allow all responses to inherit some attributes.

Expected 0 spaces between "MagicResource" and comma; 1 found

see https://scrutinizer-ci.com/g/sensorario/resources/issues/master/files/src/Sensorario/Resources/Resource.php?selectedLabels%5B0%5D=9&selectedLabels%5B1%5D=3&orderField=path&order=asc&fileId=src%2FSensorario%2FResources%2FResource.php&honorSelectedPaths=0#inspectioncomment-60179864

Override values

Remove Sensorario/Resources/ContainerBase class

Property could be object instance

$obj = Foo::bar([
    'foo' => '2015-16-17'
]);

echo get_class($obj->foo()); // DateTime()

Improve contributing rules

When an update is made, CHANGELOG should be updated and the added content should be the same of the commit message.

Add latin1 to utf-8 conversion and viceversa

When communication happens between SOAP web service that expects latin1 charset instead of utf-8, provide a way to force conversion of all request fields!

Mandatory value when others assume particular value

Define more values that make mandatory a property

Syntax improvement when.is_present to set property as mandatory

clean metadata

Remove all 2.X metadata information like UPGRADE files and CHANGELOG

When rules are not defined, throw an exception message to help developers

If a property is an object and is not defined in the rules method, throw a new exception

https://github.com/sensorario/value-object/blob/master/src/Sensorario/ValueObject/ValueObject.php#L131

remove ContainerBase class

unecessary classes just for test purpose

All the classes created just for test purpose can be removed. Actually is not necessary a real class: instead of a real class, right configuration is enough. All classes inside tests/Resources folder could be replaced with Resource::box(). Starting from version 4.0 is not necessary a real instanced object. Resource::box accept a second parameter that accept the resource configuration.

yaml configuration

Read configuration from a yaml file

Value Objects composition

Uncaught exception 'RuntimeException' with message 'Attribute `.*` must be of type `object`'

This message is unclear: improve indicating the real kind of object

Fix all dockblock with copyright

Add references to sensorario/value-objects repo

Create a collection of errors instead of stop at first failure

Instead of throw an exception, create a collection of errors, and return an unique error message with all errors.

add email validator

https://github.com/egulias/EmailValidator

Improve error message quen value is not allowed

Complete PHPDocumentor