yelp 2.0.7 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11c890b74574ed87a98958e5492b2576187d53ae
-  data.tar.gz: ffb12c0d8ab4e37692aea9a51ab7ba2268d255cc
+  metadata.gz: 076604a5f23f287ad4412e17d9c25e8666d67914
+  data.tar.gz: 4cb7f7bb5f62861006664204307a325a4d600771
 SHA512:
-  metadata.gz: 4078c68dc24492572c45a995d9aa4d0dcea9ea5ff518bee4f7640ba886259d97d362523420d73c2cc123697a485bc21c38623a38b1e546119184835fb4dfe7df
-  data.tar.gz: 8482cbc5453a520cacb584a9a3c7521e2084a194771acd126c322e8ea4cb99a4ae423a4ff0b21e525b04e29d90a1cfea12b35905329097f5ffa189356d7ad995
+  metadata.gz: 524acb6c644fb10ac46fafa4d30fffd07f307bb618a4c82eef1b3057b7f58549d9fabeab6cd99e716b1bf2b534361dc408562d81d160a7fe60e517e7a903da8e
+  data.tar.gz: 1153dc00ce890a7006a148f8496b72bd206ee29d2ae7bd152985fbf837fa7e8b4b66e2b0119e0ddf9f069d9a612065826ddf61731773070d28fd3b67f6715461

data/README.md

@@ -143,14 +143,14 @@ response.businesses[0].rating
 ## business
 response = client.business('yelp-san-francisco')
 
-response.name
+response.business.name
 # Yelp
 
-response.categories
+response.business.categories
 # [["Local Flavor", "localflavor"], ["Mass Media", "massmedia"]]
 ```
 
-For specific response values check out the docs for the [search api](http://www.yelp.com/developers/documentation/v2/search_api#rValue) and the [business api](http://www.yelp.com/developers/documentation/v2/business#rValue)
+For specific response values check out the docs for the [Search API](http://www.yelp.com/developers/documentation/v2/search_api#rValue) and the [Business API](http://www.yelp.com/developers/documentation/v2/business#rValue). You can also look at the responses and models inside of `lib/yelp/responses` and `lib/yelp/responses/models` to see the methods available.
 
 ## Contributing
 

data/lib/yelp/client.rb

@@ -1,7 +1,6 @@
 require 'faraday'
 require 'faraday_middleware'
 
-require 'yelp/burst_struct'
 require 'yelp/configuration'
 require 'yelp/error'
 require 'yelp/endpoint/business'
@@ -10,7 +9,7 @@ require 'yelp/endpoint/search'
 
 module Yelp
   class Client
-    API_HOST  = 'http://api.yelp.com'
+    API_HOST  = 'https://api.yelp.com'
     REQUEST_CLASSES = [ Yelp::Endpoint::Search,
                         Yelp::Endpoint::Business,
                         Yelp::Endpoint::PhoneSearch]

data/lib/yelp/endpoint/business.rb

@@ -1,5 +1,7 @@
 require 'json'
 
+require 'yelp/responses/business'
+
 module Yelp
   module Endpoint
     class Business
@@ -19,7 +21,7 @@ module Yelp
       #   business.name # => 'Yelp'
       #   buinesss.url  # => 'http://www.yelp.com/biz/yelp-san-francisco'
       def business(id)
-        BurstStruct::Burst.new(JSON.parse(business_request(id).body))
+        Response::Business.new(JSON.parse(business_request(id).body))
       end
 
       private

data/lib/yelp/endpoint/phone_search.rb

@@ -1,5 +1,7 @@
 require 'json'
 
+require 'yelp/responses/phone_search'
+
 module Yelp
   module Endpoint
     class PhoneSearch
@@ -27,7 +29,8 @@ module Yelp
       def phone_search(phone, options={})
         params = {phone: phone}
         params.merge!(options)
-        BurstStruct::Burst.new(JSON.parse(phone_search_request(params).body))
+
+        Response::PhoneSearch.new(JSON.parse(phone_search_request(params).body))
       end
 
       private

data/lib/yelp/endpoint/search.rb

@@ -1,5 +1,7 @@
 require 'json'
 
+require 'yelp/responses/search'
+
 module Yelp
   module Endpoint
     class Search
@@ -44,7 +46,7 @@ module Yelp
         params.merge!(locale)
         params.merge!({location: location})
 
-        BurstStruct::Burst.new(JSON.parse(search_request(params).body))
+        Response::Search.new(JSON.parse(search_request(params).body))
       end
 
       # Search by a bounding box: specify a south west lat/long and a ne lat/long
@@ -90,7 +92,7 @@ module Yelp
         options.merge!(params)
         options.merge!(locale)
 
-        BurstStruct::Burst.new(JSON.parse(search_request(options).body))
+        Response::Search.new(JSON.parse(search_request(options).body))
       end
 
       # Search by coordinates: give it a latitude and longitude along with
@@ -136,7 +138,7 @@ module Yelp
         options.merge!(params)
         options.merge!(locale)
 
-        BurstStruct::Burst.new(JSON.parse(search_request(options).body))
+        Response::Search.new(JSON.parse(search_request(options).body))
       end
 
       private

data/lib/yelp/responses/base.rb

@@ -0,0 +1,21 @@
+module Yelp
+  module Response
+    class Base
+      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

data/lib/yelp/responses/business.rb

@@ -0,0 +1,14 @@
+require 'yelp/responses/base'
+require 'yelp/responses/models/business'
+
+module Yelp
+  module Response
+    class Business < Base
+      attr_reader :business
+
+      def initialize(json)
+        @business = parse(json, Model::Business)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'yelp/responses/base'
+require 'yelp/responses/models/deal'
+require 'yelp/responses/models/gift_certificate'
+require 'yelp/responses/models/location'
+require 'yelp/responses/models/review'
+
+module Yelp
+  module Response
+    module Model
+      class Business < Response::Base
+        attr_reader :categories, :deals, :display_phone, :distance, :eat24_url, :gift_certificates, :id, :image_url,
+                    :is_claimed, :is_closed, :location, :menu_provider, :menu_date_updated, :mobile_url, :name, :phone,
+                    :rating, :reviews, :reservation_url, :review_count, :snippet_image_url, :snippet_text, :url
+
+        def initialize(json)
+          super(json)
+
+          @deals             = parse(@deals, Deal)
+          @gift_certificates = parse(@gift_certificates, GiftCertificate)
+          @location          = parse(@location, Location)
+          @reviews           = parse(@reviews, Review)
+        end
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/coordinate.rb

@@ -0,0 +1,11 @@
+require 'yelp/responses/base'
+
+module Yelp
+  module Response
+    module Model
+      class Coordinate < Response::Base
+        attr_reader :latitude, :longitude
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/deal.rb

@@ -0,0 +1,20 @@
+require 'yelp/responses/base'
+require 'yelp/responses/models/deal_option'
+
+module Yelp
+  module Response
+    module Model
+      class Deal < Response::Base
+        attr_reader :additional_restrictions, :currency_code, :image_url, :important_restriction, :is_popular,
+                    :id, :options, :time_end, :time_start, :title, :url, :what_you_get
+
+        def initialize(json)
+          super(json)
+
+          @options = parse(@options, DealOption)
+        end
+      end
+    end
+  end
+end
+

data/lib/yelp/responses/models/deal_option.rb

@@ -0,0 +1,12 @@
+require 'yelp/responses/base'
+
+module Yelp
+  module Response
+    module Model
+      class DealOption < Response::Base
+        attr_reader :formatted_original_price, :formatted_price, :is_quantity_limited, :original_price,
+                    :price, :purchase_url, :remaining_count, :title
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/gift_certificate.rb

@@ -0,0 +1,18 @@
+require 'yelp/responses/base'
+require 'yelp/responses/models/gift_certificate_option'
+
+module Yelp
+  module Response
+    module Model
+      class GiftCertificate < Response::Base
+        attr_reader :currency_code, :id, :image_url, :options, :unused_balances, :url
+
+        def initialize(json)
+          super(json)
+
+          @options = parse(@options, GiftCertificateOption)
+        end
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/gift_certificate_option.rb

@@ -0,0 +1,11 @@
+require 'yelp/responses/base'
+
+module Yelp
+  module Response
+    module Model
+      class GiftCertificateOption < Response::Base
+        attr_reader :formatted_price, :price
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'yelp/responses/base'
+require 'yelp/responses/models/coordinate'
+
+module Yelp
+  module Response
+    module Model
+      class Location < Response::Base
+        attr_reader :address, :city, :coordinate, :country_code, :cross_streets, :display_address, :geo_accuracy,
+                    :neighborhoods, :postal_code, :state_code
+
+        def initialize(json)
+          super(json)
+
+          @coordinate = parse(@coordinate, Coordinate)
+        end
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/rating.rb

@@ -0,0 +1,11 @@
+require 'yelp/responses/base'
+
+module Yelp
+  module Response
+    module Model
+      class Rating < Response::Base
+        attr_reader :rating, :img_url
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/region.rb

@@ -0,0 +1,20 @@
+require 'yelp/responses/base'
+require 'yelp/responses/models/region_center'
+require 'yelp/responses/models/region_span'
+
+module Yelp
+  module Response
+    module Model
+      class Region < Response::Base
+        attr_reader :center, :span
+
+        def initialize(json)
+          super(json)
+
+          @center = parse(@center, RegionCenter)
+          @span   = parse(@span, RegionSpan)
+        end
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/region_center.rb

@@ -0,0 +1,11 @@
+require 'yelp/responses/base'
+
+module Yelp
+  module Response
+    module Model
+      class RegionCenter < Response::Base
+        attr_reader :latitude, :longitude
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/region_span.rb

@@ -0,0 +1,11 @@
+require 'yelp/responses/base'
+
+module Yelp
+  module Response
+    module Model
+      class RegionSpan < Response::Base
+        attr_reader :latitude_delta, :longitude_delta
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/review.rb

@@ -0,0 +1,12 @@
+require 'yelp/responses/base'
+require 'yelp/responses/models/rating'
+
+module Yelp
+  module Response
+    module Model
+      class Review < Base
+        attr_reader :excerpt, :id, :rating, :time_created, :user
+      end
+    end
+  end
+end

data/lib/yelp/responses/models/user.rb

@@ -0,0 +1,11 @@
+require 'yelp/responses/base'
+
+module Yelp
+  module Response
+    module Model
+      class User < Response::Base
+        attr_reader :id, :image_url, :name
+      end
+    end
+  end
+end

data/lib/yelp/responses/phone_search.rb

@@ -0,0 +1,18 @@
+require 'yelp/responses/base'
+require 'yelp/responses/models/business'
+require 'yelp/responses/models/region'
+
+module Yelp
+  module Response
+    class PhoneSearch < Base
+      attr_reader :businesses, :region, :total
+
+      def initialize(json)
+        super(json)
+
+        @businesses = parse(@businesses, Model::Business)
+        @region     = parse(@region, Model::Region)
+      end
+    end
+  end
+end

data/lib/yelp/responses/search.rb

@@ -0,0 +1,18 @@
+require 'yelp/responses/base'
+require 'yelp/responses/models/business'
+require 'yelp/responses/models/region'
+
+module Yelp
+  module Response
+    class Search < Base
+      attr_reader :businesses, :region, :total
+
+      def initialize(json)
+        super(json)
+
+        @businesses = parse(@businesses, Model::Business)
+        @region     = parse(@region, Model::Region)
+      end
+    end
+  end
+end

data/lib/yelp/version.rb

@@ -1,3 +1,3 @@
 module Yelp
-  VERSION = "2.0.7"
+  VERSION = "2.1.0"
 end

data/spec/fixtures/vcr_cassettes/business.yml

@@ -2,17 +2,17 @@
 http_interactions:
 - request:
     method: get
-    uri: http://api.yelp.com/v2/business/yelp-san-francisco
+    uri: https://api.yelp.com/v2/business/yelp-san-francisco
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - Faraday v0.8.9
+      - Faraday v0.9.2
       Authorization:
-      - OAuth oauth_consumer_key="<YELP_CONSUMER_KEY>", oauth_nonce="91b6047f08faeace33713a65b42cb034",
-        oauth_signature="yNqoLJVrdE0Ok5SwveA2lA%2BZa4U%3D", oauth_signature_method="HMAC-SHA1",
-        oauth_timestamp="1398701819", oauth_token="<YELP_TOKEN>", oauth_version="1.0"
+      - OAuth oauth_consumer_key="<YELP_CONSUMER_KEY>", oauth_nonce="bf04bd00e56b2a626a911991aac75201",
+        oauth_signature="a48uevnfXQaPvPlZMqCJHAxO3uI%3D", oauth_signature_method="HMAC-SHA1",
+        oauth_timestamp="1445634930", oauth_token="<YELP_TOKEN>", oauth_version="1.0"
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
@@ -22,52 +22,63 @@ http_interactions:
       code: 200
       message: OK
     headers:
-      Date:
-      - Mon, 28 Apr 2014 16:16:40 GMT
       Server:
-      - Apache
+      - nginx
+      Date:
+      - Fri, 23 Oct 2015 21:15:31 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
       X-Node:
-      - web65-r1-sfo1, api_com
+      - 10-64-75-62-uswest1aprod
+      - api_com
       Cache-Control:
-      - private
+      - max-age=0, must-revalidate, no-cache, no-store, private
+      Expires:
+      - Fri, 23 Oct 2015 21:15:30 GMT
+      Pragma:
+      - no-cache
       Set-Cookie:
-      - bse=2a9f068ebb71f02e3c38f8235756f6ea; Domain=.yelp.com; Path=/; HttpOnly
-      Content-Length:
-      - '2217'
+      - bse=a4d16c41d4edd2d4d07d7e74cbc80651; Domain=.yelp.com; Path=/; HttpOnly
+      - yuv=vsukueZSeZE-fIOZGHia4PxFRYNgLhbppBfZiB3gOVcA61zINwm64_hWk6xt5mC6d99F16jmQKaI3F5AbI6Bs9sWyHQF2h31;
+        Domain=.yelp.com; Max-Age=630720000; Path=/; expires=Thu, 18-Oct-2035 21:15:30
+        GMT
       Vary:
-      - User-Agent
-      Content-Type:
-      - application/json; charset=UTF-8
+      - Accept-Encoding,User-Agent
       X-Mode:
-      - rw
+      - ro
       X-Proxied:
-      - lb1
+      - 10-64-0-167-uswest1aprod
     body:
       encoding: UTF-8
       string: '{"is_claimed": true, "rating": 2.5, "mobile_url": "http://m.yelp.com/biz/yelp-san-francisco",
-        "rating_img_url": "http://s3-media4.ak.yelpcdn.com/assets/2/www/img/c7fb9aff59f9/ico/stars/v1/stars_2_half.png",
-        "review_count": 5915, "name": "Yelp", "snippet_image_url": "http://s3-media3.ak.yelpcdn.com/photo/gNcEV7izLO97H4GS4a-UXA/ms.jpg",
-        "rating_img_url_small": "http://s3-media4.ak.yelpcdn.com/assets/2/www/img/8e8633e5f8f0/ico/stars/v1/stars_small_2_half.png",
-        "url": "http://www.yelp.com/biz/yelp-san-francisco", "reviews": [{"rating":
-        1, "excerpt": "YELP has highly questionable business practices...\n\nYELP
-        \"goes public\" to go from swindling small business to swindling the public...\n\nYelp
-        has over 2...", "time_created": 1398531118, "rating_image_url": "http://s3-media1.ak.yelpcdn.com/assets/2/www/img/f64056afac01/ico/stars/v1/stars_1.png",
-        "rating_image_small_url": "http://s3-media1.ak.yelpcdn.com/assets/2/www/img/74cb12ae7253/ico/stars/v1/stars_small_1.png",
-        "user": {"image_url": "http://s3-media2.ak.yelpcdn.com/photo/Lpmg6W5sqQM89qAAqocyLQ/ms.jpg",
-        "id": "5QWzmoRk9yXRw7712sjQTQ", "name": "Kerri G."}, "rating_image_large_url":
-        "http://s3-media3.ak.yelpcdn.com/assets/2/www/img/cc5d90a21966/ico/stars/v1/stars_large_1.png",
-        "id": "iYSiqKNIAeMi8OIJKfc8pg"}], "phone": "4159083801", "snippet_text": "Yelp
-        has dramatically changed the way I do business locally and while traveling
-        for work or pleasure. Before making plans to eat ANYWHERE, I will scout out...",
-        "image_url": "http://s3-media3.ak.yelpcdn.com/bphoto/4LSTYqXkQ-YrI1CQmr2dQA/ms.jpg",
-        "categories": [["Local Flavor", "localflavor"], ["Mass Media", "massmedia"]],
-        "display_phone": "+1-415-908-3801", "rating_img_url_large": "http://s3-media2.ak.yelpcdn.com/assets/2/www/img/d63e3add9901/ico/stars/v1/stars_large_2_half.png",
+        "rating_img_url": "http://s3-media4.fl.yelpcdn.com/assets/2/www/img/c7fb9aff59f9/ico/stars/v1/stars_2_half.png",
+        "review_count": 7534, "name": "Yelp", "rating_img_url_small": "http://s3-media4.fl.yelpcdn.com/assets/2/www/img/8e8633e5f8f0/ico/stars/v1/stars_small_2_half.png",
+        "url": "http://www.yelp.com/biz/yelp-san-francisco", "categories": [["Local
+        Flavor", "localflavor"], ["Mass Media", "massmedia"]], "reviews": [{"rating":
+        5, "excerpt": "My 200th review! For this milestone I have decided to review
+        Yelp. I wrote my first Yelp review back in 2013, I never thought that one
+        review would turn...", "time_created": 1445434241, "rating_image_url": "http://s3-media1.fl.yelpcdn.com/assets/2/www/img/f1def11e4e79/ico/stars/v1/stars_5.png",
+        "rating_image_small_url": "http://s3-media1.fl.yelpcdn.com/assets/2/www/img/c7623205d5cd/ico/stars/v1/stars_small_5.png",
+        "user": {"image_url": "http://s3-media1.fl.yelpcdn.com/photo/RCmPU2uqGkm0A_NEcRJm0g/ms.jpg",
+        "id": "E8RgeQeEF3xD6CcopTNjhA", "name": "Britt Z."}, "rating_image_large_url":
+        "http://s3-media3.fl.yelpcdn.com/assets/2/www/img/22affc4e6c38/ico/stars/v1/stars_large_5.png",
+        "id": "AIL0eKK3vFNsR_n9BaJI5Q"}], "phone": "4159083801", "snippet_text": "My
+        200th review! For this milestone I have decided to review Yelp. I wrote my
+        first Yelp review back in 2013, I never thought that one review would turn...",
+        "image_url": "http://s3-media3.fl.yelpcdn.com/bphoto/nQK-6_vZMt5n88zsAS94ew/ms.jpg",
+        "snippet_image_url": "http://s3-media1.fl.yelpcdn.com/photo/RCmPU2uqGkm0A_NEcRJm0g/ms.jpg",
+        "display_phone": "+1-415-908-3801", "rating_img_url_large": "http://s3-media2.fl.yelpcdn.com/assets/2/www/img/d63e3add9901/ico/stars/v1/stars_large_2_half.png",
         "id": "yelp-san-francisco", "is_closed": false, "location": {"cross_streets":
         "Natoma St \u0026 Minna St", "city": "San Francisco", "display_address": ["140
-        New Montgomery St", "(b/t Natoma St \u0026 Minna St)", "Financial District",
-        "San Francisco, CA 94105"], "neighborhoods": ["Financial District", "SoMa"],
-        "postal_code": "94105", "country_code": "US", "address": ["140 New Montgomery
-        St"], "state_code": "CA"}}'
+        New Montgomery St", "Financial District", "San Francisco, CA 94105"], "geo_accuracy":
+        9.5, "neighborhoods": ["Financial District", "SoMa"], "postal_code": "94105",
+        "country_code": "US", "address": ["140 New Montgomery St"], "coordinate":
+        {"latitude": 37.7867703362929, "longitude": -122.399958372115}, "state_code":
+        "CA"}}'
     http_version: 
-  recorded_at: Mon, 28 Apr 2014 16:17:05 GMT
-recorded_with: VCR 2.8.0
+  recorded_at: Fri, 23 Oct 2015 21:15:31 GMT
+recorded_with: VCR 2.9.3