fedeisas/dolar-blue

Package to fetch latest USD conversion rate on Argentina's black market

Installs: 3

Dependents: 0

Stars: 1

Watchers: 1

Language: PHP

1.0 2014-05-29 00:16 UTC

README

Travis Badge Coverage Status Latest Stable Version Latest Unstable Version Total Downloads License

Why?

Because Argentina has a black market for currency exchange. And this makes it easy to retrieve the current USD conversion rate from different sources. And also because I needed something small to talk about Package Development and testing on this meetup.

Requirements

  • PHP >= 5.4

Installation

Begin by installing this package through Composer. Edit your project's composer.json file to require `fedeisas/dolar-blue.

{
  "require": {
        ...
        "fedeisas/dolar-blue": "1.*"
        ...
    },
    "minimum-stability" : "dev"
}

Next, update Composer from the Terminal:

$ composer update

Once this operation completes, the final step is to add the service provider. Open app/config/app.php, and add a new item to the providers array.

'providers' => array(
    ...
    'Fedeisas\LaravelDolarBlue\LaravelDolarBlueServiceProvider',
)

Optionally you can also add the Facade to the aliases array on app/config/app.php:

'aliases' => array(
    ...
    'DolarBlue' => 'Fedeisas\LaravelDolarBlue\Facade\LaravelDolarBlue',
)

Providers

Usage

use Fedeisas\DolarBlue\DolarBlue;
use GuzzleHttp\Client;

$service = new DolarBlue(new Client);
$result = $service->get('DolarBlue'); // or $service->DolarBlue();
// returns
// array(
//   'buy' => '10.15',
//   'sell' => '10.55',
//   'timestamp' => 1399080004
// )

Or you can use magic methods:

$result = $service->LaNacion();
$result = $service->DolarBlue();
$result = $service->BlueLytics();

Contributing

$ composer install --dev
$ ./vendor/bin/phpunit

In addition to a full test suite, there is Travis integration.

Found a bug?

Please, let me know! Send a pull request or a patch. Questions? Ask! I will respond to all filed issues.

Inspiration

I needed an idea for a small library, and I borrowed it from a friend who has done something similar for NodeJS. You should check it out: https://github.com/matiu/dolar-blue

License

This package is open-sourced software licensed under the MIT license