kly/onesdk

One SDK Publisher php package

2.3.41 2024-11-15 06:33 UTC

Requires

• guzzlehttp/guzzle: ~6.2
• php-ds/php-ds: ^1.2
• psr/http-message: ^1.0
• psr/log: ^1.0
• symfony/polyfill-intl-normalizer: ^1.8

Requires (Dev)

• phpunit/phpunit: ^7.2
• symplify/easy-coding-standard: ^6.0

MIT

• Charis
• Kenny Karnama
• Martino Catur
• Denta Zamzam Yasin Muhajir

README

This SDK is created for easier intergration and API usage of ONE APP.

For publisher only

Prerequisite

• PHP Version >=5.3.3

Installation

If you are using composer you could get it with composer require kly/onesdk and you are all set. Load up the autoloader and Call the classes or factory you need.

Usage

To use this SDK, there are several basic steps that should be done :

1. Create and load credentials (client_id and client_secret or separated one use access_token)
2. Instance your content into \One\Model\Article object
3. Attach any necessary details (Photos, Videos, Galleries, Or extra Pages)
4. Instance \One\Publisher Object
5. Send your Article object through submitArticle method on Publisher

These are some examples code to perform those steps :

Load credentials

Refer to loadTestEnv() method.

Instance publisher object

$env = \loadTestEnv();
        $this->publisher = new Publisher(
            $env['YOUR_CLIENT_ID'],
            $env['YOUR_CLIENT_SECRET']
        );

Publish

If you want to publish an article, there are several steps should be done :

1. Instance article object

$article = new Article(
            'Eius ad odit voluptatum occaecati ducimus rerum.',
            'Facilis occaecati sequi animi corrupti. Ex sit voluptates accusamus. Quidem eum magnam veniam odio totam aut. Nobis possimus totam quasi tempora consectetur iste. Repellendus est veritatis quibusdam dicta. Sapiente modi perferendis quidem repudiandae voluptates.',
            'https://www.zahn.de/home/',
            'dummy-' . rand(0, 999),
            Article::TYPE_TEXT,
            Article::CATEGORY_BISNIS,
            "Hans-Friedrich Hettner B.Sc.",
            "Dolorum expedita repellendus ipsam. Omnis cupiditate enim. Itaque alias doloribus eligendi.",
            "distinctio",
            "2013-05-25"
        );

1. Attach if article contains some attachments

Article supports multiple kind of attachment such as: photo, page.

$photo = new Photo(
            'https://aubry.fr/',
            Photo::RATIO_RECTANGLE,
            "Rerum asperiores nulla suscipit ex. Eligendi vero optio architecto dignissimos. Omnis autem ab ad hic quaerat omnis.",
            "Eum assumenda ab accusamus quam blanditiis."
        );
$article->attachPhoto($photo);

1. Publish the article to ONE App REST API by submitting through instanced publisher object.

$this->publisher->submitArticle($article);

Fetch

You can fetch all the articles by calling listArticle() on publisher object.

$this->publisher->listArticle();

Steps to contribute :

1. Fork the original repository to your github repository.

2. Clone from your repository

   git clone https://github.com/your_username/onesdk.git

3. To keep up to date with original repository, run this command

   git remote add upstream https://github.com/KLYgarage/onesdk.git

   git pull upstream master

4. Create branch. Remember, the name of branch should express what you're doing.

   git checkout -b my-topic-branch

5. Don't forget to install composer dependencies

   composer install

6. Modify the .env.example file, to reflect correct credentials.

   CLIENT_ID=$CLIENT_ID
   
   CLIENT_SECRET=$CLIENT_SECRET
   
   To get ACCESS_TOKEN, run the following commands using curl :
   
   curl -X POST "https://dev.one.co.id/oauth/token" \
    -H "Accept: application/json" \
    -d "grant_type"="client_credentials" \
    -d "client_id"="YOUR CLIENT ID" \
    -d "client_secret"="YOUR CLIENT SECRET";
    
   

7. Save the .env.example as .env

8. When you are ready to propose changes to the original repository, it's time to create pull request. To create pull request, run the following commands :

   git push -u origin my-topic-branch

9. Go to your github account, on tab pull request, add your comment. Be detailed, use imperative, emoticon to make it clearer.

10. Watch for feedbacks.

PHP CS Fixer

PHP CS Fixer is intended to fix coding standard. So, Remember! to always run PHP CS Fixer before you create pull request.

composer run cs-fix

Testing

How to Run Tests

Open a command prompt or terminal, navigate to project directory and run command composer run test

> php ./phpunit --bootstrap ./test/bootstrap.php ./test/
PHPUnit 4.8.36 by Sebastian Bergmann and contributors.

..................

Time: 14 seconds, Memory: 10.00MB

OK (18 tests, 98 assertions)

To see what test is running you can use command composer run test:verbose

> php ./phpunit --bootstrap ./test/bootstrap.php ./test/
PHPUnit 4.8.36 by Sebastian Bergmann and contributors.

Starting test 'One\Test\Unit\PublisherTest::testSubmitArticleWithoutAttachment'.
.
Starting test 'One\Test\Unit\PublisherTest::testSubmitArticleWithPhotos'.
.
Starting test 'One\Test\Unit\PublisherTest::testSubmitArticleWithPage'.
.
Starting test 'One\Test\Unit\PublisherTest::testSubmitArticleWithGallery'.
.
Starting test 'One\Test\Unit\PublisherTest::testSubmitArticleWithVideo'.

Time: 12.34 seconds, Memory: 10.00MB

OK (18 tests, 98 assertions)

What to Remember When Writing a Test

1. Make sure to create test case for every core function on the class.
2. Always compare data you expected or created before you make a request with the actual data that you get from a response.
3. Use the correct assertion. Avoid using assertEquals to compare arrays because sometimes you will get array (response from server) values sorted in different order from your expected array. In example:

$array = [
  '0'=>'500',
  '1'=>'A'
];

$arrayFromResponse = [
  '0'=>'A',
  '1'=>'500
];

Rather than sorting $arrayFromResponse to make the order equal, we can use assertTrue combine with array_diff

assertTrue(empty(array_diff($array, $arrayFromResponse)));