get-your-rep 0.0.3.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3c54b6059d0012b8fb8e18bdcfb2d272a68596f
-  data.tar.gz: 39ca06d24c3e34fc86238310334129cf9b88faa1
+  metadata.gz: 400808cc3fb333208695e812d8f422d0d7e2c124
+  data.tar.gz: 40a5530e00c1b791b98f07cf0ed1cadd929c6da8
 SHA512:
-  metadata.gz: 3b28d04afa4b1c057fa2de4eeeb07f183124de1c07d888b76605e439caec23a16e3a5f104ed257a41423080ab48c23970907c53e88c62d458ecc1ee9a2683d1f
-  data.tar.gz: a9ac4209497c2b211f740c7561b40d9dc2d9261919d961ffb322cfdd862068ed6246ecc7f37d766d5abb4d4f57e6c8f0a69fc4c1812afd39ea9ea7642bc2b09e
+  metadata.gz: bca14b9f2f1044a41f887a941dfba903d921100c05b8434bf2b2230103dc5a66fceeb6f81560e713f65343e908efe1793d4a2d1f6d689bc94f3c9865ec24478c
+  data.tar.gz: 40500826b049505345ad1f70483158367766a31aa8e67dd423e71762f2ea020eb43689168d5fca93aebbacc7ba15ac184c615f0c55adcc4a8eddb23d967365e7

data/lib/get-your-rep.rb

@@ -1,29 +1,40 @@
+# require 'pry'
 require 'httparty'
+require_relative 'getyourrep/rep.rb'
+
+# The GetYourRep class has a collection of class methods that retrieve a representative
+# from the Google Civic Information API, parse it from JSON, and assemble it into a usable
+# Ruby hash-like object called a Rep.
 class GetYourRep
-  attr_accessor :rep, :rep_info, :address, :api_key, :level, :role
 
+  # Call GetYourRep#now to initiate a chain of method calls on self that will instantiate a Rep
+  # object and return it.
   def self.now(address, level = 'national', role = 'representative')
     @address = voter_address(address)
     @api_key = ENV['GOOGLE_API_KEY']
     @level = level
     @role = role
-    @rep = get_rep
-    if @rep.empty?
-      puts 'Could not find your rep.'
+    @response = get_rep
+    if @response.empty?
+      puts 'Could not find your rep. Your location search might be too broad, try refining it.'
       return nil
-    elsif @rep['error']
-      puts 'Error message received. Confirm and re-enter your address'
-      return @rep
+    elsif @response['error']
+      puts 'Error message received. Confirm and re-enter your address and check your parameters.'
+      return @response
     end
     parse_rep
-    parse_channels
-    @rep_info
+    parse_channels if @official['channels']
+    @rep
   end
 
+  # Parses a String address and prepares for an HTTP request.
   def self.voter_address(address)
+    # TODO try to convert FixNum submissions to String
+    raise "Entry must be of type String" if !address.is_a?(String)
     address.tr(',', '').split.join('%20')
   end
 
+  # Sets parameters for and executes Google API request.
   def self.get_rep
     level = case @level
             when 'national'
@@ -42,26 +53,31 @@ class GetYourRep
     HTTParty.get(url).parsed_response
   end
 
+  # Parses the JSON response and assembles it into a Rep object, except for social media attributes,
+  # which are handles by ::parse_channels.
   def self.parse_rep
-    @rep_info = {
-      'office'        => @rep['offices'].first['name'],
-      'name'          => @rep['officials'].first['name'],
-      'party'         => @rep['officials'].first['party'],
-      'phone'         => @rep['officials'].first['phones'].first,
-      'address_1'     => @rep['officials'].first['address'].first['line1'],
-      'address_2'     => @rep['officials'].first['address'].first['line2'],
-      'address_3'     => @rep['officials'].first['address'].first['line3'],
-      'address_city'  => @rep['officials'].first['address'].first['city'].capitalize,
-      'address_state' => @rep['officials'].first['address'].first['state'],
-      'address_zip'   => @rep['officials'].first['address'].first['zip'],
-      'url'           => @rep['officials'].first['urls'].first,
-      'photo'         => @rep['officials'].first['photoUrl'],
-    }
+    @rep = Rep.new
+    @official = @response['officials'].first
+
+    @rep['name']          = @official['name']
+    @rep['office']        = @response['offices'].first['name']
+    @rep['party']         = @official['party']
+    @rep['phone']         = @official['phones'].first
+    @rep['address_1']     = @official['address'].first['line1']
+    @rep['address_2']     = @official['address'].first['line2']
+    @rep['address_3']     = @official['address'].first['line3']
+    @rep['address_city']  = @official['address'].first['city'].capitalize
+    @rep['address_state'] = @official['address'].first['state']
+    @rep['address_zip']   = @official['address'].first['zip']
+    @rep['email']         = @official['emails'] if @official['emails']
+    @rep['url']           = @official['urls'].first
+    @rep['photo']         = @official['photoUrl']
   end
 
+  # Parses social media handles and adds them to the Rep object.
   def self.parse_channels
-    @rep['officials'].first['channels'].each do |channel|
-      @rep_info[channel['type'].downcase] = channel['id']
+    @official['channels'].each do |channel|
+      @rep[channel['type'].downcase] = channel['id']
     end
   end
 end

data/lib/getyourrep/rep.rb

@@ -0,0 +1,22 @@
+# The Rep class inherits from Hash and describes methods that can be called on a Rep
+class Rep < Hash
+
+  # business_card can be called on an instance of Rep to map it's attributes to an array for easy printing, iteration, and display. It uses #each so it can skip over nil values without mapping them.
+  def business_card
+    card = []
+    self.each do |key, value|
+      next if value.nil?
+      case key
+      when 'facebook'
+        card << "#{key.capitalize}: #{value}"
+      when 'twitter'
+        card << "#{key.capitalize}: #{value}"
+      when 'youtube'
+        card << "#{key.capitalize}: #{value}"
+      else
+        card << "#{value}"
+      end
+    end
+    card
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: get-your-rep
 version: !ruby/object:Gem::Version
-  version: 0.0.3.0
+  version: 0.1.0
 platform: ruby
 authors:
 - msimonborg
@@ -39,13 +39,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Get your rep with Google's Civic Information API using your address and
-  API key. Work in progress!!
+  API key. Work in progress, check back for updates!
 email: msimonborg@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/get-your-rep.rb
+- lib/getyourrep/rep.rb
 homepage: https://github.com/msimonborg/get-your-rep
 licenses:
 - MIT
@@ -58,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="