guard-nginx 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b3a1cb4863c400c165ba7ee33df070a11b533699a4b7776246d11629edb3828
+  data.tar.gz: 66af32f85a6b3c75ddfe317230534798f9879056d77a99e4faf11a017f60937d
+SHA512:
+  metadata.gz: 617d6591cb44014734a76bd16e4205d769792d03c09b85dae6e166a80ea9b490f547edc9813bfd83bcf0c6b9b5ddfb308d8bac9a541c0734bcd7f057709972e3
+  data.tar.gz: c37f39cfb97d6295ec81c1409f484009d535ab0b32d43d3566c8224bea2e0f69918e6f722ae179e8822244a6f6ed39acaae0b0695a3d9969bb7d16287000cb9e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at frederik@progras.dk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in guard-nginx.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Frederik Spang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# guard-nginx - An nginx plugin for *your* Guardfile
+[![Gem Version](https://badge.fury.io/rb/guard-nginx.svg)](https://badge.fury.io/rb/guard-nginx)
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'guard-nginx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install guard-nginx
+
+Then add to Guardfile by
+
+    $ guard init nginx
+
+or manually with
+
+    guard 'nginx' do
+      watch(%r{^config/nginx/.*})
+    end
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/guard-nginx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Guard::Nginx project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/guard-nginx/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "guard/nginx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/guard-nginx.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "guard/nginx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-nginx"
+  spec.version       = Guard::NginxVersion::VERSION
+  spec.authors       = ["Frederik Spang"]
+  spec.email         = ["frederik@progras.dk"]
+
+  spec.summary       = %q{A guard-plugin for running a local installation of nginx.}
+  spec.homepage      = "https://progras.dk"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata["source_code_uri"] = "https://github.com/prograsdk/guard-nginx"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'guard-compat', '~> 1.2'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/guard-nginx.rb

@@ -0,0 +1 @@
+require 'guard/nginx'

data/lib/guard/nginx.rb

@@ -0,0 +1,97 @@
+require 'guard/compat/plugin'
+require 'guard/nginx/version'
+require 'guard/nginx/config_processor'
+
+module ::Guard
+  class Nginx < Plugin
+    def initialize(options)
+      @value = "Test"
+      UI.info "hello path: #{Dir.pwd}"
+      Dir.mkdir("#{tmp_path}/config") unless Dir.exist?("#{tmp_path}/config")
+      super
+    end
+
+    def start
+      # ensure config - create tmp file
+      UI.info "Starting Nginx on port #{port}"
+      generate_config
+
+      IO.popen("#{executable} -c #{tmp_path}/config/nginx.conf", 'w+')
+      UI.info "Nginx started" if $?.success?
+    end
+
+    def stop
+      puts pid
+      if pid
+        UI.info "Sending TERM signal to Nginx (#{pid})"
+        FileUtils.rm "#{tmp_path}/config/nginx.conf"
+        Process.kill("TERM", pid)
+        true
+      end
+    end
+
+    def reload
+      UI.info 'reload'
+      if pid
+        generate_config
+
+        UI.info "Sending HUP signal to Nginx (reloading #{pid})"
+        Process.kill("HUP", pid)
+        true
+      end
+    end
+
+    def run_all
+      reload
+    end
+
+    def run_on_change(paths)
+      true
+    end
+
+    private
+
+    def pidfile_path
+      options.fetch(:pidfile) {
+        File.expand_path('tmp/pids/nginx.pid', Dir.pwd)
+      }
+    end
+
+    def tmp_path
+      File.expand_path('tmp', Dir.pwd)
+    end
+
+    def generate_config
+      UI.info 'Generating Nginx Config'
+      file = ERB.new(
+        File.read(
+          File.expand_path('nginx/templates/nginx_config.erb', File.dirname(__FILE__))
+        ),
+        nil,
+        '-'
+      ).result(
+        ConfigProcessor.new({
+          port: port,
+          use_ssl: true,
+          http_port: 3000,
+          https_port: 3001,
+          server_name: 'localhost'
+        }).get_binding
+      )
+
+      File.open("#{tmp_path}/config/nginx.conf", "w") { |f| f.write(file) }
+    end
+
+    def pid
+      File.exist?(pidfile_path) && File.read(pidfile_path).to_i
+    end
+
+    def executable
+      options.fetch(:executable) { 'nginx' }
+    end
+
+    def port
+      options.fetch(:port){ 3000 }
+    end
+  end
+end

data/lib/guard/nginx/config_processor.rb

@@ -0,0 +1,29 @@
+class ConfigProcessor
+  def initialize(options = {})
+    @config = options
+  end
+
+  def config_fetch(key)
+    @config.fetch(key.to_sym) { false }
+  end
+
+  def root_path
+    Dir.pwd
+  end
+
+  def config_path
+    "#{root_path}/config"
+  end
+
+  def tmp_path
+    "#{root_path}/tmp"
+  end
+
+  def pid_path
+    "#{Dir.pwd}/tmp/pids/nginx.pid"
+  end
+
+  def get_binding
+    binding
+  end
+end

data/lib/guard/nginx/templates/Guardfile

@@ -0,0 +1,3 @@
+guard :nginx do
+  watch(%r{^config/nginx/.*})
+end

data/lib/guard/nginx/templates/nginx_config.erb

@@ -0,0 +1,79 @@
+
+pid <%= pid_path %>;
+worker_rlimit_nofile 8192;
+worker_processes  3;
+events {
+  worker_connections  1042;
+}
+
+http {
+  upstream puma_guard_nginx {
+    <%= "server unix:#{tmp_path}/sockets/puma.sock;" %>
+  }
+
+  <% if config_fetch(:use_ssl) -%>
+  server {
+    listen <%= config_fetch(:http_port) %>;
+    server_name _;
+    rewrite ^(.*) https://$host:3001$1 permanent;
+  }
+  <% else -%>
+  server {
+    listen <%= config_fetch(:http_port) %>;
+    server_name _;
+  }
+  <% end -%>
+
+  server {
+  <% if config_fetch(:use_ssl) -%>
+    listen <%= config_fetch(:https_port) %> ssl;
+    ssl_certificate <%= config_path %>/certificates/server.crt;
+    ssl_certificate_key <%= config_path %>/certificates/server.key;
+
+    ssl_session_timeout 5m;
+    ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
+    ssl_ciphers 'ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA';
+
+    ssl_prefer_server_ciphers on;
+    ssl_session_cache shared:SSL:10m;
+    ssl_dhparam <%= config_path %>/certificates/dhparam.pem;
+  <% else -%>
+    listen <%= config_fetch(:http_port) %>;
+  <% end -%>
+    server_name _;
+    root <%= root_path %>/public;
+    try_files $uri/index.html $uri @puma_guard_nginx;
+
+    client_max_body_size 4G;
+    keepalive_timeout 10;
+
+    error_page 500 502 504 /500.html;
+    error_page 503 @503;
+
+    location @puma_guard_nginx {
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
+      proxy_set_header Host $http_host;
+      proxy_redirect off;
+  <% if config_fetch(:use_ssl) -%>
+      proxy_set_header X-Forwarded-Proto https;
+  <% end -%>
+      proxy_pass http://puma_guard_nginx;
+      # limit_req zone=one;
+      access_log <%= root_path %>/log/nginx.access.log;
+      error_log <%= root_path %>/log/nginx.error.log;
+    }
+
+    location = /50x.html {
+      root html;
+    }
+
+    location = /404.html {
+      root html;
+    }
+
+    if ($request_method !~ ^(GET|HEAD|PUT|PATCH|POST|DELETE|OPTIONS)$ ){
+      return 405;
+    }
+  }
+}

data/lib/guard/nginx/version.rb

@@ -0,0 +1,7 @@
+require 'guard/compat/plugin'
+
+module ::Guard
+  class NginxVersion
+    VERSION = "0.1.1".freeze
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: guard-nginx
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Frederik Spang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- frederik@progras.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- guard-nginx.gemspec
+- lib/guard-nginx.rb
+- lib/guard/nginx.rb
+- lib/guard/nginx/config_processor.rb
+- lib/guard/nginx/templates/Guardfile
+- lib/guard/nginx/templates/nginx_config.erb
+- lib/guard/nginx/version.rb
+homepage: https://progras.dk
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/prograsdk/guard-nginx
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A guard-plugin for running a local installation of nginx.
+test_files: []