middleman-s3_redirect 3.0.0

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_redirect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Frederic Jean
+
+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,55 @@
+# Middleman::S3Redirect
+
+AWS S3 allows redirects to occur directly from an S3 object. This gem
+automates configuring AWS S3 to redirect from one path to another.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'middleman-s3_redirect'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install middleman-s3_sync
+
+## Usage
+
+You need to add the following code to your ```config.rb``` file:
+
+```ruby
+activate :s3_redirect 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 ```redirect``` method register a redirect:
+
+```ruby
+redirect '/old/path', '/new/path'
+```
+
+You can then configure S3 to redirect these path by running  ```middleman s3_redirect```. 
+
+## A Debt of Gratitude
+
+I used Middleman Sync as a template for building a Middleman extension.
+The code is well structured and easy to understand and it was easy to
+extend it to add my synchronization code. My gratitude goes to @karlfreeman
+and is work on Middleman sync.
+
+## 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_redirect/commands.rb

@@ -0,0 +1,29 @@
+require 'middleman-core/cli'
+require 'middleman-s3_redirect/extension'
+
+module Middleman
+  module Cli
+    class S3Redirect < Thor
+      include Thor::Actions
+
+      check_unknown_options!
+
+      namespace :s3_redirect
+
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "s3_redirect", "Creates redirect objects directly in S3."
+      def s3_redirect
+        shared_inst = ::Middleman::Application.server.inst
+        bucket = shared_inst.options.bucket
+        if (!bucket)
+          raise Thor::Error.new "You need to activate this extension."
+        end
+
+        ::Middleman::S3Redirect.generate
+      end
+    end
+  end
+end

data/lib/middleman-s3_redirect/extension.rb

@@ -0,0 +1,104 @@
+require 'middleman-core'
+
+module Middleman
+  module S3Redirect
+    class Options < Struct.new(
+      :prefix,
+      :public_path,
+      :bucket,
+      :region,
+      :aws_access_key_id,
+      :aws_secret_access_key,
+      :after_build
+    )
+
+      def redirect(from, to)
+        redirects << RedirectEntry.new(from, to)
+      end
+
+      def redirects
+        @redirects ||= []
+      end
+
+      protected
+      class RedirectEntry
+        attr_reader :from, :to
+        def initialize(from, to)
+          @from = normalize(from)
+          @to = to
+        end
+
+        protected
+        def normalize(path)
+          unless path =~ /\.html$/
+            path << '/' unless path =~ /\/$/
+            path << 'index.html'
+          end
+          path = path[1..path.length] if path[0] = '/'
+          path
+        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::S3Redirect.generate if options.after_build
+          end
+        end
+      end
+      alias :included :registered
+
+      def generate
+        options.redirects.each do |redirect|
+          puts "Redirecting /#{redirect.from} to #{redirect.to}"
+          bucket.files.create({
+            :key => redirect.from,
+            :public => true,
+            :acl => 'public-read',
+            :body => '',
+            'x-amz-website-redirect-location' => "#{redirect.to}"
+          })
+        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 redirect(from, to)
+          ::Middleman::S3Redirect.options.redirect(from, to)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-s3_redirect/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module S3Redirect
+    VERSION = "3.0.0"
+  end
+end

data/lib/middleman-s3_redirect.rb

@@ -0,0 +1,10 @@
+require 'middleman-core'
+require 'fog'
+require 'parallel'
+require 'middleman-s3_redirect/version'
+require 'middleman-s3_redirect/commands'
+
+::Middleman::Extensions.register(:s3_redirect, '>= 3.0.0') do
+  require 'middleman-s3_redirect/extension'
+  ::Middleman::S3Redirect
+end

data/middleman-s3_redirect.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-s3_redirect/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "middleman-s3_redirect"
+  gem.version       = Middleman::S3Redirect::VERSION
+  gem.authors       = ["Frederic Jean"]
+  gem.email         = ["fred@fredjean.net"]
+  gem.description   = %q{Generates redirects via S3 API.}
+  gem.summary       = %q{Nothing to see here... Move along.}
+  gem.homepage      = "https://github.com/fredjean/middleman-s3_redirect"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+
+  gem.add_runtime_dependency 'middleman-core', '>= 3.0.0'
+  gem.add_runtime_dependency 'fog'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: middleman-s3_redirect
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 3.0.0
+platform: ruby
+authors:
+- Frederic Jean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: middleman-core
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: fog
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates redirects via S3 API.
+email:
+- fred@fredjean.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/middleman-s3_redirect.rb
+- lib/middleman-s3_redirect/commands.rb
+- lib/middleman-s3_redirect/extension.rb
+- lib/middleman-s3_redirect/version.rb
+- middleman-s3_redirect.gemspec
+homepage: https://github.com/fredjean/middleman-s3_redirect
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -3985194922976205752
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -3985194922976205752
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Nothing to see here... Move along.
+test_files: []