bo and sai's video store API by ssamant · Pull Request #16 · Ada-C7/VideoStoreAPI

ssamant · 2017-05-12T23:51:54Z

Video Store API

Congratulations! You're submitting your assignment!
If you didn't get to the functionality the question is asking about, reply with what you would have done if you had completed it.

Comprehension Questions

Question	Answer
Explain how you came up with the design of your ERD, based on the seed data.	We determined what the fields of the the model would be by looking at the seed data.
List all the completed endpoints of your application.	GET /movies, GET movies/:title, GET /customers, POST /rentals/:title/check-out, POST /rentals/:title/check-in, WIP (hoping to get this done by Monday!): GET /rentals/overdue
Describe a set of positive and negative test cases you implemented for a model.	We had postivie and negative tests for the due_date attribute in the Rental model. We tested the presence, data type and wrote a custom method to make sure the due_date is set for a future date. We tested all of the edge cases that could occur with these requirements.
Describe a set of positive and negative test cases you implemented for a controller.	For the movies index controller, we checked that the body of the JSON returned the required keys for a good request and that we got the appropriate error messages for a bad request.
How does your API respond when bad data is sent to it?	We send a :bad_request response and an error message that relates to the reason for the bad response (for instance for getting a particular movie, our error message says ":Title not found"
Describe one of your custom model methods and why you chose to wrap that functionality into a method.	We wrote a custom method in the Movie model to return a movie's available inventory. This way we didn't have to add an extra field to the movie db and we could use the method to return the json key-value pair as required.
Do you have any recommendations on how we could improve this project for the next cohort?	No -- it felt like a reasonable project that helped us learn more about APIs (and testing!)
Link to Trello	https://trello.com/b/My2eCvMP/video-store-api
Link to ERD	(we also did an ERD on the whiteboard if you need a pic of that) erd.pdf

made new empty api app

baseline with test route

added gems needed for testing and error views

generated models for movies and customers

Modify models

Model tests

Add controllers

Bt update rentals test

added some tests

wrote controller action for rental create and updated tests

updated tests and controller logic

Rental logic inventory

Update rental controller test

Update customer custom method

WIP overdue action in rental controller

… due date of next available movie

Sandbox overdue

CheezItMan · 2017-05-19T04:34:03Z

Video Store

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene	Lots of commits, contributions from both team members and good commit messages. Well done!
Comprehension questions	Check, glad you enjoyed the project
General
Business Logic in Models	Check, interesting custom validation method to verify inventory & due date. I think the due date could be done with an existing validator. It' also interesting how you overrode the `initialize` method.
All 3 required endpoints return expected JSON data	Check!
Requests respond with appropriate HTTP Status Code	Check
Errors are reported	Good use of the `errors` hash to report errors.
Testing
Passes all Smoke Tests	Check, very nicely done!
Model Tests - all relations, validations, and custom functions test positive & negative cases	Check, very good edge-case testing. There is one broken test, `returns an error message if available inventory is less than 1`
Controller Tests - URI parameters and data in the request body have positive & negative cases	There is one broken test, `returns an error if there is not enough inventory`. Both of these errors come from the `check_inventory` method in `rental.rb`.
Optionals
POST routes use URI parameter and request body to add a new record to the database	Well done
GET /customers shows how many movies are checked out by a customer	Check
GET /movies/:title shows updated inventory	Well done
Overall	Nicely done, some small bugs in checking out videos when there's not enough stock, but that's a minor issue. I like how you experimented with custom validators and you have good business logic in the models. A good end to our Rails unit!

bbbriana

Overall great job! I didn't find any glaring issues or anything, keep up the great work 💯

bbbriana · 2017-06-02T04:13:54Z

app/models/movie.rb

+  validates :title, presence: true
+  validates :overview, presence: true
+  validates :release_date, presence: true, format: { with: /\A\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])\z/, message: "must be in YYYY-MM-DD format" }
+  validates :inventory, presence: true, numericality: { only_integer: true, greater_than: 0}


Really great job with the validations!

bbbriana · 2017-06-02T04:16:19Z

app/models/rental.rb

+      if movie.available_inventory <= 0
+        rentals = Rental.where(movie_id: movie.id)
+        earliest = rentals.min_by { |rental| rental.due_date}
+        errors.add(:availability, "Sorry, this movie is not in stock. One is due back on #{earliest.due_date}")


Noting the earliest due date is a nice touch 👍

bbbriana · 2017-06-02T04:26:09Z

test/controllers/rentals_controller_test.rb

@@ -0,0 +1,146 @@
+require "test_helper"


Yay tests! I dig how thorough these ones are 🎉

bbbriana · 2017-06-02T04:27:01Z

test/fixtures/movies.yml

+
+one:
+  title: Titanic
+  overview: ship disaster


Omg these movie overviews 😂

bbbriana · 2017-06-02T04:28:30Z

app/controllers/rentals_controller.rb

+      overdue_rentals = []
+      customer_ids.each do |id|
+        customer = Customer.find_by_id(id)
+        hash = Hash.new


For consistency you could do {} (since you do [] for a new array)...but this is me completely nitpicking bc you did such a great job 😁

bbbriana · 2017-06-02T04:37:50Z

app/controllers/rentals_controller.rb

+  end
+
+  def overdue
+    #what is the syntax for a conditional for due date?


Remember to clean up comments! 🔍

bbbriana · 2017-06-02T04:43:32Z

app/models/rental.rb

+  end
+
+  def valid_due_date
+    if due_date.class != Date


How do you take in the due date? Would checking if the due date is too far in the future (like if I tried to check something out for 2183721983 years) be necessary?

bbbriana · 2017-06-02T04:46:21Z

.gitignore

+
+# Ignore Byebug command history file.
+.byebug_history
+/coverage/


Could also ignore that pesky .DS_Store

bbbriana · 2017-06-02T04:47:48Z

Gemfile

+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.0.2'


Ohhh that's why some of this looks weird to me, shiny new rails! ✨ (we used 4.2)

I had the same reaction!

bbbriana · 2017-06-02T04:53:58Z

app/models/rental.rb

+
+  def check_inventory
+    if movie
+      if movie.available_inventory <= 0


Would the avail inventory ever go below 0?

rpavilanis

Fantastic job - it looks like you both went above and beyond the requirements and learned a lot about building an API. nice work. :)

rpavilanis · 2017-06-06T02:51:21Z

Gemfile

+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.0.2'


I had the same reaction!

rpavilanis · 2017-06-06T02:52:37Z

Gemfile

+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+group :development do


It looks like you have two 'group :development do' sections - you could combine them to clean up the Gemfile.

rpavilanis · 2017-06-06T02:57:42Z

app/models/customer.rb

+
+  # update later after adding rental
+  def movies_checked_out_count
+    return rentals.where(returned: false).length


Nice job pulling out business logic into models. Good work on being thorough with validations.

rpavilanis · 2017-06-06T02:59:57Z

test/controllers/rentals_controller_test.rb

+    value(response).must_be :success?
+  end
+
+end


Wow, I can tell that you really put a lot of time into writing thorough tests. Nice job testing edge cases as well.

ssamant and others added 30 commits May 9, 2017 14:10

made new empty api app

5fe5fd3

Merge pull request #1 from ssamant/generate_new_api_app

d01445a

made new empty api app

baseline with test route

b5bdffa

Merge pull request #2 from ssamant/baseline

8d5c69e

baseline with test route

added gems needed for testing and error views

056e985

Merge pull request #3 from ssamant/add-gems

80e3529

added gems needed for testing and error views

generated models for movies and customers

33b86fa

Merge pull request #4 from ssamant/add-models

a602dea

generated models for movies and customers

updated gemfile.lock

2cebec7

added coverage to gitignore

2117324

Merge branch 'master' of https://github.com/ssamant/VideoStoreAPI

196cf06

Merge branch 'master' of https://github.com/ssamant/VideoStoreAPI

3886f7d

schema created

5a031f2

schema file

23a3ada

Merge branch 'master' of https://github.com/ssamant/VideoStoreAPI

bee7a24

added default value for account credit in Customer model

732afca

validations for customer and movie models

cb26563

Merge pull request #5 from ssamant/modify_models

8abd0ab

Modify models

trying to fix regex in customer model

fb97a18

adjusting regex

7ca8c02

tests for customer model

91ccd40

tests for Movie model

a4a0e95

Merge pull request #6 from ssamant/model_tests

c40ab78

Model tests

initially generted controllers for customers and movies

563e704

update routes

638714c

added controller tests for customers

7be22ef

update customers controller

de6fe7a

Merge pull request #7 from ssamant/add-controllers

8ef5f20

Add controllers

movie controller tests and controller index and show actions

121b2c1

test for custom method available_inventory and method

df86273

botrethewey and others added 25 commits May 11, 2017 09:41

Merge pull request #13 from ssamant/bt-update-rentals-test

740928d

Bt update rentals test

added some tests

44848e1

Merge pull request #14 from ssamant/add-rental-controller

d31ed5b

added some tests

wrote controller action for rental create and updated tests

0cf9d41

Merge pull request #15 from ssamant/rental-create-controller

e34603e

wrote controller action for rental create and updated tests

updated tests and controller logic

d7394fa

Merge pull request #16 from ssamant/update-rental-logic

2097e8b

updated tests and controller logic

logic and tests for Movie model method available inventory

b2b9bd5

tests for custom method check_availability in rental model

8245341

finised testing for rental model custom method

ff405d5

Merge pull request #17 from ssamant/rental_logic_inventory

b72001a

Rental logic inventory

fix typo in movie controllers test

e442f2e

added tests for the rentals custom method in model

70ee7ef

Merge pull request #18 from ssamant/update-rental-controller-test

2b3de18

Update rental controller test

fixed error message in rental model test

510a49d

updated logic on movies_checked_out_count method

029a914

updated tests for the custom method

0f368f0

Merge pull request #19 from ssamant/update-customer-custom-method

968032d

Update customer custom method

TDD! wrote controller tests for Rental update action

bf6306b

tests for update action in Rental

d19069c

WIP overdue action in rental controller

8ad3f29

Merge pull request #20 from ssamant/overdue_action

bb987ed

WIP overdue action in rental controller

hash to give to json in overdue action with all the required fields

79cd476

WIP changed error message in check_inventory method to give estimated…

656104e

… due date of next available movie

Merge pull request #21 from ssamant/sandbox_overdue

df6b2c1

Sandbox overdue

Hamled assigned rpavilanis and bbbriana May 19, 2017

bbbriana reviewed Jun 2, 2017

View reviewed changes

rpavilanis reviewed Jun 6, 2017

View reviewed changes



		# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
		gem 'rails', '~> 5.0.2'

Conversation

ssamant commented May 12, 2017

Video Store API

Comprehension Questions

Uh oh!

CheezItMan commented May 19, 2017

Video Store

What We're Looking For

Uh oh!

bbbriana left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rpavilanis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants