Support added for separate wordpress database via eloquent connection.

Author: Ahsaan Muhammad Yousuf

CHANGELOG.md

@@ -1,4 +1,22 @@
-# wordpress-auth-driver-laravel Changelog
+# CHANGELOG
+
+## 2.1.0
+ - Support added for seperate connection in `config/database.php`
+ - Default `wp_` prefix removed from `Models\WordpressUser.php`. It'll be handled by connection in `config/database.php`
+ - Added `user_registered` date mutators.
+ - Config file renamed to `wordpress-auth`
+ - README.md and CHANGELOG.md Updated
+
+## 2.0.0
+ - Added support for Laravel 5.6 & 5.7
+
+## 1.1.0
+ - Laravel 5.5 Support added
+
+## 1.0.1 - 1.0.2
+ - Package type changed to library
+ - Added scrutinizer badges in README.md
+ - Added README.md & CHANGELOG.md
 
 ## 1.0.0
  - Initial release.

README.md

@@ -2,6 +2,11 @@
 
 [![Latest Stable Version](https://poser.pugx.org/ahsankhatri/wordpress-auth-provider/v/stable)](https://packagist.org/packages/ahsankhatri/wordpress-auth-provider) [![Total Downloads](https://poser.pugx.org/ahsankhatri/wordpress-auth-provider/downloads)](https://packagist.org/packages/ahsankhatri/wordpress-auth-provider) [![Build Status](https://scrutinizer-ci.com/g/ahsankhatri/wordpress-auth-driver-laravel/badges/build.png?b=master)](https://scrutinizer-ci.com/g/ahsankhatri/wordpress-auth-driver-laravel/build-status/master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/ahsankhatri/wordpress-auth-driver-laravel/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/ahsankhatri/wordpress-auth-driver-laravel/?branch=master) [![Code Intelligence Status](https://scrutinizer-ci.com/g/ahsankhatri/wordpress-auth-driver-laravel/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence) [![License](https://poser.pugx.org/ahsankhatri/wordpress-auth-provider/license)](https://packagist.org/packages/ahsankhatri/wordpress-auth-provider)
 
+| **Laravel**  |  **wordpress-auth-driver-laravel** |
+|---|---|
+| 5.2 to 5.5  | ^1.0  |
+| 5.6 to 5.7  | ^2.0  |
+
 ## Installation
 
 To install this package you will need
@@ -55,6 +60,32 @@ To register authentication guard.
     ],
 ```
 
+#### Publish config file (optional)
+```bash
+php artisan vendor:publish --provider="MrShan0\WordpressAuth\WordpressAuthServiceProvider"
+```
+
+It will publish config file (`config/wordpress-auth.php`) where you can define your own connection type e.g `wp-mysql`. Make sure to fill `prefix` in `config/database.php` for `wp_` prefix in your tables if you're using prefix in wordpress tabels.
+
+For example:
+```php
+'wp-mysql' => [
+    'driver' => 'mysql',
+    'host' => env('WP_DB_HOST', '127.0.0.1'),
+    'port' => env('WP_DB_PORT', '3306'),
+    'database' => env('WP_DB_DATABASE', 'forge'),
+    'username' => env('WP_DB_USERNAME', 'forge'),
+    'password' => env('WP_DB_PASSWORD', ''),
+    'unix_socket' => env('WP_DB_SOCKET', ''),
+    'charset' => 'utf8mb4',
+    'collation' => 'utf8mb4_unicode_ci',
+    'prefix' => 'wp_',
+    'prefix_indexes' => true,
+    'strict' => true,
+    'engine' => null,
+],
+```
+
 ## Configuration
 
 `password_resets` table (from Laravel default auth mechanism) is required to hold reset password token. If you do not have `password_resets` table then use this migration instead
@@ -93,6 +124,9 @@ class CreatePasswordResetsTable extends Migration
 }
 ```
 
+## Extension
+Alternatively, if you want to use a custom user model, you should have it extend `MrShan0\WordpressAuth\Models\WordpressUser` and specify the name of your model in `config/auth.php` under `providers` -> `wordpress` -> `model`.
+
 ## Usage
 You need to define `wordpress` **guard** explicitly to load the driver.
 ### Examples
@@ -108,6 +142,10 @@ Auth::guard('wordpress')->attempt([
 // get user object
 Auth::guard('wordpress')->user();
 
+// Update wordpress compatible password
+$user->user_pass = app('wordpress-auth')->make('new_password');
+$user->save();
+
 // logout
 Auth::guard('wordpress')->logout();
 ```

config/hash.php

@@ -0,0 +1,47 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Seperate Database Connection
+    |--------------------------------------------------------------------------
+    |
+    | You can define your own connection other than the default one in
+    | database.php to use multiple connections/database in one.
+    |
+    */
+    'connection' => 'mysql',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Password hashing configuration for Wordpress authentication
+    |--------------------------------------------------------------------------
+    */
+    'hash' => [
+
+        /*
+        |--------------------------------------------------------------------------
+        | Iteration Count
+        |--------------------------------------------------------------------------
+        |
+        | The number of iterations used to hash the password.
+        | Minimum: 4, Maximum: 31
+        |
+        */
+        'iteration_count' => 8,
+
+
+        /*
+        |--------------------------------------------------------------------------
+        | Portable Hashes
+        |--------------------------------------------------------------------------
+        |
+        | Should we generate portable hashes? true or false
+        |
+        */
+        'portable_hashes' => true,
+
+    ]
+
+];

config/wordpress-auth.php

@@ -13,21 +13,21 @@ class WordpressUser extends Authenticatable
 
     /**
      * Explicitly define your table name
-     * 
+     *
      * @var string
      */
-    protected $table = 'wp_users';
+    protected $table = 'users';
 
     /**
      * Disable timestamps
-     * 
+     *
      * @var boolean
      */
     public $timestamps = false;
 
     /**
      * Define primary key
-     * 
+     *
      * @var string
      */
     protected $primaryKey = 'ID';
@@ -39,6 +39,15 @@ class WordpressUser extends Authenticatable
      */
     protected $rememberTokenName = false;
 
+    /**
+     * The attributes that should be mutated to dates.
+     *
+     * @var array
+     */
+    protected $dates = [
+        'user_registered',
+    ];
+
     /**
      * The attributes that should be hidden for arrays.
      *
@@ -49,6 +58,37 @@ class WordpressUser extends Authenticatable
         'remember_token', // disabled via protected property
     ];
 
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'user_login',
+        'user_pass',
+        'user_nicename',
+        'user_email',
+        'user_url',
+        'user_registered',
+        'user_activation_key',
+        'user_status',
+        'display_name',
+    ];
+
+    /**
+     * Create a new Eloquent model instance.
+     *
+     * @param  array  $attributes
+     * @return void
+     */
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+
+        // Set connection from config
+        $this->setConnection(config('wordpress-auth.connection', 'mysql'));
+    }
+
     /**
      * Get the e-mail address where password reset links are sent.
      *
@@ -61,7 +101,7 @@ public function getEmailForPasswordReset()
 
     /**
      * Return password value
-     * 
+     *
      * @return string
      */
     public function getAuthPassword()
@@ -71,7 +111,7 @@ public function getAuthPassword()
 
     /**
      * Usage for notifiable for email
-     * 
+     *
      * @return string
      */
     public function routeNotificationForMail()

src/Models/WordpressUser.php

@@ -5,9 +5,9 @@
 use Auth;
 use Hautelook\Phpass\PasswordHash;
 use Illuminate\Support\ServiceProvider;
-use MrShan0\WordpressAuth\Hashing\WordPressHasher;
 use MrShan0\WordpressAuth\Auth\EloquentWordpressUserProvider;
 use MrShan0\WordpressAuth\Guard\WordpressGuard;
+use MrShan0\WordpressAuth\Hashing\WordPressHasher;
 
 class WordpressAuthServiceProvider extends ServiceProvider
 {
@@ -18,33 +18,44 @@ class WordpressAuthServiceProvider extends ServiceProvider
      */
     protected $defer = false;
 
+    /**
+     * Perform post-registration booting of services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $this->publishes([
+            __DIR__ . '/../config/wordpress-auth.php' => config_path('wordpress-auth.php'),
+        ]);
+    }
+
     /**
      * Register bindings in the container.
      *
      * @return void
      */
     public function register()
     {
-        $this->mergeConfigFrom(__DIR__ . '/../config/hash.php', 'wordpress-hash.hash');
+        $this->mergeConfigFrom(__DIR__ . '/../config/wordpress-auth.php', 'wordpress-auth');
 
-        Auth::extend('wordpress', function($app) {
+        Auth::extend('wordpress', function ($app) {
             return new WordpressGuard(
-                new EloquentWordpressUserProvider($app['wordpress-hash'], $config['model'])
+                new EloquentWordpressUserProvider($app['wordpress-auth'], $config['model'])
             );
         });
 
-        $this->app->singleton('wordpress-hash', function ($app)
-        {
-            $iteration_count = $app['config']->get('wordpress-hash.hash.iteration_count');
-            $portable_hashes = $app['config']->get('wordpress-hash.hash.portable_hashes');
+        $this->app->singleton('wordpress-auth', function ($app) {
+            $iteration_count = $app['config']->get('wordpress-auth.hash.iteration_count');
+            $portable_hashes = $app['config']->get('wordpress-auth.hash.portable_hashes');
 
             $hasher = new PasswordHash($iteration_count, $portable_hashes);
 
             return new WordPressHasher($hasher);
         });
 
-        Auth::provider('eloquent.wordpress', function($app, array $config) {
-            return new EloquentWordpressUserProvider($app['wordpress-hash'], $config['model']);
+        Auth::provider('eloquent.wordpress', function ($app, array $config) {
+            return new EloquentWordpressUserProvider($app['wordpress-auth'], $config['model']);
         });
     }
 
@@ -55,6 +66,6 @@ public function register()
      */
     public function provides()
     {
-        return ['wordpress-hash'];
+        return ['wordpress-auth'];
     }
 }