pokeedex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 382f9b5be3017a1dffe7593e87a9796bd5f40290fb327a3af372ad8f4827e36b
+  data.tar.gz: 124be03f7980740fbf261ae89c14f65a2cb2e02799946938f558e73d1a1da78b
+SHA512:
+  metadata.gz: dc990233c6110229b1092e699150eb2cbb4df3a51e4199e95e2ea73d4f051deda1b08f1d0f9e038b9e500ee5d03bf30b935ab43ff80296b54c46143c9ed54492
+  data.tar.gz: 11fe94444e00595daffbba2612de92b2c49b7f17dc292ffc35362658c33df9622406eaca6667b61bad2e0f15b209f8f296d80d2f76286d916b5e5ae2ac4115ba

data/.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    needs: build
+    name: Run tests with RSpec
+    strategy:
+      matrix:
+        ruby:
+          - '3.3.3'
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run RSpec
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+/lib/pokeedex/db/*.sqlite3

data/.standard.yml

@@ -0,0 +1,9 @@
+fix: false # default: false
+parallel: true # default: false
+format: progress # default: Standard::Formatter
+ruby_version: 3.0.0 # default: RUBY_VERSION
+default_ignores: false # default: true
+
+ignore: # default: []
+  - "node_modules/**/*"
+  - "spec/spec_helper.rb"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pokeedex.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'standard', '~> 1.3'
+
+group :test do
+  gem 'rspec', '~> 3.4'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,125 @@
+PATH
+  remote: .
+  specs:
+    pokeedex (0.1.0)
+      base64
+      forwardable
+      nokogiri
+      playwright-ruby-client
+      sequel
+      sqlite3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    forwardable (1.3.3)
+    hashdiff (1.1.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    mime-types (3.5.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2024.0903)
+    mini_portile2 (2.8.7)
+    nokogiri (1.16.7)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
+    playwright-ruby-client (1.47.0)
+      concurrent-ruby (>= 1.1.6)
+      mime-types (>= 3.0)
+    psych (5.1.2)
+      stringio
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    rexml (3.3.7)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.65.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    sdoc (1.1.0)
+      rdoc (>= 5.0)
+    sequel (5.84.0)
+      bigdecimal
+    sqlite3 (2.0.4)
+      mini_portile2 (~> 2.8.0)
+    sqlite3 (2.0.4-arm64-darwin)
+    standard (1.40.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.65.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    stringio (3.1.1)
+    unicode-display_width (2.6.0)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-22
+  ruby
+
+DEPENDENCIES
+  pokeedex!
+  rake (~> 13.0)
+  rspec (~> 3.4)
+  sdoc (~> 1.0)
+  standard (~> 1.3)
+  webmock
+
+BUNDLED WITH
+   2.5.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Guillermo Moreno
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,154 @@
+# Pokeedex
+
+Pokeedex is a Ruby gem that provides an interface to interact with the [Pokémon Pokédex](https://www.pokemon.com/el/pokedex). It allows you to retrieve detailed information about Pokémon, including their stats, abilities, types, and evolutions. This gem is ideal for developers who want to integrate Pokémon data into their Ruby applications easily and efficiently.
+
+## Features
+
+- Search for Pokémon by name or number.
+- Retrieve detailed stats for each Pokémon.
+- Information about Pokémon abilities and types.
+
+### Next comming features
+
+- Data on Pokémon evolutions.
+- Support multilanguage.
+- Find pokemon's by types
+
+## Requirements
+
+- Python 3.9^
+- NodeJS v18^
+- Yarn 1.22^
+
+Pokedex requires [Playwright](https://playwright.dev/) to perform Web Scraping to obtain information about a Pokemon from [https://www.pokemon.com/el/pokedex](https://www.pokemon.com/el/pokedex). For Ruby, use the [playwright-ruby-client](https://playwright-ruby-client.vercel.app/) gem client to be able to interact with Playwright and use the browser that is part of the library installed. For the use of the browser, use an executable to be able to use the browser in Headless mode.
+
+For default Pokeedex use Chronium browser (You don't need install any browser).
+
+## Installation
+
+To install the gem and add it to your application's Gemfile, execute:
+
+    $ bundle add pokeedex
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install pokeedex
+
+or
+
+Clone the repository on your local and access to code and use it
+
+    $ git clone git@github.com:memoxmrdl/pokeedex.git
+    $ cd pokeedex
+
+## Usage
+
+### CLI
+
+For use pokeedex you only need execute from your terminal the following command, if you are used `gem install`:
+
+```
+$ pokeedex --help
+Usage: pokeedex [number|name]
+    -h, --help                       Prints this help
+
+```
+
+NOTE: If you are cloned the repository from on your local then use:
+
+```
+$ bin/pokeedex --help
+Usage: pokeedex [number|name]
+    -h, --help                       Prints this help
+
+```
+
+NOTE: If you do not have Python, NodeJS and Yarn installed you may be prompted that they need to be installed, please check the requirements and try again.
+
+### API
+
+```
+# pokeedex_api.rb
+
+require 'pokeedex'
+
+Pokeedex.boot
+
+begin
+  query = 'pikachu'
+
+  pokemons = Pokeedex::Pokemon::Base.search(query)
+  pokemon = pokemons.first
+
+  puts pokemon.number
+  puts pokemon.name
+rescue Pokeedex::Exceptions::ScrapperError => e
+  puts e.message
+end
+```
+
+### Example outputs
+
+#### Find by number
+
+```
+$ bin/pokeedex 1
+Número: 1
+Nombre: Bulbasaur
+Descripción: Tras nacer, crece alimentándose durante un tiempo de los nutrientes que contiene el bulbo de su lomo.
+Altura: 0.7 m
+Peso: 6.9 kg
+Categoría: Semilla
+Habilidades: Espesura
+Genero: Macho, Hembra
+Tipo: Planta, Veneno
+Habilidades: Fuego, Hielo, Volador, Psíquico
+
+Puntos de base
+###------------ PS
+###------------ Ataque
+###------------ Defensa
+####----------- Ataque Especial
+####----------- Defensa Especial
+###------------ Velocidad
+```
+
+#### Find by name
+
+```
+$ bin/pokeedex pikachu
+Número: 25
+Nombre: Pikachu
+Descripción: Cuando se enfada, este Pokémon descarga la energía que almacena en el interior de las bolsas de las mejillas.
+Altura: 0.4 m
+Peso: 6.0 kg
+Categoría: Ratón
+Habilidades: Elec. Estática
+Genero: Macho, Hembra
+Tipo: Eléctrico
+Habilidades: Tierra
+
+Puntos de base
+###------------ PS
+####----------- Ataque
+###------------ Defensa
+###------------ Ataque Especial
+###------------ Defensa Especial
+######--------- Velocidad
+```
+
+## I hate you IMPERVA!
+
+Me la pelaste!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pokeedex. 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]/pokeedex/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pokeedex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pokeedex/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+# require 'sequel'
+# require 'yaml'
+require 'rake'
+require 'sdoc'
+require 'rdoc/task'
+
+require 'standard/rake'
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/'
+  rdoc.options << '--format=sdoc'
+  rdoc.options << '--exclude=spec'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+  rdoc.template = 'rails'
+end
+
+task default: %i[standard]

data/bin/pokeedex

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+def check_python_installed
+  `python --version`
+  $?.success? || `python3 --version`
+end
+
+def check_node_installed
+  node_version = `node --version`
+  return [false, nil] unless $?.success?
+
+  version = node_version.match(/^v(\d+)\.(\d+)\.(\d+)/)
+  return [true, version] if version
+
+  [false, nil]
+end
+
+def check_node_version(version)
+  major = version[1].to_i
+  minor = version[2].to_i
+  major > 18 || (major == 18 && minor >= 0)
+end
+
+def check_dependencies
+  unless check_python_installed
+    puts 'Hi! Sorry =( Pokeedex needs Python and Node.js to work. Please install them before running the program.'
+    return
+  end
+
+  node_installed, node_version = check_node_installed
+  unless node_installed
+    puts 'Hi! Sorry =( Pokeedex needs Python and Node.js to work. Please install them before running the program.'
+    return
+  end
+
+  unless check_node_version(node_version)
+    puts "It's Require Node.js 18 version or lastest. Your current version is #{node_version}."
+    return
+  end
+
+  `playwright install`
+end
+
+check_dependencies
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '/../lib'))
+
+require 'pokeedex'
+
+options = { query: ARGV[0] }
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: pokeedex [number|name]'
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+end.parse!
+
+if ARGV.empty?
+  warn 'You need to introduce a number or name of a Pokemon'
+  warn "USAGE: #{$PROGRAM_NAME} [number|name]"
+  exit 1
+end
+
+Pokeedex.boot
+
+begin
+  pokemons = Pokeedex::Pokemon::Base.search(options[:query])
+rescue Pokeedex::Exceptions::ScrapperError => e
+  warn e.message
+  exit 1
+end
+
+if pokemons.empty?
+  warn "\nNo information found about the pokemon or criteria"
+  exit 1
+end
+
+pokemons.each do |pokemon|
+  puts Pokeedex::Pokemon::Decorators::Base.new(pokemon)
+end

data/lib/pokeedex/configuration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'sequel'
+
+module Pokeedex # :nodoc:
+  ##
+  # Class that holds the configuration of the gem and the database connection information
+  # and methods to connect to the database and run the migrations if needed
+  class Configuration
+    ##
+    # The path to the Playwright CLI executable
+    attr_accessor :playwright_cli_executable_path
+
+    ##
+    # The name of the database file to use for the gem (default: pokeedex_local.sqlite3)
+    attr_reader :db_name
+
+    ##
+    # The path to the database file to use for the gem (default: /path/to/pokeedex/db/pokeedex_local.sqlite3)
+    attr_writer :db_path
+
+    def initialize
+      @playwright_cli_executable_path = File.join(Pokeedex.root_path, 'node_modules', '.bin', 'playwright')
+
+      @db_name = 'pokeedex_local.sqlite3'
+    end
+
+    ##
+    # Set the name of the database file to use for the gem and reset the path to the database file to nil
+    def db_name=(name)
+      @db_name = name
+      @db_path = nil
+    end
+
+    ##
+    # Return the path to the database file to use for the gem (default: /path/to/pokeedex/db/pokeedex_local.sqlite3)
+    def db_path
+      @db_path ||= File.join(Pokeedex.root_path, 'lib', 'pokeedex', 'db', db_name)
+    end
+
+    ##
+    # Return the database connection to the database file to use for the gem (default: /path/to/pokeedex/db/pokeedex_local.sqlite3)
+    def db_connection
+      Sequel.sqlite(db_path)
+    end
+  end
+end