Merge pull request #15 from ricbra/guzzle

Guzzle 4 rewrite

Author: ricbra

.travis.yml

@@ -1,13 +1,13 @@
 language: php
 
 php:
-  - 5.3
   - 5.4
+  - 5.5
 
 notifications:
   email:
     - richard@vandenbrand.org
 
 before_script:
     - wget http://getcomposer.org/composer.phar
-    - php composer.phar install
+    - php composer.phar install

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Richard van den Brand
+Copyright (c) 2010-2014 Richard van den Brand
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

README.md

@@ -1,113 +1,154 @@
 ## Discogs Api
 
 [![Build Status](https://secure.travis-ci.org/ricbra/php-discogs-api.png)](http://travis-ci.org/ricbra/php-discogs-api)
+[![Latest Stable Version](https://poser.pugx.org/ricbra/php-discogs-api/v/stable.svg)](https://packagist.org/packages/ricbra/php-discogs-api)
+[![Total Downloads](https://poser.pugx.org/ricbra/php-discogs-api/downloads.png)](https://packagist.org/packages/ricbra/php-discogs-api)
+[![License](https://poser.pugx.org/ricbra/php-discogs-api/license.png)](https://packagist.org/packages/ricbra/php-discogs-api)
+[![Quality](https://scrutinizer-ci.com/g/ricbra/php-discogs-api/badges/quality-score.png)](https://scrutinizer-ci.com/g/ricbra/php-discogs-api/)
 
-This library is an PHP 5.3 implementation of the [Discogs API v2.0.](http://www.discogs.com/developers/index.html)
+This library is a PHP 5.4 implementation of the [Discogs API v2.0.](http://www.discogs.com/developers/index.html)
 The Discogs API is a REST-based interface. By using this library you don't have to worry about communicating with the
 API: all the hard work has already be done.
 
+This API is build upon the shoulders of a giant: [Guzzle 4.0](http://guzzle.readthedocs.org/en/latest/). This is an absolutely awesome library.
+
 ## License
 This library is released under the MIT license. See the complete license in the LICENSE file.
 
 ## Installation
-Start by [installing composer](http://getcomposer.org/doc/01-basic-usage.md#installation) and finally
-[install the dependencies](http://getcomposer.org/doc/01-basic-usage.md#installing-dependencies).
+Start by [installing composer](http://getcomposer.org/doc/01-basic-usage.md#installation).
+Next do:
+
+    $ composer require ricbra/php-discogs-api ~1.0.0
 
 ## Requirements
-PHP >=5.3.0
+PHP >=5.4.0
 
 ## Usage
 Creating a new instance is as simple as:
 
 ```php
 <?php
-$service = new \Discogs\Service();
+$client = Discogs\ClientFactory::factory([]);
 ```
 
-### Perform a search:
+### OAuth
+There a lot of endpoints which require OAuth. Lucky for you using Guzzle this is peanuts.
 
 ```php
 <?php
 
-$resultset = $service->search(array(
-    'q'     => 'Meagashira',
-    'label' => 'Enzyme'
-));
-
-// Total results
-echo count($resultset)."\n";
-// Total pages
-$pagination = $resultset->getPagination();
-echo count($pagination)."\n";
-
-// Fetch all results (use on your own risk, only one request per second allowed)
-do {
-    $pagination = $resultset->getPagination();
-    echo $pagination->getPage().'<br />';
-    foreach ($resultset as $result) {
-        echo get_class($result).'<br />';
-    }
-} while($resultset = $service->next($resultset));
+$client = Discogs\ClientFactory::factory([]);
+$oauth = new GuzzleHttp\Subscriber\Oauth\Oauth1([
+    'consumer_key'    => $consumerKey, // from Discogs developer page
+    'consumer_secret' => $consumerSecret, // from Discogs developer page
+    'token'           => $token['oauth_token'], // get this using a OAuth library
+    'token_secret'    => $token['oauth_token_secret'] // get this using a OAuth library
+]);
+$client->getHttpClient()->getEmitter()->attach($oauth);
+
+$response = $client->search([
+    'q' => 'searchstring'
+]);
 ```
 
-### Get information about a label:
+### History
+Another cool plugin is the History plugin:
 
 ```php
 <?php
 
-$label = $service->getLabel(1);
+$client = Discogs\ClientFactory::factory([]);
+$history = new GuzzleHttp\Subscriber\History();
+$client->getHttpClient()->getEmitter()->attach($history);
+
+$response = $client->search([
+    'q' => 'searchstring'
+]);
+
+foreach ($history as $row) {
+    print (string) $row['request'];
+    print (string) $row['response'];
+}
 
-echo $label->getName()."\n";
 ```
 
-### Get information about an artist:
+### More info and plugins
+For more information about Guzzle and its plugins checkout [the docs.](http://guzzle.readthedocs.org/en/latest/)
+
+### Perform a search:
+Per august 2014 an signed OAuth request is required for this endpoint.
 
 ```php
 <?php
 
-$artist = $service->getArtist(1);
+$response = $client->search([
+    'q' => 'Meagashira'
+]);
+// Loop through results
+foreach ($response['results'] as $result) {
+    var_dump($result['title']);
+}
+// Pagination data
+var_dump($response['pagination']);
+
+// Dump all data
+var_dump($response->toArray());
 
-echo $artist->getName()."\n";
 ```
 
-### Get information about a release:
+### Get information about a label:
 
 ```php
 <?php
 
-$release = $service->getRelease(1);
+$label = $service->getLabel([
+    'id' => 1
+]);
 
-echo $release->getTitle()."\n";
 ```
 
-### Get information about a master release:
+### Get information about an artist:
 
 ```php
 <?php
 
-$master  = $service->getMaster(1);
+$artist = $service->getArtist([
+    'id' => 1
+]);
 
-echo $master->getTitle()."\n";
 ```
 
-### Response transformation
+### Get information about a release:
 
-You have two options in which form to receive formatted response: as object using supplied models, or as plain array.
-By default (if nothing has been set via setter) Model response transformer is chosen. You can manipulate it via
-the `setResponseTransfomer` setter:
+```php
+<?php
 
-``` php
-$discogs->setResponseTransformer(new \Discogs\ResponseTransformer\Model());
-// or
-$discogs->setResponseTransformer(new \Discogs\ResponseTransformer\Hash());
+$release = $service->getRelease([
+    'id' => 1
+]);
+
+echo $release['title']."\n";
 ```
 
-You can also set your own response transformer which need to implement the `ResponseTransformerInterface`
+### Get information about a master release:
 
-**NOTE** At this moment only the "Database" resource has been implemented. The "Marketplace" and "User" are missing.
+```php
+<?php
+
+$master  = $service->getMaster([
+    'id' => 1
+]);
+
+echo $master['title']."\n";
+```
 
 ## Documentation
 Further documentation can be found at the [Discogs API v2.0 Documentation](http://www.discogs.com/developers/index.html).
 
+## Contributing
+Implemented a missing call? PR's are welcome! 
+
+
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ricbra/php-discogs-api/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 

UPGRADE.md

@@ -0,0 +1,40 @@
+Upgrade from 0.x.x to 1.0.0
+===========================
+
+API calls
+---------
+
+All API calls signatures have changed. Old situation:
+
+    <?php
+
+    $service->getArtist(1);
+
+New situation is always using arrays:
+
+    <?php
+
+    $service->getArtist([
+        'id' => 1
+    ]);
+
+In the <code>resources/service.php</code> file you can find all the implemented calls and their signatures and responses.
+
+Iterator removed
+----------------
+
+It's not yet possible to iterate over the responses. Perhaps this will be added in the near future. It should be
+easy to implement an <code>Iterator</code> yourself. PR's are welcome :).
+
+Caching removed
+---------------
+
+Caching in the library itself is removed. This can be achieved by creating or using a cache plugin. At the moment of
+writing the plugin for Guzzle isn't refactored yet for version 4.0.
+
+No more models
+--------------
+
+Models have been replaced with plain old arrays. Models were nice for typing but a hell to manage. All responses will
+return an array. When you want to debug the output use <code>$response->toArray()</code>.
+

composer.json

@@ -5,8 +5,10 @@
     "keywords": ["discogs", "api"],
     "license": "MIT",
     "require": {
-        "kriswallsmith/buzz": ">=0.5",
-        "php": ">=5.3.0"
+        "php": ">=5.4.0",
+        "guzzlehttp/guzzle": "~4.0",
+        "guzzlehttp/guzzle-services": "~0.3.0",
+        "guzzlehttp/oauth-subscriber": "~0.1.2"
     },
     "require-dev": {
         "phpunit/phpunit": "~4"
@@ -19,5 +21,7 @@
     ],
     "autoload": {
         "psr-0": { "Discogs": "lib/" }
-    }
-}
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}