puertos 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b8dafc8afa46f05328511297296b491cca5e44c
-  data.tar.gz: b29aa2fb7e86c349cd8d40ca00dac0cfc7f91e69
+  metadata.gz: ccf33fe7085a01d027c52c6409f985f136b10b76
+  data.tar.gz: b3249491e9013ec9fcecba80aead88f0227fb064
 SHA512:
-  metadata.gz: 5addb2919657a0b8feb730867e286eb8ef5273f7cb07b9fd8d3e191c973e296d65993f5fc6ddbb3e7857ab7277abb4b13bc452249bdafa33f94bcbbb3e6eb238
-  data.tar.gz: 06a65c3c8549b8f29a294c27caf40c19120d2c52302d88599a4d5e72427551e76ef75b12a7049bb91500e56e052b2b596689a8342e92b1ba3ac4693c5a99ffd3
+  metadata.gz: 277b6062b7241ad9f7fad115b517dd7cc16d44ff53e963eb2433891da4bb2a23616a8d829f9824d05895f336b697ee425f9825a3946ef64701f28dd8963c29ae
+  data.tar.gz: b55f5503d7bff00442ec894b189f56ba3b784012e331a9b9ccd373b253ce789dd361ada89e5b4fe6e18ff6c5aaef602024ee00a8eba92275db7c0e5beb355f28

data/.yardopts

@@ -0,0 +1,5 @@
+--protected
+--no-private
+--embed-mixin ClassMethods
+-
+

data/lib/parser.rb

@@ -4,9 +4,14 @@ require 'nokogiri'
 
 module Puertos
   class Parser
+    #@private
     DATA_URL = 'http://static.puertos.es/pred_simplificada/Predolas/Tablas/Med/BAR.html'
+    #@private
     CSS_ROWS_SELECTOR = 'center center table tr'
 
+    # uses the row parser to parse line by line the forecast table
+    #
+    # @return [Array] Array of ForecastData with all the relevant information
     def run
       rows = Nokogiri::HTML(open(DATA_URL)).css CSS_ROWS_SELECTOR
 

data/lib/puertos.rb

@@ -2,6 +2,9 @@ require "puertos/version"
 require "parser"
 
 module Puertos
+  # public interface for getting the forecast data
+  #
+  # @return [array] of ForecastData with the next 72 hours of forecast
   def self.fetch
     Parser.new.run
   end

data/lib/puertos/version.rb

@@ -1,3 +1,3 @@
 module Puertos
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/row_parser.rb

@@ -2,14 +2,18 @@ require "wind_data"
 require "swell_data"
 
 module Puertos
+  # The Parser is responsible of fetching the data from Puertos del Estado
+  # and return it as ruby objects
   class RowParser
-
     attr_reader :row
 
     def initialize row
       @row = row
     end
 
+    # parses each input line and returns a ForecastData object
+    #
+    # @return [ForecastData] with all the relevant information
     def run
       timestamp      = create_timestamp
       wind           = create_wind_data

data/lib/swell_data.rb

@@ -1,6 +1,5 @@
 module Puertos
   class SwellData
-
     attr_reader :height, :height_unit, :direction, :avg_period, :peak_period, :period_unit
 
     def initialize(height: nil, height_unit: 'm', direction: nil, avg_period: nil, peak_period: nil, period_unit: 's')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puertos
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Raul Galindo
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Guardfile
 - LICENSE.txt