useless-wait-list 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 166323991a40e1597674dafc34683bed1f5b8c55
-  data.tar.gz: d6213514a0bb186ebc019c7cd66f005c715a0b9f
+  metadata.gz: 41d0880acb1ceacb594266aa4a3a7e4dbb20079c
+  data.tar.gz: 4134f32eeafbcc4741d6082dd360794c12c58bff
 SHA512:
-  metadata.gz: 1f2f4d3ff35dbfd64cd6246668775f96be766e9e308159d34b1f0c8ab8abbbf521c8c317cbb6fea110e1bb558eaca33f9c408f4606ebd0e37ef82b0ea68fdd3e
-  data.tar.gz: a4b34eab291f3631d962736181c494b60808fec1c60dcda1b0abdc0d76991dca1d769a6ca02fad2b8ec8a61f0079b3dfa56a08d47b6c3f8606422f44622e85be
+  metadata.gz: 26bd0effc0fecbece82de42ff0b6dc536e31b39a0023e3e1fe631acf32b6939433fcc6bd9fee9d17f44a99efe6da7329b8b15991102364be1dabc410d1b031f9
+  data.tar.gz: 2a78d481f0e0cbf6c46d3bb76c3a6ce7e5045e3ff6d5cc274d4abb4252428549236ad26d04067dd04c4e5fb413149f96df7c2ccf1a0a9696b9e5abb9af4f3ca7

data/lib/useless/wait_list.rb

@@ -14,74 +14,72 @@ module Useless
       implementation 'Pending', 'Kevin Hyland'
 
       description <<-DESC
-        The **Wait List API** exposes a service that improves the wait list
-        experience for both restaurants and patrons. It was initially motivated
-        by a desire, as patrons, to browse and add ourselves to wait lists. It
-        also improves the process of managing wait lists for restaurants.
-
-        ### Restaurant
-
-        The top-level resource is the **restaurant**, which consists of a place
-        (from a supported place API, e.g. Foursquare), a group of users, and
-        some wait lists.
-
-        The users associated with the restaurant represent the staff and are
-        able to manage the restaurant's wait lists, i.e. create or cancel
-        reservations on behalf of other users or mark reservations as "seated",
-        "no show" or "bumped".
+        The **Wait List API** implements a new approach to filling a
+        restaurant's open tables by presenting them to potential patrons in
+        real time and allowing them to instantly make reservations.
 
         ### Wait List
 
-        The **wait list** is the primary resource. A wait list belongs to a
-        restaurant, has an ordered list of reservations, along with the
-        following attributes:
+        The API's primary resource is, of course, the **wait list**. A wait list
+        is a simple construct that represents open tables in a restaurant and
+        serves two functions:
 
-        * _table_size_ - the number of people who can be seated at this
-        wait list's tables. A restaurant should have a wait list per
-        available table size per dining service.
+        1. Exposes the tables to patrons via search.
 
-        * _reservations_start_ - when reservations can start being created
-        for this wait list. Once this time has passed, the wait list is
-        "open".
+        2. Coordinates reservations for the tables.
 
-        * _seating_start_ - when the first reservation on this wait list
-        will be seated. Once this time has passed, the wait list is
-        "active".
+        A wait list is associated with a single table size. It maintains an
+        ordered list of reservations where the front of the list is the next
+        to be seated.
 
-        A wait list can be closed manually or automatically (based upon some
-        criteria, e.g. a reservation threshold). Once closed, reservations can
-        no longer be created for the wait list, and it will no longer show up in
-        search results.
+        Wait lists can be created in an ad hoc manner (e.g., when another
+        reservation is a no show), or according to a regular schedule (e.g., a
+        wait list per table size per night).
+
+        A wait list can be either _open_ or _closed_. When open, patrons can
+        add reservations to the wait list. When closed, they cannot. A wait list
+        can be closed either manually or according to some criteria. Once
+        closed, the wait list will no longer appear in search results.
 
         ### Reservation
 
         A **reservation** represents a patron's position on a wait list. A
         reservation can have one of five states:
 
-        * _waiting_ - the patron has not yet been seated, or marked as a no
-        show.
+        * _waiting_ - the patron has not yet been seated or marked as a no show.
 
         * _cancelled_ - the patron has yet to be seated, but has removed
-        himself from the waitlist.
+        himself from the wait list.
 
         * _seated_ - the patron has been seated at his table.
 
         * _no show_ - the patron did not show up for the meal.
 
         * _bumped_ - the patron was on the wait list, but the restuarant
-        was unable to seat him, probably due to the end of service.
+        was unable to seat him.
 
         A patron can create a reservation for himself on any open wait
-        list, as long as he does not already have a reservation on another
-        wait list at "around the same time".
+        list, as long as he does not already have a "conflicting" reservation on
+        another wait list.
 
         A patron can also remove himself from a wait list, causing his
         reservation to be marked as either "cancelled" or "no show".
+
+        ### Restaurant
+
+        A wait list belongs to a **restaurant**, which consists of a place
+        (from a supported place API, e.g. Foursquare), a group of users, and
+        some wait lists.
+
+        The users associated with the restaurant represent the staff and are
+        able to manage the restaurant's wait lists, i.e. create or cancel
+        reservations on behalf of patrons or mark reservations as "seated",
+        "no show" or "bumped".
       DESC
     end
 
     doc.get '/wait_lists' do
-      description 'Search for wait lists by geolocation and party size'
+      description 'Search for wait lists by location and party size'
 
       authentication_required false
 
@@ -108,9 +106,9 @@ module Useless
               attribute 'latitude', 'The latitude of the restaurant', type: 'number'
               attribute 'latitude', 'The longitude of the restaurant', type: 'number'
             end
-            attribute 'reservations_start', 'The time that reservations can be created for this wait list', type: 'timestamp'
-            attribute 'estimated_seating_time', 'The time at which the next available reservation on the ' +
-              'wait list is estimated to be seated', type: 'timestamp'
+            attribute 'open_at', 'The time that reservations can be created for this wait list', type: 'timestamp'
+            attribute 'estimated_seated_at', 'The estimated time that the next reservation added ' +
+              'to the wait list will be seated', type: 'timestamp'
           end
         end
       end
@@ -139,15 +137,15 @@ module Useless
         attribute 'table_size', 'The party size that can be accomodated by the tables on this wait list',
           type: 'integer', required: true
         attribute 'table_quantity', 'The number of tables available on this wait list. ' +
-          'This number is used to determine the estimated_seating_time', type: 'integer', required: false
-        attribute 'seating_start', 'When the first resevation will be seated. Also used to determine the ' +
-          'estimated_seating_time', type: 'timestamp', required: false, default: '[now]'
-        attribute 'reservations_start', 'When reservations will be accepted for this wait list',
+          'This number is used to determine the estimated_seated_at', type: 'integer', required: false
+        attribute 'first_seated_at', 'When the first reservation will be seated. Also used to determine the ' +
+          'estimated_seated_at', type: 'timestamp', required: false, default: '[now]'
+        attribute 'open_at', 'When reservations will be accepted for this wait list',
           type: 'timestamp', required: false, default: '[now]'
-        attribute 'reservations_end', 'When this wait list close and stop accepting reservations',
+        attribute 'closed_at', 'When this wait list is automatically closed',
           type: 'timestamp', required: false
         attribute 'maximum_reservations', 'The total number of reservations that will be accepted before ' +
-          'the wait list closes', type: 'integer', required: false
+          'the wait list is automatically closed', type: 'integer', required: false
       end
 
       response 201, 'The wait list was successfully created' do
@@ -155,20 +153,73 @@ module Useless
       end
 
       response 401, 'Request must be authenticated'
+      response 401, 'Invalid access token'
       response 401, 'The user is not authorized to manage the specified restaurant'
       response 422, 'restaurant_id or table_size was omitted'
       response 404, 'The specified restaurant_id could not be found'
       response 422, 'Invalid table_size - must be an integer greater than zero'
       response 422, 'Invalid table_quantity - must be an integer greater than zero'
-      response 422, 'Invalid seating_start - must be a timestamp in ISO 8601 format'
-      response 422, 'Invalid reservations_start - must be a timestamp in ISO 8601 format'
-      response 422, 'Invalid reservations_end - must be a timestamp in ISO 8601 format, ' +
-        'greater than reservation_start'
+      response 422, 'Invalid first_seated_at - must be a timestamp in ISO 8601 format'
+      response 422, 'Invalid open_at - must be a timestamp in ISO 8601 format'
+      response 422, 'Invalid closed_at - must be a timestamp in ISO 8601 format, ' +
+        'greater than open_at'
       response 422, 'Invalid maximum_reservations - must be an integer greater than zero'
     end
 
     post '/wait_lists' do
       [501, 'Not yet implemented']
     end
+
+    doc.post '/wait_lists/:id/reservations' do
+      description 'Add a reservation to a wait list'
+
+      authentication_required true
+
+      response 201, 'Your reservation has been succesfully added to the wait list' do
+        body do
+          attribute 'id', 'The unique ID of this reservation'
+          attribute 'restaurant', 'The restaurant associated with the wait list', type: 'object' do
+            attribute 'id', 'The unique ID of the restaurant', type: 'string'
+            attribute 'name', 'The name of the restaurant', type: 'string'
+            attribute 'latitude', 'The latitude of the restaurant', type: 'number'
+            attribute 'latitude', 'The longitude of the restaurant', type: 'number'
+          end
+          attribute 'position', 'Your position on the wait list'
+          attribute 'estimated_seated_at', 'The time at which you are expected to be seated for ' +
+            'this reservation', type: 'timestamp'
+        end
+      end
+
+      response 401, 'Request must be authenticated'
+      response 401, 'Invalid access token'
+      response 404, 'The specified wait list ID could not be found'
+      response 422, 'Reservation could not be added due to another, conflicting reservation'
+      response 422, 'Reservation could not be added because the wait list is closed'
+    end
+
+    post '/wait_lists/:id/reservations' do
+      [501, 'Not yet implemented']
+    end
+
+    doc.put '/reservations/:id/state' do
+      description 'Set the state of a reservation'
+
+      authentication_required true
+
+      body do
+        content_type 'application/json'
+        attribute 'state', 'One of \'waiting\', \'cancelled\', \'seated\', \'no_show\' or \'bumped\''
+      end
+
+      response 201, 'The state of the reservation was successfully set'
+      response 401, 'Request must be authenticated'
+      response 401, 'Invalid access token'
+      response 401, 'You cannot set a reservation\'s state unless you are on the wait list\'s ' +
+        'restaurant\'s staff'
+      response 404, 'The specified wait list ID could not be found'
+      response 422, 'The value of state must be one of \'waiting\', \'cancelled\', \'seated\', ' +
+        '\'no_show\' or \'bumped\''
+      response 422, 'The reservation state could not be updated because the wait list is closed'
+    end
   end
 end

data/useless-wait-list.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
 
 Gem::Specification.new do |spec|
   spec.name           = 'useless-wait-list'
-  spec.version        = '0.0.4'
+  spec.version        = '0.0.5'
   spec.authors        = ['Kevin Hyland']
   spec.email          = ['khy@me.com']
   spec.summary        = 'For restaurants that don\'t take reservations'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: useless-wait-list
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Kevin Hyland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-25 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra