hungrytable 0.0.8 → 1.0.0

data/lib/hungrytable/reservation_status.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Hungrytable
+  # Checks the status of an existing reservation
+  class ReservationStatus
+    include RequestExtensions
+
+    attr_reader :opts
+
+    def initialize(opts = {})
+      @opts = opts
+      ensure_required_opts
+      @requester = opts[:requester] || GetRequest
+    end
+
+    # @return [Boolean] true if the status request was successful
+    def successful?
+      details['ns:ErrorID'].to_s == '0'
+    end
+
+    # @return [String] the current status of the reservation
+    def status
+      return nil unless successful?
+
+      details['ns:ReservationStatus']
+    end
+
+    # @return [Hash] all reservation details
+    def reservation_details
+      return nil unless successful?
+
+      {
+        status: details['ns:ReservationStatus'],
+        restaurant_name: details['ns:RestaurantName'],
+        date_time: details['ns:DateTime'],
+        party_size: details['ns:PartySize'],
+        confirmation_number: opts[:confirmation_number]
+      }
+    end
+
+    private
+
+    def request_uri
+      "/reservationstatus/?pid=#{Config.partner_id}&rid=#{opts[:restaurant_id]}&" \
+        "conf=#{CGI.escape(opts[:confirmation_number].to_s)}"
+    end
+
+    def details
+      @details ||= request.parsed_response['StatusResults'] || {}
+    end
+
+    def required_opts
+      %i[confirmation_number restaurant_id]
+    end
+  end
+end

data/lib/hungrytable/restaurant.rb

@@ -1,46 +1,59 @@
+# frozen_string_literal: true
+
 module Hungrytable
+  # Represents a restaurant and its details from the OpenTable API
   class Restaurant
     include RequestExtensions
 
-    def initialize restaurant_id, opts={}
-      @requester     = opts[:requester] || GetRequest
+    # Attributes that map directly to API response fields
+    ATTRIBUTES = %i[
+      address
+      city
+      error_ID
+      error_message
+      image_link
+      latitude
+      longitude
+      metro_name
+      neighborhood_name
+      parking
+      parking_details
+      phone
+      postal_code
+      price_range
+      primary_food_type
+      restaurant_description
+      restaurant_ID
+      restaurant_name
+      state
+      url
+    ].freeze
+
+    attr_reader :restaurant_id
+
+    def initialize(restaurant_id, opts = {})
+      @requester = opts[:requester] || GetRequest
       @restaurant_id = restaurant_id
     end
 
+    # Alias for consistency
     def id
       @restaurant_id
     end
 
+    # Check if the restaurant query was valid
+    # @return [Boolean] true if no errors
     def valid?
-      error_ID == "0"
+      error_ID.to_s == '0'
     end
 
-    def method_missing meth, *args, &blk
-      if %w(
-            address
-            city
-            error_ID
-            error_message
-            image_link
-            latitude
-            longitude
-            metro_name
-            neighborhood_name
-            parking
-            parking_details
-            phone
-            postal_code
-            price_range
-            primary_food_type
-            restaurant_description
-            restaurant_ID
-            restaurant_name
-            state
-            url
-          ).map(&:to_sym).include?(meth)
-        return details["ns:#{meth.to_s.camelize.gsub("Id","ID")}"]
+    # Dynamically define getter methods for all attributes
+    ATTRIBUTES.each do |attr|
+      define_method(attr) do
+        # Convert Ruby snake_case to API camelCase, handling special case of ID
+        api_key = "ns:#{attr.to_s.camelize.gsub('Id', 'ID')}"
+        details[api_key]
       end
-      super
     end
 
     private
@@ -49,10 +62,9 @@ module Hungrytable
       "/restaurant/?pid=#{Config.partner_id}&rid=#{id}"
     end
 
-    # @return [Hash]
+    # @return [Hash] restaurant details from API response
     def details
-      request.parsed_response["RestaurantDetailsResults"]
+      @details ||= request.parsed_response['RestaurantDetailsResults'] || {}
     end
-
   end
 end

data/lib/hungrytable/restaurant_search.rb

@@ -1,77 +1,106 @@
+# frozen_string_literal: true
+
 module Hungrytable
+  # Searches for available reservation times at a restaurant
   class RestaurantSearch
     include RequestExtensions
 
+    # Attributes that map directly to API response fields
+    ATTRIBUTES = %i[
+      cuisine_type
+      early_security_ID
+      early_time
+      error_ID
+      error_message
+      exact_security_ID
+      exact_time
+      later_security_ID
+      later_time
+      latitude
+      longitude
+      neighborhood_name
+      restaurant_name
+      results_key
+      no_times_message
+    ].freeze
+
     attr_reader :restaurant, :opts
 
-    def initialize restaurant, opts={}
+    def initialize(restaurant, opts = {})
       @opts = opts
       ensure_required_opts
-      @requester  = opts[:requester] || GetRequest
+      validate_date_time_type
+      validate_party_size
+      @requester = opts[:requester] || GetRequest
       @restaurant = restaurant
     end
 
+    # Check if the search was valid
+    # @return [Boolean] true if no errors
     def valid?
-      error_ID == "0"
+      error_ID.to_s == '0'
     end
 
-    def method_missing meth, *args, &blk
-      if %w(
-            cuisine_type
-            early_security_ID
-            early_time
-            error_ID
-            error_message
-            exact_security_ID
-            exact_time
-            later_security_ID
-            later_time
-            latitude
-            longitude
-            neighborhood_name
-            restaurant_name
-            results_key
-            no_times_message
-          ).map(&:to_sym).include?(meth)
-        return details["ns:#{meth.to_s.camelize.gsub("Id","ID")}"]
+    # Dynamically define getter methods for all attributes
+    ATTRIBUTES.each do |attr|
+      define_method(attr) do
+        # Convert Ruby snake_case to API camelCase, handling special case of ID
+        api_key = "ns:#{attr.to_s.camelize.gsub('Id', 'ID')}"
+        details[api_key]
       end
-      super
     end
 
+    # Get the best available security ID
+    # @return [String, nil] the ideal security ID for slotlock
     def ideal_security_id
-      return exact_security_ID unless exact_security_ID.nil?
-      return early_security_ID unless early_security_ID.nil?
-      return later_security_ID unless later_security_ID.nil?
-      nil
+      exact_security_ID || early_security_ID || later_security_ID
     end
 
+    # Get the best available time
+    # @return [String, nil] the ideal time for reservation
     def ideal_time
-      return exact_time unless exact_time.nil?
-      return early_time unless early_time.nil?
-      return later_time unless later_time.nil?
-      nil
+      exact_time || early_time || later_time
     end
 
+    # Get the party size for this search
+    # @return [Integer] number of people
     def party_size
       opts[:party_size]
     end
 
     private
+
     def required_opts
-      %w(date_time party_size).map(&:to_sym)
+      %i[date_time party_size]
     end
 
     def encoded_date_time
-      URI.encode(opts[:date_time].strftime("%m/%d/%Y %I:%M %p"), /[^a-z0-9\-\.\_\~]/i)
+      # Use CGI.escape instead of deprecated URI.encode
+      CGI.escape(opts[:date_time].strftime('%m/%d/%Y %I:%M %p'))
     end
 
     def request_uri
       "/table/?pid=#{Config.partner_id}&rid=#{restaurant.id}&dt=#{encoded_date_time}&ps=#{party_size}"
     end
 
+    # @return [Hash] search results from API response
     def details
-      request.parsed_response["SearchResults"]
+      @details ||= request.parsed_response['SearchResults'] || {}
+    end
+
+    def validate_date_time_type
+      return if opts[:date_time].respond_to?(:strftime)
+
+      raise ValidationError,
+            "date_time must be a Time or DateTime object, got #{opts[:date_time].class}"
     end
 
+    def validate_party_size
+      ps = opts[:party_size]
+      return if ps.is_a?(Integer) && ps.positive? && ps <= 20
+
+      raise ValidationError,
+            "party_size must be a positive integer between 1 and 20, got #{ps.inspect}"
+    end
   end
 end

data/lib/hungrytable/restaurant_slotlock.rb

@@ -1,38 +1,52 @@
+# frozen_string_literal: true
+
 module Hungrytable
+  # Locks a reservation time slot before making a reservation
   class RestaurantSlotlock
     include RequestExtensions
 
     attr_reader :restaurant_search
 
-    def initialize restaurant_search, requester=PostRequest
+    def initialize(restaurant_search, requester = PostRequest)
       @restaurant_search = restaurant_search
-      @requester         = requester
+      @requester = requester
+      validate_search_has_results
     end
 
+    # Check if the slotlock was successful
+    # @return [Boolean] true if no errors
     def successful?
-      details["ns:ErrorID"] == "0"
+      details['ns:ErrorID'].to_s == '0'
     end
 
+    # Get error messages if slotlock failed
+    # @return [String, nil] error message or nil
     def errors
-      details["ns:ErrorMessage"]
+      details['ns:ErrorMessage']
     end
 
+    # Get the slotlock ID needed for making a reservation
+    # @return [String, nil] slotlock ID or nil if unsuccessful
     def slotlock_id
       return nil unless successful?
-      details["ns:SlotLockID"]
+
+      details['ns:SlotLockID']
     end
 
+    # Parameters to send with the slotlock request
+    # @return [Hash] request parameters
     def params
       {
-        'RID'            => restaurant.id,
-        'datetime'       => restaurant_search.ideal_time,
-        'partysize'      => restaurant_search.party_size,
+        'RID' => restaurant.id,
+        'datetime' => restaurant_search.ideal_time,
+        'partysize' => restaurant_search.party_size,
         'timesecurityID' => restaurant_search.ideal_security_id,
-        'resultskey'     => restaurant_search.results_key
+        'resultskey' => restaurant_search.results_key
       }
     end
 
     private
+
     def request_uri
       "/slotlock/?pid=#{Config.partner_id}&st=0"
     end
@@ -41,9 +55,17 @@ module Hungrytable
       restaurant_search.restaurant
     end
 
+    # @return [Hash] slotlock results from API response
     def details
-      request.parsed_response["SlotLockResults"]
+      @details ||= request.parsed_response['SlotLockResults'] || {}
     end
 
+    def validate_search_has_results
+      if restaurant_search.ideal_security_id.nil? ||
+         restaurant_search.ideal_time.nil? ||
+         restaurant_search.results_key.nil?
+        raise ValidationError, 'Cannot create slotlock: no available times found in restaurant search'
+      end
+    end
   end
 end

data/lib/hungrytable/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hungrytable
-  VERSION = "0.0.8"
+  VERSION = '1.0.0'
 end

data/lib/hungrytable.rb

@@ -1,73 +1,125 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'json'
-require 'openssl'
-require 'base64'
 require 'cgi'
-require 'curb'
-require 'active_support/core_ext'
-require 'hungrytable/version'
-require 'hungrytable/config'
-require 'hungrytable/request_extensions'
-require 'hungrytable/request_header'
-require 'hungrytable/request'
-require 'hungrytable/get_request'
-require 'hungrytable/post_request'
-require 'hungrytable/restaurant'
-require 'hungrytable/restaurant_search'
-require 'hungrytable/restaurant_slotlock'
-require 'hungrytable/reservation_make'
-require 'hungrytable/reservation_status'
-require 'hungrytable/reservation_cancel'
+require 'http'
+require 'oauth'
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/concern'
+
+require_relative 'hungrytable/version'
+require_relative 'hungrytable/errors'
+require_relative 'hungrytable/config'
+
+# Safety features
+require_relative 'hungrytable/circuit_breaker'
+require_relative 'hungrytable/api_health_monitor'
+require_relative 'hungrytable/enhanced_errors'
+
+# Core functionality
+require_relative 'hungrytable/request_extensions'
+require_relative 'hungrytable/request_header'
+require_relative 'hungrytable/request'
+require_relative 'hungrytable/get_request'
+require_relative 'hungrytable/post_request'
+require_relative 'hungrytable/restaurant'
+require_relative 'hungrytable/restaurant_search'
+require_relative 'hungrytable/restaurant_slotlock'
+require_relative 'hungrytable/reservation_make'
+require_relative 'hungrytable/reservation_status'
+require_relative 'hungrytable/reservation_cancel'
 
 module Hungrytable
-  class HungrytableError < StandardError;end
+  # OpenTable API error codes
+  # @return [Hash] mapping of error codes to error details
+  ERROR_CODES = {
+    152 => { message: 'The email address is not valid. Please try again.', name: 'VALIDEMAIL' },
+    160 => {
+      message: "We're sorry but we were unable to complete you request. Our technical team has been notified " \
+               'of the problem and will resolve it shortly. Thank you.',
+      name: 'GENERALERROR'
+    },
+    197 => { message: 'You must select at least one restaurant to search.', name: 'PROVIDERESTAURANT' },
+    202 => {
+      message: 'The time you selected has already passed. You may wish to check that your computer clock ' \
+               'is correct.',
+      name: 'PASSEDTIME'
+    },
+    274 => { message: 'Your phone number must be numeric.', name: 'NUMERICPHONE' },
+    279 => { message: 'Your IP address is not listed as an OpenTable Partner IP.', name: 'INVALIDIP' },
+    280 => { message: 'Key authentication failure', name: 'AUTHENTICATEFAIL' },
+    281 => { message: 'The phone length for the number provided was not a valid length for the country code.',
+             name: 'INVALIDPHONELENGTH' },
+    282 => {
+      message: 'We are currently unable to connect to the restaurant to complete this action. ' \
+               'Please try again later.',
+      name: 'ERBERROR'
+    },
+    283 => { message: 'The time you have chosen for your reservation is no longer available.',
+             name: 'RESERVATIONNOTAVAIL' },
+    285 => { message: 'Credit Card transactions are not allowed via OT Web Services.', name: 'CCNOTALLOWED' },
+    286 => { message: 'Large parties are not allowed via OT Web Services.', name: 'LARGEPARTYNOTALLOWED' },
+    287 => { message: 'The restaurant is currently offline.', name: 'RESTOFFLINE' },
+    288 => { message: 'The restaurant is currently unreachable.', name: 'RESTUNREACHABLE' },
+    289 => { message: 'Cancel transaction failed.', name: 'CANCELFAIL' },
+    294 => { message: 'You have not provided enough information to perform the search.',
+             name: 'INSUFFICIENTINFORMATION' },
+    295 => { message: 'No restaurants were found in your search. Please try again.', name: 'NORESTAURANTSRETURNED' },
+    296 => { message: 'Your search produced no times.', name: 'NOTIMESMESSAGE' },
+    298 => { message: 'The confirmation number is invalid.', name: 'VALIDCONFIRMNUMBER' },
+    299 => { message: 'The reservation status is not available on reservations older than 30 days.',
+             name: 'VALIDSTATUSDATE' },
+    301 => {
+      message: 'The user for the reservation request already has a reservation within 2 hours ' \
+               'of the requested time.',
+      name: 'VALIDDUPRESERVATION'
+    },
+    302 => { message: 'No Reservation Activity found.', name: 'NORESOHISTORYAVAILABLE' },
+    303 => { message: 'Invalid User Email. Please re-enter your UserEmail.', name: 'INVALIDUSEREMAIL' },
+    304 => { message: 'Invalid User Password. Please re-enter your password.', name: 'INVALIDUSERPASSWORD' },
+    305 => { message: 'Unable to authenticate user to login. Please try again.', name: 'USERAUTHENTICATIONFAIL' },
+    306 => { message: 'The entered area to search is too large please limit your search to 20 miles.',
+             name: 'SEARCHAREATOOLARGE' },
+    307 => { message: 'The email address(es) you have provided are not in the correct format. Please try again.',
+             name: 'INVALIDEMAILADDRESSES' },
+    308 => {
+      message: 'Your reservation has already been cancelled, please hit the Reload button on your profile ' \
+               'to refresh your page',
+      name: 'ALREADYCANCELLED'
+    },
+    309 => { message: 'You must use SSL for this request.', name: 'SSLCONNECTIONREQUIRED' },
+    310 => { message: 'The points requested for this time slot are not available.', name: 'INVALIDPOINTREQUEST' },
+    311 => { message: 'The user account is deactivated.', name: 'ACCTDEACTIVATED' },
+    313 => { message: 'The requested Restaurant was not found.', name: 'INVALIDRESTAURANTID' },
+    314 => { message: 'We already have an account registered to <email address>', name: 'MATCHACCOUNT' },
+    315 => { message: 'A default metro must be provided for a use', name: 'PROVIDEMETRO' },
+    316 => { message: 'The password must be a minimum of 6 characters.', name: 'MALFORMEDPASSWORD' },
+    317 => { message: 'The phone length for the number provided was not a valid length for the country code.',
+             name: 'INVALIDPHONE' },
+    318 => { message: 'Please enter a valid country id for the phone number.', name: 'PROVIDEPHONECOUNTRY' },
+    319 => { message: 'Please enter a valid country id for the mobile phone number.',
+             name: 'PROVIDEMOBILEPHONECOUNTRY' },
+    321 => {
+      message: "We're sorry, but we could not complete your reservation request because an account cannot " \
+               'have more than two confirmed reservations into the same restaurant for the same day.',
+      name: 'VALIDTOOMANYSAMEREST'
+    },
+    322 => { message: 'The time slot for this reservation is no longer available.', name: 'SLOTLOCKUNAVAILABLE' },
+    323 => { message: 'The service you are trying to access is currently unavailable, please try again later.',
+             name: 'SERVICEUNAVAILABLE' },
+    324 => { message: 'The service experienced a timeout. Please try again later.', name: 'SERVICETIMEOUT' },
+    325 => { message: 'Invalid number of lookback days, the most you can look back is 8 days.',
+             name: 'INVALIDLOOKBACKDAYS' },
+    326 => { message: 'This service is currently disabled. Please try again later.', name: 'CURRENTLYDISABLED' }
+  }.freeze
 
-  def error_codes
-    {
-      152 => { message: 'The email address is not valid.  Please try again.', name: 'VALIDEMAIL' },
-      160 => { message: "We're sorry but we were unable to complete you request.  Our technical team has been notified of the problem and will resolve it shortly.  Thank you.", name: "GENERALERROR" },
-      197 => { message: "You must select at least one restaurant to search.", name: "PROVIDERESTAURANT" },
-      202 => { message: "The time you selected has already passed.  You may wish to check that your computer clock is correct.", name: "PASSEDTIME" },
-      274 => { message: "Your phone number must be numeric.", name: "NUMERICPHONE" },
-      279 => { message: "Your IP address is not listed as an OpenTable Partner IP.", name: "INVALIDIP" },
-      280 => { message: "Key authentication failure", name: "AUTHENTICATEFAIL" },
-      281 => { message: "The phone length for the number provided was not a valid length for the country code.", name: "INVALIDPHONELENGTH" },
-      282 => { message: "We are currently unable to connect to the restaurant to complete this action. Please try again later.", name: "ERBERROR" },
-      283 => { message: "The time you have chosen for your reservation is no longer available.", name: "RESERVATIONNOTAVAIL" },
-      285 => { message: "Credit Card transactions are not allowed via OT Web Services.", name: "CCNOTALLOWED" },
-      286 => { message: "Large parties are not allowed via OT Web Services.", name: "LARGEPARTYNOTALLOWED" },
-      287 => { message: "The restaurant is currently offline.", name: "RESTOFFLINE" },
-      288 => { message: "The restaurant is currently unreachable.", name: "RESTUNREACHABLE" },
-      289 => { message: "Cancel transaction failed.", name: "CANCELFAIL" },
-      294 => { message: "You have not provided enough information to perform the search.", name: "INSUFFICIENTINFORMATION" },
-      295 => { message: "No restaurants were found in your search.  Please try again.", name: "NORESTAURANTSRETURNED" },
-      296 => { message: "Your search produced no times.", name: "NOTIMESMESSAGE" },
-      298 => { message: "The confirmation number is invalid.", name: "VALIDCONFIRMNUMBER" },
-      299 => { message: "The reservation status is not available on reservations older than 30 days.", name: "VALIDSTATUSDATE" },
-      301 => { message: "The user for the reservation request already has a reservation within 2 hours of the requested time.", name: "VALIDDUPRESERVATION" },
-      302 => { message: "No Reservation Activity found.", name: "NORESOHISTORYAVAILABLE" },
-      303 => { message: "Invalid User Email. Please re-enter your UserEmail.", name: "INVALIDUSEREMAIL" },
-      304 => { message: "Invalid User Password. Please re-enter your password.", name: "INVALIDUSERPASSWORD" },
-      305 => { message: "Unable to authenticate user to login. Please try again.", name: "USERAUTHENTICATIONFAIL" },
-      306 => { message: "The entered area to search is too large please limit your search to 20 miles.", name: "SEARCHAREATOOLARGE" },
-      307 => { message: "The email address(es) you have provided are not in the correct format. Please try again.", name: "INVALIDEMAILADDRESSES" },
-      308 => { message: "Your reservation has already been cancelled, please hit the Reload button on your profile to refresh your page", name: "ALREADYCANCELLED" },
-      309 => { message: "You must use SSL for this request.", name: "SSLCONNECTIONREQUIRED" },
-      310 => { message: "The points requested for this time slot are not available.", name: "INVALIDPOINTREQUEST" },
-      311 => { message: "The user account is deactivated.", name: "ACCTDEACTIVATED" },
-      313 => { message: "The requested Restaurant was not found.", name: "INVALIDRESTAURANTID" },
-      314 => { message: "We already have an account registered to <email address>", name: "MATCHACCOUNT" },
-      315 => { message: "A default metro must be provided for a use", name: "PROVIDEMETRO" },
-      316 => { message: "The password must be a minimum of 6 characters.", name: "MALFORMEDPASSWORD" },
-      317 => { message: "The phone length for the number provided was not a valid length for the country code.", name: "INVALIDPHONE" },
-      318 => { message: "Please enter a valid country id for the phone number.", name: "PROVIDEPHONECOUNTRY" },
-      319 => { message: "Please enter a valid country id for the mobile phone number.", name: "PROVIDEMOBILEPHONECOUNTRY" },
-      321 => { message: "We're sorry, but we could not complete your reservation request because an account cannot have more than two confirmed reservations into the same restaurant for the same day.", name: "VALIDTOOMANYSAMEREST" },
-      322 => { message: "The time slot for this reservation is no longer available.", name: "SLOTLOCKUNAVAILABLE" },
-      323 => { message: "The service you are trying to access is currently unavailable, please try again later.", name: "SERVICEUNAVAILABLE" },
-      324 => { message: "The service experienced a timeout.  Please try again later.", name: "SERVICETIMEOUT" },
-      325 => { message: "Invalid number of lookback days, the most you can look back is 8 days.", name: "INVALIDLOOKBACKDAYS" },
-      326 => { message: "This service is currently disabled.  Please try again later.", name: "CURRENTLYDISABLED" }
-    }
+  class << self
+    # Configure the gem programmatically
+    # @yield [Config] configuration object
+    def configure
+      yield Config if block_given?
+    end
   end
 end