CyberSource / CyberSource/cybersource-rest-samples-node

The samples are all completely independent and self-contained.

Open
#58 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
43
Forks
66
Avg merge
23m
Merged PRs (30d)
2

Description

Under Readme section "Using the Sample Code" - https://github.com/CyberSource/cybersource-rest-samples-php#using-the-sample-code - it states "The samples are all completely independent and self-contained.", but after reviewing the code, this doesn't appear to be true.

Example:
https://github.com/CyberSource/cybersource-rest-samples-php/blob/master/Samples/Payments/Payments/AuthorizationWithCaptureSale.php

This file has code:

require_once __DIR__ . DIRECTORY_SEPARATOR . '../../../Resources/ExternalConfiguration.php';

which is another file in the repo. Maybe I'm reading the blurb wrong, but that file to me is a sample, and if it's self-contained it shouldn't require other files.

Anyway, even if I consider "self-contained" samples to mean "the repo is self-contained as a run app", then that's not exactly true either. The above line of code requires vendor through composer that's compatible with PHP 5.6:

require_once __DIR__ . DIRECTORY_SEPARATOR . '../../../vendor/autoload.php';

This is required for at least one line in that AuthorizationWithCaptureSale.php sample file's code, like:

$api_instance = new CyberSource\Api\PaymentsApi($api_client);

I'm working on a Mac (Ventura) that doesn't have PHP 5.6 or a compatible version of composer installed, so I will have to do a deep-dive to figure that out for a "self-contained" sample file.

Anyway, I can try to get the whole repo with vendor code running, but to me the blurb is not accurate, as the sample files are not self-contained. I'm curious exactly what's meant by "self-contained" or "independent".

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README section "Using the Sample Code" and the referenced Samples/Payments/Payments/AuthorizationWithCaptureSale.php file. Confirm what "independent" and "self-contained" are intended to mean, then update the wording to match the documented dependencies and verify the links and examples remain accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.