Merge pull request #47 from okta/develop

Merging 1.0.0 from Develop to Master

Author: bretterer

.travis.yml

@@ -1,61 +1,62 @@
 language: php
-
 env:
   global:
-    - COVERAGE=false
-    - SETUP=basic
-    - DEPLOY_DOCS=false
-
+  - COVERAGE=false
+  - SETUP=basic
+  - DEPLOY_DOCS=false
 install:
-  - if [[ $SETUP = 'basic' ]]; then travis_retry composer install --prefer-dist --no-interaction --no-suggest; fi
-  - if [[ $SETUP = 'stable' ]]; then travis_retry composer update --prefer-dist --no-interaction --no-suggest --prefer-stable; fi
-  - if [[ $SETUP = 'lowest' ]]; then travis_retry composer update --prefer-dist --no-interaction --no-suggest --prefer-stable --prefer-lowest; fi
-
+- if [[ $SETUP = 'basic' ]]; then travis_retry composer install --prefer-dist --no-interaction
+  --no-suggest; fi
+- if [[ $SETUP = 'stable' ]]; then travis_retry composer update --prefer-dist --no-interaction
+  --no-suggest --prefer-stable; fi
+- if [[ $SETUP = 'lowest' ]]; then travis_retry composer update --prefer-dist --no-interaction
+  --no-suggest --prefer-stable --prefer-lowest; fi
 before_script:
-  - mkdir -p ~/.phpenv/versions/$(phpenv version-name)/etc
-  - mkdir -p ~/.okta
-
+- mkdir -p ~/.phpenv/versions/$(phpenv version-name)/etc
+- mkdir -p ~/.okta
 script:
-  - vendor/bin/phpunit --verbose --coverage-clover build/logs/clover.xml
-
+- vendor/bin/phpunit --verbose --coverage-clover build/logs/clover.xml
 after_success:
-  - if [[ $COVERAGE = 'true' ]]; then bash <(curl -s https://codecov.io/bash); fi
-  - if [[ $DEPLOY_DOCS = 'true' ]]; then wget -O sami.phar http://get.sensiolabs.org/sami.phar; fi;
-  - if [[ $DEPLOY_DOCS = 'true' ]]; then chmod +x ./scripts/prepare-docs.sh; fi
-  - if [[ $DEPLOY_DOCS = 'true' ]]; then ./scripts/prepare-docs.sh; fi
-
+- if [[ $COVERAGE = 'true' ]]; then bash <(curl -s https://codecov.io/bash); fi
+- if [[ $DEPLOY_DOCS = 'true' ]]; then wget -O sami.phar http://get.sensiolabs.org/sami.phar;
+  fi;
+- if [[ $DEPLOY_DOCS = 'true' ]]; then chmod +x ./scripts/prepare-docs.sh; fi
+- if [[ $DEPLOY_DOCS = 'true' ]]; then ./scripts/prepare-docs.sh; fi
 deploy:
-  - provider: pages
-    skip_cleanup: true
-    github_token: $GITHUB_TOKEN
-    local_dir: full/build/gh-pages
-    email: [email protected]
-    name: PHP Deployment Bot
-    on:
-      php: 7.1
-      condition: $DEPLOY_DOCS = true
-      tags: true
-  - provider: pages
-    skip_cleanup: true
-    github_token: $GITHUB_TOKEN
-    local_dir: full/build/gh-pages
-    email: [email protected]
-    name: PHP Deployment Bot
-    on:
-      php: 7.1
-      condition: $DEPLOY_DOCS = true
-      branch: develop
-
+- provider: pages
+  skip_cleanup: true
+  github_token: "$GITHUB_TOKEN"
+  local_dir: full/build/gh-pages
+  email: [email protected]
+  name: PHP Deployment Bot
+  on:
+    php: 7.1
+    condition: "$DEPLOY_DOCS = true"
+    tags: true
+- provider: pages
+  skip_cleanup: true
+  github_token: "$GITHUB_TOKEN"
+  local_dir: full/build/gh-pages
+  email: [email protected]
+  name: PHP Deployment Bot
+  on:
+    php: 7.1
+    condition: "$DEPLOY_DOCS = true"
+    branch: develop
 matrix:
   include:
-    - php: 7.0
-      env: SETUP=lowest
-    - php: 7.0
-      env: SETUP=stable
-    - php: 7.1
-      env: SETUP=lowest
-    - php: 7.1
-      env:
-        - COVERAGE=true
-        - SETUP=stable
-        - DEPLOY_DOCS=true
+  - php: 7.0
+    env: SETUP=lowest
+  - php: 7.0
+    env: SETUP=stable
+  - php: 7.1
+    env: SETUP=lowest
+  - php: 7.1
+    env:
+    - COVERAGE=true
+    - SETUP=stable
+    - DEPLOY_DOCS=true
+notifications:
+  slack:
+    rooms:
+      secure: pPjnzjBbTuUFSMOKdJQfzQWk8XeCxCg7Y0cRds/DP0YRIDIPOOGzUTWdzJG4oKGmwVFmnlmqGBnC3JaufXmIj0wSw9p/YmAOV9cdaZ6ZaqpqghL6EnN2y3M5jMkmTq7A1vAAvPC8g/NLORiR4fOcgGLzNRgHVVRYIMPE840mWxpEnohfHB/8PquL2/wjlzBuPOJBieq9SAGxb25SPAwMTaP1vewX3CP/zT5IDqqeuULZzR94xNiVIkeYzniDjjmBMh1FYUXbUBhR08jUVLCuvUgk959fpowbWf4UcqwRmcnDGeGYTatvX36MbmLHRhOU1zRvMuMG+uOQwr7kWOqJya3mxcPf6IW0gwXs6TVvruInKjkhsZHyc5oVC4WKgWZ41cd+RRlLbRcLHIvALN1jhLFda/KLpfGUVGFwrVv61kPLGvExMIZMQCxNj7PIr5RZB8faYBfrT3hf2SvG4bDwhdzjc07lqzhGQWvCi12Rc0Yzmo+PuAA4crPCG2OfjAj1U4IyOznvuhXGMfHtQMy5ow6bW9w/q1HTMwNBtswY78hyTetf7FHYmEe29IUnL44Ecv/34FWuY+Hszb1KwPKVdx0g7D9gdWU6sZZSipNrhG84rYIIRTi0zSDlZBS0+0P7WQQsXRJCplQtxHOTgImWDzIXVzqX9kep/AvT0IiO4CY=

README.md

@@ -23,6 +23,17 @@ $client = (new \Okta\ClientBuilder())
             ->build();
 ```
 
+By default, The client builder will look for a file in your home directory with the Okta properties you want to use.
+This file should be placed at  `~/.okta/okta.yaml`. If at this location, you do not need to define the location 
+during initialization. If you are unable to place the file there, or you are on a Windows based machine, you will 
+have to define the location of this file manually if you want to use the file.
+
+```php
+$client = (new \Okta\ClientBuilder())
+            ->setConfigFileLocation('path/to/okta.yaml')
+            ->build();
+```
+
 If you need to override any of the defaults from your `~/.okta/okta.yaml` file, or you do not have one, you can set 
 the properties on the client builder directly. The minimum required properties are your token and organization url.
 
@@ -132,6 +143,31 @@ To start at the second entry and get the next two items:
 $users = (new \Okta\Okta)->getUsers(['query' => ['limit' = 2, 'after' = 2]]);
 ```
 
+## Caching
+The Okta PHP SDK allows any resource with a self link to be cached by default. The SDK uses any PSR-6 
+caching adaptor that you would like to use. By default, we ship with the 
+[filesystem cache pool](https://github.com/php-cache/filesystem-adapter) with the 
+[flysystem memory adaptor](https://github.com/thephpleague/flysystem-memory).  By doing this, there is no 
+need to configure anything, however, if you would like to run with your own Cache strategy, or change how 
+the default works, you are able to swap out the Cache Manager. Create a new Cache Manager that extends the 
+base `\Okta\Cache\CacheManager` class, and call the parent `setCachePool()` method. This should be called
+with an instance of a PSR-6 compliant cache pool implementation.  Once created, you can swap out the manager
+using the `ClientBuilder` class
+
+```php
+$clientBuilder = new ClientBuilder();
+        $clientBuilder->setCacheManager(new MyCacheManager());
+        $client = $clientBuilder->build();
+```
+
+### Contents of the okta.yaml File
+```php
+okta:
+  client:
+    orgUrl: null
+    token: null
+```
+
 For information on what can go into the query property, visit 
 [our documentation](https://developer.okta.com/docs/api/resources/users.html#list-users)
 

composer.json

@@ -19,8 +19,11 @@
         "php-http/curl-client": "^1.7",
         "symfony/yaml": "^3.2",
         "nesbot/carbon": "^1.22",
-        "tightenco/collect": "^5.4",
-        "guzzlehttp/psr7": "^1.4"
+        "tightenco/collect": "5.4.*",
+        "guzzlehttp/psr7": "^1.4",
+        "psr/cache": "^1.0",
+        "league/flysystem-memory": "^1.0",
+        "cache/filesystem-adapter": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.0",