imprenta 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 459db6fcf19b139f775326dee32096ee92152515
-  data.tar.gz: 74551ca9d29c416ef35aba742ad45def1410ce3a
+  metadata.gz: 5fa4d44f02caca84304d491edc76e7de0de8929f
+  data.tar.gz: 867f4e5beb6b3e58eb04455efafc9c804d704592
 SHA512:
-  metadata.gz: b92b94803153b7dcd326437b0089d9bdfe63dd6e6c4f32b2cebd5ccfcd17226697413fdb1ca563caeb72aa9effe339072c5c1fd70862043aee460811ea6ee82e
-  data.tar.gz: 7831f36d1b434abeacf5b4268c738882c3cdad4fa3a5a99efb3f67dffb3d2dd2d77db7d56418c42b33b86f1015ca22d24aaad436b8d24214fc72730c7d8e7fb8
+  metadata.gz: d97d77fe122eafce9d6bc5b76c35cd7a4308f8b314e60c8021b7918ffcdb2d795badadec2c7df4a3c7bd89cf8ceb6d284c007e0f928d001bf41e4d2b63409ab9
+  data.tar.gz: 80d2e0f80eaa62ca1c879d85a69a83b208e5184b504760a8c3524c97d8fc923272c6efae536bac62eeeaf018dbc2f951f2692ab6b4e49b0e3c514d62fafae007

data/README.md

@@ -1,6 +1,13 @@
 # Imprenta
 
-TODO: Write a gem description
+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,
+landing page, about.me, etc.
+
+The gem will provide with methods to save generated templates as static html pages.
+It also comes with a Rack server that allows you to serve the generated pages from
+an endpoint within your App.
 
 ## Installation
 
@@ -18,7 +25,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In the action that you want to cache, use something like the following:
+
+``ruby
+
+  def publish
+    imprenta_cache_template(template:  "path/to/template",
+                            layout: 'application',
+                            id: 'mytemplateid')
+
+    redirect_to media_kit_path(@media_kit), notice: 'Media Kit Published'
+  end
+``
+
+Then in your routes add the following:
+
+``ruby
+
+  get 'mystatic-pages/:id', :to => Imprenta.server
+
+``
+
+## Configuration
+
+Imprenta allows you to customize the Rack server with your own middlewares. By defaut, it
+will have loaded a middleware to handle 500,400,401,404, etc.
+
+``ruby
+
+Imprenta.configure do |config|
+  config.middlewares.use Bugsnag::Rack
+end
+
+``
 
 ## Contributing
 

data/imprenta.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["rafaelchacon@gmail.com"]
   spec.description   = %q{Publish and serve static html pages with Rails}
   spec.summary       = %q{This gem helps the process of publishing and serving static pages within rails}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/skyscrpr/imprenta"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/imprenta/configuration.rb

@@ -12,8 +12,8 @@ module Imprenta
       setup_default_middlewares
     end
 
-    def configure(&block)
-      block.call
+    def configure
+      yield self
     end
 
     def reset

data/lib/imprenta/static_server.rb

@@ -2,7 +2,6 @@ module Imprenta
   class StaticServer
     def initialize(args = {})
       @middleware_stack = args.fetch(:middlewares)
-      # @middleware_stack.use Bugsnag::Rack
     end
 
     def call(env)

data/lib/imprenta/version.rb

@@ -1,3 +1,3 @@
 module Imprenta
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/imprenta.rb

@@ -18,7 +18,7 @@ module Imprenta
     end
 
     def configure(&block)
-      configuration.configure(block)
+      configuration.configure(&block)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imprenta
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rafael Chacon
@@ -72,7 +72,7 @@ files:
 - lib/imprenta/rails.rb
 - lib/imprenta/static_server.rb
 - lib/imprenta/version.rb
-homepage: ''
+homepage: https://github.com/skyscrpr/imprenta
 licenses:
 - MIT
 metadata: {}