diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..48fb168f6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +# See https://help.github.com/articles/ignoring-files for more about ignoring files. +# +# If you find yourself ignoring temporary files generated by your text editor +# or operating system, you probably want to add a global ignore instead: +# git config --global core.excludesfile '~/.gitignore_global' + +# Ignore bundler config. +/.bundle + +# Ignore all logfiles and tempfiles. +/log/* +/tmp/* +!/log/.keep +!/tmp/.keep + +# Ignore Byebug command history file. +.byebug_history diff --git a/Gemfile b/Gemfile new file mode 100644 index 000000000..21bfaf93f --- /dev/null +++ b/Gemfile @@ -0,0 +1,53 @@ +source 'https://rubygems.org' + +git_source(:github) do |repo_name| + repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/") + "https://github.com/#{repo_name}.git" +end + +gem 'active_model_serializers', '~> 0.10.0' +# Bundle edge Rails instead: gem 'rails', github: 'rails/rails' +gem 'rails', '~> 5.0.2' +# Use postgresql as the database for Active Record +gem 'pg', '~> 0.18' +# Use Puma as the app server +gem 'puma', '~> 3.0' +# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder +gem 'jbuilder', '~> 2.5' +# Use Redis adapter to run Action Cable in production +# gem 'redis', '~> 3.0' +# Use ActiveModel has_secure_password +# gem 'bcrypt', '~> 3.1.7' + +# Use Capistrano for deployment +# gem 'capistrano-rails', group: :development + +# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible +# gem 'rack-cors' + +group :development, :test do + # Call 'byebug' anywhere in the code to stop execution and get a debugger console + gem 'byebug', platform: :mri +end + +group :development do + gem 'listen', '~> 3.0.5' + # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring + gem 'spring' + gem 'spring-watcher-listen', '~> 2.0.0' +end + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby] + +group :development do + gem 'better_errors' + gem 'pry-rails' +end + +gem 'awesome_print' +gem 'foundation-rails' +group :test do + gem 'minitest-rails' + gem 'minitest-reporters' +end diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 000000000..a220688de --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,189 @@ +GEM + remote: https://rubygems.org/ + specs: + actioncable (5.0.2) + actionpack (= 5.0.2) + nio4r (>= 1.2, < 3.0) + websocket-driver (~> 0.6.1) + actionmailer (5.0.2) + actionpack (= 5.0.2) + actionview (= 5.0.2) + activejob (= 5.0.2) + mail (~> 2.5, >= 2.5.4) + rails-dom-testing (~> 2.0) + actionpack (5.0.2) + actionview (= 5.0.2) + activesupport (= 5.0.2) + rack (~> 2.0) + rack-test (~> 0.6.3) + rails-dom-testing (~> 2.0) + rails-html-sanitizer (~> 1.0, >= 1.0.2) + actionview (5.0.2) + activesupport (= 5.0.2) + builder (~> 3.1) + erubis (~> 2.7.0) + rails-dom-testing (~> 2.0) + rails-html-sanitizer (~> 1.0, >= 1.0.3) + active_model_serializers (0.10.6) + actionpack (>= 4.1, < 6) + activemodel (>= 4.1, < 6) + case_transform (>= 0.2) + jsonapi-renderer (>= 0.1.1.beta1, < 0.2) + activejob (5.0.2) + activesupport (= 5.0.2) + globalid (>= 0.3.6) + activemodel (5.0.2) + activesupport (= 5.0.2) + activerecord (5.0.2) + activemodel (= 5.0.2) + activesupport (= 5.0.2) + arel (~> 7.0) + activesupport (5.0.2) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (~> 0.7) + minitest (~> 5.1) + tzinfo (~> 1.1) + ansi (1.5.0) + arel (7.1.4) + awesome_print (1.7.0) + babel-source (5.8.35) + babel-transpiler (0.7.0) + babel-source (>= 4.0, < 6) + execjs (~> 2.0) + better_errors (2.1.1) + coderay (>= 1.0.0) + erubis (>= 2.6.6) + rack (>= 0.9.0) + builder (3.2.3) + byebug (9.0.6) + case_transform (0.2) + activesupport + coderay (1.1.1) + concurrent-ruby (1.0.5) + erubis (2.7.0) + execjs (2.7.0) + ffi (1.9.18) + foundation-rails (6.3.1.0) + railties (>= 3.1.0) + sass (>= 3.3.0, < 3.5) + sprockets-es6 (>= 0.9.0) + globalid (0.4.0) + activesupport (>= 4.2.0) + i18n (0.8.1) + jbuilder (2.6.3) + activesupport (>= 3.0.0, < 5.2) + multi_json (~> 1.2) + jsonapi-renderer (0.1.2) + listen (3.0.8) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + loofah (2.0.3) + nokogiri (>= 1.5.9) + mail (2.6.5) + mime-types (>= 1.16, < 4) + method_source (0.8.2) + mime-types (3.1) + mime-types-data (~> 3.2015) + mime-types-data (3.2016.0521) + mini_portile2 (2.1.0) + minitest (5.10.1) + minitest-rails (3.0.0) + minitest (~> 5.8) + railties (~> 5.0) + minitest-reporters (1.1.14) + ansi + builder + minitest (>= 5.0) + ruby-progressbar + multi_json (1.12.1) + nio4r (2.0.0) + nokogiri (1.7.1) + mini_portile2 (~> 2.1.0) + pg (0.20.0) + pry (0.10.4) + coderay (~> 1.1.0) + method_source (~> 0.8.1) + slop (~> 3.4) + pry-rails (0.3.6) + pry (>= 0.10.4) + puma (3.8.2) + rack (2.0.2) + rack-test (0.6.3) + rack (>= 1.0) + rails (5.0.2) + actioncable (= 5.0.2) + actionmailer (= 5.0.2) + actionpack (= 5.0.2) + actionview (= 5.0.2) + activejob (= 5.0.2) + activemodel (= 5.0.2) + activerecord (= 5.0.2) + activesupport (= 5.0.2) + bundler (>= 1.3.0, < 2.0) + railties (= 5.0.2) + sprockets-rails (>= 2.0.0) + rails-dom-testing (2.0.2) + activesupport (>= 4.2.0, < 6.0) + nokogiri (~> 1.6) + rails-html-sanitizer (1.0.3) + loofah (~> 2.0) + railties (5.0.2) + actionpack (= 5.0.2) + activesupport (= 5.0.2) + method_source + rake (>= 0.8.7) + thor (>= 0.18.1, < 2.0) + rake (12.0.0) + rb-fsevent (0.9.8) + rb-inotify (0.9.8) + ffi (>= 0.5.0) + ruby-progressbar (1.8.1) + sass (3.4.23) + slop (3.6.0) + spring (2.0.1) + activesupport (>= 4.2) + spring-watcher-listen (2.0.1) + listen (>= 2.7, < 4.0) + spring (>= 1.2, < 3.0) + sprockets (3.7.1) + concurrent-ruby (~> 1.0) + rack (> 1, < 3) + sprockets-es6 (0.9.2) + babel-source (>= 5.8.11) + babel-transpiler + sprockets (>= 3.0.0) + sprockets-rails (3.2.0) + actionpack (>= 4.0) + activesupport (>= 4.0) + sprockets (>= 3.0.0) + thor (0.19.4) + thread_safe (0.3.6) + tzinfo (1.2.3) + thread_safe (~> 0.1) + websocket-driver (0.6.5) + websocket-extensions (>= 0.1.0) + websocket-extensions (0.1.2) + +PLATFORMS + ruby + +DEPENDENCIES + active_model_serializers (~> 0.10.0) + awesome_print + better_errors + byebug + foundation-rails + jbuilder (~> 2.5) + listen (~> 3.0.5) + minitest-rails + minitest-reporters + pg (~> 0.18) + pry-rails + puma (~> 3.0) + rails (~> 5.0.2) + spring + spring-watcher-listen (~> 2.0.0) + tzinfo-data + +BUNDLED WITH + 1.14.6 diff --git a/README.md b/README.md index fb85e2b48..7db80e4ca 100644 --- a/README.md +++ b/README.md @@ -1,280 +1,24 @@ -# Project: VideoStoreAPI -The goal of this project is to create a system that a video store (remember those?) could use to track their inventory of rental videos and their list of customers. +# README -We will use Rails to construct a RESTful API. The purpose of this API is to quickly serve information about the store's video collection, customer information, and to update rental status. This repository provides two JSON datafiles to serve as the initial seeds for this system. +This README would normally document whatever steps are necessary to get the +application up and running. -This is a pair project. You and your partner should use all the techniques we've learned so far to keep yourselves organized and on track, and ensure that no requirements slip through the cracks. +Things you may want to cover: -## Learning Goals -Upon completing this project, students should be able to: +* Ruby version -- Build an ERD and set up ActiveRecord models for a given dataset / use-case -- Expose database contents through a web API -- Respond reasonably to bad user data in the context of an API -- Verify the correctness of an API using controller tests +* System dependencies -This is a [stage 2](https://github.com/Ada-Developers-Academy/pedagogy/blob/master/rule-of-three.md) project. +* Configuration -## Success Criteria -Your project will be evaluated against the following requirements: +* Database creation -- API conformance - - The provided smoke tests should pass (see the subfolder) - - Bad data sent to the API should result in an appropriate status code and helpful error -- Test coverage - - Models: All relations, validations, and custom model methods should include at least one positive and one negative test case - - Controllers: Every API endpoint should include at least one positive and one negative test case -- Style and Organization - - Business logic should be live in models +* Database initialization -## Project Baseline -- Read the API Requirements below and create a pseudo-code "routes" file that specifies - - The _endpoints_ your API will need - - The _HTTP verbs_ each endpoint will use - - Any data that must be provided to the endpoint in order for it to do its work -- Read the Seed Data description below and, bearing in mind the API Requirements, create an ERD for your database that specifies - - The _models_ your database will require - - The _attributes_ for each model - - Any _relationships_ between models -- Create a new Rails app to serve as the API - - **Create the rails app with:** `$ rails new . --api` -- Create a route that responds to `/zomg` that serves a json-encoded "it works!" +* How to run the test suite -## Wave 1: Database Models, Tables, & Seeds -- Generate Rails models and associations to match your ERD -- Use the provided seed script `db/seeds.rb` to import the provided JSON data into your database +* Services (job queues, cache servers, search engines, etc.) -### Seed Data -`movies.json` contains information about the videos available to rent at the store. The data is presented as an array of objects, with each object having the following key-value pairs: +* Deployment instructions -| Field | Datatype | Description -|----------------|----------|------------ -| `title` | string | The title of the film -| `overview` | string | A short plot synopsis -| `release_date` | string | `YYYY-MM-DD`, Day the film was originally released -| `inventory` | integer | How many copies of the film the video store owns - -`customers.json` contains information about the customers that have rented with the store in the past. The data is presented as, you guessed it, an array of objects, with each object have the following key-value pairs: - -| Field | Datatype | Description -|------------------|----------|------------ -| `name` | string | The customer's name -| `registered_at` | string | `Wed, 29 Apr 2015 07:54:14 -0700`, When the customer first visited the store -| `address` | string | Street address -| `city` | string |   -| `state` | string |   -| `postal_code` | string |   -| `phone` | string | Primary contact phone number - -### Testing -As with all Rails projects, model testing is a requirement. You should have _at least_ one positive and one negative test case for each relation, validation, and custom function you add to your models. - -Use good TDD practices, and test _before_ you code. Remember: red-green-refactor. - -## Waves 2 Coding The API -In this wave, you will implement the API described below. The endpoints are described more-or-less in order of complexity, and we recommend you build them in that order. Every endpoint must serve JSON data, and must use HTTP response codes to indicate the status of the request. - -The schema of your database and the structure of your rails app are completely up to you, so long as the API conforms to the description and provided script. - -### Error Handling -If something goes wrong, your API should return an appropriate [HTTP status code](http://billpatrianakos.me/blog/2013/10/13/list-of-rails-status-code-symbols/), as well as a list of errors. The list should be formatted like this: - -```json -{ - "errors": { - "title": ["Movie 'Revenge of the Gnomes' not found"] - } -} -``` - -All errors your API can return should be covered by at least one test case. - -### Testing -Because APIs are often open to the public, thorough testing is essential. For a Rails API, that means controller testing. - -For each API endpoint, you should have _at least_: -- A basic test with no parameters, if applicable -- Positive and negative tests for any URI parameters (user ID, movie title) -- Testing around any data in the request body - -Use good TDD practices, and test _before_ you code. Remember: red-green-refactor. - -#### Smoke Tests -Because this API will be used as the backend for a future project, there are strict requirements about how it should be structured. To this end, we have provided a set of [smoke tests](http://softwaretestingfundamentals.com/smoke-testing/) written in Postman to exercise all the endpoints. - -The smoke tests will verify that your API looks correct to the outside world, by sending actual HTTP requests to your running server and checking the results. They test things like: - -- Did I get a success response for a valid request? -- Did the API return JSON? -- Does the JSON contain the expected property names? - -**The smoke tests are not a substitute for writing your own tests!!!!!** They do **not** check that the content is _correct_, nor do they cover any negative or edge cases. Verifying correctness in these cases is **your** responsibility. - -The smoke tests live in the file [`test/VideoStoreAPI_smoke_tests.postman_collection.json`](test/VideoStoreAPI_smoke_tests.postman_collection.json). To run them: - -1. Open Postman -1. Click `Import` in the top left -1. Drag-and-drop the file into the box -1. In the left sidebar, click on the `Collections` tab -1. There should now be an entry for the smoke tests. Hover over it and click the `>` icon for a detail view. -1. Click the blue `Run` button. This will launch the collection runner. -1. In the collection runner, scroll down in the center pane and click the blue `Start Test` button - -## API Description - -#### `GET /customers` -List all customers - -Fields to return: -- `id` -- `name` -- `registered_at` -- `postal_code` -- `phone` -- `movies_checked_out_count` - - This will be 0 unless you've completed optional requirements - -#### `GET /movies` -List all movies - -Fields to return: -- `title` -- `release_date` - -#### `GET /movies/:title` -Look a movie up by `title` - -URI parameters: -- `title`: Movie title (e.g. `Jaws`) - -Fields to return: -- `title` -- `overview` -- `release_date` -- `inventory` (total) -- `available_inventory` (not currently checked-out to a customer) - - This will be the same as `inventory` unless you've completed the optional endpoints. - -### Optional Rentals - -Wave 2 focused on **reading** data from the API. In these endpoints you will interact with the API changing models through POST requests. - -#### `POST /rentals/:title/check-out` -Check out one of the movie's inventory to the customer. The rental's check-out date should be set to today. - -**Note:** Some of the fields from wave 2 should now have interesting values. Good thing you wrote tests for them, right... right? - -URI parameters: -- `title`: Movie title (e.g. `Jaws`) - -Request body: - -| Field | Datatype | Description -|---------------|---------------------|------------ -| `customer_id` | integer | ID of the customer checking out this film -| `due_date` | string `YYYY-MM-DD` | When should this movie be checked back in? - -#### `POST /rentals/:title/check-in` -Check in one of a customer's rentals - -Request body: - -| Field | Datatype | Description -|---------------|----------|------------ -| `customer_id` | integer | ID of the customer checking in this film - -#### `GET /rentals/overdue` -List all customers with overdue movies - -Fields to return: -- `title` -- `customer_id` -- `name` -- `postal_code` -- `checkout_date` -- `due_date` - -## Going Further -These really are **optional** - if you've gotten here and you have time left, that means you're moving speedy fast! - -### Query Parameters -Any endpoint that returns a list should accept 3 _optional_ [query parameters](http://guides.rubyonrails.org/action_controller_overview.html#parameters): - -| Name | Value | Description -|--------|---------|------------ -| `sort` | string | Sort objects by this field, in ascending order -| `n` | integer | Number of responses to return per page -| `p` | integer | Page of responses to return - -So, for an API endpoint like `GET /customers`, the following requests should be valid: -- `GET /customers`: All customers, sorted by ID -- `GET /customers?sort=name`: All customers, sorted by name -- `GET /customers?n=10&p=2`: Customers 10-19, sorted by ID -- `GET /customers?sort=name&n=10&p=2`: Customers 10-19, sorted by name - -Of course, adding new features means you should be adding new controller tests to verify them. - -Things to note: -- Sorting by ID is the rails default -- Possible sort fields: - - Customers can be sorted by `name`, `registered_at` and `postal_code` - - Movies can be sorted by `title` and `release_date` - - Overdue rentals can be sorted by `title`, `name`, `checkout_date` and `due_date` -- If the client requests both sorting and pagination, pagination should be relative to the sorted order -- Check out the [will_paginate gem](https://github.com/mislav/will_paginate) - -### More Endpoints: Inventory Management -All these endpoints should support all 3 query parameters. All fields are sortable. - -#### `GET /movies/:title/current` -List customers that have _currently_ checked out a copy of the film - -URI parameters: -- `title`: Movie title (e.g. `Jaws`) - -Fields to return: -- `customer_id` -- `name` -- `postal_code` -- `checkout_date` -- `due_date` - -#### `GET /movies/:title/history` -List customers that have checked out a copy of the film _in the past_ - -URI parameters: -- `title`: Movie title (e.g. `Jaws`) - -Fields to return: -- `customer_id` -- `name` -- `postal_code` -- `checkout_date` -- `due_date` - -#### `GET /customers/:id/current` -List the movies a customer _currently_ has checked out - -URI parameters: -- `id`: Customer ID - -Fields to return: -- `title` -- `checkout_date` -- `due_date` - -#### `GET /customers/:id/history` -List the movies a customer has checked out _in the past_ - -URI parameters: -- `id`: Customer ID - -Fields to return: -- `title` -- `checkout_date` -- `due_date` - - -# Reference -- [Postman on Environments](https://www.getpostman.com/docs/environments) - \ No newline at end of file +* ... diff --git a/Rakefile b/Rakefile new file mode 100644 index 000000000..e85f91391 --- /dev/null +++ b/Rakefile @@ -0,0 +1,6 @@ +# Add your own tasks in files placed in lib/tasks ending in .rake, +# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. + +require_relative 'config/application' + +Rails.application.load_tasks diff --git a/app/channels/application_cable/channel.rb b/app/channels/application_cable/channel.rb new file mode 100644 index 000000000..d67269728 --- /dev/null +++ b/app/channels/application_cable/channel.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Channel < ActionCable::Channel::Base + end +end diff --git a/app/channels/application_cable/connection.rb b/app/channels/application_cable/connection.rb new file mode 100644 index 000000000..0ff5442f4 --- /dev/null +++ b/app/channels/application_cable/connection.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Connection < ActionCable::Connection::Base + end +end diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb new file mode 100644 index 000000000..4ac8823b0 --- /dev/null +++ b/app/controllers/application_controller.rb @@ -0,0 +1,2 @@ +class ApplicationController < ActionController::API +end diff --git a/app/controllers/concerns/.keep b/app/controllers/concerns/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/app/controllers/customers_controller.rb b/app/controllers/customers_controller.rb new file mode 100644 index 000000000..130f5da01 --- /dev/null +++ b/app/controllers/customers_controller.rb @@ -0,0 +1,11 @@ +class CustomersController < ApplicationController + + def index + customers = Customer.all + if customers.empty? + render status: :internal_server_error, json: { errors: "Something went horribly wrong with our database. Sorry for inconvenience" } + else + render json: customers, status: :ok + end + end +end diff --git a/app/controllers/movies_controller.rb b/app/controllers/movies_controller.rb new file mode 100644 index 000000000..d6672df37 --- /dev/null +++ b/app/controllers/movies_controller.rb @@ -0,0 +1,23 @@ +class MoviesController < ApplicationController + def index + movies = Movie.all + + if movies.empty? + render json: { errors: "Something is wrong with the database" }, + status: :internal_server_error + else + render json: movies, each_serializer: MovieListSerializer, status: :ok + end + end + + def show + movie = Movie.find_by(title: params[:title]) + if movie == nil + render status: :not_found, json:{ + "404 error": { "title": ["Movie #{params[:title]} not found"] } + } + else + render json: movie, status: :ok + end + end +end diff --git a/app/controllers/rentals_controller.rb b/app/controllers/rentals_controller.rb new file mode 100644 index 000000000..6fc38d80b --- /dev/null +++ b/app/controllers/rentals_controller.rb @@ -0,0 +1,69 @@ +class RentalsController < ApplicationController + + # example of params: {"rental"=>{ "customer_id"=>1 }, "title"=>"Psycho"} + def create + movie = Movie.find_by(title: params[:title]) + customer = Customer.find_by(id: params["rental"]["customer_id"]) + + if !movie.nil? && !customer.nil? + rental_info = { customer_id: customer.id, + movie_id: movie.id + } + if Rental.where(status: "checked out", + movie_id: movie.id, + customer_id: params["rental"]["customer_id"]).length > 0 + + render status: :bad_request, json: { error: "Customer has this movie currently checked out" } + else + rental = Rental.create_rental(rental_info) + if rental.errors.empty? + rental.save + render status: :ok, json: { rental_id: rental.id } + else + render status: :bad_request, json: { errors: rental.errors.messages } + end + end + + else + render status: :bad_request, json: { errors: "movie and/or customer does not exist" } + end + end + + def update + movie = Movie.find_by(title: params[:title]) + if movie + if Rental.where(status: "checked out", movie_id: movie.id, + customer_id: params["rental"]["customer_id"]).length == 0 + render status: :bad_request, json: { error: "You cannot check in movie, that you did not checked out "} + else + rental = Rental.find_by(movie_id: movie.id, customer_id: params["rental"]["customer_id"]) + if rental.status == "checked in" + render status: :ok, json: { error: "Movie is already checked in" } + else + rental.return_date = Date.today + rental.status = "checked in" + rental.customer.movies_checked_out_count -= 1 + rental.customer.save + rental.movie.available_inventory += 1 + rental.movie.save + if rental.save + render status: :ok, json: { status: rental.status } + else + render status: :bad_request, json: { errors: rental.errors.messages } + end + end + end + else + render status: :bad_request, json: { errors: "movie does not exist" } + end + end + + def overdue_rentals + overdue_rentals = Rental.overdue_movies + if overdue_rentals.empty? + render json: { message: "No overdue rentals was found" }, status: :ok + else + render json: overdue_rentals, each_serializer: OverdueListSerializer, status: :ok + end + end +end diff --git a/app/jobs/application_job.rb b/app/jobs/application_job.rb new file mode 100644 index 000000000..a009ace51 --- /dev/null +++ b/app/jobs/application_job.rb @@ -0,0 +1,2 @@ +class ApplicationJob < ActiveJob::Base +end diff --git a/app/mailers/application_mailer.rb b/app/mailers/application_mailer.rb new file mode 100644 index 000000000..286b2239d --- /dev/null +++ b/app/mailers/application_mailer.rb @@ -0,0 +1,4 @@ +class ApplicationMailer < ActionMailer::Base + default from: 'from@example.com' + layout 'mailer' +end diff --git a/app/models/application_record.rb b/app/models/application_record.rb new file mode 100644 index 000000000..10a4cba84 --- /dev/null +++ b/app/models/application_record.rb @@ -0,0 +1,3 @@ +class ApplicationRecord < ActiveRecord::Base + self.abstract_class = true +end diff --git a/app/models/concerns/.keep b/app/models/concerns/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/customer.rb b/app/models/customer.rb new file mode 100644 index 000000000..db49f49be --- /dev/null +++ b/app/models/customer.rb @@ -0,0 +1,16 @@ +class Customer < ApplicationRecord + has_many :rentals + + validates :name, presence: true + validates :registered_at, presence: true + validates :address, presence: true, length: {minimum: 3} + validates :city, presence: true, format: { with: /\A[a-zA-Z]+\z/ } + validates :state, presence: true, format: { with: /\A[a-zA-Z]+\z/} + validates :postal_code, presence: true, numericality: true, length: { is: 5 } + validates :phone, presence: true, format: { with: /\A(\+\d{1,2}\s)?\(?\d{3}\)?[\s.-]\d{3}[\s.-]\d{4}\z/ } + + def increase_checkout_count + self.movies_checked_out_count += 1 + self.save + end +end diff --git a/app/models/movie.rb b/app/models/movie.rb new file mode 100644 index 000000000..1f6fd92cc --- /dev/null +++ b/app/models/movie.rb @@ -0,0 +1,14 @@ +class Movie < ApplicationRecord + has_many :rentals + + validates :title, presence: true, uniqueness: true + validates :overview, presence: true + validates :release_date, presence: true + validates :inventory, presence: true, numericality: { greater_than: -1 } + validates :available_inventory, presence: true, numericality: { greater_than: -1 } + + def decrease_inventory + self.available_inventory -= 1 + self.save if self.valid? + end +end diff --git a/app/models/rental.rb b/app/models/rental.rb new file mode 100644 index 000000000..3ca9f23f7 --- /dev/null +++ b/app/models/rental.rb @@ -0,0 +1,49 @@ +require 'date' +class Rental < ApplicationRecord + belongs_to :movie + belongs_to :customer + + validates :check_out_date, presence: true + validates :due_date, presence: true + validates :status, inclusion: { in: [ "checked out", "checked in", "overdue" ] } + validate :movie_id, :check_inventory + # this validation also ran on overdue_movies - not just controller update + # validates :return_date, presence: true, on: :update + + + + def self.create_rental(info) + rental = Rental.new + rental.movie_id = info[:movie_id] + rental.customer_id = info[:customer_id] + rental.check_out_date = Date.today + rental.due_date = Date.today + 3 + rental.status = "checked out" + rental.movie.decrease_inventory + rental.customer.increase_checkout_count + rental.valid? + return rental + end + + def self.overdue_movies + array_of_overdues = [] + Rental.all.each do |rental| + next if rental.due_date == nil + if rental.due_date < Date.today + rental.status = "overdue" + rental.save + array_of_overdues << rental + end + end + return array_of_overdues + end + + def check_inventory + movie = self.movie + if movie.nil? || movie.available_inventory == 0 || movie.available_inventory.nil? + errors.add(:movie_id, "no available inventory") + end + end + + +end diff --git a/app/serializers/customer_serializer.rb b/app/serializers/customer_serializer.rb new file mode 100644 index 000000000..902e6fea9 --- /dev/null +++ b/app/serializers/customer_serializer.rb @@ -0,0 +1,3 @@ +class CustomerSerializer < ActiveModel::Serializer + attributes :id, :name, :registered_at, :postal_code, :phone, :movies_checked_out_count +end diff --git a/app/serializers/movie_list_serializer.rb b/app/serializers/movie_list_serializer.rb new file mode 100644 index 000000000..e142b54f2 --- /dev/null +++ b/app/serializers/movie_list_serializer.rb @@ -0,0 +1,3 @@ +class MovieListSerializer < ActiveModel::Serializer + attributes :title, :release_date +end diff --git a/app/serializers/movie_serializer.rb b/app/serializers/movie_serializer.rb new file mode 100644 index 000000000..656643cdf --- /dev/null +++ b/app/serializers/movie_serializer.rb @@ -0,0 +1,3 @@ +class MovieSerializer < ActiveModel::Serializer + attributes :title, :overview, :release_date, :inventory, :available_inventory +end diff --git a/app/serializers/overdue_list_serializer.rb b/app/serializers/overdue_list_serializer.rb new file mode 100644 index 000000000..5e67cd764 --- /dev/null +++ b/app/serializers/overdue_list_serializer.rb @@ -0,0 +1,17 @@ +class OverdueListSerializer < ActiveModel::Serializer + attributes :customer_id, :due_date, :check_out_date, + :title, :name, :postal_code + + def title + object.movie.title + end + + def name + object.customer.name + end + + def postal_code + object.customer.postal_code + end + +end diff --git a/app/views/layouts/mailer.html.erb b/app/views/layouts/mailer.html.erb new file mode 100644 index 000000000..cbd34d2e9 --- /dev/null +++ b/app/views/layouts/mailer.html.erb @@ -0,0 +1,13 @@ + + + + + + + + + <%= yield %> + + diff --git a/app/views/layouts/mailer.text.erb b/app/views/layouts/mailer.text.erb new file mode 100644 index 000000000..37f0bddbd --- /dev/null +++ b/app/views/layouts/mailer.text.erb @@ -0,0 +1 @@ +<%= yield %> diff --git a/bin/bundle b/bin/bundle new file mode 100755 index 000000000..66e9889e8 --- /dev/null +++ b/bin/bundle @@ -0,0 +1,3 @@ +#!/usr/bin/env ruby +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__) +load Gem.bin_path('bundler', 'bundle') diff --git a/bin/rails b/bin/rails new file mode 100755 index 000000000..5badb2fde --- /dev/null +++ b/bin/rails @@ -0,0 +1,9 @@ +#!/usr/bin/env ruby +begin + load File.expand_path('../spring', __FILE__) +rescue LoadError => e + raise unless e.message.include?('spring') +end +APP_PATH = File.expand_path('../config/application', __dir__) +require_relative '../config/boot' +require 'rails/commands' diff --git a/bin/rake b/bin/rake new file mode 100755 index 000000000..d87d5f578 --- /dev/null +++ b/bin/rake @@ -0,0 +1,9 @@ +#!/usr/bin/env ruby +begin + load File.expand_path('../spring', __FILE__) +rescue LoadError => e + raise unless e.message.include?('spring') +end +require_relative '../config/boot' +require 'rake' +Rake.application.run diff --git a/bin/setup b/bin/setup new file mode 100755 index 000000000..e620b4dad --- /dev/null +++ b/bin/setup @@ -0,0 +1,34 @@ +#!/usr/bin/env ruby +require 'pathname' +require 'fileutils' +include FileUtils + +# path to your application root. +APP_ROOT = Pathname.new File.expand_path('../../', __FILE__) + +def system!(*args) + system(*args) || abort("\n== Command #{args} failed ==") +end + +chdir APP_ROOT do + # This script is a starting point to setup your application. + # Add necessary setup steps to this file. + + puts '== Installing dependencies ==' + system! 'gem install bundler --conservative' + system('bundle check') || system!('bundle install') + + # puts "\n== Copying sample files ==" + # unless File.exist?('config/database.yml') + # cp 'config/database.yml.sample', 'config/database.yml' + # end + + puts "\n== Preparing database ==" + system! 'bin/rails db:setup' + + puts "\n== Removing old logs and tempfiles ==" + system! 'bin/rails log:clear tmp:clear' + + puts "\n== Restarting application server ==" + system! 'bin/rails restart' +end diff --git a/bin/spring b/bin/spring new file mode 100755 index 000000000..fb2ec2ebb --- /dev/null +++ b/bin/spring @@ -0,0 +1,17 @@ +#!/usr/bin/env ruby + +# This file loads spring without using Bundler, in order to be fast. +# It gets overwritten when you run the `spring binstub` command. + +unless defined?(Spring) + require 'rubygems' + require 'bundler' + + lockfile = Bundler::LockfileParser.new(Bundler.default_lockfile.read) + spring = lockfile.specs.detect { |spec| spec.name == "spring" } + if spring + Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path + gem 'spring', spring.version + require 'spring/binstub' + end +end diff --git a/bin/update b/bin/update new file mode 100755 index 000000000..a8e4462f2 --- /dev/null +++ b/bin/update @@ -0,0 +1,29 @@ +#!/usr/bin/env ruby +require 'pathname' +require 'fileutils' +include FileUtils + +# path to your application root. +APP_ROOT = Pathname.new File.expand_path('../../', __FILE__) + +def system!(*args) + system(*args) || abort("\n== Command #{args} failed ==") +end + +chdir APP_ROOT do + # This script is a way to update your development environment automatically. + # Add necessary update steps to this file. + + puts '== Installing dependencies ==' + system! 'gem install bundler --conservative' + system('bundle check') || system!('bundle install') + + puts "\n== Updating database ==" + system! 'bin/rails db:migrate' + + puts "\n== Removing old logs and tempfiles ==" + system! 'bin/rails log:clear tmp:clear' + + puts "\n== Restarting application server ==" + system! 'bin/rails restart' +end diff --git a/config.ru b/config.ru new file mode 100644 index 000000000..f7ba0b527 --- /dev/null +++ b/config.ru @@ -0,0 +1,5 @@ +# This file is used by Rack-based servers to start the application. + +require_relative 'config/environment' + +run Rails.application diff --git a/config/application.rb b/config/application.rb new file mode 100644 index 000000000..4fbf1ef3a --- /dev/null +++ b/config/application.rb @@ -0,0 +1,34 @@ +require_relative 'boot' + +require "rails" +# Pick the frameworks you want: +require "active_model/railtie" +require "active_job/railtie" +require "active_record/railtie" +require "action_controller/railtie" +require "action_mailer/railtie" +require "action_view/railtie" +require "action_cable/engine" +# require "sprockets/railtie" +require "rails/test_unit/railtie" + +# Require the gems listed in Gemfile, including any gems +# you've limited to :test, :development, or :production. +Bundler.require(*Rails.groups) + +module VideoStoreAPI + class Application < Rails::Application + # Force new test files to be generated in the minitest-spec style + config.generators do |g| + g.test_framework :minitest, spec: true + end + # Settings in config/environments/* take precedence over those specified here. + # Application configuration should go into files in config/initializers + # -- all .rb files in that directory are automatically loaded. + + # Only loads a smaller set of middleware suitable for API only apps. + # Middleware like session, flash, cookies can be added back manually. + # Skip views, helpers and assets when generating a new resource. + config.api_only = true + end +end diff --git a/config/boot.rb b/config/boot.rb new file mode 100644 index 000000000..30f5120df --- /dev/null +++ b/config/boot.rb @@ -0,0 +1,3 @@ +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__) + +require 'bundler/setup' # Set up gems listed in the Gemfile. diff --git a/config/cable.yml b/config/cable.yml new file mode 100644 index 000000000..0bbde6f74 --- /dev/null +++ b/config/cable.yml @@ -0,0 +1,9 @@ +development: + adapter: async + +test: + adapter: async + +production: + adapter: redis + url: redis://localhost:6379/1 diff --git a/config/database.yml b/config/database.yml new file mode 100644 index 000000000..aead51124 --- /dev/null +++ b/config/database.yml @@ -0,0 +1,85 @@ +# PostgreSQL. Versions 9.1 and up are supported. +# +# Install the pg driver: +# gem install pg +# On OS X with Homebrew: +# gem install pg -- --with-pg-config=/usr/local/bin/pg_config +# On OS X with MacPorts: +# gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config +# On Windows: +# gem install pg +# Choose the win32 build. +# Install PostgreSQL and put its /bin directory on your path. +# +# Configure Using Gemfile +# gem 'pg' +# +default: &default + adapter: postgresql + encoding: unicode + # For details on connection pooling, see rails configuration guide + # http://guides.rubyonrails.org/configuring.html#database-pooling + pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> + +development: + <<: *default + database: VideoStoreAPI_development + + # The specified database role being used to connect to postgres. + # To create additional roles in postgres see `$ createuser --help`. + # When left blank, postgres will use the default role. This is + # the same name as the operating system user that initialized the database. + #username: VideoStoreAPI + + # The password associated with the postgres role (username). + #password: + + # Connect on a TCP socket. Omitted by default since the client uses a + # domain socket that doesn't need configuration. Windows does not have + # domain sockets, so uncomment these lines. + #host: localhost + + # The TCP port the server listens on. Defaults to 5432. + # If your server runs on a different port number, change accordingly. + #port: 5432 + + # Schema search path. The server defaults to $user,public + #schema_search_path: myapp,sharedapp,public + + # Minimum log levels, in increasing order: + # debug5, debug4, debug3, debug2, debug1, + # log, notice, warning, error, fatal, and panic + # Defaults to warning. + #min_messages: notice + +# Warning: The database defined as "test" will be erased and +# re-generated from your development database when you run "rake". +# Do not set this db to the same as development or production. +test: + <<: *default + database: VideoStoreAPI_test + +# As with config/secrets.yml, you never want to store sensitive information, +# like your database password, in your source code. If your source code is +# ever seen by anyone, they now have access to your database. +# +# Instead, provide the password as a unix environment variable when you boot +# the app. Read http://guides.rubyonrails.org/configuring.html#configuring-a-database +# for a full rundown on how to provide these environment variables in a +# production deployment. +# +# On Heroku and other platform providers, you may have a full connection URL +# available as an environment variable. For example: +# +# DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase" +# +# You can use this database configuration with: +# +# production: +# url: <%= ENV['DATABASE_URL'] %> +# +production: + <<: *default + database: VideoStoreAPI_production + username: VideoStoreAPI + password: <%= ENV['VIDEOSTOREAPI_DATABASE_PASSWORD'] %> diff --git a/config/environment.rb b/config/environment.rb new file mode 100644 index 000000000..426333bb4 --- /dev/null +++ b/config/environment.rb @@ -0,0 +1,5 @@ +# Load the Rails application. +require_relative 'application' + +# Initialize the Rails application. +Rails.application.initialize! diff --git a/config/environments/development.rb b/config/environments/development.rb new file mode 100644 index 000000000..082a013ab --- /dev/null +++ b/config/environments/development.rb @@ -0,0 +1,47 @@ +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # In the development environment your application's code is reloaded on + # every request. This slows down response time but is perfect for development + # since you don't have to restart the web server when you make code changes. + config.cache_classes = false + + # Do not eager load code on boot. + config.eager_load = false + + # Show full error reports. + config.consider_all_requests_local = true + + # Enable/disable caching. By default caching is disabled. + if Rails.root.join('tmp/caching-dev.txt').exist? + config.action_controller.perform_caching = true + + config.cache_store = :memory_store + config.public_file_server.headers = { + 'Cache-Control' => 'public, max-age=172800' + } + else + config.action_controller.perform_caching = false + + config.cache_store = :null_store + end + + # Don't care if the mailer can't send. + config.action_mailer.raise_delivery_errors = false + + config.action_mailer.perform_caching = false + + # Print deprecation notices to the Rails logger. + config.active_support.deprecation = :log + + # Raise an error on page load if there are pending migrations. + config.active_record.migration_error = :page_load + + + # Raises error for missing translations + # config.action_view.raise_on_missing_translations = true + + # Use an evented file watcher to asynchronously detect changes in source code, + # routes, locales, etc. This feature depends on the listen gem. + config.file_watcher = ActiveSupport::EventedFileUpdateChecker +end diff --git a/config/environments/production.rb b/config/environments/production.rb new file mode 100644 index 000000000..49275a9d6 --- /dev/null +++ b/config/environments/production.rb @@ -0,0 +1,78 @@ +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # Code is not reloaded between requests. + config.cache_classes = true + + # Eager load code on boot. This eager loads most of Rails and + # your application in memory, allowing both threaded web servers + # and those relying on copy on write to perform better. + # Rake tasks automatically ignore this option for performance. + config.eager_load = true + + # Full error reports are disabled and caching is turned on. + config.consider_all_requests_local = false + config.action_controller.perform_caching = true + + # Disable serving static files from the `/public` folder by default since + # Apache or NGINX already handles this. + config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present? + + + # Enable serving of images, stylesheets, and JavaScripts from an asset server. + # config.action_controller.asset_host = 'http://assets.example.com' + + # Specifies the header that your server uses for sending files. + # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache + # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX + + # Mount Action Cable outside main process or domain + # config.action_cable.mount_path = nil + # config.action_cable.url = 'wss://example.com/cable' + # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ] + + # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. + # config.force_ssl = true + + # Use the lowest log level to ensure availability of diagnostic information + # when problems arise. + config.log_level = :debug + + # Prepend all log lines with the following tags. + config.log_tags = [ :request_id ] + + # Use a different cache store in production. + # config.cache_store = :mem_cache_store + + # Use a real queuing backend for Active Job (and separate queues per environment) + # config.active_job.queue_adapter = :resque + # config.active_job.queue_name_prefix = "VideoStoreAPI_#{Rails.env}" + config.action_mailer.perform_caching = false + + # Ignore bad email addresses and do not raise email delivery errors. + # Set this to true and configure the email server for immediate delivery to raise delivery errors. + # config.action_mailer.raise_delivery_errors = false + + # Enable locale fallbacks for I18n (makes lookups for any locale fall back to + # the I18n.default_locale when a translation cannot be found). + config.i18n.fallbacks = true + + # Send deprecation notices to registered listeners. + config.active_support.deprecation = :notify + + # Use default logging formatter so that PID and timestamp are not suppressed. + config.log_formatter = ::Logger::Formatter.new + + # Use a different logger for distributed setups. + # require 'syslog/logger' + # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name') + + if ENV["RAILS_LOG_TO_STDOUT"].present? + logger = ActiveSupport::Logger.new(STDOUT) + logger.formatter = config.log_formatter + config.logger = ActiveSupport::TaggedLogging.new(logger) + end + + # Do not dump schema after migrations. + config.active_record.dump_schema_after_migration = false +end diff --git a/config/environments/test.rb b/config/environments/test.rb new file mode 100644 index 000000000..30587ef6d --- /dev/null +++ b/config/environments/test.rb @@ -0,0 +1,42 @@ +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # The test environment is used exclusively to run your application's + # test suite. You never need to work with it otherwise. Remember that + # your test database is "scratch space" for the test suite and is wiped + # and recreated between test runs. Don't rely on the data there! + config.cache_classes = true + + # Do not eager load code on boot. This avoids loading your whole application + # just for the purpose of running a single test. If you are using a tool that + # preloads Rails for running tests, you may have to set it to true. + config.eager_load = false + + # Configure public file server for tests with Cache-Control for performance. + config.public_file_server.enabled = true + config.public_file_server.headers = { + 'Cache-Control' => 'public, max-age=3600' + } + + # Show full error reports and disable caching. + config.consider_all_requests_local = true + config.action_controller.perform_caching = false + + # Raise exceptions instead of rendering exception templates. + config.action_dispatch.show_exceptions = false + + # Disable request forgery protection in test environment. + config.action_controller.allow_forgery_protection = false + config.action_mailer.perform_caching = false + + # Tell Action Mailer not to deliver emails to the real world. + # The :test delivery method accumulates sent emails in the + # ActionMailer::Base.deliveries array. + config.action_mailer.delivery_method = :test + + # Print deprecation notices to the stderr. + config.active_support.deprecation = :stderr + + # Raises error for missing translations + # config.action_view.raise_on_missing_translations = true +end diff --git a/config/initializers/application_controller_renderer.rb b/config/initializers/application_controller_renderer.rb new file mode 100644 index 000000000..51639b67a --- /dev/null +++ b/config/initializers/application_controller_renderer.rb @@ -0,0 +1,6 @@ +# Be sure to restart your server when you modify this file. + +# ApplicationController.renderer.defaults.merge!( +# http_host: 'example.org', +# https: false +# ) diff --git a/config/initializers/backtrace_silencers.rb b/config/initializers/backtrace_silencers.rb new file mode 100644 index 000000000..59385cdf3 --- /dev/null +++ b/config/initializers/backtrace_silencers.rb @@ -0,0 +1,7 @@ +# Be sure to restart your server when you modify this file. + +# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces. +# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ } + +# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code. +# Rails.backtrace_cleaner.remove_silencers! diff --git a/config/initializers/cors.rb b/config/initializers/cors.rb new file mode 100644 index 000000000..3b1c1b5ed --- /dev/null +++ b/config/initializers/cors.rb @@ -0,0 +1,16 @@ +# Be sure to restart your server when you modify this file. + +# Avoid CORS issues when API is called from the frontend app. +# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests. + +# Read more: https://github.com/cyu/rack-cors + +# Rails.application.config.middleware.insert_before 0, Rack::Cors do +# allow do +# origins 'example.com' +# +# resource '*', +# headers: :any, +# methods: [:get, :post, :put, :patch, :delete, :options, :head] +# end +# end diff --git a/config/initializers/filter_parameter_logging.rb b/config/initializers/filter_parameter_logging.rb new file mode 100644 index 000000000..4a994e1e7 --- /dev/null +++ b/config/initializers/filter_parameter_logging.rb @@ -0,0 +1,4 @@ +# Be sure to restart your server when you modify this file. + +# Configure sensitive parameters which will be filtered from the log file. +Rails.application.config.filter_parameters += [:password] diff --git a/config/initializers/inflections.rb b/config/initializers/inflections.rb new file mode 100644 index 000000000..ac033bf9d --- /dev/null +++ b/config/initializers/inflections.rb @@ -0,0 +1,16 @@ +# Be sure to restart your server when you modify this file. + +# Add new inflection rules using the following format. Inflections +# are locale specific, and you may define rules for as many different +# locales as you wish. All of these examples are active by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.plural /^(ox)$/i, '\1en' +# inflect.singular /^(ox)en/i, '\1' +# inflect.irregular 'person', 'people' +# inflect.uncountable %w( fish sheep ) +# end + +# These inflection rules are supported but not enabled by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.acronym 'RESTful' +# end diff --git a/config/initializers/mime_types.rb b/config/initializers/mime_types.rb new file mode 100644 index 000000000..dc1899682 --- /dev/null +++ b/config/initializers/mime_types.rb @@ -0,0 +1,4 @@ +# Be sure to restart your server when you modify this file. + +# Add new mime types for use in respond_to blocks: +# Mime::Type.register "text/richtext", :rtf diff --git a/config/initializers/new_framework_defaults.rb b/config/initializers/new_framework_defaults.rb new file mode 100644 index 000000000..d859e4bea --- /dev/null +++ b/config/initializers/new_framework_defaults.rb @@ -0,0 +1,18 @@ +# Be sure to restart your server when you modify this file. +# +# This file contains migration options to ease your Rails 5.0 upgrade. +# +# Read the Guide for Upgrading Ruby on Rails for more info on each option. + +# Make Ruby 2.4 preserve the timezone of the receiver when calling `to_time`. +# Previous versions had false. +ActiveSupport.to_time_preserves_timezone = true + +# Require `belongs_to` associations by default. Previous versions had false. +Rails.application.config.active_record.belongs_to_required_by_default = true + +# Do not halt callback chains when a callback returns false. Previous versions had true. +ActiveSupport.halt_callback_chains_on_return_false = false + +# Configure SSL options to enable HSTS with subdomains. Previous versions had false. +Rails.application.config.ssl_options = { hsts: { subdomains: true } } diff --git a/config/initializers/wrap_parameters.rb b/config/initializers/wrap_parameters.rb new file mode 100644 index 000000000..bbfc3961b --- /dev/null +++ b/config/initializers/wrap_parameters.rb @@ -0,0 +1,14 @@ +# Be sure to restart your server when you modify this file. + +# This file contains settings for ActionController::ParamsWrapper which +# is enabled by default. + +# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array. +ActiveSupport.on_load(:action_controller) do + wrap_parameters format: [:json] +end + +# To enable root element in JSON for ActiveRecord objects. +# ActiveSupport.on_load(:active_record) do +# self.include_root_in_json = true +# end diff --git a/config/locales/en.yml b/config/locales/en.yml new file mode 100644 index 000000000..065395716 --- /dev/null +++ b/config/locales/en.yml @@ -0,0 +1,23 @@ +# Files in the config/locales directory are used for internationalization +# and are automatically loaded by Rails. If you want to use locales other +# than English, add the necessary files in this directory. +# +# To use the locales, use `I18n.t`: +# +# I18n.t 'hello' +# +# In views, this is aliased to just `t`: +# +# <%= t('hello') %> +# +# To use a different locale, set it with `I18n.locale`: +# +# I18n.locale = :es +# +# This would use the information in config/locales/es.yml. +# +# To learn more, please read the Rails Internationalization guide +# available at http://guides.rubyonrails.org/i18n.html. + +en: + hello: "Hello world" diff --git a/config/puma.rb b/config/puma.rb new file mode 100644 index 000000000..c7f311f81 --- /dev/null +++ b/config/puma.rb @@ -0,0 +1,47 @@ +# Puma can serve each request in a thread from an internal thread pool. +# The `threads` method setting takes two numbers a minimum and maximum. +# Any libraries that use thread pools should be configured to match +# the maximum value specified for Puma. Default is set to 5 threads for minimum +# and maximum, this matches the default thread size of Active Record. +# +threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }.to_i +threads threads_count, threads_count + +# Specifies the `port` that Puma will listen on to receive requests, default is 3000. +# +port ENV.fetch("PORT") { 3000 } + +# Specifies the `environment` that Puma will run in. +# +environment ENV.fetch("RAILS_ENV") { "development" } + +# Specifies the number of `workers` to boot in clustered mode. +# Workers are forked webserver processes. If using threads and workers together +# the concurrency of the application would be max `threads` * `workers`. +# Workers do not work on JRuby or Windows (both of which do not support +# processes). +# +# workers ENV.fetch("WEB_CONCURRENCY") { 2 } + +# Use the `preload_app!` method when specifying a `workers` number. +# This directive tells Puma to first boot the application and load code +# before forking the application. This takes advantage of Copy On Write +# process behavior so workers use less memory. If you use this option +# you need to make sure to reconnect any threads in the `on_worker_boot` +# block. +# +# preload_app! + +# The code in the `on_worker_boot` will be called if you are using +# clustered mode by specifying a number of `workers`. After each worker +# process is booted this block will be run, if you are using `preload_app!` +# option you will want to use this block to reconnect to any threads +# or connections that may have been created at application boot, Ruby +# cannot share connections between processes. +# +# on_worker_boot do +# ActiveRecord::Base.establish_connection if defined?(ActiveRecord) +# end + +# Allow puma to be restarted by `rails restart` command. +plugin :tmp_restart diff --git a/config/routes.rb b/config/routes.rb new file mode 100644 index 000000000..65a6afc67 --- /dev/null +++ b/config/routes.rb @@ -0,0 +1,14 @@ +Rails.application.routes.draw do + # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html + + get "customers", to: "customers#index", as: "customers" + get "customers/:id", to: "customers#show" + + get 'movies', to: 'movies#index', as: 'movies' + get 'movies/:title', to: 'movies#show', as: 'movie' + + post "/rentals/:title/check-out", to: "rentals#create", as: "create_rental" + patch "/rentals/:title/check-in", to: "rentals#update", as: "update_rental" + + get "/rentals/overdue", to: "rentals#overdue_rentals", as: "overdue_rentals" +end diff --git a/config/secrets.yml b/config/secrets.yml new file mode 100644 index 000000000..239614db0 --- /dev/null +++ b/config/secrets.yml @@ -0,0 +1,22 @@ +# Be sure to restart your server when you modify this file. + +# Your secret key is used for verifying the integrity of signed cookies. +# If you change this key, all old signed cookies will become invalid! + +# Make sure the secret is at least 30 characters and all random, +# no regular words or you'll be exposed to dictionary attacks. +# You can use `rails secret` to generate a secure secret key. + +# Make sure the secrets in this file are kept private +# if you're sharing your code publicly. + +development: + secret_key_base: 0c18084594d221ebed85d84e0f6135d42e7089bd3dfa15587fe5d6466394cf1674795d42a0f3196c7be4a06596bb3a8276f96550a45140f47444df4cf358c315 + +test: + secret_key_base: 44307eb86b04672d8cecf06efb074f0d47355779f30a83912984b2f995fbc7cf5238840dde861ff2b3215aa243571c0075d3a2aa9eed1d12106865f7ee2698aa + +# Do not keep production secrets in the repository, +# instead read values from the environment. +production: + secret_key_base: <%= ENV["SECRET_KEY_BASE"] %> diff --git a/config/spring.rb b/config/spring.rb new file mode 100644 index 000000000..c9119b40c --- /dev/null +++ b/config/spring.rb @@ -0,0 +1,6 @@ +%w( + .ruby-version + .rbenv-vars + tmp/restart.txt + tmp/caching-dev.txt +).each { |path| Spring.watch(path) } diff --git a/db/migrate/20170509212639_create_customers.rb b/db/migrate/20170509212639_create_customers.rb new file mode 100644 index 000000000..12441a3db --- /dev/null +++ b/db/migrate/20170509212639_create_customers.rb @@ -0,0 +1,15 @@ +class CreateCustomers < ActiveRecord::Migration[5.0] + def change + create_table :customers do |t| + t.string :name + t.string :address + t.string :city + t.string :state + t.string :postal_code + t.string :phone + t.string :registered_at + t.integer :movies_checked_out_count, default: 0 + t.timestamps + end + end +end diff --git a/db/migrate/20170509212649_create_movies.rb b/db/migrate/20170509212649_create_movies.rb new file mode 100644 index 000000000..18db6c02d --- /dev/null +++ b/db/migrate/20170509212649_create_movies.rb @@ -0,0 +1,12 @@ +class CreateMovies < ActiveRecord::Migration[5.0] + def change + create_table :movies do |t| + t.string :title + t.string :overview + t.string :release_date + t.integer :inventory + t.integer :available_inventory + t.timestamps + end + end +end diff --git a/db/migrate/20170510174106_create_rentals.rb b/db/migrate/20170510174106_create_rentals.rb new file mode 100644 index 000000000..b48ef352b --- /dev/null +++ b/db/migrate/20170510174106_create_rentals.rb @@ -0,0 +1,13 @@ +class CreateRentals < ActiveRecord::Migration[5.0] + def change + create_table :rentals do |t| + t.belongs_to :movie + t.belongs_to :customer + t.date :check_out_date + t.date :return_date + t.date :due_date + t.string :status + t.timestamps + end + end +end diff --git a/db/schema.rb b/db/schema.rb new file mode 100644 index 000000000..cd92f0fdc --- /dev/null +++ b/db/schema.rb @@ -0,0 +1,54 @@ +# This file is auto-generated from the current state of the database. Instead +# of editing this file, please use the migrations feature of Active Record to +# incrementally modify your database, and then regenerate this schema definition. +# +# Note that this schema.rb definition is the authoritative source for your +# database schema. If you need to create the application database on another +# system, you should be using db:schema:load, not running all the migrations +# from scratch. The latter is a flawed and unsustainable approach (the more migrations +# you'll amass, the slower it'll run and the greater likelihood for issues). +# +# It's strongly recommended that you check this file into your version control system. + +ActiveRecord::Schema.define(version: 20170510174106) do + + # These are extensions that must be enabled in order to support this database + enable_extension "plpgsql" + + create_table "customers", force: :cascade do |t| + t.string "name" + t.string "address" + t.string "city" + t.string "state" + t.string "postal_code" + t.string "phone" + t.string "registered_at" + t.integer "movies_checked_out_count", default: 0 + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + end + + create_table "movies", force: :cascade do |t| + t.string "title" + t.string "overview" + t.string "release_date" + t.integer "inventory" + t.integer "available_inventory" + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + end + + create_table "rentals", force: :cascade do |t| + t.integer "movie_id" + t.integer "customer_id" + t.date "check_out_date" + t.date "return_date" + t.date "due_date" + t.string "status" + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + t.index ["customer_id"], name: "index_rentals_on_customer_id", using: :btree + t.index ["movie_id"], name: "index_rentals_on_movie_id", using: :btree + end + +end diff --git a/db/seeds.rb b/db/seeds.rb index 5322340ba..21e49d16b 100644 --- a/db/seeds.rb +++ b/db/seeds.rb @@ -1,7 +1,24 @@ -JSON.parse(File.read('db/seeds/customers.json')).each do |customer| - Customer.create!(customer) +# This file should contain all the record creation needed to seed the database with its default values. +# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup). +# +# Examples: +# +# movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }]) +# Character.create(name: 'Luke', movie: movies.first) + + +raw_data = File.read(Rails.root.join("db", "seeds", "movies.json")) +movies = JSON.parse(raw_data) + +movies.each do |movie| + movie["available_inventory"] = movie["inventory"] + Movie.create(movie) end -JSON.parse(File.read('db/seeds/movies.json')).each do |movie| - Movie.create!(movie) +raw_data = File.read( Rails.root.join('db', 'seeds', 'customers.json')) +customers = JSON.parse(raw_data) + +customers.each do |customer| + customer.delete('account_credit') + Customer.create(customer) end diff --git a/lib/tasks/.keep b/lib/tasks/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/log/.keep b/log/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/public/robots.txt b/public/robots.txt new file mode 100644 index 000000000..3c9c7c01f --- /dev/null +++ b/public/robots.txt @@ -0,0 +1,5 @@ +# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file +# +# To ban all spiders from the entire site uncomment the next two lines: +# User-agent: * +# Disallow: / diff --git a/test/controllers/.keep b/test/controllers/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/test/controllers/customers_controller_test.rb b/test/controllers/customers_controller_test.rb new file mode 100644 index 000000000..7be6d3e58 --- /dev/null +++ b/test/controllers/customers_controller_test.rb @@ -0,0 +1,44 @@ +require "test_helper" + +describe CustomersController do + describe "index" do + + it "route is working" do + get customers_path + must_respond_with :success + end + + it "returns internal_server_error if there are no customers in db" do + Customer.destroy_all + get customers_path + must_respond_with :internal_server_error + response.parsed_body.must_include "errors" + end + + it "returns json" do + get customers_path + response.header['Content-Type'].must_include 'json' + end + + it "returns an Array class object" do + get customers_path + body = JSON.parse(response.body) + body.must_be_kind_of Array + end + + it "returns all of the customers" do + get customers_path + body = JSON.parse(response.body) + body.length.must_equal Customer.count + end + + it "returns customers with exactly the required fields" do + keys = %w(id movies_checked_out_count name phone postal_code registered_at ) + get customers_path + body = JSON.parse(response.body) + body.each do |customer| + customer.keys.sort.must_equal keys + end + end + end +end diff --git a/test/controllers/movies_controller_test.rb b/test/controllers/movies_controller_test.rb new file mode 100644 index 000000000..964dc4985 --- /dev/null +++ b/test/controllers/movies_controller_test.rb @@ -0,0 +1,66 @@ +require "test_helper" + +describe MoviesController do + describe 'Index' do + + it 'is a real working api route' do + get movies_path + must_respond_with :success + end + + it 'returns json' do + get movies_path + response.header['Content-Type'].must_include 'json' + end + + it 'returns an array of hashes' do + get movies_path + response.parsed_body.must_be_instance_of Array + response.parsed_body.each do |movie_hash| + movie_hash.must_be_instance_of Hash + end + end + + it 'returns the correct amount of movies' do + get movies_path + response.parsed_body.length.must_equal Movie.count + end + + it 'returns movies with the expected fields' do + keys = %w(release_date title) + get movies_path + response.parsed_body.each do |movie| + movie.keys.sort.must_equal keys + end + end + + it 'returns 500 if there are no movies in db' do + Movie.destroy_all + get movies_path + response.status.must_equal 500 + response.parsed_body.must_include "errors" + end + end + + describe "show" do + + it "can get a movie" do + get movie_path(movies(:movie2).title) + must_respond_with :success + response.parsed_body["title"].must_include "Psycho" + end + + it 'returns json' do + get movie_path(movies(:movie1).title) + response.header['Content-Type'].must_include 'json' + end + + it "respond with 404 error if given movie id that doesnt exist" do + title = "Title that DNE" + get movie_path(title) + must_respond_with :not_found + body = JSON.parse(response.body) + body.must_include "404 error" + end + end +end diff --git a/test/controllers/rentals_controller_test.rb b/test/controllers/rentals_controller_test.rb new file mode 100644 index 000000000..e8cffd9dd --- /dev/null +++ b/test/controllers/rentals_controller_test.rb @@ -0,0 +1,196 @@ +require "test_helper" +require 'date' +describe RentalsController do + + describe 'create' do + before do + @bad_customer_id = Customer.all.last.id + 1 + @customer = customers(:good_customer2) + @movie = movies(:movie3) + end + + let(:rental_data) { { customer_id: @customer.id } } + + it 'creates a new rental' do + post create_rental_path(movies(:movie3).title), params: { rental: rental_data } + must_respond_with :success + response.parsed_body.must_include "rental_id" + Rental.find(response.parsed_body["rental_id"]).movie_id.must_equal @movie.id + Rental.find(response.parsed_body["rental_id"]).customer_id.must_equal @customer.id + end + + it 'wont create a rental if customer already has that movie checked out' do + post create_rental_path(@movie.title), params: { rental: rental_data } + must_respond_with :success + post create_rental_path(@movie.title), params: { rental: rental_data } + must_respond_with :bad_request + response.parsed_body.must_include "error" + end + + it 'allows a customer to checkout out a movie again, as long as all past rentals, same movie, have status checked in' do + post create_rental_path(@movie.title), params: { rental: rental_data } + must_respond_with :success + patch update_rental_path(@movie.title), params: { rental: rental_data } + must_respond_with :success + post create_rental_path(@movie.title), params: { rental: rental_data } + must_respond_with :success + end + + it 'returns bad request if given customer id DNE' do + post create_rental_path(@movie.title), params: { rental: { customer_id: @bad_customer_id } } + must_respond_with :bad_request + response.parsed_body.must_include "errors" + end + + it 'returns bad request if given movie title DNE' do + post create_rental_path("Harry Potter"), params: { rental: rental_data } + must_respond_with :bad_request + response.parsed_body.must_include "errors" + end + + it 'updates movie checkout count for customer' do + count_before = @customer.movies_checked_out_count + post create_rental_path(movies(:movie5).title), params: { rental: rental_data } + @customer.reload + count_after = @customer.movies_checked_out_count + (count_after - count_before).must_equal 1 + end + + it 'updates available inventory' do + movie = movies(:movie5) + inventory_count_before = movie.available_inventory + post create_rental_path(movie.title), params: { rental: rental_data } + movie.reload + inventory_count_after = movie.available_inventory + (inventory_count_after - inventory_count_before).must_equal -1 + end + + it 'does not update available inventory and movie checkout count if available inventory is 0' do + movie = movies(:movie4) + movies_count_before = @customer.movies_checked_out_count + inventory_count_before = movie.available_inventory + post create_rental_path(movie.title), params: { rental: rental_data } + inventory_count_after = movie.available_inventory + movies_count_after = @customer.movies_checked_out_count + (inventory_count_after - inventory_count_before).must_equal 0 + (movies_count_before - movies_count_after).must_equal 0 + end + end + + describe "overdue_rentals" do + + it 'is a real working api route' do + get overdue_rentals_path + must_respond_with :success + end + + it 'returns json' do + get overdue_rentals_path + response.header['Content-Type'].must_include 'json' + end + + it 'returns an array of hashes' do + # skip + get overdue_rentals_path + response.parsed_body.must_be_instance_of Array + response.parsed_body.each do |overdue_rentals_hash| + overdue_rentals_hash.must_be_instance_of Hash + end + end + + it 'returns the correct amount of overdue rentals' do + get overdue_rentals_path + overdue_rentals = Rental.where(status: "overdue") + response.parsed_body.length.must_equal overdue_rentals.length + end + + it 'returns overdue rentals with the expected fields' do + keys = %w( check_out_date customer_id due_date name postal_code title ) + get overdue_rentals_path + response.parsed_body.each do |rental| + rental.keys.sort.must_equal keys + end + end + + it 'returns json message if there are no overdue movies' do + Rental.destroy_all + get overdue_rentals_path + # learning note: status will return the HTTP status code + # response.status.must_equal 200 + # learning note: must_respond_with lets you test to the HTTP status message + must_respond_with :success + response.parsed_body.must_include "message" + end + end + + describe "update" do + before do + customer = customers(:good_customer) + @rental_data = { "customer_id": customer.id } + @movie = movies(:movie5) + post create_rental_path(@movie.title), params: { rental: @rental_data } + rental_id = response.parsed_body["rental_id"] + @rental = Rental.find_by(id: rental_id) + @bad_customer_id = Customer.all.last.id + 1 + @bad_rental_data = { customer_id: @bad_customer_id} + + end + + it "a working api route" do + patch update_rental_path(@movie.title), params: { rental: @rental_data } + must_respond_with :success + end + + it 'returns json' do + patch update_rental_path(@movie.title), params: { rental: @rental_data } + response.header['Content-Type'].must_include 'json' + end + + it "changes rental status" do + patch update_rental_path(@movie.title), params: { rental: @rental_data } + response.parsed_body.must_include "status" + rental = Rental.find(@rental.id) + rental.status.must_equal "checked in" + end + + it "changes movies checkout count" do + count_before = @rental.customer.movies_checked_out_count + patch update_rental_path(@movie.title), params: { rental: @rental_data } + @rental.reload + count_after = @rental.customer.movies_checked_out_count + (count_before - count_after).must_equal 1 + end + + it "returns bad request status if movie for rental is not found " do + patch update_rental_path("Movie that DNE"), params: { rental: @rental_data } + must_respond_with :bad_request + response.parsed_body.must_include "errors" + end + + it "does not allow to check in movie if user didn't checkout this movie " do + customer = customers(:good_customer4) + rental_data = { "customer_id": customer.id } + patch update_rental_path(@movie.title), params: { rental: rental_data } + must_respond_with :bad_request + response.parsed_body.must_include "error" + end + + it 'updates available inventory' do + movie = movies(:movie1) + count_before = movie.available_inventory + patch update_rental_path(movie.title), params: { rental: @rental_data } + movie.reload + count_after = movie.available_inventory + (count_before - count_after).must_equal -1 + end + + it 'does not updates available inventory if given bad data' do + movie = movies(:movie1) + count_before = movie.available_inventory + patch update_rental_path(movie.title), params: { rental: @bad_rental_data } + movie.reload + count_after = movie.available_inventory + (count_before - count_after).must_equal 0 + end + end +end diff --git a/test/fixtures/.keep b/test/fixtures/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/test/fixtures/customers.yml b/test/fixtures/customers.yml new file mode 100644 index 000000000..444b1e495 --- /dev/null +++ b/test/fixtures/customers.yml @@ -0,0 +1,93 @@ +# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html + +# This model initially had no columns defined. If you add columns to the +# model remove the "{}" from the fixture names and add the columns immediately +# below each fixture, per the syntax in the comments below +# + +good_customer: + name: natalia kuleniuk + registered_at: May 21 2017 + address: 123 Fake street + city: Redmond + state: Washington + postal_code: 12345 + phone: (234) 837-2886 + +good_customer2: + name: cyn bin + registered_at: August 11 2014 + address: 123 Fake street + city: Bellevue + state: Washington + postal_code: 12124 + phone: (234) 837-2886 + +bad_customer2: + name: natalia kuleniuk + registered_at: August 11 2014 + address: 123 Fake street + city: Bellevue + postal_code: 12124 + phone: (234) 837-2886 + +bad_customer3: + name: natalia kuleniuk + registered_at: August 11 2014 + address: 123 Fake street + city: Bellevue + state: Washington + postal_code: 12124 + +bad_customer4: + name: natalia kuleniuk + registered_at: August 11 2014 + city: Bellevue + state: Washington + postal_code: 12124 + phone: (234) 837-2886 + +customer_bad_city: + name: natalia kuleniuk + registered_at: May 21 2017 + address: 123 Fake street + city: 323223 + state: Washington + postal_code: 12345 + phone: (234) 837-2886 + +customer_bad_state: + name: natalia kuleniuk + registered_at: May 21 2017 + address: 123 Fake street + city: Redmond + state: 32232 + postal_code: 12345 + phone: (234) 837-2886 + +customer_bad_zip: + name: natalia kuleniuk + registered_at: May 21 2017 + address: 123 Fake street + city: Redmond + state: 32232 + postal_code: 1234543 + phone: (234) 837-2886 + +customer_bad_phone: + name: natalia kuleniuk + registered_at: May 21 2017 + address: 123 Fake street + city: Redmond + state: 32232 + postal_code: 1234543 + phone: (2344343-)837-2886 + +good_customer4: + name: natalia kuleniu + registered_at: May 21 2017 + address: 12 Fake street + city: Redmond + state: Washington + postal_code: 12345 + phone: (234) 837-2886 diff --git a/test/fixtures/files/.keep b/test/fixtures/files/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/test/fixtures/movies.yml b/test/fixtures/movies.yml new file mode 100644 index 000000000..fea9f09cb --- /dev/null +++ b/test/fixtures/movies.yml @@ -0,0 +1,48 @@ +movie1: + title: Psycho + overview: When larcenous real estate clerk Marion Crane goes on the lam with a wad of cash and hopes of starting a new life, she ends up at the notorious Bates Motel, where manager Norman Bates cares for his housebound mother. The place seems quirky, but fine… until Marion decides to take a shower. + release_date: 1960-06-16 + inventory: 8 + available_inventory: 8 + +movie2: + title: Psycho2 + overview: When larcenous real estate clerk Marion Crane goes on the lam with a wad of cash and hopes of starting a new life, she ends up at the notorious Bates Motel, where manager Norman Bates cares for his housebound mother. The place seems quirky, but fine… until Marion decides to take a shower. + release_date: 1960-06-16 + inventory: 8 + available_inventory: 8 + +movie3: + title: Jaws + overview: An insatiable great white shark terrorizes the townspeople of Amity Island, The police chief, an oceanographer and a grizzled shark hunter seek to destroy the bloodthirsty beast. + release_date: 1975-06-19 + inventory: 6 + available_inventory: 6 + +movie5: + title: Gaslight + overview: In the late 19th century, Paula Alquist is studying music in Italy, but ends up abandoning her classes because she's fallen in love with the gallant Gregory Anton. The couple marries and moves to England to live in a home inherited by Paula from her aunt, herself a famous singer, who was mysteriously murdered in the house ten years before. Once they have moved in, Gregory, who is in reality a jewel thief and the murderer of Paula's aunt, launches a campaign of terror designed to drive his new bride insane. Though Paula is certain that she sees the house's gaslights dim every evening and that there are strange noises coming from the attic, Gregory convinces Paula that she's imagining things. Gregory's efforts to make Paula unstable are aided by an impertinent maid, Nancy. Meanwhile, a Scotland Yard inspector, Brian Cameron, becomes suspicious of Gregory and sympathetic to Paula's plight. + release_date: 1944-05-04 + inventory: 8 + available_inventory: 8 + +movie_not_available: + title: Jaws2 + overview: Jaws comes back + release_date: 1972-04-22 + inventory: 2 + available_inventory: 0 + +movie4: + title: Jaws + overview: An insatiable great white shark terrorizes the townspeople of Amity Island, The police chief, an oceanographer and a grizzled shark hunter seek to destroy the bloodthirsty beast. + release_date: 1975-06-19 + inventory: 6 + available_inventory: 0 + +movie_one_copy: + title: Jaws3 + overview: Jaws comes back again again + release_date: 1982-04-22 + inventory: 1 + available_inventory: 1 diff --git a/test/fixtures/rentals.yml b/test/fixtures/rentals.yml new file mode 100644 index 000000000..ba62b58db --- /dev/null +++ b/test/fixtures/rentals.yml @@ -0,0 +1,26 @@ +# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html + +# This model initially had no columns defined. If you add columns to the +# model remove the "{}" from the fixture names and add the columns immediately +# below each fixture, per the syntax in the comments below +# +rental1: + customer: good_customer + movie: movie1 + check_out_date: 2017-05-08 + due_date: 2017-05-11 + status: checked out + +rental2: + customer: good_customer + movie: movie2 + check_out_date: 2017-05-07 + due_date: 2017-05-10 + status: checked out + +rental3: + customer: good_customer2 + movie: movie1 + check_out_date: 2017-05-05 + due_date: 2017-05-08 + status: overdue diff --git a/test/integration/.keep b/test/integration/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/test/mailers/.keep b/test/mailers/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/test/models/.keep b/test/models/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/test/models/customer_test.rb b/test/models/customer_test.rb new file mode 100644 index 000000000..180b36285 --- /dev/null +++ b/test/models/customer_test.rb @@ -0,0 +1,79 @@ +require "test_helper" + +describe Customer do + describe "Validation" do + before do + @input = { name: "Shelley Rocha", + registered_at: "Wed, 29 Apr 2015 07:54:14 -0700", + address: "Ap #292-5216 Ipsum Rd.", + city: "Hillsboro", + state: "OR", + postal_code: "24309", + phone: "(322) 510-8695", + } + end + it "Cannot be created even if one attributes is not presented" do + @input.keys.each do |key| + input = @input.dup + input.delete(key) + customer = Customer.new(input) + result = customer.valid? + result.must_equal false + customer.errors.must_include key + end + end + + it "Can be created with all attributes" do + customer = Customer.new(@input) + result = customer.valid? + result.must_equal true + end + it "Cannot be created without attributes" do + customer = Customer.new + result = customer.valid? + result.must_equal false + end + it "cannot be created with invalid address" do + @input[:address] = "on" + customer = Customer.new(@input) + result = customer.valid? + result.must_equal false + end + it "cannot be created with invalid city" do + @input[:city] = "CityWithNumbers12345" + customer = Customer.new(@input) + result = customer.valid? + result.must_equal false + end + it "cannot be created with invalid state" do + @input[:state] = "StateWithNumbers12345" + customer = Customer.new(@input) + result = customer.valid? + result.must_equal false + end + it "cannot be created if postal_code length > 5" do + @input[:postal_code] = 3232903 + customer = Customer.new(@input) + result = customer.valid? + result.must_equal false + end + it "cannot be created if postal_code length < 5" do + @input[:postal_code] = 903 + customer = Customer.new(@input) + result = customer.valid? + result.must_equal false + end + it "cannot be created if postal_code is not contains all digits" do + @input[:postal_code] = "123la" + customer = Customer.new(@input) + result = customer.valid? + result.must_equal false + end + it "cannot be created if phone is not valid" do + @input[:phone] = "2332323232232" + customer = Customer.new(@input) + result = customer.valid? + result.must_equal false + end + end +end diff --git a/test/models/movie_test.rb b/test/models/movie_test.rb new file mode 100644 index 000000000..526eee056 --- /dev/null +++ b/test/models/movie_test.rb @@ -0,0 +1,57 @@ +require "test_helper" + +describe Movie do + + describe 'validations' do + before do + @input = { title: "Harry Potter", + overview: "Boy learns he is a wizard", + release_date: "11-23-2001", + inventory: 10, + available_inventory: 10 + + } + end + + # is this more dry? + def create_movie(info) + return Movie.new(info) + end + + it 'good data passes validations' do + movie = create_movie(@input) + movie.valid?.must_equal true + end + + it 'does not allow duplicate titles' do + Movie.create(@input) + repeat = Movie.new(@input) + repeat.valid?.must_equal false + repeat.errors.must_include :title + end + + it 'wont create instance if any attrivbute is missing' do + @input.keys.each do |attribute| + input = @input.dup + input.delete(attribute) + movie = Movie.new(input) + movie.valid?.must_equal false + movie.errors.must_include attribute + end + end + + it "can't include a negative inventory" do + @input[:inventory] = -3 + movie = create_movie(@input) + movie.valid?.must_equal false + movie.errors.must_include :inventory + end + + it 'inventory has to be a integer' do + @input[:inventory] = "one" + movie = Movie.new(@input) + movie.valid?.must_equal false + movie.errors.must_include :inventory + end + end +end diff --git a/test/models/rental_test.rb b/test/models/rental_test.rb new file mode 100644 index 000000000..83d6787f6 --- /dev/null +++ b/test/models/rental_test.rb @@ -0,0 +1,91 @@ +require "test_helper" +require 'date' + +describe Rental do + + before do + @customer_id = customers(:good_customer).id + @rental_info = { + movie_id: movies(:movie3).id, + customer_id: @customer_id, + check_out_date: Date.today, + due_date: Date.today + 3, + status: "checked out" + } + end + + it "requires all attributes to create instance" do + rental = Rental.new(@rental_info) + rental.valid?.must_equal true + rental.save + Rental.find_by(customer_id: @customer_id ).wont_be_nil + end + + it "wont create a rental if missing a needed attribute" do + @rental_info.keys.each do |attribute| + rental_info = @rental_info.dup + rental_info.delete(attribute) + rental = Rental.new(rental_info) + rental.valid?.must_equal false + rental.errors.wont_be_nil + end + end + + describe "self.overdue_movies" do + + it "returns instance of Array" do + rental1 = Rental.new(@rental_info) + rental1.save + rental2 = Rental.new(@rental_info) + rental2.save + Rental.overdue_movies.must_be_kind_of Array + end + + it "returns rentals with status overdue" do + Rental.overdue_movies.each do |movie| + movie.status.must_equal "overdue" + end + end + + it "returns empty array if no overdue rentals was found" do + Rental.destroy_all + Rental.overdue_movies.must_be_empty + end + + it "returns rentals which due_date is before today" do + Rental.overdue_movies.each do |movie| + movie.due_date.must_be :<, Date.today + end + end + end + + # does this need its own describ block + describe 'check_inventory' do + before do + @movie_one_copy = movies(:movie_one_copy).id + @rental_info = { + movie_id: nil, + customer_id: customers(:good_customer2).id, + check_out_date: Date.today, + due_date: Date.today + 3, + status: "checked out" + } + end + + # edge case 1 inventory and 1 available + it "will validate a rental if there is enough inventory" do + @rental_info[:movie_id] = @movie_one_copy + rental = Rental.new(@rental_info) + rental.valid? + # p rental.errors + rental.valid?.must_equal true + end + + it "wont validate a rental if there is not enough inventory" do + @rental_info[:movie_id] = movies(:movie_not_available).id + rental = Rental.new(@bad_rental) + rental.valid?.must_equal false + rental.errors.messages[:movie_id][0].must_equal "no available inventory" + end + end +end diff --git a/test/test_helper.rb b/test/test_helper.rb new file mode 100644 index 000000000..cc375119f --- /dev/null +++ b/test/test_helper.rb @@ -0,0 +1,26 @@ +ENV["RAILS_ENV"] = "test" +require File.expand_path("../../config/environment", __FILE__) +require "rails/test_help" +require "minitest/rails" + require "minitest/reporters" # for Colorized output + + # For colorful output! + Minitest::Reporters.use!( + Minitest::Reporters::SpecReporter.new, + ENV, + Minitest.backtrace_filter + ) + + +# To add Capybara feature tests add `gem "minitest-rails-capybara"` +# to the test group in the Gemfile and uncomment the following: +# require "minitest/rails/capybara" + +# Uncomment for awesome colorful output +# require "minitest/pride" + +class ActiveSupport::TestCase + # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order. + fixtures :all + # Add more helper methods to be used by all tests here... +end diff --git a/tmp/.keep b/tmp/.keep new file mode 100644 index 000000000..e69de29bb