satorix-rails 1.1.7 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ee5e2a9bca28a5625d0d6c611c585d1d6b32b02a
-  data.tar.gz: 678aed79747a3c59bcdca0a9f2cf435feaa5823a
+SHA256:
+  metadata.gz: 3949871c7a24df013f4f59c91eea2e07cc1d954c42535116b3a1c4dc6832b546
+  data.tar.gz: 6b6ea3f3229e0d5379a0781be75ca3c8215a83e5109758d512cbdb744f556c67
 SHA512:
-  metadata.gz: 83da29607fba4219c0377040617fe74a45b4d8c473ced5ad3d07e9e5454c6929b8a23a8fb2339a66ea5a2fa391642123d13d007d83ab7790f640034826ad51eb
-  data.tar.gz: 9ef8a25c787bf82dfa15f7ac41d338209c54cd084c33921797e15f5449f633e40e64a585f3ff066d257f0eba8cee79be51d34b0bc9ca73431d060b220ee0dc36
+  metadata.gz: 416449f6f8f67cdee5340d9c04cff43b584a698eee6fcdacc6c3e68409d747df89bb56adbc854cef88eada785319dc38c344b0c45b958d0add3695bcb9801fd9
+  data.tar.gz: 7f23d2e504afd46918a4a6063085626a60af6a020e0a21634dafd51b32b8941d6f4d7d96a21c31e8f8cef6ad7c5fb1012bdd789d7072d556eb151955c3510235

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.gitlab-ci.yml

@@ -3,7 +3,6 @@ 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
 
@@ -15,17 +14,17 @@ cache:
 
 
 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
+# This is a custom job, defined at satorix/CI/deploy/rubygems.rb
 deploy_to_rubygems:
   environment:
     name: $CI_COMMIT_REF_NAME
-    url: 'http://gems.iexposure.com/gems/satorix-rails'
+    url: 'https://rubygems.org/gems/satorix-rails'
   stage: deploy
   only:
-    - master
+    - tags
+  except:
+    - schedules
   <<: *satorix

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.5
+ruby-2.6.6

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    satorix-rails (1.2.2)
+      passenger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    passenger (6.0.4)
+      rack
+      rake (>= 0.8.1)
+    rack (2.2.2)
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  satorix-rails!
+
+RUBY VERSION
+   ruby 2.6.6p146
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -6,22 +6,19 @@ By [Internet Exposure](https://www.iexposure.com/)
 [![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.
+[Satorix](https://www.satorix.com): Get your app from local to live
 
-The satorix-rails gem provides a streamlined mechanism for a 12-factor capable Rails application to interact with the Satorix ecosystem.
+The `satorix-rails` gem provides a streamlined mechanism for a 12-factor capable Rails application to interact with the Satorix ecosystem.
 
-
-## Getting Started
+## Preparing your application
 
 Add Satorix to your Rails application by including it in your Gemfile with:
 
 ```ruby
-source 'https://gems.iexposure.com' do
-  gem 'satorix-rails'
-end
+gem 'satorix-rails'
 ```
 
-Run the bundle command to install it.
+Run the `bundle` command to install it.
 
 Next, run the generator from a terminal at the root of your application:
 
@@ -29,7 +26,7 @@ Next, run the generator from a terminal at the root of your application:
 $ rails g satorix:install
 ```
 
-Congratulations, your application is now suitable for deployment into Satorix.
+This creates a set of files that utilize environment variables created by default with Satorix. These include the [Phusion Passenger Rails app server](https://www.phusionpassenger.com/) and the Passenger built in Nginx web server.
 
 # Logging in Rails 4 and below
 
@@ -40,57 +37,62 @@ 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`
 
+# Configuring your application
 
-## What's Included
+You can configure your application on a per-environment basis using environment variables.
 
+### Default environment Variables
 
-## Environment Variables
+The following default environment variables are used by the `satorix-rails` generated files and can be managed through the Satorix Dashboard:
 
-You can configure your application on a per-environment basis using environment variables.
+##### SATORIX_CANONICAL_URI_HOST
 
-The following environment variables are used by the generated files:
+*Optional*, a domain to rewrite all requests to by default. Setting this will make it so all requests to your site will go to the supplied domain.
 
-Using the Satorix Dashboard? You can relax, all of these variables are automatically configured for you.
+Common setting:
 
-##### SATORIX_AUTHENTICATION_USER_NAMES_AND_PASSWORDS
+* `www.domain.dom`
 
-Optional
+##### SATORIX_CANONICAL_URI_PROTOCOL
 
-Hashed usernames:passwords, newline separated
+*Optional*, the `HTTP` protocol to rewrite requests to.
 
-##### SATORIX_AUTHENTICATION_ALLOWED_IPS
+Valid settings:
 
-Optional
+* `http`
+* `https`
 
-Valid settings:
+##### SATORIX_PROXY_IPS
 
-* 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`)
+*Optional*, used to define proxy IP addresses, for services like CloudFlare. This will allow you to get the actual client IP address accessing your site in the logs and accessible to your application.
 
-##### SATORIX_CANONICAL_URI_HOST
+Valid settings:
 
-Optional
+* Space separated list of IPs or network ranges (`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 131.0.72.0/22 141.101.64.0/18 162.158.0.0/15 172.64.0.0/13 173.245.48.0/20 188.114.96.0/20 190.93.240.0/20 197.234.240.0/22 198.41.128.0/17 199.27.128.0/21`)
 
-If specified, t
+##### SATORIX_AUTHENTICATION_HTPASSWDS
 
-##### SATORIX_CANONICAL_URI_PROTOCOL
+*Optional*, used to control access to your site with HTTP Basic authentication. Needs to be generated in the format created by the Apache tool `htpasswd -nb username password` or using an [online generator](http://www.htaccesstools.com/htpasswd-generator/).
 
-Optional
+Valid settings:
 
-##### SATORIX_PROXY_IPS
+* Newline separated list of username and hashed password (`username:$apr1$vAxBKb8N$m0en1zabtHktHeFyT3j9y`)
+
+##### SATORIX_AUTHENTICATION_ALLOWED_IPS
 
-was NGINX_ADDITIONAL_REAL_IPS
+*Optional*, used to control access to your site by bypassing the above HTTP Basic authentication. If set to `all` no authentication will be required. Any IP addresses or networks added here will not need to supply the username and password to access the site.
 
-Used to define proxy IP addresses, for services like CloudFlare.
+Valid settings:
 
+* All (`all`)
+* Single IP (`192.168.1.2`)
+* Network range (`192.168.1.0/24`)
+* Space separated list of multiple IPs or network ranges (`192.168.1.3 192.168.2.0/24`)
 
 ## 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/).
@@ -100,8 +102,7 @@ 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.
@@ -110,9 +111,6 @@ 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,6 +1,10 @@
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+begin
+  require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+  RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

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

@@ -1,4 +1,5 @@
-# We are using the Satorix Rails CI image from https://hub.docker.com/r/satorix/rails/
+# We are using the base Satorix Rails CI image from https://hub.docker.com/r/satorix/rails/
+# Additional versions with expanded features can be found at https://hub.docker.com/u/satorix
 image: 'satorix/rails'
 
 
@@ -9,12 +10,6 @@ cache:
     - '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.
@@ -61,6 +56,13 @@ cache:
 #    MYSQL_ROOT_PASSWORD: password # The default user is: root
 
 
+.satorix: &satorix
+  <<: *use_postgres
+  script:
+    - gem install satorix --source https://gems.iexposure.com --no-document
+    - satorix
+
+
 ###############################################################################
 #
 # Below are jobs that will run as part of the CI pipeline.
@@ -74,8 +76,6 @@ cache:
 ## Static analysis security scanner for Ruby on Rails
 ## http://brakemanscanner.org/
 #brakeman:
-#  variables:
-#    SKIP_BUILDPACK: 'true'
 #  <<: *satorix
 
 
@@ -83,8 +83,6 @@ cache:
 ## Patch-level verification for Bundler
 ## https://github.com/rubysec/bundler-audit
 #bundler_audit:
-#  variables:
-#    SKIP_BUILDPACK: 'true'
 #  <<: *satorix
 
 
@@ -92,7 +90,6 @@ cache:
 ## Executes executable specifications written in plain language
 ## https://github.com/cucumber/cucumber
 #cucumber:
-#  <<: *use_postgres
 #  <<: *satorix
 
 
@@ -100,7 +97,6 @@ cache:
 ## Built-in mechanisms in Rails for testing your application
 ## http://guides.rubyonrails.org/testing.html
 #rails_test:
-#  <<: *use_postgres
 #  <<: *satorix
 
 
@@ -108,7 +104,6 @@ cache:
 ## Behaviour Driven Development for Ruby
 ## http://rspec.info/
 #rspec:
-#  <<: *use_postgres
 #  <<: *satorix
 
 
@@ -116,8 +111,6 @@ cache:
 ## A Ruby static code analyzer, based on the community Ruby style guide.
 ## https://github.com/bbatsov/rubocop
 #rubocop:
-#  variables:
-#    SKIP_BUILDPACK: 'true'
 #  <<: *satorix
 
 
@@ -129,4 +122,6 @@ deploy_with_flynn:
   only:
     - staging
     - production
+  except:
+    - schedules
   <<: *satorix

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

@@ -22,16 +22,16 @@
   end
 
   allowed_without_auth = ENV['SATORIX_AUTHENTICATION_ALLOWED_IPS'].to_s.split
-  allowed_without_auth = ['any'] if allowed_without_auth.empty?
+  allowed_without_auth = ['all'] if allowed_without_auth.empty?
 -%>
 
 # Allow listed networks to access without auth, otherwise require password if defined
 location / {
   satisfy any;
-  deny all;
 <%% allowed_without_auth.each do |target| -%>
   allow <%%= target %>;
 <%% end -%>
+  deny all;
 <%% if File.file?(password_file_location('htpasswd')) -%>
   auth_basic "Please Log In";
   auth_basic_user_file <%%= password_file_location('htpasswd') %>;

data/lib/satorix/rails/version.rb

@@ -1,7 +1,7 @@
 module Satorix
   module Rails
     module Version
-      VERSION = '1.1.7'
+      VERSION = '1.2.2'
     end
   end
 end

data/satorix-rails.gemspec

@@ -6,7 +6,7 @@ require 'satorix/rails/version'
 Gem::Specification.new do |spec|
   spec.name          = 'satorix-rails'
   spec.version       = Satorix::Rails::Version::VERSION
-  spec.authors       = ['Internet Exposure']
+  spec.authors       = ['Satorix']
   spec.email         = ['info@satorix.com']
 
   spec.summary       = 'Satorix in Rails'
@@ -30,7 +30,4 @@ Gem::Specification.new do |spec|
 
   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

data/satorix/CI/deploy/rubygems.rb

@@ -25,7 +25,9 @@ module Satorix
 
 
         def build_gem
-          run_command 'rake build'
+          Dir.chdir(Satorix.app_dir) do
+            run_command 'bundle exec rake build'
+          end
         end
 
 
@@ -35,7 +37,7 @@ module Satorix
 
 
         def gem_build_directory
-          File.join Satorix.app_root, 'pkg'
+          File.join Satorix.app_dir, 'pkg'
         end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: satorix-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.2
 platform: ruby
 authors:
-- Internet Exposure
+- Satorix
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: passenger
@@ -24,48 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-- !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: The satorix-rails gem provides a streamlined mechanism for a Rails application
   to interact with the Satorix ecosystem.
 email:
@@ -79,6 +37,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - Procfile
 - README.md
 - Rakefile
@@ -120,8 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Satorix in Rails