Laravel integration

Author: danmichaelo

README.md

@@ -25,10 +25,30 @@ Add the package to the `require` list of your `composer.json` file.
         "scriptotek/sru-client": "dev-master"
     },
 }
-``` 
+```
 
 and run `composer install` to get the latest version of the package.
 
+### Laravel 4/5 integration
+
+In the $providers array add the service providers for this package:
+
+    'Scriptotek\Sru\Providers\SruServiceProvider'
+
+Add the facade of this package to the `$aliases` array:
+
+    'SruClient' => 'Scriptotek\Sru\Facades\SruClient'
+
+Publish configuration in Laravel 5:
+
+    $ php artisan vendor:publish --provider="Scriptotek\Sru\Providers\SruServiceProviderLaravel5"
+
+Publish configuration in Laravel 4:
+
+    $ php artisan config:publish scriptotek/sru
+
+In Laravel 5 applications the configuration file is copied to `config/sru.php`, in Laravel 4 applications you will find the file at `app/config/packages/scriptotek/sru/config.php`.
+
 ### Example
 
 ```php

config/config.php

@@ -0,0 +1,45 @@
+<?php
+return array(
+    /*
+    |--------------------------------------------------------------------------
+    | Endpoint
+    |--------------------------------------------------------------------------
+    |
+    | Default endpoint URL to use.
+    |
+    */
+    'endpoint' => 'URL-TO-ENDPOINT',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Schema
+    |--------------------------------------------------------------------------
+    |
+    | Default schema to use.
+    |
+    */
+    'schema' => 'marcxml',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Version
+    |--------------------------------------------------------------------------
+    |
+    | Default version to use.
+    |
+    */
+    'version' => '1.1',
+
+    /*
+    |--------------------------------------------------------------------------
+    | User-Agent
+    |--------------------------------------------------------------------------
+    |
+    | Default user-agent to identify as.
+    |
+    */
+    'user-agent' => 'MyLaravelSite/0.1',
+
+
+);
+

provides.json

@@ -0,0 +1,11 @@
+{
+  "providers": [
+    "Scriptotek\Sru\Providers\SruServiceProvider"
+  ],
+  "aliases": [
+    {
+      "alias": "SruClient",
+      "facade": "Scriptotek\Sru\Facades\SruClient"
+    }
+  ]
+}

src/Facades/SruClient.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Scriptotek\Sru\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+class SruClient extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return 'sru-client';
+    }
+}

src/Providers/SruServiceProvider.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Scriptotek\Sru\Providers;
+
+use Illuminate\Foundation\Application;
+use Illuminate\Support\ServiceProvider;
+
+class SruServiceProvider extends ServiceProvider
+{
+    /**
+     * Indicates if loading of the provider is deferred.
+     *
+     * @var bool
+     */
+    protected $defer = false;
+    /**
+     * Actual provider
+     *
+     * @var \Illuminate\Support\ServiceProvider
+     */
+    protected $provider;
+    /**
+     * Create a new service provider instance.
+     *
+     * @param  \Illuminate\Contracts\Foundation\Application  $app
+     * @return void
+     */
+    public function __construct($app)
+    {
+        parent::__construct($app);
+        $this->provider = $this->getProvider();
+    }
+    /**
+     * Bootstrap the application events.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        return $this->provider->boot();
+    }
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        return $this->provider->register();
+    }
+    /**
+     * Return ServiceProvider according to Laravel version
+     *
+     * @return \Scriptotek\Sru\Provider\ProviderInterface
+     */
+    private function getProvider()
+    {
+        if (version_compare(Application::VERSION, '5.0', '<')) {
+            $provider = '\Scriptotek\Sru\SruClientProviderLaravel4';
+        } else {
+            $provider = '\Scriptotek\Sru\SruClientProviderLaravel5';
+        }
+        return new $provider($this->app);
+    }
+    /**
+     * Get the services provided by the provider.
+     *
+     * @return array
+     */
+    public function provides()
+    {
+        return array('sru-client');
+    }
+}

src/Providers/SruServiceProviderLaravel4.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Scriptotek\Sru\Providers;
+
+use Illuminate\Support\ServiceProvider;
+use Scriptotek\Sru\Client as SruClient;
+
+class SruServiceProviderLaravel4 extends ServiceProvider
+{
+    /**
+     * Bootstrap the application events.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $this->package('scriptotek/sru');
+    }
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $app = $this->app;
+        $app['sru-client'] = $app->share(function ($app) {
+            return new SruClient($app['config']->get('sru-client::config'));
+        });
+        $app->alias('sru-client', 'Scriptotek\Sru\Client');
+    }
+}

src/Providers/SruServiceProviderLaravel5.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Scriptotek\Sru\Providers;
+
+use Illuminate\Support\ServiceProvider;
+use Scriptotek\Sru\Client as SruClient;
+
+class SruServiceProviderLaravel5 extends ServiceProvider
+{
+    /**
+     * Bootstrap the application events.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $this->publishes(array(
+            __DIR__.'/../../config/config.php' => config_path('sru.php')
+        ));
+    }
+
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $app = $this->app;
+        $this->mergeConfigFrom(
+            __DIR__.'/../../config/config.php',
+            'sru'
+        );
+        $app['sru-client'] = $app->share(function ($app) {
+            return new SruClient($app['config']->get('sru'));
+        });
+        $app->alias('sru-client', 'Scriptotek\Sru\Client');
+    }
+}