botterscotch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e51821e158ad2d89876eb8d527b6ffb0f00c4338d706bd2955ab84764fd4457
+  data.tar.gz: 18abdd4e66c473084aa5988d58ce38fcd16448b82d056e1a2d5f5ca5b8e4b0f2
+SHA512:
+  metadata.gz: 1c34f95d8e1f4fb33e3f356cd20a61bf44d0433443d8c75ff37dcb583037256620a8843570b3914ddc2d9fdcd601dcaeb214475e04de9538346b8a62c7e51d53
+  data.tar.gz: ca49a4ea33cc8fbdc845adc0f01fd8cf8e4772935dac298961e6d132dd95e0d1926d7f72579f313089871c4e575f943f1d8718973b65fcb532f5f69d938cf7bf

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+coverage
+doc/
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://gem.coop"
+
+# Specify your gem's dependencies in testgem.gemspec
+gemspec
+
+gem "bundler", "~> 2.7"
+gem "rake"
+gem "rspec"
+gem "standard"
+gem "ruby-lsp"

data/README

@@ -0,0 +1,7 @@
+# botterscotch
+
+Shared utilities for writing mastodon bots
+
+## Copyright
+
+Copyright (c) 2025 Daniel Senff. See LICENSE.md for further details.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ["--color", "--format", "documentation"]
+end
+
+task default: :spec

data/botterscotch.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "botterscotch/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "botterscotch"
+  spec.version = Botterscotch::VERSION
+  spec.license = "MIT"
+  spec.authors = ["Daniel Senff"]
+  spec.email = ["mail@danielsenff.de"]
+  spec.homepage = "http://codeberg.org/Dahie/botterscotch"
+  spec.summary = "Shared utilities for building Mastodon bots"
+  spec.description = "Shared utilities for building Mastodon bots"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 3"
+
+  spec.add_dependency("http")
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/botterscotch/clients/gotosocial.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "http"
+
+module Botterscotch
+  module Clients
+    class Gotosocial
+      def post_message(message, options = {})
+        form = {
+          status: message,
+          visibility: "unlisted",
+          language: "de"
+        }.merge(options)
+
+        yield(form) if block_given?
+
+        HTTP.headers(headers).post("#{config.server[:url]}/api/v1/statuses", form:)
+      end
+
+      private
+
+      def headers
+        {Authorization: "Bearer #{config.server[:access_token]}"}
+      end
+
+      def config
+        ::Botterscotch.configuration
+      end
+    end
+  end
+end

data/lib/botterscotch/clients/mastodon.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "http"
+
+module Botterscotch
+  module Clients
+    class Mastodon
+      def post_message(message, options = {})
+        form = {
+          content: message,
+          visibility: "unlisted",
+          language: "de",
+          password: config.server[:access_token]
+        }.merge(options)
+
+        yield(form) if block_given?
+
+        HTTP.headers(accept: "application/json").post("#{config.server[:url]}/action/send", form:)
+      end
+
+      private
+
+      def config
+        ::Botterscotch.configuration
+      end
+    end
+  end
+end

data/lib/botterscotch/configuration.rb

@@ -0,0 +1,20 @@
+# inspired by https://thoughtbot.com/blog/mygem-configure-block
+require "logger"
+
+module Botterscotch
+  class Configuration
+    attr_accessor :daily_fetch_at, :logger, :server, :monitoring_url
+
+    def initialize
+      @server = {
+        adapter: ENV.fetch("SERVER_ADAPTER", :mastodon).to_sym,
+        access_token: ENV.fetch("ACCESS_TOKEN", nil),
+        url: ENV.fetch("SERVER_URL", "https://example.com")
+      }
+      @monitoring_url = nil
+      @daily_fetch_at = "5 2 * * *"
+
+      @logger = Logger.new($stdout)
+    end
+  end
+end

data/lib/botterscotch/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Botterscotch
+  VERSION = "0.1.0"
+end

data/lib/botterscotch.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "botterscotch/configuration"
+require_relative "botterscotch/clients/mastodon"
+require_relative "botterscotch/clients/gotosocial"
+
+module Botterscotch
+  def self.configuration
+    @@configuration ||= ::Botterscotch::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/spec/botterscotch/clients/gotosocial_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+require "http"
+
+describe Botterscotch::Clients::Gotosocial do
+  let(:config) { double(:configuration, server: {url: "https://example.com", access_token: "secret"}) }
+  let(:message) { "Hello, World!" }
+
+  before do
+    allow(::Botterscotch).to receive(:configuration).and_return(config)
+    allow(HTTP).to receive(:headers).and_return(HTTP)
+  end
+
+  it "posts a message with default visibility and language" do
+    expect(HTTP).to receive(:headers).with({Authorization: "Bearer secret"})
+    expect(HTTP).to receive(:post).with(
+      "#{config.server[:url]}/api/v1/statuses",
+      form: {
+        status: message,
+        visibility: "unlisted",
+        language: "de"
+      }
+    )
+    subject.post_message(message)
+  end
+
+  it "posts a message with custom options" do
+    options = {visibility: "public", language: "en"}
+    expect(HTTP).to receive(:headers).with({Authorization: "Bearer secret"})
+    expect(HTTP).to receive(:post).with(
+      "#{config.server[:url]}/api/v1/statuses",
+      form: {
+        status: message,
+        visibility: "public",
+        language: "en"
+      }
+    )
+    subject.post_message(message, options)
+  end
+
+  it "raises an error if the server returns a non-2xx response" do
+    allow(HTTP).to receive(:post).and_raise(HTTP::Error.new(401))
+    expect { subject.post_message(message) }.to raise_error HTTP::Error
+  end
+end

data/spec/botterscotch/clients/mastodon_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+describe Botterscotch::Clients::Mastodon do
+  let(:config) { double(server: {url: "https://example.com", access_token: "123456"}) }
+  let(:mastodon_client) { described_class.new }
+
+  before do
+    allow(::Botterscotch).to receive(:configuration).and_return(config)
+    allow(HTTP).to receive(:headers).and_return(HTTP)
+  end
+
+  describe "#post_message" do
+    it "posts a message to Mastodon with default options" do
+      post_response = double(status: 200, body: "{\"message\":\"ok\"}")
+      expect(HTTP).to receive(:headers).with({accept: "application/json"})
+      expect(HTTP).to receive(:post).with(
+        "https://example.com/action/send",
+        form: hash_including(
+          content: "Hello, world!",
+          visibility: "unlisted",
+          language: "de",
+          password: config.server[:access_token]
+        )
+      ).and_return(post_response)
+      mastodon_client.post_message("Hello, world!")
+    end
+
+    it "posts a message to Mastodon with custom options" do
+      post_response = double(status: 200, body: "{\"message\":\"ok\"}")
+      allow(HTTP).to receive(:post).and_return(post_response)
+
+      mastodon_client.post_message("Hello, world!", visibility: "public", language: "en")
+
+      expect(HTTP).to have_received(:post).with(
+        "https://example.com/action/send",
+        form: hash_including(
+          content: "Hello, world!",
+          visibility: "public",
+          language: "en",
+          password: config.server[:access_token]
+        )
+      )
+    end
+
+    it "yields the form and tempfile to a block" do
+      post_response = double(status: 200, body: "{\"message\":\"ok\"}")
+      allow(HTTP).to receive(:post).and_return(post_response)
+
+      yielded_form = []
+
+      mastodon_client.post_message("Hello, world!", visibility: "public", language: "en") do |form|
+        yielded_form << form
+      end
+
+      expect(yielded_form).to eq([{
+        content: "Hello, world!",
+        visibility: "public",
+        language: "en",
+        password: config.server[:access_token]
+      }])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "bundler/setup"
+Bundler.setup
+
+require "botterscotch"
+
+RSpec.configure do |config|
+  Botterscotch.configure do |config|
+    config.server = {
+      url: "https://example.com",
+      access_token: "helloworld"
+    }
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: botterscotch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Senff
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shared utilities for building Mastodon bots
+email:
+- mail@danielsenff.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- Gemfile
+- README
+- Rakefile
+- botterscotch.gemspec
+- lib/botterscotch.rb
+- lib/botterscotch/clients/gotosocial.rb
+- lib/botterscotch/clients/mastodon.rb
+- lib/botterscotch/configuration.rb
+- lib/botterscotch/version.rb
+- spec/blickpunkte_spec.rb
+- spec/botterscotch/clients/gotosocial_spec.rb
+- spec/botterscotch/clients/mastodon_spec.rb
+- spec/spec_helper.rb
+homepage: http://codeberg.org/Dahie/botterscotch
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Shared utilities for building Mastodon bots
+test_files: []