puertos 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 2035415cbe891bce7c6d2302e7429df2d8c8466c
4
- data.tar.gz: 7d6c4fc21a7f4009240e3ab8da62c166054f72b7
3
+ metadata.gz: 6b8dafc8afa46f05328511297296b491cca5e44c
4
+ data.tar.gz: b29aa2fb7e86c349cd8d40ca00dac0cfc7f91e69
5
5
  SHA512:
6
- metadata.gz: c517e0bb01fa40490b5e6cbe0c0919f8b03fb384835abb48867dd2bb4bdba3091b55be6a77cedc5ce8463d2c4de80c01121c6b99825a3fd6edb5eb4430de6182
7
- data.tar.gz: 96e82346f38c78e07cbaa1a059dbc374d9c5c5dab11c4d080d1f497c2902b64960c848e82e4c4b2946ed592251830b4996b60083e5805e8cb88c0a9f0201f7b8
6
+ metadata.gz: 5addb2919657a0b8feb730867e286eb8ef5273f7cb07b9fd8d3e191c973e296d65993f5fc6ddbb3e7857ab7277abb4b13bc452249bdafa33f94bcbbb3e6eb238
7
+ data.tar.gz: 06a65c3c8549b8f29a294c27caf40c19120d2c52302d88599a4d5e72427551e76ef75b12a7049bb91500e56e052b2b596689a8342e92b1ba3ac4693c5a99ffd3
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.0
4
+ - ruby-head
5
+ addons:
6
+ code_climate:
7
+ repo_token: ffe6143e0c8ea031bdfcbf913e1a4d3764d5dcc5d27c50cc92d131deabca15d3
data/Gemfile CHANGED
@@ -2,6 +2,7 @@ source "https://rubygems.org"
2
2
 
3
3
  group :test do
4
4
  gem 'rspec'
5
+ gem "codeclimate-test-reporter", require: nil
5
6
  end
6
7
 
7
8
  group :development do
@@ -10,5 +11,4 @@ group :development do
10
11
  gem 'pry'
11
12
  end
12
13
 
13
- # Specify your gem's dependencies in puertos.gemspec
14
14
  gemspec
data/README.md CHANGED
@@ -2,6 +2,11 @@
2
2
 
3
3
  simple ruby gem that fetches the forecast swell data for Barcelona from Puertos del Estado
4
4
 
5
+ [![Gem Version](https://badge.fury.io/rb/puertos.svg)](http://badge.fury.io/rb/puertos)
6
+ [![Build Status](https://travis-ci.org/rgalindo33/puertos.svg?branch=master)](https://travis-ci.org/rgalindo33/puertos)
7
+ [![Code Climate](https://codeclimate.com/github/rgalindo33/puertos/badges/gpa.svg)](https://codeclimate.com/github/rgalindo33/puertos)
8
+ [![Test Coverage](https://codeclimate.com/github/rgalindo33/puertos/badges/coverage.svg)](https://codeclimate.com/github/rgalindo33/puertos)
9
+
5
10
  ## Installation
6
11
 
7
12
  Add this line to your application's Gemfile:
@@ -39,7 +44,7 @@ returns the time of the forecast as a Time object
39
44
  returns a Puertos::WindData object, for which the following methods are available
40
45
 
41
46
  wind_data_instance.speed => "3.4"
42
- wind_data_instance.direction => "SSE"
47
+ wind_data_instance.direction => "SSE" # shows propagation or "blowing to" direction
43
48
  wind_data_instance.unit => "m/s"
44
49
 
45
50
  forecast_data_instance.total_swell
@@ -48,31 +53,31 @@ returns a Puertos::SwellData object, which has the sum of all swells.
48
53
 
49
54
  forecast_data_instance.wind_swell
50
55
 
51
- returns a Puertos::SwellData object, which represent the swell generated by nearby winds
56
+ returns a Puertos::SwellData object, which represent the swell generated by nearby winds. Wind Swell is composed by irregular short waves that are being generated by the wind and are still growing
52
57
 
53
58
  forecast_data_instance.ground_swell_1
54
59
 
55
60
  returns a Puertos::SwellData object, with the primary ground swell data
56
61
 
57
- forecast_data_instance.ground_swell_1
62
+ forecast_data_instance.ground_swell_2
58
63
 
59
64
  returns a Puertos::SwellData object, with the secondary ground swell data
60
65
 
61
66
 
62
67
  For every SwellData object, following methods are available
63
68
 
64
- wind_data_instance.height => "3.4"
69
+ wind_data_instance.height => "3.4" # equivalent to the mean value of the 1/3rd highest waves
65
70
  wind_data_instance.height_unit => "m"
66
71
  wind_data_instance.direction => "NNW"
67
- wind_data_instance.avg_period => "8"
68
- wind_data_instance.peak_period => "10"
72
+ wind_data_instance.avg_period => "8" # the mean of all periods
73
+ wind_data_instance.peak_period => "10" # the period of the most energetic wave group
69
74
  wind_data_instance.period_unit => "s"
70
75
 
71
76
 
72
77
 
73
78
  ## Contributing
74
79
 
75
- 1. Fork it ( https://github.com/[my-github-username]/pont_del_petroli/fork )
80
+ 1. Fork it ( https://github.com/rgalindo33/puertos/fork )
76
81
  2. Create your feature branch (`git checkout -b my-new-feature`)
77
82
  3. Commit your changes (`git commit -am 'Add some feature'`)
78
83
  4. Push to the branch (`git push origin my-new-feature`)
@@ -1,3 +1,3 @@
1
1
  module Puertos
2
- VERSION = "0.1.0"
2
+ VERSION = "0.1.1"
3
3
  end
data/puertos.gemspec CHANGED
@@ -6,10 +6,10 @@ require 'puertos/version'
6
6
  Gem::Specification.new do |spec|
7
7
  spec.name = "puertos"
8
8
  spec.version = Puertos::VERSION
9
- spec.authors = ["rgalindo33"]
9
+ spec.authors = ["Raul Galindo"]
10
10
  spec.email = ["rgalindo33@hotmail.com"]
11
11
  spec.summary = %q{Forecast swell information for Barcelona}
12
- spec.description = %q{returns ruby objects with meaningfull swell data}
12
+ spec.description = %q{simple ruby gem that fetches the forecast swell data for Barcelona from Puertos del Estado}
13
13
  spec.homepage = "https://github.com/rgalindo33/puertos"
14
14
  spec.license = "MIT"
15
15
 
data/spec/spec_helper.rb CHANGED
@@ -1,3 +1,6 @@
1
+ require "codeclimate-test-reporter"
2
+ CodeClimate::TestReporter.start
3
+
1
4
  $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib")
2
5
 
3
6
  require 'pry'
metadata CHANGED
@@ -1,10 +1,10 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: puertos
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
- - rgalindo33
7
+ - Raul Galindo
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
@@ -52,7 +52,8 @@ dependencies:
52
52
  - - ">="
53
53
  - !ruby/object:Gem::Version
54
54
  version: '0'
55
- description: returns ruby objects with meaningfull swell data
55
+ description: simple ruby gem that fetches the forecast swell data for Barcelona from
56
+ Puertos del Estado
56
57
  email:
57
58
  - rgalindo33@hotmail.com
58
59
  executables: []
@@ -60,6 +61,7 @@ extensions: []
60
61
  extra_rdoc_files: []
61
62
  files:
62
63
  - ".gitignore"
64
+ - ".travis.yml"
63
65
  - Gemfile
64
66
  - Guardfile
65
67
  - LICENSE.txt