aetheryte 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef32af3ab83c5a9bb1ae6e071566476537d666e84fe17852e804ba6a50ea557f
+  data.tar.gz: 5f4df0680c063c8d12be495d8289c37c0edd6d244d2825d57b1bfa204bcd7f52
+SHA512:
+  metadata.gz: df37e9cec975cd0290b63ac69616606b69e35ca86983f51a6050f73a713542424a4414eb29ebebe23b5930f12e0cf6a81fc94709678cae033fa21a535599c1e4
+  data.tar.gz: 7f6f0bcb781f971cc0c257f1cc0dd6a0ff04a4dd6bdbad653b783fef0f1726db757196bc2c5592f9954a7d7ea0b33f48135972194c740e6b5eaef893a1f56ae7

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'nokogiri'
+
+group :development, :test do
+  gem 'pry-byebug'
+  gem 'rubocop', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    aetheryte (0.0.0)
+      nokogiri (~> 1.16)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    json (2.6.2)
+    method_source (1.0.0)
+    nokogiri (1.16.0-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  aetheryte!
+  nokogiri
+  pry-byebug
+  rubocop
+
+BUNDLED WITH
+   2.3.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 tengille
+
+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/aetheryte.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __dir__)
+require_relative 'lib/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'aetheryte'
+  s.version  = Aetheryte::VERSION
+  s.summary  = 'Aetheryte'
+  s.authors  = ['tengille']
+  s.email    = 'melitengille@gmail.com'
+  s.license  = 'MIT'
+  s.homepage = 'https://github.com/tengille/aetheryte'
+  s.metadata = { 'rubygems_mfa_required' => 'true' }
+
+  s.files    = Dir['./**/**']
+
+  s.add_dependency 'nokogiri', '~> 1.16'
+  s.add_development_dependency 'pry-byebug', '~> 3.10'
+
+  s.required_ruby_version = '>= 3.1.1'
+
+  s.require_paths = ['lib']
+end

data/lib/aetheryte/character.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Aetheryte
+  # Object for storing character information
+  class Character
+    attr_reader :id,
+                :race,
+                :clan,
+                :gender,
+                :city_state,
+                :grand_company,
+                :grand_company_rank,
+                :profile
+
+    def initialize(**args)
+      args.each do |name, value|
+        instance_variable_set("@#{name}", value)
+      end
+    end
+  end
+end

data/lib/aetheryte/character_parser.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Aetheryte
+  # Parses Lodestone character profile
+  class ChracterParser
+    def initialize(doc:, id:)
+      @id = id
+      @doc = doc
+      @basic_info = doc.css('.character-block__name').children.map(&:text)
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    def parse!
+      Aetheryte::Character.new(
+        id: id.to_s,
+        race: basic_info[0],
+        clan: clan_and_gender[:clan],
+        gender: clan_and_gender[:gender],
+        city_state: basic_info[4],
+        grand_company: grand_company_and_rank[:grand_company],
+        grand_company_rank: grand_company_and_rank[:grand_company_rank],
+        profile: doc.css('.character__selfintroduction').text,
+        jobs: Aetheryte::JobParser.new.parse(input: doc.css('.character__level li'))
+      )
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    private
+
+    attr_reader :id,
+                :doc,
+                :basic_info,
+                :race,
+                :clan,
+                :gender,
+                :guardian,
+                :city_state,
+                :grand_company,
+                :gc_rank
+
+    def clan_and_gender
+      @clan_and_gender ||= basic_info[2].split('/')
+
+      { clan: @clan_and_gender[0], gender: @clan_and_gender[1] }
+    end
+
+    def grand_company_and_rank
+      @grand_company_and_rank ||= basic_info[5].split('/')
+
+      { grand_company: @grand_company_and_rank[0], grand_company_rank: @grand_company_and_rank[1] }
+    end
+  end
+end

data/lib/aetheryte/job_parser.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Aetheryte
+  # Parses Job input
+  class JobParser
+    JOBS = {
+      'Gladiator' => 'Gladiator',
+      'Marauder' => 'Marauder',
+      'Dark Knight' => 'Knight',
+      'Gunbreaker' => 'Gunbreaker',
+      'Conjurer' => 'Conjurer',
+      'Scholar' => 'Scholar',
+      'Astrologian' => 'Astrologian',
+      'Sage' => 'Sage',
+      'Pugilist' => 'Pugilist',
+      'Lancer' => 'Lancer',
+      'Rogue' => 'Rogue',
+      'Samurai' => 'Samurai',
+      'Reaper' => 'Reaper',
+      'Archer' => 'Archer',
+      'Machinist' => 'Machinist',
+      'Dancer' => 'Dancer',
+      'Thaumaturge' => 'Thaumaturge',
+      'Summoner / Arcanist' => 'Summoner / Arcanist',
+      'Red Mage' => 'Red Mage',
+      'Blue Mage (Limited Job)' => 'Blue Mage',
+      'Carpenter' => 'Carpenter',
+      'Blacksmith' => 'Blacksmith',
+      'Armorer' => 'Armorer',
+      'Goldsmith' => 'Goldsmith',
+      'Leatherworker' => 'Leatherworker',
+      'Weaver' => 'Weaver',
+      'Alchemist' => 'Alchemist',
+      'Culinarian' => 'Culinarian',
+      'Miner' => 'Miner',
+      'Botanist' => 'Botanist',
+      'Fisher' => 'Fisher'
+    }.freeze
+
+    attr_reader :output
+
+    def parse(input:)
+      input.map do |li_node|
+        job_name = JOBS[li_node.children.first.attributes['data-tooltip'].value]
+        job_level = li_node.children.last.text
+
+        { job: job_name, level: job_level }
+      end
+    end
+  end
+end

data/lib/aetheryte.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# gems
+# require 'pry' # uncomment for debugging
+require 'nokogiri'
+require 'open-uri'
+
+# files
+require 'aetheryte/character'
+require 'aetheryte/character_parser'
+require 'aetheryte/job_parser'
+
+# Hear. Feel. Think.
+module Aetheryte
+  NO_ID_ERR_MSG = 'No :id provided'
+  NOT_FOUND_MSG = 'Invalid :id, Not found'
+  BASE_URL = 'https://na.finalfantasyxiv.com/lodestone/character'
+
+  class Error < StandardError; end
+
+  # :id must be a Integer or String of a Lodestone character URL
+  # example: https://na.finalfantasyxiv.com/lodestone/character/48513463/
+  def self.character(id: nil)
+    raise Error, NO_ID_ERR_MSG unless id
+
+    url = "#{BASE_URL}/#{id}"
+    res = URI.parse(url).open
+    doc = Nokogiri::HTML(res)
+
+    Aetheryte::ChracterParser.new(doc:, id:).parse!
+  rescue OpenURI::HTTPError
+    raise Error, NOT_FOUND_MSG
+  end
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Aetheryte
+  VERSION = '0.0.0'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: aetheryte
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- tengille
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description:
+email: melitengille@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./Gemfile"
+- "./Gemfile.lock"
+- "./LICENSE"
+- "./aetheryte.gemspec"
+- "./lib/aetheryte.rb"
+- "./lib/aetheryte/character.rb"
+- "./lib/aetheryte/character_parser.rb"
+- "./lib/aetheryte/job_parser.rb"
+- "./lib/version.rb"
+homepage: https://github.com/tengille/aetheryte
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Aetheryte
+test_files: []