gw2-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0f2c8c108757427255fb7802ca45d1a5c6b36197acd5c4f498d0df2421f2188
+  data.tar.gz: 594ee6f6c58ab53349fcf8039287c4c0bbd2723a0164f89e2d4eb98e847f98c9
+SHA512:
+  metadata.gz: d7ec10329b559efcfd8f19d305baab012952101cdae93882fd56dcee9266a24618920b34ffc97c79df2e42aac6f2ca1c3487eae65ff8929201bc525adcdedd2a
+  data.tar.gz: 47b049252cc2965b71a1bad430aad0e14f68ed29f045a4e0a4ad6a8972c2b6d56e7fa2d8c5cd79e2fdc0d287fea9cf7da1be6042a5519a39740cc797eec080f6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gw2-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    gw2-api (0.1.0)
+      rake (~> 13.0)
+      rspec (~> 3.0)
+      rubocop (~> 1.21)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.0)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  gw2-api!
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Rob Nicholas
+
+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,37 @@
+# Gw2::Api
+
+This is a gem used to make calls to the Guild Wars 2 API.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gw2-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/gw2-api/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gw2::Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gw2-api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/gw2/api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gw2
+  module Api
+    VERSION = "0.1.0"
+  end
+end

data/lib/gw2/api.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "api/version"
+require "net/http"
+require_relative "modules/achievements"
+require_relative "modules/account"
+
+module Gw2
+  module Api
+    class Client
+
+      include Gw2::Api::Achievements
+      include Gw2::Api::Account
+
+      def initialize(args)
+        @api_key = args[:api_key]
+        @base_url = "https://api.guildwars2.com/v2"
+      end
+
+      # Executes a request with parameters
+      # @endpoint [String] the endpoint to request, e.g. achievements
+      # @params [Hash] the parameters to filter the request
+      # @return [Net::HTTP] the response from the request
+      def execute_with_params(endpoint, params)
+        output = endpoint
+
+        return execute_request(output) if params.empty?
+
+        output += "?"
+        params.each do |key, value|
+          output += "#{key.to_s}=#{value}&"
+        end
+        execute_request(output)
+      end
+
+      # Executes a request
+      # @endpoint [String] the endpoint to request, e.g. achievements
+      # @return [Net::HTTP] the response from the request
+      def execute_request(endpoint)
+        uri = URI("#{@base_url}/#{endpoint}")
+        request = Net::HTTP::Get.new(uri)
+        request["Authorization"] = "Bearer #{@api_key}"
+
+        Net::HTTP.start(request.uri.hostname, request.uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+      end
+
+    end
+  end
+end

data/lib/gw2/modules/account.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Gw2
+  module Api
+    # achievements.rb
+    module Account
+      # Returns the account information
+      def account
+        execute_request("account")
+      end
+
+      # Returns the account achievements
+      # @param [Hash] params the options to filter the achievements
+      # Valid Parameters
+      # - id: [String] the id of the achievement to filter
+      # - ids: [String] the ids of the achievements to filter comma seperated
+      # - page: [String] the page number to filter
+      # - page_size: [String] the page size to filter
+      def account_achievements(params = {})
+        execute_with_params('account/achievements', params)
+      end
+
+      # Returns the account bank
+      # Empty slots are represented by null
+      # Slot is indicated by the index of the array
+      def account_bank
+        request_string = "account/bank"
+
+        execute_request(request_string)
+      end
+
+      # Returns the daily dungeons for the account
+      def account_dungeons
+        execute_request("account/dungeons")
+      end
+
+      # Returns the dye ids unlocked on the account
+      def account_dyes
+        execute_request("account/dyes")
+      end
+
+      # Returns the finisher ids unlocked on the account
+      def account_finishers
+        execute_request("account/finishers")
+      end
+
+      # Returns the glider IDs unlocked on the account
+      def account_gliders
+        execute_request("account/gliders")
+      end
+
+      # Returns the cat unlocks for the home instance on the account
+      def account_home_cats
+        execute_request("account/home/cats")
+      end
+
+      # Returns the nodes unlocked for the home instance on the account
+      def account_home_nodes
+        execute_request("account/home/nodes")
+      end
+
+      # Alias to account_shared_inventory
+      def account_inventory
+        account_shared_inventory
+      end
+
+      # Returns the shared inventory slots for the account
+      # Empty slots are represented by null
+      # Slot is indicated by the index of the array
+      def account_shared_inventory
+        execute_request("account/inventory")
+      end
+
+      # Returns the mail carrier ids unlocked on the account
+      def account_mail_carriers
+        execute_request("account/mailcarriers")
+      end
+
+      # Returns the masteries unlocked on the account
+      def account_masteries
+        execute_request("account/masteries")
+      end
+
+      # Returns the mastery points earned / spent on the account
+      def account_mastery_points
+        execute_request("account/mastery/points")
+      end
+
+      # Returns the account materials
+      # Array index indicates the slot
+      # Empty slots are represented by a count of 0
+      # @param [Hash] params the options to filter the materials
+      # Valid Parameters
+      # ids: [String] the ids of the materials to filter comma seperated, can optionally use 'all' to get all of them
+      def account_materials(params = {})
+        execute_with_params("account/materials", params)
+      end
+
+      # Returns the account mini ids unlocked
+      def account_minis
+        execute_request("account/minis")
+      end
+
+      # Returns the account outfit ids unlocked
+      def account_outfits
+        execute_request("account/outfits")
+      end
+
+      # Returns the account pvp hero ids unlocked
+      def account_pvp_heroes
+        execute_request("account/pvp/heroes")
+      end
+
+      # Returns the account weekly raid progress
+      def account_raids
+        execute_request("account/raids")
+      end
+
+      # Returns the account recipe ids unlocked
+      def account_recipes
+        execute_request("account/recipes")
+      end
+
+      # Returns the account skin ids unlocked
+      def account_skins
+        execute_request("account/skins")
+      end
+
+      # Returns the account title ids unlocked
+      def account_titles
+        execute_request("account/titles")
+      end
+
+      # Returns the account currencies to the amount of currency the account has
+      def account_wallet
+        execute_request("account/wallet")
+      end
+
+    end
+  end
+end

data/lib/gw2/modules/achievements.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Gw2
+  module Api
+    # achievements.rb
+    # This module is responsible for methods for querying information about achievements
+    module Achievements
+      # Returns the achievements
+      # @param [Hash] params the options to filter the achievements
+      # Valid Parameters
+      # - id: [String] the id of the achievement to filter
+      # - ids: [String] the ids of the achievements to filter comma seperated
+      # - page: [String] the page number to filter
+      # - page_size: [String] the page size to filter
+      def achievements(params = {})
+        execute_with_params('achievements', params)
+      end
+
+      # Returns the achievements groups
+      # @param [Hash] params the options to filter the achievements
+      # Valid Parameters
+      # - id: [String] the id of the achievement to filter
+      # - ids: [String] the ids of the achievements to filter comma seperated
+      # - page: [String] the page number to filter
+      # - page_size: [String] the page size to filter
+      def achievements_groups(params = {})
+        execute_with_params('achievements/groups', params)
+      end
+
+      # Returns the achievements categories
+      # @param [Hash] params the options to filter the achievements
+      # Valid Parameters
+      # - id: [String] the id of the achievement to filter
+      # - ids: [String] the ids of the achievements to filter comma seperated
+      # - page: [String] the page number to filter
+      def achievements_categories(params = {})
+        execute_with_params('achievements/categories', params)
+      end
+
+    end
+  end
+end

data/sig/gw2/api/account.rbs

@@ -0,0 +1,51 @@
+module Gw2
+  module Api
+    module Account
+      def account: -> Net::HTTP
+
+      def account_achievements: -> Net::HTTP
+
+      def account_bank: -> Net::HTTP
+
+      def account_dungeons: -> Net::HTTP
+
+      def account_dyes: -> Net::HTTP
+
+      def account_finishers: -> Net::HTTP
+
+      def account_gliders: -> Net::HTTP
+
+      def account_home_cats: -> Net::HTTP
+
+      def account_home_nodes: -> Net::HTTP
+
+      def account_inventory: -> Net::HTTP
+
+      def account_mail_carriers: -> Net::HTTP
+
+      def account_masteries: -> Net::HTTP
+
+      def account_mastery_points: -> Net::HTTP
+
+      def account_materials: -> Net::HTTP
+
+      def account_minis: -> Net::HTTP
+
+      def account_outfits: -> Net::HTTP
+
+      def account_pvp_heroes: -> Net::HTTP
+
+      def account_raids: -> Net::HTTP
+
+      def account_recipes: -> Net::HTTP
+
+      def account_shared_inventory: -> Net::HTTP
+
+      def account_skins: -> Net::HTTP
+
+      def account_titles: -> Net::HTTP
+
+      def account_wallet: -> Net::HTTP
+    end
+  end
+end

data/sig/gw2/api/achievements.rbs

@@ -0,0 +1,12 @@
+module Gw2
+  module Api
+    module Achievements
+      def achievements: -> Net::HTTP
+
+      def achievements_categories: -> Net::HTTP
+
+      def achievements_groups: -> Net::HTTP
+
+    end
+  end
+end

data/sig/gw2/api/client.rbs

@@ -0,0 +1,9 @@
+module Gw2
+  module Api
+    class Client
+      def execute_request: -> Net::HTTP
+
+      def execute_with_params: -> Net::HTTP
+    end
+  end
+end

data/sig/gw2/api.rbs

@@ -0,0 +1,6 @@
+module Gw2
+  module Api
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: gw2-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Nicholas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+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.
+email:
+- rob@projectshiba.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/gw2/api.rb
+- lib/gw2/api/version.rb
+- lib/gw2/modules/account.rb
+- lib/gw2/modules/achievements.rb
+- sig/gw2/api.rbs
+- sig/gw2/api/account.rbs
+- sig/gw2/api/achievements.rbs
+- sig/gw2/api/client.rbs
+homepage: https://github.com/nicholasrobertm/gw2-api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nicholasrobertm/gw2-api
+  source_code_uri: https://github.com/nicholasrobertm/gw2-api
+  changelog_uri: https://github.com/nicholasrobertm/gw2-api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: This is an API wrapper for the Guild Wars 2 API.
+test_files: []