retro_casts 0.1.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

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 snsavage@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 retro_casts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Scott Savage
+
+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,122 @@
+# RetroCasts
+
+[![Code Climate](https://codeclimate.com/github/snsavage/retro_casts/badges/gpa.svg)](https://codeclimate.com/github/snsavage/retro_casts) [![Test Coverage](https://codeclimate.com/github/snsavage/retro_casts/badges/coverage.svg)](https://codeclimate.com/github/snsavage/retro_casts/coverage) [![Issue Count](https://codeclimate.com/github/snsavage/retro_casts/badges/issue_count.svg)](https://codeclimate.com/github/snsavage/retro_casts)
+
+```
+   _____      _              _____          _
+  |  __ \    | |            / ____|        | |
+  | |__) |___| |_ _ __ ___ | |     __ _ ___| |_ ___
+  |  _  // _ \ __| '__/ _ \| |    / _` / __| __/ __|
+  | | \ \  __/ |_| | | (_) | |___| (_| \__ \ |_\__ \
+  |_|  \_\___|\__|_|  \___/ \_____\__,_|___/\__|___/
+```
+The RetroCasts gem provides access to [RailsCasts.com](http://railscasts.com) through a command line utility.  The utility allows browsing and searching of RailsCasts episodes with the option to view a description of the episode and to open the episode in your web browser.  See usage below for more detail.
+
+*RetroCasts was created as a project for  the Flatiron School's Online Web Developer program.  You can find more information here: [learn.co/with/snavage](http://learn.co/with/snavage).  Or to find out more about the making of RetroCasts checkout my post at [snsavage.com](http://www.snsavage.com/blog/2016/the_making_of_retrocasts.html)* 
+
+## Installation
+
+To install run: 
+
+    $ gem install retro_casts
+
+## Usage
+
+To access RetroCasts run the ```retrocasts``` command.  
+
+	$ retrocasts
+
+This will open the episode menu.
+
+```
+ _____      _              _____          _
+|  __ \    | |            / ____|        | |
+| |__) |___| |_ _ __ ___ | |     __ _ ___| |_ ___
+|  _  // _ \ __| '__/ _ \| |    / _` / __| __/ __|
+| | \ \  __/ |_| | | (_) | |___| (_| \__ \ |_\__ \
+|_|  \_\___|\__|_|  \___/ \_____\__,_|___/\__|___/
+Welcome to RetroCasts!
+##################################################
+1. Foundation - Jun 16, 2013
+2. Form Objects - Jun 3, 2013
+3. Model Caching (revised) - May 13, 2013
+4. Upgrading to Rails 4 - May 6, 2013
+5. Batch API Requests - Apr 27, 2013
+6. Handling Exceptions (revised) - Apr 20, 2013
+7. Fast Tests - Apr 10, 2013
+8. Fast Rails Commands - Apr 4, 2013
+9. Performance Testing - Mar 27, 2013
+10. Eager Loading (revised) - Mar 20, 2013
+Please select an option...
+Episodes: 1 to 10  | home | search {search terms} | next | back | exit
+>
+```
+In the background, RetroCasts is scraping the RailsCasts website.  Therefore, the results shown above represent the episode results shown on the homepage of RailsCasts.  From here several options are available.
+
+To view an episode's details chose an episode number.
+
+```
+>1
+Title: Foundation
+Number: 417
+Date: Jun 16, 2013
+Length: 11 minutes
+Description: ZURB's Foundation is a front-end for quickly building
+applications and prototypes. It is similar to Twitter Bootstrap but
+uses Sass instead of LESS. Here you will learn the basics of the grid
+system, navigation, tooltips and more.
+Link: /episodes/417-foundation
+Type 'back' to go back or 'open' to open the episode in your browser.
+>
+```
+From the detail screen, ```back``` will return to the main menu and ```open``` will open the episode in your browser.
+
+Back on the episode menu, other options include...
+
+* ```home``` - Go back to the RailsCasts homepage results. 
+* ```next``` - Go to the next page of episode results.
+* ```back``` - Go to the previous page of episode results.
+* ```search {search terms}``` - Search RailsCasts.  There is no need to enter the search terms in quotes.  Something like ```search model caching``` will work fine.  the ```next``` and ```back``` commands move through search results until you go back to ```home```.
+* ```exit``` - Closes the program.
+
+### Command Line Search
+RetroCasts also lets you search from the command line.  For example...
+
+	$ retrocasts model caching
+
+...will run a search instead of opening the home page results.
+
+```
+$ retrocasts model caching
+ _____      _              _____          _
+|  __ \    | |            / ____|        | |
+| |__) |___| |_ _ __ ___ | |     __ _ ___| |_ ___
+|  _  // _ \ __| '__/ _ \| |    / _` / __| __/ __|
+| | \ \  __/ |_| | | (_) | |___| (_| \__ \ |_\__ \
+|_|  \_\___|\__|_|  \___/ \_____\__,_|___/\__|___/
+Welcome to RetroCasts!
+##################################################
+1. Model Caching (revised) - May 13, 2013
+2. Facebook Authentication - Jun 25, 2012
+3. What's New in Rails 4 - Jan 4, 2013
+4. Caching in Rails 2.1 - Jun 23, 2008
+Please select an option...
+Episodes: 1 to 4  | home | search {search terms} | next | back | exit
+>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/snsavage/retro_casts](https://github.com/snsavage/retro_casts). 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,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "dotenv"
+
+Dotenv.load
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "retro_casts"
+
+# 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/exe/retrocasts

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+
+require 'retro_casts'
+
+RetroCasts.start
+

data/lib/retro_casts.rb

@@ -0,0 +1,94 @@
+require "nokogiri"
+require "open-uri"
+
+require "retro_casts/version"
+require "retro_casts/rails_casts"
+require "retro_casts/episode"
+require "retro_casts/website"
+require "retro_casts/null_website"
+require "retro_casts/CLI"
+
+require 'pry'
+
+module RetroCasts
+  extend CLI
+
+  def self.start(klass: RetroCasts::RailsCasts)
+    retro_welcome
+    welcome
+
+    if !ARGV.empty?
+      site = klass.new(search: ARGV.join(" "))
+    else
+      site ||= klass.new
+    end
+
+    message = ""
+
+    loop do
+      display("#" * 50)
+      site.list_episodes
+
+      puts "*** #{message} ***" unless message == ""
+      message = ""
+
+      puts "Please select an option..."
+      puts "Episodes: 1 to #{site.episodes.length}  | home | search {search terms} | next | back | exit"
+      print ">"
+      input = $stdin.gets.chomp.split(" ")
+      command = input.shift
+      argument = input.join(" ")
+
+      if integer?(command) && site.episode?(command.to_i)
+        loop do
+          episode = site.episode(command.to_i)
+          site.show_episode_detail(command.to_i)
+
+          puts "Type 'back' to go back or 'open' to open the episode in your browser."
+          print ">"
+
+          case $stdin.gets.chomp.downcase
+          when "back"
+            break
+          when "open"
+            `open #{site.host}/#{episode.link}`
+          else
+            puts "Please choose 'exit' or 'open'."
+            print ">"
+          end
+        end
+      elsif command == nil
+        message = "Enter is not a valid selection."
+      else
+        case command.downcase
+        when "home"
+          puts "Going back to the homepage..."
+          site = site.get_search(nil)
+        when "search"
+          puts "Searching for \"#{argument}\"..."
+          site = site.get_search(argument)
+        when "next"
+          puts "Opening page #{site.page + 1}..."
+          site = site.next_page
+        when "back"
+          puts "Opening page #{site.page - 1}..."
+          site = site.prev_page
+        when "exit"
+          break
+        else
+          message = "#{command} is not a valid selection."
+        end
+      end
+    end
+  end
+
+  private
+  def self.integer?(number)
+    begin
+      Integer(number)
+      true
+    rescue
+      false
+    end
+  end
+end

data/lib/retro_casts/cli.rb

@@ -0,0 +1,33 @@
+module RetroCasts
+  module CLI
+    def welcome
+      puts "Welcome to RetroCasts!"
+    end
+
+    def display(message = "")
+      puts word_wrap(message, line_width: 70)
+    end
+
+    def retro_welcome
+      retro_welcome = <<-ASCII
+ _____      _              _____          _
+|  __ \\    | |            / ____|        | |
+| |__) |___| |_ _ __ ___ | |     __ _ ___| |_ ___
+|  _  // _ \\ __| '__/ _ \\| |    / _` / __| __/ __|
+| | \\ \\  __/ |_| | | (_) | |___| (_| \\__ \\ |_\\__ \\
+|_|  \\_\\___|\\__|_|  \\___/ \\_____\\__,_|___/\\__|___/
+    ASCII
+      puts retro_welcome
+    end
+
+    private
+    # Source:
+    # http://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-word_wrap
+    def word_wrap(text, line_width: 80, break_sequence: "\n")
+      text.split("\n").collect! do |line|
+        line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1#{break_sequence}").strip : line
+      end * break_sequence
+    end
+  end
+end
+

data/lib/retro_casts/episode.rb

@@ -0,0 +1,14 @@
+module RetroCasts
+  class Episode
+    attr_accessor :title, :number, :date, :length, :link, :description
+
+    def date
+      @date.strftime("%b %-d, %Y")
+    end
+
+    def length
+      "#{@length} minutes"
+    end
+  end
+end
+

data/lib/retro_casts/null_website.rb

@@ -0,0 +1,16 @@
+module RetroCasts
+  class NullWebsite
+    def empty?
+      true
+    end
+
+    def collect
+      self
+    end
+
+    def each_with_index
+      RetroCasts.display("No Episodes Found")
+    end
+  end
+end
+

data/lib/retro_casts/rails_casts.rb

@@ -0,0 +1,138 @@
+module RetroCasts
+  class RailsCasts
+    attr_reader :host, :filter, :episodes, :page, :search, :url, :website
+
+    def initialize(host: 'http://www.railscasts.com',
+                   filter: '.episode',
+                   page: 1,
+                   search: nil,
+                   website: RetroCasts::Website.new)
+
+      @host = host
+      @filter = filter
+      @page = page
+      @search = search
+      @website = website
+
+      @url = build_url
+
+      nodeset = website.get_list(url, filter)
+      @episodes = parse_episodes(nodeset)
+    end
+
+    def episode?(number)
+      number > 0 && number <= episodes.length
+    end
+
+    def episode(number)
+      if episode?(number)
+        episodes[number - 1]
+      else
+        nil
+      end
+    end
+
+    def get_search(search_term)
+      self.class.new(search: search_term, website: website)
+    end
+
+    def next_page
+      self.class.new(search: search,
+                     page: page + 1,
+                     website: website)
+    end
+
+    def prev_page
+      if page > 1
+        self.class.new(search: search,
+                       page: page - 1,
+                       website: website)
+      else
+        self
+      end
+    end
+
+    def list_episodes
+      episodes.each_with_index do |episode, i|
+        RetroCasts.display "#{i +1}. #{episode.title} - #{episode.date}"
+      end
+    end
+
+    def show_episode_detail(episode_number)
+      current_episode = episode(episode_number)
+      [:title, :number, :date, :length, :description, :link].each do |attribute|
+        label = attribute.to_s.capitalize
+        message = "#{label}: #{current_episode.send(attribute)}"
+        RetroCasts.display(message)
+      end
+    end
+
+    private
+    def build_url
+      attributes = {}
+
+      attributes[:search] = search if search
+      attributes[:page] = page if page != 1
+
+      if !attributes.empty?
+        query = URI.encode_www_form(attributes)
+      end
+
+      if attributes.has_key?(:search)
+        "#{host}\/episodes?#{query}"
+      elsif attributes.has_key?(:page)
+        "#{host}\/?#{query}"
+      elsif host != ""
+        "#{host}\/"
+      else
+        ""
+      end
+    end
+
+    def parse_episodes(nodeset)
+      nodeset.collect do |node|
+        create_episode(node)
+      end
+    end
+
+    def create_episode(node)
+      episode = Episode.new
+      episode.title = title(node)
+      episode.number = number(node)
+      episode.date = date(node)
+      episode.length = length(node)
+      episode.link = link(node)
+      episode.description = description(node)
+      return episode
+    end
+
+    def title(node)
+      node.css(".main h2 a").text
+    end
+
+    def number(node)
+      text = node.css(".number").text
+      text.match(/\d+/).to_s.to_i
+    end
+
+    def date(node)
+      text = node.css(".published_at").text
+      Date.parse(text)
+    end
+
+    def length(node)
+      text = node.css(".stats").text
+      text.match(/\d+/).to_s.to_i
+    end
+
+    def link(node)
+      node.css(".screenshot a").first.attributes["href"].value
+    end
+
+    def description(node)
+      text = node.css(".description").text
+      text.sub(/\(\d+ minutes\)/, '').delete("\n").strip
+    end
+  end
+end
+