bridgetown_jam_comments 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cec102f903d67ff5d30fef92aa7748089ade11a2cb67b4177fe2c06795b24e9
+  data.tar.gz: 6e0eb8bdc6c859ba4981dff3c450629d41b3328d0cb1fad8f9e7e7e209b09287
+SHA512:
+  metadata.gz: 6a456e51630ba2a33de9c84ab904aaa859d67f678846f5ffd9039489cf7d8927c7fec3e096f3dbd8c0fe94358da0e08d6021f5d70e1a08b3c80bbcbb8b12c1e8
+  data.tar.gz: 015f7f3d5f64d24b3e044acf82364a4672e97f8f840280850d2661e964c0d321979192406109a9b20b8c900b788408fc0b381c12ac02a6fb2e49dafd1917f6bf

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alex MacArthur
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,7 @@
+# bridgetown-jam-comments
+
+A Ruby gem for setting up your [Bridgetown](https://www.bridgetownrb.com/) blog with [JamComments](https://jamcomments.com), a guilt-free commment service for Jamstack blogs.
+
+## This Package's Documentation
+
+...coming soon!

data/lib/bridgetown_jam_comments/builder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "./service"
+require_relative "./renderer"
+require_relative "./configuration"
+
+module JamComments
+  class Builder < Bridgetown::Builder
+    def build
+      liquid_tag :jam_comments, :render
+    end
+
+    private
+
+    def render(attributes, tag)
+      Renderer.new(config.bridgetown_jam_comments).render(attributes, tag)
+    end
+  end
+end

data/lib/bridgetown_jam_comments/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module JamComments
+  class Configuration
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def domain
+      config["domain"] || ENV.fetch("JAM_COMMENTS_DOMAIN", nil)
+    end
+
+    def base_url
+      config["base_url"] || ENV.fetch("JAM_COMMENTS_BASE_URL", nil)
+    end
+
+    def api_key
+      config["api_key"] || ENV.fetch("JAM_COMMENTS_API_KEY", nil)
+    end
+
+    def environment
+      config["environment"] || ENV["JAM_COMMENTS_ENVIRONMENT"] || ENV.fetch("BRIDGETOWN_ENV", nil)
+    end
+  end
+end

data/lib/bridgetown_jam_comments/renderer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "pry"
+
+module JamComments
+  class Renderer
+    CLIENT_SCRIPT_URL = "https://unpkg.com/@jam-comments/client@2.0.0-beta.2/dist/index.umd.js"
+
+    attr_reader :provided_configuration
+
+    def initialize(provided_configuration)
+      @provided_configuration = provided_configuration
+    end
+
+    def render(_attributes, tag)
+      context = tag.context
+      path = context["page"] && context["page"]["relative_url"]
+      markup = service.fetch(path: path)
+
+      "
+        #{markup}
+        <script src=\"#{CLIENT_SCRIPT_URL}\"></script>
+        <script>
+          window.JamComments.initialize();
+        </script>
+      "
+    end
+
+    private
+
+    def configuration
+      @configuration ||= Configuration.new(provided_configuration)
+    end
+
+    def service
+      @service ||= Service.new(
+        domain: configuration.domain,
+        api_key: configuration.api_key,
+        base_url: configuration.base_url,
+        environment: configuration.environment
+      )
+    end
+  end
+end

data/lib/bridgetown_jam_comments/service.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+module JamComments
+  class Service
+    attr_reader :base_url, :environment, :domain, :api_key, :client
+
+    def initialize(
+      domain:,
+      api_key:,
+      base_url: nil,
+      environment: nil,
+      client: HTTParty
+    )
+      @client = client
+      @domain = domain
+      @api_key = api_key
+      @base_url = base_url || "https://go.jamcomments.com"
+      @environment = environment || "production"
+    end
+
+    def fetch(path:)
+      options = {
+        query: {
+          path: formatted_path(path),
+          domain: domain,
+          stub: stub_value,
+        },
+        headers: {
+          Authorization: "Bearer #{api_key}",
+          Accept: "application/json",
+          "X-Platform": "jekyll",
+        },
+      }
+
+      send_request(options)
+    end
+
+    private
+
+    def send_request(options)
+      response = client.get(endpoint, options)
+
+      raise "Oh no! It looks like your credentials for JamComments are incorrect." if response.code == 401
+
+      raise "Oh no! JamComments request failed. Please try again. Status: #{response.code}" if response.code != 200
+
+      response.body
+    end
+
+    def stub_value
+      return "true" if environment != "production"
+
+      nil
+    end
+
+    def endpoint
+      "#{base_url}/api/v2/markup"
+    end
+
+    def formatted_path(path)
+      path.empty? ? "/" : path
+    end
+  end
+end

data/lib/bridgetown_jam_comments/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JamComments
+  VERSION = "0.0.1"
+end

data/lib/bridgetown_jam_comments.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require_relative "./bridgetown_jam_comments/builder"
+
+Bridgetown.initializer :bridgetown_jam_comments do |config, domain: nil, api_key: nil, base_url: nil, environment: nil|
+  config.bridgetown_jam_comments ||= {}
+  config.bridgetown_jam_comments[:domain] = config.bridgetown_jam_comments.domain || domain
+  config.bridgetown_jam_comments[:api_key] = config.bridgetown_jam_comments.api_key || api_key
+  config.bridgetown_jam_comments[:base_url] = config.bridgetown_jam_comments.base_url || base_url
+  config.bridgetown_jam_comments[:environment] =
+    config.bridgetown_jam_comments.environment || environment
+
+  config.builder JamComments::Builder
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown_jam_comments
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex MacArthur
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- alex@macarthur.me
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/bridgetown_jam_comments.rb
+- lib/bridgetown_jam_comments/builder.rb
+- lib/bridgetown_jam_comments/configuration.rb
+- lib/bridgetown_jam_comments/renderer.rb
+- lib/bridgetown_jam_comments/service.rb
+- lib/bridgetown_jam_comments/version.rb
+homepage: https://github.com/alexmacarthur/bridgetown-jam-comments
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A Bridgetown plugin for setting up JamComments in a Bridgetown site.
+test_files: []