RubyGems - nulogy_message_bus_producer - Versions diffs - 1.0.2 - Mend

nulogy_message_bus_producer 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

checksums.yaml +7 -0
data/README.md +35 -0
data/Rakefile +22 -0
data/db/migrate/20200611150212_create_public_subscriptions_and_events_tables.rb +25 -0
data/lib/nulogy_message_bus_producer.rb +112 -0
data/lib/nulogy_message_bus_producer/application_record.rb +6 -0
data/lib/nulogy_message_bus_producer/base_public_subscription.rb +13 -0
data/lib/nulogy_message_bus_producer/engine.rb +6 -0
data/lib/nulogy_message_bus_producer/postgres_public_subscriptions.rb +102 -0
data/lib/nulogy_message_bus_producer/public_subscription.rb +27 -0
data/lib/nulogy_message_bus_producer/public_subscription_event.rb +13 -0
data/lib/nulogy_message_bus_producer/subscriber_graphql_schema_validator.rb +45 -0
data/lib/nulogy_message_bus_producer/version.rb +3 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/config/manifest.js +4 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/javascripts/cable.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/channels/application_cable/channel.rb +4 -0
data/spec/dummy/app/channels/application_cable/connection.rb +4 -0
data/spec/dummy/app/controllers/application_controller.rb +7 -0
data/spec/dummy/app/controllers/dummy_controller.rb +17 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/jobs/application_job.rb +2 -0
data/spec/dummy/app/mailers/application_mailer.rb +4 -0
data/spec/dummy/app/models/application_record.rb +3 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/app/views/layouts/mailer.html.erb +13 -0
data/spec/dummy/app/views/layouts/mailer.text.erb +1 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/bin/setup +38 -0
data/spec/dummy/bin/update +29 -0
data/spec/dummy/bin/yarn +11 -0
data/spec/dummy/config.ru +5 -0
data/spec/dummy/config/application.rb +22 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/cable.yml +10 -0
data/spec/dummy/config/database.yml +22 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +54 -0
data/spec/dummy/config/environments/production.rb +91 -0
data/spec/dummy/config/environments/test.rb +42 -0
data/spec/dummy/config/initializers/application_controller_renderer.rb +8 -0
data/spec/dummy/config/initializers/assets.rb +14 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +5 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +33 -0
data/spec/dummy/config/puma.rb +56 -0
data/spec/dummy/config/routes.rb +6 -0
data/spec/dummy/config/secrets.yml +32 -0
data/spec/dummy/config/spring.rb +6 -0
data/spec/dummy/db/schema.rb +42 -0
data/spec/dummy/log/development.log +1771 -0
data/spec/dummy/log/test.log +14189 -0
data/spec/dummy/package.json +5 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/apple-touch-icon-precomposed.png +0 -0
data/spec/dummy/public/apple-touch-icon.png +0 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/integration/lib/graphql_api/postgres_public_subscriptions_spec.rb +16 -0
data/spec/integration/lib/graphql_api/validators/subscriber_graphql_schema_validator_spec.rb +76 -0
data/spec/integration_spec_helper.rb +35 -0
data/spec/spec_helper.rb +60 -0
data/spec/unit/lib/graphql_api/models/public_subscription_spec.rb +56 -0
data/spec/unit_spec_helper.rb +6 -0
metadata +342 -0

data/spec/dummy/package.json ADDED

@@ -0,0 +1,5 @@
+{
+  "name": "dummy",
+  "private": true,
+  "dependencies": {}
+}

data/spec/dummy/public/404.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/apple-touch-icon-precomposed.png ADDED

File without changes

data/spec/dummy/public/apple-touch-icon.png ADDED

File without changes

data/spec/dummy/public/favicon.ico ADDED

File without changes

data/spec/integration/lib/graphql_api/postgres_public_subscriptions_spec.rb ADDED

@@ -0,0 +1,16 @@
+require "integration_spec_helper"
+RSpec.describe NulogyMessageBusProducer::PostgresPublicSubscriptions do
+  context "when the class is not registered" do
+    it "raises" do
+      unregistered_schema = Class.new(GraphQL::Schema) do
+        use(NulogyMessageBusProducer::PostgresPublicSubscriptions)
+      end
+      expect do
+        # this find triggers the plugin to be loaded
+        unregistered_schema.find("something")
+      end.to raise_error(KeyError, /The schema registry did not contain an entry/)
+    end
+  end
+end

data/spec/integration/lib/graphql_api/validators/subscriber_graphql_schema_validator_spec.rb ADDED

@@ -0,0 +1,76 @@
+require "integration_spec_helper"
+RSpec.describe NulogyMessageBusProducer::SubscriberGraphqlSchemaValidator do
+  subject(:validator) { NulogyMessageBusProducer::SubscriberGraphqlSchemaValidator.new }
+  before do
+    NulogyMessageBusProducer.register_schema("test", "NulogyMessageBusProducer::Specs::TestSchema")
+  end
+  describe "#validate" do
+    context "when a valid query is present" do
+      it "return true" do
+        create_subscription(<<~QUERY)
+          query ($id: UUID!) {
+            foo (id: $id) {
+              id
+            }
+          }
+        QUERY
+        expect(validator.validate).to be(true)
+      end
+    end
+    context "when an invalid query is present" do
+      let(:subscription_with_error) do
+        subscription = create_subscription(<<~QUERY)
+          query ($id: UUID!) {
+            foo (id: $id) {
+              id
+            }
+          }
+        QUERY
+        subscription.query = <<~BAD_QUERY
+          query ($id: UUID!) {
+            foo (id: $id) {
+              a_field_that_does_not_exist
+            }
+          }
+        BAD_QUERY
+        subscription.save(validate: false)
+        subscription
+      end
+      it "returns false" do
+        subscription_with_error
+        expect(validator.validate).to be(false)
+      end
+      it "has errors" do
+        subscription_with_error
+        validator.validate
+        expect(validator.errors).to contain_exactly(
+          "Field 'a_field_that_does_not_exist' doesn't exist on type 'testObject' (id: #{subscription_with_error.id})"
+        )
+      end
+    end
+  end
+  def create_subscription(query, event_type = "testEvent", schema_key: "test")
+    NulogyMessageBusProducer::PublicSubscription.create_or_update(
+      query: query,
+      event_type: event_type,
+      schema_key: schema_key,
+      # not relavant, but needed for DB constraints
+      id: SecureRandom.uuid,
+      subscription_group_id: SecureRandom.uuid,
+      topic_name: SecureRandom.uuid
+    )
+  end
+end

data/spec/integration_spec_helper.rb ADDED

@@ -0,0 +1,35 @@
+# Make all rspec configuration changes to this file.
+# Leave automatically generated configuration files untouched to facilitate gem upgrades.
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("dummy/config/environment.rb", __dir__)
+require "rspec/rails"
+require "active_record"
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
+RSpec.configure do |config|
+  # Uncomment this line to see full backtraces for spec failures
+  # config.backtrace_exclusion_patterns = []
+  config.profile_examples = 0
+  # implements `use_transactional_fixtures = true`
+  config.before do
+    connection = ActiveRecord::Base.connection
+    connection.begin_transaction(joinable: false)
+  end
+  config.after do
+    connection = ActiveRecord::Base.connection
+    connection.rollback_transaction if connection.transaction_open?
+    ActiveRecord::Base.clear_active_connections!
+  end
+  # Increase characters displayed when exceptions fail (the RSpec default is 200 characters).
+  config.expect_with(:rspec) do |c|
+    c.max_formatted_output_length = 1_000_000
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,60 @@
+# Some test GraphQL objects for testing
+module NulogyMessageBusProducer
+  module Specs
+    class TestObject < GraphQL::Schema::Object
+      graphql_name "testObject"
+      field :id, type: NulogyGraphqlApi::Types::UUID, null: false
+    end
+    class TestQuery < GraphQL::Schema::Object
+      graphql_name "testQuery"
+      field :foo, TestObject, null: false do
+        argument :id, type: NulogyGraphqlApi::Types::UUID, required: false
+      end
+    end
+    class TestSchema < GraphQL::Schema
+      use NulogyMessageBusProducer::PostgresPublicSubscriptions
+      query TestQuery
+    end
+  end
+end
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with(:rspec) do |expectations|
+    # This is generally recommended, and will default to `true` in RSpec 4.
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with(:rspec) do |mocks|
+    # This is generally recommended, and will default to `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching(:focus)
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "tmp/examples.txt"
+  config.disable_monkey_patching!
+  config.default_formatter = "doc"
+  config.order = :random
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand(config.seed)
+end

data/spec/unit/lib/graphql_api/models/public_subscription_spec.rb ADDED

@@ -0,0 +1,56 @@
+require "unit_spec_helper"
+RSpec.describe NulogyMessageBusProducer::PublicSubscription do
+  context "when validating" do
+    before do
+      NulogyMessageBusProducer.register_schema("test", "NulogyMessageBusProducer::Specs::TestSchema")
+    end
+    it "is invalid with a blank query" do
+      model = NulogyMessageBusProducer::PublicSubscription.new(
+        schema_key: "test",
+        query: ""
+      )
+      model.validate
+      expect(model).to_not be_valid
+      expect(model.errors[:query]).to contain_exactly("can't be blank")
+    end
+    it "is invalid with an invalid query" do
+      model = NulogyMessageBusProducer::PublicSubscription.new(
+        schema_key: "test",
+        query: <<~QUERY
+          query ($id: UUID!) {
+            foo (id: $id) {
+              a_field_that_does_not_exist
+            }
+          }
+        QUERY
+      )
+      model.validate
+      expect(model).to_not be_valid
+      expect(model.errors[:query]).to contain_exactly("Field 'a_field_that_does_not_exist' doesn't exist on type 'testObject' (id: <new_record>)")
+    end
+    it "valid with a valid query" do
+      model = NulogyMessageBusProducer::PublicSubscription.new(
+        schema_key: "test",
+        query: <<~QUERY
+          query ($id: UUID!) {
+            foo (id: $id) {
+              id
+            }
+          }
+        QUERY
+      )
+      model.validate
+      expect(model.errors).to_not include(:query)
+    end
+  end
+end