geocodio-ocd 1.7.0

data/spec/address_set_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Geocodio::AddressSet do
+  let(:geocodio) { Geocodio::Client.new }
+  let(:addresses) do
+    [
+      '1 Infinite Loop Cupertino CA 95014',
+      '54 West Colorado Boulevard Pasadena CA 91105',
+      '826 Howard Street San Francisco CA 94103'
+    ]
+  end
+
+  subject(:address_set) do
+    VCR.use_cassette('batch_geocode') do
+      geocodio.geocode(addresses).last
+    end
+  end
+
+  it 'has a size' do
+    expect(address_set.size).to eq(4)
+  end
+
+  it 'has a best' do
+    expect(address_set.best).to be_a(Geocodio::Address)
+    expect(address_set.best.accuracy).to eq(1)
+  end
+
+  it 'references the original query' do
+    expect(address_set.query).to eq('826 Howard Street San Francisco CA 94103')
+  end
+end

data/spec/address_spec.rb

@@ -0,0 +1,235 @@
+require 'spec_helper'
+
+describe Geocodio::Address do
+  let(:geocodio) { Geocodio::Client.new }
+  
+  context 'when parsed' do
+    subject(:address) do
+      VCR.use_cassette('parse') do
+        geocodio.parse('54 West Colorado Boulevard Pasadena CA 91105')
+      end
+    end
+
+    it 'has a number' do
+      expect(address.number).to eq('54')
+    end
+
+    it 'has a predirectional' do
+      expect(address.predirectional).to eq('W')
+    end
+
+    it 'has a street' do
+      expect(address.street).to eq('Colorado')
+    end
+
+    it 'has a formatted_street' do
+      expect(address.formatted_street).to eq('W Colorado Blvd')
+    end
+
+    it 'has a suffix' do
+      expect(address.suffix).to eq('Blvd')
+    end
+
+    it 'has a city' do
+      expect(address.city).to eq('Pasadena')
+    end
+
+    it 'has a state' do
+      expect(address.state).to eq('CA')
+    end
+
+    it 'has a zip' do
+      expect(address.zip).to eq('91105')
+    end
+
+    it 'does not have a latitude' do
+      expect(address.latitude).to be_nil
+      expect(address.lat).to      be_nil
+    end
+
+    it 'does not have a longitude' do
+      expect(address.longitude).to be_nil
+      expect(address.lng).to       be_nil
+    end
+
+    it 'does not have an accuracy' do
+      expect(address.accuracy).to be_nil
+    end
+
+    it 'does not have an accuracy_type' do
+      expect(address.accuracy_type).to be_nil
+    end
+  end
+
+  context 'when geocoded' do
+    context 'has predirectional' do
+      subject(:address) do
+        VCR.use_cassette('geocode') do
+          geocodio.geocode(['54 West Colorado Boulevard Pasadena CA 91105']).best
+        end
+      end
+
+      it 'has a number' do
+        expect(address.number).to eq('54')
+      end
+
+      it 'has a predirectional' do
+        expect(address.predirectional).to eq('W')
+      end
+
+      it 'has a street' do
+        expect(address.street).to eq('Colorado')
+      end
+
+      it 'has a formatted_street' do
+        expect(address.formatted_street).to eq('W Colorado Blvd')
+      end
+
+      it 'has a suffix' do
+        expect(address.suffix).to eq('Blvd')
+      end
+
+      it 'has a city' do
+        expect(address.city).to eq('Pasadena')
+      end
+
+      it 'has a county' do
+        expect(address.county).to eq('Los Angeles County')
+      end
+
+      it 'has a state' do
+        expect(address.state).to eq('CA')
+      end
+
+      it 'has a zip' do
+        expect(address.zip).to eq('91105')
+      end
+
+      it 'has a latitude' do
+        expect(address.latitude).to eq(34.145375)
+        expect(address.lat).to      eq(34.145375)
+      end
+
+      it 'has a longitude' do
+        expect(address.longitude).to eq(-118.151622)
+        expect(address.lng).to       eq(-118.151622)
+      end
+
+      it 'has an accuracy' do
+        expect(address.accuracy).to eq(1)
+      end
+
+      it 'has an accuracy_type' do
+        expect(address.accuracy_type).to eq("rooftop")
+      end
+      
+      it 'has a source' do
+        expect(address.source).to eq("Los Angeles")
+      end
+    end
+
+    context 'has postdirectional' do
+      subject(:address) do
+        VCR.use_cassette('geocode_with_postdirectional') do
+          geocodio.geocode(['1600 Pennsylvania Ave NW Washington DC 20500']).best
+        end
+      end
+
+      it 'has a number' do
+        expect(address.number).to eq('1600')
+      end
+
+      it 'has a street' do
+        expect(address.street).to eq('Pennsylvania')
+      end
+
+      it 'has a formatted_street' do
+        expect(address.formatted_street).to eq('Pennsylvania Ave NW')
+      end
+
+      it 'has a postdirectional' do
+        expect(address.postdirectional).to eq('NW')
+      end
+
+      it 'has a suffix' do
+        expect(address.suffix).to eq('Ave')
+      end
+
+      it 'has a city' do
+        expect(address.city).to eq('Washington')
+      end
+
+      it 'has a county' do
+        expect(address.county).to eq('District of Columbia')
+      end
+
+      it 'has a state' do
+        expect(address.state).to eq('DC')
+      end
+
+      it 'has a zip' do
+        expect(address.zip).to eq('20500')
+      end
+
+      it 'has a latitude' do
+        expect(address.latitude).to eq(38.897675)
+        expect(address.lat).to      eq(38.897675)
+      end
+
+      it 'has a longitude' do
+        expect(address.longitude).to eq(-77.036547)
+        expect(address.lng).to       eq(-77.036547)
+      end
+
+      it 'has an accuracy' do
+        expect(address.accuracy).to eq(1)
+      end
+
+      it 'has an accuracy_type' do
+        expect(address.accuracy_type).to eq("rooftop")
+      end
+    end
+
+    context 'with additional fields' do
+      subject(:address) do
+        VCR.use_cassette('geocode_with_fields') do
+          geocodio.geocode(['54 West Colorado Boulevard Pasadena CA 91105'], fields: %w[cd118 stateleg-next school timezone]).best
+        end
+      end
+
+      it 'has congressional districts' do
+        address.congressional_districts.each do |district|
+          expect(district).to be_a(Geocodio::CongressionalDistrict)
+        end
+      end
+
+      it 'has house districts' do
+        expect(address.house_districts).to be_a(Array)
+        expect(address.house_districts.size).to eq(1)
+        expect(address.house_districts.first).to be_a(Geocodio::StateLegislativeDistrict)
+      end
+
+      it 'has senate districts' do
+        expect(address.senate_districts).to be_a(Array)
+        expect(address.senate_districts.size).to eq(1)
+        expect(address.senate_districts.first).to be_a(Geocodio::StateLegislativeDistrict)
+      end
+
+      it 'has a unified school district' do
+        expect(address.unified_school_district).to be_a(Geocodio::SchoolDistrict)
+      end
+
+      it 'could have an elementary school district' do
+        expect(address.elementary_school_district).to be_nil
+      end
+
+      it 'could have a secondary school district' do
+        expect(address.secondary_school_district).to be_nil
+      end
+
+      it 'has a timezone' do
+        expect(address.timezone).to be_a(Geocodio::Timezone)
+      end
+    end
+  end
+end

data/spec/canadian_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Geocodio::Canadian do
+  let(:geocodio) { Geocodio::Client.new }
+  
+  subject do
+    VCR.use_cassette('canadian') do
+      geocodio.geocode([
+        '1 Infinite Loop Cupertino CA 95014',
+        '356 Yonge St, Toronto, ON M5G, Canada',
+        '3475 Bd Sainte-Anne, Beauport, QC G1E 3L5, Canada'
+      ], fields: %w[timezone cd118 provriding riding stateleg-next]).map(&:best)
+    end
+  end
+
+  let(:us_address)   { subject[0] }
+  let(:ca_en_address){ subject[1] }
+  let(:ca_fr_address){ subject[2] }
+
+  it 'is a canadian address' do
+    expect(ca_en_address).to be_canadian
+    expect(ca_fr_address).to be_canadian
+  end
+  
+  it "isn't a canadian address" do
+    expect(us_address).to_not be_canadian
+    expect(us_address.canadian).to be_nil
+  end
+  
+  it 'has canadian federal electoral district' do
+    expect(ca_en_address.canadian).to_not be_nil
+    expect(ca_en_address.canadian.federal_electoral_district).to_not be_nil
+    
+    federal_district1 = ca_en_address.canadian.federal_electoral_district
+    
+    expect(federal_district1.code).to eq('35110')
+    expect(federal_district1.name_english).to eq('University--Rosedale')
+    expect(federal_district1.name_french).to eq('University--Rosedale')
+    expect(federal_district1.ocd_id).to eq('ocd-division/country:ca/ed:35110-2013')
+    expect(federal_district1.source).to eq('Statistics Canada')
+    
+    expect(ca_fr_address.canadian).to_not be_nil
+    expect(ca_fr_address.canadian.federal_electoral_district).to_not be_nil
+    
+    federal_district2 = ca_fr_address.canadian.federal_electoral_district
+    
+    expect(federal_district2.code).to eq('24008')
+    expect(federal_district2.name_english).to eq('Beauport--Limoilou')
+    expect(federal_district2.name_french).to eq('Beauport--Limoilou')
+    expect(federal_district2.ocd_id).to eq('ocd-division/country:ca/ed:24008-2013')
+    expect(federal_district2.source).to eq('Statistics Canada')    
+  end
+  
+  it 'has canadian provincial electoral district' do
+    expect(ca_en_address.canadian).to_not be_nil
+    expect(ca_en_address.canadian.provincial_electoral_district).to_not be_nil
+    
+    provincial_district1 = ca_en_address.canadian.provincial_electoral_district
+    
+    expect(provincial_district1.name_english).to eq('University - Rosedale')
+    expect(provincial_district1.name_french).to eq('University - Rosedale')
+    expect(provincial_district1.ocd_id).to eq('ocd-division/country:ca/province:on/ed:112-2015')
+    expect(provincial_district1.source).to eq('Elections Ontario')
+    
+    expect(ca_fr_address.canadian).to_not be_nil
+    expect(ca_fr_address.canadian.provincial_electoral_district).to_not be_nil
+    
+    provincial_district2 = ca_fr_address.canadian.provincial_electoral_district
+    
+    expect(provincial_district2.name_english).to eq('Montmorency')
+    expect(provincial_district2.name_french).to eq('Montmorency')
+    expect(provincial_district2.ocd_id).to eq('ocd-division/country:ca/province:qc/ed:742-2017')
+    expect(provincial_district2.source).to eq("Contains open data granted under the Chief Electoral Officer's Open Data User Licence available at http://dgeq.org/en/. The fact of granting the licence in no way implies that the Chief Electoral Officer approves the use made of the open data.")    
+  end
+
+  
+end

data/spec/client_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+
+describe Geocodio::Client do
+  let(:geocodio)    { Geocodio::Client.new }
+  let(:address)     { '54 West Colorado Boulevard Pasadena CA 91105' }
+  let(:coordinates) { '34.145760590909,-118.15204363636' }
+
+  it 'requires an API key' do
+    VCR.use_cassette('invalid_key') do
+      expect { geocodio.geocode([address]) }.to raise_error(Geocodio::Client::Error)
+    end
+  end
+
+  it 'parses an address into components' do
+    VCR.use_cassette('parse') do
+      result = geocodio.parse(address)
+
+      expect(result).to be_a(Geocodio::Address)
+    end
+  end
+
+  it 'sets the read_timeout on the underlying Net::HTTP request if passed an option' do
+    expect_any_instance_of(Net::HTTP).to receive(:read_timeout=).with(60 * 5)
+    VCR.use_cassette('geocode') { geocodio.geocode([address], timeout: 60 * 5) }
+  end
+
+  describe '#geocode' do
+    it 'geocodes a single address' do
+      VCR.use_cassette('geocode') do
+        addresses = geocodio.geocode([address])
+
+        expect(addresses.size).to eq(2)
+        expect(addresses).to be_a(Geocodio::AddressSet)
+      end
+    end
+
+    it 'geocodes a single address with an options hash' do
+      VCR.use_cassette('geocode_with_fields') do
+        addresses = geocodio.geocode([address], fields: %w[cd118 stateleg-next school timezone])
+
+        expect(addresses.size).to eq(2)
+        expect(addresses).to be_a(Geocodio::AddressSet)
+      end
+    end
+
+    it 'raises a client error when geocoding a bad address' do
+      VCR.use_cassette('geocode_bad_address') do
+        expect { geocodio.geocode([' , , ']) }.to raise_error(Geocodio::Client::Error)
+      end
+    end
+
+    it 'geocodes multiple addresses' do
+      VCR.use_cassette('batch_geocode') do
+        addresses = [
+          '1 Infinite Loop Cupertino CA 95014',
+          '54 West Colorado Boulevard Pasadena CA 91105',
+          '826 Howard Street San Francisco CA 94103'
+        ]
+
+        addresses = geocodio.geocode(addresses)
+
+        expect(addresses.size).to eq(3)
+        addresses.each { |address| expect(address).to be_a(Geocodio::AddressSet) }
+      end
+    end
+
+    it 'will return empty AddressSets for bad addresses in a batch geocode' do
+      VCR.use_cassette('batch_geocode_with_bad_address') do
+        addresses = [
+          '1 Infinite Loop Cupertino CA 95014',
+          ' , , '
+        ]
+
+        addresses = geocodio.geocode(addresses)
+
+        expect(addresses.last).to be_empty
+      end
+    end
+
+    it 'geocodes multiple addresses with an options hash' do
+      VCR.use_cassette('batch_geocode_with_fields') do
+        addresses = [
+          '1 Infinite Loop Cupertino CA 95014',
+          '54 West Colorado Boulevard Pasadena CA 91105',
+          '826 Howard Street San Francisco CA 94103'
+        ]
+
+        addresses = geocodio.geocode(addresses, fields: %w[cd118 stateleg-next school timezone])
+
+        expect(addresses.size).to eq(3)
+        addresses.each { |address| expect(address).to be_a(Geocodio::AddressSet) }
+      end
+    end
+  end
+
+  describe '#reverse_geocode' do
+    context 'with a single address' do
+      it 'uses strings' do
+        VCR.use_cassette('reverse') do
+          addresses = geocodio.reverse_geocode([coordinates])
+
+          expect(addresses.size).to eq(13)
+          expect(addresses).to be_a(Geocodio::AddressSet)
+        end
+      end
+
+      it 'handles a response without legislator house info' do
+        VCR.use_cassette('reverse_with_fields_no_house_info') do
+          expect { geocodio.reverse_geocode(["41.25,-96.00"], fields: %w[cd118 stateleg-next school timezone]) }.not_to raise_error(NoMethodError)
+        end
+      end
+
+      it 'uses hashes' do
+        VCR.use_cassette('reverse') do
+          lat, lng = coordinates.split(',')
+          addresses = geocodio.reverse_geocode([{ latitude: lat, longitude: lng }])
+
+          expect(addresses.size).to eq(13)
+          expect(addresses).to be_a(Geocodio::AddressSet)
+        end
+      end
+
+      it 'accepts an options hash' do
+        VCR.use_cassette('reverse_with_fields') do
+          lat, lng = coordinates.split(',')
+          addresses = geocodio.reverse_geocode([{ latitude: lat, longitude: lng} ], fields: %w[cd118 stateleg-next school timezone])
+
+          expect(addresses.size).to eq(13)
+          expect(addresses).to be_a(Geocodio::AddressSet)
+        end
+      end
+    end
+
+    context 'reverse geocoding multiple addresses' do
+      it 'uses strings' do
+        VCR.use_cassette('batch_reverse') do
+          coordinate_pairs = [
+            '37.331669,-122.03074',
+            '34.145760590909,-118.15204363636',
+            '37.7815,-122.404933'
+          ]
+
+          addresses = geocodio.reverse_geocode(coordinate_pairs)
+
+          expect(addresses.size).to eq(3)
+          addresses.each { |address| expect(address).to be_a(Geocodio::AddressSet) }
+        end
+      end
+
+      it 'uses hashes' do
+        VCR.use_cassette('batch_reverse') do
+          coordinate_pairs = [
+            { latitude: 37.331669,       longitude: -122.03074 },
+            { latitude: 34.145760590909, longitude: -118.15204363636 },
+            { latitude: 37.7815,         longitude: -122.404933 }
+          ]
+
+          addresses = geocodio.reverse_geocode(coordinate_pairs)
+
+          expect(addresses.size).to eq(3)
+          addresses.each { |address| expect(address).to be_a(Geocodio::AddressSet) }
+        end
+      end
+
+      it 'uses an arbitrary combination of strings and hashes' do
+        VCR.use_cassette('batch_reverse') do
+          coordinate_pairs = [
+            { latitude: 37.331669, longitude: -122.03074 },
+            '34.145760590909,-118.15204363636',
+            { latitude: 37.7815,   longitude: -122.404933 }
+          ]
+
+          addresses = geocodio.reverse_geocode(coordinate_pairs)
+
+          expect(addresses.size).to eq(3)
+          addresses.each { |address| expect(address).to be_a(Geocodio::AddressSet) }
+        end
+      end
+
+      it 'accepts an options hash' do
+        VCR.use_cassette('batch_reverse_with_fields') do
+          coordinate_pairs = [
+            { latitude: 37.331669, longitude: -122.03074 },
+            '34.145760590909,-118.15204363636',
+            { latitude: 37.7815,   longitude: -122.404933 }
+          ]
+
+          addresses = geocodio.reverse_geocode(coordinate_pairs, fields: %w[cd118 stateleg-next school timezone])
+
+          expect(addresses.size).to eq(3)
+          addresses.each { |address| expect(address).to be_a(Geocodio::AddressSet) }
+        end
+      end
+    end
+  end
+end

data/spec/congressional_district_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Geocodio::CongressionalDistrict do
+  let(:geocodio) { Geocodio::Client.new }
+
+  subject(:district) do
+    VCR.use_cassette('geocode_with_fields') do
+      geocodio.geocode(['54 West Colorado Boulevard Pasadena CA 91105'], fields: %w[cd118 stateleg-next school timezone]).
+        best.
+        congressional_districts.
+        first
+    end
+  end
+
+  it 'has a name' do
+    expect(district.name).to eq("Congressional District 28")
+  end
+
+  it 'has a district_number' do
+    expect(district.district_number).to eq(28)
+  end
+
+  it 'has a congress_number' do
+    expect(district.congress_number).to eq(118)
+  end
+
+  it 'has a congress_years' do
+    expect(district.congress_years).to eq(2023..2025)
+  end
+
+  it 'has a proportion' do
+    expect(district.proportion).to eq(1)
+  end
+
+  it 'has ocd_id' do
+    expect(district.ocd_id).to eq('ocd-division/country:us/state:ca/cd:28')
+  end
+
+
+  it 'has current_legislators' do
+    district.current_legislators.each do |legislator|
+      expect(legislator).to be_a(Geocodio::Legislator)
+    end
+  end
+end

data/spec/legislator_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Geocodio::Legislator do
+  let(:geocodio) { Geocodio::Client.new }
+
+  subject(:legislator) do
+    VCR.use_cassette('geocode_with_fields_legacy') do
+      geocodio.geocode(['54 West Colorado Boulevard Pasadena CA 91105'], fields: %w[cd stateleg-next school timezone]).
+        best.
+        congressional_districts.
+        first.
+        current_legislators.
+        first
+    end
+  end
+
+  it 'has a type' do
+    expect(legislator.type).to eq('representative')
+  end
+
+  it 'has a name' do
+    expect(legislator.name).to eq('Judy Chu')
+  end
+
+  it 'has a birthday' do
+    expect(legislator.birthday).to eq(Date.new(1953, 07, 07))
+  end
+
+  it 'has a gender' do
+    expect(legislator.gender).to eq('F')
+  end
+
+  it 'has a party' do
+    expect(legislator.party).to eq('Democrat')
+  end
+
+  it 'has a url' do
+    expect(legislator.url).to eq('https://chu.house.gov')
+  end
+
+  it 'has a address' do
+    expect(legislator.address).to eq('2423 Rayburn House Office Building Washington DC 20515-0527')
+  end
+
+  it 'has a phone' do
+    expect(legislator.phone).to eq('202-225-5464')
+  end
+
+  it 'has a contact_form' do
+    expect(legislator.contact_form).to be_nil
+  end
+
+  it 'has a rss_url' do
+    expect(legislator.rss_url).to eq('http://chu.house.gov/rss.xml')
+  end
+
+  it 'has a twitter' do
+    expect(legislator.twitter).to eq('RepJudyChu')
+  end
+
+  it 'has a facebook' do
+    expect(legislator.facebook).to eq('RepJudyChu')
+  end
+
+  it 'has a youtube' do
+    expect(legislator.youtube).to eq('RepJudyChu')
+  end
+
+  it 'has a youtube_id' do
+    expect(legislator.youtube_id).to eq('UCfcbYOvdEXZNelM8T05nK-w')
+  end
+
+  it 'has a bioguide_id' do
+    expect(legislator.bioguide_id).to eq('C001080')
+  end
+
+  it 'has a thomas_id' do
+    expect(legislator.thomas_id).to eq('01970')
+  end
+
+  it 'has a opensecrets_id' do
+    expect(legislator.opensecrets_id).to eq('N00030600')
+  end
+
+  it 'has a lis_id' do
+    expect(legislator.lis_id).to be_nil
+  end
+
+  it 'has a cspan_id' do
+    expect(legislator.cspan_id).to eq('92573')
+  end
+
+  it 'has a govtrack_id' do
+    expect(legislator.govtrack_id).to eq('412379')
+  end
+
+  it 'has a votesmart_id' do
+    expect(legislator.votesmart_id).to eq('16539')
+  end
+
+  it 'has a ballotpedia_id' do
+    expect(legislator.ballotpedia_id).to eq('Judy Chu')
+  end
+
+  it 'has a washington_post_id' do
+    expect(legislator.washington_post_id).to be_nil
+  end
+
+  it 'has a icpsr_id' do
+    expect(legislator.icpsr_id).to eq('20955')
+  end
+
+  it 'has a wikipedia_id' do
+    expect(legislator.wikipedia_id).to eq('Judy Chu')
+  end
+end