Merge pull request #9 from RusticiSoftware/enumsAndSwaggerBump

Regenerated library to fix enum issue and add README notes

Author: jtennies10

.php_cs

@@ -1,18 +1,23 @@
 <?php
 
-return Symfony\CS\Config::create()
-    ->level(Symfony\CS\FixerInterface::PSR2_LEVEL)
+return PhpCsFixer\Config::create()
     ->setUsingCache(true)
-    ->fixers(
-        [
-            'ordered_use',
-            'phpdoc_order',
-            'short_array_syntax',
-            'strict',
-            'strict_param'
-        ]
-    )
-    ->finder(
-        Symfony\CS\Finder\DefaultFinder::create()
-            ->in(__DIR__)
+    ->setRules([
+        '@PSR2' => true,
+        'ordered_imports' => true,
+        'phpdoc_order' => true,
+        'array_syntax' => [ 'syntax' => 'short' ],
+        'strict_comparison' => true,
+        'strict_param' => true,
+        'no_trailing_whitespace' => false,
+        'no_trailing_whitespace_in_comment' => false,
+        'braces' => false,
+        'single_blank_line_at_eof' => false,
+        'blank_line_after_namespace' => false,
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+        ->exclude('test')
+        ->exclude('tests')
+        ->in(__DIR__)
     );

README.md

@@ -4,7 +4,7 @@ REST API used for SCORM Cloud integrations.
 This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0
-- Package version: 1.0.1
+- Package version: 1.0.2
 - Build package: io.swagger.codegen.languages.PhpClientCodegen
 
 ## Requirements
@@ -40,20 +40,77 @@ Download the files and include `autoload.php`:
     require_once('/path/to/scormcloud-api-v2-client-php/autoload.php');
 ```
 
+## Key Considerations
+This library is generated using swagger-codegen. When swagger is updated, sometimes changes to the library occur. As a
+result of the recent update, service classes are now instantiated slightly differently. You now need to pass a Configuration
+object as an argument to the service class' constructor. An example of passing the default configuration is below:
+
+```php
+$registration_api = new \RusticiSoftware\Cloud\V2\Api\RegistrationApi(null, RusticiSoftware\Cloud\V2\Configuration::getDefaultConfiguration(), null);
+```
+
+If this does not make sense to you, fear not. There is a greater explanation of service classes and configurations below.
+
+It is also worth noting how boolean values need passed in order to function correctly. In functions that consume a boolean argument,
+make sure to pass the value as a string. For example, the boolean value of `True` should instead be passed as `'true'`.
+
 ## Getting Started
+If you are completely new to SCORM Cloud, please read through our [Core Concepts](http://cloud.scorm.com/docs/concepts/)
+and the rest of our documentation.
+
+This library adheres to the same specification as our API. As a result, your requests will utilize the service classes
+located in the Api folder. Each service class represents a different category of functionality. For example,
+adding, deleting, or modifying courses would all be done through functions in CourseApi. You can find examples of
+common classes and functions below.
+
+### Configuration
+Before you can interact with the API, you will need to set up your authentication credentials.
+
+```php
+$config = new RusticiSoftware\Cloud\V2\Configuration();
+$config->setUsername('APP_ID');
+$config->setPassword('SECRET_KEY');
+```
 
-Please follow the [installation procedure](#installation--usage) and then run the following:
+### CourseApi
+Below is an example of uploading a course to Cloud. Course Service documentation can be found [here](http://cloud.scorm.com/docs/api_reference/v2/endpoints/courseservice/)
+
+```php
+$course_api = new \RusticiSoftware\Cloud\V2\Api\CourseApi(null, $config, null);
+$course_file = new SplFileObject('path/to/course/file');
+$import_token = $course_api->createUploadAndImportCourseJob('COURSE_ID', 'true', null, $course_file)->getResult();
+```
+
+### RegistrationApi
+Below is an example of creating a very basic registration. Registration Service documentation can be found [here](http://cloud.scorm.com/docs/api_reference/v2/endpoints/registrationservice/)
+
+```php
+$registration_api = new \RusticiSoftware\Cloud\V2\Api\RegistrationApi(null, $config, null);
+
+//instantiate a CreateRegistrationSchema that will be passed to createRegistration
+$reg_schema = new RusticiSoftware\Cloud\V2\Model\CreateRegistrationSchema();
+$reg_schema->setCourseId('COURSE_ID');
+$reg_schema->setRegistrationId('REGISTRATION_ID');
+
+$learner_schema = new RusticiSoftware\Cloud\V2\Model\LearnerSchema();
+$learner_schema->setId('LEARNER_ID');
+
+$reg_schema->setLearner($learner_schema);
+$registration_api->createRegistration($reg_schema);
+```
 
+### Starter Script
 ```php
 <?php
-require_once(__DIR__ . '/vendor/autoload.php');
+require_once('path/to/lib/autoload.php');
 
 // Configure HTTP basic authorization: APP_NORMAL
-RusticiSoftware\Cloud\V2\Configuration::getDefaultConfiguration()->setUsername('SCORM_CLOUD_APP_ID');
-RusticiSoftware\Cloud\V2\Configuration::getDefaultConfiguration()->setPassword('SECRET_KEY_FOR_APP_ID');
+$config = new RusticiSoftware\Cloud\V2\Configuration();
+$config->setUsername('APP_ID');
+$config->setPassword('SECRET_KEY');
 
-// Then (optionally) further authenticate via Oauth2 token access
-$app_management_api = new RusticiSoftware\Cloud\V2\Api\ApplicationManagementApi();
+// Further authenticate via Oauth2 token access. This is optional
+$app_management_api = new RusticiSoftware\Cloud\V2\Api\ApplicationManagementApi(null, $config, null);
 
 $permissions = new \RusticiSoftware\Cloud\V2\Model\PermissionsSchema([ 'scopes' => ['read:registration']]);
 $expiry = new DateTime("now");
@@ -62,10 +119,10 @@ $expiry->modify('+60 minutes');
 $token_request = new \RusticiSoftware\Cloud\V2\Model\TokenRequestSchema([ 'permissions' => $permissions, 'expiry' => $expiry]);
 try {
     $response = $app_management_api->createToken($token_request);
-    RusticiSoftware\Cloud\V2\Configuration::getDefaultConfiguration()->setAccessToken($response->getResult());
+    $config->setAccessToken($response->getResult());
 
     // this call will now use Oauth2 with the "read:registration" scope
-    $registration_api = new \RusticiSoftware\Cloud\V2\Api\RegistrationApi();
+    $registration_api = new \RusticiSoftware\Cloud\V2\Api\RegistrationApi(null, $config, null);
     $registrations_list = $registration_api->getRegistrations();
     print_r($registrations_list);
 } catch (\RusticiSoftware\Cloud\V2\ApiException $e) {

autoload.php

@@ -1,5 +1,5 @@
 <?php
-
+require_once("vendor/autoload.php");
 /**
  * SCORM Cloud Rest API
  *

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "rustici-software/scormcloud-api-v2-client-php",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "",
     "keywords": [
         "scorm",
@@ -22,9 +22,10 @@
         "php": ">=5.4",
         "ext-curl": "*",
         "ext-json": "*",
-        "ext-mbstring": "*"
+        "ext-mbstring": "*",
+        "guzzlehttp/guzzle": "~6.0"
     },
     "autoload": {
         "psr-4": { "RusticiSoftware\\Cloud\\V2\\" : "src/" }
     }
-}
+}