nyc_today 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db6d1c4c4c9b8e53afa83d4912959008d7af6a33
+  data.tar.gz: 05031a167b79bb14473f4355c60f937eca32b2e6
+SHA512:
+  metadata.gz: 189a925c22166a895cb62dd1150ff1e18f81c2e24e05745ecfd43cda4f18184b7fdd002ada244db043d7889ada2f149f4df5d5b19d418467764960522c88c652
+  data.tar.gz: 5e521a1fc3dd4cd9f9343293a3a8b776fff347e8b06ae99fda7e502c5e486f69e917df773facc97e4519d1fdf75dfed81b20ee7d75a10d81385ddee751aae427

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 vicision
+
+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,38 @@
+# NYC Today
+
+NYC Today is a Ruby Gem that provides a CLI for navigating events from [Brooklyn Vegan's event listings](http://nyc-shows.brooklynvegan.com/), allowing users to select an event category, browse a list of events and details in that category, and view more information about a chosen event.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nyc_today'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nyc_today
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/vicision/nyc-today-cli-app. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nyc_today"
+require "pry"
+Pry.start
+
+# 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!)

data/bin/nyc_today

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require './lib/nyc_today'
+
+NycToday::CLI.new.call

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/lib/nyc_today.rb

@@ -0,0 +1,10 @@
+require 'open-uri'
+require 'nokogiri'
+require 'time'
+require_relative 'nyc_today/version'
+require_relative './nyc_today/cli'
+require_relative './nyc_today/event'
+require_relative './nyc_today/scraper'
+
+module NycToday
+end

data/lib/nyc_today/cli.rb

@@ -0,0 +1,211 @@
+class NycToday::CLI
+
+  @@set_no = 0
+  @@type_choice = 0
+
+  def call
+    puts welcome
+    NycToday::Scraper.scrape_events
+    list_event_types
+  end
+
+  def welcome
+    system "clear"
+    <<~HEREDOC
+
+      Welcome to NYC Today-- your guide to today's events in and around New York City!
+
+      Please wait a few seconds while I gather today's events.
+
+      For the best experience, maximize the terminal.
+
+    HEREDOC
+  end
+
+  def list_event_types
+    system "clear"
+    puts "\nHere are today's event categories:\n\n"
+    type_entry
+    puts menu_bottom
+    choose_type
+    list_events
+  end
+
+  def menu_bottom
+    <<~HEREDOC
+
+      -------------------------------------------------------------
+      * Enter a number for the type of event you would like to see.
+      * Type 'exit' to leave the program.
+    HEREDOC
+  end
+
+  def type_entry
+    NycToday::Event.event_types.each.with_index(1) do |event_type, i|
+      puts "#{i.to_s.rjust(2," ")} | #{event_type}"
+    end
+  end
+
+  def choose_type
+    input = gets.strip
+    if input.to_i > 0 && input.to_i <= NycToday::Event.event_types.count
+      @@type_choice = input.to_i-1
+    elsif input.downcase == "exit"
+      goodbye
+    else
+      system "clear"
+      puts "I'm sorry, that is not an option. Please choose a number from the menu."
+      sleep 1
+      system "clear"
+      list_event_types
+    end
+  end
+
+  def list_events
+    system "clear"
+    page_count
+    category
+    if @@set_no+1 <= page_count
+      puts "\nHere's page #{@@set_no+1}/#{page_count} of today's #{category} events ordered by time:\n\n"
+      event_entry
+    else
+      end_of_list
+    end
+    selection
+  end
+
+  def page_count
+    NycToday::Event.event_sets(@@type_choice).count
+  end
+
+  def category
+    NycToday::Event.event_types[@@type_choice]
+  end
+
+  def event_entry
+    NycToday::Event.event_sets(@@type_choice)[@@set_no].each.with_index(1) do |event, i|
+      puts "#{i.to_s.rjust(3," ")} | #{event.name}"
+      puts "    | #{event.time} at #{event.venue}\n\n"
+    end
+  end
+
+  def error
+    puts "I'm sorry, I didn't understand what you typed. Please try again."
+    sleep 1
+    system "clear"
+  end
+
+  def selection
+    puts more_events
+    input = gets.strip.downcase
+    if input == "" or input == " "
+      @@set_no += 1
+      list_events
+    elsif input.to_i > 0
+      event = NycToday::Event.sets[@@set_no][input.to_i-1]
+      NycToday::Scraper.scrape_event_page(event) unless event.event_info != nil
+      more_info(event)
+    elsif input == "menu"
+      reset_menu
+    elsif input == "back"
+      if @@set_no >= 1
+        @@set_no -= 1
+        list_events
+      else
+        reset_menu
+      end
+      puts
+    elsif input == "exit"
+      goodbye
+    else
+      system "clear"
+      error
+      sleep 2
+      list_events
+    end
+  end
+
+  def more_events
+    <<~HEREDOC
+      -------------------------------------------------------------------
+      * Enter the number of any event you'd like to know more about
+      * Press Enter for more events
+      * Enter 'menu' to return to the main menu
+      * Enter 'back' to go back or 'exit' to leave the program
+    HEREDOC
+  end
+
+  def more_info(event)
+    if event.event_info != nil || event.price != nil
+      system "clear"
+      puts "\n--------------------------------------------------------------------------------\n\n"
+      puts "Ticket info: #{event.price}\n\n" unless event.price == nil
+      puts wrap(event.event_info, 80) unless event.event_info == nil
+    else
+      system "clear"
+      puts "\nI'm sorry, there is no additional information about this event."
+    end
+    return_to_menu
+  end
+
+  def wrap(text, width=80)
+    paragraphs = text.split("\n")
+    wrapped = paragraphs.collect do |para|
+      para.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
+    end
+    wrapped
+  end
+
+  def return_to_menu
+    puts event_info_bottom
+    input = gets.strip.downcase
+    if input == "exit"
+      goodbye
+    else
+      system "clear"
+      list_events
+    end
+  end
+
+  def event_info_bottom
+    <<~HEREDOC
+
+      --------------------------------------------------------------------------------
+      * Press Enter to return to the list of events
+      * Type 'exit' to leave the program
+    HEREDOC
+  end
+
+  def end_of_list
+    puts "\nYou've reached the end of the #{category} events list. Would you like to see it again? (Y/n)"
+    input = gets.strip.downcase
+    if input == "y" || input == "yes"
+      @@set_no = 0
+      list_events
+    elsif input == "n" || input == "no"
+      puts "\nReturning to main menu..."
+      sleep 1.25
+      reset_menu
+    else
+      error
+      end_of_list
+    end
+  end
+
+  def reset_menu
+    system "clear"
+    NycToday::Event.reset_sets
+    @@set_no = 0
+    @@type_choice = 0
+    list_event_types
+  end
+
+  def goodbye
+    system "clear"
+    puts "\nGood-bye! Come back tomorrow for a new list of events."
+    sleep 1.25
+    system "clear"
+    exit
+  end
+
+end

data/lib/nyc_today/event.rb

@@ -0,0 +1,69 @@
+class NycToday::Event
+  attr_accessor :name, :venue, :time, :time_stamp, :event_link, :event_info, :event_type, :price
+
+  @@all = []
+  @@sets = []
+
+  def initialize(hash)
+    hash.each do |key, value|
+      self.send("#{key}=", value)
+    end
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.sets
+    @@sets
+  end
+
+  def self.reset_sets
+    sets.clear
+  end
+
+  def self.event_types
+    all.sort_by!{|e|e.event_type.length}.collect{|event|event.event_type}.uniq!
+  end
+
+  def self.reformat_types
+    all.each do |event|
+      if event.event_type.include?("Dj")
+        event.event_type.sub!("j", "J")
+      elsif event.event_type.include?("Food")
+        event.event_type.insert(4, ",").insert(10, " &")
+      elsif event.event_type.include?("Talks")
+        event.event_type = event.event_type.insert(8, " &")
+      elsif event.event_type.include?("Theatre")
+        event.event_type.insert(7, " &")
+      else
+        event.event_type
+      end
+    end
+  end
+
+  def self.event_sets(input)
+    choice = event_types[input]
+    event_group = []
+    all.each do |event|
+      event.event_type.downcase == choice.downcase ? event_group << event : nil
+    end
+    @@sets = event_group.sort_by!{|e|e.time_stamp}
+    sort_events
+  end
+
+  def self.midnight_fix
+    midnight = []
+    @@sets.reject! do |e|
+      e.time_stamp.to_s[11].to_i == 0 && e.time_stamp.to_s[12].to_i < 7 ? midnight << e : nil
+    end
+    midnight
+  end
+
+  def self.sort_events
+    midnight_fix.sort_by!{|e|e.time_stamp}
+    @@sets = @@sets.push(*midnight_fix).each_slice(5).to_a
+  end
+
+end

data/lib/nyc_today/scraper.rb

@@ -0,0 +1,48 @@
+class NycToday::Scraper
+
+  @@main_url = "http://nyc-shows.brooklynvegan.com"
+  @@pages = []
+
+  def self.get_pages
+    num = 1
+    while num <= 10
+      page_url = @@main_url + "/events/today?page=#{num}"
+      page = Nokogiri::HTML(open(page_url))
+      @@pages << page
+      num += 1
+    end
+  end
+
+  def self.scrape_events
+    get_pages
+    @@pages.each do |page|
+      page.css(".event-card").each do |event|
+        url_end = event.css("a").attribute("href").value
+        event_hash = {}
+        event_hash[:event_type] = event.attr("class").sub!("ds-listing event-card ds-event-category-", "").split("-").map(&:capitalize).join(" ")
+        if event.css(".ds-byline").text != ""
+          event_hash[:name] = event.css(".ds-byline").text.lstrip + ": " + event.css(".ds-listing-event-title-text").text.lstrip
+        else
+          event_hash[:name] = event.css(".ds-listing-event-title-text").text.lstrip
+        end
+        event_hash[:venue] = event.css(".ds-venue-name").text.gsub!(/\s+/, " ").strip
+        event_hash[:time] = event.css(".dtstart").text.gsub!(/\s+/, " ").strip
+        event_hash[:time_stamp] = Time.parse(event_hash[:time])
+        event_hash[:event_link] = @@main_url + url_end
+        NycToday::Event.new(event_hash)
+      end
+    end
+    NycToday::Event.reformat_types
+  end
+
+  def self.scrape_event_page(event)
+    event_page = Nokogiri::HTML(open(event.event_link))
+    event.price = event_page.css(".ds-ticket-info").text.strip.gsub!(/\s+/, " ")
+    if event_page.at(".ds-event-description-inner")
+      event.event_info = event_page.css(".ds-event-description-inner").text.strip.gsub!(/$/, "\n").to_s
+    else
+      event.event_info = nil
+    end
+  end
+
+end

data/lib/nyc_today/version.rb

@@ -0,0 +1,3 @@
+module NycToday
+  VERSION = "0.1.0"
+end

data/nyc_today.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nyc_today/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nyc_today"
+  spec.version       = NycToday::VERSION
+  spec.authors       = ["Duncan McLachlan"]
+  spec.email         = ["duncanjmclachlan@gmail.com"]
+
+  spec.summary       = %q{CLI that lists and provides information about today's events in and around NYC.}
+  spec.description   = %q{This CLI app lists a set of event categories in and around New York City for users to select from, displays a list of events and their details from that chosen type and displays further information (if available) about any chosen event.}
+  spec.homepage      = "https://github.com/vicision/nyc-today-cli-app"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_runtime_dependency "nokogiri"
+end

data/spec.md

@@ -0,0 +1,14 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+
+      CLI allows user to interact with application by choosing from a menu of event types, navigating through a list of events of that type, choosing an event from this list and seeing more information about it.
+
+- [x] Pull data from an external source
+
+      Scraper pulls data from brooklynvegan.com's event listing pages and individual event pages.
+
+- [x] Implement both list and detail views
+
+      Displays list of event types, then a list of events of a chosen type with names, venues, and times. User can then select one of these events to display further information about the event.

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: nyc_today
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Duncan McLachlan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: This CLI app lists a set of event categories in and around New York City
+  for users to select from, displays a list of events and their details from that
+  chosen type and displays further information (if available) about any chosen event.
+email:
+- duncanjmclachlan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/nyc_today
+- bin/setup
+- lib/nyc_today.rb
+- lib/nyc_today/cli.rb
+- lib/nyc_today/event.rb
+- lib/nyc_today/scraper.rb
+- lib/nyc_today/version.rb
+- nyc_today.gemspec
+- spec.md
+homepage: https://github.com/vicision/nyc-today-cli-app
+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.9
+signing_key: 
+specification_version: 4
+summary: CLI that lists and provides information about today's events in and around
+  NYC.
+test_files: []