get_your_rep 0.1.9 → 1.0.0

data/lib/get_your_rep/office_location.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module GetYourRep
+  # Office information. Belongs to Representative.
+  class OfficeLocation
+    include GetYourRep::Errors
+
+    # Each instance belongs to a Represenative, which has many OfficeLocations.
+    attr_accessor :rep
+    # Defines the type of office ('district' or 'capitol')
+    attr_accessor :type
+    # Line 1 of address.
+    attr_accessor :line_1
+    # Line 2 of address.
+    attr_accessor :line_2
+    # City, state and zip.
+    attr_accessor :city, :state, :zip
+
+    # Construct a new instance, setting attributes from an options hash.
+    def initialize(office_hash = {})
+      office_hash.each do |key, val|
+        send("#{key}=", val)
+      end
+    end
+
+    # Set the rep attribute to an instance of a Representative, and make two-way association.
+    def rep=(other)
+      if other.is_a?(Representative)
+        @rep = other
+        other.add_office_location(self) unless other.office_locations.include?(self)
+      else
+        not_a_rep_error
+      end
+    end
+
+    # Display self attributes for CLI.
+    def cli_display
+      puts "  #{type.capitalize} Office".bold.blue
+      office_lines = [line_1, line_2, "#{city}, #{state} #{zip}"]
+      office_lines.each { |line| puts "    #{line}".red if line }
+    end
+  end
+end

data/lib/get_your_rep/open_states.rb

@@ -1,114 +1,56 @@
+# frozen_string_literal: true
 module GetYourRep
-
   # Retrieve your elected state representatives from the Open States API, parse it from
   # JSON, and assemble it into a usable Ruby Hash-like object called a Representative.
   # Representatives are then wrapped in an Array-like object called a Delegation.
-  class OpenStates
-
-    # Initiates a chain of class method calls that will instantiate a
-    # Delegation object and return it.
-    def self.now(address)
-      @coordinates = if address.is_a?(Array)
-                       address
-                     else
-                       get_coordinates(address)
-                     end
-      @response = get_rep
-      if @response.empty? || @response.is_a?(String) || @response.first['error']
-        puts 'Error message received. Confirm and re-enter your address and check your parameters.'
-        puts @response
-        return GetYourRep::Delegation.new
-      end
-
-      parse_rep
-      @delegation
-    end
-
-    # Geocodes an address and returns the coordinates.
-    def self.get_coordinates(address)
-      return address if address.is_a?(Array)
-      address = '0%o' % address if address.is_a?(Integer)
-      raise "Entry must be coordinates or of types String or Integer" if !address.is_a?(String)
-      Geocoder.coordinates(address)
-    end
-
-    # Sets parameters for and executes Open States API request.
-    def self.get_rep
-      if @coordinates
-        lat  = @coordinates.first
-        long = @coordinates.last
-        url = "http://openstates.org/api/v1/legislators/geo/?lat=#{lat}&long=#{long}"
-        HTTParty.get(url).parsed_response
-      else
-        []
-      end
-    end
-
-    # Parses the JSON response and assembles it into a Delegation object.
-    def self.parse_rep
-
-      @delegation = GetYourRep::Delegation.new
-
-      @response.each do |rep|
-        @delegation << GetYourRep::Representative[
-          :name,             rep['full_name'].split(', ').reverse.join(' '),
-          :office,           "#{rep['state'].upcase} #{rep['chamber'].capitalize} Chamber, #{rep['district']}",
-          :party,            rep['party'],
-          :phone,            phone(rep),
-          :office_locations, offices(rep),
-          :email,            email(rep),
-          :url,              rep['url'],
-          :photo,            rep['photo_url'],
-          :twitter,          nil,
-          :facebook,         nil,
-          :youtube,          nil,
-          :googleplus,       nil,
-          :committees,       committees(rep)
-        ]
-      end
-    end
-
-    def self.offices(rep)
-      rep['offices'].map do |office|
-
-        # TODO change office parsing to RegEx
-        office_hash = {}
-        office_hash[:type] = office['type']
-        address = office['address'].split("\n")
-
-        if address.size == 1
-          address = office['address'].split(', ')
+  module OpenStates
+    class << self
+      include GetYourRep
+
+      # Holds the coordinates geocoded from the address. Used in the HTTP request to the API.
+      attr_accessor :coordinates
+      # Holds the Delegation object which will be returned by the all_reps class method.
+      attr_accessor :delegation
+      # Holds the raw JSON data response from the API.
+      attr_accessor :response
+
+      # Initiates a chain of class method calls that will instantiate a
+      # Delegation object and return it.
+      def all_reps(address)
+        self.coordinates = address.is_a?(Array) ? address : get_coordinates(address)
+        self.response    = find_rep
+        if response.empty? || response.is_a?(String) || response.first['error']
+          handle_reps_not_found_error
+        else
+          parse_reps
+          delegation
         end
+      end
 
-        if office['name'].downcase != "capitol office" &&
-           office['name'].downcase != "district office"
-
-          address.unshift(office['name'])
+      private
+
+      # Sets parameters for and executes Open States API request.
+      def find_rep
+        if coordinates
+          lat  = coordinates.first
+          long = coordinates.last
+          url = "http://openstates.org/api/v1/legislators/geo/?lat=#{lat}&long=#{long}"
+          HTTParty.get(url).parsed_response
+        else
+          Delegation.new
         end
+      end
 
-        i = 1
-        address.each do |line|
-          office_hash["line_#{i}".to_sym] = line
-          i += 1
+      # Parses the JSON response and assembles it into a Delegation object.
+      def parse_reps
+        self.delegation = Delegation.new
+        response.each do |rep|
+          external_rep = OpenStatesRep.new(rep)
+          rep_hash     = external_rep.build_hash
+          new_rep      = Representative.new(rep_hash)
+          delegation.add_rep(new_rep)
         end
-
-        office_hash
       end
     end
-
-    # Parses the phone, giving preference to district office..
-    def self.phone(rep)
-      rep['offices'].map { |office| office['phone']} - [nil]
-    end
-
-    # Parses the email address.
-    def self.email(rep)
-      rep['offices'].map { |office| office['email'] } - [nil]
-    end
-
-    # Parses committee involvement.
-    def self.committees(rep)
-      rep['roles'].map { |role| role['committee'] } - [nil]
-    end
   end
 end

data/lib/get_your_rep/patriotic.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+module GetYourRep
+  # Red, white and blue decorations for CLI.
+  module Patriotic
+    # Stars banner.
+    def self.banner
+      puts ' ' + '_' * 23 + ' '.bold.red
+      puts "\u23B9".bold.red + ' * * * * * * * * * * * '.white.on_blue + "\u23B8".bold.red
+      puts ' ' + "\u203E".bold.red * 23 + ' '
+    end
+
+    # Stars and Bars
+    def self.stars_and_bars
+      4.times { puts stars_and_red_bar, stars_and_white_bar }
+      puts stars_and_red_bar
+      3.times { puts white_bar, red_bar }
+    end
+
+    # Stars and red bar.
+    def self.stars_and_red_bar
+      ' *   *   *   *   *   * '.white.on_blue + '                                  '.on_red
+    end
+
+    # Stars and white bar.
+    def self.stars_and_white_bar
+      '   *   *   *   *   *   '.white.on_blue + '                                  '.on_white
+    end
+
+    # Red bar.
+    def self.red_bar
+      '                                                         '.on_red
+    end
+
+    # White bar.
+    def self.white_bar
+      '                                                         '.on_white
+    end
+
+    # Fireworks welcome message.
+    def self.welcome
+      puts ''
+      2.times do
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e   '.red + 'y o u r '.white + 'r e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e t '.red + 'y o   r '.white + 'r e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e t '.red + 'y o u r '.white + 'r   p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e t '.red + 'y o u   '.white + 'r e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e t '.red + '  o u r '.white + 'r e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + '  e t '.red + 'y o u r '.white + 'r e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e t '.red + 'y o u r '.white + 'r e   '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e t '.red + 'y o u r '.white + 'r e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e t '.red + 'y   u r '.white + 'r e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g   t '.red + 'y o u r '.white + 'r e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e t '.red + 'y o u r '.white + '  e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+        sleep(0.05)
+        print "\r" + '- '.red + '- '.white + '- '.blue + 'g e t '.red + 'y o u r '.white + 'r e p '.blue +
+                  '- '.red + '- '.white + '- '.blue
+      end
+      puts ''
+    end
+  end
+end

data/lib/get_your_rep/representative.rb

@@ -1,294 +1,128 @@
+# frozen_string_literal: true
 module GetYourRep
-
   # Stores rep info in key/value pairs, and makes values accessible by instance method.
-  class Representative < Hash
-
-    # 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_card
-
-      card = []
-
-      self.each do |key, value|
-        next if value.nil?
-        if key == :facebook || key == :twitter || key == :youtube || key == :googleplus
-          card << "#{key.to_s.capitalize}: #{value}"
-        else
-          card << "#{value}"
-        end
+  class Representative
+    include GetYourRep::Errors
+
+    # The Delegation object that the instance belongs to.
+    attr_reader   :delegation
+    # Rep personal attributes.
+    attr_accessor :name, :middle_name, :office, :phones, :party, :email, :committees, :url,
+                  :photo, :twitter, :facebook, :youtube, :googleplus
+
+    # Set office_locations, phones, and email as empty arrays. Set the rest of the attributes
+    # from the options hash.
+    def initialize(rep_hash = {})
+      @office_locations = []
+      @phones           = []
+      @email            = []
+      rep_hash.each do |key, val|
+        send("#{key}=", val)
       end
-
-      card
-    end
-
-    # Get the :name value.
-    def name
-      @name = self[:name]
-    end
-
-    # Set the :name value.
-    def name=(value)
-      @name = value
-      self[:name] = @name
     end
 
-    # Strips the first name out of the full name if there's no :first_name.
-    def first_name
-
-      return self[:first_name] if self[:first_name]
-
-      if name.split.count == 1
-        nil
-      elsif (name.split.count > 3) || (name.split[-2].downcase == name.split[-2])
-        name.split[0..-3].join(' ')
+    # Sets the Delegation object that the instance belongs to. Will add self to the Delegation's
+    # reps if not done so already.
+    def delegation=(other)
+      if other.is_a?(Delegation)
+        @delegation = other
+        other.add_rep(self) unless other.reps.include?(self)
       else
-        name.split[0..-2].join(' ')
+        not_a_del_error
       end
-
-    end
-
-    # Get the :middle_name value.
-    def middle_name
-      @middle_name = self[:middle_name]
-    end
-
-    # Strips the surname out of the full name if there's no :last_name.
-    def last_name
-
-      return self[:last_name] if self[:last_name]
-
-      if name.split.count == 1
-        name
-      elsif (name.split.count > 3) || (name.split[-2].downcase == name.split[-2])
-        name.split[-2..-1].join(' ')
-      else
-        name.split.last
-      end
-
-    end
-
-    # Get the :office value.
-    def office
-      @office = self[:office]
-    end
-
-    # Set the :office value.
-    def office=(value)
-      @office = value
-      self[:office] = @office
-    end
-
-    # Get the :party value.
-    def party
-      @party = self[:party]
-    end
-
-    # Set the :party value.
-    def party=(value)
-      @party = value
-      self[:party] = @party
-    end
-
-    # Get the :phone value.
-    def phone
-      @phone = self[:phone]
     end
 
-    # Set the :phone value.
-    def phone=(value)
-      @phone = value
-      self[:phone] = @phone
-    end
-
-    # Get the :alt_phone value.
-    # def alt_phone
-    #   @alt_phone = self[:alt_phone]
-    # end
-
-    # Set the :alt_phone value.
-    # def alt_phone=(value)
-    #   @alt_phone = value
-    #   self[:alt_phone] = @alt_phone
-    # end
-
-    # Get the :alt_address_1 value.
-    # def alt_address_1
-    #   @alt_address_1 = self[:alt_address_1]
-    # end
-
-    # Set the :alt_address_1 value.
-    # def alt_address_1=(value)
-    #   @alt_address_1 = value
-    #   self[:alt_address_1] = @alt_address_1
-    # end
-
-    # Get the :alt_address_2 value.
-    # def alt_address_2
-    #   @alt_address_2 = self[:alt_address_2]
-    # end
-
-    # Set the :alt_address_2 value.
-    # def alt_address_2=(value)
-    #   @alt_address_2 = value
-    #   self[:alt_address_2] = @alt_address_2
-    # end
-
-    # Get the :alt_address_3 value.
-    # def alt_address_3
-    #   @alt_address_3 = self[:alt_address_3]
-    # end
-
-    # Set the :alt_address_3 value.
-    # def alt_address_3=(value)
-    #   @alt_address_3 = value
-    #   self[:alt_address_3] = @alt_address_3
-    # end
-
-    # Get the :address_1 value.
-    # def address_1
-    #   @address_1 = self[:address_1]
-    # end
-
-    # Set the :address_1 value.
-    # def address_1=(value)
-    #   @address_1 = value
-    #   self[:address_1] = @address_1
-    # end
-
-    # Get the :address_2 value.
-    # def address_2
-    #   @address_2 = self[:address_2]
-    # end
-
-    # Set the :address_2 value.
-    # def address_2=(value)
-    #   @address_2 = value
-    #   self[:address_2] = @address_2
-    # end
-
-    # Get the :address_3 value.
-    # def address_3
-    #   @address_3 = self[:address_3]
-    # end
-
-    # Set the :address_3 value.
-    # def address_3=(value)
-    #   @address_3 = value
-    #   self[:address_3] = @address_3
-    # end
-
+    # Returns a frozen duplicate of the office_locations array.
     def office_locations
-      @office_locations = self[:office_locations]
+      @office_locations.dup.freeze
     end
 
-    def office_locations=(value)
-      @office_locations = value
-      self[:office_locations] = @office_locations
+    # Empties the office_locations array.
+    def clear_office_locations
+      @office_locations.clear
     end
 
-    def district_office
-      @district_office = self.office_locations.select { |loc| loc[:type] == 'district' }.first
-      if @district_office.nil?
-        {}
+    # Creates a new OfficeLocation association. Sets self as the other's rep if not done so already.
+    def add_office_location(other)
+      if other.is_a?(OfficeLocation)
+        @office_locations << other
+        other.rep = self unless other.rep == self
       else
-        @district_office
+        not_an_office_error
       end
     end
 
-    def capitol_office
-      @capitol_office = self.office_locations.select { |loc| loc[:type] == 'capitol' }.first
-      if @capitol_office.nil?
-        {}
+    # Assign an individual OfficeLocation, or an array of them.
+    def office_locations=(other)
+      if other.is_a?(Array)
+        other.each { |val| add_office_location(val) }
       else
-        @capitol_office
+        add_office_location(other)
       end
     end
 
-    # Get the :email value.
-    def email
-      @email = self[:email]
-    end
-
-    # Set the :email value.
-    def email=(value)
-      @email = value
-      self[:email] = @email
-    end
-
-    # Get the :committees value.
-    def committees
-      @committees = self[:committees]
-    end
-
-    # Set the :committees value.
-    def committees=(value)
-      @committees = value
-      self[:committees] = @committees
-    end
-
-    # Get the :url value.
-    def url
-      @url = self[:url]
-    end
-
-    # Set the :url value.
-    def url=(value)
-      @url = value
-      self[:url] = @url
-    end
-
-    # Get the :photo value.
-    def photo
-      @photo = self[:photo]
-    end
-
-    # Set the :photo value.
-    def photo=(value)
-      @photo = value
-      self[:photo] = @photo
+    # Parse the first name from the :name.
+    def first_name
+      @first_name ||= if name_count == 1
+                        nil
+                      elsif (name_count > 3) || (name_array[-2].downcase == name_array[-2])
+                        name_array[0..-3].join(' ')
+                      else
+                        name_array[0..-2].join(' ')
+                      end
     end
 
-    # Get the :twitter value.
-    def twitter
-      @twitter = self[:twitter]
+    # Parse the last name from the :name.
+    def last_name
+      @last_name ||= if name_count == 1
+                       name
+                     elsif (name_count > 3) || (name_array[-2].downcase == name_array[-2])
+                       name_array[-2..-1].join(' ')
+                     else
+                       name_array.last
+                     end
     end
 
-    # Set the :twitter value.
-    def twitter=(value)
-      @twitter = value
-      self[:twitter] = @twitter
+    # Splits the name into an array.
+    def name_array
+      @name_array ||= name.split
     end
 
-    # Get the :facebook value.
-    def facebook
-      @facebook = self[:facebook]
+    # Counts the elements in the name array.
+    def name_count
+      @name_count ||= name_array.size
     end
 
-    # Set the :facebook value.
-    def facebook=(value)
-      @facebook = value
-      self[:facebook] = @facebook
+    # Maps the offices with the :type attribute equal to 'district'.
+    def district_offices
+      @district_offices ||= office_locations.select { |office| office.type == 'district' }
     end
 
-    # Get the :youtube value.
-    def youtube
-      @youtube = self[:youtube]
+    # Maps the offices with the :type attribute equal to 'capitol'.
+    def capitol_offices
+      @district_offices ||= office_locations.select { |office| office.type == 'capitol' }
     end
 
-    # Set the :youtube value.
-    def youtube=(value)
-      @youtube = value
-      self[:youtube] = @youtube
+    # Displays self for the CLI.
+    def cli_display
+      cli_basic_info
+      office_locations.each(&:cli_display)
+      cli_display_committees
     end
 
-    # Get the :googleplus value.
-    def googleplus
-      @googleplus = self[:googleplus]
+    # Display basic info.
+    def cli_basic_info
+      puts name.bold.blue
+      puts "  #{office}".red
+      puts "  #{party}".red
+      phones.each { |phone| puts "  #{phone}".red }
     end
 
-    # Set the :googleplus value.
-    def googleplus=(value)
-      @googleplus = value
-      self[:googleplus] = @googleplus
+    # Display committee info.
+    def cli_display_committees
+      return unless committees && !committees.empty?
+      puts '  Committees'.bold.blue
+      committees.each { |comm| puts "    #{comm}".red }
     end
   end
 end