dprmc/clear-structure-sentry-data-service

A library that allows you to import standard import files into the Sentry system.

v2.0.17 2024-08-02 19:16 UTC

Requires

• ext-simplexml: *
• ext-soap: *
• dprmc/excel: ^2.0
• nesbot/carbon: ^2.35|^3.0

Requires (Dev)

• php-coveralls/php-coveralls: ^2.2
• phpunit/phpunit: ^9.2|^10.0|^11.0

MIT

• Michael Drennen

README

ImportExcel

Used to import Standard Import Files as defined by ClearStructure.

Check Sentry's documentation for the proper format if a Standard Import File.

// This will attempt to import the contents of 'standard_import_file.xlsx' into the UAT site.
// Change the 2nd parameter of the run() method to true to import to your production site.

use DPRMC\ClearStructure\Sentry\DataService\Services\ImportExcel;

$uatUrl           = 'http://your-uat-url';
$prodUrl          = 'http://your-prod-url';
$user             = 'yourSentryUserName';
$pass             = 'yourEncryptedSentryPassword';
$pathToImportFile = 'standard_import_file.xlsx';
$postToUAT        = true;

$importExcelResponse = ImportExcel::init( $uatUrl, $prodUrl, $user, $pass, $postToUAT )
                           ->setData($pathToImportFile)
                           ->run();
                           
// Contents of $importExcelResponse->response() if everything goes well:
Array
(
    [time] => Carbon\Carbon Object
        (
            [date] => 2018-08-03 16:12:23.000000
            [timezone_type] => 3
            [timezone] => UTC
        )

    [name] => Security_Attribute_Update
    [num] => 2
    [runtime] => 296.8872
    [errors] => Array
        (
        )

    [warnings] => Array
        (
        )
)

// Call path() to get the local filepath of the xlsx that was uploaded to Sentry.
$importExcelResponse->path();

Deleting Data

$data   = [];
$data[] = [
    'scheme_identifier'          => 42,
    'scheme_name'                => 'SentryId',
    'market_data_authority_name' => 'DB',
    'action'                     => 'DELETE',
    'as_of_date'                 => '1/1/2018',
];

$data[] = [
    'scheme_identifier'          => 'ABCDEFGH1',
    'scheme_name'                => 'CUSIP',
    'market_data_authority_name' => 'DB',
    'action'                     => 'DELETE',
    'as_of_date'                 => '1/1/2018',
];

$deleteExcelResponse = DeleteExcelSecurityPricing::init( $uatUrl, $prodUrl, $user, $pass, $postToUAT )
                                  ->setData($data)  
                                  ->delete();

Testing

Want to run the PHPUnit tests?

foo@bar:~$ php ./phpunit-5.7.27.phar