howlongtobeat 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef5a11f2d4eb82426ed1c0e6312a824381798af62a77425fa3bd39671a9d7080
-  data.tar.gz: b16931671e18bfd16a02a4072dd124a089549fa9dbd0af7bcddb76e693bbe388
+  metadata.gz: dade03f5e29eecc43b780f4721d6843fee4033a1a5d374ad65adbfcf9510cd21
+  data.tar.gz: 51ce4b254c4f8c8923ba56b5dacb97e8981437b449de4285c7e29f1856aa111e
 SHA512:
-  metadata.gz: b39fcf8b55b15bac316188010468528576b2c0abbec0ca69c9a29eed9fa3be32cfc38fdfb5c03425705522a9807f87da76170821cb0adbb7eb2c0bca0835e8cc
-  data.tar.gz: 77bfcbc196915c9c253db36313ed97ed404d627d14232fd2ca1439307d46a367b7dc8a29865d6deff8a68bf2b4662bc720487dfd41e72958a7f317231f82475d
+  metadata.gz: 9fb70b3b35d2a6465f37a063f2c34338dd82284ccc1e0aa684361d0a28d8028a129db8b1ea653f66fd24f9f4206284f835c5dce3f02d32e47ff3b2158b1f50ec
+  data.tar.gz: b90d809192fd9b481c837f75c53684dca44b788dcf6fbe2aaa4558203e891fb958e3e018d1e5a69b2c521cd62ede9af314539714f27c39de4f837222b0231d15

data/CHANGELOG.md

@@ -8,11 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
-- Initial release
-- Basic search functionality
-- Search by ID functionality
-- Search modifiers support
-- Similarity filtering
+- None
 
 ### Changed
 - None
@@ -29,10 +25,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 - None
 
-## [0.1.0] - 2025-03-06
+## [0.2.0] - 2025-12-13
 
-- Initial release
+### Changed
+- Updated authentication to use token-based API (`/api/search/init`)
+- Improved request headers to match API requirements
+
+### Fixed
+- Fixed search functionality to work with HowLongToBeat.com's updated API
 
 ## [0.1.2] - 2025-03-06
 
 - Update Ruby requirement version
+
+## [0.1.0] - 2025-03-06
+
+- Initial release
+- Basic search functionality
+- Search by ID functionality
+- Search modifiers support
+- Similarity filtering

data/README.md

@@ -1,5 +1,7 @@
 # HowLongToBeat Ruby API
 
+![CI](https://github.com/dpashutskii/howlongtobeat/actions/workflows/ci.yml/badge.svg)
+
 A simple Ruby API to read data from howlongtobeat.com.
 
 It is inspired by [ScrappyCocco's HowLongToBeat Python API](https://github.com/ScrappyCocco/HowLongToBeat-PythonAPI).
@@ -35,15 +37,37 @@ results = hltb.search("The Witcher 3")
 
 The `search` method returns an array of possible games, or `nil` if no results were found or there was an error in the request.
 
-Each result is a `HowLongToBeat::Entry` object containing:
-- `id`: The game's ID on HowLongToBeat
-- `name`: The game's name
-- `description`: Game description
-- `main_story`: Main story completion time
-- `main_plus_sides`: Main story + side quests completion time
-- `completionist`: 100% completion time
-- `all_styles`: Average time across all playstyles
-- `similarity`: How closely the game name matches the search query (0.0 to 1.0)
+Each result is an [`HowLongToBeatEntry`](https://github.com/dpashutskii/howlongtobeat/blob/main/lib/howlongtobeat/how_long_to_beat_entry.rb) object containing:
+
+#### Base Game Details
+- `game_id`: The game's ID on HowLongToBeat (Integer)
+- `game_name`: The game's name (String)
+- `game_alias`: Alternative names for the game (String)
+- `game_type`: Type of content (e.g., "game", "dlc") (String)
+- `game_image_url`: URL to the game's cover image (String)
+- `game_web_link`: URL to the game's HowLongToBeat page (String)
+- `review_score`: User review score (Integer, 0-100)
+- `profile_dev`: Developer information (String)
+- `profile_platforms`: Available platforms (Array of Strings)
+- `release_world`: Release year (Integer)
+
+#### Completion Times (all in hours)
+- `main_story`: Main story completion time (Float)
+- `main_extra`: Main story + side quests completion time (Float)
+- `completionist`: 100% completion time (Float)
+- `all_styles`: Average time across all playstyles (Float)
+- `coop_time`: Co-op gameplay time (Float)
+- `mp_time`: Multiplayer gameplay time (Float)
+
+#### Complexity Flags
+- `complexity_lvl_combine`: Combined gameplay complexity (Boolean)
+- `complexity_lvl_sp`: Single-player complexity (Boolean)
+- `complexity_lvl_co`: Co-op complexity (Boolean)
+- `complexity_lvl_mp`: Multiplayer complexity (Boolean)
+
+#### Other
+- `similarity`: How closely the game name matches the search query (Float, 0.0 to 1.0)
+- `json_content`: Raw JSON data from the API (Hash)
 
 ### Search by ID
 
@@ -53,7 +77,7 @@ You can also search for a game using its HowLongToBeat ID:
 result = hltb.search_from_id(10270)  # The Witcher 3: Wild Hunt
 ```
 
-This returns a single `Entry` object or `nil` if not found.
+This returns a single [`HowLongToBeatEntry`](https://github.com/dpashutskii/howlongtobeat/blob/main/lib/howlongtobeat/how_long_to_beat_entry.rb) object or `nil` if not found.
 
 ### Search Modifiers
 
@@ -85,6 +109,10 @@ hltb = HowLongToBeat::HowLongToBeat.new(0.7)
 results = hltb.search("The Witcher 3")
 ```
 
+## Who's Using It
+
+This gem was originally created for and is being used by [SearchToPlay](https://searchtoplay.com), a platform that helps gamers discover and track their gaming journey.
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.

data/lib/howlongtobeat/html_requests.rb

@@ -66,7 +66,8 @@ module HowLongToBeat
           'content-type' => 'application/json',
           'accept' => '*/*',
           'User-Agent' => random_user_agent,
-          'referer' => REFERER_HEADER
+          'referer' => REFERER_HEADER,
+          'origin' => BASE_URL
         }
       end
 
@@ -116,27 +117,12 @@ module HowLongToBeat
       end
 
       def send_web_request(game_name, search_modifiers = SearchModifiers::NONE, page = 1)
-        headers = get_search_request_headers
-        search_info = send_website_request_getcode(false)
-        search_info ||= send_website_request_getcode(true)
-
-        return nil unless search_info&.api_key
-
-        if search_info.search_url
-          search_url = "#{BASE_URL}/#{search_info.search_url}"
-        else
-          search_url = SEARCH_URL
-        end
+        token = fetch_search_token
+        return nil unless token
 
-        # Try with API key in URL
-        search_url_with_key = "#{search_url}/#{search_info.api_key}"
+        headers = get_search_request_headers.merge('x-auth-token' => token)
         payload = get_search_request_data(game_name, search_modifiers, page)
-        response = make_request(search_url_with_key, headers, payload)
-        return response if response
-
-        # Fallback to standard search with API key in payload
-        payload = get_search_request_data(game_name, search_modifiers, page, search_info)
-        make_request(search_url, headers, payload)
+        make_request(SEARCH_URL, headers, payload)
       end
 
       def get_game_title(game_id)
@@ -156,6 +142,18 @@ module HowLongToBeat
 
       private
 
+      def fetch_search_token
+        url = "#{BASE_URL}/api/search/init?t=#{Time.now.to_i}"
+        headers = get_title_request_headers
+        response = make_get_request(url, headers)
+        return nil unless response
+
+        json = JSON.parse(response) rescue nil
+        json.is_a?(Hash) ? json['token'] : nil
+      rescue StandardError
+        nil
+      end
+
       def send_website_request_getcode(parse_all_scripts)
         headers = get_title_request_headers
         response = make_get_request(BASE_URL, headers)

data/lib/howlongtobeat/version.rb

@@ -1,3 +1,3 @@
 module HowLongToBeat
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howlongtobeat
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dmitrii Pashutskii
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby client for HowLongToBeat.com