gw2-api 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0f2c8c108757427255fb7802ca45d1a5c6b36197acd5c4f498d0df2421f2188
-  data.tar.gz: 594ee6f6c58ab53349fcf8039287c4c0bbd2723a0164f89e2d4eb98e847f98c9
+  metadata.gz: cfee0a2b4d24bf1eb08c6e21430fc6ccf8667128b539d0a26ef215c21dbb4069
+  data.tar.gz: a753681723c8cce8d0181a72ecafe9d6d2bcb113ada3d13f215920d2d906bb16
 SHA512:
-  metadata.gz: d7ec10329b559efcfd8f19d305baab012952101cdae93882fd56dcee9266a24618920b34ffc97c79df2e42aac6f2ca1c3487eae65ff8929201bc525adcdedd2a
-  data.tar.gz: 47b049252cc2965b71a1bad430aad0e14f68ed29f045a4e0a4ad6a8972c2b6d56e7fa2d8c5cd79e2fdc0d287fea9cf7da1be6042a5519a39740cc797eec080f6
+  metadata.gz: 50ea94f82ef032309231568840e7dacdc2e7f305d20cbbcbc9e56735979f9e7d5371f85fd4b3078b982b9e89a0f7185721d6a542b0201bc3324a90cfc49a0cea
+  data.tar.gz: 9f81bc833ea06259dd8338f9120c613339223c543d32c3ddfdc6057e2d3985e9b835b93ac3a54bc33fecaa85d7633ec16f162c63544c3ecbba6e9db6ea1b399c

data/.rubocop.yml

@@ -1,6 +1,11 @@
 AllCops:
+  Exclude:
+    - 'gw2-api.gemspec'
   TargetRubyVersion: 2.6
 
+Metrics/BlockLength:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gw2-api (0.1.0)
+    gw2-api (0.2.0)
       rake (~> 13.0)
       rspec (~> 3.0)
       rubocop (~> 1.21)

data/README.md

@@ -4,19 +4,41 @@ 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
+    $ bundle add gw2-api
 
 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
+    $ gem install gw2-api
 
 ## Usage
 
-TODO: Write usage instructions here
+To use the gem, first require it in the application, then create a new instance of the `Gw2::Api::Client` class:
+
+```ruby
+require 'gw2-api'
+
+client = Gw2::Api::Client.new(api_key: ENV["GW2_API_KEY"])
+
+puts client.account.body
+puts client.achievements(ids: "1840,910")
+```
+
+You can replace `ENV["GW2_API_KEY"]` with your own API Key, or set the env variable
+
+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.
+
+## Tests
+
+To run the tests, execute:
+
+    $ bundle exec rspec
+
+Note that you need to set a valid API key in the environment variable `GW2_API_KEY` to run the tests.
+GW2's API Availability can affect the result of the tests (if it's down, the tests will fail).
 
 ## Development
 
@@ -26,7 +48,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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).
+Bug reports and pull requests are welcome on GitHub at https://github.com/nicholasrobertm/gw2-api.
 
 ## License
 
@@ -34,4 +56,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+Be a decent person, and don't be a jerk, it's that simple!

data/lib/gw2/api/version.rb

@@ -2,6 +2,6 @@
 
 module Gw2
   module Api
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/gw2/api.rb

@@ -7,28 +7,34 @@ require_relative "modules/account"
 
 module Gw2
   module Api
+    # Used to create a client to talk to the Guild Wars 2 API
+    # Arguments
+    # @args [Hash] the arguments to create the client
+    # Valid Arguments
+    # - api_key: [String] the api key to use for the client, defaults to ENV["GW2_API_KEY"]
+    # Variables
+    # @api_key [String] the api key to use for the client
+    # @base_url [String] the base url for the API
+    # See modules for available methods
+    # See https://wiki.guildwars2.com/wiki/API:Main
     class Client
-
       include Gw2::Api::Achievements
       include Gw2::Api::Account
 
       def initialize(args)
-        @api_key = args[:api_key]
+        @api_key = args[:api_key] || ENV["GW2_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)
+      def execute_with_params(endpoint, parameters)
         output = endpoint
 
-        return execute_request(output) if params.empty?
+        return execute_request(output) if parameters.empty?
 
         output += "?"
-        params.each do |key, value|
-          output += "#{key.to_s}=#{value}&"
+        parameters.each do |key, value|
+          output += "#{key}=#{value}&"
         end
         execute_request(output)
       end
@@ -45,7 +51,6 @@ module Gw2
           http.request(request)
         end
       end
-
     end
   end
 end

data/lib/gw2/modules/account.rb

@@ -17,7 +17,7 @@ module Gw2
       # - 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)
+        execute_with_params("account/achievements", params)
       end
 
       # Returns the account bank
@@ -135,7 +135,6 @@ module Gw2
       def account_wallet
         execute_request("account/wallet")
       end
-
     end
   end
 end

data/lib/gw2/modules/achievements.rb

@@ -13,7 +13,7 @@ module Gw2
       # - page: [String] the page number to filter
       # - page_size: [String] the page size to filter
       def achievements(params = {})
-        execute_with_params('achievements', params)
+        execute_with_params("achievements", params)
       end
 
       # Returns the achievements groups
@@ -24,7 +24,7 @@ module Gw2
       # - 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)
+        execute_with_params("achievements/groups", params)
       end
 
       # Returns the achievements categories
@@ -34,9 +34,8 @@ module Gw2
       # - 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)
+        execute_with_params("achievements/categories", params)
       end
-
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gw2-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rob Nicholas