Hyrule-Compendium 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e726e2598a53077e75749f3845280b41386921ae08d9d58785dedfc1d390e90
-  data.tar.gz: 335d8686b52ed78c8ea2a9595c7ef4729b82eafc636b9a3a53fc6df76936012b
+  metadata.gz: 4c8ae2028d9a31146617fa11e95e440fcaf3c09deb62532cecc4285a1dabec7b
+  data.tar.gz: a3bfce310743fe6bd4879f1e4fdadf369c87459410b6767491bbc765c19b18ed
 SHA512:
-  metadata.gz: b81886b6ea83a022362d92752d55ff962dda29abf66cab07d24c083e2d33c76b1e960a340ea2dc02d651a24337f47fece34c6c1ca1f5380e1734d8bee5b5b891
-  data.tar.gz: 599a5d2797a58970e66a67935468014951a40145f9867f23c018df5f172bc0773adb0ef99345d52c08f84bdfce36b076a1176fa76ccbe78fab65536b4bde89da
+  metadata.gz: 49a53bd1239809009a0f74a09351b957b96498bf2c81d2ab62c4367e3d7a9a1e7bcb545450fc429c70a440d68c3e893d27666cdbe73064e40eb55fcb3ca5c9e0
+  data.tar.gz: 136f7deafe9023707740b4e371a29bf3efe4a7d5e9807dece28db3828a65486d1df7dbeaf02856205d62289f70f3f6ee633a18bf5d34d8310c254e386ff15bf7

data/lib/hyrule_compendium.rb

@@ -31,9 +31,9 @@ class NoCategoryError < StandardError
     end
 end
 
-def make_req url
+def make_req url, timeout
     uri = URI url
-    res = Net::HTTP.start uri.host, uri.port do |http|
+    res = Net::HTTP.start uri.host, uri.port, read_timeout: timeout do |http|
         req = Net::HTTP::Get.new uri
         http.request req
     end
@@ -47,32 +47,40 @@ class Hyrule_Compendium
     #   * `url`: The base URL of the API server
     #       - type: str
     #       - default: "http://botw-compendium.herokuapp.com/api/v2"
+    #   * `default_timeout`: Default seconds to wait for response for all API calling functions until raising `Net::ReadTimeout`.
+    #       - type: float, int
+    #       - default: `nil` (no timeout)
+    #       - notes: If a API calling function has a parameter `timeout`, it will overide this.
 
-    def initialize url="http://botw-compendium.herokuapp.com/api/v2"
+    def initialize url: "http://botw-compendium.herokuapp.com/api/v2", default_timeout: nil
         @base = url
+        @default_timeout = default_timeout
     end
 
-    def get_entry entry
+    def get_entry entry, timeout=@default_timeout
         # Gets an entry from the compendium.
         #
         # Parameters:
         #   * `entry`: The ID or name of the entry to be retrieved.
         #       - type: str, int
+        #   * `timeout`: Seconds to wait for response until raising `Net::ReadTimeout`.
+        #       - type: float, int
+        #       - default: `@default_timeout`
         #
         # Returns: The entry's metadata.
-        #   type: hash
+        #   - type: hash
         #
         # Raises:
         #   * `NoEntryError` when the entry is not found.
 
-        res = make_req "#{@base}/entry/#{entry.to_s.gsub " ", "%20"}"
+        res = make_req("#{@base}/entry/#{entry.to_s.gsub " ", "%20"}", timeout=timeout)
         if res == {}
             raise NoEntryError.new entry
         end
         return res
     end
 
-    def get_category category
+    def get_category category, timeout=@default_timeout
         # Gets all entries from a category in the compendium.
         # 
         # Parameters:
@@ -81,6 +89,12 @@ class Hyrule_Compendium
         #       - notes: 
         #           * must be "creatures", "equipment", "materials", "monsters", or "treasure"
         #           * the category "creatures" has two sub-categories, as keys: "food" and "non_food"
+        #   * `timeout`: Seconds to wait for response until raising `Net::ReadTimeout`.
+        #       - type: float, int
+        #       - default: `@default_timeout`
+        #
+        # Returns: All entries in the category.
+        #   - type: array, hash (for creatures)
         #
         # Raises:
         #   * `NoCategoryError` when the category is not found.
@@ -88,19 +102,24 @@ class Hyrule_Compendium
         if !(["creatures", "equipment", "materials", "monsters", "treasure"].include? category)
             raise NoCategoryError.new category
         end
-        return make_req "#{@base}/category/#{category}"
+        return make_req "#{@base}/category/#{category}", timeout=timeout
     end
 
-    def get_all
+    def get_all timeout=@default_timeout
         # Gets all entries from the compendium.
-        # 
+        #
+        # Parameters:
+        #   * `timeout`: Seconds to wait for response until raising `Net::ReadTimeout`.
+        #       - type: float, int
+        #       - default: `@default_timeout`
+        #
         # Returns: all items in the compendium with their metadata, nested in categories.
-        #   type: hash
+        #   - type: hash
 
-        return make_req @base
+        return make_req @base, timeout
     end
 
-    def download_entry_image entry, output_file
+    def download_entry_image entry, output_file, timeout=@default_timeout
         # Downloads the image of a compendium entry.
         # 
         # Parameters:
@@ -108,8 +127,11 @@ class Hyrule_Compendium
         #       - type: str, int
         #   * `output_file`: The output file's path.
         #       - type: str
+        #   * `timeout`: Seconds to wait for server response until raising `Net::ReadTimeout`.
+        #       - type: float, int
+        #       - default: `@default_timeout`
 
-        open (get_entry entry)["image"] do |image|
+        open (get_entry entry, timeout)["image"] do |image|
             File.open output_file, "wb" do |file|
                 file.write image.read
             end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: Hyrule-Compendium
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Aarav Borthakur
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2021-01-02 00:00:00.000000000 Z
@@ -21,7 +21,7 @@ homepage: https://github.com/Hyrule-Compendium-API/Hyrule-Compendium-ruby-client
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -36,8 +36,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Hyrule Compendium API
 test_files: []