dogceo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5129483d24811569c0c387097a270c835dcbbdd58d1c17c484dd94efb5fe24af
+  data.tar.gz: 1b1a5400d66a0d2662f37766926eb19d05724304416bd158fe51f7ddf703b807
+SHA512:
+  metadata.gz: 44add0c7973cb613a1e8393c2d0572ff3b47a59a44cc460b9230db4a4d16751684619514424a7387ca1b9b0f30f689a68d001752cb1aea94ab94a2ba12775da6
+  data.tar.gz: 44416af8be0804afc87e2e60bc9b945ec2547088151fd7b7895b981e1f199e3fe7ae83643a5fd8ea0dff943c774e9e9c5d9a6af0d9c02aa045cae6c92d168c69

data/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2022 XXIV
+   
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+   
+       http://www.apache.org/licenses/LICENSE-2.0
+   
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,44 @@
+# Dog API
+
+[![](https://img.shields.io/github/v/tag/thexxiv/dogapi-ruby?label=version)](https://github.com/thexxiv/dogapi-ruby/releases/latest) [![](https://img.shields.io/github/license/thexxiv/dogapi-ruby)](https://github.com/thexxiv/dogapi-ruby/blob/main/LICENSE)
+
+Dog API client for **Ruby**.
+
+### Download
+[RubyGems](https://rubygems.org/gems/dogceo)
+
+```
+gem install dogceo
+```
+
+### Example
+
+```ruby
+require 'dogceo'
+
+puts DogAPI::multiple_random_images(10)
+```
+
+### Documentation
+
+* [RDoc](https://thexxiv.github.io/dogapi-ruby)
+
+### License
+
+Dog API client is released under the [Apache License 2.0](https://github.com/thexxiv/dogapi-ruby/blob/main/LICENSE).
+
+```
+ Copyright 2022 XXIV
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+```

data/lib/dogceo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dogceo
+  VERSION = "1.0.0"
+end

data/lib/dogceo.rb

@@ -0,0 +1,227 @@
+require_relative "dogceo/version"
+require 'net/http'
+require 'json'
+
+class DogAPIException < StandardError
+  def initialize(message)
+    super(message)
+  end
+end
+
+module DogAPI
+  class << self
+    ##
+    # DISPLAY SINGLE RANDOM IMAGE FROM ALL DOGS COLLECTION
+    #
+    # return a random dog image
+    #
+    # Raises DogAPIException
+    def random_image
+      begin
+        response = get_request('breeds/image/random')
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    ##
+    # DISPLAY MULTIPLE RANDOM IMAGES FROM ALL DOGS COLLECTION
+    #
+    # * `images_number` number of images
+    #
+    # *NOTE* ~ Max number returned is 50
+    #
+    # Return multiple random dog image
+    # Raises DogAPIException
+    def multiple_random_images(images_number)
+      begin
+        response = get_request("breeds/image/random/#{images_number}")
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    ##
+    # RANDOM IMAGE FROM A BREED COLLECTION
+    #
+    # * `breed` breed name
+    #
+    # Returns a random dog image from a breed, e.g. hound
+    # Raises DogAPIException
+    def random_image_by_breed(breed)
+      begin
+        response = get_request("breed/#{breed.strip}/images/random")
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    ##
+    # MULTIPLE IMAGES FROM A BREED COLLECTION
+    #
+    # * `breed` breed name
+    # * `images_number` number of images
+    #
+    # Return multiple random dog image from a breed, e.g. hound
+    # Raises DogAPIException
+    def multiple_random_images_by_breed(breed, images_number)
+      begin
+        response = get_request("breed/#{breed.strip}/images/random/#{images_number}")
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    ##
+    # ALL IMAGES FROM A BREED COLLECTION
+    #
+    # * `breed` breed name
+    #
+    # Returns array of all the images from a breed, e.g. hound
+    # Raises DogAPIException
+    def images_by_breed(breed)
+      begin
+        response = get_request("breed/#{breed.strip}/images")
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    ##
+    # SINGLE RANDOM IMAGE FROM A SUB BREED COLLECTION
+    #
+    # * `breed` breed name
+    # * `sub_breed` sub_breed name
+    #
+    # Returns a random dog image from a sub-breed, e.g. Afghan Ho
+    # Raises DogAPIException
+    def random_image_by_sub_breed(breed, sub_breed)
+      begin
+        response = get_request("breed/#{breed.strip}/#{sub_breed.strip}/images/random")
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    ##
+    # MULTIPLE IMAGES FROM A SUB-BREED COLLECTION
+    #
+    # * `breed` breed name
+    # * `sub_breed` sub_breed name
+    # * `images_number` number of images
+    #
+    # Return multiple random dog images from a sub-breed, e.g. Afghan Hound
+    # Raises DogAPIException
+    def multiple_random_images_by_sub_breed(breed, sub_breed, images_number)
+      begin
+        response = get_request("breed/#{breed.strip}/#{sub_breed.strip}/images/random/#{images_number}")
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    ##
+    # LIST ALL SUB-BREED IMAGES
+    #
+    # * `breed` breed name
+    # * `sub_breed` sub_breed name
+    #
+    # Returns array of all the images from the sub-breed
+    # Raises DogAPIException
+    def images_by_sub_breed(breed, sub_breed)
+      begin
+        response = get_request("breed/#{breed.strip}/#{sub_breed.strip}/images")
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    ##
+    # LIST ALL BREEDS
+    #
+    # Returns hash of all the breeds as keys and sub-breeds as values if it has
+    # Raises DogAPIException
+    def breeds_list
+      begin
+        response = get_request('breeds/list/all')
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    ##
+    # LIST ALL SUB-BREEDS
+    #
+    # * `breed` breed name
+    #
+    # Returns array of all the sub-breeds from a breed if it has sub-breeds
+    # Raises DogAPIException
+    def sub_breeds_list(breed)
+      begin
+        response = get_request("breed/#{breed.strip}/list")
+        json = JSON.parse(response)
+        if json['status'] != 'success'
+          raise DogAPIException.new(json['message'])
+        end
+        if json['message'].length == 0
+          raise DogAPIException.new('the breed does not have sub-breeds')
+        end
+        return json['message']
+      rescue => ex
+        raise DogAPIException.new(ex.message)
+      end
+    end
+
+    private def get_request(endpoint)
+      uri = URI("https://dog.ceo/api/#{endpoint}")
+      res = Net::HTTP.get_response(uri)
+      res.body
+    end
+
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: dogceo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- XXIV
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-22 00:00:00.000000000 Z
+dependencies: []
+description: Dog API client
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/dogceo.rb
+- lib/dogceo/version.rb
+homepage: https://github.com/thexxiv/dogapi-ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/thexxiv/dogapi-ruby
+  source_code_uri: https://github.com/thexxiv/dogapi-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Dog API client
+test_files: []