ffxiv-lodestone 0.9.2 → 0.9.3

data/HISTORY

@@ -1,3 +1,19 @@
+== 0.9.3 ==
+* Character.search() will now return up to 40 results; previously, it was only 20.
+
+* Character#skills now has an alias - #jobs. Sementically, char.jobs.carpenter makes more sense
+  than char.skills.carpenter - the skill name is carpentry.
+
+  They return exactly the same data, but #skills should be considered deprecated. I may replace it
+  with something else in the future.
+
+* When specifying :world in Character.search() and Character.new(), you can pass the server's ID
+  number instead of the server's name. You should only use the ID if new servers are opened and
+  the gem has not been updated with the name => ID mapping yet.
+
+* strip_nbsp and strip_nbsp! are added to String to handle Nokogiri's oddness more cleanly. I hope
+  this doesn't fuck up your application.
+
 == 0.9.2 ==
 * Added Character.search() method. It wraps the character search page; an array of hashes will
   be returned with the resulting characters. 

data/README

@@ -45,16 +45,20 @@ of these options of you will get an exception.
      wish to use the search method and allow your user to pick the correct character, then load it
      by ID, as demonstrated by this psuedo-code:
 
-    chars = FFXIVLodestone::Character.search(:name => 'Lady G', :world => 'Figaro')
+      chars = FFXIVLodestone::Character.search(:name => 'Lady G', :world => 'Figaro')
 
-    if chars.length ==  1
-      char_id = chars.first[:id]
-    else
-      # display both on a screen for the user to pick, then load the right character by ID
-      char_id = . . .
-    end
+      if chars.length ==  1
+        char_id = chars.first[:id]
+      else
+        # display both on a screen for the user to pick, then load the right character by ID
+        char_id = . . .
+      end
 
-    character = FFXIVLodestone::Character.new(char_id)
+      character = FFXIVLodestone::Character.new(char_id)
+
+    Caveat: This will only display the first page of search results (so maximum 40). If the
+    character name you are searching for is _that_ ambiguous, then just fucking delete it and
+    reroll with a sane name.
 
 == Ghetto API Doc ==
 The static search method will return a list of hashes. You can use this to avoid ambiguious name
@@ -73,7 +77,7 @@ Stuff you can do with a loaded character:
   char.current_exp, char.exp_to_next_level, char.gender, char.race, char.clan, char.character_id,
   char.portrait_url, char.portrait_thumb_url
 
-  char.skills => SkillList with these methods:
+  char.jobs => SkillList with these methods:
     .levelled => 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)
@@ -91,6 +95,17 @@ Q. Hey, why doesn't this have HP / MP / TP? They're on the character profile pag
 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.
 
+Q. I see you have a hard-coded list of server to ID mappings. That's awful! What am I supposed to
+   do when new servers open up?
+A. Yes, it is quite horrible! Hard-coding the list is less bad than doing another HTTP GET when
+   you use Character.search(), though.
+
+   But I've anticipated your problem. If new worlds open, you can just pass :world as the ID from
+   the search page's dropdown until I update the gem:
+
+     FFXIVLodestone::Character.search(:name => 'Ayeron Lifebloom', :world => 7)
+     FFXIVLodestone::Character.new(:name => 'Ayeron Lifebloom', :world => 7) 
+
 == Contributing ==
 If you want to fool around with the source code, you can see if you've fucked everything up:
 
@@ -102,4 +117,3 @@ If you want to fool around with the source code, you can see if you've fucked ev
 * 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)'.
-* Get the biography field (if its present).

data/lib/ffxiv-lodestone.rb

@@ -3,9 +3,25 @@ require 'nokogiri'
 require 'open-uri'
 require 'json'
 
+# Nokogiri changes   entities to \302\240. This may be OK in most instances,
+# but at the very least, it makes #inspect() look like shit, which is a headache
+# for people trying to troubleshoot.
+class String
+  def strip_nbsp
+    self.strip.gsub("\302\240",' ')
+  end
+
+  def strip_nbsp!
+    before = self.reverse.reverse
+    self.strip!
+    self.gsub!("\302\240",' ')
+    before == self ? nil : self
+  end
+end
+
 module FFXIVLodestone
   # Gem version.
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
 
   # Accept-language must be sent; their default is Japanese text.
   HTTP_OPTIONS = {'Accept-Language' => 'en-us,en;q=0.5', 'Accept-Charset' => 'utf-8;q=0.5'}
@@ -49,10 +65,7 @@ module FFXIVLodestone
         h
       }
     end
-
-    def to_h
-      to_hash
-    end
+    alias :to_h :to_hash # legacy API
 
     def to_json(args={})
       self.to_hash.to_json
@@ -72,7 +85,7 @@ module FFXIVLodestone
     class StatList < Hash
       def initialize(table)
         table.search('tr').each do |tr|
-          self[tr.children[0].content.strip.downcase.to_sym] = tr.children[2].content.gsub("\302\240",' ').split(' ')[0].to_i
+          self[tr.children[0].content.strip.downcase.to_sym] = tr.children[2].content.strip_nbsp.split(' ')[0].to_i
         end
       end
 
@@ -124,7 +137,7 @@ module FFXIVLodestone
             current_sp = 0
             levelup_sp = 0
           else
-            sp.gsub!("\302\240",'') # this is a &nbsp but it looks ugly in #inspect(), so remove it.
+            sp.strip_nbsp!
             current_sp = sp.split('/')[0].strip.to_i
             levelup_sp = sp.split('/')[1].strip.to_i
           end
@@ -148,21 +161,19 @@ module FFXIVLodestone
     end # FFXIVLodestone::Character::SkillList
 
     attr_reader :skills, :stats, :resistances, :profile
+    alias :jobs :skills
     def initialize(args={})
-      unless args.class == Hash
-        character_id = args
+      args = {:id => args} unless args.class == Hash
+      raise ArgumentError, 'No search paremeters were given.' if args.empty?
+
+      if args.key? :id
+        character_id = args[:id]
+        raise ArgumentError, 'No other arguments may be specified in conjunction with :id.' if args.size > 1
       else
-        raise ArgumentError, 'No search paremeters were given.' if args.empty?
-
-        if args.key? :id
-          character_id = args[:id]
-          raise ArgumentError, 'No other arguments may be specified in conjunction with :id.' if args.size > 1
-        else
-          characters = Character.search(args)
-          raise NotFoundException, 'Character search yielded no results.' if characters.empty?
-          raise AmbiguousNameError, 'Multiple characters matched that name.' if characters.size > 1
-          character_id = characters.first[:id]
-        end
+        characters = Character.search(args)
+        raise NotFoundException, 'Character search yielded no results.' if characters.empty?
+        raise AmbiguousNameError, 'Multiple characters matched that name.' if characters.size > 1
+        character_id = characters.first[:id]
       end
       
       @character_id = character_id
@@ -183,7 +194,7 @@ module FFXIVLodestone
       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",'')
+        value = th.next_sibling.next_sibling.content.strip_nbsp
 
         # 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. 
@@ -207,7 +218,7 @@ module FFXIVLodestone
       @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(' / ')
+      race_line = profile.search('tr td').first.content.strip_nbsp.split(' / ')
       @profile[:race] = race_line.pop
 
       # horrible array splitting and popping trix. hidoi hidoi!
@@ -227,33 +238,32 @@ module FFXIVLodestone
         raise ArgumentError, ':name and :world must both be specified to perform a character search.'
       end
 
-      # TODO This should be more robust ... somehow. The search page uses indexes assigned in 
-      # a dropdown and I just copied them in to a constant. It's going to fuck up if they 
-      # release new realms.
-      #
-      # perhaps take an ID or a string...? and don't validate the ID?
-      raise ArgumentError, 'Unknown world server.' unless FFXIVLodestone::SERVER_SEARCH_INDEXES.key? args[:world].downcase.to_sym 
+      # :world can be passed as a string ('Figaro') or as the integer used by the search page (7).
+      # This is so the library is not completely useless when new worlds are added - developers can
+      # fall back to the integers until the gem is updated.
+      if args[:world].class == String
+        raise ArgumentError, 'Unknown world server.' unless FFXIVLodestone::SERVER_SEARCH_INDEXES.key? args[:world].downcase.to_sym 
 
-      world_id = FFXIVLodestone::SERVER_SEARCH_INDEXES[args[:world].downcase.to_sym] 
-      doc = Nokogiri::HTML(get_search_html(args[:name],world_id))
+        world_id = FFXIVLodestone::SERVER_SEARCH_INDEXES[args[:world].downcase.to_sym] 
+      else
+        world_id = args[:world].to_i # force it to an int to prevent any funny business.
+      end
 
+      doc = Nokogiri::HTML(get_search_html(args[:name],world_id))
       results = doc.search("table.contents-table1 tr th[contains('Character Name')]")
       return [] if results.empty? # No results = no results table header. 
       
-      # Skip index 0 - it's the header row and it's very different from the character <tr>s.
       results = results.last.parent.parent
       results.children.first.remove # discard the table headers
-
+      
       results.children.map do |tr|
-        char = {}
-
         name_element = tr.search('td:first table tr td:last a').first
-        char[:name] = name = name_element.content.strip
-        char[:id] = name_element.attr('href').gsub('/rc/character/top?cicuid=','').strip.to_i
-        char[:portrait_thumb_url] = tr.search('td:first table tr td:first img').first.attr('src').strip
-        char[:world] = tr.search('td:last').last.content.strip
-
-        char
+        {
+          :id => name_element.attr('href').gsub('/rc/character/top?cicuid=','').strip.to_i,
+          :name => name_element.content.strip,
+          :portrait_thumb_url => tr.search('td:first table tr td:first img').first.attr('src').strip,
+          :world => tr.search('td:last').last.content.strip
+        }
       end
     end # search
     
@@ -285,7 +295,7 @@ module FFXIVLodestone
 
     # Another method to redefine in the test file...
     def self.get_search_html(name,world_id)
-      open(URI.encode("http://lodestone.finalfantasyxiv.com/rc/search/search?tgt=77&q=#{name}&cw=#{world_id}"), FFXIVLodestone::HTTP_OPTIONS)
+      open(URI.encode("http://lodestone.finalfantasyxiv.com/rc/search/search?tgt=77&q=#{name}&cw=#{world_id}&num=40"), FFXIVLodestone::HTTP_OPTIONS)
     end
 
     def generate_portrait_urls(url)

data/test/spec.rb

@@ -14,6 +14,33 @@ class FFXIVLodestone::Character
   end
 end
 
+describe 'Character.search' do
+  it 'should raise an argument error' do
+    should.raise(ArgumentError) { FFXIVLodestone::Character.search() }  
+    should.raise(ArgumentError) { FFXIVLodestone::Character.search(:irrelevant_key => 'value') }  
+    should.raise(ArgumentError) { FFXIVLodestone::Character.search(:world => 'Figaro') }  
+    should.raise(ArgumentError) { FFXIVLodestone::Character.search(:name => 'Ayeron Lifebloom') }  
+    should.raise(ArgumentError) { FFXIVLodestone::Character.search(12345) }  
+    should.raise(ArgumentError) { FFXIVLodestone::Character.search(:name => 'Ayeron Lifebloom', :world => 'FAKE SERVER NAME') }  
+  end
+
+  it 'should accept server as an integer' do
+    should.not.raise(ArgumentError) { FFXIVLodestone::Character.search(:name => 'Ayeron Lifebloom', :world => 7) }
+    
+    c = FFXIVLodestone::Character.new(:name => 'Ayeron Lifebloom', :world => 7)
+    c.character_id.should.equal 1502635
+  end
+
+  it 'should be empty' do
+    FFXIVLodestone::Character.search(:name => 'ABLOO BLOO UGUU', :world => 'Selbina').should.equal([])
+  end
+
+  it 'should list characters' do
+    FFXIVLodestone::Character.search(:name => 'Lady', :world => 'Selbina').should.equal(
+      [{:world=>"Selbina", :portrait_thumb_url=>"http://static.finalfantasyxiv.com/csnap/v05m_ss_7bd793d507a92d2c415b306a83280d19.png?gediwpzz", :name=>"Lady Simmons", :id=>1015990}, {:world=>"Selbina", :portrait_thumb_url=>"http://static.finalfantasyxiv.com/csnap/14fij_ss_f19cd042628445e22a17a9362cb91f26.png?gee0yejc", :name=>"Shukick Fairlady", :id=>1195603}]
+    )
+  end
+end
 describe 'Character(invalid)' do 
   it 'is an invalid id' do
     should.raise(FFXIVLodestone::Character::NotFoundException) { FFXIVLodestone::Character.new('invalid') }
@@ -90,6 +117,9 @@ describe 'Character(1015990)' do
     @char.skills.carpenter.rank.should.equal 5
     @char.skills.carpenter.current_skill_points.should.equal 305 
     @char.skills.carpenter.skillpoint_to_next_level.should.equal 1500
+
+    # make sure the alias is working!
+    @char.jobs == @char.skills
   end
 
   it 'should list all leveled jobs' do
@@ -104,24 +134,3 @@ LOLHEREDOC
     JSON.parse(@char.to_json).should.equal JSON.parse(json)
   end
 end
-
-describe 'Character.search' do
-  it 'should raise an argument error' do
-    should.raise(ArgumentError) { FFXIVLodestone::Character.search() }  
-    should.raise(ArgumentError) { FFXIVLodestone::Character.search(:irrelevant_key => 'value') }  
-    should.raise(ArgumentError) { FFXIVLodestone::Character.search(:world => 'Figaro') }  
-    should.raise(ArgumentError) { FFXIVLodestone::Character.search(:name => 'Ayeron Lifebloom') }  
-    should.raise(ArgumentError) { FFXIVLodestone::Character.search(12345) }  
-    should.raise(ArgumentError) { FFXIVLodestone::Character.search(:name => 'Ayeron Lifebloom', :world => 'FAKE SERVER NAME') }  
-  end
-
-  it 'should be empty' do
-    FFXIVLodestone::Character.search(:name => 'ABLOO BLOO UGUU', :world => 'Selbina').should.equal([])
-  end
-
-  it 'should list characters' do
-    FFXIVLodestone::Character.search(:name => 'Lady', :world => 'Selbina').should.equal(
-      [{:world=>"Selbina", :portrait_thumb_url=>"http://static.finalfantasyxiv.com/csnap/v05m_ss_7bd793d507a92d2c415b306a83280d19.png?gediwpzz", :name=>"Lady Simmons", :id=>1015990}, {:world=>"Selbina", :portrait_thumb_url=>"http://static.finalfantasyxiv.com/csnap/14fij_ss_f19cd042628445e22a17a9362cb91f26.png?gee0yejc", :name=>"Shukick Fairlady", :id=>1195603}]
-    )
-  end
-end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ffxiv-lodestone
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: false
   segments: 
   - 0
   - 9
-  - 2
-  version: 0.9.2
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - owlmanatt
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-25 00:00:00 +00:00
+date: 2010-09-26 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency