Skip to content

Commit a3391f7

Browse files
Updated SDK to match new API functionality.
1 parent 4f96ad8 commit a3391f7

20 files changed

+233
-215
lines changed

README.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
# DataRole API Client Library for PHP
2-
3-
[![Build Status](https://travis-ci.org/DataRole/api-client-php.svg?branch=master)](https://travis-ci.org/DataRole/api-client-php)
1+
# DataRole API Client Library for PHP #
42

53
The DataRole API Client Library enables you to work with DataRole APIs on your server.
64

7-
## Requirements
8-
* [PHP 5.5.0 or higher](http://www.php.net/)
5+
## Requirements ##
6+
* [PHP 5.4.0 or higher](http://www.php.net/)
97

10-
## Developer Documentation
8+
## Developer Documentation ##
119
http://developers.datarole.com/api
1210

13-
## Installation
11+
## Installation ##
1412

1513
You can use **Composer** or simply **Download the Release**
1614

@@ -43,51 +41,50 @@ Uncompress the zip file you download, and include the autoloader in your project
4341
require_once '/path/to/datarole-api-php-client/vendor/autoload.php';
4442
```
4543

46-
For additional installation and setup instructions, see [the documentation](https://developers.datarole.com/api/php#installation).
44+
For additional installation and setup instructions, see [the documentation](https://github.com/datarole/api/blob/master/sdks/php.md#installation).
4745

48-
## Basic Example
46+
## Basic Example ##
4947
See the examples/ directory for examples of the key client features. You can
5048
view them in your browser by running the php built-in web server.
5149

52-
```sh
53-
php -S localhost:8000 -t examples/
50+
```
51+
$ php -S localhost:8000 -t examples/
5452
```
5553

5654
And then browsing to the host and port you specified
5755
(in the above example, `http://localhost:8000`).
5856

59-
```php
57+
```PHP
6058
// include your composer dependencies
6159
require_once 'vendor/autoload.php';
6260

6361
$client = new DataRole\API\Client([
64-
'authorization' => <YOUR_API_KEY_HERE>,
65-
'instance' => 'default',
62+
'authorization' => '_API_TOKEN_',
6663
'version' => 'v1',
6764
]);
6865

6966
$client->permit(['Region' => 'CA_Concord'])->preview();
7067
```
7168

72-
## Frequently Asked Questions
69+
## Frequently Asked Questions ##
7370

74-
### What do I do if something isn't working?
71+
### What do I do if something isn't working? ###
7572

7673
For support with the library the best place to ask is via the datarole-api-php-client tag on StackOverflow: http://stackoverflow.com/questions/tagged/datarole-api-php-client
7774

7875
If there is a specific bug with the library, please file an issue in the Github issues tracker, including a (minimal) example of the failing code and any specific errors retrieved.
7976

80-
### How do I contribute?
77+
### How do I contribute? ###
8178

8279
We accept contributions via Github Pull Requests, but all contributors need to be covered by the standard Apache Individual Contributor License Agreement: https://www.apache.org/licenses/icla.txt
8380

84-
## Code Quality
81+
## Code Quality ##
8582

8683
Run the PHPUnit tests with PHPUnit.
8784

8885
phpunit tests/
8986

90-
## License
87+
## License ##
9188

9289
Copyright 2016 HireWheel, LLC
9390

coverage/Client.php.html

Lines changed: 62 additions & 56 deletions
Large diffs are not rendered by default.

coverage/Connection.php.html

Lines changed: 103 additions & 97 deletions
Large diffs are not rendered by default.

coverage/Meta/Base.php.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ <h4>Legend</h4>
323323
<span class="warning"><strong>Dead Code</strong></span>
324324
</p>
325325
<p>
326-
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 4 11:17:34 EST 2016.</small>
326+
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 25 12:30:14 EDT 2016.</small>
327327
</p>
328328
<a title="Back to the top" id="toplink" href="#"><span class="glyphicon glyphicon-arrow-up"></span></a>
329329
</footer>

coverage/Meta/Name.php.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ <h4>Legend</h4>
322322
<span class="warning"><strong>Dead Code</strong></span>
323323
</p>
324324
<p>
325-
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 4 11:17:34 EST 2016.</small>
325+
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 25 12:30:14 EDT 2016.</small>
326326
</p>
327327
<a title="Back to the top" id="toplink" href="#"><span class="glyphicon glyphicon-arrow-up"></span></a>
328328
</footer>

coverage/Meta/dashboard.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ <h3>Project Risks</h3>
137137
<footer>
138138
<hr/>
139139
<p>
140-
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 4 11:17:34 EST 2016.</small>
140+
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 25 12:30:14 EDT 2016.</small>
141141
</p>
142142
</footer>
143143
</div>

coverage/Meta/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ <h4>Legend</h4>
137137
<span class="success"><strong>High</strong>: 90% to 100%</span>
138138
</p>
139139
<p>
140-
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 4 11:17:34 EST 2016.</small>
140+
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 25 12:30:14 EDT 2016.</small>
141141
</p>
142142
</footer>
143143
</div>

coverage/Model.php.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ <h4>Legend</h4>
409409
<span class="warning"><strong>Dead Code</strong></span>
410410
</p>
411411
<p>
412-
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 4 11:17:34 EST 2016.</small>
412+
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 25 12:30:14 EDT 2016.</small>
413413
</p>
414414
<a title="Back to the top" id="toplink" href="#"><span class="glyphicon glyphicon-arrow-up"></span></a>
415415
</footer>

coverage/Models/Permit.php.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@
147147
<tr><td><div align="right"><a name="20"></a><a href="#20">20</a></div></td><td class="codeLine"><span class="comment">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/</span></td></tr>
148148
<tr><td><div align="right"><a name="21"></a><a href="#21">21</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="keyword">public</span><span class="default">&nbsp;</span><span class="keyword">function</span><span class="default">&nbsp;</span><span class="default">hydrate</span><span class="keyword">(</span><span class="keyword">array</span><span class="default">&nbsp;</span><span class="default">$attributes</span><span class="keyword">)</span></td></tr>
149149
<tr><td><div align="right"><a name="22"></a><a href="#22">22</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="keyword">{</span></td></tr>
150-
<tr class="covered-by-large-tests popin" data-title="5 tests cover line 23" data-content="&lt;ul&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ClientTest::testPermitReturnsSinglePermitModel&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ConnectionTest::testGetReturnsASingleModel&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ConnectionTest::testPostReturnsACollection&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;NormalizerTest::testCollectionReturnsACollection&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;NormalizerTest::testModelReturnsAModel&lt;/li&gt;&lt;/ul&gt;" data-placement="bottom" data-html="true"><td><div align="right"><a name="23"></a><a href="#23">23</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="default">$this</span><span class="default">-&gt;</span><span class="default">attributes</span><span class="default">&nbsp;</span><span class="keyword">=</span><span class="default">&nbsp;</span><span class="keyword">isset</span><span class="keyword">(</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'data'</span><span class="keyword">]</span><span class="keyword">)</span><span class="default">&nbsp;</span><span class="keyword">?</span><span class="default">&nbsp;</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'data'</span><span class="keyword">]</span><span class="keyword">[</span><span class="default">'permit'</span><span class="keyword">]</span><span class="default">&nbsp;</span><span class="keyword">:</span><span class="default">&nbsp;</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'permit'</span><span class="keyword">]</span><span class="keyword">;</span></td></tr>
150+
<tr class="covered-by-large-tests popin" data-title="5 tests cover line 23" data-content="&lt;ul&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ClientTest::testPermitReturnsSinglePermitModel&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ConnectionTest::testGetReturnsASingleModel&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ConnectionTest::testPostReturnsACollection&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;NormalizerTest::testCollectionReturnsACollection&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;NormalizerTest::testModelReturnsAModel&lt;/li&gt;&lt;/ul&gt;" data-placement="bottom" data-html="true"><td><div align="right"><a name="23"></a><a href="#23">23</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="default">$this</span><span class="default">-&gt;</span><span class="default">attributes</span><span class="default">&nbsp;</span><span class="keyword">=</span><span class="default">&nbsp;</span><span class="keyword">isset</span><span class="keyword">(</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'data'</span><span class="keyword">]</span><span class="keyword">)</span><span class="default">&nbsp;</span><span class="keyword">?</span><span class="default">&nbsp;</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'data'</span><span class="keyword">]</span><span class="keyword">[</span><span class="default">'permit'</span><span class="keyword">]</span><span class="default">&nbsp;</span><span class="keyword">:</span><span class="default">&nbsp;</span><span class="keyword">@</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'permit'</span><span class="keyword">]</span><span class="keyword">;</span></td></tr>
151151
<tr class="covered-by-large-tests popin" data-title="5 tests cover line 24" data-content="&lt;ul&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ClientTest::testPermitReturnsSinglePermitModel&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ConnectionTest::testGetReturnsASingleModel&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ConnectionTest::testPostReturnsACollection&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;NormalizerTest::testCollectionReturnsACollection&lt;/li&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;NormalizerTest::testModelReturnsAModel&lt;/li&gt;&lt;/ul&gt;" data-placement="bottom" data-html="true"><td><div align="right"><a name="24"></a><a href="#24">24</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="keyword">}</span></td></tr>
152152
<tr><td><div align="right"><a name="25"></a><a href="#25">25</a></div></td><td class="codeLine"><span class="keyword">}</span></td></tr>
153153

@@ -162,7 +162,7 @@ <h4>Legend</h4>
162162
<span class="warning"><strong>Dead Code</strong></span>
163163
</p>
164164
<p>
165-
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 4 11:17:34 EST 2016.</small>
165+
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 25 12:30:14 EDT 2016.</small>
166166
</p>
167167
<a title="Back to the top" id="toplink" href="#"><span class="glyphicon glyphicon-arrow-up"></span></a>
168168
</footer>

coverage/Models/Professional.php.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@
147147
<tr><td><div align="right"><a name="20"></a><a href="#20">20</a></div></td><td class="codeLine"><span class="comment">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/</span></td></tr>
148148
<tr><td><div align="right"><a name="21"></a><a href="#21">21</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="keyword">public</span><span class="default">&nbsp;</span><span class="keyword">function</span><span class="default">&nbsp;</span><span class="default">hydrate</span><span class="keyword">(</span><span class="keyword">array</span><span class="default">&nbsp;</span><span class="default">$attributes</span><span class="keyword">)</span></td></tr>
149149
<tr><td><div align="right"><a name="22"></a><a href="#22">22</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="keyword">{</span></td></tr>
150-
<tr class="covered-by-large-tests popin" data-title="1 test covers line 23" data-content="&lt;ul&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ClientTest::testProfessionalReturnsSingleProfessionalModel&lt;/li&gt;&lt;/ul&gt;" data-placement="bottom" data-html="true"><td><div align="right"><a name="23"></a><a href="#23">23</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="default">$this</span><span class="default">-&gt;</span><span class="default">attributes</span><span class="default">&nbsp;</span><span class="keyword">=</span><span class="default">&nbsp;</span><span class="keyword">isset</span><span class="keyword">(</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'data'</span><span class="keyword">]</span><span class="keyword">)</span><span class="default">&nbsp;</span><span class="keyword">?</span><span class="default">&nbsp;</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'data'</span><span class="keyword">]</span><span class="keyword">[</span><span class="default">'professional'</span><span class="keyword">]</span><span class="default">&nbsp;</span><span class="keyword">:</span><span class="default">&nbsp;</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'professional'</span><span class="keyword">]</span><span class="keyword">;</span></td></tr>
150+
<tr class="covered-by-large-tests popin" data-title="1 test covers line 23" data-content="&lt;ul&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ClientTest::testProfessionalReturnsSingleProfessionalModel&lt;/li&gt;&lt;/ul&gt;" data-placement="bottom" data-html="true"><td><div align="right"><a name="23"></a><a href="#23">23</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="default">$this</span><span class="default">-&gt;</span><span class="default">attributes</span><span class="default">&nbsp;</span><span class="keyword">=</span><span class="default">&nbsp;</span><span class="keyword">isset</span><span class="keyword">(</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'data'</span><span class="keyword">]</span><span class="keyword">)</span><span class="default">&nbsp;</span><span class="keyword">?</span><span class="default">&nbsp;</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'data'</span><span class="keyword">]</span><span class="keyword">[</span><span class="default">'professional'</span><span class="keyword">]</span><span class="default">&nbsp;</span><span class="keyword">:</span><span class="default">&nbsp;</span><span class="keyword">@</span><span class="default">$attributes</span><span class="keyword">[</span><span class="default">'professional'</span><span class="keyword">]</span><span class="keyword">;</span></td></tr>
151151
<tr class="covered-by-large-tests popin" data-title="1 test covers line 24" data-content="&lt;ul&gt;&lt;li class=&quot;covered-by-large-tests&quot;&gt;ClientTest::testProfessionalReturnsSingleProfessionalModel&lt;/li&gt;&lt;/ul&gt;" data-placement="bottom" data-html="true"><td><div align="right"><a name="24"></a><a href="#24">24</a></div></td><td class="codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="keyword">}</span></td></tr>
152152
<tr><td><div align="right"><a name="25"></a><a href="#25">25</a></div></td><td class="codeLine"><span class="keyword">}</span></td></tr>
153153

@@ -162,7 +162,7 @@ <h4>Legend</h4>
162162
<span class="warning"><strong>Dead Code</strong></span>
163163
</p>
164164
<p>
165-
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 4 11:17:34 EST 2016.</small>
165+
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.2.2</a> using <a href="http://php.net/" target="_top">PHP 5.5.31</a> and <a href="http://phpunit.de/">PHPUnit 4.8.6</a> at Fri Mar 25 12:30:14 EDT 2016.</small>
166166
</p>
167167
<a title="Back to the top" id="toplink" href="#"><span class="glyphicon glyphicon-arrow-up"></span></a>
168168
</footer>

0 commit comments

Comments
 (0)