xiv_lodestone 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f1bf8d0c6f4dcc49e331b28bfc3f94d222f1128
-  data.tar.gz: b04e3acc0ac3ff917ce5d7fdc7273632dbac1b60
+  metadata.gz: d232080a2b27816989b05574d6d11c40fb424766
+  data.tar.gz: dba67820e7bd6a137f5d28f5ec0245bfa47e400e
 SHA512:
-  metadata.gz: 44b54c61f2e69813af22345415b3d93f2c5ae9d772b67043ecc7197e660c82025203c10ed8dd372689f035e3db9a12804a3ed4474d6c978d27e5ad6d558f5358
-  data.tar.gz: 19e54b62a6febe1c7ea5bfdb875a7e246080fe5e9e70d7f12a6a22cfb8bbb339c7591a38b10030fee310cb3f3c57e56e4fafc802077a2d20c04b1860d15d860c
+  metadata.gz: daabe0be0130d7c981f18decb3fc982400fad31f526a6402d560a74282d0b3a677628f82ec4d5db2546089bfc4e3c88f05597f966341986036ded7ff28a94b65
+  data.tar.gz: 23e74f384445e88841081d3dc674d95a5c149b2d9fc170b9c6bd1c129ed607a8fbfda7ba62b3d47831668d693259ebb0ea571b7c988b3438c53d603406fbbaf7

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
 - 2.2.0
 sudo: false
+cache: bundler
 addons:
   code_climate:
     repo_token:

data/CHANGELOG.md

@@ -8,16 +8,30 @@ Features:
     - 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
+  - Converts Character profile to json
 
 ## Alpha: 0.0.2 (2015-01-05)
 
 Bugfixes:
   - Added required Ruby version to gemspec
 
-## Alpha: 0.0.3 (2015-01-06)
+## Alpha: 0.0.3 (2015-01-05)
 
 Bugfixes:
   - Added nokogiri dependency to gemspec
   - Remove rake dependency from spec
   - Fixed ilevel calculation, forgot to double 2handed ilevel as offhand
   - Refactored Paser#get_classes()., Parser#get_gear
+
+## Alpha: 0.0.4 (2015-01-07)
+
+Features
+  - Added new method to creating a Character class, Character.new("Benpi Kancho"), can pass name without server if you have an extremely rare name
+  - Added server name method
+  - Character, DiscipleList, GearList class have had a to_json method added to them
+  - Added first_name and last_name methods
+  - Added minion parser + mounts parser
+
+Bugfixes
+  - Rewriting more comprehensive tests
+  - Change the way Character.new arguments work

data/Gemfile

@@ -2,10 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'nokogiri', '~> 1.6.5'
-
 group :test do
-  gem 'rake', '~> 10.0'
-  gem 'rspec', '~> 3.1'
   gem 'codeclimate-test-reporter', require: nil
 end

data/README.md

@@ -1,12 +1,16 @@
 # XIVLodestone - A simple FFXIV lodestone scraper [![Build Status](https://travis-ci.org/benjiro/XIV-lodestone.svg)](https://travis-ci.org/benjiro/XIV-lodestone) [![Code Climate](https://codeclimate.com/github/benjiro/XIV-lodestone/badges/gpa.svg)](https://codeclimate.com/github/benjiro/XIV-lodestone) [![Test Coverage](https://codeclimate.com/github/benjiro/XIV-lodestone/badges/coverage.svg)](https://codeclimate.com/github/benjiro/XIV-lodestone) [![Dependency Status](https://gemnasium.com/benjiro/XIV-lodestone.svg)](https://gemnasium.com/benjiro/XIV-lodestone)
 
 A simple API for scraping information from FFXIV lodestone community website.
+The API uses a technique called metaprogramming, this means that additional
+disciples added to the game will be detected and add automatically.
 
-Please note this gem is currently in Alpha stage of development expect bugs, submit a issue for bug or feature requests.
+Please note this gem is currently in Alpha stage of development expect bugs,
+submit a issue for bug or feature requests.
 
 ## Features
 - Character Search (via ID number or Name and Server)
 - Character profile
+  - name, server, portrait image url
   - HP, MP, TP
   - Race, Sex, Clan, Nameday, Guardian, City, Grand Company, Free Company
   - Gear List - Shows item name, ilevel, slot, ffxiv db url, calculates total ilevel
@@ -14,8 +18,10 @@ Please note this gem is currently in Alpha stage of development expect bugs, sub
   - All character attributes
 
 ## TODO
-- Profile picture
-- Achievements, Blogs, Friends list
+- Server Status parser
+- Job detection, soul crystal
+- To Json functionality
+- Achievements, Blogs, Friends list, Mounts, Pets
 - Free Company Search/Gather Member information
 - Clean up smelly code 24/7
 
@@ -37,9 +43,8 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write a more indepth guide
-
-Once the gem is installed include it in your project.
+This usage of the gem is pretty straight forward most of the method names are
+directly taken from the lodestone naming conversation.
 
 ```ruby
 require 'xiv_lodestone'
@@ -47,13 +52,44 @@ require 'xiv_lodestone'
 
 To parse a character
 ```ruby
-  $ character = XIVLodestone::Character("Benpi Kancho", "Tonberry")
-  $ character = XIVLodestone::Character(1549391)
+  character = XIVLodestone::Character("Benpi Kancho", "Tonberry")
+  character = XIVLodestone::Character("Benpi Kancho")
+  character = XIVLodestone::Character(1549391)
 ```  
 
 Basic examples
 
 ```ruby
+character.name #=> character full name #String
+character.first_name #=> character first name #String
+character.last_name #=> character last name #String
+character.server #=> server name #String
+character.introduction #=> character profile introduction #String
+character.title #=> character title #String
+character.portrait #=> character portrait image url #String
+character.hp #=> character hp #Integer
+character.mp #=> character mp #Integer
+character.tp #=> character tp #Integer
+character.sex #=> character sex #String
+character.race #=> character race #String
+character.clan #=> character clan #String
+character.nameday #=> character nameday #String
+character.guardian #=> character guardian #String
+character.city #=> character home city #String
+character.grand_company #=> character grand company #String
+
+# Character Attributes
+str, dex, vit, int, mnd, pie, fire, ice, wind, earth, lighting, water, accuracy,
+critical_hite_rate, determination, defense, parry, magical_defense, attack_power,
+skill_speed, attack_magic_potency, healing_magic_potency, spell_speed, blunt,
+piercing, slashing, heavy_resistance, bind_resistance, sleep_resistance,
+stun_resistance, poison_resistance, blind_resistance, silence_resistance,
+slow_resistance
+
+# Available Gear Slot
+weapon, head, body, hands, belt, legs, feet, shield, necklace, earrings,
+bracelets, ring1, ring2
+
 character.gear.weapon # => Hash of below data
 character.gear.weapon.name # => weapon name #String
 character.gear.weapon.ilevel # => item level Integer
@@ -61,6 +97,11 @@ character.gear.weapon.slot # => item slot #String
 character.gear.weapon.url # => url to ffxivdb #String
 character.gear.ilevel # => Character ilevel
 
+# Available Disciples
+gladiator, marauder, archer, pugilist, lancer, rogue, conjurer, thaumaturge,
+arcanist, carpenter, armorer, leatherworker, alchemist, blacksmith, goldsmith,
+weaver, culinarian, miner, botanist, fisher
+
 character.disciple.rogue # => Hash of below data
 character.disciple.rogue.name # => class name #String
 character.disciple.rogue.level # => current level #Integer
@@ -68,9 +109,6 @@ 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
-
-character.str # => Character strength value
-# More to come
 ```  
 
 ## Contributing
@@ -80,3 +118,6 @@ character.str # => Character strength value
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+If you would like to say hi, i live on Tonberry - JP you can find me on my main
+Benpi Kancho most of the time.

data/lib/xiv_lodestone/lodestone_character.rb

@@ -1,115 +1,72 @@
 require 'xiv_lodestone/lodestone_helper'
-require 'xiv_lodestone/lodestone_parser'
+require 'xiv_lodestone/lodestone_character_gear'
+require 'xiv_lodestone/lodestone_character_disciple'
+require 'xiv_lodestone/lodestone_character_attribute'
+require 'xiv_lodestone/lodestone_character_mount'
 
 module XIVLodestone
-  # A Object that representation a FFXIV:ARR character,
+  # A Object that represents a FFXIV:ARR character,
   # all information is obtained from the lodestone website.
   class Character
-    def initialize(*args)
-      parser = nil
-      if args.count == 1 && args.all? {|x| x.is_a? Fixnum}
-        parser = Parser.new(Helper.open_id(args.first))
-      elsif args.count == 2 && args.all? {|x| x.is_a? String}
-        parser = Parser.new(Helper.open_url(args.at(0), args.at(1)))
-      else
-        fail ArgumentError, "Invalid Arguments: player_id(Fixnum) or player_name(String), server_name(String)]"
-      end
-
-      @profile = Hash.new
-      @profile[:disciple] = DiscipleList.new(parser.get_classes)
-      @profile[:gear] = GearList.new(parser.get_gear)
-      @profile.merge!(parser.get_attributes)
-      @profile[:hp] = parser.get_hp
-      @profile[:mp] = parser.get_mp
-      @profile[:tp] = parser.get_tp
-      @profile[:sex] = parser.get_sex
-      @profile[:race] = parser.get_race
-      @profile[:clan] = parser.get_clan
-      @profile[:nameday] = parser.get_nameday
-      @profile[:guardian] = parser.get_guardian
-      @profile[:city] = parser.get_city
-      @profile[:grand_company] = parser.get_grand_company
-      @profile[:free_company] = parser.get_free_company
-
-      parser = nil #Close the reference so Nokogiri cleans up itself
+    # default constructor, handles styles of arguments
+    # 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()
+      initialise_profile(Helper.process_args(args))
     end
-
-    def method_missing(method)
-      return @profile[method] if @profile.key?(method)
-      super
+    # Returns a #String with characters first name
+    def first_name()
+      @profile[:name].split(/ /).first
     end
-  end
-  # 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
-    def initialize(gear_list)
-      @list = Hash.new
-      gear_list.each do |key, value|
-        gear = Gear.new(value[0], value[1], value[2], value[3])
-        @list[key] = gear
-      end
+    # Returns a #String with characters last name
+    def last_name()
+      @profile[:name].split(/ /).last
+    end
+    # Returns a #Array of characters mounts
+    def mounts()
+      @mounts.list
     end
-    # Calculates the total gear list ilevel
-    # Rounds to the nearest whole number like FFXIV ingame calculation
-    # returns a #Integer
-    def ilevel()
-      ilevel = 0
-      ilevel = @list[:weapon].ilevel if Helper.is_2hand_weapon(@list[:weapon].slot)
-      @list.each_value do |value|
-        ilevel += value.ilevel
-      end
-      (ilevel/13).round
+    # Returns a #Array of characters minions
+    def minions()
+      @minions.list
     end
-    # Generates access methods for each item slot
+    # Generates missing methods from @profile hash keys
     def method_missing(method)
-      return @list[method] if @list.key?(method)
+      return @profile[method] if @profile.key?(method)
       super
     end
-    # A object representation of a peacie of gear.
-    # TODO Add more information
-    class Gear
-      attr_reader :name, :ilevel, :slot, :url
-
-      def initialize(name, ilevel, slot, url)
-        @name = name
-        @ilevel = ilevel
-        @slot = slot
-        @url = url
-      end
+    # Uses gem Oj to dump Character Object to JSON
+    def to_json()
+      Oj.dump(@profile)
     end
-  end
-  # A object representation of disciples(classes)
-  # The initialiser takes a hash of Disciple, that layout follows
-  # { :rogue => ["Rogue", 1, 0, 300, "http://..."] }
-  class DiscipleList
-    def initialize(disciple_list)
-      @list = Hash.new
-      disciple_list.each do |key, value|
-        disciple = Disciple.new(value[0], value[1], value[2], value[3], value[4])
-        @list[key.to_sym] = disciple
-      end
-      # Generates access methods for each disciple slot
-      def method_missing(method)
-        return @list[method] if @list.key?(method)
-        super
-      end
+    #### Private Methods ####
+    # Initialises all characters information from lodestone
+    def initialise_profile(page)
+      @profile[:name] = Helper.get_name(page)
+      @profile[:server] = Helper.get_server(page)
+      @profile[:introduction] = Helper.get_introduction(page)
+      @profile[:title] = Helper.get_title(page)
+      @profile[:portrait] = Helper.get_portrait(page)
+      @profile[:hp] = Helper.get_hp(page)
+      @profile[:mp] = Helper.get_mp(page)
+      @profile[:tp] = Helper.get_tp(page)
+      @profile[:sex] = Helper.get_sex(page)
+      @profile[:race] = Helper.get_race(page)
+      @profile[:clan] = Helper.get_clan(page)
+      @profile[:nameday] = Helper.get_nameday(page)
+      @profile[:guardian] = Helper.get_guardian(page)
+      @profile[:city] = Helper.get_city(page)
+      @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[: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'))
     end
-    # 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
+    private :initialise_profile
   end
 end

data/lib/xiv_lodestone/lodestone_character_attribute.rb

@@ -0,0 +1,39 @@
+require 'xiv_lodestone/lodestone_helper'
+require 'oj'
+
+module XIVLodestone
+  # A Object that represents a set of atrributes from
+  # lodestone website. The class parsers a given xpath
+  # for attributes and stores them in a Hash. All method
+  # names are based of names of attributes from lodestone website
+  class AttributeList
+    def initialize(attribute_path)
+      @attributes = Hash.new
+      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)
+      super
+    end
+    # Uses OJ to dump @attribute to json
+    def to_json()
+      Oj.dump(@attributes)
+    end
+    #### Private Methods ####
+    # Parsers attributes from a document into @attribute hash
+    def parse_attributes(attribute_path)
+      attribute_path.each_with_index do |li, index|
+        # For some weird reason the first 6 elements don't use span tags like the rest.
+        if index < 6
+          @attributes[Helper.replace_downcase(li['class']).to_sym] = li.text.to_i
+        else
+          ele = li.text.split(/(?<=\D)(?=\d)/)
+          @attributes[Helper.replace_downcase(ele[0]).to_sym] = ele[1].to_i
+        end
+      end
+    end
+
+    private :parse_attributes
+  end
+end

data/lib/xiv_lodestone/lodestone_character_disciple.rb

@@ -0,0 +1,54 @@
+require 'nokogiri'
+require 'oj'
+
+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
+    def initialize(disciple_path)
+      @disciple = Hash.new
+      parse_disciple(disciple_path)
+    end
+    # Uses gem Oj to dump DiscipleList Object to JSON
+    def to_json()
+      Oj.dump(@disciple)
+    end
+    # Generates missing methods using @disciple hash keys
+    def method_missing(method)
+      return @disciple[method] if @disciple.key?(method)
+      super
+    end
+    #### Private Methods ####
+    def parse_disciple(disciple_path)
+      disciple_path.each_slice(3) do |table|
+        next if table[0].text.empty? #skip empty cols
+        @disciple[table[0].text.downcase.to_sym] = Disciple.new(
+          table[0].text,
+          table[1].text.to_i,
+          table[2].text.split(/\//)[0].to_i,
+          table[2].text.split(/\//)[1].to_i,
+          table[0].at_css('img')['src'])
+      end
+    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

@@ -0,0 +1,78 @@
+require 'nokogiri'
+require 'oj'
+
+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
+    def initialize(gear_path)
+      @items = Hash.new
+      parse_gear(gear_path)
+    end
+    # Calculates the total gear list ilevel
+    # Rounds to the nearest whole number like FFXIV ingame calculation
+    # returns a #Integer
+    def ilevel()
+      ilevel = 0
+      ilevel = @items[:weapon].ilevel if Helper.is_2hand_weapon(@items[:weapon].slot)
+      @items.each_value do |value|
+        ilevel += value.ilevel
+      end
+      (ilevel/13).round
+    end
+    # Uses gem Oj to dump GearList Object to JSON
+    def to_json()
+      Oj.dump(@items)
+    end
+    # Generates access methods for each item slot
+    def method_missing(method)
+      return @items[method] if @items.key?(method)
+      super
+    end
+    #### Private Methods ####
+    # Parses each piece of gear and stores it in @items hash
+    def parse_gear(gear_path)
+      gear_path.each do |item|
+        @items[type(item.at_css('h3.category_name').text).to_sym] = Gear.new(
+          item.css('h2').text,
+          item.at_css('div.pt3.pb3').text.split(/ /).last.to_i,
+          item.at_css('h3').text,
+        "http://na.finalfantasyxiv.com#{item.at_css('a')['href']}")
+      end
+    end
+    # Returns a string representation of item slot
+    def type(name)
+      if name =~ /(Arm|Arms|Grimoire|Primary Tool)/i
+        return "weapon"
+      elsif name =~ /Shield/i
+        return "shield"
+      elsif name.eql?("Ring")
+        return "ring#{ring_inc}"
+      else
+        return name.downcase
+      end
+    end
+    # Initialise @num and count upwards, if @num >= 2 reset to 1
+    # @num += 1 reset if @num >= 2
+    def ring_inc()
+      @num ||= 0
+      @num = 0 if @num >= 2
+      @num += 1
+    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_character_mount.rb

@@ -0,0 +1,35 @@
+require 'xiv_lodestone/lodestone_helper'
+require 'oj'
+
+module XIVLodestone
+  class MountList
+    attr_reader :list
+
+    def initialize(mount_path)
+      @list = Array.new
+      parse_mount(mount_path)
+    end
+    # Uses gem Oj to dump MountList to JSON
+    def to_json()
+      Oj.dump(@list)
+    end
+    #### Private Methods ####
+    def parse_mount(mount_path)
+      mount_path.each do |mount|
+        @list.push(Mount.new(mount['title'],
+          mount.at_xpath('img')['src']))
+      end
+    end
+
+    private :parse_mount
+
+    class Mount
+      attr_reader :name, :icon_url
+
+      def initialize(name, icon_url)
+        @name = name.split.map(&:capitalize)*' '
+        @icon_url = icon_url
+      end
+    end
+  end
+end

data/lib/xiv_lodestone/lodestone_helper.rb

@@ -1,55 +1,134 @@
-require 'nokogiri'
-require 'open-uri'
-
-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
-    # 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
-      Nokogiri::HTML(open_id_url(id))
-    end
-    # Find a characters profiles from a given id.
-    # Returns a Nokogiri XML document of the characters
-    # page.
-    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
-    # Open a URL with the given name and server.
-    # Returns a file stream.
-    def self.open_character_url(name, server)
-      open('http://na.finalfantasyxiv.com/lodestone/character/' \
-           "?q=#{name}&worldname=#{server}")
-    end
-    # Open a URL with the given id.
-    # Reutrn a file stream.
-    def self.open_id_url(id)
-      open("http://na.finalfantasyxiv.com/lodestone/character/#{id}")
-    end
-    # Validates a Nokogiri document for a character.
-    # Throws a CharacterNotFound exception.
-    # 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
-    private_class_method :check_valid_url
-  end
-end
+require 'nokogiri'
+require 'open-uri'
+
+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
+      fail ArgumentError, "Invalid arguments passed"
+    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
+      Nokogiri::HTML(open_id_url(id))
+    end
+    # Find a characters profiles from a given id.
+    # Returns a Nokogiri XML document of the characters
+    # page.
+    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)
+      string.gsub(" ", "_").downcase
+    end
+    # Returns a #String of the character portrait
+    def self.get_server(page)
+      page.at_xpath('//h2/span').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']
+    end
+    # Returns a #String of the character name
+    def self.get_name(page)
+      page.at_xpath('//h2/a').text
+    end
+    # Returns a #String of character title
+    def self.get_title(page)
+      page.at_xpath('//h2/div').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!
+    end
+    # Returns a #Integer of the characters hp
+    def self.get_hp(page)
+      page.at_xpath('//li[@class="hp"]').text.to_i
+    end
+    # Returns a #Integer of the characters mp
+    def self.get_mp(page)
+      page.at_xpath('//li[@class="mp"]').text.to_i
+    end
+    # Returns a #Integer of the characters tp
+    def self.get_tp(page)
+      page.at_xpath('//li[@class="tp"]').text.to_i
+    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"
+    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!
+    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!
+    end
+    # Returns a #String with the nameday
+    def self.get_nameday(page)
+      page.at_xpath('(//div[@class="chara_profile_table"]/dl/dd)[1]').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
+    end
+    # Returns a #String the city name
+    def self.get_city(page)
+      page.at_xpath('(//dd[@class="txt_name"])[1]').text
+    end
+    # Returns a #String with the grandcompany
+    def self.get_grand_company(page)
+      page.at_xpath('(//dd[@class="txt_name"])[2]').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']}" ]
+    end
+    # Open a URL with the given name and server.
+    # Returns a file stream.
+    def self.open_character_url(name, server)
+      open('http://na.finalfantasyxiv.com/lodestone/character/' \
+           "?q=#{name}&worldname=#{server}")
+    end
+    # Open a URL with the given id.
+    # Reutrn a file stream.
+    def self.open_id_url(id)
+      open("http://na.finalfantasyxiv.com/lodestone/character/#{id}")
+    end
+    # Validates a Nokogiri document for a character.
+    # Throws a CharacterNotFound exception.
+    # 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
+    private_class_method :check_valid_url
+  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.3'
-end
+# Stores the current version number of the gem
+module XIVLodestone
+  VERSION = '0.0.4'
+end

data/lib/xiv_lodestone.rb

@@ -1,8 +1,2 @@
-require 'xiv_lodestone/version'
-require 'xiv_lodestone/lodestone_helper'
-require 'xiv_lodestone/lodestone_character'
-require 'xiv_lodestone/lodestone_parser'
-
-# TODO
-module XIVLodestone
-end
+require 'xiv_lodestone/version'
+require 'xiv_lodestone/lodestone_character'

data/spec/spec_helper.rb

@@ -1,12 +1,12 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-end
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/xiv_lodestone_spec.rb

@@ -5,7 +5,7 @@ LOCAL_FILE = File.join(File.dirname(__FILE__), "resources/character.html")
 INVALID_FILE = File.join(File.dirname(__FILE__), "resources/invalid.html")
 
 describe XIVLodestone::Character do
-  let(:character) { XIVLodestone::Character.new("Benpi Kancho", "Tonberry") }
+  let(:character) { XIVLodestone::Character.new(:name => "Benpi Kancho", :server => "Tonberry") }
 
   it 'Character profile found' do
     expect(character.nil?).to eql(false)
@@ -13,95 +13,68 @@ describe XIVLodestone::Character do
 end
 
 describe XIVLodestone::Helper do
+  let(:helper) { XIVLodestone::Helper }
+
   it 'Find character from name and server' do
-    page = XIVLodestone::Helper.open_url("Benpi Kancho", "Tonberry")
-    expect(page.xpath('//h2/a')[0].text).to eql("Benpi Kancho")
+    page = helper.open_url("Benpi Kancho", "Tonberry")
+    expect(page.xpath('//h2/a')[0].text).to eq("Benpi Kancho")
   end
 
   it 'Invalid character name' do
-    expect { XIVLodestone::Helper.open_url("#$%#FG", "Tonberry") }.to raise_error(URI::InvalidURIError)
+    expect { helper.open_url("#$%#FG", "Tonberry") }.to raise_error(URI::InvalidURIError)
   end
 
   it 'Find multiple characters exception' do
-    expect { XIVLodestone::Helper.open_url("Benpi", "") }.to raise_error(XIVLodestone::MoreThanOneCharacter)
+    expect { helper.open_url("Benpi", "") }.to raise_error(XIVLodestone::MoreThanOneCharacter)
   end
 
   it 'No character found exception' do
-    expect { XIVLodestone::Helper.open_url("Yoloswaggings", "Tonberry") }.to raise_error(XIVLodestone::CharacterNotFound)
+    expect { helper.open_url("Yoloswaggings", "Tonberry") }.to raise_error(XIVLodestone::CharacterNotFound)
   end
 
   it 'Find character from id' do
-    page = XIVLodestone::Helper.open_id("1549391")
+    page = helper.open_id("1549391")
     expect(page.xpath('//h2/a')[0].text).to eql("Benpi Kancho")
   end
-end
 
-describe XIVLodestone::Character do
-  let(:character) { XIVLodestone::Character.new("Pocket Rocket", "Tonberry") }
-
-  it 'Character methods check' do
-    expect(character.city).to eql("Ul'dah")
-    # TODO Add full test of API
+  it 'invalid character id' do
+    expect { helper.open_id("154") }.to raise_error(OpenURI::HTTPError)
   end
 
-  it 'GearList class check' do
-    list = XIVLodestone::GearList.new({:weapon => ["Fist", 110, "Weapon", "http://..."]})
-    expect(list.weapon.name).to eql("Fist")
-    expect(list.weapon.ilevel).to eql(110)
-    expect(list.weapon.slot).to eql("Weapon")
-    expect(list.weapon.url).to eql("http://...")
+  it 'invalid arguments' do
+    expect { helper.process_args(:server => "Tonberry")}. to raise_error(ArgumentError)
   end
 
-  it 'DiscipleList class check' do
-    list = XIVLodestone::DiscipleList.new({:rogue => ["Rogue", 1, 0, 300, "http://..."]})
-    expect(list.rogue.name).to eql("Rogue")
-    expect(list.rogue.level).to eql(1)
-    expect(list.rogue.current_exp).to eql(0)
-    expect(list.rogue.total_exp).to eql(300)
-    expect(list.rogue.icon_url).to eql("http://...")
-    expect(list.rogue.next_level).to eql(300)
+  it 'Should/Shouldnt be a 2hand weapon' do
+    expect(helper.is_2hand_weapon("Two-handed Conjurer's Arm")).to be
+    expect(helper.is_2hand_weapon("Dogs Brekkie")).not_to be
   end
-end
 
-describe XIVLodestone::Parser do
-  let(:parser) { XIVLodestone::Parser.new(Nokogiri::HTML(File.open(LOCAL_FILE))) }
-  let(:invalid) { XIVLodestone::Parser.new(Nokogiri::HTML(File.open(INVALID_FILE))) }
+  it 'replace_downcase case test' do
+    expect(helper.replace_downcase("HELLO WORLD")).to eq("hello_world")
+    expect(helper.replace_downcase("well_yea")).to eq("well_yea")
+  end
 
-  it 'Nil initializer to parser' do
-    expect { XIVLodestone::Parser.new(nil) }.to raise_error(XIVLodestone::Parser::InvalidDocument)
+  it 'sucessful call of get methods' do
+    valid = Nokogiri::HTML(open(LOCAL_FILE))
+    expect(helper.get_hp(valid)).to eq(4975)
+    expect(helper.get_mp(valid)).to eq(4819)
+    expect(helper.get_tp(valid)).to eq(1000)
+    expect(helper.get_sex(valid)).to eq("Male")
+    expect(helper.get_race(valid)).to eq("Miqo'te")
+    expect(helper.get_clan(valid)).to eq("Keeper of the Moon")
+    expect(helper.get_nameday(valid)).to eq("27th Sun of the 1st Astral Moon")
+    expect(helper.get_guardian(valid)).to eq("Oschon, the Wanderer")
+    expect(helper.get_city(valid)).to eq("Gridania")
+    expect(helper.get_grand_company(valid)).to eq("Immortal Flames/Second Flame Lieutenant")
+    expect(helper.get_free_company(valid)).to eq(["Nomad Moogles", "http://na.finalfantasyxiv.com/lodestone/freecompany/9233505136016403440/"])
   end
+end
 
-  it 'Invalid parse methods' do
-    expect(invalid.get_hp()).to eql(nil)
-    expect(invalid.get_mp()).to eql(nil)
-    expect(invalid.get_tp()).to eql(nil)
-    expect(invalid.get_sex()).to eql(nil)
-    expect(invalid.get_race()).to eql(nil)
-    expect(invalid.get_clan()).to eql(nil)
-    expect(invalid.get_nameday()).to eql(nil)
-    expect(invalid.get_guardian()).to eql(nil)
-    expect(invalid.get_city()).to eql(nil)
-    expect(invalid.get_grand_company()).to eql(nil)
-    expect(invalid.get_classes()).to eql({})
-    expect(invalid.get_attributes()).to eql({})
-    expect(invalid.get_gear()).to eql({})
-    end
-
-  it 'Sucessful parse methods' do
-    expect(parser.get_classes().count).to eql(20)
-    expect(parser.get_attributes().count).to eql(34)
-    expect(parser.get_gear().count).to eql (12)
-    expect(parser.get_hp()).to eql(4975)
-    expect(parser.get_mp()).to eql(4819)
-    expect(parser.get_tp()).to eql(1000)
-    expect(parser.get_sex()).to eql("Male")
-    expect(parser.get_race()).to eql("Miqo'te")
-    expect(parser.get_clan()).to eql("Keeper of the Moon")
-    expect(parser.get_nameday()).to eql("27th Sun of the 1st Astral Moon")
-    expect(parser.get_guardian()).to eql("Oschon, the Wanderer")
-    expect(parser.get_city()).to eql("Gridania")
-    expect(parser.get_grand_company()).to eql("Immortal Flames/Second Flame Lieutenant")
-    expect(parser.get_free_company()).to eql(["Nomad Moogles",
-                                              "http://na.finalfantasyxiv.com/lodestone/freecompany/9233505136016403440/"])
+describe XIVLodestone::Character do
+  let(:character) { XIVLodestone::Character.new(:name => "Pocket Rocket", :server =>"Tonberry") }
+
+  it 'Character methods check' do
+    # TODO Add full test of API
   end
 end

data/xiv_lodestone.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 2.2"
 
   spec.add_dependency("nokogiri", "~> 1.6")
+  spec.add_dependency("oj", "~> 2.11")
 
   spec.add_development_dependency("bundler", "~> 1.7")
   spec.add_development_dependency("rspec", "~> 3.1")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xiv_lodestone
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Benjamin Evenson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-05 00:00:00.000000000 Z
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,8 +98,11 @@ files:
 - Rakefile
 - lib/xiv_lodestone.rb
 - lib/xiv_lodestone/lodestone_character.rb
+- lib/xiv_lodestone/lodestone_character_attribute.rb
+- lib/xiv_lodestone/lodestone_character_disciple.rb
+- lib/xiv_lodestone/lodestone_character_gear.rb
+- lib/xiv_lodestone/lodestone_character_mount.rb
 - lib/xiv_lodestone/lodestone_helper.rb
-- lib/xiv_lodestone/lodestone_parser.rb
 - lib/xiv_lodestone/version.rb
 - spec/resources/character.html
 - spec/resources/invalid.html

data/lib/xiv_lodestone/lodestone_parser.rb

@@ -1,158 +0,0 @@
-require 'nokogiri'
-
-module XIVLodestone
-  class Parser
-    # An exception for a invalid Nokogiri page
-    class InvalidDocument < Exception
-    end
-    # default constructor, initalises @page with a
-    # Nokogiri document. Raises a InvalidDocument eception
-    # if page is invalid
-    def initialize(page)
-      fail InvalidDocument, 'Invalid page' if page.nil?
-      @page = page
-    end
-    # Returns a #Hash of the characters class levels
-    # Example { :Gladitor => 10, ... }
-    # If no classes found returns a empty #Hash
-    def get_classes()
-      class_list = Hash.new
-      @page.xpath('//table[@class="class_list"]/tr/td').each_slice(3) do |td|
-        # Not a valid class
-        next if td[0].text.empty?
-        exp = td[2].text.split(/\//)
-
-        class_list[td[0].text.downcase.to_sym] = [td[0].text,
-          td[1].text.to_i,
-          exp[0].to_i,
-          exp[1].to_i,
-          td[0].at_css('img')['src']]
-      end
-      class_list
-    end
-    # Returns a #Hash of the character attributes
-    # Example { :str => 243, ... }
-    # If no attributes found returns a empty #Hash
-    def get_attributes()
-      stats = Hash.new
-      @page.xpath('//div[starts-with(@class, "param_left_area_inner")]/ul/li').each_with_index do |li, index|
-        if index < 6
-          stats[replace_downcase(li['class']).to_sym] = li.text.to_i
-        else
-          ele = li.text.split(/(?<=\D)(?=\d)/)
-          stats[replace_downcase(ele[0]).to_sym] = ele[1].to_i
-        end
-      end
-      stats
-    end
-    # Returns a #Hash of the characters gear list
-    # Example { :head => [ "item_name", "item_url" ], ... }
-    # If no gear found returns a empty #Hash
-    def get_gear()
-      items = Hash.new
-      @page.xpath("(//div[@class='item_detail_box'])[position() < 13]").each do |item|
-        type = get_item_type(item.at_css('h3.category_name').text)
-        items[type.to_sym] = [ item.css('h2').text,
-          item.at_css('div.pt3.pb3').text.split(/ /).last.to_i,
-          item.at_css('h3.category_name').text,
-          "http://na.finalfantasyxiv.com#{item.css('a')[0]['href']}" ]
-      end
-      items
-    end
-    # Returns a #Integer of the characters hp
-    # otherwise returns nil
-    def get_hp()
-      hp = @page.at_xpath('//li[@class="hp"]')
-      hp.nil? ? nil : hp.text.to_i
-    end
-    # Returns a #Integer of the characters mp
-    # otherwise returns nil
-    def get_mp()
-      mp = @page.at_xpath('//li[@class="mp"]')
-      mp.nil? ? nil : mp.text.to_i
-    end
-     # Returns a #Integer of the characters tp
-    # otherwise returns nil
-    def get_tp()
-      tp = @page.at_xpath('//li[@class="tp"]')
-      tp.nil? ? nil : tp.text.to_i
-    end
-    # Returns a #String of the characters sex
-    # example "Male" or "Female"
-    # otherwise returns nil
-    def get_sex()
-      sex = @page.at_xpath('//div[@class="chara_profile_title"]')
-      if sex.nil?
-        nil
-      else
-        sex.text.split(/\//).last =~ /♂/i ? "Male" : "Female"
-      end
-    end
-    # Returns a #String of the characters race
-    # otherwise returns nil
-    def get_race()
-      race = @page.at_xpath('//div[@class="chara_profile_title"]')
-      race.nil? ? nil : race.text.split(/\//).first.strip!
-    end
-    # Returns a #String of the characters clan
-    # otherwise returns nil
-    def get_clan()
-      clan = @page.at_xpath('//div[@class="chara_profile_title"]')
-      clan.nil? ? nil : clan.text.split(/\//)[1].strip!
-    end
-    # Returns a #String with the nameday
-    # otherwise returns nil
-    def get_nameday()
-      nameday = @page.at_xpath('(//div[@class="chara_profile_table"]/dl/dd)[1]')
-      nameday.nil? ? nil : nameday.text
-    end
-    # Returns a #String with the guardian name
-    # otherwise returns nil
-    def get_guardian()
-      guardian = @page.at_xpath('(//div[@class="chara_profile_table"]/dl/dd)[2]')
-      guardian.nil? ? nil : guardian.text
-    end
-    # Returns a #String the city name
-    # otherwise returns nil
-    def get_city()
-      city = @page.at_xpath('(//dd[@class="txt_name"])[1]')
-      city.nil? ? nil : city.text
-    end
-    # Returns a #String with the grandcompany
-    # otherwise returns nil
-    def get_grand_company()
-      company = @page.at_xpath('(//dd[@class="txt_name"])[2]')
-      company.nil? ? nil : company.text
-    end
-    # Returns a #Array with the freecompany name and url
-    # otherwise returns nil
-    def get_free_company()
-      element = @page.at_xpath('//dd[@class="txt_name"]/a')
-      element.nil? ? nil : [ element.text, "http://na.finalfantasyxiv.com#{element['href']}" ]
-    end
-    # Replaces spaces wtih underscores, and downcases
-    # Returns a #String
-    def replace_downcase(string)
-      string.gsub(" ", "_").downcase
-    end
-    # Auto-increaments between 1 and 2
-    def ring
-      @num ||= 0
-      @num = 0 if @num >= 2
-      @num += 1
-    end
-    # Returns a string representing what item type it is
-    def get_item_type(item_name)
-      if item_name =~ /(Arm|Arms|Grimoire|Primary Tool)/i
-        return "weapon"
-      elsif item_name =~ /Shield/i
-        return "shield"
-      elsif item_name.eql?("Ring")
-        return "ring#{ring}"
-      else
-        return item_name.downcase
-      end
-    end
-    private :replace_downcase, :ring, :get_item_type
-  end
-end