Hyrule-Compendium 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fd41a9a00958a4157972be44116bdfd842b18f5b846a14f35dff39dfb94ff83
-  data.tar.gz: 9bdabdbd60ff6b8ffa5998d3f65512f4a0c43e1508339bcccf10393e1272b8fa
+  metadata.gz: 5e726e2598a53077e75749f3845280b41386921ae08d9d58785dedfc1d390e90
+  data.tar.gz: 335d8686b52ed78c8ea2a9595c7ef4729b82eafc636b9a3a53fc6df76936012b
 SHA512:
-  metadata.gz: a16f4bf3472aeef0970317c3ecfc73db80731df34f1e8a8829345dec497eb158aae91108886ecf080148f2a0572a85f52ddb265b5e5dfd64c5b611dc29bc0157
-  data.tar.gz: 6269f5479f726b0cc2f14a64c4deb7bfb1524744b54ecc6de40d1e4dd50eb3f015bacadcc2f4090ee41e8c2ea7da683a6c343a55a3858d3b821b41693baeb400
+  metadata.gz: b81886b6ea83a022362d92752d55ff962dda29abf66cab07d24c083e2d33c76b1e960a340ea2dc02d651a24337f47fece34c6c1ca1f5380e1734d8bee5b5b891
+  data.tar.gz: 599a5d2797a58970e66a67935468014951a40145f9867f23c018df5f172bc0773adb0ef99345d52c08f84bdfce36b076a1176fa76ccbe78fab65536b4bde89da

data/lib/hyrule_compendium.rb

@@ -1,6 +1,35 @@
 require "json"
 require "uri"
 require "net/http"
+require "open-uri"
+
+class NoEntryError < StandardError
+    # Raised when a given entry does not exist in the compendium
+    # 
+    # Parameters:
+    #   * `target_entry`: Non-existant input entry that causes error.
+    #       - type: str, int
+
+    def initialize(target_entry)
+        if target_entry.is_a? String
+            super "Entry with name '#{target_entry}' not in compendium."
+        elsif target_entry.is_a? Integer
+            super "Entry with ID '#{target_entry}' not in compendium."
+        end
+    end
+end
+
+class NoCategoryError < StandardError
+    # Raised when a given category does not exist in the compendium
+    # 
+    # Parameters:
+    #   * `target_category`: Non-existant input category that causes error.
+    #       - type: str
+
+    def initialize(target_category)
+        super "Category '#{target_category}' not in compendium. Categories are 'creatures', 'equipment', 'materials', 'monsters', and 'treaure'."
+    end
+end
 
 def make_req url
     uri = URI url
@@ -8,23 +37,82 @@ def make_req url
         req = Net::HTTP::Get.new uri
         http.request req
     end
-    return JSON.parse res.body
+    return (JSON.parse res.body)["data"]
 end
 
 class Hyrule_Compendium
-    def initialize url="http://botw-compendium.herokuapp.com"
-        @base = url + "/api/v1"
+    # Base class for the Hyrule-Compendium
+    #
+    # Parameters:
+    #   * `url`: The base URL of the API server
+    #       - type: str
+    #       - default: "http://botw-compendium.herokuapp.com/api/v2"
+
+    def initialize url="http://botw-compendium.herokuapp.com/api/v2"
+        @base = url
     end
 
     def get_entry entry
-        return make_req("#{@base}/entry/#{entry.to_s.gsub " ", "%20"}")["data"]
+        # Gets an entry from the compendium.
+        #
+        # Parameters:
+        #   * `entry`: The ID or name of the entry to be retrieved.
+        #       - type: str, int
+        #
+        # Returns: The entry's metadata.
+        #   type: hash
+        #
+        # Raises:
+        #   * `NoEntryError` when the entry is not found.
+
+        res = make_req "#{@base}/entry/#{entry.to_s.gsub " ", "%20"}"
+        if res == {}
+            raise NoEntryError.new entry
+        end
+        return res
     end
 
     def get_category category
-        return make_req("#{@base}/category/#{category}")["data"]
+        # Gets all entries from a category in the compendium.
+        # 
+        # Parameters:
+        #   * `category`: The name of the category to be retrieved. Must be one of the compendium categories.
+        #       - type: string
+        #       - notes: 
+        #           * must be "creatures", "equipment", "materials", "monsters", or "treasure"
+        #           * the category "creatures" has two sub-categories, as keys: "food" and "non_food"
+        #
+        # Raises:
+        #   * `NoCategoryError` when the category is not found.
+
+        if !(["creatures", "equipment", "materials", "monsters", "treasure"].include? category)
+            raise NoCategoryError.new category
+        end
+        return make_req "#{@base}/category/#{category}"
     end
 
     def get_all
+        # Gets all entries from the compendium.
+        # 
+        # Returns: all items in the compendium with their metadata, nested in categories.
+        #   type: hash
+
         return make_req @base
     end
+
+    def download_entry_image entry, output_file
+        # Downloads the image of a compendium entry.
+        # 
+        # Parameters:
+        #   * `entry`: The ID or name of the entry of the image to be downloaded.
+        #       - type: str, int
+        #   * `output_file`: The output file's path.
+        #       - type: str
+
+        open (get_entry entry)["image"] do |image|
+            File.open output_file, "wb" do |file|
+                file.write image.read
+            end
+        end
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Hyrule-Compendium
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Aarav Borthakur
@@ -10,7 +10,7 @@ bindir: bin
 cert_chain: []
 date: 2021-01-02 00:00:00.000000000 Z
 dependencies: []
-description: Ruby wrapper for the Hyrule Compendium API
+description: The official ruby wrapper for the Hyrule Compendium API
 email: gadhaguy13@gmail.com
 executables: []
 extensions: []