teak_util 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.circleci/config.yml +13 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/CHANGELOG.md +3 -0
- data/Gemfile +14 -0
- data/Gemfile.lock +97 -0
- data/LICENSE +202 -0
- data/NOTICE +2 -0
- data/README.md +35 -0
- data/Rakefile +8 -0
- data/bin/console +15 -0
- data/bin/setup +8 -0
- data/lib/teak_util/storage/make_externally_available_file.rb +79 -0
- data/lib/teak_util/storage/s3.rb +68 -0
- data/lib/teak_util/version.rb +5 -0
- data/lib/teak_util.rb +8 -0
- data/teak_util.gemspec +39 -0
- metadata +120 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 1e699ed3a7acc47afe78483aa12f2b9db62208c1afb4227f998daa68e4cd0992
|
4
|
+
data.tar.gz: e2df8adf7887df6df954c1c8429cd8adefbbe9fb1bb86be76b6d2d01c0003b9f
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 072ec5b638c324de96f21a73798df6337ee6a1eed8f7b26796bd4147610776112fbaf7fd7741949c462206ea79c28dbb8e4f586861657ccc4b99e215b1e3de5f
|
7
|
+
data.tar.gz: b48a13ba504bf4bc8ccdd63b43226d4f81e9c15e8ed48f36538664f3cc4d94b27e705f5559a95985e3f7d450705a738a0a302d9d9f16e291d9aabdc981052f4a
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/CHANGELOG.md
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,97 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
teak_util (0.1.0)
|
5
|
+
aws-sdk-s3 (>= 1.102)
|
6
|
+
business_flow (>= 0.18.0)
|
7
|
+
mime-types (>= 3)
|
8
|
+
rubyzip (~> 2.3)
|
9
|
+
|
10
|
+
GEM
|
11
|
+
remote: https://rubygems.org/
|
12
|
+
specs:
|
13
|
+
activemodel (7.1.1)
|
14
|
+
activesupport (= 7.1.1)
|
15
|
+
activesupport (7.1.1)
|
16
|
+
base64
|
17
|
+
bigdecimal
|
18
|
+
concurrent-ruby (~> 1.0, >= 1.0.2)
|
19
|
+
connection_pool (>= 2.2.5)
|
20
|
+
drb
|
21
|
+
i18n (>= 1.6, < 2)
|
22
|
+
minitest (>= 5.1)
|
23
|
+
mutex_m
|
24
|
+
tzinfo (~> 2.0)
|
25
|
+
aws-eventstream (1.2.0)
|
26
|
+
aws-partitions (1.834.0)
|
27
|
+
aws-sdk-core (3.185.1)
|
28
|
+
aws-eventstream (~> 1, >= 1.0.2)
|
29
|
+
aws-partitions (~> 1, >= 1.651.0)
|
30
|
+
aws-sigv4 (~> 1.5)
|
31
|
+
jmespath (~> 1, >= 1.6.1)
|
32
|
+
aws-sdk-kms (1.72.0)
|
33
|
+
aws-sdk-core (~> 3, >= 3.184.0)
|
34
|
+
aws-sigv4 (~> 1.1)
|
35
|
+
aws-sdk-s3 (1.136.0)
|
36
|
+
aws-sdk-core (~> 3, >= 3.181.0)
|
37
|
+
aws-sdk-kms (~> 1)
|
38
|
+
aws-sigv4 (~> 1.6)
|
39
|
+
aws-sigv4 (1.6.0)
|
40
|
+
aws-eventstream (~> 1, >= 1.0.2)
|
41
|
+
base64 (0.1.1)
|
42
|
+
bigdecimal (3.1.4)
|
43
|
+
business_flow (0.19.3)
|
44
|
+
activemodel (>= 4.2, < 8)
|
45
|
+
activesupport (>= 4.2, < 8)
|
46
|
+
concurrent-ruby (1.2.2)
|
47
|
+
connection_pool (2.4.1)
|
48
|
+
diff-lcs (1.5.0)
|
49
|
+
docile (1.4.0)
|
50
|
+
drb (2.1.1)
|
51
|
+
ruby2_keywords
|
52
|
+
i18n (1.14.1)
|
53
|
+
concurrent-ruby (~> 1.0)
|
54
|
+
jmespath (1.6.2)
|
55
|
+
mime-types (3.5.1)
|
56
|
+
mime-types-data (~> 3.2015)
|
57
|
+
mime-types-data (3.2023.1003)
|
58
|
+
minitest (5.20.0)
|
59
|
+
mutex_m (0.1.2)
|
60
|
+
rake (13.0.6)
|
61
|
+
rspec (3.12.0)
|
62
|
+
rspec-core (~> 3.12.0)
|
63
|
+
rspec-expectations (~> 3.12.0)
|
64
|
+
rspec-mocks (~> 3.12.0)
|
65
|
+
rspec-core (3.12.2)
|
66
|
+
rspec-support (~> 3.12.0)
|
67
|
+
rspec-expectations (3.12.3)
|
68
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
69
|
+
rspec-support (~> 3.12.0)
|
70
|
+
rspec-mocks (3.12.6)
|
71
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
72
|
+
rspec-support (~> 3.12.0)
|
73
|
+
rspec-support (3.12.1)
|
74
|
+
ruby2_keywords (0.0.5)
|
75
|
+
rubyzip (2.3.2)
|
76
|
+
simplecov (0.22.0)
|
77
|
+
docile (~> 1.1)
|
78
|
+
simplecov-html (~> 0.11)
|
79
|
+
simplecov_json_formatter (~> 0.1)
|
80
|
+
simplecov-html (0.12.3)
|
81
|
+
simplecov_json_formatter (0.1.4)
|
82
|
+
timecop (0.9.8)
|
83
|
+
tzinfo (2.0.6)
|
84
|
+
concurrent-ruby (~> 1.0)
|
85
|
+
|
86
|
+
PLATFORMS
|
87
|
+
ruby
|
88
|
+
|
89
|
+
DEPENDENCIES
|
90
|
+
rake (~> 13.0)
|
91
|
+
rspec (~> 3.0)
|
92
|
+
simplecov (~> 0.22.0)
|
93
|
+
teak_util!
|
94
|
+
timecop (~> 0.9.8)
|
95
|
+
|
96
|
+
BUNDLED WITH
|
97
|
+
2.1.4
|
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/NOTICE
ADDED
data/README.md
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
# TeakUtil
|
2
|
+
|
3
|
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/teak_util`. To experiment with that code, run `bin/console` for an interactive prompt.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'teak_util'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle install
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install teak_util
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
30
|
+
|
31
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/teak_util.
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require "bundler/setup"
|
5
|
+
require "teak_util"
|
6
|
+
|
7
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
8
|
+
# with your gem easier. You can also use a different console, if you like.
|
9
|
+
|
10
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
11
|
+
# require "pry"
|
12
|
+
# Pry.start
|
13
|
+
|
14
|
+
require "irb"
|
15
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,79 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'teak_util/storage/s3'
|
4
|
+
require 'business_flow'
|
5
|
+
require 'mime-types'
|
6
|
+
require 'zip'
|
7
|
+
require 'zip/filesystem'
|
8
|
+
|
9
|
+
module TeakUtil
|
10
|
+
module Storage
|
11
|
+
# Creates a file and provides a time limited publicly accessible URL to the file.
|
12
|
+
# The file may optionally be a Zip folder containing multiple distinct files. This
|
13
|
+
# is achieved by passing in a hash for 'value', where the keys will be the contained
|
14
|
+
# file names, and the values will be the file contents.
|
15
|
+
class MakeExternallyAvailableFile
|
16
|
+
include BusinessFlow::Base
|
17
|
+
|
18
|
+
needs :storage, :key, :value
|
19
|
+
wants(:compress) { false }
|
20
|
+
|
21
|
+
lookup :storage, by: [:bucket_name, :prefix], with: -> { Storage::S3.new(bucket_name, prefix: "#{prefix}#{time_prefix}") }
|
22
|
+
uses(:time_prefix) { Time.now.utc.strftime('%Y/%m/%d/') }
|
23
|
+
|
24
|
+
provides :stored_file_name, :public_url
|
25
|
+
|
26
|
+
step :convert_data
|
27
|
+
step :store_data
|
28
|
+
|
29
|
+
private
|
30
|
+
|
31
|
+
attr_accessor :data, :content_type
|
32
|
+
|
33
|
+
def initialize
|
34
|
+
@multiple_files = value.kind_of?(Hash)
|
35
|
+
self.stored_file_name = compress ? "#{key}.zip" : key
|
36
|
+
self.content_type = MIME::Types.type_for(stored_file_name).first&.to_s
|
37
|
+
|
38
|
+
if multiple_files? && !compress
|
39
|
+
errors.add(:compress, :invalid, message: 'must be true when storing multiple files')
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
def multiple_files?
|
44
|
+
@multiple_files
|
45
|
+
end
|
46
|
+
|
47
|
+
def convert_data
|
48
|
+
self.data =
|
49
|
+
if multiple_files?
|
50
|
+
Zip::File.open_buffer(StringIO.new(String.new)) do |zip_file|
|
51
|
+
value.each do |(fname, contents)|
|
52
|
+
zip_file.file.open(fname, +'w') do |file|
|
53
|
+
file.write(contents)
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end.string
|
57
|
+
elsif compress
|
58
|
+
Zip::File.open_buffer(StringIO.new(String.new)) do |zip_file|
|
59
|
+
zip_file.file.open(key, +'w') do |file|
|
60
|
+
file.write(value)
|
61
|
+
end
|
62
|
+
end.string
|
63
|
+
else
|
64
|
+
value
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
def store_data
|
69
|
+
opts = {
|
70
|
+
content_disposition: "attachment; filename=\"#{stored_file_name}\""
|
71
|
+
}
|
72
|
+
opts[:content_type] = content_type if content_type
|
73
|
+
storage.put(stored_file_name, data, opts)
|
74
|
+
|
75
|
+
self.public_url = storage.public_url(stored_file_name)
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'aws-sdk-s3'
|
4
|
+
|
5
|
+
module TeakUtil
|
6
|
+
module Storage
|
7
|
+
# Wraps access to S3 in a simpler key/value API.
|
8
|
+
class S3
|
9
|
+
# @param bucket [String] the name of the s3 bucket that this wrapper accesses
|
10
|
+
# @param client [Aws::S3::Client] injectable S3 client for testing
|
11
|
+
# @param prefix [String] prefix applied to all keys
|
12
|
+
# @param server_side_encryption [String, nil] one of AES256 or aws:kms to
|
13
|
+
# encrypt written objects
|
14
|
+
# @param kms_key_id [String, nil] if server_side_encryption is aws:ksm then this
|
15
|
+
# is the ARN of the KMS key to encrypt with. If blank, we will use the AWS managed
|
16
|
+
# aws/s3 KMS key
|
17
|
+
# @param acl [String] the canned ACL to apply to objects, defaults to 'private'
|
18
|
+
def initialize(bucket, client: nil, prefix: '', server_side_encryption: 'aws:kms',
|
19
|
+
kms_key_id: nil, acl: 'private')
|
20
|
+
|
21
|
+
client ||= Aws::S3::Client.new
|
22
|
+
@bucket = Aws::S3::Resource.new(client: client).bucket(bucket)
|
23
|
+
@prefix = prefix
|
24
|
+
|
25
|
+
@put_opts = {
|
26
|
+
acl: acl,
|
27
|
+
server_side_encryption: server_side_encryption
|
28
|
+
}
|
29
|
+
|
30
|
+
@put_opts[:ssekms_key_id] = kms_key_id if kms_key_id
|
31
|
+
end
|
32
|
+
|
33
|
+
# Set key to hold the string value. If a key already holds a value it
|
34
|
+
# is overwritten.
|
35
|
+
# @param key [String]
|
36
|
+
# @param value [String, IO]
|
37
|
+
# @param opts [Hash] Additional S3 options for the file
|
38
|
+
# @option opts [String] :content_type A standard MIME type describing the format of the contents.
|
39
|
+
# @option opts [String] :content_disposition Specifies presentational information for the object.
|
40
|
+
def put(key, value, opts = {})
|
41
|
+
path = "#{@prefix}#{key}"
|
42
|
+
@bucket.object(path).put(
|
43
|
+
opts.merge(@put_opts.merge(body: value))
|
44
|
+
)
|
45
|
+
true
|
46
|
+
end
|
47
|
+
|
48
|
+
# Retrieves the value stored at key
|
49
|
+
# @param key [String]
|
50
|
+
def get(key)
|
51
|
+
path = "#{@prefix}#{key}"
|
52
|
+
begin
|
53
|
+
@bucket.object(path).get.body.read
|
54
|
+
rescue Aws::S3::Errors::NoSuchKey
|
55
|
+
return nil
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
# Returns a URL which allows public access to the data stored at key
|
60
|
+
# @param expires_in [Fixnum] number of seconds the link will remain valid for
|
61
|
+
# Maximum is 604800 (1 week).
|
62
|
+
def public_url(key, expires_in: 1.week)
|
63
|
+
path = "#{@prefix}#{key}"
|
64
|
+
@bucket.object(path).presigned_url(:get, expires_in: expires_in.to_i)
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
data/lib/teak_util.rb
ADDED
data/teak_util.gemspec
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "lib/teak_util/version"
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = "teak_util"
|
7
|
+
spec.version = TeakUtil::VERSION
|
8
|
+
spec.authors = ["Alex Scarborough"]
|
9
|
+
spec.email = ["alex@teak.io"]
|
10
|
+
|
11
|
+
spec.summary = "A collection of utilities used by multiple projects at Teak"
|
12
|
+
spec.homepage = "https://github.com/GoCarrot/teak_util"
|
13
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
|
14
|
+
|
15
|
+
spec.license = "Apache-2.0"
|
16
|
+
|
17
|
+
spec.metadata["rubygems_mfa_required"] = "true"
|
18
|
+
|
19
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
20
|
+
spec.metadata["source_code_uri"] = "https://github.com/GoCarrot/teak_util"
|
21
|
+
spec.metadata["changelog_uri"] = "https://github.com/GoCarrot/teak_util/blob/main/CHANGELOG.md"
|
22
|
+
|
23
|
+
# Specify which files should be added to the gem when it is released.
|
24
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
25
|
+
spec.files = Dir.chdir(File.expand_path(__dir__)) do
|
26
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
|
27
|
+
end
|
28
|
+
spec.bindir = "exe"
|
29
|
+
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
|
30
|
+
spec.require_paths = ["lib"]
|
31
|
+
|
32
|
+
spec.add_dependency "aws-sdk-s3", ">= 1.102"
|
33
|
+
spec.add_dependency "business_flow", ">= 0.18.0"
|
34
|
+
spec.add_dependency "mime-types", ">= 3"
|
35
|
+
spec.add_dependency "rubyzip", "~> 2.3"
|
36
|
+
|
37
|
+
# For more information and examples about making a new gem, checkout our
|
38
|
+
# guide at: https://bundler.io/guides/creating_gem.html
|
39
|
+
end
|
metadata
ADDED
@@ -0,0 +1,120 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: teak_util
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Alex Scarborough
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2023-10-12 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: aws-sdk-s3
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.102'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.102'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: business_flow
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 0.18.0
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 0.18.0
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: mime-types
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rubyzip
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '2.3'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '2.3'
|
69
|
+
description:
|
70
|
+
email:
|
71
|
+
- alex@teak.io
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".circleci/config.yml"
|
77
|
+
- ".gitignore"
|
78
|
+
- ".rspec"
|
79
|
+
- CHANGELOG.md
|
80
|
+
- Gemfile
|
81
|
+
- Gemfile.lock
|
82
|
+
- LICENSE
|
83
|
+
- NOTICE
|
84
|
+
- README.md
|
85
|
+
- Rakefile
|
86
|
+
- bin/console
|
87
|
+
- bin/setup
|
88
|
+
- lib/teak_util.rb
|
89
|
+
- lib/teak_util/storage/make_externally_available_file.rb
|
90
|
+
- lib/teak_util/storage/s3.rb
|
91
|
+
- lib/teak_util/version.rb
|
92
|
+
- teak_util.gemspec
|
93
|
+
homepage: https://github.com/GoCarrot/teak_util
|
94
|
+
licenses:
|
95
|
+
- Apache-2.0
|
96
|
+
metadata:
|
97
|
+
rubygems_mfa_required: 'true'
|
98
|
+
homepage_uri: https://github.com/GoCarrot/teak_util
|
99
|
+
source_code_uri: https://github.com/GoCarrot/teak_util
|
100
|
+
changelog_uri: https://github.com/GoCarrot/teak_util/blob/main/CHANGELOG.md
|
101
|
+
post_install_message:
|
102
|
+
rdoc_options: []
|
103
|
+
require_paths:
|
104
|
+
- lib
|
105
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: 2.5.0
|
110
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
111
|
+
requirements:
|
112
|
+
- - ">="
|
113
|
+
- !ruby/object:Gem::Version
|
114
|
+
version: '0'
|
115
|
+
requirements: []
|
116
|
+
rubygems_version: 3.1.6
|
117
|
+
signing_key:
|
118
|
+
specification_version: 4
|
119
|
+
summary: A collection of utilities used by multiple projects at Teak
|
120
|
+
test_files: []
|