pony_breeds 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe1fbb3134c21c7dbb01dfd837470e1cf3bf262cc687f198eb931317ecc9a182
-  data.tar.gz: 4f937de719c8fbb986acad2df2b3f4177f4b983454309b6042b9589c7c57b957
+  metadata.gz: 7c991b91a54fba64f1481f87d154d9c8ecc45963f9b5ccab7c38494e2d5671b8
+  data.tar.gz: 752340eec51381762a3dc39b6d5045a4eb2c9c1e0d8f61d2dbb704f8074370c1
 SHA512:
-  metadata.gz: 1d49570b7c879ce31d3739fd6116910feab8f310af510c18b7a3321676996bfd27e7fb692de5014de3387c6c9dd9d6f41c17e1687dcfb6f948915aa2a1fee22e
-  data.tar.gz: e3fb4e637cfd1979634599b8fdf232eab9ed11c419628b260d16d00fd4e1d00770a8bab46a9ae376ea4b455a8d53cb95d7387e8abe8c2b75a9f6f2e1a57c3a33
+  metadata.gz: 6b1a928e00eca054f3460e08ad07adaf3ffeca95ffb15e7dfc10950d5b5c6d3b075d4d15fe09486a1ab523a60d804a406c3dfd0e43d74d8c9d87ed6a1a6df5d3
+  data.tar.gz: 5398f7b55625cf380ef5532bef1153ffc965c53983a505a44d9bec1201b312e5a9e0c44d7fbc86d60a2151daae2ae2d7b2e8c0907de0929c21ea032d75057dd4

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.6
+  SuggestExtensions: false
+  NewCops: disable
 
 # ------------------------------------------------------- Layout -------------------------------------------------------
 
@@ -26,3 +28,8 @@ Style/ClassAndModuleChildren:
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
+
+# ------------------------------------------------------- Metrics ------------------------------------------------------
+
+Metrics/BlockLength:
+  Enabled: false

data/README.md

@@ -1,6 +1,7 @@
-# PonyBreeds
+# PonyBreeds :horse:
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pony_breeds`. To experiment with that code, run `bin/console` for an interactive prompt.
+The `pony_breeds` gem provides informations for 76 pony breeds. You can easily integrate the gem
+into your project and use the data coming from it.
 
 ## Installation
 
@@ -20,6 +21,9 @@ Get the pony data by the symbolized JSON key
 Get the pony data by the actual name of the pony
     `Pony::Breeds::ReadPonyData.new.get_pony_by_name('Actual Pony Name')`
 
+Get a random pony data
+    `Pony::Breeds::ReadPonyData.new.retrieve_random_pony`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -28,12 +32,19 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/napster235/pony_breeds. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pony_breeds/blob/master/CODE_OF_CONDUCT.md).
+Contributions are welcomed to this project!
+If you have an idea for a new feature or find a bug, please open an issue in this repository.
 
-## License
+To contribute code to the project, follow these steps:
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+    1. Fork this repo 
+    2. Create a new branch for your changes
+    3. Make the necessary changes and commit them to your branch
+    4. Push your branch to your forked repository
+    5. Open a pull request from your branch to this repository
 
-## Code of Conduct
+I review your changes and merge them into the project if they are approved.
 
-Everyone interacting in the PonyBreeds project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pony_breeds/blob/master/CODE_OF_CONDUCT.md).
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/breeds.rb

@@ -4,6 +4,10 @@ require_relative 'pony/breeds/version'
 
 module Pony
   module Breeds
+    AWS_BUCKET_URL = 'https://s3.eu-central-1.amazonaws.com/ponybreeds/pony_breeds.json'
+
+    private_constant :AWS_BUCKET_URL
+
     class Error < StandardError; end
   end
 end

data/lib/pony/breeds/read_pony_data.rb

@@ -2,6 +2,8 @@
 
 require 'json'
 require 'active_support/core_ext/hash/keys'
+require 'faraday'
+require 'breeds'
 
 module Pony
   module Breeds
@@ -12,7 +14,7 @@ module Pony
       # @param key [Symbol] the symbolized key used to retrieve data for a specific pony
       #
       # @return [Hash] the hash containing the data for the pony
-      def get_pony_by_key(key)
+      def self.get_pony_by_key(key)
         read_ponies[key.to_sym]
       end
 
@@ -21,21 +23,32 @@ module Pony
       # @param name [String] the actual name of the pony
       #
       # @return [Hash] the hash containing the data for the pony
-      def get_pony_by_name(name)
+      def self.get_pony_by_name(name)
+        return unless name.is_a?(String)
+
         key = name&.split&.join('_')&.downcase
-        get_pony_by_key(key.to_sym)
+        get_pony_by_key(key)
       end
 
-      private
+      # Get data related to a pony by a random JSON key
+      #
+      # @return [Hash] the hash containing the data for the pony
+      def self.retrieve_random_pony
+        arr = []
+
+        read_ponies.each_key { |pony_name| arr << pony_name }
+        get_pony_by_key(arr.sample)
+      end
 
       # Read and parse the JSON file
       #
       # @return [Hash] the data from the json file
-      def read_ponies
-        file_location = File.dirname(__FILE__)
-        load_pony_breeds = File.join(file_location, 'pony_breeds.json')
-        JSON.parse(File.read(load_pony_breeds)).deep_symbolize_keys
+      def self.read_ponies
+        json_response = Faraday.get(AWS_BUCKET_URL)
+        JSON.parse(json_response.body).deep_symbolize_keys
       end
+
+      private_class_method :read_ponies
     end
   end
 end

data/lib/pony/breeds/version.rb

@@ -2,6 +2,6 @@
 
 module Pony
   module Breeds
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pony_breeds
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - napster235
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A small little gem that offers the capability of reading pony breeds.
 email:
 - dragomir.tuddor@gmail.com
@@ -34,12 +62,10 @@ files:
 - ".idea/.gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/breeds.rb
-- lib/pony/breeds/pony_breeds.json
 - lib/pony/breeds/read_pony_data.rb
 - lib/pony/breeds/version.rb
 homepage: https://github.com/napster235/pony_breeds

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at Tudor.Dragomir@cerner.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/lib/pony/breeds/pony_breeds.json

@@ -1,17 +0,0 @@
-{
-  "american_shetland_pony": {
-    "name": "American Shetland Pony",
-    "description": "The American Shetland Pony is an American breed of pony. It derives from the traditional Shetland Pony from the Shetland Isles of Scotland, but as a result of cross-breeding with other horse and pony breeds, is taller and more elegant",
-    "wiki_url": "https://en.wikipedia.org/wiki/American_Shetland_Pony"
-  },
-  "american_walking_pony": {
-    "name": "American Walking Pony",
-    "description": "The American Walking Pony is a modern American breed of gaited riding pony. It was created by crossbreeding of the Tennessee Walking Horse and the Welsh Pony.",
-    "wiki_url": "https://en.wikipedia.org/wiki/American_Walking_Pony"
-  },
-  "andalou_pony": {
-    "name": "Andalou Pony",
-    "description":"The Anadolu Pony is descended from crosses of Turkoman, Arabian, Persian, Karabakh, Akhal-Teke, Karbada, Deliboz, Mongolian and the ancient Anatolia horse. Some books refer to this small pony as the Native Turkish Pony, or Turk, but Professors Salahattin Batu and M. Nurettin Aral made a distinction in types between the horses in Anatolia as Anadolu and East and Southeast Anadolu.",
-    "wiki_url": "https://en.wikipedia.org/wiki/Anadolu_Pony"
-  }
-}