Reports API (#7)

* Separate contributor's guide; Document reports api endpoints

* Write test

* Re-write test

* Add jbuilder json views

* Give credit h/t SO

* Prevent data leakage by cleaning the db before this test.

* Test reports view

* Change search endpoint to regular index endpoint, clean code, refactor

* Re-write, and can now filter on one or both params, which is actually good - more robust

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributor's Guide
+
+## Installation
+
+Install Ruby 2.2.5, probably using rbenv.
+
+Install PostgreSQL, probably using homebrew.
+
+Download the source code:
+
+```sh
+git clone [email protected]:data-creative/law-schools-reporter.git
+cd law-schools-reporter/
+bin/setup # installs package dependencies and preps the database
+```
+
+## Setup
+
+Seed the database with schools and employment data.
+
+```sh
+bundle exec rake db:seed
+```
+
+## Developing
+
+Run interactive development console:
+
+```shell
+bin/rails c
+```
+
+Serve locally:
+
+```shell
+bin/rails s
+```
+
+## Testing
+
+Run tests:
+
+```shell
+bundle exec rspec spec/
+```
+
+## Deploying
+
+Gain access to the `law-school-reporter` heroku application. Then deploy:
+
+```sh
+git push heroku master # or ...
+git push heroku mybranch:master
+```

CREDITS.md

@@ -1,6 +1,13 @@
 # Credits, Notes, and Reference
 
+### Previous Projects
+
   + [ToneBase API](https://github.com/data-creative/tonebase-api/)
+
+### Rails
+
   + [Routing via non-id attribute](https://stackoverflow.com/a/20773186)
   + [Linking to show page and passing params](https://stackoverflow.com/a/8477394)
   + [Linking to show page and passing the resource](https://stackoverflow.com/a/21708346/)
+  + [Rendering JSON within a controller spec](https://stackoverflow.com/a/10038777/670433)
+  + [Preventing data leakage across tests](https://stackoverflow.com/questions/9927671/rspec-database-cleaner-not-cleaning-correctly#comment15607311_9927671)

README.md

@@ -1,48 +1,15 @@
 # Law Schools Reporter
 
-## Installation
+## API Endpoints
 
-Install Ruby 2.2.5, probably using rbenv.
+### Schools
 
-Install PostgreSQL, probably using homebrew.
+  + GET `api/v1/schools`
+  + GET `api/v1/schools/:uuid`
 
-Download the source code:
+### Employment Reports
 
-```sh
-git clone [email protected]:data-creative/law-schools-reporter.git
-cd law-schools-reporter/
-bin/setup # installs package dependencies and preps the database
-```
-
-## Usage
-
-Seed the database with schools and employment data.
-
-```sh
-bundle exec rake db:seed
-```
-
-## Developing
-
-Serve locally:
-
-```shell
-rails s
-```
-
-Run tests:
-
-```shell
-bundle exec rspec spec/
-```
-
-## Deploying
-
-Gain access to the `law-school-reporter` heroku application. Then deploy:
-
-```sh
-git push heroku master # or ...
-git push heroku mybranch:master
-```
+  + GET `api/v1/employment_reports`
+  + GET `api/v1/employment_reports?years[]=2016&years[]=2017&schools[]=25&schools[]=36`
 
 ## [License](/LICENSE.md)

app/controllers/api/v1/employment_reports_controller.rb

@@ -0,0 +1,22 @@
+class Api::V1::EmploymentReportsController < ApplicationController
+
+  # GET /api/v1/employment_reports
+  # GET /api/v1/employment_reports.json
+  #
+  # GET /api/v1/employment_reports?years[]=2016&years[]=2017&schools[]=96&schools[]=132
+  def index
+    @reports = EmploymentReport.all
+    @reports = @reports.where(year: years) if params[:years]
+    @reports = @reports.where(school_uuid: school_uuids) if params[:schools]
+  end
+
+  private
+
+  def school_uuids
+    params.require(:schools)
+  end
+
+  def years
+    params.require(:years)
+  end
+end

app/models/employment_report.rb

@@ -9,4 +9,12 @@ class EmploymentReport < ApplicationRecord
   def self.with_grads
     where("total_grads <> 0")
   end
+
+  def reported_school_name
+    school_name
+  end
+
+  #def real_school_name
+  #  school.try(:name)
+  #end
 end

app/views/api/v1/employment_reports/_report.json.jbuilder

@@ -0,0 +1,9 @@
+json.extract! report,
+  :school_uuid,
+  :reported_school_name,
+  :year,
+  :total_grads,
+  :total_employed,
+  :employment_types,
+  :employment_statuses,
+  :employment_locations

app/views/api/v1/employment_reports/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @reports, partial: 'api/v1/employment_reports/report', as: :report

config/routes.rb

@@ -6,6 +6,8 @@
   namespace :api do
     namespace :v1, defaults: {format: :json} do
       resources :schools, param: :uuid, only: [:index, :show]
+
+      resources :employment_reports, only: [:index]
     end
   end
 end

spec/controllers/api/v1/employment_reports_controller_spec.rb

@@ -0,0 +1,49 @@
+require 'rails_helper'
+require_relative "../../../support/api/v1/response"
+
+RSpec.describe Api::V1::EmploymentReportsController, type: :controller do
+  let(:valid_session){ {} }
+
+  before(:all) do
+    create(:school, :with_reports, uuid: 98, report_years: [2015, 2016, 2017]) # 2 matches
+    create(:school, :with_reports, uuid: 76, report_years: [2011, 2012, 2016]) # 1 match
+    create(:school, :with_reports, uuid: 23, report_years: [2015, 2016, 2017]) # 0 matches
+  end
+
+  describe "GET #index", "when not given any search parameters" do
+    let(:response){ get(:index, params: {format: 'json'}, session: valid_session) }
+
+    render_views # avoids JSON parsing error
+
+    it "returns a success response" do
+      expect(response).to be_success
+    end
+
+    it "should exclude non-matching resources" do # ensures proper configuration of this test :-)
+      expect(EmploymentReport.count).to eql(3 + 3 + 3)
+    end
+
+    it "should include all resources" do
+      expect(parsed_response.count).to eql(3 + 3 + 3)
+    end
+  end
+
+  describe "GET #index", "when given both search parameters" do
+    let(:search_params){ {years: ["2016", "2017"], schools: ["98", "76"]} }
+    let(:response){ get(:index, params: search_params.merge(format: 'json'), session: valid_session) }
+
+    render_views # avoids JSON parsing error
+
+    it "returns a success response" do
+      expect(response).to be_success
+    end
+
+    it "should exclude non-matching resources" do # ensures proper configuration of this test :-)
+      expect(EmploymentReport.count).to eql(3 + 3 + 3)
+    end
+
+    it "should include matching resources" do
+      expect(parsed_response.count).to eql(2 + 1 + 0)
+    end
+  end
+end

spec/factories/schools.rb

@@ -7,4 +7,16 @@
     sequence(:url){|n| "http://law.my-school-#{n}.edu" }
     reports_url "N/A - NOT FOUND"
   end
+
+  trait :with_reports do
+      transient do
+        report_years [2015, 2016, 2017]
+      end
+
+      after(:create) do |school, evaluator|
+        evaluator.report_years.each do |year|
+          create(:employment_report, school_uuid: school.uuid, year: year)
+        end
+      end
+    end
 end

spec/jobs/report_seeder_job_spec.rb

@@ -7,6 +7,8 @@
     let(:years) { mock_batches.map{|k,_| k.to_i} }
 
     before(:all) do
+      DatabaseCleaner.clean_with(:truncation) # avoid dirty database errors.
+
       RSpec::Mocks.with_temporary_scope do # use this technique to allow stubbing within a before(:all) hook
         create(:school, long_name: "AKRON, UNIVERSITY OF") # to be matched with report via long_name
         create(:school, name: "BOSTON COLLEGE") # to be matched with report via name

spec/support/api/v1/response.rb

@@ -0,0 +1,9 @@
+module Api::V1::Response
+  def parsed_response
+    JSON.parse(response.body)
+  end
+end
+
+RSpec.configure do |config|
+  config.include Api::V1::Response
+end

spec/support/api/v1/view.rb

@@ -1,5 +1,5 @@
 module Api::V1::View
-  def parsed_response
+  def parsed_view
     JSON.parse(rendered)
   end
 end

spec/views/api/v1/employment_reports/index_spec.rb

@@ -0,0 +1,25 @@
+require 'rails_helper'
+require_relative "../../../../support/api/v1/view"
+
+RSpec.describe "api/v1/employment_reports/index", type: :view do
+  before(:each) do
+    @reports = assign(:reports, [ create(:employment_report), create(:employment_report) ] )
+    render
+  end
+
+  it "renders a list of reports" do
+    expect(parsed_view.count).to eql(@reports.count)
+    expect(parsed_view.first.keys).to match_array(
+      [
+        "school_uuid",
+        "reported_school_name",
+        "year",
+        "total_grads",
+        "total_employed",
+        "employment_types",
+        "employment_statuses",
+        "employment_locations"
+      ]
+    )
+  end
+end

spec/views/api/v1/schools/index_spec.rb

@@ -8,7 +8,7 @@
   end
 
   it "renders a list of schools" do
-    expect(parsed_response.count).to eql(@schools.count)
-    expect(parsed_response.first.keys).to match_array(["uuid", "year_founded", "long_name", "name", "url", "reports_url"]) # , "report_years"
+    expect(parsed_view.count).to eql(@schools.count)
+    expect(parsed_view.first.keys).to match_array(["uuid", "year_founded", "long_name", "name", "url", "reports_url"]) # , "report_years"
   end
 end

spec/views/api/v1/schools/show_spec.rb

@@ -8,7 +8,7 @@
   end
 
   it "renders the requested school" do
-    expect(parsed_response.keys).to match_array(["uuid", "year_founded", "long_name", "name", "url", "reports_url"]) # , "report_years"
-    expect(parsed_response["uuid"]).to eql(@school.uuid)
+    expect(parsed_view.keys).to match_array(["uuid", "year_founded", "long_name", "name", "url", "reports_url"]) # , "report_years"
+    expect(parsed_view["uuid"]).to eql(@school.uuid)
   end
 end