Update character data

* Adds missing MIMO and CJ data options to the `all_data` option. * Adds `extended` option for retrieving extended character data.
xivapi · Aug 3, 2020 · 3cc181a · 3cc181a
1 parent a3c373a
commit 3cc181a
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xivapi (0.3.1)
+    xivapi (0.3.2)
       rest-client (~> 2.0)
 
 GEM
@@ -14,7 +14,7 @@ GEM
       domain_name (~> 0.5)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    mime-types-data (3.2020.0512)
     netrc (0.11.0)
     rake (10.4.2)
     rest-client (2.1.0)
@@ -24,7 +24,7 @@ GEM
       netrc (~> 0.8)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
     yard (0.9.19)
 
 PLATFORMS

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ A Ruby library for [XIVAPI](https://www.xivapi.com/).
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'xivapi', git: 'https://github.com/xivapi/xivapi-ruby.git', tag: 'v0.3.1'
+gem 'xivapi', git: 'https://github.com/xivapi/xivapi-ruby.git', tag: 'v0.3.2'
 ```
 
 And then run:

diff --git a/lib/xivapi/request.rb b/lib/xivapi/request.rb
@@ -6,7 +6,7 @@ module XIVAPI::Request
   LODESTONE_LIMIT = 50.freeze
 
   # Options used to retrieve all data when querying a character
-  ALL_CHARACTER_DATA = 'AC,FR,FC,FCM,PVP'.freeze
+  ALL_CHARACTER_DATA = 'AC,MIMO,CJ,FR,FC,FCM,PVP'.freeze
 
   # @param indexes [String, Array <String>] One or more indexes to search on
   # @param string [String] Value to search for in the string column
@@ -63,11 +63,13 @@ def servers(group: false)
 
   # @param id [Integer] Character ID
   # @param all_data [true, false] Return the full set of character data
+  # @param extended [true, false] Return additional data for various fields (e.g. name, icon)
   # @param data [String, Array <String>] Additional data to request, see: https://xivapi.com/docs/Character#character
   # @param columns [String, Array <String>] One or more columns to limit results to
   # @return [OpenStruct] The requested character
-  def character(id: nil, all_data: false, data: [], columns: [])
+  def character(id: nil, all_data: false, extended: false, data: [], columns: [])
     params = { data: character_data(all_data, data), columns: [*columns].join(',') }
+    params[:extended] = 1 if extended
     request(self, "character/#{id}", params)
   end
 

diff --git a/lib/xivapi/version.rb b/lib/xivapi/version.rb
@@ -1,4 +1,4 @@
 module XIVAPI
   # Gem version
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end