curseforge 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48378e345c14758cf0a44b052ce525164bb67dc26d8c5427de1094f17cfcad15
-  data.tar.gz: 4b8b18a3339139baf1307c585bd92104a3e204d267c4c38f929d87940928a254
+  metadata.gz: da00e0c6338f15e272e1bb866b455dfa60cdcb69db648945fa31c55aaf9f492d
+  data.tar.gz: d5e4efcba49878147bc0b707b22aca679de07de44af2466aaa9013d8b92aa171
 SHA512:
-  metadata.gz: a5aeee4b11bdb9252da519cf8faae58441f5370c2ad5abc80462397d06d2f84a0ea65ce1c8a1414a940a1677191783aea50b4aef9970c3bcd89a6b328d4e2959
-  data.tar.gz: 3063fd94bee136ac1ab2943ede304a1011e8cdec13234abb72d4f8cc8bbd0e4644f867a94128caa4ed2b53ca8eb6c4f4ca159cdd9f57db6c9de5a593adfedbe6
+  metadata.gz: ede150b6b6210a9078a0127819501446f78358255780275ba007b2b6df0b07a8cf463d0b33e8a74d465ea68b7b407318bc1126e0b4917775239568ceb9e695d0
+  data.tar.gz: 3b5c9ee72dea8ad134225164c6c5e0eb6f6512a7fe0446d72cee80c341ea49bc814789fb9b8f53c4bd63a78d29aed665881f42b3d1425b8c2e68dd1179623ba8

data/.env.example

@@ -0,0 +1 @@
+CURSEFORGE_TOKEN='token'

data/lib/curseforge/error.rb

@@ -0,0 +1,11 @@
+class CurseForge
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(response, message)
+      super(message)
+
+      @response = response
+    end
+  end
+end

data/lib/curseforge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class CurseForge
-  VERSION = '0.1.1'
-end
+  VERSION = '0.3.0'
+end

data/lib/curseforge.rb

@@ -7,30 +7,32 @@ require 'json'
 # by PackBuilder.io
 class CurseForge
   require_relative 'curseforge/version'
+  require_relative 'curseforge/error'
 
-  def initialize(token)
+  def initialize(token, **options)
     @token = token
-    @api = Faraday.new(
-      url: 'https://api.curseforge.com',
-      headers: { 'x-api-key' => @token }
-    )
+
+    options[:url] ||= 'https://api.curseforge.com'
+    options[:headers] ||= {}
+    options[:headers]["x-api-key"] = @token
+    @api = Faraday.new(options)
   end
 
   # @param [Integer] mod_id
   # @raise [Faraday::Error]
   # @return [Hash]
-  # @see https://docs.curseforge.com/rest-api/#schemaget%20mod%20response
+  # @see https://docs.curseforge.com/rest-api/#get-mod
   def get_mod(mod_id)
-    get_request("/v1/mods/#{mod_id}")
+    req(:get, "/v1/mods/#{mod_id}")
   end
 
   # @param [Array<Integer>] mod_ids
   # @param [Boolean] filter_pc_only
   # @raise [Faraday::Error]
   # @return [Hash]
-  # @see https://docs.curseforge.com/rest-api/#schemaget%20mods%20response
+  # @see https://docs.curseforge.com/rest-api/#get-mods
   def get_mods(*mods_ids, filter_pc_only: true)
-    post_request('/v1/mods', body: {
+    req(:post, '/v1/mods', body: {
                    modIds: mods_ids,
                    filterPCOnly: filter_pc_only
                 }.to_json, headers: { 'Content-Type' => 'application/json' })["data"]
@@ -39,7 +41,7 @@ class CurseForge
   # @param [Hash] json
   # @raise [Faraday::Error]
   # @return [Hash]
-  # @see https://docs.curseforge.com/rest-api/#schemaget%20mods%20response
+  # @see https://docs.curseforge.com/rest-api/#get-mods
   # @example
   #  require 'json'
   #  require 'curseforge'
@@ -50,7 +52,7 @@ class CurseForge
   #  client = CurseForge.new('token')
   #  mods = client.get_mods_from_manifest(json)
   def get_mods_from_manifest(json)
-    get_mods(json['files'].map(&:projectID))
+    get_mods(*json['files'].map { |f| f['projectID'] })
   end
 
   # Filters mods based on the given query parameters.
@@ -79,20 +81,17 @@ class CurseForge
   # @see https://docs.curseforge.com/rest-api/#schemasearch%20mods%20response
   def search_mods(game_id, **query)
     query[:gameId] = game_id
-    get_request('/v1/mods/search', body: query)
+    req(:get, '/v1/mods/search', body: query)
   end
 
   private
 
-  def req(method, path, body: nil, headers: nil)
-    @api.send(method, path, body, headers)
-  end
-
-  %i[get post put delete].each do |method|
-    define_method(:"#{method}_request") do |path, body: nil, headers: nil|
-      resp = req(method, path, body: body, headers: headers)
+    def req(method, path, body: nil, headers: nil)
+      resp = @api.send(method, path, body, headers)
+      raise CurseForge::Error.new(resp, "received #{resp.status}") unless resp.success?
 
       JSON.parse(resp.body)
+    rescue JSON::ParserError => e
+      raise CurseForge::Error.new(resp, e.message)
     end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curseforge
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Goob-Hub
 - Dylan Hackworth
 bindir: exe
 cert_chain: []
-date: 2024-12-27 00:00:00.000000000 Z
+date: 2025-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -32,6 +32,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".rspec"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -39,6 +40,7 @@ files:
 - README.md
 - Rakefile
 - lib/curseforge.rb
+- lib/curseforge/error.rb
 - lib/curseforge/version.rb
 - sig/curseforge.rbs
 homepage: https://github.com/packbuilder/curseforge/