refreshingmenus_api 0.0.4 → 0.0.5

data/README.md

@@ -19,10 +19,14 @@ Or install it yourself as:
 ## Usage
 
     api = RefreshingmenusApi::Client.new(:auth_token => 'your_auth_token_here')
-    result = api.places(:q => "o'pazzo") # Returns Array or results
-    result.first[:name] # => "O'Pazzo Pizzeria"
-    result.first[:id] # => "194ebdcc-fcd9-11e1-b4ac-5254006b3bb5"
-    result.first[:menus].first[:title] # => "Pizzeria Kaart" 
+
+### Places
+
+    result = api.places(:q => "o'pazzo") # Returns Array of RefreshingmenusApi::Place objects
+    result.first.name # => "O'Pazzo Pizzeria"
+    result.first.guid # => "194ebdcc-fcd9-11e1-b4ac-5254006b3bb5"
+    result.first.menus_count # => 2
+    result.first.menus.first.title # => "Pizzeria Kaart" 
 
 A query to match businesses / venues / places based on a phone number:
 
@@ -30,8 +34,8 @@ A query to match businesses / venues / places based on a phone number:
         :phone => '+31-(0)-10-2065151',
         :country_code => 'NL'
       )
-    result.first[:normalized_phone] # => "31102065151"
-    result.first[:id] # => "194e9016-fcd9-11e1-b4ac-5254006b3bb5"
+    result.first.normalized_phone # => "31102065151"
+    result.first.guid # => "194e9016-fcd9-11e1-b4ac-5254006b3bb5"
 
 This phone number is normalized based on the country_code passed. So '010-2065151' and '+31-(0)-10-2065151' with country_code 'NL' will be normalized to '31102065151'.
 
@@ -46,6 +50,17 @@ Because sometimes multiple places have the same phone number we can do more spec
         :phone => place.phone_number # Eg. '010-12341234'. 
       )
 
+### Menus
+
+    result = api.places(:q => "o'pazzo")
+    result.first.menus.first # => RefreshingmenusApi::Menu 
+    menu1 = result.first.menus.first.fetch!(api) # Pass api client to fetch all Menu info
+    menu1.title # => "Pizzeria Kaart"
+    menu1.entries.first.title # => "ANTIPASTI"
+
+A Menu is a tree of Entries. An Entry is either a Section (eg. 'Starters') or an Item (eg. 'Hamburger').
+Both Sections and Items can have multiple Prices.
+
 ## Widget usage
 
     RefreshingmenusApi::Widget.script_tag(:place_id => 'some_place_id', :widget_token => 'some_token')

data/lib/refreshingmenus_api.rb

@@ -1,9 +1,7 @@
 require 'refreshingmenus_api/version'
 require 'refreshingmenus_api/widget'
 
-require 'httparty'
-require 'active_support/core_ext'
-require 'active_support/core_ext/hash'
+require 'api_smith'
 
 module RefreshingmenusApi
 
@@ -14,6 +12,64 @@ module RefreshingmenusApi
   class UnprocessableEntityError < ApiError;
   end
 
+  class Menu < APISmith::Smash
+  
+    class Entry < APISmith::Smash
+
+      class Price < APISmith::Smash
+        property :position
+        property :title
+        property :price
+        property :unit
+        property :currency
+      end
+
+      property :type
+      property :position
+      property :title
+      property :desc
+
+      # Item specific
+      property :restrictions
+      property :spiciness
+
+      # Price info
+      property :prices, :transformer => Entry::Price
+
+      # Sub-Entries
+      property :entries, :transformer => Entry
+    end
+
+    property :guid, :from => :id
+    property :title
+    property :desc
+    property :position
+    property :entries, :transformer => Menu::Entry
+
+    # FIXME: What is the proper way to do this?
+    def fetch!(client)
+      client.menu(self.guid)
+    end
+
+  end
+
+  class Place < APISmith::Smash
+    property :guid, :from => :id
+    property :name
+    property :street
+    property :zip
+    property :country_code
+    property :lat
+    property :lng
+    property :normalized_phone
+    property :menus_count
+    property :menus, :transformer => Menu
+  end
+
+  # class PlaceCollection < APISmith::Smash
+  #   property :dates, :transformer => lambda { |c| c.map { |v| TallyStat.call(v['items']) }.flatten }
+  # end
+
   # Usage:
   # api = RefreshingmenusApi::Client.new(:auth_token => 'your_auth_token_here')
   # api.places(:q => 'some query')
@@ -25,47 +81,51 @@ module RefreshingmenusApi
     }
     ERRORS.default = ApiError
 
-    include HTTParty
+    include APISmith::Client
 
-    attr_reader :auth_token, :version, :format
+    attr_reader :auth_token, :version, :locale
 
     # Options:
     # * :auth_token - Your RefreshingMenus Authentication token (API)
     # * :version - Version (defaults to 1)
+    # * :locale - The language (defaults to 'nl')
     def initialize(options = {})
       @auth_token = options[:auth_token]
       @version = options[:version] || '1'
+      @locale = options[:locale] || 'nl'
+
       self.class.base_uri(options[:base_uri] || 'www.refreshingmenus.com')
+      self.class.endpoint("api/v#{version}")
+
+      add_query_options!(:auth_token => auth_token)
+      add_query_options!(:locale => locale)
     end
 
     def places(options)
-      get('places.json', :query => options)
+      raise ArgumentError, "Expected options to be a Hash, got #{options.inspect}." if not options.is_a?(Hash)
+      get('places.json', :extra_query => options, :transform => Place)
     end
 
-    def get(*args)
-      request :get, *args
+    def menu(guid)
+      raise ArgumentError, "Expected guid to be a String, got #(guid.inspect}." if not guid.is_a?(String)
+      get("menus/#{guid}.json", :transform => Menu)
     end
 
   private
-
-    def request(method, path, options = {})
-      options[:query] ||= {}
-      options[:query][:auth_token] ||= auth_token
-      path = File.join("/api/v#{version}", path)
-      response = self.class.send(method, path, options)
-
+   
+    def check_response_errors(response)
       # In 2XX range is success otherwise it's probably error (3XX redirects range is handled by HTTParty).
       # In case of error we lookup error class or default to ApiError.
-      case response.code
-      when 200..299
-        result = response.parsed_response
-        result = result.collect {|r| r.is_a?(Hash) ? r.with_indifferent_access : r} if result.is_a?(Array)
-        return result
-      else
-        raise ERRORS[response.code], "Got HTTP code #{response.code} (#{response.message}) from API.\nPath: #{path} #{options.inspect}\nAuthToken: #{auth_token}"
+      if not (200..299).include?(response.code)
+        raise ERRORS[response.code], "Got HTTP code #{response.code} (#{response.message}) from API."
       end
-    end
 
-  end
+      # # TODO: Check JSON for error
+      # if response.first.is_a?(Hash) and (error = response.first['error'])
+      #   raise Error.new(error)
+      # end
+    end
+   
+  end # Client
 
 end

data/lib/refreshingmenus_api/version.rb

@@ -1,3 +1,3 @@
 module RefreshingmenusApi
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/refreshingmenus_api.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = RefreshingmenusApi::VERSION
 
-  gem.add_dependency('httparty')
-  gem.add_dependency('activesupport')
+  # gem.add_dependency('httparty')
+  # gem.add_dependency('activesupport')
+  gem.add_dependency('api_smith')
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Joost Hietbrink
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-17 00:00:00 +02:00
+date: 2012-09-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: httparty
+  name: api_smith
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
@@ -29,18 +29,6 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
 description: Ruby API to use the Refreshing Menus REST API.
 email: 
 - joost@joopp.com