governator 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0786767ccd0fd5582e610a5624efa8637ad61996'
-  data.tar.gz: 27c94c6ec91d39c2a4f7db1508fc9175b0bdef26
+  metadata.gz: cc2cfb3afb5a52e54736ec79856170eae33635ca
+  data.tar.gz: 5d707a4ee20acefff40bc18565615e9df2bf9d29
 SHA512:
-  metadata.gz: dc01befab8bb1465b9704709ea70df929b028fdb79aed39db6c9eb6fb4879afe5ade43623ddda86de8a5f0455f8c585ab7471cd55f12aea773e1639f3f3bde9e
-  data.tar.gz: c3ff56a12367e31f02ed04124fad148bcc2d57845e9dc677a9a610235c9daa9bd07e5dfede666446ee8015dcd9afebba0bbd5f7a1895e3f0d3ba34c4a94f7297
+  metadata.gz: a06d70c950212b8f5436b9d4085841c14f67f7443eab04a2f14f4c9cba7076e56709c2f9ccdba9094c932f643f7d854190d24bac4bed708a791e9be472e101f7
+  data.tar.gz: 71ab8dd0ac9214a82982e54c01ba2ceff210403e50c0c0f94949b59c9ba3e12d452b5fddc47acb247645d92a134098eb50c2240e65892121cf2b9542cba9bc5a

data/governator.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_dependency 'faraday', '~> 0.11.0'
   spec.add_dependency 'twitter', '~> 6.1.0'
   spec.add_dependency 'nokogiri', '~> 1.8.0'
 

data/lib/governator/bio_page.rb

@@ -1,23 +1,24 @@
 # frozen_string_literal: true
 
+require 'governator/http_client'
 require 'governator/page_scraper'
 
 class Governator
+  # Scrapes the biographical page for an individual Governor
   class BioPage < PageScraper
+    include HTTPClient
+
     attr_reader :uri
 
     def initialize(uri)
       @uri = uri
-      @raw = Nokogiri::HTML(CONN.get(uri).body)
+      @raw = Nokogiri::HTML get_page_contents(uri)
       check_for_alt_office
     end
 
     def check_for_alt_office
-      @alt_office_present = if raw.css('address')[2].to_s =~ /Phone|Address|Fax/
-                              true
-                            else
-                              false
-                            end
+      @alt_office_present =
+        raw.css('address')[2].to_s =~ /Phone|Address|Fax/ ? true : false
     end
 
     def alt_office_present?
@@ -29,11 +30,7 @@ class Governator
     end
 
     def party_panel
-      @_party_panel ||= if alt_office_present?
-                          raw.css('address')[3]
-                        else
-                          raw.css('address')[2]
-                        end
+      @_party_panel ||= alt_office_present? ? raw.css('address')[3] : raw.css('address')[2]
     end
 
     def party_paragraph
@@ -72,7 +69,7 @@ class Governator
     end
 
     def phone
-      @_phone ||= address_paragraph_text(4)&.delete("\t\nPhone: ").strip.sub('/', '-')
+      @_phone ||= address_paragraph_text(4)&.delete("\t\nPhone: ")&.strip&.sub('/', '-')
     end
 
     def fax

data/lib/governator/civil_services.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
+require 'governator/http_client'
+
 class Governator
   class CivilServices
+    extend HTTPClient
+
     def self.json
-      @_json ||= JSON.parse Faraday.get(
-        'https://raw.githubusercontent.com/CivilServiceUSA/us-governors'\
-          '/master/us-governors/data/us-governors.json'
-      ).body
+      @_json ||= JSON.parse get_page_contents(uri)
+    end
+
+    def self.uri
+      @_uri ||= 'https://raw.githubusercontent.com/CivilServiceUSA/us-governors'\
+        '/master/us-governors/data/us-governors.json'
     end
 
     attr_reader :governor
@@ -39,7 +45,7 @@ class Governator
 
     def record
       @_record ||= self.class.json.detect do |record|
-        record['last_name'] == governor.last && record['state_name'] == governor.state_name
+        record['last_name'] == governor.last_name && record['state_name'] == governor.state_name
       end
     end
   end

data/lib/governator/config.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Governator
+  # The configuration object to set Twitter preferences and keys
+  class Config
+    class << self
+      attr_reader :use_twitter
+
+      def use_twitter=(boolean)
+        raise ArgumentError, 'value must be Boolean value' unless [true, false].include? boolean
+        @use_twitter = boolean
+        require 'twitter' if use_twitter?
+      end
+
+      def use_twitter?
+        @use_twitter || false
+      end
+
+      def twitter(&block)
+        Governator::TwitterClient.config(&block)
+      end
+    end
+  end
+end

data/lib/governator/governor.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+class Governator
+  # Instance methods included in the Governator class
+  class Governor
+    attr_reader :panel, :state_name, :official_full, :parsed_name,
+                :url, :party, :office_locations, :twitter
+
+    private :panel
+
+    def self.create(panel)
+      new(panel).tap do |g|
+        g.send :build
+        g.send :save
+      end
+    end
+
+    # Initializes a new Governator instance
+    #
+    # @param panel [Governator::Panel] the Panel scraper object to pull the Governor's data from
+    def initialize(panel)
+      @panel = panel
+    end
+
+    def to_h
+      syms = %i[photo_url state_name official_full url party office_locations]
+      syms.each_with_object({}) do |sym, hsh|
+        hsh[sym] = send(sym)
+      end
+    end
+
+    def inspect
+      "#<Governator #{official_full}>"
+    end
+
+    def secondary_office
+      @_secondary_office ||= office(prefix: :alt_)
+    end
+
+    def primary_office
+      @_primary_office ||= office
+    end
+
+    def photo_url
+      civil_services.photo_url || Governator::BASE_URI + panel.image
+    end
+
+    def facebook
+      civil_services.facebook
+    end
+
+    def contact_form
+      civil_services.contact_form
+    end
+
+    def first_name
+      parsed_name.first_name
+    end
+
+    def middle_name
+      parsed_name.middle_name
+    end
+
+    def nickname
+      parsed_name.nickname
+    end
+
+    def last_name
+      parsed_name.last_name
+    end
+
+    def suffix
+      parsed_name.suffix
+    end
+
+    private
+
+    def office(prefix: nil)
+      syms = %i[address city state zip phone fax office_type]
+      syms.each_with_object(Governator::Office.new) do |sym, office|
+        office[sym] = bio_page.send("#{prefix}#{sym}")
+      end
+    end
+
+    def build
+      @state_name    = panel.state
+      @official_full = panel.governor_name
+      @url           = bio_page.website
+      @party         = bio_page.party
+
+      @parsed_name = Governator::NameParser.new(official_full).parse
+      build_office_locations
+      fetch_twitter_handle
+      self
+    end
+
+    def bio_page
+      @_bio_page ||= Governator::BioPage.new(panel.bio_page)
+    end
+
+    def civil_services
+      @_civil_services ||= Governator::CivilServices.new(self)
+    end
+
+    def fetch_twitter_handle
+      check_twitter_client_for_handle if Governator::Config.use_twitter?
+      @twitter = civil_services.twitter if twitter.nil?
+    end
+
+    def check_twitter_client_for_handle
+      twitter_governor = Governator::TwitterClient.governors.detect do |tg|
+        tg[:name].match(last_name) && (
+          tg[:location].match(state_name) || tg[:description].match(state_name)
+        )
+      end
+
+      @twitter = twitter_governor[:screen_name] if twitter_governor
+    end
+
+    def build_office_locations
+      @office_locations = [primary_office]
+      @office_locations << secondary_office if bio_page.alt_office_present?
+    end
+
+    def save
+      Governator.governors << self
+      self
+    end
+  end
+end

data/lib/governator/http_client.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+
+class Governator
+  # Module to mixin HTTP web content retrieval
+  module HTTPClient
+    module_function
+
+    def get_page_contents(path)
+      path = URI.parse(path)
+      uri  = path.relative? ? "#{base_uri}#{path}" : path
+      open(uri, &:read)
+    end
+
+    def base_uri
+      @base_uri ||= 'https://www.nga.org'
+    end
+  end
+end

data/lib/governator/name.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Governator
+  # Data structure for a governor's parsed name
+  Name = Struct.new(:full_name, :first_name, :middle_name, :nickname, :last_name, :suffix) do
+    def to_s
+      full_name
+    end
+  end
+end

data/lib/governator/name_parser.rb

@@ -1,61 +1,113 @@
 # frozen_string_literal: true
 
 class Governator
+  # Parses a name into it's component parts
+  #
+  # === Example
+  #   name = "Firstname Two Middlenames 'Nick Name' Lastname, Suffix."
+  #   name_parser = NameParser.new(name)
+  #   parsed_name = name_parser.parse
+  #   parsed_name.first_name # => "Firstname"
+  #   parsed_name.middle_name # => "Two Middlenames"
+  #   parsed_name.nickname # => "Nick Name"
+  #   parsed_name.last_name # => "Lastname"
+  #   parsed_name.suffix # => "Suffix"
   class NameParser
-    attr_reader :official_full, :first, :last, :middle, :nickname, :suffix
-
-    def initialize(official_full)
-      @official_full = official_full
+    # Initialize a new NameParser object
+    #
+    # @param original [String] the original name to parse
+    def initialize(original)
+      @original = original
     end
 
+    # Parse the name into its component parts
+    #
+    # @api public
+    #
+    # @return [Governator::Name]
     def parse
       split_name
-      [first, last, middle, nickname, suffix]
+      Governator::Name.new(original, first, middle, nickname, last, suffix)
     end
 
-    def name_array
-      @_name_array ||= official_full.split(' ')
+    private
+
+    attr_reader :original, :first, :last, :middle, :nickname, :suffix
+
+    # @api private
+    def first_middle_last
+      @_first_middle_last ||= parsing_copy.split(' ')
     end
 
+    # @api private
     def split_name
       detect_nickname
       detect_suffix
-      if name_array.length == 2
+      if two_part_name?
         set_first_and_last
-      elsif name_array[0].include?('.') && name_array[1].include?('.')
+      elsif initialed_first_name?
         set_name_with_initialed_first
-      elsif name_array.length >= 3
+      elsif three_or_more_part_name?
         set_first_last_and_middle
       end
     end
 
+    # @api private
+    def three_or_more_part_name?
+      first_middle_last.length >= 3
+    end
+
+    # @api private
+    def initialed_first_name?
+      first_middle_last[0].include?('.') && first_middle_last[1].include?('.')
+    end
+
+    # @api private
+    def two_part_name?
+      first_middle_last.length == 2
+    end
+
+    # @api private
     def set_first_and_last
-      @first = name_array.first
-      @last  = name_array.last
+      @first = first_middle_last.first
+      @last  = first_middle_last.last
     end
 
+    # @api private
     def set_name_with_initialed_first
-      @first  = "#{name_array.shift} #{name_array.shift}"
-      @last   = name_array.pop
-      @middle = name_array.pop
+      @first  = "#{first_middle_last.first} #{first_middle_last[1]}"
+      @last   = first_middle_last.last
+      @middle = first_middle_last[2..-2].join(' ')
     end
 
+    # @api private
     def set_first_last_and_middle
-      @first  = name_array.shift
-      @last   = name_array.pop
-      @middle = name_array.join(' ')
+      @first  = first_middle_last.first
+      @last   = first_middle_last.last
+      @middle = first_middle_last[1..-2].join(' ')
     end
 
+    # @api private
     def detect_nickname
-      @nickname = name_array.detect { |name| name.include?('"') }
-      name_array.reject! { |name| name.include?('"') }
+      match_data = parsing_copy.match(/\s["'][\w\s]+["']/)
+      return unless match_data
+      @nickname = match_data.to_s if match_data
+      parsing_copy.sub!(nickname, '')
+      nickname.sub!(' ', '')
     end
 
+    # @api private
     def detect_suffix
-      @suffix = if name_array[-2].include?(',')
-                  name_array[-2].delete(',')
-                  name_array.pop
-                end
+      match_data = parsing_copy.match(/,\s\w+\.?/)
+      return unless match_data
+      @suffix = match_data.to_s if match_data
+      parsing_copy.sub!(suffix, '')
+      suffix.delete!(', ')
+    end
+
+    # @api private
+    def parsing_copy
+      @_parsing_copy ||= original.dup
     end
   end
 end

data/lib/governator/office.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Governator
-  Office = Struct.new *%i[address city state zip phone fax office_type] do
+  Office = Struct.new(:address, :city, :state, :zip, :phone, :fax, :office_type) do
     def to_s
       [address, city, state, zip, phone, fax].compact.join("\n")
     end

data/lib/governator/twitter_client.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 class Governator
+  # Wrapper for the Twitter client with convenience methods
   class TwitterClient
     class << self
       attr_reader :client
 
       def config(&block)
         @client = Twitter::REST::Client.new(&block)
+      rescue NameError
+        raise RuntimeError, 'set `use_twitter` configuration option to true if you '\
+          ' wish to configure and use a Twitter client'
       end
 
       def governors

data/lib/governator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Governator
-  VERSION = '0.1.10'
+  VERSION = '0.1.11'
 end

data/lib/governator.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
-require 'faraday'
 require 'nokogiri'
-require 'twitter'
+require 'open-uri'
 
 require 'governator/bio_page'
 require 'governator/civil_services'
+require 'governator/config'
+require 'governator/governor'
+require 'governator/http_client'
+require 'governator/name'
 require 'governator/name_parser'
 require 'governator/office'
 require 'governator/panel'
@@ -15,16 +18,13 @@ require 'governator/version'
 # Governator.scrape!
 # governors = Governor.governors
 class Governator
-  BASE_URI = 'https://www.nga.org'
-  CONN = Faraday.new(url: BASE_URI)
-
-  class << self # <-- Begin class methods
-    attr_reader :use_twitter
+  class << self
+    include HTTPClient
 
     def scrape!
       governors.clear
       panels.each do |panel|
-        governor = create(panel)
+        governor = Governator::Governor.create(panel)
         puts "Scraped #{governor.official_full} of #{governor.state_name}"
       end
 
@@ -36,134 +36,28 @@ class Governator
       @_governors ||= []
     end
 
-    def to_json
+    def serialize
       governors.map(&:to_h)
     end
-    alias serialize to_json
 
     def config
-      yield self
-    end
-
-    def twitter(&block)
-      TwitterClient.config(&block)
+      yield Governator::Config
     end
 
     def twitter_client
-      TwitterClient.client
+      Governator::TwitterClient.client
     end
 
-    def use_twitter=(boolean)
-      raise ArgumentError, 'value must be Boolean value' unless [true, false].include? boolean
-      @use_twitter = boolean
-    end
-
-    private # private class methods
+    private
 
     def index_page
-      @_index_page ||= Nokogiri::HTML(CONN.get('/cms/governors/bios').body)
+      @_index_page ||= Nokogiri::HTML get_page_contents('/cms/governors/bios')
     end
 
     def panels
       @_panels ||= index_page.css('.panel.panel-default.governors').map do |panel|
-        Panel.new(panel)
-      end
-    end
-
-    def create(panel)
-      new(panel).tap do |g|
-        g.send :build
-        g.send :save
-      end
-    end
-  end # <-- End class methods
-
-  attr_reader :panel, :state_name, :bio_page, :official_full, :first, :last,
-              :middle, :nickname, :suffix, :url, :party, :office_locations,
-              :twitter
-
-  def initialize(panel)
-    @panel = panel
-  end
-
-  def to_h
-    syms =  %i[photo_url state_name official_full url party office_locations]
-    syms.each_with_object({}) do |sym, hsh|
-      hsh[sym] = send(sym)
-    end
-  end
-
-  def inspect
-    "#<Governator #{official_full}>"
-  end
-
-  def secondary_office
-    @_secondary_office ||= office(prefix: :alt_)
-  end
-
-  def primary_office
-    @_primary_office ||= office
-  end
-
-  def office(prefix: nil)
-    syms = %i[address city state zip phone fax office_type]
-    syms.each_with_object(Office.new) do |sym, office|
-      office[sym] = bio_page.send("#{prefix}#{sym}")
-    end
-  end
-
-  def photo_url
-    civil_services.photo_url || BASE_URI + panel.image
-  end
-
-  def facebook
-    civil_services.facebook
-  end
-
-  def contact_form
-    civil_services.contact_form
-  end
-
-  private
-
-  def build
-    @bio_page      = BioPage.new(panel.bio_page)
-    @state_name    = panel.state
-    @official_full = panel.governor_name
-    @url           = bio_page.website
-    @party         = bio_page.party
-
-    @first, @last, @middle, @nickname, @suffix = NameParser.new(official_full).parse
-    build_office_locations
-    fetch_twitter_handle
-    self
-  end
-
-  def civil_services
-    @_civil_services ||= CivilServices.new(self)
-  end
-
-  def fetch_twitter_handle
-    if self.class.use_twitter == true
-      twitter_governor = TwitterClient.governors.detect do |tg|
-        tg[:name].match(last) && (
-          tg[:location].match(state_name) || tg[:description].match(state_name)
-        )
+        Governator::Panel.new(panel)
       end
-
-      @twitter = twitter_governor[:screen_name] if twitter_governor
     end
-
-    @twitter = civil_services.twitter if twitter.nil?
-  end
-
-  def build_office_locations
-    @office_locations = [primary_office]
-    @office_locations << secondary_office if bio_page.alt_office_present?
-  end
-
-  def save
-    self.class.governors << self
-    self
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: governator
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - M. Simon Borg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-24 00:00:00.000000000 Z
+date: 2017-07-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: twitter
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +79,10 @@ files:
 - lib/governator.rb
 - lib/governator/bio_page.rb
 - lib/governator/civil_services.rb
+- lib/governator/config.rb
+- lib/governator/governor.rb
+- lib/governator/http_client.rb
+- lib/governator/name.rb
 - lib/governator/name_parser.rb
 - lib/governator/office.rb
 - lib/governator/page_scraper.rb