apw_articles 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 762d2ad97904f469c347327ca3bf900ea49ed4af
+  data.tar.gz: 9af397ae00b4c5781ef1d419aa8e6f329397b23e
+SHA512:
+  metadata.gz: 7e857e447b235f45510310db1fee667d447d52d858991de58b8750cc9dbaa51a3dac448718a5135788660a508640008cbc7b7e1aa346298c4c6c54ced3bf8e3e
+  data.tar.gz: f1dce15cbb89fc5524c23a6b42f1834a8bff0b5fce399b3a1553a100cb63ce2ca6d3150ce628342565d9e05c06ccf1ab91d7ed0fde82390980e04fc97b53a5d3

data/bin/apw_articles

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/apw_articles.rb'
+
+APWArticles::CLI.new.run

data/config/environment.rb

@@ -0,0 +1,10 @@
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+require 'colorize'
+
+
+require_relative '../lib/apw_articles/article.rb'
+require_relative '../lib/apw_articles/category.rb'
+require_relative '../lib/apw_articles/cli.rb'
+require_relative '../lib/apw_articles/scraper.rb'

data/lib/apw_articles.rb

@@ -0,0 +1,5 @@
+module APWArticles
+
+end
+
+require_relative '../config/environment.rb'

data/lib/apw_articles/article.rb

@@ -0,0 +1,33 @@
+class APWArticles::Article
+  attr_accessor :title, :author, :blurb, :url, :categories
+  @@all = []
+
+  def initialize(attribute_hash)
+    self.categories = []
+    attribute_hash.each do |key, value|
+      if key == :categories
+        value.each do |category|
+          c = APWArticles::Category.find_or_create_by_url(category)
+          self.categories << c
+          c.articles << self
+        end
+      else
+        self.send(("#{key}="), value)
+      end
+      @@all << self
+    end
+  end
+
+  def self.new_from_url(url)
+    self.new(APWArticles::Scraper.scrape_article(url))
+  end
+
+  def self.new_from_list(list_url)
+    # call scraper for list and then initalize from hash
+  end
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/apw_articles/category.rb

@@ -0,0 +1,36 @@
+class APWArticles::Category
+  attr_accessor :name, :articles, :url
+  @@all = []
+  CATEGORIES = ["divorce", "kids-no-kids", "sex", "career", "life", "marriage-essays", "money", "feminism", "essays", "the-hard-stuff", "reclaiming-wife", "advice", "genderfeminism", "friends-relations", "engagements-proposals", "happy-hour"]
+  # NOTE: the CATEGORIES constant was gathered using the APWArticles::Scraper.scrape_categories method, however as the only way to scrape this information was iterating over 66 articles which is rather time-consuming in the CLI, I have elected to hard code the categories as default categories. New category objects will still be made when they're encountered in articles.
+
+  def self.defaults
+    CATEGORIES.each {|url| self.find_or_create_by_url(url)}
+  end
+
+  def initialize(url)
+    self.name = url.gsub(/-/, ' ').split.map(&:capitalize).join(' ')
+    self.url = url
+    self.class.all << self
+    self.articles = []
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.find_or_create_by_url(url)
+    if self.all.detect{|category| category.url == url } == nil
+      self.new(url)
+    else
+      self.all.detect{|category| category.url == url }
+    end
+  end
+
+  def self.create_from_url
+    APWArticles::Scraper.scrape_categories.each do |category|
+      self.find_or_create_by_url(category)
+    end
+  end
+
+end

data/lib/apw_articles/cli.rb

@@ -0,0 +1,85 @@
+class APWArticles::CLI
+
+  def run
+    APWArticles::Category.defaults
+    self.list_categories
+  end # basic functionality
+
+  # Lists categories by iterating over APWARrticles::Category.all and requests input to view article list based on category
+  def list_categories
+    puts "------------ A Practical Wedding - Marriage Essays ------------\n".colorize(:cyan)
+    puts "CATEGORIES:"
+    APWArticles::Category.all.each_with_index do |category, index|
+      print "#{index+1}.\t".colorize(:cyan)
+      puts "#{category.name}"
+    end # do loop end
+    puts "\nPlease choose a category by number".colorize(:blue)
+    input = gets.strip
+    until input.to_i > 0 && input.to_i <= APWArticles::Category.all.size
+      puts "Please type a number between 1 and #{APWArticles::Category.all.size}.".colorize(:blue)
+      input = gets.strip
+    end # until end
+    self.list_articles_in_category_by_page(APWArticles::Category.all[input.to_i-1], 1)
+  end # list_categories def end
+
+  # Based on a category and a page number, this method creates an array of indexes of articles to list, then calls the scraper to scrape the category page to generate article objects for that category. The method then iterates over the array of articles to list, printing the article number and name for the article at that index in the category object's articles array.
+  # Method then asks user to choose an article number to display.
+  def list_articles_in_category_by_page(category, page = 1)
+    articles_to_display = Array (((page*10)-10)..((page*10)-1)) # page 1 = 0-9, page 2 = 10-19
+    puts "\n\n------------ Articles in #{category.name} ------------".colorize(:cyan)
+    APWArticles::Scraper.scrape_list(category.url, page) unless page.between?(2,5) || page.between?(7,12)
+    # NOTE this is very laggy and perhaps shouldn't take place here.
+    articles_to_display.each do |article_num|
+      print "#{article_num+1}.\t".colorize(:cyan) unless
+      category.articles[article_num] == nil
+      puts "#{category.articles[article_num].title}" unless
+      category.articles[article_num] == nil
+    end # do end
+    # NOTE: I might like to split out the input logic here.
+    puts "\n\nType the article number to view more information about the article. \nOr type 'next' to view the next page of articles.".colorize(:blue)
+    input = gets.strip
+    until /(?i)next/ === input || ( input.to_i >= (articles_to_display[0]+1) && input.to_i <= (articles_to_display[-1]+1) )
+      puts "Please type a number between #{articles_to_display[0]+1} and #{articles_to_display[-1]+1} or type 'next'.".colorize(:blue)
+      input = gets.strip
+    end # until end
+    if /(?i)next/ === input
+      page += 1
+      list_articles_in_category_by_page(category, page)
+    else
+      self.article_information(
+      category.articles[input.to_i-1].url)
+    end # if end
+  end # list_articles_in_category_by_page def end
+
+  # This method creates a new Article object from the URL passed to the method and assigns it a local variable. The method then calls instance methods for each of the object's variables (title, author, blurb, url and categories). Then it requests input to view more information or exit.
+  def article_information(article_url)
+    article = APWArticles::Article.new_from_url(article_url)
+    print "\nTitle:".colorize(:cyan)
+    puts "#{article.title}"
+    print "\nAuthor:".colorize(:cyan)
+    puts "#{article.author}"
+    print "\n\nBlurb:".colorize(:cyan)
+    puts "\"#{article.blurb}...\""
+    print "\nURL:".colorize(:cyan)
+    puts "#{article_url}"
+    article_categories = []
+    article.categories.each do |category| # category is an object, and I want its name
+      article_categories << category.name
+    end # do end
+    print "\nCategories:".colorize(:cyan)
+    puts "#{article_categories.join(", ")}."
+    puts "Type 'list' to return to the category list page. To exit, type 'exit'".colorize(:blue)
+    input = gets.strip
+    # validating input
+    until /(?i)exit/ === input || /(?i)list/ === input
+      puts "Please type 'list' or 'exit'.".colorize(:blue)
+      input = gets.strip
+    end # until end
+    if /(?i)exit/ === input
+      abort("Thank you.")
+    elsif /(?i)list/ === input
+      self.list_categories
+    end # if end
+  end # def article_information end
+
+end # class end

data/lib/apw_articles/scraper.rb

@@ -0,0 +1,53 @@
+class APWArticles::Scraper
+
+  # This class method defines variables i and j to determine what url number needs to be scraped based on the number of items on each page (at time of publicaion, 66 articles/page). The method then scrapes a url based on the category and URL number and uses that page's list of articles to creates a new article object per article link. Article objects include title, url and category. The method returns nil
+  def self.scrape_list(category, page = 1)
+    # NOTE: probably I should only scrape for the # of articles I need for the given request / call - this is very laggy
+    i = 1 if page.between?(1,6)
+    i = 2 if page.between?(7,13)
+    i = 3 if page > 13
+    j = 1 if page.between?(1,5)
+    j = 2 if page.between?(6,12)
+    j = 3 if page > 12
+    until i > j
+      Nokogiri::HTML(open("https://apracticalwedding.com/category/marriage-essays/#{category}/page/#{i}/?listas=list")).css(".type-post").each do |post|
+        APWArticles::Article.new({url: post.css("a").attribute("href").value, title: post.css("h2").text, categories: [category]})
+      end # do end
+      i += 1
+    end # until loop end
+    nil
+  end # def end
+
+  # This method takes an article URL, creates an article hash then populates that article hash using information scraped from the URL. The method then returns the article hash.
+  def self.scrape_article(url)
+    article = {}
+    doc = Nokogiri::HTML(open(url))
+    article[:title] = doc.css("h1").text
+    article[:author] = doc.css(".staff-info h2").text
+    article[:url] = url
+    article[:blurb] = doc.css(".entry p").text[0,400]
+    categories = []
+    doc.css(".categories a").each do |link|
+      categories << link.attribute("href").value.split("/")[-1]
+    end # do end
+    article[:categories] = categories
+    article
+  end # returns hash of information on the article.
+
+  # This method takes in a URL of a list page of essays at APW and creates an array of all link attributes on the essay links in the list. It then breaks apart the string of link attributes and returns an array of those attributes with the preface "category-",
+  def self.scrape_categories(url = "https://apracticalwedding.com/category/marriage-essays/?listas=list")
+    doc = Nokogiri::HTML(open(url)).css(".type-post")
+    link_attributes = []
+    categories = []
+    doc.each { |link| link_attributes << link.attribute("class").value }
+    link_attributes.each do |attributes_list|
+      attributes_array = attributes_list.split(/ category-/)
+      attributes_array.slice!(0)
+      attributes_array.each do |category|
+        categories << category.split[0]
+      end # attributes_array do end
+    end # link_attributes do end
+    categories.uniq
+  end # self.scrape_categories end
+
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: apw_articles
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Rachel Walwood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-21 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby Gem to explore articles on the A Practical Wedding website that
+  are useful after the wedding.
+email: walwoodr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/apw_articles
+- config/environment.rb
+- lib/apw_articles.rb
+- lib/apw_articles/article.rb
+- lib/apw_articles/category.rb
+- lib/apw_articles/cli.rb
+- lib/apw_articles/scraper.rb
+homepage: http://rubygems.org/gems/apw_articles
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Articles from A Practical Wedding
+test_files: []