curseforge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d43af937748b81ae05d58c293e1ad04283d46f2a69442153b7e70b89931de91c
+  data.tar.gz: abc5eb38d6c75a342bd8f1ffa623855fac6ed1379cc5945438ec18f34d506094
+SHA512:
+  metadata.gz: 8651f4056171da5957946603dbfab5c4210495705d6e8d50be57360c0666ce68bbe9c57b8c326d999b5e186bc116534ccd2b9ba92ccd6b15eaf918114124df5c
+  data.tar.gz: 36015242b803ed63fd9b74d8a47d12e486221d4961b1a5c539267c4112a059c67ecd19acf953893d49ed2455b93219329b42c3f850a8618e903debb84259fa47

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 PackBuilder.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# CurseForge
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add curseforge
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install curseforge
+```
+
+## Usage
+
+TODO: usage examples :)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/packbuilder/curseforge. 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/packbuilder/curseforge/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 CurseForge project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/packbuilder/curseforge/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/lib/curseforge/version.rb

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

data/lib/curseforge.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+# CurseForge API Wrapper
+# by PackBuilder.io
+class CurseForge
+  require_relative 'curseforge/version'
+
+  def initialize(token)
+    @token = token
+    @api = Faraday.new(
+      url: 'https://api.curseforge.com',
+      headers: { 'x-api-key' => @token }
+    )
+  end
+
+  # @param [Integer] mod_id
+  # @raise [Faraday::Error]
+  # @return [Hash]
+  # @see https://docs.curseforge.com/rest-api/#schemaget%20mod%20response
+  def get_mod(mod_id)
+    get_request("/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
+  def get_mods(*mods_ids, filter_pc_only: true)
+    post_request('/v1/mods', body: {
+                   modIds: mods_ids,
+                   filterPCOnly: filter_pc_only
+                 }, headers: { 'Content-Type' => 'application/json' })
+  end
+
+  # @param [Hash] json
+  # @raise [Faraday::Error]
+  # @return [Hash]
+  # @see https://docs.curseforge.com/rest-api/#schemaget%20mods%20response
+  # @example
+  #  require 'json'
+  #  require 'curseforge'
+  #
+  #  file = File.open('manifest.json')
+  #  json = JSON.parse(file.read)
+  #  file.close
+  #  client = CurseForge.new('token')
+  #  mods = client.get_mods_from_manifest(json)
+  def get_mods_from_manifest(json)
+    get_mods(json['files'].map(&:projectID))
+  end
+
+  # Filters mods based on the given query parameters.
+  #
+  # @param [Integer] game_id Filter by game ID.
+  # @param [Hash] query
+  # @option query [Integer] classId Filter by section ID.
+  # @option query [Integer] categoryId Filter by category ID.
+  # @option query [String] categoryIds Filter by a list of category IDs (overrides <tt>categoryId</tt>)
+  # @option query [String] gameVersion Filter by game version string
+  # @option query [String] gameVersions Filter by a list of game version strings (overrides <tt>gameVersion</tt>)
+  # @option query [String] searchFilter Free text search in the mod name and author
+  # @option query [String] sortField Filter by <tt>ModsSearchSortField</tt> enumeration
+  # @option query [String] sortOrder <tt>asc</tt> for ascending, <tt>desc</tt> for descending
+  # @option query [String] modLoaderType Filter mods associated with a specific modloader (requires <tt>gameVersion</tt>)
+  # @option query [String] modLoaderTypes Filter by a list of mod loader types (overrides <tt>modLoaderType</tt>)
+  # @option query [Integer] gameVersionTypeId Filter mods tagged with versions of the given <tt>gameVersionTypeId</tt>
+  # @option query [Integer] authorId Filter by mods authored by the given <tt>authorId</tt>
+  # @option query [Integer] primaryAuthorId Filter by mods owned by the given <tt>primaryAuthorId</tt>
+  # @option query [String] slug Filter by slug (use with <tt>classId</tt> for unique result)
+  # @option query [Integer] index **Zero-based** index of the first item to include in the response (max: <tt>index + pageSize <= 10,000</tt>)
+  # @option query [Integer] pageSize Number of items to include in the response (default/max: 50).
+  #
+  # @raise [Faraday::Error]
+  # @return [Hash] Filtered mods based on the query parameters.
+  # @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)
+  end
+
+  private
+
+  def req(method, path, body: nil, headers: nil)
+    # TODO: actual error handling
+    @api.send(method, path, body, headers).body
+  end
+
+  %i[get post put delete].each do |method|
+    define_method(:"#{method}_request") do |path, body: nil, headers: nil|
+      req(method, path, body: body, headers: headers)
+    end
+  end
+end

data/sig/curseforge.rbs

@@ -0,0 +1,5 @@
+# TODO: we do a little rbs
+module CurseForge
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: curseforge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Goob-Hub
+- Dylan Hackworth
+bindir: exe
+cert_chain: []
+date: 2024-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: CurseForge API wrapper for Ruby
+email:
+- theg00bdev@gmail.com
+- dylan.hackworth@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/curseforge.rb
+- lib/curseforge/version.rb
+- sig/curseforge.rbs
+homepage: https://github.com/packbuilder/curseforge/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/packbuilder/curseforge/
+  source_code_uri: https://github.com/packbuilder/curseforge/
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.1
+specification_version: 4
+summary: CurseForge API Wrapper
+test_files: []