diff --git a/README.md b/README.md index db507e7..bd45cf5 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,7 @@ Further examples and config options are in the further reading section: [Further Reading](docs/further_reading.md) +[Ruby on Rails example](ruby_on_rails_example/README.md) ------------------------- [Harness](https://www.harness.io/) is a feature management platform that helps teams to build better software and to diff --git a/ruby_on_rails_example/.gitattributes b/ruby_on_rails_example/.gitattributes new file mode 100644 index 0000000..31eeee0 --- /dev/null +++ b/ruby_on_rails_example/.gitattributes @@ -0,0 +1,7 @@ +# See https://git-scm.com/docs/gitattributes for more about git attribute files. + +# Mark the database schema as having been generated. +db/schema.rb linguist-generated + +# Mark any vendored files as having been vendored. +vendor/* linguist-vendored diff --git a/ruby_on_rails_example/.gitignore b/ruby_on_rails_example/.gitignore new file mode 100644 index 0000000..886f714 --- /dev/null +++ b/ruby_on_rails_example/.gitignore @@ -0,0 +1,35 @@ +# See https://help.github.com/articles/ignoring-files for more about ignoring files. +# +# If you find yourself ignoring temporary files generated by your text editor +# or operating system, you probably want to add a global ignore instead: +# git config --global core.excludesfile '~/.gitignore_global' + +# Ignore bundler config. +/.bundle + +# Ignore the default SQLite database. +/db/*.sqlite3 +/db/*.sqlite3-* + +# Ignore all logfiles and tempfiles. +/log/* +/tmp/* +!/log/.keep +!/tmp/.keep + +# Ignore pidfiles, but keep the directory. +/tmp/pids/* +!/tmp/pids/ +!/tmp/pids/.keep + +# Ignore uploaded files in development. +/storage/* +!/storage/.keep +/tmp/storage/* +!/tmp/storage/ +!/tmp/storage/.keep + +/public/assets + +# Ignore master key for decrypting credentials and more. +/config/master.key diff --git a/ruby_on_rails_example/.ruby-version b/ruby_on_rails_example/.ruby-version new file mode 100644 index 0000000..1f7da99 --- /dev/null +++ b/ruby_on_rails_example/.ruby-version @@ -0,0 +1 @@ +2.7.7 diff --git a/ruby_on_rails_example/Dockerfile b/ruby_on_rails_example/Dockerfile new file mode 100644 index 0000000..17a610c --- /dev/null +++ b/ruby_on_rails_example/Dockerfile @@ -0,0 +1,9 @@ +FROM ruby:2.7.7 +RUN apt-get update && apt-get install -y build-essential nodejs +RUN mkdir -p /app +WORKDIR /app +COPY Gemfile Gemfile.lock ./ +RUN gem install bundler && bundle install --jobs 10 --retry 3 +COPY . ./ +EXPOSE 3000 +CMD ["rails", "s", "-b", "0.0.0.0"] diff --git a/ruby_on_rails_example/Gemfile b/ruby_on_rails_example/Gemfile new file mode 100644 index 0000000..5287f58 --- /dev/null +++ b/ruby_on_rails_example/Gemfile @@ -0,0 +1,74 @@ +source "https://rubygems.org" +git_source(:github) { |repo| "https://github.com/#{repo}.git" } + +ruby "2.7.7" + +# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main" +gem "rails", "~> 7.0.4", ">= 7.0.4.2" + +# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails] +gem "sprockets-rails" + +# Use sqlite3 as the database for Active Record +gem "sqlite3", "~> 1.4" + +# Use the Puma web server [https://github.com/puma/puma] +gem "puma", "~> 5.0" + +# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails] +gem "importmap-rails" + +# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev] +gem "turbo-rails" + +# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev] +gem "stimulus-rails" + +# Build JSON APIs with ease [https://github.com/rails/jbuilder] +gem "jbuilder" + +# Use Redis adapter to run Action Cable in production +gem "redis", "~> 4.0" + +# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis] +# gem "kredis" + +# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword] +# gem "bcrypt", "~> 3.1.7" + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ] + +# Reduces boot times through caching; required in config/boot.rb +gem "bootsnap", require: false + +# Use Sass to process CSS +# gem "sassc-rails" + +# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images] +# gem "image_processing", "~> 1.2" + +gem 'ff-ruby-server-sdk', '>= 1.0.6' + +group :development, :test do + # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem + gem "debug", platforms: %i[ mri mingw x64_mingw ] +end + +group :development do + # Use console on exceptions pages [https://github.com/rails/web-console] + gem "web-console" + + # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler] + # gem "rack-mini-profiler" + + # Speed up commands on slow machines / big apps [https://github.com/rails/spring] + # gem "spring" +end + +group :test do + # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing] + gem "capybara" + gem "selenium-webdriver" + gem "webdrivers" +end diff --git a/ruby_on_rails_example/README.md b/ruby_on_rails_example/README.md new file mode 100644 index 0000000..1aa3ccd --- /dev/null +++ b/ruby_on_rails_example/README.md @@ -0,0 +1,31 @@ +# Ruby on Rails example + +This basic project shows how to use the Ruby SDK in a Rails (2.7.x) application. + +### Build the docker image + +```bash +docker build -t rails-example . +``` + +### Run docker image + +```bash +export FF_API_KEY= +docker run -e FF_API_KEY=$FF_API_KEY -p 3000:3000 --rm rails-example +``` + +### Access web server + +http://localhost:3000/ + +When you toggle a flag on https://app.harness.io it will be logged in the console output of the container. Since this is a server SDK you need to refresh the page in the browser to see the HTML update. + + +### Main files + +[Controller](app/controllers/example_controller.rb) + +[View](app/views/example/index.html.erb) + +[Helper](app/helpers/example_helper.rb) diff --git a/ruby_on_rails_example/Rakefile b/ruby_on_rails_example/Rakefile new file mode 100644 index 0000000..9a5ea73 --- /dev/null +++ b/ruby_on_rails_example/Rakefile @@ -0,0 +1,6 @@ +# Add your own tasks in files placed in lib/tasks ending in .rake, +# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. + +require_relative "config/application" + +Rails.application.load_tasks diff --git a/ruby_on_rails_example/app/assets/config/manifest.js b/ruby_on_rails_example/app/assets/config/manifest.js new file mode 100644 index 0000000..ddd546a --- /dev/null +++ b/ruby_on_rails_example/app/assets/config/manifest.js @@ -0,0 +1,4 @@ +//= link_tree ../images +//= link_directory ../stylesheets .css +//= link_tree ../../javascript .js +//= link_tree ../../../vendor/javascript .js diff --git a/ruby_on_rails_example/app/assets/images/.keep b/ruby_on_rails_example/app/assets/images/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/app/assets/stylesheets/application.css b/ruby_on_rails_example/app/assets/stylesheets/application.css new file mode 100644 index 0000000..288b9ab --- /dev/null +++ b/ruby_on_rails_example/app/assets/stylesheets/application.css @@ -0,0 +1,15 @@ +/* + * This is a manifest file that'll be compiled into application.css, which will include all the files + * listed below. + * + * Any CSS (and SCSS, if configured) file within this directory, lib/assets/stylesheets, or any plugin's + * vendor/assets/stylesheets directory can be referenced here using a relative path. + * + * You're free to add application-wide styles to this file and they'll appear at the bottom of the + * compiled file so the styles you add here take precedence over styles defined in any other CSS + * files in this directory. Styles in this file should be added after the last require_* statement. + * It is generally better to create a new file per style scope. + * + *= require_tree . + *= require_self + */ diff --git a/ruby_on_rails_example/app/channels/application_cable/channel.rb b/ruby_on_rails_example/app/channels/application_cable/channel.rb new file mode 100644 index 0000000..d672697 --- /dev/null +++ b/ruby_on_rails_example/app/channels/application_cable/channel.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Channel < ActionCable::Channel::Base + end +end diff --git a/ruby_on_rails_example/app/channels/application_cable/connection.rb b/ruby_on_rails_example/app/channels/application_cable/connection.rb new file mode 100644 index 0000000..0ff5442 --- /dev/null +++ b/ruby_on_rails_example/app/channels/application_cable/connection.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Connection < ActionCable::Connection::Base + end +end diff --git a/ruby_on_rails_example/app/controllers/application_controller.rb b/ruby_on_rails_example/app/controllers/application_controller.rb new file mode 100644 index 0000000..09705d1 --- /dev/null +++ b/ruby_on_rails_example/app/controllers/application_controller.rb @@ -0,0 +1,2 @@ +class ApplicationController < ActionController::Base +end diff --git a/ruby_on_rails_example/app/controllers/concerns/.keep b/ruby_on_rails_example/app/controllers/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/app/controllers/example_controller.rb b/ruby_on_rails_example/app/controllers/example_controller.rb new file mode 100644 index 0000000..9eaa073 --- /dev/null +++ b/ruby_on_rails_example/app/controllers/example_controller.rb @@ -0,0 +1,7 @@ +class ExampleController < ApplicationController + + def index + @flag_name = ENV['FF_FLAG_NAME'] || 'harnessappdemodarkmode' + @target = Target.new("RubyOnRailsExample", identifier="rubysdk", attributes={"username": "test"}) + end +end diff --git a/ruby_on_rails_example/app/helpers/application_helper.rb b/ruby_on_rails_example/app/helpers/application_helper.rb new file mode 100644 index 0000000..de6be79 --- /dev/null +++ b/ruby_on_rails_example/app/helpers/application_helper.rb @@ -0,0 +1,2 @@ +module ApplicationHelper +end diff --git a/ruby_on_rails_example/app/helpers/example_helper.rb b/ruby_on_rails_example/app/helpers/example_helper.rb new file mode 100644 index 0000000..193c4df --- /dev/null +++ b/ruby_on_rails_example/app/helpers/example_helper.rb @@ -0,0 +1,37 @@ +module ExampleHelper + + def make_ff_client + $stdout.sync = true + logger = Logger.new $stdout + logger.level = 'info' + + + api_key = ENV['FF_API_KEY'] || 'changeme' + + client = CfClient.instance + client.init(api_key, ConfigBuilder.new.logger(logger).build) + client.wait_for_initialization + + logger.info "---- CfClient ready ----" + + client + end + + # Use this to access the CfClient.instance - it will make sure it's only instantiated once + def get_ff_client + @@ff_client ||= make_ff_client + + @@ff_client + end + + + # A helper method that gets and logs the flag state + def get_bool_flag(flag_name, target, default) + value = get_ff_client.bool_variation(flag_name, target, default) + + logger.info "FLAG %s ---> %s" % [flag_name, value] + + value + end + +end diff --git a/ruby_on_rails_example/app/javascript/application.js b/ruby_on_rails_example/app/javascript/application.js new file mode 100644 index 0000000..0d7b494 --- /dev/null +++ b/ruby_on_rails_example/app/javascript/application.js @@ -0,0 +1,3 @@ +// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails +import "@hotwired/turbo-rails" +import "controllers" diff --git a/ruby_on_rails_example/app/javascript/controllers/application.js b/ruby_on_rails_example/app/javascript/controllers/application.js new file mode 100644 index 0000000..1213e85 --- /dev/null +++ b/ruby_on_rails_example/app/javascript/controllers/application.js @@ -0,0 +1,9 @@ +import { Application } from "@hotwired/stimulus" + +const application = Application.start() + +// Configure Stimulus development experience +application.debug = false +window.Stimulus = application + +export { application } diff --git a/ruby_on_rails_example/app/javascript/controllers/hello_controller.js b/ruby_on_rails_example/app/javascript/controllers/hello_controller.js new file mode 100644 index 0000000..5975c07 --- /dev/null +++ b/ruby_on_rails_example/app/javascript/controllers/hello_controller.js @@ -0,0 +1,7 @@ +import { Controller } from "@hotwired/stimulus" + +export default class extends Controller { + connect() { + this.element.textContent = "Hello World!" + } +} diff --git a/ruby_on_rails_example/app/javascript/controllers/index.js b/ruby_on_rails_example/app/javascript/controllers/index.js new file mode 100644 index 0000000..54ad4ca --- /dev/null +++ b/ruby_on_rails_example/app/javascript/controllers/index.js @@ -0,0 +1,11 @@ +// Import and register all your controllers from the importmap under controllers/* + +import { application } from "controllers/application" + +// Eager load all controllers defined in the import map under controllers/**/*_controller +import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading" +eagerLoadControllersFrom("controllers", application) + +// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!) +// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading" +// lazyLoadControllersFrom("controllers", application) diff --git a/ruby_on_rails_example/app/jobs/application_job.rb b/ruby_on_rails_example/app/jobs/application_job.rb new file mode 100644 index 0000000..d394c3d --- /dev/null +++ b/ruby_on_rails_example/app/jobs/application_job.rb @@ -0,0 +1,7 @@ +class ApplicationJob < ActiveJob::Base + # Automatically retry jobs that encountered a deadlock + # retry_on ActiveRecord::Deadlocked + + # Most jobs are safe to ignore if the underlying records are no longer available + # discard_on ActiveJob::DeserializationError +end diff --git a/ruby_on_rails_example/app/mailers/application_mailer.rb b/ruby_on_rails_example/app/mailers/application_mailer.rb new file mode 100644 index 0000000..3c34c81 --- /dev/null +++ b/ruby_on_rails_example/app/mailers/application_mailer.rb @@ -0,0 +1,4 @@ +class ApplicationMailer < ActionMailer::Base + default from: "from@example.com" + layout "mailer" +end diff --git a/ruby_on_rails_example/app/models/application_record.rb b/ruby_on_rails_example/app/models/application_record.rb new file mode 100644 index 0000000..b63caeb --- /dev/null +++ b/ruby_on_rails_example/app/models/application_record.rb @@ -0,0 +1,3 @@ +class ApplicationRecord < ActiveRecord::Base + primary_abstract_class +end diff --git a/ruby_on_rails_example/app/models/concerns/.keep b/ruby_on_rails_example/app/models/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/app/views/example/index.html.erb b/ruby_on_rails_example/app/views/example/index.html.erb new file mode 100644 index 0000000..05f58e8 --- /dev/null +++ b/ruby_on_rails_example/app/views/example/index.html.erb @@ -0,0 +1,4 @@ +

Ruby on Rails FF Example

+ +

Flag "<%= @flag_name %>" is <%= get_bool_flag(@flag_name, @target, false) %>

+

(server example - refresh page to update)

diff --git a/ruby_on_rails_example/app/views/layouts/application.html.erb b/ruby_on_rails_example/app/views/layouts/application.html.erb new file mode 100644 index 0000000..b95c43c --- /dev/null +++ b/ruby_on_rails_example/app/views/layouts/application.html.erb @@ -0,0 +1,16 @@ + + + + FfSdkExample + + <%= csrf_meta_tags %> + <%= csp_meta_tag %> + + <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %> + <%= javascript_importmap_tags %> + + + + <%= yield %> + + diff --git a/ruby_on_rails_example/app/views/layouts/mailer.html.erb b/ruby_on_rails_example/app/views/layouts/mailer.html.erb new file mode 100644 index 0000000..cbd34d2 --- /dev/null +++ b/ruby_on_rails_example/app/views/layouts/mailer.html.erb @@ -0,0 +1,13 @@ + + + + + + + + + <%= yield %> + + diff --git a/ruby_on_rails_example/app/views/layouts/mailer.text.erb b/ruby_on_rails_example/app/views/layouts/mailer.text.erb new file mode 100644 index 0000000..37f0bdd --- /dev/null +++ b/ruby_on_rails_example/app/views/layouts/mailer.text.erb @@ -0,0 +1 @@ +<%= yield %> diff --git a/ruby_on_rails_example/bin/rails b/ruby_on_rails_example/bin/rails new file mode 100755 index 0000000..efc0377 --- /dev/null +++ b/ruby_on_rails_example/bin/rails @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +APP_PATH = File.expand_path("../config/application", __dir__) +require_relative "../config/boot" +require "rails/commands" diff --git a/ruby_on_rails_example/bin/rake b/ruby_on_rails_example/bin/rake new file mode 100755 index 0000000..4fbf10b --- /dev/null +++ b/ruby_on_rails_example/bin/rake @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +require_relative "../config/boot" +require "rake" +Rake.application.run diff --git a/ruby_on_rails_example/bin/setup b/ruby_on_rails_example/bin/setup new file mode 100755 index 0000000..ec47b79 --- /dev/null +++ b/ruby_on_rails_example/bin/setup @@ -0,0 +1,33 @@ +#!/usr/bin/env ruby +require "fileutils" + +# path to your application root. +APP_ROOT = File.expand_path("..", __dir__) + +def system!(*args) + system(*args) || abort("\n== Command #{args} failed ==") +end + +FileUtils.chdir APP_ROOT do + # This script is a way to set up or update your development environment automatically. + # This script is idempotent, so that you can run it at any time and get an expectable outcome. + # Add necessary setup steps to this file. + + puts "== Installing dependencies ==" + system! "gem install bundler --conservative" + system("bundle check") || system!("bundle install") + + # puts "\n== Copying sample files ==" + # unless File.exist?("config/database.yml") + # FileUtils.cp "config/database.yml.sample", "config/database.yml" + # end + + puts "\n== Preparing database ==" + system! "bin/rails db:prepare" + + puts "\n== Removing old logs and tempfiles ==" + system! "bin/rails log:clear tmp:clear" + + puts "\n== Restarting application server ==" + system! "bin/rails restart" +end diff --git a/ruby_on_rails_example/config.ru b/ruby_on_rails_example/config.ru new file mode 100644 index 0000000..4a3c09a --- /dev/null +++ b/ruby_on_rails_example/config.ru @@ -0,0 +1,6 @@ +# This file is used by Rack-based servers to start the application. + +require_relative "config/environment" + +run Rails.application +Rails.application.load_server diff --git a/ruby_on_rails_example/config/application.rb b/ruby_on_rails_example/config/application.rb new file mode 100644 index 0000000..02d83bf --- /dev/null +++ b/ruby_on_rails_example/config/application.rb @@ -0,0 +1,22 @@ +require_relative "boot" + +require "rails/all" + +# Require the gems listed in Gemfile, including any gems +# you've limited to :test, :development, or :production. +Bundler.require(*Rails.groups) + +module FfSdkExample + class Application < Rails::Application + # Initialize configuration defaults for originally generated Rails version. + config.load_defaults 7.0 + + # Configuration for the application, engines, and railties goes here. + # + # These settings can be overridden in specific environments using the files + # in config/environments, which are processed later. + # + # config.time_zone = "Central Time (US & Canada)" + # config.eager_load_paths << Rails.root.join("extras") + end +end diff --git a/ruby_on_rails_example/config/boot.rb b/ruby_on_rails_example/config/boot.rb new file mode 100644 index 0000000..988a5dd --- /dev/null +++ b/ruby_on_rails_example/config/boot.rb @@ -0,0 +1,4 @@ +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +require "bundler/setup" # Set up gems listed in the Gemfile. +require "bootsnap/setup" # Speed up boot time by caching expensive operations. diff --git a/ruby_on_rails_example/config/cable.yml b/ruby_on_rails_example/config/cable.yml new file mode 100644 index 0000000..4707539 --- /dev/null +++ b/ruby_on_rails_example/config/cable.yml @@ -0,0 +1,11 @@ +development: + adapter: redis + url: redis://localhost:6379/1 + +test: + adapter: test + +production: + adapter: redis + url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %> + channel_prefix: ff_sdk_example_production diff --git a/ruby_on_rails_example/config/database.yml b/ruby_on_rails_example/config/database.yml new file mode 100644 index 0000000..fcba57f --- /dev/null +++ b/ruby_on_rails_example/config/database.yml @@ -0,0 +1,25 @@ +# SQLite. Versions 3.8.0 and up are supported. +# gem install sqlite3 +# +# Ensure the SQLite 3 gem is defined in your Gemfile +# gem "sqlite3" +# +default: &default + adapter: sqlite3 + pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> + timeout: 5000 + +development: + <<: *default + database: db/development.sqlite3 + +# Warning: The database defined as "test" will be erased and +# re-generated from your development database when you run "rake". +# Do not set this db to the same as development or production. +test: + <<: *default + database: db/test.sqlite3 + +production: + <<: *default + database: db/production.sqlite3 diff --git a/ruby_on_rails_example/config/environment.rb b/ruby_on_rails_example/config/environment.rb new file mode 100644 index 0000000..cac5315 --- /dev/null +++ b/ruby_on_rails_example/config/environment.rb @@ -0,0 +1,5 @@ +# Load the Rails application. +require_relative "application" + +# Initialize the Rails application. +Rails.application.initialize! diff --git a/ruby_on_rails_example/config/environments/development.rb b/ruby_on_rails_example/config/environments/development.rb new file mode 100644 index 0000000..8500f45 --- /dev/null +++ b/ruby_on_rails_example/config/environments/development.rb @@ -0,0 +1,70 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # In the development environment your application's code is reloaded any time + # it changes. This slows down response time but is perfect for development + # since you don't have to restart the web server when you make code changes. + config.cache_classes = false + + # Do not eager load code on boot. + config.eager_load = false + + # Show full error reports. + config.consider_all_requests_local = true + + # Enable server timing + config.server_timing = true + + # Enable/disable caching. By default caching is disabled. + # Run rails dev:cache to toggle caching. + if Rails.root.join("tmp/caching-dev.txt").exist? + config.action_controller.perform_caching = true + config.action_controller.enable_fragment_cache_logging = true + + config.cache_store = :memory_store + config.public_file_server.headers = { + "Cache-Control" => "public, max-age=#{2.days.to_i}" + } + else + config.action_controller.perform_caching = false + + config.cache_store = :null_store + end + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Don't care if the mailer can't send. + config.action_mailer.raise_delivery_errors = false + + config.action_mailer.perform_caching = false + + # Print deprecation notices to the Rails logger. + config.active_support.deprecation = :log + + # Raise exceptions for disallowed deprecations. + config.active_support.disallowed_deprecation = :raise + + # Tell Active Support which deprecation messages to disallow. + config.active_support.disallowed_deprecation_warnings = [] + + # Raise an error on page load if there are pending migrations. + config.active_record.migration_error = :page_load + + # Highlight code that triggered database queries in logs. + config.active_record.verbose_query_logs = true + + # Suppress logger output for asset requests. + config.assets.quiet = true + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + # config.action_view.annotate_rendered_view_with_filenames = true + + # Uncomment if you wish to allow Action Cable access from any origin. + # config.action_cable.disable_request_forgery_protection = true +end diff --git a/ruby_on_rails_example/config/environments/production.rb b/ruby_on_rails_example/config/environments/production.rb new file mode 100644 index 0000000..2d8c349 --- /dev/null +++ b/ruby_on_rails_example/config/environments/production.rb @@ -0,0 +1,93 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # Code is not reloaded between requests. + config.cache_classes = true + + # Eager load code on boot. This eager loads most of Rails and + # your application in memory, allowing both threaded web servers + # and those relying on copy on write to perform better. + # Rake tasks automatically ignore this option for performance. + config.eager_load = true + + # Full error reports are disabled and caching is turned on. + config.consider_all_requests_local = false + config.action_controller.perform_caching = true + + # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"] + # or in config/master.key. This key is used to decrypt credentials (and other encrypted files). + # config.require_master_key = true + + # Disable serving static files from the `/public` folder by default since + # Apache or NGINX already handles this. + config.public_file_server.enabled = ENV["RAILS_SERVE_STATIC_FILES"].present? + + # Compress CSS using a preprocessor. + # config.assets.css_compressor = :sass + + # Do not fallback to assets pipeline if a precompiled asset is missed. + config.assets.compile = false + + # Enable serving of images, stylesheets, and JavaScripts from an asset server. + # config.asset_host = "http://assets.example.com" + + # Specifies the header that your server uses for sending files. + # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache + # config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Mount Action Cable outside main process or domain. + # config.action_cable.mount_path = nil + # config.action_cable.url = "wss://example.com/cable" + # config.action_cable.allowed_request_origins = [ "http://example.com", /http:\/\/example.*/ ] + + # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. + # config.force_ssl = true + + # Include generic and useful information about system operation, but avoid logging too much + # information to avoid inadvertent exposure of personally identifiable information (PII). + config.log_level = :info + + # Prepend all log lines with the following tags. + config.log_tags = [ :request_id ] + + # Use a different cache store in production. + # config.cache_store = :mem_cache_store + + # Use a real queuing backend for Active Job (and separate queues per environment). + # config.active_job.queue_adapter = :resque + # config.active_job.queue_name_prefix = "ff_sdk_example_production" + + config.action_mailer.perform_caching = false + + # Ignore bad email addresses and do not raise email delivery errors. + # Set this to true and configure the email server for immediate delivery to raise delivery errors. + # config.action_mailer.raise_delivery_errors = false + + # Enable locale fallbacks for I18n (makes lookups for any locale fall back to + # the I18n.default_locale when a translation cannot be found). + config.i18n.fallbacks = true + + # Don't log any deprecations. + config.active_support.report_deprecations = false + + # Use default logging formatter so that PID and timestamp are not suppressed. + config.log_formatter = ::Logger::Formatter.new + + # Use a different logger for distributed setups. + # require "syslog/logger" + # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new "app-name") + + if ENV["RAILS_LOG_TO_STDOUT"].present? + logger = ActiveSupport::Logger.new(STDOUT) + logger.formatter = config.log_formatter + config.logger = ActiveSupport::TaggedLogging.new(logger) + end + + # Do not dump schema after migrations. + config.active_record.dump_schema_after_migration = false +end diff --git a/ruby_on_rails_example/config/environments/test.rb b/ruby_on_rails_example/config/environments/test.rb new file mode 100644 index 0000000..6ea4d1e --- /dev/null +++ b/ruby_on_rails_example/config/environments/test.rb @@ -0,0 +1,60 @@ +require "active_support/core_ext/integer/time" + +# The test environment is used exclusively to run your application's +# test suite. You never need to work with it otherwise. Remember that +# your test database is "scratch space" for the test suite and is wiped +# and recreated between test runs. Don't rely on the data there! + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # Turn false under Spring and add config.action_view.cache_template_loading = true. + config.cache_classes = true + + # Eager loading loads your whole application. When running a single test locally, + # this probably isn't necessary. It's a good idea to do in a continuous integration + # system, or in some way before deploying your code. + config.eager_load = ENV["CI"].present? + + # Configure public file server for tests with Cache-Control for performance. + config.public_file_server.enabled = true + config.public_file_server.headers = { + "Cache-Control" => "public, max-age=#{1.hour.to_i}" + } + + # Show full error reports and disable caching. + config.consider_all_requests_local = true + config.action_controller.perform_caching = false + config.cache_store = :null_store + + # Raise exceptions instead of rendering exception templates. + config.action_dispatch.show_exceptions = false + + # Disable request forgery protection in test environment. + config.action_controller.allow_forgery_protection = false + + # Store uploaded files on the local file system in a temporary directory. + config.active_storage.service = :test + + config.action_mailer.perform_caching = false + + # Tell Action Mailer not to deliver emails to the real world. + # The :test delivery method accumulates sent emails in the + # ActionMailer::Base.deliveries array. + config.action_mailer.delivery_method = :test + + # Print deprecation notices to the stderr. + config.active_support.deprecation = :stderr + + # Raise exceptions for disallowed deprecations. + config.active_support.disallowed_deprecation = :raise + + # Tell Active Support which deprecation messages to disallow. + config.active_support.disallowed_deprecation_warnings = [] + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + # config.action_view.annotate_rendered_view_with_filenames = true +end diff --git a/ruby_on_rails_example/config/importmap.rb b/ruby_on_rails_example/config/importmap.rb new file mode 100644 index 0000000..8dce42d --- /dev/null +++ b/ruby_on_rails_example/config/importmap.rb @@ -0,0 +1,7 @@ +# Pin npm packages by running ./bin/importmap + +pin "application", preload: true +pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true +pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true +pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true +pin_all_from "app/javascript/controllers", under: "controllers" diff --git a/ruby_on_rails_example/config/initializers/assets.rb b/ruby_on_rails_example/config/initializers/assets.rb new file mode 100644 index 0000000..2eeef96 --- /dev/null +++ b/ruby_on_rails_example/config/initializers/assets.rb @@ -0,0 +1,12 @@ +# Be sure to restart your server when you modify this file. + +# Version of your assets, change this if you want to expire all your assets. +Rails.application.config.assets.version = "1.0" + +# Add additional assets to the asset load path. +# Rails.application.config.assets.paths << Emoji.images_path + +# Precompile additional assets. +# application.js, application.css, and all non-JS/CSS in the app/assets +# folder are already added. +# Rails.application.config.assets.precompile += %w( admin.js admin.css ) diff --git a/ruby_on_rails_example/config/initializers/content_security_policy.rb b/ruby_on_rails_example/config/initializers/content_security_policy.rb new file mode 100644 index 0000000..54f47cf --- /dev/null +++ b/ruby_on_rails_example/config/initializers/content_security_policy.rb @@ -0,0 +1,25 @@ +# Be sure to restart your server when you modify this file. + +# Define an application-wide content security policy. +# See the Securing Rails Applications Guide for more information: +# https://guides.rubyonrails.org/security.html#content-security-policy-header + +# Rails.application.configure do +# config.content_security_policy do |policy| +# policy.default_src :self, :https +# policy.font_src :self, :https, :data +# policy.img_src :self, :https, :data +# policy.object_src :none +# policy.script_src :self, :https +# policy.style_src :self, :https +# # Specify URI for violation reports +# # policy.report_uri "/csp-violation-report-endpoint" +# end +# +# # Generate session nonces for permitted importmap and inline scripts +# config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s } +# config.content_security_policy_nonce_directives = %w(script-src) +# +# # Report violations without enforcing the policy. +# # config.content_security_policy_report_only = true +# end diff --git a/ruby_on_rails_example/config/initializers/filter_parameter_logging.rb b/ruby_on_rails_example/config/initializers/filter_parameter_logging.rb new file mode 100644 index 0000000..adc6568 --- /dev/null +++ b/ruby_on_rails_example/config/initializers/filter_parameter_logging.rb @@ -0,0 +1,8 @@ +# Be sure to restart your server when you modify this file. + +# Configure parameters to be filtered from the log file. Use this to limit dissemination of +# sensitive information. See the ActiveSupport::ParameterFilter documentation for supported +# notations and behaviors. +Rails.application.config.filter_parameters += [ + :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn +] diff --git a/ruby_on_rails_example/config/initializers/inflections.rb b/ruby_on_rails_example/config/initializers/inflections.rb new file mode 100644 index 0000000..3860f65 --- /dev/null +++ b/ruby_on_rails_example/config/initializers/inflections.rb @@ -0,0 +1,16 @@ +# Be sure to restart your server when you modify this file. + +# Add new inflection rules using the following format. Inflections +# are locale specific, and you may define rules for as many different +# locales as you wish. All of these examples are active by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.plural /^(ox)$/i, "\\1en" +# inflect.singular /^(ox)en/i, "\\1" +# inflect.irregular "person", "people" +# inflect.uncountable %w( fish sheep ) +# end + +# These inflection rules are supported but not enabled by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.acronym "RESTful" +# end diff --git a/ruby_on_rails_example/config/initializers/permissions_policy.rb b/ruby_on_rails_example/config/initializers/permissions_policy.rb new file mode 100644 index 0000000..00f64d7 --- /dev/null +++ b/ruby_on_rails_example/config/initializers/permissions_policy.rb @@ -0,0 +1,11 @@ +# Define an application-wide HTTP permissions policy. For further +# information see https://developers.google.com/web/updates/2018/06/feature-policy +# +# Rails.application.config.permissions_policy do |f| +# f.camera :none +# f.gyroscope :none +# f.microphone :none +# f.usb :none +# f.fullscreen :self +# f.payment :self, "https://secure.example.com" +# end diff --git a/ruby_on_rails_example/config/locales/en.yml b/ruby_on_rails_example/config/locales/en.yml new file mode 100644 index 0000000..8ca56fc --- /dev/null +++ b/ruby_on_rails_example/config/locales/en.yml @@ -0,0 +1,33 @@ +# Files in the config/locales directory are used for internationalization +# and are automatically loaded by Rails. If you want to use locales other +# than English, add the necessary files in this directory. +# +# To use the locales, use `I18n.t`: +# +# I18n.t "hello" +# +# In views, this is aliased to just `t`: +# +# <%= t("hello") %> +# +# To use a different locale, set it with `I18n.locale`: +# +# I18n.locale = :es +# +# This would use the information in config/locales/es.yml. +# +# The following keys must be escaped otherwise they will not be retrieved by +# the default I18n backend: +# +# true, false, on, off, yes, no +# +# Instead, surround them with single quotes. +# +# en: +# "true": "foo" +# +# To learn more, please read the Rails Internationalization guide +# available at https://guides.rubyonrails.org/i18n.html. + +en: + hello: "Hello world" diff --git a/ruby_on_rails_example/config/puma.rb b/ruby_on_rails_example/config/puma.rb new file mode 100644 index 0000000..daaf036 --- /dev/null +++ b/ruby_on_rails_example/config/puma.rb @@ -0,0 +1,43 @@ +# Puma can serve each request in a thread from an internal thread pool. +# The `threads` method setting takes two numbers: a minimum and maximum. +# Any libraries that use thread pools should be configured to match +# the maximum value specified for Puma. Default is set to 5 threads for minimum +# and maximum; this matches the default thread size of Active Record. +# +max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 } +min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count } +threads min_threads_count, max_threads_count + +# Specifies the `worker_timeout` threshold that Puma will use to wait before +# terminating a worker in development environments. +# +worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development" + +# Specifies the `port` that Puma will listen on to receive requests; default is 3000. +# +port ENV.fetch("PORT") { 3000 } + +# Specifies the `environment` that Puma will run in. +# +environment ENV.fetch("RAILS_ENV") { "development" } + +# Specifies the `pidfile` that Puma will use. +pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" } + +# Specifies the number of `workers` to boot in clustered mode. +# Workers are forked web server processes. If using threads and workers together +# the concurrency of the application would be max `threads` * `workers`. +# Workers do not work on JRuby or Windows (both of which do not support +# processes). +# +# workers ENV.fetch("WEB_CONCURRENCY") { 2 } + +# Use the `preload_app!` method when specifying a `workers` number. +# This directive tells Puma to first boot the application and load code +# before forking the application. This takes advantage of Copy On Write +# process behavior so workers use less memory. +# +# preload_app! + +# Allow puma to be restarted by `bin/rails restart` command. +plugin :tmp_restart diff --git a/ruby_on_rails_example/config/routes.rb b/ruby_on_rails_example/config/routes.rb new file mode 100644 index 0000000..8330a65 --- /dev/null +++ b/ruby_on_rails_example/config/routes.rb @@ -0,0 +1,8 @@ +Rails.application.routes.draw do + # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html + + # Defines the root path route ("/") + # root "articles#index" + + root 'example#index' +end diff --git a/ruby_on_rails_example/config/storage.yml b/ruby_on_rails_example/config/storage.yml new file mode 100644 index 0000000..4942ab6 --- /dev/null +++ b/ruby_on_rails_example/config/storage.yml @@ -0,0 +1,34 @@ +test: + service: Disk + root: <%= Rails.root.join("tmp/storage") %> + +local: + service: Disk + root: <%= Rails.root.join("storage") %> + +# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key) +# amazon: +# service: S3 +# access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %> +# secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %> +# region: us-east-1 +# bucket: your_own_bucket-<%= Rails.env %> + +# Remember not to checkin your GCS keyfile to a repository +# google: +# service: GCS +# project: your_project +# credentials: <%= Rails.root.join("path/to/gcs.keyfile") %> +# bucket: your_own_bucket-<%= Rails.env %> + +# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key) +# microsoft: +# service: AzureStorage +# storage_account_name: your_account_name +# storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %> +# container: your_container_name-<%= Rails.env %> + +# mirror: +# service: Mirror +# primary: local +# mirrors: [ amazon, google, microsoft ] diff --git a/ruby_on_rails_example/lib/assets/.keep b/ruby_on_rails_example/lib/assets/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/lib/tasks/.keep b/ruby_on_rails_example/lib/tasks/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/log/.keep b/ruby_on_rails_example/log/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/storage/.keep b/ruby_on_rails_example/storage/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/test/application_system_test_case.rb b/ruby_on_rails_example/test/application_system_test_case.rb new file mode 100644 index 0000000..d19212a --- /dev/null +++ b/ruby_on_rails_example/test/application_system_test_case.rb @@ -0,0 +1,5 @@ +require "test_helper" + +class ApplicationSystemTestCase < ActionDispatch::SystemTestCase + driven_by :selenium, using: :chrome, screen_size: [1400, 1400] +end diff --git a/ruby_on_rails_example/test/channels/application_cable/connection_test.rb b/ruby_on_rails_example/test/channels/application_cable/connection_test.rb new file mode 100644 index 0000000..800405f --- /dev/null +++ b/ruby_on_rails_example/test/channels/application_cable/connection_test.rb @@ -0,0 +1,11 @@ +require "test_helper" + +class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase + # test "connects with cookies" do + # cookies.signed[:user_id] = 42 + # + # connect + # + # assert_equal connection.user_id, "42" + # end +end diff --git a/ruby_on_rails_example/test/controllers/.keep b/ruby_on_rails_example/test/controllers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/test/fixtures/files/.keep b/ruby_on_rails_example/test/fixtures/files/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/test/helpers/.keep b/ruby_on_rails_example/test/helpers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/test/integration/.keep b/ruby_on_rails_example/test/integration/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/test/mailers/.keep b/ruby_on_rails_example/test/mailers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/test/models/.keep b/ruby_on_rails_example/test/models/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/test/system/.keep b/ruby_on_rails_example/test/system/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/test/test_helper.rb b/ruby_on_rails_example/test/test_helper.rb new file mode 100644 index 0000000..d713e37 --- /dev/null +++ b/ruby_on_rails_example/test/test_helper.rb @@ -0,0 +1,13 @@ +ENV["RAILS_ENV"] ||= "test" +require_relative "../config/environment" +require "rails/test_help" + +class ActiveSupport::TestCase + # Run tests in parallel with specified workers + parallelize(workers: :number_of_processors) + + # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order. + fixtures :all + + # Add more helper methods to be used by all tests here... +end diff --git a/ruby_on_rails_example/vendor/.keep b/ruby_on_rails_example/vendor/.keep new file mode 100644 index 0000000..e69de29 diff --git a/ruby_on_rails_example/vendor/javascript/.keep b/ruby_on_rails_example/vendor/javascript/.keep new file mode 100644 index 0000000..e69de29