Category: API

Laravel 5 RESTful API with Basic Auth: PHPUnit Testing

I’ve been using PHPUnit to test my RESTful API. PHPUnit is ready to use in Laravel.

In my Laravel-based RESTful API, I have an endpoint /api/users which returns JSON data when you send a GET request. The API will only return such data if the client sends the corrent username and password (Basic Authentication). The JSON data looks like this:

{“success”:true,”users”:[{“id”:1,”name”:”default”,”email”:”def@def.def”,”created_at”:”2016-07-08 20:23:47″,”updated_at”:”2016-07-08 20:23:47″},{“id”:2,”name”:”Eddard Stark”,”email”:”winter@westeros.org”,”created_at”:”2016-07-08 20:23:47″,”updated_at”:”2016-07-08 20:23:47″},{“id”:3,”name”:”Jon Snow”,”email”:”lorcommander@nightswatch.org”,”created_at”:”2016-07-08 20:23:47″,”updated_at”:”2016-07-08 20:23:47″},{“id”:4,”name”:”Sansa Stark”,”email”:”wholetthedogsout@winterfell.com”,”created_at”:”2016-07-08 20:23:48″,”updated_at”:”2016-07-08 20:23:48″},{“id”:5,”name”:”Tyrion Lanniter”,”email”:”ilikedragons@westeros.org”,”created_at”:”2016-07-08 20:23:48″,”updated_at”:”2016-07-08 20:23:48″},{“id”:6,”name”:”Lyanna Mormont”,”email”:”lyanna@bearisland.org”,”created_at”:”2016-07-08 20:23:48″,”updated_at”:”2016-07-08 20:23:48″},{“id”:7,”name”:”Davos Seaworth”,”email”:”seaworth@westeros.org”,”created_at”:”2016-07-08 20:23:48″,”updated_at”:”2016-07-08 20:23:48″},{“id”:8,”name”:”Daenerys Targaryen”,”email”:”queen@westeros.org”,”created_at”:”2016-07-08 20:23:48″,”updated_at”:”2016-07-08 20:23:48″},{“id”:9,”name”:”Cersei Lannister”,”email”:”longmayshereign@westeros.org”,”created_at”:”2016-07-08 20:23:48″,”updated_at”:”2016-07-08 20:23:48″},{“id”:10,”name”:”Gregor Clegane”,”email”:”hound@westeros.org”,”created_at”:”2016-07-08 20:23:48″,”updated_at”:”2016-07-08 20:23:48″}],”status_code”:200}

{“success”:true,“users”:[{“id”:1,“name”:“default”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:47”,“updated_at”:“2016-07-08 20:23:47”},{“id”:2,“name”:“Eddard Stark”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:47”,“updated_at”:“2016-07-08 20:23:47”},{“id”:3,“name”:“Jon Snow”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:47”,“updated_at”:“2016-07-08 20:23:47”},{“id”:4,“name”:“Sansa Stark”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:48”,“updated_at”:“2016-07-08 20:23:48”},{“id”:5,“name”:“Tyrion Lanniter”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:48”,“updated_at”:“2016-07-08 20:23:48”},{“id”:6,“name”:“Lyanna Mormont”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:48”,“updated_at”:“2016-07-08 20:23:48”},{“id”:7,“name”:“Davos Seaworth”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:48”,“updated_at”:“2016-07-08 20:23:48”},{“id”:8,“name”:“Daenerys Targaryen”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:48”,“updated_at”:“2016-07-08 20:23:48”},{“id”:9,“name”:“Cersei Lannister”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:48”,“updated_at”:“2016-07-08 20:23:48”},{“id”:10,“name”:“Gregor Clegane”,“email”:“[email protected]”,“created_at”:“2016-07-08 20:23:48”,“updated_at”:“2016-07-08 20:23:48”}],“status_code”:200}

I’m gonna show you how to create a PHPUnit test for this kind of JSON API data in Laravel 5.

To create a test case, use this command:

 php artisan make:test ApiUsersTest

1	php artisan make:test ApiUsersTest

This will create a new test case named ApiUsersTest.php in your directory /tests

Paste the following code in it.

<?php

use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;

class ApiUsersTest extends TestCase
{
    use DatabaseTransactions; 

    public function testGetAllUsersNoAuth()
    {
		$content = $this->call(‘GET’, ‘/api/users’)->getContent();
		$this->assertEquals($content, “Invalid credentials.”);
    }

    public function testGetAllUsersWithBasicAuth()
    {
	    $content = $this->call(‘GET’, ‘/api/users’,[],[], [], [
            “HTTP_Authorization” => “Basic ” . base64_encode(“username” . “:” . “password”),
            “PHP_AUTH_USER” => “username”, // must add this header since PHP won’t set it correctly
            “PHP_AUTH_PW” => “password” // must add this header since PHP won’t set it correctly as well
        ])->getContent();

		$json_content = json_decode($content);

        if(!empty($json_content->success)){
        	$this->assertTrue($json_content->success); // this test expects the JSON key “success” to have value of Boolean true
        }
        
	}

}

<?php

use Illuminate\Foundation\Testing\WithoutMiddleware;

use Illuminate\Foundation\Testing\DatabaseMigrations;

use Illuminate\Foundation\Testing\DatabaseTransactions;

class ApiUsersTest extends TestCase

{

use DatabaseTransactions;

public function testGetAllUsersNoAuth()

{

$content = $this->call(‘GET’, ‘/api/users’)->getContent();

$this->assertEquals($content, “Invalid credentials.”);

}

public function testGetAllUsersWithBasicAuth()

{

$content = $this->call(‘GET’, ‘/api/users’,[],[], [], [

“HTTP_Authorization” => “Basic “ . base64_encode(“username” . “:” . “password”),

“PHP_AUTH_USER” => “username”, // must add this header since PHP won’t set it correctly

“PHP_AUTH_PW” => “password” // must add this header since PHP won’t set it correctly as well

])->getContent();

$json_content = json_decode($content);

if(!empty($json_content->success)){

$this->assertTrue($json_content->success); // this test expects the JSON key “success” to have value of Boolean true

}

Edit the test case as needed.

July 9, 2016

Google Maps get coordinates on click or drag and drop
With this tutorial you’ll see how we can place a Google map with search box on your web page, and then get coordinates (i.e. latitude and longitude) based on where you click or where you drag and drop the marker into. The JavaScript API of Google Maps will help us achieve this.

This kind of map will be useful if you want to save coordinates from a Google map into your database. For example, if you’d like to save coordinates of a user-defined location, you can incorporate this map into your registration process — ask your users to point the marker to their location by clicking on the map or by dragging then dropping the marker.

There will be two types of icons in this map. First, a red default marker. Wherever you move it, we’ll get the coordinates that it points to. Second, white square markers which will appear to point to the location you searched for using the search box.

Map Demo

Try the map below — this is more or less how our map will look like later at the end of this tutorial. 🙂 Please read on and soon I’ll share the codes with you.

Get coordinates from Google Map

Latitude: Longitude:

Click on any point or drag the marker to get coordinates.
This tutorial will cover the following:

Google map on a web page

Search box for map

Get map coordinates on click

Get map coordinates on drag and drop of the marker
And you will need these:

Familiarity with HTML and JavaScript

Internet connection

Google account

Development environment (I used XAMPP on Windows 7 for this)

Code editor (I use Sublime Text)
(more…)
October 12, 2015
How to make a basic “Login via Facebook” with PHP & JavaScript

You’ve seen how some popular websites let you register or login via Facebook — Pinterest, Vimeo, Lifehacker, and many more.

In this blog post, I’ll show you the very basic setup of the Facebook login button for your website. It is up to you to enhance the functions of your registration system.

Note: There are periodic updates to the Facebook API, sometimes resulting to issues with previously working implementations of the API. So please note that this tutorial was written in the third week August 2015. 🙂

I began writing this tutorial late in August, but because of other projects, was able to publish it when it’s already September.

(more…)

September 8, 2015

Category: API

Laravel 5 RESTful API with Basic Auth: PHPUnit Testing

Google Maps get coordinates on click or drag and drop

Map Demo

Get coordinates from Google Map

How to make a basic “Login via Facebook” with PHP & JavaScript