google-civic-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecf478592957b5fc9111b2f913dbc780eeae1fc9
-  data.tar.gz: d6ad081f1789c5b78160b765ed184be3c6de9ad1
+  metadata.gz: 7ee66524f2360ca52385c2b44fe98dea5a2c081e
+  data.tar.gz: 7e6fa47faf2d296f20bc152e1abb2dd536b7a62d
 SHA512:
-  metadata.gz: 348df3a75d235aa9fb9090364b8f9d350801fa1511a6559a3f56d1510c16a8e10f624bc3a1c45a6ff2686f5f93166f120798ed51ed2e9e1a89a9622d3448c1e2
-  data.tar.gz: 38a8a77b5263029ad0821ad7dbf63baaf266a69374c82e62166cd916ce8efa1525fda257f68898c8f98f43b2b6f93d37bc25433b69b24618bd89fb10f263d6fc
+  metadata.gz: 2dc06c70e8b06e0e580f6dd4819b1dc948135926bc020bc2041ed06300a49867a9baf6eb12f643016f08f63a01d6e6d1489f3f9c953ba43837284eb80f82c1d2
+  data.tar.gz: c1af46a146bb53d83a160161db814e07a7cd077e06ebc1f15ae2b37278648277e55e1afd45602eca13a562d2367a0ca5ad257a1e338771e74df1c29bafab6f98

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/google-civic-api-ruby/fork )
+1. Fork it ( http://github.com/CodingZeal/google-civic-api-ruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/google-civic-ruby.gemspec

@@ -17,12 +17,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "multi_json", "~> 1.10"
-  spec.add_dependency "hashie", "~> 3.0"
   spec.add_dependency "faraday", "~> 0.9"
   spec.add_dependency "faraday_middleware", "~> 0.9"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rspec", "~> 2.14"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-debugger"
   spec.add_development_dependency "webmock", "~> 1.18"
 end

data/lib/google-civic.rb

@@ -1,4 +1,5 @@
 require 'google-civic/version'
+require "google-civic/representation"
 require 'google-civic/election'
 require 'google-civic/elections'
 # require 'google-civic/address'
@@ -6,4 +7,10 @@ require 'google-civic/elections'
 require 'google-civic/client'
 require 'google-civic/router'
 require 'google-civic/requester'
-require "google-civic/connection"
+require "google-civic/connection"
+require "google-civic/address"
+require "google-civic/channel"
+require "google-civic/division"
+require "google-civic/office"
+require "google-civic/official"
+require "google-civic/representative_info"

data/lib/google-civic/address.rb

@@ -0,0 +1,6 @@
+module Google
+  module Civic
+    class Address < Representation
+    end
+  end
+end

data/lib/google-civic/channel.rb

@@ -0,0 +1,31 @@
+module Google
+  module Civic
+    class Channel < Representation
+    end
+
+    class Facebook < Channel
+      def url
+        "http://facebook.com/#{self.id}"
+      end
+    end
+
+    class Twitter < Channel
+      def url
+        "http://twitter.com/#{self.id}"
+      end
+    end
+
+    class GooglePlus < Channel
+      def url
+        "https://plus.google.com/#{self.id}"
+      end
+    end
+
+    class YouTube < Channel
+      def url
+        "http://youtube.com/#{self.id}"
+      end
+    end
+  end
+end
+

data/lib/google-civic/client.rb

@@ -10,6 +10,10 @@ module Google
         Elections.for_zipcode(zipcode, self)
       end
 
+      def representative_info(address)
+        RepresentativeInfo.for_address(address, self)
+      end
+
       def voter_info(address)
         VoterInfo.for_address(address, self)
       end

data/lib/google-civic/connection.rb

@@ -39,4 +39,4 @@ module Google
       end
     end
   end
-end
+end

data/lib/google-civic/division.rb

@@ -0,0 +1,7 @@
+module Google
+  module Civic
+    class Division < Representation
+      has_many :offices
+    end
+  end
+end

data/lib/google-civic/election.rb

@@ -1,14 +1,9 @@
-require "multi_json"
-require "hashie"
-
 module Google
   module Civic
-    class Election < Hashie::Dash
-      include Hashie::Extensions::Dash::IndifferentAccess
-
-      property :id, required: true
-      property :name, required: true
-      property :electionDay, required: true
+    class Election < Representation
+      def election_day
+        self["electionDay"]
+      end
     end
   end
 end

data/lib/google-civic/elections.rb

@@ -1,5 +1,3 @@
-require "multi_json"
-
 module Google
   module Civic
     module Elections

data/lib/google-civic/office.rb

@@ -0,0 +1,7 @@
+module Google
+  module Civic
+    class Office < Representation
+      has_many :officials
+    end
+  end
+end

data/lib/google-civic/official.rb

@@ -0,0 +1,22 @@
+module Google
+  module Civic
+    class Official < Representation
+      def address
+      end
+
+      def addresses
+        @__addresses ||= self["address"].map { |address| Address.new(address) }
+      end
+
+      def channels
+        @__channels ||= self["channels"].map { |channel| channel_class.new(channel) }
+      end
+
+      private
+
+      def channel_class
+        Object.const_get("Google::Civic::#{channel.fetch("type")}")
+      end
+    end
+  end
+end

data/lib/google-civic/representation.rb

@@ -0,0 +1,47 @@
+module Google
+  module Civic
+    class Representation < OpenStruct
+      class << self
+        def has_many(association, options={})
+          build_getter_for_ids(association)
+          build_getter_for_collection(association, options)
+        end
+
+        private
+
+        def build_getter_for_ids(association)
+          singularized_association = __singularized(association)
+
+          class_eval %{
+            def #{singularized_association}_ids
+              self["#{singularized_association}Ids"] || []
+            end
+          }
+        end
+
+        def build_getter_for_collection(association, options)
+          class_eval %{
+            def #{association}
+              @__#{association} ||= #{__singularized(association)}_ids.map do |id|
+                #{options[:class_name] || __singularized(association).capitalize}.new(__find_#{association}_by_id(id), @root_scope)
+              end
+            end
+
+            def __find_#{association}_by_id(id)
+              @root_scope.fetch("#{association}").fetch(id)
+            end
+          }
+        end
+
+        def __singularized(word)
+          word.to_s.gsub(/s\z/, '')
+        end
+      end
+
+      def initialize(representation, root_scope = nil)
+        @root_scope = root_scope || representation
+        super(representation)
+      end
+    end
+  end
+end

data/lib/google-civic/representative_info.rb

@@ -0,0 +1,34 @@
+module Google
+  module Civic
+    class RepresentativeInfo < Representation
+
+      def self.for_address(address, client)
+        representative_info_from_response response(address, client)
+      end
+
+      def divisions
+        @divisions ||= self["divisions"].keys.map do |key|
+          division_rep = self["divisions"].fetch(key).merge(id: key)
+          Division.new(division_rep, @root_scope)
+        end
+      end
+
+      def offices
+        @offices ||= self["offices"].keys.map do |key|
+          office_rep = self["offices"].fetch(key).merge(id: key)
+          Office.new(office_rep, @root_scope)
+        end
+      end
+
+      private
+
+      def self.representative_info_from_response(response)
+        RepresentativeInfo.new(response.body)
+      end
+
+      def self.response(address, client)
+        client.request(:representative_info, address: address)
+      end
+    end
+  end
+end

data/lib/google-civic/router.rb

@@ -4,11 +4,16 @@ module Google
 
       BASE_URL  = "https://www.googleapis.com"
       BASE_PATH = "/civicinfo/v1"
+
       ROUTES    = {
         elections: {
           method: :get,
-          path: "/elections",
-          klass: Election
+          path:   "/elections"
+        },
+
+        representative_info: {
+          method: :post,
+          path:   "/representatives/lookup"
         }
       }
 
@@ -25,11 +30,6 @@ module Google
       def path_for(kind)
         [BASE_PATH, route_map_for(kind).fetch(:path)].join('')
       end
-
-      def klass_for(kind)
-        route_map_for(kind).fetch(:klass)
-      end
-      alias :class_for :klass_for
     end
   end
 end

data/lib/google-civic/version.rb

@@ -1,5 +1,5 @@
 module Google
   module Civic
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
-end
+end

data/spec/google-civic/division_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+module Google
+  module Civic
+    describe Division do
+      subject { described_class.new(first_division, representation) }
+      let(:representation) { MultiJson.load(load_fixture("representative_info")) }
+      let(:first_division) {
+        divisions = representation.fetch("divisions")
+        divisions.keys.map do |key|
+          divisions.fetch(key)
+        end.select do |division|
+          !division["officeIds"].nil? and !division["officeIds"].empty?
+        end.first
+      }
+
+      it { expect(subject.name).to be_a_kind_of String }
+      it { expect(subject.office_ids).to be_a_kind_of Array }
+      it { expect(subject.offices.first).to be_a_kind_of Office }
+    end
+  end
+end

data/spec/google-civic/election_spec.rb

@@ -1,13 +1,14 @@
 require "spec_helper"
-require "multi_json"
 
-module Google::Civic
-  describe Election do
-    subject { Election.new(response) }
-    let(:response) { MultiJson.load(load_fixture("elections"))["elections"][0] }
+module Google
+  module Civic
+    describe Election do
+      subject { Election.new(response) }
+      let(:response) { MultiJson.load(load_fixture("elections"))["elections"][0] }
 
-    its(:id)          { should_not be_nil }
-    its(:name)        { should_not be_nil }
-    its(:electionDay) { should_not be_nil }
+      its(:id) { should_not be_nil }
+      its(:name) { should_not be_nil }
+      its(:election_day) { should_not be_nil }
+    end
   end
 end

data/spec/google-civic/office_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+module Google
+  module Civic
+    describe Office do
+      include_context "a connection to the client"
+    end
+  end
+end

data/spec/google-civic/official_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+module Google
+  module Civic
+    describe Official do
+      pending
+    end
+  end
+end

data/spec/google-civic/representative_info_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+module Google
+  module Civic
+    describe RepresentativeInfo do
+      include_context "a connection to the client"
+      let(:method) { :post }
+      let(:kind) { "representative_info" }
+      let(:path) { "representatives/lookup?key=#{api_key}&address=#{address}" }
+
+      describe ".for_address" do
+        subject { RepresentativeInfo.for_address(address, client) }
+        let(:address) { "1263 Pacific Ave. Kansas City KS" }
+
+        it { expect(subject.divisions).to have(8).record }
+        it { expect(subject.offices).to have(19).record }
+        it { expect(subject.officials).to have(20).record }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'rspec'
 require 'rspec/autorun'
 require 'pry'
 require 'webmock/rspec'
+require "multi_json"
 
 PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
 $LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
@@ -15,4 +16,4 @@ RSpec.configure do |config|
   config.include Requests
 end
 
-require 'google-civic'
+require 'google-civic'

data/spec/support/helpers/requests.rb

@@ -1,5 +1,5 @@
 module Requests
-  def stub_request_for(fixture, path)
-    stub_request(:get, "https://www.googleapis.com/civicinfo/v1/#{path}").to_return(status: 200, body: Fixtures.load_fixture(fixture), headers: {})
+  def stub_request_for(method, fixture, path)
+    stub_request(method, "https://www.googleapis.com/civicinfo/v1/#{path}").to_return(status: 200, body: Fixtures.load_fixture(fixture), headers: {})
   end
-end
+end

data/spec/support/shared_examples/connection_to_the_client.rb

@@ -9,8 +9,11 @@ module Google
           base_url: Router::BASE_URL
         }
       }
+      let(:method) { :get }
+      let(:path) { "elections?zipcode=#{zipcode}&key=#{api_key}" }
+      let(:kind) { "elections" }
 
-      before { stub_request_for("elections", "elections?zipcode=#{zipcode}&key=#{api_key}") }
+      before { stub_request_for(method, kind, path) }
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-civic-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Coding ZEAL
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -25,20 +25,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-debugger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -138,16 +124,27 @@ files:
 - Rakefile
 - google-civic-ruby.gemspec
 - lib/google-civic.rb
+- lib/google-civic/address.rb
+- lib/google-civic/channel.rb
 - lib/google-civic/client.rb
 - lib/google-civic/connection.rb
+- lib/google-civic/division.rb
 - lib/google-civic/election.rb
 - lib/google-civic/elections.rb
+- lib/google-civic/office.rb
+- lib/google-civic/official.rb
+- lib/google-civic/representation.rb
+- lib/google-civic/representative_info.rb
 - lib/google-civic/requester.rb
 - lib/google-civic/router.rb
 - lib/google-civic/version.rb
 - spec/google-civic/client_spec.rb
+- spec/google-civic/division_spec.rb
 - spec/google-civic/election_spec.rb
 - spec/google-civic/elections_spec.rb
+- spec/google-civic/office_spec.rb
+- spec/google-civic/official_spec.rb
+- spec/google-civic/representative_info_spec.rb
 - spec/google-civic/requester_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/elections.json
@@ -182,8 +179,12 @@ specification_version: 4
 summary: Ruby wrapper for the Google Civic API
 test_files:
 - spec/google-civic/client_spec.rb
+- spec/google-civic/division_spec.rb
 - spec/google-civic/election_spec.rb
 - spec/google-civic/elections_spec.rb
+- spec/google-civic/office_spec.rb
+- spec/google-civic/official_spec.rb
+- spec/google-civic/representative_info_spec.rb
 - spec/google-civic/requester_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/elections.json