Official public release

Author: Nara Kasbergen

.editorconfig

@@ -0,0 +1,27 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+trim_trailing_whitespace = true
+# Unix-style newlines with a newline ending every file
+end_of_line = lf
+insert_final_newline = true
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{php,inc,js,css,html}]
+charset = utf-8
+
+# 4 space indentation
+[*.{php,inc,js,css,html}]
+indent_style = space
+indent_size = 4
+
+# Matches the exact file
+[{composer.json}]
+indent_style = space
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,13 @@
+* text=auto
+
+/bin export-ignore
+/docs export-ignore
+/examples export-ignore
+/tests export-ignore
+/.editorconfig export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/phpdoc.xml export-ignore
+/phpunit.xml export-ignore
+/CODE_OF_CONDUCT.md export-ignore
+/CONTRIBUTING.md export-ignore

.gitignore

@@ -0,0 +1,61 @@
+*.log
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+### Composer template
+# composer.phar
+composer.lock
+vendor/
+
+# PHPUnit Results & Code Coverage
+test-results/
+
+# PHPDoc
+build/
+docs/structure.xml

CHANGELOG.md

@@ -0,0 +1,4 @@
+<a name="1.0.0"></a>
+# 1.0.0 (2016-06-17)
+
+Initial release.

CODE_OF_CONDUCT.md

@@ -0,0 +1,37 @@
+# Developer Community Code of Conduct
+
+### Introduction
+
+* Diversity and inclusion make our community strong. We encourage participation from the most varied and diverse backgrounds possible and want to be very clear about where we stand.
+* Our goal is to maintain a safe, helpful and friendly community for everyone, regardless of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other defining characteristic.
+* This code and related procedures also apply to unacceptable behavior occurring outside the scope of community activities, in all community venues— online and in-person— as well as in all one-on-one communications, and anywhere such behavior has the potential to adversely affect the safety and well-being of community members.
+
+
+### Expected Behavior
+
+* Be welcoming.
+* Be kind.
+* Look out for each other.
+
+
+### Unacceptable Behavior
+
+* Conduct or speech which might be considered sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory or offensive in nature.
+    * Do not use unwelcome, suggestive, derogatory or inappropriate nicknames or terms.
+    * Do not show disrespect towards others. (Jokes, innuendo, dismissive attitudes.)
+* Intimidation or harassment (online or in-person). Please read the [Citizen Code of Conduct](http://citizencodeofconduct.org/) for how we interpret harassment.
+* Disrespect towards differences of opinion.
+* Inappropriate attention or contact. Be aware of how your actions affect others. If it makes someone uncomfortable, stop.
+* Not understanding the differences between constructive criticism and disparagement.
+* Sustained disruptions.
+* Violence, threats of violence or violent language.
+
+
+### Enforcement
+
+* Understand that speech and actions have consequences, and unacceptable behavior will not be tolerated.
+* If you are the subject of, or witness to any violations of this Code of Conduct, please contact us by sending an email to [NPROneEnterprise@npr.org](mailto:NPROneEnterprise@npr.org).
+* If violations occur, organizers will take any action they deem appropriate for the infraction, up to and including expulsion.
+
+
+_Copied from the [Slack Developer Community Code of Conduct](https://api.slack.com/docs/community-code-of-conduct). Portions of the original were derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/), [The Citizen Code of Conduct](http://citizencodeofconduct.org/), [The Rust Code of Conduct](https://www.rust-lang.org/conduct.html) and [The Ada Initiative](http://adainitiative.org/2014/02/18/howto-design-a-code-of-conduct-for-your-community/) under a Creative Commons [Attribution-ShareAlike](http://creativecommons.org/licenses/by-sa/3.0/) license._

CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing
+
+If you're interested in contributing to this project by submitting bug reports, helping to improve the documentation, or writing actual code, please read on.
+
+##### Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Submitting Issues](#submitting-issues)
+  - [Got a Question or Problem?](#got-a-question-or-problem)
+  - [Found a Bug?](#found-a-bug)
+  - [Want a Feature?](#want-a-feature)
+- [Contributing to Development](#contributing-to-development)
+  - [Getting Set Up](#getting-set-up)
+  - [Coding Style](#coding-style)
+  - [Testing](#testing)
+  - [Generating Documentation](#generating-documentation)
+  - [Generating a Changelog](#generating-a-changelog)
+
+
+## Code of Conduct
+
+Please note that this project has a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
+
+
+## Submitting Issues
+
+When you're considering [submitting an issue to our GitHub repository](https://github.com/nprdm/npr-one-backend-proxy-php/issues/new), please consider the following guidelines:
+
+### Got a Question or Problem?
+
+If you have questions about how to use this package, we would generally prefer that you [contact us via e-mail](mailto:NPROneEnterprise@npr.org) rather than opening a ticket. That said, if you have constructive feedback for how we can make this package better by improving the documentation, by all means, [submit an issue](https://github.com/nprdm/npr-one-backend-proxy-php/issues/new). Please be detailed about your specific pain points, so that we're clear on what aspects of the documentation should be improved.
+
+### Found a Bug?
+
+If you find a bug in the source code or a mistake in the documentation, you can help us by [submitting an issue to our GitHub repository](https://github.com/nprdm/npr-one-backend-proxy-php/issues/new). Even better, you can submit a pull request with a fix. (Please read and follow our [Development Guidelines](#contributing-to-development) before submitting your PR.)
+
+### Want a Feature?
+
+You can request a new feature by [submitting an issue to our GitHub repository](https://github.com/nprdm/npr-one-backend-proxy-php/issues/new). Even if the feature is small and you are able to submit a pull request to implement it yourself, we would prefer to discuss it in the comments on the issue before you run off and write the code. Because this package is largely intended to function as an educational tool and documentation companion, we are trying to keep the codebase as simple and clear as possible, and not all new feature requests will be accepted. That said, you are always welcome to maintain a fork of our repository that has the additional features that you need.
+
+
+## Contributing to Development
+
+If you would like to contribute to the development of this project, here is the additional information you need:
+
+### Getting Set Up
+
+This project uses [Composer](https://getcomposer.org/) and includes a composer.phar for convenience under `/bin`.
+
+- `bin/composer.phar install`: install all dependencies
+
+Additionally, we highly recommend doing your development with [Xdebug enabled](https://xdebug.org/docs/install), to allow you to take advantage of various features, such as automatic code coverage measurement.
+
+### Coding Style
+
+We follow the [PSR-1](http://www.php-fig.org/psr/psr-1/) basic coding standards and [PSR-2](http://www.php-fig.org/psr/psr-2/) coding style guide, with the following addenda, exceptions, and clarifications:
+
+* All variables/property names should be in `$camelCase` only.
+* We put all opening curly braces on their own separate line, even for control structures.
+* We prefer `else if` to `elseif`.
+* We do not enforce any soft limit on line length (but expect developers to practice common sense here).
+
+Pull requests not conforming to our coding style may be asked to be updated before they are merged.
+
+### Testing
+
+This project includes tests which can be executed with PHPUnit.
+
+- `./vendor/bin/phpunit`: runs all unit tests
+
+PHPUnit is configured to generate coverage reports in a `coverage` folder under `test-results` in the root of the project. Overall test coverage can viewed by opening `test-results/coverage/index.html`. (N.B. These coverage reports are purposely excluded from source control.) Note that [Xdebug must be enabled](https://xdebug.org/docs/install) in order for code coverage to be generated.
+
+XML files are also generated for reporting test results and coverage on a CI server; again, those can be found under `test-results`.
+
+### Generating Documentation
+
+We are using [phpDocumentor](http://www.phpdoc.org) paired with the [phpdoc-md](https://github.com/evert/phpdoc-md) plugin to generate documentation in Markdown based on the contents of our PHPDoc blocks. To generate or update the documentation, use:
+
+```
+./vendor/bin/phpdoc
+./vendor/bin/phpdocmd docs/structure.xml docs --index README.md
+```
+
+### Generating a Changelog
+
+This will generally only ever be done by a maintainer from within NPR, but just in case: We're using the [phly/changelog-generator](https://github.com/weierophinney/changelog_generator) package, and the CLI command is:
+
+```
+vendor/bin/changelog_generator.php -t githubAPItoken -u nprdm -r npr-one-backend-proxy-php -m 1 > CHANGELOG.md
+```

LICENSE.md

@@ -0,0 +1,17 @@
+Copyright (c) 2016 NPR
+
+Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/License-2.0) (the “License”) with the following modification; you may not use this file except in compliance with the License as modified by the addition of Section 10, as follows:
+
+##### 10. Prohibitions
+
+When using the Work, you may not (or allow those acting on your behalf to):
+
+a.	Perform an action with the intent of introducing to the Work, the NPR One API or any other NPR products and services any viruses, worms, defects, Trojan horses, malware or any items of a destructive nature, or obtaining unauthorized access to the NPR One API or any other NPR products or services;
+
+b.	Remove, obscure or alter any NPR terms of service, including the [NPR services Terms of Use](http://www.npr.org/about-npr/179876898/terms-of-use) and the [Developer API Terms of Use](http://dev.npr.org/terms-of-use/), or any links to or notices of those terms; or
+
+c.	Take any other action prohibited by any NPR terms of service, including the [NPR services Terms of Use](http://www.npr.org/about-npr/179876898/terms-of-use) and the [Developer API Terms of Use](http://dev.npr.org/terms-of-use/), unless expressly permitted by the License.
+
+You may obtain a copy of the License at http://www.apache.org/licenses/License-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License with the above modification is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.