gw2-api 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0845be116bde90bdf5c52ce92827833310d34c8c368f8e1ac4fe0dc6fb2ddf
-  data.tar.gz: ea61dca98bacef0ba9503b42d9e9a4e2ff0898858dcb365325bdd69e0bec6519
+  metadata.gz: 727a7c4636ce3cf00fee9274cd0e94dbea90cc776285ea67b35e884b5c74a526
+  data.tar.gz: 56956672512cfd2d3b7d8ca2ae63b198f211e4d89988123db0c51adc9889fac5
 SHA512:
-  metadata.gz: 066cc3d59251faa55cbb00da14089cb06dd040fca9086d769f163c4f22d5502d4522575e96371b61fd258bd8723a85934c9137f42500cb0ce15068dd6e91413b
-  data.tar.gz: 68f89fbf24773c971ff221c184ca2b81337c534bcde6597f9f38496a36e951f0fc5f4cdac53e8ea1c90ce7c533200066312a3e0d464027f0a94f28742c45c81f
+  metadata.gz: 22563cf0c46a8568a097887681903e7bd1111e7439820f14b7630aec718fb229a1d27a590c424bc0775b5e76caa4114ded4ac1d24dca66adfb5aacc18b276c38
+  data.tar.gz: aeee440d964e4f95e7ed94a6b716e625ce03704161063dcc4a68a75d83f512b645aa90504374e27a0aba2f4539561b6e2c44ad0fb36db7e5e660b6205748db6b

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: enable
   Exclude:
     - 'gw2-api.gemspec'
   TargetRubyVersion: 2.6
@@ -6,6 +7,9 @@ AllCops:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/ModuleLength:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/Gemfile.lock

@@ -1,16 +1,20 @@
 PATH
   remote: .
   specs:
-    gw2-api (0.5.0)
+    gw2-api (0.7.0)
+      rack (~> 3.0.9.1)
       rake (~> 13.0)
       rspec (~> 3.0)
       rubocop (~> 1.21)
+      simplecov (~> 0.21.2)
+      yard (~> 0.9.36)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     diff-lcs (1.5.1)
+    docile (1.4.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     parallel (1.25.1)
@@ -18,6 +22,7 @@ GEM
       ast (~> 2.4.1)
       racc
     racc (1.8.0)
+    rack (3.0.9.1)
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
@@ -50,8 +55,15 @@ GEM
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     strscan (3.1.0)
     unicode-display_width (2.5.0)
+    yard (0.9.36)
 
 PLATFORMS
   x86_64-linux

data/README.md

@@ -31,6 +31,13 @@ A list of available functions can be found `lib/gw2/modules`.
 
 You can find valid parameters for each function in the [Guild Wars 2 API documentation](https://wiki.guildwars2.com/wiki/API:Main) or from the public [API-CDI](https://github.com/arenanet/api-cdi) repo.
 
+## Docs
+This project uses [YARD](https://yardoc.org/) for documentation. To generate the documentation, execute:
+
+    $ bundle exec yardoc 'lib/**/*.rb' - README.md LICENSE.md
+
+The documentation will be generated in the `doc` directory. You can view the documentation by running `yard server` and visiting `http://localhost:8808` in your browser.
+
 ## Tests
 
 To run the tests, execute:

data/gw2-api.gemspec

@@ -31,8 +31,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rack", "~> 3.0.9.1"
   spec.add_dependency "rake", "~> 13.0"
   spec.add_dependency "rspec", "~> 3.0"
   spec.add_dependency "rubocop", "~> 1.21"
+  spec.add_dependency "simplecov", "~> 0.21.2"
+  spec.add_dependency "yard", "~> 0.9.36"
 
 end

data/lib/gw2/api/version.rb

@@ -2,6 +2,6 @@
 
 module Gw2
   module Api
-    VERSION = "0.5.0"
+    VERSION = "0.7.0"
   end
 end

data/lib/gw2/api.rb

@@ -4,6 +4,8 @@ require_relative "api/version"
 require "net/http"
 require_relative "modules/achievements"
 require_relative "modules/account"
+require_relative "modules/character"
+require_relative "modules/pvp"
 
 module Gw2
   module Api
@@ -20,9 +22,11 @@ module Gw2
     class Client
       include Gw2::Api::Achievements
       include Gw2::Api::Account
+      include Gw2::Api::Characters
+      include Gw2::Api::Pvp
 
       def initialize(args)
-        @api_key = args[:api_key] || ENV["GW2_API_KEY"]
+        @api_key = args[:api_key] || ENV.fetch("GW2_API_KEY", nil)
         @base_url = "https://api.guildwars2.com/v2"
       end
 

data/lib/gw2/modules/account.rb

@@ -29,6 +29,11 @@ module Gw2
         execute_request(request_string)
       end
 
+      # Returns the account daily crafting
+      def account_daily_crafting
+        execute_request("account/dailycrafting")
+      end
+
       # Returns the daily dungeons for the account
       def account_dungeons
         execute_request("account/dungeons")
@@ -71,6 +76,21 @@ module Gw2
         execute_request("account/inventory")
       end
 
+      # Returns the account jadebot skin id unlocks
+      def account_jadebots
+        execute_request("account/jadebots")
+      end
+
+      # Returns the account luck
+      def account_luck
+        execute_request("account/luck")
+      end
+
+      # Returns the account legendary armory unlocks
+      def account_legendary_armory
+        execute_request("account/legendaryarmory")
+      end
+
       # Returns the mail carrier ids unlocked on the account
       def account_mail_carriers
         execute_request("account/mailcarriers")
@@ -101,11 +121,41 @@ module Gw2
         execute_request("account/minis")
       end
 
+      # Alias to account_mounts_skins
+      def account_mount_skins
+        account_mounts_skins
+      end
+
+      # Returns the account mount skins unlocked
+      def account_mounts_skins
+        execute_request("account/mounts/skins")
+      end
+
+      # Alias to account_mounts_types
+      def account_mount_types
+        account_mounts_types
+      end
+
+      # Returns the account mount types unlocked
+      def account_mounts_types
+        execute_request("account/mounts/types")
+      end
+
+      # Returns the account novelties unlocked
+      def account_novelties
+        execute_request("account/novelties")
+      end
+
       # Returns the account outfit ids unlocked
       def account_outfits
         execute_request("account/outfits")
       end
 
+      # Returns the account progression
+      def account_progression
+        execute_request("account/progression")
+      end
+
       # Returns the account pvp hero ids unlocked
       def account_pvp_heroes
         execute_request("account/pvp/heroes")
@@ -121,6 +171,11 @@ module Gw2
         execute_request("account/recipes")
       end
 
+      # Returns the account skiff skin unlocked ids
+      def account_skiffs
+        execute_request("account/skiffs")
+      end
+
       # Returns the account skin ids unlocked
       def account_skins
         execute_request("account/skins")
@@ -135,6 +190,53 @@ module Gw2
       def account_wallet
         execute_request("account/wallet")
       end
+
+      # Returns the wizard vault daily objectives and progress
+      def account_wizardsvault_daily
+        execute_request("account/wizardsvault/daily")
+      end
+
+      # Returns the astral rewards for the account
+      def account_wizardsvault_listings
+        execute_request("account/wizardsvault/listings")
+      end
+
+      # Returnst he wizard vault weekly objectives and progress
+      def account_wizardsvault_weekly
+        execute_request("account/wizardsvault/weekly")
+      end
+
+      # Returns the daily world boss clears for the account
+      def account_worldbosses
+        execute_request("account/worldbosses")
+      end
+
+      # Returns the account trading post transactions
+      def commerce_transactions
+        execute_request("commerce/transactions")
+      end
+
+      # Returns the account characters
+      def account_characters(params = {})
+        execute_with_params("characters", params)
+      end
+
+      # Creates a subtoken of the current api token
+      # @param [Hash] params the options to create the subtoken
+      # Valid Parameters
+      # expires: [String] An ISO-8601 datetime specifing when the generated Subtoken will expire.
+      # The token expiry date may not exceed one year from creation.
+      # Attempting to specify a longer expiry date will result in the expiry being clamped at one year.
+      # permissions: [String] A comma separated list of permissions to grant to the Subtoken.
+      # urls: [String] A comma separated list of URLs that the Subtoken will be restricted to.
+      def create_subtoken(params = {})
+        execute_with_params("createsubtoken", params)
+      end
+
+      # Returns info about the supplied token
+      def token_info(params = {})
+        execute_with_params("tokeninfo", params)
+      end
     end
   end
 end

data/lib/gw2/modules/character.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Gw2
+  module Api
+    # achievements.rb
+    module Characters
+      # Returns the account characters
+      def characters(params = {})
+        execute_with_params("characters", params)
+      end
+
+      def character_backstory(character_id, params = {})
+        execute_with_params("characters/#{character_id}/backstory", params)
+      end
+
+      def character_buildtabs(character_id, params = {})
+        execute_with_params("characters/#{character_id}/buildtabs", params)
+      end
+
+      def character_core(character_id, params = {})
+        execute_with_params("characters/#{character_id}/core", params)
+      end
+
+      def character_crafting(character_id, params = {})
+        execute_with_params("characters/#{character_id}/crafting", params)
+      end
+
+      def character_equipment(character_id, params = {})
+        execute_with_params("characters/#{character_id}/equipment", params)
+      end
+
+      def character_equipmenttabs(character_id, params = {})
+        execute_with_params("characters/#{character_id}/equipmenttabs", params)
+      end
+
+      def character_inventory(character_id, params = {})
+        execute_with_params("characters/#{character_id}/inventory", params)
+      end
+
+      def character_recipes(character_id, params = {})
+        execute_with_params("characters/#{character_id}/recipes", params)
+      end
+
+      def character_skills(character_id, params = {})
+        execute_with_params("characters/#{character_id}/skills", params)
+      end
+
+      def character_specializations(character_id, params = {})
+        execute_with_params("characters/#{character_id}/specializations", params)
+      end
+
+      def character_active_buildtabs(character_id, params = {})
+        execute_with_params("characters/#{character_id}/buildtabs/active", params)
+      end
+
+      def character_active_equipmenttabs(character_id, params = {})
+        execute_with_params("characters/#{character_id}/equipmenttabs/active", params)
+      end
+
+      def character_hero_points(character_id, params = {})
+        execute_with_params("characters/#{character_id}/heropoints", params)
+      end
+
+      def character_quests(character_id, params = {})
+        execute_with_params("characters/#{character_id}/quests", params)
+      end
+
+      def character_sab(character_id, params = {})
+        execute_with_params("characters/#{character_id}/sab", params)
+      end
+    end
+  end
+end

data/lib/gw2/modules/pvp.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gw2
+  module Api
+    # achievements.rb
+    module Pvp
+      # Returns the account characters
+      def pvp_stats(params = {})
+        execute_with_params("pvp/stats", params)
+      end
+
+      # Returns detailed info about recent player games
+      def pvp_games(params = {})
+        execute_with_params("pvp/games", params)
+      end
+
+      # Returns the best and current standing of a player in sPVP
+      def pvp_standings(params = {})
+        execute_with_params("pvp/standings", params)
+      end
+    end
+  end
+end

data/sig/gw2/api/characters.rbs

@@ -0,0 +1,37 @@
+module Gw2
+  module Api
+    module Characters
+      def character_active_buildtabs: -> Net::HTTP
+
+      def character_active_equipmenttabs: -> Net::HTTP
+
+      def character_backstory: -> Net::HTTP
+
+      def character_buildtabs: -> Net::HTTP
+
+      def character_core: -> Net::HTTP
+
+      def character_crafting: -> Net::HTTP
+
+      def character_equipment: -> Net::HTTP
+
+      def character_equipmenttabs: -> Net::HTTP
+
+      def character_hero_points: -> Net::HTTP
+
+      def character_inventory: -> Net::HTTP
+
+      def character_quests: -> Net::HTTP
+
+      def character_recipes: -> Net::HTTP
+
+      def character_sab: -> Net::HTTP
+
+      def character_skills: -> Net::HTTP
+
+      def character_specializations: -> Net::HTTP
+
+      def characters: -> Net::HTTP
+    end
+  end
+end

data/sig/gw2/api/pvp.rbs

@@ -0,0 +1,11 @@
+module Gw2
+  module Api
+    module Pvp
+      def pvp_games: -> Net::HTTP
+
+      def pvp_standings: -> Net::HTTP
+
+      def pvp_stats: -> Net::HTTP
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gw2-api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rob Nicholas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.9.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.36
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.36
 description: This is a wrapper to the Guild Wars 2 API. It is designed to make it
   easier to interact with the API and to provide a more Ruby-like interface to the
   data provided by the API.
@@ -66,7 +108,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - gw2-api.gemspec
@@ -74,10 +116,14 @@ files:
 - lib/gw2/api/version.rb
 - lib/gw2/modules/account.rb
 - lib/gw2/modules/achievements.rb
+- lib/gw2/modules/character.rb
+- lib/gw2/modules/pvp.rb
 - sig/gw2/api.rbs
 - sig/gw2/api/account.rbs
 - sig/gw2/api/achievements.rbs
+- sig/gw2/api/characters.rbs
 - sig/gw2/api/client.rbs
+- sig/gw2/api/pvp.rbs
 homepage: https://github.com/nicholasrobertm/gw2-api
 licenses:
 - MIT
@@ -101,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: This is an API wrapper for the Guild Wars 2 API.