discourse_subscription_client 0.1.0.pre1

data/lib/discourse_subscription_client/request.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module DiscourseSubscriptionClient
+  class Request
+    SUPPLIER_ERROR_LIMIT = 3
+    RESOURCE_ERROR_LIMIT = 5
+    VALID_TYPES = %w[resource supplier].freeze
+
+    attr_reader :type,
+                :id
+
+    def initialize(type, id)
+      @type = type.to_s
+      @id = id
+    end
+
+    def perform(url, headers: {}, body: nil, opts: { method: "GET" })
+      return nil unless VALID_TYPES.include?(type)
+
+      if body
+        uri = URI.parse(url)
+        uri.query = CGI.unescape(body.to_query)
+        url = uri.to_s
+      end
+
+      headers.merge!({ "Origin" => Discourse.base_url_no_prefix })
+
+      connection = Excon.new(url, headers: headers)
+
+      begin
+        response = connection.request(opts)
+      rescue Excon::Error::Socket, Excon::Error::Timeout
+        response = nil
+      end
+
+      if response && response.status == 200
+        expire_error
+
+        begin
+          data = JSON.parse(response.body).deep_symbolize_keys
+        rescue JSON::ParserError
+          return nil
+        end
+
+        data
+      else
+        create_error(url, response)
+        nil
+      end
+    end
+
+    def current_error(query_only: false)
+      @current_error ||= begin
+        query = SubscriptionClientRequest
+                .where("request_id = :request_id AND request_type = :request_type AND expired_at IS NULL", request_id: id, request_type: type)
+
+        return nil unless query.exists?
+        return query if query_only
+
+        query.first
+      end
+    end
+
+    def self.current_error(type, id)
+      new(type, id).current_error
+    end
+
+    def limit
+      send("#{@type}_limit")
+    end
+
+    def create_error(url, response)
+      if (error = current_error)
+        error.count = error.count.to_i + 1
+      else
+        error = SubscriptionClientRequest.new(
+          request_id: id,
+          request_type: type,
+          message: I18n.t("subscription_client.notices.connection_error", url: url),
+          count: 1
+        )
+      end
+
+      if response.present?
+        begin
+          body = JSON.parse(response.body)
+        rescue JSON::ParserError
+          body = nil
+        end
+
+        error.response = {
+          status: response.status,
+          body: body
+        }
+
+        error.message = body["error"] if body && body["error"]
+      end
+
+      error.save
+
+      @current_error = nil
+
+      return unless reached_limit?
+
+      SubscriptionClientNotice.notify_connection_error(type, id)
+
+      return unless type === "supplier" && (supplier = SubscriptionClientSupplier.find_by_id(id))
+
+      supplier.deactivate_all_subscriptions!
+    end
+
+    def expire_error
+      if (query = current_error(query_only: true))
+        record = query.first
+        record.expired_at = Time.now
+        record.save
+      end
+
+      SubscriptionClientNotice.expire_connection_error(type, id)
+    end
+
+    def supplier_limit
+      SUPPLIER_ERROR_LIMIT
+    end
+
+    def resource_limit
+      RESOURCE_ERROR_LIMIT
+    end
+
+    def reached_limit?
+      return false unless current_error.present?
+
+      current_error.count.to_i >= limit
+    end
+  end
+end

data/lib/discourse_subscription_client/resources.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module DiscourseSubscriptionClient
+  class Resources
+    attr_accessor :suppliers,
+                  :resources
+
+    def initialize
+      @suppliers = []
+      @resources = []
+    end
+
+    def self.find_all
+      RailsMultisite::ConnectionManagement.each_connection do
+        new.find_all
+      end
+    end
+
+    def find_all
+      return unless DiscourseSubscriptionClient.database_exists?
+
+      setup_resources
+      find_resources
+
+      return unless @resources.any?
+
+      ActiveRecord::Base.transaction do
+        find_suppliers
+        save_resources
+      end
+    end
+
+    def setup_resources
+      setup_plugins
+    end
+
+    def find_resources
+      find_plugins
+    end
+
+    def find_suppliers
+      supplier_urls = @resources.map { |resource| resource[:supplier_url] }.uniq.compact
+
+      supplier_urls.each do |url|
+        supplier = SubscriptionClientSupplier.find_by(url: url)
+
+        if supplier&.name
+          @suppliers << supplier
+        else
+          supplier ||= SubscriptionClientSupplier.create!(url: url)
+          request = DiscourseSubscriptionClient::Request.new(:supplier, supplier.id)
+          data = request.perform("#{url}/subscription-server")
+
+          if data
+            supplier.update(name: data[:supplier])
+            @suppliers << supplier
+          else
+            supplier.destroy!
+          end
+        end
+      end
+    end
+
+    def save_resources
+      @resources.each do |resource|
+        supplier = @suppliers.select { |s| s.url === resource[:supplier_url] }.first
+
+        next unless supplier.present?
+
+        attrs = {
+          supplier_id: supplier.id,
+          name: resource[:name]
+        }
+        SubscriptionClientResource.create!(attrs) unless SubscriptionClientResource.exists?(attrs)
+      end
+    end
+
+    def setup_plugins
+      Plugin::Metadata::FIELDS << :subscription_url unless Plugin::Metadata::FIELDS.include?(:subscription_url)
+      Plugin::Metadata.attr_accessor(:subscription_url)
+    end
+
+    def find_plugins
+      Dir["#{DiscourseSubscriptionClient.root}/plugins/*/plugin.rb"].sort.each do |path|
+        source = File.read(path)
+        metadata = Plugin::Metadata.parse(source)
+
+        next unless metadata.subscription_url.present?
+
+        @resources << {
+          name: metadata.name,
+          supplier_url: metadata.subscription_url
+        }
+      end
+    end
+  end
+end

data/lib/discourse_subscription_client/subscriptions/result.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module ::DiscourseSubscriptionClient
+  class Subscriptions
+    class Result
+      REQUIRED_KEYS ||= %i[
+        resource_id
+        product_id
+        price_id
+      ].freeze
+      OPTIONAL_KEYS ||= %i[
+        product_name
+        price_name
+      ].freeze
+      KEYS = REQUIRED_KEYS + OPTIONAL_KEYS
+
+      attr_reader :errors,
+                  :errored_suppliers,
+                  :infos
+
+      def initialize
+        @errors = []
+        @infos = []
+      end
+
+      def not_authorized(supplier)
+        error("not_authorized", supplier)
+      end
+
+      def retrieve_subscriptions(supplier, raw_data)
+        subscriptions_data = raw_data[:subscriptions].compact
+
+        unless subscriptions_data.present? && subscriptions_data.is_a?(Array)
+          error("invalid_response", supplier)
+          return []
+        end
+
+        # subscriptions must be properly formed
+
+        subscriptions_data =
+          subscriptions_data
+          .map(&:symbolize_keys)
+          .each { |data| data[:resource_id] = data[:resource] }
+          .select { |data| REQUIRED_KEYS.all? { |key| data.key?(key) } }
+
+        # we only care about subscriptions for resources on this instance
+
+        resources = SubscriptionClientResource.where(
+          supplier_id: supplier.id,
+          name: subscriptions_data.map { |data| data[:resource] }
+        )
+
+        subscriptions_data.each_with_object([]) do |data, result|
+          resource = resources.select { |r| r.name === data[:resource] }.first
+
+          if resource.present?
+            data[:resource_id] = resource.id
+            result << OpenStruct.new(
+              required: data.slice(*REQUIRED_KEYS),
+              create: data.slice(*KEYS),
+              subscription: nil
+            )
+          else
+            info("no_resource", supplier, resource: data[:resource])
+          end
+        end
+      end
+
+      def connection_error(supplier)
+        error("supplier_connection", supplier)
+      end
+
+      def no_suppliers
+        info("no_suppliers")
+      end
+
+      def no_subscriptions(supplier)
+        info("no_subscriptions", supplier)
+      end
+
+      def updated_subscription(supplier, subscription_ids: nil)
+        info("updated_subscription", supplier, subscription_ids: subscription_ids)
+      end
+
+      def created_subscription(supplier, subscription_ids: nil)
+        info("created_subscription", supplier, subscription_ids: subscription_ids)
+      end
+
+      def failed_to_create_subscription(supplier, subscription_ids: nil)
+        info("failed_to_create_subscription", supplier, subscription_ids: subscription_ids)
+      end
+
+      def info(key, supplier = nil, subscription_ids: nil, resource: nil)
+        attrs = {}
+
+        if supplier
+          attrs = {
+            supplier: supplier.name,
+            supplier_url: supplier.url,
+            deep_interpolation: true,
+            price: "",
+            resource_name: ""
+          }
+        end
+
+        attrs.merge!(subscription_ids) if subscription_ids.present?
+        attrs[:resource] if resource.present?
+
+        @infos << I18n.t("subscription_client.subscriptions.info.#{key}", **attrs)
+      end
+
+      def error(key, supplier)
+        @errors << I18n.t("subscription_client.subscriptions.error.#{key}", supplier: supplier.name,
+                                                                            supplier_url: supplier.url)
+      end
+    end
+  end
+end

data/lib/discourse_subscription_client/subscriptions.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module DiscourseSubscriptionClient
+  class Subscriptions
+    def initialize
+      @suppliers = SubscriptionClientSupplier.authorized
+    end
+
+    def self.update
+      new.update
+    end
+
+    def update
+      return unless SiteSetting.subscription_client_enabled
+
+      @result = DiscourseSubscriptionClient::Subscriptions::Result.new
+
+      if @suppliers.blank?
+        @result.no_suppliers
+      else
+        @suppliers.each do |supplier|
+          update_supplier(supplier)
+        end
+      end
+
+      if @result.errors.any?
+        @result.errors.each do |error|
+          Rails.logger.error "DiscourseSubscriptionClient::Subscriptions.update: #{error}"
+        end
+      end
+
+      if SiteSetting.subscription_client_verbose_logs && @result.infos.any?
+        @result.infos.each do |info|
+          Rails.logger.info "DiscourseSubscriptionClient::Subscriptions.update: #{info}"
+        end
+      end
+
+      @result.errors.blank?
+    end
+
+    def update_supplier(supplier)
+      resources = supplier.resources
+      return unless resources.present?
+
+      request = DiscourseSubscriptionClient::Request.new(:supplier, supplier.id)
+      headers = { "User-Api-Key" => supplier.api_key }
+      url = "#{supplier.url}/subscription-server/user-subscriptions"
+
+      response = request.perform(url, headers: headers, body: { resources: resources.map(&:name) })
+      return (supplier.deactivate_all_subscriptions! && @result.connection_error(supplier)) if response.nil?
+
+      subscription_data = @result.retrieve_subscriptions(supplier, response)
+      return supplier.deactivate_all_subscriptions! if @result.errors.any?
+
+      # deactivate any of the supplier's subscriptions not retrieved from supplier
+      if supplier.subscriptions.present?
+        supplier.subscriptions.each do |subscription|
+          has_match = false
+          subscription_data.each do |data|
+            if data_matches_subscription(data, subscription)
+              data.subscription = subscription
+              has_match = true
+            end
+          end
+          subscription.deactivate! unless has_match
+        end
+      end
+
+      return @result.no_subscriptions(supplier) if subscription_data.blank?
+
+      subscription_data.each do |data|
+        if data.subscription.present?
+          data.subscription.update(subscribed: true)
+          data.subscription.touch
+
+          @result.updated_subscription(supplier, subscription_ids: data.required)
+        else
+          subscription = SubscriptionClientSubscription.create!(data.create.merge(subscribed: true))
+
+          if subscription
+            @result.created_subscription(supplier, subscription_ids: data.required)
+          else
+            @result.failed_to_create_subscription(supplier, subscription_ids: data.required)
+          end
+        end
+      end
+    end
+
+    def data_matches_subscription(data, subscription)
+      data.required.all? { |k, v| subscription.send(k.to_s) == v }
+    end
+  end
+end

data/lib/discourse_subscription_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DiscourseSubscriptionClient
+  VERSION = "0.1.0.pre1"
+end

data/lib/discourse_subscription_client.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+%w[
+  ./discourse_subscription_client/version
+  ./discourse_subscription_client/engine
+].each do |path|
+  require_relative path
+end

metadata

@@ -0,0 +1,252 @@
+--- !ruby/object:Gem::Specification
+name: discourse_subscription_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+platform: ruby
+authors:
+- Angus McLeod
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: annotate
+  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: byebug
+  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: excon
+  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: fabrication
+  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: message_bus
+  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: mini_scheduler
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.1
+- !ruby/object:Gem::Dependency
+  name: rspec-activemodel-mocks
+  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-rails
+  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: webmock
+  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: Adds a backend subscription client to a Discourse plugin.
+email:
+- angus@mcleod.org.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/discourse_subscription_client_manifest.js
+- app/assets/stylesheets/discourse_subscription_client/application.css
+- app/controllers/discourse_subscription_client/admin_controller.rb
+- app/controllers/discourse_subscription_client/notices_controller.rb
+- app/controllers/discourse_subscription_client/subscriptions_controller.rb
+- app/controllers/discourse_subscription_client/suppliers_controller.rb
+- app/jobs/regular/discourse_subscription_client/find_resources.rb
+- app/jobs/scheduled/discourse_subscription_client/update_notices.rb
+- app/jobs/scheduled/discourse_subscription_client/update_subscriptions.rb
+- app/models/subscription_client_notice.rb
+- app/models/subscription_client_request.rb
+- app/models/subscription_client_resource.rb
+- app/models/subscription_client_subscription.rb
+- app/models/subscription_client_supplier.rb
+- app/serializers/discourse_subscription_client/notice_serializer.rb
+- app/serializers/discourse_subscription_client/resource_serializer.rb
+- app/serializers/discourse_subscription_client/subscription_serializer.rb
+- app/serializers/discourse_subscription_client/supplier_serializer.rb
+- config/locales/server.en.yml
+- config/routes.rb
+- config/settings.yml
+- db/migrate/20220318160955_create_subscription_client_suppliers.rb
+- db/migrate/20220318181029_create_subscription_client_resources.rb
+- db/migrate/20220318181054_create_subscription_client_notices.rb
+- db/migrate/20220318181140_create_subscription_client_subscriptions.rb
+- db/migrate/20230220130259_create_subscription_client_requests.rb
+- lib/discourse_subscription_client.rb
+- lib/discourse_subscription_client/authorization.rb
+- lib/discourse_subscription_client/engine.rb
+- lib/discourse_subscription_client/notices.rb
+- lib/discourse_subscription_client/request.rb
+- lib/discourse_subscription_client/resources.rb
+- lib/discourse_subscription_client/subscriptions.rb
+- lib/discourse_subscription_client/subscriptions/result.rb
+- lib/discourse_subscription_client/version.rb
+homepage: https://github.com/paviliondev/discourse_subscription_client
+licenses:
+- GPL-2.0-only
+metadata:
+  homepage_uri: https://github.com/paviliondev/discourse_subscription_client
+  source_code_uri: https://github.com/paviliondev/discourse_subscription_client
+  changelog_uri: https://github.com/paviliondev/discourse_subscription_client
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Discourse plugin subscription client.
+test_files: []