yelp-fusion 0.1.pre.beta

data/lib/yelp/fusion/error.rb

@@ -0,0 +1,105 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'json'
+
+module Yelp
+  module Fusion
+    module Error
+      class ResponseValidator
+        # If the request is not successful, raise an appropriate Yelp::Error
+        # exception with the error text from the request response.
+        # @param response from the Yelp API
+        def validate(response)
+          return if successful_response?(response)
+          raise error_from_response(response)
+        end
+
+        private
+
+        def successful_response?(response)
+          # check if the status is in the range of non-error status codes
+          (200..399).cover?(response.status)
+        end
+
+        # Create an initialized exception from the response
+        # @return [Yelp::Error::Base] exception corresponding to API error
+        def error_from_response(response)
+          body = JSON.parse(response.body)
+          klass = error_classes[body['error']['code']]
+          klass.new(body['error']['description'], body['error'])
+        end
+
+        # Maps from API Error id's to Yelp::Error exception classes.
+        def error_classes
+          @error_classes ||= Hash.new do |hash, key|
+            class_name = key.split('_').map(&:capitalize).join('')
+            hash[key] = Yelp::Fusion::Error.const_get(class_name)
+          end
+        end
+      end
+
+      # Check the response for errors, raising an appropriate exception if
+      # necessary
+      # @param (see ResponseValidator#validate)
+      def self.check_for_error(response)
+        @response_validator ||= ResponseValidator.new
+        @response_validator.validate(response)
+      end
+
+      class Base < StandardError
+        def initialize(msg, _error = nil)
+          super(msg)
+        end
+      end
+
+      class AlreadyConfigured < Base
+        def initialize(msg = 'Gem cannot be reconfigured.  Initialize a new ' \
+          'instance of Yelp::Client.', error = nil)
+          super
+        end
+      end
+
+      class MissingAPIKeys < Base
+        def initialize(msg = "You're missing an API key", error = nil)
+          super
+        end
+      end
+
+      class MissingLatLng < Base
+        def initialize(msg = 'Missing required latitude '\
+          'or longitude parameters', error = nil)
+          super
+        end
+      end
+
+      class TokenInvalid < Base; end
+      class LocationNotFound < Base; end
+      class TooManyRequestsPerSecond < Base; end
+      class InternalError < Base; end
+      class ValidationError < Base; end
+      class TokenMissing < Base; end
+      class RequestTimedOut < Base; end
+      class AccessLimitReached < Base; end
+      class NotFound < Base; end
+      class ClientError < Base; end
+    end
+  end
+end

data/lib/yelp/fusion/responses/base.rb

@@ -0,0 +1,43 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Yelp
+  module Fusion
+    module Responses
+      class Base
+        # yelp returns its data in JSON form/language
+        def initialize(json)
+          return if json.nil?
+          json.each do |key, value|
+            instance_variable_set("@#{key}", value)
+          end
+        end
+
+        private
+
+        def parse(json, klass)
+          return json.collect { |j| klass.new(j) } if json.is_a?(Array)
+          return klass.new(json) if json
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/responses/business.rb

@@ -0,0 +1,36 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'yelp/fusion/responses/base'
+require 'yelp/fusion/responses/models/business'
+
+module Yelp
+  module Fusion
+    module Responses
+      class Business < Base
+        attr_reader :business
+        def initialize(json)
+          super(business)
+          @business = parse(json, Models::Business)
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/responses/match.rb

@@ -0,0 +1,36 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'yelp/fusion/responses/base'
+require 'yelp/fusion/responses/models/business'
+
+module Yelp
+  module Fusion
+    module Responses
+      class Match < Base
+        attr_reader :total, :businesses
+        def initialize(json)
+          super(json)
+          @businesses = parse(@businesses, Models::Business)
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/responses/models/business.rb

@@ -0,0 +1,48 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'yelp/fusion/responses/base'
+require 'yelp/fusion/responses/models/categories'
+require 'yelp/fusion/responses/models/location'
+require 'yelp/fusion/responses/models/hours'
+
+module Yelp
+  module Fusion
+    module Responses
+      module Models
+        class Business < Responses::Base
+          attr_reader :categories, :coordinates, :display_phone,
+                      :distance, :id,
+                      :alias, :image_url, :is_closed, :location,
+                      :name, :phone, :price,
+                      :rating, :review_count, :url, :transactions,
+                      :hours, :is_claimed, :photos
+          def initialize(json)
+            super(json)
+            @categories = parse(@categories, Categories)
+            @location = parse(@location, Location)
+            @hours = parse(@hours, Hours)
+            @coordinates = parse(@coordinates, Center)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/responses/models/categories.rb

@@ -0,0 +1,34 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Yelp
+  module Fusion
+    module Responses
+      module Models
+        class Categories < Responses::Base
+          attr_reader :alias, :title
+          def initialize(json)
+            super(json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/responses/models/center.rb

@@ -0,0 +1,34 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Yelp
+  module Fusion
+    module Responses
+      module Models
+        class Center < Responses::Base
+          attr_reader :latitude, :longitude
+          def initialize(json)
+            super(json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/responses/models/hours.rb

@@ -0,0 +1,38 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'yelp/fusion/responses/base'
+require 'yelp/fusion/responses/models/openHours'
+
+module Yelp
+  module Fusion
+    module Responses
+      module Models
+        class Hours < Responses::Base
+          attr_reader :is_open_now, :hours_type, :open
+          def initialize(json)
+            super(json)
+            @open = parse(@open, OpenHours)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/responses/models/location.rb

@@ -0,0 +1,36 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Yelp
+  module Fusion
+    module Responses
+      module Models
+        class Location < Responses::Base
+          attr_reader :city, :country, :address2, :address3,
+                      :state, :address1, :zip_code,
+                      :cross_streets, :display_address
+          def initialize(json)
+            super(json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/responses/models/openHours.rb

@@ -0,0 +1,34 @@
+# Copyright (c) Jobcase, Inc. All rights reserved. 
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Yelp
+  module Fusion
+    module Responses
+      module Models
+        class OpenHours < Responses::Base
+          attr_reader :day, :start, :end, :is_overnight
+          def initialize(json)
+            super(json)
+          end
+        end
+      end
+    end
+  end
+end