BE | Create PuzzlesController#index Endpoint

.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.1

app/controllers/api/v1/puzzles_controller.rb

@@ -0,0 +1,17 @@
+class Api::V1::PuzzlesController < ApplicationController
+
+  def index
+
+      zip_code = params[:zip_code]
+
+      users = User.where(zip_code: zip_code) if zip_code.present?
+
+      if users != []
+        puzzles = Puzzle.where(user_id: users.pluck(:id))
+        render json: PuzzleSerializer.new(puzzles)
+      elsif puzzles == [] || users = []
+        render json: { error: "Puzzles not found in this area" }, status: "404"
+      end
+  end
+
+end

config/routes.rb

@@ -1,12 +1,13 @@
 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"
 
   namespace :api do
     namespace :v1 do
       # resources :users, only: [:show] #for ease of understanding, we will skip resoruces for now
+      put 'puzzles', to: 'puzzles#index'
+
       get '/users/:user_id', to: 'users#show'
       get '/users/:user_id/dashboard', to: 'users#dashboard'
 

spec/requests/api/v1/puzzles_request_spec.rb

@@ -0,0 +1,84 @@
+require 'rails_helper'
+
+RSpec.describe "PuzzlesController", type: :request do
+  describe "#ndex" do
+    context 'when successful' do
+      it "returns all puzzles from a zipcode" do
+        zip_code = 12345
+
+        user_1 = create(:user, id: 1, zip_code: zip_code)
+        user_2 = create(:user, id: 2, zip_code: zip_code)
+        user_3 = create(:user, id: 3, zip_code: 54321)
+        puzzle_1 = create(:puzzle, user: user_1)
+        puzzle_2 = create(:puzzle, user: user_1)
+        puzzle_3 = create(:puzzle, user: user_2)
+        puzzle_4 = create(:puzzle, user: user_3)
+
+        zipcode_params = { zip_code: 12345 }
+
+        headers = { 'CONTENT_TYPE' => 'application/json' }
+        put "/api/v1/puzzles", headers: headers, params: JSON.generate(zipcode_params)
+
+        expect(response).to have_http_status(200)
+
+        parsed_data = JSON.parse(response.body, symbolize_names: true)
+
+        expect(parsed_data).to be_a(Hash)
+        expect(parsed_data.keys).to eq([:data])
+        expect(parsed_data[:data]).to be_an(Array)
+        expect(parsed_data[:data][0]).to be_a(Hash)
+        expect(parsed_data[:data][0].keys).to eq([:id, :type, :attributes])
+
+        expect(parsed_data[:data][0][:attributes]).to be_a(Hash)
+        expect(parsed_data[:data][0][:attributes].keys).to eq([:user_id, :status, :title, :description, :total_pieces, :notes, :puzzle_image_url])
+        expect(parsed_data[:data][0][:attributes][:user_id]).to eq(puzzle_1.user_id)
+        expect(parsed_data[:data][0][:attributes][:status]).to eq(puzzle_1.status)
+        expect(parsed_data[:data][0][:attributes][:title]).to eq(puzzle_1.title) 
+        expect(parsed_data[:data][0][:attributes][:description]).to eq(puzzle_1.description)
+        expect(parsed_data[:data][0][:attributes][:total_pieces]).to eq(puzzle_1.total_pieces)
+        expect(parsed_data[:data][0][:attributes][:notes]).to eq(puzzle_1.notes)
+        expect(parsed_data[:data][0][:attributes][:puzzle_image_url]).to eq(puzzle_1.puzzle_image_url)
+
+        # NOTE Could refactor tests to not see a puzzle_4 in the test because it's in a diff zipcode
+
+        expect(parsed_data[:data][2][:attributes]).to be_a(Hash)
+        expect(parsed_data[:data][2][:attributes].keys).to eq([:user_id, :status, :title, :description, :total_pieces, :notes, :puzzle_image_url])
+        expect(parsed_data[:data][2][:attributes][:user_id]).to eq(puzzle_3.user_id)
+        expect(parsed_data[:data][2][:attributes][:status]).to eq(puzzle_3.status)
+        expect(parsed_data[:data][2][:attributes][:title]).to eq(puzzle_3.title) 
+        expect(parsed_data[:data][2][:attributes][:description]).to eq(puzzle_3.description)
+        expect(parsed_data[:data][2][:attributes][:total_pieces]).to eq(puzzle_3.total_pieces)
+        expect(parsed_data[:data][2][:attributes][:notes]).to eq(puzzle_3.notes)
+        expect(parsed_data[:data][2][:attributes][:puzzle_image_url]).to eq(puzzle_3.puzzle_image_url)
+
+
+    end
+  end
+
+  context 'when NOT successful' do
+    it 'returns an error message when zipcode is not found' do
+      zip_code = 12345
+        user_1 = create(:user, id: 1, zip_code: 54321)
+        user_2 = create(:user, id: 2, zip_code: 12346)
+        puzzle_1 = create(:puzzle, user: user_1)
+        puzzle_2 = create(:puzzle, user: user_1)
+        puzzle_3 = create(:puzzle, user: user_2)
+        puzzle_4 = create(:puzzle, user: user_2)
+
+        zipcode_params = { zip_code: 00000 }
+
+        headers = { 'CONTENT_TYPE' => 'application/json' }
+        put "/api/v1/puzzles", headers: headers, params: JSON.generate(zipcode_params)
+
+        expect(response).to have_http_status(404)
+
+        parsed_error_data = JSON.parse(response.body, symbolize_names: true)
+
+        expect(parsed_error_data).to be_a(Hash)
+        expect(parsed_error_data.keys).to eq([:error])
+        expect(parsed_error_data[:error]).to eq("Puzzles not found in this area")
+    end
+
+   end
+  end
+end