feed2gram 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 186b11421ce39cc03f041f010e695fbd295edb0631235d80545e42928fe6edca
-  data.tar.gz: 688601d45092f6f1c57c9871af2b337c7df93f441ccefc6b787e01169a8bd236
+  metadata.gz: 6be6dddfdc2c228de285536b0fbefd7a5f1d34d864fd625e21c996307cc439f1
+  data.tar.gz: 35509d9f7bfacf70bce7ce37fdba2ddae9bb783171a561aad80b27b5ba9b0546
 SHA512:
-  metadata.gz: 4682d5d13f8443ebb0cdc853394fb9e8a0c8677a0e4850daaa0df8feb54d9fcc73cc64eb5c41368dd14c958e8a5be25fe50e2c8a006602d66751161c411c9e13
-  data.tar.gz: 7ca4d2096fa0b0b60df85c0f902f312ab27083a2ec9b7b0590951315370b3dd74fee02c92781ebdc7347945a5dc7142ac9f1204cbfe468125bd523c4b5509964
+  metadata.gz: cf84920a3113a0bbe9c73790171e8216846aa4f7d66edeabd4ae9f58b71857a65c81630f1cc5eab094b1fe246ae5069a6086e2a798d39f9a925e3c4c2e3951cb
+  data.tar.gz: 3176d62ca5a41b2de36cf695771579de800fb3346ae83aa31d51d0716b780afb29dc1a49a268d2c32caf14d351120fcf7fad533e828ce38566089d446bcec63f

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [1.2.1]
+
+* Add `SECONDS_PER_UPLOAD_CHECK` and `MAX_UPLOAD_STATUS_CHECKS` env vars
+
+## [1.2.0]
+
+* Add support for the `cover_url` property for reel posts by way of a
+`data-cover-url` attribute on the `<img>` tag of single-video posts..
+
 ## [1.1.0]
 
 * Add support for videos and stories, including:

data/README.md

@@ -96,6 +96,14 @@ Usage: feed2gram [options]
   --populate-cache     Populate the cache file with any posts found in the feed WITHOUT posting them to Instagram
 ```
 
+## Environment variables
+
+These environment variables can be set to augment the gem's behavior:
+
+* `SECONDS_PER_UPLOAD_CHECK` - when uploading video, feed2gram must wait until
+the [status code](https://tiagogrosso.github.io/instagram-graph-api-lib/enums/CONTAINER_STATUS_CODE.html) on the media indicates it is published. This variable determines how many seconds to wait between each check (defaults to 30 seconds). Shortening this value can lead to hitting one's hourly rate limit
+* `MAX_UPLOAD_STATUS_CHECKS` - how many status checks to perform before giving up on a piece of media and calling the post failed. Unfortunately, Facebook's servers can take anywhere from 15 seconds to 15 hours to download and process even trivially small videos, so GLHF
+
 ## Formatting your Atom feed's HTML
 
 feed2gram uses the first `<figure>` element to generate each Instagram post. That `<figure>` can contain one or more `<img>` tags and one `<figcaption>` tag, which will be used as the post's image(s) and caption, respectively.
@@ -108,6 +116,7 @@ Some things to keep in mind:
 * If one `<img>` tag is present, a single photo post will be created. If there are more, a [carousel post](https://developers.facebook.com/docs/instagram-api/guides/content-publishing/#carousel-posts) will be created
 * Because Facebook's servers actually _download your image_ as opposed to receiving them as uploads via the API, every `<img>` tag's `src` attribute must be set to a publicly-reachable, fully-qualified URL
 * To post videos, stories, or reels, set the `data-media-type` attribute on the `<img>` tag to `video` or `image` (a media type of `image` will be assumed by default if left unspecified). Note that while `image` and `video` media may be interspersed throughout a carousel
+* For video (reel) posts containing a single video, you can set `data-cover-url` on the `<img>` tag to a publicly-available URL and the Instagram API will use it as a custom thumbnail for the reel
 * For carousel posts, the aspect ratio of the first image determines the aspect ratio of the rest, so be mindful of how you order the images based on how you want them to appear in the app
 * Only one caption will be published, regardless of whether it's a single photo post or a carousel
 * The caption limit is 2200 characters, so feed2gram will truncate it if necessary

data/example/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "rackup"
+gem "sinatra"
+
+gem "feed2gram", path: ".."

data/example/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: ..
+  specs:
+    feed2gram (1.2.1)
+      nokogiri (~> 1.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base64 (0.2.0)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    nokogiri (1.16.2-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.2-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.2-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.2-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.7.3)
+    rack (3.0.9)
+    rack-protection (4.0.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    ruby2_keywords (0.0.5)
+    sinatra (4.0.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.0.0)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
+    tilt (2.3.0)
+    webrick (1.8.1)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  feed2gram!
+  rackup
+  sinatra
+
+BUNDLED WITH
+   2.5.4

data/example/sample.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-us">
+  <id>https://gram.betterwithbecky.com/syndications/grams</id>
+  <title>Beckygram</title>
+  <updated>2024-02-09T12:41:16Z</updated>
+  <author>
+    <name>Becky Searls</name>
+    <email>becky@betterwithbecky.com</email>
+  </author>
+  <link href="https://gram.betterwithbecky.com/" rel="alternate" type="text/html" title="HTML"/>
+  <link href="https://gram.betterwithbecky.com/syndications/grams" rel="self" type="application/atom+xml" title="Grams"/>
+  <category term="Fitness"/>
+  <generator uri="https://rubyonrails.org/" version="0.119.0">
+Ruby on Rails  </generator>
+  <icon>https://gram.betterwithbecky.com/favicon.ico</icon>
+  <logo>https://static-cdn.betterwithbecky.com/assets/logo-fa728624cb9c92f3e052ee6b58a653d8e64fda32.png</logo>
+  <rights>Copyright Build with Becky LLC. All rights reserved.</rights>
+  <subtitle>What you're getting when you get Better with Becky.</subtitle>
+  <entry>
+    <id>https://gram.betterwithbecky.com/posts/1/whatever</id>
+    <title type="text">Test Title</title>
+    <link href="https://gram.betterwithbecky.com/posts/1/whatever" rel="alternate" type="text/html"/>
+    <author>
+      <name>Becky Searls</name>
+      <email>becky@example.com</email>
+    </author>
+    <published>2024-02-04T14:59:00Z</published>
+    <updated>2024-02-09T12:41:16Z</updated>
+    <content type="html"><![CDATA[
+      <figure data-post-type="post">
+        <img data-media-type="video" data-cover-url="https://upload.wikimedia.org/wikipedia/commons/7/7c/Aspect_ratio_16_9_example.jpg" src="https://static.videezy.com/system/resources/previews/000/032/359/original/MM008645___BOUNCING_FRUIT_009___1080p___phantom.mp4"/>"
+        <figcaption>
+          Nothing to see here. Just a test post.
+        </figcaption>
+      </figure>
+    ]]></content>
+  </entry>
+</feed>

data/example/server.rb

@@ -0,0 +1,9 @@
+require "sinatra"
+
+feed_file = ARGV[0] || "sample.xml"
+raise "Usage: script/server <path/to/xml/file>" unless File.exist?(feed_file)
+puts "Hosting '#{feed_file}' on port 4567"
+
+get "/" do
+  send_file feed_file
+end

data/lib/feed2gram/parses_entries.rb

@@ -2,7 +2,7 @@ require "nokogiri"
 require "open-uri"
 
 module Feed2Gram
-  Media = Struct.new(:media_type, :url, keyword_init: true) do
+  Media = Struct.new(:media_type, :url, :cover_url, keyword_init: true) do
     def video?
       media_type == "VIDEO"
     end
@@ -17,7 +17,8 @@ module Feed2Gram
         medias = html.xpath("//figure[1]/img").map { |img|
           Media.new(
             media_type: (img["data-media-type"] || "image").upcase,
-            url: img["src"]
+            url: img["src"],
+            cover_url: img["data-cover-url"]
           )
         }
 

data/lib/feed2gram/publishes_posts.rb

@@ -33,6 +33,7 @@ module Feed2Gram
         :media_type => post.media_type,
         :caption => post.caption,
         :access_token => config.access_token,
+        :cover_url => media.cover_url,
         media.video? ? :video_url : :image_url => media.url
       }.compact)[:id]
 
@@ -80,12 +81,14 @@ module Feed2Gram
       Result.new(post: post, status: :posted)
     end
 
+    SECONDS_PER_UPLOAD_CHECK = ENV.fetch("SECONDS_PER_UPLOAD_CHECK") { 30 }
+    MAX_UPLOAD_STATUS_CHECKS = ENV.fetch("MAX_UPLOAD_STATUS_CHECKS") { 100 }
     # Good ol' loop-and-sleep. Haven't loop do'd in a while
     def wait_for_media_to_upload!(url, container_id, config, options)
       wait_attempts = 0
       loop do
-        if wait_attempts > 90
-          warn "Giving up waiting for media to upload after waiting 120 seconds: #{url}"
+        if wait_attempts > MAX_UPLOAD_STATUS_CHECKS
+          warn "Giving up waiting for media to upload after waiting #{SECONDS_PER_UPLOAD_CHECK * MAX_UPLOAD_STATUS_CHECKS} seconds: #{url}"
           break
         end
 
@@ -93,12 +96,12 @@ module Feed2Gram
           fields: "status_code",
           access_token: config.access_token
         })
-        puts "Upload status #{res[:status_code]} after #{wait_attempts + 1} check for #{url}" if options.verbose
+        puts "Upload status #{res[:status_code]} after waiting #{wait_attempts * SECONDS_PER_UPLOAD_CHECK} seconds for IG to download #{url}" if options.verbose
         if res[:status_code] == "FINISHED"
           break
         elsif res[:status_code] == "IN_PROGRESS"
           wait_attempts += 1
-          sleep 1
+          sleep SECONDS_PER_UPLOAD_CHECK
         else
           warn "Unexpected status code (#{res[:status_code]}) uploading: #{url}"
           break

data/lib/feed2gram/version.rb

@@ -1,3 +1,3 @@
 module Feed2Gram
-  VERSION = "1.1.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feed2gram
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-26 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,6 +38,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/Gemfile
+- example/Gemfile.lock
+- example/sample.xml
+- example/server.rb
 - exe/feed2gram
 - lib/feed2gram.rb
 - lib/feed2gram/filters_posts.rb
@@ -73,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Reads an Atom feed and posts its entries to Instagram