ffxiv-lodestone 0.7.0

data/README

@@ -0,0 +1,56 @@
+== About ==
+This is a screen scraper for the FFXIV community side, Lodestone. It gets information about
+characters. The Lodestone pages are a huge pile of shit, so this will save you a few hours of
+hating your life while you write a screen scraper.
+
+The aim is to not break if SquareEnix adds new pieces of data to the page. Any new attributes,
+skills, of general pieces of profile data should automatically be handled by this library.
+
+She ain't pretty, but it's decently robust. 
+
+== Usage ==
+Take, for example, this character: <http://lodestone.finalfantasyxiv.com/rc/character/status?cicuid=1502635>
+
+To fire it up, call Character.new with the cicuid from that URL:
+
+  require 'ffxiv_lodestone'
+  char = FFXIVLodestone::Character.new(1502635)
+
+Stuff you can do:
+
+  char.to_json => String containing a JSON representation of the character / jobs.
+
+  char.name, char.world, char.nameday, char.guardian, char.starting_city, char.physical_level,
+  char.current_exp, char.exp_to_next_level, char.gender, char.race, char.clan
+
+  char.skills => SkillList with these methods:
+    .list => Array of all skills that have been leveled (ie rank 0 jobs omitted)
+    .pugilist (or any class name) => The skill, regardless of if its been leveled or not
+              (ie you can explicitly ask for a skill to see if it's been leveled or not)
+
+  char.resistances => StatList (same deal as stats but with fire instead of strength, 
+                      see method list below)
+  char.stats => StatList with these methods:
+    .each {} => Does some iteration
+    .strength (or any stat name) => Integer value of the state
+
+A skill object has these methods: 
+  name, skill_name, rank, skillpoint_to_next_level, current_skill_points
+
+== FAQ ==
+Q. Hey, why doesn't this have HP / MP / TP? They're on the character profile page!
+A. Because those values change based on the currently equipped job. I don't think they're useful
+   pieces of data. If you have a use case for them, please let me know and I will include them.
+
+== TODO ==
+* Error handling (if you put in a crap char ID you'll get some cryptic Nokogiri errors)
+* Figure out what the fuck the stats in parenthesis mean and do something with them.
+  * Currently, these are dropped on the floor because I don't know what they mean. The current
+    theories include 'Base (with gear)' and 'Stat (with buffs)'.
+* Make SkillList implement enumerable.
+* Character search by name in the constructor. Pending Lodestone's character search not randomly
+  omitting people.
+
+== Author, License, Etc ==
+Copyright owlmanatt <owlmanatt@gmail.com> 2010. The library is free to use, modify, redistribute, 
+sell, or whatever. Go hog wild, just keep this license notice around.

data/lib/ffxiv-lodestone.rb

@@ -0,0 +1,202 @@
+require 'rubygems'
+require 'nokogiri'
+require 'open-uri'
+require 'json'
+
+module FFXIVLodestone
+  VERSION = '0.7.0'
+
+  class Character
+    class StatList
+      include Enumerable 
+      attr_reader :stats
+
+      def initialize(table)
+        @stats = {}
+        
+        table.search('tr').each do |tr|
+          @stats[tr.children[0].content.strip.downcase.to_sym] = tr.children[2].content.gsub("\302\240",' ').split(' ')[0].to_i
+        end
+      end
+
+      def each
+        @stats.each {|stat| yield stat}
+      end
+
+      def to_h
+        @stats
+      end
+
+      def method_missing(method)
+        return @stats[method] if @stats.key? method
+        super
+      end
+    end # StatList
+
+    class SkillList
+      class Skill
+        attr_reader :name, :skill_name, :rank, :current_skill_points, :skillpoint_to_next_level
+
+        def initialize(job,skill_name,rank,cur_sp,skillup_sp)
+          @name = job 
+          @skill_name = skill_name
+          @rank = rank
+          @current_skill_points = cur_sp
+          @skillpoint_to_next_level = skillup_sp
+        end # initalize
+
+        def to_h
+          {:name => @name, :skill_name => @skill_name, :rank => @rank, :current_skill_points => @current_skill_points, :skillpoint_to_next_level => @skillpoint_to_next_level}
+        end
+      end # Skill
+      
+      # Alias the stupid names in Lodestone to class names. 
+      SKILL_TO_CLASS = {
+        'Hand-to-Hand' => :pugilist,
+        'Sword' => :gladiator,
+        'Axe' => :marauder,
+        'Archery' => :archer,
+        'Polearm' => :lancer,
+        'Thaumaturgy' => :thaumaturge,
+        'Conjury' => :conjurer,
+        'Woodworking' => :carpenter,
+        'Smithing' => :blacksmith,
+        'Armorcraft' => :armorer,
+        'Goldsmithing' => :goldsmith,
+        'Leatherworking' => :leatherworker,
+        'Clothcraft' => :weaver,
+        'Alchemy' => :alchemist,
+        'Cooking' => :culinarian,
+        'Mining' => :miner,
+        'Botany' => :botanist,
+        'Fishing' => :fisher,
+      }
+
+      def initialize(skill_table)
+        @skills = {}
+
+        skill_table.children.each do |skill|
+          name = skill.children[0].children[1].content
+          if SKILL_TO_CLASS.key? name
+            key = SKILL_TO_CLASS[name]
+            job = key.to_s.capitalize
+          else
+            key = name.gsub('-', '_').downcase.to_sym
+            job = name
+          end
+
+          # '-' = not leveled (never equipped the class' weapon)
+          rank = skill.children[2].search('table tr td[last()]').children.first.content
+          rank = (rank.include?('-') ? 0 : rank.to_i)
+
+          # # '-' = not leveled, otherwise it will be in the format '391 / 1500'
+          sp = skill.children[4].search('table tr td[last()]').children.first.content
+
+          if sp.include? '-'
+            current_sp = 0
+            levelup_sp = 0
+          else
+            sp.gsub!("\302\240",'') # this is a &nbsp but it looks ugly in #inspect(), so remove it.
+            current_sp = sp.split('/')[0].strip.to_i
+            levelup_sp = sp.split('/')[1].strip.to_i
+          end
+
+          @skills[key] = Skill.new(job,name,rank,current_sp,levelup_sp)
+        end
+      end # initialize
+
+      # Lists all leveled jobs.
+      def list
+        list = []
+        @skills.each do |name,skill| 
+          list << skill if skill.rank > 0
+        end
+
+        return list
+      end
+
+      def to_h
+        list = {}
+        @skills.each {|job,data| list[job] = data.to_h}
+
+        return list
+      end
+      
+      def method_missing(method)
+        return @skills[method] if @skills.key? method
+        super
+      end
+
+    end # FFXIVLodestone::Character::SkillList
+
+    attr_reader :skills, :stats, :resistances, :profile
+    def initialize(character_id)
+      # TODO exception if ID isn't an integer
+      # TODO exception if we don't have a valid char ID
+      @character_id = character_id
+
+      doc = Nokogiri::HTML(open("http://lodestone.finalfantasyxiv.com/rc/character/status?cicuid=#{@character_id}", {'Accept-Language' => 'en-us,en;q=0.5', 'Accept-Charset' => 'utf-8;q=0.5'}))
+
+      # The skills table doesn't have a unqiue ID or class to find it by, so take the first skill lable and go up two elements (table -> tr -> th.mianskill-lable)
+      @skills = SkillList.new(doc.search('th.mainskill-label').first.parent.parent)
+      @stats = StatList.new(doc.search("div.contents-subheader[contains('Attributes')]").first.next_sibling.next_sibling)
+      @resistances = StatList.new(doc.search("div.contents-subheader[contains('Elements')]").first.next_sibling.next_sibling)
+      
+      # The character info box at the top ... actually has a useful ID!
+      @profile = {}
+      profile = doc.search('#profile-plate2')
+      profile.search('tr th').each do |th|
+        key = th.content.strip.downcase.gsub(':','').gsub(' ','_').to_sym
+        value = th.next_sibling.next_sibling.content.strip.gsub("\302\240",'')
+
+        # HP/MP/TP are max values. They depend on the currently equipped job and are not very
+        # meaningful pieces of data. XP will be handled seperately. 
+        unless [:hp, :mp, :tp, :experience_points].include? key
+          @profile[key] = value 
+        end
+
+        if key == :experience_points
+          @profile[:current_exp] = value.split('/')[0].to_i
+          @profile[:exp_to_next_level] = value.split('/')[1].to_i
+        end
+      end
+      
+      # Fix this datatype.
+      @profile[:physical_level] = @profile[:physical_level].to_i
+      
+      # Parse the character name/world line...
+      name_line = profile.search('#charname').first.content.gsub(')','').strip.split(' (')
+      @profile[:world] = name_line[1]
+      @profile[:first_name] = name_line[0].split(' ')[0]
+      @profile[:last_name] = name_line[0].split(' ')[1]
+
+      # Parse the "Seeker of the Sun Female / Miqo'te" line... fun~
+      race_line = profile.search('tr td').first.content.strip.gsub("\302\240",' ').split(' / ')
+      @profile[:race] = race_line.pop
+
+      # horrible array splitting and popping trix. hidoi hidoi!
+      race_line = race_line.first.split ' '
+      @profile[:gender] = race_line.pop
+      @profile[:clan] = race_line.join ' '
+    end
+    
+    def name
+      "#{@profile[:first_name]} #{@profile[:last_name]}"
+    end
+
+    def to_json
+      data = {}
+      data.merge!(@profile)
+      data[:jobs] = @skills.to_h
+      data[:attributes] = @stats.to_h
+      data[:resistances] = @resistances.to_h
+
+      data.to_json
+    end
+
+    def method_missing(method)
+      return @profile[method] if @profile.key? method
+      super
+    end
+  end # character
+end # end FFXIVLodestone

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: ffxiv-lodestone
+version: !ruby/object:Gem::Version 
+  hash: 3
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  - 0
+  version: 0.7.0
+platform: ruby
+authors: 
+- owlmanatt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-23 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: A nice Ruby library for accessing character data on the FFXIV community site. It's a screen scraper, but you can PRETEND you're using something nice.
+email: 
+- owlmanatt@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ffxiv-lodestone.rb
+- README
+has_rdoc: true
+homepage: http://github.com/OwlManAtt/FFXIV-Lodestone-API
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Screenscraper for FFXIV character data.
+test_files: []
+