gw2-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff8b7a236713ec7ab718626fc956da6d1063e59efa52fce48ff8b864500993f
-  data.tar.gz: ddb30ca1c16e8aeb6b7c146910743d43ec2d6c61881bd57458164749261c1517
+  metadata.gz: cfee0a2b4d24bf1eb08c6e21430fc6ccf8667128b539d0a26ef215c21dbb4069
+  data.tar.gz: a753681723c8cce8d0181a72ecafe9d6d2bcb113ada3d13f215920d2d906bb16
 SHA512:
-  metadata.gz: 97efa70f1ce3643a02fb937be1e8fa7f918351893a1a10a539c15179967f8a036108c43419998e275a49aaf0523d6cec5bf8c47d04a420a3ebfe2395b708241d
-  data.tar.gz: b63f4448a59fbbb5cf538442d30226f4e4732753e846250353b9886885fdf50afda5e62618b5d445c77a11525a50c5ac7942914a3c3feb76473fa2f99326cf06
+  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/lib/gw2/api/version.rb

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

data/lib/gw2/api.rb

@@ -7,8 +7,17 @@ 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
 
@@ -18,17 +27,14 @@ module Gw2
       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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rob Nicholas