blue_factory 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10e968b7723f9f1244cc006195c899ef5152d8aca0393787fbf0ac39901c7a2a
-  data.tar.gz: 0d020d91890d1afdac88a993cc6f659a29b6790b6dc031c7464f93ca347c263a
+  metadata.gz: 41390cf32bc0c614a9cec3414ce6b5f4c2b325d81c59655089efe4e732356bd0
+  data.tar.gz: 24f49ed933396117be07381b43ae1878022a687b5a88d3b1e0dd1feb0582b972
 SHA512:
-  metadata.gz: 90304d80cc54255f1550bdf42403e699334f92a1a1bf6d0b0ecea43a66e109f1f1fbcee9600f6ff38198093a7bbf9d189c3e31d226d0db7f8ae956521a051967
-  data.tar.gz: 70180d3c1fde075b0e088882b47a18716dc7488cdb669bf28808d2b7a9b55917053ce7adf4418a1e2ce00eade2eabef49dda211a93cbf6c6dc92918351587d7a
+  metadata.gz: 94accb55c086ea2302e479f6f7e5f5cf83631c47a165d429349207dbeb654c48970a78b095fe6b2f9a3686674869f7fbfe382841d49bad84dd67b391585d05f5
+  data.tar.gz: c2b1d4590f546ee2c1c8d98b4c7a776974ca2c9dd1a94cce517a7021cb9e9f295d39b4f986fc41dd058bee00af1942113ab770d91cadbc135bc7ca4c9e27cfcb

data/CHANGELOG.md

@@ -1 +1,12 @@
-## [Unreleased]
+## [0.1.2] - 2023-06-15
+
+- added validation for feed rkey
+- renamed `all_feeds` to `feed_keys`, `all_feeds` now returns an array of feeds
+
+## [0.1.1] - 2023-06-13
+
+- added a rake task for publishing the feed to Bluesky
+
+## [0.1.0] - 2023-06-12
+
+Initial release: working version that serves all required endpoints for the feed.

data/README.md

@@ -22,7 +22,7 @@ The server is configured through the `BlueFactory` module. The two required sett
 - `publisher_did` - DID identifier of the account that you will publish the feed on (the string that starts with `did:plc:...`)
 - `hostname` - the hostname on which the feed service will be run
 
-You also need to configure at least one feed by passing a feed key and a feed object. The key is the identifier that will appear at the end of the feed URI - ideally something short and lowercase. The object is anything that implements the single required method `get_posts` (could be a class, a module or an instance).
+You also need to configure at least one feed by passing a feed key and a feed object. The key is the identifier that will appear at the end of the feed URI - it must only contain characters that are valid in URLs (preferably all lowercase) and it can't be longer than 15 characters. The object is anything that implements the single required method `get_posts` (could be a class, a module or an instance).
 
 So a simple setup could look like this:
 

data/lib/blue_factory/errors.rb

@@ -1,4 +1,7 @@
 module BlueFactory
+  class InvalidKeyError < StandardError
+  end
+
   class InvalidRequestError < StandardError
     attr_reader :error_type
 

data/lib/blue_factory/modules/feeds.rb

@@ -5,15 +5,29 @@ module BlueFactory
     end
 
     def add_feed(key, feed_class)
+      validate_key(key)
       @feeds[key.to_s] = feed_class
     end
 
-    def all_feeds
+    def feed_keys
       @feeds.keys
     end
 
     def get_feed(key)
       @feeds[key.to_s]
     end
+
+    def all_feeds
+      @feeds.values
+    end
+
+    private
+
+    def validate_key(key)
+      raise InvalidKeyError, "Key must be a string" unless key.is_a?(String)
+      raise InvalidKeyError, "Key must not be empty" if key == ''
+      raise InvalidKeyError, "Key must not contain a slash" if key.include?('/')
+      raise InvalidKeyError, "Key must not be longer than 15 characters" if key.length > 15
+    end
   end
 end

data/lib/blue_factory/server.rb

@@ -83,7 +83,7 @@ module BlueFactory
     get '/xrpc/app.bsky.feed.describeFeedGenerator' do
       return json({
         did: config.service_did,
-        feeds: config.all_feeds.map { |f| { uri: feed_uri(f) }}
+        feeds: config.feed_keys.map { |f| { uri: feed_uri(f) }}
       })
     end
 

data/lib/blue_factory/version.rb

@@ -1,3 +1,3 @@
 module BlueFactory
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blue_factory
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-13 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -24,7 +24,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Write a longer description or delete this line.
+description: "\n    BlueFactory is a Ruby library which helps you build a web service
+  that hosts custom feeds a.k.a. feed generators\n    for the Bluesky social network.
+  It implements a simple HTTP server based on Sinatra which provides the required\n
+  \   endpoints for the feed generator interface. You need to provide the content
+  for the feed by making a query to your\n    preferred local database.\n  "
 email:
 - jakub.suder@gmail.com
 executables: []
@@ -70,5 +74,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: A Ruby gem for hosting custom feeds for Bluesky
 test_files: []