civic_information 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ab684c9efb61701b321f0998377b80b71277d59670c5d9453a228dcebad8328
-  data.tar.gz: ebfef062642fa4e44e3c1ca1bd0614db3e67e211e31ef09a8db3e482771cb6fe
+  metadata.gz: f4b11cfc5030aaa88eda0379f0371d88f9f9c85704c5178c529245763fe61a34
+  data.tar.gz: 3c1f2659cccac88e8a0264640d4d50095923eb4f1fe5575787c573c3db306d6f
 SHA512:
-  metadata.gz: c6e25eb4f9702f5aa930f79338f7e4d9af33dbd0ddde009f6297dcb1a60b87ee1abf4e0e1ba27dd30451fd1cf9ce70da51f23381685d19ffb638c1320bae8ff2
-  data.tar.gz: e819221761bbb20638a397d0c35a010b561e94132c04853064505a0c877a8a87ddf0fa7c0d4b7dd7b941861cd2e0fe3e198c9df02a076708f2bb9fb35801edd0
+  metadata.gz: 7e277a8058ce64b1456154e5e86ca5b8091be1e5491e3d153ccd8e22526ec0d8c425c57cd2e6b5389abb27bd38e614a646cf2d04454e47d60a3280aa6534ac3e
+  data.tar.gz: cebc4524362c82d29238b3421757c96852bec0fe7f41d8f8038589b1b534c8460a9b4bcc7d92452147ef186f87a670ba0ec8999bc6ff3991efa7ffb7426857eb

data/.gitignore

@@ -6,3 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+*.gem
+
+.byebug_history

data/Gemfile.lock

@@ -1,28 +1,57 @@
 PATH
   remote: .
   specs:
-    civic_information (0.1.0)
+    civic_information (1.0.1)
       httparty (= 0.18.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (1.0.1)
     httparty (0.18.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
+    minitest (5.14.1)
     multi_xml (0.6.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    public_suffix (4.0.5)
+    rack (2.2.3)
+    rack-protection (2.0.8.1)
+      rack
     rake (12.3.3)
+    ruby2_keywords (0.0.2)
+    safe_yaml (1.0.5)
+    sinatra (2.0.8.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.8.1)
+      tilt (~> 2.0)
+    tilt (2.0.10)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.17)
+  byebug (~> 11.1, >= 11.1.3)
   civic_information!
+  minitest (~> 5.14, >= 5.14.1)
   rake (~> 12.3, >= 12.3.3)
+  sinatra (~> 2.0, >= 2.0.8)
+  webmock (~> 3.8, >= 3.8.3)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -42,6 +42,22 @@ CivicInformation.configure do |config|
 end
 ```
 
+## Usage
+
+After configuration, you can do the following things.
+
+### Representatives Resource
+
+[https://developers.google.com/civic-information/docs/v2/representatives](https://developers.google.com/civic-information/docs/v2/representatives)
+
+#### Searching
+
+```ruby
+CivicInformation::RepresentativesResource.
+  where(address: '55555', roles: ['legislatorLowerBody', 'legislatorUpperBody']).
+  officials.map(&:name)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/civic_information.gemspec

@@ -38,6 +38,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 12.3", ">= 12.3.3"
+  spec.add_development_dependency "minitest", "~> 5.14", ">= 5.14.1"
+  spec.add_development_dependency "webmock", "~> 3.8", ">= 3.8.3"
+  spec.add_development_dependency "sinatra", "~> 2.0", ">= 2.0.8"
+  spec.add_development_dependency "byebug", "~> 11.1", ">= 11.1.3"
 
   spec.add_dependency "httparty", "0.18.0"
 end

data/lib/civic_information.rb

@@ -1,7 +1,10 @@
 require "httparty"
 require "civic_information/version"
 require "civic_information/configuration"
-require "civic_information/models/representative"
+require "civic_information/models/representatives_resource"
+require "civic_information/models/representatives_resource/official"
+require "civic_information/models/representatives_resource/channel"
+require "civic_information/models/representatives_resource/address"
 
 module CivicInformation
   include HTTParty

data/lib/civic_information/models/representatives_resource.rb

@@ -0,0 +1,28 @@
+module CivicInformation
+  class RepresentativesResource
+    attr_accessor :officials
+
+    def self.where(address: nil, roles: nil)
+      response = CivicInformation.get "/representatives", query: {
+          key: CivicInformation.configuration.google_api_key,
+          address: address,
+          roles: roles
+        }.delete_if { |k, v| v.nil? }
+
+      self.new(
+        officials: build_officials(response.parsed_response["officials"] || [])
+      )
+    end
+
+    def initialize(officials:)
+      @officials = officials
+    end
+
+    private
+
+      def self.build_officials(officials_response)
+        officials_response.
+          map { |official| RepresentativesResource::Official.new(official) }
+      end
+  end
+end

data/lib/civic_information/models/representatives_resource/address.rb

@@ -0,0 +1,16 @@
+module CivicInformation
+  class RepresentativesResource::Address
+    attr_accessor :location_name, :line_one, :line_two, :line_three, :city,
+      :state, :zip
+
+    def initialize(address_json)
+      @location_name = address_json["locationName"]
+      @line_one = address_json["line1"]
+      @line_two = address_json["line2"]
+      @line_three = address_json["line3"]
+      @city = address_json["city"]
+      @state = address_json["state"]
+      @zip = address_json["zip"]
+    end
+  end
+end

data/lib/civic_information/models/representatives_resource/channel.rb

@@ -0,0 +1,10 @@
+module CivicInformation
+  class RepresentativesResource::Channel
+    attr_accessor :id, :type
+
+    def initialize(channel_json)
+      @id = channel_json["id"]
+      @type = channel_json["type"]
+    end
+  end
+end

data/lib/civic_information/models/representatives_resource/official.rb

@@ -0,0 +1,27 @@
+module CivicInformation
+  class RepresentativesResource::Official
+    attr_accessor :name, :photo_url, :party, :phones, :emails, :urls, :channels,
+      :addresses
+
+    def initialize(official_json)
+      @name = official_json["name"]
+      @photo_url = official_json["photoUrl"]
+      @party = official_json["party"]
+      @phones = official_json["phones"] || []
+      @emails = official_json["emails"] || []
+      @urls = official_json["urls"] || []
+      @channels = build_channels(official_json["channels"] || [])
+      @addresses = build_addresses(official_json["address"] || [])
+    end
+
+    private
+
+      def build_addresses(address_json)
+        address_json.map { |address| RepresentativesResource::Address.new(address) }
+      end
+
+      def build_channels(channels_json)
+        channels_json.map { |channel| RepresentativesResource::Channel.new(channel) }
+      end
+  end
+end

data/lib/civic_information/version.rb

@@ -1,3 +1,3 @@
 module CivicInformation
-  VERSION = "0.1.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: civic_information
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Will Olson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,6 +44,86 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.8
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +157,10 @@ files:
 - civic_information.gemspec
 - lib/civic_information.rb
 - lib/civic_information/configuration.rb
-- lib/civic_information/models/representative.rb
+- lib/civic_information/models/representatives_resource.rb
+- lib/civic_information/models/representatives_resource/address.rb
+- lib/civic_information/models/representatives_resource/channel.rb
+- lib/civic_information/models/representatives_resource/official.rb
 - lib/civic_information/version.rb
 homepage: https://github.com/frankolson/ruby-civic-information
 licenses:

data/lib/civic_information/models/representative.rb

@@ -1,23 +0,0 @@
-module CivicInformation
-  class Representative
-    attr_accessor :name, :phones
-
-    def self.where(address: nil, roles: nil)
-      response = CivicInformation.get "/representatives", query: {
-          key: CivicInformation.configuration.google_api_key,
-          address: address,
-          roles: roles
-        }.delete_if { |k, v| v.nil? }
-      officials = response.parsed_response["officials"] || []
-
-      officials.map do |representative|
-        self.new(representative)
-      end
-    end
-
-    def initialize(representative_json)
-      @name = representative_json["name"]
-      @phones = representative_json["phones"]
-    end
-  end
-end