Skip to content

Commit

Permalink
updated README and source code to match package rename
Browse files Browse the repository at this point in the history
  • Loading branch information
James Tyler committed Jun 27, 2018
1 parent d77b3d5 commit add4bff
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# RapidSpike API Binding (PHP)
# RapidSpike API Wrapper (PHP)

PHP bindings for the [RapidSpike API](https://docs.rapidspike.com/system-api) (v1).
PHP wrapper for the [RapidSpike API](https://docs.rapidspike.com/system-api) (v1).

## Information

RapidSpike provides a RESTful API designed to make interfacing with their services cleaner and easier. The [RapidSpike Portal](https://my.rapidspike.com) is 100% API powered so anything you can do there is possible directly via the API.

To interact with the API you must first have a RapidSpike subscription that allows access to the API. Then you need to generate API keys in your [account settings area](https://my.rapidspike.com/#/account/my-account/account-settings?tab=api).

This bindings package is future proof as new end-points become available - it is mearly a wrapper that provides a standardised way to create end-points, package request data and authenticate in the API.
This wrapper package is future proof as new end-points become available - it is mearly a wrapper that provides a standardised way to create end-points, package request data and authenticate in the API.

## Concepts

#### End-point Chaining
This bindings package is very simple, but provides you with a standard way to call our API. End-points are built using a function-per-path segment or directly in the `call()` method. This makes use of magic methods so that we're future proofed against new end-points.
This wrapper package is very simple, but provides you with a standard way to call our API. End-points are built using a function-per-path segment or directly in the `call()` method. This makes use of magic methods so that we're future proofed against new end-points.
```
/*
* Read account API keys
Expand Down Expand Up @@ -58,10 +58,10 @@ $Client->websites()->addQueryData(['page' => 1, 'per_page' => 10])->via('get');

## Installation

Recommended installation is via [Composer](https://getcomposer.org/) and [Packagist](https://packagist.org/packages/rapidspike/rapidspike-api-binding-php). Check the available version tags, however, development won't be overly active due to to nature of the package.
Recommended installation is via [Composer](https://getcomposer.org/) and [Packagist](https://packagist.org/packages/rapidspike/rapidspike-api-wrapper-php). Check the available version tags, however, development won't be overly active due to to nature of the package.

```
composer require rapidspike/rapidspike-api-binding-php
composer require rapidspike/rapidspike-api-wrapper-php
```

## Usage example
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "rapidspike/rapidspike-api-binding-php",
"name": "rapidspike/rapidspike-api-wrapper-php",
"description": "PHP wrapper functions for interfacing with RapidSpike's API.",
"license": "MIT",
"authors": [
Expand Down
4 changes: 2 additions & 2 deletions src/RapidSpike/API/Client.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
*/

/*
* RapidSpike API Binding (PHP)
* RapidSpike API Wrapper (PHP)
*
* @package rapidspike/rapidspike-api-binding-php
* @package rapidspike/rapidspike-api-wrapper-php
* @author James Tyler <james.tyler@rapidspike.com>
* @license MIT
*/
Expand Down
4 changes: 2 additions & 2 deletions src/RapidSpike/API/KeyAuth.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
*/

/*
* RapidSpike API Binding (PHP)
* RapidSpike API Wrapper (PHP)
*
* @package rapidspike/rapidspike-api-binding-php
* @package rapidspike/rapidspike-api-wrapper-php
* @author James Tyler <james.tyler@rapidspike.com>
* @license MIT
*/
Expand Down
6 changes: 3 additions & 3 deletions src/RapidSpike/API/Request.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
*/

/*
* RapidSpike API Binding (PHP)
* RapidSpike API Wrapper (PHP)
*
* @package rapidspike/rapidspike-api-binding-php
* @package rapidspike/rapidspike-api-wrapper-php
* @author James Tyler <james.tyler@rapidspike.com>
* @license MIT
*/
Expand Down Expand Up @@ -80,7 +80,7 @@ public function call(string $method)
RequestOptions::TIMEOUT => $this->Scope->timeout,
RequestOptions::HEADERS => [
'Accept' => 'application/json',
'User-Agent' => "RapidSpike-API-Binding-v{$this->Scope->version}",
'User-Agent' => "RapidSpike-API-Wrapper-v{$this->Scope->version}",
],
];

Expand Down

0 comments on commit add4bff

Please sign in to comment.