redactor_s3 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e12f897ffc4c3a07d5d402817df954c4174f27cc
-  data.tar.gz: ee4b26125ff17eeb3aa9d4927fdc1f29b8616966
+  metadata.gz: b728ee99cfe4c22b0819ef40e7f262d6970c89a1
+  data.tar.gz: 325900ea4a9afbb746c86f08daa8fbb5e290d9fc
 SHA512:
-  metadata.gz: eca361228fc7b10f3fac57e72fc715197a6e6a614f5f0a858f9ef90499884357bd8401a6addde6f910e9c4ee29a36c20a7b0b048540e3cc97ff3f3d481983bb7
-  data.tar.gz: 46cc3a4730abfadf02f3e332c32fcbad6d73807d685a7a9e1971ccd50d4b131843e404f7d5288d339fcaa869d9def906d0731232a643909e517ed15f472ba400
+  metadata.gz: d08e2fd3829fc465369d7f05abfb96a2fa493e726af738f0ad3db614ac78f8e1d221c51913c4371b4f75442e1c4ccfbe789460dad7d47e787268cbe2c3ef0718
+  data.tar.gz: 714c439f623ef954d0bc69f248d39659cdb1e292bbf713933fcf3c0c416bdd2721176b7cd8d8c2a7a7eb102dfab6762ef4fc32eec2920ef4e2443822a5bea169

data/README.rdoc

@@ -1,3 +1,48 @@
 = RedactorS3
+This gem provides easy integration between redactor.js and Amazon S3 for rails applications
 
+== Getting started
+1. Add the gem:
+    gem 'redactor_s3'
+2. Mount it inside your routes:
+    mount RedactorS3::Engine => "/s3"
+3. Run the installer:
+    rails generate redactor_s3:install
+Dont forget to edit the config file
+
+== Usage
+To use it you need to render some hidden fields in the views where you will be using redactor
+
+Example:
+    # edit.html.rb
+    ...
+    ...
+    <textarea class="redactor"></textarea>
+    <%= render 'redactor_s3/config' %>
+
+You then need to configure your redactor instance in jquery:
+    # edit.js
+    ...
+    ...
+    $("textarea.redactor").redactor({
+        ...
+        ...
+        imageUpload: $("#aws_endpoint").val(),
+        uploadCrossDomain: true,
+        uploadFields: {
+            'key': '#aws_key',
+            'AWSAccessKeyId': '#aws_access_key',
+            'acl': '#aws_acl',
+            'success_action_redirect': '#aws_success_path',
+            'policy': '#aws_policy',
+            'signature': '#aws_signature',
+            'Content-Type': '#aws_content_type'
+        },
+        imageGetJson: $("#aws_files_path").val()
+    });
+
+
+You should now be good to go
+
+== License
 This project rocks and uses MIT-LICENSE.

data/app/controllers/redactor_s3/files_controller.rb

@@ -5,15 +5,13 @@ require_dependency "jbuilder"
 module RedactorS3
   class FilesController < ApplicationController
     def success
-      settings = Settings.new
-      render json: { filelink: "http://#{settings.s3_host}/#{params[:key]}" }
+      render json: { filelink: "#{RedactorS3.config.s3_host_url}/#{params[:key]}" }
     end
     
     def index
-      @settings = Settings.new
-      s3 = AWS::S3.new access_key_id: @settings.access_key, secret_access_key: @settings.secret_key, s3_endpoint: @settings.endpoint
-      bucket = s3.buckets[@settings.bucket]
-      @files = bucket.objects.with_prefix(@settings.prefix)
+      s3 = AWS::S3.new access_key_id: RedactorS3.config.access_key, secret_access_key: RedactorS3.config.secret_key, s3_endpoint: RedactorS3.config.endpoint
+      bucket = s3.buckets[RedactorS3.config.bucket]
+      @files = bucket.objects.with_prefix(RedactorS3.config.prefix)
     end
   end
 end

data/app/views/redactor_s3/{files/_config.html.erb → _config.html.erb}

@@ -1,10 +1,9 @@
-<% settings = RedactorS3::Settings.new %>
-<input type="hidden" id="aws_key" name="aws_key" value="<%= settings.prefix %>${filename}">
-<input type="hidden" id="aws_access_key" name="aws_access_key" value="<%= settings.access_key %>">
+<input type="hidden" id="aws_key" name="aws_key" value="<%= RedactorS3.config.prefix %>${filename}">
+<input type="hidden" id="aws_access_key" name="aws_access_key" value="<%= RedactorS3.config.access_key %>">
 <input type="hidden" id="aws_acl" name="aws_acl" value="public-read">
-<input type="hidden" id="aws_success_path" name="aws_success_path" value="<%= settings.success_url %>">
-<input type="hidden" id="aws_policy" name="aws_policy" value="<%= settings.policy %>">
-<input type="hidden" id="aws_signature" name="aws_signature" value="<%= settings.signature %>">
+<input type="hidden" id="aws_success_path" name="aws_success_path" value="<%= RedactorS3.config.success_url %>">
+<input type="hidden" id="aws_policy" name="aws_policy" value="<%= RedactorS3.config.policy %>">
+<input type="hidden" id="aws_signature" name="aws_signature" value="<%= RedactorS3.config.signature %>">
 <input type="hidden" id="aws_content_type" name="aws_content_type" value="">
-<input type="hidden" id="aws_endpoint" name="aws_endpoint" value="<%= settings.bucket_url %>">
+<input type="hidden" id="aws_endpoint" name="aws_endpoint" value="<%= RedactorS3.config.bucket_url %>">
 <input type="hidden" id="aws_files_path" name="aws_files_path" value="/s3/files">

data/app/views/redactor_s3/files/index.jbuilder

@@ -1,4 +1,4 @@
 json.array! @files do |file|
-  json.thumb "#{@settings.bucket_url}/#{file.key}"
-  json.image "#{@settings.bucket_url}/#{file.key}"
+  json.thumb "#{RedactorS3.config.s3_host_url}/#{file.key}"
+  json.image "#{RedactorS3.config.s3_host_url}/#{file.key}"
 end

data/lib/rails/generators/redactor_s3/install/install_generator.rb

@@ -0,0 +1,15 @@
+module RedactorS3
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Creates an initializer at config/initializers/radactor_s3.rb'
+
+      def self.source_root
+        @source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def create_initializer_file
+        template 'initializer.rb', File.join('config', 'initializers', 'redactor_s3.rb')
+      end
+    end
+  end
+end

data/lib/rails/generators/redactor_s3/install/templates/initializer.rb

@@ -0,0 +1,11 @@
+RedactorS3.configure do |config|
+  config.application_host = 'my.domain.com'
+  config.bucket = 'mybucket'
+  config.access_key = 'AWS_ACCESS_KEY_ID'
+  config.secret_key = 'AWS_SECRET_ACCESS_KEY'
+  
+  ## Optinal
+  # config.region = 'eu-west-1'
+  # config.s3_host = 'mybucket.example.com'
+  # config.prefix = 'files/'
+end

data/lib/redactor_s3.rb

@@ -1,5 +1,6 @@
+require 'redactor_s3/redactor_s3'
+require 'redactor_s3/config'
 require "redactor_s3/engine"
 
 module RedactorS3
-  mattr_accessor :application_host, :access_key, :secret_key, :bucket, :s3_host, :endpoint, :prefix
 end

data/lib/redactor_s3/config.rb

@@ -0,0 +1,46 @@
+module RedactorS3
+  class Config
+    attr_accessor :application_host, :bucket, :access_key, :secret_key, :region, :prefix, :s3_alias
+
+    def initialize
+      self.prefix = 'files/'
+    end
+
+    def success_url
+      "http://#{application_host}/s3/success"
+    end
+
+    def bucket_url
+      "http://#{self.bucket}.#{self.endpoint}"
+    end
+
+    def s3_host_url
+      self.s3_alias ? "http://#{self.s3_alias}" : self.bucket_url
+    end
+
+    def endpoint
+      s3_prefix = 's3'
+      s3_prefix << "-#{self.region}" if region
+      "#{s3_prefix}.amazonaws.com"
+    end
+
+    def policy
+      policy_json="{'expiration': '2020-01-01T00:00:00Z',
+        'conditions': [ 
+          {'bucket': '#{self.bucket}'}, 
+          ['starts-with', '$key', ''],
+          {'acl': 'public-read'},
+          {'success_action_redirect': '#{self.success_url}'},
+          ['starts-with', '$Content-Type', ''],
+          ['content-length-range', 0, 1048576]
+        ]
+      }"
+
+      Base64.encode64(policy_json).gsub("\n","")
+    end
+
+    def signature
+      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), self.secret_key, policy)).gsub("\n","")
+    end
+  end
+end

data/lib/redactor_s3/redactor_s3.rb

@@ -0,0 +1,18 @@
+module RedactorS3
+  class << self
+
+    def config=(data)
+      @config = data
+    end
+
+    def config
+      @config ||= Config.new
+      @config
+    end
+
+    def configure(&proc)
+      @config ||= Config.new
+      yield @config
+    end
+  end
+end

data/lib/redactor_s3/version.rb

@@ -1,3 +1,3 @@
 module RedactorS3
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redactor_s3
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Aske Hansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-11 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,21 +87,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/assets/javascripts/redactor_s3/application.js
-- app/assets/javascripts/redactor_s3/files.js
-- app/assets/stylesheets/redactor_s3/application.css
-- app/assets/stylesheets/redactor_s3/files.css
 - app/controllers/redactor_s3/application_controller.rb
 - app/controllers/redactor_s3/files_controller.rb
 - app/helpers/redactor_s3/application_helper.rb
 - app/helpers/redactor_s3/files_helper.rb
-- app/models/redactor_s3/settings.rb
-- app/views/layouts/redactor_s3/application.html.erb
-- app/views/redactor_s3/files/_config.html.erb
+- app/views/redactor_s3/_config.html.erb
 - app/views/redactor_s3/files/index.jbuilder
-- config/initializers/redactor_s3.rb
 - config/routes.rb
+- lib/rails/generators/redactor_s3/install/install_generator.rb
+- lib/rails/generators/redactor_s3/install/templates/initializer.rb
+- lib/redactor_s3/config.rb
 - lib/redactor_s3/engine.rb
+- lib/redactor_s3/redactor_s3.rb
 - lib/redactor_s3/version.rb
 - lib/redactor_s3.rb
 - lib/tasks/redactor_s3_tasks.rake

data/app/assets/javascripts/redactor_s3/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
-//
-// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
-// GO AFTER THE REQUIRES BELOW.
-//
-//= require_tree .

data/app/assets/javascripts/redactor_s3/files.js

@@ -1,2 +0,0 @@
-// Place all the behaviors and hooks related to the matching controller here.
-// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/redactor_s3/application.css

@@ -1,13 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the top of the
- * compiled file, but it's generally better to create a new file per style scope.
- *
- *= require_self
- *= require_tree .
- */

data/app/assets/stylesheets/redactor_s3/files.css

@@ -1,4 +0,0 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/

data/app/models/redactor_s3/settings.rb

@@ -1,43 +0,0 @@
-module RedactorS3
-  class Settings
-    attr_accessor :application_host, :bucket, :access_key, :secret_key, :endpoint, :s3_host, :prefix
-
-    def initialize
-      @application_host = RedactorS3.application_host
-      @bucket = RedactorS3.bucket
-      @access_key = RedactorS3.access_key
-      @secret_key = RedactorS3.secret_key
-
-      @endpoint = RedactorS3.endpoint || 's3.amazonaws.com'
-      @s3_host = RedactorS3.s3_host || "#{@bucket}.#{@endpoint}"
-      @prefix = RedactorS3.prefix || 'files/'
-    end
-
-    def bucket_url
-      "http://#{@bucket}.#{@endpoint}"
-    end
-
-    def success_url
-      "http://#{@application_host}/s3/success"
-    end
-
-    def policy
-      policy_json="{'expiration': '2020-01-01T00:00:00Z',
-        'conditions': [ 
-          {'bucket': '#{@bucket}'}, 
-          ['starts-with', '$key', ''],
-          {'acl': 'public-read'},
-          {'success_action_redirect': '#{success_url}'},
-          ['starts-with', '$Content-Type', ''],
-          ['content-length-range', 0, 1048576]
-        ]
-      }"
-
-      Base64.encode64(policy_json).gsub("\n","")
-    end
-
-    def signature
-      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), @secret_key, policy)).gsub("\n","")
-    end
-  end
-end

data/app/views/layouts/redactor_s3/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>RedactorS3</title>
-  <%= stylesheet_link_tag    "redactor_s3/application", media: "all" %>
-  <%= javascript_include_tag "redactor_s3/application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/config/initializers/redactor_s3.rb

@@ -1,11 +0,0 @@
-# # These are required options
-# RedactorS3.application_host = 'www.example.com' # your domain
-# RedactorS3.bucket = 'mybucket' # your s3 bucket name
-# RedactorS3.access_key = 'AWS_ACCESS_KEY_ID' # your aws access key id
-# RedactorS3.secret_key = 'AWS_SECRET_ACCESS_KEY' #your aws secret access key
-
-
-# # These are optinal options
-# RedactorS3.endpoint = 's3-eu-west-1.amazonaws.com' # use this for eu buckets
-# RedactorS3.s3_host = 'mybucket.example.com' # use this if you have a alias for your s3 bucket
-# RedactorS3.prefix = 'files' # all uploads goes the this folder