middleman-s3_metadata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cebb1a692bbd9d2d3aac540e0fd832dd4df57a3
+  data.tar.gz: d0b0e30467613b24fad9b1ac25e11ff44959a3c4
+SHA512:
+  metadata.gz: efaeb1a575b019024ceaea41c41098a84357232ba1e3a7ecbb189f05ee06c441f4b0f855b87d9918592e9249eb5f64d6a820697de03c74995982c8f3ee5efa28
+  data.tar.gz: 86b7cfbf63798704622b38ac7c0719f254843273695ff2e19e0601c88756fc4de8a58ca319c0b29070572ef79724877308e2b2e13558ebf40fee40cfcc5cd36e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-s3_metadata.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Junya Ogura and QNYP, LLC.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Middleman::S3Metadata
+
+This gem automates updating metadata of specific AWS S3 object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'middleman-s3_metadata'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install middleman-s3_metadata
+
+## Usage
+
+You need to add the following code to your config.rb file:
+
+```ruby
+activate :s3_metadata do |config|
+  config.bucket                = 'my.bucket.com' # The name of the S3 bucket you are targetting. This is globally unique.
+  config.region                = 'us-west-1'     # The AWS region for your bucket.
+  config.aws_access_key_id     = 'AWS KEY ID'
+  config.aws_secret_access_key = 'AWS SECRET KEY'
+  config.after_build           = false # We chain after the build step by default. This may not be your desired behavior...
+end
+```
+
+The `s3_metadata` method set a metadata for S3 object:
+
+```ruby
+s3_metadata('feeds/feed.rss', 'Content-Type', 'rss/xml')
+s3_metadata('archives.tar.gz', 'Content-Type', 'application/x-gzip')
+```
+
+First argument is key for S3 object, second and third arguments is key and value for metadata.
+
+## A Debt of Gratitude
+
+I used middleman-sync and middleman-s3_redirect as a template for building a Middleman extension.
+My gratitude goes to @karlfreeman and @fredjean.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/middleman/s3_metadata/commands.rb

@@ -0,0 +1,30 @@
+require 'middleman-core/cli'
+require 'middleman/s3_metadata/extension'
+
+module Middleman
+  module Cli
+    class S3Metadata < Thor
+      include Thor::Actions
+
+      check_unknown_options!
+
+      namespace :s3_metadata
+
+      def self.exit_on_failure?
+        true
+      end
+
+      desc 's3_metadata', 'Updates metadata for S3 objects.'
+      def s3_metadata
+        shared_inst = ::Middleman::Application.server.inst
+
+        if (!shared_inst.respond_to?('s3_metadata_options') ||
+            !shared_inst.s3_metadata_options.aws_access_key_id)
+          raise Thor::Error.new 'You need to activate this extension.'
+        end
+
+        ::Middleman::S3Metadata.generate
+      end
+    end
+  end
+end

data/lib/middleman/s3_metadata/extension.rb

@@ -0,0 +1,101 @@
+require 'middleman-core'
+
+module Middleman
+  module S3Metadata
+
+    class Options < Struct.new(:prefix,
+                               :public_path,
+                               :bucket,
+                               :region,
+                               :aws_access_key_id,
+                               :aws_secret_access_key,
+                               :after_build)
+
+      # Returns an array
+      def mappings
+        @mappings ||= []
+      end
+
+      # object - String key for S3 object.
+      # key    - Attribute key for metadata.
+      # value  - Value for metadata.
+      #
+      # No return value
+      def s3_metadata(object, key, value)
+        mappings << Metadata.new(object, key, value)
+      end
+
+      protected
+
+      class Metadata
+        attr_reader :object, :key, :value
+
+        def initialize(object, key, value)
+          @object = object
+          @key = key
+          @value = value
+        end
+      end
+    end
+
+    class << self
+      def options
+        @@options
+      end
+
+      def registered(app, options_hash = {}, &block)
+        options = Options.new(options.hash)
+        yield options if block_given?
+
+        @@options = options
+
+        app.send :include, Helpers
+
+        options.public_path ||= 'build'
+
+        app.after_configuration do |config|
+          after_build do |builder|
+            ::Middleman::S3Metadata.generate if options.after_build
+          end
+        end
+      end
+      alias :included :registered
+
+      def generate
+        options.mappings.each do |mapping|
+          puts "Set metadata for '/#{mapping.object}' with '#{mapping.key}' => '#{mapping.value}'"
+          file = s3_files.find { |i| i.key == mapping.object }
+          file.reload
+          file.metadata = { mapping.key => mapping.value }
+          file.save
+        end
+      end
+
+      def connection
+        @connection ||= Fog::Storage.new(provider: 'AWS',
+                                         aws_access_key_id: options.aws_access_key_id,
+                                         aws_secret_access_key: options.aws_secret_access_key,
+                                         region: options.region)
+      end
+
+      def bucket
+        @bucket ||= connection.directories.get(options.bucket)
+      end
+
+      def s3_files
+        @s3_files ||= bucket.files
+      end
+
+      module Helpers
+        def s3_metadata(object, key, value)
+          ::Middleman::S3Metadata.options.s3_metadata(object, key, value)
+        end
+
+        def s3_metadata_options
+          ::Middleman::S3Metadata.options
+        end
+      end
+    end
+
+  end
+end

data/lib/middleman/s3_metadata/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module S3Metadata
+    VERSION = '0.1.0'
+  end
+end

data/lib/middleman-s3_metadata.rb

@@ -0,0 +1,9 @@
+require 'middleman-core'
+require 'fog'
+require 'middleman/s3_metadata/version'
+require 'middleman/s3_metadata/commands'
+
+::Middleman::Extensions.register(:s3_metadata, '>= 3.0.0') do
+  require 'middleman/s3_metadata/extension'
+  ::Middleman::S3Metadata
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-s3_metadata'

data/middleman-s3_metadata.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman/s3_metadata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'middleman-s3_metadata'
+  spec.version       = Middleman::S3Metadata::VERSION
+  spec.authors       = ['Junya Ogura', 'QNYP, LLC.']
+  spec.email         = ['junyaogura@gmail.com']
+  spec.description   = %q{Set Content-Type metadata for S3 objects after syncing.}
+  spec.summary       = %q{Set Content-Type metadata for S3 objects after syncing.}
+  spec.homepage      = 'https://github.com/juno/middleman-s3_metadata'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'middleman-core', '>= 3.0.0'
+  spec.add_runtime_dependency 'fog'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: middleman-s3_metadata
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Junya Ogura
+- QNYP, LLC.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Set Content-Type metadata for S3 objects after syncing.
+email:
+- junyaogura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/middleman-s3_metadata.rb
+- lib/middleman/s3_metadata/commands.rb
+- lib/middleman/s3_metadata/extension.rb
+- lib/middleman/s3_metadata/version.rb
+- lib/middleman_extension.rb
+- middleman-s3_metadata.gemspec
+homepage: https://github.com/juno/middleman-s3_metadata
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Set Content-Type metadata for S3 objects after syncing.
+test_files: []