get_your_rep 0.1.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1782c2a5230bdcc479cec091d9a35c066e8fd845
-  data.tar.gz: 968959010cce628943b0451ff3b21d5389c3b628
+  metadata.gz: ba6cc36506ebdc000dd985795884989ae947ec4a
+  data.tar.gz: ae75fd36e09b93d71417ed39b24e674169356610
 SHA512:
-  metadata.gz: 743d761b375e97435248cf3b1f9a798c6b5282fdb21bcfdde43999894083086730483ce353272f7c2afa0f462ff8e39b465b31218832d0f5f0874d3ba0404283
-  data.tar.gz: 574ec214a72556ed7b3bc3bff029a74007a0c7398abec54f27d17f541bea72df6f1120b08cad16fe462fdc128de7a6528e497fddfdb06f78ea31f44942ec441d
+  metadata.gz: 1644ce639ff3fedb084bfd2e5ace28633d355da9a63ce7ca5134f10483746f4a45335b6f75c8956207309fa5f738775a101c7985ae320942856464feb5093722
+  data.tar.gz: fedee5d0c4d211768ba342f988553c4af70687cc49c27c20d1b09041a93a38865c7bea921ddc5b648610b1402f7e40aba978651ea4f68e5eb3a5bf7525e9ed83

data/.gitignore

@@ -0,0 +1,55 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+# RubyMine project settings
+.idea
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+Contact GitHub API Training Shop Blog About
+© 2016 GitHub, Inc. Terms Privacy Security Status Help

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'lib/get_your_rep/patriotic.rb'
+
+Metrics/MethodLength:
+  Max: 15
+  Exclude:
+    - 'test/*'
+    - 'lib/get_your_rep/cli.rb'
+    - 'lib/get_your_rep/patriotic.rb'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  Exclude:
+    - 'lib/get_your_rep/patriotic.rb'
+
+Style/HashSyntax:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 m. simon borg
+
+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,84 @@
+# Get yo' rep!
+
+This is the companion [gem](https://rubygems.org/gems/get_your_rep) for the [Phone Your Rep API] (https://github.com/thecristen/phone-your-rep-api)
+
+This gem sends requests to the Google Civic Information API for info on your representatives and parses the JSON response into a Ruby hash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'get_your_rep'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install get_your_rep
+
+## You must use your own Google API key activated for use with the [Civic Information API](https://developers.google.com/civic-information/).
+
+Add this line to your ~/.bashrc or ~/.bash_profile
+`export GOOGLE_API_KEY="<YOUR_API_KEY>"`
+
+## Usage
+
+### Usage documentation is out of date with new release. Update coming soon. Install and setup are accurate!
+
+Send queries like this `reps = GetYourRep.now(address, level:, role:)` to gather a Delegation of Representatives.
+
+`address` is your address. You can use just a zip code, but use a full address for the best results. Don't worry about commas, spaces, character case, or `.`s (`"123 1/2 main St., anywhere    CA 12345"` is A-OK)
+
+Some queries will return `nil` when using only a zip code because not every zip code can be directly mapped to a voting district. I strongly recommend using a full address.
+
+`:level` is the level of government. The two values that are currently supported are `"state"` and `"national"`. The default value is `"national"`
+
+`:role` corresponds to the rep's legislative house. The values that are currently supported are `"representative"`, `"senator"`, `"executive"` and `"vice executive"`. The default value is `"representative"`
+
+Add Delegations together with `reps << other_reps`.
+
+Or, get Congress, State Legislature, Governor and Lieutenant Governor all at once with `GetYourRep.all(address)`.
+
+When making db queries, for instance in a Rails app, you can use form useful collection like this:
+
+```
+2.3.3 :008 > reps
+ => [{...}, {...}, {...}, {...}, {...}]
+2.3.3 :009 > reps.first_names
+ => ["Peter", "Bernard", "Patrick J.", "Peter", "Phil"]
+2.3.3 :010 > reps.last_names
+ => ["Welch", "Sanders", "Leahy", "Shumlin", "Scott"]
+```
+
+`reps.business_cards` gathers attributes of all reps in a Delegation into a simple array for easy iteration.
+
+You can access an individual Representative and its attributes like this:
+```
+2.3.3 :003 > rep = reps.second
+ => {:name=>"Bernard Sanders", :office=>"United States Senate", :party=>"Independent", :phone=>"(202) 224-5141", :address_1=>"332 dirksen building", :address_2=>nil, :address_3=>"Washington, DC 20510", :email=>nil, :url=>"http://www.sanders.senate.gov/", :photo=>"http://bioguide.congress.gov/bioguide/photo/S/S000033.jpg", :googleplus=>"+BernieSanders", :facebook=>"senatorsanders", :twitter=>"sensanders", :youtube=>"senatorsanders"}
+2.3.3 :004 > rep.name
+ => "Bernard Sanders"
+2.3.3 :005 > rep.first_name
+ => "Bernard"
+2.3.3 :006 > rep.last_name
+ => "Sanders"
+2.3.3 :007 > rep.party
+ => "Independent"
+```
+
+## 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. Add `export GOOGLE_API_KEY="<YOUR_API_KEY>"` to your `.bashrc` or `.bash_profile` and then `bundle exec rake_test`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/msimonborg/get_your_rep.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'get_your_rep'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/config.reek

@@ -0,0 +1,18 @@
+Attribute:
+  enabled: false
+
+DuplicateMethodCall:
+  exclude:
+    - ['lib/get_your_rep/patriotic.rb']
+
+TooManyStatements:
+  exclude:
+    - ['lib/get_your_rep/patriotic.rb']
+
+TooManyMethods:
+  exclude:
+    - ['lib/get_your_rep/representative.rb'] # #business_card is the offender. TODO: write method or delete.
+
+UncommunicativeVariableName:
+  exclude:
+    - ['lib/get_your_rep/responses/google_office.rb'] # doesn't like @line1 and @line1 but I don't care.

data/exe/reps

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'get_your_rep'
+
+GetYourRep::CLI.call

data/get_your_rep.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date'
+require 'get_your_rep/version'
+
+Gem::Specification.new do |s|
+  s.name                     = 'get_your_rep'
+  s.version                  = GetYourRep::VERSION
+  s.date                     = Date.today.to_s
+  s.required_ruby_version    = '>= 2.0.0'
+  s.post_install_message     = "If you are upgrading from get_your_rep ~> 0.1, version 1.0 may break your app. It is \
+a good idea to upgrade, but please read the documentation first!"
+  s.add_dependency             'httparty', '~> 0'
+  s.add_dependency             'geocoder', '~> 1.4', '>= 1.4.1'
+  s.add_dependency             'colorize', '~> 0.8.1'
+  s.add_development_dependency 'pry',      '~> 0'
+  s.add_development_dependency 'minitest', '~> 5.10', '>= 5.10.1'
+  s.add_development_dependency 'minitest-reporters', '~> 1.1', '>= 1.1.13'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.summary       = "Get yo' rep!"
+  s.description   = "Get your rep(s) from Google's Civic Information API and Open States. Formerly get-your-rep."
+  s.authors       = ['msimonborg']
+  s.email         = 'msimonborg@gmail.com'
+  s.homepage      = 'https://github.com/msimonborg/get-your-rep'
+  s.license       = 'MIT'
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/get_your_rep.rb

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'geocoder'
+require 'colorize'
+require 'pry' # TODO: remove for publication
+
+require 'get_your_rep/version'
+require 'get_your_rep/errors'
+require 'get_your_rep/get_your_rep_module'
+require 'get_your_rep/patriotic'
+require 'get_your_rep/cli'
 require 'get_your_rep/open_states'
 require 'get_your_rep/delegation'
 require 'get_your_rep/representative'
 require 'get_your_rep/google'
-require 'core_extensions/array/get_your_rep_mutations'
-require 'core_extensions/hash/get_your_rep_mutations'
-
-##
-# Monkey patch the Array and Hash classes with .to_rep and .to_del methods.
-Array.include CoreExtensions::Array::GetYourRepMutations
-Hash.include  CoreExtensions::Hash::GetYourRepMutations
-
-##
-# Top level namespace.
-module GetYourRep
+require 'get_your_rep/office_location'
+require 'get_your_rep/responses/open_states_office'
+require 'get_your_rep/responses/base'
+require 'get_your_rep/responses/open_states_rep'
+require 'get_your_rep/responses/google_office'
+require 'get_your_rep/responses/google_rep'
 
-  ##
-  # Get all reps using Google for state executives and national reps,
-  # and OpenStates for state reps.
-  def self.all(address)
-    @reps = Google.top_level_reps(address)
-    @reps << OpenStates.now(address)
-  end
-end
+# Top level namespace
+module GetYourRep; end

data/lib/get_your_rep/cli.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+module GetYourRep
+  # Command Line Interface
+  module CLI # :nodoc:
+    class << self
+      include GetYourRep
+
+      attr_reader :line, :address, :delegation
+
+      def call
+        Patriotic.stars_and_bars
+        Patriotic.welcome
+        @line = 0
+        start
+      end
+
+      private
+
+      def start
+        puts '', "Type 'help' for help".blue
+        loop do
+          new_line
+          print "[#{line}] gyr(#{VERSION}) -> "
+          input = gets.strip.downcase
+
+          case input
+          when 'help'
+            help
+          when 'exit'
+            break
+          when 'set address'
+            set_address
+          when 'address'
+            find_or_set_address
+          when 'all reps'
+            all_reps
+          when 'google all reps'
+            google_all_reps
+          when 'google congress only'
+            google_congress_only
+          when 'open states'
+            open_states
+          else
+            command_not_found_error
+          end
+        end
+      end
+
+      def find_or_set_address
+        puts address || set_address
+      end
+
+      def new_line
+        @line += 1
+      end
+
+      def help
+        puts "'help'...................list of commands".bold.blue
+        puts "'address'................displays address or sets it if there is none".bold.blue
+        puts "'set address'............set a new address".bold.blue
+        puts "'all reps'...............get federal legislators from Google".bold.blue
+        puts "                         and state legislators from Open States".bold.blue
+        puts "'google all reps'........get all federal and state executives and".bold.blue
+        puts "                         legislators from Google".bold.blue
+        puts "'google congress only'...get only congress from Google".bold.blue
+        puts "'open states'............get only state legislators from Open States".bold.blue
+      end
+
+      def set_address
+        puts "\nThe most accurate results will always be achieved with a full address, \n\
+but you can try a zip code if you insist.".yellow
+        puts 'Hint: '.bold.blue + 'GYR will geocode your zip to an address anyway.'.yellow
+        print "\nPlease enter your address -> "
+        self.address = gets.strip
+      end
+
+      def address=(value)
+        @address = address_is_a_zip?(value) ? convert_zip_to_address(value) : value
+      end
+
+      def all_reps
+        address || set_address
+        super(address)
+        display_reps
+      end
+
+      def google_all_reps
+        address || set_address
+        @delegation = Google.all_reps(address)
+        display_reps
+      end
+
+      def google_congress_only
+        address || set_address
+        @delegation = Google.all_reps(address, congress_only: true)
+        display_reps
+      end
+
+      def open_states
+        address || set_address
+        @delegation = OpenStates.all_reps(address)
+        display_reps
+      end
+
+      def display_reps
+        delegation.reps.each do |rep|
+          @banner ||= Patriotic.banner
+          rep.cli_display
+        end
+      end
+    end
+  end
+end