also looking at this
initialize progress
#1
17 files
+581
-48
Review threads live on the whole diff, not on one commit, so none are shown here - a thread's line means something in the branch's final form, and painting it into an intermediate step would put it on code it is not about.
| @@ -0,0 +1,21 @@ | ||
| 1 | MIT License | |
| 2 | ||
| 3 | Copyright (c) Meema, Inc. | |
| 4 | ||
| 5 | Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 6 | of this software and associated documentation files (the "Software"), to deal | |
| 7 | in the Software without restriction, including without limitation the rights | |
| 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 9 | copies of the Software, and to permit persons to whom the Software is | |
| 10 | furnished to do so, subject to the following conditions: | |
| 11 | ||
| 12 | The above copyright notice and this permission notice shall be included in all | |
| 13 | copies or substantial portions of the Software. | |
| 14 | ||
| 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
| 21 | SOFTWARE. | |
| @@ -1,49 +1,68 @@ | ||
| 1 | # Coming Soon - Meema.io API | |
| 1 | <p align="center"> | |
| 2 | <a href="https://meema.io"> | |
| 3 | <img alt="Meema for PHP" src="https://raw.githubusercontent.com/meema/meemasearch-client-common/master/banners/php.png" > | |
| 4 | </a> | |
| 2 | 5 | |
| 3 | This package contains a [Flysystem](https://flysystem.thephpleague.com/) adapter for Meema. Under the hood, the Meema API is used. | |
| 6 | <h4 align="center">The most simple way to integrate <a href="https://meema.io" target="_blank">Meema</a> and your PHP project</h4> | |
| 4 | 7 | |
| 5 | ## Installation | |
| 8 | <p align="center"> | |
| 9 | <a href="https://scrutinizer-ci.com/g/meemalabs/meema-client-php/badges/quality-score.png?b=main"><img src="https://scrutinizer-ci.com/g/meemalabs/meema-client-php/badges/quality-score.png?b=main" alt="Scrutinizer" /></a> | |
| 10 | <a href="https://packagist.org/packages/meema/meema-client-php"><img src="https://poser.pugx.org/meema/meema-client-php/d/total.svg" alt="Total Downloads"></a> | |
| 11 | <a href="https://packagist.org/packages/meema/meema-client-php"><img src="https://poser.pugx.org/meema/meema-client-php/v/stable.svg" alt="Latest Version"></a> | |
| 12 | <a href="https://packagist.org/packages/meema/meema-client-php"><img src="https://poser.pugx.org/meema/meema-client-php/license.svg" alt="License"></a> | |
| 13 | </p> | |
| 6 | 14 | |
| 7 | You can install the package via composer: | |
| 15 | <p align="center"> | |
| 16 | <a href="https://www.meema.com/doc/api-client/getting-started/install/php/" target="_blank">Documentation</a> • | |
| 17 | <a href="https://github.com/meema/laravel-meema" target="_blank">Laravel</a> • | |
| 18 | <a href="http://stackoverflow.com/questions/tagged/meema" target="_blank">Stack Overflow</a> • | |
| 19 | <a href="https://github.com/meema/meema-client-php/issues" target="_blank">Report a bug</a> • | |
| 20 | <a href="https://meema.io/docs" target="_blank">FAQ</a> • | |
| 21 | <a href="https://meema.io/support" target="_blank">Support</a> | |
| 22 | </p> | |
| 8 | 23 | |
| 9 | ``` bash | |
| 10 | composer require meemaio/meema-api | |
| 11 | ``` | |
| 12 | ||
| 13 | ## Usage | |
| 24 | ## ✨ Features | |
| 14 | 25 | |
| 15 | The first thing you need to do is get an authorization token at Meema.io. A token can be generated in the [App Console](https://meema.io/) for any Meema API app. | |
| 26 | - Thin & minimal low-level HTTP client to interact with Meema's API | |
| 27 | - Supports php `^5.*`. | |
| 16 | 28 | |
| 17 | ``` php | |
| 18 | use League\Flysystem\Filesystem; | |
| 19 | use Meema\Client; | |
| 20 | use Meema\FlysystemMeema\MeemaAdapter; | |
| 29 | ## 💡 Usage | |
| 21 | 30 | |
| 22 | $client = new Client($authorizationToken); | |
| 31 | First, install Meema PHP API Client via the [composer](https://getcomposer.org/) package manager: | |
| 23 | 32 | |
| 24 | $adapter = new MeemaAdapter($client); | |
| 25 | ||
| 26 | $filesystem = new Filesystem($adapter); | |
| 33 | ```bash | |
| 34 | composer require meema/meema-client-php | |
| 27 | 35 | ``` |
| 28 | 36 | |
| 29 | ## Changelog | |
| 30 | ||
| 31 | Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. | |
| 32 | ||
| 33 | ## Testing | |
| 34 | ||
| 35 | ``` bash | |
| 36 | composer test | |
| 37 | Then, wip | |
| 38 | ||
| 39 | ```php | |
| 40 | $client->folders()->get(); | |
| 41 | $client->folders(1, 2, 3)->delete(); | |
| 42 | $client->folders(1)->update(['name' = 'New Folder Name']); | |
| 43 | $client->folders([1, 2, 3])->media()->get(); | |
| 44 | $client->tags()->get(); | |
| 45 | $client->tags(1, 2, 3)->delete(); | |
| 46 | $client->tags(1)->update(['name' = 'New Tag Name']); | |
| 47 | $client->tags([1, 2, 3])->media()->get(); | |
| 48 | // need to the same for following resources | |
| 49 | $client->favorites()->get(); | |
| 50 | $client->media()->get(); | |
| 51 | $client->teams()->get(); | |
| 52 | ||
| 53 | $client->media()->get(); | |
| 54 | $client->media()->search($q); | |
| 55 | ||
| 56 | $client->folders()->get(); | |
| 57 | $client->folders()->search($q); | |
| 37 | 58 | ``` |
| 38 | 59 | |
| 39 | ## Contributing | |
| 40 | ||
| 41 | Please see [CONTRIBUTING](CONTRIBUTING.md) for details. | |
| 60 | For the full documentation, visit the **[Meema PHP API Client](https://meema.io/docs/)**. | |
| 42 | 61 | |
| 43 | ## Security | |
| 62 | ## ❓ Troubleshooting | |
| 44 | 63 | |
| 45 | If you discover any security related issues, please email chris@cion.agency instead of using the issue tracker. | |
| 64 | Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://meema.io/docs/) where you will find answers for the most common issues and gotchas with the client. | |
| 46 | 65 | |
| 47 | ## License | |
| 66 | ## 📄 License | |
| 48 | 67 | |
| 49 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information. | |
| 68 | Meema PHP API Client is an open-sourced software licensed under the [MIT license](LICENSE.md). | |