yiffspace-images 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9025106d5bb94489dfd2d3e31ca2316b63d5fd9e388f32c865ba2dc894e3b4b
+  data.tar.gz: 95653c5d9dbcc6bfb928dec4a174dac3a927be8e31c458c164700b7b4e2171b5
+SHA512:
+  metadata.gz: 5da48bdfab1e99c431abf2a0bbd52c953dce061389daf7bf5f98b054f05a34fe454bd4cbe320ce4affa25f917982c63824a08ae515dad14d9b58d0829663cbf4
+  data.tar.gz: ae7fa8214d9d0a8fba4b3da685e52b99788221e76ee9bbc49c2365e26b0fdc4abed4487d7dded070a8f974f10907a223f6fa6b9fe9f1a71e49855162b15e4a18

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.0.1
+
+- Initial release, extracted from the `yiffspace` gem's `YiffSpace::Images::*`,
+  `YiffSpace::Serializers::Avatar/BannerSerializer`, and
+  `YiffSpace::Configuration#images`. `Configuration::Images` is now
+  `YiffSpace::Images::Configuration`.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright Donovan_DMC
+
+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,42 @@
+# YiffSpace::Images
+
+Avatar/banner URL building and updating (Discord/Gravatar), for
+https://yiff.space and related projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "yiffspace-images"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+```ruby
+YiffSpace::Images::Avatar.default_for(user.id).url
+YiffSpace::Images::Banner.get_for(user.id, :discord).url
+```
+
+Configure via:
+
+```ruby
+YiffSpace.configure do |config|
+  config.images.server_url = "https://images.example.com"
+  config.images.update_token = ENV["IMAGES_UPDATE_TOKEN"]
+end
+```
+
+## Contributing
+
+Go away
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require("bundler/gem_tasks")
+
+# CI releases from an already-tagged, already-pushed commit checked out at a detached HEAD, so
+# the default release task's git tag/push step has nothing to do and fails trying to push a
+# branch ref that does not exist in that checkout.
+Rake::Task["release"].clear
+task("release" => "release:rubygem_push")

data/lib/yiffspace/images/avatar/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Images
+    module Avatar
+      class Base
+        def self.type = nil
+
+        attr_reader(:id, :type)
+
+        def initialize(id, type)
+          @id   = id
+          @type = type
+        end
+
+        def url
+          raise(NotImplementedError)
+        end
+
+        def update(*)
+          raise(NotImplementedError)
+        end
+
+        def serializable_hash(*)
+          { "id" => @id, "type" => @type }
+        end
+
+        def self.from_json(data)
+          raise(ArgumentError, "invalid data") if data.blank?
+
+          data = JSON.parse(data) if data.is_a?(String)
+          data = ::YiffSpace::Utils::OpenHash.from(data)
+
+          return Avatar.find_type(data.type).from_json(data) if self == Base
+
+          new(data.id)
+        end
+      end
+    end
+  end
+end

data/lib/yiffspace/images/avatar/discord.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require("httparty")
+
+module YiffSpace
+  module Images
+    module Avatar
+      class Discord < Base
+        def self.type = :discord
+
+        def initialize(id)
+          super(id, self.class.type)
+        end
+
+        def url
+          "#{YiffSpace.config.images.server_url}/avatar/discord/#{id}"
+        end
+
+        def update(hash)
+          raise(StandardError, "images.update_token config option must be set to use avatar update") if YiffSpace.config.images.update_token.blank?
+
+          response = HTTParty.post("#{YiffSpace.config.images.server_url}/avatar/discord/update/#{id}",
+                                   YiffSpace.config.images.httparty_options.deep_merge(
+                                     headers: {
+                                       "Authorization" => "Bearer #{YiffSpace.config.images.update_token}",
+                                       "Content-Type"  => "application/json",
+                                     },
+                                     body:    { hash: hash }.to_json,
+                                   ))
+          Rails.logger.error("avatar update failed: #{response.to_json}") unless response.key?("updated")
+
+          response.fetch("updated", false)
+        end
+      end
+    end
+  end
+end

data/lib/yiffspace/images/avatar/gravatar.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require("httparty")
+
+module YiffSpace
+  module Images
+    module Avatar
+      class Gravatar < Base
+        def self.type = :gravatar
+
+        def initialize(id)
+          super(id, self.class.type)
+        end
+
+        def url
+          "#{YiffSpace.config.images.server_url}/avatar/gravatar/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/yiffspace/images/avatar.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Images
+    module Avatar
+      module_function
+
+      def default_for(id)
+        type = YiffSpace.config.images.default_avatar_type
+        get_for(id, type)
+      end
+
+      def get_for(id, type)
+        klass = find_type(type)
+        raise(StandardError, "No avatar class for type: #{type}") if klass.nil?
+
+        klass.new(id)
+      end
+
+      def find_type(type)
+        constants.map { |c| [c, const_get(c)] }.find do |_const, value|
+          next unless value < Base
+
+          value.try(:type)&.to_sym == type.to_sym
+        end&.second
+      end
+
+      def find_type!(type)
+        find_type(type) || raise(StandardError, "No avatar class for type: #{type}")
+      end
+    end
+  end
+end

data/lib/yiffspace/images/banner/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Images
+    module Banner
+      class Base
+        def self.type = nil
+
+        attr_reader(:id, :type)
+
+        def initialize(id, type)
+          @id   = id
+          @type = type
+        end
+
+        def url
+          raise(NotImplementedError)
+        end
+
+        def update(*)
+          raise(NotImplementedError)
+        end
+
+        def serializable_hash(*)
+          { "id" => @id, "type" => @type }
+        end
+
+        def self.from_json(data)
+          raise(ArgumentError, "invalid data") if data.blank?
+
+          data = JSON.parse(data) if data.is_a?(String)
+          data = ::YiffSpace::Utils::OpenHash.from(data)
+
+          return Banner.find_type(data.type).from_json(data) if self == Base
+
+          new(data.id)
+        end
+      end
+    end
+  end
+end

data/lib/yiffspace/images/banner/discord.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require("httparty")
+
+module YiffSpace
+  module Images
+    module Banner
+      class Discord < Base
+        def self.type = :discord
+
+        def initialize(id)
+          super(id, self.class.type)
+        end
+
+        def url
+          "#{YiffSpace.config.images.server_url}/banner/discord/#{id}"
+        end
+
+        def update(hash)
+          raise(StandardError, "images.update_token config option must be set to use banner update") if YiffSpace.config.images.update_token.blank?
+
+          response = HTTParty.post("#{YiffSpace.config.images.server_url}/banner/discord/update/#{id}",
+                                   YiffSpace.config.images.httparty_options.deep_merge(
+                                     headers: {
+                                       "Authorization" => "Bearer #{YiffSpace.config.images.update_token}",
+                                       "Content-Type"  => "application/json",
+                                     },
+                                     body:    { hash: hash }.to_json,
+                                   ))
+          Rails.logger.error("banner update failed: #{response.to_json}") unless response.key?("updated")
+
+          response.fetch("updated", false)
+        end
+      end
+    end
+  end
+end

data/lib/yiffspace/images/banner.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Images
+    module Banner
+      module_function
+
+      def default_for(id)
+        type = YiffSpace.config.images.default_banner_type
+        get_for(id, type)
+      end
+
+      def get_for(id, type)
+        klass = find_type(type)
+        raise(StandardError, "No banner class for type: #{type}") if klass.nil?
+
+        klass.new(id)
+      end
+
+      def find_type(type)
+        constants.map { |c| [c, const_get(c)] }.find do |_const, value|
+          next unless value < Base
+
+          value.try(:type)&.to_sym == type.to_sym
+        end&.second
+      end
+
+      def find_type!(type)
+        find_type(type) || raise(StandardError, "No banner class for type: #{type}")
+      end
+    end
+  end
+end

data/lib/yiffspace/images/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Images
+    class Configuration
+      attr_accessor(:server_url, :update_token, :default_avatar_type, :default_banner_type, :httparty_options)
+
+      def initialize
+        @server_url          = "https://images.yiff.space"
+        @default_avatar_type = :discord
+        @default_banner_type = :discord
+        @httparty_options    = {
+          timeout:      10,
+          open_timeout: 5,
+          headers:      {
+            "User-Agent" => "YiffSpaceRuby/#{YiffSpace::Images::VERSION} (https://yiff.space)",
+          },
+        }
+      end
+    end
+  end
+end

data/lib/yiffspace/images/engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require("rails")
+
+module YiffSpace
+  module Images
+    # No app/ of its own - this exists to register the Avatar/BannerSerializer with ActiveJob.
+    class Engine < ::Rails::Engine
+      config.root = File.expand_path("../../..", __dir__)
+
+      initializer("yiffspace.images.serializers") do
+        ActiveSupport.on_load(:active_job) do
+          ActiveJob::Serializers.add_serializers(
+            Serializers::AvatarSerializer,
+            Serializers::BannerSerializer,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/yiffspace/images/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Images
+    VERSION = "0.0.1"
+  end
+end

data/lib/yiffspace/images.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require("yiffspace/core")
+require("zeitwerk")
+
+module YiffSpace
+  module Images
+  end
+
+  class Configuration
+    def images
+      @images ||= Images::Configuration.new
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.for_gem_extension(YiffSpace)
+loader.ignore("#{__dir__}/images/engine.rb")
+loader.setup
+
+# Require the engine eagerly so it registers with Rails before the host app's
+# active_support.initialize_per_engine_zeitwerk_loaders initializer runs.
+require_relative("images/engine") if defined?(Rails)

data/lib/yiffspace/serializers/avatar_serializer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require("active_job")
+
+module YiffSpace
+  module Serializers
+    class AvatarSerializer < ActiveJob::Serializers::ObjectSerializer
+      def serialize(arg)
+        super(**arg.serializable_hash)
+      end
+
+      def deserialize(arg)
+        Images::Avatar::Base.from_json(arg)
+      end
+
+      def klass
+        Images::Avatar::Base
+      end
+    end
+  end
+end

data/lib/yiffspace/serializers/banner_serializer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require("active_job")
+
+module YiffSpace
+  module Serializers
+    class BannerSerializer < ActiveJob::Serializers::ObjectSerializer
+      def serialize(arg)
+        super(**arg.serializable_hash)
+      end
+
+      def deserialize(arg)
+        Images::Banner::Base.from_json(arg)
+      end
+
+      def klass
+        Images::Banner::Base
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: yiffspace-images
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Donovan_DMC
+bindir: bin
+cert_chain: []
+date: 2026-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: yiffspace-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Avatar/banner URL building and updating (Discord/Gravatar), for https://yiff.space
+  and related projects
+email:
+- hewwo@yiff.rocks
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/yiffspace/images.rb
+- lib/yiffspace/images/avatar.rb
+- lib/yiffspace/images/avatar/base.rb
+- lib/yiffspace/images/avatar/discord.rb
+- lib/yiffspace/images/avatar/gravatar.rb
+- lib/yiffspace/images/banner.rb
+- lib/yiffspace/images/banner/base.rb
+- lib/yiffspace/images/banner/discord.rb
+- lib/yiffspace/images/configuration.rb
+- lib/yiffspace/images/engine.rb
+- lib/yiffspace/images/version.rb
+- lib/yiffspace/serializers/avatar_serializer.rb
+- lib/yiffspace/serializers/banner_serializer.rb
+homepage: https://yiff.space
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://yiff.space
+  source_code_uri: https://github.com/YiffSpace/Gem/tree/master/yiffspace-images
+  changelog_uri: https://github.com/YiffSpace/Gem/blob/master/yiffspace-images/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Avatar/banner URL building and updating (Discord/Gravatar), for https://yiff.space
+  and related projects
+test_files: []