Skip to content

Commit

Permalink
versionlog.md and readme.md files are updated
Browse files Browse the repository at this point in the history
  • Loading branch information
hakobyansen committed Jan 20, 2019
1 parent a6b2765 commit 0a24f89
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 44 deletions.
38 changes: 23 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,36 @@ or
```

## Installation
`composer require codebot/response-builder:0.1.*`
`composer require codebot/response-builder:0.2.*`

**For Laravel 5.4 and versions below add `\RB\Core\RBServiceProvider::class` to providers in config/app.php file.**

Next run `php artisan vendor:publish --tag=laravel-response-builder` command in your console.

## Requests

Once you published vendor, you should see `App\Http\Requests\RB\RB_Request class`. This will be base class for
Once you published vendor, you should see `App\Http\Requests\RB\RBRequest class`. This will be base class for
laravel-response-builder's requests.
To generate a request that extends RB_Request, do:
To generate a request that extends RBRequest, do:

`php artisan make:rb_request YourNewRequest`
`php artisan make:rbrequest YourNewRequest`

If you are using Laravel's Validator class, you can use `RB\Core\RBValidator` to standardize the structure of failed response.

```php
$validator = new Validator( $data, $rules ); // assuming you have a $validator instance

\RB\Core\RBValidator::validate( $Validator ); // throws HttpResponseException or returns boolean true

```

RBValidator::validate() method checks if validation fails and throws an Illuminate\Http\Exceptions\HttpResponseException with the standardized json response structure.

### Usage
```php
$response = new \RB\Core\Response();

$response->setStatus( true ); // required

$response->setStatusCode( \RB\Core\HttpStatusCodes::OK ); // required
$response->setStatusCode( \RB\Core\HttpStatusCode::OK ); // required. If code is 2XX then Response::status field will be "true", otherwise "false"

$response->setMessage( 'Some inspiring message.' ); // null will be returned if no message set

Expand All @@ -70,22 +79,21 @@ All setters are fluent, so example above could be written like:
```php
$response = new \RB\Core\Response();

$response->setStatus( true )
->setStatusCode( \RB\Core\HttpStatusCodes::OK )
$response->setStatusCode( \RB\Core\HttpStatusCode::OK )
->setMessage( 'Some inspiring message.' );
// ...
```

Package contains HttpStatusCodes class with http status codes defined.
Package contains HttpStatusCode class with http status codes defined.

```php
use \RB\Core\HttpStatusCodes;
use \RB\Core\HttpStatusCode;

HttpStatusCodes::OK; // returns status code 200 (integer)
HttpStatusCode::OK; // returns status code 200 (integer)

HttpStatusCodes::getMessageByCode( \RB\Core\HttpStatusCodes::OK::NOT_FOUND ); // returns string "Not Found"
HttpStatusCode::getMessageByCode( \RB\Core\HttpStatusCode::OK::NOT_FOUND ); // returns string "Not Found"

HttpStatusCodes::getCodeWithMessage( \RB\Core\HttpStatusCodes::OK::CREATED ); // returns string - code and message, e.g. "201 Created"
HttpStatusCode::getCodeWithMessage( \RB\Core\HttpStatusCode::OK::CREATED ); // returns string - code and message, e.g. "201 Created"
```

## Configuration
Expand All @@ -100,7 +108,7 @@ Once you have vendor published, you should see `config/response_builder.php` fil

**messages** - Contains messages for Response's "message" field.

*messages.failed_validation* - Default message for response that failed the valiadtion.
*messages.failed_validation* - Default message for response that failed the validation.

## Fields

Expand Down
63 changes: 34 additions & 29 deletions versionlog.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,50 @@
# Versions

## 0.0.1 2018-09-12
* Initial commit.
## 0.2.0 2019-01-20
* RBValidator class created.
* Status automatically set to "true" whenever status code is 2XX.
* RB_Request class renamed to RBRequest.
* HttpStatusCodes class renamed to HttpStatusCode.
* make:rb_request command renamed to make:rbrequest.

## 0.0.2 2018-09-12
* Response class created.
## 0.1.3
* Refactoring.
* Documentation updated.

## 0.0.3 2018-09-12
* "src" directory created.
* Composer autoload added.
## 0.1.2 2018-09-18
* Issues fixed related to rb_request blade generator.

## 0.0.4 2018-09-14
* getResponse() method added.
* unit test created for Response class.
## 0.1.1 2018-09-18
* Vendor publishing issue fixed

## 0.0.5 2018-09-14
* Type hints added in Response class.
* Readme.md added.
## 0.1.0 2018-09-18
* Introducing RB_Request.
* Artisan command created for RB_Request generation.
* Making things configurable.

## 0.0.6 2018-09-14
* Updates to composer.json file.
## 0.0.8 2018-09-15
* HttpStatusCodes class created.

## 0.0.7 2018-09-14
* ResponseTest refactoring.

## 0.0.8 2018-09-15
* HttpStatusCodes class created.

## 0.1.0 2018-09-18
* Introducing RB_Request.
* Artisan command created for RB_Request generation.
* Making things configurable.
## 0.0.6 2018-09-14
* Updates to composer.json file.

## 0.1.1 2018-09-18
* Vendor publishing issue fixed
## 0.0.5 2018-09-14
* Type hints added in Response class.
* Readme.md added.

## 0.1.2 2018-09-18
* Issues fixed related to rb_request blade generator.
## 0.0.4 2018-09-14
* getResponse() method added.
* unit test created for Response class.

## 0.1.3
* Refactoring.
* Documentation updated.
## 0.0.3 2018-09-12
* "src" directory created.
* Composer autoload added.

## 0.0.2 2018-09-12
* Response class created.

## 0.0.1 2018-09-12
* Initial commit.

0 comments on commit 0a24f89

Please sign in to comment.