Merge pull request #12 from 5am-code/dev

Dev

Author: johguentner

.github/workflows/main.yml

@@ -1,45 +1,46 @@
-name: run-tests
+name: Run tests
 
-on:
-    push:
-        branches: [master]
-    pull_request:
-        branches: [master]
+on: ['push', 'workflow_dispatch']
 
 jobs:
-    test:
-        runs-on: ${{ matrix.os }}
-        strategy:
-            fail-fast: true
-            matrix:
-                os: [ubuntu-latest, windows-latest]
-                php: [7.4, 8.0]
-                laravel: [8.*]
-                stability: [prefer-lowest, prefer-stable]
-                include:
-                    - laravel: 8.*
-                      testbench: ^6.6
-
-        name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
-
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v2
-
-            - name: Setup PHP
-              uses: shivammathur/setup-php@v2
-              with:
-                  php-version: ${{ matrix.php }}
-                  extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
-                  coverage: none
-
-            - name: Setup problem matchers
-              run: |
-                  echo "::add-matcher::${{ runner.tool_cache }}/php.json"
-                  echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
-            - name: Install dependencies
-              run: |
-                  composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
-                  composer update --${{ matrix.stability }} --prefer-dist --no-interaction
-            - name: Execute tests
-              run: vendor/bin/phpunit
+  php-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php:
+          - '8.0'
+        laravel:
+          - '8.*'
+        testbench:
+          - '6.*'
+        dependency-version:
+          - 'prefer-stable'
+
+        include:
+          - laravel: '8.*'
+            testbench: '6.*'
+
+
+
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+          coverage: none
+
+      - name: Install dependencies
+        run: |
+          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+          composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction --no-suggest
+
+      - name: Execute tests
+        run: vendor/bin/phpunit tests

.gitignore

@@ -1,2 +1,5 @@
 .idea
-vendor
+vendor
+.phpunit.result.cache
+coverage/
+.phpunit.cache/

README.md

@@ -36,16 +36,16 @@ Head over to the [Documentation](https://5amco.de/docs) of this package.
 
 ### 🔥 Code Examples to jumpstart your Notion API Project
 
-#### Basic Setup
+#### Basic Setup (+ example)
 ```php
-use FiveamCode\LaravelNotionApi\Notion;
-use Illuminate\Support\Collection;
-use FiveamCode\LaravelNotionApi\Query\Sorting;
-use FiveamCode\LaravelNotionApi\Query\Filter;
-
-// Setup basic API connection
-$notion = new Notion();
-$notion->v1();
+use FiveamCode\LaravelNotionApi\Notion; 
+
+# Access through Facade (token has to be set in .env)
+\Notion::databases()->find($databaseId);
+
+# Custom instantiation (necessary if you want to access more than one NotionApi integration)
+$notion = new Notion($apiToken, $apiVersion); // version-default is 'v1'
+$notion->databases()->find($databaseId);
 ```
 
 #### Fetch Page Information
@@ -54,34 +54,41 @@ $notion->v1();
 $notion->pages()->find($yourPageId);
 ```
 
+#### Search
+```php
+// Returns a collection pages and databases of your workspace (included in your integration-token)
+\Notion::search($searchText)
+        ->query()
+        ->asCollection();
+```
+
 #### Query Database
+
 ```php
 // Queries a specific database and returns a collection of pages (= database entries)
 $sortings = new Collection();
 $filters = new Collection();
 
 $sortings
-  ->add(Sorting::propertySort("Ordered", "ascending"));
+  ->add(Sorting::propertySort('Ordered', 'ascending'));
 $sortings
-  ->add(Sorting::timestampSort("created_time", "ascending"));
+  ->add(Sorting::timestampSort('created_time', 'ascending'));
 
 $filters
-  ->add(Filter::textFilter("title", ["contains" => "new"]));
+  ->add(Filter::textFilter('title', ['contains' => 'new']));
 // or
 $filters
-  ->add(Filter::rawFilter("Tags", ["multi_select" => ["contains" => "great"]]));
+  ->add(Filter::rawFilter('Tags', ['multi_select' => ['contains' => 'great']]));
 
-$notion
-  ->database($yourDatabaseId)
-  ->filterBy($filters) // filters are optional
-  ->sortBy($sortings) // sorts are optional
-  ->limit(5) // limit is optional
-  ->query(); 
+\Notion::database($yourDatabaseId)
+      ->filterBy($filters) // filters are optional
+      ->sortBy($sortings) // sorts are optional
+      ->limit(5) // limit is optional
+      ->query()
+      ->asCollection();
 ```
 
 
-
-
 ### Testing
 
 ```bash
@@ -90,7 +97,11 @@ vendor/bin/phpunit tests
 
 ### Changelog
 
-Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+Please see [CHANGELOG](https://5amco.de/docs/0.3.0/changelog) for more information what has changed recently.
+
+## References / UsedBy
+
+- Julien Nahum created [notionforms.io](https://notionforms.io) with [laravel-notion-api](https://github.com/5am-code/laravel-notion-api), which allows you to easily create custom forms, based on your selected database within notion.
 
 ## Contributing
 

composer.json

@@ -3,7 +3,11 @@
     "description": "Laravel Wrapper for the Notion API",
     "keywords": [
         "fiveam-code",
-        "laravel-notion-api"
+        "laravel-notion-api",
+        "laravel",
+        "notion",
+        "notion-api",
+        "api-wrapper"
     ],
     "homepage": "https://github.com/fiveam-code/laravel-notion-api",
     "license": "MIT",
@@ -13,10 +17,16 @@
             "name": "Diana Scharf",
             "email": "hello@dianaweb.dev",
             "role": "Developer"
+        },
+        {
+            "name": "Johannes Güntner",
+            "email": "johannes.guentner@it-guentner.de",
+            "role": "Developer"
         }
     ],
     "require": {
         "php": "^7.4|^8.0",
+        "guzzlehttp/guzzle": "^7.0.1",
         "illuminate/support": "^8.0"
     },
     "require-dev": {
@@ -49,7 +59,7 @@
                 "FiveamCode\\LaravelNotionApi\\LaravelNotionApiServiceProvider"
             ],
             "aliases": {
-                "LaravelNotionApi": "FiveamCode\\LaravelNotionApi\\LaravelNotionApiFacade"
+                "Notion": "FiveamCode\\LaravelNotionApi\\NotionFacade"
             }
         }
     }