dog_api_bindings 0.0.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b9e202c21bb0f274f885171628a78f0a105e999baa49b9f752d3d0cebd8184a
-  data.tar.gz: b03c0513f70151e44a6bf81605cb456d36b93cc0f619588d080edf0a58fec484
+  metadata.gz: 9fef5139fe652f9f67f0ab361f72722d91fc52c120fb416b49b66c2875e5beff
+  data.tar.gz: 0cd4b4f70f9d9c0d4999c05b1268a48447e2341ed27f5cfe63e7d565eb2886bf
 SHA512:
-  metadata.gz: b679b696d7899dc913ec4b046865f8bdd2678cf2b98156920271df68d48cf904c1337e7306e6e4a8325268fe8e8daef18f711662600077a5635c4fc2467018b1
-  data.tar.gz: 150053398bac9f1a2db992cc7eaf60627718816e03ea72323f523bab2f22bd95c62ceb4f7a28ac6d4d11809c7b2e7f78f2b58fa016ee0b4c13c2035b69aa6b27
+  metadata.gz: b9489400c7effa57ac2de01e49c246c571e55b066f31ba0702f86f0d9900c5f493236f979e673ddec58ad68e497c2e5599adeff36f774e25b399d470c1c5cb50
+  data.tar.gz: 7738d7aef2415891340399382583ef54319d1844948d658704abe078a5fb31541c37c1b37d2a5bb500523a74daf47a92f93737afa888b587d0ca0631603a3e63

data/lib/dog-api.rb

@@ -2,33 +2,41 @@
 
 require 'http'
 
+# BASE API URI
 API_ENDPOINT = 'https://dog.ceo/api'
 
-def return_breeds_list
+# Returns a hash of all available breeds.
+def breeds_list
   response = HTTP.get("#{API_ENDPOINT}/breeds/list/all")
   hashed_response = response.parse['message'] if response.code == 200
   hashed_response or "Could not connect to the API, Status Code: #{response.code}"
 end
 
-def return_sub_breeds_list(breed)
+# Returns a hash of all available sub-breeds of the given breed.
+def sub_breeds_list(breed)
   response = HTTP.get("#{API_ENDPOINT}/breed/#{breed}/list")
   hashed_response = response.parse['message'] if response.code == 200
   hashed_response || "Could not connect to the API, Status Code: #{response.code}. Perhaps this breed does not have any sub-breeds?"
 end
 
-def return_breed_images(breed)
+# Returns an array of all available images of the given breed.
+def all_breed_images(breed)
   response = HTTP.get("#{API_ENDPOINT}/breed/#{breed}/images")
   hashed_response = response.parse['message'] if response.code == 200
   hashed_response || "Could not connect to the API, Status Code: #{response.code}"
 end
 
-def return_sub_breed_images(breed, sub_breed)
+# Returns an array of all available images of the given breed and sub-breed.
+def all_sub_breed_images(breed, sub_breed)
   response = HTTP.get("#{API_ENDPOINT}/breed/#{breed}/#{sub_breed}/images")
   hashed_response = response.parse['message'] if response.code == 200
   hashed_response || "Could not connect to the API, Status Code: #{response.code} Perhaps this breed does not have any sub-breeds?"
 end
 
-def return_random_images(amount)
+# Returns an array of random breed images equivalent to the passed amount.
+#
+# Due to API limitations, it can only return an amount between 1 and 50.
+def random_images(amount)
   if amount >= 1 && amount <= 50
     response = HTTP.get("#{API_ENDPOINT}/breeds/image/random/#{amount}")
     hashed_response = response.parse['message'] if response.code == 200
@@ -38,7 +46,10 @@ def return_random_images(amount)
   end
 end
 
-def return_random_breed_images(breed, amount)
+# Returns an array of breed images equivalent to the passed amount.
+#
+# Due to API limitations, it can only return an amount between 1 and 50.
+def random_breed_images(breed, amount)
   if amount >= 1 && amount <= 50
     response = HTTP.get("#{API_ENDPOINT}/breed/#{breed}/images/random/#{amount}")
     hashed_response = response.parse['message'] if response.code == 200
@@ -48,7 +59,11 @@ def return_random_breed_images(breed, amount)
   end
 end
 
-def return_random_sub_breed_images(breed, sub_breed, amount)
+# Returns an array of sub-breed images equivalent to the passed amount.
+#
+# Due to API limitations, it can only return an amount between 1 and 50.
+def random_sub_breed_images(breed, sub_breed, amount)
+
   if amount >= 1 && amount <= 50
     response = HTTP.get("#{API_ENDPOINT}/breed/#{breed}/#{sub_breed}/images/random/#{amount}")
     hashed_response = response.parse['message'] if response.code == 200

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dog_api_bindings
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Quinton Oglesby
@@ -9,8 +9,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2022-01-25 00:00:00.000000000 Z
-dependencies: []
-description: My first ruby gem.
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+description: |2
+      This is an api wrapper for dog.ceo written in Ruby.
+
+      ```Test```
 email: qoglesby97@gmail.com
 executables: []
 extensions: []
@@ -29,7 +46,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -39,5 +56,5 @@ requirements: []
 rubygems_version: 3.3.5
 signing_key:
 specification_version: 4
-summary: Ruby bindings for the dog.ceo API.
+summary: Ruby API wrapper for the dog.ceo API.
 test_files: []