Skip to content

Commit 0e3d1ea

Browse files
florianvflorianv
committed
Swap 3.0
1 parent 5276499 commit 0e3d1ea

16 files changed

+743
-254
lines changed

‎.editorconfig

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at http://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_size = 4
9+
indent_style = space
10+
end_of_line = lf
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.gitattributes

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
* text=auto
2+
3+
/doc export-ignore
4+
/tests export-ignore
5+
.editorconfig export-ignore
6+
.gitattributes export-ignore
7+
.gitignore export-ignore
8+
.scrutinizer.yml export-ignore
9+
.styleci.yml export-ignore
10+
.travis.yml export-ignore
11+
phpunit.xml export-ignore

‎.scrutinizer.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
filter:
2+
excluded_paths: [tests/*]
3+
4+
checks:
5+
php:
6+
remove_extra_empty_lines: true
7+
remove_php_closing_tag: true
8+
remove_trailing_whitespace: true
9+
fix_use_statements:
10+
remove_unused: true
11+
preserve_multiple: false
12+
preserve_blanklines: true
13+
order_alphabetically: true
14+
fix_php_opening_tag: true
15+
fix_linefeed: true
16+
fix_line_ending: true
17+
fix_identation_4spaces: true
18+
fix_doc_comments: true

‎.styleci.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
preset: symfony
2+
3+
finder:
4+
path:
5+
- "src"
6+
- "tests"

‎.travis.yml

+9-5
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@ language: php
22

33
php:
44
- 5.5
5-
- 5.5.9
65
- 5.6
76
- 7.0
8-
- nightly
97
- hhvm
108

9+
sudo: false
10+
11+
cache:
12+
directories:
13+
- $HOME/.composer/cache
14+
1115
before_script:
12-
- composer selfupdate
13-
- composer --prefer-source --dev install
16+
- travis_retry composer self-update
17+
- travis_retry composer update --no-interaction --prefer-dist
1418

1519
script:
16-
- bin/phpunit
20+
- composer test

‎README.md

+50-39
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,85 @@
1-
# Laravel Swap
1+
<img src="https://github.com/florianv/swap/blob/master/doc/logo.png" width="200px" align="left"/>
2+
> Currency exchange rates library for Laravel
23
3-
[![Build status][travis-image]][travis-url]
4-
[![Version][version-image]][version-url]
5-
[![Downloads][downloads-image]][downloads-url]
4+
[![Build status](http://img.shields.io/travis/florianv/laravel-swap.svg?style=flat-square)](https://travis-ci.org/florianv/laravel-swap)
5+
[![Total Downloads](https://img.shields.io/packagist/dt/florianv/laravel-swap.svg?style=flat-square)](https://packagist.org/packages/florianv/laravel-swap)
6+
[![Scrutinizer](https://img.shields.io/scrutinizer/g/florianv/laravel-swap.svg?style=flat-square)](https://scrutinizer-ci.com/g/florianv/laravel-swap)
7+
[![Version](http://img.shields.io/packagist/v/florianv/laravel-swap.svg?style=flat-square)](https://packagist.org/packages/florianv/laravel-swap)
68

7-
> Integrates [Swap](https://github.com/florianv/swap) with Laravel
9+
**Swap** allows you to retrieve currency exchange rates from various services such as [Fixer](http://fixer.io) or [Yahoo](https://finance.yahoo.com/) and optionally cache the results.
810

9-
## Installation
11+
<br /><br />
1012

11-
Install the package via [Composer](https://getcomposer.org):
13+
## QuickStart
14+
15+
1) Install via Composer:
1216

1317
```bash
14-
$ composer require florianv/laravel-swap
18+
$ composer require florianv/laravel-swap php-http/message php-http/guzzle6-adapter
1519
```
1620

17-
## Configuration
18-
19-
Register the service provider and the facade in your configuration:
21+
2) Configure the Service Provider and alias:
2022

2123
```php
2224
// config/app.php
2325
'providers' => [
24-
Florianv\LaravelSwap\SwapServiceProvider::class
26+
Swap\Laravel\SwapServiceProvider::class
2527
],
2628

2729
'aliases' => [
28-
'Swap' => Florianv\LaravelSwap\Facades\Swap::class
30+
'Swap' => Swap\Laravel\Facades\Swap::class
2931
]
3032
```
3133

32-
Publish Swap's configuration:
34+
3) Publish the Package configuration
3335

3436
```bash
35-
$ php artisan vendor:publish
37+
$ php artisan vendor:publish --provider="Swap\Laravel\SwapServiceProvider"
3638
```
3739

38-
By default, `Swap` is configured to use the `FileGetContentsHttpAdapter`, the `YahooFinanceProvider` provider and don't use a cache.
40+
4) Start using it!
3941

40-
For more informations about all possibilities including Laravel Cache integration, read the comments in the
41-
[configuration file](https://github.com/florianv/laravel-swap/blob/master/config/swap.php).
42+
```php
43+
// Get the latest EUR/USD rate
44+
$rate = Swap::latest('EUR/USD');
4245

43-
## Usage
46+
// 1.129
47+
$rate->getValue();
4448

45-
### Via the Facade
49+
// 2016-08-26
50+
$rate->getDate()->format('Y-m-d');
4651

47-
```php
48-
Route::get('/', function () {
49-
$rate = Swap::quote('EUR/USD');
50-
});
52+
// Get the EUR/USD rate yesterday
53+
$rate = Swap::historical('EUR/USD', Carbon::yesterday());
5154
```
5255

53-
### Via Injection
56+
## Documentation
5457

55-
```php
56-
use Swap\SwapInterface;
58+
The complete documentation can be found [here](https://github.com/florianv/laravel-swap/blob/master/doc/readme.md).
5759

58-
Route::get('/', function (SwapInterface $swap) {
59-
$rate = $swap->quote('EUR/USD');
60-
});
61-
```
60+
## Services
6261

63-
## License
62+
Here is the list of the currently implemented services.
6463

65-
[MIT](https://github.com/florianv/laravel-swap/blob/master/LICENSE)
64+
| Service | Base Currency | Quote Currency | Historical |
65+
|---------------------------------------------------------------------------|----------------------|----------------|----------------|
66+
| [Fixer](http://fixer.io) | * | * | Yes |
67+
| [European Central Bank](http://www.ecb.europa.eu/home/html/index.en.html) | EUR | * | Yes |
68+
| [Google](http://www.google.com/finance) | * | * | No |
69+
| [Open Exchange Rates](https://openexchangerates.org) | USD (free), * (paid) | * | Yes |
70+
| [Xignite](https://www.xignite.com) | * | * | Yes |
71+
| [Yahoo](https://finance.yahoo.com) | * | * | No |
72+
| [WebserviceX](http://www.webservicex.net/ws/default.aspx) | * | * | No |
73+
| [National Bank of Romania](http://www.bnr.ro) | RON | * | No |
74+
| [Central Bank of the Republic of Turkey](http://www.tcmb.gov.tr) | * | TRY | No |
75+
| [Central Bank of the Czech Republic](http://www.cnb.cz) | * | CZK | No |
76+
| [currencylayer](https://currencylayer.com) | USD (free), * (paid) | * | Yes |
6677

67-
[travis-url]: https://travis-ci.org/florianv/laravel-swap
68-
[travis-image]: http://img.shields.io/travis/florianv/laravel-swap.svg
78+
## Credits
6979

70-
[version-url]: https://packagist.org/packages/florianv/laravel-swap
71-
[version-image]: http://img.shields.io/packagist/v/florianv/laravel-swap.svg
80+
- [Florian Voutzinos](https://github.com/florianv)
81+
- [All Contributors](https://github.com/florianv/laravel-swap/contributors)
82+
83+
## License
7284

73-
[downloads-url]: https://packagist.org/packages/florianv/laravel-swap
74-
[downloads-image]: https://img.shields.io/packagist/dt/florianv/laravel-swap.svg
85+
The MIT License (MIT). Please see [LICENSE](https://github.com/florianv/laravel-swap/blob/master/LICENSE) for more information.

‎composer.json

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "florianv/laravel-swap",
33
"type": "library",
4-
"description": "Integrates Swap with Laravel 5",
4+
"description": "Currency exchange rates library for Laravel",
55
"keywords": [
66
"laravel",
77
"currency",
@@ -21,26 +21,28 @@
2121
],
2222
"autoload": {
2323
"psr-4": {
24-
"Florianv\\LaravelSwap\\": "src/"
24+
"Swap\\Laravel\\": "src/"
2525
}
2626
},
2727
"autoload-dev": {
2828
"psr-4": {
29-
"Florianv\\LaravelSwap\\Tests\\": "tests/"
29+
"Swap\\Laravel\\Tests\\": "tests/"
3030
}
3131
},
3232
"require": {
33-
"php": ">=5.5.9",
34-
"illuminate/contracts": "~5.0",
35-
"illuminate/support": "~5.0",
36-
"illuminate/view": "~5.0",
37-
"florianv/swap": "~2.5"
33+
"php": "^5.5|^7.0",
34+
"florianv/swap": "^3.0",
35+
"psr/cache": "^1.0",
36+
"cache/adapter-common": "^0.3"
3837
},
3938
"require-dev": {
40-
"graham-campbell/testbench": "~2.1"
39+
"graham-campbell/testbench": "~2.1",
40+
"php-http/guzzle6-adapter": "^1.0",
41+
"php-http/message": "^1.0",
42+
"cache/integration-tests": "^0.11"
4143
},
42-
"config": {
43-
"bin-dir": "bin"
44+
"scripts": {
45+
"test": "phpunit"
4446
},
4547
"extra": {
4648
"branch-alias": {

‎config/swap.php

+45-20
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,32 @@
1313

1414
/*
1515
|--------------------------------------------------------------------------
16-
| Http Adapter
16+
| Options.
1717
|--------------------------------------------------------------------------
1818
|
19-
| This option specifies a service id to use as http adapter
20-
| (defaults to FileGetContentsHttpAdapter).
19+
| The options to pass to Swap amongst:
2120
|
21+
| * cache_ttl: The cache ttl in seconds.
2222
*/
23-
'http_adapter' => null,
23+
'options' => [],
2424

2525
/*
2626
|--------------------------------------------------------------------------
27-
| Providers
27+
| Services
2828
|--------------------------------------------------------------------------
2929
|
30-
| This option specifies the providers to use with their name as key and
31-
| their config as value. The providers will be wrapped in a ChainProvider
32-
| in the order they appear in this array.
30+
| This option specifies the services to use with their name as key and
31+
| their config as value.
3332
|
34-
| Here is the config spec for each provider:
33+
| Here is the config spec for each service:
3534
|
36-
| * "yahoo_finance", "google_finance", "european_central_bank", "webservicex"
37-
| "national_bank_of_romania" can be enabled with "true" as value.
35+
| * "central_bank_of_czech_republic", "central_bank_of_republic_turkey", "european_central_bank", "fixer"
36+
| "google", "national_bank_of_romania", "webservicex", "yahoo" can be enabled with "true" as value.
37+
|
38+
| * 'currency_layer' => [
39+
| 'access_key' => 'secret', // Your app id
40+
| 'enterprise' => true, // True if your AppId is an enterprise one
41+
| ]
3842
|
3943
| * 'open_exchange_rates' => [
4044
| 'app_id' => 'secret', // Your app id
@@ -47,24 +51,45 @@
4751
|
4852
*/
4953

50-
'providers' => [
51-
'yahoo_finance' => true,
54+
'services' => [
55+
'fixer' => true,
5256
],
5357

5458
/*
5559
|--------------------------------------------------------------------------
5660
| Cache
5761
|--------------------------------------------------------------------------
5862
|
59-
| This option specifies which cache to use to store rate values and its ttl.
60-
| Currently only Illuminate cache is supported:
63+
| This option specifies the Laravel cache store to use.
6164
|
62-
| 'cache' => [
63-
| 'type' => 'illuminate',
64-
| 'store' => 'apc', // Name of the cache store
65-
| 'ttl' => 60 // Ttl in minutes (defaults to 0)
66-
| ],
65+
| 'cache' => 'file'
6766
*/
6867
'cache' => null,
6968

69+
/*
70+
|--------------------------------------------------------------------------
71+
| Http Client.
72+
|--------------------------------------------------------------------------
73+
|
74+
| The HTTP client service name to use.
75+
*/
76+
'http_client' => null,
77+
78+
/*
79+
|--------------------------------------------------------------------------
80+
| Request Factory.
81+
|--------------------------------------------------------------------------
82+
|
83+
| The Request Factory service name to use.
84+
*/
85+
'request_factory' => null,
86+
87+
/*
88+
|--------------------------------------------------------------------------
89+
| Cache Item Pool.
90+
|--------------------------------------------------------------------------
91+
|
92+
| The Cache Item Pool service name to use.
93+
*/
94+
'cache_item_pool' => null,
7095
];

0 commit comments

Comments
 (0)