Developed with love by KnpLabs Hire us for your project!
17

rokka-client-bundle

by rokka-io

Symfony Bundle to access rokka.io using the rokka client library.

Rokka Symfony Bundle

StyleCI
Latest Stable Version

A Symfony bundle for the Rokka image service.

Installation Symfony version <= 3

Require the bundle using composer:

composer require rokka/client-bundle

Add it to app/AppKernel.php

        $bundles = array(
            ...
            new Rokka\RokkaClientBundle\RokkaClientBundle(),
        );

Configure the bundle with the parameters below.

Installation Symfony version >= 4

The rokka Symfony bundle comes with a flex recipe.

Do the following.

composer config extra.symfony.allow-contrib true
composer require rokka/client-bundle

Then you can add your api key and organization to the .env file
or edit config/packages/rokka.yaml.

Configuration

Enter your api key and organization strings.

rokka_client:
    api_key: 'key-here'
    organization: 'my-organization'

    # Optional, not needed for most users
    #base_url: https://api.rokka.io

base_url is to override the API location. We use this for testing mainly, so no need to change it ever.

Usage

The bundle will create two services for you, rokka.client.image and rokka.client.user. These give you access to the
basic functionality from the rokka/client library, pre-configured with
your credentials.

This bundle also provides console commands to interact with rokka.io. If you only want a CLI for rokka, you can also
install the rokka PHP CLI tool as stand-alone phar.

See the official documentation for further information on how to use rokka.

The MIT License (MIT)

Copyright (c) 2016 rokka.io

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
  • Merge pull request #13 from rokka-io/remove-apiSecret
    By web-flow, 2 years ago
  • remove api_secret
    By chregu, 2 years ago
  • added symfony 4 installation instructions to README
    By chregu, 2 years ago
  • Merge pull request #11 from rokka-io/symfony-4
    By web-flow, 2 years ago
  • sf 3.2.0 fails because it requires annotation, fixed with https://github.com/symfony/symfony/commit/e38be091cef535206cf1d6625806bf5f17095f53
    By Tobion, 2 years ago
  • fix tests and service visibility
    By Tobion, 2 years ago
  • test against 3.4 by default
    By chregu, 2 years ago
  • removed api_secret from examples and comment it as deprecated
    By chregu, 2 years ago
  • adjust kernel dir as well, for old symfony versions
    By dbu, 2 years ago
  • styleci
    By chregu, 2 years ago
  • prepare 1.1.0 release
    By chregu, 2 years ago
  • require rokka/client-cli 1.4.0
    By chregu, 2 years ago
  • make api_secret optional
    By chregu, 2 years ago
  • set branch alias correctly
    By chregu, 2 years ago
  • handle prefix correctly
    By dbu, 2 years ago
  • update phpunit tests for symfony 4
    By dbu, 2 years ago
  • report problem in case of error
    By dbu, 2 years ago
  • Merge pull request #12 from dbu/symfony-4
    By web-flow, 2 years ago
  • handle command prefix in lazy commands
    By dbu, 2 years ago
  • temporarely use rokka/client-cli symfony-4 branch
    By chregu, 2 years ago
  • test against symfony 4.0
    By chregu, 2 years ago
  • Merge pull request #10 from rokka-io/api-host-not-correctly-set
    By web-flow, 2 years ago
  • support symfony 4
    By chregu, 2 years ago
  • for some reason the argument order for RokkaCli/Configuration was wrong
    By chregu, 2 years ago
  • don't test php 5.5 anymore, but 7.2 do
    By chregu, 2 years ago
  • prepare 1.0.0
    By chregu, 2 years ago
  • use rokka/client 1.0.0 and rokka/client-cli 1.3.0, remove php 5.5 support
    By chregu, 2 years ago
  • Merge pull request #7 from dbu/commands
    By web-flow, 2 years ago
  • provide the cli commands in the bundle
    By dbu, 2 years ago
  • update rokka client to 0.8.0
    By chregu, 2 years ago