grubber 0.0.1

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,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matthew Werner
+
+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,125 @@
+# Grubber
+
+Grubber helps you find a place to eat neaby.
+
+## Installation
+
+Simply:
+
+    $ gem install grubber
+
+## API Access
+
+Grubber uses the Yelp API to find nearby places. To use
+grubber you must get yourself Yelp API access. You
+can do so at: [http://www.yelp.com/developers](http://www.yelp.com/developers)
+
+Once you have your tokens, run `grubber auth`. This will
+prompt you for your credentials and get you the rest of the way.
+
+## Location Services
+
+Grubber uses CoreLocation to find out where you're geographically operating.
+It will request permission once and then cache your location. Grubber will automatically 
+find your coordinates when needed if you haven't previously located yourself.
+
+#### Granting Permission
+
+CoreLocation requires you grant ruby permission to use Location Services. You should
+be prompted for permission once, and don't have to worry about it again.
+
+#### Revoking Permission
+
+To revoke previously granted permissions, you can uncheck ruby in:
+    
+    System Preferences > Security & Privacy > Privacy > Location Services
+
+#### Updating your location
+
+You can request grubber to update its cached location by calling `locate`:
+
+    $ grubber locate
+    Updated coordinates to: 37.782487810714265, -122.40982359190473
+
+*Developers Note: No stalkers please*
+
+## Usage
+
+Grubber has two primary commands:
+
+### List
+
+Grubber can list a bunch of nearby restaurants. Each entry has
+the name, rating, address, category, phone and url.
+
+**Protip:** If using iTerm, you can cmd+click on a url to open in your default browser
+
+    $ grubber list
+
+    Split Pea Seduction  ★ ★ ★ ★ ☆
+    138 6th St
+    [Sandwiches] +1-415-551-2223
+    http://www.yelp.com/biz/split-pea-seduction-san-francisco
+
+    Miss SaiGon  ★ ★ ★ ★ ☆
+    100 6th St
+    [Vietnamese] +1-415-522-0332
+    http://www.yelp.com/biz/miss-saigon-san-francisco-2
+
+    Punjab Kabab House  ★ ★ ★ ☆ ☆
+    101 Eddy St
+    [Indian] +1-415-447-7499
+    http://www.yelp.com/biz/punjab-kabab-house-san-francisco
+
+    Cafe Venue  ★ ★ ★ ☆ ☆
+    67 5th St
+    [Coffee & Tea] +1-415-546-1144
+    http://www.yelp.com/biz/cafe-venue-san-francisco-7
+
+    ...
+
+### Pick
+
+Grubber can just go ahead and pick a nearby restaurant for you
+to avoid you having to think about exactly where you want to go.
+Pick returns all the same fields as list.
+
+    $ grubber pick
+
+    Tu Lan  ★ ★ ★ ★ ☆
+    8 6th St
+    [Vietnamese] +1-415-626-0927
+    http://www.yelp.com/biz/tu-lan-san-francisco-2
+
+### The CLI
+
+    grubber help [TASK]  # Describe available tasks or one specific task
+    grubber auth         # Enter your Yelp API credentials
+    grubber list         # List available nearby restaurants
+    grubber locate       # Refresh your grubber's known coordinates
+    grubber pick         # Pick a restaurant nearby
+
+## Troubleshooting 
+
+_**When I run call locate twice in a row, it just hangs. wtf**_
+
+If you request a new location from CoreLocation too quickly, the command 
+will simply hang. Unfortunately this pertains to [a problem]((https://github.com/evanphx/lost/pull/2) with the awesome ruby wrapper [lost](https://github.com/evanphx/lost) that [evanphx](https://github.com/evanphx) has written. Grubber will cache your location, so it shouldn't be a problem. Just don't move around so fast.
+
+## The future
+
+I would like to add a few features to grubber. Such as:
+
+- Testing
+- Preferred tags/categories of food
+- CLI for search terms
+- Price range
+- Maximum distance
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/grubber

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << lib unless $LOAD_PATH.include?(lib)
+require 'grubber'
+Grubber::Command.start

data/grubber.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grubber/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "grubber"
+  gem.version       = Grubber::VERSION
+  gem.authors       = ["Matthew Werner"]
+  gem.email         = ["matthew@culini.com"]
+  gem.description   = %q{Grubber uses the Yelp API to find nearby restaurants to eat at}
+  gem.summary       = %q{Grubber helps you decide where to eat}
+  gem.homepage      = ""
+  gem.license       = 'MIT'
+
+  gem.add_runtime_dependency 'oauth'
+  gem.add_runtime_dependency 'thor'
+  gem.add_runtime_dependency 'lost'
+
+  gem.add_development_dependency 'rake'
+
+  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/lib/grubber.rb

@@ -0,0 +1,12 @@
+require "grubber/version"
+
+module Grubber
+  autoload :Client,     'grubber/client'
+  autoload :Command,    'grubber/command'
+  autoload :Config,     'grubber/config'
+  autoload :Store,      'grubber/store'
+  autoload :Presenter,  'grubber/presenter'
+  autoload :Restaurant, 'grubber/restaurant'
+
+  CONFIG = Config.load
+end

data/lib/grubber/client.rb

@@ -0,0 +1,47 @@
+require 'oauth'
+require 'json'
+require 'yaml'
+
+module Grubber
+  class Client
+
+    HOST = 'api.yelp.com'
+    attr_accessor :consumer_key, :consumer_secret, :token_key, :token_secret
+
+    def search(term, opts={})
+      lat, lng = *Grubber::CONFIG.coordinates
+      yelp     = connection
+      return [] if yelp.nil?
+
+      response = yelp.get("/v2/search?term=#{term}&ll=#{lat},#{lng}")
+      Restaurant.parse(response.body)
+    end
+
+    private
+
+    def connection
+      return @connection if defined?(@connection)
+      ckey, csec, tkey, tsec = credentials
+      
+      oauth = OAuth::Consumer.new(ckey, csec, {:site => "http://#{HOST}"})
+      @connection = OAuth::AccessToken.new(oauth, tkey, tsec)
+    end
+
+    def credentials
+      config = Grubber::CONFIG
+      unless config.has_auth?
+        puts "\nYou are missing Yelp API Credentials"
+        puts "Add your credentials using `grubber auth`"
+        return nil
+      end
+
+      return [
+        config.consumer_key,
+        config.consumer_secret,
+        config.token_key,
+        config.token_secret
+      ]
+    end
+
+  end
+end

data/lib/grubber/command.rb

@@ -0,0 +1,52 @@
+require 'thor'
+
+module Grubber
+  class Command < Thor
+    include Thor::Actions
+    
+    desc "pick", "Select one restaurant nearby"
+    def pick
+      Presenter.new( Restaurant.random ).present
+    end
+
+    desc "list", "List available nearby restaurants"
+    def list
+      Presenter.new( Restaurant.all ).present
+    end
+
+    desc 'locate', "Refresh your grubber's known coordinates"
+    def locate
+      lat, lng = Grubber::Config.update_location
+      say "Updated coordinates to: #{lat}, #{lng}", :green
+    end
+
+    desc 'auth', 'Enter your Yelp API credentials'
+    def auth
+      config = Grubber::Config.load
+
+      say("\nGrubber requires Yelp API v2 credentials")
+      say("To learn more go to: http://www.yelp.com/developers")
+      if config.has_auth?
+        say("\nYelp authentication already set:")
+        say("Consumer Key:    #{config.consumer_key}")
+        say("Consumer Secret: #{config.consumer_secret}\n")
+        say("Token Key:       #{config.token_key}\n")
+        say("Token Sec:       #{config.token_secret}\n")
+        overwrite = ask('Overwrite? (y,n)')
+        return unless overwrite.downcase == 'y'
+      end
+
+      c_key = ask("\nConsumer Key: ")
+      c_sec = ask('Consumer Secret: ')
+      t_key = ask('Token Key: ')
+      t_sec = ask('Token Sec: ')
+
+      if Grubber::Config.update_auth(c_key, c_sec, t_key, t_sec)
+        say("Complete!", :green)
+      else
+        say("Failed", :red)
+      end
+    end
+
+  end
+end

data/lib/grubber/config.rb

@@ -0,0 +1,70 @@
+require 'lost'
+
+module Grubber
+  class Config
+
+    attr_accessor :store, :lat, :lng, :credentials
+
+    def initialize(opts={})
+      @store = Grubber::Store.load[:grubber]
+
+      location = store[:location]
+      @lat = location[:lat]
+      @lng = location[:lng]
+      
+      @credentials = store[:credentials]
+      self
+    end
+
+    def self.load
+      new
+    end
+    
+    def coordinates
+      [lat, lng]
+    end
+
+    def has_auth?
+      !self.credentials.nil?
+    end
+
+    # consumer_key, consumer_secret
+    # token_key,    token_secret
+    %w(consumer token).each do |type|
+      %w(key secret).each do |obj|
+        auth_attr = "#{type}_#{obj}".to_sym
+        define_method(auth_attr) do
+          return '' unless has_auth?
+          credentials[auth_attr] || ''
+        end
+      end
+    end
+
+    def self.update_auth(ckey, csec, tkey, tsec)
+      [ckey, csec, tkey, tsec].each do |k|
+        return nil if k.nil? || k == ''
+      end
+
+      Grubber::Store.update({
+        credentials: {
+          consumer_key: ckey,
+          consumer_secret: csec,
+          token_key: tkey,
+          token_secret: tsec
+        }
+      })
+    end
+
+    def self.update_location
+      lat, lng = *Lost.current_position
+      Grubber::Store.update({
+        location: {
+          lat: lat,
+          lng: lng
+        }
+      })
+      return [lat, lng]
+    end
+
+  end
+end

data/lib/grubber/presenter.rb

@@ -0,0 +1,34 @@
+#!/bin/env ruby
+# encoding: utf-8
+
+module Grubber
+  class Presenter
+
+    attr_accessor :restaurants
+
+    def initialize(restaurants)
+      @restaurants = [*restaurants]
+    end
+
+    def present
+      return nil if empty?
+
+      restaurants.each do |r|
+        puts "\n#{r.name} #{stars(r.rating)}"
+        puts r.address
+        puts "[#{r.category}] #{r.phone}"
+        puts r.url
+      end
+      nil
+    end
+
+    def stars(rating)
+      (" ★" * rating) + (" ☆" * (5 - rating))
+    end
+
+    def empty?
+      self.restaurants.empty?
+    end
+
+  end
+end

data/lib/grubber/restaurant.rb

@@ -0,0 +1,47 @@
+module Grubber
+  class Restaurant
+    
+    ATTRIBUTES = [:name, :description, :categories, :rating, :url, :display_phone, :location, :reviews].freeze
+    attr_accessor *ATTRIBUTES
+
+    alias_method :phone, :display_phone
+
+    def initialize(opts={})
+      opts.each_pair do |k,v|
+        self.instance_variable_set("@#{k}", v)
+      end
+      yield self
+    end
+    
+    def self.all(opts={})
+      q = opts[:term] || 'lunch'
+      Client.new.search(q)
+    end
+
+    def self.random(opts={})
+      all(opts).sample
+    end
+
+    def address
+      location['display_address'].first
+    end
+
+    def category
+      cat = categories.first
+      cat.is_a?(Array) ? cat.first : cat
+    end
+
+    def self.parse(body)
+      JSON.parse(body)['businesses'].collect do |r|
+        Restaurant.new do |n|
+          ATTRIBUTES.map(&:to_s).each do |a|
+            value = r[a]
+            value = value.to_i if a == 'rating'
+            n.send("#{a}=", value)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/grubber/store.rb

@@ -0,0 +1,85 @@
+require 'yaml'
+require 'lost'
+
+module Grubber
+  class Store
+
+    attr_accessor :path, :content
+
+    DEFAULT_PATH = "/Users/#{`whoami`.strip}/.grubber"
+
+    def initialize(opts={})
+      @path = opts[:path] || DEFAULT_PATH
+      
+      setup
+    end
+
+    def self.load
+      client = new
+
+      data = client.read
+      return data unless data.nil?
+
+      client.reset
+    end
+
+    def self.update(data)
+      return unless data.is_a?(Hash)
+      
+      client = new
+      client.content[:grubber].merge!(data)
+      client.write
+      data
+    end
+
+    def setup
+      return reload if File.exist?(path)
+
+      reset
+    end
+
+    def read
+      begin
+        yml = YAML.load_file(path)
+      rescue TypeError => e
+        return nil
+      end
+      
+      return nil unless yml
+
+      yml
+    end
+
+    def reload
+      @content = read
+    end
+
+    def write
+      File.open(path, 'w'){|f| f.write(content.to_yaml) }
+    end
+
+    def reset
+      File.open(path, 'w') do |f|
+        f.write(base_config.to_yaml)
+      end
+
+      reload
+    end
+
+    def base_config
+      lat, lng      = *Lost.current_position
+      current_time  = Time.now.to_i
+
+      { 
+        grubber: {
+          location: {
+            lat: lat,
+            lng: lng  
+          },
+          created_at: current_time
+        }
+      }
+    end
+
+  end
+end

data/lib/grubber/version.rb

@@ -0,0 +1,3 @@
+module Grubber
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: grubber
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Werner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  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: thor
+  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: lost
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Grubber uses the Yelp API to find nearby restaurants to eat at
+email:
+- matthew@culini.com
+executables:
+- grubber
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/grubber
+- grubber.gemspec
+- lib/grubber.rb
+- lib/grubber/client.rb
+- lib/grubber/command.rb
+- lib/grubber/config.rb
+- lib/grubber/presenter.rb
+- lib/grubber/restaurant.rb
+- lib/grubber/store.rb
+- lib/grubber/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3855025966836421654
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3855025966836421654
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Grubber helps you decide where to eat
+test_files: []