satorix-rails 0.0.1 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 139448f84d0176cd1cbce7bcc9dfcb3c85efb389
-  data.tar.gz: 549e6d642dfaea6da7ef3923ee4d22e3dd233629
+  metadata.gz: a5dbf0b5018c9ce918066276a1dba71c041a7a2f
+  data.tar.gz: 3d9c9065c8f8d85945f8f5a81be09c295f25d9fc
 SHA512:
-  metadata.gz: 5f43071c9c21906cf5c844b6a816a032ac01a3b1dd15912faac3d4ec81d5d046ee55ccb1f32b1b8ce290c7e09e0232f238cb17c175f643d7d324a9e472e5074c
-  data.tar.gz: 337c9161d533f8a6a83f5be26d169d0d9766f77677a52bb6635d4ead786a669927c1be5fcb7135bb3a4d3643049e20522b0bb2763f852c74e01325ed96a93127
+  metadata.gz: 2b8e13947ba20ba173d173af8097bfcd602edce3f5ceac950627baf9489b5fabff1376f3da52811a8787438fad2b997177661427486b31dbb6e96a85ca3b4dd3
+  data.tar.gz: 50872269ddd8cc9f68f35ac4458da9c87643270d21abc68a7f466faebcaa2385495a3ffa377d480d99deaf62169dfefa9462e275df66e8a6c5fbe54f0feb6d8e

data/.gitlab-ci.yml

@@ -0,0 +1,31 @@
+image: 'satorix/rails'
+
+
+.satorix: &satorix
+  script:
+    - bundle # This generates a Gemfile.lock, to make the buildpacks happy
+    - gem install satorix --source https://gems.iexposure.com --no-document
+    - satorix
+
+
+cache:
+  key: "$CI_PROJECT_ID"
+  paths:
+    - 'tmp/satorix/cache' # To cache buildpack gems between runs.
+
+
+rspec:
+  before_script:
+    - sed -i -e 's/add_development_dependency/add_dependency/g' satorix-rails.gemspec # To avoid an application dependency, but still be available for CI
+  <<: *satorix
+
+
+# This is a custom job, defined at satorix/CI/deploy/ie_gem_server.rb
+deploy_to_ie_gem_server:
+  environment:
+    name: $CI_COMMIT_REF_NAME
+    url: 'http://gems.iexposure.com/gems/satorix-rails'
+  stage: deploy
+  only:
+    - master
+  <<: *satorix

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.1

data/Gemfile

@@ -1,3 +1,5 @@
+ruby File.open("#{ File.dirname(__FILE__) }/.ruby-version", &:gets).strip[/ruby-(.+)/i, 1]
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in satorix-rails.gemspec

data/Procfile

@@ -0,0 +1,4 @@
+# This Procfile defines the types of process that Flynn will run.
+# For more information, please see the documentation at http://gitlab.iexposure.com/satorix/satorix
+
+# We don't need to run anything, so there are no jobs here.

data/README.md

@@ -1,3 +1,118 @@
-# Satorix::Rails
+# satorix-rails
 
 By [Internet Exposure](https://www.iexposure.com/)
+
+[![build](http://gitlab.iexposure.com/satorix/satorix-rails/badges/master/build.svg)](http://gitlab.iexposure.com/satorix/satorix-rails/pipelines)
+[![coverage](http://gitlab.iexposure.com/satorix/satorix-rails/badges/master/coverage.svg)](http://gitlab.iexposure.com/satorix/satorix-rails/pipelines)
+
+
+[Satorix](http://gitlab.iexposure.com/satorix/satorix) is a full-featured CI/CD pipeline developed by Internet Exposure.
+
+The satorix-rails gem provides a streamlined mechanism for a 12-factor capable Rails application to interact with the Satorix ecosystem.
+
+
+## Getting Started
+
+Add Satorix to your Rails application by including it in your Gemfile with:
+
+```ruby
+source 'https://gems.iexposure.com' do
+  gem 'satorix-rails'
+end
+```
+
+Run the bundle command to install it.
+
+Next, run the generator from a terminal at the root of your application:
+
+```console
+$ rails g satorix:install
+```
+
+Congratulations, your application is now suitable for deployment into Satorix.
+
+# Logging in Rails 4 and below
+
+If you are using Rails version 4 or below, you will need to take an additional step so that your application logs correctly.
+
+You will need to either:
+
+* add `gem 'rails_12factor', group: :production` to your Gemfile
+* Set `config.logger = Logger.new(STDOUT)` in `config/environments/production.rb`
+
+
+## What's Included
+
+
+## Environment Variables
+
+You can configure your application on a per-environment basis using environment variables.
+
+The following environment variables are used by the generated files:
+
+Using the Satorix Dashboard? You can relax, all of these variables are automatically configured for you.
+
+##### SATORIX_AUTHENTICATION_USER_NAMES_AND_PASSWORDS
+
+Optional
+
+Hashed usernames:passwords, newline separated
+
+##### SATORIX_AUTHENTICATION_ALLOWED_IPS
+
+Optional
+
+Valid settings:
+
+* all (`all`)
+* single IP (`192.168.101.2`)
+* single IP range (`192.168.101.0/24`)
+* multiple IPs/ranges (`192.168.101.3 192.168.1.4`)
+
+##### SATORIX_CANONICAL_URI_HOST
+
+Optional
+
+If specified, t
+
+##### SATORIX_CANONICAL_URI_PROTOCOL
+
+Optional
+
+##### SATORIX_PROXY_IPS
+
+was NGINX_ADDITIONAL_REAL_IPS
+
+Used to define proxy IP addresses, for services like CloudFlare.
+
+
+## Contributing
+
+Please coordinate contributions using the [official issue tracker](http://gitlab.iexposure.com/satorix/satorix-rails/issues).
+
+
+## Testing
+
+This application is tested using [rspec](http://rspec.info/).
+
+You can run the same tests that run during CI with:
+
+ ```
+bundle exec rspec spec
+ ```
+
+
+## CI/CD
+
+Satorix is used to provide continuous integration and continuous deployment for this application.
+
+CI is run against every push.
+
+CD is used to build and publish the gem for the master branch.
+
+
+
+## License
+
+
+The Satorix gem is released under the terms described in the [LICENSE file](LICENSE).

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/rails/generators/satorix/custom_ci_job_generator.rb

@@ -0,0 +1,27 @@
+module Satorix
+  module Generators
+    class CustomCiJobGenerator < ::Rails::Generators::Base
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Adds Satorix custom CI job functionality and examples to your application.'
+
+
+      def install_satorix
+        template 'custom_ci_job/satorix/custom.rb', 'satorix/custom.rb'
+        template 'custom_ci_job/satorix/CI/deploy/mock_deploy.rb', 'satorix/CI/deploy/mock_deploy.rb'
+        template 'custom_ci_job/satorix/CI/test/bare_bones.rb', 'satorix/CI/test/bare_bones.rb'
+        template 'custom_ci_job/satorix/CI/test/info.rb', 'satorix/CI/test/info.rb'
+
+        say ''
+        say 'Satorix custom CI job examples have been added to your project.'
+        say "Don't forget to add your new jobs to the gitlab-ci.yml file."
+        say ''
+      end
+
+
+    end
+  end
+end
+
+

data/lib/rails/generators/satorix/install_generator.rb

@@ -0,0 +1,32 @@
+module Satorix
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Generators to prepare a Rails application for the Satorix ecosystem.'
+
+
+      def install_satorix
+        template 'install/Procfile', 'Procfile'
+        template 'install/.gitlab-ci.yml', '.gitlab-ci.yml'
+
+        template 'install/config/passenger_standalone/nginx.conf.erb', 'config/passenger_standalone/nginx.conf.erb'
+
+        template 'install/config/passenger_standalone/includes/htpasswd', 'config/passenger_standalone/includes/htpasswd'
+        template 'install/config/passenger_standalone/includes/authentication.erb', 'config/passenger_standalone/includes/authentication.erb'
+        template 'install/config/passenger_standalone/includes/page_level_redirects.erb', 'config/passenger_standalone/includes/page_level_redirects.erb'
+        template 'install/config/passenger_standalone/includes/proxy_configuration.erb', 'config/passenger_standalone/includes/proxy_configuration.erb'
+
+        say ''
+        say 'Satorix installation complete!', "\e[32m"
+        say 'For additional configuration information, please see http://gitlab.iexposure.com/satorix/satorix'
+        say ''
+      end
+
+
+    end
+  end
+end
+
+

data/lib/rails/generators/templates/custom_ci_job/satorix/CI/deploy/mock_deploy.rb

@@ -0,0 +1,37 @@
+module Satorix
+  module CI
+    module Deploy
+      module MockDeploy
+
+
+        include Satorix::Shared::Console
+
+
+        extend self
+
+
+        def go
+          log_bench('Atomic batteries to power...') { batnap }
+          log_bench('Turbines to speed...') { turbines_to_speed }
+          log_bench('Moving out...') { batnap }
+        end
+
+
+        private ########################################################################################################
+
+
+        def turbines_to_speed
+          batnap
+          puts 'Roger. Ready to move out.'
+        end
+
+
+        def batnap
+          sleep(rand(6))
+        end
+
+
+      end
+    end
+  end
+end

data/lib/rails/generators/templates/custom_ci_job/satorix/CI/test/bare_bones.rb

@@ -0,0 +1,25 @@
+module Satorix
+  module CI
+    module Test
+
+      # This is the simplest possible implementation of a custom job.
+      module BareBones
+
+
+        extend self
+
+        # go() is the method that will be called during the CI run.
+        # You can add your own logic to do whatever you want.
+        def go
+          # Uncomment the line below if you want to execute in the context of the app's buildpack.
+          # Satorix::CI::Test::Shared::Buildpack.go
+          puts "\n\nRunning BareBones#go..."
+        end
+
+
+      end
+
+
+    end
+  end
+end

data/lib/rails/generators/templates/custom_ci_job/satorix/CI/test/info.rb

@@ -0,0 +1,96 @@
+module Satorix
+  module CI
+    module Test
+      module Info
+
+
+        include Satorix::Shared::Console
+
+
+        extend self
+
+        # go() is the method that will be called during the CI run.
+        # You can add your own logic to do whatever you want.
+        def go
+          # Uncomment the line below if you want to execute in the context of the app's buildpack.
+          # Satorix::CI::Test::Shared::Buildpack.go
+
+          log_bench('Describing logging...') do
+            describe_log
+            describe_log_error
+            describe_log_error_and_abort
+          end
+
+          log_bench('Describing console commands...') do
+            describe_run_command_string
+            describe_run_command_array
+            describe_run_command_filtered
+            describe_run_command_quiet
+            describe_run_command_with_error
+          end
+
+          log_bench('Describing environment variables...') { describe_environment_variables }
+        end
+
+
+        private ########################################################################################################
+
+
+        def describe_environment_variables
+          puts "Remember, #{ ENV['GITLAB_USER_EMAIL'] }, that you have access to all of the environment variables ",
+               ' described at https://docs.gitlab.com/ce/ci/variables/#predefined-variables-environment-variables'
+        end
+
+
+        def describe_log
+          log 'The log() method writes a message to the log'
+          colors.keys.each { |color| log "You can provide an optional color, like :#{ color }", color }
+        end
+
+
+        def describe_log_error
+          log_error 'The log_error() method writes an error to the log'
+        end
+
+
+        def describe_log_error_and_abort
+          log_error 'The log_error_and_abort() method writes an error to the log and aborts the job'
+        rescue SystemExit => e
+          puts 'Rescuing from the error, to continue the tutorial.',
+               e.inspect
+        end
+
+
+        def describe_run_command_string
+          run_command "echo 'We can safely run string console commands with the run_command() method'"
+        end
+
+
+        def describe_run_command_array
+          run_command ['echo', "'We can safely run array console commands with the run_command() method'"]
+        end
+
+
+        def describe_run_command_quiet
+          run_command "echo 'This will not be displayed'", quiet: true
+        end
+
+
+        def describe_run_command_filtered
+          run_command "echo 'You can filter secrets, like 1234 and 5678 (unless you explicitly display them)'", filtered_text: %w(1234 5678)
+        end
+
+
+        def describe_run_command_with_error
+          run_command 'false'
+        rescue SystemExit
+          puts 'Commands that exit with a non-zero return code abort operation, unless rescued.',
+               'Rescuing from the error, to continue the tutorial.',
+               e.inspect
+        end
+
+
+      end
+    end
+  end
+end

data/lib/rails/generators/templates/custom_ci_job/satorix/custom.rb

@@ -0,0 +1,50 @@
+module Satorix
+  module Custom
+
+    # Ensure the files required by the available_jobs method are available.
+    require_relative 'CI/deploy/mock_deploy.rb'
+    require_relative 'CI/test/bare_bones.rb'
+    require_relative 'CI/test/info.rb'
+
+
+    extend self
+
+
+    # Define the custom jobs to be added to the application's Ci pipeline.
+    #
+    # The first tier describes the stage. Default stages are build, test, and deploy.
+    # If desired, you can define your own custom stages in your gitlab-ci.yml file.
+    # For more information about GitLab stages, please refer to https://docs.gitlab.com/ce/ci/yaml/#stages
+    #
+    # The second tier describes the jobs available within each tier, and the class they map to.
+    # The key should be the actual job name to be used in the gitlab-ci.yml file.
+    # The value should be a Ruby class or module with a go() method.
+    #
+    # Example:
+    #
+    #   The available_jobs method below defines three new jobs - one for the deploy stage and
+    #   two for the test stage. The deploy job is named 'mock_deploy'.
+    #   The test jobs are named 'bare_bones_example' and 'info'.
+    #
+    #   In this example, the Satorix::CI::Test::Info#go method
+    #   will be called by an entry in gitlab-ci.yml that looks like:
+    #
+    #     display_info:
+    #       stage: test
+    #       <<: *satorix
+    #
+    def available_jobs
+      {
+        deploy: {
+          mock_deploy: Satorix::CI::Deploy::MockDeploy
+        },
+        test: {
+          bare_bones_example: Satorix::CI::Test::BareBones,
+          display_info: Satorix::CI::Test::Info
+        }
+      }
+    end
+
+
+  end
+end

data/lib/rails/generators/templates/install/.gitlab-ci.yml

@@ -0,0 +1,132 @@
+# We are using the Satorix Rails CI image from https://hub.docker.com/r/satorix/rails/
+image: 'satorix/rails'
+
+
+# Global caching directives.
+cache:
+  key: "$CI_PROJECT_ID"
+  paths:
+    - 'tmp/satorix/cache' # To cache buildpack gems between runs.
+
+
+.satorix: &satorix
+  script:
+    - gem install satorix --source https://gems.iexposure.com --no-document
+    - satorix
+
+
+###############################################################################
+#
+# Below are resources that will be available as part of the CI pipeline.
+# Uncomment the resources matching the testing requirements of your application.
+# Feel free to delete unused/unwanted resource entries.
+#
+###############################################################################
+
+
+# Configure postgresql environment variables (https://hub.docker.com/r/_/postgres/)
+# These defaults should work well for all implementations.
+.use_postgres: &use_postgres
+  services:
+    - postgres:9.5
+  variables:
+    DB_HOST: postgres
+    POSTGRES_DB: test
+    POSTGRES_PASSWORD: password
+    POSTGRES_USER: root
+
+
+## https://github.com/flynn/flynn/issues/3505
+## https://hub.docker.com/r/_/mariadb/
+## These defaults should work well for all implementations.
+#.use_mariadb: &use_mariadb
+#  services:
+#    - mariadb:10.1
+#  variables:
+#    DB_HOST: mariadb
+#    MYSQL_DATABASE: test
+#    MYSQL_ROOT_PASSWORD: password # The default user is: root
+#
+
+
+## https://github.com/flynn/flynn/issues/3505
+## https://hub.docker.com/r/_/mysql/
+## These defaults should work well for all implementations.
+#.use_mysql: &use_mysql
+#  services:
+#    - mysql:5.7
+#  variables:
+#    DB_HOST: mysql
+#    MYSQL_DATABASE: test
+#    MYSQL_ROOT_PASSWORD: password # The default user is: root
+
+
+###############################################################################
+#
+# Below are jobs that will run as part of the CI pipeline.
+# Uncomment the jobs you want to use for your application.
+# Feel free to delete unused/unwanted job entries.
+#
+###############################################################################
+
+
+## Brakeman
+## Static analysis security scanner for Ruby on Rails
+## http://brakemanscanner.org/
+#brakeman:
+#  variables:
+#    SKIP_BUILDPACK: 'true'
+#  <<: *satorix
+
+
+## bundler-audit
+## Patch-level verification for Bundler
+## https://github.com/rubysec/bundler-audit
+#bundler_audit:
+#  variables:
+#    SKIP_BUILDPACK: 'true'
+#  <<: *satorix
+
+
+## Cucumber
+## Executes executable specifications written in plain language
+## https://github.com/cucumber/cucumber
+#cucumber:
+#  <<: *use_postgres
+#  <<: *satorix
+
+
+## Rails test
+## Built-in mechanisms in Rails for testing your application
+## http://guides.rubyonrails.org/testing.html
+#rails_test:
+#  <<: *use_postgres
+#  <<: *satorix
+
+
+## RSpec
+## Behaviour Driven Development for Ruby
+## http://rspec.info/
+#rspec:
+#  <<: *use_postgres
+#  <<: *satorix
+
+
+## RuboCop
+## A Ruby static code analyzer, based on the community Ruby style guide.
+## https://github.com/bbatsov/rubocop
+#rubocop:
+#  variables:
+#    SKIP_BUILDPACK: 'true'
+#  <<: *satorix
+
+
+deploy_with_flynn:
+  environment:
+    name: $CI_COMMIT_REF_NAME
+    url: "http://$CI_PROJECT_NAME.$CI_COMMIT_REF_SLUG.$SATORIX_HOSTING_NAMESPACE"
+  stage: deploy
+  only:
+    - staging
+    - production
+  <<: *satorix

data/lib/rails/generators/templates/install/Procfile

@@ -0,0 +1,6 @@
+# This Procfile defines the types of process that Flynn will run.
+# For more information, please see the documentation at http://gitlab.iexposure.com/satorix/satorix
+
+web: bundle exec passenger start -p $PORT --nginx-config-template config/passenger_standalone/nginx.conf.erb --max-pool-size 3
+# worker: rake jobs:work
+# clock: bundle exec clockwork config/clock.rb

data/lib/rails/generators/templates/install/config/passenger_standalone/includes/authentication.erb

@@ -0,0 +1,14 @@
+
+# Authentication
+#
+#   Allow listed networks to access without auth, otherwise require password
+
+satisfy any;
+<%% ENV['SATORIX_AUTHENTICATION_ALLOWED_IPS'].to_s.split(' ').each do |target| %>
+  allow <%%= target %>;
+<%% end %>
+deny  all;
+auth_basic           "Please Log In";
+auth_basic_user_file /app/config/passenger_standalone/includes/htpasswd;
+
+# End Authentication

data/lib/rails/generators/templates/install/config/passenger_standalone/includes/htpasswd

@@ -0,0 +1 @@
+iestaging:$apr1$b4UNgid/$jVoc0rRDzUfmldUp9.DK8.

data/lib/rails/generators/templates/install/config/passenger_standalone/includes/page_level_redirects.erb

@@ -0,0 +1,16 @@
+
+# Page-level Redirects
+#
+#   Define your own custom page-level redirects below.
+#
+#   Examples:
+#     Standard single page redirects:
+#       location = /old-page-1 { return 301 $scheme://$server_name/new-page-1; }
+#       location = /old-page-2 { return 301 $scheme://$server_name/new-page-2; }
+#     Do not work:
+#       # Redirects to port 8080
+#       location = /asdf2 { return 301 /process; }
+
+
+
+# End Page-level Redirects

data/lib/rails/generators/templates/install/config/passenger_standalone/includes/proxy_configuration.erb

@@ -0,0 +1,27 @@
+
+# Proxy Configuration
+#
+#  Used to configure settings related to Flynn's interaction with proxies.
+#  Add your custom proxy configuration details below.
+
+<%% if ENV['SATORIX_PROXY_IPS'] %>
+  # Provide additional proxy IPS, as described at http://nginx.org/en/docs/http/ngx_http_realip_module.html.
+  #
+  # This is particularity useful for services like CloudFlare, using the example at:
+  # https://support.cloudflare.com/hc/en-us/articles/200170706-How-do-I-restore-original-visitor-IP-with-Nginx-
+  #
+  # If required, this variable should be populated with a space-separated list of proxy IPs. Example:
+  # 103.21.244.0/22 103.22.200.0/22 103.31.4.0/22 104.16.0.0/12 108.162.192.0/18 2c0f:f248::/32
+
+  real_ip_recursive on;
+
+  <%% ENV['SATORIX_PROXY_IPS'].to_s.split(' ').each do |real_ip| %>
+    set_real_ip_from <%%= real_ip %>;
+  <%% end %>
+<%% end %>
+
+# Use the internal Flynn network set X-Forwarded-For header for access IPs.
+set_real_ip_from 100.100.0.0/16;
+real_ip_header X-Forwarded-For;
+
+# End Proxy Configuration

data/lib/rails/generators/templates/install/config/passenger_standalone/nginx.conf.erb

@@ -0,0 +1,139 @@
+#  passenger start --nginx-config-template config/passenger_standalone/nginx.conf.erb --debug-nginx-config
+
+
+##########################################################################
+#  Passenger Standalone is built on the same technology that powers
+#  Passenger for Nginx, so any configuration option supported by Passenger
+#  for Nginx can be applied to Passenger Standalone as well. You can do
+#  this by direct editing the Nginx configuration template that is used by
+#  Passenger Standalone.
+#
+#  This file is the original template. DO NOT EDIT THIS FILE DIRECTLY.
+#  Instead, make a copy of this file and pass the `--nginx-config-template`
+#  parameter to Passenger Standalone.
+#
+#  Learn more about using the Nginx configuration template at:
+#  https://www.phusionpassenger.com/library/config/standalone/intro.html#nginx-configuration-template
+#
+#  *** NOTE ***
+#  If you customize the template file, make sure you keep an eye on the
+#  original template file and merge any changes. New Phusion Passenger
+#  features may require changes to the template file.
+##############################################################
+
+<%%
+  def include_passenger_custom_template(template)
+    ERB.new(File.read( File.join( File.dirname(__FILE__), 'includes', template ) )).result(binding)
+  end
+
+  def use_canonical?
+    !canonical_domain.nil? &&
+    !canonical_domain.empty? &&
+    !canonical_domain_protocol.nil? &&
+    !canonical_domain_protocol.empty?
+  end
+
+  def canonical_domain
+    ENV['SATORIX_CANONICAL_URI_HOST']
+  end
+
+  def canonical_domain_protocol
+    ENV['SATORIX_CANONICAL_URI_PROTOCOL']
+  end
+
+  def canonical_uri
+    "#{ canonical_domain_protocol }://#{ canonical_domain }" if use_canonical?
+  end
+%>
+
+<%%= include_passenger_internal_template('global.erb') %>
+
+worker_processes 1;
+events {
+    worker_connections 4096;
+}
+
+http {
+    <%%= include_passenger_internal_template('http.erb', 4) %>
+
+    ### BEGIN your own configuration options ###
+    # This is a good place to put your own config
+    # options. Note that your options must not
+    # conflict with the ones Passenger already sets.
+    # Learn more at:
+    # https://www.phusionpassenger.com/library/config/standalone/intro.html#nginx-configuration-template
+
+    ### END your own configuration options ###
+
+    default_type application/octet-stream;
+    types_hash_max_size 2048;
+    server_names_hash_bucket_size 96;
+    client_max_body_size 1024m;
+    access_log off;
+    keepalive_timeout 60;
+    underscores_in_headers on;
+    gzip on;
+    gzip_comp_level 3;
+    gzip_min_length 150;
+    gzip_proxied any;
+    gzip_types text/plain text/css text/json text/javascript
+        application/javascript application/x-javascript application/json
+        application/rss+xml application/vnd.ms-fontobject application/x-font-ttf
+        application/xml font/opentype image/svg+xml text/xml;
+
+  <%% if @app_finder.multi_mode? %>
+    # Default server entry for mass deployment mode.
+    server {
+        <%%= include_passenger_internal_template('mass_deployment_default_server.erb', 12) %>
+    }
+  <%% end %>
+
+  <%% @apps.each do |app| %>
+
+    <%% if use_canonical? %>
+    # Redirect all requests to the canonical domain.
+    server {
+      server_name <%%= app[:server_names].join(' ') %>;
+      listen <%%= nginx_listen_address(app) %> default_server;
+
+      return 301 <%%= canonical_uri %>$request_uri;
+    }
+    <%% else %>
+    # No canonical domain defined, passing all requests to the main server block.
+    <%% end %>
+
+    # Main server block.
+    server {
+        <%% app[:server_names] = [canonical_domain] if use_canonical? %>
+        <%%= include_passenger_internal_template('server.erb', 8, true, binding) %>
+        <%%= include_passenger_internal_template('rails_asset_pipeline.erb', 8, false) %>
+
+        <%%= include_passenger_custom_template('page_level_redirects.erb') %>
+        <%%= include_passenger_custom_template('proxy_configuration.erb') %>
+        <%%= include_passenger_custom_template('authentication.erb') %>
+
+        ### BEGIN your own configuration options ###
+        # This is a good place to put your own config options.
+        # Note that your options must not conflict with the ones Passenger already sets.
+        #
+        # Learn more at:
+        # https://www.phusionpassenger.com/library/config/standalone/intro.html#nginx-configuration-template
+        #
+        # You can use the include_passenger_custom_template to method include your own custom template.
+        # This will help you compartmentalize your configurations, to help organize your settings.
+        #
+        #   Example:
+        #
+        #     Create a new file for your new logic ( /config/passenger_standalone/includes/my_new_logic.erb )
+        #     Add your custom logic to your newly created file.
+        #     Add your file to the area below, in an ERB block ( include_passenger_custom_template('my_new_logic.erb') )
+
+
+        ### END your own configuration options ###
+    }
+
+    passenger_pre_start <%%= listen_url(app) %>;
+  <%% end %>
+
+    <%%= include_passenger_internal_template('footer.erb', 4) %>
+}

data/lib/satorix/rails/version.rb

@@ -1,5 +1,7 @@
 module Satorix
   module Rails
-    VERSION = '0.0.1'
+    module Version
+      VERSION = '1.0.11'
+    end
   end
 end

data/lib/satorix/rails.rb

@@ -1,7 +1 @@
-require "satorix/rails/version"
-
-module Satorix
-  module Rails
-    # Your code goes here...
-  end
-end
+require_relative 'rails/version'

data/satorix/CI/deploy/ie_gem_server.rb

@@ -0,0 +1,80 @@
+module Satorix
+  module CI
+    module Deploy
+      module IeGemServer
+
+
+        require 'fileutils'
+
+
+        include Satorix::Shared::Console
+
+
+        extend self
+
+
+        def go
+          log_bench('Installing the geminabox gem...') { install_geminabox_gem }
+          log_bench('Preparing gem build directory...') { prepare_gem_build_directory }
+          log_bench('Building gem...') { build_gem }
+          built_gems.each { |gem| log_bench("Publishing #{ File.basename gem }...") { publish_gem gem } }
+        end
+
+
+        private ########################################################################################################
+
+
+        def build_gem
+          run_command 'rake build'
+        end
+
+
+        def built_gems
+          Dir.glob(File.join(gem_build_directory, '*.gem')).select { |e| File.file? e }
+        end
+
+
+        def gem_build_directory
+          File.join Satorix.app_root, 'pkg'
+        end
+
+
+        def ie_gem_server_host
+          "https://#{ ie_gem_server_user_name }:#{ ie_gem_server_password }@gems.iexposure.com"
+        end
+
+
+        def ie_gem_server_password
+          ENV['SATORIX_CI_IE_GEM_SERVER_PASSWORD']
+        end
+
+
+        def ie_gem_server_user_name
+          ENV['SATORIX_CI_IE_GEM_SERVER_USER_NAME']
+        end
+
+
+        def install_geminabox_gem
+          run_command 'gem install geminabox --source https://gems.iexposure.com --no-document'
+        end
+
+
+        def prepare_gem_build_directory
+          run_command "rm -rf #{ gem_build_directory }"
+          FileUtils.mkdir_p gem_build_directory
+        end
+
+
+        def publish_gem(gem)
+          run_command "gem inabox #{ gem } --host #{ ie_gem_server_host }",
+                      filtered_text: [ie_gem_server_user_name, ie_gem_server_password]
+        rescue RuntimeError
+          # To prevent the display of an ugly stacktrace.
+          abort "\nGem was not published!"
+        end
+
+
+      end
+    end
+  end
+end

data/satorix/custom.rb

@@ -0,0 +1,21 @@
+module Satorix
+  module Custom
+
+
+    require_relative 'CI/deploy/ie_gem_server.rb'
+
+
+    extend self
+
+
+    def available_jobs
+      {
+        deploy: {
+          deploy_to_ie_gem_server: Satorix::CI::Deploy::IeGemServer
+        }
+      }
+    end
+
+
+  end
+end

data/satorix-rails.gemspec

@@ -4,14 +4,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'satorix/rails/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "satorix-rails"
-  spec.version = Satorix::Rails::VERSION
-  spec.authors = ['Brad Werth', 'Bret Baptist']
-  spec.email = ['satorix@iexposure.com']
+  spec.name          = 'satorix-rails'
+  spec.version       = Satorix::Rails::Version::VERSION
+  spec.authors       = ['Internet Exposure']
+  spec.email         = ['info@satorix.com']
 
-  spec.summary = 'Satorix in Rails'
-  spec.description = 'The satorix-rails gem provides a streamlined mechanism for a Rails application to interact with the Satorix ecosystem.'
-  spec.homepage = 'https://iexposure.com'
+  spec.summary       = 'Satorix in Rails'
+  spec.description   = 'The satorix-rails gem provides a streamlined mechanism for a Rails application to interact with the Satorix ecosystem.'
+  spec.homepage      = 'https://www.satorix.com'
 
   # 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.
@@ -21,14 +21,16 @@ Gem::Specification.new do |spec|
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'passenger'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,16 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: satorix-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.11
 platform: ruby
 authors:
-- Brad Werth
-- Bret Baptist
+- Internet Exposure
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: passenger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,23 +69,40 @@ dependencies:
 description: The satorix-rails gem provides a streamlined mechanism for a Rails application
   to interact with the Satorix ecosystem.
 email:
-- satorix@iexposure.com
+- info@satorix.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
+- Procfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/rails/generators/satorix/custom_ci_job_generator.rb
+- lib/rails/generators/satorix/install_generator.rb
+- lib/rails/generators/templates/custom_ci_job/satorix/CI/deploy/mock_deploy.rb
+- lib/rails/generators/templates/custom_ci_job/satorix/CI/test/bare_bones.rb
+- lib/rails/generators/templates/custom_ci_job/satorix/CI/test/info.rb
+- lib/rails/generators/templates/custom_ci_job/satorix/custom.rb
+- lib/rails/generators/templates/install/.gitlab-ci.yml
+- lib/rails/generators/templates/install/Procfile
+- lib/rails/generators/templates/install/config/passenger_standalone/includes/authentication.erb
+- lib/rails/generators/templates/install/config/passenger_standalone/includes/htpasswd
+- lib/rails/generators/templates/install/config/passenger_standalone/includes/page_level_redirects.erb
+- lib/rails/generators/templates/install/config/passenger_standalone/includes/proxy_configuration.erb
+- lib/rails/generators/templates/install/config/passenger_standalone/nginx.conf.erb
 - lib/satorix/rails.rb
 - lib/satorix/rails/version.rb
 - satorix-rails.gemspec
-homepage: https://iexposure.com
+- satorix/CI/deploy/ie_gem_server.rb
+- satorix/custom.rb
+homepage: https://www.satorix.com
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
@@ -92,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Satorix in Rails

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.13.6