rlocu 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rlocu.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stephen Philp
+
+MIT License
+
+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,60 @@
+# Rlocu
+
+A simple, unoffical, and currently incomplete wrapper for the Locu API (locu.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rlocu'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rlocu
+
+## Getting Started
+
+When you require Rlocu it runs config! on itself to set api_key and http_base.  It reads these values from a YAML .config file in .lib/ exa:
+
+API_KEY: 'yourapikeyyourapikeyyourapikey'
+HTTP_BASE: 'https://api.locu.com/v1_0/'
+
+## Usage
+
+Right now the only functionality covered is Venue Search to search for venues, and Venue Details which gets you menus, etc.
+Everything is under the Rlocu namespace. 
+
+Venue Search
+Pass a hash of params to Rlocu::VenueSearch.query()
+Returns an array of venues (Rlocu::Venue)
+Or you can pass it a block to iterate through the venues:
+
+    Rlocu::VenueSearch.query(postal_code: '90278', cuisine: 'Thai') do |v|
+      puts v.name
+    end
+
+Venue Details
+You can pass an array of up to 5 venues to Rlocu::VenueDetails()
+Returns an array of Rlocu::Venues with the detail data (th venue search and detail search have overlapping attributes).
+
+Or you can pass it a block to iterate through the venues:
+    Rlocu::VenueDetails.query(array_of_venues) do |v|
+      puts v.twitter_id
+    end
+
+Object Space
+The object space essentially follows the Locu API with two little utility objects:
+RLocu::Location
+Rlocu::Bounds
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+task default: [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  #t.verbose = true
+end
+

data/lib/rlocu.rb

@@ -0,0 +1,8 @@
+#require "rlocu/version"
+require_relative 'rlocu/config'
+require_relative 'rlocu/venue'
+require_relative 'rlocu/menu'
+require_relative 'rlocu/venue_search'
+require_relative 'rlocu/venue_details'
+require_relative 'utilities'
+

data/lib/rlocu/config.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+module Rlocu
+  
+  class << self
+
+    def config!(file=File.expand_path("../../../.config", __FILE__))
+      configs = YAML::load(File.open(file))
+      @api_key = configs['API_KEY']  
+      @http_base = configs['HTTP_BASE']  
+    end
+
+    def api_key
+      @api_key
+    end
+
+    def http_base
+      @http_base
+    end
+
+  end
+
+  config!
+end

data/lib/rlocu/menu.rb

@@ -0,0 +1,130 @@
+module Rlocu
+  class Menu
+    attr_accessor :name
+    attr_reader :sections
+
+    def initialize(meta_menu)
+      @name = meta_menu['menu_name']
+      self.sections = meta_menu['sections']
+    end
+
+    def sections=(meta_sections)
+      @sections = []
+      meta_sections.each {|h| @sections << Section.new(h)}
+    end
+
+  end
+
+  class Section
+    attr_accessor :name
+    attr_reader :subsections
+
+    def initialize(meta_section)
+      @name = meta_section['section_name']
+      self.subsections = meta_section['subsections']
+    end
+
+    def subsections=(meta_subsections)
+      @subsections = []
+      meta_subsections.each {|h| @subsections << Subsection.new(h)}
+    end
+
+  end
+
+  class Subsection
+    attr_accessor :name
+    attr_reader :contents
+
+    def initialize(meta_subsection)
+      @name = meta_subsection['subsection_name']
+      self.contents = meta_subsection['contents']
+    end
+
+    def contents=(meta_contents)
+      @contents = []
+      meta_contents.each do |h|
+        #TODO: raise error if type is different
+        @contents << case h['type']
+          when 'SECTION_TEXT'
+            SectionText.new(h)
+          when 'ITEM'
+            MenuItem.new(h)
+        end  
+      end
+    end
+
+  end
+
+  class SectionText
+    attr_accessor :type, :text
+
+    def initialize(meta_section_text)
+      @type = meta_section_text['type']
+      @text = meta_section_text['text']
+    end
+
+    def to_s
+      @text
+    end
+  
+  end
+
+# create a to_s for each that can be over-ridden by the user
+  class MenuItem
+    attr_accessor :type, :name, :description, :price
+    attr_reader :option_groups
+
+    def initialize(meta_menu_item)
+      @type = meta_menu_item['type']
+      @name = meta_menu_item['name']
+      @description = meta_menu_item['description']
+      @price = meta_menu_item['price']
+      self.option_groups = meta_menu_item['option_groups'] 
+    end
+
+    def option_groups=(meta_option_groups)
+      @option_groups = []
+      meta_option_groups.each { |h| @option_groups << OptionGroup.new(h) } if meta_option_groups
+    end
+
+  end
+
+  class OptionGroup
+    attr_accessor :type, :text
+    attr_reader :options
+
+    def initialize(meta_option_group)
+      @type = meta_option_group['type']
+      @text = meta_option_group['text']
+      self.options = meta_option_group['options'] 
+    end
+
+    def options=(meta_options)
+      @options = []
+      meta_options.each {|h| @options << Option.new(h) } if meta_options
+    end
+
+
+  end
+
+  class Option
+    attr_accessor :name
+    attr_writer :price
+
+    def initialize(meta_option)
+      @name = meta_option['name']
+      @price = meta_option['price']
+    end
+
+    def price
+      # price can be relative indicated by a + in the price
+      # not currently doing anything w it 
+      @price
+    end
+
+    def to_s
+      "#{name} #{price}"
+    end
+
+  end
+end

data/lib/rlocu/venue.rb

@@ -0,0 +1,34 @@
+module Rlocu
+  class Venue
+    PROPERTIES = [:name, :locality, :street_address, 
+      :cuisines, :region, :long, :phone, :postal_code, 
+      :categories, :has_menu, :country, :lat, :id, 
+      :website_url, :resource_uri]
+    # the Venue class encapsulates the venue_details also
+    # keeping them separate for maintainability when they eventually change
+    VENUE_DETAILS = [:open_hours, :facebook_url, :twitter_id,
+      :similar_venues, :redirected_from]
+    attr_reader :menus
+    (PROPERTIES | VENUE_DETAILS).each {|prop| attr_accessor prop}
+
+    def initialize(meta_venue)
+      @menus = []
+      update(meta_venue)
+    end
+    
+    def update(meta_venue)
+      meta_venue.each {|k,v| self.send("#{k.to_s}=",v) }
+    end
+
+    # override some of the writers
+    def menus=(meta_menus)
+      # menus is an array of menu hashes
+      # don't keep adding and duplicating if there are already menus
+      @menus = []        
+      meta_menus.each do |h|
+        @menus << Menu.new(h)
+      end
+    end
+
+  end
+end

data/lib/rlocu/venue_details.rb

@@ -0,0 +1,35 @@
+require 'open-uri'
+require 'JSON'
+
+module Rlocu
+  module VenueDetails
+
+    def self.query(venues, &block)  
+      response = {}
+      open(url(venues)) { |request| response = JSON.parse(request.read) }
+      # should we update the venues passed in or should we create new venue
+      # objects with the updated info? lets create new ones 
+
+      venues_w_details = []
+      response['objects'].each do |object|
+        venues_w_details << Venue.new(object)
+      end
+      venues_w_details.each { |venue| yield venue } if block_given?
+      return venues_w_details
+    end 
+
+    private
+
+    def self.url(venues)
+      ids = reduce_ids(venues)
+      "#{Rlocu.http_base}venue/#{ids}/?#{Rlocu.encode}"
+    end
+
+    def self.reduce_ids(venues)
+      raise ArgumentError.new "Only 5 venues can be queried at a time for venue details" if venues.count > 5
+      ids = venues.reduce('') {|memo, venue| memo << "#{venue.id};"}
+      ids.chop
+    end
+
+  end
+end

data/lib/rlocu/venue_search.rb

@@ -0,0 +1,27 @@
+require 'open-uri'
+require 'JSON'
+
+module Rlocu
+  module VenueSearch
+    PARAMETERS = [:name, :has_menu, :category, :cuisine, :website_url, :open_at, :street_address, 
+                  :locality, :region, :postal_code, :country, :location, :radius, :bounds]
+    
+    def self.query(params, &block)    
+      unsupported = params.keys.reduce([]) {|memo,p| memo << p unless PARAMETERS.include? p; memo }
+      raise ArgumentError.new "Unsupported parameter to Rlocu::VenuSearch (#{unsupported})" unless unsupported.empty?
+      response = {}
+      open(url(params)) {|request| response = JSON.parse(request.read)}
+      venues = []
+      venues = response['objects'].reduce(venues) {|arr, o| arr << Rlocu::Venue.new(o) ; arr }
+      venues.each { |venue| yield venue } if block_given?
+      return venues
+    end
+
+    private
+
+    def self.url(params)
+      "#{Rlocu.http_base}venue/search/?#{Rlocu.encode(params)}"
+    end
+    
+  end
+end

data/lib/rlocu/version.rb

@@ -0,0 +1,3 @@
+module Rlocu
+  VERSION = "0.1.0"
+end

data/lib/utilities.rb

@@ -0,0 +1,40 @@
+require 'open-uri'
+
+module Rlocu
+
+  def self.encode(params={})
+    s = params.reduce("api_key=#{Rlocu.api_key}&") {|memo,(key,val)| memo << "#{key.to_s}=#{val}&"}
+    URI::encode(s.chop)
+  end
+
+  class Location
+    attr_accessor :lat, :long
+
+    def initialize(lat, long)
+      if !lat.is_a?(Numeric) || !long.is_a?(Numeric)
+        raise ArgumentError.new "Lat and long must be numeric (floats)" 
+      end
+      @lat = lat
+      @long = long
+    end
+
+    def to_s
+      "#{lat},#{long}"
+    end
+
+  end
+
+  class Bounds
+
+    def initialize(loc1, loc2)
+      @loc1 = loc1
+      @loc2 = loc2
+    end
+
+    def to_s
+      "#{@loc1.to_s}|#{@loc2.to_s}"
+    end
+    
+  end
+
+end

data/rlocu.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rlocu/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rlocu"
+  gem.version       = Rlocu::VERSION
+  gem.authors       = ["Stephen Philp"]
+  gem.email         = ["stephen@stephenphilp.com"]
+  gem.description   = %q{A simple ruby wrapper for the Locu API}
+  gem.summary       = %q{Rlocu is a ruby wrapper for Locu's API. The Locu API gives you access to real-time local business data, from opening hours to price lists, such as restaurant menus.}
+  gem.homepage      = "https://github.com/swelltrain/rlocu"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/test/test_truth.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class TruthTest < Test::Unit::TestCase
+  def test_reality
+    assert true, "aye, it is true"
+  end
+end

data/test/test_utilities.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+require_relative '../lib/rlocu'
+
+class UtilitiesTest < Test::Unit::TestCase
+  include Rlocu
+  def test_location_raises
+    assert_raise ArgumentError do Location.new('some','silliness') end
+  end
+
+  def test_location_to_s
+    l = Location.new(123.4,678)
+    assert_equal '123.4,678', l.to_s
+  end
+
+  def test_encode
+    #params = {name: 'bamboo thai', postal_code: '90278'}
+    skip "insert your api into .config"
+    #assert_equal 'api_key=YOUR_API_HERE&name=bamboo%20thai&postal_code=90278', Rlocu.encode(params)
+  end
+
+end

data/test/test_venue.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+require_relative '../lib/rlocu'
+require 'JSON'
+
+class VenueTest < Test::Unit::TestCase
+  include Rlocu
+  def test_menu_setter
+    params = {name: 'bamboo thai', postal_code: '90278'}
+    venues = Rlocu::VenueSearch.query(params)
+  
+    deets = Rlocu::VenueDetails.query(venues)
+    
+
+  end
+end

data/test/test_venue_details.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+require_relative '../lib/rlocu'
+
+class VenueDetailsTest < Test::Unit::TestCase
+  include Rlocu
+  def test_reduce_ids
+    venues = Set.new
+    5.times {|n| venues << Venue.new(id: n)}
+    assert_equal '0;1;2;3;4', Rlocu::VenueDetails.send(:reduce_ids, venues)
+  end
+end

data/test/test_venue_search.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+require_relative '../lib/rlocu'
+                        
+class VenueSearchTest < Test::Unit::TestCase
+  include Rlocu
+  def test_bad_arg_throws_error
+    assert_raise ArgumentError do VenueSearch.query(bad_param: 'blah') end
+  end
+
+  def test_venue_search
+    params = {name: 'bamboo thai', postal_code: '90278'}
+    venues = VenueSearch.query(params)
+    assert_equal 'Bamboo Thai Bistro', venues[0].name
+  end
+
+  def test_venue_search_block
+    params = {postal_code: '90278'}
+    # the search will only return 25 so we can be pretty confident this wont change
+    str = ''
+    VenueSearch.query(params) do |p| 
+      str << p.region
+    end
+    assert_equal 'CA'*25, str
+  end
+end
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rlocu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Philp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-08 00:00:00.000000000 Z
+dependencies: []
+description: A simple ruby wrapper for the Locu API
+email:
+- stephen@stephenphilp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rlocu.rb
+- lib/rlocu/config.rb
+- lib/rlocu/menu.rb
+- lib/rlocu/venue.rb
+- lib/rlocu/venue_details.rb
+- lib/rlocu/venue_search.rb
+- lib/rlocu/version.rb
+- lib/utilities.rb
+- rlocu.gemspec
+- test/test_truth.rb
+- test/test_utilities.rb
+- test/test_venue.rb
+- test/test_venue_details.rb
+- test/test_venue_search.rb
+homepage: https://github.com/swelltrain/rlocu
+licenses: []
+post_install_message: 
+rdoc_options: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rlocu is a ruby wrapper for Locu's API. The Locu API gives you access to
+  real-time local business data, from opening hours to price lists, such as restaurant
+  menus.
+test_files:
+- test/test_truth.rb
+- test/test_utilities.rb
+- test/test_venue.rb
+- test/test_venue_details.rb
+- test/test_venue_search.rb