brainyquote 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 478413eec2c2eb10ee414c075bb906a41076f715
+  data.tar.gz: 3c42fe5c9c7a48c899a6f1b092eab72f2513dfd1
+SHA512:
+  metadata.gz: aae02218bd9c2ece40bfebcce56daa1b5dc24cecf41bb2a206a86caaf3fe8bc18ed5ebfdfed326aa9420e2b890fbcf92d280eb64112f40b345523c19cb49d3b7
+  data.tar.gz: 9cd0fa6a3d6ab99be46b673efd03893855f22d9f0d88bba503b85e4cde1aca36b7d04871e62e7fd596ae14527d6b600f5daaafd6ebf78da457a84029f28e940e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dukeoflaser@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in BrainyQuote.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nathaniel Miller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# BrainyQuote
+A simple Command Line Interface that allows the user to receive a randomly
+selected quote based on topic of the user's choice.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brainyquote'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brainyquote
+
+## Usage
+
+After installation, simply type `brainyquote` to access the BrainyQuote interface.
+Hitting 'enter' will display a list of topics.
+Choose a topic via the associated number to receive a quote.
+The user can type `y` to get another quote from the same topic as many times
+as he or she wishes.
+Type `n` to view the list of topics again.
+Leave the interface at any time by typing `exit`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/BrainyQuote. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/brainyquote

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require './lib/brainyquote'
+BrainyQuote::CLI.new.call

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "brainyquote"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/brainyquote.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brainyquote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brainyquote"
+  spec.version       = BrainyQuote::VERSION
+  spec.authors       = ["Nathaniel Miller"]
+  spec.email         = ["dukeoflaser@gmail.com"]
+  spec.summary       = "Retrieve random quotes according to topic."
+  spec.homepage      = "https://github.com/dukeoflaser/brainyquote-gem"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables << 'brainyquote'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "nokogiri"
+end

data/lib/BrainyQuote/version.rb

@@ -0,0 +1,3 @@
+module BrainyQuote
+  VERSION = "0.2.0"
+end

data/lib/brainyquote.rb

@@ -0,0 +1,6 @@
+require_relative './brainyquote/version'
+require_relative './brainyquote/cli'
+require_relative './brainyquote/quote'
+
+require 'nokogiri'
+require 'open-uri'

data/lib/brainyquote/cli.rb

@@ -0,0 +1,139 @@
+class BrainyQuote::CLI
+  def call
+    starter
+  end
+
+
+
+
+  private
+  def starter
+    @filter = 'main'
+    puts ""
+    display_instructions_for('intro', 'topics', 'exit')
+    skip_line
+    get_input
+    continue_or_exit
+  end
+
+  def display_instructions_for(*options)
+    puts "Welcome to BrainyQuote." if options.include?('intro')
+    puts "That is not a valid option." if options.include?('invalid')
+    puts "Hit 'Enter' to see available topics." if options.include?('topics')
+    if options.include?('retry')
+      puts "Would you like another quote from this topic? (y/n)"
+      puts "Hitting 'n' will display the topic list."
+    end
+    puts "Enter a number from the list to select a topic." if options.include?('choose')
+    puts "Type 'exit' to leave." if options.include?('exit')
+  end
+
+  def get_input
+    @input = gets.strip.downcase
+  end
+
+  def continue_or_exit
+    until @input == 'exit'
+      main_controller
+    end
+    skip_line
+    puts "Enough quotes for now. Goodbye!"
+    exit
+  end
+
+  def main_controller
+    if @filter == 'main'
+      if @input == ""
+        topic_controller
+      else
+        display_instructions_for('invalid', 'topics', 'exit')
+        get_input
+      end
+    elsif @filter == 'topic'
+      if (1..122) === @input.to_i
+        translate_input_to_topic_name
+        retrieve_quote
+        format_quote
+        display_instructions_for('retry', 'exit')
+        decide_to_retry
+      else
+        display_instructions_for('invalid', 'choose', 'exit')
+        get_input
+        continue_or_exit
+      end
+    end
+  end
+
+  def topic_controller
+    @filter = 'topic'
+    get_topics
+    format_topics
+    display_instructions_for('choose', 'exit')
+    get_input
+    continue_or_exit
+  end
+
+  def format_topics
+    topics_string = ""
+    @topics.each_with_index do |topic, i|
+      cell =  "#{i + 1}) #{topic}"
+      x = (25 - cell.length)
+      x.times{ cell << " " }
+      topics_string << cell
+    end
+
+    rows = topics_string.scan(/.{1,75}/)
+    rows.each {|row| puts row}
+    skip_line
+  end
+
+  def format_quote
+    skip_line
+    puts "~#{@quote.topic_name.split.map(&:capitalize).join(' ')}~"
+    skip_line(2)
+    puts word_wrap(@quote.text, line_width: 75)
+    skip_line
+    puts "  - #{@quote.author}"
+    skip_line(4)
+  end
+
+  #ActionView's WordWrap
+  def word_wrap(text, options = {})
+   line_width = options.fetch(:line_width, 80)
+
+   text.split("\n").collect! do |line|
+     line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
+   end * "\n"
+ end
+
+  def skip_line(n = 1)
+    n.times{ puts "" }
+  end
+
+  def get_topics
+    @topics = BrainyQuote::Quote.topics
+  end
+
+
+  def translate_input_to_topic_name
+    @topic_name = @topics[@input.to_i - 1].downcase
+  end
+
+  def retrieve_quote
+    @quote = BrainyQuote::Quote.quote_about(@topic_name)
+  end
+
+  def decide_to_retry
+    get_input
+
+    if @input == 'y'
+      retrieve_quote
+      format_quote
+      display_instructions_for('retry', 'exit')
+      decide_to_retry
+    elsif @input == 'n'
+      topic_controller
+    end
+  end
+
+end

data/lib/brainyquote/quote.rb

@@ -0,0 +1,66 @@
+class BrainyQuote::Quote
+  attr_accessor :text, :author
+  attr_reader :topic_name
+
+  def initialize(topic_name)
+    @topic_name = topic_name
+  end
+
+  def data_from_topic
+    text_and_author = []
+    doc = Nokogiri::HTML(open(random_pagination_url))
+
+    #Retrieve text/author pairs.
+    doc.css('.bqQt').each do |data|
+      text_and_author << data.text.split("\n").reject!(&:empty?).take(2)
+    end
+
+    #Randomly selectand return a scraped quote/author.
+    index = (rand(text_and_author.length) - 1)
+    text_and_author[index]
+  end
+
+
+  def random_pagination_url
+    #Prepare basic topic_url
+    page_name = @topic_name.split(/\W/).join.downcase
+    url = "http://www.brainyquote.com/quotes/topics/topic_#{page_name}.html"
+
+    doc = Nokogiri::HTML(open(url))
+
+    #Find number of available pages for topics and pick one at random
+    max = doc.css('ul.pagination').first.css('li:nth-last-child(2)').text.to_i
+    page = rand(max)
+
+    #Render url for selected page
+    "http://www.brainyquote.com/quotes/topics/topic_#{page_name}#{page}.html"
+  end
+
+
+
+
+  class << self
+    def quote_about(topic_name)
+      quote_object = self.new(topic_name)
+      quote_data = quote_object.data_from_topic
+
+      quote_object.text = quote_data.first
+      quote_object.author = quote_data.last
+      quote_object
+    end
+
+    def topics
+      topics = []
+      url = 'http://www.brainyquote.com/quotes/topics.html'
+      doc = Nokogiri::HTML(open(url))
+
+      doc.css('table .bqLn a').each do |link|
+        topics << link.text
+      end
+
+      topics
+    end
+  end
+  
+  private :random_pagination_url
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: brainyquote
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nathaniel Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dukeoflaser@gmail.com
+executables:
+- brainyquote
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/brainyquote
+- bin/console
+- bin/setup
+- brainyquote.gemspec
+- lib/BrainyQuote/version.rb
+- lib/brainyquote.rb
+- lib/brainyquote/cli.rb
+- lib/brainyquote/quote.rb
+homepage: https://github.com/dukeoflaser/brainyquote-gem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Retrieve random quotes according to topic.
+test_files: []