google-civic-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecf478592957b5fc9111b2f913dbc780eeae1fc9
+  data.tar.gz: d6ad081f1789c5b78160b765ed184be3c6de9ad1
+SHA512:
+  metadata.gz: 348df3a75d235aa9fb9090364b8f9d350801fa1511a6559a3f56d1510c16a8e10f624bc3a1c45a6ff2686f5f93166f120798ed51ed2e9e1a89a9622d3448c1e2
+  data.tar.gz: 38a8a77b5263029ad0821ad7dbf63baaf266a69374c82e62166cd916ce8efa1525fda257f68898c8f98f43b2b6f93d37bc25433b69b24618bd89fb10f263d6fc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+script: "bundle exec rspec spec"
+
+language: ruby
+
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google-civic-api-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Adam Cuppy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Google::Civic
+[![Build Status](https://travis-ci.org/CodingZeal/google-civic-ruby.svg?branch=master)](https://travis-ci.org/CodingZeal/google-civic-ruby) [![Code Climate](https://codeclimate.com/github/CodingZeal/google-civic-ruby.png)](https://codeclimate.com/github/CodingZeal/google-civic-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google-civic-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-civic-ruby
+
+## Usage
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/google-civic-ruby.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google-civic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google-civic-ruby"
+  spec.version       = Google::Civic::VERSION
+  spec.authors       = ["Coding ZEAL", "Adam Cuppy"]
+  spec.email         = ["adam@codingzeal.com"]
+  spec.summary       = %q{Ruby wrapper for the Google Civic API}
+  spec.homepage      = "https://github.com/CodingZeal/google-civic-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  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 "webmock", "~> 1.18"
+end

data/lib/google-civic.rb

@@ -0,0 +1,9 @@
+require 'google-civic/version'
+require 'google-civic/election'
+require 'google-civic/elections'
+# require 'google-civic/address'
+# require 'google-civic/voter_info'
+require 'google-civic/client'
+require 'google-civic/router'
+require 'google-civic/requester'
+require "google-civic/connection"

data/lib/google-civic/client.rb

@@ -0,0 +1,34 @@
+module Google
+  module Civic
+    class Client
+      def initialize(api_key, connection)
+        @api_key    = api_key
+        @connection = connection
+      end
+
+      def elections(zipcode)
+        Elections.for_zipcode(zipcode, self)
+      end
+
+      def voter_info(address)
+        VoterInfo.for_address(address, self)
+      end
+
+      def request(*args)
+        @request       ||= {}
+        @request[args] ||= Requester.new(connection, { key: api_key }).request(*args)
+      end
+
+      private
+
+      def connection
+        @connection or raise "Connection not established"
+      end
+
+      def api_key
+        @api_key or raise "No Google API key defined"
+      end
+    end
+  end
+end
+

data/lib/google-civic/connection.rb

@@ -0,0 +1,42 @@
+require "faraday"
+require "faraday_middleware"
+
+module Google
+  module Civic
+    class Connection
+      attr_writer :base_url
+
+      def initialize(params={})
+        @base_url = params.delete(:base_url)
+        establish!
+      end
+
+      def get(*args, &block)
+        resource.get(*args, &block)
+      end
+
+      def post(*args, &block)
+        resource.post(*args, &block)
+      end
+
+      private
+
+      def establish!
+        @resource = Faraday.new(base_url) do |builder|
+          builder.request :json
+          builder.request :url_encoded
+          builder.use FaradayMiddleware::ParseJson
+          builder.adapter  Faraday.default_adapter
+        end
+      end
+
+      def resource
+        @resource or raise "Connection not established"
+      end
+
+      def base_url
+        @base_url or ""
+      end
+    end
+  end
+end

data/lib/google-civic/election.rb

@@ -0,0 +1,14 @@
+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
+    end
+  end
+end

data/lib/google-civic/elections.rb

@@ -0,0 +1,34 @@
+require "multi_json"
+
+module Google
+  module Civic
+    module Elections
+
+      class InvalidZipcode < Exception; end
+
+      class << self
+
+        def for_zipcode(zipcode, client)
+          raise InvalidZipcode if not zipcode?(zipcode)
+          elections_from_response collection(zipcode, client)
+        end
+
+        private
+
+        def elections_from_response(response)
+          response.body.fetch("elections").map do |election|
+            Election.new(election)
+          end
+        end
+
+        def collection(zipcode, client)
+          client.request(:elections, zipcode: zipcode)
+        end
+
+        def zipcode?(zipcode)
+          zipcode =~ /\A\d{5}(?:[-\s]\d{4})?\z/
+        end
+      end
+    end
+  end
+end

data/lib/google-civic/requester.rb

@@ -0,0 +1,19 @@
+module Google
+  module Civic
+    class Requester
+      include Router
+
+      def initialize(connection, request_params={})
+        @connection = connection
+        @connection.base_url = BASE_URL
+        @request_params = request_params
+      end
+
+      def request(kind, params={})
+        @connection.send method_for(kind) do |request|
+          request.url path_for(kind), @request_params.merge(params)
+        end
+      end
+    end
+  end
+end

data/lib/google-civic/router.rb

@@ -0,0 +1,35 @@
+module Google
+  module Civic
+    module Router
+
+      BASE_URL  = "https://www.googleapis.com"
+      BASE_PATH = "/civicinfo/v1"
+      ROUTES    = {
+        elections: {
+          method: :get,
+          path: "/elections",
+          klass: Election
+        }
+      }
+
+      private
+
+      def route_map_for(kind)
+        ROUTES.fetch(kind)
+      end
+
+      def method_for(kind)
+        route_map_for(kind).fetch(:method)
+      end
+
+      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

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

data/spec/google-civic/client_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+module Google
+  module Civic
+    describe Client do
+      include_context "a connection to the client"
+
+      describe "#request" do
+        subject { client.request(request_type, request_params) }
+        let(:zipcode) { "12345" }
+        let(:request_type) { :elections }
+        let(:request_params) { Hash[ zipcode: zipcode ] }
+
+        it { expect(subject).to be_a_kind_of Faraday::Response }
+      end
+    end
+  end
+end

data/spec/google-civic/election_spec.rb

@@ -0,0 +1,13 @@
+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] }
+
+    its(:id)          { should_not be_nil }
+    its(:name)        { should_not be_nil }
+    its(:electionDay) { should_not be_nil }
+  end
+end

data/spec/google-civic/elections_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+module Google
+  module Civic
+    describe Elections do
+      include_context "a connection to the client"
+
+      describe ".for_zipcode" do
+        subject { Elections.for_zipcode(zipcode, client) }
+
+        context "with an invalid zipcode" do
+          let(:zipcode) { "1234567890" }
+          it { expect { subject }.to raise_error(Elections::InvalidZipcode) }
+        end
+
+        context "with a valid 9 digit zipcode" do
+          let(:zipcode) { "12345-1234" }
+          it { expect { subject }.not_to raise_error }
+        end
+
+        context "with a valid 5 digit zipcode" do
+          let(:zipcode) { "12345" }
+          it { expect(subject).to have(3).record }
+          it { expect(subject.first).to be_a_kind_of Election }
+        end
+      end
+    end
+  end
+end

data/spec/google-civic/requester_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+module Google
+  module Civic
+    describe Requester do
+      it "includes the Router" do
+        expect(described_class.ancestors).to include Router
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rspec'
+require 'rspec/autorun'
+require 'pry'
+require 'webmock/rspec'
+
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
+$LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
+Dir[File.join(PROJECT_ROOT, 'spec/support/**/*.rb')].each { |file| require(file) }
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  config.include Fixtures
+  config.include Requests
+end
+
+require 'google-civic'

data/spec/support/fixtures/elections.json

@@ -0,0 +1,20 @@
+{
+ "kind": "civicinfo#electionsqueryresponse",
+ "elections": [
+  {
+   "id": "2000",
+   "name": "VIP Test Election",
+   "electionDay": "2013-06-06"
+  },
+  {
+   "id": "2124",
+   "name": "Rhode Island 2012 Primary Election",
+   "electionDay": "2012-09-11"
+  },
+  {
+   "id": "2126",
+   "name": "Delaware 2012 Primary Election",
+   "electionDay": "2012-09-11"
+  }
+ ]
+}