bgg_remote 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b13c746ba96509bfa7959c390fb604f177eb5c0663312c0038e1485a984ed7cf
-  data.tar.gz: c7b7aba64f3036947cede0af9c7828c703e043066f1cfd30d10a7cc57e8f52f8
+  metadata.gz: 7d574a6f1b8d82304adc264c9d02f9048a6e4402e191ae97ab26760389be8842
+  data.tar.gz: 9556f9e6c9822ae909fa4da90f326050451f6ee894e7043ff64e43812e35d165
 SHA512:
-  metadata.gz: c3511bc789b8823dfdc6ef5648892bb40f29d3fca5be45589981b0a8c0f51bca6bf8f4df24898f57d33a909db84d28ead90828f5a4464d0099002e4c860da9a4
-  data.tar.gz: b6e799f7bc9b8225d4634b39376a5347e601ac4ab631dce5f8a08d0ba796501a4f2126bc3028179ae9533d35274d054c398df098d7553db546c36be72354b101
+  metadata.gz: 685cfbf8b85ea35b40f571c76846b9ffa112de7ceb42ee68d1f115eae6424e91a35e57a4619d8430d7e80e6da9d6054302ba2d161ef95c42098ec5e60e8e5b56
+  data.tar.gz: 340d387999062553e66be9f782868ab2dd376b48d203a535c4df7e34f5c8e556e4fa31393611fcdd4cd02d64a3669c76b4b0c61f24d2c7628c053530a46feea1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
-## [0.1.0] - 2025-12-22
+## [0.1.1] - 2025-12-29
+- Add support for plays lookup without type
+- Improve header handling when token is empty
+- Internal refactor in client initialization
 
+## [0.1.0] - 2025-12-22
 - Initial release

data/README.md

@@ -1,43 +1,82 @@
 # BggRemote
 
-TODO: Delete this and the text below, and describe your gem
+BggRemote is a Ruby client for the [BoardGameGeek XML API](https://boardgamegeek.com/wiki/page/BGG_XML_API2), providing easy access to board game data. It can optionally parse XML responses into Ruby hashes for easier usage.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bgg_remote`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_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.
+Add this line to your application's `Gemfile`:
 
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+gem "bgg_remote", "~> 0.1.0"
 ```
+then execute ```bundle install```
+Or install it yourself as a gem ``` gem install bgg_remote ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+BggRemote.configure do |config|
+  config.token = "your-api-token"
+  config.timeout = 8             # optional, default is 10
+  config.convert_to_hash = true  # optional, set to false if you want raw XML
+end
+
+# Alternatively, minimal configuration:
+# BggRemote.configure do |config|
+#   config.token = "your-api-token"
+# end
+
+bgg_api = BggRemote.api
+bgg_api.thing(id: 21)      # Fetch a boardgame by ID
+bgg_api.user(name: "geek") # Fetch a user by name
 ```
 
-## Usage
+You can also instantiate the client manually if you prefer:
 
-TODO: Write usage instructions here
+```ruby
+client = BggRemote::Client.new("your_api_token", timeout: 21)
+bgg_api = BggRemote::Api.new(client, convert_to_hash: true)
+# convert_to_hash and timeout are optional
 
-## Development
+bgg_api.thing(id: 222)
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## API Endpoints
+- thing(id:, **params)
+- family(id:, type: nil)
+- forum_list(id:, type: nil)
+- forum(id:, page: nil)
+- thread(id:, **params)
+- user(name:, **params)
+- guild(id:, **params)
+- search(query:, **params)
+- plays(username: nil, id: nil, **params) – validates at least one of username or id
+- hot_items(type:)
+- collection(username:, **params)
+
+**Notes:**
+- `**params` can be used for extra parameters, e.g., `bgg_api.thing(id: 3214, stats: 1)`.
+- `stats` is an example of an extra parameter.
+- **Sending Multiple Parameters** \
+Some endpoints support multiple values ​​for a single parameter, such as `id` or `type`. You can pass:
+
+```ruby
+#Multiple values as a comma-separated string:
+BggRemote.api.family(id: "20,111815", type: "boardgamefamily,rpg")
+```
 
-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).
+## Details
+- The API client also provides error classes for retry logic if needed.
+  See: [error.rb](https://github.com/nicollinoxx/bgg_remote/blob/master/lib/bgg_remote/error.rb)
+- This gem uses [HTTParty](https://github.com/jnunemaker/httparty) to make HTTP requests and [Crack](https://github.com/jnunemaker/crack) to parse XML into hashes.  You can choose to receive raw XML instead by setting `convert_to_hash = false`.
+- The gem does not process the XML content itself; it only wraps HTTP requests
+  and optionally converts XML to Ruby hashes.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bgg_remote. 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]/bgg_remote/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/nicollinoxx/bgg_remote. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
 
 ## 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 BggRemote project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bgg_remote/blob/master/CODE_OF_CONDUCT.md).
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/bgg_remote/api.rb

@@ -40,10 +40,10 @@ class BggRemote::Api
     request("search", query: query, **params)
   end
 
-  def plays(username: nil, id: nil, type: nil, **params)
+  def plays(username: nil, id: nil, **params)
     validate_at_least_one_of!(username: username, id: id)
 
-    request("plays", username: username, id: id, type: type, **params)
+    request("plays", username: username, id: id, **params)
   end
 
   def hot_items(type:)

data/lib/bgg_remote/client.rb

@@ -18,10 +18,10 @@ class BggRemote::Client
   }.freeze
 
   def initialize(token, timeout: 10)
-    @token   = token
-    @timeout = timeout || 10
-
     raise BggRemote::Error::MissingToken, "token is required" if token.nil?
+
+    @token   = token
+    @timeout = timeout
   end
 
   def perform_request(path, **params)
@@ -34,7 +34,6 @@ class BggRemote::Client
   private
 
   def headers
-    return { "Accept" => "application/xml" } unless token
     { "Accept" => "application/xml", "Authorization" => "Bearer #{token}" }
   end
 

data/lib/bgg_remote/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BggRemote
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/bgg_remote.rb

@@ -12,11 +12,11 @@ module BggRemote
     attr_reader :api
 
     def configure
-      config ||= Config.new
+      config = Config.new(timeout: 10, convert_to_hash: true)
       yield config if block_given?
 
       client = Client.new(config.token, timeout: config.timeout)
-      @api = Api.new(client, convert_to_hash: config.convert_to_hash)
+      @api   = Api.new(client, convert_to_hash: config.convert_to_hash)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bgg_remote
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nícolas Amaral
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-24 00:00:00.000000000 Z
+date: 2025-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -80,8 +80,8 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '3.26'
-description: A simple Ruby interface to the BoardGameGeek XML API2, providing easy
-  access to board game data with XML parsing to Ruby hashes.
+description: A simple Ruby client to the BoardGameGeek XML API2, providing easy access
+  to board game data with XML parsing to Ruby hashes.
 email:
 - nicolasalmeida321@gmail.com
 executables: []