libtad 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0199d049a73b8fd060defe6dc08ab230bc3718e4b2ba9f38ade44babcfdf3d8
-  data.tar.gz: 714efc2a4105145b43b440bdb0eea3d21fbf341a269918a29d725df4eaa4a1ee
+  metadata.gz: 977d138cf0263513fe4fc2277d3b96b4523b81df1c6983627e34fbaf59279237
+  data.tar.gz: 9de6d875879d0e2c53fa042252cc3313e837bba78321733059a351a841a85ac4
 SHA512:
-  metadata.gz: 7c95e56ed533e92252e67250f637d48fb7fd938933a71476c0653722e7a3962c125c8ca0b756c0da3de8aa254fafbbf819de7fa18547e48804418f3b7374e6e8
-  data.tar.gz: ab7994a5b52a3fab73f0d00748fbae874b3e8c7d51b0b67bb4a2b6a0b2949700e6672792f71f46fdf525b171a3ca1c46d14040d28a197897d35730a55af494df
+  metadata.gz: ad223d7da22ac8dc49bdad384b37aa7234654b640391de8c77f209d8b412b05b63b0e6aa32b05d6f614288ab50400ef2ec17178a5017d37684a5c86414e84702
+  data.tar.gz: ec0317e7e358248d95540913361bb49e03e7390e2667449d8ab22dbff95c07693162448cd5e803fc0e4d3ee6773d87ff5162fccbbb04e04cb719b6f70bcd5821

data/lib/libtad.rb

@@ -3,6 +3,7 @@ require 'services/date_calculator'
 require 'services/holidays'
 require 'services/onthisday'
 require 'services/places'
+require 'services/tides'
 require 'services/time'
 
 require 'types/astronomy/astronomy_current'
@@ -37,6 +38,10 @@ require 'types/places/location_ref'
 require 'types/places/place'
 require 'types/places/region'
 
+require 'types/tides/station'
+require 'types/tides/station_info'
+require 'types/tides/tide'
+
 require 'types/time/datetime'
 require 'types/time/dst_entry'
 require 'types/time/time'
@@ -57,6 +62,7 @@ module LibTAD
     include LibTAD::Client::HolidaysService
     include LibTAD::Client::OnThisDayService
     include LibTAD::Client::PlacesService
+    include LibTAD::Client::TidesService
     include LibTAD::Client::TimeService
 
     # The endpoint the client connects to.

data/lib/services/tides.rb

@@ -0,0 +1,46 @@
+module LibTAD
+  class Client
+    # Tides API.
+    module TidesService
+      # @return [Array<::LibTAD::Tides::Station>]
+      # @param placeid [String] Specify the ID or a list of ID's for a location which you would like to get tidal data for.
+      # @param onlyhighlow [Boolean] Whether to return every point per interval, or just the highest and lowest points.
+      # @param start_date [String] Start of the requested time interval.
+      # @param end_date [String] End of the requested time interval.
+      # @param radius [Float] Search for tidal stations within the radius from the requested place.
+      # @param subordinate [Boolean] Whether or not to resolve subordinate or just reference stations.
+      # @param interval [Integer] How many minutes between each data point. Supported values: 5 min, 15 min, 30 min, 60 min.
+      # @param localtime [Boolean] Whether input and output timestamps should be resolved to local time or not.
+      #
+      # The Tides service can be used to retrieve predicted tidal data over a given time interval for one or multiple places.
+      def get_tidal_data(
+        placeid:,
+        onlyhighlow: nil,
+        start_date: nil,
+        end_date: nil,
+        radius: nil,
+        subordinate: nil,
+        interval: nil,
+        localtime: nil
+      )
+        args = {
+          placeid: placeid,
+          onlyhighlow: onlyhighlow,
+          startdt: start_date,
+          enddt: end_date,
+          radius: radius,
+          subordinate: subordinate,
+          interval: interval,
+          localtime: localtime
+        }.compact
+
+        response = get('tides', args)
+        stations = response.fetch('stations', [])
+
+        return stations.collect do |e|
+          ::LibTAD::Tides::Station.new(e)
+        end
+      end
+    end
+  end
+end

data/lib/types/tides/station.rb

@@ -0,0 +1,27 @@
+module LibTAD
+  module Tides
+    # Predicted data for a given station.
+    class Station
+      # @return [StationInfo]
+      # The source station for the predicted tidal data.
+      attr_reader :source
+
+      # @return [String]
+      # The part of the queried placeid that this location matches.
+      attr_reader :matchparam
+
+      # @return [Array<Tide>]
+      # Requested tidal information.
+      attr_reader :result
+
+ 
+      def initialize(hash)
+        @source = StationInfo.new hash.fetch('source', nil)
+
+        @matchparam = hash.fetch('matchparam', nil)
+        @result = hash.fetch('result', nil)
+          &.map { |e| Tide.new(e) }
+      end
+    end
+  end
+end

data/lib/types/tides/station_info.rb

@@ -0,0 +1,34 @@
+module LibTAD
+  module Tides
+    # Information about a station.
+    class StationInfo
+      # @return [String]
+      # Station name.
+      attr_reader :name
+
+      # @return [Float]
+      # Latitude coordinates of the station.
+      attr_reader :latitude
+
+      # @return [Float]
+      # Longitude coordinates of the station.
+      attr_reader :longitude
+
+      # @return [String]
+      # Station type. Either reference or subordinate station.
+      attr_reader :type
+
+      # @return [Float]
+      # Distance between request place and this station.
+      attr_reader :distance
+ 
+      def initialize(hash)
+        @name = hash.fetch('name', nil)
+        @latitude = hash.fetch('latitude', nil)
+        @longitude = hash.fetch('longitude', nil)
+        @type = hash.fetch('type', nil)
+        @distance = hash.fetch('distance', nil)
+      end
+    end
+  end
+end

data/lib/types/tides/tide.rb

@@ -0,0 +1,25 @@
+
+module LibTAD
+  module Tides
+    # Information about the tide at a specific point in time.
+    class Tide
+      # @return [::LibTAD::TADTime::TADTime]
+      # Date/time of the specific tidal data point.
+      attr_reader :time
+
+      # @return [Float]
+      # The elevation of tidal water above or below mean sea level.
+      attr_reader :amplitude
+
+      # @return [TidalPhase]
+      # The current tidal phase.
+      attr_reader :phase
+ 
+      def initialize(hash)
+        @time = ::LibTAD::TADTime::TADTime.new hash.fetch('time', nil)
+        @amplitude = hash.fetch('amplitude', nil)
+        @phase = hash.fetch('phase', nil)
+      end
+    end
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: libtad
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Alvsåker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +78,7 @@ files:
 - lib/services/holidays.rb
 - lib/services/onthisday.rb
 - lib/services/places.rb
+- lib/services/tides.rb
 - lib/services/time.rb
 - lib/types/astronomy/astronomy_current.rb
 - lib/types/astronomy/astronomy_day.rb
@@ -106,6 +107,9 @@ files:
 - lib/types/places/location_ref.rb
 - lib/types/places/place.rb
 - lib/types/places/region.rb
+- lib/types/tides/station.rb
+- lib/types/tides/station_info.rb
+- lib/types/tides/tide.rb
 - lib/types/time/datetime.rb
 - lib/types/time/dst_entry.rb
 - lib/types/time/time.rb