world_time_api 0.1.4 → 0.1.5

data/lib/world_time_api/request.rb

@@ -4,22 +4,29 @@ require_relative "response"
 require_relative "error"
 require 'httparty'
 
+# The WorldTimeApi module contains methods for making requests to the World Time API.
 module WorldTimeApi
+
+  # The Request module contains methods 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.
+    #
+    # @param url [String] The URL to make the request to.
+    # @return [Hash] A hash representing the response body, or an error hash if there was a problem with the request.
     Call = ->(url) {
       begin
         response = get(url)
 
-          return WorldTimeApi::Error["Invalid timezone"] if response.code != 200
+        return WorldTimeApi::Error["Invalid timezone"] if response.code != 200
 
-          WorldTimeApi::Response[response]
-        rescue StandardError
-          WorldTimeApi::Error["Connection error"]
-        end
+        WorldTimeApi::Response[response]
+      rescue StandardError
+        WorldTimeApi::Error["Connection error"]
+      end
     }
   end
 end

data/lib/world_time_api/response.rb

@@ -2,6 +2,12 @@
 
 require 'json'
 
+# The WorldTimeApi module contains methods for making requests to 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) }
 end

data/lib/world_time_api/version.rb

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

data/lib/world_time_api.rb

@@ -1,16 +1,28 @@
 # frozen_string_literal: true
 
+require "httparty"
 require_relative "world_time_api/version"
 require_relative "world_time_api/request"
+require_relative "world_time_api/response"
+require_relative "world_time_api/error"
 
-require "httparty"
-
-# module WorldTimeAPi
+# The WorldTimeApi module contains methods for making requests to the World Time API.
 module WorldTimeApi
 
+  # Returns a list of all timezones supported by the World Time API.
+  #
+  # @return [WorldTimeApi::Response] The API response.
   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}"] }
 
+  # 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}" : ''}"] }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: world_time_api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Alef Ojeda de Oliveira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -63,6 +63,22 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
+- doc/WorldTimeApi.html
+- doc/WorldTimeApi/Request.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/world_time_api.rb
 - lib/world_time_api/error.rb
 - lib/world_time_api/request.rb
@@ -75,6 +91,7 @@ metadata:
   homepage_uri: https://github.com/nemuba/world_time_api
   source_code_uri: https://github.com/nemuba/world_time_api
   changelog_uri: https://github.com/nemuba/world_time_api/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/github/nemuba/world_time_api/blob/main/doc/index.html
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -90,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.4.7
 signing_key: 
 specification_version: 4
 summary: Api World Time