geo_seeder 0.0.3 → 1.0.0

data/README.md

@@ -17,12 +17,12 @@ 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:
+PLEASE NOTE: GeoSeeder employs Google Maps' Geocoder API. If you're going to be making a large - >1000 - number of requests (one request is made 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.
+Call GeoSeeder::Location.random to get an array of random GeoSeeder::Location objects. The random method takes center (address_string) radius (in miles) and a quantity as options.
 
 In your seed.rb:
 ```ruby
@@ -70,6 +70,11 @@ location = GeoSeeder::Location.address([40.7492998, -73.8888135])
 location.formatted_address
 # => "77-11 37th Avenue, Jackson Heights, NY 11372"
 ```
+
+### Comming Soon!
+* .all instance method - returns a hash containing all of a locations object's attributes. 
+* output option - call any class method with the option - output: ["attribute1", "attribute2", ...] - and it will return a hash/array of hashes with only those attributes, all ready for your merging pleasure.
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/geo_seeder/fork )

data/geo_seeder.gemspec

@@ -6,7 +6,7 @@ require 'geo_seeder/version'
 Gem::Specification.new do |spec|
   spec.name          = "geo_seeder"
   spec.version       = GeoSeeder::VERSION
-  spec.authors       = ["paris"]
+  spec.authors       = ["Paris Yee"]
   spec.email         = ["paris.yee@gmail.com"]
   spec.summary       = %q{Provides real addresses for populating models/databases.}
   spec.description   = %q{Provides real addresses for populating models/databases.}
@@ -16,7 +16,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "addressable"
   spec.add_runtime_dependency "rest-client"
   spec.add_runtime_dependency "json"
-  spec.add_runtime_dependency "rails"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/geo_seeder/version.rb

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

data/lib/geo_seeder.rb

@@ -38,6 +38,8 @@ module GeoSeeder
           @zip_code = ln
         elsif types.include?("neighborhood")
           @neighborhood = ln
+        elsif types.include?("country")
+          @country = ln
         end
       end
     end
@@ -47,23 +49,12 @@ module GeoSeeder
     end
     
     def all
-      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
-      }
+      addr_hash = {}
       
-      if neighborhood
-        addr_hash[:neighborhood] = neighborhood
-      end
+      instance_variables.each do |iv|
+        variable = iv.to_s[1..-1]
+        addr_hash[variable.to_sym] = eval("self.#{variable}")
+      end  
       
       addr_hash
     end
@@ -98,12 +89,17 @@ module GeoSeeder
     
     def self.address(latlng)
       response = api_request({latlng: latlng})
-      response.count > 0 ? GeoSeeder::Location.new(response.first) : nil
+      location = response.count > 0 ? GeoSeeder::Location.new(response.first) : nil
+      return nil if location && location.formatted_address == "Foo Bar, San Francisco, CA 94115, USA"
+      # Google returns a dummy address for bad latlng requests.
+      location
     end
     
     def self.latlng(address_string)
       response = api_request({address: address_string})
-      response.count > 0 ? GeoSeeder::Location.new(response.first) : nil
+      location = response.count > 0 ? GeoSeeder::Location.new(response.first) : nil
+      return nil if location && location.formatted_address == "Foo Bar, San Francisco, CA 94115, USA"
+      location
     end
     
     protected
@@ -125,6 +121,7 @@ module GeoSeeder
         :query_values => q_vals
       ).to_s
  
+    
       JSON.parse(RestClient.get(query_string))["results"]
     end
   end

data/spec/geo_seeder_spec.rb

@@ -4,24 +4,93 @@ describe "GeoSeeder" do
   context "Location" do
     
     describe "api_request" do
-      it "should return an array of result hashes" do
-        response = GeoSeeder::Location.api_request({latlng: [40.7493, -71.8888]})
+      it "returns an array of result google address hashes for valid request input" do
+        response = GeoSeeder::Location.api_request({latlng: [40.7492998, -73.8888135]})
         expect(response.is_a?(Array)).to be true
+        expect(response.first.is_a?(Hash)).to be true
+        expect(response.first["formatted_address"]).to match(/NY 11372/)
+      end
+      
+      it "returns an empty array for requests that yield no results" do
+        response = GeoSeeder::Location.api_request({address: "asdfjkhsdf"})
+        expect(response.is_a?(Array)).to be true
+        expect(response).to be_empty
       end
     end
     
     describe "latlng" do
-      it "returns a hash with :lat and :lng keys when called with an address string" do
-        response = GeoSeeder::Location.latlng("77-11 37th Ave, Jackson Heights, NY 11372")
-        expect(response.is_a?(Hash)).to be true
-        expect(response["lat"].to_s).to match(/40.7492/)
-        expect(response["lng"]to_s).to match(/-73.8888/)
+      let(:location) { GeoSeeder::Location.latlng("77-11 37th Ave, Jackson Heights, NY 11372") }
+      
+      it "returns an a Location object" do
+        expect(location.class).to eq(GeoSeeder::Location)
+      end
+      
+      it "returns an object with lat/lng attributes set as floats" do
+        expect(location.lat.class).to eq(Float)
+        expect(location.lng.class).to eq(Float)
+      end
+      
+      it "represent the closest approximation of the provided address (if valid)" do
+        expect(location.formatted_address).to match(/77-11 37th Ave/)
+      end
+      
+      it "retruns nil for invalid input" do
+        bad_location = GeoSeeder::Location.latlng("asdfasdf")
+        expect(bad_location).to be_nil
       end
     end
     
     describe "address" do
-      it "returns the proper address when given an array of latlng floats" do
-        expect(GeoSeeder::Location.address([40.7492998, -73.8888135])).to eq("77-11 37th Ave, Jackson Heights, NY 11372")
+      let(:location) { GeoSeeder::Location.address([40.7307596, -73.9913105]) }
+      
+      it "returns an a Location object" do
+        expect(location.class).to eq(GeoSeeder::Location)
+      end
+      
+      it "returns an object with proper address attributes set" do
+        expect(location.street).not_to be_nil
+        expect(location.city).not_to be_nil
+        expect(location.country).not_to be_nil
+        expect(location.state).not_to be_nil
+        expect(location.zip_code).not_to be_nil
+      end
+      
+      it "retruns nil for invalid input" do
+        bad_location = GeoSeeder::Location.latlng([3441283, 88942838])
+        expect(bad_location).to be_nil
+      end
+    end
+    
+    describe "all" do
+      let(:loc_attrs) { GeoSeeder::Location.latlng("Brooklyn, NY").all }
+      
+      it "returns a hash of all attributes of a location object" do
+        expect(loc_attrs.is_a?(Hash)).to be true
+      end
+      
+      it "only returns hash with keys of instance variables possessed by Location object" do
+        expect(loc_attrs[:city]).to eq("Brooklyn")
+        expect(loc_attrs.has_key?(:street_number)).to be false
+      end
+    end
+    
+    describe "random" do
+      let(:locations) {
+        GeoSeeder::Location.random({
+          center: "54 LeFever Ln, New Paltz, NY 12561",
+          radius: 5,
+          quantity: 3
+        })
+      }
+      
+      it "retruns an array of Location objects of length - quantity" do
+        expect(locations.is_a?(Array)).to be true
+        expect(locations.sample.class).to eq(GeoSeeder::Location)
+        expect(locations.count).to eq(3)
+      end
+      
+      it "only returns objects with full addresses, i.e. only addresses with street_numbers" do
+        expect(locations.all? { |loc| loc.street_number =~ /\d+/}).to be true
       end
     end
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: geo_seeder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
-- paris
+- Paris Yee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -59,22 +59,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement