civic_aide 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56f970f6dbdf0bc676809891902697c3324486bd
-  data.tar.gz: d2a0e07abf8aa8f9b4d2daebcb7f676593b66963
+  metadata.gz: 1ae4a622cfd518c0129d07db8829419441cea136
+  data.tar.gz: c688b4f5eb3ca0a5d7f16ef4cc46ddfa1ccc31e4
 SHA512:
-  metadata.gz: 2555271f3b409f60053278b35beb6ec27af35ee21893862d32eadda81302e13fa6b503ea21982ff8c79ac165cc63fa213b807143c858f67d2ff5d47281ab03ed
-  data.tar.gz: 226a43e8c8d7e65d2b38f19102620e597f7e98fd7b705aac2abbb6441884a8d2331e436527c4b43a4d6befc31f8ec188ab6d25171ec901624cca589d72c381c7
+  metadata.gz: e6a27854b2aa259cae4b768c5aac3757001d0e4a20492ea37568b309929c7ab427412f35e9f3f70f287b4a50762e64697774379235b49aad846ad070e914a972
+  data.tar.gz: 8819fd8df652eb375581110ec3b4e177fdfca25c9f287e8ead4cfe111fe3f70822ce8687a15ad1cdb3d45111092d390720a4ed114b8dc5ae17384c1561ac0572

data/README.md

@@ -38,8 +38,8 @@ Additionally, to avoid clashing with the [Array#zip Ruby method](http://apidock.
 ### Configuration
 
 ```ruby
-google_api_key = `ABCaSyD5aMsdmaXxHc7aiUyYuVXtCICV-y_PWnf5w`
-client = CivicAide::Client.new(google_api_key)
+api_key = `ABCaSyD5aMsdmaXxHc7aiUyYuVXtCICV-y_PWnf5w`
+client = CivicAide::Client.new(api_key)
 ```
 
 Alternatively, the API key can be set with global configuration and the resources can be accessed directly.
@@ -49,6 +49,14 @@ CivicAide.api_key = "ABCaSyD5aMsdmaXxHc7aiUyYuVXtCICV-y_PWnf5w"
 CivicAide.elections.all
 ```
 
+To [receive data that is only from official state sources](https://developers.google.com/civic-information/docs/us_v1/elections/voterInfoQuery), set `CivicPage.official_sources` to `true`. By default this is set to `false`.
+
+```ruby
+CivicAide.official_sources = true
+# or
+client.official_sources = true
+```
+
 ## Resources
 
 ### [Elections](https://developers.google.com/civic-information/docs/us_v1/elections)

data/lib/civic_aide/client.rb

@@ -14,10 +14,12 @@ module CivicAide
     headers  "User-Agent" => "CivicAide Ruby gem v#{CivicAide::VERSION}".freeze
 
     attr_reader :api_key
+    attr_accessor :official_only
 
-    def initialize(api_key=nil)
-      @api_key = api_key
+    def initialize(api_key=nil, official_only=nil)
+      @api_key, @official_only = api_key, official_only
       @api_key ||= CivicAide.api_key
+      @official_only ||= CivicAide.official_only
     end
 
     def get(url, query={})

data/lib/civic_aide/elections.rb

@@ -14,7 +14,7 @@ module CivicAide
 
     def at(address)
       raise ElectionIdMissing, "Missing a required election id" if @election_id.nil?
-      response = client.post("/voterinfo/#{election_id}/lookup", {officialOnly: false}, {:address => address})
+      response = client.post("/voterinfo/#{election_id}/lookup", {officialOnly: @client.official_only}, {address: address})
       response.except!(:kind, :status)
     end
 

data/lib/civic_aide/version.rb

@@ -1,3 +1,3 @@
 module CivicAide
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/civic_aide.rb

@@ -11,6 +11,7 @@ require 'civic_aide/errors'
 module CivicAide
   class << self
     extend Forwardable
+    attr_accessor :official_only
 
     def api_key
       raise APIKeyNotSet if @api_key.nil?
@@ -21,13 +22,17 @@ module CivicAide
       @api_key = api_key
     end
 
+    def official_only
+      @official_only ||= false
+    end
+
     delegate [
       :elections,
       :representatives
     ] => :client
 
     def client
-      @client = CivicAide::Client.new(@api_key)
+      @client = CivicAide::Client.new(@api_key, @official_only)
     end
 
   end

data/spec/civic_aide/civic_aide_spec.rb

@@ -6,6 +6,10 @@ describe CivicAide do
     CivicAide.api_key = "samplekey"
   end
 
+  after do
+    CivicAide.official_only = false
+  end
+
   it 'should include Forwardable' do
     CivicAide.extend(Forwardable)
   end
@@ -22,4 +26,15 @@ describe CivicAide do
     end
   end
 
+  describe ".official_only" do
+    it "should default to false" do
+      expect(CivicAide.official_only).to eq(false)
+    end
+
+    it "should allow changing" do
+      CivicAide.official_only = true
+      expect(CivicAide.official_only).to eq(true)
+    end
+  end
+
 end

data/spec/civic_aide/client_spec.rb

@@ -16,6 +16,10 @@ describe CivicAide::Client do
       CivicAide.api_key = "AIzaSyDWJSisG_4Azd6nVJTU5gdKPiKKTCovupY"
       expect{ CivicAide::Client.new }.to_not raise_error
     end
+
+    it "defaults to false for official only" do
+      expect(@client.official_only).to eq(false)
+    end
   end
 
   describe "#new" do
@@ -102,4 +106,21 @@ describe CivicAide::Client do
     end
   end
 
+  describe "official only" do
+    it "should allowing toggling official_only" do
+      expect(@client.official_only).to eq(false)
+    end
+
+    it "should allowing toggling official_only" do
+      @client.official_only = true
+      expect(@client.official_only).to eq(true)
+    end
+
+    it "should have client instead of class for official_only" do
+      CivicAide.official_only = true
+      @client.official_only = false
+      expect(@client.official_only).to eq(false)
+    end
+  end
+
 end

data/spec/vcr/elections/single.yml

@@ -78,6 +78,86 @@ http_interactions:
         P. QUINN","title":"General Registrar Physical","officePhoneNumber":"7033244715","emailAddress":"cameronquinn@fairfaxcounty.gov"}]},"sources":[{"name":"Voting
         Information Project","official":true}]},"sources":[{"name":"Voting Information
         Project","official":true}]}]}'
-    http_version:
+    http_version: 
   recorded_at: Fri, 27 Dec 2013 16:20:05 GMT
+- request:
+    method: post
+    uri: https://www.googleapis.com/civicinfo/us_v1/voterinfo/4015/lookup?key=AIzaSyDWJSisG_4Azd6nVJTU5gdKPiKKTCovupY&officialOnly=true&prettyPrint=false
+    body:
+      encoding: UTF-8
+      string: '{"address":"4910 Willet Drive, Annandale, VA 22003"}'
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - CivicAide Ruby gem v0.0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache, no-store, max-age=0, must-revalidate
+      Pragma:
+      - no-cache
+      Expires:
+      - Fri, 01 Jan 1990 00:00:00 GMT
+      Date:
+      - Sun, 29 Dec 2013 19:02:34 GMT
+      Etag:
+      - '"AkiRpOnd7sKoopyUaI9w1UXzdBI/vWeYnvL4AVWs9UxlTsL7NNSRt1U"'
+      Content-Type:
+      - application/json; charset=UTF-8
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Server:
+      - GSE
+      Alternate-Protocol:
+      - 443:quic
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"kind":"civicinfo#voterInfoResponse","status":"success","election":{"id":"4015","name":"VA
+        State Election","electionDay":"2013-11-05"},"normalizedInput":{"line1":"4910
+        willet dr","city":"annandale","state":"VA","zip":"22003"},"contests":[{"type":"general","special":"no","office":"Governor","district":{"name":"Statewide","scope":"statewide"},"ballotPlacement":"4","candidates":[{"name":"Ken
+        T. Cuccinelli II","party":"Republican","candidateUrl":"http://www.cuccinelli.com","phone":"8047863808","email":"ken@cuccinelli.com"},{"name":"Robert
+        C. Sarvis","party":"Libertarian","candidateUrl":"http://www.robertsarvis.com","email":"info@robertsarvis.com"},{"name":"Terry
+        R. McAuliffe","party":"Democrat","candidateUrl":"http://www.terrymcauliffe.com","phone":"7038227604","email":"info@terrymcauliffe.com"}],"sources":[{"name":"Voting
+        Information Project","official":true}]},{"type":"general","special":"no","office":"Lieutenant
+        Governor","district":{"name":"Statewide","scope":"statewide"},"ballotPlacement":"5","candidates":[{"name":"Ralph
+        S. Northam","party":"Democrat","candidateUrl":"http://www.northamforlg.com","phone":"7576954188","email":"ralph@ralphnortham.com"},{"name":"E.
+        W. Jackson","party":"Republican","candidateUrl":"http://www.jacksonforlg.com","phone":"7578024246","email":"jackson@jacksonforlg.com"}],"sources":[{"name":"Voting
+        Information Project","official":true}]},{"type":"general","special":"no","office":"Attorney
+        General","district":{"name":"Statewide","scope":"statewide"},"ballotPlacement":"6","candidates":[{"name":"Mark
+        D. Obenshain","party":"Republican","candidateUrl":"http://www.markobenshain.com","phone":"5404371451","email":"campaign@markobenshain.com"},{"name":"Mark
+        R. Herring","party":"Democrat","candidateUrl":"http://www.herringforag.com","phone":"7036699090","email":"kevin@herringforag.com"}],"sources":[{"name":"Voting
+        Information Project","official":true}]},{"type":"general","special":"no","office":"Member
+        House of Delegates","district":{"name":"039","scope":"stateLower","id":"39"},"ballotPlacement":"8","candidates":[{"name":"Vivian
+        E. Watts","party":"Democrat","candidateUrl":"http://www.vivianwatts.com","phone":"7039782989","email":"vwatts@erols.com"},{"name":"Joe
+        G. Bury","party":"Republican","candidateUrl":"http://www.joebury.com","phone":"7033078221","email":"jgbury@hotmail.com"}],"sources":[{"name":"Voting
+        Information Project","official":true}]},{"type":"general","special":"no","office":"Sheriff","district":{"name":"FAIRFAX
+        COUNTY"},"ballotPlacement":"11","candidates":[{"name":"Stacey Ann Kincaid","party":"Democrat","candidateUrl":"http://staceykincaid.com","phone":"7039381658","email":"Kincaidforsheriff@gmail.com"},{"name":"Christopher
+        F. DeCarlo","party":"Independent","candidateUrl":"http://www.honestyandethics.com","phone":"7035736160","email":"cdecarlo@fairfaxpropane.com"},{"name":"Bryan
+        A. /B. A./ Wolfe","party":"Republican","candidateUrl":"http://www.wolfeforsheriff.com","phone":"7035436360","email":"fairfaxwolfe@yahoo.com"},{"name":"Robert
+        A. Rivera","party":"Independent","phone":"7039783034","email":"riveraforsheriff@gmail.com"}],"sources":[{"name":"Voting
+        Information Project","official":true}]},{"type":"Referendum","special":"no","office":"School
+        Bonds","district":{"name":"FAIRFAX COUNTY","id":"59"},"ballotPlacement":"9999","sources":[{"name":"Voting
+        Information Project","official":true}]}],"state":[{"name":"Virginia","electionAdministrationBody":{"name":"State
+        Board of Elections","electionInfoUrl":"http://www.sbe.virginia.gov/","electionRegistrationUrl":"https://www.vote.virginia.gov/","electionRegistrationConfirmationUrl":"https://www.vote.virginia.gov/","absenteeVotingInfoUrl":"http://www.sbe.virginia.gov/absenteevoting.html","votingLocationFinderUrl":"https://www.vote.virginia.gov/","ballotInfoUrl":"https://www.vote.virginia.gov/","electionRulesUrl":"http://www.sbe.virginia.gov/","physicalAddress":{"locationName":"State
+        Board of Elections","line1":"Washington Building First Floor","line2":"1100
+        Bank Street","city":"Richmond","state":"VA","zip":"23219"}},"local_jurisdiction":{"name":"FAIRFAX
+        COUNTY","electionAdministrationBody":{"name":"FAIRFAX COUNTY","electionInfoUrl":"http://www.fairfaxcounty.gov/elections","electionRegistrationUrl":"http://www.vote.virginia.gov","electionRegistrationConfirmationUrl":"http://www.vote.virginia.gov","absenteeVotingInfoUrl":"http://www.vote.virginia.gov","votingLocationFinderUrl":"http://www.vote.virginia.gov","ballotInfoUrl":"http://www.vote.virginia.gov","electionRulesUrl":"http://www.vote.virginia.gov","hoursOfOperation":"8:00
+        a.m. to 4:30 p.m Monday-Wednesday and Friday and 8:00 a.m. to 7:00 p.m. Thursday","physicalAddress":{"locationName":"FAIRFAX
+        COUNTY","line1":"OFFICE OF ELECTIONS","line2":"12000 GOVERNMENT CENTER PKWY","line3":"SUITE
+        323","city":"FAIRFAX","state":"VA","zip":"22035-0081"},"electionOfficials":[{"name":"CAMERON
+        P. QUINN","title":"General Registrar Physical","officePhoneNumber":"7033244715","emailAddress":"cameronquinn@fairfaxcounty.gov"}]},"sources":[{"name":"Voting
+        Information Project","official":true}]},"sources":[{"name":"Voting Information
+        Project","official":true}]}]}'
+    http_version: 
+  recorded_at: Sun, 29 Dec 2013 19:02:35 GMT
 recorded_with: VCR 2.5.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: civic_aide
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Tyler Pearson