surf_rockaway 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9eb8bf9bcf9d8e206a2c1038d37b9bf6d7b2dcd264f14602275dd108b8cb236
-  data.tar.gz: 51ed24eab166dc88c7cf9b7379a6ca743f0dfdecffecbe5ac4f70d992ea1b5e6
+  metadata.gz: e05d4d6a5c2d8ae3e0cd13f5cc6cf14bab81c59bedf1001e1be4bccefeedf4a8
+  data.tar.gz: 10a47bf16925070c89477aeca35a53dc175bff4dc1792afa7bacfcc84d3b48d1
 SHA512:
-  metadata.gz: 4b1b3909933faf464e7c5c110a7dcae32aa02ab73d15ef5d79e8864354ec6ea723c1dc056fe5795b2150b1f9fb5d01dccf1e1fb06d8f6657a75e236c8b67e5bc
-  data.tar.gz: 770dc6e1b2d6005d20d6b6af7e300862be8ca47afaa36870a82fb923ca4f82f2ad01236e35885da12bd7842c92f750309cc8fea77f07c9e4fa8099cd291f686a
+  metadata.gz: 50ac370c78a75b6a9e1b62c1d0ad568edcf46113e3466802defa5adcea09bb8b8adeed7de86225d4537528ca0c70ce1dd10a1d84172457cbe46905a546dc3713
+  data.tar.gz: b24d27a49234a76b8bb6d2b100b1ac54210ee738bcbcd3754bd50e32044c8d3f6c535842e395875e462bb603980b58bf29473b671ac38a8fd32644a4a92df3f6

data/CHANGELOG.md

@@ -0,0 +1 @@
+

data/README.md

@@ -10,12 +10,12 @@ $ gem install surf-rockaway
 
 ## Detailed Description
 
-A Florida native for most of my life, moving to NYC over the summer left me longing for the beach. I soon discovered Rockaway Beach is the closest surf spot to the city. (bonus you can take the water ferry!) All too often, I found myself lost in a terminal screen ... searching for an excuse to hit the beach for a few hours. So, I created surf-rockaway. This gem provides a quick way to check the current surf condtions without ever leaving the terminal.
+A Florida native, moving to NYC over the summer left me longing for the beach. I soon discovered Rockaway Beach is the closest surf spot to the city. (bonus you can take the water ferry!) All too often, I found myself lost in a terminal screen ... searching for an excuse to hit the beach for a few hours. So, I created surf-rockaway. This gem provides a quick way to check the current surf condtions without ever leaving the terminal.
 
 ## Data Provided
 
---- current forcast
---- 3-day surf condtions
+--- current forecast
+--- 3-day surf conditions
 --- (in development) Set notification based on wave size
 
 ## Development

data/lib/environment.rb

@@ -7,4 +7,5 @@ require "tty-table"
 
 require_relative "./surf_data/version"
 require_relative './surf_data/cli'
-require_relative './surf_data/surf_report.rb'
+require_relative './surf_data/surf_report'
+require_relative './surf_data/search'

data/lib/surf_data/cli.rb

@@ -22,6 +22,7 @@ class SurfRockaway::CLI
             input = prompt.select('Please select an options below:') do |menu|
                 menu.choice 'Current conditions', 'Current'
                 menu.choice '3 day forecast', '3 day'
+                menu.choice 'Seach by wave size', 'Search'
                 menu.choice 'Set notification', 'Set notification', disabled: '(in development)'
                 menu.choice 'Exit the program', 'Exit'
             end
@@ -34,10 +35,39 @@ class SurfRockaway::CLI
                 puts ""
                 SurfRockaway::SurfReport.multi_day
                 puts ""
+            elsif input == "Search"
+                puts "---------------------------------------------------------"
+                puts ""
+                options = SurfRockaway::Search.wave_options
+                options.each.with_index(1) do |wave, i|
+                    puts "  #{i}.  #{wave}".green
+                end
+                #options returns an array of unique wave sizes
+                puts ""
+                puts "---------------------------------------------------------"
+                puts " Enter the number associated with the desired wave size: "
+                puts "---------------------------------------------------------"
+                # request input, set value to a variable called #input
+                input = gets.chomp.to_i
+                # set variable called #selection
+                selection = options[input-1]
+                puts ""
+                puts ""
+                puts ""
+                # accepts #selection variable as an argument for #search_by_size ... in #Search class. Prints results.
+                input_size = SurfRockaway::Search.search_by_size(selection)
+                return_values = input_size.collect {|day| day.values}.to_a
+                puts ""
+                puts "== WAVES @ #{selection.green} ============"
+                puts ""
+                puts return_values
+                puts ""
+                puts "-------------------------"
+                puts ""
             else input == "Exit"
                 puts ""
                 puts ""
-                puts "__̴ı̴̴̡̡̡ ̡͌l̡̡̡ ̡͌l̡*̡̡ ̴̡ı̴̴̡ ̡̡͡| ̲▫̲͡ ̲̲͡▫̲̲͡͡ ̲|̡̡̡ ̡ ̴̡ı̴̡̡ ̡͌l̡̡̡̡.___  ... See you soon! "
+                puts "__̴ı̴̴̡̡̡ ̡͌l̡̡̡ ̡͌l̡*̡̡ ̴̡ı̴̴̡ ̡̡͡| ̲▫̲͡ ̲̲͡▫̲̲͡͡ ̲|̡̡̡ ̡ ̴̡ı̴̡̡ ̡͌l̡̡̡̡.___  ... Thanks! See you soon! "
                 puts ""
                 exit
             end

data/lib/surf_data/search.rb

@@ -0,0 +1,125 @@
+
+###############################################################################
+    
+    #### DONE ####
+    
+    # waves => array of unique wave sizes for the next 3 days
+    # hash with wave/date/time for the next 3-day
+    # display waves array as CLI options
+    # accept user input for wave size
+    # search hash for days/times when waves will be at the desired height
+    # return results on CLI
+    # fix return formatting for #return_values
+    # link values for #search_wave_size
+    
+    #### TODO ####
+
+    # refactor code for clarity
+
+# As discussed, I buit out functionality to search for a specific wave size.
+# 
+#   1. select input from a index of avaliable wave sizes
+#   2. use input to query dates, times, and wave sizes from 3 day forecast 
+#   3. return date && time when wave size == input
+# 
+# The way I collected/returned data, using the TTY-Prompt gem, proved challenging to work with. To save time
+# and move forward  ... I built a nested hash, broken down by day, in #Search.
+# The #Search class below takes an input in the form of a wave size. The wave size then iterates over the 
+# nested hash, #search_by_size, to locate a day/time where wave size == input.
+
+###############################################################################
+
+class SurfRockaway::Search
+    
+    @doc = Nokogiri::HTML(open('https://magicseaweed.com/Rockaway-Surf-Report/384/'))
+
+    def self.wave_options
+        
+        # scrapes magicseaweed.com for wave size each day 
+        
+        day_1 = @doc.search("td.background-info").text.strip.split[2..6]
+        day_2 = @doc.search("td.background-info").text.strip.split[10..14]
+        day_3 = @doc.search("td.background-info").text.strip.split[18..22]
+        
+        # combines days into a variable called "waves" 
+        # returns "waves" as an array with only unique values
+
+        @size = day_1 + day_2 + day_3
+        @size.uniq
+
+    end
+
+    def self.date_options
+
+        # scrapes magicseaweed.com for dates
+        @date = []
+
+        day_1 = @doc.search("tr.tbody-title").text.strip.split("   ").compact.first 
+        day_2 = @doc.search("tr.tbody-title").text.strip.split.slice(4..5).join(" ")
+        day_3 = @doc.search("tr.tbody-title").text.strip.split.slice(6..7).join(" ")
+
+        # returns data for each day && pushes data to instance variable @date 
+        @date << day_1
+        @date << day_2
+        @date << day_3
+
+        # calls @date
+        @date
+
+    end
+
+    def self.time_options
+
+        # scrapes magicseaweed.com for times && returns @times variable
+
+        @time = @doc.search("td.nopadding-left").text.strip.split[2..6]
+        @time
+
+    end
+
+    def self.collect_data
+
+        # call #wave_options, @waves, #date_options, #time_options
+        
+        wave_options && @waves
+        date_options
+        time_options
+    
+    end
+
+    
+    def self.search_by_size(selection)
+        
+        # calls #collect_data
+        collect_data
+
+        # create array to store day, time, and wave size as nested hash
+        wave_sizes = [
+                
+            { :day => "#{@date[0]}", :time => "#{@time[0]}", :size => "#{@size[0]}" },
+            { :day => "#{@date[0]}", :time => "#{@time[1]}", :size => "#{@size[1]}" },
+            { :day => "#{@date[0]}", :time => "#{@time[2]}", :size => "#{@size[2]}" },
+            { :day => "#{@date[0]}", :time => "#{@time[3]}", :size => "#{@size[3]}" },
+            { :day => "#{@date[0]}", :time => "#{@time[4]}", :size => "#{@size[4]}" },
+
+            { :day => "#{@date[1]}", :time => "#{@time[0]}", :size => "#{@size[5]}" },
+            { :day => "#{@date[1]}", :time => "#{@time[1]}", :size => "#{@size[6]}" },
+            { :day => "#{@date[1]}", :time => "#{@time[2]}", :size => "#{@size[7]}" },
+            { :day => "#{@date[1]}", :time => "#{@time[3]}", :size => "#{@size[8]}" },
+            { :day => "#{@date[1]}", :time => "#{@time[4]}", :size => "#{@size[9]}" },
+
+            { :day => "#{@date[2]}", :time => "#{@time[0]}", :size => "#{@size[10]}" },
+            { :day => "#{@date[2]}", :time => "#{@time[1]}", :size => "#{@size[11]}" },
+            { :day => "#{@date[2]}", :time => "#{@time[2]}", :size => "#{@size[12]}" },
+            { :day => "#{@date[2]}", :time => "#{@time[3]}", :size => "#{@size[13]}" },
+            { :day => "#{@date[2]}", :time => "#{@time[4]}", :size => "#{@size[14]}" },
+
+        ]
+
+        # selection argument captured on ./cli.rb
+        # selection compared to key :size by iterating over array #wave_sizes
+        wave_sizes.select {|i| i[:size] == selection}
+               
+    end
+
+end

data/lib/surf_data/surf_report.rb

@@ -1,52 +1,72 @@
 class SurfRockaway::SurfReport
     attr_accessor :location, :wave_size, :wind, :primary_swell, :weather, :temp, :date, :time
 
+    @doc = Nokogiri::HTML(open('https://magicseaweed.com/Rockaway-Surf-Report/384/'))
+
     def self.current
+        
         # Scrape magicseaweed.com and return current conditions for rockaway
-        puts "### Pulling current report ... this may take up to seconds ###"
+        
+        puts "### Pulling current report ... this may take up to 10 seconds ###"
         puts ""
+        
         self.scrape_data
+
     end
 
     def self.scrape_data
+        
         # creates empty array to store data
+        
         conditions = []
 
         # pushes new instances of data from magicseaweed.com to conditions array
+        
         conditions << self.scrape_magicseaweed
 
         conditions
     end
 
     def self.multi_day
+        
         # Scrape 3-day forecast
-        puts "### Pulling current report ... this may take up to seconds ###"
+        
+        puts "### Pulling current report ... this may take up to 15 seconds ###"
         puts ""
+        
         self.scrape_data_multi
+    
     end
 
     def self.scrape_data_multi
-        
+
         multi_day = []
         
+        # pushes new instances of data for 3-day forcast to multi_day array
+
         multi_day << self.scrape_magicseaweed_3day
 
+        # returns the array
+
         multi_day
     end
 
 
     def self.scrape_magicseaweed
-        doc = Nokogiri::HTML(open('https://magicseaweed.com/Rockaway-Surf-Report/384/'))
         
+        # scrape current surf report
+
         current_report = self.new
-        location_raw = doc.search("div.forecast-sub-title-fluid").text.strip.split
+        location_raw = @doc.search("div.forecast-sub-title-fluid").text.strip.split
         current_report.location = location_raw.first(5).join(" ")
-        current_report.wave_size = doc.xpath("//ul[@class='rating rating-large clearfix']/li").text.strip
-        current_report.wind = doc.xpath("//p[@class='h5 nomargin-top']").text.strip
-        p_swell = doc.search("div.list-group-content").text.strip.split
+        current_report.wave_size = @doc.xpath("//ul[@class='rating rating-large clearfix']/li").text.strip
+        current_report.wind = @doc.xpath("//p[@class='h5 nomargin-top']").text.strip
+        p_swell = @doc.search("div.list-group-content").text.strip.split
         current_report.primary_swell = p_swell.first(3).join(" ")
-        current_report.weather = doc.xpath("//p[@class='nomargin-bottom']/i").text.strip
+        current_report.weather = @doc.xpath("//p[@class='nomargin-bottom']/i").text.strip
         
+        # CLI OUTPUT
+
         puts "================================"
         puts "#{current_report.location}"
         puts "================================"
@@ -61,37 +81,41 @@ class SurfRockaway::SurfReport
     end
 
     def self.scrape_magicseaweed_3day
-        doc = Nokogiri::HTML(open('https://magicseaweed.com/Rockaway-Surf-Report/384/'))
 
         # collect Day 1
 
         day_1 = self.new
-        day_1.date = doc.search("tr.tbody-title").text.strip.split("   ").compact.first
-        day_1.time = doc.search("td.nopadding-left").text.strip.split[2..6]
-        day_1.wave_size = doc.search("td.background-info").text.strip.split[2..6]
-        day_1.primary_swell = doc.search("h4.font-sans-serif").text.strip.split[4..13]
-        day_1.temp = doc.search("h5.heavy").text.strip.split("f")[2..6]
+        day_1.date = @doc.search("tr.tbody-title").text.strip.split("   ").compact.first
+        day_1.time = @doc.search("td.nopadding-left").text.strip.split[2..6]
+        day_1.wave_size = @doc.search("td.background-info").text.strip.split[2..6]
+        day_1.primary_swell = @doc.search("h4.font-sans-serif").text.strip.split[4..13]
+        day_1.temp = @doc.search("h5.heavy").text.strip.split("f")[2..6]
+        day_1
 
         # collect Day 2
 
         day_2 = self.new
-        day_2.date = doc.search("tr.tbody-title").text.strip.split.slice(4..5).join(" ")
-        day_2.time = doc.search("td.nopadding-left").text.strip.split[2..6]
-        day_2.wave_size = doc.search("td.background-info").text.strip.split[10..14]
-        day_2.primary_swell = doc.search("h4.font-sans-serif").text.strip.split[20..29]
-        day_2.temp = doc.search("h5.heavy").text.strip.split("f")[10..14]
+        day_2.date = @doc.search("tr.tbody-title").text.strip.split.slice(4..5).join(" ")
+        day_2.time = @doc.search("td.nopadding-left").text.strip.split[2..6]
+        day_2.wave_size = @doc.search("td.background-info").text.strip.split[10..14]
+        day_2.primary_swell = @doc.search("h4.font-sans-serif").text.strip.split[20..29]
+        day_2.temp = @doc.search("h5.heavy").text.strip.split("f")[10..14]
+        day_2
 
         # collect Day 3
 
         day_3 = self.new
-        day_3.date = doc.search("tr.tbody-title").text.strip.split.slice(6..7).join(" ")
-        day_3.time = doc.search("td.nopadding-left").text.strip.split[2..6]
-        day_3.wave_size = doc.search("td.background-info").text.strip.split[18..22]
-        day_3.primary_swell = doc.search("h4.font-sans-serif").text.strip.split[36..45]
-        day_3.temp = doc.search("h5.heavy").text.strip.split("f")[18..22]
+        day_3.date = @doc.search("tr.tbody-title").text.strip.split.slice(6..7).join(" ")
+        day_3.time = @doc.search("td.nopadding-left").text.strip.split[2..6]
+        day_3.wave_size = @doc.search("td.background-info").text.strip.split[18..22]
+        day_3.primary_swell = @doc.search("h4.font-sans-serif").text.strip.split[36..45]
+        day_3.temp = @doc.search("h5.heavy").text.strip.split("f")[18..22]
+        day_3
 
-        # CLI display for 3 day forecast
+        # CLI DISPLAY FOR 3 DAY FORECAST
 
+        # day 1
+        
         puts ""
         puts "==========================="
         puts "#{day_1.date}"
@@ -99,12 +123,15 @@ class SurfRockaway::SurfReport
         table = TTY::Table.new ['', 'wave_size', 'primary_swell', 'temp'], 
         [       
             ["#{day_1.time[0]}", "#{day_1.wave_size[0]}", "#{day_1.primary_swell[0]}", "#{day_1.temp[0]}"],
-            ["#{day_1.time[1]}", "#{day_1.wave_size[1]}", "#{day_1.primary_swell[1]}", "#{day_1.temp[1]}"],
-            ["#{day_1.time[2]}", "#{day_1.wave_size[2]}", "#{day_1.primary_swell[2]}", "#{day_1.temp[2]}"],
-            ["#{day_1.time[3]}", "#{day_1.wave_size[3]}", "#{day_1.primary_swell[3]}", "#{day_1.temp[3]}"],
-            ["#{day_1.time[4]}", "#{day_1.wave_size[4]}", "#{day_1.primary_swell[4]}", "#{day_1.temp[4]}"]
+            ["#{day_1.time[1]}", "#{day_1.wave_size[1]}", "#{day_1.primary_swell[2]}", "#{day_1.temp[1]}"],
+            ["#{day_1.time[2]}", "#{day_1.wave_size[2]}", "#{day_1.primary_swell[4]}", "#{day_1.temp[2]}"],
+            ["#{day_1.time[3]}", "#{day_1.wave_size[3]}", "#{day_1.primary_swell[6]}", "#{day_1.temp[3]}"],
+            ["#{day_1.time[4]}", "#{day_1.wave_size[4]}", "#{day_1.primary_swell[8]}", "#{day_1.temp[4]}"]
         ]
         puts table.render(:ascii).green
+        
+        # day 2
+
         puts ""
         puts "==========================="
         puts "#{day_2.date}"
@@ -112,13 +139,15 @@ class SurfRockaway::SurfReport
         table = TTY::Table.new ['', 'wave_size', 'primary_swell', 'temp'],
         [       
             ["#{day_2.time[0]}", "#{day_2.wave_size[0]}", "#{day_2.primary_swell[0]}", "#{day_2.temp[0]}"],
-            ["#{day_2.time[1]}", "#{day_2.wave_size[1]}", "#{day_2.primary_swell[1]}", "#{day_2.temp[1]}"],
-            ["#{day_2.time[2]}", "#{day_2.wave_size[2]}", "#{day_2.primary_swell[2]}", "#{day_2.temp[2]}"],
-            ["#{day_2.time[3]}", "#{day_2.wave_size[3]}", "#{day_2.primary_swell[3]}", "#{day_2.temp[3]}"],
-            ["#{day_2.time[4]}", "#{day_2.wave_size[4]}", "#{day_2.primary_swell[4]}", "#{day_2.temp[4]}"]
+            ["#{day_2.time[1]}", "#{day_2.wave_size[1]}", "#{day_2.primary_swell[2]}", "#{day_2.temp[1]}"],
+            ["#{day_2.time[2]}", "#{day_2.wave_size[2]}", "#{day_2.primary_swell[4]}", "#{day_2.temp[2]}"],
+            ["#{day_2.time[3]}", "#{day_2.wave_size[3]}", "#{day_2.primary_swell[6]}", "#{day_2.temp[3]}"],
+            ["#{day_2.time[4]}", "#{day_2.wave_size[4]}", "#{day_2.primary_swell[8]}", "#{day_2.temp[4]}"]
         ]
         puts table.render(:ascii).green
 
+        # day 3
+
         puts ""
         puts "==========================="
         puts "#{day_3.date}"
@@ -126,16 +155,14 @@ class SurfRockaway::SurfReport
         table = TTY::Table.new ['', 'wave_size', 'primary_swell', 'temp'],
         [       
             ["#{day_3.time[0]}", "#{day_3.wave_size[0]}", "#{day_3.primary_swell[0]}", "#{day_3.temp[0]}"],
-            ["#{day_3.time[1]}", "#{day_3.wave_size[1]}", "#{day_3.primary_swell[1]}", "#{day_3.temp[1]}"],
-            ["#{day_3.time[2]}", "#{day_3.wave_size[2]}", "#{day_3.primary_swell[2]}", "#{day_3.temp[2]}"],
-            ["#{day_3.time[3]}", "#{day_3.wave_size[3]}", "#{day_3.primary_swell[3]}", "#{day_3.temp[3]}"],
-            ["#{day_3.time[4]}", "#{day_3.wave_size[4]}", "#{day_3.primary_swell[4]}", "#{day_3.temp[4]}"]
+            ["#{day_3.time[1]}", "#{day_3.wave_size[1]}", "#{day_3.primary_swell[2]}", "#{day_3.temp[1]}"],
+            ["#{day_3.time[2]}", "#{day_3.wave_size[2]}", "#{day_3.primary_swell[4]}", "#{day_3.temp[2]}"],
+            ["#{day_3.time[3]}", "#{day_3.wave_size[3]}", "#{day_3.primary_swell[6]}", "#{day_3.temp[3]}"],
+            ["#{day_3.time[4]}", "#{day_3.wave_size[4]}", "#{day_3.primary_swell[8]}", "#{day_3.temp[4]}"]
         ]
         puts table.render(:ascii).green
         puts ""
         puts ""
         puts "######################################"
-        
     end
-
 end

data/lib/surf_data/version.rb

@@ -1,3 +1,3 @@
 module SurfRockaway
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surf_rockaway
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - kyle crews
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2019-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".DS_Store"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -73,9 +74,11 @@ files:
 - lib/environment.rb
 - lib/surf_data/.DS_Store
 - lib/surf_data/cli.rb
+- lib/surf_data/search.rb
 - lib/surf_data/surf_report.rb
 - lib/surf_data/version.rb
 - still_in_progress/notification.rb
+- surf_rockaway-0.1.0.gem
 - surf_rockaway.gemspec
 homepage: https://github.com/kyle-crews/surf-rockaway
 licenses: