Initial commit 🎉

Author: morganarnel

.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        laravel: [8, 9, 10]
+        php: ["8.0", 8.1, 8.2]
+        exclude:
+          - php: "8.0"
+            laravel: 10
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: test against Laravel ${{ matrix.laravel }} on PHP ${{ matrix.php }}
+        run: docker build . --build-arg PHP_VERSION=${{ matrix.php }} --build-arg LARAVEL=${{ matrix.laravel }}

.gitignore

@@ -0,0 +1,4 @@
+build/
+vendor/
+composer.lock
+.phpunit.result.cache

Dockerfile

@@ -0,0 +1,25 @@
+ARG PHP_VERSION=8.0
+FROM php:$PHP_VERSION-cli-alpine
+
+RUN apk add git zip unzip autoconf make g++
+
+# apparently newer xdebug needs these now?
+RUN apk add --update linux-headers
+
+RUN pecl install xdebug && docker-php-ext-enable xdebug
+
+RUN curl -sS https://getcomposer.org/installer | php \
+    && mv composer.phar /usr/local/bin/composer
+
+WORKDIR /package
+
+COPY composer.json ./
+
+ARG LARAVEL=8
+RUN composer require illuminate/support ^$LARAVEL.0
+
+COPY src src
+COPY tests tests
+COPY phpunit.xml ./
+
+RUN COMPOSER_ALLOW_SUPERUSER=1 composer test

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Synergi Tech Ltd
+
+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.

README.md

@@ -0,0 +1,108 @@
+# Laravel Salesforce
+
+[![Tests](https://github.com/SynergiTech/laravel-salesforce/actions/workflows/test.yml/badge.svg)](https://github.com/SynergiTech/laravel-salesforce/actions/workflows/test.yml)
+
+This package uses [omniphx/forrest](https://github.com/omniphx/forrest) to provide an Eloquent-style way of querying sObjects from Salesforce.
+
+:warning: This is an initial version that only allows for the selecting of data. Newer versions will aim to provide a more complete experience.
+
+## Getting Started
+
+Follow the instructions provided at [omniphx/forrest](https://github.com/omniphx/forrest) to connect to your Salesforce environment.
+Once done, you can then use the `SynergiTech\Salesforce\Facades\Salesforce` facade to perform queries against a particular table like so:
+
+```php
+use SynergiTech\Salesforce\Facades\Salesforce;
+
+// Get an individual record by Id
+Salesforce::table('MyTable')->find('YourIdHere');
+```
+
+## Available Methods
+
+### find
+
+Allows you to directly pull an individual record as an array by Id.
+You can also specify another field name as the second parameter.
+If you specify a non-unique column and multiple records are returned then the first record is always returned.
+
+```php
+Salesforce::table('MyTable')->find('YourIdHere');
+```
+
+### findMany
+
+Allows you to directly pull multiple records as a Laravel Collection by provide an array of their respective Id fields.
+You can also specify another field name as the second parameter.
+
+```php
+Salesforce::table('MyTable')->findMany(['YourId1Here', 'YourId2Here']);
+```
+
+### where
+
+You can also scope your queries with where clauses.
+
+```php
+// Basic where clause
+Salesforce::table('MyTable')->where('Name', 'John Doe')->get();
+
+// You can also use any of the following operators
+
+// Equals and Not Equals
+Salesforce::table('MyTable')->where('Name', '=', 'John Doe')->get();
+Salesforce::table('MyTable')->where('Name', '!=', 'John Doe')->get();
+
+// Comparisons
+Salesforce::table('MyTable')->where('Age', '<', 30)->get();
+Salesforce::table('MyTable')->where('Age', '<=', 30)->get();
+Salesforce::table('MyTable')->where('Age', '>', 30)->get();
+Salesforce::table('MyTable')->where('Age', '>=', 30)->get();
+
+// Like
+Salesforce::table('MyTable')->where('Name', 'LIKE', 'John %')->get();
+Salesforce::table('MyTable')->where('Name', 'LIKE', '% Middlename %')->get();
+Salesforce::table('MyTable')->where('Name', 'LIKE', '% Doe')->get();
+```
+
+### whereIn
+
+You can provide an array of possible values to the `whereIn` method to select any records that match any of the values.
+
+```php
+Salesforce::table('MyTable')->whereIn('Country', ['United Kingdom', 'United States'])->get();
+```
+
+### orderBy
+
+You can order by a particular field in either ascending or descending order.
+
+```php
+// Ascending (default)
+Salesforce::table('MyTable')->orderBy('Age')->get();
+
+// Descending
+Salesforce::table('MyTable')->orderBy('Age', 'DESC')->get();
+```
+
+### nullsLast
+
+By default when chaining an orderBy null values are returned first.
+You can chain on `->nullsLast()` to return null values last.
+
+```php
+Salesforce::table('MyTable')->orderBy('LastLoginDate')->nullsLast()->get();
+```
+
+### limit
+
+You can limit the amount of records returned.
+
+```php
+Salesforce::table('MyTable')->where('Name', 'LIKE', 'John%')->limit(20)->get();
+```
+
+## Exceptions
+
+By default [omniphx/forrest](https://github.com/omniphx/forrest) typically throws a single exception with more detail contained within a JSON encoded string.
+We've wrapped a couple with our own exceptions to help with debugging.

composer.json

@@ -0,0 +1,43 @@
+{
+    "name": "synergitech/laravel-salesforce",
+    "description": "This package uses omniphx/forrest to provide an Eloquent-style way of querying sObjects from Salesforce.",
+    "license": "MIT",
+    "keywords": [
+        "laravel",
+        "salesforce"
+    ],
+    "require": {
+        "php": "^8.0",
+        "illuminate/collections": "^8.0 || ^9.0 || ^10.0",
+        "illuminate/support": "^8.0 || ^9.0 || ^10.0",
+        "omniphx/forrest": "^2.0"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^6.0 || ^7.0 || ^8.0",
+        "php-parallel-lint/php-parallel-lint": "^1.3",
+        "phpstan/phpstan": "^1",
+        "phpunit/phpunit": "^9.0",
+        "squizlabs/php_codesniffer": "^3.6"
+    },
+    "autoload": {
+        "psr-4": {
+            "SynergiTech\\Salesforce\\": "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "aliases": {
+                "Salesforce": "SynergiTech\\Salesforce\\Facades\\Salesforce"
+            }
+        }
+    },
+    "scripts": {
+        "test": [
+            "Composer\\Config::disableProcessTimeout",
+            "XDEBUG_MODE=coverage phpunit tests",
+            "parallel-lint --exclude vendor .",
+            "phpcs --standard=PSR12 src/ tests/",
+            "phpstan analyse --level 9 src"
+        ]
+    }
+}

phpunit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="alert-package-tests">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage processUncoveredFiles="true">
+        <report>
+            <html outputDirectory="build/coverage"/>
+            <text outputFile="php://stdout"/>
+        </report>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
+</phpunit>

src/Exceptions/AuthenticationFailedException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace SynergiTech\Salesforce\Exceptions;
+
+use Exception;
+
+class AuthenticationFailedException extends Exception
+{
+}

src/Exceptions/InvalidFieldException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace SynergiTech\Salesforce\Exceptions;
+
+use Exception;
+
+class InvalidFieldException extends Exception
+{
+}

src/Exceptions/InvalidResponseException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace SynergiTech\Salesforce\Exceptions;
+
+use Exception;
+
+class InvalidResponseException extends Exception
+{
+}

src/Exceptions/MalformedQueryException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace SynergiTech\Salesforce\Exceptions;
+
+use Exception;
+
+class MalformedQueryException extends Exception
+{
+}

src/Exceptions/NotFoundException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace SynergiTech\Salesforce\Exceptions;
+
+use Exception;
+
+class NotFoundException extends Exception
+{
+}

src/Facades/Salesforce.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace SynergiTech\Salesforce\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use SynergiTech\Salesforce\Services\SalesforceService;
+
+class Salesforce extends Facade
+{
+    /**
+     * Get the registered class for the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor(): string
+    {
+        return SalesforceService::class;
+    }
+}