feed2gram 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f8b1df08d5636342c7517691d0f4bce4cc4d89f261368f730d62d9392a6d8a7
-  data.tar.gz: e617c168c1c999be12ce2d263ca823b90777639f7d51003ac809e7660e9ef0c9
+  metadata.gz: c053ce1eafec6ed200dc7ed549fb25e7bc22fcd78fa6b92c773673d47aeba056
+  data.tar.gz: 767a90bd8534d43f0e9bef8ef73e8e577bd959ade67ebabe639ac96d6bde4828
 SHA512:
-  metadata.gz: 9af47b0dadb5db2cbaa1c0208fd1873fd40e310646433c416635dbad2657ed05e591d212bc13819c6038a144c7d3523b9b61e932d91bb8bc012237cac6df0938
-  data.tar.gz: f96cfbc1ba2e994b56943179906130211bd9f992828059d59b2da197f7607ad7402ae5699bb67270a944775feccd3cae3a5f184b3d6ec8b87493271fcaaeb428
+  metadata.gz: 57c2490cf9aee77fa40d5dffceaeddb3ac71e2d23d8b44d962b87e10caa295079c9e8772d7986b0db37f2a5a826a838c5ec7cdd7355d2c0bb6704acc0b58493d
+  data.tar.gz: e6e39cc6033dab9c32e958c413790b2d0c8eacbe1e6d7175108df34ed2894ad2ecbb305e98ab88891fd3e8600243849dbb22dda4b73fbe3c4f0ed76096125055

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.0.4]
+
+* Optimize the size of the Docker image (about 85% reduction)
+
+## [0.0.3]
+
+* Fix the `--populate-cache` so that all entries are marked `skipped`
+* Include a `bin/daemon` script
+* Ship a Dockerfile to build an image that can run feed2gram on a schedule
+
 ## [0.0.2] - 2023-10-29
 
 - Initial release

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:3.2.2-alpine
+
+LABEL org.opencontainers.image.source=https://github.com/searls/feed2gram
+LABEL org.opencontainers.image.description="Reads an Atom feed and posts its entries to Instagram (basically feed2toot, but for Instagram)"
+LABEL org.opencontainers.image.licenses=GPLv3
+
+WORKDIR /srv
+COPY Gemfile Gemfile.lock feed2gram.gemspec ./
+COPY lib/feed2gram/version.rb lib/feed2gram/
+RUN apk update && \
+    apk add autoconf bash git gcc make musl-dev && \
+    bundle install && \
+    apk del --purge --rdepends git gcc autoconf make musl-dev
+ADD . .
+VOLUME /config
+CMD ["--config", "/config/feed2gram.yml"]
+ENTRYPOINT ["/srv/bin/daemon"]

data/README.md

@@ -1,4 +1,4 @@
-# Feed2Gram
+# feed2gram
 
 I've joined the [POSSE](https://indieweb.org/POSSE) and publish as much as I can
 to [justin.searls.co](https://justin.searls.co) and syndicate it elsewhere.  I'm
@@ -87,7 +87,7 @@ run.
 For available options, run `feed2gram --help`:
 
 ```
-$ ./script/run --help
+$ feed2gram --help
 Usage: feed2gram [options]
   --config PATH        Path of feed2gram YAML configuration (default: feed2gram.yml)
   --cache-path PATH    Path of feed2gram's cache file to track processed entries (default: feed2gram.cache.yml)
@@ -147,6 +147,58 @@ See more at http://localhost:1313/
 </entry>
 ```
 
+## Running continuously with Docker
+
+We publish a Docker image [using GitHub
+actions](https://github.com/searls/feed2gram/blob/main/.github/workflows/main.yml)
+tagged as `latest` for every new commit to the `main` branch, as well as with a
+release tag tracking every release of the gem on
+[rubygems.org](https://rubygems.org). The images are hosted [here on GitHub's
+container
+registry](https://github.com/searls/feed2gram/pkgs/container/feed2gram)
+
+
+You can also use Docker to run this on your own automation platform like Proxmox or Kubernetes.
+
+```
+$ docker run --rm -it \
+  -v ./your_config_dir:/srv/config
+  ghcr.io/searls/feed2gram
+```
+
+To configure the container, there are just four things to know:
+
+1. A volume containing your configuration and cache files must be mounted to `/config`
+2. By default, feed2gram will run with `--config /config/feed2gram.yml`, but you can
+customize this by configuring the command value as needed
+3. By default, feed2gram is run as a daemon every 60 seconds, and that duration can be overridden
+by setting a `SLEEP_TIME` environment variable to the number of seconds you'd like
+to wait between runs
+4. If you'd rather run `feed2gram` as ad hoc as opposed to via the included daemon
+(presumably to handle scheduling it yourself), simply change the entrypoint to
+`/srv/exe/feed2gram`
+
+### Running the docker image specifically on your Synology NAS
+
+I run this on my [Synology DS 920+](https://www.pcmag.com/reviews/synology-diskstation-ds920-plus), using the [DSM's Container Manager](https://www.synology.com/en-global/dsm/feature/container-manager) app.
+
+There are just a few things to know to set this up:
+
+At the time of this writing, the `Action > Import > Add from URL` feature of the Container Manager's
+"Image" tab does not support GitHub Container Registry URLs. However, if you connect [via SSH](https://kb.synology.com/en-my/DSM/tutorial/How_to_login_to_DSM_with_root_permission_via_SSH_Telnet):
+
+```
+$ sudo -s
+# Enter your user password.
+$ docker pull ghcr.io/searls/feed2gram:latest
+```
+
+Once downloaded, the image will appear in the app. From there, select
+`ghcr.io/searls/feed2gram`, hit Run, and complete the wizard, setting any custom
+command line flags (once the container is created, this cannot be edited), as
+well as choosing a location to mount the `/config` volume and setting a
+`SLEEP_TIME` environment variable (these can be changed after the fact).
+
 ## Frequently Asked Questions
 
 ### Why didn't my post show up?
@@ -166,3 +218,4 @@ The submitted image with aspect ratio ('719/194',) cannot be published. Please s
 It means your photo is too avant garde for a mainstream normie platform like
 Instagram. Make sure all images' aspect ratiosa re between 4:5 and 1.91:1 or
 else the post will fail.
+

data/lib/feed2gram/loads_cache.rb

@@ -6,11 +6,13 @@ module Feed2Gram
   end
 
   class LoadsCache
-    def load(cache_path)
-      if File.exist?(cache_path)
-        yaml = YAML.load_file(cache_path, permitted_classes: [Time])
+    def load(options)
+      if File.exist?(options.cache_path)
+        puts "Loading cache from: #{options.cache_path}" if options.verbose
+        yaml = YAML.load_file(options.cache_path, permitted_classes: [Time])
         Cache.new(**yaml)
       else
+        puts "No cache found (looked at '#{options.cache_path}'), initializing a new one" if options.verbose
         Cache.new(posted: [], failed: [], skipped: [])
       end
     end

data/lib/feed2gram/loads_config.rb

@@ -17,8 +17,9 @@ module Feed2Gram
   end
 
   class LoadsConfig
-    def load(config_path)
-      yaml = YAML.load_file(config_path, permitted_classes: [Time])
+    def load(options)
+      puts "Loading config from: #{options.config_path}" if options.verbose
+      yaml = YAML.load_file(options.config_path, permitted_classes: [Time])
       Config.new(**yaml)
     end
   end

data/lib/feed2gram/parses_options.rb

@@ -1,7 +1,7 @@
 require "optparse"
 
 module Feed2Gram
-  Options = Struct.new(:config_path, :cache_path, :limit, :skip_token_refresh, :populate_cache, keyword_init: true) do
+  Options = Struct.new(:config_path, :cache_path, :limit, :skip_token_refresh, :populate_cache, :verbose, keyword_init: true) do
     undef_method :cache_path
     def cache_path
       @cache_path || config_path.sub(/\.yml$/, ".cache.yml")
@@ -36,6 +36,10 @@ module Feed2Gram
         opts.on "--populate-cache", "Populate the cache file with any posts found in the feed WITHOUT posting them to Instagram" do
           options.populate_cache = true
         end
+
+        opts.on "-v", "--verbose", "Enable verbose output" do
+          options.verbose = true
+        end
       end.parse!(argv)
 
       options

data/lib/feed2gram/publishes_posts.rb

@@ -2,13 +2,18 @@ module Feed2Gram
   Result = Struct.new(:post, :status, keyword_init: true)
 
   class PublishesPosts
-    def publish(posts, config, limit)
+    def publish(posts, config, options)
+      post_limit = options.limit || posts.size
+      puts "Publishing #{post_limit} posts to Instagram" if options.verbose
+
       # reverse to post oldest first (most Atom feeds are reverse-chronological)
-      posts.reverse.take(limit || posts.size).map { |post|
+      posts.reverse.take(post_limit).map { |post|
         begin
           if post.images.size == 1
+            puts "Publishing single image post for: #{post.url}" if options.verbose
             publish_single_image(post, config)
           else
+            puts "Publishing carousel post for: #{post.url}" if options.verbose
             publish_carousel(post, config)
           end
         rescue => e

data/lib/feed2gram/refreshes_token.rb

@@ -1,9 +1,10 @@
 module Feed2Gram
   class RefreshesToken
-    def refresh!(config, config_path)
+    def refresh!(config, options)
       return unless config.access_token_refreshed_at.nil? ||
         config.access_token_refreshed_at < Time.now - (60 * 60)
 
+      puts "Refreshing Facebook OAuth token" if options.verbose
       data = Http.get("/oauth/access_token", {
         grant_type: "fb_exchange_token",
         client_id: config.facebook_app_id,
@@ -14,7 +15,8 @@ module Feed2Gram
       config.access_token = data[:access_token]
       config.access_token_refreshed_at = Time.now.utc
 
-      File.write(config_path, config.as_yaml)
+      puts "Updating Facebook OAuth token in: #{options.config_path}" if options.verbose
+      File.write(options.config_path, config.as_yaml)
     end
   end
 end

data/lib/feed2gram/updates_cache.rb

@@ -1,6 +1,6 @@
 module Feed2Gram
   class UpdatesCache
-    def update!(cache, results, cache_path)
+    def update!(cache, results, options)
       cache.updated_at = Time.now
       results.group_by { |result| result.status }
         .transform_values { |results| results.map { |result| result.post.url } }
@@ -8,7 +8,8 @@ module Feed2Gram
         cache[status] += urls
       end
 
-      File.write(cache_path, cache.as_yaml)
+      puts "Writing updated cache to: #{options.cache_path}" if options.verbose
+      File.write(options.cache_path, cache.as_yaml)
     end
   end
 end

data/lib/feed2gram/version.rb

@@ -1,3 +1,3 @@
 module Feed2Gram
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/feed2gram.rb

@@ -18,16 +18,20 @@ module Feed2Gram
   end
 
   def self.run(options)
-    config = LoadsConfig.new.load(options.config_path)
-    RefreshesToken.new.refresh!(config, options.config_path) unless options.skip_token_refresh
+    config = LoadsConfig.new.load(options)
+    RefreshesToken.new.refresh!(config, options) unless options.skip_token_refresh
 
-    cache = LoadsCache.new.load(options.cache_path)
-    posts = FiltersPosts.new.filter(ParsesEntries.new.parse(config.feed_url), cache)
+    cache = LoadsCache.new.load(options)
+    puts "Loading entries from feed: #{config.feed_url}" if options.verbose
+    entries = ParsesEntries.new.parse(config.feed_url)
+    puts "Found #{entries.size} entries in feed" if options.verbose
+    posts = FiltersPosts.new.filter(entries, cache)
     results = if options.populate_cache
-      posts.map { |post| Result.new(post: post, status: [:skipped, :failed, :posted].sample) }
+      puts "Populating cache, marking #{posts.size} posts as skipped" if options.verbose
+      posts.map { |post| Result.new(post: post, status: :skipped) }
     else
-      PublishesPosts.new.publish(posts, config, options.limit)
+      PublishesPosts.new.publish(posts, config, options)
     end
-    UpdatesCache.new.update!(cache, results, options.cache_path)
+    UpdatesCache.new.update!(cache, results, options)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feed2gram
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -34,6 +34,7 @@ extra_rdoc_files: []
 files:
 - ".standard.yml"
 - CHANGELOG.md
+- Dockerfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -72,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Reads an Atom feed and posts its entries to Instagram