imprenta 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: addc2eedab80a43efb3d54cd43969312be95631e
-  data.tar.gz: 6e50491dc5a26982441fd9cd7aad02809b65cb83
+  metadata.gz: a41c878c7744c585924be4102d5f1bd9a8139dfc
+  data.tar.gz: 1be6f4b0bbba656894081372eae2cd0b3e134806
 SHA512:
-  metadata.gz: 9d1f1d4b162d4c010c46d98d3686a4eb7dc43775c2afff88b9ee2f4aace1e4af12178a637560de7ee7132c39969eca159ce1da33bb00465d9f182d293f19c769
-  data.tar.gz: 40b4b6e2f02600ac8844ea01c1302bbb511f1d10e8bd6e4914f5cc3401613157bac2b4866d586fa9938b5a7f03deb549d563a4c515a921587fa5eab3af5140d6
+  metadata.gz: 27c87f0c08066a52c5367fe2d37d8f37bfc255d3d1cb006136d1a79677af5499a483263a1e0b67cd03acd591d78be702982c262d4b9d116621e5d5b0db2cd2bf
+  data.tar.gz: bbf9c4a5bfe0863f80b19905585900d4ccbe49694dce25ce288e35518f84b3e244e162860d4d81e4f592b28ae62675adb8b9977a48d486bb616681fc73b3d7b3

data/.gitignore

@@ -12,6 +12,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/dummy/log
 test/tmp
 test/version_tmp
 tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: "bundle exec rake"
+rvm:
+  - 2.0.0
+gemfile:
+  - Gemfile

data/README.md

@@ -1,8 +1,11 @@
-# Imprenta
+[![Build Status](https://api.travis-ci.org/skyscrpr/imprenta.png?branch=master)](http://travis-ci.org/skyscrpr/imprenta)
+[![Code Climate](https://codeclimate.com/repos/5272d3faf3ea004b9c013f64/badges/53c51fa28cabe58bf214/gpa.png)](https://codeclimate.com/repos/5272d3faf3ea004b9c013f64/feed)
+
+# Imprenta - Publish and Serve Static Pages within Rails.
 
 The goal of this gem is to provide an easy and efficient way to generate and serve
 static pages within Rails. The perfect use case for this gem is when your users
-generate some content that gets published and then it barely changes. e.g: a blog post,
+generate some content that gets published and after this it almost never change. e.g: a blog post,
 landing page, about.me, etc.
 
 The gem will provide with methods to save generated templates as static html pages.
@@ -36,8 +39,6 @@ def publish
   redirect_to root_path, success: 'Yei page published!'
 end
 ```
-  
-
 
 Then in your routes add the following:
 
@@ -45,8 +46,16 @@ Then in your routes add the following:
 get 'mystatic-pages/:id', :to => Imprenta.server
 ```
 
+Now if you go to your server to following url:
+```code
+http://localhost:3000/mystatic-pages/mytemplateid
+```
+
+You should be able to see the page you cached in the publish action. 
 ## Configuration
 
+### Middlewares
+
 Imprenta allows you to customize the Rack Server (Imprenta.server) with your own middlewares. By defaut, it
 will have loaded a middleware to handle 500,400,401,404, etc.
 
@@ -56,6 +65,48 @@ Imprenta.configure do |config|
 end
 ```
 
+### Storage
+
+Imprenta provides two kinds of storage to save the static pages: File and S3. The default one is file.
+If you want to use s3. You can configure the gem the following way:
+
+
+```ruby
+Imprenta.configure do |config|
+  config.storage :s3
+  config.aws_bucket = "bucket"
+  config.aws_access_key_id = "xxxxid"
+  config.aws_secret_access_key = "xxxkey"
+end
+```
+
+When using s3, it is strongly advisable to use it in conjunction with a reverse proxy (Varnish, Squid). 
+Otherwise, it will be hitting s3 for every request. In rails you could use rack-cache and memcached with
+a configuration like this: 
+
+In your Gemfile:
+
+```ruby
+gem 'rack-cache'
+gem 'dalli'
+```
+
+Then, in your initializer: 
+
+```ruby
+Imprenta.configure do |config|
+
+  client = Dalli::Client.new('localhost:11211',
+                             :value_max_bytes => 10485760)
+
+  config.middlewares.use Rack::Cache,
+                         verbose: true,
+                         metastore: client, 
+                         entitystore: client,
+end
+```
+
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,12 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/imprenta.gemspec

@@ -18,7 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rails", "~> 4.0.0"
+  spec.add_dependency "fog"
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rails", "~> 4.0.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "capybara"
   spec.add_development_dependency "rake"
 end

data/lib/imprenta/cache_page.rb

@@ -1,32 +1,23 @@
 module Imprenta
   module CachePage
-    # This methods come from action_pack/cache_page'
-    # https://github.com/rails/actionpack-page_caching
-    # We didn't need the whole gem. So I decided to get
-    # just what we need :)
+
     def imprenta_cache_template(args = {})
       template = args.fetch(:template)
       layout = args.fetch(:layout) { 'application'}
       id = args.fetch(:id)
 
       content = render_to_string(template: template, layout: layout)
-      imprenta_cache_page(content, id)
-    end
-
-    def imprenta_cache_page(content, id, extension = '.html', gzip = Zlib::BEST_COMPRESSION)
-      path = path_for_id(id, extension)
-      FileUtils.makedirs(File.dirname(path))
-      File.open(path, 'wb+') { |f| f.write(content) }
-      if gzip
-        Zlib::GzipWriter.open(path + '.gz', gzip) { |f| f.write(content) }
-      end
+      storage.persist(content, id)
     end
 
     private
 
-    def path_for_id(id, extension = nil)
-      page_cache_directory = Rails.public_path
-      page_cache_directory.to_s + '/imprenta/' + id + extension
+    def storage
+      @storage ||= case Imprenta.configuration.storage
+                     when :file then Imprenta::Storage::File.new
+                     when :s3 then Imprenta::Storage::S3.new
+                     else raise StandardError.exception("Invalid storage provider")
+                   end
     end
   end
 end

data/lib/imprenta/configuration.rb

@@ -3,7 +3,11 @@ module Imprenta
     # Same configuration pattern that sferik uses in:
     # https://github.com/sferik/mtgox/blob/master/lib/mtgox/configuration.rb
     VALID_OPTIONS_KEYS = [:middlewares,
+                          :storage,
                           :custom_domain,
+                          :aws_access_key_id,
+                          :aws_secret_access_key,
+                          :aws_bucket,
                           :development]
 
     attr_accessor *VALID_OPTIONS_KEYS
@@ -20,6 +24,7 @@ module Imprenta
     def reset
       self.middlewares = ActionDispatch::MiddlewareStack.new
       self.development = false
+      self.storage = :file
       self.custom_domain = false
     end
 

data/lib/imprenta/content_rack.rb

@@ -0,0 +1,27 @@
+module Imprenta
+  class ContentRack
+    attr_accessor :custom_domain, :content_server
+
+    def initialize
+      @custom_domain = Imprenta.configuration.custom_domain
+      @content_server = case Imprenta.configuration.storage
+                          when :file then Imprenta::ContentServer::File.new
+                          when :s3 then Imprenta::ContentServer::S3.new
+                          else raise StandardError.exception("Invalid storage provider")
+                        end
+    end
+
+    def call(env)
+      path = custom_domain ? env["SERVER_NAME"] : id_from_env(env)
+      raise ::ActionController::RoutingError.exception("Page Not Found") unless path
+
+      content_server.generate_response(path, env)
+    end
+
+    private
+
+    def id_from_env(env)
+      env["action_dispatch.request.path_parameters"][:id]
+    end
+  end
+end

data/lib/imprenta/content_server/file.rb

@@ -0,0 +1,36 @@
+module Imprenta
+  module ContentServer
+    class File
+      def generate_response(path, env)
+        request = ::Rack::Request.new(env)
+        file, headers = pick_file_and_headers_for_path(path, request)
+        env.merge!("PATH_INFO" => "/")
+        ::Rack::File.new(file, headers).call(env)
+      end
+
+      private
+
+      def headers
+        @headers ||= {'Content-Type' => 'text/html' }
+      end
+
+      def pick_file_and_headers_for_path(path, request)
+        encoding = get_best_encoding(request)
+        file = "#{Rails.public_path}/imprenta/" + path + '.html'
+        if ::File.exist?(file)
+          if encoding == 'gzip'
+            file = file + '.gz'
+            headers['Content-Encoding'] = 'gzip'
+          end
+        else
+          raise ::ActionController::RoutingError.exception("Page Not Found")
+        end
+        [file, headers]
+      end
+
+      def get_best_encoding(request)
+        ::Rack::Utils.select_best_encoding(%w(gzip identity), request.accept_encoding)
+      end
+    end
+  end
+end

data/lib/imprenta/content_server/s3.rb

@@ -0,0 +1,32 @@
+require 'open-uri'
+module Imprenta
+  module ContentServer
+    class S3
+
+      attr_accessor :bucket
+
+      def initialize
+        @bucket = Imprenta.configuration.aws_bucket
+      end
+
+      def generate_response(path, env)
+        content = open("https://s3.amazonaws.com/#{bucket}/#{path}.html.gz")
+        if success?(content)
+          body = content.read
+          content.close
+          headers = content.meta.slice("etag", "last-modified", "content-type")
+          headers['Cache-Control'] = 'max-age=3600'
+          [200, headers, [body]]
+        else
+          raise ::ActionController::RoutingError.exception("Page Not Found")
+        end
+      end
+
+      private
+
+      def success?(content)
+        content.status[0] == "200"
+      end
+    end
+  end
+end

data/lib/imprenta/rails.rb

@@ -1 +1,5 @@
-ActionController::Base.send :include, Imprenta::CachePage
+class Engine < Rails::Engine
+  initializer 'imprenta.controller_methods' do |app|
+    ActionController::Base.send :include, Imprenta::CachePage
+  end
+end

data/lib/imprenta/static_server.rb

@@ -1,11 +1,8 @@
 module Imprenta
   class StaticServer
 
-    attr_accessor :custom_domain
-
-    def initialize(args = {})
-      @middleware_stack = args.fetch(:middlewares)
-      @custom_domain = args[:custom_domain]
+    def initialize
+      @middleware_stack = Imprenta.configuration.middlewares
     end
 
     def call(env)
@@ -16,8 +13,7 @@ module Imprenta
     private
 
     def build_app
-      @app ||= @middleware_stack.build(Imprenta::FileRack.new(custom_domain: custom_domain))
+      @app ||= @middleware_stack.build(Imprenta::ContentRack.new)
     end
-
   end
 end

data/lib/imprenta/storage/S3.rb

@@ -0,0 +1,39 @@
+module Imprenta
+  module Storage
+    class S3
+
+      attr_accessor :connection, :bucket
+
+      def initialize
+        @bucket = Imprenta.configuration.aws_bucket
+        @connection = Fog::Storage.new(provider: 'AWS',
+                                       aws_access_key_id: Imprenta.configuration.aws_access_key_id,
+                                       aws_secret_access_key: Imprenta.configuration.aws_secret_access_key)
+      end
+
+      def persist(content, id, extension = '.html', gzip = Zlib::BEST_COMPRESSION)
+        file_name = id + extension
+        write_body_to_s3(file_name, content)
+        if gzip
+          str = StringIO.new()
+          gz = Zlib::GzipWriter.new(str, gzip)
+          gz.write(content)
+          gz.close
+          write_body_to_s3(file_name + ".gz", str.string, 'gzip')
+        end
+      end
+
+      def write_body_to_s3(key, body, encoding = nil)
+        directory.files.create(key: key,
+                               body: body,
+                               content_type: 'text/html',
+                               content_encoding: encoding,
+                               public: true)
+      end
+
+      def directory
+        @directory ||= connection.directories.create(key: bucket, public: true)
+      end
+    end
+  end
+end

data/lib/imprenta/storage/file.rb

@@ -0,0 +1,25 @@
+module Imprenta
+  module Storage
+    class File
+      # This methods come from action_pack/cache_page'
+      # https://github.com/rails/actionpack-page_caching
+      # We didn't need the whole gem. So I decided to get
+      # just what we need :)
+      def persist(content, id, extension = '.html', gzip = Zlib::BEST_COMPRESSION)
+        path = path_for_id(id, extension)
+        FileUtils.makedirs(::File.dirname(path))
+        ::File.open(path, 'wb+') { |f| f.write(content) }
+        if gzip
+          Zlib::GzipWriter.open(path + '.gz', gzip) { |f| f.write(content) }
+        end
+      end
+
+      private
+
+      def path_for_id(id, extension = nil)
+        page_cache_directory = Rails.public_path
+        page_cache_directory.to_s + '/imprenta/' + id + extension
+      end
+    end
+  end
+end

data/lib/imprenta/version.rb

@@ -1,3 +1,3 @@
 module Imprenta
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/imprenta.rb

@@ -1,8 +1,13 @@
 require "imprenta/version"
 require "rails"
+require "fog"
 require "imprenta/configuration"
-require "imprenta/file_rack"
+require "imprenta/storage/file"
+require "imprenta/storage/S3"
 require "imprenta/cache_page"
+require "imprenta/content_server/file"
+require "imprenta/content_server/s3"
+require "imprenta/content_rack"
 require "imprenta/static_server"
 require "imprenta/rails"
 
@@ -10,8 +15,7 @@ module Imprenta
   class << self
 
     def server
-      Imprenta::StaticServer.new(middlewares: configuration.middlewares,
-                                 custom_domain: configuration.custom_domain)
+      Imprenta::StaticServer.new
     end
 
     def configuration

data/spec/configuration_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe "Imprenta configuraion" do
+  before do
+    Imprenta.configuration.reset
+  end
+
+  context "defaults"  do
+    it "custom_domain is set to false" do
+      expect(Imprenta.configuration.custom_domain).to be_false
+    end
+
+    it "storage is set to false" do
+      expect(Imprenta.configuration.storage).to eq(:file)
+    end
+
+    it "development is set to false" do
+      expect(Imprenta.configuration.development).to be_false
+    end
+
+    it "middlewares is initialized to a middleware stack" do
+      expect(Imprenta.configuration.middlewares).to be_kind_of(ActionDispatch::MiddlewareStack)
+    end
+  end
+
+  context "when configuring" do
+    context "fog" do
+      it "sets aws_secret_access_key  " do
+        Imprenta.configure do |config|
+          config.aws_secret_access_key = "xxxsecret"
+        end
+        expect(Imprenta.configuration.aws_secret_access_key).to eq("xxxsecret")
+      end
+
+      it "aws_access_key_id" do
+        Imprenta.configure do |config|
+          config.aws_access_key_id = "xxxkeyid"
+        end
+        expect(Imprenta.configuration.aws_access_key_id).to eq("xxxkeyid")
+      end
+    end
+
+    it "allows to set custom_domain to true" do
+      Imprenta.configure do |config|
+        config.custom_domain = true
+      end
+      expect(Imprenta.configuration.custom_domain).to be_true
+    end
+
+    it "allows to add custom racks to the config" do
+      Imprenta.configure do |config|
+        config.middlewares.use DummyRack
+      end
+      expect(Imprenta.configuration.middlewares.last).to eq(DummyRack)
+    end
+  end
+end