campfire_logic 1.1.7

data/app/models/location.rb

@@ -0,0 +1,216 @@
+Stateflow.persistence = :mongoid
+
+class Location
+  include CampfireLogic::Base
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Stateflow
+
+  # Mongo Config ===================================================================================
+  field :name
+  field :address1
+  field :address2
+  field :city
+  field :state
+  field :state_long_name
+  field :zip
+  field :country
+  field :country_long_name
+  field :email
+  field :fax
+  field :phone
+  field :toll_free
+  field :hours
+  field :active, :type => Boolean
+  field :location_number
+  field :meta_description
+  field :accuracy, :type => Integer
+  field :address_status
+  field :lat_lng, :type => Array
+  field :validated_address1
+  field :validated_city
+  field :validated_zip
+  index [[ :lat_lng, Mongo::GEO2D ]], :min => -200, :max => 200
+  references_one :locale, :dependent => :destroy
+  references_and_referenced_in_many :services, :inverse_of => :locations
+
+  # Callbacks ======================================================================================
+
+  # Macros =========================================================================================
+  attr_reader :geocoder
+  trimmed_fields :address1, :address2, :city, :email, :fax, :location_number, :name, :phone, :state, :zip
+  validates_presence_of :address1, :city, :state
+
+  # State machine ==================================================================================
+  stateflow do
+    state_column :address_status
+    initial :new
+
+    state :new, :partial_match, :validated
+
+    # Approves this location's partially-matched address, marking it as "validated".
+    event :approve_address do
+      transitions :from => :partial_match, :to => :validated
+    end
+
+    # Clears this location's address, marking it as "new".
+    event :clear_address do
+      transitions :from => any, :to => :new
+    end
+
+    # Validates this location's address by geocoding. Partial matches are flagged; exact matches are flagged as "validated".
+    event :validate_address do
+      transitions :from => any, :to => [:new, :partial_match, :validated], :decide => :geocode
+    end
+  end
+
+  # Instance methods: Overrides ====================================================================
+  def address1=(value)
+    clear_geocoding if self.address1 != value
+    self[:address1] = value
+  end
+
+  def city=(value)
+    clear_geocoding if self.city != value
+    self[:city] = value
+  end
+
+  def state=(value)
+    clear_geocoding if self.state != value
+    self[:state] = value
+  end
+
+  # Instance methods: Addressing ===================================================================
+
+  # Returns this location's address for geocoding. It omits the second address field to simplify post-processing.
+  def geocoding_address
+    [address1, city, state].select{|s| ! s.blank?} * ' '
+  end
+
+  # Returns this location's street address, combining the two address fields with the specified delimiter. Latter defaults to a space.
+  def street_address( delimiter = ' ' )
+    [address1, address2].select{|s| ! s.blank?} * delimiter
+  end
+
+  # Instance methods: Geocoding ====================================================================
+
+  # Geocodes this location.
+  def geocode
+    return :new if self.geocoding_address.blank?
+
+    unless @geocoder
+      @geocoder = GoogleMapsGeocoder.new(self.geocoding_address)
+      self.country, self.country_long_name, self[:state], self.state_long_name = @geocoder.country_short_name, @geocoder.country_long_name, @geocoder.state_short_name, @geocoder.state_long_name
+      self.lat_lng = [@geocoder.lat, @geocoder.lng]
+      audit_address
+    end
+
+    @geocoder.partial_match? ? :partial_match : :validated
+  rescue SocketError
+    Rails.logger.error "Can't geocode without a network connection!"
+    :new
+  rescue RuntimeError
+    Rails.logger.error "Can't geocode!"
+    :new
+  end
+
+  # Returns true if this location has a latitude and longitude.
+  def geocoded?
+    self.lat_lng.is_a?(Array)
+  end
+
+  # Returns true if the specified address field matches the geocoder's results.
+  def matches_geocoder?(attribute)
+    @geocoder.blank? || self.send(attribute) == @geocoder.send(GOOGLE_MAPS_GEOCODER_FIELDS_BY_LOCATION_FIELD[attribute])
+  end
+
+  # Returns the n nearest locations.
+  def nearby_locations(n = 5)
+    Location.near(:lat_lng => self.lat_lng).limit(n + 1).select{ |l| l != self }
+  end
+
+  # Instance methods: Locales ======================================================================
+
+  def localize
+    self.save
+    self.locale ? update_locales : create_locales
+    self.save
+  end
+
+  # Returns this location's city locale.
+  def city_locale
+    self.locale.parent
+  end
+
+  # Returns this location's state locale.
+  def state_locale
+    self.city_locale.parent
+  end
+
+  private
+
+  GOOGLE_MAPS_GEOCODER_FIELDS_BY_LOCATION_FIELD = {
+    :address1 => :formatted_street_address,
+    :city => :city,
+    :zip => :postal_code
+  }.freeze
+
+  # Compares this location's address with the geocoder's results.
+  def audit_address
+    if @geocoder.partial_match?
+      GOOGLE_MAPS_GEOCODER_FIELDS_BY_LOCATION_FIELD.keys.each do |field|
+        # set "validated_" field to geocoder's result
+        self.send("validated_#{field}=", @geocoder.send(GOOGLE_MAPS_GEOCODER_FIELDS_BY_LOCATION_FIELD[field])) unless self.matches_geocoder?(field)
+      end
+    end
+  end
+
+  # Clears all addressing data set by the geocoder.
+  def clear_geocoding
+    @geocoder = nil
+    self.country, self.country_long_name, self.lat_lng, self.state_long_name, self.validated_address1, self.validated_city, self.validated_zip = nil
+    clear_address
+  end
+
+  # Creates a locale tree for this location.
+  def create_locales
+    # Find or create a state locale for this location
+    _state = Locale.find_or_create_state_for(self)
+
+    # Find or create a city locale for this location
+    _city = _state.children.to_a.detect{ |c| c.name =~ /#{self.city}/i } || (sleep 0.25; _state.children.create(:name => self.city))
+
+    # Find or create a locale for this location
+    self.locale = _city.children.to_a.detect{ |c| c.name =~ /#{self.name}/i } || (sleep 0.25; _city.children.create(:name => self.name, :skip_geocoding => true))
+    self.locale.save
+  end
+
+  # Updates the locale tree for this location.
+  def update_locales
+    # update location
+    self.locale.name = self.name
+    self.locale.save
+
+    # does its city locale have other locations?
+    if self.city_locale.children.count > 1
+      # create a new city
+      self.locale.parent = self.state_locale.children.create(:name => self.city)
+    else
+      # update the city
+      self.city_locale.name = self.city
+    end
+
+    # does its state locale have other cities?
+    if self.state_locale.children.count > 1
+      # find or create a state
+      self.city_locale.parent = Locale.find_or_create_state_for(self)
+    else
+      # update the state
+      self.state_locale.abbreviation = self.state
+      self.state_locale.name = self.state_long_name
+      self.state_locale.save
+    end
+
+    self.city_locale.save
+  end
+end

data/app/models/location_import.rb

@@ -0,0 +1,48 @@
+class LocationImport < ScaffoldLogic::DataImport
+  def self.save(upload)
+    # create file path
+    _path = File.join('tmp', upload['datafile'].original_filename)
+
+    # write file
+     File.open(_path, 'wb') { |f| f.write(upload['datafile'].read) }
+
+    self.run(_path)
+  end
+
+  def self.test(path='public/sample-locations.xls')
+    self.run(path)
+  end
+
+  def process_row
+    @required_fields ||= [:'location #']
+
+    if valid_row? && _location = Location.find_or_initialize_by(:location_number => row_map[@required_fields.first])
+      COLUMNS_BY_MODEL_FIELDS.keys.each do |_field|
+        _content = eval(COLUMNS_BY_MODEL_FIELDS[_field])
+        _location.send("#{_field}=", _content) unless _content.blank?
+      end
+
+      _location.validate_address!
+      _location.localize
+      sleep 0.33
+    else
+      @errors << "Row #{@row_index}: Missing at least one required field: #{@required_fields * ', '}!"
+    end
+  end
+
+  protected
+
+  COLUMNS_BY_MODEL_FIELDS = {
+    'location_number' => 'row_map[:"location #"]',
+    'name' => 'row_map[:"name"]',
+    'address1' => 'row_map[:"address 1"]',
+    'address2' => 'row_map[:"address 2"]',
+    'city' => 'row_map[:"city"]',
+    'state' => 'row_map[:"state"]',
+    'zip' => 'row_map[:"postal code"]',
+    'country' => 'row_map[:"country code"]',
+    'phone' => 'row_map[:"phone"]',
+    'email' => 'row_map[:"email"]',
+    'meta_description' => 'row_map[:"description"]'
+  }
+end

data/app/models/service.rb

@@ -0,0 +1,27 @@
+class Service
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  # Attributes =====================================================================================
+  field :name
+  field :description
+
+  # Indices ========================================================================================
+
+  # Constants ======================================================================================
+
+  # Scopes =========================================================================================
+
+  # Relationships ==================================================================================
+  references_and_referenced_in_many :locations, :inverse_of => :services
+
+  # Behavior =======================================================================================
+
+  # Callbacks ======================================================================================
+
+  # Validations ====================================================================================
+
+  # Class methods ==================================================================================
+
+  # Instance methods ===============================================================================
+end

data/app/models/zip_code.rb

@@ -0,0 +1,48 @@
+class ZipCode
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  # Attributes =====================================================================================
+  field :zip
+  field :city
+  field :state
+  field :county
+  field :lat_lng, :type => Array
+  index [[ :lat_lng, Mongo::GEO2D ]], :min => -200, :max => 200
+
+  # Indices ========================================================================================
+
+  # Constants ======================================================================================
+
+  # Scopes =========================================================================================
+
+  # Relationships ==================================================================================
+
+  # Behavior =======================================================================================
+
+  # Callbacks ======================================================================================
+  before_save :geocode
+
+  # Validations ====================================================================================
+
+  # Class methods ==================================================================================
+
+  # Instance methods ===============================================================================
+
+  # Geocodes this zip code.
+  def geocode
+    return if geocoded?
+
+    unless @geocoder
+      @geocoder = GoogleMapsGeocoder.new(self.zip)
+      self.city, self.state, self.county, self.lat_lng = @geocoder.city, @geocoder.state_short_name, @geocoder.county, [@geocoder.lat, @geocoder.lng], @geocoder.state_long_name
+    end
+  rescue SocketError
+    Rails.logger.error "Can't geocode without a network connection!"
+  end
+
+  # Returns true if this location has a latitude and longitude.
+  def geocoded?
+    self.lat_lng.is_a?(Array)
+  end
+end

data/app/models/zip_code_import.rb

@@ -0,0 +1,19 @@
+class ZipCodeImport < ScaffoldLogic::DataImport
+  def self.save(upload)
+    # create file path
+    _path = File.join('tmp', upload['datafile'].original_filename)
+
+    # write file
+     File.open(_path, 'wb') { |f| f.write(upload['datafile'].read) }
+
+    self.run(_path)
+  end
+
+  def self.test(path='db/zip_codes.txt')
+    self.run(path)
+  end
+
+  def process_row
+    zip = ZipCode.create :zip => row_map[:zip], :city => row_map[:city], :state => row_map[:state], :county => row_map[:zip_class], :lat_lng => [row_map[:latitude].to_f, row_map[:longitude].to_f]
+  end
+end

data/app/views/directory/_search_form.html.erb

@@ -0,0 +1,4 @@
+<%= form_tag "/#{CampfireLogic.directory_slug}/search", :method => :get, :id => 'search-form' do -%>
+  <%= text_field_tag 'criteria', params[:criteria], :id => 'search-input', :maxlength => 40 -%>
+  <%= submit_tag 'Search' -%>
+<%- end -%>

data/app/views/directory/_show_children.html.erb

@@ -0,0 +1,29 @@
+<%-
+  subtitle = " - #{@locale.location ? @locale.location.name : @locale.name}" unless @locale.planet?
+  set_title "Location Directory#{subtitle}"
+-%>
+
+<br style="clear: both;" />
+<br style="clear: both;" />
+
+<%- unless @locale.children.blank? -%>
+  <%- if @locale.root? -%>
+    <h2>Select a State/Province</h2>
+  <%- elsif @locale.country? -%>
+    <h2>Select a State</h2>
+  <%- elsif @locale.state? -%>
+    <h2>Select a City</h2>
+  <%- else -%>
+    <h2>Select a Location</h2>
+  <%- end -%>
+
+  <div>
+    <%- @locale.sorted_children.in_groups(2, false).each do |group| -%>
+      <ul style="float: left; margin-right: 1em; width: 40%;">
+      <%- group.each do |_child| -%>
+        <li><%= link_to _child.name, _child.to_url -%></li>
+      <%- end -%>
+      </ul>
+    <%- end -%>
+  </div><br style="clear: both;" />
+<%- end -%>

data/app/views/directory/_show_location.html.erb

@@ -0,0 +1,14 @@
+<%- set_title "Location Directory - #{ @location.name }" -%>
+
+<%= render 'shared/location' -%><br style="clear: both;" />
+<br style="clear: both;" />
+
+<h2>Nearby Locations</h2>
+
+<%- @location.nearby_locations.in_groups(2, false).each do |group| -%>
+  <ul style="float: left; margin-right: 1em; width: 40%;">
+    <% group.each do |@location| %>
+      <li><%= render 'shared/location' -%></li>
+    <% end %>
+  </ul>
+<%- end -%>

data/app/views/directory/search.html.erb

@@ -0,0 +1,31 @@
+<%- set_title 'Location Directory - Search' -%>
+
+<div id="map_canvas" style="border: solid black 1px; width: 100%; height: 300px"></div><br />
+
+<%= render 'search_form' -%><br style="clear: both;" />
+<br style="clear: both;" />
+
+<div id="directions_panel"></div>
+
+<%- if @locations.empty? -%>
+  <p>No matching locations found. Please try again.</p>
+</em></p>
+<%- else -%>
+  <h2><%= controller.searching_by_zip? ? 'Locations nearest' : "#{@locations.size} locations match" -%> "<%= params[:criteria] -%>"</h2>
+
+  <%- for @location in @locations -%>
+    <%= render 'shared/location' -%>
+  <%- end -%>
+<%- end -%>
+
+<br style="clear: both;" />
+
+<%= render :partial => 'shared/map', :locals => {:locations => @locations, :place => Locale.us.first} -%>
+
+<script type="text/javascript">
+  initializeMap();
+
+  $('search-form').addEventListener('submit', function (e) {
+    window.location = '<%= directory_search_root_url -%>/' + $('search-input').value;
+  }, false);
+</script>

data/app/views/directory/show.html.erb

@@ -0,0 +1,32 @@
+<div id="map_canvas" style="border: solid black 1px; width: 100%; height: 300px"></div><br />
+
+<%= render 'search_form' -%>
+
+<div id="directions_panel" style="margin-bottom: 1em;"></div>
+
+<%- if Locale.count <= 1 -%>
+  <%- set_title 'Location Directory' -%>
+
+  <p>No locations found. Why don't you <%= link_to 'import', import_locations_path -%> some?</p>
+<%- else -%>
+  <%- if @locale.location? -%>
+    <%= render :partial => 'show_location' -%>
+  <%- else -%>
+    <%= render :partial => 'show_children' -%>
+  <%- end -%>
+<%- end -%>
+
+<br style="clear: both;" />
+
+<%= render :partial => 'shared/map', :locals => {:locations => @locale.locations, :place => @locale.root? ? Locale.us.first : @locale} -%>
+
+<script type="text/javascript">
+  initializeMap();
+
+  // change search-form's action so its query string can be converted to a URL
+  $('search-form').action = 'javascript:return(false);';
+
+  $('search-form').addEventListener('submit', function (e) {
+    window.location = '<%= directory_search_root_url -%>/' + $('search-input').value;
+  }, false);
+</script>

data/app/views/layouts/application.html.erb

@@ -0,0 +1,49 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <title><%= yield(:title) -%></title>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+    <meta name="description" content="" />
+    <meta name="keywords" content="" />
+    <link rel="canonical" href="<%= request.url -%>" />
+    <link rel="shortcut icon" href="/favicon.ico" />
+    <%= stylesheet_link_tag 'core', 'application', :cache => true -%>
+    <!--[if IE]>
+      <%= stylesheet_link_tag 'core_ie', :media => :all -%>
+    <![endif]-->
+    <%= javascript_include_tag :defaults, :cache => true -%>
+    <%= csrf_meta_tag -%>
+  </head>
+  <body>
+    <div id="container">
+      <div id="header">
+        <div id="branding"></div>
+        <div id="navigation"><%= render :partial => 'shared/nav_tabs' -%></div>
+      </div>
+      <div id="page_header">
+        <h1><%= yield(:page_title) -%></h1>
+        <div id="breadcrumbs"><%= breadcrumbs -%></div>
+      </div>
+      <div id="content_area">
+      <div id="washout" style="display:none;"></div>
+
+      <%- flash.each do |name, msg| -%>
+        <%- if name == :notice -%>
+          <%= content_tag :div, msg, :id => "flash_#{name}", :class => "flash_#{name}", :style => "display:none;" -%>
+           <script type="text/javascript">
+            $('washout').toggle();
+            $('flash_notice').toggle();
+            <%= visual_effect(:fade, 'flash_notice', :duration => 1.0, :delay => 1.0).html_safe -%>
+            <%= visual_effect(:fade, 'washout', :duration => 1.0, :delay => 1.0).html_safe -%>
+          </script>
+        <%- else -%>
+          <%= content_tag :div, msg, :id => "flash_#{name}", :class => "flash_#{name}" -%>
+        <%- end -%>
+      <%- end -%>
+        <%= yield -%>
+        <br style="clear: both;" />
+      </div>
+      <div id="footer"><p>&copy; <%= Time.zone.now.year -%> SEO Logic. All rights reserved.</p></div>
+    </div>
+  </body>
+</html>

data/app/views/locations/_form.html.erb

@@ -0,0 +1,69 @@
+<%= form_for(@location) do |f| -%>
+  <%- if @location.errors.any? -%>
+    <div id="error_explanation">
+      <h2>Please correct the following errors:</h2>
+      <%- @location.errors.to_a.in_groups(2, false).each do |group| -%>
+      <ul>
+        <%- group.each do |msg| -%>
+        <li><%= msg -%></li>
+        <%- end -%>
+      </ul>
+      <%- end -%>
+      <br style="clear: both;" />
+    </div>
+    <br style="clear: both;" />
+  <%- end -%>
+
+  <fieldset class="form_container">
+    <%= legend_tag 'About This Location' -%>
+    <div class="form_column">
+      <%= f.text_field :name -%>
+      <%= f.check_box :active, :inline_label => 'Yes' -%>
+    </div>
+
+    <div class="form_column">
+      <div id="map_canvas" style="border: solid black 1px; width: 100%; height: 200px"></div>
+    </div>
+  </fieldset>
+
+  <fieldset class="form_container">
+    <%= legend_tag 'Address' -%>
+    <div class="form_column">
+      <%= f.text_field :address1 -%>
+      <%= f.text_field :address2 -%>
+      <%= f.text_field :city -%>
+      <%= f.text_field :state -%>
+      <%= f.text_field :zip -%>
+    </div>
+    <div class="form_column">
+      <%= f.text_field :phone -%>
+      <%= f.text_field :fax -%>
+      <%= f.text_field :email -%>
+    </div>
+  </fieldset>
+
+  <fieldset class="form_container">
+    <%= legend_tag 'Services Offered' -%>
+    <%- i = 0 -%>
+    <%- Service.all.to_a.in_groups(2, false) do |column| -%>
+      <div class="form_column">
+        <%- column.each do |service| -%>
+          <fieldset>
+            <%= check_box_tag 'location[service_ids][]', service.id, @location.services.include?(service), :id => "service_#{i}" -%>
+            <%= service.name -%>
+          </fieldset>
+          <%- i += 1 -%>
+        <%- end -%>
+      </div>
+    <%- end -%>
+  </fieldset>
+
+<%= f.submit 'Save', :class => 'button' -%>
+  <%= link_to 'Cancel', @location, :class => 'button' -%>
+<%- end -%>
+
+<%= render :partial => 'shared/map', :locals => {:place => @location.locale} -%>
+
+<script type="text/javascript">
+  initializeMap();
+</script>

data/app/views/locations/edit.html.erb

@@ -0,0 +1,3 @@
+<%- set_title "Editing #{@location.name}" -%>
+
+<%= render :partial => 'form' -%>

data/app/views/locations/export.erb

@@ -0,0 +1,4 @@
+Location #	Name	Address 1	Address 2	City	State	Postal Code	Country Code	Phone	Email	Description
+<%- @locations.each do |l| -%>
+<%= l.location_number -%>	<%= l.name -%>	<%= l.address1 -%>	<%= l.address2 -%>	<%= l.city -%>	<%= l.state -%>	<%= l.zip -%>	<%= l.country -%>	<%= l.phone -%>	<%= l.email -%>	<%= l.meta_description %>
+<%- end -%>

data/app/views/locations/import.html.erb

@@ -0,0 +1,13 @@
+<%- set_title 'Import Locations' -%>
+
+<%= form_tag upload_locations_path, :method => :post, :multipart => true do -%>
+  <fieldset class="form_container">
+    <p>To import locations, upload the import file below. Make sure the file follows this <%= link_to 'format', '/sample-locations.xls' -%>: it must be tab-delimited and the column names must match exactly. Otherwise, your data won't be processed correctly.</p>
+
+    <fieldset>
+      <%= file_field 'upload', 'datafile' -%>
+    </fieldset>
+  </fieldset>
+
+  <%= submit_tag 'Upload', :class => 'button' -%>
+<%- end -%>

data/app/views/locations/index.html.erb

@@ -0,0 +1,37 @@
+<%- set_title 'Locations' -%>
+
+<%- unless @errors.blank? -%>
+  <%= @errors * '<br />' -%>
+<%- end -%>
+
+<%- if @locations.empty? -%>
+  <p><em>No locations found. Why don't you <%= link_to 'import', import_locations_path -%> some?
+</em></p>
+<%- else -%>
+  <table class="standard">
+    <tr>
+      <th><%= sort_link('locations', 'location_number', params) -%></th>
+      <th><%= sort_link('locations', 'name', params) -%></th>
+      <th>Address</th>
+      <th>URL</th>
+      <th> </th>
+    </tr>
+
+  <%- for location in @locations -%>
+    <tr class="<%= cycle('odd', 'even') -%>">
+      <td><%= link_to location.location_number, location -%></td>
+      <td><%= link_to location.name, location -%></td>
+      <td><%= location.geocoding_address -%></td>
+      <td>
+        <%- if location.locale -%>
+          <%= link_to location.locale.to_url, location.locale.to_url -%>
+        <%- end -%>
+      </td>
+      <td class="crud_links"><%= crud_links(location, [:show, :edit, :destroy]) -%></td>
+    </tr>
+  <%- end -%>
+  </table>
+<%- end -%>
+
+<%= link_to 'Import', import_locations_path, :class => 'button' -%>
+<%= link_to 'Export', export_locations_path, :class => 'button' -%>

data/app/views/locations/new.html.erb

@@ -0,0 +1,3 @@
+<%- set_title 'Create a New Location' -%>
+
+<%= render :partial => 'form' -%>