google-cloud-storage 1.14.0 → 1.14.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +178 -0
- data/CHANGELOG.md +167 -0
- data/CODE_OF_CONDUCT.md +40 -0
- data/CONTRIBUTING.md +188 -0
- data/LOGGING.md +27 -0
- data/OVERVIEW.md +573 -0
- data/TROUBLESHOOTING.md +37 -0
- data/lib/google/cloud/storage/version.rb +1 -1
- metadata +9 -3
- data/README.md +0 -100
data/TROUBLESHOOTING.md
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
# Troubleshooting
|
2
|
+
|
3
|
+
## Where can I get more help?
|
4
|
+
|
5
|
+
### Ask the Community
|
6
|
+
|
7
|
+
If you have a question about how to use a Google Cloud client library in your
|
8
|
+
project or are stuck in the Developer's console and don't know where to turn,
|
9
|
+
it's possible your questions have already been addressed by the community.
|
10
|
+
|
11
|
+
First, check out the appropriate tags on StackOverflow:
|
12
|
+
- [`google-cloud-platform+ruby+storage`][so-ruby]
|
13
|
+
|
14
|
+
Next, try searching through the issues on GitHub:
|
15
|
+
|
16
|
+
- [`api:storage` issues][gh-search-ruby]
|
17
|
+
|
18
|
+
Still nothing?
|
19
|
+
|
20
|
+
### Ask the Developers
|
21
|
+
|
22
|
+
If you're experiencing a bug with the code, or have an idea for how it can be
|
23
|
+
improved, *please* create a new issue on GitHub so we can talk about it.
|
24
|
+
|
25
|
+
- [New issue][gh-ruby]
|
26
|
+
|
27
|
+
Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
|
28
|
+
can use the "ruby" channel for general Ruby questions, or use the
|
29
|
+
"google-cloud-ruby" channel if you have questions about this gem in particular.
|
30
|
+
|
31
|
+
[so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+storage
|
32
|
+
|
33
|
+
[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+storage%22
|
34
|
+
|
35
|
+
[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
|
36
|
+
|
37
|
+
[slack-ruby]: https://gcp-slack.appspot.com/
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-storage
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.14.
|
4
|
+
version: 1.14.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Mike Moore
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2018-09-
|
12
|
+
date: 2018-09-12 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: google-cloud-core
|
@@ -216,8 +216,14 @@ extensions: []
|
|
216
216
|
extra_rdoc_files: []
|
217
217
|
files:
|
218
218
|
- ".yardopts"
|
219
|
+
- AUTHENTICATION.md
|
220
|
+
- CHANGELOG.md
|
221
|
+
- CODE_OF_CONDUCT.md
|
222
|
+
- CONTRIBUTING.md
|
219
223
|
- LICENSE
|
220
|
-
-
|
224
|
+
- LOGGING.md
|
225
|
+
- OVERVIEW.md
|
226
|
+
- TROUBLESHOOTING.md
|
221
227
|
- lib/google-cloud-storage.rb
|
222
228
|
- lib/google/cloud/storage.rb
|
223
229
|
- lib/google/cloud/storage/bucket.rb
|
data/README.md
DELETED
@@ -1,100 +0,0 @@
|
|
1
|
-
# google-cloud-storage
|
2
|
-
|
3
|
-
[Google Cloud Storage](https://cloud.google.com/storage/) ([docs](https://cloud.google.com/storage/docs/json_api/)) allows you to store data on Google infrastructure with very high reliability, performance and availability, and can be used to distribute large data objects to users via direct download.
|
4
|
-
|
5
|
-
- [google-cloud-storage API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-storage/latest)
|
6
|
-
- [google-cloud-storage on RubyGems](https://rubygems.org/gems/google-cloud-storage)
|
7
|
-
- [Google Cloud Storage documentation](https://cloud.google.com/storage/docs)
|
8
|
-
|
9
|
-
## Quick Start
|
10
|
-
|
11
|
-
```sh
|
12
|
-
$ gem install google-cloud-storage
|
13
|
-
```
|
14
|
-
|
15
|
-
## Authentication
|
16
|
-
|
17
|
-
This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables.
|
18
|
-
|
19
|
-
Instructions and configuration options are covered in the [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-storage/latest/file.AUTHENTICATION).
|
20
|
-
|
21
|
-
## Example
|
22
|
-
|
23
|
-
```ruby
|
24
|
-
require "google/cloud/storage"
|
25
|
-
|
26
|
-
storage = Google::Cloud::Storage.new(
|
27
|
-
project_id: "my-project",
|
28
|
-
credentials: "/path/to/keyfile.json"
|
29
|
-
)
|
30
|
-
|
31
|
-
bucket = storage.bucket "task-attachments"
|
32
|
-
|
33
|
-
file = bucket.file "path/to/my-file.ext"
|
34
|
-
|
35
|
-
# Download the file to the local file system
|
36
|
-
file.download "/tasks/attachments/#{file.name}"
|
37
|
-
|
38
|
-
# Copy the file to a backup bucket
|
39
|
-
backup = storage.bucket "task-attachment-backups"
|
40
|
-
file.copy backup, file.name
|
41
|
-
```
|
42
|
-
|
43
|
-
## Enabling Logging
|
44
|
-
|
45
|
-
To enable logging for this library, set the logger for the underlying [Google API Client](https://github.com/google/google-api-ruby-client/blob/master/README.md#logging) library. The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger) that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/).
|
46
|
-
|
47
|
-
If you do not set the logger explicitly and your application is running in a Rails environment, it will default to `Rails.logger`. Otherwise, if you do not set the logger and you are not using Rails, logging is disabled by default.
|
48
|
-
|
49
|
-
Configuring a Ruby stdlib logger:
|
50
|
-
|
51
|
-
```ruby
|
52
|
-
require "logger"
|
53
|
-
|
54
|
-
my_logger = Logger.new $stderr
|
55
|
-
my_logger.level = Logger::WARN
|
56
|
-
|
57
|
-
# Set the Google API Client logger
|
58
|
-
Google::Apis.logger = my_logger
|
59
|
-
```
|
60
|
-
|
61
|
-
## Supported Ruby Versions
|
62
|
-
|
63
|
-
This library is supported on Ruby 2.3+.
|
64
|
-
|
65
|
-
Google provides official support for Ruby versions that are actively supported
|
66
|
-
by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
|
67
|
-
security maintenance, and not end of life. Currently, this means Ruby 2.3 and
|
68
|
-
later. Older versions of Ruby _may_ still work, but are unsupported and not
|
69
|
-
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
70
|
-
about the Ruby support schedule.
|
71
|
-
|
72
|
-
## Versioning
|
73
|
-
|
74
|
-
This library follows [Semantic Versioning](http://semver.org/).
|
75
|
-
|
76
|
-
## Contributing
|
77
|
-
|
78
|
-
Contributions to this library are always welcome and highly encouraged.
|
79
|
-
|
80
|
-
See the [Contributing
|
81
|
-
Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-storage/latest/file.CONTRIBUTING)
|
82
|
-
for more information on how to get started.
|
83
|
-
|
84
|
-
Please note that this project is released with a Contributor Code of Conduct. By
|
85
|
-
participating in this project you agree to abide by its terms. See [Code of
|
86
|
-
Conduct](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-storage/latest/file.CODE_OF_CONDUCT)
|
87
|
-
for more information.
|
88
|
-
|
89
|
-
## License
|
90
|
-
|
91
|
-
This library is licensed under Apache 2.0. Full license text is available in
|
92
|
-
[LICENSE](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-storage/latest/file.LICENSE).
|
93
|
-
|
94
|
-
## Support
|
95
|
-
|
96
|
-
Please [report bugs at the project on
|
97
|
-
Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues). Don't
|
98
|
-
hesitate to [ask
|
99
|
-
questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby)
|
100
|
-
about the client or APIs on [StackOverflow](http://stackoverflow.com).
|