rockstart 0.1.0 → 0.1.1

data/lib/generators/rockstart/{devise → authorization/devise}/templates/spec/models/user_spec.rb

@@ -15,27 +15,22 @@ RSpec.describe User, type: :model do
   # deleted_at:datetime
   it { is_expected.to have_db_column(:deleted_at).of_type(:datetime) }
 
-  describe "#given" do
+  describe "#first_name" do
     it "returns the given name from the name" do
       user = User.new(name: "John Smith")
-      expect(user.given).to eq "John"
+      expect(user.first_name).to eq "John"
     end
 
     it "handles nil name valeus" do
       user = User.new(name: nil)
-      expect(user.given).to be_nil
+      expect(user.first_name).to be_nil
     end
   end
 
-  describe "#family" do
-    it "returns the family name from the name" do
-      user = User.new(name: "John Smith")
-      expect(user.family).to eq "Smith"
-    end
-
-    it "handles nil name valeus" do
-      user = User.new(name: nil)
-      expect(user.family).to be_nil
+  describe "#image" do
+    it "returns a gravatar image based off the email address" do
+      user = User.new(email: "test@example.com")
+      expect(user.image).to eq "https://s.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?s=480"
     end
   end
 
@@ -49,16 +44,9 @@ RSpec.describe User, type: :model do
       expect(user.to_s).to eq "John Smith"
     end
 
-    it "falls back to a generic label when name is not present" do
+    it "falls back to a generic label" do
       user = build_stubbed(:user, name: nil)
-      allow(user).to receive(:id?).and_return(true)
-      allow(user).to receive(:id).and_return(1234)
-      expect(user.to_s).to eq "User #1234"
-    end
-
-    it "returns a generic label when user is not persisted" do
-      user = User.new(name: nil)
-      expect(user.to_s).to eq "Guest User"
+      expect(user.to_s).to start_with "#<User:"
     end
   end
 end

data/lib/generators/rockstart/{devise → authorization/devise}/templates/spec/requests/users/registrations_spec.rb

@@ -28,7 +28,7 @@ RSpec.describe "Users::Registrations", type: :request do
     end
   end
 
-  describe "POST /users", :cache_testing do
+  describe "POST /users" do
     context "with valid create user params" do
       let(:valid_password) { Faker::Internet.password }
       let(:valid_registration_params) do
@@ -149,7 +149,7 @@ RSpec.describe "Users::Registrations", type: :request do
     end
   end
 
-  describe "PUT /users", :cache_testing do
+  describe "PUT /users" do
     context "with update user email params" do
       let(:original_email) { Faker::Internet.email }
       let(:updated_email) { Faker::Internet.email }
@@ -193,15 +193,6 @@ RSpec.describe "Users::Registrations", type: :request do
           expect(delivery.to).to eq [original_email]
           expect(delivery.subject).to eq t("devise.mailer.email_changed.subject")
         end
-
-        it "rate limits requests based off ip address" do
-          5.times do
-            put user_registration_path, params: update_user_email_params
-          end
-
-          put user_registration_path, params: update_user_email_params
-          expect(response).to have_http_status(:too_many_requests)
-        end
       end
 
       context "as a guest" do

data/lib/generators/rockstart/{devise → authorization/devise}/templates/spec/requests/users/sessions_spec.rb

@@ -41,7 +41,7 @@ RSpec.describe "Users::Passwords", type: :request do
     end
   end
 
-  describe "POST /users/sign_in", :cache_testing do
+  describe "POST /users/sign_in" do
     context "with known user credentials" do
       let(:valid_password) { Faker::Internet.password }
       let(:known_user) { create(:user, password: valid_password) }
@@ -102,43 +102,6 @@ RSpec.describe "Users::Passwords", type: :request do
         expect(response.body).to have_selector(".alert-alert", text: t("devise.failure.invalid", authentication_keys: "Email"))
       end
     end
-
-    it "rate limits requests based off ip address" do
-      5.times do
-        post new_user_session_path, params: {
-          user: {
-            email: Faker::Internet.email,
-            password: Faker::Internet.password
-          }
-        }
-      end
-
-      post new_user_session_path, params: {
-        user: {
-          email: Faker::Internet.email,
-          password: Faker::Internet.password
-        }
-      }
-      expect(response).to have_http_status(:too_many_requests)
-    end
-
-    it "rate limits requests based off email address" do
-      valid_email_parameters = {
-        user: {
-          email: Faker::Internet.email,
-          password: Faker::Internet.password
-        }
-      }
-
-      5.times do |n|
-        post new_user_session_path, params: valid_email_parameters, headers: {
-          "REMOTE_ADDR" => format("120.0.1.%<n>d", n: n)
-        }
-      end
-
-      post new_user_session_path, params: valid_email_parameters
-      expect(response).to have_http_status(:too_many_requests)
-    end
   end
 
   describe "DELETE /users/sign_outs" do

data/lib/generators/rockstart/{pundit → authorization/pundit}/USAGE

@@ -2,7 +2,7 @@ Description:
     Adds authentication to a project with simple authentication needs
 
 Example:
-    rails generate rockstart:pundit
+    rails generate rockstart:authorization:pundit
 
     This will create:
         Installs pundit gem

data/lib/generators/rockstart/authorization/pundit/pundit_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+
+module Rockstart::Authorization
+  class PunditGenerator < Rails::Generators::Base
+    include Rockstart::Generators::ClassOptionHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    auth0_class_option
+
+    def add_pundit_exception_handling
+      application <<~PUNDIT
+        # Treat Pundit authentication failures as forbidden
+        config.action_dispatch.rescue_responses["Pundit::NotAuthorizedError"] = :forbidden
+      PUNDIT
+    end
+
+    def add_pundit_to_application_controller
+      inject_into_file "app/controllers/application_controller.rb",
+                       "  include Pundit\n",
+                       before: /^end$/
+    end
+
+    def add_pundit_configuration
+      directory "config"
+    end
+
+    def add_prebuilt_resources
+      directory "app"
+      directory "lib"
+      directory "spec"
+    end
+
+    def add_scaffold_templates
+      copy_file "scaffold/policy.rb.tt", "lib/templates/pundit/policy/policy.rb"
+      copy_file "scaffold/policy_spec.rb.tt", "lib/templates/rspec/policy/policy_spec.rb"
+    end
+  end
+end

data/lib/generators/rockstart/{pundit/templates/app/policies/user_policy.rb → authorization/pundit/templates/app/policies/user_policy.rb.tt}

@@ -41,7 +41,11 @@ class UserPolicy < ApplicationPolicy
   # Safe scope for User
   class Scope < Scope
     def resolve
+<%- if auth0? -%>
+      raise Pundit::NotDefinedError, "Cannot scope Users"
+<%- else -%>
       user.persisted? ? scope.where(id: user.id) : scope.none
+<%- end -%>
     end
   end
 end

data/lib/generators/rockstart/authorization/pundit/templates/lib/admin_constraint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Constraint for limiting routes to admin users
+class AdminConstraint
+  def self.matches?(request)
+    return false unless request.session[:userinfo].present?
+
+    user = User.new(request.session[:userinfo])
+    user&.admin?
+  end
+end

data/lib/generators/rockstart/{pundit/templates/spec/policies/user_policy_spec.rb → authorization/pundit/templates/spec/policies/user_policy_spec.rb.tt}

@@ -5,15 +5,23 @@ require "rails_helper"
 RSpec.describe UserPolicy, type: :policy do
   subject { described_class.new(user, user_record) }
 
+<%- if auth0? -%>
+  let(:resolved_scope) { described_class::Scope.new(user, []).resolve }
+<%- else -%>
   let(:resolved_scope) { described_class::Scope.new(user, User.all).resolve }
+<%- end -%>
 
   let(:user_record) do
+<%- if auth0? -%>
+    build(:user, uid: 123)
+<%- else -%>
     build_stubbed(:user).tap do |record|
       allow(record).to receive(:id).and_return(123)
     end
+<%- end -%>
   end
 
-  context "with a guest" do
+  context "as a guest" do
     let(:user) { nil }
 
     it { is_expected.to forbid_action(:index) }
@@ -22,12 +30,18 @@ RSpec.describe UserPolicy, type: :policy do
     it { is_expected.to forbid_actions(%i[edit update]) }
     it { is_expected.to forbid_action(:destroy) }
 
+<%- if auth0? -%>
+    it "raises a Pundit::NotDefinedError" do
+      expect { resolved_scope }.to raise_error(Pundit::NotDefinedError)
+    end
+<%- else -%>
     it "returns no items in scope" do
       expect(resolved_scope.to_sql).to eq(User.none.to_sql)
     end
+<%- end -%>
   end
 
-  context "with the same user" do
+  context "as the same user" do
     let(:user) { user_record }
 
     it { is_expected.to permit_actions(%i[edit update]) }
@@ -39,14 +53,24 @@ RSpec.describe UserPolicy, type: :policy do
 
     it { is_expected.to permit_mass_assignment_of(:name).for_action(:update) }
 
+<%- if auth0? -%>
+    it "raises a Pundit::NotDefinedError" do
+      expect { resolved_scope }.to raise_error(Pundit::NotDefinedError)
+    end
+<%- else -%>
     it "returns the a scope with only the user" do
       expect(resolved_scope.to_sql).to eq(User.where(id: user.id).to_sql)
     end
+<%- end -%>
 
-    context "when the user is an admin" do
+    context "as a user with admin persmission" do
+<%- if auth0? -%>
+      let(:user) { build(:user, :admin, uid: 123) }
+<%- else -%>
       before do
         user.admin = true
       end
+ <%- end -%>
 
       it { is_expected.to permit_actions(%i[edit update]) }
 
@@ -57,17 +81,27 @@ RSpec.describe UserPolicy, type: :policy do
 
       it { is_expected.to permit_mass_assignment_of(:name).for_action(:update) }
 
+<%- if auth0? -%>
+      it "raises a Pundit::NotDefinedError" do
+        expect { resolved_scope }.to raise_error(Pundit::NotDefinedError)
+      end
+<%- else -%>
       it "returns the a scope with only the user" do
         expect(resolved_scope.to_sql).to eq(User.where(id: user.id).to_sql)
       end
+<%- end -%>
     end
   end
 
   context "with a different user" do
     let(:user) do
-      build_stubbed(:user).tap do |user|
-        allow(user).to receive(:id).and_return(987)
+<%- if auth0? -%>
+      build(:user, uid: 987)
+  <%- else -%>
+      build_stubbed(:user).tap do |record|
+        allow(record).to receive(:id).and_return(987)
       end
+  <%- end -%>
     end
 
     it { is_expected.to forbid_action(:index) }
@@ -79,9 +113,13 @@ RSpec.describe UserPolicy, type: :policy do
     it { is_expected.to forbid_mass_assignment_of(:name).for_action(:update) }
 
     context "when the user is an admin" do
+<%- if auth0? -%>
+      let(:user) { build(:user, :admin, uid: 987) }
+<%- else -%>
       before do
         user.admin = true
       end
+ <%- end -%>
 
       it { is_expected.to forbid_action(:index) }
       it { is_expected.to forbid_action(:show) }

data/lib/generators/rockstart/deployment/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Setups up a Rails application for Continuous Integration, Delivery and Deployment (CI/CD)
+
+Example:
+    rails generate rockstart:deployment
+
+    This will create:
+        bin/hooks-release script for fresh deployments

data/lib/generators/rockstart/deployment/deployment_generator.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+require "rockstart/generators/template_helpers"
+
+class Rockstart::DeploymentGenerator < Rails::Generators::Base
+  include Rockstart::Generators::ClassOptionHelpers
+  include Rockstart::Generators::TemplateHelpers
+
+  source_root File.expand_path("templates", __dir__)
+
+  auth0_class_option
+  devise_class_option
+  frontend_class_option
+  memcached_class_option
+  postgres_class_option
+  rollbar_class_option
+  sidekiq_class_option
+
+  def configure_environment
+    application(nil, env: :production) do
+      <<~APP_HOST
+        config.action_controller.default_url_options = { host: ENV["APP_HOST"] }
+        config.action_controller.asset_host = ENV.fetch("ASSET_HOST") { ENV["APP_HOST"] }
+      APP_HOST
+    end
+  end
+
+  def create_run_scripts
+    script_template "web"
+    script_template "worker" if sidekiq?
+  end
+
+  def create_deployment_scripts
+    script_template "hooks-postdeploy"
+    script_template "hooks-release"
+  end
+
+  def add_rack_deflater
+    application do
+      <<~RACK_DEFLATER
+        if ENV["RAILS_SERVE_STATIC_FILES"].present?
+          config.middleware.insert_after ActionDispatch::Static, Rack::Deflater
+          config.static_cache_control = "public, max-age=\#{2.days.to_i}"
+        else
+          config.middleware.insert_after Rack::Sendfile, Rack::Deflater
+        end
+      RACK_DEFLATER
+    end
+  end
+
+  def add_rack_deflater_spec
+    copy_file "rack_deflater_spec.rb", "spec/requests/rack_deflater_spec.rb"
+  end
+
+  def generate_nginx
+    generate "rockstart:deployment:nginx"
+  end
+
+  def generate_heroku
+    generate "rockstart:deployment:heroku",
+             auth0_option,
+             memcached_option,
+             postgres_option,
+             rollbar_option,
+             sidekiq_option
+  end
+
+  def generate_docker
+    generate "rockstart:deployment:docker",
+             devise_option,
+             frontend_option,
+             memcached_option,
+             postgres_option,
+             rollbar_option,
+             sidekiq_option
+  end
+end

data/lib/generators/rockstart/deployment/docker/docker_generator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+
+module Rockstart::Deployment
+  class DockerGenerator < Rails::Generators::Base
+    include Rails::Generators::AppName
+    include Rockstart::Generators::ClassOptionHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    desc "This generator configures a Rails Application to work with Docker"
+
+    class_option :root_image, type: :string,
+                              desc: "Docker image to build the container from",
+                              default: "ruby:#{RUBY_VERSION}"
+
+    class_option :app_home, type: :string,
+                            desc: "Mount directory used within Docker image",
+                            default: Rails.application.engine_name
+
+    devise_class_option
+    frontend_class_option
+    memcached_class_option
+    postgres_class_option
+    rollbar_class_option
+    sidekiq_class_option
+
+    def create_dockerignore
+      copy_file "dockerignore", ".dockerignore"
+    end
+
+    def create_dockerfile
+      @root_image = options[:root_image]
+      @app_home = options[:app_home]
+      template "app/Dockerfile-app", "Dockerfile"
+    end
+
+    def create_nginx_image
+      @root_image = options[:root_image]
+      @app_home = options[:app_home]
+      template "web/Dockerfile-web", "docker/web/Dockerfile"
+      template "web/nginx.conf", "docker/web/nginx.conf"
+    end
+
+    def add_docker_compose
+      @app_home = options[:app_home]
+      template "docker-compose.yml", "docker-compose.yml"
+      template "docker-compose.test.yml", "docker-compose.test.yml"
+    end
+
+    def create_certs_directory
+      FileUtils.mkdir_p(Rails.root.join("docker", "certs", "web"))
+      append_file ".gitignore", "\n# Docker Configuration\ndocker/certs\n"
+    end
+
+    def create_dotenv_files
+      template "dotenv.docker.tt", ".env.docker"
+      template "dotenv.docker-db.tt", ".env.docker-db"
+    end
+
+    private
+
+    # Generates an example password
+    def example_db_password
+      require "base64"
+      Base64.urlsafe_encode64(Rails.application.engine_name)
+    end
+  end
+end