geo_seeder 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # GeoSeeder
 
-Seed your test database with real addresses for those apps that impliment maping and/or other location features.
+Seed your test database with real addresses for apps that rely on geo data for mapping and/or other location features.
 
 ## Installation
 
@@ -17,9 +17,59 @@ Or install it yourself as:
     $ gem install geo_seeder
 
 ## Usage
+PLEASE NOTE: GeoSeeder employs Google Maps' Geocoder API. If you're going to be making a large number of requests (one request per GeoSeeder::Location object retured), please register your app with google and obtain an api key. I suggest using [figaro](https://github.com/laserlemon/figaro) to manage your keys. Add this your applicaton.yml:
+```yaml
+GOOGLE_KEY: "YOUR_GOOGLE_API_KEY"
+```
+### Random Addresses
+Call GeoSeeder::Location.random to get a random an array of GeoSeeder::Location objects. The random method takes center (address_string) radius (in miles) and a quantity.
 
-TODO: Write usage instructions here
+In your seed.rb:
+```ruby
+locations = GeoSeeder.random({
+  center: "10003", 
+  radius: 2, 
+  quantity: 50
+})
 
+locations.each do |location|
+  Event.create!(
+    name: Faker::Name.name,
+    email: Faker::Email.email,
+    street: location.street_number + location.street,
+    city: location.city,
+    state: location.state,
+    zip: location.zip_code
+  )
+end
+```
+### Setting Coordinates
+If you have models that require lat/lng attributes you could use GeoSeeder in a before_validation like so:
+```ruby
+before_validation :set_coordinates
+
+def set_coordinates
+  address_string = [street, city, state].join(", ") 
+    # => "123 Fake Street, Springfield, IL"
+  
+  location = GeoSeeder::Location.latlng(address_string)
+    # => #<GeoSeeder::Location:0x007f8771311028>
+  
+  if location.lat && location.lng
+    lat, lng = location.lat, location.lng
+  else
+    errors[:base] << "Unable to determine geo data based on provided address."
+  end
+end
+```
+
+### Finding Addresses
+If you're starting with a geometric location, perhaps provided by a mobile device, you can user GeoSeeder to return a street address:
+```ruby
+location = GeoSeeder::Location.address([40.7492998, -73.8888135])
+location.formatted_address
+# => "77-11 37th Avenue, Jackson Heights, NY 11372"
+```
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/geo_seeder/fork )

data/lib/geo_seeder/version.rb

@@ -1,3 +1,3 @@
 module GeoSeeder
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/geo_seeder.rb

@@ -3,48 +3,6 @@ require "addressable/uri"
 require "rest_client"
 require "json"
 
-
-# What do I want to be able to do?
-# 
-# In seed file i want to be able to do 
-# 
-# locations = GeoSeeder.random({
-#   center: "10003", 
-#   radius: 2, 
-#   quantity: 50
-# })
-# 
-# locations.each do |location|
-#   Event.create!(
-#     name: Faker::Name.name,
-#     email: Faker::Email.email,
-#     street: location.street_number + location.street,
-#     city: location.city,
-#     state: location.state,
-#     zip: location.zip_code
-#   )
-# end
-# 
-# 
-# In a model I want to be able to use it for before validation
-# 
-# before_validation :set_coordinates
-# 
-# def set_coordinates
-#   address_string = [street, city, state].join(", ") 
-#     => "123 Fake Street, Springfield, IL"
-#   
-#   location = GeoSeeder::Location.latlng(address_string)
-#     => #<GeoSeeder::Location:0x007f8771311028>
-#   
-#   if location.lat && location.lng
-#     lat, lng = location.lat, location.lng
-#   else
-#     errors[:base] << "Unable to determine geo data based on provided address."
-#   end
-# end
-
-
 module GeoSeeder
   class Location
     
@@ -89,18 +47,25 @@ module GeoSeeder
     end
     
     def all
-      {
-        formatted_address: self.formatted_address,
-        lat: self.lat,
-        lng: self.lng,
-        number: self.number,
-        street: self.street,
-        city: self.city,
-        county: self.county,
-        state: self.state,
-        country: self.country,
-        zip_code: self.zip_code
+      addr_hash = {
+        formatted_address: formatted_address,
+        lat: lat,
+        lng: lng,
+        street_number: street_number,
+        street: street,
+        city: city,
+        county: county,
+        state: state,
+        state_abrv: state_abrv,
+        country: country,
+        zip_code: zip_code
       }
+      
+      if neighborhood
+        addr_hash[:neighborhood] = neighborhood
+      end
+      
+      addr_hash
     end
     
     def self.random(defaults = {})
@@ -116,15 +81,13 @@ module GeoSeeder
       diff = options[:radius] * 1.0 / 70.0
       
       results = []
-      i = 0
+      
       while results.count < options[:quantity]
         rand_lat = (center_lat + rand(-diff..diff)).round(7)
         rand_lng = (center_lng + rand(-diff..diff)).round(7)
         
         rand_address = address([rand_lat, rand_lng])
         
-        puts i
-        i += 1
         if rand_address && rand_address.street_number
           results << rand_address
         end
@@ -135,7 +98,6 @@ module GeoSeeder
     
     def self.address(latlng)
       response = api_request({latlng: latlng})
-      puts response.first
       response.count > 0 ? GeoSeeder::Location.new(response.first) : nil
     end
     
@@ -144,6 +106,7 @@ module GeoSeeder
       response.count > 0 ? GeoSeeder::Location.new(response.first) : nil
     end
     
+    protected
     def self.api_request(options = {})
       # options must either contain an address string or a latlng array
       if options[:latlng]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geo_seeder
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: