middleman-s3_metadata 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/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +53 -0
- data/Rakefile +1 -0
- data/lib/middleman/s3_metadata/commands.rb +30 -0
- data/lib/middleman/s3_metadata/extension.rb +101 -0
- data/lib/middleman/s3_metadata/version.rb +5 -0
- data/lib/middleman-s3_metadata.rb +9 -0
- data/lib/middleman_extension.rb +1 -0
- data/middleman-s3_metadata.gemspec +26 -0
- metadata +112 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 4cebb1a692bbd9d2d3aac540e0fd832dd4df57a3
|
4
|
+
data.tar.gz: d0b0e30467613b24fad9b1ac25e11ff44959a3c4
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: efaeb1a575b019024ceaea41c41098a84357232ba1e3a7ecbb189f05ee06c441f4b0f855b87d9918592e9249eb5f64d6a820697de03c74995982c8f3ee5efa28
|
7
|
+
data.tar.gz: 86b7cfbf63798704622b38ac7c0719f254843273695ff2e19e0601c88756fc4de8a58ca319c0b29070572ef79724877308e2b2e13558ebf40fee40cfcc5cd36e
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Junya Ogura and QNYP, LLC.
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
# Middleman::S3Metadata
|
2
|
+
|
3
|
+
This gem automates updating metadata of specific AWS S3 object.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'middleman-s3_metadata'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install middleman-s3_metadata
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
You need to add the following code to your config.rb file:
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
activate :s3_metadata do |config|
|
25
|
+
config.bucket = 'my.bucket.com' # The name of the S3 bucket you are targetting. This is globally unique.
|
26
|
+
config.region = 'us-west-1' # The AWS region for your bucket.
|
27
|
+
config.aws_access_key_id = 'AWS KEY ID'
|
28
|
+
config.aws_secret_access_key = 'AWS SECRET KEY'
|
29
|
+
config.after_build = false # We chain after the build step by default. This may not be your desired behavior...
|
30
|
+
end
|
31
|
+
```
|
32
|
+
|
33
|
+
The `s3_metadata` method set a metadata for S3 object:
|
34
|
+
|
35
|
+
```ruby
|
36
|
+
s3_metadata('feeds/feed.rss', 'Content-Type', 'rss/xml')
|
37
|
+
s3_metadata('archives.tar.gz', 'Content-Type', 'application/x-gzip')
|
38
|
+
```
|
39
|
+
|
40
|
+
First argument is key for S3 object, second and third arguments is key and value for metadata.
|
41
|
+
|
42
|
+
## A Debt of Gratitude
|
43
|
+
|
44
|
+
I used middleman-sync and middleman-s3_redirect as a template for building a Middleman extension.
|
45
|
+
My gratitude goes to @karlfreeman and @fredjean.
|
46
|
+
|
47
|
+
## Contributing
|
48
|
+
|
49
|
+
1. Fork it
|
50
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
51
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
52
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
53
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
@@ -0,0 +1,30 @@
|
|
1
|
+
require 'middleman-core/cli'
|
2
|
+
require 'middleman/s3_metadata/extension'
|
3
|
+
|
4
|
+
module Middleman
|
5
|
+
module Cli
|
6
|
+
class S3Metadata < Thor
|
7
|
+
include Thor::Actions
|
8
|
+
|
9
|
+
check_unknown_options!
|
10
|
+
|
11
|
+
namespace :s3_metadata
|
12
|
+
|
13
|
+
def self.exit_on_failure?
|
14
|
+
true
|
15
|
+
end
|
16
|
+
|
17
|
+
desc 's3_metadata', 'Updates metadata for S3 objects.'
|
18
|
+
def s3_metadata
|
19
|
+
shared_inst = ::Middleman::Application.server.inst
|
20
|
+
|
21
|
+
if (!shared_inst.respond_to?('s3_metadata_options') ||
|
22
|
+
!shared_inst.s3_metadata_options.aws_access_key_id)
|
23
|
+
raise Thor::Error.new 'You need to activate this extension.'
|
24
|
+
end
|
25
|
+
|
26
|
+
::Middleman::S3Metadata.generate
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,101 @@
|
|
1
|
+
require 'middleman-core'
|
2
|
+
|
3
|
+
module Middleman
|
4
|
+
module S3Metadata
|
5
|
+
|
6
|
+
class Options < Struct.new(:prefix,
|
7
|
+
:public_path,
|
8
|
+
:bucket,
|
9
|
+
:region,
|
10
|
+
:aws_access_key_id,
|
11
|
+
:aws_secret_access_key,
|
12
|
+
:after_build)
|
13
|
+
|
14
|
+
# Returns an array
|
15
|
+
def mappings
|
16
|
+
@mappings ||= []
|
17
|
+
end
|
18
|
+
|
19
|
+
# object - String key for S3 object.
|
20
|
+
# key - Attribute key for metadata.
|
21
|
+
# value - Value for metadata.
|
22
|
+
#
|
23
|
+
# No return value
|
24
|
+
def s3_metadata(object, key, value)
|
25
|
+
mappings << Metadata.new(object, key, value)
|
26
|
+
end
|
27
|
+
|
28
|
+
protected
|
29
|
+
|
30
|
+
class Metadata
|
31
|
+
attr_reader :object, :key, :value
|
32
|
+
|
33
|
+
def initialize(object, key, value)
|
34
|
+
@object = object
|
35
|
+
@key = key
|
36
|
+
@value = value
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
class << self
|
42
|
+
def options
|
43
|
+
@@options
|
44
|
+
end
|
45
|
+
|
46
|
+
def registered(app, options_hash = {}, &block)
|
47
|
+
options = Options.new(options.hash)
|
48
|
+
yield options if block_given?
|
49
|
+
|
50
|
+
@@options = options
|
51
|
+
|
52
|
+
app.send :include, Helpers
|
53
|
+
|
54
|
+
options.public_path ||= 'build'
|
55
|
+
|
56
|
+
app.after_configuration do |config|
|
57
|
+
after_build do |builder|
|
58
|
+
::Middleman::S3Metadata.generate if options.after_build
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
alias :included :registered
|
63
|
+
|
64
|
+
def generate
|
65
|
+
options.mappings.each do |mapping|
|
66
|
+
puts "Set metadata for '/#{mapping.object}' with '#{mapping.key}' => '#{mapping.value}'"
|
67
|
+
file = s3_files.find { |i| i.key == mapping.object }
|
68
|
+
file.reload
|
69
|
+
file.metadata = { mapping.key => mapping.value }
|
70
|
+
file.save
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
def connection
|
75
|
+
@connection ||= Fog::Storage.new(provider: 'AWS',
|
76
|
+
aws_access_key_id: options.aws_access_key_id,
|
77
|
+
aws_secret_access_key: options.aws_secret_access_key,
|
78
|
+
region: options.region)
|
79
|
+
end
|
80
|
+
|
81
|
+
def bucket
|
82
|
+
@bucket ||= connection.directories.get(options.bucket)
|
83
|
+
end
|
84
|
+
|
85
|
+
def s3_files
|
86
|
+
@s3_files ||= bucket.files
|
87
|
+
end
|
88
|
+
|
89
|
+
module Helpers
|
90
|
+
def s3_metadata(object, key, value)
|
91
|
+
::Middleman::S3Metadata.options.s3_metadata(object, key, value)
|
92
|
+
end
|
93
|
+
|
94
|
+
def s3_metadata_options
|
95
|
+
::Middleman::S3Metadata.options
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
end
|
101
|
+
end
|
@@ -0,0 +1,9 @@
|
|
1
|
+
require 'middleman-core'
|
2
|
+
require 'fog'
|
3
|
+
require 'middleman/s3_metadata/version'
|
4
|
+
require 'middleman/s3_metadata/commands'
|
5
|
+
|
6
|
+
::Middleman::Extensions.register(:s3_metadata, '>= 3.0.0') do
|
7
|
+
require 'middleman/s3_metadata/extension'
|
8
|
+
::Middleman::S3Metadata
|
9
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'middleman-s3_metadata'
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'middleman/s3_metadata/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'middleman-s3_metadata'
|
8
|
+
spec.version = Middleman::S3Metadata::VERSION
|
9
|
+
spec.authors = ['Junya Ogura', 'QNYP, LLC.']
|
10
|
+
spec.email = ['junyaogura@gmail.com']
|
11
|
+
spec.description = %q{Set Content-Type metadata for S3 objects after syncing.}
|
12
|
+
spec.summary = %q{Set Content-Type metadata for S3 objects after syncing.}
|
13
|
+
spec.homepage = 'https://github.com/juno/middleman-s3_metadata'
|
14
|
+
spec.license = 'MIT'
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ['lib']
|
20
|
+
|
21
|
+
spec.add_runtime_dependency 'middleman-core', '>= 3.0.0'
|
22
|
+
spec.add_runtime_dependency 'fog'
|
23
|
+
|
24
|
+
spec.add_development_dependency 'bundler', '~> 1.3'
|
25
|
+
spec.add_development_dependency 'rake'
|
26
|
+
end
|
metadata
ADDED
@@ -0,0 +1,112 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: middleman-s3_metadata
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Junya Ogura
|
8
|
+
- QNYP, LLC.
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-04-23 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: middleman-core
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
requirements:
|
18
|
+
- - '>='
|
19
|
+
- !ruby/object:Gem::Version
|
20
|
+
version: 3.0.0
|
21
|
+
type: :runtime
|
22
|
+
prerelease: false
|
23
|
+
version_requirements: !ruby/object:Gem::Requirement
|
24
|
+
requirements:
|
25
|
+
- - '>='
|
26
|
+
- !ruby/object:Gem::Version
|
27
|
+
version: 3.0.0
|
28
|
+
- !ruby/object:Gem::Dependency
|
29
|
+
name: fog
|
30
|
+
requirement: !ruby/object:Gem::Requirement
|
31
|
+
requirements:
|
32
|
+
- - '>='
|
33
|
+
- !ruby/object:Gem::Version
|
34
|
+
version: '0'
|
35
|
+
type: :runtime
|
36
|
+
prerelease: false
|
37
|
+
version_requirements: !ruby/object:Gem::Requirement
|
38
|
+
requirements:
|
39
|
+
- - '>='
|
40
|
+
- !ruby/object:Gem::Version
|
41
|
+
version: '0'
|
42
|
+
- !ruby/object:Gem::Dependency
|
43
|
+
name: bundler
|
44
|
+
requirement: !ruby/object:Gem::Requirement
|
45
|
+
requirements:
|
46
|
+
- - ~>
|
47
|
+
- !ruby/object:Gem::Version
|
48
|
+
version: '1.3'
|
49
|
+
type: :development
|
50
|
+
prerelease: false
|
51
|
+
version_requirements: !ruby/object:Gem::Requirement
|
52
|
+
requirements:
|
53
|
+
- - ~>
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: '1.3'
|
56
|
+
- !ruby/object:Gem::Dependency
|
57
|
+
name: rake
|
58
|
+
requirement: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - '>='
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '0'
|
63
|
+
type: :development
|
64
|
+
prerelease: false
|
65
|
+
version_requirements: !ruby/object:Gem::Requirement
|
66
|
+
requirements:
|
67
|
+
- - '>='
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
description: Set Content-Type metadata for S3 objects after syncing.
|
71
|
+
email:
|
72
|
+
- junyaogura@gmail.com
|
73
|
+
executables: []
|
74
|
+
extensions: []
|
75
|
+
extra_rdoc_files: []
|
76
|
+
files:
|
77
|
+
- .gitignore
|
78
|
+
- Gemfile
|
79
|
+
- LICENSE.txt
|
80
|
+
- README.md
|
81
|
+
- Rakefile
|
82
|
+
- lib/middleman-s3_metadata.rb
|
83
|
+
- lib/middleman/s3_metadata/commands.rb
|
84
|
+
- lib/middleman/s3_metadata/extension.rb
|
85
|
+
- lib/middleman/s3_metadata/version.rb
|
86
|
+
- lib/middleman_extension.rb
|
87
|
+
- middleman-s3_metadata.gemspec
|
88
|
+
homepage: https://github.com/juno/middleman-s3_metadata
|
89
|
+
licenses:
|
90
|
+
- MIT
|
91
|
+
metadata: {}
|
92
|
+
post_install_message:
|
93
|
+
rdoc_options: []
|
94
|
+
require_paths:
|
95
|
+
- lib
|
96
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
97
|
+
requirements:
|
98
|
+
- - '>='
|
99
|
+
- !ruby/object:Gem::Version
|
100
|
+
version: '0'
|
101
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
102
|
+
requirements:
|
103
|
+
- - '>='
|
104
|
+
- !ruby/object:Gem::Version
|
105
|
+
version: '0'
|
106
|
+
requirements: []
|
107
|
+
rubyforge_project:
|
108
|
+
rubygems_version: 2.0.3
|
109
|
+
signing_key:
|
110
|
+
specification_version: 4
|
111
|
+
summary: Set Content-Type metadata for S3 objects after syncing.
|
112
|
+
test_files: []
|