searchlink 2.3.83 → 2.3.84

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d9d44b58260a556b6834758e6782fe1b0b0d6ebb43ed79c88b3ecee9d53d124
-  data.tar.gz: a10d673938b4a58c907b2588fedaf4e71f021d5f85d392cbc17c144dea91c3b8
+  metadata.gz: 78ae4255b0a3a287ce3ccf4b84db34597f8c2a566bf4e7cb0b4939a28f62cca1
+  data.tar.gz: f654c706f574f6c23dca1a6714b2b52177944379fb1df00d34d9bac22e14104b
 SHA512:
-  metadata.gz: e1a3d23ee5be311f69772b5f46a72a9c18b9684a22d62af561d6c1421ab13343df8b6f233e00ba6811748d5b2cf31c91886d45fae4fff94e797ecca10a285b65
-  data.tar.gz: 8100ed794563d9747bce2be4b1b2a13e6475331769ee5411a7c4c186089b01bde9536c17002bffdd8c4821db11d185590b9de3d6b8c42b27175540e2cdae945c
+  metadata.gz: ecccb8b8f87a8aa891c9bbafffd7e40f9ecee5ee8042326fe8e0151d52e225797bcff745c7ec67b7f7dd8010fd5e32330673b3fe062c378873a74407b666205a
+  data.tar.gz: 6a4ada563e8488646f0cc4fe5ab8c5414c906ead7560cafaf3e6b68fcdf9292a37c04ab8261970de6d5a3a3224dc135a3dba7bc2b2abc60160ca6181dbec512c

data/lib/searchlink/curl/html.rb

@@ -111,7 +111,7 @@ module Curl
     def extract_tag_contents(tag, source: false)
       return @body.scan(%r{<#{tag}.*?>(?:.*?</#{tag}>)?}) if source
 
-      @body.scan(/<#{tag}.*?>(.*?)</).map { |t| t[0] }
+      @body.scan(/<#{tag}.*?>(.*?)</).map { |t| t[1] }
     end
 
     ##

data/lib/searchlink/parse.rb

@@ -386,10 +386,10 @@ module SL
                 m = Regexp.last_match
 
                 search_type = if m[1].nil?
-                    SL::GoogleSearch.api_key? ? "gg" : "g"
-                  else
-                    m[1]
-                  end
+                                SL::GoogleSearch.api_key? ? "gg" : "g"
+                              else
+                                m[1]
+                              end
 
                 search_terms = m[2].gsub(/(^["']|["']$)/, "")
                 search_terms.strip!
@@ -414,6 +414,12 @@ module SL
                 link_only = true if search_terms =~ /!!\^?$/
 
                 search_terms = search_terms.sub(/(!!)?\^?(!!)?$/, "")
+
+                if search_type =~ /^(\S+\.)+\S+$/
+                  search_type = "g"
+                  search_terms = "site:#{m[1]} #{search_terms}"
+                end
+
               elsif link_info =~ /^!/
                 search_word = link_info.match(/^!(\S+)/)
 

data/lib/searchlink/searches/bitly.rb

@@ -14,11 +14,12 @@ module SL
           config: [
             {
               key: "bitly_access_token",
-              value: "xxxx",
-              required: false,
+              value: "",
+              required: true,
               description: "Generate an access token at https://app.bitly.com/settings/api/"
             },
             {
+              description: "Bit.ly domain (optional).",
               key: "bitly_domain",
               value: "bit.ly",
               required: false
@@ -31,32 +32,56 @@ module SL
         if SL::URL.url?(search_terms)
           link = search_terms
         else
-          link, rtitle = SL.ddg(search_terms, link_text)
+          link, title, link_text = SL.ddg(search_terms, link_text)
         end
 
-        url, title = bitly_shorten(link, rtitle)
-        link_text = title || url
-        [url, title, link_text]
-      end
+        url = shorten(link)
 
-      def bitly_shorten(url, title = nil)
-        unless SL.config.key?("bitly_access_token") && !SL.config["bitly_access_token"].empty?
-          SL.add_error("Bit.ly not configured", "Missing access token")
-          return [false, title]
+        unless url
+          SL.add_error("Result is not a valid URL", "URL error")
+          return [false, title, link_text]
         end
 
+        format_response(url, link, link_text)
+      end
+
+      def shorten(url)
+        return false unless bitly_config?
+
         domain = SL.config.key?("bitly_domain") ? SL.config["bitly_domain"] : "bit.ly"
-        long_url = url.dup
-        curl = TTY::Which.which("curl")
-        cmd = [
-          %(#{curl} -SsL -H 'Authorization: Bearer #{SL.config['bitly_access_token']}'),
-          %(-H 'Content-Type: application/json'),
-          "-X POST", %(-d '{ "long_url": "#{url}", "domain": "#{domain}" }'), "https://api-ssl.bitly.com/v4/shorten"
-        ]
-        data = JSON.parse(`#{cmd.join(" ")}`.strip)
-        link = data["link"]
-        title ||= SL::URL.title(long_url)
-        [link, title]
+        url.dup
+
+        headers = {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{SL.config['bitly_access_token']}"
+        }
+        data_obj = {
+          "long_url" => url,
+          "domain" => domain
+        }
+        data = Curl::Json.new("https://api-ssl.bitly.com/v4/shorten", data: data_obj.to_json, headers: headers, symbolize_names: true)
+
+        return false unless data.json.key?(:link)
+
+        link = data.json[:link]
+
+        return false unless SL::URL.valid_link?(link)
+
+        link
+      end
+
+      private
+
+      def bitly_config?
+        return true if SL.config["bitly_access_token"] && !SL.config["bitly_access_token"].empty?
+
+        SL.add_error("Bit.ly not configured", "Missing access token")
+        false
+      end
+
+      def format_response(link, original_url, link_text)
+        rtitle = SL::URL.title(original_url)
+        [link, rtitle, link_text == "" && !SL.titleize ? rtitle : link_text]
       end
     end
 

data/lib/searchlink/searches/github.rb

@@ -25,6 +25,9 @@ module SL
       end
 
       def search(search_type, search_terms, link_text)
+        @auth_token = Secrets::GH_AUTH_TOKEN if defined? Secrets::GH_AUTH_TOKEN
+        @auth_token = SL.config["github_token"] if SL.config.key?("github_token") && !SL.config["github_token"].empty?
+
         case search_type
         when /^gist/
           url, title, link_text = gist(search_terms, search_type, link_text)
@@ -46,7 +49,7 @@ module SL
           "Accept" => "application/vnd.github+json",
           "X-GitHub-Api-Version" => "2022-11-28"
         }
-        headers["Authorization"] = "Bearer #{Secrets::GH_AUTH_TOKEN}" if defined? Secrets::GH_AUTH_TOKEN
+        headers["Authorization"] = "Bearer #{@auth_token}" if defined? @auth_token
 
         url = "https://api.github.com/search/#{endpoint}?q=#{query.url_encode}&per_page=1&page=1&order=desc"
         res = Curl::Json.new(url, headers: headers)
@@ -163,6 +166,8 @@ module SL
       end
 
       def filter_gists(gists, search_terms)
+        return false if gists.is_a?(Hash)
+
         score = 0
         gists.map! do |g|
           {
@@ -238,7 +243,7 @@ module SL
         end
 
         # Assuming we retrieved a full gist URL
-        if url =~ %r{https://gist.github.com/(?:(?<user>[^/]+)/)?(?<id>[a-z0-9]+?)(?:[#/](?<file>(?:file-)?.*?))?$}
+        if url && url =~ %r{https://gist.github.com/(?:(?<user>[^/]+)/)?(?<id>[a-z0-9]+?)(?:[#/](?<file>(?:file-)?.*?))?$}
           m = Regexp.last_match
           user = m["user"]
           id = m["id"]

data/lib/searchlink/searches/google.rb

@@ -43,7 +43,7 @@ module SL
           return false
         end
 
-        url = "https://customsearch.googleapis.com/customsearch/v1?cx=338419ee5ac894523&q=#{ERB::Util.url_encode(search_terms)}&num=1&key=#{@api_key}"
+        url = "https://customsearch.googleapis.com/customsearch/v1?cx=338419ee5ac894523&q=#{ERB::Util.url_encode(search_terms.gsub(/%22/, '"'))}&num=1&key=#{@api_key}"
         json = Curl::Json.new(url).json
 
         if json["error"] && json["error"]["code"].to_i == 429

data/lib/searchlink/searches/isgd.rb

@@ -17,29 +17,26 @@ module SL
         if SL::URL.url?(search_terms)
           link = search_terms
         else
-          link, rtitle = SL.ddg(search_terms, link_text)
+          link, title, link_text = SL.ddg(search_terms, link_text)
         end
 
-        url, title = isgd_shorten(link, rtitle)
-        link_text = title || url
+        url = shorten(link)
+        title = SL::URL.title(link) if title.nil? || title.empty?
+        link_text = title if (link_text.nil? || link_text.empty?) && !SL.titleize
         [url, title, link_text]
       end
 
-      def isgd_shorten(url, title = nil)
+      def shorten(url)
         long_url = url.dup
 
         data = Curl::Json.new("https://is.gd/create.php?format=json&url=#{CGI.escape(long_url)}", symbolize_names: true)
 
         if data.json.key?("errorcode")
           SL.add_error("Error creating is.gd url", data.json[:errorcode])
-          return [false, title, link_text]
+          return false
         end
 
-        link = data.json[:shorturl]
-        rtitle = SL::URL.title(long_url)
-        title = rtitle
-        link_text = rtitle if link_text == "" && !SL.titleize
-        [link, title, link_text]
+        data.json[:shorturl]
       end
     end
 

data/lib/searchlink/searches/linkding.rb

@@ -10,6 +10,20 @@ module SL
           trigger: "(ld|ding)",
           searches: [
             [%w[ld ding], "Linkding Bookmark Search"]
+          ],
+          config: [
+            {
+              description: "Linkding server URL.",
+              key: "linkding_server",
+              value: "''",
+              required: true
+            },
+            {
+              description: "Linkding API key.\nYou can find your api key here: https://your_server/settings/integrations",
+              key: "linkding_api_key",
+              value: "''",
+              required: true
+            }
           ]
         }
       end
@@ -108,7 +122,7 @@ module SL
         cache
       end
 
-      # Search pinboard bookmarks
+      # Search linkding bookmarks
       # Begin query with '' to force exact matching (including description text)
       # Regular matching searches for each word of query and scores the bookmarks
       # exact matches in title get highest score
@@ -120,13 +134,13 @@ module SL
       #
       # Exact matching is case and punctuation insensitive
       def search(_, search_terms, link_text)
-        unless SL.config["linkding_server"]
+        unless SL.config["linkding_server"] && !SL.config["linkding_server"].empty?
           SL.add_error("Missing Linkding server",
                        "add it to your configuration (linkding_server: https://YOUR_SERVER)")
           return false
         end
 
-        unless SL.config["linkding_api_key"]
+        unless SL.config["linkding_api_key"] && !SL.config["linkding_api_key"].empty?
           SL.add_error("Missing Linkding API token",
                        "Find your api key at https://your_server/settings/integrations and add it
                         to your configuration (linkding_api_key: YOURKEY)")

data/lib/searchlink/searches/setapp.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# Setapp Plugin
+# Takes an app name or Setapp URL, adds an affiliate string,
+# and outputs a URL, optionally shortened with is.gd or bit.ly
+#
+# Optional config:
+#
+# ```yaml
+# setapp_affiliate_string: xxxxxxxxx # see below
+# bitly_domain: bit.ly # or custom domain
+# bitly_access_token: xxxxxxxxxxxx # see below
+# ```
+#
+# To get your Setapp affiliate string
+#
+# 1. You must have a Setapp affiliate account through impact.com
+# 2. Generate a campaign url for an app landing page
+# 3. Follow the short link provided
+# 4. The browser URL bar will now show the expanded link
+# 5. Copy everything after the & symbol in the url to
+#    the `setapp_affiliate_string` config line
+#
+# Run a search with !set, !seti, or !setb. The input can either be
+# a Setapp app landing page url, or an app name, e.g. `!seti marked`,
+# `[jump desktop](!seti)`, or `!setb https://setapp.com/apps/marked`
+#
+module SL
+  # is.gd link shortening
+  class SetappSearch
+    class << self
+      def settings
+        {
+          trigger: "set[ib]?",
+          searches: [
+            ["set", "Setapp Link with optional affiliate string"],
+            ["seti", "Shorten Setapp Affiliate Link with is.gd"],
+            ["setb", "Shorten Setapp Affiliate Link with bit.ly"]
+          ],
+          config: [
+            {
+              description: "Setapp affiliate string (optional).\nYou can find your affiliate string here: https://www.impact.com/affiliate/links",
+              key: "setapp_affiliate_string",
+              value: "''",
+              required: false
+            }
+          ]
+        }
+      end
+
+      def search(search_type, search_terms, link_text)
+        link = build_link(search_terms)
+        link, rtitle, link_text = process_link(link, search_terms, link_text)
+        return [false, rtitle, link_text] unless valid_setapp_url?(link)
+
+        process_search_type(search_type, link, rtitle, link_text)
+      end
+
+      private
+
+      def build_link(search_terms)
+        return search_terms if SL::URL.url?(search_terms)
+
+        "https://setapp.com/apps/#{CGI.escape(search_terms.gsub(/ \d+$/, '').gsub(/ +/, '-').downcase)}"
+      end
+
+      def process_link(link, search_terms, link_text)
+        SL::URL.valid_link?(link, 2) && [link, search_terms, link_text] || SL.ddg("site:setapp.com #{search_terms}", link_text)
+      end
+
+      def process_search_type(search_type, link, title, link_text)
+        link_text = link_text.nil? || link_text.empty? ? Curl::Html.new(link).title.sub(/ on Setapp.*/, "") : link_text
+        link = build_affiliate_url(link)
+        case search_type
+        when "set"
+          format_response(link, link_text)
+        when "seti"
+          shorten(:isgd, link, title, link_text)
+        when "setb"
+          shorten(:bitly, link, title, link_text)
+        else
+          SL.add_error("Invalid search type", "Search error")
+          [false, title, link_text]
+        end
+      end
+
+      def shorten(type, url, title = nil, link_text = nil)
+        return [false, title, link_text] unless valid_setapp_url?(url)
+
+        shortened_url = case type
+                        when :isgd
+                          SL::IsgdSearch.shorten(url)
+                        when :bitly
+                          SL::BitlySearch.shorten(url)
+                        end
+        return [false, title, link_text] unless shortened_url
+
+        format_response(shortened_url, link_text)
+      end
+
+      def valid_setapp_url?(url)
+        return true if SL::URL.valid_link?(url, 2) && url =~ %r{^https://setapp.com}
+
+        SL.add_error("URL is not a valid Setapp link", "URL error")
+        false
+      end
+
+      def valid_affiliate_config?
+        return true if SL.config.key?("setapp_affiliate_string") && !SL.config["setapp_affiliate_string"].empty?
+
+        # SL.add_error("Setapp affiliate string not configured", "Missing affiliate string")
+        false
+      end
+
+      def build_affiliate_url(url)
+        return url unless valid_affiliate_config?
+
+        separator = url =~ /\?/ ? "&" : "?"
+        "#{url}#{SL.config['setapp_affiliate_string'].sub(/^[?&]?/, separator)}"
+      end
+
+      def format_response(link, link_text)
+        title = SL::URL.title(link)
+
+        [link, title, link_text.nil? || link_text.empty? && !SL.titleize ? title : link_text]
+      end
+    end
+
+    SL::Searches.register "setapp", :search, self
+  end
+end

data/lib/searchlink/searches.rb

@@ -218,6 +218,9 @@ require_relative "searches/lastfm"
 # import
 require_relative "searches/pinboard"
 
+# import
+require_relative "searches/setapp"
+
 # import
 require_relative "searches/social"
 

data/lib/searchlink/string.rb

@@ -157,6 +157,30 @@ module SL
       input + append
     end
 
+    ##
+    ## Append an affiliate string to a URL
+    ##
+    ## @param      aff_string   [String]  The affiliate string
+    ## @return     [String]  The URL with the affiliate string
+    ##
+    ## @see        #append_affiliate_string!
+    ##
+    def append_affiliate_string(aff_string)
+      separator = self =~ /\?/ ? "&" : "?"
+      "#{self}#{aff_string.sub(/^[?&]?/, separator)}"
+    end
+
+    ## Destructively append an affiliate string to a URL
+    ##
+    ## @param      aff_string   [String]  The affiliate string
+    ## @return     [String]  The URL with the affiliate string
+    ##
+    ## @see        #append_affiliate_string
+    ##
+    def append_affiliate_string!(aff_string)
+      replace append_affiliate_string(aff_string)
+    end
+
     ##
     ## Remove the protocol from a URL
     ##

data/lib/searchlink/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SL
-  VERSION = '2.3.83'
+  VERSION = "2.3.84"
 end
 
 # Main module
@@ -47,7 +47,7 @@ module SL
       if defined? Secrets::GH_AUTH_TOKEN
         headers["Authorization"] = "Bearer #{Secrets::GH_AUTH_TOKEN}"
       elsif SL.config["github_token"]
-        headers["Authorization"] = "Bearer #{SL.settings["github_token"]}"
+        headers["Authorization"] = "Bearer #{SL.config["github_token"]}"
       end
 
       url = "https://api.github.com/repos/ttscoff/searchlink/releases/latest"

data/lib/tokens.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Secrets
-  GH_AUTH_TOKEN = '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'
+  GH_AUTH_TOKEN = "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"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: searchlink
 version: !ruby/object:Gem::Version
-  version: 2.3.83
+  version: 2.3.84
 platform: ruby
 authors:
 - Brett Terpstra
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -303,6 +303,7 @@ files:
 - lib/searchlink/searches/linkding.rb
 - lib/searchlink/searches/lyrics.rb
 - lib/searchlink/searches/pinboard.rb
+- lib/searchlink/searches/setapp.rb
 - lib/searchlink/searches/social.rb
 - lib/searchlink/searches/software.rb
 - lib/searchlink/searches/spelling.rb