ffxiv 0.9.1 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fb7ce29800d85a1d741dced5bb8ba1049b63115
-  data.tar.gz: 40595334045f34238ec0e636e896fb24f521252f
+  metadata.gz: 20be78bbbb48a7d2a7dffb7eb33531c739d7dbbe
+  data.tar.gz: 9c3296043f94c90b6094eaf5ad680e02346f1d8b
 SHA512:
-  metadata.gz: cdfe1416572fa6daf7a401c00d48a3d87720777b531585230f7d82a0c5e539f4984e8be5f365c8f599ab384a59261245a51132256a04022a7b051391242f8f23
-  data.tar.gz: a5951abe15687d137cee233c7fd2fda8a224d73cc5d016caf7b5688e0baaeb91f1d1d9f3baaa4bdadde382b8f39d51f055321567cdac4ae861ed10454a8f1e22
+  metadata.gz: 5782cde3206205e06590e452dbb6a5baae3103758f8da63ea0cd318a46b58eee203e2dd3edf2b111a45a26c29a4c4e5465f0d14dfa5ebf412a2aa2a6ca5873d7
+  data.tar.gz: d7e2044a0c0626daa1f5a0a7f97dc7c785a0f074085b7a5612997ba7f093fc3ba426de6fb66fd4b2e902e01dcdec852bee1fb441c997502025e8bead6b3b8722

data/lib/ffxiv/lodestone.rb

@@ -8,17 +8,37 @@ require "open-uri"
 require "lodestone/model"
 require "lodestone/character"
 require "lodestone/free-company"
+require "lodestone/linkshell"
 
 module FFXIV
   module Lodestone
+
+    @@debug = false
+
     class << self
+
+      def debug
+        @@debug
+      end
+
+      def debug=(flag)
+        @@debug = flag
+      end
+
+      def d(str)
+        puts "\033[35m[Debug]\033[0m #{str}" if @@debug
+      end
+
       def fetch(endpoint)
         uri = "http://na.finalfantasyxiv.com/lodestone/" + endpoint
+        d("Fetching #{uri} ......")
         html, charset = open(uri) do |page|
           [page.read, page.charset]
         end
+        d("    done (size=#{html.size}, charset=#{charset})")
         Nokogiri::HTML.parse(html, nil, charset)
       end
+
     end
   end
 end

data/lib/ffxiv/lodestone/character.rb

@@ -3,16 +3,50 @@ module FFXIV
     class Character < Model
 
       attr_accessor :id, :name, :server, :thumbnail_uri, :image_uri, :race, :subrace, :gender,
-                    :nameday, :guardian, :city_state, :grand_company, :grand_company_rank,
-                    :free_company, :minions, :mounts, :end_contents, :self_introduction, :classes,
-                    :num_blogs, :first_blogged, :latest_blogged, :bpd, :free_company_rank
+                    :nameday, :guardian, :city_state, :grand_company, :grand_company_rank, :free_company,
+                    :minions, :mounts, :end_contents, :eternal_bonding, :self_introduction, :classes,
+                    :num_blogs, :first_blogged, :latest_blogged, :bpd, :free_company_rank, :linkshell_rank
       alias :end_contents? :end_contents
+      alias :eternal_bonding? :eternal_bonding
 
       class << self
 
+        def search(keyword, server: nil, page: 1, verbose: false)
+          dom = Lodestone.fetch("character/?q=#{URI.escape(keyword)}&worldname=#{server ? URI.escape(server) : ""}&page=#{URI.escape(page.to_s)}")
+          # Couldn't find a way to get this node with CSS...
+          characters = dom.xpath("//comment()[.=' result ']/following::table[1]/tr").map do |tr|
+            h4 = tr.at("td h4")
+            a = h4.at("a")
+            id = a.attr("href").split("/")[-1].to_i
+            if verbose
+              self.find_by_id(id)
+            else
+              self.new({
+                id: id,
+                name: a.content,
+                server: h4.at("span").content.strip[1...-1],
+                thumbnail_uri: drop_uts(tr.at("th img").attr("src"))
+              })
+            end
+          end
+          pagination = dom.at("div.current_list")
+          span_total = pagination.at("span.total")
+          raise "Character not found" unless span_total
+          total = span_total.content.to_i
+          results = {
+            show_start: pagination.at("span.show_start").content.to_i,
+            show_end: pagination.at("span.show_end").content.to_i,
+            total: total,
+            num_pages: (total / 50.0).ceil,
+            characters: characters
+          }
+        end
+
         def name_to_id(name, server)
-          dom = Lodestone.fetch("character/?q=#{URI.escape(name)}&worldname=#{URI.escape(server)}")
-          dom.at("h4.player_name_gold a").attr("href").split("/")[-1].to_i
+          self.search(name, server: server)[:characters].each do |ch|
+            return ch.id if name == ch.name
+          end
+          nil
         end
 
         def find_by_id(id)
@@ -21,36 +55,57 @@ module FFXIV
 
             props = {}
             props[:id] = id
-            props[:name] = dom.css("div.player_name_txt h2 a").inner_text
-            props[:server] = dom.css("div.player_name_txt h2 span").inner_text[2...-1]
-            props[:thumbnail_uri] = drop_uts(dom.css("div.player_name_thumb img").attr("src").inner_text)
-            props[:image_uri] = drop_uts(dom.css("img[width='264']").attr("src").inner_text)
-            props[:race], props[:subrace], props[:gender] = dom.css("div.chara_profile_title").inner_text.strip.split(" / ")
-            dom.css("ul.chara_profile_list li").to_a.each do |n|
-              t = n.inner_text
-              if t.include?("Nameday")
-                props[:nameday], props[:guardian] = n.css(".txt_yellow").to_a.map(&:inner_text)
-              elsif t.include?("City-state")
-                props[:city_state] = n.css(".txt_yellow").inner_text
-              elsif t.include?("Grand Company")
-                props[:grand_company], props[:grand_company_rank] = n.css(".txt_yellow").inner_text.split("/")
-              elsif t.include?("Free Company")
-                props[:free_company] = n.css(".txt_yellow").inner_text
-              end
+            ch_name = dom.at("div.player_name_txt h2 a")
+            props[:name] = ch_name.content
+            props[:server] = ch_name.next_element.content.strip[1...-1]
+            props[:thumbnail_uri] = drop_uts(dom.at("div.player_name_thumb img").attr("src"))
+            props[:image_uri] = drop_uts(dom.at("div.bg_chara_264 img").attr("src"))
+            props[:race], props[:subrace], gender = dom.at("div.chara_profile_title").content.strip.split(" / ")
+            props[:gender] = case gender
+              when "♀" then :female
+              when "♂" then :male
+              else raise "Unrecognized gender symbol: #{gender}"
             end
-            dom.css("div.area_header_w358_inner").to_a.each do |n|
-              aname = n.css("h4.ic_silver").inner_text.downcase
-              items = n.css("a.ic_reflection_box").to_a.map{|m| m.attr("title")}.map{|i| i.capitalize.gsub(/[\s][a-z]/) {|s| s.upcase}}.sort
-              props[:"#{aname}"] = items
+
+            dom.search("dl.chara_profile_box_info").each do |n|
+              n.search("dd.txt").each do |dd|
+                t = dd.next_element.content
+                case dd.content
+                  when "Nameday"
+                    props[:nameday] = t
+                  when "Guardian"
+                    props[:guardian] = t
+                  when "City-state"
+                    props[:city_state] = t
+                  when "Grand Company"
+                    props[:grand_company], props[:grand_company_rank] = t.split("/")
+                  when "Free Company"
+                    props[:free_company] = FreeCompany.new(name: t, server: props[:server])
+                end
+              end
             end
+
+            # The first "minion_box" contains mounts, and they need capitalization unlike minions.
+            minion_boxes = dom.search("div.minion_box")
+            props[:mounts] = minion_boxes[0].search("a").map{|a| a.attr("title").split.map(&:capitalize).join(' ')}
+            props[:minions] = minion_boxes[1].search("a").map{|a| a.attr("title")}
+
+            # Let's assume that whoever has this mount has slained Ultima Weapon and watched the ending movie, hence is qualified for the endgame contents.
             props[:end_contents] = props[:mounts].include?("Magitek Armor")
-            props[:self_introduction] = dom.css("div.txt_selfintroduction").inner_html.strip
+
+            # Likewise, assume that whoever has this mount has purchased Gold or Platinum eternal bonding.
+            # Note that Standard version doesn't come with the mount, so use nil instead of false to indicate "unknown".
+            props[:eternal_bonding] = props[:mounts].include?("Ceremony Chocobo") ? true : nil
+
+            self_introduction = dom.at("div.txt_selfintroduction").inner_html.strip
+            props[:self_introduction] = self_introduction == "" ? nil : self_introduction
+
             props[:classes] = {}
             %w{fighter sorcerer crafter gatherer}.each do |discipline|
-              dom.css("h4.class_#{discipline} + div.table_black_w626 td.ic_class_wh24_box").to_a.each do |td|
-                txt = td.inner_text
-                if !txt.empty?
-                  lvl = td.next_sibling().next_sibling().inner_text.to_i
+              dom.search("h4.class_#{discipline} + div.table_black_w626 td.ic_class_wh24_box").each do |td|
+                txt = td.content
+                unless txt.empty?
+                  lvl = td.next_sibling().next_sibling().content.to_i
                   props[:classes][txt] = lvl == 0 ? nil : lvl
                 end
               end
@@ -65,6 +120,13 @@ module FFXIV
 
       end
 
+      def free_company(fetch = false)
+        if fetch
+          @free_company = FreeCompany.find_by_name(@free_company, @server)
+        end
+        @free_company
+      end
+
       def num_blogs
         init_blog; @num_blogs
       end
@@ -81,6 +143,77 @@ module FFXIV
         init_blog; @first_blogged
       end
 
+      def blogs(load_details = false)
+        unless @blogs
+          @blogs = []
+          if num_blogs > 0
+            num_blog_pages = (num_blogs / 10.0).ceil
+            1.upto(num_blog_pages) do |page|
+              dom = Lodestone.fetch("character/#{@id}/blog?order=2&page=#{page}")
+              dom.search("section.base_body").each do |section_blog|
+                a_title = section_blog.at("a.blog_title")
+                blog = {
+                  id: a_title.attr("href").split("/")[-1],
+                  title: a_title.content,
+                  date: Time.at(section_blog.at("script").content[/ldst_strftime\((\d{10}),/, 1].to_i),
+                  num_comments: section_blog.at("span.ic_comment").content.to_i
+                }
+                if load_details
+                  dom_blog = Lodestone.fetch("character/#{@id}/blog/#{blog[:id]}")
+                  blog[:body] = dom_blog.at(".txt_selfintroduction").inner_html.strip
+
+                  blog[:comments] = []
+                  if blog[:num_comments] > 0
+                    dom_blog.search("div.comment").each do |dom_comment|
+                      unless dom_comment.at("div.comment_delete_box")
+                        div_by = dom_comment.at("div.player_id")
+                        by = nil
+                        if div_by
+                          a_by = div_by.at("a")
+                          by = self.class.new({
+                            id: a_by.attr("href").split("/")[-1],
+                            name: a_by.content,
+                            server: div_by.at("span").content.strip[1...-1]
+                          })
+                        end
+                        blog[:comments] << {
+                          by: by,
+                          date: Time.at(dom_comment.at("script").content[/ldst_strftime\((\d{10}),/, 1].to_i),
+                          body: dom_comment.at("div.balloon_body_inner").inner_html.strip
+                        }
+                      end
+                    end
+                  end
+
+                  blog[:tags] = []
+                  a_tags = dom_blog.search("div.diary_tag a")
+                  if a_tags
+                    a_tags.each do |a_tag|
+                      blog[:tags] << a_tag.content[1...-1]
+                    end
+                  end
+
+                  blog[:images] = []
+                  img_thumbs = dom_blog.search("ul.thumb_list li img")
+                  if img_thumbs
+                    img_thumbs.each do |img_thumb|
+                      unless img_thumb.attr("class") == "img_delete"
+                        blog[:images] << {
+                          thumbnail: img_thumb.attr("src"),
+                          original: img_thumb.attr("data-origin_src")
+                        }
+                      end
+                    end
+                  end
+                end
+                @blogs << blog
+              end
+            end
+          end
+        end
+        @blogs
+      end
+
       def thumbnail_uri
         @thumbnail_uri + "?#{Time.now.to_i}"
       end
@@ -94,11 +227,11 @@ module FFXIV
         if @num_blogs.nil?
           dom1 = Lodestone.fetch("character/#{@id}/blog?order=1")
           total_node = dom1.at("div.current_list span.total")
-          @num_blogs = total_node.nil? ? 0 : total_node.inner_text.to_i
+          @num_blogs = total_node.nil? ? 0 : total_node.content.to_i
           if @num_blogs > 0
             dom2 = Lodestone.fetch("character/#{@id}/blog?order=2")
             {latest_blogged: dom1, first_blogged: dom2}.each do |prop, dom|
-              txt = dom.at("h3.header_title").inner_text
+              txt = dom.at("h3.header_title").content
               uts = txt.match(/ldst_strftime\((\d{10}), 'YMDHM'\)/)[1].to_i
               send("#{prop}=", Time.at(uts).utc)
             end

data/lib/ffxiv/lodestone/free-company.rb

@@ -9,11 +9,46 @@ module FFXIV
 
       class << self
 
+        def search(keyword, server: nil, page: 1, verbose: false)
+          dom = Lodestone.fetch("freecompany/?q=#{URI.escape(keyword)}&worldname=#{URI.escape(server)}&page=#{URI.escape(page.to_s)}")
+          free_companies = dom.search("table.table_elements_com_fc tr").map do |tr|
+            h4 = tr.at("td h4")
+            a = h4.at("a")
+            id = a.attr("href").split("/")[-1].to_i
+            if verbose
+              self.find_by_id(id)
+            else
+              self.new({
+                id: id,
+                name: a.content,
+                server: h4.at("span").content.strip[1...-1],
+                grand_company: tr.at("div.groundcompany_name").content
+              })
+            end
+          end
+          pagination = dom.at("div.current_list")
+          total = pagination.at("span.total").content.to_i
+          results = {
+            show_start: pagination.at("span.show_start").content.to_i,
+            show_end: pagination.at("span.show_end").content.to_i,
+            total: total,
+            num_pages: (total / 50.0).ceil,
+            free_companies: free_companies
+          }
+        end
+
         def name_to_id(name, server)
           dom = Lodestone.fetch("freecompany/?q=#{URI.escape(name)}&worldname=#{URI.escape(server)}")
           dom.at("div.ic_freecompany_box a").attr("href").split("/")[-1].to_i
         end
 
+        def name_to_id(name, server)
+          self.search(name, server: server)[:free_companies].each do |fc|
+            return fc.id if name == fc.name
+          end
+          nil
+        end
+
         def find_by_id(id)
           begin
             dom = Lodestone.fetch("freecompany/#{id}")
@@ -21,7 +56,7 @@ module FFXIV
             props = {}
             props[:id] = id
 
-            props[:logo_uri] = dom.css("div.ic_crest_64 img").to_a.map{|n| n.attr("src")}
+            props[:logo_uri] = dom.search("div.ic_crest_64 img").map{|n| n.attr("src")}
 
             gcs_node = dom.at("span.friendship_color")
             props[:grand_company_standing] = gcs_node.inner_text[1...-1]
@@ -37,7 +72,7 @@ module FFXIV
 
             props[:tag] = dom.at("td.vm").last_element_child.next_sibling.inner_text[1...-1]
 
-            dom.css("table.table_style2 tr").to_a.each do |tr|
+            dom.search("table.table_style2 tr").each do |tr|
               td_node = tr.at("td")
               td_text = td_node.inner_text.strip
               case tr.at("th").inner_text
@@ -52,25 +87,25 @@ module FFXIV
                   props[:weekly_rank] = weekly.include?("--") ? nil : weekly.match(/\d+/)[0].to_i
                   props[:monthly_rank] = monthly.include?("--") ? nil : monthly.match(/\d+/)[0].to_i
                 when "Company Slogan"
-                  props[:slogan] = td_text
+                  props[:slogan] = td_text == "" ? nil : td_text
                 when "Active"
-                  props[:active] = td_text
+                  props[:active] = td_text == "Not specified" ? nil : td_text
                 when "Recruitment"
                   props[:recruiting] = td_text == "Open"
                 when "Focus"
-                  props[:focus] = td_node.css("img").to_a.map{|n| n.attr("title")}
+                  props[:focus] = td_node.search("li:not(.icon_off) img").map{|n| n.attr("title")}
                 when "Seeking"
-                  props[:seeking] = td_node.css("img").to_a.map{|n| n.attr("title")}
+                  props[:seeking] = td_node.search("li:not(.icon_off) img").map{|n| n.attr("title")}
                 when "Estate Profile"
                   name_node = td_node.at("div.txt_yellow")
                   if name_node
-                    address_size, greeting = td_node.css("p").to_a.map(&:inner_text)
+                    address_size, greeting = td_node.search("p").map(&:inner_text)
                     address, size = address_size.split(" (")
                     props[:housing] = {
                       name: name_node.inner_text,
                       address: address,
                       size: size[0...-1],
-                      greeting: greeting
+                      greeting: greeting == "No greeting available." ? nil : greeting
                     }
                   else
                     props[:housing] = nil
@@ -91,15 +126,15 @@ module FFXIV
           num_pages = (@num_members / 50.0).ceil # 50 members / page
           1.upto(num_pages) do |page_no|
             dom = Lodestone.fetch("freecompany/#{@id}/member/?page=#{page_no}")
-            dom.css("div.player_name_area").to_a.each do |node|
+            dom.search("div.player_name_area").each do |node|
               cid = node.at("div.name_box a").attr("href").split("/")[-1]
-              fcrank = node.at("div.fc_member_status").inner_text
+              fcrank = node.at("div.fc_member_status").content.strip
               members[cid] = fcrank
             end
           end
           characters = []
           members.each do |cid, fcrank|
-            character = Character.find(cid)
+            character = Character.find_by_id(cid)
             character.free_company_rank = fcrank.strip
             characters << character
           end

data/lib/ffxiv/lodestone/linkshell.rb

@@ -0,0 +1,92 @@
+module FFXIV
+  module Lodestone
+    class Linkshell < Model
+
+      attr_accessor :id, :name, :server, :members, :num_members
+
+      class << self
+
+        def search(keyword, server: nil, page: 1, verbose: false)
+          dom = Lodestone.fetch("linkshell/?q=#{URI.escape(keyword)}&worldname=#{URI.escape(server)}&page=#{URI.escape(page.to_s)}")
+          linkshells = dom.search("table.table_elements_com_ls tr").map do |tr|
+            h4 = tr.at("th h4")
+            a = h4.at("a")
+            id = a.attr("href").split("/")[-1].to_i
+            if verbose
+              self.find_by_id(id)
+            else
+              self.new({
+                id: id,
+                name: a.content,
+                server: h4.at("span").content.strip[1...-1],
+                num_members: tr.at("td span").content.split(": ")[1].to_i
+              })
+            end
+          end
+          pagination = dom.at("div.current_list")
+          total = pagination.at("span.total").content.to_i
+          results = {
+            show_start: pagination.at("span.show_start").content.to_i,
+            show_end: pagination.at("span.show_end").content.to_i,
+            total: total,
+            num_pages: (total / 50.0).ceil,
+            linkshells: linkshells
+          }
+        end
+
+        def name_to_id(name, server)
+          self.search(name, server: server)[:linkshells].each do |ls|
+            return ls.id if name == ls.name
+          end
+          nil
+        end
+
+        def find_by_id(id)
+          begin
+            dom = Lodestone.fetch("linkshell/#{id}")
+            props = {}
+            props[:id] = id
+            buff = dom.at("div.contents_header h2").content.match(/^(.+)\s\((.+)\)$/)
+            props[:name] = buff[1]
+            props[:server] = buff[2]
+            props[:num_members] = dom.at("h3.ic_silver").content.match(/\s\((\d+)\s/)[1].to_i
+            self.new(props)
+          rescue => e
+            pp e
+            nil
+          end
+        end
+      end
+
+      def members
+        if @members.nil?
+          members = {}
+          num_pages = (@num_members / 50.0).ceil # 50 members / page
+          1.upto(num_pages) do |page_no|
+            dom = Lodestone.fetch("linkshell/#{@id}?page=#{page_no}")
+            dom.search("div.player_name_area").each do |node|
+              cid = node.at("div.name_box a").attr("href").split("/")[-1]
+              if node.at("span.ic_master")
+                lsrank = :master
+              elsif node.at("span.ic_leader")
+                lsrank = :leader
+              else
+                lsrank = :member
+              end
+              members[cid] = lsrank
+            end
+          end
+          characters = []
+          members.each do |cid, lsrank|
+            character = Character.find_by_id(cid)
+            character.linkshell_rank = lsrank
+            characters << character
+          end
+          @members = characters
+        end
+        @members
+      end
+
+    end
+  end
+end

metadata

@@ -1,18 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: ffxiv
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.5
 platform: ruby
 authors:
-- Isjaki Kveikur
+- Syro Bonkus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
-dependencies: []
-description: An unofficial FFXIV ARR toolkit for Ruby, featuring Lodestone scraper.
+date: 2015-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: An unofficial Final Fantasy XIV / A Realm Reborn toolkit for Ruby, featuring
+  Lodestone scraper.
 email:
-- isjaki.xiv@gmail.com
+- sb.ffxiv@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -21,6 +42,7 @@ files:
 - lib/ffxiv/lodestone.rb
 - lib/ffxiv/lodestone/character.rb
 - lib/ffxiv/lodestone/free-company.rb
+- lib/ffxiv/lodestone/linkshell.rb
 - lib/ffxiv/lodestone/model.rb
 homepage: https://github.com/ffxiv/ffxiv
 licenses:
@@ -42,8 +64,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: An unofficial FFXIV ARR toolkit for Ruby, featuring Lodestone scraper.
 test_files: []
+has_rdoc: