portero 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/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter "lib/portero/version.rb"
+end

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Robert Rouse
+
+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,67 @@
+# Portero
+
+Portero is another word for someone that may act as a concierge. Portero will help you find venues around a location using as many services known.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'portero'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install portero
+
+## Usage
+
+Configure Portero with providers, either in a Rails initializer or elsewhere:
+
+    Portero.providers = [Portero::SearchProvider::Foursquare.new(client_id: YOUR_ID, client_secret: YOUR_SECRET)]
+    Portero.init!
+
+If more than one provider is given, it will search both providers and return combined results.
+
+To search
+
+    results = Portero.search("pizza", latitude, longitude, options)
+    results #=> Array of Portero::SearchResult
+
+Options can be anything the provider allows. All providers may not utilize all options. It's provider implementation dependant
+
+SearchResult objects contain the following fields
+
+    name
+    address
+    latitude
+    longitude
+    city
+    state
+    postal_code
+    country
+    category
+    icon
+    extra
+
+A provider may put whatever extraneous data that might be important in extra. It is also not forced to provide usable data in all fields.
+
+## Writing a provider
+
+A new provider must include Porter::SearchProvider and implement (at minimum) the search method that returns the SearchResult objects. A provider my require specific options that need to be passed to the constructor with requires_option. If those options are not given, an exception is raised. See one of the bundled providers in lib/portero/providers for examples.
+
+## TODO
+
+1. When using multiple providers, parallelize the requests.
+2. When using multiple providers, analyze the result set and remove duplication as much as possible.
+3. Always make it better
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/portero/portero.rb

@@ -0,0 +1,33 @@
+require 'portero/search_provider'
+require 'portero/search_result'
+require 'faraday'
+require 'json'
+
+module Portero
+  module SearchProvider
+    autoload :Foursquare, 'portero/providers/foursquare'
+    autoload :GooglePlaces, 'portero/providers/google_places'
+  end
+
+  def self.init!
+    @conn = Faraday.new do |builder|
+      builder.adapter Faraday.default_adapter
+    end
+  end
+
+  def self.search(query, latitude, longitude, options = {})
+    results = []
+    @providers.each do |provider|
+      results += provider.search(@conn, query, latitude, longitude, options)
+    end
+    results
+  end
+
+  def self.providers=(providers)
+    @providers = providers
+  end
+
+  def self.providers
+    @providers
+  end
+end

data/lib/portero/providers/foursquare.rb

@@ -0,0 +1,39 @@
+module Portero
+  module SearchProvider
+    class Foursquare
+      include SearchProvider
+
+      requires_option :client_id
+      requires_option :client_secret
+
+      def search(conn, query, latitude, longitude, options = {})
+        results = conn.get("https://api.foursquare.com/v2/venues/search", {query: query, client_id: @provider_options[:client_id], client_secret: @provider_options[:client_secret], v: "20120709",
+          limit: options[:limit], radius: options[:radius], ll: [latitude, longitude].join(",")})
+        parse_results(results)
+      end
+
+      def parse_results(results)
+        json = JSON.parse(results.body)
+        venues = json["response"]["venues"]
+        results = []
+        venues.each do |found_venue|
+          venue = Portero::SearchResult.new
+          venue.name = found_venue["name"]
+          venue.address = found_venue["location"]["address"]
+          venue.latitude = found_venue["location"]["lat"]
+          venue.longitude = found_venue["location"]["lng"]
+          venue.city = found_venue["location"]["city"]
+          venue.state = found_venue["location"]["state"]
+          venue.postal_code = found_venue["location"]["postalCode"]
+          venue.country = found_venue["location"]["country"]
+          venue.category = found_venue["categories"].first["name"]
+          venue.icon = found_venue["categories"].first["icon"]["prefix"] + "64" + found_venue["categories"].first["icon"]["suffix"]
+          venue.extra = {categories: found_venue["categories"], url: found_venue["url"]}
+
+          results << venue
+        end
+        results
+      end
+    end
+  end
+end

data/lib/portero/providers/google_places.rb

@@ -0,0 +1,41 @@
+module Portero
+  module SearchProvider
+
+    class GooglePlaces
+      include SearchProvider
+
+      requires_option :key
+
+      def search(conn, query, latitude, longitude, options = {})
+        results = conn.get("https://maps.googleapis.com/maps/api/place/textsearch/json", {query: query, key: @provider_options[:key],
+        radius: options[:radius], location: [latitude, longitude].join(","), sensor: false})
+        parse_results(results)
+      end
+
+      def parse_results(results)
+        json = JSON.parse(results.body)
+        venues = json["results"]
+        results = []
+        venues.each do |found_venue|
+          venue = Portero::SearchResult.new
+          venue.name = found_venue["name"]
+          venue.address = found_venue["formatted_address"]
+          venue.latitude = found_venue["geometry"]["location"]["lat"]
+          venue.longitude = found_venue["geometry"]["location"]["lng"]
+          venue.city = ""
+          venue.state = ""
+          venue.postal_code = ""
+          venue.country = ""
+          venue.category = found_venue["types"].first
+          venue.icon = found_venue["icon"]
+          venue.extra = {types: found_venue["types"]}
+
+          results << venue
+        end
+        results
+      end
+
+    end
+
+  end
+end

data/lib/portero/search_provider.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext/class/attribute'
+
+module Portero
+  module SearchProvider
+    module ClassMethods
+
+      def api_not_implemented(klass)
+        caller.first.match(/in \`(.+)\'/)
+        method_name = $1
+        raise InterfaceNotImplementedError.new("#{klass.class.name} needs to implement '#{method_name}'!")
+      end
+
+      def requires_option(key)
+        required_options << key
+      end
+    end
+
+    module InstanceMethods
+
+      def initialize(options = {})
+        @provider_options = options
+        validate_options
+      end
+
+      def search(connection, query, latitude, longitude, options = {})
+        self.class.api_not_implemented(self)
+      end
+
+      def validate_options
+        self.class.required_options.each do |key|
+          raise MissingRequirementError.new("#{self.class.name} needs an options hash key of '#{key}' to function") unless @provider_options.has_key?(key)
+        end
+      end
+
+    end
+
+    def self.included(receiver)
+      receiver.extend           ClassMethods
+      receiver.send :include,   InstanceMethods
+      class << receiver
+        class_attribute(:required_options)
+        self.required_options = []
+      end
+    end
+
+    class InterfaceNotImplementedError < NoMethodError
+    end
+
+    class MissingRequirementError < Exception
+    end
+  end
+end

data/lib/portero/search_result.rb

@@ -0,0 +1,5 @@
+module Portero
+  class SearchResult
+    attr_accessor :name, :address, :latitude, :longitude, :city, :state, :postal_code, :country, :category, :icon, :extra
+  end
+end

data/lib/portero/version.rb

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

data/lib/portero.rb

@@ -0,0 +1,2 @@
+require "portero/version"
+require "portero/portero"

data/portero.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/portero/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Robert Rouse"]
+  gem.email         = ["robert@theymaybecoders.com"]
+  gem.description   = %q{Portero will help you find venues around a location using as many services known}
+  gem.summary       = %q{Portero will help you find venues around a location using as many services known}
+  gem.homepage      = "http://github.com/theymaybecoders"
+
+  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.name          = "portero"
+  gem.require_paths = ["lib"]
+  gem.version       = Portero::VERSION
+
+  gem.add_development_dependency "rspec", '~>2.0'
+  gem.add_development_dependency "shoulda-matchers", '~>1.2'
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "fakeweb"
+
+  gem.add_dependency "faraday", '~>0.8'
+  gem.add_dependency "activesupport", '~> 3'
+end