nexus_mods 0.1.1 → 0.3.0

data/spec/nexus_mods_test/helpers.rb

@@ -1,9 +1,12 @@
 require 'digest'
 require 'webmock/rspec'
 require 'rspec/support/object_formatter'
+require 'nexus_mods_test/factories/games'
+require 'nexus_mods_test/factories/mods'
+require 'nexus_mods_test/factories/mod_files'
 require 'nexus_mods'
 
-module NexusModsTests
+module NexusModsTest
 
   module Helpers
 
@@ -72,6 +75,7 @@ module NexusModsTests
     # * *message* (String): Mocked returned message [default: 'OK']
     # * *json* (Object): Mocked JSON body [default: {}]
     # * *headers* (Hash<String,String>): Mocked additional HTTP headers [default: {}]
+    # * *times* (Integer): Number of times the call is expected [default: 1]
     def expect_http_call_to(
       host: 'api.nexusmods.com',
       http_method: :get,
@@ -80,7 +84,8 @@ module NexusModsTests
       code: 200,
       message: 'OK',
       json: {},
-      headers: {}
+      headers: {},
+      times: 1
     )
       json_as_str = json.to_json
       mocked_etag = "W/\"#{Digest::MD5.hexdigest("#{path}|#{json_as_str}")}\""
@@ -93,19 +98,25 @@ module NexusModsTests
       else
         @expected_returned_etags << mocked_etag
       end
-      stub_request(http_method, "https://#{host}#{path}").with(headers: expected_request_headers).to_return(
-        status: [code, message],
-        body: json_as_str,
-        headers: DEFAULT_API_HEADERS.
-          merge(
-            'etag' => mocked_etag
-          ).
-          merge(headers)
-      )
+      @expected_stubs << [
+        stub_request(http_method, "https://#{host}#{path}").with(headers: expected_request_headers).to_return(
+          status: [code, message],
+          body: json_as_str,
+          headers: DEFAULT_API_HEADERS.
+            merge(
+              'etag' => mocked_etag
+            ).
+            merge(headers)
+        ),
+        times
+      ]
     end
 
     # Expect a successfull call made to validate the user
-    def expect_validate_user
+    #
+    # Parameters::
+    # * *times* (Integer): Number of times the call is expected [default: 1]
+    def expect_validate_user(times: 1)
       expect_http_call_to(
         path: '/v1/users/validate.json',
         json: {
@@ -118,7 +129,8 @@ module NexusModsTests
           profile_url: 'https://www.nexusmods.com/Contents/Images/noavatar.gif',
           is_supporter: false,
           is_premium: false
-        }
+        },
+        times:
       )
     end
 
@@ -127,12 +139,25 @@ module NexusModsTests
 end
 
 RSpec.configure do |config|
-  config.include NexusModsTests::Helpers
+  config.include NexusModsTest::Helpers
+  config.include NexusModsTest::Factories::Games
+  config.include NexusModsTest::Factories::Mods
+  config.include NexusModsTest::Factories::ModFiles
   config.before do
     @nexus_mods = nil
+    # Reload the ApiClient as it stores caches at class level
+    NexusMods::ApiClient.clear_cacheable_expiry_caches
     # Keep a list of the etags we should have returned, so that we know when queries should contain them
     # Array<String>
     @expected_returned_etags = []
+    # List of expected stubs and the number of times they were supposed to mock
+    # Array< [ WebMock::RequestStub, Integer ] >
+    @expected_stubs = []
+  end
+  config.after do
+    @expected_stubs.each do |(stub, times)|
+      expect(stub).to have_been_made.times(times)
+    end
   end
 end
 

data/spec/nexus_mods_test/scenarios/nexus_mods/{api_limits_spec.rb → api/api_limits_spec.rb}

@@ -1,10 +1,9 @@
-describe NexusMods::ApiLimits do
+describe NexusMods::Api::ApiLimits do
 
   context 'when testing API limits' do
 
     it 'gets api limits' do
-      expect_validate_user
-      expect_validate_user
+      expect_validate_user(times: 2)
       api_limits = nexus_mods.api_limits
       expect(api_limits.daily_limit).to eq 2500
       expect(api_limits.daily_remaining).to eq 2500
@@ -14,6 +13,14 @@ describe NexusMods::ApiLimits do
       expect(api_limits.hourly_reset).to eq Time.parse('2019-10-02T16:00:00+00:00')
     end
 
+    it 'compares objects for equality' do
+      expect_validate_user(times: 3)
+      api_limits1 = nexus_mods.api_limits
+      api_limits2 = nexus_mods.api_limits
+      expect(api_limits1.object_id).not_to eq api_limits2.object_id
+      expect(api_limits1).to eq api_limits2
+    end
+
   end
 
 end

data/spec/nexus_mods_test/scenarios/nexus_mods/api/game_spec.rb

@@ -0,0 +1,93 @@
+describe NexusMods::Api::Game do
+
+  context 'when testing games' do
+
+    before do
+      expect_validate_user
+    end
+
+    it 'returns the games list' do
+      expect_http_call_to(
+        path: '/v1/games.json',
+        json: [
+          json_game100,
+          json_game101
+        ]
+      )
+      games = nexus_mods.games.sort_by(&:id)
+      expect(games.size).to eq 2
+      expect_game_to_be_game100(games.first)
+      expect_game_to_be_game101(games[1])
+    end
+
+    it 'returns a game having missing parent category' do
+      expect_http_call_to(
+        path: '/v1/games.json',
+        json: [
+          {
+            'id' => 100,
+            'name' => 'Morrowind',
+            'forum_url' => 'https://forums.nexusmods.com/index.php?/forum/111-morrowind/',
+            'nexusmods_url' => 'http://www.nexusmods.com/morrowind',
+            'genre' => 'RPG',
+            'file_count' => 14_143,
+            'downloads' => 20_414_985,
+            'domain_name' => 'morrowind',
+            'approved_date' => 1,
+            'file_views' => 100_014_750,
+            'authors' => 2062,
+            'file_endorsements' => 719_262,
+            'mods' => 6080,
+            'categories' => [
+              {
+                'category_id' => 1,
+                'name' => 'Morrowind',
+                'parent_category' => false
+              },
+              {
+                'category_id' => 2,
+                'name' => 'Buildings',
+                'parent_category' => 3
+              }
+            ]
+          }
+        ]
+      )
+      game = nexus_mods.games.first
+      expect(game.id).to eq 100
+      expect(game.name).to eq 'Morrowind'
+      expect(game.forum_url).to eq 'https://forums.nexusmods.com/index.php?/forum/111-morrowind/'
+      expect(game.nexusmods_url).to eq 'http://www.nexusmods.com/morrowind'
+      expect(game.genre).to eq 'RPG'
+      expect(game.files_count).to eq 14_143
+      expect(game.downloads_count).to eq 20_414_985
+      expect(game.domain_name).to eq 'morrowind'
+      expect(game.approved_date).to eq Time.parse('1970-01-01 00:00:01 +0000')
+      expect(game.files_views).to eq 100_014_750
+      expect(game.authors_count).to eq 2062
+      expect(game.files_endorsements).to eq 719_262
+      expect(game.mods_count).to eq 6080
+      game_categories = game.categories
+      expect(game_categories.size).to eq 2
+      expect(game_categories.first.id).to eq 1
+      expect(game_categories.first.name).to eq 'Morrowind'
+      expect(game_categories.first.parent_category).to be_nil
+      expect(game_categories[1].id).to eq 2
+      expect(game_categories[1].name).to eq 'Buildings'
+      expect(game_categories[1].parent_category).to be_nil
+    end
+
+    it 'compares objects for equality' do
+      expect_http_call_to(
+        path: '/v1/games.json',
+        json: [json_game100]
+      )
+      game1 = nexus_mods.games.first
+      game2 = nexus_mods.games.first
+      expect(game1.object_id).not_to eq game2.object_id
+      expect(game1).to eq game2
+    end
+
+  end
+
+end

data/spec/nexus_mods_test/scenarios/nexus_mods/api/mod_file_spec.rb

@@ -0,0 +1,73 @@
+describe NexusMods::Api::ModFile do
+
+  context 'when testing mod files' do
+
+    before do
+      expect_validate_user
+    end
+
+    # Example of JSON object returned by the API for a mod files list
+    let(:json_example_mod_files) do
+      [
+        json_mod_file2472,
+        json_mod_file2487
+      ]
+    end
+
+    # Expect a mod's files to be the example ones
+    #
+    # Parameters::
+    # * *mod_files* (Array<NexusMods::Api::File>): List of files to validate
+    def expect_mod_files_to_be_example(mod_files)
+      expect(mod_files.size).to eq 2
+      sorted_mod_files = mod_files.sort_by(&:id)
+      expect_mod_file_to_be2472(sorted_mod_files.first)
+      expect_mod_file_to_be2487(sorted_mod_files[1])
+    end
+
+    it 'returns a mod files list' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      expect_mod_files_to_be_example(nexus_mods.mod_files(game_domain_name: 'skyrimspecialedition', mod_id: 2014))
+    end
+
+    it 'returns the default mod files list' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      expect_mod_files_to_be_example(nexus_mods(mod_id: 2014).mod_files(game_domain_name: 'skyrimspecialedition'))
+    end
+
+    it 'returns mod files list for the default game' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      expect_mod_files_to_be_example(nexus_mods(game_domain_name: 'skyrimspecialedition').mod_files(mod_id: 2014))
+    end
+
+    it 'returns mod files list for the default game and mod' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      expect_mod_files_to_be_example(nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod_files)
+    end
+
+    it 'compares objects for equality' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: [json_mod_file2472] }
+      )
+      mod_file1 = nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod_files.first
+      mod_file2 = nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod_files.first
+      expect(mod_file1.object_id).not_to eq mod_file2.object_id
+      expect(mod_file1).to eq mod_file2
+    end
+
+  end
+
+end

data/spec/nexus_mods_test/scenarios/nexus_mods/api/mod_spec.rb

@@ -0,0 +1,62 @@
+describe NexusMods::Api::Mod do
+
+  context 'when testing mods' do
+
+    before do
+      expect_validate_user
+    end
+
+    it 'returns a mod complete information' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      expect_mod_to_be_complete(nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014))
+    end
+
+    it 'returns a mod partial information' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_partial_mod
+      )
+      expect_mod_to_be_partial(nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014))
+    end
+
+    it 'returns the default mod information' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      expect_mod_to_be_complete(nexus_mods(mod_id: 2014).mod(game_domain_name: 'skyrimspecialedition'))
+    end
+
+    it 'returns mod information for the default game' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      expect_mod_to_be_complete(nexus_mods(game_domain_name: 'skyrimspecialedition').mod(mod_id: 2014))
+    end
+
+    it 'returns mod information for the default game and mod' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      expect_mod_to_be_complete(nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod)
+    end
+
+    it 'compares objects for equality' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      mod1 = nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014)
+      mod2 = nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014)
+      expect(mod1.object_id).not_to eq mod2.object_id
+      expect(mod1).to eq mod2
+    end
+
+  end
+
+end

data/spec/nexus_mods_test/scenarios/nexus_mods_caching_spec.rb

@@ -0,0 +1,88 @@
+describe NexusMods do
+
+  context 'when testing caching' do
+
+    it 'does not cache user queries' do
+      expect_validate_user(times: 3)
+      nexus_mods.api_limits
+      nexus_mods.api_limits
+    end
+
+    it 'caches games queries' do
+      expect_validate_user
+      expect_http_call_to(
+        path: '/v1/games.json',
+        json: [
+          json_game100,
+          json_game101
+        ]
+      )
+      games = nexus_mods.games
+      expect(nexus_mods.games).to eq(games)
+    end
+
+    it 'caches mod queries' do
+      expect_validate_user
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      mod = nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014)
+      expect(nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014)).to eq(mod)
+    end
+
+    it 'caches mod files queries' do
+      expect_validate_user
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: [json_mod_file2472, json_mod_file2487] }
+      )
+      mod_files = nexus_mods.mod_files(game_domain_name: 'skyrimspecialedition', mod_id: 2014)
+      expect(nexus_mods.mod_files(game_domain_name: 'skyrimspecialedition', mod_id: 2014)).to eq(mod_files)
+    end
+
+    it 'expires games queries cache' do
+      expect_validate_user
+      expect_http_call_to(
+        path: '/v1/games.json',
+        json: [
+          json_game100,
+          json_game101
+        ],
+        times: 2
+      )
+      nexus_mods_instance = nexus_mods(api_cache_expiry: { games: 1 })
+      games = nexus_mods_instance.games
+      sleep 2
+      expect(nexus_mods_instance.games).to eq(games)
+    end
+
+    it 'expires mod queries cache' do
+      expect_validate_user
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod,
+        times: 2
+      )
+      nexus_mods_instance = nexus_mods(api_cache_expiry: { mod: 1 })
+      mod = nexus_mods_instance.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014)
+      sleep 2
+      expect(nexus_mods_instance.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014)).to eq(mod)
+    end
+
+    it 'expires mod files queries cache' do
+      expect_validate_user
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: [json_mod_file2472, json_mod_file2487] },
+        times: 2
+      )
+      nexus_mods_instance = nexus_mods(api_cache_expiry: { mod_files: 1 })
+      mod_files = nexus_mods_instance.mod_files(game_domain_name: 'skyrimspecialedition', mod_id: 2014)
+      sleep 2
+      expect(nexus_mods_instance.mod_files(game_domain_name: 'skyrimspecialedition', mod_id: 2014)).to eq(mod_files)
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_mods
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: cacheable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,19 +136,29 @@ files:
 - LICENSE.md
 - README.md
 - lib/nexus_mods.rb
-- lib/nexus_mods/api_limits.rb
-- lib/nexus_mods/category.rb
-- lib/nexus_mods/game.rb
-- lib/nexus_mods/mod.rb
-- lib/nexus_mods/mod_file.rb
-- lib/nexus_mods/user.rb
+- lib/nexus_mods/api/api_limits.rb
+- lib/nexus_mods/api/category.rb
+- lib/nexus_mods/api/game.rb
+- lib/nexus_mods/api/mod.rb
+- lib/nexus_mods/api/mod_file.rb
+- lib/nexus_mods/api/user.rb
+- lib/nexus_mods/api_client.rb
+- lib/nexus_mods/cacheable_api.rb
+- lib/nexus_mods/cacheable_with_expiry.rb
+- lib/nexus_mods/core_extensions/cacheable/cache_adapters/persistent_json_adapter.rb
+- lib/nexus_mods/core_extensions/cacheable/method_generator.rb
+- lib/nexus_mods/file_cache.rb
 - lib/nexus_mods/version.rb
+- spec/nexus_mods_test/factories/games.rb
+- spec/nexus_mods_test/factories/mod_files.rb
+- spec/nexus_mods_test/factories/mods.rb
 - spec/nexus_mods_test/helpers.rb
-- spec/nexus_mods_test/scenarios/nexus_mods/api_limits_spec.rb
-- spec/nexus_mods_test/scenarios/nexus_mods/game_spec.rb
-- spec/nexus_mods_test/scenarios/nexus_mods/mod_file_spec.rb
-- spec/nexus_mods_test/scenarios/nexus_mods/mod_spec.rb
+- spec/nexus_mods_test/scenarios/nexus_mods/api/api_limits_spec.rb
+- spec/nexus_mods_test/scenarios/nexus_mods/api/game_spec.rb
+- spec/nexus_mods_test/scenarios/nexus_mods/api/mod_file_spec.rb
+- spec/nexus_mods_test/scenarios/nexus_mods/api/mod_spec.rb
 - spec/nexus_mods_test/scenarios/nexus_mods_access_spec.rb
+- spec/nexus_mods_test/scenarios/nexus_mods_caching_spec.rb
 - spec/nexus_mods_test/scenarios/rubocop_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Muriel-Salvan/nexus_mods
@@ -158,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Access NexusMods REST API from Ruby

data/lib/nexus_mods/api_limits.rb

@@ -1,44 +0,0 @@
-class NexusMods
-
-  # Object giving the NexusMods API limits
-  class ApiLimits
-
-    attr_reader(
-      *%i[
-        daily_limit
-        daily_remaining
-        daily_reset
-        hourly_limit
-        hourly_remaining
-        hourly_reset
-      ]
-    )
-
-    # Constructor
-    #
-    # Parameters::
-    # * *daily_limit* (Integer): The daily limit
-    # * *daily_remaining* (Integer): The daily remaining
-    # * *daily_reset* (Integer): The daily reset time
-    # * *hourly_limit* (Integer): The hourly limit
-    # * *hourly_remaining* (Integer): The hourly remaining
-    # * *hourly_reset* (Integer): The hourly reset time
-    def initialize(
-      daily_limit:,
-      daily_remaining:,
-      daily_reset:,
-      hourly_limit:,
-      hourly_remaining:,
-      hourly_reset:
-    )
-      @daily_limit = daily_limit
-      @daily_remaining = daily_remaining
-      @daily_reset = daily_reset
-      @hourly_limit = hourly_limit
-      @hourly_remaining = hourly_remaining
-      @hourly_reset = hourly_reset
-    end
-
-  end
-
-end

data/lib/nexus_mods/category.rb

@@ -1,37 +0,0 @@
-class NexusMods
-
-  # Categories defined for a game in NexusMods
-  class Category
-
-    attr_reader(
-      *%i[
-        id
-        name
-      ]
-    )
-
-    attr_accessor(
-      *%i[
-        parent_category
-      ]
-    )
-
-    # Constructor
-    #
-    # Parameters::
-    # *id* (Integer): The category id
-    # *name* (String): The category id
-    # *parent_category* (Category or nil): The parent category, or nil if none [default: nil]
-    def initialize(
-      id:,
-      name:,
-      parent_category: nil
-    )
-      @id = id
-      @name = name
-      @parent_category = parent_category
-    end
-
-  end
-
-end