ygoprodeck

ygoprodeck API wrapper for search yugioh card


Keywords
ruby, yugioh
License
MIT
Install
gem install ygoprodeck -v 1.0.3

Documentation

Ygoprodeck

Lang Gem Gem Build Status

API wrapper for search yugioh card

Installation

Add this line to your application's Gemfile:

gem 'ygoprodeck'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ygoprodeck

Usage

first you need :

require 'ygoprodeck'

Fuzzy search : (RECOMMENDED)

Ygoprodeck::Fname.is('dark magician')

Normal search :

Ygoprodeck::Name.is('time wizard')

Random search :

Ygoprodeck::Card.random

List search :

Ygoprodeck::List.is('magician')

Archetype search :

Ygoprodeck::Archetype.is('blue-eyes')

All card sets :

Ygoprodeck::Card.sets

Banlist (TCG, OCG, GOAT) :

Ygoprodeck::Banlist.tcg
Ygoprodeck::Banlist.ocg
Ygoprodeck::Banlist.goat

or look examples

Noted

Rate Limiting on the API is enabled. The rate limit is 20 requests per 1 second

Response Information

Monster Cards
  • id - ID or Passocde of the card.
  • name - Name of the card.
  • type - The type of card you are viewing (Normal Monster, Effect Monster, Synchro Monster, etc).
  • desc - Card description/effect.
  • atk - The ATK value of the card.
  • def - The DEF value of the card.
  • level - The Level/RANK of the card.
  • race - The card race which is officially called type (Spellcaster, Warrior, Insect, etc).
  • attribute - The attribute of the card.
Spell/Trap Cards
  • id - ID or Passocde of the card.
  • name - Name of the card.
  • type - The type of card you are viewing (Spell Card or Trap Card).
  • desc - Card description/effect.
  • race - The card race which is officially called type for Spell/Trap Cards (Field, Equip, Counter, etc).
Additional Response for Pendulum Monsters
  • scale - The Pendulum Scale Value.
Additional Response for Link Monsters
  • linkval - The Link Value of the card if it's of type "Link Monster".
  • linkmarkers - The Link Markers of the card if it's of type "Link Monster". This information is returned as an array.

Development

Test

rake spec 

Contributing

Fork and Pull Request to contibuting https://github.com/rokhimin/ygoprodeck .

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Ygoprodeck project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.