discourse_subscription_client 0.1.0.pre4 → 0.1.0.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 307c93dedfd3a85110f7ad12a1d7e6e91bb1aecaaffc7e6025fec54905aa0df7
-  data.tar.gz: 11dd2c79ba1d825028cc32d2fabc31b0d889be2cb4d2f3c1ad1664c23025dad0
+  metadata.gz: 3449957ada14519fd11be48009e904a8fbfc06d6f12f2ede952a1b7e426c2b53
+  data.tar.gz: 3befbc23e94b37dfcf7f9f7ecef9aa07d7bba851d2c9a0395a990af7adbcc501
 SHA512:
-  metadata.gz: f22185915974d1abbc65ae2b0ed1b14022eb14ebdf7a9f8d12e03b3a00968d93ec69d39c25ad286149d95cec29e8e5035b4c52f38fbd362720664970f0044472
-  data.tar.gz: 6f47325b66b776ac2485989006b7d63f3d6e389f5cf0c53b5c4eb8914d8cb16481dcc05d46eeecada45a9ecd620ca70bd64ea2f502af0d3fcfe09a1760c5cc4e
+  metadata.gz: 057bd00307d2c7f8a9d5aec6e71871efee9fa5ffe52bddee16ca4a3c2373cf21f7d9dfa18ea16be62435184c5112c4f4b2d9366f740189a8bddb293fbdfa404e
+  data.tar.gz: 9d2a38b104215c347bc51caa6725c0f1c5123de9cd9d0c916c825814cda2b9c3586c52332f1485c37858a073c0aad5258f6ab86055910b104a55ce2d47c215c5

data/README.md

@@ -1,28 +1,60 @@
-# DiscourseSubscriptionClient
-Short description and motivation.
+# Discourse Subscription Client Gem
+This gem is only for use with Discourse plugins. It provides subscription client support to a Discourse plugin, primarily for use with the Discourse Subscription Server plugin.
+
+## Installation
+Add this line to your plugin's `plugin.rb` file
+
+```ruby
+gem "discourse_subscription_client", "0.1.0.pre5", require_name: "discourse_subscription_client"
+```
 
 ## Usage
-How to use my plugin.
 
-## Installation
-Add this line to your application's Gemfile:
+The gem API is accessible through the `DiscourseSubscriptionClient` class. Supported methods are described below.
+
+### find_subscriptions
 
 ```ruby
-gem "discourse_subscription_client"
+DiscourseSubscriptionClient.find_subscriptions(resource_name)
 ```
 
-And then execute:
-```bash
-$ bundle
+#### Arguments
+
+##### resource_name
+
+The name of a resource defined in the `discourse-subscription-server` plugin's `subscription_server_subscriptions` setting.
+
+#### Returns
+
+Returns a `DiscourseSubscriptionClient::Subscriptions::Result` object, containing the supplier, resource and any active subscriptions.
+
+#### Example
+
+```ruby
+result = DiscourseSubscriptionClient.find_subscriptions("discourse-custom-wizard")
+result.supplier # <DiscourseSubscriptionSupplier name="Pavilion" ...>
+result.resource # <DiscourseSubscriptionResource name="discourse-custom-wizard" ...>
+result.subscriptions # [<DiscourseSubscriptionSubscription product_name="Business" ...>]
 ```
 
-Or install it yourself as:
-```bash
-$ gem install discourse_subscription_client
+## Development
+
+### Tests
+The gem has to create a dummy Discourse environment when running specs, so there are a few testing quirks.
+
+Discourse migrations go in `db/migrate` as normal. They are including in the rails migrations_paths in `lib/discourse_subscription_client/engine.rb`.
+
+If you add new migrations, run test migrations as normal (from the root of the gem)
+
+```
+RAILS_ENV=test rake db:drop db:create db:migrate
 ```
 
-## Contributing
-Contribution directions go here.
+If you're not adding new migrations you only need to load the schema. If you are running migrations you need to also load the schema (in addition to running the migrations)
+
+```
+RAILS_ENV=test rake db:schema:load
+```
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [GNU GPL v2 License](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).

data/app/models/subscription_client_subscription.rb

@@ -6,7 +6,12 @@ class SubscriptionClientSubscription < ActiveRecord::Base
 
   belongs_to :resource, class_name: "SubscriptionClientResource"
 
-  scope :active, -> { where("subscribed = true AND updated_at > ?", SubscriptionClientSubscription.update_period) }
+  scope :active, lambda {
+    where(
+      "subscription_client_subscriptions.subscribed = true AND
+       subscription_client_subscriptions.updated_at > ?", SubscriptionClientSubscription.update_period
+    )
+  }
 
   def active
     subscribed && updated_at.to_datetime > self.class.update_period.to_datetime

data/app/models/subscription_client_supplier.rb

@@ -23,6 +23,12 @@ class SubscriptionClientSupplier < ActiveRecord::Base
     api_key.present?
   end
 
+  def product_slugs
+    @product_slugs ||= products.each_with_object({}) do |product, result|
+      result[product["product_id"]] = product["product_slug"]
+    end
+  end
+
   def deactivate_all_subscriptions!
     subscriptions.update_all(subscribed: false)
   end

data/config/routes.rb

@@ -3,6 +3,7 @@
 DiscourseSubscriptionClient::Engine.routes.draw do
   get "" => "admin#index"
   get ".json" => "admin#index"
+  get "no-access" => "admin#index"
 
   get "suppliers" => "suppliers#index"
   get "suppliers/authorize" => "suppliers#authorize"

data/config/settings.yml

@@ -1,7 +1,6 @@
 plugins:
   subscription_client_enabled:
     default: true
-    client: true
   subscription_client_verbose_logs:
     default: false
   subscription_client_warning_notices_on_dashboard:
@@ -10,7 +9,6 @@ plugins:
     default: false
   subscription_client_allow_moderator_supplier_management:
     default: false
-    client: true
   subscription_client_request_plugin_statuses:
     default: false
     hidden: true

data/db/migrate/20230221100514_create_subscription_client_suppliers.rb

@@ -2,7 +2,7 @@
 
 class CreateSubscriptionClientSuppliers < ActiveRecord::Migration[7.0]
   def change
-    create_table :subscription_client_suppliers do |t|
+    create_table :subscription_client_suppliers, if_not_exists: true do |t|
       t.string :name
       t.string :url, null: false
       t.string :api_key

data/db/migrate/20230221100524_create_subscription_client_resources.rb

@@ -2,7 +2,7 @@
 
 class CreateSubscriptionClientResources < ActiveRecord::Migration[7.0]
   def change
-    create_table :subscription_client_resources do |t|
+    create_table :subscription_client_resources, if_not_exists: true do |t|
       t.references :supplier, foreign_key: { to_table: :subscription_client_suppliers }
       t.string :name, null: false
 

data/db/migrate/20230221100529_create_subscription_client_notices.rb

@@ -2,7 +2,7 @@
 
 class CreateSubscriptionClientNotices < ActiveRecord::Migration[7.0]
   def change
-    create_table :subscription_client_notices do |t|
+    create_table :subscription_client_notices, if_not_exists: true do |t|
       t.string :title, null: false
       t.string :message
       t.integer :notice_type, null: false

data/db/migrate/20230221100535_create_subscription_client_subscriptions.rb

@@ -2,7 +2,7 @@
 
 class CreateSubscriptionClientSubscriptions < ActiveRecord::Migration[7.0]
   def change
-    create_table :subscription_client_subscriptions do |t|
+    create_table :subscription_client_subscriptions, if_not_exists: true do |t|
       t.references :resource, foreign_key: { to_table: :subscription_client_resources }
       t.string :product_id, null: false
       t.string :product_name

data/db/migrate/20230221100540_create_subscription_client_requests.rb

@@ -2,7 +2,7 @@
 
 class CreateSubscriptionClientRequests < ActiveRecord::Migration[7.0]
   def change
-    create_table :subscription_client_requests do |t|
+    create_table :subscription_client_requests, if_not_exists: true do |t|
       t.bigint :request_id
       t.string :request_type
       t.datetime :expired_at

data/db/migrate/20230223135957_add_products_to_subscription_client_suppliers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddProductsToSubscriptionClientSuppliers < ActiveRecord::Migration[7.0]
+  def change
+    add_column :subscription_client_suppliers, :products, :json
+  end
+end

data/extensions/discourse_subscription_client/{current_user.rb → current_user_serializer.rb}

@@ -2,6 +2,14 @@
 
 module DiscourseSubscriptionClient
   module CurrentUserSerializerExtension
+    def attributes
+      super.tap do |attrs|
+        attrs[:subscription_notice_count] = subscription_notice_count if include_subscription_notice_count?
+        attrs[:can_manage_subscriptions] = can_manage_subscriptions
+        attrs[:can_manage_suppliers] = can_manage_suppliers
+      end
+    end
+
     def subscription_notice_count
       SubscriptionClientNotice.list(visible: true).count
     end
@@ -13,5 +21,9 @@ module DiscourseSubscriptionClient
     def can_manage_subscriptions
       scope.can_manage_subscriptions?
     end
+
+    def can_manage_suppliers
+      scope.can_manage_suppliers?
+    end
   end
 end

data/extensions/discourse_subscription_client/site_serializer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DiscourseSubscriptionClient
+  module SiteSerializerExtension
+    def attributes
+      super.tap do |attrs|
+        attrs[:subscription_client_enabled] = subscription_client_enabled
+      end
+    end
+
+    def subscription_client_enabled
+      SiteSetting.subscription_client_enabled
+    end
+  end
+end

data/lib/discourse_subscription_client/engine.rb

@@ -23,6 +23,7 @@ module DiscourseSubscriptionClient
         ./notices
         ./subscriptions
         ./subscriptions/result
+        ./subscriptions/update_result
         ../../app/models/subscription_client_notice
         ../../app/models/subscription_client_resource
         ../../app/models/subscription_client_subscription
@@ -35,16 +36,17 @@ module DiscourseSubscriptionClient
         ../../app/serializers/discourse_subscription_client/resource_serializer
         ../../app/serializers/discourse_subscription_client/notice_serializer
         ../../app/serializers/discourse_subscription_client/subscription_serializer
-        ../../app/jobs/regular/discourse_subscription_client_find_resources
-        ../../app/jobs/scheduled/discourse_subscription_client_update_subscriptions
-        ../../app/jobs/scheduled/discourse_subscription_client_update_notices
-        ../../extensions/discourse_subscription_client/current_user
+        ../../app/jobs/discourse_subscription_client_find_resources
+        ../../app/jobs/discourse_subscription_client_update_subscriptions
+        ../../app/jobs/discourse_subscription_client_update_notices
+        ../../extensions/discourse_subscription_client/current_user_serializer
+        ../../extensions/discourse_subscription_client/site_serializer
         ../../extensions/discourse_subscription_client/guardian
       ].each do |path|
         require_relative path
       end
 
-      Jobs.enqueue(:discourse_subscription_client_find_resources) if DiscourseSubscriptionClient.database_exists? && !Rails.env.test?
+      Jobs.enqueue(:discourse_subscription_client_find_resources) if !Rails.env.test? && DiscourseSubscriptionClient.database_exists?
 
       Rails.application.routes.append do
         mount DiscourseSubscriptionClient::Engine, at: "/admin/plugins/subscription-client"
@@ -54,6 +56,7 @@ module DiscourseSubscriptionClient
 
       Guardian.prepend DiscourseSubscriptionClient::GuardianExtension
       CurrentUserSerializer.prepend DiscourseSubscriptionClient::CurrentUserSerializerExtension
+      SiteSerializer.prepend DiscourseSubscriptionClient::SiteSerializerExtension
 
       User.has_many(:subscription_client_suppliers)
 
@@ -93,5 +96,23 @@ module DiscourseSubscriptionClient
     else
       true
     end
+
+    def find_subscriptions(resource_name = nil)
+      return nil unless resource_name
+
+      subscriptions = SubscriptionClientSubscription.active
+                                                    .includes(resource: [:supplier])
+                                                    .references(resource: [:supplier])
+                                                    .where("subscription_client_resources.name = ? ", resource_name)
+
+      result = DiscourseSubscriptionClient::Subscriptions::Result.new
+      return result unless subscriptions.exists?
+
+      result.resource = subscriptions.first.resource
+      result.supplier = subscriptions.first.resource.supplier
+      result.subscriptions = subscriptions.to_a
+
+      result
+    end
   end
 end

data/lib/discourse_subscription_client/resources.rb

@@ -51,8 +51,8 @@ module DiscourseSubscriptionClient
           request = DiscourseSubscriptionClient::Request.new(:supplier, supplier.id)
           data = request.perform("#{url}/subscription-server")
 
-          if data
-            supplier.update(name: data[:supplier])
+          if valid_supplier_data?(data)
+            supplier.update(name: data[:supplier], products: data[:products])
             @suppliers << supplier
           else
             supplier.destroy!
@@ -89,9 +89,22 @@ module DiscourseSubscriptionClient
 
         @resources << {
           name: metadata.name,
-          supplier_url: metadata.subscription_url
+          supplier_url: ENV["TEST_SUBSCRIPTION_URL"] || metadata.subscription_url
         }
       end
     end
+
+    def valid_supplier_data?(data)
+      return false unless %i[supplier products].all? { |key| data.key?(key) }
+      return false unless data[:supplier].is_a?(String)
+      return false unless data[:products].is_a?(Array)
+
+      data[:products].all? do |product|
+        product.is_a?(Hash) &&
+          %i[product_id product_slug].all? do |key|
+            product.key?(key) && product[key].is_a?(String)
+          end
+      end
+    end
   end
 end

data/lib/discourse_subscription_client/subscriptions/result.rb

@@ -1,117 +1,14 @@
 # frozen_string_literal: true
 
-module ::DiscourseSubscriptionClient
+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_accessor :supplier,
+                    :resource,
+                    :subscriptions
 
-      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)
+      def any?
+        supplier.present? && resource.present? && subscriptions.present?
       end
     end
   end

data/lib/discourse_subscription_client/subscriptions/update_result.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module ::DiscourseSubscriptionClient
+  class Subscriptions
+    class UpdateResult
+      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

@@ -13,7 +13,7 @@ module DiscourseSubscriptionClient
     def update
       return unless SiteSetting.subscription_client_enabled
 
-      @result = DiscourseSubscriptionClient::Subscriptions::Result.new
+      @result = DiscourseSubscriptionClient::Subscriptions::UpdateResult.new
 
       if @suppliers.blank?
         @result.no_suppliers

data/lib/discourse_subscription_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discourse_subscription_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre4
+  version: 0.1.0.pre6
 platform: ruby
 authors:
 - Angus McLeod
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.4.1
+- !ruby/object:Gem::Dependency
+  name: rails_multisite
+  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-activemodel-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -222,9 +236,9 @@ files:
 - 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/jobs/discourse_subscription_client_find_resources.rb
+- app/jobs/discourse_subscription_client_update_notices.rb
+- app/jobs/discourse_subscription_client_update_subscriptions.rb
 - app/models/subscription_client_notice.rb
 - app/models/subscription_client_request.rb
 - app/models/subscription_client_resource.rb
@@ -242,8 +256,10 @@ files:
 - db/migrate/20230221100529_create_subscription_client_notices.rb
 - db/migrate/20230221100535_create_subscription_client_subscriptions.rb
 - db/migrate/20230221100540_create_subscription_client_requests.rb
-- extensions/discourse_subscription_client/current_user.rb
+- db/migrate/20230223135957_add_products_to_subscription_client_suppliers.rb
+- extensions/discourse_subscription_client/current_user_serializer.rb
 - extensions/discourse_subscription_client/guardian.rb
+- extensions/discourse_subscription_client/site_serializer.rb
 - lib/discourse_subscription_client.rb
 - lib/discourse_subscription_client/authorization.rb
 - lib/discourse_subscription_client/engine.rb
@@ -252,6 +268,7 @@ files:
 - lib/discourse_subscription_client/resources.rb
 - lib/discourse_subscription_client/subscriptions.rb
 - lib/discourse_subscription_client/subscriptions/result.rb
+- lib/discourse_subscription_client/subscriptions/update_result.rb
 - lib/discourse_subscription_client/version.rb
 homepage: https://github.com/paviliondev/discourse_subscription_client
 licenses: