gw2-api 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff8b7a236713ec7ab718626fc956da6d1063e59efa52fce48ff8b864500993f
-  data.tar.gz: ddb30ca1c16e8aeb6b7c146910743d43ec2d6c61881bd57458164749261c1517
+  metadata.gz: f6dcc9e1374f9272f25aeff77172fd2c2f0b4d2e231fb0ed76c06a7fda74721a
+  data.tar.gz: 4d69081af045e6d07245d112c8634917c993460295841de5450733a9f8c20c56
 SHA512:
-  metadata.gz: 97efa70f1ce3643a02fb937be1e8fa7f918351893a1a10a539c15179967f8a036108c43419998e275a49aaf0523d6cec5bf8c47d04a420a3ebfe2395b708241d
-  data.tar.gz: b63f4448a59fbbb5cf538442d30226f4e4732753e846250353b9886885fdf50afda5e62618b5d445c77a11525a50c5ac7942914a3c3feb76473fa2f99326cf06
+  metadata.gz: 1427fbf7900e4c44b60968a9e05686ad9af3e18fbd1d681b85f652f550bfcaf4f8f93e0835eb450e32f7a3be442388b2b8ffb30e1bd5867bcac11af572edaa9e
+  data.tar.gz: a2cb6ba23d89dd5ac73113307f3cc48348cd6cb736c0318ce40fd6503bf9dd74afeda53b662775e112e02e41cd26a766e238bc3914d26bee70eb5243d720d3e0

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.4.0)
       rake (~> 13.0)
       rspec (~> 3.0)
       rubocop (~> 1.21)

data/README.md

@@ -1,59 +1,59 @@
-# Gw2::Api
-
-This is a gem used to make calls to the Guild Wars 2 API.
-
-## Installation
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add gw2-api
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install gw2-api
-
-## Usage
-
-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
-
-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/nicholasrobertm/gw2-api.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Be a decent person, and don't be a jerk, it's that simple!
+# Gw2::Api
+
+This is a gem used to make calls to the Guild Wars 2 API.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add gw2-api
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install gw2-api
+
+## Usage
+
+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
+
+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/nicholasrobertm/gw2-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Be a decent person, and don't be a jerk, it's that simple!

data/Rakefile

@@ -5,8 +5,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+task default: %i[spec]

data/gw2-api.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/gw2/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gw2-api"
+  spec.version = Gw2::Api::VERSION
+  spec.authors = ["Rob Nicholas"]
+  spec.email = ["rob@projectshiba.com"]
+
+  spec.summary = "This is an API wrapper for the Guild Wars 2 API."
+  spec.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."
+  spec.homepage = "https://github.com/nicholasrobertm/gw2-api"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nicholasrobertm/gw2-api"
+  spec.metadata["changelog_uri"] = "https://github.com/nicholasrobertm/gw2-api"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rake", "~> 13.0"
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "rubocop", "~> 1.21"
+
+end

data/lib/gw2/api/version.rb

@@ -2,6 +2,6 @@
 
 module Gw2
   module Api
-    VERSION = "0.2.0"
+    VERSION = "0.4.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.4.0
 platform: ruby
 authors:
 - Rob Nicholas
@@ -69,6 +69,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- gw2-api.gemspec
 - lib/gw2/api.rb
 - lib/gw2/api/version.rb
 - lib/gw2/modules/account.rb
@@ -100,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: This is an API wrapper for the Guild Wars 2 API.