tidy up comments; add README; add LICENSE

Grogs · Mar 3, 2014 · 35c46c8 · 35c46c8
1 parent ca0dbad
commit 35c46c8
Show file tree

Hide file tree

Showing 18 changed files with 699 additions and 67 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
-Scala Webservice for retrieving Cineworld movie listings and ratings
-====
+Cineworld movie listings and ratings webservice
+====
+The Cineworld Unlimited card is pretty awesome, but I always find myself checking every films IMDb rating. Too manual; I want to see the ratings inline. So I created a Chrome extension: [Cineworld Ratings](https://chrome.google.com/webstore/detail/cineworld-ratings/aeihmofihjacjlkecnjpoicmaaandnnc). This is the RESTful backend for that extension.
+
+
+Getting Started
+====
+Get an API key for Rotten Tomatoes and Cineworld. Modify application.conf to include your API keys.
+If you have gradle installed, type 'gradle run' in your terminal. If not, './gradlew run'.
+
+Check it's working by browsing to the listings for [my local cinema](http://localhost:9001/api/cinema/66).
+
+License (GPLv3)
+----
+Copyright (c) Greg Dorrell
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
diff --git a/src/main/scala/me/gregd/cineworld/Config.scala b/src/main/scala/me/gregd/cineworld/Config.scala
@@ -9,10 +9,6 @@ import grizzled.slf4j.Logging
 import collection.JavaConverters._
 import com.typesafe.config.ConfigFactory
 
-/**
- * Author: Greg Dorrell
- * Date: 09/06/2013
- */
 object Config extends TaskSupport with Logging {
   val prop = ConfigFactory.load.getString _
 
@@ -32,10 +28,4 @@ object Config extends TaskSupport with Logging {
     frequency = 5 minutes
   )
 
-
-//  schedule (
-//    task = logger.info("test"),
-//    frequency = 20 seconds
-//  )
-
 }
diff --git a/src/main/scala/me/gregd/cineworld/dao/cineworld/Cineworld.scala b/src/main/scala/me/gregd/cineworld/dao/cineworld/Cineworld.scala
@@ -15,10 +15,6 @@ import grizzled.slf4j.Logging
 import me.gregd.cineworld.Config
 
 
-/**
- * Author: Greg Dorrell
- * Date: 11/05/2013
- */
 class Cineworld(apiKey:String, implicit val imdb: IMDbDao) extends CineworldDao with Logging {
   val movieCache : LoadingCache[String, List[Movie]] = {
     val loader = getMoviesUncached(_:String)(imdb)

diff --git a/src/main/scala/me/gregd/cineworld/dao/cineworld/CineworldDao.scala b/src/main/scala/me/gregd/cineworld/dao/cineworld/CineworldDao.scala
@@ -3,10 +3,6 @@ package me.gregd.cineworld.dao.cineworld
 import me.gregd.cineworld.domain.{Cinema, Movie, Performance}
 import me.gregd.cineworld.dao.imdb.IMDbDao
 
-/**
- * Author: Greg Dorrell
- * Date: 09/06/2013
- */
 trait CineworldDao {
   def getCinemas(): List[Cinema]
   def getMovies(cinema:String)(implicit imdb: IMDbDao): List[Movie]

diff --git a/src/main/scala/me/gregd/cineworld/dao/cineworld/MoviesCache.scala b/src/main/scala/me/gregd/cineworld/dao/cineworld/MoviesCache.scala
@@ -6,9 +6,6 @@ import me.gregd.cineworld.util.caching.{JavaSerialization, LoadingCache, Databas
 import JavaSerialization._
 import java.io.{ByteArrayInputStream, ObjectInputStream}
 
-/**
- * Created by Greg Dorrell on 14/12/2013.
- */
 class MoviesCache(val db: Database, val loader: (String) => List[Movie]) extends DatabaseCache[List[Movie]] with LoadingCache[List[Movie]] {
   val cacheName = "moviesForCinema"
   val deserialise = createDeserializer[List[Movie]]

diff --git a/src/main/scala/me/gregd/cineworld/dao/imdb/IMDbDao.scala b/src/main/scala/me/gregd/cineworld/dao/imdb/IMDbDao.scala
@@ -2,10 +2,6 @@ package me.gregd.cineworld.dao.imdb
 
 import me.gregd.cineworld.domain.Movie
 
-/**
- * Author: Greg Dorrell
- * Date: 11/05/2013
- */
 trait IMDbDao {
   def getId(title: String): Option[String]
   def getIMDbRating(id:String) : Option[Double]

diff --git a/src/main/scala/me/gregd/cineworld/dao/imdb/Ratings.scala b/src/main/scala/me/gregd/cineworld/dao/imdb/Ratings.scala
@@ -12,10 +12,6 @@ import java.util.concurrent.TimeUnit._
 import grizzled.slf4j.Logging
 import java.text.NumberFormat
 
-/**
- * Author: Greg Dorrell
- * Date: 11/05/2013
- */
 class Ratings(rottenTomatoesApiKey:String) extends IMDbDao with Logging {
   implicit val formats = DefaultFormats
 

diff --git a/src/main/scala/me/gregd/cineworld/domain/Cinema.scala b/src/main/scala/me/gregd/cineworld/domain/Cinema.scala
@@ -3,10 +3,6 @@ package me.gregd.cineworld.domain
 import me.gregd.cineworld.dao.cineworld.CineworldDao
 import me.gregd.cineworld.dao.imdb.IMDbDao
 
-/**
- * Author: Greg Dorrell
- * Date: 09/06/2013
- */
 case class Cinema(
   id: String,
   name: String

diff --git a/src/main/scala/me/gregd/cineworld/domain/Movie.scala b/src/main/scala/me/gregd/cineworld/domain/Movie.scala
@@ -3,10 +3,6 @@ package me.gregd.cineworld.domain
 import me.gregd.cineworld.dao.imdb.{IMDbRating, Ratings, IMDbDao}
 import me.gregd.cineworld.dao.cineworld.Cineworld
 
-/**
- * Author: Greg Dorrell
- * Date: 11/05/2013
- */
 case class Movie (
   title: String,
   cineworldId: String,

diff --git a/src/main/scala/me/gregd/cineworld/domain/Performance.scala b/src/main/scala/me/gregd/cineworld/domain/Performance.scala
@@ -3,9 +3,6 @@ package me.gregd.cineworld.domain
 import org.joda.time.DateTime
 
 /**
- * Author: Greg Dorrell
- * Date: 11/05/2013
- *
  * Playing about with dates and times, always fun.
  * All Cineworld cinemas are in the same time zone, so afaik I don't have to worry about it.
  * I'll treat is as LocalDate (on US server) but not doing any tricky time stuff or getting times from any other sources.

diff --git a/src/main/scala/me/gregd/cineworld/rest/CinemaService.scala b/src/main/scala/me/gregd/cineworld/rest/CinemaService.scala
@@ -7,10 +7,6 @@ import org.scalatra.json.NativeJsonSupport
 import me.gregd.cineworld.dao.imdb.Ratings
 import com.typesafe.scalalogging.slf4j.Logging
 
-/**
- * Author: Greg Dorrell
- * Date: 10/06/2013
- */
 class CinemaService(dao: Cineworld) extends ScalatraServlet with NativeJsonSupport with Logging {
   protected implicit val jsonFormats = DefaultFormats.withBigDecimal
 

diff --git a/src/main/scala/me/gregd/cineworld/util/FilmsToWatch.scala b/src/main/scala/me/gregd/cineworld/util/FilmsToWatch.scala
@@ -2,10 +2,6 @@ package me.gregd.cineworld.util
 
 import me.gregd.cineworld.dao.cineworld.Cineworld
 
-/**
- * Author: Greg Dorrell
- * Date: 13/10/2013
- */
 object FilmsToWatch extends App {
 
   val localCinema = Cineworld.getCinemas.find(

diff --git a/src/main/scala/me/gregd/cineworld/util/JettyBootstrap.scala b/src/main/scala/me/gregd/cineworld/util/JettyBootstrap.scala
@@ -4,10 +4,6 @@ import org.eclipse.jetty.server.Server
 import org.eclipse.jetty.webapp.WebAppContext
 import org.scalatra.servlet.ScalatraListener
 
-/**
- * Author: Greg Dorrell
- * Date: 30/05/2013
- */
 object JettyBootstrap extends App {
   var port = 9001
   val server = new Server( port )

diff --git a/src/main/scala/me/gregd/cineworld/util/TaskSupport.scala b/src/main/scala/me/gregd/cineworld/util/TaskSupport.scala
@@ -2,10 +2,6 @@ package me.gregd.cineworld.util
 
 import java.util.{TimerTask, Timer}
 
-/**
- * Author: Greg Dorrell
- * Date: 09/08/2013
- */
 trait TaskSupport {
 
   lazy val defaultTimer = TaskSupport.timer

diff --git a/src/main/scala/me/gregd/cineworld/util/caching/DatabaseCache.scala b/src/main/scala/me/gregd/cineworld/util/caching/DatabaseCache.scala
@@ -6,9 +6,6 @@ import Q.interpolation
 import java.util.Date
 import java.sql.{Blob, Timestamp}
 
-/**
- * Created by Greg Dorrell on 14/12/2013.
- */
 abstract class DatabaseCache[T] {
 
   val cacheName: String

diff --git a/src/main/scala/me/gregd/cineworld/util/caching/JavaSerialization.scala b/src/main/scala/me/gregd/cineworld/util/caching/JavaSerialization.scala
@@ -3,9 +3,6 @@ package me.gregd.cineworld.util.caching
 import java.io.{ByteArrayOutputStream, ObjectOutputStream, ByteArrayInputStream, ObjectInputStream}
 import me.gregd.cineworld.domain.Movie
 
-/**
- * Created by Greg Dorrell on 14/12/2013.
- */
 object JavaSerialization {
 
   def createSerializer[T]: (T) => Array[Byte] = { t =>

diff --git a/src/main/scala/me/gregd/cineworld/util/caching/LoadingCache.scala b/src/main/scala/me/gregd/cineworld/util/caching/LoadingCache.scala
@@ -1,8 +1,5 @@
 package me.gregd.cineworld.util.caching
 
-/**
- * Created by Greg Dorrell on 14/12/2013.
- */
 trait LoadingCache[T] { self: DatabaseCache[T] =>
 
   val loader: String => T