<%= t(".summary") %>: <%= @project_analysis.summary %>
+<%= t(".applicant_role") %>: <%= @project_analysis.applicant_role.humanize %>
+<%= t(".language") %>: <%= @project_analysis.language_code %>
+<%= t(".tags") %>: <%= @project_analysis.tags.join(', ') %>
+ +| <%= t(".criteria") %> | +<%= t(".score") %> | +<%= t(".reason") %> | +
|---|---|---|
| <%= score_hash[:field] %> | +<%= (score_hash[:score]).round %> | +<%= score_hash[:reason] %> | +
<%= t(".suggestions") %>: <%= @project_analysis.suggestion %>
+ diff --git a/app/views/projects/_project_details.html.erb b/app/views/projects/_project_details.html.erb index 3e226dd8..404b3e8a 100644 --- a/app/views/projects/_project_details.html.erb +++ b/app/views/projects/_project_details.html.erb @@ -13,9 +13,10 @@ <%= link_to I18n.t(".awesome", scope: "projects.project", count: voting_chapters.size, chapter: voting_chapter.slug), project_vote_path(project, chapter_id: voting_chapter.id), :method => :post, :remote => true, :class => "short-list", data: { chapter: voting_chapter.id } %> <% end %> - <% if display_project_actions?(current_user, project) %> - <%= link_to ''.html_safe, "#", class: "project-actions-toggle", data: { action: "click->toggler#toggle" } %> - <% end %> + <% if display_project_actions?(current_user, project) %> + <%= link_to ''.html_safe, "#", class: "project-actions-toggle", data: { action: "click->toggler#toggle" } %> + <%= link_to I18n.t("auto_awesome", scope: "projects.project.buttons"), show_or_create_project_project_analysis_path(project), class: "auto-awesome" %> + <% end %> <% end %> diff --git a/config/locales/en.yml b/config/locales/en.yml index ef055930..9647e7f1 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -34,6 +34,20 @@ en: error: There was a problem saving your project flashes: failure_when_not_signed_in: You must be logged in. + project_analyses: + flash: + cache_loaded: Project analysis loaded from cache. + generated: New project analysis generated. + show: + title: Project Analysis for "%{title}" + summary: Summary + applicant_role: Applicant Role + language: Language + tags: Tags + criteria: Criterion + score: Score + reason: Reason + suggestions: Suggestions layouts: application: main-header: The Awesome Foundation @@ -183,6 +197,8 @@ en: add-comment: Add a comment confirm-delete-comment: Are you sure you want to remove this comment? delete-comment: Delete comment + buttons: + auto_awesome: Auto-awesome hide_form: hide: Hide unhide: Unhide diff --git a/config/openai.yml b/config/openai.yml new file mode 100644 index 00000000..717d1053 --- /dev/null +++ b/config/openai.yml @@ -0,0 +1,264 @@ +default_settings: &default + api_key: <%= ENV['OPENAI_API_KEY'] || '' %> + project_analysis: + model: gpt-4o + prompt_text: | + You are an Awesome Foundation trustee. You have been asked to review the + following grant application and provide your feedback to qualify it for the + monthly award. + + format_instructions: | + DO NOT start the summary with unnecessary setup like 'This grant application + seeks funding for a community garden in Rogers Park...'. Instead just say + something like 'A community garden in Rogers Park...' + + For the score fields, provide a decimal value between 0 and 1, as well as a short + 2-sentence explanation for why the application meets or does not meet the + criteria described in the field. + + For the score fields, provide a JSON object with the score value as a number + (without quotes) and the reason field as a string. + + DO provide values for all scores. + DO NOT provide any other text in the result beyond the JSON. + DO NOT surround the JSON in backticks. + + Return all responses in English. + + response_schema: + "$defs": + ApplicantRole: + enum: + - community_leader + - teacher + - student + - artist + - academic + - entrepreneur + - nonprofit_organizer + - activist + - healthcare_worker + - scientist + - engineer + - social_worker + - musician + - filmmaker + - writer + - performer + - environmentalist + - technologist + - craftsperson + - parent + title: ApplicantRole + type: string + ProjectTag: + enum: + - science + - music + - technology + - art + - education + - environment + - health + - community + - social_justice + - culture + - history + - literature + - sports + - mental_health + - youth + - seniors + - accessibility + - urban_gardening + - sustainability + - renewable_energy + - robotics + - coding + - wildlife_conservation + - food_security + - housing + - dance + - theater + - filmmaking + - photography + - public_art + - disaster_relief + - transportation + - civic_engagement + - public_health + - water_safety + - astronomy + - journalism + - advocacy + - peacebuilding + - maker_space + - entrepreneurship + - clean_technology + - urban_planning + - heritage + - migration + - storytelling + - digital_inclusion + - biodiversity + - maker_education + - language_preservation + - homelessness + - libraries + - autism + - arts_activism + - food + - disability + - gender_equality + - lgbtq + - bicycles + - media_literacy + - animals + - crafts + - parks + title: ProjectTag + type: string + Score: + properties: + score: + title: Score + type: number + description: + Decimal value between 0 and 1 representing whether or not the + project fits this criterion described in the field. Two digit precision. + reason: + title: Reason + type: string + description: + One to two sentences explaining why the application received its score + for this field. + required: + - score + - reason + title: Score + type: object + Scores: + properties: + reach: + "$ref": "#/$defs/Score" + description: | + Number of people impacted, focusing on those local to the chapter's region. + alignment: + "$ref": "#/$defs/Score" + description: | + Project alignment with the Awesome Foundation’s mission and geographical focus. + novelty: + "$ref": "#/$defs/Score" + description: | + Originality, cleverness, and uniqueness of the project’s concept or approach. Should + not be an obvious idea that replicates other existing work. + use_of_proceeds: + "$ref": "#/$defs/Score" + description: | + Clarity and detail of fund allocation within the proposal, as well as ensuring the + funds will NOT finacially enrich the applicant directly (e.g., stipends paid to the + applicant). + impact_of_grant: + "$ref": "#/$defs/Score" + description: | + Significance of the $1000 grant in achieving the project’s goals. The grant should + be executable solely with no additional outside funding. + feasibility: + "$ref": "#/$defs/Score" + description: | + Practicality of executing the project within the stated timeline and budget. Also + evaluate applicant’s experience and credibility relevant to the project’s scope. + sustainability: + "$ref": "#/$defs/Score" + description: | + Long-term viability and potential for impact beyond the grant period, + as well as potential for project expansion or replication in other contexts. + urgency: + "$ref": "#/$defs/Score" + description: | + Immediacy of need for funds; score lower if impact isn’t time-sensitive. + whimsy: + "$ref": "#/$defs/Score" + description: | + Playful, imaginative qualities that inspire curiosity or delight. + social_good: + "$ref": "#/$defs/Score" + description: | + Potential for positive social impact and contribution to community welfare. + required: + - reach + - alignment + - novelty + - use_of_proceeds + - impact_of_grant + - feasibility + - sustainability + - urgency + - whimsy + - social_good + title: Scores + type: object + properties: + project_id: + title: Project Id + type: integer + summary: + description: + A brief overview of the project, outlining its goals, activities, + and potential risks. + title: Summary + type: string + tags: + description: + List of tags representing the project's themes. Should be instances + of the provided list of enums. + items: + "$ref": "#/$defs/ProjectTag" + title: Tags + type: array + applicant_role: + "$ref": "#/$defs/ApplicantRole" + description: + The applicant's primary role or background in relation to the project. + Should be an be one of the provided list of enums. + language_code: + description: + The ISO 639-1 code representing the language of the project description, + e.g., 'en' for English. + title: Language Code + type: string + funding_deadline: + anyOf: + - type: string + - type: "null" + default: + description: + The date by which the grant funds are needed to ensure timely execution + of the project, in ISO format. + title: Funding Deadline + suggestions: + description: + 4 - 6 sentences with any additional comments or suggestions for the + applicant. + title: Suggestions + type: string + scores: + "$ref": "#/$defs/Scores" + required: + - project_id + - summary + - tags + - applicant_role + - language_code + - scores + title: ProjectSummary + type: object + +development: + <<: *default + +production: + <<: *default + +test: + <<: *default diff --git a/config/routes.rb b/config/routes.rb index 7ee6d559..7ee77e9a 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -66,6 +66,9 @@ put :confirm_legit put :undo end + resource :project_analysis, :only => [] do + get "show_or_create", :to => "project_analyses#show_or_create" + end end resources :moderations, only: [:index] diff --git a/db/migrate/20241028031112_create_project_analyses.rb b/db/migrate/20241028031112_create_project_analyses.rb new file mode 100644 index 00000000..bf2240de --- /dev/null +++ b/db/migrate/20241028031112_create_project_analyses.rb @@ -0,0 +1,41 @@ +class CreateProjectAnalyses < ActiveRecord::Migration[6.1] + def change + create_table :project_analyses do |t| + t.references :project, foreign_key: true, null: false + + t.text :summary + t.string :language_code + t.string :applicant_role + t.date :funding_deadline + t.string :tags, array: true + + # Scores (flattened) + score_fields = [ + "reach", + "proximity", + "self_interest", + "budget_clarity", + "impact_of_grant", + "feasibility", + "credibility", + "innovation", + "sustainability", + "community_involvement", + "cultural_relevance", + "scalability", + "urgency", + "alignment_with_mission", + "whimsy", + "social_good", + "artistic_merit" + ] + + score_fields.each do |field| + t.decimal "#{field}_score", precision: 4, scale: 2 + t.text "#{field}_score_reason" + end + + t.timestamps + end + end +end diff --git a/db/migrate/20241029213306_add_project_analysis_suggestion_column.rb b/db/migrate/20241029213306_add_project_analysis_suggestion_column.rb new file mode 100644 index 00000000..46f3af42 --- /dev/null +++ b/db/migrate/20241029213306_add_project_analysis_suggestion_column.rb @@ -0,0 +1,5 @@ +class AddProjectAnalysisSuggestionColumn < ActiveRecord::Migration[6.1] + def change + add_column :project_analyses, :suggestion, :text + end +end diff --git a/db/migrate/20241029213419_add_project_analysis_prompt_info_columns.rb b/db/migrate/20241029213419_add_project_analysis_prompt_info_columns.rb new file mode 100644 index 00000000..b1f11613 --- /dev/null +++ b/db/migrate/20241029213419_add_project_analysis_prompt_info_columns.rb @@ -0,0 +1,11 @@ +class AddProjectAnalysisPromptInfoColumns < ActiveRecord::Migration[6.1] + def change + add_column :project_analyses, :prompt_usage_data, :jsonb, default: {}, null: false + add_column :project_analyses, :prompt_tokens, :integer + add_column :project_analyses, :completion_tokens, :integer + add_column :project_analyses, :cached_tokens, :integer + add_column :project_analyses, :prompt_estimated_cost, :float + add_column :project_analyses, :prompt_input_params, :jsonb, default: {}, null: false + add_column :project_analyses, :prompt_response_data, :jsonb, default: {}, null: false + end +end diff --git a/db/migrate/20241030001603_add_project_analysis_novelty_score.rb b/db/migrate/20241030001603_add_project_analysis_novelty_score.rb new file mode 100644 index 00000000..b17d98f0 --- /dev/null +++ b/db/migrate/20241030001603_add_project_analysis_novelty_score.rb @@ -0,0 +1,6 @@ +class AddProjectAnalysisNoveltyScore < ActiveRecord::Migration[6.1] + def change + add_column :project_analyses, :novelty_score, :decimal, precision: 4, scale: 2 + add_column :project_analyses, :novelty_score_reason, :text + end +end diff --git a/docker-compose.yml b/docker-compose.yml index 2a851a4f..9de3099d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -3,6 +3,8 @@ services: image: postgres volumes: - postgresqldata:/var/lib/postgresql/data + ports: + - "6432:5432" environment: POSTGRES_USER: "postgres" POSTGRES_PASSWORD: "mysecretpassword" diff --git a/spec/jobs/project_analysis_job_spec.rb b/spec/jobs/project_analysis_job_spec.rb new file mode 100644 index 00000000..5e6d9ce9 --- /dev/null +++ b/spec/jobs/project_analysis_job_spec.rb @@ -0,0 +1,5 @@ +require 'spec_helper' + +RSpec.describe ProjectAnalysisJob, type: :job do + pending "add some examples to (or delete) #{__FILE__}" +end diff --git a/spec/services/project_analysis_generator_integration_spec.rb b/spec/services/project_analysis_generator_integration_spec.rb new file mode 100644 index 00000000..fad2620d --- /dev/null +++ b/spec/services/project_analysis_generator_integration_spec.rb @@ -0,0 +1,25 @@ +require "spec_helper" + +RSpec.describe "ProjectAnalysisGenerator Integration", type: :integration do + let(:project) { create(:project) } + + before do + skip "Integration test skipped: OPENAI_API_KEY is not configured." if ENV["OPENAI_API_KEY"].blank? + end + + it "calls the OpenAI API with a real key and validates the response", integration: true do + generator = ProjectAnalysisGenerator.new(project.id) + expect { generator.call }.not_to raise_error + + analysis = ProjectAnalysis.last + expect(analysis).not_to be_nil + expect(analysis.summary).to be_a(String) + expect(analysis.language_code).to be_a(String) + expect(analysis.scores).to be_a(Hash) + expect(analysis.scores).to include(*ProjectAnalysisScores::SCORE_FIELDS) + + [*ProjectAnalysisScores::SCORE_FIELDS].each do |field| + expect(analysis.scores[field][:reason]).to be_a(String) + end + end +end diff --git a/spec/services/project_analysis_generator_spec.rb b/spec/services/project_analysis_generator_spec.rb new file mode 100644 index 00000000..191eda3e --- /dev/null +++ b/spec/services/project_analysis_generator_spec.rb @@ -0,0 +1,70 @@ +require "spec_helper" + +RSpec.describe ProjectAnalysisGenerator, type: :service do + let(:project) { create(:project) } + let(:openai_config) do + { + api_key: "test-api-key", + project_analysis: { + model: "gpt-test", + prompt_text: "Prompt", + format_instructions: "Format", + response_schema: {} + } + } + end + + let(:mock_client) { mock("OpenAI::Client") } + + before do + # Mock the OpenAI API client (Mocha) + OpenAI::Client.stubs(:new).returns(mock_client) + Rails.application.stubs(:config_for).with(:openai).returns(openai_config) + end + + describe "#call" do + context "when OpenAI API returns a valid response" do + it "creates a ProjectAnalysis record" do + scores = ProjectAnalysisScores::SCORE_FIELDS.each_with_object({}) do |field, hash| + hash[field] = {"score" => 0.8, "reason" => "#{field} ok"} + end + # Mock the API response + api_response = { + "choices" => [ + { + "message" => { + "content" => { + "summary" => "A great project.", + "language_code" => "en", + "applicant_role" => "Founder", + "scores" => scores + }.to_json + } + } + ] + } + mock_client.stubs(:chat).returns(api_response) + + generator = ProjectAnalysisGenerator.new(project.id) + expect { + generator.call + }.to change { ProjectAnalysis.count }.by(1) + + analysis = ProjectAnalysis.last + expect(analysis.summary).to eq("A great project.") + expect(analysis.language_code).to eq("en") + expect(analysis.scores.feasibility.score).to eq(0.8) + expect(analysis.scores.feasibility.reason).to eq("feasibility ok") + end + end + + context "when OpenAI API fails" do + it "raises an error" do + mock_client.stubs(:chat).raises(StandardError.new("API Error")) + + generator = ProjectAnalysisGenerator.new(project.id) + expect { generator.call }.to raise_error("Error: OpenAI API call failed.") + end + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 423b08c3..88dcec9c 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -19,6 +19,7 @@ config.infer_spec_type_from_file_location! config.mock_with :mocha + config.include FactoryBot::Syntax::Methods config.before(:each){ DatabaseCleaner.start } config.append_after(:each){ DatabaseCleaner.clean } config.before(:each){ FactoryBot.create(:chapter, :name => "Any") }