mina-nginx 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fc9f55e13f8c93e65915450dba5af5b713a835f
-  data.tar.gz: 3ceb413fd582ed68e31e3d50854f2a14f3ae6f5b
+  metadata.gz: ea131bbcb4d8565d2bfee03d1bab5b2b17a5c4c8
+  data.tar.gz: 5be0493451234e99ddee778988a994bbb4e27681
 SHA512:
-  metadata.gz: 925707213e89e846e632c363ec2572cf53e25f2604019324a7de1a83499275fb1e5a5428edf7d8767bcd8d92c5094b91f2516b05ef87f210b906eb428f76f889
-  data.tar.gz: 0405cf368b7f6ade3a12667a6d0655b6d408585c7594dedc1814d93ac6fa9868dd51249a122fb5d6758fae864ecfb944b68672ee7791c301a49c3c5bb60025ba
+  metadata.gz: d971e6222af56fd0e74f3af63e737b7280fde61e968c8d9f16670d5780d991a36c0905e453fd243707819a488293a9a654833add9e0d186abdc17ec406fb9b69
+  data.tar.gz: f778b49a2f19603cf6d73f8b7aca9fd625a480f8e85f5ffba885e2c57d860443005dcaa814ed513020fbc4e8ab1f3d2f998e562e0ef8756f155203f6024c7631

data/README.md

@@ -5,55 +5,49 @@
 
 This gem provides several mina tasks:
 
-    mina nginx:link     # Symlinking nginx config file
-    mina nginx:parse    # Parse nginx configuration file and upload it to the server
+    mina nginx:install  # Install template config to host repo for easy overrides
+    mina nginx:setup    # Install config file to the server's shared dir + symlink
+    mina nginx:print    # Parse & print the nginx config
+
     mina nginx:reload   # Reload Nginx
     mina nginx:restart  # Restart Nginx
-    mina nginx:setup    # Setup Nginx
     mina nginx:start    # Start Nginx
     mina nginx:status   # Status Nginx
     mina nginx:stop     # Stop Nginx
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile, then `bundle install`:
 
     gem 'mina-nginx', :require => false
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install mina-nginx
-
-## Usage
-
-Add this to your `config/deploy.rb` file:
+Once installed, add this to your `config/deploy.rb` file:
 
     require 'mina/nginx'
 
-Make sure the following settings are set in your `config/deploy.rb`:
+Install the base template to your repo's `lib/mina/templates` directory:
+
+    $ bundle exec mina nginx:install
 
-* `application` - application name
-* `server_name` - your application's server_name in nginx (e.g. example.com)(optional)
-* `deploy_to`   - deployment path
+Consider variables used by the nginx config, particularly:
 
-Launch new tasks:
+* `application`       - application name; defaults to 'application'
+* `nginx_socket_path` - path to socket file used in nginx upstream directive
+* `server_name`       - application's nginx server_name (e.g. example.com); defaults to value for `domain`
+* `domain`            - fqdn you are deploying to
+* `deploy_to`         - deployment path
+* `current_path`      - current revision path
 
-```
-$ mina nginx:setup
-$ mina nginx:link
-```
+Edit installed template as required.
 
-You can parse an sample configuration file by `mina nginx:parse` on your server.
+## Recommended Usage
 
-Be sure to edit `shared/config/nginx.conf`, and then:
+1. Follow install steps above; and
+2. Invoke `nginx:setup` in your main `setup` task
+3. Run `nginx:setup` (or base `setup`) to install config changes
 
-```
-$ mina nginx:reload
-```
+n.b. if the config template has not been installed locally, `mina-nginx` will
+fall back to the default template gracefully.
 
 ## Contributing
 

data/lib/mina/nginx.rb

@@ -1,31 +1,48 @@
 require 'mina/nginx/version'
 
 namespace :nginx do
-  set :nginx_user,     'www-data'
-  set :nginx_group,    'www-data'
-  set :nginx_path,     '/etc/nginx'
-  set :nginx_config,   -> { "#{fetch(:shared_path)}/config/nginx.conf" }
-  set :nginx_config_e, -> { "#{fetch(:nginx_path)}/sites-enabled/#{application}.conf" }
+  application = fetch :application, 'application'
 
-  desc 'Setup Nginx'
-  task :setup => :environment do
-    command %(Setup the nginx)
-    command %(touch #{fetch(:nginx_config)})
-    comment %(Be sure to edit 'shared/config/nginx.conf'.)
+  set :nginx_user,        'www-data'
+  set :nginx_group,       'www-data'
+  set :nginx_path,        '/etc/nginx'
+  set :nginx_config,      -> { "#{fetch(:shared_path)}/config/nginx.conf" }
+  set :nginx_config_e,    -> { "#{fetch(:nginx_path)}/sites-enabled/#{application}.conf" }
+  set :nginx_socket_path, -> { "#{fetch(:shared_path)}/tmp/puma.sock" }
+
+  desc 'Install Nginx config to repo'
+  task :install => :environment do
+    run :local do
+      installed_path = path_for_template
+
+      if File.exist? installed_path
+        error! %(file exists; please rm to continue: #{installed_path})
+      else
+        command %(mkdir -p config/deploy/templates)
+        command %(cp #{nginx_template} #{installed_path})
+      end
+    end
   end
 
-  desc 'Symlinking nginx config file'
-  task :link => :environment do
-    comment %(Symlinking nginx config file)
-    command %(sudo ln -nfs "#{fetch(:nginx_config)}" "#{fetch(:nginx_config_e)}")
+  desc 'Print nginx config in local terminal'
+  task :print => :environment do
+    run :local do
+      command %(echo '#{erb nginx_template}')
+    end
   end
 
-  desc 'Parse nginx configuration file and upload it to the server.'
-  task :parse => :environment do
-    content = erb(nginx_template)
-    command %(echo '#{content}' > #{fetch(:nginx_config)})
-    command %(cat #{fetch(:nginx_config)})
-    comment %(Be sure to edit 'shared/config/nginx.conf'.)
+  desc 'Setup Nginx on server'
+  task :setup => :environment do
+    nginx_config = fetch :nginx_config
+    nginx_enabled_config = fetch :nginx_config_e
+
+    comment %(Installing nginx config file to #{nginx_config})
+    command %(echo '#{erb nginx_template}' > #{nginx_config})
+
+    comment %(Symlinking nginx config file to #{nginx_enabled_config})
+    command %(sudo ln -nfs #{nginx_config} #{nginx_enabled_config})
+
+    invoke :'nginx:restart'
   end
 
   %w(stop start restart reload status).each do |action|
@@ -39,6 +56,15 @@ namespace :nginx do
   private
 
   def nginx_template
-    File.expand_path('../templates/nginx.conf.erb', __FILE__)
+    installed_path = path_for_template
+    template_path = path_for_template installed: false
+
+    File.exist?(installed_path) ? installed_path : template_path
+  end
+
+  def path_for_template installed: true
+    installed ?
+      File.expand_path('./config/deploy/templates/nginx.conf.erb') :
+      File.expand_path('../templates/nginx.conf.erb', __FILE__)
   end
 end

data/lib/mina/nginx/version.rb

@@ -1,5 +1,5 @@
 module Mina
   module Nginx
-    VERSION = '0.0.2'.freeze
+    VERSION = '0.0.3'.freeze
   end
 end

data/lib/mina/templates/nginx.conf.erb

@@ -1,15 +1,14 @@
+<% application = fetch :application, 'application' %>
+<% socket_path = fetch :nginx_socket_path, '/path/to/web/socket' %>
+
 upstream <%= application %> {
-  # server www.example.com     weight=5;
-  # server 127.0.0.1:8080      max_fails=3 fail_timeout=30s;
-  # server unix:///path/to/web_socket.sock;
-  #
-  server unix:///PATH/TO/WEB_SOCKET fail_timeout=0;
+  server unix://<%= socket_path %> fail_timeout=0;
 }
 
 server {
   listen 80 default deferred;
-  <%= server_name.to_s.empty? ? "# server_name example.com" : "server_name #{server_name}" %>;
-  root <%= deploy_to %>/<%= current_path %>/public;
+  server_name <%= fetch :server_name, fetch(:domain) %>
+  root <%= "#{fetch :deploy_to}/#{fetch :current_path}/public" %>;
 
   location ^~ /assets/ {
     gzip_static on;

data/mina-nginx.gemspec

@@ -6,7 +6,7 @@ require 'mina/nginx/version'
 Gem::Specification.new do |spec|
   spec.name          = 'mina-nginx'
   spec.version       = Mina::Nginx::VERSION
-  spec.authors       = ['hbin']
+  spec.authors       = ['hbin', 'anulman']
   spec.email         = ['huangbin88@foxmail.com']
   spec.summary       = %(Mina tasks for handle with Nginx.)
   spec.description   = %(Configuration and managements Mina tasks for Nginx.)

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mina-nginx
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - hbin
+- anulman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mina
@@ -88,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Mina tasks for handle with Nginx.