xiv_lodestone 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d232080a2b27816989b05574d6d11c40fb424766
-  data.tar.gz: dba67820e7bd6a137f5d28f5ec0245bfa47e400e
+  metadata.gz: 900f8547e08b2e76ee9b9392bb936fbc92c9b977
+  data.tar.gz: 12f1fe3b77ca3771923ca7b116b56d3d29a414a7
 SHA512:
-  metadata.gz: daabe0be0130d7c981f18decb3fc982400fad31f526a6402d560a74282d0b3a677628f82ec4d5db2546089bfc4e3c88f05597f966341986036ded7ff28a94b65
-  data.tar.gz: 23e74f384445e88841081d3dc674d95a5c149b2d9fc170b9c6bd1c129ed607a8fbfda7ba62b3d47831668d693259ebb0ea571b7c988b3438c53d603406fbbaf7
+  metadata.gz: 2720c1bb7badfdbbe00d1cd2289f2b1a064c15aabf0bc9527f7f38ad81781e6e892789df9e50038d657fe93c53bf44749136104813fc96782bf555a27dc0f5b9
+  data.tar.gz: b37c89c1ae581c130cb57d697fa6a48d717798377757a080d91821e367909eb7aeea465723303783db078b2dd8a35a8992df2c4abc7046a828721f98a6a66c63

data/CHANGELOG.md

@@ -35,3 +35,16 @@ Features
 Bugfixes
   - Rewriting more comprehensive tests
   - Change the way Character.new arguments work
+  - Cleaned up code structure to be more modular
+
+## Alpha: 0.0.5 (2015-01-19)
+Features
+  - Added server status
+  - Added job detection
+
+Bugfixes
+  - Logic error in process_args
+  - Removed MoreThanOneCharacter exception(now picks the first character from result search)
+  - Now returns the first match if multiple characters
+  - cleaned up to_json method
+  - More bug fixes

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Benjamin Evenson
+Copyright (c) 2015 Benjamin Evenson
 
 MIT License
 

data/OUTLINE.md

@@ -0,0 +1,37 @@
+Helper
+  - Opening URL - DONE
+  - Searching ID/Character - DONE
+
+Character
+  - Profile - DONE
+  - Mounts - DONE
+  - Minions - DONE
+  - Gear - DONE
+  - Attributes - DONE
+  - Disciple - DONE
+  - Achievements
+    - Total Points
+#### Leave Last ####
+  - Blog
+  - Following
+  - Friend
+
+Free Company
+  - Profile
+    - Name
+    - Faction
+    - Tag
+    - Formed
+    - Active Members
+    - Rank
+    - Weekly Rank
+    - Monthly Rank
+    - Slogan
+    - Focus
+    - Seeking
+    - Active
+    - Recruitment
+    - Estate Profile
+  - Members
+    - Name
+    - Rank

data/README.md

@@ -9,6 +9,7 @@ submit a issue for bug or feature requests.
 
 ## Features
 - Character Search (via ID number or Name and Server)
+- To Json functionality
 - Character profile
   - name, server, portrait image url
   - HP, MP, TP
@@ -16,14 +17,14 @@ submit a issue for bug or feature requests.
   - Gear List - Shows item name, ilevel, slot, ffxiv db url, calculates total ilevel
   - Disciple List(Classes) - Shows class name, level, current exp, total exp, icon url, calculates experience to next level
   - All character attributes
+  - Mounts & Minions
+  - Server Status
+  - Job detection
 
 ## TODO
-- Server Status parser
-- Job detection, soul crystal
-- To Json functionality
-- Achievements, Blogs, Friends list, Mounts, Pets
+- Multi-Language support(JP,NA,DE,FR)
+- Achievements
 - Free Company Search/Gather Member information
-- Clean up smelly code 24/7
 
 ## Installation
 
@@ -48,14 +49,22 @@ directly taken from the lodestone naming conversation.
 
 ```ruby
 require 'xiv_lodestone'
-```  
+```
 
 To parse a character
 ```ruby
-  character = XIVLodestone::Character("Benpi Kancho", "Tonberry")
-  character = XIVLodestone::Character("Benpi Kancho")
-  character = XIVLodestone::Character(1549391)
-```  
+  character = XIVLodestone::Character(name: "Benpi Kancho", :server: "Tonberry")
+  character = XIVLodestone::Character(name: "Benpi Kancho")
+  character = XIVLodestone::Character(id: 1549391)
+```
+
+Get server status
+```ruby
+  status = XIVLodestone::ServerStatus.new
+  status.tonberry.name #=> Returns a string server name
+  status.tonberry.registration #=> Returns a string Open or Closed(Character registration)
+  status.tonberry.status #=> Retuns a string Online or Offline
+```
 
 Basic examples
 
@@ -77,6 +86,7 @@ character.nameday #=> character nameday #String
 character.guardian #=> character guardian #String
 character.city #=> character home city #String
 character.grand_company #=> character grand company #String
+character.job #=> characters current job
 
 # Character Attributes
 str, dex, vit, int, mnd, pie, fire, ice, wind, earth, lighting, water, accuracy,
@@ -86,6 +96,8 @@ piercing, slashing, heavy_resistance, bind_resistance, sleep_resistance,
 stun_resistance, poison_resistance, blind_resistance, silence_resistance,
 slow_resistance
 
+character.attribute.str #=> character str #Integer
+
 # Available Gear Slot
 weapon, head, body, hands, belt, legs, feet, shield, necklace, earrings,
 bracelets, ring1, ring2
@@ -109,7 +121,29 @@ character.disciple.rogue.current_exp # => current experience #Interger
 character.disciple.rogue.total_exp # => total experience #Integer
 character.disciple.rogue.icon_url # => class icon url #String
 character.disciple.rogue.next_level # => experience to required to level #Integer
-```  
+
+# Mounts & Minions
+character.mounts.each do |mount|
+  puts mount.name
+  puts mount.icon_url
+end
+
+character.minions.each do |minion|
+  puts minion.name
+  puts minion.icon_url
+end
+
+character.minions #=> Returns a array of Minion
+character.mounts #=> Returns a array of mounts
+
+# To Json
+character.to_json
+character.mounts.to_json
+character.minions.to_json
+character.disciple.to_json
+character.gear.to_json
+character.attribute.to_json
+```
 
 ## Contributing
 

data/lib/xiv_lodestone/lodestone_character.rb

@@ -2,7 +2,8 @@ require 'xiv_lodestone/lodestone_helper'
 require 'xiv_lodestone/lodestone_character_gear'
 require 'xiv_lodestone/lodestone_character_disciple'
 require 'xiv_lodestone/lodestone_character_attribute'
-require 'xiv_lodestone/lodestone_character_mount'
+require 'xiv_lodestone/lodestone_character_collectable'
+require 'json'
 
 module XIVLodestone
   # A Object that represents a FFXIV:ARR character,
@@ -12,34 +13,38 @@ module XIVLodestone
     # 1. Character.new(:name => "CHARACTER_NAME", :server => "SERVER_NAME")
     # 2. Character.new(:name => "CHARACTER_NAME")
     # 3. Character.new(:id => ID_NUMBER)
-    def initialize(args = Hash.new)
-      @profile = Hash.new()
+    def initialize(args = {})
+      @profile = Hash.new
       initialise_profile(Helper.process_args(args))
     end
     # Returns a #String with characters first name
-    def first_name()
+    def first_name
       @profile[:name].split(/ /).first
     end
     # Returns a #String with characters last name
-    def last_name()
+    def last_name
       @profile[:name].split(/ /).last
     end
     # Returns a #Array of characters mounts
-    def mounts()
+    def mounts
       @mounts.list
     end
     # Returns a #Array of characters minions
-    def minions()
+    def minions
       @minions.list
     end
+    # Returns the current character job
+    def job
+      @profile[:gear].soul_crystal.name.gsub("Soul of the ", "")
+    end
     # Generates missing methods from @profile hash keys
     def method_missing(method)
       return @profile[method] if @profile.key?(method)
       super
     end
     # Uses gem Oj to dump Character Object to JSON
-    def to_json()
-      Oj.dump(@profile)
+    def to_json
+      @profile.to_json
     end
     #### Private Methods ####
     # Initialises all characters information from lodestone
@@ -61,10 +66,10 @@ module XIVLodestone
       @profile[:grand_company] = Helper.get_grand_company(page)
       @profile[:free_company] = Helper.get_free_company(page)
       @profile[:disciple] = DiscipleList.new(page.xpath("//table[@class='class_list']/tr/td"))
-      @profile[:gear] = GearList.new(page.xpath("(//div[@class='item_detail_box'])[position() < 13]"))
+      @profile[:gear] = GearList.new(page.xpath("(//div[@class='item_detail_box'])[position() < 14]"))
       @profile[:attribute] = AttributeList.new(page.xpath('//div[starts-with(@class, "param_left_area_inner")]/ul/li'))
-      @mounts = MountList.new(page.xpath('(//div[@class="minion_box clearfix"])[1]/a'))
-      @minions = MountList.new(page.xpath('(//div[@class="minion_box clearfix"])[2]/a'))
+      @mounts = CollectableList.new(page.xpath('(//div[@class="minion_box clearfix"])[1]/a'))
+      @minions = CollectableList.new(page.xpath('(//div[@class="minion_box clearfix"])[2]/a'))
     end
 
     private :initialise_profile

data/lib/xiv_lodestone/lodestone_character_attribute.rb

@@ -1,5 +1,5 @@
 require 'xiv_lodestone/lodestone_helper'
-require 'oj'
+require 'json'
 
 module XIVLodestone
   # A Object that represents a set of atrributes from
@@ -8,17 +8,17 @@ module XIVLodestone
   # names are based of names of attributes from lodestone website
   class AttributeList
     def initialize(attribute_path)
-      @attributes = Hash.new
+      @attributes = {}
       parse_attributes(attribute_path)
     end
     # Generate methods from each key in the @attribute hash
     def method_missing(method)
-      return @attributes[method] if @attributes.key?(@attributes)
+      return @attributes[method] if @attributes.key?(method)
       super
     end
-    # Uses OJ to dump @attribute to json
+    # Converts t
     def to_json()
-      Oj.dump(@attributes)
+      @attributes.to_json
     end
     #### Private Methods ####
     # Parsers attributes from a document into @attribute hash

data/lib/xiv_lodestone/lodestone_character_collectable.rb

@@ -0,0 +1,29 @@
+require 'xiv_lodestone/lodestone_helper'
+require 'json'
+
+module XIVLodestone
+  class CollectableList
+    attr_reader :list
+
+    Collectable = Struct.new(:name, :icon_url)
+
+    def initialize(collectable_path)
+      @list = []
+      parse_collectable(collectable_path)
+    end
+    # Uses gem Oj to dump MountList to JSON
+    def to_json()
+      @list.map { |obj| Hash[obj.each_pair.to_a] }.to_json
+    end
+    #### Private Methods ####
+    def parse_collectable(collectable_path)
+      collectable_path.each do |collectable|
+        @list.push(Collectable.new(
+          collectable['title'].split.map(&:capitalize)*' ',
+          collectable.at_xpath('img')['src']))
+      end
+    end
+
+    private :parse_collectable
+  end
+end

data/lib/xiv_lodestone/lodestone_character_disciple.rb

@@ -1,18 +1,25 @@
 require 'nokogiri'
-require 'oj'
+require 'json'
 
 module XIVLodestone
   # A object representation of disciples(classes)
   # The initialiser takes a hash of Disciple, that layout follows
   # { :rogue => ["Rogue", 1, 0, 300, "http://..."] }
   class DiscipleList
+    # This strct representents a disciple
+    Disciple = Struct.new(:name, :level, :current_exp, :total_exp, :icon_url) do
+      def next_level
+        total_exp - current_exp
+      end
+    end
+
     def initialize(disciple_path)
-      @disciple = Hash.new
+      @disciple = {}
       parse_disciple(disciple_path)
     end
-    # Uses gem Oj to dump DiscipleList Object to JSON
+    # Returns a json repsentation of all disciples
     def to_json()
-      Oj.dump(@disciple)
+      @disciple.to_json
     end
     # Generates missing methods using @disciple hash keys
     def method_missing(method)
@@ -33,22 +40,5 @@ module XIVLodestone
     end
 
     private :parse_disciple
-
-    # A object representation of a disciple
-    class Disciple
-      attr_reader :name, :level, :current_exp, :total_exp, :icon_url
-
-      def initialize(name, level, curr, req, icon)
-        @name = name
-        @level = level
-        @current_exp = curr
-        @total_exp = req
-        @icon_url = icon
-      end
-      # Returns the required experience to the next level
-      def next_level()
-        @total_exp - @current_exp
-      end
-    end
   end
 end

data/lib/xiv_lodestone/lodestone_character_gear.rb

@@ -1,13 +1,17 @@
 require 'nokogiri'
-require 'oj'
+require 'json'
+require 'xiv_lodestone/lodestone_helper'
 
 module XIVLodestone
   # A Object that represents a list of Gear pieces
   # The initialiser takes a hash of items in the following layout
   # { :weapon => ["Fist", 110, "Weapon", "http://...."], ... }
   class GearList
+    # This struct representation a piece of gear.
+    Gear = Struct.new(:name, :ilevel, :slot, :url)
+
     def initialize(gear_path)
-      @items = Hash.new
+      @items = {}
       parse_gear(gear_path)
     end
     # Calculates the total gear list ilevel
@@ -15,15 +19,15 @@ module XIVLodestone
     # returns a #Integer
     def ilevel()
       ilevel = 0
-      ilevel = @items[:weapon].ilevel if Helper.is_2hand_weapon(@items[:weapon].slot)
+      ilevel = @items[:weapon].ilevel if @items[:shield].nil?
       @items.each_value do |value|
-        ilevel += value.ilevel
+        ilevel += value.ilevel unless value.name =~ /Soul of the/i
       end
       (ilevel/13).round
     end
-    # Uses gem Oj to dump GearList Object to JSON
+    # Returns a JSON string of all items
     def to_json()
-      Oj.dump(@items)
+      @items.to_json
     end
     # Generates access methods for each item slot
     def method_missing(method)
@@ -50,7 +54,7 @@ module XIVLodestone
       elsif name.eql?("Ring")
         return "ring#{ring_inc}"
       else
-        return name.downcase
+        return Helper.replace_downcase(name)
       end
     end
     # Initialise @num and count upwards, if @num >= 2 reset to 1
@@ -62,17 +66,5 @@ module XIVLodestone
     end
 
     private :parse_gear, :type, :ring_inc
-
-    # A object representation of a peacie of gear.
-    class Gear
-      attr_reader :name, :ilevel, :slot, :url
-
-      def initialize(name, ilevel, slot, url)
-        @name = name
-        @ilevel = ilevel
-        @slot = slot
-        @url = url
-      end
-    end
   end
 end

data/lib/xiv_lodestone/lodestone_helper.rb

@@ -5,26 +5,33 @@ module XIVLodestone
   # RuntimeError if a character can't be found
   class CharacterNotFound < RuntimeError
   end
-  # RuntimeError if more than one character is found
-  class MoreThanOneCharacter < RuntimeError
-  end
   # A class of helper methods
   class Helper
     # Validates arguments and calls corresponding method
     # Invalid arguments will rase a ArgumentError
     def self.process_args(args)
       return Helper.open_id(args[:id]) if args.key?(:id)
-      return Helper.open_url(args[:name], "") if args.key?(:name)
       return Helper.open_url(args[:name], args[:server]) if args.size == 2
+      return Helper.open_url(args[:name], "") if args.key?(:name)
       fail ArgumentError, "Invalid arguments passed"
     end
+    # Opens the FFXIV server status page
+    # returns a Nokogiri document
+    def self.open_server_status()
+      Nokogiri::HTML(open("http://na.finalfantasyxiv.com/lodestone/worldstatus/"))
+    end
+    # Opens the FFXIV registration page
+    # returns a Nokogiri document
+    def self.open_registration_status()
+      Nokogiri::HTML(open("http://na.finalfantasyxiv.com/lodestone/news/detail/80cd4583bf743600105b947d6906d0909189e479"))
+    end
     # Find a character profile from a given name and
     # server. Returns a Nokogiri XML document of the
     # characters page.
     def self.open_url(name, server)
       page = Nokogiri::HTML(open_character_url(name, server))
       check_valid_url(page)
-      id = page.xpath('//h4/a')[0]['href'].split(/\//).last
+      id = page.at_xpath('//h4/a')['href'].split(/\//).last
       Nokogiri::HTML(open_id_url(id))
     end
     # Find a characters profiles from a given id.
@@ -33,11 +40,6 @@ module XIVLodestone
     def self.open_id(id)
       Nokogiri::HTML(open_id_url(id))
     end
-    # Checks string if two handed weapon type
-    # returns true if two handed weapon type
-    def self.is_2hand_weapon(name)
-      (name =~ /(Arm|Arms|Grimoire|Primary Tool)/i) ? true : false
-    end
     # Replaces spaces wtih underscores, and downcases
     # Returns a #String
     def self.replace_downcase(string)
@@ -45,69 +47,83 @@ module XIVLodestone
     end
     # Returns a #String of the character portrait
     def self.get_server(page)
-      page.at_xpath('//h2/span').text.strip.gsub(/\(|\)/, "")
+      server = page.at_xpath('//h2/span')
+      server ? server.text.strip.gsub(/\(|\)/, "") : ""
     end
     # Returns a #String of the character portrait
     def self.get_portrait(page)
-      page.at_xpath('//div[@class="img_area bg_chara_264"]/img')['src']
+      port = page.at_xpath('//div[@class="img_area bg_chara_264"]/img')
+      port ? port['src'] : ""
     end
     # Returns a #String of the character name
     def self.get_name(page)
-      page.at_xpath('//h2/a').text
+      name = page.at_xpath('//h2/a')
+      name ? name.text : ""
     end
     # Returns a #String of character title
     def self.get_title(page)
-      page.at_xpath('//h2/div').text
+      title = page.at_xpath('//h2/div')
+      title ? title.text : ""
     end
     # Returns a #String of character introduction
     def self.get_introduction(page)
-      page.at_xpath('//div[@class="area_inner_body txt_selfintroduction"]').text.strip!
+      intro = page.at_xpath('//div[@class="area_inner_body txt_selfintroduction"]')
+      intro ? intro.text.strip! : ""
     end
     # Returns a #Integer of the characters hp
     def self.get_hp(page)
-      page.at_xpath('//li[@class="hp"]').text.to_i
+      hp = page.at_xpath('//li[@class="hp"]')
+      hp ? hp.text.to_i : 0
     end
     # Returns a #Integer of the characters mp
     def self.get_mp(page)
-      page.at_xpath('//li[@class="mp"]').text.to_i
+      mp = page.at_xpath('//li[@class="mp"]')
+      mp ? mp.text.to_i : 0
     end
     # Returns a #Integer of the characters tp
     def self.get_tp(page)
-      page.at_xpath('//li[@class="tp"]').text.to_i
+      tp = page.at_xpath('//li[@class="tp"]')
+      tp ? tp.text.to_i : 0
     end
     # Returns a #String of the characters sex
     # example "Male" or "Female"
     def self.get_sex(page)
-      page.at_xpath('//div[@class="chara_profile_title"]').text.split(/\//).last =~ /♂/i ? "Male" : "Female"
+      sex = page.at_xpath('//div[@class="chara_profile_title"]').text.split(/\//).last =~ /♂/i ? "Male" : "Female"
     end
     # Returns a #String of the characters race
     def self.get_race(page)
-      page.at_xpath('//div[@class="chara_profile_title"]').text.split(/\//).first.strip!
+      race = page.at_xpath('//div[@class="chara_profile_title"]')
+      race ? race.text.split(/\//).first.strip! : ""
     end
     # Returns a #String of the characters clan
     def self.get_clan(page)
-      page.at_xpath('//div[@class="chara_profile_title"]').text.split(/\//)[1].strip!
+      clan = page.at_xpath('//div[@class="chara_profile_title"]')
+      clan ? clan.text.split(/\//)[1].strip! : ""
     end
     # Returns a #String with the nameday
     def self.get_nameday(page)
-      page.at_xpath('(//div[@class="chara_profile_table"]/dl/dd)[1]').text
+      nameday = page.at_xpath('(//div[@class="chara_profile_table"]/dl/dd)[1]')
+      nameday ? nameday.text : ""
     end
     # Returns a #String with the guardian name
     def self.get_guardian(page)
-      page.at_xpath('(//div[@class="chara_profile_table"]/dl/dd)[2]').text
+      guardian = page.at_xpath('(//div[@class="chara_profile_table"]/dl/dd)[2]')
+      guardian ? guardian.text : ""
     end
     # Returns a #String the city name
     def self.get_city(page)
-      page.at_xpath('(//dd[@class="txt_name"])[1]').text
+      city = page.at_xpath('(//dd[@class="txt_name"])[1]')
+      city ? city.text : ""
     end
     # Returns a #String with the grandcompany
     def self.get_grand_company(page)
-      page.at_xpath('(//dd[@class="txt_name"])[2]').text
+      company = page.at_xpath('(//dd[@class="txt_name"])[2]')
+      company ? company.text : ""
     end
     # Returns a #Array with the freecompany name and url
     def self.get_free_company(page)
       element = page.at_xpath('//dd[@class="txt_name"]/a')
-      [ element.text, "http://na.finalfantasyxiv.com#{element['href']}" ]
+      element ? [ element.text, "http://na.finalfantasyxiv.com#{element['href']}" ] : [ "", "" ]
     end
     # Open a URL with the given name and server.
     # Returns a file stream.
@@ -125,7 +141,6 @@ module XIVLodestone
     # Throws a MoreThanOneCharacter exception.
     def self.check_valid_url(page)
       fail CharacterNotFound unless page.at_xpath('//h4/a')
-      fail MoreThanOneCharacter if page.xpath('//h4/a').size > 1
     end
 
     private_class_method :open_character_url, :open_id_url

data/lib/xiv_lodestone/lodestone_server.rb

@@ -0,0 +1,34 @@
+require 'xiv_lodestone/lodestone_helper'
+require 'json'
+
+module XIVLodestone
+  # This is a basic class fetchs the server status from
+  # lodestone.
+  class ServerStatus
+    Server = Struct.new(:name, :status, :registration)
+
+    def initialize()
+      @list = {}
+      fetch_server_status(Helper.open_server_status)
+    end
+    # Generates methods from @server hash keys
+    def method_missing(method)
+      return @list[method] if @list.key?(method)
+      super
+    end
+    # Fills the @server hash with each servers status
+    def fetch_server_status(page)
+      rego = Helper.open_registration_status
+      page.xpath('//td').each_slice(2) do |elem|
+        @list[elem[0].text.strip.downcase.to_sym] = Server.new(
+          elem[0].text.strip,
+          elem[1].text.strip,
+          rego.css('div.area_inner_cont').text[/○ #{elem[0].text.strip}/] ? "Open" : "Closed")
+      end
+    end
+    # Returns a JSON string of server list
+    def to_json
+      @list.to_json
+    end
+  end
+end

data/lib/xiv_lodestone/version.rb

@@ -1,4 +1,4 @@
 # Stores the current version number of the gem
 module XIVLodestone
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/xiv_lodestone.rb

@@ -1,2 +1,3 @@
 require 'xiv_lodestone/version'
 require 'xiv_lodestone/lodestone_character'
+require 'xiv_lodestone/lodestone_server'