get-your-rep 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 400808cc3fb333208695e812d8f422d0d7e2c124
-  data.tar.gz: 40a5530e00c1b791b98f07cf0ed1cadd929c6da8
+  metadata.gz: 9b0541c0a6fc00771ce898665eb5dcd1fc0c73a5
+  data.tar.gz: 98b6170d9fa0d37868c826218343002706f43bb2
 SHA512:
-  metadata.gz: bca14b9f2f1044a41f887a941dfba903d921100c05b8434bf2b2230103dc5a66fceeb6f81560e713f65343e908efe1793d4a2d1f6d689bc94f3c9865ec24478c
-  data.tar.gz: 40500826b049505345ad1f70483158367766a31aa8e67dd423e71762f2ea020eb43689168d5fca93aebbacc7ba15ac184c615f0c55adcc4a8eddb23d967365e7
+  metadata.gz: d1f40c6e1fc82f6019a00f798eee45ceb30e364e0f2dbc43e5f06bec2ddcde4f866aecec9553408867a38c363edd61c6a76a770c6647c6fc6ac74b4c36f06a76
+  data.tar.gz: ebad1ed2bb360ec70761381b36e38562b50bac2f0385fced2ffa2bbcece533401386538fafff33a6b4057d8b1f42a86ecf617e83317f31dd031e837fd0065aa2

data/lib/get-your-rep.rb

@@ -1,15 +1,14 @@
 # require 'pry'
 require 'httparty'
-require_relative 'getyourrep/rep.rb'
+require_relative 'get-your-rep/delegation.rb'
 
-# The GetYourRep class has a collection of class methods that retrieve a representative
+# The GetYourRep class has a collection of class methods that retrieve your elected representatives
 # from the Google Civic Information API, parse it from JSON, and assemble it into a usable
-# Ruby hash-like object called a Rep.
+# Ruby array-like object called a Delegation.
 class GetYourRep
 
-  # 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')
+  # Call GetYourRep#now to initiate a chain of method calls on self that will instantiate a Delegation object and return it.
+  def self.now(address, level: 'national', role: 'representative')
     @address = voter_address(address)
     @api_key = ENV['GOOGLE_API_KEY']
     @level = level
@@ -17,20 +16,20 @@ class GetYourRep
     @response = get_rep
     if @response.empty?
       puts 'Could not find your rep. Your location search might be too broad, try refining it.'
-      return nil
+      return Delegation.new
     elsif @response['error']
       puts 'Error message received. Confirm and re-enter your address and check your parameters.'
-      return @response
+      return Delegation.new
     end
     parse_rep
-    parse_channels if @official['channels']
-    @rep
+    parse_channels if @officials.any? { |official| official['channels'] }
+    @reps
   end
 
-  # Parses a String address and prepares for an HTTP request.
+  # Parses a String address and prepares for an HTTP request. Accepts Strings and Integers as args.
   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 = '0%o' % address if address.is_a?(Integer)
+    raise "Entry must be of types String or Integer" if !address.is_a?(String)
     address.tr(',', '').split.join('%20')
   end
 
@@ -38,9 +37,9 @@ class GetYourRep
   def self.get_rep
     level = case @level
             when 'national'
-              "country"
+              'country'
             when 'state'
-              "administrativeArea1"
+              'administrativeArea1'
             end
 
     role =  case @role
@@ -53,31 +52,42 @@ class GetYourRep
     HTTParty.get(url).parsed_response
   end
 
-  # Parses the JSON response and assembles it into a Rep object, except for social media attributes,
+  # Parses the JSON response and assembles it into a Delegation object, except for social media attributes,
   # which are handles by ::parse_channels.
   def self.parse_rep
-    @rep = Rep.new
-    @official = @response['officials'].first
+    @reps = Delegation.new
+    @officials = @response['officials']
 
-    @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']
+    i = 0
+    @officials.each do |official|
+      @reps[i] = {}
+
+      @reps[i][:name]          = official['name']
+      @reps[i][:office]        = @response['offices'].first['name']
+      @reps[i][:party]         = official['party']
+      @reps[i][:phone]         = official['phones'].first
+      @reps[i][:address_1]     = official['address'].first['line1']
+      @reps[i][:address_2]     = official['address'].first['line2']
+      @reps[i][:address_3]     = official['address'].first['line3']
+      @reps[i][:address_city]  = official['address'].first['city'].capitalize
+      @reps[i][:address_state] = official['address'].first['state']
+      @reps[i][:address_zip]   = official['address'].first['zip']
+      @reps[i][:email]         = official['emails'] if official['emails']
+      @reps[i][:url]           = official['urls'].first
+      @reps[i][:photo]         = official['photoUrl']
+      i += 1
+    end
   end
 
-  # Parses social media handles and adds them to the Rep object.
+  # Parses social media handles and adds them to the Delegation object.
   def self.parse_channels
-    @official['channels'].each do |channel|
-      @rep[channel['type'].downcase] = channel['id']
+    i = 0
+    @officials.each do |official|
+      next unless official['channels']
+      official['channels'].each do |channel|
+        @reps[i][channel['type'].downcase.to_sym] = channel['id']
+      end
+      i += 1
     end
   end
 end

data/lib/get-your-rep/delegation.rb

@@ -0,0 +1,46 @@
+# The Delegation class inherits from Array and describes methods that can be called on a Delegation for ease of display and database query.
+class Delegation < Array
+
+  # Overloads the << operator so the receiving object is not overwritten as an Array, and there are no nested Delegations.
+  def <<(value)
+    if value.is_a?(Delegation) || value.is_a?(Array)
+      self.replace(self + value)
+    else
+      super
+    end
+  end
+
+  # Collects the first names of every rep in the Delegation.
+  def first_names
+    self.map { |rep| rep[:name].split[0..-2].join(' ')}
+  end
+
+  # Collects the last names of every rep in the Delegation.
+  def last_names
+    self.map { |rep| rep[:name].split.last }
+  end
+
+  # Maps attributes to a simple array for easy printing, iteration, and display. It uses #each rather than #map so it can skip over nil values without mapping them.
+  def business_cards
+    card = []
+    i = 0
+    self.each do |rep|
+      card[i] = []
+      rep.each do |key, value|
+        next if value.nil?
+        case key
+        when :facebook
+          card[i] << "#{key.to_s.capitalize}: #{value}"
+        when :twitter
+          card[i] << "#{key.to_s.capitalize}: #{value}"
+        when :youtube
+          card[i] << "#{key.to_s.capitalize}: #{value}"
+        else
+          card[i] << "#{value}"
+        end
+      end
+      i += 1
+    end
+    card
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: get-your-rep
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - msimonborg
@@ -39,14 +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, check back for updates!
+  API key.
 email: msimonborg@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/get-your-rep.rb
-- lib/getyourrep/rep.rb
+- lib/get-your-rep/delegation.rb
 homepage: https://github.com/msimonborg/get-your-rep
 licenses:
 - MIT

data/lib/getyourrep/rep.rb

@@ -1,22 +0,0 @@
-# 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