RubyGems - world_time_api - Versions diffs - 0.1.5 → 0.1.6 - Mend

world_time_api 0.1.5 → 0.1.6

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.

Files changed (23) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +18 -8
data/README.md +13 -5
data/doc/WorldTimeApi/Request.html +13 -5
data/doc/WorldTimeApi.html +67 -16
data/doc/_index.html +4 -4
data/doc/class_list.html +6 -3
data/doc/css/full_list.css +3 -3
data/doc/css/style.css +6 -0
data/doc/file.README.html +32 -29
data/doc/file_list.html +5 -2
data/doc/frames.html +10 -5
data/doc/index.html +32 -29
data/doc/js/app.js +294 -264
data/doc/js/full_list.js +30 -4
data/doc/method_list.html +5 -2
data/doc/top-level-namespace.html +3 -3
data/lib/world_time_api/error.rb +4 -3
data/lib/world_time_api/request.rb +16 -5
data/lib/world_time_api/response.rb +5 -4
data/lib/world_time_api/version.rb +2 -3
data/lib/world_time_api.rb +12 -7
metadata +3 -3

data/doc/js/full_list.js CHANGED Viewed

@@ -62,8 +62,25 @@ function enableToggles() {
     evt.stopPropagation();
     evt.preventDefault();
     $(this).parent().parent().toggleClass('collapsed');
+    $(this).attr('aria-expanded', function (i, attr) {
+        return attr == 'true' ? 'false' : 'true'
+    });
     highlight();
   });
+  // navigation of nested classes using keyboard
+  $('#full_list a.toggle').on('keypress',function(evt) {
+    // enter key is pressed
+    if (evt.which == 13) {
+      evt.stopPropagation();
+      evt.preventDefault();
+      $(this).parent().parent().toggleClass('collapsed');
+      $(this).attr('aria-expanded', function (i, attr) {
+          return attr == 'true' ? 'false' : 'true'
+      });
+      highlight();
+    }
+  });
 }
 function populateSearchCache() {
@@ -91,7 +108,7 @@ function enableSearch() {
     }
   });
-  $('#full_list').after("<div id='noresults' style='display:none'></div>");
+  $('#full_list').after("<div id='noresults' role='status' style='display: none'></div>");
 }
 function ignoredKeyPress(event) {
@@ -154,11 +171,14 @@ function partialSearch(searchString, offset) {
 function searchDone() {
   searchTimeout = null;
   highlight();
-  if ($('#full_list li:visible').size() === 0) {
-    $('#noresults').text('No results were found.').hide().fadeIn();
+  var found = $('#full_list li:visible').size();
+  if (found === 0) {
+    $('#noresults').text('No results were found.');
   } else {
-    $('#noresults').text('').hide();
+    // This is read out to screen readers
+    $('#noresults').text('There are ' + found + ' results.');
   }
+  $('#noresults').show();
   $('#content').removeClass('insearch');
 }
@@ -188,6 +208,12 @@ function expandTo(path) {
   $target.addClass('clicked');
   $target.removeClass('collapsed');
   $target.parentsUntil('#full_list', 'li').removeClass('collapsed');
+  $target.find('a.toggle').attr('aria-expanded', 'true')
+  $target.parentsUntil('#full_list', 'li').each(function(i, el) {
+    $(el).find('> div > a.toggle').attr('aria-expanded', 'true');
+  });
   if($target[0]) {
     window.scrollTo(window.scrollX, $target.offset().top - 250);
     highlight();

data/doc/method_list.html CHANGED Viewed

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html>
+<html >
   <head>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="utf-8" />
@@ -38,7 +38,10 @@
         </div>
-        <div id="search">Search: <input type="text" /></div>
+        <div id="search">
+          <label for="search-class">Search:</label>
+          <input id="search-class" type="text" />
+        </div>
       </div>
       <ul id="full_list" class="method">

data/doc/top-level-namespace.html CHANGED Viewed

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
 </title>
@@ -100,9 +100,9 @@
 </div>
       <div id="footer">
-  Generated on Thu Feb 23 15:07:22 2023 by
+  Generated on Thu Nov 20 18:24:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.2.0).
+  0.9.37 (ruby-3.2.2).
 </div>
     </div>

data/lib/world_time_api/error.rb CHANGED Viewed

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
-# The WorldTimeApi module contains methods for making requests to the World Time API.
+# A Ruby wrapper for the World Time API.
 module WorldTimeApi
   # Creates an error object with the specified message.
   #
   # @param message [String] The error message.
   # @return [Hash] A hash with a single key `"error"` containing the error message.
-  Error = -> (message) { { error: message } }
+  # @example
+  #   WorldTimeApi::Error.call('Invalid timezone')
+  Error = ->(message) { { error: message } }
 end

data/lib/world_time_api/request.rb CHANGED Viewed

@@ -2,22 +2,27 @@
 require_relative "response"
 require_relative "error"
-require 'httparty'
+require "httparty"
-# The WorldTimeApi module contains methods for making requests to the World Time API.
+# A Ruby wrapper for the World Time API.
 module WorldTimeApi
-  # The Request module contains methods for making HTTP requests to the World Time API.
+  # A module for making HTTP requests to the World Time API.
   module Request
     include HTTParty
     base_uri "http://worldtimeapi.org/api"
     # Makes an HTTP GET request to the specified URL and returns the response as a hash.
+    # Retries up to 3 times in case of connection errors.
     #
     # @param url [String] The URL to make the request to.
+    # @param max_retries [Integer] Maximum number of retry attempts (default: 3).
     # @return [Hash] A hash representing the response body, or an error hash if there was a problem with the request.
-    Call = ->(url) {
+    # @example
+    #   WorldTimeApi::Request::Call.call('/timezone/Europe/London')
+    Call = lambda { |url, max_retries: 3|
+      retries = 0
       begin
         response = get(url)
@@ -25,6 +30,12 @@ module WorldTimeApi
         WorldTimeApi::Response[response]
       rescue StandardError
+        retries += 1
+        if retries < max_retries
+          sleep(0.5 * retries) # Exponential backoff: 0.5s, 1s, 1.5s
+          puts "Retrying request to #{url} (attempt #{retries + 1})..."
+          retry
+        end
         WorldTimeApi::Error["Connection error"]
       end
     }

data/lib/world_time_api/response.rb CHANGED Viewed

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
-require 'json'
+require "json"
-# The WorldTimeApi module contains methods for making requests to the World Time API.
+# A Ruby wrapper for the World Time API.
 module WorldTimeApi
   # Converts the HTTParty response object into a hash.
   #
   # @param response [HTTParty::Response] The HTTParty response object to convert.
   # @return [Hash] A hash representation of the response body.
-  Response = -> (response) { JSON.parse(response.body) }
+  # @example
+  #   WorldTimeApi::Response.call(HTTParty.get('http://worldtimeapi.org/api/timezone/Europe/London'))
+  Response = ->(response) { JSON.parse(response.body) }
 end

data/lib/world_time_api/version.rb CHANGED Viewed

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
-# The WorldTimeApi module contains methods for making requests to the World Time API.
+# A Ruby wrapper for the World Time API.
 module WorldTimeApi
   # The current version number of the WorldTimeApi gem.
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/world_time_api.rb CHANGED Viewed

@@ -6,23 +6,28 @@ require_relative "world_time_api/request"
 require_relative "world_time_api/response"
 require_relative "world_time_api/error"
-# The WorldTimeApi module contains methods for making requests to the World Time API.
+# A Ruby wrapper for the World Time API.
 module WorldTimeApi
   # Returns a list of all timezones supported by the World Time API.
   #
-  # @return [WorldTimeApi::Response] The API response.
+  # @return [Hash] A hash representing the response body, or an error hash if there was a problem with the request.
+  # @example
+  #   WorldTimeApi::Timezones.call
   Timezones = -> { Request::Call["/timezone"] }
   # Returns the current time for the specified timezone.
   #
   # @param timezone [String] The timezone ID.
-  # @return [WorldTimeApi::Response] The API response.
-  Time = -> (timezone) { Request::Call["/timezone/#{timezone}"] }
+  # @return [Hash] A hash representing the response body, or an error hash if there was a problem with the request.
+  # @example
+  #   WorldTimeApi::Time.call('Europe/London')
+  Time = ->(timezone) { Request::Call["/timezone/#{timezone}"] }
   # Returns the current time for the client's IP address, or for the specified IP address if provided.
   #
   # @param ip [String] (optional) The IP address to lookup.
-  # @return [WorldTimeApi::Response] The API response.
-  ClientIp = -> (ip = nil) { Request::Call["/ip#{ip ? "/#{ip}" : ''}"] }
+  # @return [Hash] A hash representing the response body, or an error hash if there was a problem with the request.
+  # @example
+  #   WorldTimeApi::ClientIp.call('127.0.0.1')
+  ClientIp = ->(ip = nil) { Request::Call["/ip#{ip ? "/#{ip}" : ""}"] }
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: world_time_api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Alef Ojeda de Oliveira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2025-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Api World Time