campfire_logic 1.1.7

data/Capfile

@@ -0,0 +1,4 @@
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+
+load 'config/deploy' # remove this line to skip loading any of the default tasks

data/Gemfile

@@ -0,0 +1,29 @@
+source 'http://rubygems.org'
+source 'http://jose.seologic.com:8808/'
+
+gem 'bson_ext'
+gem 'fastercsv'
+gem 'mongoid-tree'
+gem 'rake'
+gem 'rails', '>= 3.0'
+gem 'scaffold_logic'
+gem 'stateflow'
+gem 'stringex'
+gem 'SystemTimer'
+
+group :development do
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'be_valid_asset'
+  gem 'capybara'
+  gem 'cucumber-rails'
+  gem 'database_cleaner'
+  gem 'launchy'
+  gem 'metric_fu'
+  gem 'mocha'
+  gem 'nokogiri'
+  gem 'rcov'
+  gem 'rspec-rails'
+end

data/Gemfile.local

@@ -0,0 +1,27 @@
+source 'http://rubygems.org'
+source 'http://jose.seologic.com:8808/'
+
+gem 'bson_ext'
+gem 'fastercsv'
+gem 'mongo', '>= 1.0.7'
+gem 'mongoid', '>= 2.0.0.beta.20'
+gem 'mongoid-tree'
+gem 'rails'
+gem 'scaffold_logic', :path => '~/Documents/projects/scaffold_logic'
+gem 'stateflow'
+gem 'stringex'
+
+group :development do
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'capybara'
+  gem 'cucumber-rails'
+  gem 'database_cleaner'
+  gem 'launchy'
+  gem 'mocha'
+  gem 'nokogiri'
+  gem 'rcov'
+  gem 'rspec-rails'
+end

data/README.rdoc

@@ -0,0 +1,17 @@
+= CampfireLogic
+
+The engine that powers CAMP. Provides location browsing, search, and management.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Roderick Monje. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'metric_fu'
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rubygems'
+require File.expand_path('../config/application', __FILE__)
+
+CampfireLogic::Application.load_tasks
+Rspec::Core::RakeTask.new
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'campfire_logic'
+    gem.summary = %Q{Rails engine that adds a location directory to your web app}
+    gem.description = %Q{Users can browse locations by country, city, and state and search locations by string or zip code. Administrators can manage locations and the services they offer.}
+    gem.email = 'rod@seologic.com'
+    gem.homepage = 'http://github.com/ivanoblomov/campfire_logic'
+    gem.authors = ['Roderick Monje']
+    gem.add_development_dependency 'rspec', '>= 1.2.9'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "CampfireLogic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :spec do
+  desc 'Run specs with RCov'
+  RSpec::Core::RakeTask.new('rcov') do |t|
+    t.rcov = true
+    t.rcov_opts = IO.readlines('spec/rcov.opts').map{ |l| l.chomp.split } * ' '
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.7

data/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  ActionView::Base.default_form_builder = ScaffoldLogic::FormBuilder
+end

data/app/controllers/directory_controller.rb

@@ -0,0 +1,65 @@
+class DirectoryController < ApplicationController
+  def search
+    if searching_by_zip?
+      search_by_zip
+    else
+      search_by_string
+    end
+  end
+
+  def show
+    @locale = find_location_locale || find_city || find_state || find_country || Locale.init_root
+    @location = find_location_locale.location if find_location_locale
+    Rails.logger.info "Found a #{@locale.kind} locale: #{@locale.name}"
+  end
+
+  def searching_by_zip?
+    params[:criteria] =~ /[0-9]{5}/
+  end
+
+  private
+
+  def find_city
+    @city ||= find_state.children.to_a.detect{ |c| c.slug == params[:city] } if params[:city]
+  end
+
+  def find_country
+    @country ||= Locale.root.children.to_a.detect{ |c| c.slug == params[:country] } if params[:country]
+  end
+
+  def find_location_locale
+    @location_locale ||= find_city.children.to_a.detect{ |c| c.slug == params[:location] } if params[:location]
+  end
+
+  def find_state
+    @state ||= Locale.first(:conditions => {:slug => params[:state]}) if params[:state]
+  end
+
+  def search_by_string
+    _query = params[:criteria]
+
+    # find matching locations
+    @locations = Location.all( :conditions => search_conditions(_query) ).to_a
+
+    if @locations.blank?
+      # find a matching locale
+      @locale = Locale.first( :conditions => search_conditions(_query) )
+
+      # find locations in locale
+      @locations = @locale.locations if @locale
+    end
+  end
+
+  def search_by_zip
+    # find matching zip or create one
+    _zip = ZipCode.first(:conditions => {:zip => params[:criteria]}) || ZipCode.create(:zip => params[:criteria])
+
+    @locations = Location.near(:lat_lng => _zip.lat_lng).limit(10)
+  end
+
+  # Returns a hash specifying the abbreviation for a two-letter query or the name otherwise. Blank queries return null.
+  def search_conditions(query)
+    return if query.blank?
+    {query.size == 2 ? :abbreviation : :name => /#{query}/i}
+  end
+end

data/app/controllers/locations_controller.rb

@@ -0,0 +1,65 @@
+class LocationsController < ApplicationController
+  before_filter :authenticate_user!, :only => [:destroy, :edit, :export, :import, :index, :new, :update, :upload] if Object.const_defined?('Devise')
+  before_filter :scope_location, :only => [:show, :edit, :update, :destroy]
+
+  # Custom =========================================================================================
+  def export
+    headers["Content-Type"] = "application/x-excel"
+    headers["Content-disposition"] = %{attachment; filename="locations.xls"}
+    @locations = Location.all
+    self.response_body = render :layout => false
+  end
+
+  def import
+  end
+
+  def upload
+    if params[:upload].blank?
+      flash[:error] = 'You must choose an import file.'
+      render :action => 'import'
+    else
+      unless (errors = LocationImport.save(params[:upload])).blank?
+        flash[:error] = (errors * '<br />').html_safe
+      end
+
+      flash[:notice] = 'File has been uploaded successfully.' unless flash[:error]
+      redirect_to locations_path
+    end
+  end
+
+  # CRUD ===========================================================================================
+  def destroy
+    @location.destroy
+    flash[:notice] = 'Deleted location.'
+    redirect_to locations_path
+  end
+
+  def edit
+  end
+
+  def index
+    @locations = Location.all.order_by([params[:by] || :name, params[:dir] || :asc])
+  end
+
+  def new
+    @location = Location.new
+  end
+
+  def show
+  end
+
+  def update
+    if @location.update_attributes(params[:location])
+      flash[:notice] = 'Updated location.'
+      redirect_to locations_path
+    else
+      render :action => 'edit'
+    end
+  end
+
+  private
+
+  def scope_location
+    @location = Location.find(params[:id])
+  end
+end

data/app/controllers/services_controller.rb

@@ -0,0 +1,46 @@
+class ServicesController < ApplicationController
+  before_filter :authenticate_user! if Object.const_defined?('Devise')
+
+  def index
+    @services = Service.all
+  end
+
+  def show
+    @service = Service.find(params[:id])
+  end
+
+  def new
+    @service = Service.new
+  end
+
+  def create
+    @service = Service.new(params[:service])
+    if @service.save
+      flash[:notice] = 'Successfully created service.'
+      redirect_to @service
+    else
+      render :action => 'new'
+    end
+  end
+
+  def edit
+    @service = Service.find(params[:id])
+  end
+
+  def update
+    @service = Service.find(params[:id])
+    if @service.update_attributes(params[:service])
+      flash[:notice] = 'Successfully updated service.'
+      redirect_to @service
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @service = Service.find(params[:id])
+    @service.destroy
+    flash[:notice] = 'Successfully destroyed service.'
+    redirect_to services_url
+  end
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,27 @@
+module ApplicationHelper
+  include ScaffoldLogic::FormHelper
+  include ScaffoldLogic::Helper
+
+  def breadcrumbs
+    html = [ link_to('Home', root_path) ]
+    html << link_to( 'Locations', locations_path ) if controller?('locations')
+    html << link_to( 'Search', directory_search_root_path ) if controller?('directory') && action?('search')
+    html << link_to( 'Services', services_path ) if controller?('services')
+    html << @locale.non_root_ancestors_and_self.map{ |l| link_to l.name, l.to_url } if @locale && ! @locale.country?
+    (html * ' &gt; ').html_safe
+  end
+
+  def set_title(title = nil)
+    if title.nil?
+      content_for(:title) { APPLICATION_NAME }
+      content_for(:page_title) {  }
+    else
+      content_for(:title) { title + " - #{APPLICATION_NAME}" }
+      content_for(:page_title) { title }
+    end
+  end
+
+  private
+
+  APPLICATION_NAME = Rails.application.class.to_s.split('::').first.freeze
+end

data/app/models/google_maps_geocoder.rb

@@ -0,0 +1,108 @@
+require 'net/http'
+
+class GoogleMapsGeocoder
+  # Returns the complete formatted address with standardized abbreviations.
+  attr_reader :formatted_address
+  # Returns the formatted street address with standardized abbreviations.
+  attr_reader :formatted_street_address
+  # Self-explanatory
+  attr_reader :city, :country_long_name, :country_short_name, :county, :lat, :lng, :postal_code, :state_long_name, :state_short_name
+
+  # Instance Methods: Overrides ====================================================================
+
+  # Geocodes the specified address and wraps the results in a geocoder object.
+  #
+  # ==== Attributes
+  #
+  # * +address+ - a geocodable address
+  #
+  # ==== Examples
+  #
+  #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Washington')
+  #    white_house.formatted_address
+  #     => "1600 Pennsylvania Ave NW, Washington D.C., DC 20500, USA"
+  def initialize(address)
+    response = Net::HTTP.get_response(URI.parse("http://maps.googleapis.com/maps/api/geocode/json?address=#{Rack::Utils.escape(address)}&sensor=false"))
+    @json = ActiveSupport::JSON.decode(response.body)
+    raise "Geocoding \"#{address}\" exceeded query limit! Google returned...\n#{@json.inspect}" if @json.blank? || @json['status'] != 'OK'
+
+    Rails.logger.info "Geocoded \"#{address}\" and Google returned...\n#{@json.inspect}"
+
+    @city, @country_short_name, @country_long_name, @county, @formatted_address, @formatted_street_address, @lat, @lng, @postal_code, @state_long_name, @state_short_name = parse_city, parse_country_short_name, parse_country_long_name, parse_county, parse_formatted_address, parse_formatted_street_address, parse_lat, parse_lng, parse_postal_code, parse_state_long_name, parse_state_short_name
+  end
+
+  # Instance Methods ===============================================================================
+
+  # Returns true if the address Google returns is an exact match.
+  #
+  # ==== Examples
+  #
+  #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Ave')
+  #    white_house.exact_match?
+  #     => true
+  def exact_match?
+    ! self.partial_match?
+  end
+
+  # Returns true if the address Google returns isn't an exact match.
+  #
+  # ==== Examples
+  #
+  #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Washington')
+  #    white_house.exact_match?
+  #     => false
+  def partial_match?
+    @json['results'][0]['partial_match'] == true
+  end
+
+  private
+
+  def parse_address_component_type(type, name='long_name')
+    _address_component = @json['results'][0]['address_components'].detect{ |ac| ac['types'] && ac['types'].include?(type) }
+    _address_component && _address_component[name]
+  end
+
+  def parse_city
+    parse_address_component_type('sublocality') || parse_address_component_type('locality')
+  end
+
+  def parse_country_long_name
+    parse_address_component_type('country')
+  end
+
+  def parse_country_short_name
+    parse_address_component_type('country', 'short_name')
+  end
+
+  def parse_county
+    parse_address_component_type('administrative_area_level_2')
+  end
+
+  def parse_formatted_address
+    @json['results'][0]['formatted_address']
+  end
+
+  def parse_formatted_street_address
+    "#{parse_address_component_type('street_number')} #{parse_address_component_type('route')}"
+  end
+
+  def parse_lat
+    @json['results'][0]['geometry']['location']['lat']
+  end
+
+  def parse_lng
+    @json['results'][0]['geometry']['location']['lng']
+ end
+
+  def parse_postal_code
+    parse_address_component_type('postal_code')
+  end
+
+  def parse_state_long_name
+    parse_address_component_type('administrative_area_level_1')
+  end
+
+  def parse_state_short_name
+    parse_address_component_type('administrative_area_level_1', 'short_name')
+  end
+end

data/app/models/locale.rb

@@ -0,0 +1,204 @@
+class Locale
+  require 'mongoid/tree'
+  require 'stringex'
+
+  include LuckySneaks::StringExtensions
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::Tree
+
+  # Constants ======================================================================================
+
+  # Mongo Config ===================================================================================
+  field :name
+  field :abbreviation
+  field :slug
+  field :accuracy, :type => Integer
+  field :lat_lng, :type => Array
+  field :kind
+  index [[ :lat_lng, Mongo::GEO2D ]], :min => -200, :max => 200
+
+  # Relationships ==================================================================================
+  referenced_in :location
+
+  # Scopes =========================================================================================
+  scope :canada, :where => {:name => 'Canada'}
+  scope :cities, :where => {:kind => 'city' }
+  scope :locations, :where => {:kind => 'location'}
+  scope :states, :where => {:kind => 'state'}
+  scope :us, :where => {:name => 'United States'}
+
+  # Callbacks ======================================================================================
+  after_create :post_process
+
+  # Macros =========================================================================================
+  attr_accessor :skip_geocoding
+
+  # Class Methods: Initialization ==================================================================
+
+  # Initialize the root-level locale.
+  def self.init_root
+    Locale.find_or_create_by(:name => 'Earth')
+  end
+
+  def self.find_or_create_country_for(location)
+    Locale.first(:conditions => {:name => location.country_long_name}) || Locale.create_country_for(location)
+  end
+
+  def self.find_or_create_state_for(location)
+    Locale.first(:conditions => {:name => location.state_long_name}) || Locale.find_or_create_country_for(location).children.create(:abbreviation => location.state, :name => location.state_long_name)
+  end
+
+  # Instance methods: Initialization ===============================================================
+
+  def post_process
+    self.set_slug
+    self.geocode
+    self.set_kind
+    self.save
+  end
+
+  # Instance methods: Overrides ====================================================================
+
+  # Returns this locale's latitude/longitude, delegating to location as needed (to prevent duplicate/conflicting coordinates).
+  def lat_lng
+    self.location ? self.location.lat_lng : self[:lat_lng]
+  end
+
+  def friendly_name
+    self.city? ? "#{self.name}, #{self.parent.name}" : self.name
+  end
+
+  # Returns this locale's sorted children.
+  def sorted_children
+    if self.root?
+      self.children.map{ |l| l.children }.flatten.sort_by{ |c| c.name.to_s }
+    else
+      self.children.sort_by{ |c| c.name.to_s }
+    end
+  end
+
+  # Instance methods: Geocoding ====================================================================
+
+  # Geocodes this location.
+  def geocode
+    return if self.skip_geocoding || self.geocoding_address.blank?
+
+    unless @geocoder
+      @geocoder = GoogleMapsGeocoder.new(self.geocoding_address)
+      self.lat_lng = [@geocoder.lat, @geocoder.lng]
+    end
+
+    @geocoder
+  rescue SocketError
+    Rails.logger.error "Can't geocode without a network connection!"
+  rescue RuntimeError
+    Rails.logger.error "Can't geocode, over query limit!"
+  end
+
+  # Returns true if this location has a latitude and longitude.
+  def geocoded?
+    self.lat_lng.is_a?(Array)
+  end
+
+  # Returns this locale's address for geocoding.
+  def geocoding_address
+    a = case self.kind
+      when 'country' then self.name
+      when 'state' then self.name
+      when 'city' then [self.name, self.parent.name]
+      when 'location' then nil
+    end
+
+    a && a.select{|s| ! s.blank?} * ' '
+  end
+
+  # Return an appropriate Google-Maps zoom level.
+  def zoom_level
+    case self.kind
+      when 'country' then 3
+      when 'state' then 5
+      when 'city' then 9
+      when 'location' then 10
+    end
+  end
+
+  # Instance Methods: Tree =========================================================================
+  def destroy
+    if self.parent && self.parent.children.count == 1
+      Rails.logger.info "Destroyed #{self.parent.name}"
+      self.parent.destroy
+    elsif self.parent
+      Rails.logger.info "Did not destroy #{self.parent.name}: has #{self.parent.children.to_a.map{|x|x.name.to_s}.sort * ', '}"
+    end
+
+    super unless self.country?
+  end
+
+  # Returns location-locales found within this locale.
+  def location_locales
+    self.descendants.select{ |d| d.location? && d.location }
+  end
+
+  # Returns locations found within this locale.
+  def locations
+    (self.location_locales.map{ |l| l.location } | [self.location]).compact
+  end
+
+  # Returns an array of this locale's ancestors and itself. Countries are omitted.
+  def non_root_ancestors_and_self
+    self.ancestors_and_self.select{ |l| ! l.root? }
+  end
+
+  # Sets the slug for this locale. Slugs from the locale tree are used to build this locale's URL.
+  def set_slug
+    self.slug = self.root? ? nil : self.name.to_s.to_url
+  end
+
+  # Returns the permalink for this locale.
+  def to_url
+    "/directory/#{(non_root_ancestors_and_self_names * '/').to_url.gsub('-slash-', '/')}"
+  end
+
+  # Instance Methods: Typing =======================================================================
+  def city?
+    self.kind == 'city'
+  end
+
+  def country?
+    self.kind == 'country'
+  end
+
+  def location?
+    self.kind == 'location'
+  end
+
+  def planet?
+    self.kind == 'planet'
+  end
+
+  def state?
+    self.kind == 'state'
+  end
+
+  def set_kind
+    case self.depth
+      when 0; self.kind = 'planet'
+      when 1; self.kind = 'country'
+      when 2; self.kind = 'state'
+      when 3; self.kind = 'city'
+      when 4; self.kind = 'location'
+    end
+  end
+
+  private
+
+  def self.create_country_for(location)
+    Locale.init_root.children.create(:abbreviation => location.country, :name => location.country_long_name)
+  end
+
+  # Returns an array of this locale's and its ancestors' names. Countries are omitted.
+  def non_root_ancestors_and_self_names
+    self.non_root_ancestors_and_self.map{ |l| l.name }
+  end
+end