From 3e21b68005e89205ffc1cda9c46fc1fb879ee056 Mon Sep 17 00:00:00 2001 From: John Pedrie Date: Fri, 10 Mar 2017 17:24:36 -0500 Subject: [PATCH] Component split (#360) * Reorganize namespaces and fix tests * # This is a combination of 9 commits. # This is the 1st commit message: Reorganize namespaces and fix tests Update component versions via the CLI # This is the commit message #2: Create tags in components # This is the commit message #3: Send component name and version in user agent # This is the commit message #4: Add README files # This is the commit message #5: Fix CLI # This is the commit message #6: Add split to travis # This is the commit message #7: Test datastore release # This is the commit message #8: Compile splitsh # This is the commit message #9: Reintroduce full split process * # This is a combination of 2 commits. # This is the 1st commit message: Reorganize namespaces and fix tests Update component versions via the CLI Create tags in components Send component name and version in user agent Add README files Fix CLI Add split to travis Test datastore release Compile splitsh Reintroduce full split process Release patches # This is the commit message #2: Run split in each build matrix * Reorganize namespaces and fix tests Update component versions via the CLI Create tags in components Send component name and version in user agent Add README files Fix CLI Add split to travis Test datastore release Compile splitsh Reintroduce full split process Release patches Run split in each build matrix Release datastore patch enable set -e * Work with github API directly * Fix Vision class reference * Create VERSION file for all components * Remove componentName * Fix int64 snippet tests * Update component release target * Parse documentation separately for each component * This works now * Add flag to docs to use JSON_PRETTY_PRINT for debugging * Parse correct links between components * Fix unit tests * Doc links within component should not change version * Cross-component links should go to the correct version docs * Update snippets to remove refs to ServiceBuilder * Remove unnecessary env vars * Don't write VERSION for parent * Release packages * release v0.24.1 * Add autoloaders to each component * Pass libVersion to gax config * Update push docs command * add gcsUri helper * allow gcsUri or storage object * Release 0.24.2 * Update things again * this is the worst * Link to upstream tag * tag * Update table of contents * Reset versions * Update suggests and requires * fix build docs trigger * dont throw exceptions on decode * Fix docs link * Fix various doc issues * fix namespace --- .travis.yml | 35 +-- composer.json | 8 + dev/google-cloud | 2 + dev/sh/build-docs | 8 +- dev/sh/compile-splitsh | 13 + dev/sh/push-docs | 19 +- dev/sh/split | 10 + dev/sh/trigger-split | 9 + dev/src/DocGenerator/Command/Docs.php | 100 +++++++- dev/src/DocGenerator/DocGenerator.php | 56 +++- dev/src/DocGenerator/Parser/CodeParser.php | 90 ++++++- .../DocGenerator/Parser/MarkdownParser.php | 2 +- dev/src/DocGenerator/TableOfContents.php | 44 ++++ dev/src/DocGenerator/TypeGenerator.php | 4 +- dev/src/DocGenerator/Writer.php | 12 +- dev/src/GetComponentsTrait.php | 116 +++++++++ dev/src/Release/Command/Release.php | 131 +++++++--- dev/src/Snippet/Parser/Snippet.php | 11 +- dev/src/Split/Command/Split.php | 172 +++++++++++++ docs/contents/cloud-bigquery.json | 31 +++ docs/contents/cloud-core.json | 30 +++ docs/contents/cloud-datastore.json | 25 ++ docs/contents/cloud-error-reporting.json | 20 ++ docs/contents/cloud-logging.json | 35 +++ docs/contents/cloud-monitoring.json | 17 ++ docs/contents/cloud-natural-language.json | 7 + docs/contents/cloud-pubsub.json | 26 ++ docs/contents/cloud-speech.json | 17 ++ docs/contents/cloud-storage.json | 13 + docs/contents/cloud-translate.json | 4 + docs/contents/cloud-vision.json | 34 +++ docs/contents/google-cloud.json | 4 + docs/home.html | 2 +- docs/manifest.json | 162 +++++++++--- docs/toc.json | 239 +----------------- src/BigQuery/BigQueryClient.php | 21 +- src/BigQuery/Bytes.php | 5 +- .../Connection/ConnectionInterface.php | 2 + src/BigQuery/Connection/Rest.php | 18 +- src/BigQuery/Dataset.php | 2 +- src/BigQuery/Date.php | 5 +- src/BigQuery/Job.php | 2 +- src/BigQuery/LICENSE | 202 +++++++++++++++ src/BigQuery/QueryResults.php | 4 +- src/BigQuery/README.md | 10 + src/BigQuery/Table.php | 17 +- src/BigQuery/Time.php | 4 + src/BigQuery/Timestamp.php | 4 + src/BigQuery/ValueMapper.php | 8 +- src/BigQuery/composer.json | 26 ++ src/{ => Core}/ArrayTrait.php | 2 +- src/{ => Core}/CallTrait.php | 2 +- src/{ => Core}/ClientTrait.php | 7 +- src/{ => Core}/Compute/Metadata.php | 8 +- .../Metadata/Readers/ReaderInterface.php | 2 +- .../Compute/Metadata/Readers/StreamReader.php | 2 +- src/{ => Core}/EmulatorTrait.php | 6 +- .../Exception/BadRequestException.php | 2 +- .../Exception/ConflictException.php | 2 +- src/{ => Core}/Exception/GoogleException.php | 2 +- .../Exception/NotFoundException.php | 2 +- src/{ => Core}/Exception/ServerException.php | 2 +- src/{ => Core}/Exception/ServiceException.php | 2 +- src/{ => Core}/ExponentialBackoff.php | 2 +- src/{ => Core}/GrpcRequestWrapper.php | 12 +- src/{ => Core}/GrpcTrait.php | 11 +- src/{ => Core}/Iam/Iam.php | 14 +- src/{ => Core}/Iam/IamConnectionInterface.php | 2 +- src/{ => Core}/Iam/PolicyBuilder.php | 4 +- src/{ => Core}/Int64.php | 2 +- src/{ => Core}/JsonTrait.php | 2 +- src/Core/LICENSE | 202 +++++++++++++++ .../Logger/AppEngineFlexFormatter.php | 4 +- .../Logger/AppEngineFlexHandler.php | 2 +- src/{ => Core}/PhpArray.php | 2 +- src/Core/README.md | 7 + src/{ => Core}/RequestBuilder.php | 4 +- src/{ => Core}/RequestWrapper.php | 27 +- src/{ => Core}/RequestWrapperTrait.php | 2 +- src/{ => Core}/RestTrait.php | 8 +- src/{ => Core}/Upload/AbstractUploader.php | 6 +- src/{ => Core}/Upload/MultipartUploader.php | 4 +- src/{ => Core}/Upload/ResumableUploader.php | 6 +- src/{ => Core}/Upload/StreamableUploader.php | 2 +- src/{ => Core}/UriTrait.php | 2 +- src/{ => Core}/ValidateTrait.php | 2 +- src/Core/composer.json | 28 ++ src/Datastore/Blob.php | 5 +- src/Datastore/Connection/Rest.php | 14 +- src/Datastore/DatastoreClient.php | 29 +-- src/Datastore/DatastoreSessionHandler.php | 12 +- src/Datastore/Entity.php | 7 +- src/Datastore/EntityMapper.php | 6 +- src/Datastore/GeoPoint.php | 6 +- src/Datastore/Key.php | 7 +- src/Datastore/LICENSE | 202 +++++++++++++++ src/Datastore/Operation.php | 2 +- src/Datastore/Query/GqlQuery.php | 7 +- src/Datastore/Query/Query.php | 5 +- src/Datastore/README.md | 10 + src/Datastore/Transaction.php | 5 +- src/Datastore/composer.json | 22 ++ src/ErrorReporting/README.md | 3 + src/ErrorReporting/composer.json | 24 ++ src/Logging/Connection/Grpc.php | 9 +- src/Logging/Connection/Rest.php | 12 +- src/Logging/Entry.php | 5 +- src/Logging/LICENSE | 202 +++++++++++++++ src/Logging/Logger.php | 9 +- src/Logging/LoggingClient.php | 12 +- src/Logging/Metric.php | 7 +- src/Logging/PsrLogger.php | 5 +- src/Logging/README.md | 10 + src/Logging/Sink.php | 7 +- src/Logging/composer.json | 26 ++ src/Monitoring/LICENSE | 202 +++++++++++++++ src/Monitoring/README.md | 3 + src/Monitoring/composer.json | 24 ++ src/NaturalLanguage/Annotation.php | 7 +- src/NaturalLanguage/Connection/Rest.php | 12 +- src/NaturalLanguage/LICENSE | 202 +++++++++++++++ src/NaturalLanguage/NaturalLanguageClient.php | 67 +++-- src/NaturalLanguage/README.md | 10 + src/NaturalLanguage/composer.json | 25 ++ src/PubSub/Connection/Grpc.php | 11 +- src/PubSub/Connection/IamSubscription.php | 2 +- src/PubSub/Connection/IamTopic.php | 2 +- src/PubSub/Connection/Rest.php | 14 +- src/PubSub/IncomingMessageTrait.php | 2 +- src/PubSub/LICENSE | 202 +++++++++++++++ src/PubSub/Message.php | 5 +- src/PubSub/PubSubClient.php | 20 +- src/PubSub/README.md | 139 +--------- src/PubSub/Subscription.php | 13 +- src/PubSub/Topic.php | 10 +- src/PubSub/composer.json | 26 ++ src/ServiceBuilder.php | 4 +- src/Speech/Connection/Rest.php | 12 +- src/Speech/LICENSE | 202 +++++++++++++++ src/Speech/Operation.php | 7 +- src/Speech/README.md | 10 + src/Speech/SpeechClient.php | 42 +-- src/Speech/composer.json | 27 ++ src/Storage/Acl.php | 5 +- src/Storage/Bucket.php | 12 +- src/Storage/Connection/Rest.php | 20 +- src/Storage/LICENSE | 202 +++++++++++++++ src/Storage/README.md | 10 + src/Storage/StorageClient.php | 13 +- src/Storage/StorageObject.php | 27 +- src/Storage/StreamWrapper.php | 4 +- src/Storage/WriteStream.php | 2 +- src/Storage/composer.json | 22 ++ src/Translate/Connection/Rest.php | 12 +- src/Translate/LICENSE | 202 +++++++++++++++ src/Translate/README.md | 10 + src/Translate/TranslateClient.php | 13 +- src/Translate/composer.json | 22 ++ src/Vision/Annotation.php | 5 +- src/Vision/Annotation/CropHint.php | 7 +- src/Vision/Annotation/Document.php | 7 +- src/Vision/Annotation/Entity.php | 7 +- src/Vision/Annotation/Face.php | 7 +- src/Vision/Annotation/Face/Landmarks.php | 5 +- src/Vision/Annotation/ImageProperties.php | 5 +- src/Vision/Annotation/SafeSearch.php | 7 +- src/Vision/Annotation/Web.php | 5 +- src/Vision/Annotation/Web/WebEntity.php | 7 +- src/Vision/Annotation/Web/WebImage.php | 7 +- src/Vision/Annotation/Web/WebPage.php | 7 +- src/Vision/Connection/Rest.php | 12 +- src/Vision/Image.php | 15 +- src/Vision/LICENSE | 202 +++++++++++++++ src/Vision/README.md | 10 + src/Vision/VisionClient.php | 16 +- src/Vision/composer.json | 25 ++ .../snippets/BigQuery/BigQueryClientTest.php | 10 +- tests/snippets/BigQuery/TableTest.php | 2 +- .../{ => Core}/Compute/MetadataTest.php | 6 +- tests/snippets/{ => Core}/Iam/IamTest.php | 6 +- .../{ => Core}/Iam/PolicyBuilderTest.php | 4 +- tests/snippets/{ => Core}/Int64Test.php | 4 +- .../Datastore/DatastoreClientTest.php | 14 +- tests/snippets/Logging/LoggingClientTest.php | 8 - .../NaturalLanguageClientTest.php | 7 - tests/snippets/PubSub/MessageTest.php | 2 +- tests/snippets/PubSub/PubSubClientTest.php | 12 +- tests/snippets/PubSub/SubscriptionTest.php | 2 +- tests/snippets/PubSub/TopicTest.php | 2 +- tests/snippets/Speech/SpeechClientTest.php | 8 - tests/snippets/Storage/BucketTest.php | 8 +- tests/snippets/Storage/StorageClientTest.php | 7 - tests/snippets/Storage/StorageObjectTest.php | 10 + .../Translate/TranslateClientTest.php | 8 - tests/snippets/Vision/VisionClientTest.php | 8 - tests/snippets/bootstrap.php | 4 +- tests/system/BigQuery/BigQueryTestCase.php | 2 +- .../system/BigQuery/LoadDataAndQueryTest.php | 2 +- tests/system/BigQuery/ManageTablesTest.php | 2 +- tests/system/Datastore/DatastoreTestCase.php | 2 +- tests/system/Datastore/SaveAndModifyTest.php | 2 +- tests/system/Logging/LoggingTestCase.php | 2 +- .../system/Logging/WriteAndListEntryTest.php | 2 +- .../NaturalLanguageTestCase.php | 2 +- tests/system/PubSub/PubSubTestCase.php | 2 +- tests/system/Storage/ManageAclTest.php | 2 +- tests/system/Storage/StorageTestCase.php | 2 +- tests/unit/BigQuery/BigQueryClientTest.php | 2 +- tests/unit/BigQuery/BytesTest.php | 2 +- tests/unit/BigQuery/Connection/RestTest.php | 15 +- tests/unit/BigQuery/DatasetTest.php | 4 +- tests/unit/BigQuery/DateTest.php | 2 +- tests/unit/BigQuery/InsertResponseTest.php | 2 +- tests/unit/BigQuery/JobTest.php | 4 +- tests/unit/BigQuery/QueryResultsTest.php | 4 +- tests/unit/BigQuery/TableTest.php | 26 +- tests/unit/BigQuery/TimeTest.php | 2 +- tests/unit/BigQuery/TimestampTest.php | 2 +- tests/unit/BigQuery/ValueMapperTest.php | 4 +- tests/unit/{ => Core}/ArrayTraitTest.php | 6 +- tests/unit/{ => Core}/CallTraitTest.php | 6 +- tests/unit/{ => Core}/ClientTraitTest.php | 26 +- .../unit/{ => Core}/Compute/MetadataTest.php | 8 +- tests/unit/{ => Core}/EmulatorTraitTest.php | 6 +- .../Exception/ServiceExceptionTest.php | 5 +- .../{ => Core}/ExponentialBackoffTest.php | 6 +- .../{ => Core}/GrpcRequestWrapperTest.php | 21 +- tests/unit/{ => Core}/GrpcTraitTest.php | 15 +- tests/unit/{ => Core}/Iam/IamTest.php | 7 +- .../unit/{ => Core}/Iam/PolicyBuilderTest.php | 5 +- tests/unit/{ => Core}/Int64Test.php | 6 +- tests/unit/{ => Core}/JsonTraitTest.php | 4 +- .../Logger/AppEngineFlexHandlerTest.php | 5 +- tests/unit/{ => Core}/PhpArrayTest.php | 8 +- tests/unit/{ => Core}/RequestBuilderTest.php | 12 +- tests/unit/{ => Core}/RequestWrapperTest.php | 46 ++-- tests/unit/{ => Core}/RestTraitTest.php | 12 +- tests/unit/{ => Core}/ServiceBuilderTest.php | 4 +- .../Upload/MultipartUploaderTest.php | 11 +- .../Upload/ResumableUploaderTest.php | 27 +- .../Upload/StreamableUploaderTest.php | 17 +- tests/unit/{ => Core}/UriTraitTest.php | 6 +- tests/unit/{ => Core}/ValidateTraitTest.php | 6 +- tests/unit/Datastore/BlobTest.php | 2 +- tests/unit/Datastore/Connection/RestTest.php | 7 +- tests/unit/Datastore/DatastoreClientTest.php | 2 +- .../Datastore/DatastoreSessionHandlerTest.php | 2 +- tests/unit/Datastore/DatastoreTraitTest.php | 2 +- tests/unit/Datastore/EntityMapperTest.php | 4 +- tests/unit/Datastore/EntityTest.php | 2 +- tests/unit/Datastore/GeoPointTest.php | 2 +- tests/unit/Datastore/KeyTest.php | 2 +- tests/unit/Datastore/OperationTest.php | 2 +- tests/unit/Datastore/Query/GqlQueryTest.php | 2 +- tests/unit/Datastore/Query/QueryTest.php | 2 +- tests/unit/Datastore/TransactionTest.php | 2 +- tests/unit/JsonFileTest.php | 37 ++- tests/unit/Logging/Connection/GrpcTest.php | 6 +- tests/unit/Logging/Connection/RestTest.php | 7 +- tests/unit/Logging/LoggerTest.php | 2 +- tests/unit/Logging/LoggingClientTest.php | 2 +- tests/unit/Logging/MetricTest.php | 4 +- .../Logging/PsrLoggerCompatabilityTest.php | 2 +- tests/unit/Logging/PsrLoggerTest.php | 2 +- tests/unit/Logging/SinkTest.php | 4 +- tests/unit/NaturalLanguage/AnnotationTest.php | 4 +- .../NaturalLanguage/Connection/RestTest.php | 9 +- .../NaturalLanguageClientTest.php | 20 +- tests/unit/PubSub/Connection/GrpcTest.php | 4 +- .../PubSub/Connection/IamSubscriptionTest.php | 2 +- tests/unit/PubSub/Connection/IamTopicTest.php | 2 +- tests/unit/PubSub/Connection/RestTest.php | 7 +- .../unit/PubSub/IncomingMessageTraitTest.php | 4 +- tests/unit/PubSub/MessageTest.php | 2 +- tests/unit/PubSub/PubSubClientTest.php | 2 +- tests/unit/PubSub/ResourceNameTraitTest.php | 2 +- tests/unit/PubSub/SubscriptionTest.php | 6 +- tests/unit/PubSub/TopicTest.php | 6 +- tests/unit/Speech/Connection/RestTest.php | 7 +- tests/unit/Speech/OperationTest.php | 4 +- tests/unit/Speech/SpeechClientTest.php | 23 +- tests/unit/Storage/AclTest.php | 2 +- tests/unit/Storage/BucketTest.php | 25 +- tests/unit/Storage/Connection/RestTest.php | 23 +- tests/unit/Storage/EncryptionTraitTest.php | 2 +- tests/unit/Storage/StorageClientTest.php | 2 +- tests/unit/Storage/StorageObjectTest.php | 12 +- tests/unit/Storage/StreamWrapperTest.php | 16 +- tests/unit/Storage/WriteStreamTest.php | 2 +- tests/unit/Translate/Connection/RestTest.php | 7 +- tests/unit/Translate/TranslateClientTest.php | 2 +- tests/unit/Vision/Annotation/EntityTest.php | 2 +- .../Vision/Annotation/Face/LandmarksTest.php | 2 +- tests/unit/Vision/Annotation/FaceTest.php | 2 +- .../Vision/Annotation/LikelihoodTraitTest.php | 2 +- .../unit/Vision/Annotation/SafeSearchTest.php | 2 +- tests/unit/Vision/AnnotationTest.php | 2 +- tests/unit/Vision/Connection/RestTest.php | 7 +- tests/unit/Vision/ImageTest.php | 2 +- tests/unit/Vision/VisionClientTest.php | 2 +- 300 files changed, 4638 insertions(+), 1319 deletions(-) create mode 100755 dev/sh/compile-splitsh create mode 100755 dev/sh/split create mode 100755 dev/sh/trigger-split create mode 100644 dev/src/DocGenerator/TableOfContents.php create mode 100644 dev/src/GetComponentsTrait.php create mode 100644 dev/src/Split/Command/Split.php create mode 100644 docs/contents/cloud-bigquery.json create mode 100644 docs/contents/cloud-core.json create mode 100644 docs/contents/cloud-datastore.json create mode 100644 docs/contents/cloud-error-reporting.json create mode 100644 docs/contents/cloud-logging.json create mode 100644 docs/contents/cloud-monitoring.json create mode 100644 docs/contents/cloud-natural-language.json create mode 100644 docs/contents/cloud-pubsub.json create mode 100644 docs/contents/cloud-speech.json create mode 100644 docs/contents/cloud-storage.json create mode 100644 docs/contents/cloud-translate.json create mode 100644 docs/contents/cloud-vision.json create mode 100644 docs/contents/google-cloud.json create mode 100644 src/BigQuery/LICENSE create mode 100644 src/BigQuery/README.md create mode 100644 src/BigQuery/composer.json rename src/{ => Core}/ArrayTrait.php (98%) rename src/{ => Core}/CallTrait.php (97%) rename src/{ => Core}/ClientTrait.php (97%) rename src/{ => Core}/Compute/Metadata.php (93%) rename src/{ => Core}/Compute/Metadata/Readers/ReaderInterface.php (93%) rename src/{ => Core}/Compute/Metadata/Readers/StreamReader.php (96%) rename src/{ => Core}/EmulatorTrait.php (93%) rename src/{ => Core}/Exception/BadRequestException.php (95%) rename src/{ => Core}/Exception/ConflictException.php (95%) rename src/{ => Core}/Exception/GoogleException.php (94%) rename src/{ => Core}/Exception/NotFoundException.php (94%) rename src/{ => Core}/Exception/ServerException.php (95%) rename src/{ => Core}/Exception/ServiceException.php (97%) rename src/{ => Core}/ExponentialBackoff.php (99%) rename src/{ => Core}/GrpcRequestWrapper.php (95%) rename src/{ => Core}/GrpcTrait.php (95%) rename src/{ => Core}/Iam/Iam.php (93%) rename src/{ => Core}/Iam/IamConnectionInterface.php (97%) rename src/{ => Core}/Iam/PolicyBuilder.php (98%) rename src/{ => Core}/Int64.php (98%) rename src/{ => Core}/JsonTrait.php (98%) create mode 100644 src/Core/LICENSE rename src/{ => Core}/Logger/AppEngineFlexFormatter.php (96%) rename src/{ => Core}/Logger/AppEngineFlexHandler.php (98%) rename src/{ => Core}/PhpArray.php (99%) create mode 100644 src/Core/README.md rename src/{ => Core}/RequestBuilder.php (98%) rename src/{ => Core}/RequestWrapper.php (91%) rename src/{ => Core}/RequestWrapperTrait.php (99%) rename src/{ => Core}/RestTrait.php (93%) rename src/{ => Core}/Upload/AbstractUploader.php (96%) rename src/{ => Core}/Upload/MultipartUploader.php (96%) rename src/{ => Core}/Upload/ResumableUploader.php (97%) rename src/{ => Core}/Upload/StreamableUploader.php (98%) rename src/{ => Core}/UriTrait.php (98%) rename src/{ => Core}/ValidateTrait.php (98%) create mode 100644 src/Core/composer.json create mode 100644 src/Datastore/LICENSE create mode 100644 src/Datastore/README.md create mode 100644 src/Datastore/composer.json create mode 100644 src/ErrorReporting/composer.json create mode 100644 src/Logging/LICENSE create mode 100644 src/Logging/README.md create mode 100644 src/Logging/composer.json create mode 100644 src/Monitoring/LICENSE create mode 100644 src/Monitoring/composer.json create mode 100644 src/NaturalLanguage/LICENSE create mode 100644 src/NaturalLanguage/README.md create mode 100644 src/NaturalLanguage/composer.json create mode 100644 src/PubSub/LICENSE create mode 100644 src/PubSub/composer.json create mode 100644 src/Speech/LICENSE create mode 100644 src/Speech/README.md create mode 100644 src/Speech/composer.json create mode 100644 src/Storage/LICENSE create mode 100644 src/Storage/README.md create mode 100644 src/Storage/composer.json create mode 100644 src/Translate/LICENSE create mode 100644 src/Translate/README.md create mode 100644 src/Translate/composer.json create mode 100644 src/Vision/LICENSE create mode 100644 src/Vision/README.md create mode 100644 src/Vision/composer.json rename tests/snippets/{ => Core}/Compute/MetadataTest.php (96%) rename tests/snippets/{ => Core}/Iam/IamTest.php (96%) rename tests/snippets/{ => Core}/Iam/PolicyBuilderTest.php (96%) rename tests/snippets/{ => Core}/Int64Test.php (96%) rename tests/unit/{ => Core}/ArrayTraitTest.php (96%) rename tests/unit/{ => Core}/CallTraitTest.php (93%) rename tests/unit/{ => Core}/ClientTraitTest.php (88%) rename tests/unit/{ => Core}/Compute/MetadataTest.php (92%) rename tests/unit/{ => Core}/EmulatorTraitTest.php (93%) rename tests/unit/{ => Core}/Exception/ServiceExceptionTest.php (90%) rename tests/unit/{ => Core}/ExponentialBackoffTest.php (97%) rename tests/unit/{ => Core}/GrpcRequestWrapperTest.php (89%) rename tests/unit/{ => Core}/GrpcTraitTest.php (96%) rename tests/unit/{ => Core}/Iam/IamTest.php (96%) rename tests/unit/{ => Core}/Iam/PolicyBuilderTest.php (97%) rename tests/unit/{ => Core}/Int64Test.php (92%) rename tests/unit/{ => Core}/JsonTraitTest.php (95%) rename tests/unit/{ => Core}/Logger/AppEngineFlexHandlerTest.php (93%) rename tests/unit/{ => Core}/PhpArrayTest.php (96%) rename tests/unit/{ => Core}/RequestBuilderTest.php (91%) rename tests/unit/{ => Core}/RequestWrapperTest.php (88%) rename tests/unit/{ => Core}/RestTraitTest.php (88%) rename tests/unit/{ => Core}/ServiceBuilderTest.php (97%) rename tests/unit/{ => Core}/Upload/MultipartUploaderTest.php (81%) rename tests/unit/{ => Core}/Upload/ResumableUploaderTest.php (84%) rename tests/unit/{ => Core}/Upload/StreamableUploaderTest.php (89%) rename tests/unit/{ => Core}/UriTraitTest.php (95%) rename tests/unit/{ => Core}/ValidateTraitTest.php (95%) diff --git a/.travis.yml b/.travis.yml index fd8876ac630c..0c37a6d81b32 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,30 +1,31 @@ language: php - sudo: required dist: trusty matrix: - include: - - php: 5.5.38 - - php: 5.6.25 - - php: 7.0 - - php: 7.1 - - php: hhvm - group: edge - fast_finish: true + include: + - php: 5.5.38 + - php: 5.6.25 + - php: 7.0 + - php: 7.1 + - php: hhvm + group: edge + fast_finish: true before_script: - - pecl install grpc || echo 'Failed to install grpc' - - composer install + - pecl install grpc || echo 'Failed to install grpc' + - composer install script: - - ./dev/sh/tests - - vendor/bin/phpcs --standard=./phpcs-ruleset.xml - - ./dev/sh/build-docs + - ./dev/sh/tests + - vendor/bin/phpcs --standard=./phpcs-ruleset.xml + - ./dev/sh/build-docs after_success: - - bash <(curl -s https://codecov.io/bash) - - ./dev/sh/push-docs + - bash <(curl -s https://codecov.io/bash) + - ./dev/sh/push-docs + - ./dev/sh/trigger-split + - cat ./build/snippets-uncovered.json after_failure: - - echo "SNIPPET COVERAGE REPORT" && cat ./build/snippets-uncovered.json + - echo "SNIPPET COVERAGE REPORT" && cat ./build/snippets-uncovered.json diff --git a/composer.json b/composer.json index 4402d1145b28..0ed669718bb4 100644 --- a/composer.json +++ b/composer.json @@ -76,5 +76,13 @@ }, "scripts": { "google-cloud": "dev/google-cloud" + }, + "extra": { + "component": { + "id": "google-cloud", + "target": "git@github.com:jdpedrie-gcp/google-cloud-php.git", + "path": "src", + "entry": "ServiceBuilder.php" + } } } diff --git a/dev/google-cloud b/dev/google-cloud index cd0636602a4f..e004b499d438 100755 --- a/dev/google-cloud +++ b/dev/google-cloud @@ -20,6 +20,7 @@ require __DIR__ . '/../vendor/autoload.php'; use Google\Cloud\Dev\DocGenerator\Command\Docs; use Google\Cloud\Dev\Release\Command\Release; +use Google\Cloud\Dev\Split\Command\Split; use Symfony\Component\Console\Application; if (!class_exists(Application::class)) { @@ -33,4 +34,5 @@ if (!class_exists(Application::class)) { $app = new Application; $app->add(new Release(__DIR__)); $app->add(new Docs(__DIR__)); +$app->add(new Split(__DIR__)); $app->run(); diff --git a/dev/sh/build-docs b/dev/sh/build-docs index cc09be67d534..1079b9de9dd6 100755 --- a/dev/sh/build-docs +++ b/dev/sh/build-docs @@ -5,7 +5,13 @@ set -ev function buildDocs () { echo "doc dir before generation:" find docs - composer google-cloud docs + + if [ -z "$TRAVIS_TAG" ]; then + ./dev/google-cloud docs + else + ./dev/google-cloud docs -r ${TRAVIS_TAG} + fi + echo "doc dir after generation:" find docs } diff --git a/dev/sh/compile-splitsh b/dev/sh/compile-splitsh new file mode 100755 index 000000000000..1cef5094d2b0 --- /dev/null +++ b/dev/sh/compile-splitsh @@ -0,0 +1,13 @@ +#!/bin/bash + +mkdir $ +export GOPATH=$TRAVIS_BUILD_DIR/go + +go get -d github.com/libgit2/git2go +cd $GOPATH/src/github.com/libgit2/git2go +git checkout next +git submodule update --init +make install + +go get github.com/splitsh/lite +go build -o $TRAVIS_BUILD_DIR/splitsh-lite github.com/splitsh/lite diff --git a/dev/sh/push-docs b/dev/sh/push-docs index a0ef3d50e770..0ee349729324 100755 --- a/dev/sh/push-docs +++ b/dev/sh/push-docs @@ -2,20 +2,11 @@ set -ev -function generateDocs () { - echo "doc dir before generation:" - find docs - composer google-cloud docs - echo "doc dir after generation:" - find docs -} - function pushDocs () { - git submodule add -q -f -b gh-pages https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} ghpages - mkdir -p ghpages/json/${1} - cp -R docs/json/master/* ghpages/json/${1} - cp docs/overview.html ghpages/json/${1} - cp docs/toc.json ghpages/json/${1} + git submodule add -q -f -b gh-pages https://${GH_OAUTH_TOKEN}@github.com/${TRAVIS_REPO_SLUG} ghpages + + rsync -aP docs/json/* ghpages/json/ + cp docs/home.html ghpages/json cp docs/manifest.json ghpages cd ghpages @@ -25,7 +16,7 @@ function pushDocs () { git config user.email "travis@travis-ci.org" git commit -m "Updating docs for ${1}" git status - git push -q https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} HEAD:gh-pages + git push -q https://${GH_OAUTH_TOKEN}@github.com/${TRAVIS_REPO_SLUG} HEAD:gh-pages else echo "Nothing to commit." fi diff --git a/dev/sh/split b/dev/sh/split new file mode 100755 index 000000000000..6ff7c259f9ac --- /dev/null +++ b/dev/sh/split @@ -0,0 +1,10 @@ +#!/bin/bash + +set -e + +branch=$(git branch | sed -n -e 's/^\* \(.*\)/\1/p') + +SHA=`$TRAVIS_BUILD_DIR/splitsh-lite --prefix=$1` +git push -q \ + "https://${GH_OAUTH_TOKEN}@github.com/$2" \ + $SHA:master --force diff --git a/dev/sh/trigger-split b/dev/sh/trigger-split new file mode 100755 index 000000000000..5685a6fe239e --- /dev/null +++ b/dev/sh/trigger-split @@ -0,0 +1,9 @@ +#!/bin/bash + +if [[ "$TRAVIS_JOB_NUMBER" == *.1 && -n "$TRAVIS_TAG" ]]; then + $(dirname $0)/compile-splitsh + git fetch --unshallow + composer google-cloud split +else + echo "Split occurs only in a tag run, and in the first matrix build" +fi diff --git a/dev/src/DocGenerator/Command/Docs.php b/dev/src/DocGenerator/Command/Docs.php index 33c522682c84..2ade7f174d00 100644 --- a/dev/src/DocGenerator/Command/Docs.php +++ b/dev/src/DocGenerator/Command/Docs.php @@ -19,7 +19,9 @@ use Google\Cloud\Dev\DocGenerator\DocGenerator; use Google\Cloud\Dev\DocGenerator\GuideGenerator; +use Google\Cloud\Dev\DocGenerator\TableOfContents; use Google\Cloud\Dev\DocGenerator\TypeGenerator; +use Google\Cloud\Dev\GetComponentsTrait; use RecursiveDirectoryIterator; use RecursiveIteratorIterator; use RecursiveRegexIterator; @@ -27,11 +29,16 @@ use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; class Docs extends Command { - const DEFAULT_OUTPUT_DIR = 'docs/json/master'; + use GetComponentsTrait; + + const DEFAULT_OUTPUT_DIR = 'docs/json'; + const TOC_SOURCE_DIR = 'docs/contents'; + const TOC_TEMPLATE = 'docs/toc.json'; const DEFAULT_SOURCE_DIR = 'src'; private $cliBasePath; @@ -47,29 +54,94 @@ protected function configure() { $this->setName('docs') ->setDescription('Generate Documentation') - ->addArgument('source', InputArgument::OPTIONAL, 'The source directory to traverse and parse') - ->addArgument('output', InputArgument::OPTIONAL, 'The directory to output files into'); + ->addOption('release', 'r', InputOption::VALUE_REQUIRED, 'If set, docs will be generated into tag folders' . + ' such as v1.0.0 rather than master.', false) + ->addOption('pretty', 'p', InputOption::VALUE_OPTIONAL, 'If set, json files will be written with pretty'. + ' formatting using PHP\'s JSON_PRETTY_PRINT flag', false); } protected function execute(InputInterface $input, OutputInterface $output) { + $release = ($input->getOption('release') === false && $input->getOption('release') !== 'false') + ? null + : $input->getOption('release'); + + $pretty = ($input->getOption('pretty') === false) ? false : true; + $paths = [ - 'source' => ($input->getArgument('source')) - ? $this->cliBasePath .'/../'. $input->getArgument('source') - : $this->cliBasePath .'/../'. self::DEFAULT_SOURCE_DIR, + 'source' => $this->cliBasePath .'/../'. self::DEFAULT_SOURCE_DIR, + 'output' => $this->cliBasePath .'/../'. self::DEFAULT_OUTPUT_DIR, + 'project' => $this->cliBasePath .'/../', + 'manifest' => $this->cliBasePath .'/../docs/manifest.json', + 'toc' => $this->cliBasePath .'/../'. self::TOC_SOURCE_DIR, + 'tocTemplate' => $this->cliBasePath .'/../'. self::TOC_TEMPLATE + ]; - 'output' => ($input->getArgument('output')) - ? $this->cliBasePath .'/../'. $input->getArgument('output') - : $this->cliBasePath .'/../'. self::DEFAULT_OUTPUT_DIR + $components = $this->getComponents($paths['source']); + $tocTemplate = json_decode(file_get_contents($paths['tocTemplate']), true); + + foreach ($components as $component) { + $input = $paths['project'] . $component['path']; + $source = $this->getFilesList($input); + $this->generateComponentDocumentation($output, $source, $component, $paths, $tocTemplate, $release, $pretty); + } + + $source = [$paths['project'] .'src/ServiceBuilder.php']; + $component = [ + 'id' => 'google-cloud', + 'path' => 'src/' ]; + $this->generateComponentDocumentation($output, $source, $component, $paths, $tocTemplate, $release, $pretty); + } + + private function generateComponentDocumentation( + OutputInterface $output, + array $source, + array $component, + array $paths, + $tocTemplate, + $release = false, + $pretty = false + ) { + $output->writeln(sprintf('Writing documentation for %s', $component['id'])); + $output->writeln('--------------'); + + $version = $this->getComponentVersion($paths['manifest'], $component['id']); + + $outputPath = ($release) + ? $paths['output'] .'/'. $component['id'] .'/'. $version + : $paths['output'] .'/'. $component['id'] .'/master'; + + $output->writeln(sprintf('Writing to %s', realpath($outputPath))); + + $types = new TypeGenerator($outputPath); + + $docs = new DocGenerator( + $types, + $source, + $outputPath, + $this->cliBasePath, + $component['id'], + $paths['manifest'], + $release + ); + $docs->generate($component['path'], $pretty); + + $types->write($pretty); - $types = new TypeGenerator($paths['output']); + $output->writeln(sprintf('Writing table of contents to %s', realpath($outputPath))); + $services = json_decode(file_get_contents($paths['toc'] .'/'. $component['id'] .'.json'), true); - $sourceFiles = $this->getFilesList($paths['source']); - $docs = new DocGenerator($types, $sourceFiles, $paths['output'], $this->cliBasePath); - $docs->generate(); + $toc = new TableOfContents( + $tocTemplate, + $services, + $release, + $outputPath + ); + $toc->generate($pretty); - $types->write(); + $output->writeln(' '); + $output->writeln(' '); } private function getFilesList($source) diff --git a/dev/src/DocGenerator/DocGenerator.php b/dev/src/DocGenerator/DocGenerator.php index 7394002af896..239e54eb1dca 100644 --- a/dev/src/DocGenerator/DocGenerator.php +++ b/dev/src/DocGenerator/DocGenerator.php @@ -32,16 +32,29 @@ class DocGenerator private $files; private $outputPath; private $executionPath; + private $componentId; + private $manifestPath; + private $release; /** * @param array $files */ - public function __construct(TypeGenerator $types, array $files, $outputPath, $executionPath) - { + public function __construct( + TypeGenerator $types, + array $files, + $outputPath, + $executionPath, + $componentId, + $manifestPath, + $release + ) { $this->types = $types; $this->files = $files; $this->outputPath = $outputPath; $this->executionPath = $executionPath; + $this->componentId = $componentId; + $this->manifestPath = $manifestPath; + $this->release = $release; } /** @@ -49,31 +62,56 @@ public function __construct(TypeGenerator $types, array $files, $outputPath, $ex * * @return void */ - public function generate() + public function generate($basePath, $pretty) { foreach ($this->files as $file) { - $currentFile = substr(str_replace($this->executionPath, '', $file), 3); + if ($basePath) { + $currentFileArr = explode($basePath, trim($file, '/')); + if (isset($currentFileArr[1])) { + $currentFile = trim($currentFileArr[1], '/'); + } + } + $isPhp = strrpos($file, '.php') == strlen($file) - strlen('.php'); if ($isPhp) { $fileReflector = new FileReflector($file); - $parser = new CodeParser($file, $currentFile, $fileReflector); + $parser = new CodeParser( + $file, + $currentFile, + $fileReflector, + dirname($this->executionPath), + $this->componentId, + $this->manifestPath, + $this->release + ); } else { $content = file_get_contents($file); - $parser = new MarkdownParser($currentFile, $content); + $split = explode('src/', $file); + $parser = new MarkdownParser($split[1], $content); } $document = $parser->parse(); - $writer = new Writer(json_encode($document), $this->outputPath); - $writer->write(substr($currentFile, 4)); + $writer = new Writer($document, $this->outputPath, $pretty); + $writer->write($currentFile); $this->types->addType([ 'id' => $document['id'], 'title' => $document['title'], - 'contents' => $document['id'] . '.json' + 'contents' => $this->prune($document['id'] . '.json') ]); } } + + private function prune($contentsFileName) + { + $explode = explode('/', $contentsFileName); + if (count($explode) > 1) { + array_shift($explode); + } + + return implode('/', $explode); + } } diff --git a/dev/src/DocGenerator/Parser/CodeParser.php b/dev/src/DocGenerator/Parser/CodeParser.php index e478bdd41d42..fd13c43f8885 100644 --- a/dev/src/DocGenerator/Parser/CodeParser.php +++ b/dev/src/DocGenerator/Parser/CodeParser.php @@ -18,6 +18,7 @@ namespace Google\Cloud\Dev\DocGenerator\Parser; use Google\Cloud\Dev\DocBlockStripSpaces; +use Google\Cloud\Dev\GetComponentsTrait; use phpDocumentor\Reflection\DocBlock; use phpDocumentor\Reflection\DocBlock\Description; use phpDocumentor\Reflection\DocBlock\Tag\SeeTag; @@ -25,21 +26,38 @@ class CodeParser implements ParserInterface { + use GetComponentsTrait; + const SNIPPET_NAME_REGEX = '/\/\/\s?\[snippet\=(\w{0,})\]/'; private $path; private $outputName; private $reflector; private $markdown; + private $projectRoot; private $externalTypes; - - public function __construct($path, $outputName, FileReflector $reflector) - { + private $componentId; + private $manifestPath; + private $release; + + public function __construct( + $path, + $outputName, + FileReflector $reflector, + $projectRoot, + $componentId, + $manifestPath, + $release + ) { $this->path = $path; $this->outputName = $outputName; $this->reflector = $reflector; $this->markdown = \Parsedown::instance(); + $this->projectRoot = $projectRoot; $this->externalTypes = json_decode(file_get_contents(__DIR__ .'/../../../../docs/external-classes.json'), true); + $this->componentId = $componentId; + $this->manifestPath = $manifestPath; + $this->release = $release; } public function parse() @@ -485,15 +503,59 @@ private function buildExternalType($type) private function buildLink($content) { - if ($content[0] === '\\') { - $content = substr($content, 1); + $componentId = null; + if (substr_compare(trim($content, '\\'), 'Google\Cloud', 0, 12) === 0) { + try { + $matches = []; + preg_match('/[Generator\<]?(Google\\\Cloud\\\[\w\\\]{0,})[\>]?[\[\]]?/', $content, $matches); + $ref = new \ReflectionClass($matches[1]); + } catch (\ReflectionException $e) { + throw new \Exception(sprintf( + 'Reflection Exception: %s in %s. Given class was %s', + $e->getMessage(), + realpath($this->path), + $content + )); + } + + $recurse = true; + $file = $ref->getFileName(); + + if (strpos($file, dirname(realpath($this->path))) !== false) { + $recurse = false; + } + + do { + $composer = dirname($file) .'/composer.json'; + if (file_exists($composer) && $component = $this->isComponent($composer)) { + $componentId = $component['id']; + if ($componentId === $this->componentId) { + $componentId = null; + } + $recurse = false; + } elseif (trim($file, '/') === trim($this->projectRoot, '/')) { + $recurse = false; + } else { + $file = dirname($file); + } + } while($recurse); } + $content = trim($content, '\\'); + $displayName = $content; $content = substr($content, 13); $parts = explode('::', $content); $type = strtolower(str_replace('\\', '/', $parts[0])); + if ($componentId) { + $version = ($this->release) + ? $this->getComponentVersion($this->manifestPath, $componentId) + : 'master'; + + $type = $componentId .'/'. $version .'/'. $type; + } + $openTag = ' $examples ]; } + + private static $composerFiles = []; + + private function isComponent($composerPath) + { + if (isset(self::$composerFiles[$composerPath])) { + $contents = self::$composerFiles[$composerPath]; + } else { + $contents = json_decode(file_get_contents($composerPath), true); + self::$composerFiles[$composerPath] = $contents; + } + + if (isset($contents['extra']['component'])) { + return $contents['extra']['component']; + } + + return false; + } } diff --git a/dev/src/DocGenerator/Parser/MarkdownParser.php b/dev/src/DocGenerator/Parser/MarkdownParser.php index 2599f80d4954..058dba85bbfe 100644 --- a/dev/src/DocGenerator/Parser/MarkdownParser.php +++ b/dev/src/DocGenerator/Parser/MarkdownParser.php @@ -49,7 +49,7 @@ public function parse() $body = $doc->getElementsByTagName('body')->item(0); return [ - 'id' => strtolower(substr($pathinfo['dirname'] .'/'. $pathinfo['filename'], 5)), + 'id' => strtolower(trim($pathinfo['dirname'] .'/'. $pathinfo['filename'], '/.')), 'type' => 'guide', 'title' => $heading->textContent, 'name' => $heading->textContent, diff --git a/dev/src/DocGenerator/TableOfContents.php b/dev/src/DocGenerator/TableOfContents.php new file mode 100644 index 000000000000..162a5877c8be --- /dev/null +++ b/dev/src/DocGenerator/TableOfContents.php @@ -0,0 +1,44 @@ +template = $template; + $this->component = $component; + $this->componentVersion = $componentVersion; + $this->outputPath = $outputPath; + } + + public function generate($pretty = false) + { + $toc = $this->template; + $toc['services'] = $this->component; + $toc['tagName'] = $this->componentVersion; + + $writer = new Writer($toc, $this->outputPath, $pretty); + $writer->write('toc.json'); + } +} diff --git a/dev/src/DocGenerator/TypeGenerator.php b/dev/src/DocGenerator/TypeGenerator.php index f05a39a6fcfc..8abfc8d4ac87 100644 --- a/dev/src/DocGenerator/TypeGenerator.php +++ b/dev/src/DocGenerator/TypeGenerator.php @@ -36,9 +36,9 @@ public function addType(array $type) $this->types[] = $type; } - public function write() + public function write($pretty = false) { - $writer = new Writer(json_encode($this->types), $this->outputPath); + $writer = new Writer($this->types, $this->outputPath, $pretty); $writer->write('types.json'); } } diff --git a/dev/src/DocGenerator/Writer.php b/dev/src/DocGenerator/Writer.php index 4cafcb9200e3..f2c22e458b63 100644 --- a/dev/src/DocGenerator/Writer.php +++ b/dev/src/DocGenerator/Writer.php @@ -21,11 +21,13 @@ class Writer { private $content; private $outputPath; + private $pretty; - public function __construct($content, $outputPath) + public function __construct(array $content, $outputPath, $pretty = false) { $this->content = $content; $this->outputPath = $outputPath; + $this->pretty = (bool) $pretty; } public function write($currentFile) @@ -33,10 +35,14 @@ public function write($currentFile) $path = $this->buildOutputPath($currentFile); if (!is_dir(dirname($path))) { - mkdir(dirname($path), 0777, true); + @mkdir(dirname($path), 0777, true); } - file_put_contents($path, $this->content); + $content = ($this->pretty) + ? json_encode($this->content, JSON_PRETTY_PRINT) + : json_encode($this->content); + + file_put_contents($path, $content); } private function buildOutputPath($currentFile) diff --git a/dev/src/GetComponentsTrait.php b/dev/src/GetComponentsTrait.php new file mode 100644 index 000000000000..3efa11290fe5 --- /dev/null +++ b/dev/src/GetComponentsTrait.php @@ -0,0 +1,116 @@ + 1) { + $component['prefix'] = dirname('src' . $path[1]); + } else { + $component['prefix'] = ''; + } + + $components[] = $component; + } + + return $components; + } + + private function getComponentVersion($manifestPath, $componentId) + { + $manifest = $this->getComponentManifest($manifestPath, $componentId); + return $manifest['versions'][0]; + } + + private function getComponentManifest($manifestPath, $componentId) + { + $manifest = $this->getManifest($manifestPath); + $index = $this->getManifestComponentModuleIndex($manifestPath, $manifest, $componentId); + + return $manifest['modules'][$index]; + } + + private function getManifestComponentModuleIndex($manifestPath, array $manifest, $componentId) + { + $modules = array_filter($this->getManifest($manifestPath)['modules'], function ($module) use ($componentId) { + return ($module['id'] === $componentId); + }); + + return array_keys($modules)[0]; + } + + private function getManifest($manifestPath) + { + if (self::$__manifest) { + $manifest = self::$__manifest; + } else { + $manifest = json_decode(file_get_contents($manifestPath), true); + + if (json_last_error() !== JSON_ERROR_NONE) { + throw new RuntimeException('Could not decode manifest json'); + } + + self::$__manifest = $manifest; + } + + return $manifest; + } + + private function getComponentComposer($componentId) + { + $components = $this->getComponents($this->components, $this->defaultComponentComposer); + + $components = array_values(array_filter($components, function ($component) use ($componentId) { + return ($component['id'] === $componentId); + })); + + if (count($components) === 0) { + throw new \InvalidArgumentException(sprintf( + 'Given component id %s is not a valid component.', + $componentId + )); + } + + return $components[0]; + } +} diff --git a/dev/src/Release/Command/Release.php b/dev/src/Release/Command/Release.php index edc3bd1f21c3..37e0b62400c8 100644 --- a/dev/src/Release/Command/Release.php +++ b/dev/src/Release/Command/Release.php @@ -17,20 +17,35 @@ namespace Google\Cloud\Dev\Release\Command; +use Google\Cloud\Dev\GetComponentsTrait; use RuntimeException; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; use vierbergenlars\SemVer\version; class Release extends Command { - const PATH_MANIFEST = 'docs/manifest.json'; - const PATH_SERVICE_BUILDER = 'src/ServiceBuilder.php'; + use GetComponentsTrait; + + const COMPONENT_BASE = '%s/../src'; + const DEFAULT_COMPONENT = 'google-cloud'; + const DEFAULT_COMPONENT_COMPOSER = '%s/../composer.json'; + const PATH_MANIFEST = '%s/../docs/manifest.json'; + const PATH_SERVICE_BUILDER = '%s/../src/ServiceBuilder.php'; private $cliBasePath; + private $defaultClient; + + private $manifest; + + private $defaultComponentComposer; + + private $components; + private $allowedReleaseTypes = [ 'major', 'minor', 'patch' ]; @@ -39,6 +54,11 @@ public function __construct($cliBasePath) { $this->cliBasePath = $cliBasePath; + $this->defaultClient = sprintf(self::PATH_SERVICE_BUILDER, $cliBasePath); + $this->manifest = sprintf(self::PATH_MANIFEST, $cliBasePath); + $this->defaultComponentComposer = sprintf(self::DEFAULT_COMPONENT_COMPOSER, $cliBasePath); + $this->components = sprintf(self::COMPONENT_BASE, $cliBasePath); + parent::__construct(); } @@ -46,23 +66,31 @@ protected function configure() { $this->setName('release') ->setDescription('Prepares a new release') - ->addArgument('version', InputArgument::REQUIRED, 'The new version number'); + ->addArgument('version', InputArgument::REQUIRED, 'The new version number.') + ->addOption( + 'component', + 'c', + InputOption::VALUE_REQUIRED, + 'The component for which the version should be updated.', + self::DEFAULT_COMPONENT + ); } protected function execute(InputInterface $input, OutputInterface $output) { + $component = $this->getComponentComposer($input->getOption('component')); + $version = $input->getArgument('version'); + + // If the version is one of "major", "minor" or "patch", determine the + // correct incrementation. if (in_array(strtolower($version), $this->allowedReleaseTypes)) { - $version = $this->getNextVersionName($version); + $version = $this->getNextVersionName($version, $component); } try { $validatedVersion = new version($version); } catch (\Exception $e) { - $validatedVersion = null; - } - - if (is_null($validatedVersion)) { throw new RuntimeException(sprintf( 'Given version %s is not a valid version name', $version @@ -72,18 +100,33 @@ protected function execute(InputInterface $input, OutputInterface $output) $version = (string) $validatedVersion; $output->writeln(sprintf( - 'Adding version %s to Documentation Manifest.', - $version + 'Adding version %s to Documentation Manifest for component %s.', + $version, + $component['id'] )); - $this->addToManifest($version); + $this->addToComponentManifest($version, $component); $output->writeln(sprintf( - 'Setting ServiceBuilder version constant to %s.', + 'Setting component version constant to %s.', $version )); - $this->updateServiceBuilder($version); + $this->updateComponentVersionConstant($version, $component); + $output->writeln(sprintf( + 'File %s VERSION constant updated to %s', + $component['entry'], + $version + )); + + if ($component['id'] !== 'google-cloud') { + $this->updateComponentVersionFile($version, $component); + $output->writeln(sprintf( + 'Component %s VERSION file updated to %s', + $component['id'], + $version + )); + } $output->writeln(sprintf( 'Release %s generated!', @@ -91,64 +134,72 @@ protected function execute(InputInterface $input, OutputInterface $output) )); } - private function getNextVersionName($type) + private function getNextVersionName($type, array $component) { - $manifest = $this->getManifest(); - $lastRelease = new version($manifest['versions'][0]); + $manifest = $this->getComponentManifest($this->manifest, $component['id']); + + if ($manifest['versions'][0] === 'master') { + $lastRelease = new version('0.0.0'); + } else { + $lastRelease = new version($manifest['versions'][0]); + } return $lastRelease->inc($type); } - private function addToManifest($version) + private function addToComponentManifest($version, array $component) { - $manifest = $this->getManifest(); - - if (json_last_error() !== JSON_ERROR_NONE) { - throw new RuntimeException('Could not decode manifest json'); - } + $manifest = $this->getManifest($this->manifest); + $index = $this->getManifestComponentModuleIndex($this->manifest, $manifest, $component['id']); - array_unshift($manifest['versions'], 'v'. $version); + array_unshift($manifest['modules'][$index]['versions'], 'v'. $version); $content = json_encode($manifest, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) ."\n"; - $result = file_put_contents($this->getManifestPath(), $content); + $result = file_put_contents($this->manifest, $content); if (!$result) { throw new RuntimeException('File write failed'); } } - private function updateServiceBuilder($version) + private function updateComponentVersionConstant($version, array $component) { - $path = $this->cliBasePath .'/../'. self::PATH_SERVICE_BUILDER; + if (is_null($component['entry'])) { + return false; + } + + $path = $this->cliBasePath .'/../'. $component['path'] .'/'. $component['entry']; if (!file_exists($path)) { - throw new RuntimeException('ServiceBuilder not found at '. $path); + throw new \RuntimeException(sprintf( + 'Component entry file %s does not exist', + $path + )); } - $sb = file_get_contents($path); + $entry = file_get_contents($path); $replacement = sprintf("const VERSION = '%s';", $version); - $sb = preg_replace("/const VERSION = '[0-9.]{0,}'\;/", $replacement, $sb); + $entry = preg_replace("/const VERSION = [\'\\\"]([0-9.]{0,}|master)[\'\\\"]\;/", $replacement, $entry); - $result = file_put_contents($path, $sb); + $result = file_put_contents($path, $entry); if (!$result) { throw new RuntimeException('File write failed'); } + + return true; } - private function getManifest() + private function updateComponentVersionFile($version, array $component) { - $path = $this->getManifestPath(); - if (!file_exists($path)) { - throw new RuntimeException('Manifest file not found at '. $path); - } + $path = $this->cliBasePath .'/../'. $component['path'] .'/VERSION'; + $result = file_put_contents($path, $version); - return json_decode(file_get_contents($path), true); - } + if (!$result) { + throw new RuntimeException('File write failed'); + } - private function getManifestPath() - { - return $this->cliBasePath .'/../'. self::PATH_MANIFEST; + return true; } } diff --git a/dev/src/Snippet/Parser/Snippet.php b/dev/src/Snippet/Parser/Snippet.php index 74316ecaf25d..d1ace59affdf 100644 --- a/dev/src/Snippet/Parser/Snippet.php +++ b/dev/src/Snippet/Parser/Snippet.php @@ -152,9 +152,14 @@ public function invoke($returnVar = null) $cb = function($return) use ($content) { extract($this->locals); - ob_start(); - $res = eval($content ."\n\n". $return); - $out = ob_get_clean(); + try { + ob_start(); + $res = eval($content ."\n\n". $return); + $out = ob_get_clean(); + } catch (\Exception $e) { + ob_end_clean(); + throw $e; + } return new InvokeResult($res, $out); }; diff --git a/dev/src/Split/Command/Split.php b/dev/src/Split/Command/Split.php new file mode 100644 index 000000000000..6959e6985ac7 --- /dev/null +++ b/dev/src/Split/Command/Split.php @@ -0,0 +1,172 @@ +cliBasePath = $cliBasePath; + $this->splitShell = sprintf(self::SPLIT_SHELL, $cliBasePath); + $this->components = sprintf(self::COMPONENT_BASE, $cliBasePath); + $this->manifest = sprintf(self::PATH_MANIFEST, $cliBasePath); + + $this->http = new Client; + $this->token = getenv(self::TOKEN_ENV); + + parent::__construct(); + } + + protected function configure() + { + $this->setName('split') + ->setDescription('Split subtree and push to various remotes.'); + } + + protected function execute(InputInterface $input, OutputInterface $output) + { + if (!getenv(self::TAG_ENV)) { + $output->writeln('This command should only be run inside a CI post-release process'); + return; + } + + $components = $this->getComponents($this->components); + + $tag = getenv(self::TAG_ENV); + + $parentTagSource = sprintf(self::PARENT_TAG_NAME, $tag); + + foreach ($components as $component) { + $output->writeln(''); + $output->writeln(sprintf('Starting on component %s', $component['id'])); + $output->writeln('------------'); + shell_exec(sprintf( + '%s %s %s', + $this->splitShell, + $component['prefix'], + $component['target'] + )); + + $target = $component['target']; + $matches = []; + preg_match(self::TARGET_REGEX, $target, $matches); + + $org = $matches[1]; + $repo = $matches[2]; + + $version = $this->getComponentVersion($this->manifest, $component['id']); + try { + new version($version); + } catch (SemVerException $e) { + $output->writeln(sprintf( + 'Component %s version %s is invalid.', + $component['id'], + $version + )); + continue; + } + + if ($this->doesTagExist($version, $org, $repo)) { + $output->writeln(sprintf( + 'Component %s already tagged at version %s', + $component['id'], + $version + )); + continue; + } + + $name = $component['displayName'] .' '. $version; + $notes = sprintf( + 'For release notes, please see the [associated Google Cloud PHP release](%s).', + $parentTagSource + ); + $this->createRelease($version, $org, $repo, $name, $notes); + + $output->writeln(sprintf( + 'Release %s created for component %s', + $version, + $component['id'] + )); + } + } + + private function doesTagExist($tagName, $org, $repo) + { + $res = $this->http->get(sprintf( + self::GITHUB_RELEASES_ENDPOINT, + $org, $repo, $tagName + ), [ + 'http_errors' => false, + 'auth' => [null, $this->token] + ]); + + return ($res->getStatusCode() === 200); + } + + private function createRelease($tagName, $org, $repo, $name, $notes) + { + $requestBody = [ + 'tag_name' => $tagName, + 'name' => $name, + 'body' => $notes + ]; + + $res = $this->http->post(sprintf( + self::GITHUB_RELEASE_CREATE_ENDPOINT, + $org, $repo + ), [ + 'http_errors' => false, + 'json' => $requestBody, + 'auth' => [null, $this->token] + ]); + } +} diff --git a/docs/contents/cloud-bigquery.json b/docs/contents/cloud-bigquery.json new file mode 100644 index 000000000000..1d92ef396619 --- /dev/null +++ b/docs/contents/cloud-bigquery.json @@ -0,0 +1,31 @@ +[{ + "title": "BigQueryClient", + "type": "bigquery/bigqueryclient" +}, { + "title": "Bytes", + "type": "bigquery/bytes" +}, { + "title": "Dataset", + "type": "bigquery/dataset" +}, { + "title": "Date", + "type": "bigquery/date" +}, { + "title": "InsertResponse", + "type": "bigquery/insertresponse" +}, { + "title": "Job", + "type": "bigquery/job" +}, { + "title": "QueryResults", + "type": "bigquery/queryresults" +}, { + "title": "Table", + "type": "bigquery/table" +}, { + "title": "Time", + "type": "bigquery/time" +}, { + "title": "Timestamp", + "type": "bigquery/timestamp" +}] diff --git a/docs/contents/cloud-core.json b/docs/contents/cloud-core.json new file mode 100644 index 000000000000..9779bf4b5c63 --- /dev/null +++ b/docs/contents/cloud-core.json @@ -0,0 +1,30 @@ +[{ + "title": "Overview", + "type": "core/readme" +}, { + "title": "IAM", + "type": "core/iam/iam", + "patterns": [ + "core/iam/\\w{1,}" + ], + "nav": [{ + "title": "PolicyBuilder", + "type": "core/iam/policybuilder" + }] +}, { + "title": "Upload", + "type": "core/upload/abstractuploader", + "nav": [{ + "title": "MultipartUploader", + "type": "core/upload/multipartuploader" + }, { + "title": "ResumableUploader", + "type": "core/upload/resumableuploader" + }, { + "title": "StreamableUploader", + "type": "core/upload/streamableuploader" + }] +}, { + "title": "Int64", + "type": "core/int64" +}] diff --git a/docs/contents/cloud-datastore.json b/docs/contents/cloud-datastore.json new file mode 100644 index 000000000000..aec83962d0d2 --- /dev/null +++ b/docs/contents/cloud-datastore.json @@ -0,0 +1,25 @@ +[{ + "title": "DatastoreClient", + "type": "datastore/datastoreclient" +}, { + "title": "Transaction", + "type": "datastore/transaction" +}, { + "title": "Entity", + "type": "datastore/entity" +}, { + "title": "Key", + "type": "datastore/key" +}, { + "title": "Query", + "type": "datastore/query/query" +}, { + "title": "GQL Query", + "type": "datastore/query/gqlquery" +}, { + "title": "GeoPoint", + "type": "datastore/geopoint" +}, { + "title": "Blob", + "type": "datastore/blob" +}] diff --git a/docs/contents/cloud-error-reporting.json b/docs/contents/cloud-error-reporting.json new file mode 100644 index 000000000000..a6f2d22170da --- /dev/null +++ b/docs/contents/cloud-error-reporting.json @@ -0,0 +1,20 @@ +[{ + "title": "Overview", + "type": "errorreporting/readme" +}, { + "title": "v1beta1", + "type": "errorreporting/v1beta1/readme", + "patterns": [ + "errorreporting/v1beta1/\\w{1,}" + ], + "nav": [{ + "title": "ErrorGroupServiceClient", + "type": "errorreporting/v1beta1/errorgroupserviceclient" + }, { + "title": "ErrorStatsServiceClient", + "type": "errorreporting/v1beta1/errorstatsserviceclient" + }, { + "title": "ReportErrorsServiceClient", + "type": "errorreporting/v1beta1/reporterrorsserviceclient" + }] +}] diff --git a/docs/contents/cloud-logging.json b/docs/contents/cloud-logging.json new file mode 100644 index 000000000000..8b40def8299f --- /dev/null +++ b/docs/contents/cloud-logging.json @@ -0,0 +1,35 @@ +[{ + "title": "LoggingClient", + "type": "logging/loggingclient" +}, { + "title": "Entry", + "type": "logging/entry" +}, { + "title": "Logger", + "type": "logging/logger" +}, { + "title": "Metric", + "type": "logging/metric" +},{ + "title": "PsrLogger", + "type": "logging/psrlogger" +},{ + "title": "Sink", + "type": "logging/sink" +}, { + "title": "v2", + "type": "logging/v2/readme", + "patterns": [ + "logging/v2/\\w{1,}" + ], + "nav": [{ + "title": "ConfigServiceV2Client", + "type": "logging/v2/configservicev2client" + }, { + "title": "LoggingServiceV2Client", + "type": "logging/v2/loggingservicev2client" + }, { + "title": "MetricsServiceV2Client", + "type": "logging/v2/metricsservicev2client" + }] +}] diff --git a/docs/contents/cloud-monitoring.json b/docs/contents/cloud-monitoring.json new file mode 100644 index 000000000000..092ed41613bc --- /dev/null +++ b/docs/contents/cloud-monitoring.json @@ -0,0 +1,17 @@ +[{ + "title": "Overview", + "type": "monitoring/readme" +}, { + "title": "v3", + "type": "monitoring/v3/readme", + "patterns": [ + "monitoring/v3/\\w{1,}" + ], + "nav": [{ + "title": "GroupServiceClient", + "type": "monitoring/v3/groupserviceclient" + }, { + "title": "MetricServiceClient", + "type": "monitoring/v3/metricserviceclient" + }] +}] diff --git a/docs/contents/cloud-natural-language.json b/docs/contents/cloud-natural-language.json new file mode 100644 index 000000000000..c9d82e7b35cd --- /dev/null +++ b/docs/contents/cloud-natural-language.json @@ -0,0 +1,7 @@ +[{ + "title": "NaturalLanguageClient", + "type": "naturallanguage/naturallanguageclient" +}, { + "title": "Annotation", + "type": "naturallanguage/annotation" +}] diff --git a/docs/contents/cloud-pubsub.json b/docs/contents/cloud-pubsub.json new file mode 100644 index 000000000000..ef5acc571971 --- /dev/null +++ b/docs/contents/cloud-pubsub.json @@ -0,0 +1,26 @@ +[{ + "title": "PubSubClient", + "type": "pubsub/pubsubclient" +}, { + "title": "Message", + "type": "pubsub/message" +}, { + "title": "Subscription", + "type": "pubsub/subscription" +}, { + "title": "Topic", + "type": "pubsub/topic" +}, { + "title": "v1", + "type": "pubsub/v1/readme", + "patterns": [ + "pubsub/v1/\\w{1,}" + ], + "nav": [{ + "title": "PublisherClient", + "type": "pubsub/v1/publisherclient" + }, { + "title": "SubscriberClient", + "type": "pubsub/v1/subscriberclient" + }] +}] diff --git a/docs/contents/cloud-speech.json b/docs/contents/cloud-speech.json new file mode 100644 index 000000000000..d433dce34a69 --- /dev/null +++ b/docs/contents/cloud-speech.json @@ -0,0 +1,17 @@ +[{ + "title": "SpeechClient", + "type": "speech/speechclient" +}, { + "title": "Operation", + "type": "speech/operation" +}, { + "title": "v1beta1", + "type": "speech/v1beta1/readme", + "patterns": [ + "speech/v1beta1/\\w{1,}" + ], + "nav": [{ + "title": "SpeechClient", + "type": "speech/v1beta1/speechclient" + }] +}] diff --git a/docs/contents/cloud-storage.json b/docs/contents/cloud-storage.json new file mode 100644 index 000000000000..0b7c36cbfd68 --- /dev/null +++ b/docs/contents/cloud-storage.json @@ -0,0 +1,13 @@ +[{ + "title": "StorageClient", + "type": "storage/storageclient" +}, { + "title": "ACL", + "type": "storage/acl" +}, { + "title": "Bucket", + "type": "storage/bucket" +}, { + "title": "StorageObject", + "type": "storage/storageobject" +}] diff --git a/docs/contents/cloud-translate.json b/docs/contents/cloud-translate.json new file mode 100644 index 000000000000..d829deaa0161 --- /dev/null +++ b/docs/contents/cloud-translate.json @@ -0,0 +1,4 @@ +[{ + "title": "TranslateClient", + "type": "translate/translateclient" +}] diff --git a/docs/contents/cloud-vision.json b/docs/contents/cloud-vision.json new file mode 100644 index 000000000000..1ffef7a6ec5f --- /dev/null +++ b/docs/contents/cloud-vision.json @@ -0,0 +1,34 @@ +[{ + "title": "VisionClient", + "type": "vision/visionclient" +}, { + "title": "Image", + "type": "vision/image" +}, { + "title": "Annotation", + "type": "vision/annotation", + "nav": [ + { + "title": "CropHint", + "type": "vision/annotation/crophint" + }, { + "title": "Document", + "type": "vision/annotation/document" + }, { + "title": "Entity", + "type": "vision/annotation/entity" + }, { + "title": "Face", + "type": "vision/annotation/face" + }, { + "title": "ImageProperties", + "type": "vision/annotation/imageproperties" + }, { + "title": "SafeSearch", + "type": "vision/annotation/safesearch" + }, { + "title": "Web", + "type": "vision/annotation/web" + } + ] +}] diff --git a/docs/contents/google-cloud.json b/docs/contents/google-cloud.json new file mode 100644 index 000000000000..ab88991df84b --- /dev/null +++ b/docs/contents/google-cloud.json @@ -0,0 +1,4 @@ +[{ + "title": "ServiceBuilder", + "type": "servicebuilder" +}] diff --git a/docs/home.html b/docs/home.html index 46eb81f7d874..82f9296f1687 100644 --- a/docs/home.html +++ b/docs/home.html @@ -22,7 +22,7 @@

  • - + PHP icon Read the Docs diff --git a/docs/manifest.json b/docs/manifest.json index 5fc7b1af8f4d..c68ca246b012 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -3,37 +3,139 @@ "friendlyLang": "PHP", "libraryTitle": "Google Cloud Client Library", "moduleName": "google-cloud-php", - "defaultService": "servicebuilder", - "matchPartialServiceId": true, "markdown": "php", - "versions": [ - "v0.23.0", - "v0.22.0", - "v0.21.1", - "v0.21.0", - "v0.20.2", - "v0.20.1", - "v0.20.0", - "v0.13.2", - "v0.13.1", - "v0.13.0", - "v0.12.0", - "v0.11.1", - "v0.11.0", - "v0.10.2", - "v0.10.1", - "v0.10.0", - "v0.9.0", - "v0.8.0", - "v0.7.1", - "v0.7.0", - "v0.6.0", - "v0.5.1", - "v0.5.0", - "v0.4.1", - "v0.4.0", - "v0.3.0", - "master" + "defaultModule": "google-cloud", + "modules": [ + { + "id": "google-cloud", + "name": "google/cloud", + "defaultService": "servicebuilder", + "versions": [ + "v0.23.0", + "v0.22.0", + "v0.21.1", + "v0.21.0", + "v0.20.2", + "v0.20.1", + "v0.20.0", + "v0.13.2", + "v0.13.1", + "v0.13.0", + "v0.12.0", + "v0.11.1", + "v0.11.0", + "v0.10.2", + "v0.10.1", + "v0.10.0", + "v0.9.0", + "v0.8.0", + "v0.7.1", + "v0.7.0", + "v0.6.0", + "v0.5.1", + "v0.5.0", + "v0.4.1", + "v0.4.0", + "v0.3.0", + "master" + ] + }, + { + "id": "cloud-bigquery", + "name": "google/cloud-bigquery", + "defaultService": "bigquery/bigqueryclient", + "versions": [ + "master" + ] + }, + { + "id": "cloud-core", + "name": "google/cloud-core", + "defaultService": "core/readme", + "versions": [ + "master" + ] + }, + { + "id": "cloud-datastore", + "name": "google/cloud-datastore", + "defaultService": "datastore/datastoreclient", + "versions": [ + "master" + ] + }, + { + "id": "cloud-error-reporting", + "name": "google/cloud-error-reporting", + "defaultService": "errorreporting/readme", + "versions": [ + "master" + ] + }, + { + "id": "cloud-logging", + "name": "google/cloud-logging", + "defaultService": "logging/loggingclient", + "versions": [ + "master" + ] + }, + { + "id": "cloud-monitoring", + "name": "google/cloud-monitoring", + "defaultService": "monitoring/readme", + "versions": [ + "master" + ] + }, + { + "id": "cloud-natural-language", + "name": "google/cloud-natural-language", + "defaultService": "naturallanguage/naturallanguageclient", + "versions": [ + "master" + ] + }, + { + "id": "cloud-pubsub", + "name": "google/cloud-pubsub", + "defaultService": "pubsub/pubsubclient", + "versions": [ + "master" + ] + }, + { + "id": "cloud-speech", + "name": "google/cloud-speech", + "defaultService": "speech/speechclient", + "versions": [ + "master" + ] + }, + { + "id": "cloud-storage", + "name": "google/cloud-storage", + "defaultService": "storage/storageclient", + "versions": [ + "master" + ] + }, + { + "id": "cloud-translate", + "name": "google/cloud-translate", + "defaultService": "translate/translateclient", + "versions": [ + "master" + ] + }, + { + "id": "cloud-vision", + "name": "google/cloud-vision", + "defaultService": "vision/visionclient", + "versions": [ + "master" + ] + } ], "content": "json", "home": "home.html", diff --git a/docs/toc.json b/docs/toc.json index b61475532810..853743a07998 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -30,242 +30,5 @@ "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/contributing/readme.md", "contents": "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/contributing/readme.md" }], - "services": [ - { - "title": "ServiceBuilder", - "type": "servicebuilder" - }, - { - "title": "BigQuery", - "type": "bigquery/bigqueryclient", - "nav": [{ - "title": "Bytes", - "type": "bigquery/bytes" - }, { - "title": "Dataset", - "type": "bigquery/dataset" - }, { - "title": "Date", - "type": "bigquery/date" - }, { - "title": "InsertResponse", - "type": "bigquery/insertresponse" - }, { - "title": "Job", - "type": "bigquery/job" - }, { - "title": "QueryResults", - "type": "bigquery/queryresults" - }, { - "title": "Table", - "type": "bigquery/table" - }, { - "title": "Time", - "type": "bigquery/time" - }, { - "title": "Timestamp", - "type": "bigquery/timestamp" - }] - }, - { - "title": "Datastore", - "type": "datastore/datastoreclient", - "nav": [{ - "title": "Transaction", - "type": "datastore/transaction" - }, { - "title": "Entity", - "type": "datastore/entity" - }, { - "title": "Key", - "type": "datastore/key" - }, { - "title": "Query", - "type": "datastore/query/query" - }, { - "title": "GQL Query", - "type": "datastore/query/gqlquery" - }, { - "title": "GeoPoint", - "type": "datastore/geopoint" - }, { - "title": "Blob", - "type": "datastore/blob" - }] - }, - { - "title": "Error Reporting", - "type": "errorreporting/readme", - "nav": [{ - "title": "v1beta1", - "type": "errorreporting/v1beta1/readme", - "nav": [{ - "title": "ErrorGroupServiceClient", - "type": "errorreporting/v1beta1/errorgroupserviceclient" - }, { - "title": "ErrorStatsServiceClient", - "type": "errorreporting/v1beta1/errorstatsserviceclient" - }, { - "title": "ReportErrorsServiceClient", - "type": "errorreporting/v1beta1/reporterrorsserviceclient" - }] - }] - }, - { - "title": "Logging", - "type": "logging/loggingclient", - "nav": [{ - "title": "Entry", - "type": "logging/entry" - }, { - "title": "Logger", - "type": "logging/logger" - }, { - "title": "Metric", - "type": "logging/metric" - },{ - "title": "PsrLogger", - "type": "logging/psrlogger" - },{ - "title": "Sink", - "type": "logging/sink" - }, { - "title": "v2", - "type": "logging/v2/readme", - "nav": [{ - "title": "ConfigServiceV2Client", - "type": "logging/v2/configservicev2client" - }, { - "title": "LoggingServiceV2Client", - "type": "logging/v2/loggingservicev2client" - }, { - "title": "MetricsServiceV2Client", - "type": "logging/v2/metricsservicev2client" - }] - }] - }, - { - "title": "Monitoring", - "type": "monitoring/readme", - "nav": [{ - "title": "v3", - "type": "monitoring/v3/readme", - "nav": [{ - "title": "GroupServiceClient", - "type": "monitoring/v3/groupserviceclient" - }, { - "title": "MetricServiceClient", - "type": "monitoring/v3/metricserviceclient" - }] - }] - }, - { - "title": "Natural Language", - "type": "naturallanguage/naturallanguageclient", - "nav": [{ - "title": "Annotation", - "type": "naturallanguage/annotation" - }] - }, - { - "title": "PubSub", - "type": "pubsub/pubsubclient", - "nav": [{ - "title": "Message", - "type": "pubsub/message" - }, - { - "title": "Subscription", - "type": "pubsub/subscription" - }, - { - "title": "Topic", - "type": "pubsub/topic" - }, { - "title": "v1", - "type": "pubsub/v1/readme", - "nav": [{ - "title": "PublisherClient", - "type": "pubsub/v1/publisherclient" - }, { - "title": "SubscriberClient", - "type": "pubsub/v1/subscriberclient" - }] - }] - }, - { - "title": "Speech", - "type": "speech/speechclient", - "nav": [{ - "title": "Operation", - "type": "speech/operation" - }, { - "title": "v1beta1", - "type": "speech/v1beta1/readme", - "nav": [{ - "title": "SpeechClient", - "type": "speech/v1beta1/speechclient" - }] - }] - }, - { - "title": "Storage", - "type": "storage/storageclient", - "nav": [{ - "title": "ACL", - "type": "storage/acl" - }, { - "title": "Bucket", - "type": "storage/bucket" - }, { - "title": "StorageObject", - "type": "storage/storageobject" - }] - }, - { - "title": "Translate", - "type": "translate/translateclient" - }, - { - "title": "Vision", - "type": "vision/visionclient", - "patterns": [ - "/vision" - ], - "nav": [{ - "title": "Image", - "type": "vision/image" - }, { - "title": "Annotation", - "type": "vision/annotation", - "patterns": [ - "/vision/annotation" - ], - "nav": [ - { - "title": "CropHint", - "type": "vision/annotation/crophint" - }, { - "title": "Document", - "type": "vision/annotation/document" - }, { - "title": "Entity", - "type": "vision/annotation/entity" - }, { - "title": "Face", - "type": "vision/annotation/face" - }, { - "title": "ImageProperties", - "type": "vision/annotation/imageproperties" - }, { - "title": "SafeSearch", - "type": "vision/annotation/safesearch" - }, { - "title": "Web", - "type": "vision/annotation/web" - } - ] - }] - } - ] + "services": [] } diff --git a/src/BigQuery/BigQueryClient.php b/src/BigQuery/BigQueryClient.php index 07d771be5a65..9f867b0f7a65 100644 --- a/src/BigQuery/BigQueryClient.php +++ b/src/BigQuery/BigQueryClient.php @@ -17,11 +17,11 @@ namespace Google\Cloud\BigQuery; -use Google\Cloud\ArrayTrait; +use Google\Cloud\Core\ArrayTrait; use Google\Cloud\BigQuery\Connection\ConnectionInterface; use Google\Cloud\BigQuery\Connection\Rest; -use Google\Cloud\ClientTrait; -use Google\Cloud\Int64; +use Google\Cloud\Core\ClientTrait; +use Google\Cloud\Core\Int64; use Psr\Cache\CacheItemPoolInterface; use Psr\Http\Message\StreamInterface; @@ -32,15 +32,6 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); - * - * $bigQuery = $cloud->bigQuery(); - * ``` - * - * ``` - * // BigQueryClient can be instantiated directly. * use Google\Cloud\BigQuery\BigQueryClient; * * $bigQuery = new BigQueryClient(); @@ -52,6 +43,8 @@ class BigQueryClient use ClientTrait; use JobConfigurationTrait; + const VERSION = 'master'; + const SCOPE = 'https://www.googleapis.com/auth/bigquery'; const INSERT_SCOPE = 'https://www.googleapis.com/auth/bigquery.insertdata'; @@ -90,7 +83,7 @@ class BigQueryClient * to** `3`. * @type array $scopes Scopes to be used for the request. * @type bool $returnInt64AsObject If true, 64 bit integers will be - * returned as a {@see Google\Cloud\Int64} object for 32 bit + * returned as a {@see Google\Cloud\Core\Int64} object for 32 bit * platform compatibility. **Defaults to** false. * } */ @@ -123,7 +116,7 @@ public function __construct(array $config = []) * | `\DateTimeInterface` | `DATETIME` | * | {@see Google\Cloud\BigQuery\Bytes} | `BYTES` | * | {@see Google\Cloud\BigQuery\Date} | `DATE` | - * | {@see Google\Cloud\Int64} | `INT64` | + * | {@see Google\Cloud\Core\Int64} | `INT64` | * | {@see Google\Cloud\BigQuery\Time} | `TIME` | * | {@see Google\Cloud\BigQuery\Timestamp} | `TIMESTAMP` | * | Associative Array | `STRUCT` | diff --git a/src/BigQuery/Bytes.php b/src/BigQuery/Bytes.php index 5a09c5a407a8..571f23d7222f 100644 --- a/src/BigQuery/Bytes.php +++ b/src/BigQuery/Bytes.php @@ -26,10 +26,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\BigQuery\BigQueryClient; * - * $cloud = new ServiceBuilder(); - * $bigQuery = $cloud->bigQuery(); + * $bigQuery = new BigQueryClient(); * * $bytes = $bigQuery->bytes('hello world'); * ``` diff --git a/src/BigQuery/Connection/ConnectionInterface.php b/src/BigQuery/Connection/ConnectionInterface.php index df0be5e51982..1350a66e2083 100644 --- a/src/BigQuery/Connection/ConnectionInterface.php +++ b/src/BigQuery/Connection/ConnectionInterface.php @@ -17,6 +17,8 @@ namespace Google\Cloud\BigQuery\Connection; +use Google\Cloud\Core\Upload\AbstractUploader; + /** * Represents a connection to * [BigQuery](https://cloud.google.com/bigquery/). diff --git a/src/BigQuery/Connection/Rest.php b/src/BigQuery/Connection/Rest.php index 50651f555310..dc5084580381 100644 --- a/src/BigQuery/Connection/Rest.php +++ b/src/BigQuery/Connection/Rest.php @@ -17,14 +17,15 @@ namespace Google\Cloud\BigQuery\Connection; +use Google\Cloud\BigQuery\BigQueryClient; use Google\Cloud\BigQuery\Connection\ConnectionInterface; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; -use Google\Cloud\RestTrait; -use Google\Cloud\Upload\AbstractUploader; -use Google\Cloud\Upload\MultipartUploader; -use Google\Cloud\Upload\ResumableUploader; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; +use Google\Cloud\Core\Upload\AbstractUploader; +use Google\Cloud\Core\Upload\MultipartUploader; +use Google\Cloud\Core\Upload\ResumableUploader; +use Google\Cloud\Core\UriTrait; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; @@ -46,7 +47,8 @@ class Rest implements ConnectionInterface public function __construct(array $config = []) { $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/bigquery-v2.json' + 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/bigquery-v2.json', + 'componentVersion' => BigQueryClient::VERSION ]; $this->setRequestWrapper(new RequestWrapper($config)); diff --git a/src/BigQuery/Dataset.php b/src/BigQuery/Dataset.php index ffd930a11fa7..bd453576e862 100644 --- a/src/BigQuery/Dataset.php +++ b/src/BigQuery/Dataset.php @@ -17,7 +17,7 @@ namespace Google\Cloud\BigQuery; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\BigQuery\Connection\ConnectionInterface; /** diff --git a/src/BigQuery/Date.php b/src/BigQuery/Date.php index 85d3f6fca4c3..ba5c1bad3a5d 100644 --- a/src/BigQuery/Date.php +++ b/src/BigQuery/Date.php @@ -23,10 +23,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\BigQuery\BigQueryClient; * - * $cloud = new ServiceBuilder(); - * $bigQuery = $cloud->bigQuery(); + * $bigQuery = new BigQueryClient(); * * $date = $bigQuery->date(new \DateTime('1995-02-04')); * ``` diff --git a/src/BigQuery/Job.php b/src/BigQuery/Job.php index 8ae4810ac1ca..ac09bf32b78f 100644 --- a/src/BigQuery/Job.php +++ b/src/BigQuery/Job.php @@ -17,7 +17,7 @@ namespace Google\Cloud\BigQuery; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\BigQuery\Connection\ConnectionInterface; /** diff --git a/src/BigQuery/LICENSE b/src/BigQuery/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/BigQuery/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/BigQuery/QueryResults.php b/src/BigQuery/QueryResults.php index f835b2080198..0b8b7de67c23 100644 --- a/src/BigQuery/QueryResults.php +++ b/src/BigQuery/QueryResults.php @@ -18,7 +18,7 @@ namespace Google\Cloud\BigQuery; use Google\Cloud\BigQuery\Connection\ConnectionInterface; -use Google\Cloud\Exception\GoogleException; +use Google\Cloud\Core\Exception\GoogleException; /** * QueryResults represent the result of a BigQuery SQL query. Read more at the @@ -95,7 +95,7 @@ public function __construct( * | `\DateTimeInterface` | `DATETIME` | * | {@see Google\Cloud\BigQuery\Bytes} | `BYTES` | * | {@see Google\Cloud\BigQuery\Date} | `DATE` | - * | {@see Google\Cloud\Int64} | `INTEGER` | + * | {@see Google\Cloud\Core\Int64} | `INTEGER` | * | {@see Google\Cloud\BigQuery\Time} | `TIME` | * | {@see Google\Cloud\BigQuery\Timestamp} | `TIMESTAMP` | * | Associative Array | `RECORD` | diff --git a/src/BigQuery/README.md b/src/BigQuery/README.md new file mode 100644 index 000000000000..1d3c2110c3d3 --- /dev/null +++ b/src/BigQuery/README.md @@ -0,0 +1,10 @@ +# Google Cloud PHP BigQuery + +> Idiomatic PHP client for [BigQuery](https://cloud.google.com/bigquery/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/bigquery/bigqueryclient) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/BigQuery/Table.php b/src/BigQuery/Table.php index 0d9b7502af0a..5f58ab142732 100644 --- a/src/BigQuery/Table.php +++ b/src/BigQuery/Table.php @@ -18,8 +18,9 @@ namespace Google\Cloud\BigQuery; use Google\Cloud\BigQuery\Connection\ConnectionInterface; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Storage\StorageObject; +use Psr\Http\Message\StreamInterface; /** * [BigQuery Tables](https://cloud.google.com/bigquery/docs/tables) are a @@ -252,7 +253,10 @@ public function copy(Table $destination, array $options = []) * * @see https://cloud.google.com/bigquery/docs/reference/v2/jobs Jobs insert API Documentation. * - * @param StorageObject $destination The destination object. + * @param string|StorageObject $destination The destination object. May be + * a {@see Google\Cloud\Storage\StorageObject} or a URI pointing to + * a Google Cloud Storage object in the format of + * `gs://{bucket-name}/{object-name}`. * @param array $options [optional] { * Configuration options. * @@ -262,15 +266,18 @@ public function copy(Table $destination, array $options = []) * } * @return Job */ - public function export(StorageObject $destination, array $options = []) + public function export($destination, array $options = []) { - $objIdentity = $destination->identity(); + if ($destination instanceof StorageObject) { + $destination = $destination->gcsUri(); + } + $config = $this->buildJobConfig( 'extract', $this->identity['projectId'], [ 'sourceTable' => $this->identity, - 'destinationUris' => ['gs://' . $objIdentity['bucket'] . '/' . $objIdentity['object']] + 'destinationUris' => [$destination] ], $options ); diff --git a/src/BigQuery/Time.php b/src/BigQuery/Time.php index 184282f8a456..42dc1935dca3 100644 --- a/src/BigQuery/Time.php +++ b/src/BigQuery/Time.php @@ -23,6 +23,10 @@ * * Example: * ``` + * use Google\Cloud\BigQuery\BigQueryClient; + * + * $bigQuery = new BigQueryClient(); + * * $time = $bigQuery->time(new \DateTime('12:15:00.482172')); * ``` */ diff --git a/src/BigQuery/Timestamp.php b/src/BigQuery/Timestamp.php index 76dcbcdf1ee3..88e9ad5ff34b 100644 --- a/src/BigQuery/Timestamp.php +++ b/src/BigQuery/Timestamp.php @@ -23,6 +23,10 @@ * * Example: * ``` + * use Google\Cloud\BigQuery\BigQueryClient; + * + * $bigQuery = new BigQueryClient(); + * * $timestamp = $bigQuery->timestamp(new \DateTime('2003-02-05 11:15:02.421827Z')); * ``` */ diff --git a/src/BigQuery/ValueMapper.php b/src/BigQuery/ValueMapper.php index 9121dcc2b584..ba5fa6f9dc79 100644 --- a/src/BigQuery/ValueMapper.php +++ b/src/BigQuery/ValueMapper.php @@ -17,8 +17,8 @@ namespace Google\Cloud\BigQuery; -use Google\Cloud\ArrayTrait; -use Google\Cloud\Int64; +use Google\Cloud\Core\ArrayTrait; +use Google\Cloud\Core\Int64; /** * Maps values to their expected BigQuery types. This class is intended for @@ -49,14 +49,14 @@ class ValueMapper /** * @var bool $returnInt64AsObject If true, 64 bit integers will be returned - * as a {@see Google\Cloud\Int64} object for 32 bit platform + * as a {@see Google\Cloud\Core\Int64} object for 32 bit platform * compatibility. */ private $returnInt64AsObject; /** * @param bool $returnInt64AsObject If true, 64 bit integers will be - * returned as a {@see Google\Cloud\Int64} object for 32 bit + * returned as a {@see Google\Cloud\Core\Int64} object for 32 bit * platform compatibility. */ public function __construct($returnInt64AsObject) diff --git a/src/BigQuery/composer.json b/src/BigQuery/composer.json new file mode 100644 index 000000000000..187c743879fa --- /dev/null +++ b/src/BigQuery/composer.json @@ -0,0 +1,26 @@ +{ + "name": "google/cloud-bigquery", + "description": "BigQuery Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*" + }, + "suggest": { + "google/cloud-storage": "Makes it easier to load data from Cloud Storage into BigQuery" + }, + "extra": { + "component": { + "displayName": "Google Cloud BigQuery", + "id": "cloud-bigquery", + "target": "GoogleCloudPlatform/google-cloud-php-bigquery.git", + "path": "src/BigQuery", + "entry": "BigQueryClient.php" + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\BigQuery\\": "" + } + } +} diff --git a/src/ArrayTrait.php b/src/Core/ArrayTrait.php similarity index 98% rename from src/ArrayTrait.php rename to src/Core/ArrayTrait.php index 0bb5d43b1f96..402507de987d 100644 --- a/src/ArrayTrait.php +++ b/src/Core/ArrayTrait.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; /** * Provides basic array helper methods. diff --git a/src/CallTrait.php b/src/Core/CallTrait.php similarity index 97% rename from src/CallTrait.php rename to src/Core/CallTrait.php index 0ed942e76c43..dd7485f52134 100644 --- a/src/CallTrait.php +++ b/src/Core/CallTrait.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; /** * Provide magic method support for fetching values from results diff --git a/src/ClientTrait.php b/src/Core/ClientTrait.php similarity index 97% rename from src/ClientTrait.php rename to src/Core/ClientTrait.php index 251016c593fd..4bf1083816d9 100644 --- a/src/ClientTrait.php +++ b/src/Core/ClientTrait.php @@ -15,15 +15,14 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; use Google\Auth\ApplicationDefaultCredentials; use Google\Auth\CredentialsLoader; use Google\Auth\Credentials\GCECredentials; use Google\Auth\HttpHandler\HttpHandlerFactory; -use Google\Cloud\Compute\Metadata; -use Google\Cloud\Exception\GoogleException; -use Google\Cloud\JsonTrait; +use Google\Cloud\Core\Compute\Metadata; +use Google\Cloud\Core\Exception\GoogleException; use GuzzleHttp\Psr7; /** diff --git a/src/Compute/Metadata.php b/src/Core/Compute/Metadata.php similarity index 93% rename from src/Compute/Metadata.php rename to src/Core/Compute/Metadata.php index b7424849de94..01dbd9267d40 100644 --- a/src/Compute/Metadata.php +++ b/src/Core/Compute/Metadata.php @@ -15,10 +15,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -namespace Google\Cloud\Compute; +namespace Google\Cloud\Core\Compute; -use Google\Cloud\Compute\Metadata\Readers\StreamReader; -use Google\Cloud\Compute\Metadata\Readers\ReaderInterface; +use Google\Cloud\Core\Compute\Metadata\Readers\StreamReader; +use Google\Cloud\Core\Compute\Metadata\Readers\ReaderInterface; /** * A library for accessing the Google Compute Engine (GCE) metadata. @@ -31,7 +31,7 @@ * * Example: * ``` - * use Google\Cloud\Compute\Metadata; + * use Google\Cloud\Core\Compute\Metadata; * * $metadata = new Metadata(); * $projectId = $metadata->getProjectId(); diff --git a/src/Compute/Metadata/Readers/ReaderInterface.php b/src/Core/Compute/Metadata/Readers/ReaderInterface.php similarity index 93% rename from src/Compute/Metadata/Readers/ReaderInterface.php rename to src/Core/Compute/Metadata/Readers/ReaderInterface.php index 1beb7ee9ff43..4f5f6f507d0f 100644 --- a/src/Compute/Metadata/Readers/ReaderInterface.php +++ b/src/Core/Compute/Metadata/Readers/ReaderInterface.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Compute\Metadata\Readers; +namespace Google\Cloud\Core\Compute\Metadata\Readers; /** * Defines a metadata reader implementation. diff --git a/src/Compute/Metadata/Readers/StreamReader.php b/src/Core/Compute/Metadata/Readers/StreamReader.php similarity index 96% rename from src/Compute/Metadata/Readers/StreamReader.php rename to src/Core/Compute/Metadata/Readers/StreamReader.php index 34431ba5fdf7..654a39c8de48 100644 --- a/src/Compute/Metadata/Readers/StreamReader.php +++ b/src/Core/Compute/Metadata/Readers/StreamReader.php @@ -15,7 +15,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -namespace Google\Cloud\Compute\Metadata\Readers; +namespace Google\Cloud\Core\Compute\Metadata\Readers; /** * A class only reading the metadata URL with an appropriate header. diff --git a/src/EmulatorTrait.php b/src/Core/EmulatorTrait.php similarity index 93% rename from src/EmulatorTrait.php rename to src/Core/EmulatorTrait.php index e70ca0252bf8..c6c6f6c40c41 100644 --- a/src/EmulatorTrait.php +++ b/src/Core/EmulatorTrait.php @@ -15,10 +15,10 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; /** * Provides common logic for configuring the usage of an emualtor. diff --git a/src/Exception/BadRequestException.php b/src/Core/Exception/BadRequestException.php similarity index 95% rename from src/Exception/BadRequestException.php rename to src/Core/Exception/BadRequestException.php index 7c0f71f020ed..52fcc88a0be4 100644 --- a/src/Exception/BadRequestException.php +++ b/src/Core/Exception/BadRequestException.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Exception; +namespace Google\Cloud\Core\Exception; /** * Exception thrown when a request fails due to an error in the request. diff --git a/src/Exception/ConflictException.php b/src/Core/Exception/ConflictException.php similarity index 95% rename from src/Exception/ConflictException.php rename to src/Core/Exception/ConflictException.php index 270c6ed3a4c3..aa127a41d637 100644 --- a/src/Exception/ConflictException.php +++ b/src/Core/Exception/ConflictException.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Exception; +namespace Google\Cloud\Core\Exception; /** * Exception thrown when a request fails due to a conflict. diff --git a/src/Exception/GoogleException.php b/src/Core/Exception/GoogleException.php similarity index 94% rename from src/Exception/GoogleException.php rename to src/Core/Exception/GoogleException.php index 1ffed2b2222e..e1ec78f0ed2c 100644 --- a/src/Exception/GoogleException.php +++ b/src/Core/Exception/GoogleException.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Exception; +namespace Google\Cloud\Core\Exception; use Exception; diff --git a/src/Exception/NotFoundException.php b/src/Core/Exception/NotFoundException.php similarity index 94% rename from src/Exception/NotFoundException.php rename to src/Core/Exception/NotFoundException.php index 90e511812437..f0a1f3139ed6 100644 --- a/src/Exception/NotFoundException.php +++ b/src/Core/Exception/NotFoundException.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Exception; +namespace Google\Cloud\Core\Exception; /** * Exception thrown when a resource is not found. diff --git a/src/Exception/ServerException.php b/src/Core/Exception/ServerException.php similarity index 95% rename from src/Exception/ServerException.php rename to src/Core/Exception/ServerException.php index 65ba4a6ee6b7..89388b52832d 100644 --- a/src/Exception/ServerException.php +++ b/src/Core/Exception/ServerException.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Exception; +namespace Google\Cloud\Core\Exception; /** * Exception thrown when a request fails due to an error on the server. diff --git a/src/Exception/ServiceException.php b/src/Core/Exception/ServiceException.php similarity index 97% rename from src/Exception/ServiceException.php rename to src/Core/Exception/ServiceException.php index 87ae111eac19..19a9e114c322 100644 --- a/src/Exception/ServiceException.php +++ b/src/Core/Exception/ServiceException.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Exception; +namespace Google\Cloud\Core\Exception; use Exception; diff --git a/src/ExponentialBackoff.php b/src/Core/ExponentialBackoff.php similarity index 99% rename from src/ExponentialBackoff.php rename to src/Core/ExponentialBackoff.php index 905c549819e6..8e34fe62a0ca 100644 --- a/src/ExponentialBackoff.php +++ b/src/Core/ExponentialBackoff.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; /** * Exponential backoff implementation. diff --git a/src/GrpcRequestWrapper.php b/src/Core/GrpcRequestWrapper.php similarity index 95% rename from src/GrpcRequestWrapper.php rename to src/Core/GrpcRequestWrapper.php index a76ea808d574..f7c7e2f8f938 100644 --- a/src/GrpcRequestWrapper.php +++ b/src/Core/GrpcRequestWrapper.php @@ -15,15 +15,15 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; use DrSlump\Protobuf\Codec\CodecInterface; use DrSlump\Protobuf\Message; use Google\Auth\FetchAuthTokenInterface; use Google\Auth\HttpHandler\HttpHandlerFactory; -use Google\Cloud\Exception; -use Google\Cloud\PhpArray; -use Google\Cloud\RequestWrapperTrait; +use Google\Cloud\Core\Exception; +use Google\Cloud\Core\PhpArray; +use Google\Cloud\Core\RequestWrapperTrait; use Google\GAX\ApiException; use Google\GAX\PagedListResponse; use Google\GAX\RetrySettings; @@ -66,8 +66,8 @@ class GrpcRequestWrapper /** * @param array $config [optional] { * Configuration options. Please see - * {@see Google\Cloud\RequestWrapperTrait::setCommonDefaults()} for the other - * available options. + * {@see Google\Cloud\Core\RequestWrapperTrait::setCommonDefaults()} for + * the other available options. * * @type callable $authHttpHandler A handler used to deliver Psr7 * requests specifically for authentication. diff --git a/src/GrpcTrait.php b/src/Core/GrpcTrait.php similarity index 95% rename from src/GrpcTrait.php rename to src/Core/GrpcTrait.php index 6aecb4314380..a3a61fb4e661 100644 --- a/src/GrpcTrait.php +++ b/src/Core/GrpcTrait.php @@ -15,15 +15,14 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; use DateTime; use DateTimeZone; use Google\Auth\FetchAuthTokenCache; use Google\Auth\Cache\MemoryCacheItemPool; -use Google\Cloud\ArrayTrait; -use Google\Cloud\GrpcRequestWrapper; -use Google\Cloud\ServiceBuilder; +use Google\Cloud\Core\ArrayTrait; +use Google\Cloud\Core\GrpcRequestWrapper; /** * Provides shared functionality for gRPC service implementations. @@ -70,13 +69,13 @@ public function send(callable $request, array $args) * * @return array */ - private function getGaxConfig() + private function getGaxConfig($version) { return [ 'credentialsLoader' => $this->requestWrapper->getCredentialsFetcher(), 'enableCaching' => false, 'libName' => 'gccl', - 'libVersion' => ServiceBuilder::VERSION + 'libVersion' => $version ]; } diff --git a/src/Iam/Iam.php b/src/Core/Iam/Iam.php similarity index 93% rename from src/Iam/Iam.php rename to src/Core/Iam/Iam.php index 70708fdd68f6..50c708dcdffe 100644 --- a/src/Iam/Iam.php +++ b/src/Core/Iam/Iam.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Iam; +namespace Google\Cloud\Core\Iam; /** * IAM Manager @@ -26,8 +26,8 @@ * Note that examples make use of the PubSub API, and the * {@see Google\Cloud\PubSub\Topic} class. * - * Policies can be created using the {@see Google\Cloud\Iam\PolicyBuilder} to - * help ensure their validity. + * Policies can be created using the {@see Google\Cloud\Core\Iam\PolicyBuilder} + * to help ensure their validity. * * Example: * ``` @@ -35,10 +35,9 @@ * // In this example, we'll use PubSub topics to demonstrate * // how IAM politices are managed. * - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\PubSub\PubSubClient; * - * $cloud = new ServiceBuilder; - * $pubsub = $cloud->pubsub(); + * $pubsub = new PubSubClient(); * $topic = $pubsub->topic('my-new-topic'); * * $iam = $topic->iam(); @@ -76,7 +75,8 @@ public function __construct(IamConnectionInterface $connection, $resource) * Get the existing IAM policy for this resource. * * If a policy has already been retrieved from the API, it will be returned. - * To fetch a fresh copy of the policy, use {@see Google\Cloud\Iam\Iam::reload()}. + * To fetch a fresh copy of the policy, use + * {@see Google\Cloud\Core\Iam\Iam::reload()}. * * Example: * ``` diff --git a/src/Iam/IamConnectionInterface.php b/src/Core/Iam/IamConnectionInterface.php similarity index 97% rename from src/Iam/IamConnectionInterface.php rename to src/Core/Iam/IamConnectionInterface.php index f475df94532f..6b15166ad763 100644 --- a/src/Iam/IamConnectionInterface.php +++ b/src/Core/Iam/IamConnectionInterface.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Iam; +namespace Google\Cloud\Core\Iam; /** * An interface defining how wrappers interact with their IAM implementations. diff --git a/src/Iam/PolicyBuilder.php b/src/Core/Iam/PolicyBuilder.php similarity index 98% rename from src/Iam/PolicyBuilder.php rename to src/Core/Iam/PolicyBuilder.php index aab7be22e10e..405b37ee90b2 100644 --- a/src/Iam/PolicyBuilder.php +++ b/src/Core/Iam/PolicyBuilder.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Iam; +namespace Google\Cloud\Core\Iam; use InvalidArgumentException; @@ -24,7 +24,7 @@ * * Example: * ``` - * use Google\Cloud\Iam\PolicyBuilder; + * use Google\Cloud\Core\Iam\PolicyBuilder; * * $builder = new PolicyBuilder(); * $builder->addBinding('roles/admin', [ 'user:admin@domain.com' ]); diff --git a/src/Int64.php b/src/Core/Int64.php similarity index 98% rename from src/Int64.php rename to src/Core/Int64.php index ee963118bcac..442dfeadd08e 100644 --- a/src/Int64.php +++ b/src/Core/Int64.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; /** * Represents a 64 bit integer. This can be useful when working on a 32 bit diff --git a/src/JsonTrait.php b/src/Core/JsonTrait.php similarity index 98% rename from src/JsonTrait.php rename to src/Core/JsonTrait.php index ef161b6fa394..84748d7dbf0c 100644 --- a/src/JsonTrait.php +++ b/src/Core/JsonTrait.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; /** * Provides wrappers for json_encode/json_decode that throw exceptions when an diff --git a/src/Core/LICENSE b/src/Core/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/Core/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/Logger/AppEngineFlexFormatter.php b/src/Core/Logger/AppEngineFlexFormatter.php similarity index 96% rename from src/Logger/AppEngineFlexFormatter.php rename to src/Core/Logger/AppEngineFlexFormatter.php index 815f9b6ae329..f3697e75102b 100644 --- a/src/Logger/AppEngineFlexFormatter.php +++ b/src/Core/Logger/AppEngineFlexFormatter.php @@ -14,9 +14,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -namespace Google\Cloud\Logger; +namespace Google\Cloud\Core\Logger; -use Google\Cloud\JsonTrait; +use Google\Cloud\Core\JsonTrait; use Monolog\Formatter\LineFormatter; /** diff --git a/src/Logger/AppEngineFlexHandler.php b/src/Core/Logger/AppEngineFlexHandler.php similarity index 98% rename from src/Logger/AppEngineFlexHandler.php rename to src/Core/Logger/AppEngineFlexHandler.php index 35c121d77890..78b5665f4038 100644 --- a/src/Logger/AppEngineFlexHandler.php +++ b/src/Core/Logger/AppEngineFlexHandler.php @@ -14,7 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -namespace Google\Cloud\Logger; +namespace Google\Cloud\Core\Logger; use Monolog\Formatter\FormatterInterface; use Monolog\Handler\StreamHandler; diff --git a/src/PhpArray.php b/src/Core/PhpArray.php similarity index 99% rename from src/PhpArray.php rename to src/Core/PhpArray.php index 984061bbbe3f..01bfa1ae578e 100644 --- a/src/PhpArray.php +++ b/src/Core/PhpArray.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; use DrSlump\Protobuf; use google\protobuf\Struct; diff --git a/src/Core/README.md b/src/Core/README.md new file mode 100644 index 000000000000..c7c01cf09003 --- /dev/null +++ b/src/Core/README.md @@ -0,0 +1,7 @@ +# Google Cloud PHP Core Libraries + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/RequestBuilder.php b/src/Core/RequestBuilder.php similarity index 98% rename from src/RequestBuilder.php rename to src/Core/RequestBuilder.php index e15928d6ccd6..38116422d3f8 100644 --- a/src/RequestBuilder.php +++ b/src/Core/RequestBuilder.php @@ -15,10 +15,8 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; -use Google\Cloud\JsonTrait; -use Google\Cloud\UriTrait; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use Psr\Http\Message\RequestInterface; diff --git a/src/RequestWrapper.php b/src/Core/RequestWrapper.php similarity index 91% rename from src/RequestWrapper.php rename to src/Core/RequestWrapper.php index 979118288f20..40d49cb4a980 100644 --- a/src/RequestWrapper.php +++ b/src/Core/RequestWrapper.php @@ -15,13 +15,11 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; use Google\Auth\FetchAuthTokenInterface; use Google\Auth\HttpHandler\HttpHandlerFactory; -use Google\Cloud\Exception; -use Google\Cloud\JsonTrait; -use Google\Cloud\RequestWrapperTrait; +use Google\Cloud\Core\RequestWrapperTrait; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7; use Psr\Http\Message\RequestInterface; @@ -36,6 +34,11 @@ class RequestWrapper use JsonTrait; use RequestWrapperTrait; + /** + * @var string + */ + private $componentVersion; + /** * @var string Access token used to sign requests. */ @@ -82,9 +85,13 @@ class RequestWrapper /** * @param array $config [optional] { * Configuration options. Please see - * {@see Google\Cloud\RequestWrapperTrait::setCommonDefaults()} for the other - * available options. + * {@see Google\Cloud\Core\RequestWrapperTrait::setCommonDefaults()} for + * the other available options. * + * @type string $componentName The name of the component from which the request + * originated. + * @type string $componentVersion The current version of the component from + * which the request originated. * @type string $accessToken Access token used to sign requests. * @type callable $authHttpHandler A handler used to deliver Psr7 * requests specifically for authentication. @@ -101,9 +108,11 @@ public function __construct(array $config = []) 'authHttpHandler' => null, 'httpHandler' => null, 'httpOptions' => [], - 'shouldSignRequest' => true + 'shouldSignRequest' => true, + 'componentVersion' => null ]; + $this->componentVersion = $config['componentVersion']; $this->accessToken = $config['accessToken']; $this->httpHandler = $config['httpHandler'] ?: HttpHandlerFactory::build(); $this->authHttpHandler = $config['authHttpHandler'] ?: $this->httpHandler; @@ -146,8 +155,8 @@ public function send(RequestInterface $request, array $options = []) private function applyHeaders(RequestInterface $request) { $headers = [ - 'User-Agent' => 'gcloud-php/' . ServiceBuilder::VERSION, - 'x-goog-api-client' => 'gl-php/' . phpversion() . ' gccl/' . ServiceBuilder::VERSION + 'User-Agent' => 'gcloud-php/' . $this->componentVersion, + 'x-goog-api-client' => 'gl-php/' . phpversion() . ' gccl/' . $this->componentVersion, ]; if ($this->shouldSignRequest) { diff --git a/src/RequestWrapperTrait.php b/src/Core/RequestWrapperTrait.php similarity index 99% rename from src/RequestWrapperTrait.php rename to src/Core/RequestWrapperTrait.php index 90bea8b03550..95990f5613a5 100644 --- a/src/RequestWrapperTrait.php +++ b/src/Core/RequestWrapperTrait.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; use Google\Auth\ApplicationDefaultCredentials; use Google\Auth\Cache\MemoryCacheItemPool; diff --git a/src/RestTrait.php b/src/Core/RestTrait.php similarity index 93% rename from src/RestTrait.php rename to src/Core/RestTrait.php index f7b493333d39..3bff556e07bb 100644 --- a/src/RestTrait.php +++ b/src/Core/RestTrait.php @@ -15,11 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; - -use Google\Cloud\JsonTrait; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; +namespace Google\Cloud\Core; /** * Provides shared functionality for REST service implementations. @@ -76,7 +72,7 @@ public function send($resource, $method, array $options = []) 'retries' => null ]); - return $this->jsonDecode( + return json_decode( $this->requestWrapper->send( $this->requestBuilder->build($resource, $method, $options), $requestOptions diff --git a/src/Upload/AbstractUploader.php b/src/Core/Upload/AbstractUploader.php similarity index 96% rename from src/Upload/AbstractUploader.php rename to src/Core/Upload/AbstractUploader.php index cb5fb73cd12e..05a3e9b5bcbf 100644 --- a/src/Upload/AbstractUploader.php +++ b/src/Core/Upload/AbstractUploader.php @@ -15,10 +15,10 @@ * limitations under the License. */ -namespace Google\Cloud\Upload; +namespace Google\Cloud\Core\Upload; -use Google\Cloud\RequestWrapper; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\UriTrait; use GuzzleHttp\Psr7; use Psr\Http\Message\StreamInterface; diff --git a/src/Upload/MultipartUploader.php b/src/Core/Upload/MultipartUploader.php similarity index 96% rename from src/Upload/MultipartUploader.php rename to src/Core/Upload/MultipartUploader.php index 0b77e5ab9338..34251a70c71f 100644 --- a/src/Upload/MultipartUploader.php +++ b/src/Core/Upload/MultipartUploader.php @@ -15,9 +15,9 @@ * limitations under the License. */ -namespace Google\Cloud\Upload; +namespace Google\Cloud\Core\Upload; -use Google\Cloud\JsonTrait; +use Google\Cloud\Core\JsonTrait; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; diff --git a/src/Upload/ResumableUploader.php b/src/Core/Upload/ResumableUploader.php similarity index 97% rename from src/Upload/ResumableUploader.php rename to src/Core/Upload/ResumableUploader.php index 787ede57c647..3d099cff04c6 100644 --- a/src/Upload/ResumableUploader.php +++ b/src/Core/Upload/ResumableUploader.php @@ -15,10 +15,10 @@ * limitations under the License. */ -namespace Google\Cloud\Upload; +namespace Google\Cloud\Core\Upload; -use Google\Cloud\Exception\GoogleException; -use Google\Cloud\JsonTrait; +use Google\Cloud\Core\Exception\GoogleException; +use Google\Cloud\Core\JsonTrait; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\LimitStream; use GuzzleHttp\Psr7\Request; diff --git a/src/Upload/StreamableUploader.php b/src/Core/Upload/StreamableUploader.php similarity index 98% rename from src/Upload/StreamableUploader.php rename to src/Core/Upload/StreamableUploader.php index 70013d84f227..3d876dc9502e 100644 --- a/src/Upload/StreamableUploader.php +++ b/src/Core/Upload/StreamableUploader.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Upload; +namespace Google\Cloud\Core\Upload; use Google\Cloud\Exception\GoogleException; use Google\Cloud\Exception\ServiceException; diff --git a/src/UriTrait.php b/src/Core/UriTrait.php similarity index 98% rename from src/UriTrait.php rename to src/Core/UriTrait.php index 6e0313488c5d..8b1df091ce06 100644 --- a/src/UriTrait.php +++ b/src/Core/UriTrait.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; use GuzzleHttp\Psr7; use Psr\Http\Message\UriInterface; diff --git a/src/ValidateTrait.php b/src/Core/ValidateTrait.php similarity index 98% rename from src/ValidateTrait.php rename to src/Core/ValidateTrait.php index a13c7e106e47..52c7343f4bec 100644 --- a/src/ValidateTrait.php +++ b/src/Core/ValidateTrait.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud; +namespace Google\Cloud\Core; use InvalidArgumentException; diff --git a/src/Core/composer.json b/src/Core/composer.json new file mode 100644 index 000000000000..cee03e142b4a --- /dev/null +++ b/src/Core/composer.json @@ -0,0 +1,28 @@ +{ + "name": "google/cloud-core", + "description": "Google Cloud PHP shared dependency, providing functionality useful to all components.", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "php": ">=5.5", + "rize/uri-template": "~0.3", + "google/auth": "^0.11", + "guzzlehttp/guzzle": "^5.3|^6.0", + "guzzlehttp/psr7": "^1.2", + "monolog/monolog": "~1", + "psr/http-message": "1.0.*" + }, + "extra": { + "component": { + "id": "cloud-core", + "target": "GoogleCloudPlatform/google-cloud-php-core.git", + "path": "src/Core", + "entry": null + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\Core\\": "" + } + } +} diff --git a/src/Datastore/Blob.php b/src/Datastore/Blob.php index 2af20fbeebb5..ceecf8b5cdb6 100644 --- a/src/Datastore/Blob.php +++ b/src/Datastore/Blob.php @@ -27,10 +27,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Datastore\DatastoreClient; * - * $cloud = new ServiceBuilder(); - * $datastore = $cloud->datastore(); + * $datastore = new DatastoreClient(); * * $blob = $datastore->blob(file_get_contents(__DIR__ .'/family-photo.jpg')); * ``` diff --git a/src/Datastore/Connection/Rest.php b/src/Datastore/Connection/Rest.php index 1b6e32cebace..0c0f54857976 100644 --- a/src/Datastore/Connection/Rest.php +++ b/src/Datastore/Connection/Rest.php @@ -17,11 +17,12 @@ namespace Google\Cloud\Datastore\Connection; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; -use Google\Cloud\EmulatorTrait; -use Google\Cloud\RestTrait; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\EmulatorTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; +use Google\Cloud\Core\UriTrait; +use Google\Cloud\Datastore\DatastoreClient; /** * Implementation of the @@ -45,7 +46,8 @@ public function __construct(array $config = []) $baseUri = $this->getEmulatorBaseUri(self::BASE_URI, $emulatorHost); $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/datastore-v1.json' + 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/datastore-v1.json', + 'componentVersion' => DatastoreClient::VERSION ]; $this->setRequestWrapper(new RequestWrapper($config)); diff --git a/src/Datastore/DatastoreClient.php b/src/Datastore/DatastoreClient.php index bbfcc6ebd98c..f10d2e6ffe1b 100644 --- a/src/Datastore/DatastoreClient.php +++ b/src/Datastore/DatastoreClient.php @@ -18,15 +18,16 @@ namespace Google\Cloud\Datastore; use DomainException; -use Google\Cloud\ClientTrait; +use Google\Cloud\Core\ClientTrait; use Google\Cloud\Datastore\Connection\Rest; use Google\Cloud\Datastore\Query\GqlQuery; use Google\Cloud\Datastore\Query\Query; use Google\Cloud\Datastore\Query\QueryBuilder; use Google\Cloud\Datastore\Query\QueryInterface; -use Google\Cloud\Int64; +use Google\Cloud\Core\Int64; use InvalidArgumentException; use Psr\Cache\CacheItemPoolInterface; +use Psr\Http\Message\StreamInterface; /** * Google Cloud Datastore is a highly-scalable NoSQL database for your @@ -47,15 +48,6 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); - * - * $datastore = $cloud->datastore(); - * ``` - * - * ``` - * // DatastoreClient can be instantiated directly. * use Google\Cloud\Datastore\DatastoreClient; * * $datastore = new DatastoreClient(); @@ -63,25 +55,22 @@ * * ``` * // Multi-tenant applications can supply a namespace ID. - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); + * use Google\Cloud\Datastore\DatastoreClient; * - * $datastore = $cloud->datastore([ + * $datastore = new DatastoreClient([ * 'namespaceId' => 'my-application-namespace' * ]); * ``` * * ``` * // Using the Datastore Emulator - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Datastore\DatastoreClient; * * // Be sure to use the port specified when starting the emulator. * // `8900` is used as an example only. * putenv('DATASTORE_EMULATOR_HOST=http://localhost:8900'); * - * $cloud = new ServiceBuilder(); - * $datastore = $cloud->datastore(); + * $datastore = new DatastoreClient(); * ``` */ class DatastoreClient @@ -89,6 +78,8 @@ class DatastoreClient use ClientTrait; use DatastoreTrait; + const VERSION = 'master'; + const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/datastore'; /** @@ -133,7 +124,7 @@ class DatastoreClient * @type string $namespaceId Partitions data under a namespace. Useful for * [Multitenant Projects](https://cloud.google.com/datastore/docs/concepts/multitenancy). * @type bool $returnInt64AsObject If true, 64 bit integers will be - * returned as a {@see Google\Cloud\Int64} object for 32 bit + * returned as a {@see Google\Cloud\Core\Int64} object for 32 bit * platform compatibility. **Defaults to** false. * } * @throws \InvalidArgumentException diff --git a/src/Datastore/DatastoreSessionHandler.php b/src/Datastore/DatastoreSessionHandler.php index e4248e27708f..d1793db25ce4 100644 --- a/src/Datastore/DatastoreSessionHandler.php +++ b/src/Datastore/DatastoreSessionHandler.php @@ -59,11 +59,9 @@ * * Example without error handling: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Datastore\DatastoreClient; * - * $cloud = new ServiceBuilder(); - * $datastore = $cloud->datastore(); - * // or just $datastore = new \Google\Cloud\Datastore\DatastoreClient(); + * $datastore = new DatastoreClient(); * * $handler = new DatastoreSessionHandler($datastore); * @@ -85,11 +83,9 @@ * Example with error handling: * * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Datastore\DatastoreClient; * - * $cloud = new ServiceBuilder(); - * $datastore = $cloud->datastore(); - * // or just $datastore = new \Google\Cloud\Datastore\DatastoreClient(); + * $datastore = new DatastoreClient; * * $handler = new DatastoreSessionHandler($datastore); * session_set_save_handler($handler, true); diff --git a/src/Datastore/Entity.php b/src/Datastore/Entity.php index bdc712745168..bcae7e4d61cc 100644 --- a/src/Datastore/Entity.php +++ b/src/Datastore/Entity.php @@ -37,7 +37,7 @@ * | {@see Google\Cloud\Datastore\GeoPoint} | `geoPointValue` | * | {@see Google\Cloud\Datastore\Entity} | `entityValue` | * | {@see Google\Cloud\Datastore\Blob} | `blobValue` | - * | {@see Google\Cloud\Int64} | `integerValue` | + * | {@see Google\Cloud\Core\Int64} | `integerValue` | * | Associative Array | `entityValue` (No Key) | * | Non-Associative Array | `arrayValue` | * | `float` | `doubleValue` | @@ -50,10 +50,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Datastore\DatastoreClient; * - * $cloud = new ServiceBuilder(); - * $datastore = $cloud->datastore(); + * $datastore = new DatastoreClient(); * * $key = $datastore->key('Person', 'Bob'); * $entity = $datastore->entity($key, [ diff --git a/src/Datastore/EntityMapper.php b/src/Datastore/EntityMapper.php index 83c97b0b6cb7..50e9b516d4aa 100644 --- a/src/Datastore/EntityMapper.php +++ b/src/Datastore/EntityMapper.php @@ -17,11 +17,11 @@ namespace Google\Cloud\Datastore; -use Google\Cloud\ArrayTrait; +use Google\Cloud\Core\ArrayTrait; use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\GeoPoint; use Google\Cloud\Datastore\Key; -use Google\Cloud\Int64; +use Google\Cloud\Core\Int64; use InvalidArgumentException; use RuntimeException; @@ -57,7 +57,7 @@ class EntityMapper * @param string $projectId The datastore project ID * @param bool $encode Whether to encode blobs as base64. * @param bool $returnInt64AsObject If true, 64 bit integers will be - * returned as a {@see Google\Cloud\Int64} object for 32 bit + * returned as a {@see Google\Cloud\Core\Int64} object for 32 bit * platform compatibility. */ public function __construct($projectId, $encode, $returnInt64AsObject) diff --git a/src/Datastore/GeoPoint.php b/src/Datastore/GeoPoint.php index ac03a29c1cfe..399988cce189 100644 --- a/src/Datastore/GeoPoint.php +++ b/src/Datastore/GeoPoint.php @@ -24,7 +24,11 @@ * * Example: * ``` - * $point = new GeoPoint(37.423147, -122.085015); + * use Google\Cloud\Datastore\DatastoreClient; + * + * $datastore = new DatastoreClient(); + * + * $point = $datastore->geoPoint(37.423147, -122.085015); * ``` * * @see https://cloud.google.com/datastore/reference/rest/Shared.Types/LatLng LatLng diff --git a/src/Datastore/Key.php b/src/Datastore/Key.php index 8e16d1bb7fcb..1341bfb0fec2 100644 --- a/src/Datastore/Key.php +++ b/src/Datastore/Key.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Datastore; -use Google\Cloud\ArrayTrait; +use Google\Cloud\Core\ArrayTrait; use InvalidArgumentException; use JsonSerializable; @@ -46,10 +46,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Datastore\DatastoreClient; * - * $cloud = new ServiceBuilder(); - * $datastore = $cloud->datastore(); + * $datastore = new DatastoreClient(); * * $key = $datastore->key('Person', 'Bob'); * ``` diff --git a/src/Datastore/LICENSE b/src/Datastore/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/Datastore/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/Datastore/Operation.php b/src/Datastore/Operation.php index 8372872b3cb5..358cbe9dcb31 100644 --- a/src/Datastore/Operation.php +++ b/src/Datastore/Operation.php @@ -20,7 +20,7 @@ use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\Connection\Rest; use Google\Cloud\Datastore\Query\QueryInterface; -use Google\Cloud\ValidateTrait; +use Google\Cloud\Core\ValidateTrait; use InvalidArgumentException; /** diff --git a/src/Datastore/Query/GqlQuery.php b/src/Datastore/Query/GqlQuery.php index 646e47b22a24..ece8bedbe126 100644 --- a/src/Datastore/Query/GqlQuery.php +++ b/src/Datastore/Query/GqlQuery.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Datastore\Query; -use Google\Cloud\ArrayTrait; +use Google\Cloud\Core\ArrayTrait; use Google\Cloud\Datastore\DatastoreTrait; use Google\Cloud\Datastore\EntityMapper; use InvalidArgumentException; @@ -35,10 +35,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Datastore\DatastoreClient; * - * $cloud = new ServiceBuilder(); - * $datastore = $cloud->datastore(); + * $datastore = new DatastoreClient(); * * $query = $datastore->gqlQuery('SELECT * FROM Companies WHERE companyName = @companyName', [ * 'bindings' => [ diff --git a/src/Datastore/Query/Query.php b/src/Datastore/Query/Query.php index dbc3e3f6b7e3..9b89c948d9e6 100644 --- a/src/Datastore/Query/Query.php +++ b/src/Datastore/Query/Query.php @@ -31,10 +31,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Datastore\DatastoreClient; * - * $cloud = new ServiceBuilder(); - * $datastore = $cloud->datastore(); + * $datastore = new DatastoreClient(); * * $query = $datastore->query(); * $query->kind('Companies'); diff --git a/src/Datastore/README.md b/src/Datastore/README.md new file mode 100644 index 000000000000..afb2e4580697 --- /dev/null +++ b/src/Datastore/README.md @@ -0,0 +1,10 @@ +# Google Cloud PHP Datastore + +> Idiomatic PHP client for [Cloud Datastore](https://cloud.google.com/datastore/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/datastore/datastoreclient) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/Datastore/Transaction.php b/src/Datastore/Transaction.php index d2e24529b70b..229bcf910074 100644 --- a/src/Datastore/Transaction.php +++ b/src/Datastore/Transaction.php @@ -46,10 +46,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Datastore\DatastoreClient; * - * $cloud = new ServiceBuilder(); - * $datastore = $cloud->datastore(); + * $datastore = new DatastoreClient(); * * $transaction = $datastore->transaction(); * ``` diff --git a/src/Datastore/composer.json b/src/Datastore/composer.json new file mode 100644 index 000000000000..8054c0258b0d --- /dev/null +++ b/src/Datastore/composer.json @@ -0,0 +1,22 @@ +{ + "name": "google/cloud-datastore", + "description": "Cloud Datastore Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*" + }, + "extra": { + "component": { + "id": "cloud-datastore", + "target": "GoogleCloudPlatform/google-cloud-php-datastore.git", + "path": "src/Datastore", + "entry": "DatastoreClient.php" + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\Datastore\\": "" + } + } +} diff --git a/src/ErrorReporting/README.md b/src/ErrorReporting/README.md index 6d2df572ba92..30bf0d58711d 100644 --- a/src/ErrorReporting/README.md +++ b/src/ErrorReporting/README.md @@ -3,3 +3,6 @@ Stackdriver Error Reporting counts, analyzes and aggregates the crashes in your running cloud services. For more information, see [cloud.google.com](https://cloud.google.com/error-reporting/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/error-reporting/readme) diff --git a/src/ErrorReporting/composer.json b/src/ErrorReporting/composer.json new file mode 100644 index 000000000000..baa66c84d353 --- /dev/null +++ b/src/ErrorReporting/composer.json @@ -0,0 +1,24 @@ +{ + "name": "google/cloud-error-reporting", + "description": "Stackdriver Error Reporting Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*", + "google/proto-client-php": "^0.9", + "google/gax": "^0.8" + }, + "extra": { + "component": { + "id": "cloud-error-reporting", + "target": "GoogleCloudPlatform/google-cloud-php-errorreporting.git", + "path": "src/ErrorReporting", + "entry": null + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\ErrorReporting\\": "" + } + } +} diff --git a/src/Logging/Connection/Grpc.php b/src/Logging/Connection/Grpc.php index b9fc8f6d43dd..77613d1ae4f1 100644 --- a/src/Logging/Connection/Grpc.php +++ b/src/Logging/Connection/Grpc.php @@ -18,13 +18,14 @@ namespace Google\Cloud\Logging\Connection; use DrSlump\Protobuf\Codec\CodecInterface; +use Google\Cloud\Core\GrpcRequestWrapper; +use Google\Cloud\Core\GrpcTrait; +use Google\Cloud\Core\PhpArray; use Google\Cloud\Logging\Logger; +use Google\Cloud\Logging\LoggingClient; use Google\Cloud\Logging\V2\ConfigServiceV2Client; use Google\Cloud\Logging\V2\LoggingServiceV2Client; use Google\Cloud\Logging\V2\MetricsServiceV2Client; -use Google\Cloud\PhpArray; -use Google\Cloud\GrpcRequestWrapper; -use Google\Cloud\GrpcTrait; use google\logging\v2\LogEntry; use google\logging\v2\LogMetric; use google\logging\v2\LogSink; @@ -101,7 +102,7 @@ public function __construct(array $config = []) ]); $config['codec'] = $this->codec; $this->setRequestWrapper(new GrpcRequestWrapper($config)); - $gaxConfig = $this->getGaxConfig(); + $gaxConfig = $this->getGaxConfig(LoggingClient::VERSION); $this->configClient = new ConfigServiceV2Client($gaxConfig); $this->loggingClient = new LoggingServiceV2Client($gaxConfig); diff --git a/src/Logging/Connection/Rest.php b/src/Logging/Connection/Rest.php index 2529d3b9c70c..2307bbb83d6f 100644 --- a/src/Logging/Connection/Rest.php +++ b/src/Logging/Connection/Rest.php @@ -17,10 +17,11 @@ namespace Google\Cloud\Logging\Connection; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; -use Google\Cloud\RestTrait; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; +use Google\Cloud\Core\UriTrait; +use Google\Cloud\Logging\LoggingClient; /** * Implementation of the @@ -39,7 +40,8 @@ class Rest implements ConnectionInterface public function __construct(array $config = []) { $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/logging-v2.json' + 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/logging-v2.json', + 'componentVersion' => LoggingClient::VERSION ]; $this->setRequestWrapper(new RequestWrapper($config)); diff --git a/src/Logging/Entry.php b/src/Logging/Entry.php index c20b161f4697..4f7bbbfc6675 100644 --- a/src/Logging/Entry.php +++ b/src/Logging/Entry.php @@ -24,10 +24,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Logging\LoggingClient; * - * $cloud = new ServiceBuilder(); - * $logging = $cloud->logging(); + * $logging = new LoggingClient(); * * $logger = $logging->logger('my-log'); * diff --git a/src/Logging/LICENSE b/src/Logging/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/Logging/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/Logging/Logger.php b/src/Logging/Logger.php index ac77e9bfc57c..4f95cb603bf9 100644 --- a/src/Logging/Logger.php +++ b/src/Logging/Logger.php @@ -17,19 +17,18 @@ namespace Google\Cloud\Logging; -use Google\Cloud\ArrayTrait; +use Google\Cloud\Core\ArrayTrait; use Google\Cloud\Logging\Connection\ConnectionInterface; -use Google\Cloud\ValidateTrait; +use Google\Cloud\Core\ValidateTrait; /** * A logger used to write entries to Google Stackdriver Logging. * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Logging\LoggingClient; * - * $cloud = new ServiceBuilder(); - * $logging = $cloud->logging(); + * $logging = new LoggingClient(); * * $logger = $logging->logger('my-log'); * ``` diff --git a/src/Logging/LoggingClient.php b/src/Logging/LoggingClient.php index ca537f2fde4a..35c091e92c70 100644 --- a/src/Logging/LoggingClient.php +++ b/src/Logging/LoggingClient.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Logging; -use Google\Cloud\ClientTrait; +use Google\Cloud\Core\ClientTrait; use Google\Cloud\Logging\Connection\ConnectionInterface; use Google\Cloud\Logging\Connection\Grpc; use Google\Cloud\Logging\Connection\Rest; @@ -54,14 +54,6 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); - * $logging = $cloud->logging(); - * ``` - * - * ``` - * // LoggingClient can be instantiated directly. * use Google\Cloud\Logging\LoggingClient; * * $logging = new LoggingClient(); @@ -71,6 +63,8 @@ class LoggingClient { use ClientTrait; + const VERSION = 'master'; + const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/logging.admin'; const READ_ONLY_SCOPE = 'https://www.googleapis.com/auth/logging.read'; const WRITE_ONLY_SCOPE = 'https://www.googleapis.com/auth/logging.write'; diff --git a/src/Logging/Metric.php b/src/Logging/Metric.php index f3e8b7a22211..cae8460fa474 100644 --- a/src/Logging/Metric.php +++ b/src/Logging/Metric.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Logging; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Logging\Connection\ConnectionInterface; /** @@ -27,10 +27,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Logging\LoggingClient; * - * $cloud = new ServiceBuilder(); - * $logging = $cloud->logging(); + * $logging = new LoggingClient(); * * $metric = $logging->metric('my-metric'); * ``` diff --git a/src/Logging/PsrLogger.php b/src/Logging/PsrLogger.php index 684a5af050a9..078fac1bef19 100644 --- a/src/Logging/PsrLogger.php +++ b/src/Logging/PsrLogger.php @@ -28,10 +28,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Logging\LoggingClient; * - * $cloud = new ServiceBuilder(); - * $logging = $cloud->logging(); + * $logging = new LoggingClient(); * * $psrLogger = $logging->psrLogger('my-log'); * ``` diff --git a/src/Logging/README.md b/src/Logging/README.md new file mode 100644 index 000000000000..e056e7290377 --- /dev/null +++ b/src/Logging/README.md @@ -0,0 +1,10 @@ +# Google Cloud PHP Logging + +> Idiomatic PHP client for [Stackdriver Logging](https://cloud.google.com/logging/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/logging/loggingclient) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/Logging/Sink.php b/src/Logging/Sink.php index 89f24c4430fb..b8107af0064b 100644 --- a/src/Logging/Sink.php +++ b/src/Logging/Sink.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Logging; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Logging\Connection\ConnectionInterface; /** @@ -25,10 +25,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Logging\LoggingClient; * - * $cloud = new ServiceBuilder(); - * $logging = $cloud->logging(); + * $logging = new LoggingClient(); * * $sink = $logging->sink('my-sink'); * ``` diff --git a/src/Logging/composer.json b/src/Logging/composer.json new file mode 100644 index 000000000000..e5ae270c3771 --- /dev/null +++ b/src/Logging/composer.json @@ -0,0 +1,26 @@ +{ + "name": "google/cloud-logging", + "description": "Stackdriver Logging Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*" + }, + "suggest": { + "google/gax": "Required to support gRPC", + "google/proto-client-php": "Required to support gRPC" + }, + "extra": { + "component": { + "id": "cloud-logging", + "target": "GoogleCloudPlatform/google-cloud-php-logging.git", + "path": "src/Logging", + "entry": "LoggingClient.php" + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\Logging\\": "" + } + } +} diff --git a/src/Monitoring/LICENSE b/src/Monitoring/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/Monitoring/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/Monitoring/README.md b/src/Monitoring/README.md index b6936242f5b0..72d320c64049 100644 --- a/src/Monitoring/README.md +++ b/src/Monitoring/README.md @@ -3,3 +3,6 @@ Stackdriver Monitoring provides visibility into the performance, uptime, and overall health of cloud-powered applications. For more information, see [cloud.google.com](https://cloud.google.com/monitoring/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/monitoring/v3/metricserviceclient) diff --git a/src/Monitoring/composer.json b/src/Monitoring/composer.json new file mode 100644 index 000000000000..9ed5a34bcfb0 --- /dev/null +++ b/src/Monitoring/composer.json @@ -0,0 +1,24 @@ +{ + "name": "google/cloud-monitoring", + "description": "Stackdriver Monitoring Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*", + "google/proto-client-php": "^0.9", + "google/gax": "^0.8" + }, + "extra": { + "component": { + "id": "cloud-monitoring", + "target": "GoogleCloudPlatform/google-cloud-php-monitoring.git", + "path": "src/Monitoring", + "entry": null + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\Monitoring\\": "" + } + } +} diff --git a/src/NaturalLanguage/Annotation.php b/src/NaturalLanguage/Annotation.php index 0d1616b7b248..de2739e83ee4 100644 --- a/src/NaturalLanguage/Annotation.php +++ b/src/NaturalLanguage/Annotation.php @@ -17,7 +17,7 @@ namespace Google\Cloud\NaturalLanguage; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; /** * Annotations represent the result of a request against the @@ -36,10 +36,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\NaturalLanguage\NaturalLanguageClient; * - * $cloud = new ServiceBuilder(); - * $language = $cloud->naturalLanguage(); + * $language = new NaturalLanguageClient(); * * $annotation = $language->annotateText('Google Cloud Platform is a powerful tool.'); * ``` diff --git a/src/NaturalLanguage/Connection/Rest.php b/src/NaturalLanguage/Connection/Rest.php index 01d2622c62e1..7b34d7656546 100644 --- a/src/NaturalLanguage/Connection/Rest.php +++ b/src/NaturalLanguage/Connection/Rest.php @@ -17,10 +17,11 @@ namespace Google\Cloud\NaturalLanguage\Connection; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; -use Google\Cloud\RestTrait; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; +use Google\Cloud\Core\UriTrait; +use Google\Cloud\NaturalLanguage\NaturalLanguageClient; /** * Implementation of the @@ -39,7 +40,8 @@ class Rest implements ConnectionInterface public function __construct(array $config = []) { $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/language-v1.json' + 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/language-v1.json', + 'componentVersion' => NaturalLanguageClient::VERSION ]; $this->setRequestWrapper(new RequestWrapper($config)); diff --git a/src/NaturalLanguage/LICENSE b/src/NaturalLanguage/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/NaturalLanguage/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/NaturalLanguage/NaturalLanguageClient.php b/src/NaturalLanguage/NaturalLanguageClient.php index 2b3001e52b69..7af4af6d81f1 100644 --- a/src/NaturalLanguage/NaturalLanguageClient.php +++ b/src/NaturalLanguage/NaturalLanguageClient.php @@ -17,7 +17,7 @@ namespace Google\Cloud\NaturalLanguage; -use Google\Cloud\ClientTrait; +use Google\Cloud\Core\ClientTrait; use Google\Cloud\NaturalLanguage\Connection\ConnectionInterface; use Google\Cloud\NaturalLanguage\Connection\Rest; use Google\Cloud\Storage\StorageObject; @@ -32,15 +32,6 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); - * - * $language = $cloud->naturalLanguage(); - * ``` - * - * ``` - * // NaturalLanguage can be instantiated directly. * use Google\Cloud\NaturalLanguage\NaturalLanguageClient; * * $language = new NaturalLanguageClient(); @@ -50,6 +41,8 @@ class NaturalLanguageClient { use ClientTrait; + const VERSION = 'master'; + const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/cloud-platform'; /** @@ -120,11 +113,18 @@ public function __construct(array $config = []) * @see https://cloud.google.com/natural-language/docs/reference/rest/v1beta1/documents/analyzeEntities Analyze Entities API documentation * @codingStandardsIgnoreEnd * - * @param string|StorageObject $content The content to analyze. When - * providing a string it should be UTF-8 encoded. + * @param string|StorageObject $content The content to analyze. May be + * either a string of UTF-8 encoded content, a URI pointing to a + * Google Cloud Storage object in the format of + * `gs://{bucket-name}/{object-name}` or a + * {@see Google\Cloud\Storage\StorageObject}. * @param array $options [optional] { * Configuration options. * + * @type bool $detectGcsUri When providing $content as a string, this + * flag determines whether or not to attempt to detect if the + * string represents a Google Cloud Storage URI in the format of + * `gs://{bucket-name}/{object-name}`. **Defaults to** `true`. * @type string $type The document type. Acceptable values are * `PLAIN_TEXT` or `HTML`. **Defaults to** `"PLAIN_TEXT"`. * @type string $language The language of the document. Both ISO @@ -170,11 +170,18 @@ public function analyzeEntities($content, array $options = []) * @see https://cloud.google.com/natural-language/docs/reference/rest/v1beta1/documents/analyzeSentiment Analyze Sentiment API documentation * @codingStandardsIgnoreEnd * - * @param string|StorageObject $content The content to analyze. When - * providing a string it should be UTF-8 encoded. + * @param string|StorageObject $content The content to analyze. May be + * either a string of UTF-8 encoded content, a URI pointing to a + * Google Cloud Storage object in the format of + * `gs://{bucket-name}/{object-name}` or a + * {@see Google\Cloud\Storage\StorageObject}. * @param array $options [optional] { * Configuration options. * + * @type bool $detectGcsUri When providing $content as a string, this + * flag determines whether or not to attempt to detect if the + * string represents a Google Cloud Storage URI in the format of + * `gs://{bucket-name}/{object-name}`. **Defaults to** `true`. * @type string $type The document type. Acceptable values are * `PLAIN_TEXT` or `HTML`. **Defaults to** `"PLAIN_TEXT"`. * @type string $language The language of the document. Both ISO @@ -219,11 +226,18 @@ public function analyzeSentiment($content, array $options = []) * @see https://cloud.google.com/natural-language/docs/reference/rest/v1beta1/documents/analyzeSyntax Analyze Syntax API documentation * @codingStandardsIgnoreEnd * - * @param string|StorageObject $content The content to analyze. When - * providing a string it should be UTF-8 encoded. + * @param string|StorageObject $content The content to analyze. May be + * either a string of UTF-8 encoded content, a URI pointing to a + * Google Cloud Storage object in the format of + * `gs://{bucket-name}/{object-name}` or a + * {@see Google\Cloud\Storage\StorageObject}. * @param array $options [optional] { * Configuration options. * + * @type bool $detectGcsUri When providing $content as a string, this + * flag determines whether or not to attempt to detect if the + * string represents a Google Cloud Storage URI in the format of + * `gs://{bucket-name}/{object-name}`. **Defaults to** `true`. * @type string $type The document type. Acceptable values are * `PLAIN_TEXT` or `HTML`. **Defaults to** `"PLAIN_TEXT"`. * @type string $language The language of the document. Both ISO @@ -280,11 +294,18 @@ public function analyzeSyntax($content, array $options = []) * @see https://cloud.google.com/natural-language/docs/reference/rest/v1beta1/documents/annotateText Annotate Text API documentation * @codingStandardsIgnoreEnd * - * @param string|StorageObject $content The content to analyze. When - * providing a string it should be UTF-8 encoded. + * @param string|StorageObject $content The content to analyze. May be + * either a string of UTF-8 encoded content, a URI pointing to a + * Google Cloud Storage object in the format of + * `gs://{bucket-name}/{object-name}` or a + * {@see Google\Cloud\Storage\StorageObject}. * @param array $options [optional] { * Configuration options. * + * @type bool $detectGcsUri When providing $content as a string, this + * flag determines whether or not to attempt to detect if the + * string represents a Google Cloud Storage URI in the format of + * `gs://{bucket-name}/{object-name}`. **Defaults to** `true`. * @type array $features Features to apply to the request. Valid values * are `syntax`, `sentiment`, and `entities`. If no features are * provided the request will run with all three enabled. @@ -354,16 +375,20 @@ private function formatRequest($content, array $options) $docOptions = ['type', 'language', 'content', 'gcsContentUri']; $options += [ 'encodingType' => 'UTF8', - 'type' => 'PLAIN_TEXT' + 'type' => 'PLAIN_TEXT', + 'detectGcsUri' => true ]; if ($content instanceof StorageObject) { - $objIdentity = $content->identity(); - $options['gcsContentUri'] = 'gs://' . $objIdentity['bucket'] . '/' . $objIdentity['object']; + $options['gcsContentUri'] = $content->gcsUri(); + } elseif ($options['detectGcsUri'] && substr($content, 0, 5) === 'gs://') { + $options['gcsContentUri'] = $content; } else { $options['content'] = $content; } + unset($options['detectGcsUri']); + foreach ($options as $option => $value) { if (in_array($option, $docOptions)) { $options['document'][$option] = $value; diff --git a/src/NaturalLanguage/README.md b/src/NaturalLanguage/README.md new file mode 100644 index 000000000000..b20f42e2f538 --- /dev/null +++ b/src/NaturalLanguage/README.md @@ -0,0 +1,10 @@ +# Google Cloud PHP Natural Language + +> Idiomatic PHP client for [Cloud Natural Language](https://cloud.google.com/natural-language/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/naturallanguage/naturallanguageclient) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/NaturalLanguage/composer.json b/src/NaturalLanguage/composer.json new file mode 100644 index 000000000000..a56720b04807 --- /dev/null +++ b/src/NaturalLanguage/composer.json @@ -0,0 +1,25 @@ +{ + "name": "google/cloud-natural-language", + "description": "Cloud Natural Language Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*" + }, + "suggest": { + "google/cloud-storage": "Analyze documents stored in Google Cloud Storage" + }, + "extra": { + "component": { + "id": "cloud-natural-language", + "target": "GoogleCloudPlatform/google-cloud-php-naturallanguage.git", + "path": "src/NaturalLanguage", + "entry": "NaturalLanguageClient.php" + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\NaturalLanguage\\": "" + } + } +} diff --git a/src/PubSub/Connection/Grpc.php b/src/PubSub/Connection/Grpc.php index 3731bfb88812..622219af2f24 100644 --- a/src/PubSub/Connection/Grpc.php +++ b/src/PubSub/Connection/Grpc.php @@ -18,12 +18,13 @@ namespace Google\Cloud\PubSub\Connection; use DrSlump\Protobuf\Codec\CodecInterface; -use Google\Cloud\EmulatorTrait; -use Google\Cloud\PhpArray; +use Google\Cloud\Core\EmulatorTrait; +use Google\Cloud\Core\GrpcRequestWrapper; +use Google\Cloud\Core\GrpcTrait; +use Google\Cloud\Core\PhpArray; +use Google\Cloud\PubSub\PubSubClient; use Google\Cloud\PubSub\V1\PublisherClient; use Google\Cloud\PubSub\V1\SubscriberClient; -use Google\Cloud\GrpcRequestWrapper; -use Google\Cloud\GrpcTrait; use Grpc\ChannelCredentials; use google\iam\v1\Policy; use google\pubsub\v1\PubsubMessage; @@ -65,7 +66,7 @@ public function __construct(array $config = []) }]); $config['codec'] = $this->codec; $this->setRequestWrapper(new GrpcRequestWrapper($config)); - $grpcConfig = $this->getGaxConfig(); + $grpcConfig = $this->getGaxConfig(PubSubClient::VERSION); $emulatorHost = getenv('PUBSUB_EMULATOR_HOST'); $baseUri = $this->getEmulatorBaseUri(self::BASE_URI, $emulatorHost); diff --git a/src/PubSub/Connection/IamSubscription.php b/src/PubSub/Connection/IamSubscription.php index 261a8d948a19..e4693f23dcd8 100644 --- a/src/PubSub/Connection/IamSubscription.php +++ b/src/PubSub/Connection/IamSubscription.php @@ -17,7 +17,7 @@ namespace Google\Cloud\PubSub\Connection; -use Google\Cloud\Iam\IamConnectionInterface; +use Google\Cloud\Core\Iam\IamConnectionInterface; /** * Proxy IAM service calls to the Pub/Sub Subscription IAM resources diff --git a/src/PubSub/Connection/IamTopic.php b/src/PubSub/Connection/IamTopic.php index 151ad3b67cc4..5efe89c760d1 100644 --- a/src/PubSub/Connection/IamTopic.php +++ b/src/PubSub/Connection/IamTopic.php @@ -17,7 +17,7 @@ namespace Google\Cloud\PubSub\Connection; -use Google\Cloud\Iam\IamConnectionInterface; +use Google\Cloud\Core\Iam\IamConnectionInterface; /** * Proxy IAM service calls to the Pub/Sub Topic IAM resources diff --git a/src/PubSub/Connection/Rest.php b/src/PubSub/Connection/Rest.php index 681d1b78572d..76bfb3f48090 100644 --- a/src/PubSub/Connection/Rest.php +++ b/src/PubSub/Connection/Rest.php @@ -17,11 +17,12 @@ namespace Google\Cloud\PubSub\Connection; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; -use Google\Cloud\EmulatorTrait; -use Google\Cloud\RestTrait; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\EmulatorTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; +use Google\Cloud\Core\UriTrait; +use Google\Cloud\PubSub\PubSubClient; /** * Implementation of the @@ -52,7 +53,8 @@ public function __construct(array $config = []) } $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/pubsub-v1.json' + 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/pubsub-v1.json', + 'componentVersion' => PubSubClient::VERSION ]; $this->setRequestWrapper(new RequestWrapper($config)); diff --git a/src/PubSub/IncomingMessageTrait.php b/src/PubSub/IncomingMessageTrait.php index b1b80b884f6c..025e3eff6414 100644 --- a/src/PubSub/IncomingMessageTrait.php +++ b/src/PubSub/IncomingMessageTrait.php @@ -17,7 +17,7 @@ namespace Google\Cloud\PubSub; -use Google\Cloud\Exception\GoogleException; +use Google\Cloud\Core\Exception\GoogleException; use Google\Cloud\PubSub\Connection\ConnectionInterface; /** diff --git a/src/PubSub/LICENSE b/src/PubSub/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/PubSub/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/PubSub/Message.php b/src/PubSub/Message.php index 973218018daf..f3ca7330ab03 100644 --- a/src/PubSub/Message.php +++ b/src/PubSub/Message.php @@ -22,10 +22,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\PubSub\PubSubClient; * - * $cloud = new ServiceBuilder(); - * $pubsub = $cloud->pubsub(); + * $pubsub = new PubSubClient(); * $subscription = $pubsub->subscription('my-new-subscription'); * * $messages = $subscription->pull(); diff --git a/src/PubSub/PubSubClient.php b/src/PubSub/PubSubClient.php index 774495fcd48f..4fc1b93b4036 100644 --- a/src/PubSub/PubSubClient.php +++ b/src/PubSub/PubSubClient.php @@ -17,7 +17,7 @@ namespace Google\Cloud\PubSub; -use Google\Cloud\ClientTrait; +use Google\Cloud\Core\ClientTrait; use Google\Cloud\PubSub\Connection\Grpc; use Google\Cloud\PubSub\Connection\Rest; use InvalidArgumentException; @@ -57,15 +57,6 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); - * - * $pubsub = $cloud->pubsub(); - * ``` - * - * ``` - * // PubSubClient can be instantiated directly. * use Google\Cloud\PubSub\PubSubClient; * * $pubsub = new PubSubClient(); @@ -73,14 +64,13 @@ * * ``` * // Using the Pub/Sub Emulator - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\PubSub\PubSubClient; * * // Be sure to use the port specified when starting the emulator. * // `8900` is used as an example only. * putenv('PUBSUB_EMULATOR_HOST=http://localhost:8900'); * - * $cloud = new ServiceBuilder(); - * $pubsub = $cloud->pubsub(); + * $pubsub = new PubSubClient(); * ``` */ class PubSubClient @@ -89,6 +79,8 @@ class PubSubClient use IncomingMessageTrait; use ResourceNameTrait; + const VERSION = 'master'; + const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/pubsub'; /** @@ -217,7 +209,7 @@ public function topic($name) * @type int $pageSize Maximum number of results to return per * request. * } - * @return Generator + * @return \Generator */ public function topics(array $options = []) { diff --git a/src/PubSub/README.md b/src/PubSub/README.md index 6d15710106df..c9cf12ba58d9 100644 --- a/src/PubSub/README.md +++ b/src/PubSub/README.md @@ -1,135 +1,10 @@ -# Google Cloud Pub/Sub +# Google Cloud PHP PubSub -Google Cloud Pub/Sub allows you to send and receive messages between independent -applications. +> Idiomatic PHP client for [Cloud Pub/Sub](https://cloud.google.com/pubsub/). -## More Information +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/pubsub/pubsubclient) -* [Google Cloud Pub/Sub docs](https://cloud.google.com/pubsub/docs/). - -## Client Libraries - -* [**PubSubClient**](https://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/pubsub/pubsubclient) -* [Subscription](https://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/pubsub/subscription) -* [Topic](https://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/pubsub/topic) - -## Generated Client - -[What are Generated Clients?](https://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/guides/generated-client) - -### V1 - -* [PublisherApi](https://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/pubsub/v1/publisherapi) -* [SubscriberApi](https://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/pubsub/v1/subscriberapi) - -## Using Pub/Sub - -### Concepts - -Pub/Sub is a way of sharing messages between independent applications. A -"Publisher" will push messages into a topic, while a "Subscriber" will retrieve -messages from a subscription. - -Subscriptions are a named resource representing the stream of messages from a -single topic. Generally, each subscribing application would create a single -subscription to each topic which is applicable to that application. - -Messages are a combination of data and optional attributes which a publisher -sends to a topic to be delivered to each subscriber. - -Subscribers may elect to receive messages by pulling (i.e. sending a request, -to which the response contains all new messages), or by push (by supplying an -application endpoint which can consume incoming messages on demand). - -### Examples - -#### Obtaining an instance of `PubSubClient` - -```php -pubsub(); -``` - -#### Creating a new Topic - -```php -$pubsub->createTopic('my-new-topic'); -``` - -#### Publish a message - -`PubSubClient::createTopic()` should be called *once* to create the named topic -in the service. To obtain a reference to an *existing* topic, use -`PubSubClient::topic()`. - -```php -$topic = $pubsub->topic('my-new-topic'); -$topic->publish([ - 'data' => 'Hello world!', - 'attributes' => [ - 'key' => 'val' - ] -); -``` - -#### Subscribe to a topic - -```php -$subscription = $pubsub->subscribe('my-new-subscription'); -``` - -#### Retrieve messages - -`PubSubClient::subscribe()` should be called *once* to create the named -subscription in the service. To obtain a reference to an *existing* -subscription, use `PubSubClient::subscription()`. - -```php -$subscription = $pubsub->subscription('my-new-subscription'); -$messages = $subscription->pull(); - -foreach ($messages as $message) { - echo $message['message']['data']; -} -``` - -#### Acknowledge received message - -Received messages should be *acknowledged* upon receipt, to prevent them from -being delivered multiple times. - -```php -$subscription = $pubsub->subscription('my-new-subscription'); -$messages = $subscription->pull(); - -$ackIds = []; -foreach ($messages as $message) { - $ackIds[] = $message['ackId']; -} - -$subscription->acknowledgeBatch($ackIds); -``` - -#### Configure Push Delivery - -When Push Delivery is enabled, new messages will be delivered via HTTP to the -given endpoint. - -For more information, refer to the [receive push](https://cloud.google.com/pubsub/docs/subscriber#receive_push) -guide. - -To pause push delivery for a subscription, call -`Subscription::modifyPushConfig()`, supplying an empty string (`''`) as the -`pushEndpoint`. - -```php -$subscription = $pubsub->subscription('my-new-subscription'); -$subscription->modifyPushConfig([ - 'pushEndpoint' => 'https://mysite.com/application/pubsub/push' -]); -``` +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/PubSub/Subscription.php b/src/PubSub/Subscription.php index a956e5b7e8d6..5c6ee7128b10 100644 --- a/src/PubSub/Subscription.php +++ b/src/PubSub/Subscription.php @@ -17,12 +17,12 @@ namespace Google\Cloud\PubSub; -use Google\Cloud\Exception\NotFoundException; -use Google\Cloud\Iam\Iam; +use Google\Cloud\Core\Exception\NotFoundException; +use Google\Cloud\Core\Iam\Iam; use Google\Cloud\PubSub\Connection\ConnectionInterface; use Google\Cloud\PubSub\Connection\IamSubscription; use Google\Cloud\PubSub\IncomingMessageTrait; -use Google\Cloud\ValidateTrait; +use Google\Cloud\Core\ValidateTrait; use InvalidArgumentException; /** @@ -32,11 +32,9 @@ * Example: * ``` * // Create subscription through a topic - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); + * use Google\Cloud\PubSub\PubSubClient; * - * $pubsub = $cloud->pubsub(); + * $pubsub = new PubSubClient(); * * $topic = $pubsub->topic('my-new-topic'); * @@ -45,7 +43,6 @@ * * ``` * // Create subscription through PubSubClient - * * use Google\Cloud\PubSub\PubSubClient; * * $pubsub = new PubSubClient(); diff --git a/src/PubSub/Topic.php b/src/PubSub/Topic.php index 2afaf8c16487..cf1ad53c79bf 100644 --- a/src/PubSub/Topic.php +++ b/src/PubSub/Topic.php @@ -17,8 +17,8 @@ namespace Google\Cloud\PubSub; -use Google\Cloud\Iam\Iam; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Iam\Iam; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\PubSub\Connection\ConnectionInterface; use Google\Cloud\PubSub\Connection\IamTopic; use InvalidArgumentException; @@ -28,11 +28,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\PubSub\PubSubClient; * - * $client = new ServiceBuilder(); - * - * $pubsub = $client->pubsub(); + * $pubsub = new PubSubClient(); * $topic = $pubsub->topic('my-new-topic'); * ``` * diff --git a/src/PubSub/composer.json b/src/PubSub/composer.json new file mode 100644 index 000000000000..59ab2de6c647 --- /dev/null +++ b/src/PubSub/composer.json @@ -0,0 +1,26 @@ +{ + "name": "google/cloud-pubsub", + "description": "Cloud PubSub Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*" + }, + "suggest": { + "google/gax": "Required to support gRPC", + "google/proto-client-php": "Required to support gRPC" + }, + "extra": { + "component": { + "id": "cloud-pubsub", + "target": "GoogleCloudPlatform/google-cloud-php-pubsub.git", + "path": "src/PubSub", + "entry": "PubSubClient.php" + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\PubSub\\": "" + } + } +} diff --git a/src/ServiceBuilder.php b/src/ServiceBuilder.php index c8d2bfaf7419..e58352b765cc 100644 --- a/src/ServiceBuilder.php +++ b/src/ServiceBuilder.php @@ -111,7 +111,7 @@ public function __construct(array $config = []) * {@see Google\Cloud\ServiceBuilder::__construct()} for the other available options. * * @type bool $returnInt64AsObject If true, 64 bit integers will be - * returned as a {@see Google\Cloud\Int64} object for 32 bit + * returned as a {@see Google\Cloud\Core\Int64} object for 32 bit * platform compatibility. **Defaults to** false. * @return BigQueryClient */ @@ -135,7 +135,7 @@ public function bigQuery(array $config = []) * {@see Google\Cloud\ServiceBuilder::__construct()} for the other available options. * * @type bool $returnInt64AsObject If true, 64 bit integers will be - * returned as a {@see Google\Cloud\Int64} object for 32 bit + * returned as a {@see Google\Cloud\Core\Int64} object for 32 bit * platform compatibility. **Defaults to** false. * @return DatastoreClient */ diff --git a/src/Speech/Connection/Rest.php b/src/Speech/Connection/Rest.php index e8b5aefae474..38985f03d90d 100644 --- a/src/Speech/Connection/Rest.php +++ b/src/Speech/Connection/Rest.php @@ -17,10 +17,11 @@ namespace Google\Cloud\Speech\Connection; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; -use Google\Cloud\RestTrait; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; +use Google\Cloud\Core\UriTrait; +use Google\Cloud\Speech\SpeechClient; /** * Implementation of the @@ -39,7 +40,8 @@ class Rest implements ConnectionInterface public function __construct(array $config = []) { $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/speech-v1beta1.json' + 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/speech-v1beta1.json', + 'componentVersion' => SpeechClient::VERSION ]; $this->setRequestWrapper(new RequestWrapper($config)); diff --git a/src/Speech/LICENSE b/src/Speech/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/Speech/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/Speech/Operation.php b/src/Speech/Operation.php index c9731858d4bb..44e2f422401f 100644 --- a/src/Speech/Operation.php +++ b/src/Speech/Operation.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Speech; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Speech\Connection\ConnectionInterface; /** @@ -25,10 +25,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Speech\SpeechClient; * - * $cloud = new ServiceBuilder(); - * $speech = $cloud->speech(); + * $speech = new SpeechClient(); * * $audioFileStream = fopen(__DIR__ . '/audio.flac', 'r'); * $operation = $speech->beginRecognizeOperation( diff --git a/src/Speech/README.md b/src/Speech/README.md new file mode 100644 index 000000000000..9bbc02e8fb3a --- /dev/null +++ b/src/Speech/README.md @@ -0,0 +1,10 @@ +# Google Cloud PHP Speech + +> Idiomatic PHP client for [Cloud Speech](https://cloud.google.com/speech/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/speech/speechclient) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/Speech/SpeechClient.php b/src/Speech/SpeechClient.php index 7bb2e2108f86..5b042bbdd6b2 100644 --- a/src/Speech/SpeechClient.php +++ b/src/Speech/SpeechClient.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Speech; -use Google\Cloud\ClientTrait; +use Google\Cloud\Core\ClientTrait; use Google\Cloud\Speech\Connection\ConnectionInterface; use Google\Cloud\Speech\Connection\Rest; use Google\Cloud\Storage\StorageObject; @@ -41,15 +41,6 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); - * - * $speech = $cloud->speech(); - * ``` - * - * ``` - * // SpeechClient can be instantiated directly. * use Google\Cloud\Speech\SpeechClient; * * $speech = new SpeechClient(); @@ -59,6 +50,8 @@ class SpeechClient { use ClientTrait; + const VERSION = 'master'; + const SCOPE = 'https://www.googleapis.com/auth/cloud-platform'; /** @@ -149,11 +142,18 @@ public function __construct(array $config = []) * @see https://cloud.google.com/speech/docs/best-practices Speech API best practices * @codingStandardsIgnoreEnd * - * @param resource|string|StorageObject $audio The audio to recognize. May - * be a resource, string of bytes, or Google Cloud Storage object. + * @param resource|string|StorageObject $audio The audio to recognize. May + * be a resource, string of bytes, a URI pointing to a + * Google Cloud Storage object in the format of + * `gs://{bucket-name}/{object-name}` or a + * {@see Google\Cloud\Storage\StorageObject}. * @param array $options [optional] { * Configuration options. * + * @type bool $detectGcsUri When providing $audio as a string, this flag + * determines whether or not to attempt to detect if the string + * represents a Google Cloud Storage URI in the format of + * `gs://{bucket-name}/{object-name}`. **Defaults to** `true`. * @type int $sampleRate Sample rate in Hertz of the provided audio. * Valid values are: 8000-48000. 16000 is optimal. For best * results, set the sampling rate of the audio source to 16000 Hz. @@ -263,10 +263,17 @@ public function recognize($audio, array $options = []) * @codingStandardsIgnoreEnd * * @param resource|string|StorageObject $audio The audio to recognize. May - * be a resource, string of bytes, or Google Cloud Storage object. + * be a resource, string of bytes, a URI pointing to a + * Google Cloud Storage object in the format of + * `gs://{bucket-name}/{object-name}` or a + * {@see Google\Cloud\Storage\StorageObject}. * @param array $options [optional] { * Configuration options. * + * @type bool $detectGcsUri When providing $audio as a string, this flag + * determines whether or not to attempt to detect if the string + * represents a Google Cloud Storage URI in the format of + * `gs://{bucket-name}/{object-name}`. **Defaults to** `true`. * @type int $sampleRate Sample rate in Hertz of the provided audio. * Valid values are: 8000-48000. 16000 is optimal. For best * results, set the sampling rate of the audio source to 16000 Hz. @@ -342,6 +349,7 @@ private function formatRequest($audio, array $options) { $analyzedFileInfo = null; $fileFormat = null; + $options += ['detectGcsUri' => true]; $recognizeOptions = [ 'encoding', 'sampleRate', @@ -352,16 +360,20 @@ private function formatRequest($audio, array $options) ]; if ($audio instanceof StorageObject) { - $objIdentity = $audio->identity(); - $options['audio']['uri'] = 'gs://' . $objIdentity['bucket'] . '/' . $objIdentity['object']; + $options['audio']['uri'] = $audio->gcsUri(); $fileFormat = pathinfo($options['audio']['uri'], PATHINFO_EXTENSION); } elseif (is_resource($audio)) { $options['audio']['content'] = base64_encode(stream_get_contents($audio)); $fileFormat = pathinfo(stream_get_meta_data($audio)['uri'], PATHINFO_EXTENSION); + } elseif ($options['detectGcsUri'] && substr($audio, 0, 5) === 'gs://') { + $options['audio']['uri'] = $audio; + $fileFormat = pathinfo($options['audio']['uri'], PATHINFO_EXTENSION); } else { $options['audio']['content'] = base64_encode($audio); } + unset($options['detectGcsUri']); + if (isset($options['encoding'])) { $options['encoding'] = strtoupper($options['encoding']); } else { diff --git a/src/Speech/composer.json b/src/Speech/composer.json new file mode 100644 index 000000000000..1e26c75b2f12 --- /dev/null +++ b/src/Speech/composer.json @@ -0,0 +1,27 @@ +{ + "name": "google/cloud-speech", + "description": "Cloud Speech Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*" + }, + "suggest": { + "google/gax": "Required to support gRPC", + "google/proto-client-php": "Required to support gRPC", + "google/cloud-storage": "Run operations on files stored in Google Cloud Storage" + }, + "extra": { + "component": { + "id": "cloud-speech", + "target": "GoogleCloudPlatform/google-cloud-php-speech.git", + "path": "src/Speech", + "entry": "SpeechClient.php" + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\Speech\\": "" + } + } +} diff --git a/src/Storage/Acl.php b/src/Storage/Acl.php index c4014af5a58d..19d69150e497 100644 --- a/src/Storage/Acl.php +++ b/src/Storage/Acl.php @@ -29,10 +29,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Storage\StorageClient; * - * $cloud = new ServiceBuilder(); - * $storage = $cloud->storage(); + * $storage = new StorageClient(); * * $bucket = $storage->bucket('my-bucket'); * $acl = $bucket->acl(); diff --git a/src/Storage/Bucket.php b/src/Storage/Bucket.php index ceb3d7c30c4a..f936c2d9b416 100644 --- a/src/Storage/Bucket.php +++ b/src/Storage/Bucket.php @@ -17,10 +17,11 @@ namespace Google\Cloud\Storage; -use Google\Cloud\Exception\NotFoundException; -use Google\Cloud\Exception\ServiceException; +use Google\Cloud\Core\Exception\ServiceException; +use Google\Cloud\Core\Upload\ResumableUploader; +use Google\Cloud\Core\Upload\StreamableUploader; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Storage\Connection\ConnectionInterface; -use Google\Cloud\Upload\ResumableUploader; use GuzzleHttp\Psr7; use Psr\Http\Message\StreamInterface; @@ -30,10 +31,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Storage\StorageClient; * - * $cloud = new ServiceBuilder(); - * $storage = $cloud->storage(); + * $storage = new StorageClient(); * * $bucket = $storage->bucket('my-bucket'); * ``` diff --git a/src/Storage/Connection/Rest.php b/src/Storage/Connection/Rest.php index 7d71d2e3262c..f4751f010156 100644 --- a/src/Storage/Connection/Rest.php +++ b/src/Storage/Connection/Rest.php @@ -17,15 +17,16 @@ namespace Google\Cloud\Storage\Connection; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; -use Google\Cloud\RestTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; +use Google\Cloud\Core\Upload\AbstractUploader; +use Google\Cloud\Core\Upload\MultipartUploader; +use Google\Cloud\Core\Upload\ResumableUploader; +use Google\Cloud\Core\Upload\StreamableUploader; +use Google\Cloud\Core\UriTrait; use Google\Cloud\Storage\Connection\ConnectionInterface; -use Google\Cloud\Upload\AbstractUploader; -use Google\Cloud\Upload\MultipartUploader; -use Google\Cloud\Upload\ResumableUploader; -use Google\Cloud\Upload\StreamableUploader; -use Google\Cloud\UriTrait; +use Google\Cloud\Storage\StorageClient; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; @@ -48,7 +49,8 @@ class Rest implements ConnectionInterface public function __construct(array $config = []) { $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/storage-v1.json' + 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/storage-v1.json', + 'componentVersion' => StorageClient::VERSION ]; $this->setRequestWrapper(new RequestWrapper($config)); diff --git a/src/Storage/LICENSE b/src/Storage/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/Storage/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/Storage/README.md b/src/Storage/README.md new file mode 100644 index 000000000000..4cb0394b70c4 --- /dev/null +++ b/src/Storage/README.md @@ -0,0 +1,10 @@ +# Google Cloud PHP Storage + +> Idiomatic PHP client for [Cloud Storage](https://cloud.google.com/storage/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/storage/storageclient) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/Storage/StorageClient.php b/src/Storage/StorageClient.php index 0afcdb8ac919..417dfb136836 100644 --- a/src/Storage/StorageClient.php +++ b/src/Storage/StorageClient.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Storage; -use Google\Cloud\ClientTrait; +use Google\Cloud\Core\ClientTrait; use Google\Cloud\Storage\Connection\ConnectionInterface; use Google\Cloud\Storage\Connection\Rest; use Psr\Cache\CacheItemPoolInterface; @@ -29,15 +29,6 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); - * - * $storage = $cloud->storage(); - * ``` - * - * ``` - * // StorageClient can be instantiated directly. * use Google\Cloud\Storage\StorageClient; * * $storage = new StorageClient(); @@ -47,6 +38,8 @@ class StorageClient { use ClientTrait; + const VERSION = 'master'; + const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/devstorage.full_control'; const READ_ONLY_SCOPE = 'https://www.googleapis.com/auth/devstorage.read_only'; const READ_WRITE_SCOPE = 'https://www.googleapis.com/auth/devstorage.read_write'; diff --git a/src/Storage/StorageObject.php b/src/Storage/StorageObject.php index eaada957add2..35242e035186 100644 --- a/src/Storage/StorageObject.php +++ b/src/Storage/StorageObject.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Storage; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Storage\Connection\ConnectionInterface; use GuzzleHttp\Psr7; use Psr\Http\Message\StreamInterface; @@ -28,10 +28,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Storage\StorageClient; * - * $cloud = new ServiceBuilder(); - * $storage = $cloud->storage(); + * $storage = new StorageClient(); * * $bucket = $storage->bucket('my-bucket'); * $object = $bucket->object('my-object'); @@ -754,6 +753,26 @@ public function identity() return $this->identity; } + /** + * Formats the object as a string in the following format: + * `gs://{bucket-name}/{object-name}`. + * + * Example: + * ``` + * echo $object->gcsUri(); + * ``` + * + * @return string + */ + public function gcsUri() + { + return sprintf( + 'gs://%s/%s', + $this->identity['bucket'], + $this->identity['object'] + ); + } + /** * Formats a destination based request, such as copy or rewrite. * diff --git a/src/Storage/StreamWrapper.php b/src/Storage/StreamWrapper.php index e2c0a9923a5c..b393fa5bb1a3 100644 --- a/src/Storage/StreamWrapper.php +++ b/src/Storage/StreamWrapper.php @@ -17,8 +17,8 @@ namespace Google\Cloud\Storage; -use Google\Cloud\Exception\NotFoundException; -use Google\Cloud\Exception\ServiceException; +use Google\Cloud\Core\Exception\NotFoundException; +use Google\Cloud\Core\Exception\ServiceException; use Google\Cloud\Storage\Bucket; use GuzzleHttp\Psr7\CachingStream; use GuzzleHttp\Psr7; diff --git a/src/Storage/WriteStream.php b/src/Storage/WriteStream.php index e3dcd689393c..c78bcc91a89b 100644 --- a/src/Storage/WriteStream.php +++ b/src/Storage/WriteStream.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Storage; -use Google\Cloud\Upload\AbstractUploader; +use Google\Cloud\Core\Upload\AbstractUploader; use GuzzleHttp\Psr7\StreamDecoratorTrait; use GuzzleHttp\Psr7\BufferStream; use Psr\Http\Message\StreamInterface; diff --git a/src/Storage/composer.json b/src/Storage/composer.json new file mode 100644 index 000000000000..d8d2daeeba43 --- /dev/null +++ b/src/Storage/composer.json @@ -0,0 +1,22 @@ +{ + "name": "google/cloud-storage", + "description": "Cloud Storage Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*" + }, + "extra": { + "component": { + "id": "cloud-storage", + "target": "GoogleCloudPlatform/google-cloud-php-storage.git", + "path": "src/Storage", + "entry": "StorageClient.php" + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\Storage\\": "" + } + } +} diff --git a/src/Translate/Connection/Rest.php b/src/Translate/Connection/Rest.php index 584163a29a0f..9e67617246c2 100644 --- a/src/Translate/Connection/Rest.php +++ b/src/Translate/Connection/Rest.php @@ -17,10 +17,11 @@ namespace Google\Cloud\Translate\Connection; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; -use Google\Cloud\RestTrait; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; +use Google\Cloud\Core\UriTrait; +use Google\Cloud\Translate\TranslateClient; /** * Implementation of the @@ -39,7 +40,8 @@ class Rest implements ConnectionInterface public function __construct(array $config = []) { $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/translate-v2.json' + 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/translate-v2.json', + 'componentVersion' => TranslateClient::VERSION ]; $this->setRequestWrapper(new RequestWrapper($config)); diff --git a/src/Translate/LICENSE b/src/Translate/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/Translate/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/Translate/README.md b/src/Translate/README.md new file mode 100644 index 000000000000..a5858285f74c --- /dev/null +++ b/src/Translate/README.md @@ -0,0 +1,10 @@ +# Google Cloud PHP Translation + +> Idiomatic PHP client for [Translation](https://cloud.google.com/translate/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/translate/translateclient) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/Translate/TranslateClient.php b/src/Translate/TranslateClient.php index 0d44a76c5652..c0f3b02b7ef9 100644 --- a/src/Translate/TranslateClient.php +++ b/src/Translate/TranslateClient.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Translate; -use Google\Cloud\ClientTrait; +use Google\Cloud\Core\ClientTrait; use Google\Cloud\Translate\Connection\ConnectionInterface; use Google\Cloud\Translate\Connection\Rest; @@ -42,15 +42,6 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); - * - * $translate = $cloud->translate(); - * ``` - * - * ``` - * // TranslateClient can be instantiated directly. * use Google\Cloud\Translate\TranslateClient; * * $translate = new TranslateClient(); @@ -60,6 +51,8 @@ class TranslateClient { use ClientTrait; + const VERSION = 'master'; + const ENGLISH_LANGUAGE_CODE = 'en'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/cloud-platform'; diff --git a/src/Translate/composer.json b/src/Translate/composer.json new file mode 100644 index 000000000000..a1439088d331 --- /dev/null +++ b/src/Translate/composer.json @@ -0,0 +1,22 @@ +{ + "name": "google/cloud-translate", + "description": "Cloud Transation Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*" + }, + "extra": { + "component": { + "id": "cloud-translate", + "target": "GoogleCloudPlatform/google-cloud-php-translate.git", + "path": "src/Translate", + "entry": "TranslateClient.php" + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\Translate\\": "" + } + } +} diff --git a/src/Vision/Annotation.php b/src/Vision/Annotation.php index 321af9cbfa8c..646cd3f9fa80 100644 --- a/src/Vision/Annotation.php +++ b/src/Vision/Annotation.php @@ -31,10 +31,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); * $image = $vision->image($imageResource, [ diff --git a/src/Vision/Annotation/CropHint.php b/src/Vision/Annotation/CropHint.php index 36c1eee94167..0800fa0d17a5 100644 --- a/src/Vision/Annotation/CropHint.php +++ b/src/Vision/Annotation/CropHint.php @@ -17,17 +17,16 @@ namespace Google\Cloud\Vision\Annotation; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; /** * Represents a recommended image crop. * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); * $image = $vision->image($imageResource, [ 'CROP_HINTS' ]); diff --git a/src/Vision/Annotation/Document.php b/src/Vision/Annotation/Document.php index 48e5915a8665..144407a7a50a 100644 --- a/src/Vision/Annotation/Document.php +++ b/src/Vision/Annotation/Document.php @@ -17,17 +17,16 @@ namespace Google\Cloud\Vision\Annotation; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; /** * Represents a Document Text Detection result. * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/the-constitution.jpg', 'r'); * $image = $vision->image($imageResource, [ 'DOCUMENT_TEXT_DETECTION' ]); diff --git a/src/Vision/Annotation/Entity.php b/src/Vision/Annotation/Entity.php index 937ea4563498..042615cf9cac 100644 --- a/src/Vision/Annotation/Entity.php +++ b/src/Vision/Annotation/Entity.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Vision\Annotation; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; /** * Represents an entity annotation. Entities are created by several @@ -26,10 +26,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); * $image = $vision->image($imageResource, [ 'text' ]); diff --git a/src/Vision/Annotation/Face.php b/src/Vision/Annotation/Face.php index 6b1369b0809f..839fd1744bb4 100644 --- a/src/Vision/Annotation/Face.php +++ b/src/Vision/Annotation/Face.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Vision\Annotation; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; use Google\Cloud\Vision\Annotation\Face\Landmarks; /** @@ -25,10 +25,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); * $image = $vision->image($imageResource, [ 'FACE_DETECTION' ]); diff --git a/src/Vision/Annotation/Face/Landmarks.php b/src/Vision/Annotation/Face/Landmarks.php index 5dbb3f5c8fbb..85721ce35103 100644 --- a/src/Vision/Annotation/Face/Landmarks.php +++ b/src/Vision/Annotation/Face/Landmarks.php @@ -24,10 +24,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); * $image = $vision->image($imageResource, ['FACE_DETECTION']); diff --git a/src/Vision/Annotation/ImageProperties.php b/src/Vision/Annotation/ImageProperties.php index 9b6649c91024..c5b6d73ad712 100644 --- a/src/Vision/Annotation/ImageProperties.php +++ b/src/Vision/Annotation/ImageProperties.php @@ -22,10 +22,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); * $image = $vision->image($imageResource, [ 'imageProperties' ]); diff --git a/src/Vision/Annotation/SafeSearch.php b/src/Vision/Annotation/SafeSearch.php index 8e3781f0f481..b3f3e06639a0 100644 --- a/src/Vision/Annotation/SafeSearch.php +++ b/src/Vision/Annotation/SafeSearch.php @@ -17,17 +17,16 @@ namespace Google\Cloud\Vision\Annotation; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; /** * Represents a SafeSearch annotation result * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); * $image = $vision->image($imageResource, [ 'safeSearch' ]); diff --git a/src/Vision/Annotation/Web.php b/src/Vision/Annotation/Web.php index f384be49c3a1..ff1422501eaf 100644 --- a/src/Vision/Annotation/Web.php +++ b/src/Vision/Annotation/Web.php @@ -26,10 +26,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); * $image = $vision->image($imageResource, [ 'WEB_DETECTION' ]); diff --git a/src/Vision/Annotation/Web/WebEntity.php b/src/Vision/Annotation/Web/WebEntity.php index a6ef07e7a4ae..754db2008cb4 100644 --- a/src/Vision/Annotation/Web/WebEntity.php +++ b/src/Vision/Annotation/Web/WebEntity.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Vision\Annotation\Web; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; use Google\Cloud\Vision\Annotation\AbstractFeature; /** @@ -25,10 +25,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/eiffel-tower.jpg', 'r'); * $image = $vision->image($imageResource, ['WEB_DETECTION']); diff --git a/src/Vision/Annotation/Web/WebImage.php b/src/Vision/Annotation/Web/WebImage.php index 6481628ad9be..85985b28dacf 100644 --- a/src/Vision/Annotation/Web/WebImage.php +++ b/src/Vision/Annotation/Web/WebImage.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Vision\Annotation\Web; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; use Google\Cloud\Vision\Annotation\AbstractFeature; /** @@ -25,10 +25,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/eiffel-tower.jpg', 'r'); * $image = $vision->image($imageResource, ['WEB_DETECTION']); diff --git a/src/Vision/Annotation/Web/WebPage.php b/src/Vision/Annotation/Web/WebPage.php index 1d229be56fec..4585e3e966c7 100644 --- a/src/Vision/Annotation/Web/WebPage.php +++ b/src/Vision/Annotation/Web/WebPage.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Vision\Annotation\Web; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; use Google\Cloud\Vision\Annotation\AbstractFeature; /** @@ -25,10 +25,9 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/eiffel-tower.jpg', 'r'); * $image = $vision->image($imageResource, ['WEB_DETECTION']); diff --git a/src/Vision/Connection/Rest.php b/src/Vision/Connection/Rest.php index e083b1b5497a..36ebedd47c19 100644 --- a/src/Vision/Connection/Rest.php +++ b/src/Vision/Connection/Rest.php @@ -17,10 +17,11 @@ namespace Google\Cloud\Vision\Connection; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; -use Google\Cloud\RestTrait; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; +use Google\Cloud\Core\UriTrait; +use Google\Cloud\Vision\VisionClient; /** * Implementation of the @@ -39,7 +40,8 @@ class Rest implements ConnectionInterface public function __construct(array $config = []) { $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/vision-v1.json' + 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/vision-v1.json', + 'componentVersion' => VisionClient::VERSION ]; $this->setRequestWrapper(new RequestWrapper($config)); diff --git a/src/Vision/Image.php b/src/Vision/Image.php index 5e3dceeaacfd..33733f82c069 100644 --- a/src/Vision/Image.php +++ b/src/Vision/Image.php @@ -42,10 +42,9 @@ * Example: * ``` * //[snippet=default] - * use Google\Cloud\ServiceBuilder; + * use Google\Cloud\Vision\VisionClient; * - * $cloud = new ServiceBuilder(); - * $vision = $cloud->vision(); + * $vision = new VisionClient(); * * $imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); * $image = $vision->image($imageResource, [ @@ -79,10 +78,11 @@ * ``` * //[snippet=gcs] * // Files stored in Google Cloud Storage can be used. - * + * use Google\Cloud\Storage\StorageClient; * use Google\Cloud\Vision\Image; * - * $file = $cloud->storage()->bucket('my-test-bucket')->object('family-photo.jpg'); + * $storage = new StorageClient(); + * $file = $storage->bucket('my-test-bucket')->object('family-photo.jpg'); * $image = new Image($file, [ * 'FACE_DETECTION' * ]); @@ -242,11 +242,8 @@ public function __construct($image, array $features, array $options = []) } elseif (is_string($image)) { $this->type = self::TYPE_STRING; } elseif ($image instanceof StorageObject) { - $identity = $image->identity(); - $uri = sprintf('gs://%s/%s', $identity['bucket'], $identity['object']); - $this->type = self::TYPE_URI; - $this->image = $uri; + $this->image = $image->gcsUri(); } elseif (is_resource($image)) { $this->type = self::TYPE_BYTES; $this->image = Psr7\stream_for($image); diff --git a/src/Vision/LICENSE b/src/Vision/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/src/Vision/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with 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 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. + diff --git a/src/Vision/README.md b/src/Vision/README.md new file mode 100644 index 000000000000..9cd21c463951 --- /dev/null +++ b/src/Vision/README.md @@ -0,0 +1,10 @@ +# Google Cloud PHP Vision + +> Idiomatic PHP client for [Cloud Vision](https://cloud.google.com/vision/). + +* [Homepage](http://googlecloudplatform.github.io/google-cloud-php) +* [API documentation](http://googlecloudplatform.github.io/google-cloud-php/#/docs/latest/vision/visionclient) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googlecloudplatform/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. diff --git a/src/Vision/VisionClient.php b/src/Vision/VisionClient.php index b7d203bdb38f..2010fdbaa66a 100644 --- a/src/Vision/VisionClient.php +++ b/src/Vision/VisionClient.php @@ -17,8 +17,9 @@ namespace Google\Cloud\Vision; -use Google\Cloud\ClientTrait; -use Google\Cloud\ValidateTrait; +use Google\Cloud\Core\ClientTrait; +use Google\Cloud\Core\ValidateTrait; +use Google\Cloud\Storage\StorageObject; use Google\Cloud\Vision\Connection\Rest; use InvalidArgumentException; use Psr\Cache\CacheItemPoolInterface; @@ -31,15 +32,6 @@ * * Example: * ``` - * use Google\Cloud\ServiceBuilder; - * - * $cloud = new ServiceBuilder(); - * - * $vision = $cloud->vision(); - * ``` - * - * ``` - * // VisionClient can be instantiated directly. * use Google\Cloud\Vision\VisionClient; * * $vision = new VisionClient(); @@ -50,6 +42,8 @@ class VisionClient use ClientTrait; use ValidateTrait; + const VERSION = 'master'; + const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/cloud-platform'; /** diff --git a/src/Vision/composer.json b/src/Vision/composer.json new file mode 100644 index 000000000000..655613b3a174 --- /dev/null +++ b/src/Vision/composer.json @@ -0,0 +1,25 @@ +{ + "name": "google/cloud-vision", + "description": "Cloud Vision Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "require": { + "google/cloud-core": "*" + }, + "suggest": { + "google/cloud-storage": "Annotate images stored in Google Cloud Storage" + }, + "extra": { + "component": { + "id": "cloud-vision", + "target": "GoogleCloudPlatform/google-cloud-php-vision.git", + "path": "src/Vision", + "entry": "VisionClient.php" + } + }, + "autoload": { + "psr-4": { + "Google\\Cloud\\Vision\\": "" + } + } +} diff --git a/tests/snippets/BigQuery/BigQueryClientTest.php b/tests/snippets/BigQuery/BigQueryClientTest.php index 2b02c17011de..d3c79b9e56ab 100644 --- a/tests/snippets/BigQuery/BigQueryClientTest.php +++ b/tests/snippets/BigQuery/BigQueryClientTest.php @@ -27,7 +27,7 @@ use Google\Cloud\BigQuery\Job; use Google\Cloud\BigQuery\QueryResults; use Google\Cloud\Dev\Snippet\SnippetTestCase; -use Google\Cloud\Int64; +use Google\Cloud\Core\Int64; use Prophecy\Argument; /** @@ -74,14 +74,6 @@ public function testClass() $this->assertInstanceOf(BigQueryClient::class, $res->returnVal()); } - public function testClassDirectInstantiation() - { - $snippet = $this->snippetFromClass(BigQueryClient::class, 1); - $res = $snippet->invoke('bigQuery'); - - $this->assertInstanceOf(BigQueryClient::class, $res->returnVal()); - } - public function testRunQuery() { $snippet = $this->snippetFromMethod(BigQueryClient::class, 'runQuery'); diff --git a/tests/snippets/BigQuery/TableTest.php b/tests/snippets/BigQuery/TableTest.php index 5e05f6f1b526..90558814abbc 100644 --- a/tests/snippets/BigQuery/TableTest.php +++ b/tests/snippets/BigQuery/TableTest.php @@ -25,7 +25,7 @@ use Google\Cloud\BigQuery\ValueMapper; use Google\Cloud\Dev\Snippet\SnippetTestCase; use Google\Cloud\Storage\Connection\ConnectionInterface as StorageConnectionInterface; -use Google\Cloud\Upload\MultipartUploader; +use Google\Cloud\Core\Upload\MultipartUploader; use Prophecy\Argument; /** diff --git a/tests/snippets/Compute/MetadataTest.php b/tests/snippets/Core/Compute/MetadataTest.php similarity index 96% rename from tests/snippets/Compute/MetadataTest.php rename to tests/snippets/Core/Compute/MetadataTest.php index 5208836d481e..9c64eb0099d4 100644 --- a/tests/snippets/Compute/MetadataTest.php +++ b/tests/snippets/Core/Compute/MetadataTest.php @@ -15,10 +15,10 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Snippets\Compute; +namespace Google\Cloud\Tests\Snippets\Core\Compute; -use Google\Cloud\Compute\Metadata; -use Google\Cloud\Compute\Metadata\Readers\ReaderInterface; +use Google\Cloud\Core\Compute\Metadata; +use Google\Cloud\Core\Compute\Metadata\Readers\ReaderInterface; use Google\Cloud\Dev\Snippet\SnippetTestCase; use Prophecy\Argument; diff --git a/tests/snippets/Iam/IamTest.php b/tests/snippets/Core/Iam/IamTest.php similarity index 96% rename from tests/snippets/Iam/IamTest.php rename to tests/snippets/Core/Iam/IamTest.php index d66fe0bf8890..de025c4b774e 100644 --- a/tests/snippets/Iam/IamTest.php +++ b/tests/snippets/Core/Iam/IamTest.php @@ -15,11 +15,11 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Snippets\Iam; +namespace Google\Cloud\Tests\Snippets\Core\Iam; use Google\Cloud\Dev\Snippet\SnippetTestCase; -use Google\Cloud\Iam\Iam; -use Google\Cloud\Iam\IamConnectionInterface; +use Google\Cloud\Core\Iam\Iam; +use Google\Cloud\Core\Iam\IamConnectionInterface; use Prophecy\Argument; /** diff --git a/tests/snippets/Iam/PolicyBuilderTest.php b/tests/snippets/Core/Iam/PolicyBuilderTest.php similarity index 96% rename from tests/snippets/Iam/PolicyBuilderTest.php rename to tests/snippets/Core/Iam/PolicyBuilderTest.php index 6649bb0c6e3b..32bf8bb19d71 100644 --- a/tests/snippets/Iam/PolicyBuilderTest.php +++ b/tests/snippets/Core/Iam/PolicyBuilderTest.php @@ -15,10 +15,10 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Snippets\Iam; +namespace Google\Cloud\Tests\Snippets\Core\Iam; use Google\Cloud\Dev\Snippet\SnippetTestCase; -use Google\Cloud\Iam\PolicyBuilder; +use Google\Cloud\Core\Iam\PolicyBuilder; /** * @group iam diff --git a/tests/snippets/Int64Test.php b/tests/snippets/Core/Int64Test.php similarity index 96% rename from tests/snippets/Int64Test.php rename to tests/snippets/Core/Int64Test.php index ee4f4427a6ab..d9d10a22f9a6 100644 --- a/tests/snippets/Int64Test.php +++ b/tests/snippets/Core/Int64Test.php @@ -18,10 +18,10 @@ namespace Google\Cloud\Tests\Snippets; use Google\Cloud\Dev\Snippet\SnippetTestCase; -use Google\Cloud\Int64; +use Google\Cloud\Core\Int64; /** - * @group root + * @group core */ class Int64Test extends SnippetTestCase { diff --git a/tests/snippets/Datastore/DatastoreClientTest.php b/tests/snippets/Datastore/DatastoreClientTest.php index 54037599843d..e12caf10c27c 100644 --- a/tests/snippets/Datastore/DatastoreClientTest.php +++ b/tests/snippets/Datastore/DatastoreClientTest.php @@ -30,7 +30,7 @@ use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\Transaction; use Google\Cloud\Dev\Snippet\SnippetTestCase; -use Google\Cloud\Int64; +use Google\Cloud\Core\Int64; use Prophecy\Argument; /** @@ -68,17 +68,9 @@ public function testClass() $this->assertInstanceOf(DatastoreClient::class, $res->returnVal()); } - public function testClassDirectInstantiation() - { - $snippet = $this->snippetFromClass(DatastoreClient::class, 1); - $res = $snippet->invoke('datastore'); - - $this->assertInstanceOf(DatastoreClient::class, $res->returnVal()); - } - public function testMultiTenant() { - $snippet = $this->snippetFromClass(DatastoreClient::class, 2); + $snippet = $this->snippetFromClass(DatastoreClient::class, 1); $res = $snippet->invoke('datastore'); $this->assertInstanceOf(DatastoreClient::class, $res->returnVal()); @@ -100,7 +92,7 @@ public function testMultiTenant() public function testEmulator() { - $snippet = $this->snippetFromClass(DatastoreClient::class, 3); + $snippet = $this->snippetFromClass(DatastoreClient::class, 2); $res = $snippet->invoke('datastore'); $this->assertInstanceOf(DatastoreClient::class, $res->returnVal()); diff --git a/tests/snippets/Logging/LoggingClientTest.php b/tests/snippets/Logging/LoggingClientTest.php index 585ec9d4b0d5..305ee83e1fa8 100644 --- a/tests/snippets/Logging/LoggingClientTest.php +++ b/tests/snippets/Logging/LoggingClientTest.php @@ -49,14 +49,6 @@ public function testClass() $this->assertInstanceOf(LoggingClient::class, $res->returnVal()); } - public function testClassDirectInstantiation() - { - $snippet = $this->snippetFromClass(LoggingClient::class, 1); - $res = $snippet->invoke('logging'); - - $this->assertInstanceOf(LoggingClient::class, $res->returnVal()); - } - public function testCreateSink() { $snippet = $this->snippetFromMethod(LoggingClient::class, 'createSink'); diff --git a/tests/snippets/NaturalLanguage/NaturalLanguageClientTest.php b/tests/snippets/NaturalLanguage/NaturalLanguageClientTest.php index 123fdd8f11f5..f8035d9cca33 100644 --- a/tests/snippets/NaturalLanguage/NaturalLanguageClientTest.php +++ b/tests/snippets/NaturalLanguage/NaturalLanguageClientTest.php @@ -44,13 +44,6 @@ public function testClass() $this->assertInstanceOf(NaturalLanguageClient::class, $res->returnVal()); } - public function testClassDirect() - { - $snippet = $this->snippetFromClass(NaturalLanguageClient::class, 1); - $res = $snippet->invoke('language'); - $this->assertInstanceOf(NaturalLanguageClient::class, $res->returnVal()); - } - public function testAnalyzeEntities() { $this->connection->analyzeEntities(Argument::any()) diff --git a/tests/snippets/PubSub/MessageTest.php b/tests/snippets/PubSub/MessageTest.php index c8991e5fc87f..4b8fdeda2870 100644 --- a/tests/snippets/PubSub/MessageTest.php +++ b/tests/snippets/PubSub/MessageTest.php @@ -73,7 +73,7 @@ public function testClass() $snippet = $this->snippetFromClass(Message::class); $snippet->addLocal('connectionStub', $connection->reveal()); - $snippet->insertAfterLine(3, '$reflection = new \ReflectionClass($pubsub); + $snippet->insertAfterLine(2, '$reflection = new \ReflectionClass($pubsub); $property = $reflection->getProperty(\'connection\'); $property->setAccessible(true); $property->setValue($pubsub, $connectionStub); diff --git a/tests/snippets/PubSub/PubSubClientTest.php b/tests/snippets/PubSub/PubSubClientTest.php index 8fd768c1d715..e17e2019c020 100644 --- a/tests/snippets/PubSub/PubSubClientTest.php +++ b/tests/snippets/PubSub/PubSubClientTest.php @@ -43,7 +43,7 @@ public function setUp() $this->client = new \PubSubClientStub(['transport' => 'rest']); } - public function testClassExample1() + public function testClassExample() { $snippet = $this->snippetFromClass(PubSubClient::class); $res = $snippet->invoke('pubsub'); @@ -51,18 +51,10 @@ public function testClassExample1() $this->assertInstanceOf(PubSubClient::class, $res->returnVal()); } - public function testClassExample2() - { - $snippet = $this->snippetFromClass(PubSubClient::class, 1); - $res = $snippet->invoke('pubsub'); - - $this->assertInstanceOf(PubSubClient::class, $res->returnVal()); - } - // phpunit doesn't get the value of $_ENV, so testing PUBSUB_EMULATOR_HOST is pretty tough. public function testClassExample3() { - $snippet = $this->snippetFromClass(PubSubClient::class, 2); + $snippet = $this->snippetFromClass(PubSubClient::class, 1); $res = $snippet->invoke('pubsub'); $this->assertInstanceOf(PubSubClient::class, $res->returnVal()); diff --git a/tests/snippets/PubSub/SubscriptionTest.php b/tests/snippets/PubSub/SubscriptionTest.php index 84cefa0ce3a7..22fdebeab968 100644 --- a/tests/snippets/PubSub/SubscriptionTest.php +++ b/tests/snippets/PubSub/SubscriptionTest.php @@ -19,7 +19,7 @@ use Google\Cloud\Dev\SetStubConnectionTrait; use Google\Cloud\Dev\Snippet\SnippetTestCase; -use Google\Cloud\Iam\Iam; +use Google\Cloud\Core\Iam\Iam; use Google\Cloud\PubSub\Connection\ConnectionInterface; use Google\Cloud\PubSub\Message; use Google\Cloud\PubSub\PubSubClient; diff --git a/tests/snippets/PubSub/TopicTest.php b/tests/snippets/PubSub/TopicTest.php index c7e7230af0a7..61e920201aad 100644 --- a/tests/snippets/PubSub/TopicTest.php +++ b/tests/snippets/PubSub/TopicTest.php @@ -18,7 +18,7 @@ namespace Google\Cloud\Tests\Snippets\PubSub; use Google\Cloud\Dev\Snippet\SnippetTestCase; -use Google\Cloud\Iam\Iam; +use Google\Cloud\Core\Iam\Iam; use Google\Cloud\PubSub\Connection\ConnectionInterface; use Google\Cloud\PubSub\Subscription; use Google\Cloud\PubSub\Topic; diff --git a/tests/snippets/Speech/SpeechClientTest.php b/tests/snippets/Speech/SpeechClientTest.php index b823391e0152..ba51616aaf3b 100644 --- a/tests/snippets/Speech/SpeechClientTest.php +++ b/tests/snippets/Speech/SpeechClientTest.php @@ -48,14 +48,6 @@ public function testClass() $this->assertInstanceOf(SpeechClient::class, $res->returnVal()); } - public function testClassDirectInstantiation() - { - $snippet = $this->snippetFromClass(SpeechClient::class, 1); - - $res = $snippet->invoke('speech'); - $this->assertInstanceOf(SpeechClient::class, $res->returnVal()); - } - public function testRecognize() { $snippet = $this->snippetFromMethod(SpeechClient::class, 'recognize', 0); diff --git a/tests/snippets/Storage/BucketTest.php b/tests/snippets/Storage/BucketTest.php index 563c5b0061eb..1f120736db19 100644 --- a/tests/snippets/Storage/BucketTest.php +++ b/tests/snippets/Storage/BucketTest.php @@ -18,14 +18,14 @@ namespace Google\Cloud\Tests\Snippets\Storage; use Google\Cloud\Dev\Snippet\SnippetTestCase; -use Google\Cloud\Exception\GoogleException; +use Google\Cloud\Core\Exception\GoogleException; use Google\Cloud\Storage\Acl; use Google\Cloud\Storage\Bucket; use Google\Cloud\Storage\Connection\ConnectionInterface; use Google\Cloud\Storage\StorageObject; -use Google\Cloud\Upload\MultipartUploader; -use Google\Cloud\Upload\ResumableUploader; -use Google\Cloud\Upload\StreamableUploader; +use Google\Cloud\Core\Upload\MultipartUploader; +use Google\Cloud\Core\Upload\ResumableUploader; +use Google\Cloud\Core\Upload\StreamableUploader; use Prophecy\Argument; /** diff --git a/tests/snippets/Storage/StorageClientTest.php b/tests/snippets/Storage/StorageClientTest.php index 0c339bda8b3c..427eb75fcf56 100644 --- a/tests/snippets/Storage/StorageClientTest.php +++ b/tests/snippets/Storage/StorageClientTest.php @@ -47,13 +47,6 @@ public function testClass() $this->assertInstanceOf(StorageClient::class, $res->returnVal()); } - public function testClassDirectInstantiation() - { - $snippet = $this->snippetFromClass(StorageClient::class, 1); - $res = $snippet->invoke('storage'); - $this->assertInstanceOf(StorageClient::class, $res->returnVal()); - } - public function testBucket() { $snippet = $this->snippetFromMethod(StorageClient::class, 'bucket'); diff --git a/tests/snippets/Storage/StorageObjectTest.php b/tests/snippets/Storage/StorageObjectTest.php index c94204e3375f..0cd7f6e5fdd6 100644 --- a/tests/snippets/Storage/StorageObjectTest.php +++ b/tests/snippets/Storage/StorageObjectTest.php @@ -349,4 +349,14 @@ public function testIdentity() $res = $snippet->invoke(); $this->assertEquals(self::OBJECT, $res->output()); } + + public function testGcsUri() + { + $snippet = $this->snippetFromMethod(StorageObject::class, 'gcsUri'); + $snippet->addLocal('object', $this->object); + + $res = $snippet->invoke(); + $expectedOutput = sprintf('gs://%s/%s', self::BUCKET, self::OBJECT); + $this->assertEquals($expectedOutput, $res->output()); + } } diff --git a/tests/snippets/Translate/TranslateClientTest.php b/tests/snippets/Translate/TranslateClientTest.php index 7ec952b8bc4f..7f748e1ac0b2 100644 --- a/tests/snippets/Translate/TranslateClientTest.php +++ b/tests/snippets/Translate/TranslateClientTest.php @@ -45,14 +45,6 @@ public function testClass() $this->assertInstanceOf(TranslateClient::class, $res->returnVal()); } - public function testClassDirectInstantiation() - { - $snippet = $this->snippetFromClass(TranslateClient::class, 1); - $res = $snippet->invoke('translate'); - - $this->assertInstanceOf(TranslateClient::class, $res->returnVal()); - } - public function testTranslate() { $snippet = $this->snippetFromMethod(TranslateClient::class, 'translate'); diff --git a/tests/snippets/Vision/VisionClientTest.php b/tests/snippets/Vision/VisionClientTest.php index 4b7d677541c7..832c33591c4b 100644 --- a/tests/snippets/Vision/VisionClientTest.php +++ b/tests/snippets/Vision/VisionClientTest.php @@ -47,14 +47,6 @@ public function testClassWithServiceBuilder() $this->assertInstanceOf(VisionClient::class, $res->returnVal()); } - public function testClassDirectInstantiation() - { - $snippet = $this->snippetFromClass(VisionClient::class, 1); - $res = $snippet->invoke('vision'); - - $this->assertInstanceOf(VisionClient::class, $res->returnVal()); - } - public function testImage() { $snippet = $this->snippetFromMethod(VisionClient::class, 'image'); diff --git a/tests/snippets/bootstrap.php b/tests/snippets/bootstrap.php index b8c3c9ef2e53..0cfe02ec8cf8 100644 --- a/tests/snippets/bootstrap.php +++ b/tests/snippets/bootstrap.php @@ -29,7 +29,7 @@ file_put_contents(__DIR__ . '/../../build/snippets-uncovered.json', json_encode($uncovered, JSON_PRETTY_PRINT)); if (!empty($uncovered)) { - echo sprintf("\033[31mNOTICE: %s uncovered snippets! See build/snippets-uncovered.json for a report.\n", count($uncovered)); + echo sprintf("\033[31mNOTICE: %s uncovered snippets! \033[0m See build/snippets-uncovered.json for a report.\n", count($uncovered)); exit(1); } }); @@ -45,7 +45,7 @@ function stub($name, $extends) stub('BigQueryClientStub', Google\Cloud\BigQuery\BigQueryClient::class); stub('BucketStub', Google\Cloud\Storage\Bucket::class); stub('DatastoreClientStub', Google\Cloud\Datastore\DatastoreClient::class); -stub('IamStub', Google\Cloud\Iam\Iam::class); +stub('IamStub', Google\Cloud\Core\Iam\Iam::class); stub('LoggerStub', Google\Cloud\Logging\Logger::class); stub('LoggingClientStub', Google\Cloud\Logging\LoggingClient::class); stub('MetricStub', Google\Cloud\Logging\Metric::class); diff --git a/tests/system/BigQuery/BigQueryTestCase.php b/tests/system/BigQuery/BigQueryTestCase.php index ed9bc88d17c2..25f4bea43278 100644 --- a/tests/system/BigQuery/BigQueryTestCase.php +++ b/tests/system/BigQuery/BigQueryTestCase.php @@ -18,7 +18,7 @@ namespace Google\Cloud\Tests\System\BigQuery; use Google\Cloud\BigQuery\BigQueryClient; -use Google\Cloud\ExponentialBackoff; +use Google\Cloud\Core\ExponentialBackoff; use Google\Cloud\Storage\StorageClient; class BigQueryTestCase extends \PHPUnit_Framework_TestCase diff --git a/tests/system/BigQuery/LoadDataAndQueryTest.php b/tests/system/BigQuery/LoadDataAndQueryTest.php index 99c917c675f4..5ef687afe88d 100644 --- a/tests/system/BigQuery/LoadDataAndQueryTest.php +++ b/tests/system/BigQuery/LoadDataAndQueryTest.php @@ -19,10 +19,10 @@ use Google\Cloud\BigQuery\Bytes; use Google\Cloud\BigQuery\Date; +use Google\Cloud\Core\ExponentialBackoff; use Google\Cloud\BigQuery\Time; use Google\Cloud\BigQuery\Timestamp; use Google\Cloud\BigQuery\ValueMapper; -use Google\Cloud\ExponentialBackoff; use GuzzleHttp\Psr7; /** diff --git a/tests/system/BigQuery/ManageTablesTest.php b/tests/system/BigQuery/ManageTablesTest.php index 7dc53933d9b9..bba2824e2bc2 100644 --- a/tests/system/BigQuery/ManageTablesTest.php +++ b/tests/system/BigQuery/ManageTablesTest.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Tests\System\BigQuery; -use Google\Cloud\ExponentialBackoff; +use Google\Cloud\Core\ExponentialBackoff; /** * @group bigquery diff --git a/tests/system/Datastore/DatastoreTestCase.php b/tests/system/Datastore/DatastoreTestCase.php index aa726c76b8f3..4363eee9c863 100644 --- a/tests/system/Datastore/DatastoreTestCase.php +++ b/tests/system/Datastore/DatastoreTestCase.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Tests\System\Datastore; -use Google\Cloud\ExponentialBackoff; +use Google\Cloud\Core\ExponentialBackoff; use Google\Cloud\Datastore\DatastoreClient; class DatastoreTestCase extends \PHPUnit_Framework_TestCase diff --git a/tests/system/Datastore/SaveAndModifyTest.php b/tests/system/Datastore/SaveAndModifyTest.php index fa366daf8ef6..7ec8101224f4 100644 --- a/tests/system/Datastore/SaveAndModifyTest.php +++ b/tests/system/Datastore/SaveAndModifyTest.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Tests\System\Datastore; -use Google\Cloud\Int64; +use Google\Cloud\Core\Int64; /** * @group datastore diff --git a/tests/system/Logging/LoggingTestCase.php b/tests/system/Logging/LoggingTestCase.php index 9c93fec7d2cc..fdecd9cae58f 100644 --- a/tests/system/Logging/LoggingTestCase.php +++ b/tests/system/Logging/LoggingTestCase.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Tests\System\Logging; -use Google\Cloud\ExponentialBackoff; +use Google\Cloud\Core\ExponentialBackoff; use Google\Cloud\BigQuery\BigQueryClient; use Google\Cloud\Logging\LoggingClient; use Google\Cloud\PubSub\PubSubClient; diff --git a/tests/system/Logging/WriteAndListEntryTest.php b/tests/system/Logging/WriteAndListEntryTest.php index 12d74a847f1f..44b5a9e9e6ba 100644 --- a/tests/system/Logging/WriteAndListEntryTest.php +++ b/tests/system/Logging/WriteAndListEntryTest.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Tests\System\Logging; -use Google\Cloud\ExponentialBackoff; +use Google\Cloud\Core\ExponentialBackoff; /** * @group logging diff --git a/tests/system/NaturalLanguage/NaturalLanguageTestCase.php b/tests/system/NaturalLanguage/NaturalLanguageTestCase.php index cc6da38eb219..956ab308c4d9 100644 --- a/tests/system/NaturalLanguage/NaturalLanguageTestCase.php +++ b/tests/system/NaturalLanguage/NaturalLanguageTestCase.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Tests\System\NaturalLanguage; -use Google\Cloud\ExponentialBackoff; +use Google\Cloud\Core\ExponentialBackoff; use Google\Cloud\BigQuery\BigQueryClient; use Google\Cloud\NaturalLanguage\NaturalLanguageClient; use Google\Cloud\PubSub\PubSubClient; diff --git a/tests/system/PubSub/PubSubTestCase.php b/tests/system/PubSub/PubSubTestCase.php index 07dd04d87ad0..4e33b77d0268 100644 --- a/tests/system/PubSub/PubSubTestCase.php +++ b/tests/system/PubSub/PubSubTestCase.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Tests\System\PubSub; -use Google\Cloud\ExponentialBackoff; +use Google\Cloud\Core\ExponentialBackoff; use Google\Cloud\PubSub\PubSubClient; class PubSubTestCase extends \PHPUnit_Framework_TestCase diff --git a/tests/system/Storage/ManageAclTest.php b/tests/system/Storage/ManageAclTest.php index 5cf495fff7ff..872d44735da1 100644 --- a/tests/system/Storage/ManageAclTest.php +++ b/tests/system/Storage/ManageAclTest.php @@ -18,7 +18,7 @@ namespace Google\Cloud\Tests\System\Storage; use Google\Cloud\Storage\Acl; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; /** * @group storage diff --git a/tests/system/Storage/StorageTestCase.php b/tests/system/Storage/StorageTestCase.php index c41dbd700c54..461a54aa73ca 100644 --- a/tests/system/Storage/StorageTestCase.php +++ b/tests/system/Storage/StorageTestCase.php @@ -17,7 +17,7 @@ namespace Google\Cloud\Tests\System\Storage; -use Google\Cloud\ExponentialBackoff; +use Google\Cloud\Core\ExponentialBackoff; use Google\Cloud\Storage\StorageClient; class StorageTestCase extends \PHPUnit_Framework_TestCase diff --git a/tests/unit/BigQuery/BigQueryClientTest.php b/tests/unit/BigQuery/BigQueryClientTest.php index ad45055fd860..b4030ff4f374 100644 --- a/tests/unit/BigQuery/BigQueryClientTest.php +++ b/tests/unit/BigQuery/BigQueryClientTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\BigQueryClient; use Google\Cloud\BigQuery\Bytes; diff --git a/tests/unit/BigQuery/BytesTest.php b/tests/unit/BigQuery/BytesTest.php index 66e446c00c9f..37865bf9eafd 100644 --- a/tests/unit/BigQuery/BytesTest.php +++ b/tests/unit/BigQuery/BytesTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\Bytes; use GuzzleHttp\Psr7; diff --git a/tests/unit/BigQuery/Connection/RestTest.php b/tests/unit/BigQuery/Connection/RestTest.php index 50ebeba9a383..af3a26b5bcad 100644 --- a/tests/unit/BigQuery/Connection/RestTest.php +++ b/tests/unit/BigQuery/Connection/RestTest.php @@ -15,10 +15,13 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery\Connection; +namespace Google\Cloud\Tests\Unit\BigQuery\Connection; +use Google\Cloud\BigQuery\BigQueryClient; use Google\Cloud\BigQuery\Connection\Rest; -use Google\Cloud\Upload\AbstractUploader; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\Upload\AbstractUploader; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; @@ -35,7 +38,7 @@ class RestTest extends \PHPUnit_Framework_TestCase public function setUp() { - $this->requestWrapper = $this->prophesize('Google\Cloud\RequestWrapper'); + $this->requestWrapper = $this->prophesize(RequestWrapper::class); $this->successBody = '{"canI":"kickIt"}'; } @@ -48,7 +51,7 @@ public function testCallBasicMethods($method) $request = new Request('GET', '/somewhere'); $response = new Response(200, [], $this->successBody); - $requestBuilder = $this->prophesize('Google\Cloud\RequestBuilder'); + $requestBuilder = $this->prophesize(RequestBuilder::class); $requestBuilder->build( Argument::type('string'), Argument::type('string'), @@ -56,7 +59,7 @@ public function testCallBasicMethods($method) )->willReturn($request); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->willReturn($response); @@ -115,7 +118,7 @@ public function testInsertJobUpload() ] ])); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->will( function ($args) use (&$actualRequest, $response) { diff --git a/tests/unit/BigQuery/DatasetTest.php b/tests/unit/BigQuery/DatasetTest.php index 10b1f1da2140..1f9703811f96 100644 --- a/tests/unit/BigQuery/DatasetTest.php +++ b/tests/unit/BigQuery/DatasetTest.php @@ -15,13 +15,13 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\Connection\ConnectionInterface; use Google\Cloud\BigQuery\Dataset; use Google\Cloud\BigQuery\Table; use Google\Cloud\BigQuery\ValueMapper; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Prophecy\Argument; /** diff --git a/tests/unit/BigQuery/DateTest.php b/tests/unit/BigQuery/DateTest.php index 6e28a8f8449d..a7479819619b 100644 --- a/tests/unit/BigQuery/DateTest.php +++ b/tests/unit/BigQuery/DateTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\Date; diff --git a/tests/unit/BigQuery/InsertResponseTest.php b/tests/unit/BigQuery/InsertResponseTest.php index c411a3b53e1a..2081d0d33b74 100644 --- a/tests/unit/BigQuery/InsertResponseTest.php +++ b/tests/unit/BigQuery/InsertResponseTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\InsertResponse; use Prophecy\Argument; diff --git a/tests/unit/BigQuery/JobTest.php b/tests/unit/BigQuery/JobTest.php index 8613fa90ff3e..5bbcf5251b2a 100644 --- a/tests/unit/BigQuery/JobTest.php +++ b/tests/unit/BigQuery/JobTest.php @@ -15,13 +15,13 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\Connection\ConnectionInterface; use Google\Cloud\BigQuery\Job; use Google\Cloud\BigQuery\QueryResults; use Google\Cloud\BigQuery\ValueMapper; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Prophecy\Argument; /** diff --git a/tests/unit/BigQuery/QueryResultsTest.php b/tests/unit/BigQuery/QueryResultsTest.php index 8e642b5e3e4b..8f655d3a71aa 100644 --- a/tests/unit/BigQuery/QueryResultsTest.php +++ b/tests/unit/BigQuery/QueryResultsTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\Connection\ConnectionInterface; use Google\Cloud\BigQuery\QueryResults; @@ -63,7 +63,7 @@ public function getQueryResults($connection, array $data = []) } /** - * @expectedException \Google\Cloud\Exception\GoogleException + * @expectedException \Google\Cloud\Core\Exception\GoogleException */ public function testGetsRowsThrowsExceptionWhenQueryNotComplete() { diff --git a/tests/unit/BigQuery/TableTest.php b/tests/unit/BigQuery/TableTest.php index b20fd86338c0..7082d2cc8466 100644 --- a/tests/unit/BigQuery/TableTest.php +++ b/tests/unit/BigQuery/TableTest.php @@ -15,17 +15,17 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\Connection\ConnectionInterface; use Google\Cloud\BigQuery\InsertResponse; use Google\Cloud\BigQuery\Job; use Google\Cloud\BigQuery\Table; use Google\Cloud\BigQuery\ValueMapper; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; +use Google\Cloud\Core\Upload\AbstractUploader; use Google\Cloud\Storage\Connection\ConnectionInterface as StorageConnectionInterface; use Google\Cloud\Storage\StorageObject; -use Google\Cloud\Upload\AbstractUploader; use Prophecy\Argument; /** @@ -217,9 +217,11 @@ public function testRunsCopyJob() $this->assertEquals($this->insertJobResponse, $job->info()); } - public function testRunsExportJob() + /** + * @dataProvider destinationProvider + */ + public function testRunsExportJob($destinationObject) { - $destinationObject = $this->getObject(); $expectedArguments = [ 'projectId' => $this->projectId, 'configuration' => [ @@ -245,6 +247,20 @@ public function testRunsExportJob() $this->assertEquals($this->insertJobResponse, $job->info()); } + public function destinationProvider() + { + $this->setUp(); + + return [ + [$this->getObject()], + [sprintf( + 'gs://%s/%s', + $this->bucketName, + $this->fileName + )] + ]; + } + public function testRunsLoadJob() { $data = 'abc'; diff --git a/tests/unit/BigQuery/TimeTest.php b/tests/unit/BigQuery/TimeTest.php index b26681473b1e..72cba3ec585d 100644 --- a/tests/unit/BigQuery/TimeTest.php +++ b/tests/unit/BigQuery/TimeTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\Time; diff --git a/tests/unit/BigQuery/TimestampTest.php b/tests/unit/BigQuery/TimestampTest.php index e918bf393f8c..a0f47795289c 100644 --- a/tests/unit/BigQuery/TimestampTest.php +++ b/tests/unit/BigQuery/TimestampTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\Timestamp; diff --git a/tests/unit/BigQuery/ValueMapperTest.php b/tests/unit/BigQuery/ValueMapperTest.php index 157ba271958a..4b211f8a294a 100644 --- a/tests/unit/BigQuery/ValueMapperTest.php +++ b/tests/unit/BigQuery/ValueMapperTest.php @@ -15,14 +15,14 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\BigQuery; +namespace Google\Cloud\Tests\Unit\BigQuery; use Google\Cloud\BigQuery\Bytes; use Google\Cloud\BigQuery\Date; use Google\Cloud\BigQuery\Time; use Google\Cloud\BigQuery\Timestamp; use Google\Cloud\BigQuery\ValueMapper; -use Google\Cloud\Int64; +use Google\Cloud\Core\Int64; /** * @group bigquery diff --git a/tests/unit/ArrayTraitTest.php b/tests/unit/Core/ArrayTraitTest.php similarity index 96% rename from tests/unit/ArrayTraitTest.php rename to tests/unit/Core/ArrayTraitTest.php index 53dc38667917..362b6e124923 100644 --- a/tests/unit/ArrayTraitTest.php +++ b/tests/unit/Core/ArrayTraitTest.php @@ -15,13 +15,13 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\ArrayTrait; +use Google\Cloud\Core\ArrayTrait; use Prophecy\Argument; /** - * @group root + * @group core */ class ArrayTraitTest extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/CallTraitTest.php b/tests/unit/Core/CallTraitTest.php similarity index 93% rename from tests/unit/CallTraitTest.php rename to tests/unit/Core/CallTraitTest.php index b17fa31165bb..6ae6842ca25a 100644 --- a/tests/unit/CallTraitTest.php +++ b/tests/unit/Core/CallTraitTest.php @@ -15,12 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Test; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\CallTrait; +use Google\Cloud\Core\CallTrait; /** - * @group root + * @group core */ class CallTraitTest extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/ClientTraitTest.php b/tests/unit/Core/ClientTraitTest.php similarity index 88% rename from tests/unit/ClientTraitTest.php rename to tests/unit/Core/ClientTraitTest.php index 4e581f3e9a3e..d79f04120472 100644 --- a/tests/unit/ClientTraitTest.php +++ b/tests/unit/Core/ClientTraitTest.php @@ -15,19 +15,19 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\ClientTrait; -use Google\Cloud\Compute\Metadata; +use Google\Cloud\Core\ClientTrait; +use Google\Cloud\Core\Compute\Metadata; use GuzzleHttp\Psr7\Response; /** - * @group root + * @group core */ class ClientTraitTest extends \PHPUnit_Framework_TestCase { /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testGetConnectionTypeThrowsExceptionWhenAttempingGrpcWithoutDeps() { @@ -69,7 +69,7 @@ public function dependencyStatusProvider() public function testConfigureAuthentication() { - $keyFilePath = __DIR__ . '/fixtures/json-key-fixture.json'; + $keyFilePath = __DIR__ . '/../fixtures/json-key-fixture.json'; putenv("GOOGLE_APPLICATION_CREDENTIALS=$keyFilePath"); // for application default credentials $trait = new ClientTraitStub; @@ -81,7 +81,7 @@ public function testConfigureAuthentication() public function testConfigureAuthenticationWithKeyFile() { - $keyFilePath = __DIR__ . '/fixtures/json-key-fixture.json'; + $keyFilePath = __DIR__ . '/../fixtures/json-key-fixture.json'; $keyFile = json_decode(file_get_contents($keyFilePath), true); $keyFile['project_id'] = 'test'; @@ -96,7 +96,7 @@ public function testConfigureAuthenticationWithKeyFile() public function testConfigureAuthenticationWithKeyFilePath() { - $keyFilePath = __DIR__ . '/fixtures/json-key-fixture.json'; + $keyFilePath = __DIR__ . '/../fixtures/json-key-fixture.json'; $keyFile = json_decode(file_get_contents($keyFilePath), true); $trait = new ClientTraitStub; @@ -109,7 +109,7 @@ public function testConfigureAuthenticationWithKeyFilePath() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testConfigureAuthenticationWithInvalidKeyFilePath() { @@ -122,7 +122,7 @@ public function testConfigureAuthenticationWithInvalidKeyFilePath() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testConfigureAuthenticationWithKeyFileThatCantBeDecoded() { @@ -135,11 +135,11 @@ public function testConfigureAuthenticationWithKeyFileThatCantBeDecoded() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testDetectProjectIdWithNoProjectIdAvailable() { - $keyFilePath = __DIR__ . '/fixtures/json-key-fixture.json'; + $keyFilePath = __DIR__ . '/../fixtures/json-key-fixture.json'; $keyFile = json_decode(file_get_contents($keyFilePath), true); unset($keyFile['project_id']); @@ -167,7 +167,7 @@ public function testDetectProjectIdOnGce() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testDetectProjectIdOnGceButOhNoThereStillIsntAProjectId() { diff --git a/tests/unit/Compute/MetadataTest.php b/tests/unit/Core/Compute/MetadataTest.php similarity index 92% rename from tests/unit/Compute/MetadataTest.php rename to tests/unit/Core/Compute/MetadataTest.php index 599d20c09f4d..6b939bac9f28 100644 --- a/tests/unit/Compute/MetadataTest.php +++ b/tests/unit/Core/Compute/MetadataTest.php @@ -15,11 +15,13 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Compute; +namespace Google\Cloud\Tests\Unit\Core\Compute; -use Google\Cloud\Compute\Metadata; +use Google\Cloud\Core\Compute\Metadata; +use Google\Cloud\Core\Compute\Metadata\Readers\StreamReader; /** + * @group core * @group compute */ class MetadataTest extends \PHPUnit_Framework_TestCase @@ -31,7 +33,7 @@ public function setUp() { $this->metadata = new Metadata(); $this->mock = $this->getMockBuilder( - '\Google\Cloud\Compute\Metadata\Readers\StreamReader') + StreamReader::class) ->setMethods(array('read')) ->getmock(); $this->metadata->setReader($this->mock); diff --git a/tests/unit/EmulatorTraitTest.php b/tests/unit/Core/EmulatorTraitTest.php similarity index 93% rename from tests/unit/EmulatorTraitTest.php rename to tests/unit/Core/EmulatorTraitTest.php index 13cc5767190b..e0ae80ec0fbb 100644 --- a/tests/unit/EmulatorTraitTest.php +++ b/tests/unit/Core/EmulatorTraitTest.php @@ -15,13 +15,13 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\EmulatorTrait; +use Google\Cloud\Core\EmulatorTrait; use Prophecy\Argument; /** - * @group root + * @group core */ class EmulatorTraitTest extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/Exception/ServiceExceptionTest.php b/tests/unit/Core/Exception/ServiceExceptionTest.php similarity index 90% rename from tests/unit/Exception/ServiceExceptionTest.php rename to tests/unit/Core/Exception/ServiceExceptionTest.php index aa4554a182ab..cec5d5c85be0 100644 --- a/tests/unit/Exception/ServiceExceptionTest.php +++ b/tests/unit/Core/Exception/ServiceExceptionTest.php @@ -15,11 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Exception; +namespace Google\Cloud\Tests\Unit\Core\Exception; -use Google\Cloud\Exception\ServiceException; +use Google\Cloud\Core\Exception\ServiceException; /** + * @group core * @group exception */ class ServiceExceptionTest extends \PHPUnit_Framework_TestCase diff --git a/tests/unit/ExponentialBackoffTest.php b/tests/unit/Core/ExponentialBackoffTest.php similarity index 97% rename from tests/unit/ExponentialBackoffTest.php rename to tests/unit/Core/ExponentialBackoffTest.php index 884948172ece..8971a38bbf5b 100644 --- a/tests/unit/ExponentialBackoffTest.php +++ b/tests/unit/Core/ExponentialBackoffTest.php @@ -15,13 +15,13 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\ExponentialBackoff; +use Google\Cloud\Core\ExponentialBackoff; use Prophecy\Argument; /** - * @group root + * @group core */ class ExponentialBackoffTest extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/GrpcRequestWrapperTest.php b/tests/unit/Core/GrpcRequestWrapperTest.php similarity index 89% rename from tests/unit/GrpcRequestWrapperTest.php rename to tests/unit/Core/GrpcRequestWrapperTest.php index e8dc9014246d..ff171e827864 100644 --- a/tests/unit/GrpcRequestWrapperTest.php +++ b/tests/unit/Core/GrpcRequestWrapperTest.php @@ -16,18 +16,19 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; use DrSlump\Protobuf\Message; -use Google\Cloud\Exception; -use Google\Cloud\GrpcRequestWrapper; +use Google\Auth\FetchAuthTokenInterface; +use Google\Cloud\Core\Exception; +use Google\Cloud\Core\GrpcRequestWrapper; use Google\GAX\ApiException; use Google\GAX\Page; use Google\GAX\PagedListResponse; use Prophecy\Argument; /** - * @group root + * @group core */ class GrpcRequestWrapperTest extends \PHPUnit_Framework_TestCase { @@ -73,7 +74,7 @@ public function responseProvider() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testThrowsExceptionWhenRequestFails() { @@ -104,7 +105,7 @@ public function testCredentialsFetcher($wrapperConfig) $requestWrapper = new GrpcRequestWrapper($wrapperConfig); $this->assertInstanceOf( - 'Google\Auth\FetchAuthTokenInterface', + FetchAuthTokenInterface::class, $requestWrapper->getCredentialsFetcher() ); } @@ -119,15 +120,15 @@ public function testCredentialsFromKeyFileStreamCanBeReadMultipleTimes($wrapperC $requestWrapper->getCredentialsFetcher(); $credentials = $requestWrapper->getCredentialsFetcher(); - $this->assertInstanceOf('Google\Auth\FetchAuthTokenInterface', $credentials); + $this->assertInstanceOf(FetchAuthTokenInterface::class, $credentials); } public function credentialsProvider() { - $keyFilePath = __DIR__ . '/fixtures/json-key-fixture.json'; + $keyFilePath = __DIR__ . '/../fixtures/json-key-fixture.json'; putenv("GOOGLE_APPLICATION_CREDENTIALS=$keyFilePath"); // for application default credentials - $credentialsFetcher = $this->prophesize('Google\Auth\FetchAuthTokenInterface'); + $credentialsFetcher = $this->prophesize(FetchAuthTokenInterface::class); return [ [['keyFile' => json_decode(file_get_contents($keyFilePath), true)]], // keyFile @@ -139,7 +140,7 @@ public function credentialsProvider() public function keyFileCredentialsProvider() { - $keyFilePath = __DIR__ . '/fixtures/json-key-fixture.json'; + $keyFilePath = __DIR__ . '/../fixtures/json-key-fixture.json'; return [ [['keyFile' => json_decode(file_get_contents($keyFilePath), true)]], // keyFile diff --git a/tests/unit/GrpcTraitTest.php b/tests/unit/Core/GrpcTraitTest.php similarity index 96% rename from tests/unit/GrpcTraitTest.php rename to tests/unit/Core/GrpcTraitTest.php index ae8e77af5330..642b4aed9085 100644 --- a/tests/unit/GrpcTraitTest.php +++ b/tests/unit/Core/GrpcTraitTest.php @@ -15,18 +15,17 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; use Google\Auth\Cache\MemoryCacheItemPool; use Google\Auth\FetchAuthTokenCache; use Google\Auth\FetchAuthTokenInterface; -use Google\Cloud\GrpcRequestWrapper; -use Google\Cloud\GrpcTrait; -use Google\Cloud\ServiceBuilder; +use Google\Cloud\Core\GrpcRequestWrapper; +use Google\Cloud\Core\GrpcTrait; use Prophecy\Argument; /** - * @group root + * @group core */ class GrpcTraitTest extends \PHPUnit_Framework_TestCase { @@ -65,6 +64,8 @@ public function testSendsRequest() public function testGetsGaxConfig() { + $version = '1.0.0'; + $fetcher = $this->prophesize(FetchAuthTokenInterface::class)->reveal(); $this->requestWrapper->getCredentialsFetcher()->willReturn($fetcher); $this->implementation->setRequestWrapper($this->requestWrapper->reveal()); @@ -72,10 +73,10 @@ public function testGetsGaxConfig() 'credentialsLoader' => $fetcher, 'enableCaching' => false, 'libName' => 'gccl', - 'libVersion' => ServiceBuilder::VERSION + 'libVersion' => $version ]; - $this->assertEquals($expected, $this->implementation->call('getGaxConfig')); + $this->assertEquals($expected, $this->implementation->call('getGaxConfig', [$version])); } public function testFormatsTimestamp() diff --git a/tests/unit/Iam/IamTest.php b/tests/unit/Core/Iam/IamTest.php similarity index 96% rename from tests/unit/Iam/IamTest.php rename to tests/unit/Core/Iam/IamTest.php index 16262c9e0d44..58d9218a3469 100644 --- a/tests/unit/Iam/IamTest.php +++ b/tests/unit/Core/Iam/IamTest.php @@ -15,13 +15,14 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Iam; +namespace Google\Cloud\Tests\Unit\Core\Iam; -use Google\Cloud\Iam\Iam; -use Google\Cloud\Iam\IamConnectionInterface; +use Google\Cloud\Core\Iam\Iam; +use Google\Cloud\Core\Iam\IamConnectionInterface; use Prophecy\Argument; /** + * @group core * @group iam */ class IamTest extends \PHPUnit_Framework_TestCase diff --git a/tests/unit/Iam/PolicyBuilderTest.php b/tests/unit/Core/Iam/PolicyBuilderTest.php similarity index 97% rename from tests/unit/Iam/PolicyBuilderTest.php rename to tests/unit/Core/Iam/PolicyBuilderTest.php index cf411eb3bb6f..e271bae45923 100644 --- a/tests/unit/Iam/PolicyBuilderTest.php +++ b/tests/unit/Core/Iam/PolicyBuilderTest.php @@ -15,11 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Iam; +namespace Google\Cloud\Tests\Unit\Core\Iam; -use Google\Cloud\Iam\PolicyBuilder; +use Google\Cloud\Core\Iam\PolicyBuilder; /** + * @group core * @group iam */ class PolicyBuilderTest extends \PHPUnit_Framework_TestCase diff --git a/tests/unit/Int64Test.php b/tests/unit/Core/Int64Test.php similarity index 92% rename from tests/unit/Int64Test.php rename to tests/unit/Core/Int64Test.php index 5bf9b7626ac1..770a1b3e8e4e 100644 --- a/tests/unit/Int64Test.php +++ b/tests/unit/Core/Int64Test.php @@ -15,12 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\Int64; +use Google\Cloud\Core\Int64; /** - * @group root + * @group core */ class Int64Test extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/JsonTraitTest.php b/tests/unit/Core/JsonTraitTest.php similarity index 95% rename from tests/unit/JsonTraitTest.php rename to tests/unit/Core/JsonTraitTest.php index b4d94b171aa6..19e169658db7 100644 --- a/tests/unit/JsonTraitTest.php +++ b/tests/unit/Core/JsonTraitTest.php @@ -15,9 +15,9 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\JsonTrait; +use Google\Cloud\Core\JsonTrait; /** * @group root diff --git a/tests/unit/Logger/AppEngineFlexHandlerTest.php b/tests/unit/Core/Logger/AppEngineFlexHandlerTest.php similarity index 93% rename from tests/unit/Logger/AppEngineFlexHandlerTest.php rename to tests/unit/Core/Logger/AppEngineFlexHandlerTest.php index 9222cce2ef70..4ea7e0fa76e1 100644 --- a/tests/unit/Logger/AppEngineFlexHandlerTest.php +++ b/tests/unit/Core/Logger/AppEngineFlexHandlerTest.php @@ -15,12 +15,13 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Logger; +namespace Google\Cloud\Tests\Unit\Core\Logger; -use Google\Cloud\Logger\AppEngineFlexHandler; +use Google\Cloud\Core\Logger\AppEngineFlexHandler; use Monolog\Logger; /** + * @group core * @group logger */ class AppEngineFlexHandlerTest extends \PHPUnit_Framework_TestCase diff --git a/tests/unit/PhpArrayTest.php b/tests/unit/Core/PhpArrayTest.php similarity index 96% rename from tests/unit/PhpArrayTest.php rename to tests/unit/Core/PhpArrayTest.php index 4df80c571925..7a207cc2d605 100644 --- a/tests/unit/PhpArrayTest.php +++ b/tests/unit/Core/PhpArrayTest.php @@ -15,14 +15,14 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; use DrSlump\Protobuf\Message; -use Google\Cloud\PhpArray; +use Google\Cloud\Core\PhpArray; use Prophecy\Argument; /** - * @group root + * @group core */ class PhpArrayTest extends \PHPUnit_Framework_TestCase { @@ -119,7 +119,7 @@ public static function descriptor() $f->name = "test_labels"; $f->type = \DrSlump\Protobuf::TYPE_MESSAGE; $f->rule = \DrSlump\Protobuf::RULE_REPEATED; - $f->reference = '\Google\Cloud\Tests\TestLabelsEntry'; + $f->reference = '\Google\Cloud\Tests\Unit\Core\TestLabelsEntry'; $descriptor->addField($f); $f = new \DrSlump\Protobuf\Field(); diff --git a/tests/unit/RequestBuilderTest.php b/tests/unit/Core/RequestBuilderTest.php similarity index 91% rename from tests/unit/RequestBuilderTest.php rename to tests/unit/Core/RequestBuilderTest.php index 36831d4d5ac5..7d7d8ce66497 100644 --- a/tests/unit/RequestBuilderTest.php +++ b/tests/unit/Core/RequestBuilderTest.php @@ -15,20 +15,20 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\RequestBuilder; +use Google\Cloud\Core\RequestBuilder; use Prophecy\Argument; /** - * @group root + * @group core */ class RequestBuilderTest extends \PHPUnit_Framework_TestCase { public function setUp() { $this->builder = new RequestBuilder( - __DIR__ . '/fixtures/service-fixture.json', + __DIR__ . '/../fixtures/service-fixture.json', 'http://www.example.com/' ); } @@ -52,7 +52,7 @@ public function testBuildsRequest() public function testBuildsNestedRequest() { $builder = new RequestBuilder( - __DIR__ . '/fixtures/service-fixture.json', + __DIR__ . '/../fixtures/service-fixture.json', 'http://www.example.com/', ['resources', 'projects', 'otherThing'] ); @@ -74,7 +74,7 @@ public function testBuildsNestedRequest() public function testBuildsNestedRequestWithStringSplitting() { $builder = new RequestBuilder( - __DIR__ . '/fixtures/service-fixture.json', + __DIR__ . '/../fixtures/service-fixture.json', 'http://www.example.com/', ['resources', 'projects', 'otherThing'] ); diff --git a/tests/unit/RequestWrapperTest.php b/tests/unit/Core/RequestWrapperTest.php similarity index 88% rename from tests/unit/RequestWrapperTest.php rename to tests/unit/Core/RequestWrapperTest.php index 3158836dd5b5..00ca37d1b7e7 100644 --- a/tests/unit/RequestWrapperTest.php +++ b/tests/unit/Core/RequestWrapperTest.php @@ -16,9 +16,10 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\RequestWrapper; +use Google\Auth\FetchAuthTokenInterface; +use Google\Cloud\Core\RequestWrapper; use Google\Cloud\ServiceBuilder; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\Request; @@ -26,10 +27,12 @@ use Prophecy\Argument; /** - * @group root + * @group core */ class RequestWrapperTest extends \PHPUnit_Framework_TestCase { + const VERSION = 'v0.1'; + public function testSuccessfullySendsRequest() { $expectedBody = 'responseBody'; @@ -50,7 +53,7 @@ public function testSuccessfullySendsRequest() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testThrowsExceptionWhenRequestFails() { @@ -96,7 +99,7 @@ public function testCredentialsFetcher($wrapperConfig) $requestWrapper = new RequestWrapper($wrapperConfig); $this->assertInstanceOf( - 'Google\Auth\FetchAuthTokenInterface', + FetchAuthTokenInterface::class, $requestWrapper->getCredentialsFetcher() ); } @@ -111,7 +114,7 @@ public function testCredentialsFromKeyFileStreamCanBeReadMultipleTimes($wrapperC $requestWrapper->getCredentialsFetcher(); $credentials = $requestWrapper->getCredentialsFetcher(); - $this->assertInstanceOf('Google\Auth\FetchAuthTokenInterface', $credentials); + $this->assertInstanceOf(FetchAuthTokenInterface::class, $credentials); } public function credentialsProvider() @@ -125,10 +128,10 @@ public function credentialsProvider() } ]; - $keyFilePath = __DIR__ . '/fixtures/json-key-fixture.json'; + $keyFilePath = __DIR__ . '/../fixtures/json-key-fixture.json'; putenv("GOOGLE_APPLICATION_CREDENTIALS=$keyFilePath"); // for application default credentials - $credentialsFetcher = $this->prophesize('Google\Auth\FetchAuthTokenInterface'); + $credentialsFetcher = $this->prophesize(FetchAuthTokenInterface::class); $credentialsFetcher->fetchAuthToken(Argument::any()) ->willReturn(['access_token' => 'abc']); @@ -151,7 +154,7 @@ public function keyFileCredentialsProvider() } ]; - $keyFilePath = __DIR__ . '/fixtures/json-key-fixture.json'; + $keyFilePath = __DIR__ . '/../fixtures/json-key-fixture.json'; return [ [$config + ['keyFile' => json_decode(file_get_contents($keyFilePath), true)]], // keyFile @@ -162,11 +165,12 @@ public function keyFileCredentialsProvider() public function testAddsUserAgentAndXGoogApiClientToRequest() { $requestWrapper = new RequestWrapper([ + 'componentVersion' => self::VERSION, 'httpHandler' => function ($request, $options = []) { $userAgent = $request->getHeaderLine('User-Agent'); - $this->assertEquals('gcloud-php/' . ServiceBuilder::VERSION, $userAgent); + $this->assertEquals('gcloud-php/' . self::VERSION, $userAgent); $xGoogApiClient = $request->getHeaderLine('x-goog-api-client'); - $this->assertEquals('gl-php/' . phpversion() . ' gccl/' . ServiceBuilder::VERSION, $xGoogApiClient); + $this->assertEquals('gl-php/' . phpversion() . ' gccl/' . self::VERSION, $xGoogApiClient); return new Response(200); }, 'accessToken' => 'abc' @@ -196,17 +200,19 @@ public function testAddsTokenToRequest() public function testRequestUsesApiKeyInsteadOfAuthHeader() { + $version = '1.0.0'; $requestWrapper = new RequestWrapper([ - 'httpHandler' => function ($request, $options = []) { + 'httpHandler' => function ($request, $options = []) use ($version) { $authHeader = $request->getHeaderLine('Authorization'); $userAgent = $request->getHeaderLine('User-Agent'); $xGoogApiClient = $request->getHeaderLine('x-goog-api-client'); - $this->assertEquals('gcloud-php/' . ServiceBuilder::VERSION, $userAgent); - $this->assertEquals('gl-php/' . phpversion() . ' gccl/' . ServiceBuilder::VERSION, $xGoogApiClient); + $this->assertEquals('gcloud-php/' . $version, $userAgent); + $this->assertEquals('gl-php/' . phpversion() . ' gccl/' . $version, $xGoogApiClient); $this->assertEmpty($authHeader); return new Response(200); }, - 'shouldSignRequest' => false + 'shouldSignRequest' => false, + 'componentVersion' => $version ]); $requestWrapper->send( @@ -215,7 +221,7 @@ public function testRequestUsesApiKeyInsteadOfAuthHeader() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testThrowsExceptionWhenFetchingCredentialsFails() { @@ -258,7 +264,7 @@ public function testExceptionMessageIsNotTruncatedWithGuzzle() } /** - * @expectedException Google\Cloud\Exception\BadRequestException + * @expectedException Google\Cloud\Core\Exception\BadRequestException */ public function testThrowsBadRequestException() { @@ -274,7 +280,7 @@ public function testThrowsBadRequestException() } /** - * @expectedException Google\Cloud\Exception\NotFoundException + * @expectedException Google\Cloud\Core\Exception\NotFoundException */ public function testThrowsNotFoundException() { @@ -290,7 +296,7 @@ public function testThrowsNotFoundException() } /** - * @expectedException Google\Cloud\Exception\ConflictException + * @expectedException Google\Cloud\Core\Exception\ConflictException */ public function testThrowsConflictException() { @@ -306,7 +312,7 @@ public function testThrowsConflictException() } /** - * @expectedException Google\Cloud\Exception\ServerException + * @expectedException Google\Cloud\Core\Exception\ServerException */ public function testThrowsServerException() { diff --git a/tests/unit/RestTraitTest.php b/tests/unit/Core/RestTraitTest.php similarity index 88% rename from tests/unit/RestTraitTest.php rename to tests/unit/Core/RestTraitTest.php index f323600b9898..1be4b20e42f6 100644 --- a/tests/unit/RestTraitTest.php +++ b/tests/unit/Core/RestTraitTest.php @@ -15,15 +15,17 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\RestTrait; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\RestTrait; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; use Prophecy\Argument; /** - * @group root + * @group core */ class RestTraitTest extends \PHPUnit_Framework_TestCase { @@ -34,8 +36,8 @@ class RestTraitTest extends \PHPUnit_Framework_TestCase public function setUp() { $this->implementation = $this->getObjectForTrait(RestTrait::class); - $this->requestWrapper = $this->prophesize('Google\Cloud\RequestWrapper'); - $this->requestBuilder = $this->prophesize('Google\Cloud\RequestBuilder'); + $this->requestWrapper = $this->prophesize(RequestWrapper::class); + $this->requestBuilder = $this->prophesize(RequestBuilder::class); $this->requestBuilder->build(Argument::cetera()) ->willReturn(new Request('GET', '/someplace')); } diff --git a/tests/unit/ServiceBuilderTest.php b/tests/unit/Core/ServiceBuilderTest.php similarity index 97% rename from tests/unit/ServiceBuilderTest.php rename to tests/unit/Core/ServiceBuilderTest.php index 5059d04e81d4..b91c87ecd066 100644 --- a/tests/unit/ServiceBuilderTest.php +++ b/tests/unit/Core/ServiceBuilderTest.php @@ -15,13 +15,13 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; use Google\Cloud\ServiceBuilder; use Google\Cloud\Translate\TranslateClient; /** - * @group root + * @group core */ class ServiceBuilderTest extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/Upload/MultipartUploaderTest.php b/tests/unit/Core/Upload/MultipartUploaderTest.php similarity index 81% rename from tests/unit/Upload/MultipartUploaderTest.php rename to tests/unit/Core/Upload/MultipartUploaderTest.php index ec184c0699f8..9882e4642d30 100644 --- a/tests/unit/Upload/MultipartUploaderTest.php +++ b/tests/unit/Core/Upload/MultipartUploaderTest.php @@ -15,28 +15,31 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Upload; +namespace Google\Cloud\Tests\Unit\Core\Upload; -use Google\Cloud\Upload\MultipartUploader; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\Upload\MultipartUploader; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; use Prophecy\Argument; +use Psr\Http\Message\RequestInterface; /** + * @group core * @group upload */ class MultipartUploaderTest extends \PHPUnit_Framework_TestCase { public function testUploadsData() { - $requestWrapper = $this->prophesize('Google\Cloud\RequestWrapper'); + $requestWrapper = $this->prophesize(RequestWrapper::class); $stream = Psr7\stream_for('abcd'); $successBody = '{"canI":"kickIt"}'; $response = new Response(200, [], $successBody); $requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->willReturn($response); diff --git a/tests/unit/Upload/ResumableUploaderTest.php b/tests/unit/Core/Upload/ResumableUploaderTest.php similarity index 84% rename from tests/unit/Upload/ResumableUploaderTest.php rename to tests/unit/Core/Upload/ResumableUploaderTest.php index f8123a5b95bb..b9f487935fd9 100644 --- a/tests/unit/Upload/ResumableUploaderTest.php +++ b/tests/unit/Core/Upload/ResumableUploaderTest.php @@ -15,15 +15,20 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Upload; +namespace Google\Cloud\Tests\Unit\Core\Upload; -use Google\Cloud\Upload\ResumableUploader; +use Google\Cloud\Core\Exception\GoogleException; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\Upload\ResumableUploader; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; use Prophecy\Argument; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\StreamInterface; /** + * @group core * @group upload */ class ResumableUploaderTest extends \PHPUnit_Framework_TestCase @@ -34,7 +39,7 @@ class ResumableUploaderTest extends \PHPUnit_Framework_TestCase public function setUp() { - $this->requestWrapper = $this->prophesize('Google\Cloud\RequestWrapper'); + $this->requestWrapper = $this->prophesize(RequestWrapper::class); $this->stream = Psr7\stream_for('abcd'); $this->successBody = '{"canI":"kickIt"}'; } @@ -44,7 +49,7 @@ public function testUploadsData() $response = new Response(200, ['Location' => 'theResumeUri'], $this->successBody); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->willReturn($response); @@ -63,7 +68,7 @@ public function testGetResumeUri() $response = new Response(200, ['Location' => $resumeUri]); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->willReturn($response); @@ -82,7 +87,7 @@ public function testResumesUpload() $statusResponse = new Response(200, ['Range' => 'bytes 0-2']); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->willReturn($response); @@ -110,7 +115,7 @@ public function testResumeFinishedUpload() $statusResponse = new Response(200, [], $this->successBody); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->willReturn($statusResponse); @@ -127,11 +132,11 @@ public function testResumeFinishedUpload() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testThrowsExceptionWhenResumingNonSeekableStream() { - $stream = $this->prophesize('Psr\Http\Message\StreamInterface'); + $stream = $this->prophesize(StreamInterface::class); $stream->isSeekable()->willReturn(false); $stream->getMetadata('uri')->willReturn('blah'); @@ -145,7 +150,7 @@ public function testThrowsExceptionWhenResumingNonSeekableStream() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testThrowsExceptionWithFailedUpload() { @@ -159,7 +164,7 @@ public function testThrowsExceptionWithFailedUpload() $this->requestWrapper->send( Argument::which('getMethod', 'PUT'), Argument::type('array') - )->willThrow('Google\Cloud\Exception\GoogleException'); + )->willThrow(GoogleException::class); $uploader = new ResumableUploader( $this->requestWrapper->reveal(), diff --git a/tests/unit/Upload/StreamableUploaderTest.php b/tests/unit/Core/Upload/StreamableUploaderTest.php similarity index 89% rename from tests/unit/Upload/StreamableUploaderTest.php rename to tests/unit/Core/Upload/StreamableUploaderTest.php index f162e0a2a8f3..c39ae80b14c7 100644 --- a/tests/unit/Upload/StreamableUploaderTest.php +++ b/tests/unit/Core/Upload/StreamableUploaderTest.php @@ -15,10 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Upload; +namespace Google\Cloud\Tests\Unit\Core\Upload; +use Google\Cloud\Core\Exception\GoogleException; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\Upload\StreamableUploader; use Google\Cloud\Storage\WriteStream; -use Google\Cloud\Upload\StreamableUploader; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; @@ -26,6 +28,7 @@ use Psr\Http\Message\RequestInterface; /** + * @group core * @group upload */ class StreamableUploaderTest extends \PHPUnit_Framework_TestCase @@ -36,7 +39,7 @@ class StreamableUploaderTest extends \PHPUnit_Framework_TestCase public function setUp() { - $this->requestWrapper = $this->prophesize('Google\Cloud\RequestWrapper'); + $this->requestWrapper = $this->prophesize(RequestWrapper::class); $this->stream = new WriteStream(null, ['chunkSize' => 16]); $this->successBody = '{"canI":"kickIt"}'; } @@ -85,7 +88,7 @@ public function testUploadsData() $response = new Response(200, ['Location' => 'theResumeUri'], $this->successBody); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->willReturn($response); @@ -105,7 +108,7 @@ public function testGetResumeUri() $response = new Response(200, ['Location' => $resumeUri]); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->willReturn($response); @@ -120,7 +123,7 @@ public function testGetResumeUri() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testThrowsExceptionWithFailedUpload() { @@ -134,7 +137,7 @@ public function testThrowsExceptionWithFailedUpload() $this->requestWrapper->send( Argument::which('getMethod', 'PUT'), Argument::type('array') - )->willThrow('Google\Cloud\Exception\GoogleException'); + )->willThrow(GoogleException::class); $uploader = new StreamableUploader( $this->requestWrapper->reveal(), diff --git a/tests/unit/UriTraitTest.php b/tests/unit/Core/UriTraitTest.php similarity index 95% rename from tests/unit/UriTraitTest.php rename to tests/unit/Core/UriTraitTest.php index 1681ae411c6b..ab0761ccde7f 100644 --- a/tests/unit/UriTraitTest.php +++ b/tests/unit/Core/UriTraitTest.php @@ -15,12 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\UriTrait; +use Google\Cloud\Core\UriTrait; /** - * @group root + * @group core */ class UriTraitTest extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/ValidateTraitTest.php b/tests/unit/Core/ValidateTraitTest.php similarity index 95% rename from tests/unit/ValidateTraitTest.php rename to tests/unit/Core/ValidateTraitTest.php index b40adbd19695..3dc730845227 100644 --- a/tests/unit/ValidateTraitTest.php +++ b/tests/unit/Core/ValidateTraitTest.php @@ -15,12 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit\Core; -use Google\Cloud\ValidateTrait; +use Google\Cloud\Core\ValidateTrait; /** - * @group root + * @group core */ class ValidateTraitTest extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/Datastore/BlobTest.php b/tests/unit/Datastore/BlobTest.php index 469f0a06f08d..5a6971c04485 100644 --- a/tests/unit/Datastore/BlobTest.php +++ b/tests/unit/Datastore/BlobTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Google\Cloud\Datastore\Blob; use GuzzleHttp\Psr7; diff --git a/tests/unit/Datastore/Connection/RestTest.php b/tests/unit/Datastore/Connection/RestTest.php index 3483e1c6a79a..1fef3cb95a9c 100644 --- a/tests/unit/Datastore/Connection/RestTest.php +++ b/tests/unit/Datastore/Connection/RestTest.php @@ -15,11 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore\Connection; +namespace Google\Cloud\Tests\Unit\Datastore\Connection; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; use Google\Cloud\Datastore\Connection\Rest; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; +use Google\Cloud\Datastore\DatastoreClient; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; diff --git a/tests/unit/Datastore/DatastoreClientTest.php b/tests/unit/Datastore/DatastoreClientTest.php index 5025f7bf08f4..14f9bfade3fe 100644 --- a/tests/unit/Datastore/DatastoreClientTest.php +++ b/tests/unit/Datastore/DatastoreClientTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Google\Cloud\Datastore\Blob; use Google\Cloud\Datastore\Connection\ConnectionInterface; diff --git a/tests/unit/Datastore/DatastoreSessionHandlerTest.php b/tests/unit/Datastore/DatastoreSessionHandlerTest.php index ff03edc716f7..55be63a759c3 100644 --- a/tests/unit/Datastore/DatastoreSessionHandlerTest.php +++ b/tests/unit/Datastore/DatastoreSessionHandlerTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Exception; diff --git a/tests/unit/Datastore/DatastoreTraitTest.php b/tests/unit/Datastore/DatastoreTraitTest.php index 849232d12a1f..28c3c8531d91 100644 --- a/tests/unit/Datastore/DatastoreTraitTest.php +++ b/tests/unit/Datastore/DatastoreTraitTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\DatastoreTrait; diff --git a/tests/unit/Datastore/EntityMapperTest.php b/tests/unit/Datastore/EntityMapperTest.php index 678e2eebde26..c0e2b1347dc5 100644 --- a/tests/unit/Datastore/EntityMapperTest.php +++ b/tests/unit/Datastore/EntityMapperTest.php @@ -15,14 +15,14 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Google\Cloud\Datastore\Blob; use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\GeoPoint; use Google\Cloud\Datastore\Key; -use Google\Cloud\Int64; +use Google\Cloud\Core\Int64; /** * @group datastore diff --git a/tests/unit/Datastore/EntityTest.php b/tests/unit/Datastore/EntityTest.php index 27dd26ed9b8c..ca4e491df563 100644 --- a/tests/unit/Datastore/EntityTest.php +++ b/tests/unit/Datastore/EntityTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\EntityMapper; diff --git a/tests/unit/Datastore/GeoPointTest.php b/tests/unit/Datastore/GeoPointTest.php index 24d8fbc33a46..19e76f7f8906 100644 --- a/tests/unit/Datastore/GeoPointTest.php +++ b/tests/unit/Datastore/GeoPointTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Google\Cloud\Datastore\GeoPoint; diff --git a/tests/unit/Datastore/KeyTest.php b/tests/unit/Datastore/KeyTest.php index 9520d6b3ebf5..b1705351707f 100644 --- a/tests/unit/Datastore/KeyTest.php +++ b/tests/unit/Datastore/KeyTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Google\Cloud\Datastore\Key; diff --git a/tests/unit/Datastore/OperationTest.php b/tests/unit/Datastore/OperationTest.php index 39934e1b8c85..b5515372931e 100644 --- a/tests/unit/Datastore/OperationTest.php +++ b/tests/unit/Datastore/OperationTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\Entity; diff --git a/tests/unit/Datastore/Query/GqlQueryTest.php b/tests/unit/Datastore/Query/GqlQueryTest.php index 5ad43de5d4d0..0e5ce9a6c3a6 100644 --- a/tests/unit/Datastore/Query/GqlQueryTest.php +++ b/tests/unit/Datastore/Query/GqlQueryTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore\Query; +namespace Google\Cloud\Tests\Unit\Datastore\Query; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\Query\GqlQuery; diff --git a/tests/unit/Datastore/Query/QueryTest.php b/tests/unit/Datastore/Query/QueryTest.php index 5c6e31a34289..de0b01e1f5d8 100644 --- a/tests/unit/Datastore/Query/QueryTest.php +++ b/tests/unit/Datastore/Query/QueryTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore\Query; +namespace Google\Cloud\Tests\Unit\Datastore\Query; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\Key; diff --git a/tests/unit/Datastore/TransactionTest.php b/tests/unit/Datastore/TransactionTest.php index d32902135482..dc7d8783a979 100644 --- a/tests/unit/Datastore/TransactionTest.php +++ b/tests/unit/Datastore/TransactionTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Datastore; +namespace Google\Cloud\Tests\Unit\Datastore; use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\Key; diff --git a/tests/unit/JsonFileTest.php b/tests/unit/JsonFileTest.php index 9dea101b3c6f..ba747f5e8c2e 100644 --- a/tests/unit/JsonFileTest.php +++ b/tests/unit/JsonFileTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests; +namespace Google\Cloud\Tests\Unit; use League\JsonGuard\Dereferencer; use League\JsonGuard\Validator; @@ -41,9 +41,36 @@ public function testComposer() $validator = new Validator($json, $schema); + if ($validator->fails()) { + print_r($validator->errors()); + } + $this->assertFalse($validator->fails()); } + public function testComponentComposer() + { + $files = glob(__DIR__ .'/../../src/*/composer.json'); + foreach ($files as $file) { + $json = json_decode(file_get_contents($file)); + $this->assertEquals(JSON_ERROR_NONE, json_last_error()); + + $deref = new Dereferencer(); + $schema = $deref->dereference(json_decode(file_get_contents(sprintf( + self::SCHEMA_PATH, + __DIR__, 'composer.json.schema' + )))); + + $validator = new Validator($json, $schema); + + if ($validator->fails()) { + print_r($validator->errors()); + } + + $this->assertFalse($validator->fails()); + } + } + public function testManifest() { $file = file_get_contents(__DIR__ .'/../../docs/manifest.json'); @@ -58,6 +85,10 @@ public function testManifest() $validator = new Validator($json, $schema); + if ($validator->fails()) { + print_r($validator->errors()); + } + $this->assertFalse($validator->fails()); } @@ -75,6 +106,10 @@ public function testToc() $validator = new Validator($json, $schema); + if ($validator->fails()) { + print_r($validator->errors()); + } + $this->assertFalse($validator->fails()); } } diff --git a/tests/unit/Logging/Connection/GrpcTest.php b/tests/unit/Logging/Connection/GrpcTest.php index be24988f73cc..317d0ff4e242 100644 --- a/tests/unit/Logging/Connection/GrpcTest.php +++ b/tests/unit/Logging/Connection/GrpcTest.php @@ -15,11 +15,11 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Logging\Connection; +namespace Google\Cloud\Tests\Unit\Logging\Connection; use Google\Cloud\Logging\Connection\Grpc; -use Google\Cloud\GrpcRequestWrapper; -use Google\Cloud\PhpArray; +use Google\Cloud\Core\GrpcRequestWrapper; +use Google\Cloud\Core\PhpArray; use Prophecy\Argument; use google\logging\v2\LogEntry; use google\logging\v2\LogMetric; diff --git a/tests/unit/Logging/Connection/RestTest.php b/tests/unit/Logging/Connection/RestTest.php index 5d6ca2fea252..a5f1eb718737 100644 --- a/tests/unit/Logging/Connection/RestTest.php +++ b/tests/unit/Logging/Connection/RestTest.php @@ -15,11 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Logging\Connection; +namespace Google\Cloud\Tests\Unit\Logging\Connection; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; use Google\Cloud\Logging\Connection\Rest; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; +use Google\Cloud\Logging\LoggingClient; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; diff --git a/tests/unit/Logging/LoggerTest.php b/tests/unit/Logging/LoggerTest.php index da402cb4da58..b35b9cd9b898 100644 --- a/tests/unit/Logging/LoggerTest.php +++ b/tests/unit/Logging/LoggerTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Logging; +namespace Google\Cloud\Tests\Unit\Logging; use Google\Cloud\Logging\Logger; use Google\Cloud\Logging\Connection\ConnectionInterface; diff --git a/tests/unit/Logging/LoggingClientTest.php b/tests/unit/Logging/LoggingClientTest.php index 244847e0bcba..31f61ed54e0b 100644 --- a/tests/unit/Logging/LoggingClientTest.php +++ b/tests/unit/Logging/LoggingClientTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Logging; +namespace Google\Cloud\Tests\Unit\Logging; use Google\Cloud\Logging\Logger; use Google\Cloud\Logging\LoggingClient; diff --git a/tests/unit/Logging/MetricTest.php b/tests/unit/Logging/MetricTest.php index 76db1e24dfa5..bc6380c54511 100644 --- a/tests/unit/Logging/MetricTest.php +++ b/tests/unit/Logging/MetricTest.php @@ -15,9 +15,9 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Logging; +namespace Google\Cloud\Tests\Unit\Logging; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Logging\Metric; use Google\Cloud\Logging\Connection\ConnectionInterface; use Prophecy\Argument; diff --git a/tests/unit/Logging/PsrLoggerCompatabilityTest.php b/tests/unit/Logging/PsrLoggerCompatabilityTest.php index e4dfceca7d22..f410bbc6318d 100644 --- a/tests/unit/Logging/PsrLoggerCompatabilityTest.php +++ b/tests/unit/Logging/PsrLoggerCompatabilityTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Logging; +namespace Google\Cloud\Tests\Unit\Logging; use Google\Cloud\Logging\Connection\ConnectionInterface; use Google\Cloud\Logging\Logger; diff --git a/tests/unit/Logging/PsrLoggerTest.php b/tests/unit/Logging/PsrLoggerTest.php index 736854c8c0e3..55242fd9acf4 100644 --- a/tests/unit/Logging/PsrLoggerTest.php +++ b/tests/unit/Logging/PsrLoggerTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Logging; +namespace Google\Cloud\Tests\Unit\Logging; use Google\Cloud\Logging\Logger; use Google\Cloud\Logging\PsrLogger; diff --git a/tests/unit/Logging/SinkTest.php b/tests/unit/Logging/SinkTest.php index c23c5f4ea750..3dc634b01476 100644 --- a/tests/unit/Logging/SinkTest.php +++ b/tests/unit/Logging/SinkTest.php @@ -15,9 +15,9 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Logging; +namespace Google\Cloud\Tests\Unit\Logging; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Logging\Sink; use Google\Cloud\Logging\Connection\ConnectionInterface; use Prophecy\Argument; diff --git a/tests/unit/NaturalLanguage/AnnotationTest.php b/tests/unit/NaturalLanguage/AnnotationTest.php index a323d31dd15e..0cd93c1d18a2 100644 --- a/tests/unit/NaturalLanguage/AnnotationTest.php +++ b/tests/unit/NaturalLanguage/AnnotationTest.php @@ -15,12 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\NaturalLanguage; +namespace Google\Cloud\Tests\Unit\NaturalLanguage; use Google\Cloud\NaturalLanguage\Annotation; /** - * @group naturalLanguage + * @group naturallanguage */ class AnnotationTest extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/NaturalLanguage/Connection/RestTest.php b/tests/unit/NaturalLanguage/Connection/RestTest.php index c5ccf0761ea6..f607a43b4769 100644 --- a/tests/unit/NaturalLanguage/Connection/RestTest.php +++ b/tests/unit/NaturalLanguage/Connection/RestTest.php @@ -15,11 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\NaturalLanguage\Connection; +namespace Google\Cloud\Tests\Unit\NaturalLanguage\Connection; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; use Google\Cloud\NaturalLanguage\Connection\Rest; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; +use Google\Cloud\NaturalLanguage\NaturalLanguageClient; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; @@ -28,7 +29,7 @@ use Rize\UriTemplate; /** - * @group naturalLanguage + * @group naturallanguage */ class RestTest extends \PHPUnit_Framework_TestCase { diff --git a/tests/unit/NaturalLanguage/NaturalLanguageClientTest.php b/tests/unit/NaturalLanguage/NaturalLanguageClientTest.php index 19fbbef74645..26ccb0dd45b4 100644 --- a/tests/unit/NaturalLanguage/NaturalLanguageClientTest.php +++ b/tests/unit/NaturalLanguage/NaturalLanguageClientTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\NaturalLanguage; +namespace Google\Cloud\Tests\Unit\NaturalLanguage; use Google\Cloud\NaturalLanguage\Annotation; use Google\Cloud\NaturalLanguage\Connection\ConnectionInterface; @@ -24,7 +24,7 @@ use Prophecy\Argument; /** - * @group naturalLanguage + * @group naturallanguage */ class NaturalLanguageClientTest extends \PHPUnit_Framework_TestCase { @@ -115,9 +115,23 @@ public function testAnnotateText($options, $expectedOptions) public function analyzeDataProvider() { $objectMock = $this->prophesize(StorageObject::class); - $objectMock->identity(Argument::any())->willReturn(['bucket' => 'bucket', 'object' => 'object']); + $gcsUri = 'gs://bucket/object'; + $objectMock->gcsUri(Argument::any())->willReturn($gcsUri); return [ + [ + [ + 'content' => $gcsUri, + 'encodingType' => 'UTF16' + ], + [ + 'document' => [ + 'gcsContentUri' => $gcsUri, + 'type' => 'PLAIN_TEXT' + ], + 'encodingType' => 'UTF16' + ] + ], [ [ 'content' => 'My content.', diff --git a/tests/unit/PubSub/Connection/GrpcTest.php b/tests/unit/PubSub/Connection/GrpcTest.php index 970eabb3c6c0..61ff231740aa 100644 --- a/tests/unit/PubSub/Connection/GrpcTest.php +++ b/tests/unit/PubSub/Connection/GrpcTest.php @@ -15,10 +15,10 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub\Connection; +namespace Google\Cloud\Tests\Unit\PubSub\Connection; use Google\Cloud\PubSub\Connection\Grpc; -use Google\Cloud\GrpcRequestWrapper; +use Google\Cloud\Core\GrpcRequestWrapper; use Prophecy\Argument; use google\iam\v1\Binding; use google\iam\v1\Policy; diff --git a/tests/unit/PubSub/Connection/IamSubscriptionTest.php b/tests/unit/PubSub/Connection/IamSubscriptionTest.php index 006a9f0682d0..cb7cfc6aa910 100644 --- a/tests/unit/PubSub/Connection/IamSubscriptionTest.php +++ b/tests/unit/PubSub/Connection/IamSubscriptionTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub\Connection; +namespace Google\Cloud\Tests\Unit\PubSub\Connection; use Google\Cloud\PubSub\Connection\ConnectionInterface; use Google\Cloud\PubSub\Connection\IamSubscription; diff --git a/tests/unit/PubSub/Connection/IamTopicTest.php b/tests/unit/PubSub/Connection/IamTopicTest.php index 4fedb85eb855..1f751d5e18ad 100644 --- a/tests/unit/PubSub/Connection/IamTopicTest.php +++ b/tests/unit/PubSub/Connection/IamTopicTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub\Connection; +namespace Google\Cloud\Tests\Unit\PubSub\Connection; use Google\Cloud\PubSub\Connection\ConnectionInterface; use Google\Cloud\PubSub\Connection\IamTopic; diff --git a/tests/unit/PubSub/Connection/RestTest.php b/tests/unit/PubSub/Connection/RestTest.php index bd13d614c524..6a4ad4d518f4 100644 --- a/tests/unit/PubSub/Connection/RestTest.php +++ b/tests/unit/PubSub/Connection/RestTest.php @@ -15,11 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub\Connection; +namespace Google\Cloud\Tests\Unit\PubSub\Connection; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; use Google\Cloud\PubSub\Connection\Rest; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; +use Google\Cloud\PubSub\PubSubClient; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; diff --git a/tests/unit/PubSub/IncomingMessageTraitTest.php b/tests/unit/PubSub/IncomingMessageTraitTest.php index 19bfcd4f7454..e1a343b5109c 100644 --- a/tests/unit/PubSub/IncomingMessageTraitTest.php +++ b/tests/unit/PubSub/IncomingMessageTraitTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub; +namespace Google\Cloud\Tests\Unit\PubSub; use Google\Cloud\PubSub\Connection\ConnectionInterface; use Google\Cloud\PubSub\IncomingMessageTrait; @@ -47,7 +47,7 @@ public function testMessageFactory() } /** - * @expectedException Google\Cloud\Exception\GoogleException + * @expectedException Google\Cloud\Core\Exception\GoogleException */ public function testInvalidMessage() { diff --git a/tests/unit/PubSub/MessageTest.php b/tests/unit/PubSub/MessageTest.php index 0ab96a7f7667..770bbe7ba293 100644 --- a/tests/unit/PubSub/MessageTest.php +++ b/tests/unit/PubSub/MessageTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub; +namespace Google\Cloud\Tests\Unit\PubSub; use Google\Cloud\PubSub\Message; use Google\Cloud\PubSub\Subscription; diff --git a/tests/unit/PubSub/PubSubClientTest.php b/tests/unit/PubSub/PubSubClientTest.php index 52b339cff5e5..488a46e60f38 100644 --- a/tests/unit/PubSub/PubSubClientTest.php +++ b/tests/unit/PubSub/PubSubClientTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub; +namespace Google\Cloud\Tests\Unit\PubSub; use Generator; use Google\Cloud\PubSub\Connection\ConnectionInterface; diff --git a/tests/unit/PubSub/ResourceNameTraitTest.php b/tests/unit/PubSub/ResourceNameTraitTest.php index 6cebb9d152cc..306553be0379 100644 --- a/tests/unit/PubSub/ResourceNameTraitTest.php +++ b/tests/unit/PubSub/ResourceNameTraitTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub; +namespace Google\Cloud\Tests\Unit\PubSub; use Google\Cloud\PubSub\ResourceNameTrait; diff --git a/tests/unit/PubSub/SubscriptionTest.php b/tests/unit/PubSub/SubscriptionTest.php index d6cb96a05c40..4b4131578790 100644 --- a/tests/unit/PubSub/SubscriptionTest.php +++ b/tests/unit/PubSub/SubscriptionTest.php @@ -15,11 +15,11 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub; +namespace Google\Cloud\Tests\Unit\PubSub; use Generator; -use Google\Cloud\Exception\NotFoundException; -use Google\Cloud\Iam\Iam; +use Google\Cloud\Core\Exception\NotFoundException; +use Google\Cloud\Core\Iam\Iam; use Google\Cloud\PubSub\Connection\ConnectionInterface; use Google\Cloud\PubSub\Message; use Google\Cloud\PubSub\Subscription; diff --git a/tests/unit/PubSub/TopicTest.php b/tests/unit/PubSub/TopicTest.php index eb45676a0963..f2827f8eb781 100644 --- a/tests/unit/PubSub/TopicTest.php +++ b/tests/unit/PubSub/TopicTest.php @@ -15,11 +15,11 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\PubSub; +namespace Google\Cloud\Tests\Unit\PubSub; use Generator; -use Google\Cloud\Exception\NotFoundException; -use Google\Cloud\Iam\Iam; +use Google\Cloud\Core\Exception\NotFoundException; +use Google\Cloud\Core\Iam\Iam; use Google\Cloud\PubSub\Connection\ConnectionInterface; use Google\Cloud\PubSub\Subscription; use Google\Cloud\PubSub\Topic; diff --git a/tests/unit/Speech/Connection/RestTest.php b/tests/unit/Speech/Connection/RestTest.php index fec3bf296e2c..32ca5c001b34 100644 --- a/tests/unit/Speech/Connection/RestTest.php +++ b/tests/unit/Speech/Connection/RestTest.php @@ -15,11 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Speech\Connection; +namespace Google\Cloud\Tests\Unit\Speech\Connection; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; use Google\Cloud\Speech\Connection\Rest; +use Google\Cloud\Speech\SpeechClient; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; diff --git a/tests/unit/Speech/OperationTest.php b/tests/unit/Speech/OperationTest.php index 9ada91bec9b1..5d77840dbbbc 100644 --- a/tests/unit/Speech/OperationTest.php +++ b/tests/unit/Speech/OperationTest.php @@ -15,9 +15,9 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Speech; +namespace Google\Cloud\Tests\Unit\Speech; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Speech\Connection\ConnectionInterface; use Google\Cloud\Speech\Operation; use Prophecy\Argument; diff --git a/tests/unit/Speech/SpeechClientTest.php b/tests/unit/Speech/SpeechClientTest.php index 10a5902c2473..58dce6563465 100644 --- a/tests/unit/Speech/SpeechClientTest.php +++ b/tests/unit/Speech/SpeechClientTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Speech; +namespace Google\Cloud\Tests\Unit\Speech; use Google\Cloud\Speech\Connection\ConnectionInterface; use Google\Cloud\Speech\Operation; @@ -114,10 +114,11 @@ public function audioProvider() { stream_wrapper_unregister('http'); stream_wrapper_register('http', HttpStreamWrapper::class); + $gcsUri = 'gs://bucket/object'; $amrMock = $this->prophesize(StorageObject::class); - $amrMock->identity(Argument::any())->willReturn(['bucket' => 'bucket', 'object' => 'object.amr']); + $amrMock->gcsUri(Argument::any())->willReturn($gcsUri . '.amr'); $awbMock = $this->prophesize(StorageObject::class); - $awbMock->identity(Argument::any())->willReturn(['bucket' => 'bucket', 'object' => 'object.awb']); + $awbMock->gcsUri(Argument::any())->willReturn($gcsUri . '.awb'); $audioPath = __DIR__ . '/../data/brooklyn.flac'; return [ @@ -202,6 +203,22 @@ public function audioProvider() ] ] ], + [ + $gcsUri, + [ + 'encoding' => 'FLAC', + 'sampleRate' => 16000 + ], + [ + 'audio' => [ + 'uri' => $gcsUri + ], + 'config' => [ + 'encoding' => 'FLAC', + 'sampleRate' => 16000 + ] + ] + ], [ fopen('http://www.example.com/file.flac', 'r'), [ diff --git a/tests/unit/Storage/AclTest.php b/tests/unit/Storage/AclTest.php index 815c5d9ebe53..06b3f0c8626b 100644 --- a/tests/unit/Storage/AclTest.php +++ b/tests/unit/Storage/AclTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Storage; +namespace Google\Cloud\Tests\Unit\Storage; use Google\Cloud\Storage\Acl; use Prophecy\Argument; diff --git a/tests/unit/Storage/BucketTest.php b/tests/unit/Storage/BucketTest.php index 0d0bd2558e86..74befe0031e2 100644 --- a/tests/unit/Storage/BucketTest.php +++ b/tests/unit/Storage/BucketTest.php @@ -15,15 +15,16 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Storage; +namespace Google\Cloud\Tests\Unit\Storage; -use Google\Cloud\Exception\NotFoundException; -use Google\Cloud\Exception\ServerException; -use Google\Cloud\Exception\ServiceException; +use Google\Cloud\Core\Exception\NotFoundException; +use Google\Cloud\Core\Exception\ServerException; +use Google\Cloud\Core\Exception\ServiceException; +use Google\Cloud\Core\Upload\ResumableUploader; +use Google\Cloud\Storage\Acl; use Google\Cloud\Storage\Bucket; use Google\Cloud\Storage\Connection\ConnectionInterface; use Google\Cloud\Storage\StorageObject; -use Google\Cloud\Upload\ResumableUploader; use Prophecy\Argument; /** @@ -44,14 +45,14 @@ public function testGetsAcl() { $bucket = new Bucket($this->connection->reveal(), 'bucket'); - $this->assertInstanceOf('Google\Cloud\Storage\Acl', $bucket->acl()); + $this->assertInstanceOf(Acl::class, $bucket->acl()); } public function testGetsDefaultAcl() { $bucket = new Bucket($this->connection->reveal(), 'bucket'); - $this->assertInstanceOf('Google\Cloud\Storage\Acl', $bucket->defaultAcl()); + $this->assertInstanceOf(Acl::class, $bucket->defaultAcl()); } public function testDoesExistTrue() @@ -80,7 +81,7 @@ public function testUploadData() $bucket = new Bucket($this->connection->reveal(), 'bucket'); $this->assertInstanceOf( - 'Google\Cloud\Storage\StorageObject', + StorageObject::class, $bucket->upload('some data to upload', ['name' => 'data.txt']) ); } @@ -101,7 +102,7 @@ public function testGetResumableUploader() $bucket = new Bucket($this->connection->reveal(), 'bucket'); $this->assertInstanceOf( - 'Google\Cloud\Upload\ResumableUploader', + ResumableUploader::class, $bucket->getResumableUploader('some data to upload', ['name' => 'data.txt']) ); } @@ -120,7 +121,7 @@ public function testGetObject() { $bucket = new Bucket($this->connection->reveal(), 'bucket'); - $this->assertInstanceOf('Google\Cloud\Storage\StorageObject', $bucket->object('peter-venkman.jpg')); + $this->assertInstanceOf(StorageObject::class, $bucket->object('peter-venkman.jpg')); } public function testInstantiateObjectWithOptions() @@ -133,7 +134,7 @@ public function testInstantiateObjectWithOptions() 'encryptionKeySHA256' => '123' ]); - $this->assertInstanceOf('Google\Cloud\Storage\StorageObject', $object); + $this->assertInstanceOf(StorageObject::class, $object); } public function testGetsObjectsWithoutToken() @@ -331,7 +332,7 @@ public function testIsWritableAccessDenied() } /** - * @expectedException \Google\Cloud\Exception\ServerException + * @expectedException Google\Cloud\Core\Exception\ServerException */ public function testIsWritableServerException() { diff --git a/tests/unit/Storage/Connection/RestTest.php b/tests/unit/Storage/Connection/RestTest.php index daab4fbcb7ce..4d7ade35bf39 100644 --- a/tests/unit/Storage/Connection/RestTest.php +++ b/tests/unit/Storage/Connection/RestTest.php @@ -15,9 +15,14 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Storage\Connection; +namespace Google\Cloud\Tests\Unit\Storage\Connection; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; +use Google\Cloud\Core\Upload\MultipartUploader; +use Google\Cloud\Core\Upload\ResumableUploader; use Google\Cloud\Storage\Connection\Rest; +use Google\Cloud\Storage\StorageClient; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; @@ -35,7 +40,7 @@ class RestTest extends \PHPUnit_Framework_TestCase public function setUp() { - $this->requestWrapper = $this->prophesize('Google\Cloud\RequestWrapper'); + $this->requestWrapper = $this->prophesize(RequestWrapper::class); $this->successBody = '{"canI":"kickIt"}'; } @@ -49,7 +54,7 @@ public function testCallBasicMethods($method) $request = new Request('GET', '/somewhere'); $response = new Response(200, [], $this->successBody); - $requestBuilder = $this->prophesize('Google\Cloud\RequestBuilder'); + $requestBuilder = $this->prophesize(RequestBuilder::class); $requestBuilder->build( Argument::type('string'), Argument::type('string'), @@ -57,7 +62,7 @@ public function testCallBasicMethods($method) )->willReturn($request); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->willReturn($response); @@ -101,7 +106,7 @@ public function testDownloadObject() $response = new Response(200, [], $this->successBody); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->will( function ($args) use (&$actualRequest, $response) { @@ -143,7 +148,7 @@ public function testInsertObject( $response = new Response(200, ['Location' => 'http://www.mordor.com'], $this->successBody); $this->requestWrapper->send( - Argument::type('Psr\Http\Message\RequestInterface'), + Argument::type(RequestInterface::class), Argument::type('array') )->will( function ($args) use (&$actualRequest, $response) { @@ -184,7 +189,7 @@ public function insertObjectProvider() 'predefinedAcl' => 'private', 'metadata' => ['contentType' => 'text/plain'] ], - 'Google\Cloud\Upload\ResumableUploader', + ResumableUploader::class, 'text/plain', [ 'md5Hash' => base64_encode(Psr7\hash($tempFile, 'md5', true)), @@ -196,7 +201,7 @@ public function insertObjectProvider() 'data' => $logoFile, 'validate' => false ], - 'Google\Cloud\Upload\MultipartUploader', + MultipartUploader::class, 'image/svg+xml', [ 'name' => 'logo.svg' @@ -215,7 +220,7 @@ public function insertObjectProvider() ] ] ], - 'Google\Cloud\Upload\ResumableUploader', + ResumableUploader::class, 'text/plain', [ 'name' => 'file.ext', diff --git a/tests/unit/Storage/EncryptionTraitTest.php b/tests/unit/Storage/EncryptionTraitTest.php index 288472b99954..30cbf1d8f833 100644 --- a/tests/unit/Storage/EncryptionTraitTest.php +++ b/tests/unit/Storage/EncryptionTraitTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Storage; +namespace Google\Cloud\Tests\Unit\Storage; use Google\Cloud\Storage\EncryptionTrait; diff --git a/tests/unit/Storage/StorageClientTest.php b/tests/unit/Storage/StorageClientTest.php index 96b3f3d7ac7f..8cbb5fff1304 100644 --- a/tests/unit/Storage/StorageClientTest.php +++ b/tests/unit/Storage/StorageClientTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Storage; +namespace Google\Cloud\Tests\Unit\Storage; use Google\Cloud\Storage\StorageClient; use Google\Cloud\Storage\StreamWrapper; diff --git a/tests/unit/Storage/StorageObjectTest.php b/tests/unit/Storage/StorageObjectTest.php index af7d334b9ac5..ebe0e9d80aab 100644 --- a/tests/unit/Storage/StorageObjectTest.php +++ b/tests/unit/Storage/StorageObjectTest.php @@ -15,9 +15,9 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Storage; +namespace Google\Cloud\Tests\Unit\Storage; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Storage\Connection\ConnectionInterface; use Google\Cloud\Storage\Bucket; use Google\Cloud\Storage\StorageObject; @@ -482,4 +482,12 @@ public function testGetsIdentity() $this->assertEquals($name, $object->identity()['object']); $this->assertEquals($bucketName, $object->identity()['bucket']); } + + public function testGetsGcsUri() + { + $object = new StorageObject($this->connection->reveal(), $name = 'object.txt', $bucketName = 'bucket'); + + $expectedUri = sprintf('gs://%s/%s', $bucketName, $name); + $this->assertEquals($expectedUri, $object->gcsUri()); + } } diff --git a/tests/unit/Storage/StreamWrapperTest.php b/tests/unit/Storage/StreamWrapperTest.php index 95a4b3148192..d65b6b40bcaf 100644 --- a/tests/unit/Storage/StreamWrapperTest.php +++ b/tests/unit/Storage/StreamWrapperTest.php @@ -17,16 +17,16 @@ namespace Google\Cloud\Tests\Storage; -use Google\Cloud\Exception\NotFoundException; +use Google\Cloud\Core\Exception\NotFoundException; +use Google\Cloud\Core\Upload\StreamableUploader; use Google\Cloud\Storage\Bucket; use Google\Cloud\Storage\StorageClient; use Google\Cloud\Storage\StorageObject; use Google\Cloud\Storage\StreamWrapper; -use Google\Cloud\Upload\StreamableUploader; +use GuzzleHttp\Psr7; use Prophecy\Argument; -use Prophecy\Prophecy\ObjectProphecy; use Prophecy\Promise\CallbackPromise; -use GuzzleHttp\Psr7; +use Prophecy\Prophecy\ObjectProphecy; /** * @group storage @@ -73,7 +73,7 @@ public function testOpeningExistingFile() */ public function testOpeningNonExistentFileReturnsFalse() { - $this->mockDownloadException('non-existent/file.txt', \Google\Cloud\Exception\NotFoundException::class); + $this->mockDownloadException('non-existent/file.txt', NotFoundException::class); $fp = @fopen('gs://my_bucket/non-existent/file.txt', 'r'); $this->assertFalse($fp); @@ -224,7 +224,7 @@ public function testUnlink() public function testUnlinkOnNonExistentFile() { $obj = $this->prophesize(StorageObject::class); - $obj->delete()->willThrow(\Google\Cloud\Exception\NotFoundException::class); + $obj->delete()->willThrow(NotFoundException::class); $this->bucket->object('some_long_file.txt')->willReturn($obj->reveal()); $this->assertFalse(unlink('gs://my_bucket/some_long_file.txt')); } @@ -261,7 +261,7 @@ public function testMkdirPrivate() */ public function testMkdirOnBadDirectory() { - $this->bucket->upload('', ['name' => 'foo/bar/', 'predefinedAcl' => 'publicRead'])->willThrow(\Google\Cloud\Exception\NotFoundException::class); + $this->bucket->upload('', ['name' => 'foo/bar/', 'predefinedAcl' => 'publicRead'])->willThrow(NotFoundException::class); $this->assertFalse(mkdir('gs://my_bucket/foo/bar')); } @@ -298,7 +298,7 @@ public function testRmdir() public function testRmdirOnBadDirectory() { $obj = $this->prophesize(StorageObject::class); - $obj->delete()->willThrow(\Google\Cloud\Exception\NotFoundException::class); + $obj->delete()->willThrow(NotFoundException::class); $this->bucket->object('foo/bar/')->willReturn($obj->reveal()); $this->assertFalse(rmdir('gs://my_bucket/foo/bar')); } diff --git a/tests/unit/Storage/WriteStreamTest.php b/tests/unit/Storage/WriteStreamTest.php index 95c706b33b8f..505d584dffa9 100644 --- a/tests/unit/Storage/WriteStreamTest.php +++ b/tests/unit/Storage/WriteStreamTest.php @@ -18,7 +18,7 @@ namespace Google\Cloud\Tests\Storage; use Google\Cloud\Storage\WriteStream; -use Google\Cloud\Upload\StreamableUploader; +use Google\Cloud\Core\Upload\StreamableUploader; use Prophecy\Argument; diff --git a/tests/unit/Translate/Connection/RestTest.php b/tests/unit/Translate/Connection/RestTest.php index 173733bc5628..de2431cae741 100644 --- a/tests/unit/Translate/Connection/RestTest.php +++ b/tests/unit/Translate/Connection/RestTest.php @@ -15,11 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Translate\Connection; +namespace Google\Cloud\Tests\Unit\Translate\Connection; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; use Google\Cloud\Translate\Connection\Rest; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; +use Google\Cloud\Translate\TranslateClient; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; diff --git a/tests/unit/Translate/TranslateClientTest.php b/tests/unit/Translate/TranslateClientTest.php index 86808bf28c30..1cc2dc15edc2 100644 --- a/tests/unit/Translate/TranslateClientTest.php +++ b/tests/unit/Translate/TranslateClientTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Translate; +namespace Google\Cloud\Tests\Unit\Translate; use Google\Cloud\Translate\Connection\ConnectionInterface; use Google\Cloud\Translate\TranslateClient; diff --git a/tests/unit/Vision/Annotation/EntityTest.php b/tests/unit/Vision/Annotation/EntityTest.php index 5173671f46dc..3a872891ae8d 100644 --- a/tests/unit/Vision/Annotation/EntityTest.php +++ b/tests/unit/Vision/Annotation/EntityTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Vision\Annotation; +namespace Google\Cloud\Tests\Unit\Vision\Annotation; use Google\Cloud\Vision\Annotation\Entity; diff --git a/tests/unit/Vision/Annotation/Face/LandmarksTest.php b/tests/unit/Vision/Annotation/Face/LandmarksTest.php index 46875e3ffb05..531acfbdf6f3 100644 --- a/tests/unit/Vision/Annotation/Face/LandmarksTest.php +++ b/tests/unit/Vision/Annotation/Face/LandmarksTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Vision\Annotation; +namespace Google\Cloud\Tests\Unit\Vision\Annotation; use Google\Cloud\Vision\Annotation\Face\Landmarks; diff --git a/tests/unit/Vision/Annotation/FaceTest.php b/tests/unit/Vision/Annotation/FaceTest.php index da91c700eef5..883203f80408 100644 --- a/tests/unit/Vision/Annotation/FaceTest.php +++ b/tests/unit/Vision/Annotation/FaceTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Vision\Annotation; +namespace Google\Cloud\Tests\Unit\Vision\Annotation; use Google\Cloud\Vision\Annotation\Face; use Google\Cloud\Vision\Annotation\Face\Landmarks; diff --git a/tests/unit/Vision/Annotation/LikelihoodTraitTest.php b/tests/unit/Vision/Annotation/LikelihoodTraitTest.php index dbeccb5a32c1..706b5136c554 100644 --- a/tests/unit/Vision/Annotation/LikelihoodTraitTest.php +++ b/tests/unit/Vision/Annotation/LikelihoodTraitTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Vision\Annotation; +namespace Google\Cloud\Tests\Unit\Vision\Annotation; use Google\Cloud\Vision\Annotation\FeatureInterface; use Google\Cloud\Vision\Annotation\LikelihoodTrait; diff --git a/tests/unit/Vision/Annotation/SafeSearchTest.php b/tests/unit/Vision/Annotation/SafeSearchTest.php index afb877aea58c..6ae2a08c5b20 100644 --- a/tests/unit/Vision/Annotation/SafeSearchTest.php +++ b/tests/unit/Vision/Annotation/SafeSearchTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Vision\Annotation; +namespace Google\Cloud\Tests\Unit\Vision\Annotation; use Google\Cloud\Vision\Annotation\SafeSearch; diff --git a/tests/unit/Vision/AnnotationTest.php b/tests/unit/Vision/AnnotationTest.php index b89b37b725c8..0e2745536c17 100644 --- a/tests/unit/Vision/AnnotationTest.php +++ b/tests/unit/Vision/AnnotationTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Vision; +namespace Google\Cloud\Tests\Unit\Vision; use Google\Cloud\Vision\Annotation; use Google\Cloud\Vision\Annotation\CropHint; diff --git a/tests/unit/Vision/Connection/RestTest.php b/tests/unit/Vision/Connection/RestTest.php index e774d512823f..7fdbc2ee27b9 100644 --- a/tests/unit/Vision/Connection/RestTest.php +++ b/tests/unit/Vision/Connection/RestTest.php @@ -15,11 +15,12 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Vision\Connection; +namespace Google\Cloud\Tests\Unit\Vision\Connection; +use Google\Cloud\Core\RequestBuilder; +use Google\Cloud\Core\RequestWrapper; use Google\Cloud\Vision\Connection\Rest; -use Google\Cloud\RequestBuilder; -use Google\Cloud\RequestWrapper; +use Google\Cloud\Vision\VisionClient; use GuzzleHttp\Psr7; use GuzzleHttp\Psr7\Request; use GuzzleHttp\Psr7\Response; diff --git a/tests/unit/Vision/ImageTest.php b/tests/unit/Vision/ImageTest.php index c2b2fb948359..4dac191fc94b 100644 --- a/tests/unit/Vision/ImageTest.php +++ b/tests/unit/Vision/ImageTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Vision; +namespace Google\Cloud\Tests\Unit\Vision; use Google\Cloud\Storage\StorageClient; use Google\Cloud\Vision\Image; diff --git a/tests/unit/Vision/VisionClientTest.php b/tests/unit/Vision/VisionClientTest.php index 66cb42d25ae4..12ed2e548d25 100644 --- a/tests/unit/Vision/VisionClientTest.php +++ b/tests/unit/Vision/VisionClientTest.php @@ -15,7 +15,7 @@ * limitations under the License. */ -namespace Google\Cloud\Tests\Vision; +namespace Google\Cloud\Tests\Unit\Vision; use Google\Cloud\Vision\Annotation; use Google\Cloud\Vision\Connection\ConnectionInterface;