yelp-fusion 0.1.pre.beta

data/lib/yelp/fusion/configuration.rb

@@ -0,0 +1,37 @@
+# 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
+    class Configuration
+      attr_accessor :api_key
+
+      # Creates the configuration
+      # @param [config_api] String
+      # containing configuration parameter and its value
+      # @return [Configuration] a new configuration with the value from the
+      # config_api String
+      def initialize(config_api = nil)
+        return unless !config_api.nil? && config_api.is_a?(String)
+        self.api_key = config_api
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# 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 'erb'
+require 'json'
+
+require 'yelp/fusion/responses/business'
+
+module Yelp
+  module Fusion
+    module Endpoint
+      class Business
+        PATH = '/v3/businesses/'.freeze
+
+        def initialize(client)
+          @client = client
+        end
+
+        # Make a request to the business endpoint on the API
+        #
+        # @param id [String] the business id
+        # @param locale [Hash] a hash of supported locale-related parameters
+        # @return [Response::Business] the parsed response object from the API
+        #
+        # @example Get business
+        #   business = client.business('yelp-san-francisco')
+        #   business.name # => 'Yelp'
+        #   buinesss.url  # => 'http://www.yelp.com/biz/yelp-san-francisco'
+        def business(id, locale = {})
+          Responses::Business.new(JSON.parse(business_request(id, locale).body))
+        end
+
+        private
+
+        # Make a request to the business endpoint of the API
+        # The endpoint requires a format of /v3/business/{business-id}
+        # so the primary request parameter is concatenated. After getting
+        # the response back it's checked to see if there are any API errors
+        # and raises the relevant one if there is
+        #
+        # @param id [String, Integer] the business id
+        # @param locale [Hash] a hash of supported locale-related parameters
+        # @return [Faraday::Response] the raw response back from the connection
+        def business_request(id, locale = {})
+          result = @client.connection.get (PATH +
+            ERB::Util.url_encode(id)), locale
+          Error.check_for_error(result)
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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 'erb'
+require 'json'
+
+require 'yelp/fusion/responses/business'
+
+module Yelp
+  module Fusion
+    module Endpoint
+      class Match
+        PATH = '/v3/businesses/matches'.freeze
+
+        def initialize(client)
+          @client = client
+        end
+
+        # Make a request to the business endpoint on the API
+        #
+        # @param params [Hash] a hash of the required location parameters
+        # @return [Response::Match] a parsed object of the response.
+        #   For a complete sample response visit:
+        #   https://www.yelp.com/developers/documentation/v3/business_match
+        #
+        # @example Search for business with params
+        #   params = { name: 'swissbakers', address1:
+        #   '168 Western Ave', city: 'allston', state:
+        #   'MA', country: 'US' }
+        #   response = client.mathc(params)
+        #   response.businesses # [<Business 1>, <Business 2>, <Business 3>]
+        #   response.businesses[0].name # 'Yelp'
+        def match(params = {})
+          Responses::Match.new(JSON.parse(match_request(params).body))
+        end
+
+        private
+
+        def match_request(params = {})
+          result = @client.connection.get PATH, params
+          Error.check_for_error(result)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/endpoint/phone.rb

@@ -0,0 +1,71 @@
+# 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 'erb'
+require 'json'
+
+require 'yelp/fusion/responses/phone'
+
+module Yelp
+  module Fusion
+    module Endpoint
+      class Phone
+        PATH = '/v3/businesses/search/phone'.freeze
+
+        def initialize(client)
+          @client = client
+        end
+
+        # Make a request to the business endpoint on the API
+        #
+        # @param phone [String] the phone number
+        # @return [Response::Phone] a parsed object of the response.
+        #   For a complete sample response visit:
+        #   https://www.yelp.com/developers/documentation/v3/business_search_phone
+        #
+        # @example Search for business with params and locale
+        #
+        #   response = client.phone_search('+14159083801')
+        #   response.businesses # [<Business 1>, <Business 2>, <Business 3>]
+        #   response.businesses[0].name # 'Yelp'
+        def phone_search(phone)
+          phone_hash = { phone: phone }
+          Responses::Phone.new(JSON.parse(phone_request(phone_hash).body))
+        end
+
+        private
+
+        # Make a request to the business endpoint of the API
+        # The endpoint requires a format of /v3/business_search_phone
+        # so the primary request parameter is concatenated. After getting
+        # the response back it's checked to see if there are any API errors
+        # and raises the relevant one if there is.
+        #
+        # @param phone [String] the phone number
+        # @return [Faraday::Response] the raw response back from the connection
+        def phone_request(phone)
+          result = @client.connection.get PATH, phone
+          Error.check_for_error(result)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/endpoint/review.rb

@@ -0,0 +1,72 @@
+# 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 'erb'
+require 'json'
+
+require 'yelp/fusion/responses/review'
+
+module Yelp
+  module Fusion
+    module Endpoint
+      class Review
+        PATH = '/v3/businesses/'.freeze
+
+        def initialize(client)
+          @client = client
+        end
+
+        # Make a request to the business endpoint on the API
+        #
+        # @param id [String] the business id
+        # @param locale [Hash] a hash of supported locale-related parameters
+        # @return [Response::Review] the parsed response object from the API
+        #
+        # @example Get Review
+        #   id = 'xAG4O7l-t1ubbwVAlPnDKg'
+        #   locale = { lang: 'fr' }
+        #   response = client.review(id, locale)
+        #   response.name # => 'Yelp'
+        #   response.url  # => 'http://www.yelp.com/biz/yelp-san-francisco'
+        def review(id, locale = {})
+          Responses::Review.new(JSON.parse(review_request(id, locale).body))
+        end
+
+        private
+
+        # Make a request to the review endpoint of the API
+        # The endpoint requires a format of v3/businesses/{id}/reviews
+        # so the primary request parameter is concatenated. After getting
+        # the response back it's checked to see if there are any API errors
+        # and raises the relevant one if there is.
+        #
+        # @param id [String] the business id
+        # @param locale [Hash] a hash of supported locale-related parameters
+        # @return [Faraday::Response] the raw response back from the connection
+        def review_request(id, locale = {})
+          result = @client.connection.get (PATH +
+            ERB::Util.url_encode(id) + '/reviews'), locale
+          Error.check_for_error(result)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/endpoint/search.rb

@@ -0,0 +1,104 @@
+# 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'
+require 'yelp/fusion/responses/search'
+
+module Yelp
+  module Fusion
+    module Endpoint
+      class Search
+        PATH = '/v3/businesses/search'.freeze
+        def initialize(client)
+          @client = client
+        end
+
+        # Take a search_request and return the formatted/structured
+        # response from the API
+        #
+        # @param location [String] a string location of the neighborhood,
+        #   address, or city
+        # @param params [Hash] a hash that corresponds to params on the API:
+        #   https://www.yelp.com/developers/documentation/v3/business_search
+        # @return [Response::Search] a parsed object of the response.
+        #   For a complete list of possible response values visit:
+        #   https://www.yelp.com/developers/documentation/v3/business_search
+        #
+        # @example Search for business with params
+        #   params = { term: 'food',
+        #              limit: 3,
+        #              category: 'discgolf' }
+        #
+        #   response = client.search('San Francisco', params)
+        #   response.businesses # [<Business 1>, <Business 2>, <Business 3>]
+        #   response.businesses[0].name # 'Yelp'
+        def search(location, params = {})
+          params[:location] = location
+
+          Responses::Search.new(JSON.parse(search_request(params).body))
+        end
+
+        # Search by coordinates: give it a latitude and longitude along with
+        # option accuracy, altitude, and altitude_accuracy to search an area.
+        # More info at:
+        # https://www.yelp.com/developers/documentation/v3/business_search
+        #
+        # @param coordinates [Hash] a hash of latitude and longitude.
+        # @param params [Hash] a hash that corresponds to params on the API:
+        #   https://www.yelp.com/developers/documentation/v3/business_search
+        # @return [Response::Search] a parsed object of the response.
+        #   For a complete list of possible response values visit:
+        #   https://www.yelp.com/developers/documentation/v3/business_search
+        #
+        # @example Search for business with params
+        #   coordinates = { latitude: 37.786732,
+        #                   longitude: -122.399978 }
+        #
+        #   params = { term: 'food',
+        #              limit: 3,
+        #              category: 'discgolf' }
+        #
+        #   response = client.search(coordinates, params)
+        #   response.businesses # [<Business 1>, <Business 2>, <Business 3>]
+        #   response.businesses[0].name # 'Yelp'
+        def search_by_coordinates(coordinates, params = {})
+          raise Error::MissingLatLng if coordinates[:latitude].nil? ||
+                                        coordinates[:longitude].nil?
+          coordinates.merge!(params)
+          Responses::Search.new(JSON.parse(search_request(coordinates).body))
+        end
+
+        private
+
+        # Make a request against the search endpoint from the API and return the
+        # raw response. After getting the response back it's checked to see if
+        # there are any API errors and raises the relevant one if there is.
+        #
+        # @param params [Hash] a hash of parameters for the search request
+        # @return [Faraday::Response] the raw response back from the connection
+        def search_request(params)
+          result = @client.connection.get PATH, params
+          Yelp::Fusion::Error.check_for_error(result)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/yelp/fusion/endpoint/transaction.rb

@@ -0,0 +1,97 @@
+# 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 'erb'
+require 'json'
+
+require 'yelp/fusion/responses/business'
+
+module Yelp
+  module Fusion
+    module Endpoint
+      class Transaction
+        PATH = '/v3/transactions/'.freeze
+
+        def initialize(client)
+          @client = client
+        end
+
+        # Make a request to the business endpoint on the API
+        #
+        # @param id [String] the business id
+        # @param locale [Hash] a hash of supported locale-related parameters
+        # @return [Response::Review] the parsed response object from the API
+        #
+        # @example Get Transaction
+        #   review = client.transaction('delivery', 'San Francisco')
+        #   review.name # => 'Yelp'
+        #   review.url  # => 'http://www.yelp.com/biz/yelp-san-francisco'
+        def transaction_search(transaction_type, location)
+          result = transaction_request(transaction_type, location)
+          Responses::Transaction.new(JSON.parse(result.body))
+        end
+
+        # Search by coordinates: give it a latitude and longitude along with
+        # option accuracy, altitude, and altitude_accuracy to search an area.
+        # More info at
+        # https://www.yelp.com/developers/documentation/v3/transaction_search
+        #
+        # @param coordinates [Hash] a hash of latitude and longitude.
+        # @param params [Hash] a hash that corresponds to params on the API:
+        #   https://www.yelp.com/developers/documentation/v3/transaction_search
+        # @return [Response::Search] a parsed object of the response.
+        #   For a complete list of possible response values visit:
+        #   https://www.yelp.com/developers/documentation/v3/transaction_search
+        #
+        # @example Search for business with params
+        #   coordinates = { latitude: 37.786732,
+        #                   longitude: -122.399978 }
+        #
+        #   response = client.search('delivery', coordinates)
+        #   response.businesses # [<Business 1>, <Business 2>, <Business 3>]
+        #   response.businesses[0].name # 'Yelp'
+        def transaction_by_coordinates(transaction_type, coordinates)
+          raise Error::MissingLatLng if coordinates[:latitude].nil? ||
+                                        coordinates[:longitude].nil?
+          result = transaction_request(transaction_type, coordinates)
+          Responses::Transaction.new(JSON.parse(result.body))
+        end
+
+        private
+
+        # Make a request to the transaction endpoint of the API
+        # The endpoint requires a format of /v3/transaction_search
+        # so the primary request parameter is concatenated. After getting
+        # the response back it's checked to see if there are any API errors
+        # and raises the relevant one if there is.
+        #
+        # @param transaction_type [String] it has to be delivery
+        # @param location [Hash] a hash of supported location
+        # @return [Faraday::Response] the raw response back from the connection
+        def transaction_request(transaction_type, location)
+          result = @client.connection.get (PATH +
+            ERB::Util.url_encode(transaction_type) + '/search'), location
+          Error.check_for_error(result)
+          result
+        end
+      end
+    end
+  end
+end