puertos 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b966b0e6c7533b0658dffb9bf1fbc55225131c0
-  data.tar.gz: 1452503be21e7662b8481f553539b093f045f638
+  metadata.gz: 2035415cbe891bce7c6d2302e7429df2d8c8466c
+  data.tar.gz: 7d6c4fc21a7f4009240e3ab8da62c166054f72b7
 SHA512:
-  metadata.gz: 482508b2961db645d5f4c79a2ac3ef8ab2c4c907278521672d6bb2d5ee3dd999e7782145a7feeec4707d7461948c13bed0ff5822579101e111ca70602c17b4e0
-  data.tar.gz: 67ae52cb1a8c87ecbf74f4c3ab110985a2c6f7596e41bb6bbb8b26bf0ad968767113eb367fe1473a6fab2cec03528db9dda099b526f1d4c5b5c70593e24474b5
+  metadata.gz: c517e0bb01fa40490b5e6cbe0c0919f8b03fb384835abb48867dd2bb4bdba3091b55be6a77cedc5ce8463d2c4de80c01121c6b99825a3fd6edb5eb4430de6182
+  data.tar.gz: 96e82346f38c78e07cbaa1a059dbc374d9c5c5dab11c4d080d1f497c2902b64960c848e82e4c4b2946ed592251830b4996b60083e5805e8cb88c0a9f0201f7b8

data/README.md

@@ -26,7 +26,48 @@ and then there is the one and only command available
 
     Puertos.fetch
 
-returns the swell and wind data for the next 72 hours
+returns the swell and wind data for the next 72 hours, as an ForecastData array
+
+ForecastData has the following methods:
+
+    forecast_data_instance.timestamp
+
+returns the time of the forecast as a Time object
+
+    forecast_data_instance.wind
+
+returns a Puertos::WindData object, for which the following methods are available
+
+    wind_data_instance.speed     => "3.4"
+    wind_data_instance.direction => "SSE"
+    wind_data_instance.unit      => "m/s"
+
+    forecast_data_instance.total_swell
+
+returns a Puertos::SwellData object, which has the sum of all swells.
+
+    forecast_data_instance.wind_swell
+
+returns a Puertos::SwellData object, which represent the swell generated by nearby winds
+
+    forecast_data_instance.ground_swell_1
+
+returns a Puertos::SwellData object, with the primary ground swell data
+
+    forecast_data_instance.ground_swell_1
+
+returns a Puertos::SwellData object, with the secondary ground swell data
+
+
+For every SwellData object, following methods are available
+
+    wind_data_instance.height      => "3.4"
+    wind_data_instance.height_unit => "m"
+    wind_data_instance.direction   => "NNW"
+    wind_data_instance.avg_period  => "8"
+    wind_data_instance.peak_period => "10"
+    wind_data_instance.period_unit => "s"
+
 
 
 ## Contributing

data/lib/puertos/version.rb

@@ -1,3 +1,3 @@
 module Puertos
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/row_parser.rb

@@ -5,49 +5,53 @@ module Puertos
   class RowParser
 
     attr_reader :row
-    
+
     def initialize row
       @row = row
     end
 
     def run
-      timestamp      = read_column(1)
+      timestamp      = create_timestamp
       wind           = create_wind_data
       total_swell    = create_total_swell_data
       wind_swell     = create_wind_swell_data
       ground_swell_1 = create_ground_swell_data_1
       ground_swell_2 = create_ground_swell_data_2
 
-      ForecastData.new wind, total_swell, wind_swell, ground_swell_1, ground_swell_2
+      ForecastData.new timestamp, wind, total_swell, wind_swell, ground_swell_1, ground_swell_2
     end
 
   private
 
+    def create_timestamp
+      Time.parse read_column(1)
+    end
+
     def create_wind_data
-      Puertos::WindData.new speed: read_column(5), direction: read_column(6)
+      Puertos::WindData.new speed: read_column(4), direction: read_column(5)
     end
 
     def create_total_swell_data
-      Puertos::SwellData.new height: read_column(7), direction: read_column(8), avg_period: read_column(10), peak_period: read_column(9)
+      Puertos::SwellData.new height: read_column(6), direction: read_column(7), avg_period: read_column(9), peak_period: read_column(8)
     end
 
     def create_wind_swell_data
-      Puertos::SwellData.new height: read_column(11), direction: read_column(12)
+      Puertos::SwellData.new height: read_column(10), direction: read_column(11)
     end
 
     def create_ground_swell_data_1
-      Puertos::SwellData.new height: read_column(13), direction: read_column(14), avg_period: read_column(15)
+      Puertos::SwellData.new height: read_column(12), direction: read_column(13), avg_period: read_column(14)
     end
 
     def create_ground_swell_data_2
-      Puertos::SwellData.new height: read_column(16), direction: read_column(17), avg_period: read_column(18)
+      Puertos::SwellData.new height: read_column(15), direction: read_column(16), avg_period: read_column(17)
     end
 
     def read_column number
-      row.css("td:nth-child(#{number})").text
+      row.css("td:nth-child(#{number})").text.strip
     end
   end
 
-  class ForecastData < Struct.new :wind, :total_swell, :wind_swell, :ground_swell_1, :ground_swell_2
+  class ForecastData < Struct.new :timestamp, :wind, :total_swell, :wind_swell, :ground_swell_1, :ground_swell_2
   end
 end

data/lib/swell_data.rb

@@ -1,11 +1,15 @@
 module Puertos
   class SwellData
-    #remove after upgrading to ruby 2.1
-    def initialize(height: 1, direction: 'e', avg_period: nil, peak_period: nil)
+
+    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')
       @height      = height
+      @height_unit = height_unit
       @direction   = direction
       @avg_period  = avg_period
       @peak_period = peak_period
+      @period_unit = period_unit
     end
   end
 end

data/lib/wind_data.rb

@@ -1,9 +1,11 @@
 module Puertos
   class WindData
-    #remove after upgrading to ruby 2.1
-    def initialize(speed: 1, direction: 'e')
+    attr_reader :speed, :direction, :unit
+
+    def initialize(speed: nil, direction: nil, unit: 'm/s')
       @speed     = speed
       @direction = direction
+      @unit      = unit
     end
   end
 end

data/spec/row_parser_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Puertos::RowParser do
+  let(:row) do
+    Nokogiri::HTML(open(Puertos::Parser::DATA_URL)).css(Puertos::Parser::CSS_ROWS_SELECTOR).last
+  end
+
+  let(:subject) { Puertos::RowParser.new row }
+
+  describe '#run' do
+    let(:forecast) { subject.run }
+
+    it 'has a proper timestamp' do
+      expect(forecast.timestamp).to be_a Time
+    end
+
+    it 'has wind data' do
+      expect(forecast.wind).to be_a Puertos::WindData
+    end
+
+    it 'has total swell data' do
+      expect(forecast.total_swell).to be_a Puertos::SwellData
+    end
+
+    it 'has wind swell data' do
+      expect(forecast.wind_swell).to be_a Puertos::SwellData
+    end
+
+    it 'has ground swell data' do
+      expect(forecast.ground_swell_1).to be_a Puertos::SwellData
+    end
+
+    it 'has secondary swell data' do
+      expect(forecast.ground_swell_2).to be_a Puertos::SwellData
+    end
+  end
+end

data/spec/swell_data_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Puertos::SwellData do
+  let(:subject) { Puertos::SwellData.new height: '3', direction: 'E', avg_period: '3', peak_period: '5'}
+
+  describe '#height' do
+    it 'returns the swell height' do
+      expect(subject.height).to eq '3'
+    end
+  end
+
+  describe '#height_unit' do
+    it 'returns the swell height_unit' do
+      expect(subject.height_unit).to eq 'm'
+    end
+  end
+
+  describe '#direction' do
+    it 'returns the swell direction' do
+      expect(subject.direction).to eq 'E'
+    end
+  end
+
+  describe '#avg_period' do
+    it 'returns the swell avg_period' do
+      expect(subject.avg_period).to eq '3'
+    end
+  end
+
+  describe '#peak_period' do
+    it 'returns the swell peak_period' do
+      expect(subject.peak_period).to eq '5'
+    end
+  end
+
+  describe '#period_unit' do
+    it 'returns the swell period_unit' do
+      expect(subject.period_unit).to eq 's'
+    end
+  end
+
+end

data/spec/wind_data_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Puertos::WindData do
+  let(:subject) { Puertos::WindData.new speed: '2.3', direction: 'E' }
+
+  describe '#speed' do
+    it 'returns the wind speed' do
+      expect(subject.speed).to eq '2.3'
+    end
+  end
+
+  describe '#direction' do
+    it 'returns the wind direction' do
+      expect(subject.direction).to eq 'E'
+    end
+  end
+
+  describe '#unit' do
+    it 'returns the wind unit' do
+      expect(subject.unit).to eq 'm/s'
+    end
+  end
+
+end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: puertos
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - rgalindo33
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-11 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   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: returns ruby objects with meaningfull swell data
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -73,7 +73,10 @@ files:
 - lib/wind_data.rb
 - puertos.gemspec
 - spec/puertos_spec.rb
+- spec/row_parser_spec.rb
 - spec/spec_helper.rb
+- spec/swell_data_spec.rb
+- spec/wind_data_spec.rb
 homepage: https://github.com/rgalindo33/puertos
 licenses:
 - MIT
@@ -84,12 +87,12 @@ 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: []
@@ -100,4 +103,7 @@ specification_version: 4
 summary: Forecast swell information for Barcelona
 test_files:
 - spec/puertos_spec.rb
+- spec/row_parser_spec.rb
 - spec/spec_helper.rb
+- spec/swell_data_spec.rb
+- spec/wind_data_spec.rb