refreshingmenus_api 0.0.2 → 0.0.3

data/README.md

@@ -24,6 +24,36 @@ Or install it yourself as:
     result.first[:id] # => "194ebdcc-fcd9-11e1-b4ac-5254006b3bb5"
     result.first[:menus].first[:title] # => "Pizzeria Kaart" 
 
+A query to match businesses / venues / places based on a phone number:
+
+    result = api.places(
+        :phone => '+31-(0)-10-2065151',
+        :country_code => 'NL'
+      )
+    result.first[:normalized_phone] # => "31102065151"
+    result.first[:id] # => "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'.
+
+Because sometimes multiple places have the same phone number we can do more specific matching:
+
+    result = api.places(
+        :q => "#{place.name} #{place.postal_code}", # Matches at least one word.
+        :country_code => place.country_code, # Eg. 'NL'
+        :lat => place.lat,
+        :lng => place.lng,
+        :distance => '0.2', # 200 meter
+        :phone => place.phone_number # Eg. '010-12341234'. 
+      )
+
+## Widget usage
+
+    RefreshingmenusApi::Widget.tag(:place_id => 'some_place_id', :widget_token => 'some_token')
+
+This will result in a script tag like:
+
+    <script id='rm-menuwidget' src='http://www.refreshingmenus.com/api/v1/widget.js?dom_id=rm-menuwidget&place_id=some_place_id&widget_token=some_token'></script>"
+
 ## Contributing
 
 1. Fork it

data/lib/refreshingmenus_api.rb

@@ -1,4 +1,5 @@
 require 'refreshingmenus_api/version'
+require 'refreshingmenus_api/widget'
 
 require 'httparty'
 require 'active_support/core_ext'
@@ -28,6 +29,9 @@ module RefreshingmenusApi
 
     attr_reader :auth_token, :version, :format
 
+    # Options:
+    # * :auth_token - Your RefreshingMenus Authentication token (API)
+    # * :version - Version (defaults to 1)
     def initialize(options = {})
       @auth_token = options[:auth_token]
       @version = options[:version] || '1'

data/lib/refreshingmenus_api/version.rb

@@ -1,3 +1,3 @@
 module RefreshingmenusApi
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/refreshingmenus_api/widget.rb

@@ -0,0 +1,21 @@
+module RefreshingmenusApi
+  class Widget
+
+    # Options:
+    # * widget_token (required) - Your RefreshingMenus Widget token
+    # * place_id (required) - The RefreshingMenus Place ID (UUID)
+    # * secure - Boolean, we'll use https if true
+    # * style - The style name we should use (default: 'default'), use 'none' for no styling (if you embed your own styling)
+    def self.tag(options)
+      raise ArgumentError, "Expected options argument to be a Hash, got #{options.inspect}." if not options.is_a?(Hash)
+      options[:dom_id] = 'rm-menuwidget'
+      raise ArgumentError, "Expected a :place_id as option but got #{options[:place_id].inspect}." if not options[:place_id].is_a?(String)
+      raise ArgumentError, "Expected a :widget_token as option but got #{options[:widget_token].inspect}." if not options[:widget_token].is_a?(String)
+      secure = options.delete(:secure)
+      version = options.delete(:version) || '1'
+      src = "#{secure ? 'https' : 'http'}://www.refreshingmenus.com/api/v#{version}/widget.js?#{options.to_param}"
+      return "<script id='#{options[:dom_id]}' src='#{src}'></script>"
+    end
+
+  end
+end

metadata

@@ -1,55 +1,56 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: refreshingmenus_api
-version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
-authors:
+authors: 
 - Joost Hietbrink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-09-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  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:
+email: 
 - joost@joopp.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - LICENSE
@@ -57,30 +58,37 @@ files:
 - Rakefile
 - lib/refreshingmenus_api.rb
 - lib/refreshingmenus_api/version.rb
+- lib/refreshingmenus_api/widget.rb
 - refreshingmenus_api.gemspec
+has_rdoc: true
 homepage: http://www.refreshingmenus.com
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby API to use the Refreshing Menus REST API.
 test_files: []
-has_rdoc: 
+