reddit_post_to_markdown 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbcefef7bcf13e1fc6d417be5e2a5adf397f69931fbacae27855c0fc0d34e66e
-  data.tar.gz: 4cecd3cb2af8878a4766a12b7b33fc6eb7a47bcb957681f4ce7f83248c76a384
+  metadata.gz: 37b7ab66e1f79d44320d9e0faa596663be2849e1118c495a5ae58930a3fd3d9b
+  data.tar.gz: ffda7283ff6597b0a9b6098674fd76e617c1b9d0e8666605d816e743ea914f86
 SHA512:
-  metadata.gz: 3e5e54ea2bf6f039f889ee2d19020b7e9d7621f993722b0d1850969d48f67adcfe3ae1bcd26c15548e0512a6d40a3c56a342b9e206e368327925e9c60380ee61
-  data.tar.gz: fbfa20da94b37b834cfbcf88b6ae4f625aba540a0abe9ec0738e2fde074f0d9230545c9889ab93ddd7e555de2ac88457e6689f0c0f12189ab369b07353b69220
+  metadata.gz: 781345b4d59eb26e7118149590f116a1e69c2be3a77bbc64a4234793ace76b26318c634db722c5bf4a13b4db45485bdce61c2d68160cc7145e0ef5eccaee24ba
+  data.tar.gz: 31de8a980cd49b874dfed294515a1807dd52e349b478f6c608129c476cb6e6e33f9c37f0361d95b7e522a1a014ac8d1440ce386f658eef0b59f041161b095afd

data/lib/reddit_post_to_markdown/post_renderer.rb

@@ -114,7 +114,8 @@ module RedditPostToMarkdown
     end
 
     def post_url
-      @post_data.fetch("url", "")
+      permalink = @post_data.fetch("permalink", "")
+      permalink.empty? ? @post_data.fetch("url", "") : "https://www.reddit.com#{permalink}"
     end
 
     def post_created_utc
@@ -123,6 +124,13 @@ module RedditPostToMarkdown
 
     def post_image_urls
       image_urls = []
+
+      if @post_data["post_hint"] == "image"
+        url = @post_data["url"]
+        image_urls << url if url && !url.empty?
+        return image_urls
+      end
+
       media_metadata = @post_data["media_metadata"]
       # a hash of hashes with some sort of hashed keys we don't care about
       return image_urls unless media_metadata

data/lib/reddit_post_to_markdown/reddit_client.rb

@@ -23,10 +23,10 @@ module RedditPostToMarkdown
     # @raise [FetchError] if the server returns a non-2xx HTTP status
     # @raise [InvalidResponseError] if the parsed response is not a two-element
     #   Array
-    def fetch_post(url)
+    def fetch_post(url, user_agent: USER_AGENT)
       json_url = url.end_with?(".json") ? url : "#{url}.json"
 
-      response = self.class.get(json_url, headers: { "User-Agent" => USER_AGENT })
+      response = self.class.get(json_url, headers: { "User-Agent" => user_agent })
 
       raise FetchError, "HTTP #{response.code} fetching #{url}" unless response.success?
 

data/lib/reddit_post_to_markdown/url_validator.rb

@@ -28,19 +28,17 @@ module RedditPostToMarkdown
       PATTERNS.any? { |pattern| url.match?(pattern) }
     end
 
-    # Strips common tracking parameters and the trailing slash from a Reddit URL.
+    # Strips the query string and trailing slash from a Reddit URL.
     #
-    # Removes query strings beginning with +?utm_source+, +?ref=+, or
-    # +?context=+, then strips any trailing slash. Leading and trailing
-    # whitespace is also removed.
+    # Removes everything from the first +?+ onward (tracking params, share IDs,
+    # etc. are never needed to fetch the post JSON), then strips any trailing
+    # slash. Leading and trailing whitespace is also removed.
     #
     # @param url [String] the URL to clean
     # @return [String] the cleaned URL
     def self.clean_url(url)
       url = url.to_s.strip
-      url = url.split("?utm_source").first
-      url = url.split("?ref=").first
-      url = url.split("?context=").first
+      url = url.split("?").first
       url.chomp("/")
     end
   end

data/lib/reddit_post_to_markdown/version.rb

@@ -1,3 +1,3 @@
 module RedditPostToMarkdown
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/reddit_post_to_markdown.rb

@@ -1,3 +1,6 @@
+warn "[DEPRECATION] reddit_post_to_markdown is deprecated and no longer maintained. " \
+     "Reddit is shutting down unauthenticated access to post JSON, so this gem no longer works."
+
 require_relative "reddit_post_to_markdown/version"
 require_relative "reddit_post_to_markdown/errors"
 require_relative "reddit_post_to_markdown/url_validator"

data/reddit_post_to_markdown.gemspec

@@ -4,12 +4,24 @@ Gem::Specification.new do |spec|
   spec.name        = "reddit_post_to_markdown"
   spec.version     = RedditPostToMarkdown::VERSION
   spec.authors     = ["masukomi"]
-  spec.summary     = "Download a public Reddit post and convert it to Markdown"
-  spec.description = "Takes the URL of a public Reddit post, downloads the post and its comments via the Reddit JSON API, and returns the content as a Markdown string."
+  spec.email       = ["masukomi@masukomi.org"]
+  spec.homepage    = "https://github.com/masukomi/reddit_post_to_markdown"
+  spec.summary     = "DEPRECATED: Download a public Reddit post and convert it to Markdown"
+  spec.description = "DEPRECATED and no longer maintained. Reddit is shutting down unauthenticated access to post JSON, so this gem no longer works. Originally: takes the URL of a public Reddit post, downloads the post and its comments via the Reddit JSON API, and returns the content as a Markdown string."
   spec.license     = "MIT"
 
+  spec.post_install_message = <<~MSG
+    WARNING: reddit_post_to_markdown is DEPRECATED and no longer maintained.
+    Reddit is shutting down unauthenticated access to post JSON, so this gem
+    no longer works. See #{spec.homepage} for details.
+  MSG
+
   spec.required_ruby_version = ">= 2.7"
 
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.org"
+
   spec.files = Dir["lib/**/*.rb", "reddit_post_to_markdown.gemspec"]
 
   spec.add_dependency "httparty", "~> 0.22"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reddit_post_to_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - masukomi
@@ -51,8 +51,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.26'
-description: Takes the URL of a public Reddit post, downloads the post and its comments
-  via the Reddit JSON API, and returns the content as a Markdown string.
+description: 'DEPRECATED and no longer maintained. Reddit is shutting down unauthenticated
+  access to post JSON, so this gem no longer works. Originally: takes the URL of a
+  public Reddit post, downloads the post and its comments via the Reddit JSON API,
+  and returns the content as a Markdown string.'
+email:
+- masukomi@masukomi.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,9 +68,17 @@ files:
 - lib/reddit_post_to_markdown/url_validator.rb
 - lib/reddit_post_to_markdown/version.rb
 - reddit_post_to_markdown.gemspec
+homepage: https://github.com/masukomi/reddit_post_to_markdown
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/masukomi/reddit_post_to_markdown
+  source_code_uri: https://github.com/masukomi/reddit_post_to_markdown
+  changelog_uri: https://github.com/masukomi/reddit_post_to_markdown/CHANGELOG.org
+post_install_message: |
+  WARNING: reddit_post_to_markdown is DEPRECATED and no longer maintained.
+  Reddit is shutting down unauthenticated access to post JSON, so this gem
+  no longer works. See https://github.com/masukomi/reddit_post_to_markdown for details.
 rdoc_options: []
 require_paths:
 - lib
@@ -83,5 +95,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.7
 specification_version: 4
-summary: Download a public Reddit post and convert it to Markdown
+summary: 'DEPRECATED: Download a public Reddit post and convert it to Markdown'
 test_files: []