libtad 0.1.0

data/lib/types/astronomy/astronomy_object_details.rb

@@ -0,0 +1,32 @@
+module LibTAD
+  module Astronomy
+    # Information about an astronomy object.
+    class AstronomyObjectDetails
+      # @return [String]
+      # Object name.
+      attr_reader :name
+
+      # @return [Array<AstronomyDay>]
+      # Lists and wraps all requested days where events are happening.
+      attr_reader :days
+
+      # @return [AstronomyCurrent]
+      # The current data for the object. Only if requested.
+      attr_reader :current
+
+      # @return [Array<AstronomyCurrent>]
+      # The specific data for the object at isotime/utctime.
+      attr_reader :results
+
+      def initialize(hash)
+        @name = hash.fetch('name', nil)
+        @days = hash.fetch('days', nil)
+          &.map { |e| AstronomyDay.new(e) }
+
+        @current = AstronomyCurrent.new hash['current'] unless !hash.key?('current')
+        @results = hash.fetch('results', nil)
+          &.map { |e| AstronomyCurrent.new(e) }
+      end
+    end
+  end
+end

data/lib/types/astronomy/astronomy_object_type.rb

@@ -0,0 +1,36 @@
+module LibTAD
+  module Astronomy
+    # All valid astronomy object types.
+    ASTRONOMY_OBJECT_TYPE = [
+      # The sun.
+      :sun,
+
+      # The moon.
+      :moon,
+
+      # Mercury.
+      :mercury,
+
+      # Venus.
+      :venus,
+
+      # Mars.
+      :mars,
+
+      # Jupiter.
+      :jupiter,
+
+      # Saturn.
+      :saturn,
+
+      # Uranus.
+      :uranus,
+
+      # Neptune.
+      :neptune,
+
+      # Pluto.
+      :pluto
+    ].freeze
+  end
+end

data/lib/types/astronomy/moonphase.rb

@@ -0,0 +1,37 @@
+module LibTAD
+  module Astronomy
+    # Moon phase.
+    class MoonPhase
+      # @return [String]
+      # Moonphase id.
+      attr_reader :id
+
+      # @return [String]
+      # Moonphase description.
+      def description
+        case @id
+        when 'newmoon'
+          'New moon'
+        when 'waxingcrescent'
+          'Waxing crescent'
+        when 'firstquarter'
+          'Moon in first quarter'
+        when 'waxinggibbous'
+          'Waxing gibbous moon'
+        when 'fullmoon'
+          'Full moon'
+        when 'waninggibbous'
+          'Waning gibbous moon'
+        when 'thirdquarter'
+          'Moon in third quarter'
+        when 'waningcrescent'
+          'Waning crescent moon'
+        end
+      end
+
+      def initialize(id)
+        @id = id
+      end
+    end
+  end
+end

data/lib/types/date_calculator/business_days_filter.rb

@@ -0,0 +1,39 @@
+module LibTAD
+  module DateCalculator
+    # All valid business days filters.
+    BUSINESS_DAYS_FILTER = [
+      # Include or exclude Mondays.
+      :mon,
+
+      # Include or exclude Tuesdays.
+      :tue,
+
+      # Include or exclude Wednesdays.
+      :wed,
+
+      # Include or exclude Thursdays.
+      :thu,
+
+      # Include or exclude Fridays.
+      :fri,
+
+      # Include or exclude Saturdays.
+      :sat,
+
+      # Include or exclude Sundays.
+      :sun,
+
+      # Include or exclude weekends.
+      :weekend,
+
+      # Include or exclude holidays.
+      :holidays,
+
+      # Include or exclude weekends and holidays combined.
+      :weekendholidays,
+
+      # Include or exclude nothing.
+      :none
+    ].freeze
+  end
+end

data/lib/types/date_calculator/business_holiday.rb

@@ -0,0 +1,26 @@
+module LibTAD
+  module DateCalculator
+    # A holiday event which occurs in a requested period.
+    class BusinessHoliday
+      # @return [String]
+      # Either included or excluded, specifying whether or not the holidays
+      # in the result array were included or excluded when queried.
+      attr_reader :type
+
+      # @return [Integer]
+      # The number of holidays in the results.
+      attr_reader :count
+
+      # @return [Array<::LibTAD::Holiday::Holiday>]
+      # Holidays which occur in the requested period.
+      attr_reader :list
+
+      def initialize(hash)
+        @type = hash.fetch('type', nil)
+        @count = hash.fetch('count', nil)
+        @list = hash.fetch('list', nil)
+          &.map { |e| ::LibTAD::Holidays::Holiday.new(e) }
+      end
+    end
+  end
+end

data/lib/types/date_calculator/period.rb

@@ -0,0 +1,44 @@
+module LibTAD
+  module DateCalculator
+    # Calculated results for a requested period.
+    class Period
+      # @return [Integer]
+      # Number of days calculated.
+      attr_reader :includeddays
+
+      # @return [Integer]
+      # Number of calendar days in calculated period.
+      attr_reader :calendardays
+
+      # @return [Integer]
+      # Number of days which was skipped in the calculated period.
+      attr_reader :skippeddays
+
+      # @return [::LibTAD::TADTime::TADTime]
+      # The date the calculation started from.
+      attr_reader :startdate
+
+      # @return [::LibTAD::TADTime::TADTime]
+      # The date the calculation ended on.
+      attr_reader :enddate
+
+      # @return [::LibTAD::DateCalculator::Weekdays]
+      # The spread of excluded or included weekdays in includeddays.
+      attr_reader :weekdays
+
+      # @return [::LibTAD::DateCalculator::BusinessHoliday]
+      # Holidays which occur in the requested period.
+      attr_reader :holidays
+
+      def initialize(hash)
+        @includeddays = hash.fetch('includeddays', nil)
+        @calendardays = hash.fetch('calendardays', nil)
+        @skippeddays = hash.fetch('skippeddays', nil)
+        @startdate = ::LibTAD::TADTime::TADTime.new hash['startdate'] unless !hash.key?('startdate')
+        @enddate = ::LibTAD::TADTime::TADTime.new hash['enddate'] unless !hash.key?('enddate')
+        @weekdays = ::LibTAD::DateCalculator::Weekdays.new hash['weekdays'] unless !hash.key?('weekdays')
+        @holidays = ::LibTAD::DateCalculator::BusinessHoliday.new hash['holidays'] unless !hash.key?('holidays')
+      end
+    end
+  end
+end

data/lib/types/date_calculator/weekdays.rb

@@ -0,0 +1,54 @@
+module LibTAD
+  module DateCalculator
+    # The spread of excluded or included weekdays.
+    class Weekdays
+      # @return [String]
+      # Specifies whether or not the weekdays counted were part of an included or excluded filter.
+      attr_reader :type
+
+      # @return [Integer]
+      # How many days in total have been counted.
+      attr_reader :count
+
+      # @return [Integer]
+      # Count for Mondays.
+      attr_reader :mon
+
+      # @return [Integer]
+      # Count for Tuesdays.
+      attr_reader :tue
+
+      # @return [Integer]
+      # Count for Wednesdays.
+      attr_reader :wed
+
+      # @return [Integer]
+      # Count for Thursdays.
+      attr_reader :thu
+
+      # @return [Integer]
+      # Count for Fridays.
+      attr_reader :fri
+
+      # @return [Integer]
+      # Count for Saturdays.
+      attr_reader :sat
+
+      # @return [Integer]
+      # Count for Sundays.
+      attr_reader :sun
+
+      def initialize(hash)
+        @type = hash.fetch('type', nil)
+        @count = hash.fetch('count', nil)
+        @mon = hash.fetch('mon', nil)
+        @tue = hash.fetch('tue', nil)
+        @wed = hash.fetch('wed', nil)
+        @thu = hash.fetch('thu', nil)
+        @fri = hash.fetch('fri', nil)
+        @sat = hash.fetch('sat', nil)
+        @sun = hash.fetch('sun', nil)
+      end
+    end
+  end
+end

data/lib/types/holidays/holiday.rb

@@ -0,0 +1,93 @@
+module LibTAD
+  module Holidays
+    # A holiday event.
+    class Holiday
+      # @return [Integer]
+      # Identifier for the holiday definition. Please note that this id 
+      # is not unique, not even with a single year – the same holiday 
+      # event may be returned multiple time because it is observed on a 
+      # different day, or because it is scheduled in a different calendar 
+      # (Hebrew or Muslim calendar) and happens multiple times within a 
+      # Gregorian year. Use the uid attribute for purposes where you need a 
+      # unique identifier.
+      attr_reader :id
+
+      # @return [String]
+      # Id for the shown holiday instance. The id is designed to be unique 
+      # across all holiday instances generated by the timeanddate.com API 
+      # services and respects different calendars and other reasons that 
+      # may cause events to occurs multiple times within one Gregorian year.
+      #
+      # Example: 0007d600000007db
+      attr_reader :uid
+
+      # @return [Hash<String, String>]
+      # Hash of languages with corresponding holiday/observance name.
+      attr_reader :name
+
+      # @return [::LibTAD::TADTime::TADTime]
+      # Date/time of the holiday instance. Most holidays do have a specific 
+      # time – in this case the time components will be skipped. Some 
+      # special events like equinoxes and solstices include the exact time 
+      # of the event as well, in this case the timestamp will be in local 
+      # time zone (including time zone data) (countries with multiple 
+      # timezones: local time in capital city).
+      attr_reader :date
+
+      # @return [String]
+      # Further information about the specific holiday. The URL points to 
+      # the timeanddate.com web page.
+      # 
+      # Example: http://www.timeanddate.com/holidays/us/new-year-day
+      attr_reader :url
+
+      # @return [::LibTAD::Models::Country]
+      # Country of the holiday instance.
+      attr_reader :country
+
+      # @return [String]
+      # Summary of locations where this holiday instance is valid. Element is 
+      # only present if the holiday instance does not affect the whole country.
+      attr_reader :locations
+
+      # @return [Array<HolidayState>]
+      # States/subdivisions that are affected by this holiday instance. This 
+      # element is only present if the holiday instance is not valid in the 
+      # whole country.
+      attr_reader :states
+
+      # @return [Hash<String, String>]
+      # Languages with corresponding holiday description.
+      attr_reader :oneliner
+
+      # @return [Array<String>]
+      # Classification of the holiday. Most days have only one classification, 
+      # but some have multiple types associated. This happens e.g. in 
+      # conjunction with religious days that also are flag days.
+      #
+      # Example: National Holiday
+      attr_reader :types
+ 
+      def initialize(hash)
+        @id = hash.fetch('id', nil)
+        @uid = hash.fetch('uid', nil)
+        @name = hash.fetch('name', nil)
+          &.map { |e| [ e['lang'], e['text'] ] }
+          .to_h
+
+        @date = ::LibTAD::TADTime::TADTime.new hash.fetch('date', nil)
+        @url = hash.fetch('url', nil)
+        @country = ::LibTAD::Places::Country.new hash['country'] unless !hash.key?('country')
+        @locations = hash.fetch('locations', nil)
+        @states = hash.fetch('states', nil)
+          &.map { |e| HolidayState.new(e) }
+
+        @oneliner = hash.fetch('oneliner', nil)
+          &.map { |e| [ e['lang'], e['text'] ] }
+          .to_h
+
+        @types = hash.fetch('types', nil)
+      end
+    end
+  end
+end

data/lib/types/holidays/holiday_state.rb

@@ -0,0 +1,35 @@
+module LibTAD
+  module Holidays
+    # A holiday event in a specific state.
+    class HolidayState
+      # @return [String]
+      # An ISO 3166-1 country or ISO 3166-2 country state code.
+      # @see https://dev-test.timeanddate.com/docs/external-references#ISO3166 ISO3166
+      attr_reader :iso
+
+      # @return [Integer]
+      # Unique id of the state/subdivision.
+      attr_reader :id
+
+      # @return [String]
+      # Abbreviation of the state/subdivision.
+      attr_reader :abbrev
+
+      # @return [String]
+      # Common name of the state/subdivision.
+      attr_reader :name
+
+      # @return [String]
+      # Eventual exception if the holiday does not affect the whole state/subdivision.
+      attr_reader :exception
+
+      def initialize(hash)
+        @iso = hash.fetch('iso', nil)
+        @id = hash.fetch('id', nil)
+        @abbrev = hash.fetch('abbrev', nil)
+        @name = hash.fetch('name', nil)
+        @exception = hash.fetch('exception', nil)
+      end
+    end
+  end
+end

data/lib/types/holidays/holiday_type.rb

@@ -0,0 +1,107 @@
+module LibTAD
+  module Holidays
+    # All valid holiday types
+    HOLIDAY_TYPE = [
+      # Combinations of all known types (except fun).
+      :all,
+
+      # Default holiday set: federal, federallocal, obs1, weekday.
+      :default,
+
+      # Default set depending on country.
+      # For most countries, this is the same as default. However,
+      # for some countries it makes sense to add further types – this type 
+      # accounts for this case. Currently this only affects the UK: 
+      # local holidays are added as well. This is to include days that 
+      # are only valid in one of countries – e.g. Jan 2 is a holiday only for Scotland.
+      :countrydefault,
+
+      # Important (obs1), common (obs2) and other observances (obs3).
+      :obs,
+      
+      # All religious holidays: buddhism, christian, hebrew, hinduism, muslim, orthodox.
+      :religious,
+
+      # Some countries (e.g. Sweden) have days which are de facto treted as official holidays, even if there's no legal regulation.
+      :defacto,
+
+      # Federal/national holidays.
+      :federal,
+
+      # Common local holidays.
+      :federallocal,
+
+      # Flag days.
+      :flagday,
+
+      # Half day holidays (only afternoon off). These days can be half day holidays either by law, or being de facto half day holidays (e.g. Sweden).
+      :halfday,
+
+      # Local holidays.
+      :local,
+
+      # Local observances.
+      :local2,
+
+      # Important observances.
+      :obs1,
+
+      # Common observances.
+      :obs2,
+
+      # Other observances
+      :obs3,
+
+      # Optional holiday.
+      # Employment and holiday laws in certain countries allow employees to choose a 
+      # limited number of holidays from a list of holidays. Some employees may 
+      # choose to take the day off on these day, however, most offices and businesses remain open.
+      :optional,
+
+      # Normal working days.
+      # In some cases, working days are declared non-working days 
+      # in order to form a longer period of consecutive non-working days.
+      # In exchange, weekend days become normal working days.
+      :weekday,
+
+      # Buddhist holidays.
+      :buddhism,
+
+      # Christian holidays.
+      :christian,
+
+      # Hebrew holidays.
+      :hebrew,
+
+      # Hindu holidays.
+      :hinduism,
+
+      # Muslim holidays.
+      :muslim,
+
+      # Orthodox holidays.
+      :orthodox,
+
+      # Religious holidays, not covered by other types.
+      :otherreligion,
+
+      # Seasons (equinoxes and solstices).
+      :seasons,
+
+      # Sport events.
+      :sport,
+
+      # Time zone events – daylight savings time start and end.
+      :tz,
+
+      # United Nations days.
+      :un,
+
+      # Worldwide observances.
+      :world,
+
+      # Fun, Wacky and Trivial holidays.
+      :fun,
+    ].freeze
+  end
+end