Merge pull request #276 from 3kh0/main

allow users to hide stats from public lookup

app/controllers/api/v1/stats_controller.rb

@@ -32,7 +32,11 @@ class Api::V1::StatsController < ApplicationController
   def user_stats
     # Used by the github stats page feature
 
-    return render plain: "User not found", status: :not_found unless @user.present?
+    return render json: { error: "User not found" }, status: :not_found unless @user.present?
+
+    if !@user.allow_public_stats_lookup && (!current_user || current_user != @user)
+      return render json: { error: "user has disabled public stats" }, status: :forbidden
+    end
 
     start_date = params[:start_date].to_datetime if params[:start_date].present?
     start_date ||= 10.years.ago

app/controllers/users_controller.rb

@@ -100,6 +100,6 @@ class UsersController < ApplicationController
   end
 
   def user_params
-    params.require(:user).permit(:uses_slack_status, :hackatime_extension_text_type, :timezone)
+    params.require(:user).permit(:uses_slack_status, :hackatime_extension_text_type, :timezone, :allow_public_stats_lookup)
   end
 end

app/models/user.rb

@@ -7,6 +7,8 @@ class User < ApplicationRecord
   validates :timezone, inclusion: { in: TZInfo::Timezone.all_identifiers }, allow_nil: false
   validates :country_code, inclusion: { in: ISO3166::Country.codes }, allow_nil: true
 
+  attribute :allow_public_stats_lookup, :boolean, default: true
+
   def country_name
     ISO3166::Country.new(country_code).common_name
   end

app/views/users/edit.html.erb

@@ -212,6 +212,21 @@
     </p>
   </section>
 
+  <section>
+    <h2 id="user_privacy">Privacy</h2>
+    <%= form_with model: @user,
+      url: @is_own_settings ? my_settings_path : settings_user_path(@user),
+      method: :patch do |f| %>
+      <fieldset>
+        <label for="user_allow_public_stats_lookup">
+          <%= f.check_box :allow_public_stats_lookup, id: "user_allow_public_stats_lookup" %>
+          <%= f.label :allow_public_stats_lookup, "Allow others to look up my public coding stats via the API" %>
+        </label>
+      </fieldset>
+      <%= f.submit "Save Settings" %>
+    <% end %>
+  </section>
+
   <% admin_tool do %>
     <section>
       <h2 id="wakatime_mirror">WakaTime Mirror</h2>

db/migrate/20250531120000_add_allow_public_stats_lookup_to_users.rb

@@ -0,0 +1,5 @@
+class AddAllowPublicStatsLookupToUsers < ActiveRecord::Migration[7.0]
+  def change
+    add_column :users, :allow_public_stats_lookup, :boolean, default: true, null: false
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[8.0].define(version: 2025_05_30_135145) do
+ActiveRecord::Schema[8.0].define(version: 2025_05_31_120000) do
   create_schema "pganalyze"
 
   # These are extensions that must be enabled in order to support this database
@@ -426,6 +426,7 @@ ActiveRecord::Schema[8.0].define(version: 2025_05_30_135145) do
     t.integer "trust_level", default: 0, null: false
     t.string "country_code"
     t.string "mailing_address_otc"
+    t.boolean "allow_public_stats_lookup", default: true, null: false
     t.index ["slack_uid"], name: "index_users_on_slack_uid", unique: true
     t.index ["timezone"], name: "index_users_on_timezone"
   end