zomato 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.redcar
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+gem 'httparty'
+gem 'fakeweb'
+gem 'rspec'
+
+

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+== extended_attributes
+
+Copyright (c) 2011 Chirantan Rajhans.
+
+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.

data/README.md

@@ -0,0 +1,59 @@
+# Zomato
+_Ruby gem that wraps [Zomato API](http://www.zomato.com/api/documentation)_
+
+In your Gemfile
+
+```ruby 
+gem 'zomato'
+```
+
+```bash 
+$ bundle install
+```
+
+and...
+
+```ruby 
+require 'rubygems'
+require 'zomato'
+
+zomato = Zomato::Base.new('your_key_here')
+delhi = zomato.cities.first 
+#<Zomato::City:0x8ffe080 @id=1, @name="Delhi NCR", @longitude="77.210276", @latitude="28.625789", @has_nightlife=true, @show_zones=true>
+noida = delhi.zones.first
+#<Zomato::Zone:0x9b6d8bc @id=1, @name="Noida", @city_id=1>
+alaknanda = delhi.localities.first 
+#<Zomato::Subzone:0x8c67020 @id=316, @name="Alaknanda", @zone_id=3, @city_id=1>
+american = delhi.cuisines.first
+#<Zomato::Cuisine:0x94c0c58 @id=1, @name="American", @city_id=1>
+restaurants = american.restaurants
+restaurants.results_found # 100
+restaurants.results_start # 0
+restaurants.results_shown # 10
+underdogs =  restaurants.restaurants.first # or
+underdogs =  restaurants.first
+#<Zomato::Restaurant:0x8e90694 @id=3384, @name="Underdoggs Sports Bar & Grill", @address="F 38, Level 1, Ambience Mall, Vasant Kunj, New Delhi", @locality="Vasant Kunj", @city="Delhi", @cuisines="American, Mediterranean, Italian", @rating_editor_overall=3.5, @cost_for_two=1500, @has_discount=false, @has_citibank_discount=false>
+
+noida.restaurants
+alaknanda.restaurants 
+# Like for cuisines, fetches restaurants in "Noida" zone and "Alaknanda" subzone respectively
+
+underdogs.details
+underdogs.reviews
+# Returns details and reviews as a hash, check zomato documentation for details as the response is returned as is.
+ 
+underdogs.report_error("This is a test, please ignore.", "Chirantan Rajhans") # true or false based on success or failure.
+
+searched_underdogs = Zomato::Restaurant.search(delhi.id, 'underdog').restaurants.first
+# Check zomato documentation for more search options (to be passed as a hash to Zomato::Restaurant.search
+searched_underdogs.id == underdogs.id # true
+
+Zomato::Restaurant.near('28.557706', '77.205879')
+# Finds a random restaurant near given geocodes.
+```
+
+### Note
+
+* Some methods accept optional parameters (e.g. searches). Pass them as a hash. Refer zomato's documentation to know their names and datatypes.
+* Also, this gem could use some more specs.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :development
+
+desc 'Default: run specs'
+task :default => :spec  
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+Bundler::GemHelper.install_tasks

data/lib/zomato.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/zomato/api.rb')
+require File.expand_path(File.dirname(__FILE__) + '/zomato/city.rb')
+require File.expand_path(File.dirname(__FILE__) + '/zomato/locality.rb')
+require File.expand_path(File.dirname(__FILE__) + '/zomato/zone.rb')
+require File.expand_path(File.dirname(__FILE__) + '/zomato/subzone.rb')
+require File.expand_path(File.dirname(__FILE__) + '/zomato/restaurant.rb')
+require File.expand_path(File.dirname(__FILE__) + '/zomato/cuisine.rb')
+require File.expand_path(File.dirname(__FILE__) + '/zomato/base.rb')

data/lib/zomato/api.rb

@@ -0,0 +1,14 @@
+require 'httparty'
+
+module Zomato
+
+  class Api
+    
+    include HTTParty
+    format :json
+    base_uri 'https://api.zomato.com/v1/'
+    default_params :format => 'json'
+    
+  end
+  
+end

data/lib/zomato/base.rb

@@ -0,0 +1,20 @@
+
+module Zomato
+  class Base
+    
+    def initialize(key)
+      @key = key
+      Api.headers 'X-Zomato-API-Key' => key
+    end
+    
+    def cities
+      @cities ||= City.build(Api.get('/cities').parsed_response)
+    end
+    
+    def locality(lat, lon)
+      response = Api.get('/geocodes', :query => {:lat => lat, :lon => lon}).parsed_response
+      Locality.new(response['locality'])
+    end
+    
+  end
+end

data/lib/zomato/city.rb

@@ -0,0 +1,51 @@
+module Zomato
+  class City
+    
+    attr_reader :id, :name, :longitude, :latitude, :has_nightlife, :show_zones
+    
+    class << self
+      
+      def build(response)
+        @cities ||=
+        response['cities'].collect do |city|
+          City.new(city['city'])
+        end
+      end
+      
+    end
+    
+    def initialize(attributes)
+      @id = attributes['id']
+      @name = attributes['name']
+      @longitude = attributes['longitude']
+      @latitude = attributes['latitude']
+      @has_nightlife = attributes['has_nightlife'] == 1
+      @show_zones = attributes['show_zones'] == 1
+    end
+    
+    def zones
+      response = Api.get(
+        '/zones', 
+        :query => {:city_id => id}
+      ).parsed_response
+      Zone.build(response)
+    end
+    
+    def localities
+      response = Api.get(
+        '/subzones', 
+        :query => {:city_id => id}
+      ).parsed_response
+      Subzone.build(response, id)
+    end
+    
+    def cuisines
+      response = Api.get(
+        '/cuisines', 
+        :query => {:city_id => id}
+      ).parsed_response
+      Cuisine.build(response, id)
+    end
+    
+  end
+end

data/lib/zomato/cuisine.rb

@@ -0,0 +1,30 @@
+module Zomato
+  class Cuisine
+    
+    attr_reader :id, :name, :city_id
+    
+    class << self
+      def build(response, city_id)
+        response["cuisines"].collect do |cuisine|
+          Cuisine.new(cuisine['cuisine'].merge({'city_id' => city_id}))
+        end
+      end
+    end
+    
+    def initialize(attributes)
+      @id = attributes['cuisine_id'].to_i
+      @name = attributes['cuisine_name']
+      @city_id = attributes['city_id'].to_i
+    end
+    
+    def restaurants(query = {})
+      query = {
+        :city_id    => city_id,
+        :cuisine_id => id
+      }.merge(query)
+      response = Api.get('/search', :query => query).parsed_response
+      Restaurant.build(response, query)
+    end
+    
+  end
+end

data/lib/zomato/locality.rb

@@ -0,0 +1,14 @@
+module Zomato
+  class Locality
+    
+    attr_reader :name, :city_name, :city_id
+    
+    def initialize(attributes)
+      @name = attributes['name']
+      @city_name = attributes['city_name']
+      @city_id = attributes['city_id']
+      
+    end
+    
+  end
+end

data/lib/zomato/restaurant.rb

@@ -0,0 +1,151 @@
+module Zomato
+  class Restaurant
+    
+    class Collection
+      attr_reader :results_found, :results_start, :results_shown, :restaurants
+      
+      def initialize(response, query)
+        load(response, query)
+      end
+      
+      def total_pages
+        (results_found.to_i / results_shown.to_f).ceil
+      end
+      
+      def next_page!
+        return self unless has_next_page?
+        @results_start = next_page_result_start 
+        @query.merge({:start => results_start, :count => results_shown})
+        response = Api.get('/search', :query => @query).parsed_response
+        load(response, @query)
+      end
+      
+      def previous_page!
+        return self unless has_previous_page?
+        @results_start = previous_page_result_start
+        @query.merge({:start => results_start, :count => results_shown})
+        response = Api.get('/search', :query => query).parsed_response
+        load(response, @query)
+      end
+      
+      def has_next_page?
+        next_page_result_start <= results_found.to_i
+      end
+      
+      def has_previous_page?
+        previous_page_result_start >= 0
+      end
+      
+      def attributes
+        {
+          :results_found => @results_found,
+          :results_start => @results_start,
+          :results_shown => @results_shown,
+          :resturants    => @restaurants,
+          :query         => @query
+        }
+      end
+      
+      def first; restaurants.first end
+      def last;  restaurants.last  end
+      
+      private
+      
+      def previous_page_result_start
+        results_start.to_i - results_shown.to_i - 1
+      end
+      
+      def next_page_result_start
+        results_start.to_i + results_shown.to_i + 1
+      end
+      
+      def load(response, query)
+        @query = query || {}
+        @results_found = response['resultsFound']
+        @results_start = response['resultsStart']
+        @results_shown = response['resultsShown']
+        @restaurants   = response['results'].collect do |restaurant|
+          Restaurant.new(restaurant['result'])
+        end
+      end
+      
+    end
+    
+    attr_reader :id, :name, :address, :locality, :city, :cuisines, :rating_editor_overall, :cost_for_two, :has_discount, :has_citibank_discount
+    
+    def initialize(attributes)
+      @id                    = attributes['id'].to_i
+      @name                  = attributes['name']
+      @address               = attributes['address']
+      @locality              = attributes['locality']
+      @city                  = attributes['city']
+      @cuisines              = attributes['cuisines']
+      @rating_editor_overall = attributes['rating_editor_overall']
+      @cost_for_two          = attributes['cost_for_two']
+      @has_discount          = attributes['has_discount'] == 1
+      @has_citibank_discount = attributes['has_citibank_discount'] == 1
+      @details               = attributes['details'] if attributes['details']
+    end
+    
+    def details
+      @details ||= Api.get("/restaurant/#{id}").parsed_response
+    end
+    
+    def reviews(query = {})
+      query = {
+        :start => 1,
+        :count => 10
+      }.merge(query)
+      Api.get("/reviews/#{id}/user", :query => query).parsed_response
+    end
+    
+    def report_error(data, name = nil)
+      query = {:res_id => id, :data => data}
+      query.store(:name, name) if name
+      Api.post('/contact', :query => query).parsed_response['status'] == 1
+    end
+    
+    class << self
+      def build(response, query)
+        Collection.new(response, query)
+      end
+      
+      def create_by_details(details)
+        attributes = {
+          'details'               => details,
+          'name'                  => details['name'],
+          'id'                    => details['id'],
+          'address'               => details['location']['address'],
+          'locality'              => details['location']['locality'],
+          'city'                  => details['location']['city'],
+          'cuisines'              => details['cuisines'],
+          'rating_editor_overall' => details['editorRating']['overall'],
+          'cost_for_two'          => details['avgCostForTwo']
+        }
+        Restaurant.new(attributes)
+      end
+      
+      def search(city_id, search_term, query = {})
+        query = {
+          :city_id  => city_id,
+          :q        => search_term
+        }.merge(query)
+        response = Api.get("/search", :query => query).parsed_response
+        Restaurant.build(response, query)
+      end
+      
+      def near(lat, lon, query = {})
+        query = {
+          :lat        => lat,
+          :lon        => lon,
+          :random     => true
+        }.merge(query)
+        create_by_details(Api.get("/search/near", :query => query).parsed_response)
+      end
+      
+    end
+    
+  end
+end
+
+

data/lib/zomato/subzone.rb

@@ -0,0 +1,32 @@
+module Zomato
+  class Subzone
+    
+    attr_reader :id, :name, :zone_id, :city_id
+    
+    class << self
+      
+      def build(response, city_id)
+        @subzones ||=
+        response['subzones'].collect do |subzone|
+          Subzone.new(subzone['subzone'], city_id)
+        end
+      end
+      
+    end
+    
+    def initialize(attributes, city_id)
+      @id = attributes['subzone_id']
+      @name = attributes['name']
+      @zone_id = attributes['zone_id'].to_i
+      @city_id = city_id.to_i
+    end
+    
+    def restaurants
+      query = {:city_id => city_id, :subzone_id => id}
+      response = Api.get('/search', :query => query).parsed_response
+      Restaurant.build(response, query)
+    end
+    
+  end
+
+end

data/lib/zomato/zone.rb

@@ -0,0 +1,30 @@
+module Zomato
+  class Zone
+    
+    attr_reader :id, :name, :city_id
+    
+    def self.build(response)
+      response['zones'].collect do |zone|
+        Zone.new(zone['zone'])
+      end
+    end
+    
+    def initialize(attributes)
+      @id = attributes['zone_id']
+      @name = attributes['name']
+      @city_id = attributes['city_id'].to_i
+    end
+    
+    def subzones
+      response = Api.get('/subzones', :query => {:zone_id => id}).parsed_response
+      Subzone.build(response, city_id)
+    end
+    
+    def restaurants
+      query = {:city_id => city_id, :zone_id => id}
+      response = Api.get('/search', :query => query).parsed_response
+      Restaurant.build(response, query)
+    end
+    
+  end
+end