middleman-s3_redirect 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fba30466432df1f1fc4b02c84b31f3f87c0d860
-  data.tar.gz: aa584c64af0b5f15b9b4ef1c22eae65290e6d779
+  metadata.gz: 6645a78129ff9d9ee32b93a06ec00c4c4cfc38c1
+  data.tar.gz: da0172f182c49de0d591e28a95fbdeadf993a325
 SHA512:
-  metadata.gz: 18dacefd83dbf3b4eae1ebb6199c8581691ea4b84ff3971cfcefd94d47cfb939f400b3de6be73bc65f5eda7775ad107e270224e0c03974d525abee501bd306f4
-  data.tar.gz: 1753ef083ae0f4538e22f0351e6c405d431243c8cd835327cad47372cae73a53d739a05f85a479e4dd9ba03503da3cd093b6606c2afa64070e3d5cfcbb756feb
+  metadata.gz: 1414a3cbdbd1f90854d85ce3aa1122e3c7d1bc40ea4915117bdd5fea790847d3d1f468163b6f65e791e9e24013245e366282a2313d6df741e8a02cde8bd49370
+  data.tar.gz: dc40049a708320f698cb412d0232cb35e4abb8bf8cb1017a363b8a03615a1f8d73d212800a7992c60fbca495ed0730b8687b7d16a2e664008f50e8287918ebdb

data/.s3_sync.sample

@@ -0,0 +1,3 @@
+---
+aws_access_key_id: <AWS Access Key>
+aws_secret_access_key: <AWS Secret Access Key>

data/README.md

@@ -37,7 +37,40 @@ The ```redirect``` method register a redirect:
 redirect '/old/path', '/new/path'
 ```
 
-You can then configure S3 to redirect these path by running  ```middleman s3_redirect```. 
+You can then configure S3 to redirect these path by running  ```middleman s3_redirect```.
+
+### Providing AWS Credentials
+
+There are a few ways to provide the AWS credentials for s3_redirect:
+
+#### Through ```config.rb```
+
+You can set the aws_access_key_id and aws_secret_access_key in the block
+that is passed to the activate method.
+
+#### Through ```.s3_sync``` File
+
+You can create a ```.s3_sync``` at the root of your middleman project.
+The credentials are passed in the YAML format. The keys match the
+options keys.
+
+The .s3_sync file takes precedence to the configuration passed in the
+activate method.
+
+A sample ```.s3_sync``` file is included at the root of this repo.
+
+#### Through Environment
+
+You can also pass the credentials through environment variables. They
+map to the following values:
+
+| Setting               | Environment Variable               |
+| --------------------- | ---------------------------------- |
+| aws_access_key_id     | ```ENV['AWS_ACCESS_KEY_ID```       |
+| aws_secret_access_key | ```ENV['AWS_SECRET_ACCESS_KEY']``` |
+
+The environment is used when the credentials are not set in the activate
+method or passed through the ```.s3_sync``` configuration file.
 
 ## A Debt of Gratitude
 
@@ -47,7 +80,7 @@ extend it to add my synchronization code. My gratitude goes to @karlfreeman
 and is work on Middleman sync.
 
 Many thanks to [Junya Ogura](https://github.com/juno) for multiple pull
-requests improving this gem. 
+requests improving this gem.
 
 ## Contributing
 

data/lib/middleman-s3_redirect/extension.rb

@@ -2,16 +2,20 @@ require 'middleman-core'
 
 module Middleman
   module S3Redirect
-    class Options < Struct.new(
-      :prefix,
-      :public_path,
-      :bucket,
-      :region,
-      :path_style,
-      :aws_access_key_id,
-      :aws_secret_access_key,
-      :after_build
-    )
+    class Options
+      attr_accessor \
+        :prefix,
+        :public_path,
+        :bucket,
+        :region,
+        :path_style,
+        :aws_access_key_id,
+        :aws_secret_access_key,
+        :after_build
+
+      def initialize
+        self.read_config
+      end
 
       def redirect(from, to)
         redirects << RedirectEntry.new(from, to)
@@ -22,6 +26,24 @@ module Middleman
       end
 
       protected
+
+      def read_config(io = nil)
+        unless io
+          root_path = ::Middleman::Application.root
+          config_file_path = File.join(root_path, ".s3_sync")
+
+          # skip if config file does not exist
+          return unless File.exists?(config_file_path)
+
+          io = File.open(config_file_path, "r")
+        end
+
+        config = YAML.load(io)
+
+        self.aws_access_key_id = config["aws_access_key_id"] if config["aws_access_key_id"]
+        self.aws_secret_access_key = config["aws_secret_access_key"] if config["aws_secret_access_key"]
+      end
+
       class RedirectEntry
         attr_reader :from, :to
         def initialize(from, to)
@@ -48,7 +70,7 @@ module Middleman
       end
 
       def registered(app, options_hash = {}, &block)
-        options = Options.new(options.hash)
+        options = Options.new
         yield options if block_given?
 
         @@options = options

data/lib/middleman-s3_redirect/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module S3Redirect
-    VERSION = "3.0.3"
+    VERSION = "3.0.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-s3_redirect
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Frederic Jean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-15 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .s3_sync.sample
 - Gemfile
 - LICENSE.txt
 - README.md