blue_factory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80b991e6702487fe63c56386b86d181093e88abbe3bc3c30360a4fca7977350f
+  data.tar.gz: d4fe4bfd4a4cb2dea7dd165eb6dbff45bd3e55eb72144b82669dd5bab212b1d8
+SHA512:
+  metadata.gz: 3c591080e8fb94fb8ecbc8db0178b08a4d98b018ece55975ab672dd81ea05d5b7aaa18aebedd3b1514d7e134b2d77794e98026a9bcfcc06d73fe71bf67d74df0
+  data.tar.gz: 3c2dcb624de1429e6eee265727c5a2368ce4cbb999e74d07016ae485b568c34cfdea39c9cb5640d32730f597e548bac48255c7e04a8cf8359d360e9db4d88ef4

data/CHANGELOG.md

@@ -0,0 +1 @@
+## [Unreleased]

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The zlib License
+
+Copyright (c) 2023 Jakub Suder
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+3. This notice may not be removed or altered from any source distribution.
+

data/README.md

@@ -0,0 +1,31 @@
+# BlueFactory
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/blue_factory`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/blue_factory.

data/lib/blue_factory/configuration.rb

@@ -0,0 +1,19 @@
+require_relative 'modules/configurable'
+require_relative 'modules/feeds'
+
+module BlueFactory
+  extend Configurable
+  extend Feeds
+
+  def self.service_did
+    'did:web:' + hostname
+  end
+
+  def self.environment
+    (ENV['APP_ENV'] || ENV['RACK_ENV'] || :development).to_sym
+  end
+
+  configurable :publisher_did, :hostname, :validate_responses
+
+  set :validate_responses, (environment != :production)
+end

data/lib/blue_factory/errors.rb

@@ -0,0 +1,13 @@
+module BlueFactory
+  class InvalidRequestError < StandardError
+    attr_reader :error_type
+
+    def initialize(message, error_type = nil)
+      super(message)
+      @error_type = error_type
+    end
+  end
+
+  class InvalidResponseError < StandardError
+  end
+end

data/lib/blue_factory/modules/configurable.rb

@@ -0,0 +1,23 @@
+module BlueFactory
+  module Configurable
+    def self.extended(target)
+      target.instance_variable_set('@properties', [])
+    end
+
+    def configurable(*properties)
+      @properties ||= []
+      @properties += properties.map(&:to_sym)
+      singleton_class.attr_reader(*properties)
+    end
+
+    def set(property, value)
+      if @properties.include?(property.to_sym)
+        self.instance_variable_set("@#{property}", value)
+      else
+        raise NoMethodError
+      end
+    end
+
+    private :configurable
+  end
+end

data/lib/blue_factory/modules/feeds.rb

@@ -0,0 +1,19 @@
+module BlueFactory
+  module Feeds
+    def self.extended(target)
+      target.instance_variable_set('@feeds', {})
+    end
+
+    def add_feed(key, feed_class)
+      @feeds[key.to_s] = feed_class
+    end
+
+    def all_feeds
+      @feeds.keys
+    end
+
+    def get_feed(key)
+      @feeds[key.to_s]
+    end
+  end
+end

data/lib/blue_factory/rake.rb

@@ -0,0 +1 @@
+load 'blue_factory/tasks/publish.rake'

data/lib/blue_factory/server.rb

@@ -0,0 +1,104 @@
+require 'json'
+require 'sinatra/base'
+
+require_relative 'configuration'
+require_relative 'errors'
+
+module BlueFactory
+  class Server < Sinatra::Base
+    AT_URI_REGEXP = %r(^at://did:plc:[a-z0-9]+/app\.bsky\.feed\.post/[a-z0-9]+$)
+
+    configure do
+      disable :static
+      enable :quiet
+      enable :logging
+      set :default_content_type, 'application/json'
+      settings.add_charset << 'application/json'
+    end
+
+    helpers do
+      def config
+        BlueFactory
+      end
+
+      def feed_uri(key)
+        'at://' + config.publisher_did + '/' + FEED_GENERATOR_TYPE + '/' + key
+      end
+
+      def json(data)
+        JSON.generate(data)
+      end
+
+      def json_error(name, message, status: 400)
+        [status, JSON.generate({ error: name, message: message })]
+      end
+
+      def validate_response(response)
+        cursor = response[:cursor]
+        raise InvalidResponseError, ":cursor key is missing" unless response.has_key?(:cursor)
+        raise InvalidResponseError, ":cursor should be a string or nil" unless cursor.nil? || cursor.is_a?(String)
+
+        posts = response[:posts]
+        raise InvalidResponseError, ":posts key is missing" unless response.has_key?(:posts)
+        raise InvalidResponseError, ":posts should be an array of strings" unless posts.is_a?(Array)
+        raise InvalidResponseError, ":posts should be an array of strings" unless posts.all? { |x| x.is_a?(String) }
+
+        if bad_uri = posts.detect { |x| x !~ AT_URI_REGEXP }
+          raise InvalidResponseError, "Invalid post URI: #{bad_uri}"
+        end
+      end
+    end
+
+    get '/xrpc/app.bsky.feed.getFeedSkeleton' do
+      if params[:feed].to_s.empty?
+        return json_error("InvalidRequest", "Error: Params must have the property \"feed\"")
+      end
+
+      if params[:feed] !~ %r(^at://[\w\-\.\:]+/[\w\.]+/[\w\.\-]+$)
+        return json_error("InvalidRequest", "Error: feed must be a valid at-uri")
+      end
+
+      feed_key = params[:feed].split('/').last
+      feed = config.get_feed(feed_key)
+
+      if feed.nil? || feed_uri(feed_key) != params[:feed]
+        return json_error("UnsupportedAlgorithm", "Unsupported algorithm")
+      end
+
+      begin
+        response = feed.get_posts(params.slice(:feed, :cursor, :limit))
+        validate_response(response) if config.validate_responses
+
+        return json({
+          cursor: response[:cursor],
+          feed: response[:posts].map { |s| { post: s }}
+        })
+      rescue InvalidRequestError => e
+        return json_error(e.error_type || "InvalidRequest", e.message)
+      rescue InvalidResponseError => e
+        return json_error("InvalidResponse", e.message)
+      end
+    end
+
+    get '/xrpc/app.bsky.feed.describeFeedGenerator' do
+      return json({
+        did: config.service_did,
+        feeds: config.all_feeds.map { |f| { uri: feed_uri(f) }}
+      })
+    end
+
+    get '/.well-known/did.json' do
+      return json({
+        '@context': ['https://www.w3.org/ns/did/v1'],
+        id: config.service_did,
+        service: [
+          {
+            id: '#bsky_fg',
+            type: 'BskyFeedGenerator',
+            serviceEndpoint: 'https://' + config.hostname
+          }
+        ]
+      })
+    end
+  end
+end

data/lib/blue_factory/tasks/publish.rake

@@ -0,0 +1,91 @@
+require 'blue_factory/configuration'
+require 'blue_factory/tasks/support'
+require 'io/console'
+
+namespace :bluesky do
+  desc "Publish a feed"
+  task :publish do
+    if ENV['KEY'].to_s == ''
+      puts "Please specify feed key as KEY=feedname (the part of the feed's at:// URI after the last slash)"
+      exit 1
+    end
+
+    feed_key = ENV['KEY']
+
+    if BlueFactory.hostname.nil?
+      puts "Missing server hostname: please set the hostname with `BlueFactory.set :hostname, 'example.com'`"
+      exit 1
+    end
+
+    if BlueFactory.publisher_did.nil?
+      puts "Missing publisher DID: please set it with `BlueFactory.set :publisher_did, 'did:plc:youridentifier'`"
+      exit 1
+    end
+
+    feed = BlueFactory.get_feed(feed_key)
+
+    if feed.nil?
+      puts "No feed configured for key '#{feed_key}' - use `BlueFactory.add_feed '#{feed_key}', MyFeed.new`"
+      exit 1
+    end
+
+    if feed.respond_to?(:display_name) && feed.display_name.to_s.strip != ''
+      feed_display_name = feed.display_name
+    else
+      puts "The feed has no display name - implement a #display_name method."
+      exit 1
+    end
+
+    if feed.respond_to?(:description) && feed.description.to_s.strip != ''
+      feed_description = feed.description
+    end
+
+    if feed.respond_to?(:avatar_file) && feed.avatar_file.to_s.strip != ''
+      avatar_file = feed.avatar_file
+
+      if !File.exist?
+        puts "Avatar file #{avatar_file} not found."
+        exit 1
+      end
+
+      encoding = case avatar_file
+      when /\.png$/ then 'image/png'
+      when /\.jpe?g$/ then 'image/jpeg'
+      else
+        puts "The avatar must be either a PNG or a JPEG file."
+        exit 1
+      end
+
+      avatar_data = File.read(avatar_file)
+    end
+
+    server = ENV['SERVER_URL'] || "https://bsky.social"
+
+    print "Enter password for your publisher account (#{BlueFactory.publisher_did}): "
+    password = STDIN.noecho(&:gets).chomp
+    puts
+
+    json = BlueFactory::Net.post_request(server, 'com.atproto.server.createSession', {
+      identifier: BlueFactory.publisher_did,
+      password: password
+    })
+
+    access_token = json['accessJwt']
+
+    record = {
+      did: BlueFactory.service_did,
+      displayName: feed_display_name,
+      description: feed_description,
+      createdAt: Time.now.iso8601,
+    }
+
+    json = BlueFactory::Net.post_request(server, 'com.atproto.repo.putRecord', {
+      repo: BlueFactory.publisher_did,
+      collection: BlueFactory::FEED_GENERATOR_TYPE,
+      rkey: feed_key,
+      record: record
+    }, auth: access_token)
+
+    p json
+  end
+end

data/lib/blue_factory/tasks/support.rb

@@ -0,0 +1,23 @@
+require 'json'
+require 'net/http'
+
+module BlueFactory
+  module Net
+    class ResponseError < StandardError; end
+
+    def self.post_request(server, method, data, auth: nil, content_type: "application/json")
+      headers = {}
+      headers['Content-Type'] = content_type
+      headers['Authorization'] = "Bearer #{auth}" if auth
+
+      body = data.is_a?(String) ? data : data.to_json
+
+      puts body unless data.is_a?(String)
+
+      response = ::Net::HTTP.post(URI("#{server}/xrpc/#{method}"), body, headers)
+      raise ResponseError, "Invalid response: #{response.code} #{response.body}" if response.code.to_i / 100 != 2
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/blue_factory/version.rb

@@ -0,0 +1,3 @@
+module BlueFactory
+  VERSION = "0.1.0"
+end

data/lib/blue_factory.rb

@@ -0,0 +1,7 @@
+require_relative 'blue_factory/configuration'
+require_relative 'blue_factory/server'
+require_relative 'blue_factory/version'
+
+module BlueFactory
+  FEED_GENERATOR_TYPE = 'app.bsky.feed.generator'
+end

data/sig/blue_factory.rbs

@@ -0,0 +1,4 @@
+module BlueFactory
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: blue_factory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kuba Suder
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Write a longer description or delete this line.
+email:
+- jakub.suder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/blue_factory.rb
+- lib/blue_factory/configuration.rb
+- lib/blue_factory/errors.rb
+- lib/blue_factory/modules/configurable.rb
+- lib/blue_factory/modules/feeds.rb
+- lib/blue_factory/rake.rb
+- lib/blue_factory/server.rb
+- lib/blue_factory/tasks/publish.rake
+- lib/blue_factory/tasks/support.rb
+- lib/blue_factory/version.rb
+- sig/blue_factory.rbs
+homepage: https://github.com/mackuba/blue_factory
+licenses:
+- Zlib
+metadata:
+  bug_tracker_uri: https://github.com/mackuba/blue_factory/issues
+  changelog_uri: https://github.com/mackuba/blue_factory/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/mackuba/blue_factory
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []