peripatetic 0.0.1 → 0.0.2

data/README.md

@@ -1,8 +1,17 @@
-# Peripatetic
+Peripatetic
+This gem adds location functionality to any app it create 3 tables in the database (locations, countries, and postal_codes) and populates countries and postal_codes from a compressed yaml file. One may specify wether it be has_one or has_many. The countries and postal_codes table are just look up tables. in the form partial the gem guesses the country and zip code from the ip and fills it in. If it takes too long or the data is not there it doesn't populate it. The country table has a position field which you can use to order the countries. If a user adds a street address then it geocodes it and adds the updated lat lng to the locations table.
 
-TODO: Write a gem description
+the postal codes are from geonames and the f
 
-## Installation
+countries db is from https://github.com/hexorx/countries
+the postal_codes db is from http://download.geonames.org/export/dump/ and http://federalgovernmentzipcodes.us/
+
+The US postal_codes lat and lng columns have been recently updated.
+
+
+Drop in Location for any model has_one or has_many, creates a nested association and allows you to drop into your form a partial
+
+Installation:
 
 Add this line to your application's Gemfile:
 
@@ -16,9 +25,29 @@ Or install it yourself as:
 
     $ gem install peripatetic
 
-## Usage
+Usage:
+
+Add include Peripatetic to the model you want locations
+then just drop in nested form into the form
+
+<%= f.fields_for peripatetic_locations(model, number_of_times_to_build) do |builder| %><br>
+  <% if builder.object.new_record? %><br>
+    <%= builder.hidden_field :ip, :value => ip_address %><br>
+  <div class="field">
+    <%= builder.label :street %><br />
+    <%= builder.text_field :street %>
+  </div>
+  <div class="field">
+    <%= builder.label :accessor_postal_code, "Postal Code" %><br />
+    <%= builder.text_field :accessor_postal_code, :value => get_accessor_postal_code(builder.object)[:postal_code] %>
+  </div>
+  <div class="field">
+    <%= builder.label :accessor_country, "Country" %><br />
+    <%= builder.country_select :accessor_country, get_accessor_postal_code(builder.object)[:country] %>
+  </div>
+  <% end %><br>
+<% end %><br>
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/generators/db/create_countries.rb

@@ -0,0 +1,31 @@
+class CreateCountries < ActiveRecord::Migration
+  def change
+    create_table :countries do |t|
+      t.string :name
+      t.string :continent
+      t.string :alpha2
+      t.string :alpha3
+      t.string :country_code
+      t.string :currency
+      t.string :international_prefix
+      t.string :ioc
+      t.float :latitude
+      t.float :longitude
+      t.string :names
+      t.string :national_destination_code_lengths
+      t.string :national_number_lengths
+      t.string :national_prefix
+      t.string :number
+      t.string :region
+      t.string :subregion
+      t.string :un_locode
+      t.string :languages
+      t.string :nationality
+      t.string :address_format
+      t.string :alt_currency
+      t.integer :position
+      t.timestamps
+    end
+    add_index :countries, :name, :position
+  end
+end

data/lib/generators/db/create_locations_table.rb

@@ -0,0 +1,20 @@
+class CreateLocations < ActiveRecord::Migration
+  def change
+    create_table :locations do |t|
+      t.string :street
+      t.string :city
+      t.string :region
+      t.string :region_code
+      t.string :postal_code
+      t.string :country
+      t.string :country_code
+      t.float :latitude
+      t.float :longitude
+      t.string :locationable_type
+      t.integer :locationable_id
+      t.boolean :geocoded
+      t.integer :country_id
+      t.timestamps
+    end
+  end
+end

data/lib/generators/db/create_postal_codes_table.rb

@@ -0,0 +1,19 @@
+class CreatePostalCode < ActiveRecord::Migration
+  def change
+    create_table :postal_codes do |t|
+      t.string :name
+      t.string :city
+      t.string :region
+      t.string :region_code
+      t.string :country_code
+      t.float :latitude
+      t.float :longitude
+      t.boolean :geocoded
+      t.string :time_zone
+      t.integer :country_id
+      t.timestamps
+    end
+    add_index :postal_codes, :country_code
+    add_index :postal_codes, :name
+  end
+end

data/lib/generators/rake/dump_and_load.rake

@@ -0,0 +1,60 @@
+##### JSON
+desc 'Dump a database to yaml fixtures. '
+task :dump_fixtures => :environment do
+  path = ENV['FIXTURE_DIR'] || "#{Rails.root}/data"
+
+  ActiveRecord::Base.establish_connection(Rails.env.to_sym)
+  ActiveRecord::Base.connection.tables.each do |table_name|
+    if table_name == "postal_codes"
+      i = 0
+      File.open("#{path}/#{table_name}.json", 'wb') do |file|
+        file.write ActiveRecord::Base.connection.
+            select_all("SELECT * FROM #{table_name}").inject({}) { |hash, record|
+        hash["#{table_name}_#{i += 1}"] = record
+          hash
+        }.to_json
+      end
+    end
+  end
+end
+
+desc "Reset Database data to that in fixtures that were dumped"
+task :load_dumped_fixtures => :environment do
+  require 'active_record/fixtures'
+  ActiveRecord::Base.establish_connection(Rails.env.to_sym)
+  path = ENV['FIXTURE_DIR'] || "#{Rails.root}/data"
+  Dir.glob("#{path}/*.{json}").each do |fixture_file|    
+    ActiveRecord::Fixtures.create_fixtures(path, File.basename(fixture_file, '.*'))
+  end
+end
+
+##### YAML
+task :dump_fixtures_yaml => :environment do
+  path = ENV['FIXTURE_DIR'] || "#{Rails.root}/data"
+
+  ActiveRecord::Base.establish_connection(Rails.env.to_sym)
+  ActiveRecord::Base.connection.tables.each do |table_name|
+    if table_name == "postal_codes" or table_name == "countries"
+      i = 0
+      File.open("#{path}/#{table_name}.yml", 'wb') do |file|
+        file.write ActiveRecord::Base.connection.
+            select_all("SELECT * FROM #{table_name}").inject({}) { |hash, record|
+        hash["#{table_name}_#{i += 1}"] = record
+          hash
+        }.to_yaml
+      end
+    end
+  end
+end
+
+desc "Reset Database data to that in fixtures that were dumped"
+task :load_dumped_fixtures_yaml => :environment do
+  require 'active_record/fixtures'
+  
+  
+  ActiveRecord::Base.establish_connection(Rails.env.to_sym)
+  path = ENV['FIXTURE_DIR'] || "#{Rails.root}/data"
+  Dir.glob("#{path}/*.{yml}").each do |fixture_file|
+    ActiveRecord::Fixtures.create_fixtures(path, File.basename(fixture_file, '.*'))
+  end
+end

data/lib/peripatetic.rb

@@ -1,6 +1,113 @@
 require "peripatetic/version"
 require 'peripatetic/location'
+require 'peripatetic/postal_code'
+require 'peripatetic/country'
 
 module Peripatetic
-  # Your code goes here...
+  def self.included(base)
+    # base.extend(ClassMethods).relate
+    base.extend ClassMethods
+
+    base.class_eval do
+      attr_accessible :locations_attributes #, :location_attributes
+      has_many :locations, :as => :locationable, :class_name => "Peripatetic::Location"
+      accepts_nested_attributes_for :locations, :reject_if => lambda { |a| a[:accessor_postal_code].blank? }, :allow_destroy => true
+      # has_one :location, :as => :locationable, :class_name => "Peripatetic::Location"
+      # accepts_nested_attributes_for :location, :reject_if => lambda { |a| a[:accessor_postal_code].blank? }, :allow_destroy => true
+    end
+    
+  end
+  
+  module ClassMethods
+    # def acts_as_peripatetic
+    #   send :include, Peripatetic
+    # end
+  end
+  
+  module ModelMethods
+  
+  end
+
+  module HelperMethods
+    def nested_form_builder
+    # <%= f.fields_for poly_locations(@user, 1) do |builder| %>
+    #   <% if builder.object.new_record? %>
+    #     <%= builder.hidden_field :ip, :value => ip_address %>
+    #   <div class="field">
+    #     <%= builder.label :street %><br />
+    #     <%= builder.text_field :street %>
+    #   </div>
+    #   <div class="field">
+    #     <%= builder.label :accessor_postal_code, "Postal Code" %><br />
+    #     <%= builder.text_field :accessor_postal_code, :value => get_accessor_postal_code(builder.object)[:postal_code] %>
+    #   </div>
+    #   <div class="field">
+    #     <%= builder.label :accessor_country, "Country" %><br />
+    #     <%= builder.country_select :accessor_country, get_accessor_postal_code(builder.object)[:country] %>
+    #   </div>
+    #   <% end %>
+    # <% end %>
+    end
+
+    def all_countries
+      Country.select([:id, :name, :position]).order("position ASC")
+    end
+    
+    def ip_address
+      (Rails.env.development? or Rails.env.test?) ? '206.127.79.163' : (env['HTTP_X_REAL_IP'] ||= env['REMOTE_ADDR'])
+    end
+
+    def get_country
+      if builder.object.accessor_postal_code.present?
+        @get_country = { :ip => ip_address, :country => builder.object.accessor_country, :postal_code => builder.object.accessor_postal_code }
+      else
+        res = Geocoder.search(ip_address)
+        if res.first
+          @get_country = { :ip => ip_address, :country => res.first.country, :postal_code => res.first.postal_code }
+        end
+      end
+    end
+    
+    def get_accessors(model)
+      @get_accessors ||= get_accessor_postal_code(model)
+    end
+
+    def get_accessor_postal_code(model)
+      # return unless @get_accessor_postal_code.blank?
+      if model.postal_code.blank?
+        res = Geocoder.search(ip_address)
+        if res.first
+          country = Country.select([:id, :name, :position]).find_by_name(res.first.country)
+          if country.present?
+            country_id = country.id
+          else
+            country_id = Country.select([:id, :name, :position]).find_by_name("United States").id
+          end
+          model.country_id = country_id
+          @get_accessor_postal_code = { :ip => ip_address, :postal_code => res.first.postal_code }
+        else
+          @get_accessor_postal_code = { :ip => ip_address, :postal_code => "" }
+        end
+      else
+        @get_accessor_postal_code = { :ip => ip_address, :postal_code => model.postal_code }
+      end
+    end
+
+    def peripatetic_locations(model, amount=false)
+      if amount == false
+        # user.build_profile  # this will work
+        model.build_location 
+        :location
+      else
+        amount.times { model.locations.build } if model.new_record?
+        :locations
+      end
+    end
+  end
+
 end
+
+ActionView::Base.send :include, Peripatetic::HelperMethods
+# class ActiveRecord::Base
+#   include Peripatetic
+# end

data/lib/peripatetic/country.rb

@@ -0,0 +1,8 @@
+module Peripatetic
+
+  class Country < ActiveRecord::Base
+    attr_accessible :name
+    has_many :postal_codes
+  end
+
+end

data/lib/peripatetic/location.rb

@@ -0,0 +1,121 @@
+require 'geocoder'
+module Peripatetic
+
+  class Location < ActiveRecord::Base
+    attr_accessible :latitude, :longitude, :street, :accessor_country, :accessor_postal_code, :time_zone, :ip, :country_id
+    attr_accessor :accessor_country, :accessor_postal_code, :ip
+
+    belongs_to :locationable, :polymorphic => true
+    belongs_to :country
+    # belongs_to :postal_code
+    
+    Geocoder.configure(:timeout => 1) 
+    reverse_geocoded_by :latitude, :longitude
+    geocoded_by :location_attributes_available do |obj, results|
+      puts "Geocoding Yo!"
+      if geo = results.first
+        obj.latitude = geo.latitude if geo.latitude
+        obj.longitude = geo.longitude if geo.longitude
+        if geo.state.present? and geo.state_code.present?
+          obj.region = geo.state
+        end
+        obj.city = geo.city.downcase if geo.city.present?
+        obj.geocoded = true
+      end
+    end
+    # after_validation :geocode, :if => :street_or_postal_code_changed?
+    
+    after_validation :geocode,              :if     => :street_present_or_changed?
+    after_validation :inject_location_info
+    
+    
+    validate :validate_postal_code
+    def validate_postal_code
+      return unless postal_code_changed? and postal_code.present?
+      if PostalCode.find_by_postal_code_and_country_code(accessor_postal_code, country.alpha2).present?
+        true
+      else
+        errors.add(:postal_code, "appears to be invalid") 
+        false
+      end
+    end
+
+    def street?
+      street.present?
+    end
+
+    def city?
+      city.present?
+    end
+
+    def postal_code?
+      postal.present?
+    end
+
+    def accessor_postal_code?
+      accessor_postal_code.present?
+    end
+
+    def region?
+      region.present?
+    end
+
+    def accessor_country?
+      accessor_country.present?
+    end
+
+    def inject_location_info
+      # p_c = Peripatetic::PostalCode.find_by_postal_code_and_country_code("59601", (Peripatetic::Country.find(231).alpha2))
+      # p_c = Peripatetic::PostalCode.find_by_postal_code_and_country_code("59601", "US")
+      p_c = PostalCode.find_by_postal_code_and_country_code(accessor_postal_code, (country.alpha2))
+      puts "almost injecting"
+      return unless postal_code_changed? or self.new_record?
+      puts "injecting"
+      self.postal_code = p_c.postal_code
+      self.city = p_c.city
+      self.region = p_c.region
+      self.country_code = p_c.country_code
+      self.time_zone = p_c.time_zone unless p_c.time_zone == "f" 
+      self.latitude = p_c.latitude
+      self.longitude = p_c.longitude
+    end
+    
+    def street_present_or_changed?
+      return true if street_changed? and street.present?
+    end
+
+    def fill_in_city_region_postal_code
+    end
+    
+    def location_attributes_available
+      if street? and accessor_postal_code?
+        "#{street} #{accessor_postal_code} #{accessor_country}"
+      elsif accessor_postal_code?
+        "#{accessor_postal_code} #{accessor_country}"
+      elsif accessor_country?
+        accessor_country
+      else
+        ip
+      end
+    end
+
+    def get_time_zone
+      # latitude = l.latitude
+      # longitude = l.longitude
+      url = "http://api.geonames.org/timezone?lat=#{latitude}&lng=#{longitude}&username=davinjay"
+      doc = Nokogiri::HTML(open(url))
+      doc.search("timezoneid").first.children.first.to_s
+      # self.postal_code.time_zone = self.time_zone
+      # self.postal_code.save
+    end
+
+    def city_address
+      "#{city} #{region}"
+    end
+
+    def full_address
+      ("#{street} #{city} #{region} #{postal}").chomp
+    end
+
+  end
+end

data/lib/peripatetic/peripateticize.rb

@@ -0,0 +1,85 @@
+# require "peripatetic/version"
+# require 'peripatetic/location'
+# require 'peripatetic/city'
+# require 'peripatetic/country'
+# require 'peripatetic/postal_code'
+# require 'peripatetic/region'
+# 
+# module Peripatetic
+#   
+#   module ClassMethods
+#     def peripateticize
+#     end
+#     # def acts_as_peripatetic
+#     #   send :include, Peripatetic
+#     # end
+#   end
+#   
+#   module ModelMethods
+#   
+#   end
+# 
+#   module HelperMethods
+#     def nested_form_builder
+#     # <%= f.fields_for poly_locations(@user, 1) do |builder| %>
+#     #   <% if builder.object.new_record? %>
+#     #     <%= builder.hidden_field :ip, :value => ip_address %>
+#     #   <div class="field">
+#     #     <%= builder.label :street %><br />
+#     #     <%= builder.text_field :street %>
+#     #   </div>
+#     #   <div class="field">
+#     #     <%= builder.label :accessor_postal_code %><br />
+#     #     <%= builder.text_field :accessor_postal_code, :value => get_accessor_postal_code(builder.object)[:postal_code] %>
+#     #   </div>
+#     #   <div class="field">
+#     #     <%= builder.label :accessor_country %><br />
+#     #     <%= builder.country_select :accessor_country, get_accessor_postal_code(builder.object)[:country] %>
+#     #   </div>
+#     #   <% end %>
+#     # <% end %>
+#     end
+# 
+#     def ip_address
+#       (Rails.env.development? or Rails.env.test?) ? '206.127.79.163' : (env['HTTP_X_REAL_IP'] ||= env['REMOTE_ADDR'])
+#     end
+# 
+#     def get_country
+#       # Geokit::Geocoders::google = "AIzaSyAi43R79isU8MeS7ISBxAdUUe2phnoxpoM"
+#       # res = GeoKit::Geocoders::IpGeocoder.geocode(ip_address)
+#       # if res.success
+#       #   res.country
+#       #   res.country_code
+#       #   # get_country = {:country => res.country, :country_code => res.country_code}
+#       # end
+#       res = Geocoder.search(ip_address)
+#       if res.first
+#         @get_country = { :ip => ip_address, :country => res.first.country, :postal_code => res.first.postal_code }
+#       end
+#     end
+# 
+#     def get_accessor_postal_code(model)
+#       if model.postal_code.blank?
+#         res = Geocoder.search(ip_address)
+#         if res.first
+#           @get_accessor_postal_code = { :ip => ip_address, :country => res.first.country, :postal_code => res.first.postal_code }
+#         end
+#       else
+#         @get_accessor_postal_code = { :ip => ip_address, :country => model.postal_code.country_name, :postal_code => model.postal_code.name }
+#       end
+#     end
+# 
+#     def poly_locations(model, amount=false)
+#       if amount == false
+#         model.build_location 
+#       else
+#         amount.times { model.locations.build }
+#       end
+#       :locations
+#     end
+#   end
+# end
+# ActionView::Base.send :include, Peripatetic::HelperMethods
+# 
+# module Peripatetic::ActiveRecord
+# end