From 51f4556ede952a1a527577f5a950692266c82cb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Mon, 15 Jan 2024 19:41:30 +0300 Subject: [PATCH 1/5] Refactor admin settings routes This is much cleaner, and semantically more correct. --- .../settings/registrations_controller.rb | 4 +- .../admin/settings/services_controller.rb | 29 ++++++++++---- app/controllers/admin/settings_controller.rb | 2 +- .../{index.html.erb => show.html.erb} | 2 +- .../{index.html.erb => show.html.erb} | 4 +- .../shared/_admin_sidenav_settings.html.erb | 4 +- .../_admin_sidenav_settings_services.html.erb | 40 +++++++++---------- config/routes.rb | 4 +- spec/features/admin/settings_spec.rb | 12 +++--- 9 files changed, 56 insertions(+), 45 deletions(-) rename app/views/admin/settings/registrations/{index.html.erb => show.html.erb} (97%) rename app/views/admin/settings/services/{index.html.erb => show.html.erb} (85%) diff --git a/app/controllers/admin/settings/registrations_controller.rb b/app/controllers/admin/settings/registrations_controller.rb index 1d888a5..4c6cb83 100644 --- a/app/controllers/admin/settings/registrations_controller.rb +++ b/app/controllers/admin/settings/registrations_controller.rb @@ -1,8 +1,8 @@ class Admin::Settings::RegistrationsController < Admin::SettingsController - def index + def show end - def create + def update update_settings redirect_to admin_settings_registrations_path, flash: { diff --git a/app/controllers/admin/settings/services_controller.rb b/app/controllers/admin/settings/services_controller.rb index a228f5e..95a01b3 100644 --- a/app/controllers/admin/settings/services_controller.rb +++ b/app/controllers/admin/settings/services_controller.rb @@ -1,19 +1,32 @@ class Admin::Settings::ServicesController < Admin::SettingsController - def index - @service = params[:s] + before_action :set_service, only: [:show, :update] - if @service.blank? - redirect_to admin_settings_services_path(params: { s: "btcpay" }) - end + def index + redirect_to admin_settings_service_path("btcpay") end - def create - service = params.require(:service) + def show + end + def update update_settings - redirect_to admin_settings_services_path(params: { s: service }), flash: { + redirect_to admin_settings_service_path(@service), flash: { success: "Settings saved" } end + + private + + def set_subsection + @subsection = "services" + end + + def set_service + @service = params[:service] + + if @service.blank? + redirect_to admin_settings_services_path and return + end + end end diff --git a/app/controllers/admin/settings_controller.rb b/app/controllers/admin/settings_controller.rb index 8a168b1..0ac029b 100644 --- a/app/controllers/admin/settings_controller.rb +++ b/app/controllers/admin/settings_controller.rb @@ -20,7 +20,7 @@ class Admin::SettingsController < Admin::BaseController end if @errors.any? - render :index and return + render :show and return end changed_keys.each do |key| diff --git a/app/views/admin/settings/registrations/index.html.erb b/app/views/admin/settings/registrations/show.html.erb similarity index 97% rename from app/views/admin/settings/registrations/index.html.erb rename to app/views/admin/settings/registrations/show.html.erb index 90b67af..0028c15 100644 --- a/app/views/admin/settings/registrations/index.html.erb +++ b/app/views/admin/settings/registrations/show.html.erb @@ -1,7 +1,7 @@ <%= render HeaderComponent.new(title: "Settings") %> <%= render MainWithSidenavComponent.new(sidenav_partial: 'shared/admin_sidenav_settings') do %> - <%= form_for(Setting.new, url: admin_settings_registrations_path) do |f| %> + <%= form_for(Setting.new, url: admin_settings_registrations_path, method: :put) do |f| %>

Registrations

diff --git a/app/views/admin/settings/services/index.html.erb b/app/views/admin/settings/services/show.html.erb similarity index 85% rename from app/views/admin/settings/services/index.html.erb rename to app/views/admin/settings/services/show.html.erb index f63653d..97db9dc 100644 --- a/app/views/admin/settings/services/index.html.erb +++ b/app/views/admin/settings/services/show.html.erb @@ -1,9 +1,7 @@ <%= render HeaderComponent.new(title: "Settings") %> <%= render MainWithSidenavComponent.new(sidenav_partial: 'shared/admin_sidenav_settings') do %> - <%= form_for(Setting.new, url: admin_settings_services_path) do |f| %> - <%= hidden_field_tag :service, @service %> - + <%= form_for(Setting.new, url: admin_settings_service_path(@service), method: :put) do |f| %> <% if @errors && @errors.any? %>
<%= render partial: "admin/settings/errors", locals: { errors: @errors } %> diff --git a/app/views/shared/_admin_sidenav_settings.html.erb b/app/views/shared/_admin_sidenav_settings.html.erb index 387cd9b..48c5ced 100644 --- a/app/views/shared/_admin_sidenav_settings.html.erb +++ b/app/views/shared/_admin_sidenav_settings.html.erb @@ -4,9 +4,9 @@ ) %> <%= render SidenavLinkComponent.new( name: "Services", path: admin_settings_services_path, icon: "grid", - active: current_page?(admin_settings_services_path) + active: controller_name == "services" ) %> -<% if current_page?(admin_settings_services_path) %> +<% if controller_name == "services" %> <%= render partial: "shared/admin_sidenav_settings_services" %> <% end %> <%= render SidenavLinkComponent.new( diff --git a/app/views/shared/_admin_sidenav_settings_services.html.erb b/app/views/shared/_admin_sidenav_settings_services.html.erb index a69f3cc..ae0fe21 100644 --- a/app/views/shared/_admin_sidenav_settings_services.html.erb +++ b/app/views/shared/_admin_sidenav_settings_services.html.erb @@ -1,23 +1,23 @@ <%= render SidenavLinkComponent.new( level: 2, name: "BTCPay", - path: admin_settings_services_path(params: { s: "btcpay" }), + path: admin_settings_service_path("btcpay"), text_icon: Setting.btcpay_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "btcpay" })), + active: current_page?(admin_settings_service_path("btcpay")), ) %> <%= render SidenavLinkComponent.new( level: 2, name: "Discourse", - path: admin_settings_services_path(params: { s: "discourse" }), + path: admin_settings_service_path("discourse"), text_icon: Setting.discourse_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "discourse" })), + active: current_page?(admin_settings_service_path("discourse")), ) %> <%= render SidenavLinkComponent.new( level: 2, name: "Drone CI", - path: admin_settings_services_path(params: { s: "droneci" }), + path: admin_settings_service_path("droneci"), text_icon: Setting.droneci_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "droneci" })), + active: current_page?(admin_settings_service_path("droneci")), ) %> <%= render SidenavLinkComponent.new( level: 2, @@ -29,49 +29,49 @@ <%= render SidenavLinkComponent.new( level: 2, name: "ejabberd", - path: admin_settings_services_path(params: { s: "ejabberd" }), + path: admin_settings_service_path("ejabberd"), text_icon: Setting.ejabberd_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "ejabberd" })), + active: current_page?(admin_settings_service_path("ejabberd")), ) %> <%= render SidenavLinkComponent.new( level: 2, name: "Gitea", - path: admin_settings_services_path(params: { s: "gitea" }), + path: admin_settings_service_path("gitea"), text_icon: Setting.gitea_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "gitea" })), + active: current_page?(admin_settings_service_path("gitea")), ) %> <%= render SidenavLinkComponent.new( level: 2, name: "LNDHub", - path: admin_settings_services_path(params: { s: "lndhub" }), + path: admin_settings_service_path("lndhub"), text_icon: Setting.lndhub_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "lndhub" })), + active: current_page?(admin_settings_service_path("lndhub")), ) %> <%= render SidenavLinkComponent.new( level: 2, name: "Mastodon", - path: admin_settings_services_path(params: { s: "mastodon" }), + path: admin_settings_service_path("mastodon"), text_icon: Setting.mastodon_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "mastodon" })), + active: current_page?(admin_settings_service_path("mastodon")), ) %> <%= render SidenavLinkComponent.new( level: 2, name: "MediaWiki", - path: admin_settings_services_path(params: { s: "mediawiki" }), + path: admin_settings_service_path("mediawiki"), text_icon: Setting.mediawiki_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "mediawiki" })), + active: current_page?(admin_settings_service_path("mediawiki")), ) %> <%= render SidenavLinkComponent.new( level: 2, name: "Nostr", - path: admin_settings_services_path(params: { s: "nostr" }), + path: admin_settings_service_path("nostr"), text_icon: Setting.nostr_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "nostr" })), + active: current_page?(admin_settings_service_path("nostr")), ) %> <%= render SidenavLinkComponent.new( level: 2, name: "RemoteStorage", - path: admin_settings_services_path(params: { s: "remotestorage" }), + path: admin_settings_service_path("remotestorage"), text_icon: Setting.remotestorage_enabled? ? "◉" : "○", - active: current_page?(admin_settings_services_path(params: { s: "remotestorage" })), + active: current_page?(admin_settings_service_path("remotestorage")), ) %> diff --git a/config/routes.rb b/config/routes.rb index 39e69f2..13c1694 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -93,8 +93,8 @@ Rails.application.routes.draw do end namespace :settings do - resources 'registrations', only: ['index', 'create'] - resources 'services', only: ['index', 'create'] + resource 'registrations', only: ['show', 'update'] + resources 'services', param: 'service', only: ['index', 'show', 'update'] end end diff --git a/spec/features/admin/settings_spec.rb b/spec/features/admin/settings_spec.rb index 01a43f4..91d8ffe 100644 --- a/spec/features/admin/settings_spec.rb +++ b/spec/features/admin/settings_spec.rb @@ -23,35 +23,35 @@ RSpec.describe 'Admin/global settings', type: :feature do scenario "Opening service settings shows page for first service" do visit admin_settings_services_path - expect(current_url).to eq(admin_settings_services_url(params: { s: "btcpay" })) + expect(current_url).to eq(admin_settings_service_url("btcpay")) end scenario "View service settings" do - visit admin_settings_services_path(params: { s: "ejabberd" }) + visit admin_settings_service_path("ejabberd") expect(page).to have_content("Enable ejabberd integration") expect(page).to have_field("API URL", with: "http://xmpp.example.com/api") end scenario "Disable a service integration" do - visit admin_settings_services_path(params: { s: "ejabberd" }) + visit admin_settings_service_path("ejabberd") expect(page).to have_checked_field("setting[ejabberd_enabled]") uncheck "setting[ejabberd_enabled]" click_button "Save" - expect(current_url).to eq(admin_settings_services_url(params: { s: "ejabberd" })) + expect(current_url).to eq(admin_settings_service_url("ejabberd")) expect(page).to_not have_checked_field("setting[ejabberd_enabled]") expect(page).to_not have_field("API URL", disabled: true) end scenario "Resettable fields" do - visit admin_settings_services_path(params: { s: "ejabberd" }) + visit admin_settings_service_path("ejabberd") expect(page).to have_field("API URL", with: "http://xmpp.example.com/api") expect(page).to_not have_css('input#setting_ejabberd_api_url+button') Setting.ejabberd_api_url = "http://example.com/foo" - visit admin_settings_services_path(params: { s: "ejabberd" }) + visit admin_settings_service_path("ejabberd") expect(page).to have_field("API URL", with: "http://example.com/foo") expect(page).to have_css('input#setting_ejabberd_api_url+button') end From c312e30c17fa7c29e871315b6bb61d235d9e7262 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Sat, 2 Mar 2024 15:26:12 +0100 Subject: [PATCH 2/5] Fix link in admin settings/services sidenav --- app/views/shared/_admin_sidenav_settings_services.html.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/shared/_admin_sidenav_settings_services.html.erb b/app/views/shared/_admin_sidenav_settings_services.html.erb index ae0fe21..e4ab082 100644 --- a/app/views/shared/_admin_sidenav_settings_services.html.erb +++ b/app/views/shared/_admin_sidenav_settings_services.html.erb @@ -22,7 +22,7 @@ <%= render SidenavLinkComponent.new( level: 2, name: "E-Mail", - path: admin_settings_services_path(params: { s: "email" }), + path: admin_settings_service_path("email"), text_icon: Setting.email_enabled? ? "◉" : "○", active: current_page?(admin_settings_services_path(params: { s: "email" })), ) %> From 1afd56fb80612fe244123bc4946d2ebc299a9650 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Sat, 2 Mar 2024 16:56:07 +0100 Subject: [PATCH 3/5] Allow running specs in Docker (Web) container --- config/environments/test.rb | 5 ++--- spec/requests/webfinger_spec.rb | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/config/environments/test.rb b/config/environments/test.rb index a459967..65473dd 100644 --- a/config/environments/test.rb +++ b/config/environments/test.rb @@ -52,10 +52,9 @@ Rails.application.configure do config.active_job.queue_adapter = :test - if ENV["S3_ENABLED"] + if ENV["S3_ENABLED"] && ENV["S3_ENABLED"].to_s != "false" config.active_storage.service = :s3 else - # Store attachments on the local disk (in ./tmp) - config.active_storage.service = :test + config.active_storage.service = :local end end diff --git a/spec/requests/webfinger_spec.rb b/spec/requests/webfinger_spec.rb index 1dcdfa3..27cd361 100644 --- a/spec/requests/webfinger_spec.rb +++ b/spec/requests/webfinger_spec.rb @@ -15,7 +15,7 @@ RSpec.describe "WebFinger", type: :request do res = JSON.parse(response.body) rs_link = res["links"].find {|l| l["rel"] == "http://tools.ietf.org/id/draft-dejong-remotestorage"} - expect(rs_link["href"]).to eql("https://storage.kosmos.org/tony") + expect(rs_link["href"]).to eql("#{Setting.rs_storage_url}/tony") oauth_url = rs_link["properties"]["http://tools.ietf.org/html/rfc6749#section-4.2"] expect(oauth_url).to eql("http://www.example.com/rs/oauth/tony") From f57edd4d3ba481791d4562e8688b8b09544fa213 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Sat, 2 Mar 2024 16:57:07 +0100 Subject: [PATCH 4/5] Update README to account for Docker Compose everywhere --- README.md | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 564b833..13e20ac 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,10 @@ so: 1. Make sure [Docker Compose is installed][1] and Docker is running (included in Docker Desktop) -3. Run `docker compose up` and wait until 389ds announces its successful start - in the log output +3. Run `docker compose up --build` and wait until all services have started + (389ds might take an extra minute to be ready). This will take a while when + running for the first time, so you might want to do something else in the + meantime. 4. `docker-compose exec ldap dsconf localhost backend create --suffix="dc=kosmos,dc=org" --be-name="dev"` 5. `docker compose run web rails ldap:setup` 6. `docker compose run web rails db:setup` @@ -28,38 +30,44 @@ have the password "user is user". ### Rails app +_Note: when using Docker Compose, prefix the following commands with `docker-compose +run web`._ + Installing dependencies: bundle install yarn install -Setting up local database (SQLite): +Migrating the local database (after schema changes): - bundle exec rails db:create bundle exec rails db:migrate -Running the dev server and auto-building CSS files on change: +Running the dev server, and auto-building CSS files on change _(automatic with Docker Compose)_: bin/dev -Running the background workers (requires Redis): +Running the background workers (requires Redis) _(automatic with Docker Compose)_: bundle exec sidekiq -C config/sidekiq.yml -Running all specs: +Running the test suite: bundle exec rspec -### Docker (Compose) +Running the test suite with Docker Compose requires overriding the Rails +environment: -There is a working Docker Compose config file, which define a number of services including -an app server for Rails as well as a local 389ds (LDAP) server. + docker-compose run -e "RAILS_ENV=test" web rspec -For Rails developers, you probably just want to start the LDAP server: `docker-compose up ldap`, -listening on port 389 on your machine. +### Docker Compose -You can pick and choose your services adding them by name (listed in `docker-compose.yml`) at -the end of the docker compose command. eg. `docker compose up ldap redis` +Services/containers are configured in `docker-compose.yml`. + +You can run services selectively, for example if you want to run the Rails app +and test suite on the host machine. Just add the service names of the +containers you want to run to the `up` command, like so: + + docker-compose up ldap redis #### LDAP server @@ -76,13 +84,15 @@ Now you can seed the back-end with data using this Rails task: The setup task will first delete any existing entries in the directory tree ("dc=kosmos,dc=org"), and then create our development entries. -Note that all 389ds data is stored in `tmp/389ds`. So if you want to start over -with a fresh installation, delete both that directory as well as the container. +Note that all 389ds data is stored in the `389ds-data` volume. So if you want +to start over with a fresh installation, delete both that volume as well as the +container. -#### Minio / RS +#### Minio / remoteStorage If you want to run remoteStorage accounts locally, you will have to create the -respective bucket first: +respective bucket first. With the `minio` container running (run by default +when using Docker Compose), follow these steps: * `docker compose up web redis minio liquor-cabinet` * Head to http://localhost:9001 and log in with user `minioadmin`, password From e65b8908801be003a973e1d15c91306925ef9b40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Sat, 2 Mar 2024 17:31:44 +0100 Subject: [PATCH 5/5] Update db schema --- db/schema.rb | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/db/schema.rb b/db/schema.rb index e558da8..934c5f3 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -10,7 +10,7 @@ # # It's strongly recommended that you check this file into your version control system. -ActiveRecord::Schema[7.1].define(version: 2024_02_07_080515) do +ActiveRecord::Schema[7.1].define(version: 2024_02_16_124640) do create_table "active_storage_attachments", force: :cascade do |t| t.string "name", null: false t.string "record_type", null: false @@ -50,12 +50,17 @@ ActiveRecord::Schema[7.1].define(version: 2024_02_07_080515) do create_table "donations", force: :cascade do |t| t.integer "user_id" t.integer "amount_sats" - t.integer "amount_eur" - t.integer "amount_usd" + t.integer "fiat_amount" t.string "public_name" t.datetime "created_at", null: false t.datetime "updated_at", null: false t.datetime "paid_at", precision: nil + t.string "fiat_currency", default: "USD" + t.string "donation_method" + t.string "payment_method" + t.string "btcpay_invoice_id" + t.string "payment_status" + t.index ["payment_status"], name: "index_donations_on_payment_status" t.index ["user_id"], name: "index_donations_on_user_id" end