xiv_lodestone 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a432c0ad6b311ba278eb7f9dd6b955f7e871a3e
+  data.tar.gz: 57ce133ac2807b8f95bb33e728753ccdb0541e21
+SHA512:
+  metadata.gz: ddd77ff25fdc421423e8f47447e1e456adbb08cf0462c21cb74fe104b590aef64934d81b274fa544a919ef644ccc59632570fb05c7240aa691adb5ab3740da0b
+  data.tar.gz: acd1e309345ec4d6555b09771efafe865c510926a80bd355751e833e96d3939747bef716e8a4676178a35f81def9b23c374281b6a11b19ad03ef14f520d405d8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 2.2.0
+sudo: false
+addons:
+  code_climate:
+    repo_token:
+      secure: "cNY3+gHTFC/mL3K34u+JR4UvsvREtytTUakNjy/J6avX1Zrgbzo26p4JzKNIsDzDvPkkaQqhLkdELMBnNjermTFFGtbJ8PNU1rNWwsLJ/R+RsFzrD8eBOgCBgLVt798qz7skLzKpiUzoU8rEq5ksyn1sBHo6OcrrKwvE8lQY8zs="

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'nokogiri'
+gem 'json'
+
+group :test do
+  gem 'rake'
+  gem 'codeclimate-test-reporter', require: nil
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Benjamin Evenson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# 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)
+
+A simple API for scraping information from FFXIV lodestone community website.
+
+## Features
+- Character Search (via ID number or Name and Server)
+- Character profile
+  - 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
+  - Disciple List(Classes) - Shows class name, level, current exp, total exp, icon url, calculates experience to next level
+  - All character attributes
+
+## TODO
+- Profile picture
+- Achievements, Blogs, Friends list
+- Free Company Search/Gather Member information
+- Clean up smelly code 24/7
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xiv_lodestone'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xiv_lodestone
+
+## Usage
+
+TODO: Write a more indepth guide
+
+Once the gem is installed include it in your project.
+
+```ruby
+require 'xiv_lodestone'
+```  
+
+To parse a character
+```ruby
+  $ character = XIVLodestone::Character("Benpi Kancho", "Tonberry")
+  $ character = XIVLodestone::Character(1549391)
+```  
+
+Basic examples
+
+```ruby
+character.gear.weapon # => Hash of below data
+character.gear.weapon.name # => weapon name #String
+character.gear.weapon.ilevel # => item level Integer
+character.gear.weapon.slot # => item slot #String
+character.gear.weapon.url # => url to ffxivdb #String
+character.gear.ilevel # => Character ilevel
+
+character.disciple.rogue # => Hash of below data
+character.disciple.rogue.name # => class name #String
+character.disciple.rogue.level # => current level #Integer
+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
+
+1. Fork it ( https://github.com/[my-github-username]/xiv-lodestone/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/xiv_lodestone/lodestone_character.rb

@@ -0,0 +1,114 @@
+require 'xiv_lodestone/lodestone_helper'
+require 'xiv_lodestone/lodestone_parser'
+
+module XIVLodestone
+  # A Object that representation 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
+    end
+
+    def method_missing(method)
+      return @profile[method] if @profile.key?(method)
+      super
+    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
+    end
+    # Calculates the total gear list ilevel
+    # Rounds to the nearest whole number like FFXIV ingame calculation
+    # returns a #Integer
+    def ilevel()
+      ilevel = 0
+      @list.each_value do |value|
+        ilevel += value.ilevel
+      end
+      (@list.key?(:shield)) ? (ilevel/13).round : (ilevel/12).round
+    end
+    # Generates access methods for each item slot
+    def method_missing(method)
+      return @list[method] if @list.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
+    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
+    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
+  end
+end

data/lib/xiv_lodestone/lodestone_helper.rb

@@ -0,0 +1,50 @@
+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
+    # 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/lodestone_parser.rb

@@ -0,0 +1,155 @@
+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?
+
+        name = td[0].text
+        level = td[1].text.to_i
+        exp = td[2].text.split(/\//)
+        icon = td[0].at_css('img')['src']
+
+        class_list[name.downcase.to_sym] = [name, level, exp[0].to_i,
+                   exp[1].to_i, icon]
+      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()
+      # TODO: Smelly code, rewrite
+      items = Hash.new
+      ring_count = 1
+      @page.xpath("(//div[@class='item_detail_box'])[position() < 13]").each_with_index do |item, index|
+        type = get_item_type(item.at_css('h3.category_name').text)
+        level = item.xpath('//div[@class="pt3 pb3"]')[index].text.split(/ /).last.to_i
+        if type.eql? "ring"
+          items["#{type}#{ring_count}".to_sym] = [item.css('h2').text, level, type, "http://na.finalfantasyxiv.com#{item.css('a')[0]['href']}"]
+          ring_count += 1
+        else
+          items[replace_downcase(type).to_sym] = [item.css('h2').text, level, type, "http://na.finalfantasyxiv.com#{item.css('a')[0]['href']}"]
+        end
+      end
+      items
+    end
+    # Returns a string representing what item 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"
+      else
+        return item_name.downcase
+      end
+    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
+  end
+end

data/lib/xiv_lodestone/version.rb

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

data/lib/xiv_lodestone.rb

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