yaml_csp_config 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c1a15cf473158e7caa531c124ef6d3b916aea37e2935836e091d45e1a577005
-  data.tar.gz: d58ca4a23c4f0c9a00c083b3fc53bb05436de96e53f2eb0c49ebbaaecf89553b
+  metadata.gz: 636f76164108ed26ee965a4c3a6b62f17691134fba8077f5bdbd157faff5b6d5
+  data.tar.gz: 2627769481fee67efdc943ab7e50f0757edcdea387a930079cbf128ef49c927e
 SHA512:
-  metadata.gz: b3086d40d76804167f12b22bed3efa8e50267f8e6060a7715769e7fc0a949e5c5bf3a6c0f2e2173c7b5401d76c83a6385e320916d43b7f4cc043848542311c57
-  data.tar.gz: 0d83c01baa01b4026b0da4c804bdfe3adf1ae3ed2a196d85dc6b10b36cb662306f645a6620382b7b182d8dcf732324e9debc65fc88195247ad1492c725dfdece
+  metadata.gz: bbca5b53805a870e2c8f5811d25e718953628c2e6e33150f2f62d5a29555a38d79057b7910a34aca052f97b34cf31d15056a1ecbc9923a5093db7801dc628cc6
+  data.tar.gz: ba204c300eb92eadfb14270df762294ccd33ee2f271a1289fce35be10ac104a64854b37f84abd3632014fa6d7ef088e2f352ecd8f6665869e940f49c133d2f5f

data/lib/yaml_csp_config/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YamlCspConfig
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/sig/types.rbs

@@ -0,0 +1,60 @@
+module YamlCspConfig
+  VERSION: String
+
+  class Railtie < ::Rails::Railtie
+  end
+
+  class Configuration
+    attr_accessor configuration_file_path: String | Pathname
+    attr_accessor yaml_config_base_key: String | Symbol
+    attr_accessor default_env_var_additions_key_prefix: String
+    attr_accessor default_env_var_group_key: String
+
+    def initialize: -> void
+  end
+
+  def self.configuration: -> YamlCspConfig::Configuration
+  def self.configure: ?{ (YamlCspConfig::Configuration config) -> void } -> YamlCspConfig::Configuration
+
+  YamlLoader::DIRECTIVES: Array[Symbol]
+
+  type cspFilePath = String | Pathname
+  type cspGroup = Hash[String, cspDirectives]
+  type cspDirectives = Hash[String, String | Symbol | Array[String | Symbol]]
+
+  type cspPolicyRules = Hash[String, Array[String | Symbol]]
+
+  class YamlLoader
+    def self.call: (ActionDispatch::ContentSecurityPolicy policy, ?cspFilePath config_file) -> ActionDispatch::ContentSecurityPolicy
+
+    def initialize: (
+      ActionDispatch::ContentSecurityPolicy policy,
+      cspFilePath config_file_path,
+      ?group_key: String,
+      ?var_key_prefix: String
+    ) -> void
+
+    def configure: -> ActionDispatch::ContentSecurityPolicy
+
+    private
+
+    attr_reader policy: ActionDispatch::ContentSecurityPolicy
+    attr_reader config_file_path: cspFilePath
+    attr_reader env_var_group_key: String
+    attr_reader env_var_key_prefix: String
+
+    def raw_configuration: -> cspGroup
+    def configure_with_overrides: -> cspPolicyRules
+    def env_override: (cspGroup config, cspPolicyRules policies) -> cspPolicyRules
+    def env_var_group_override: (cspGroup config, cspPolicyRules policies) -> cspPolicyRules
+    def env_var_direct_override: (cspPolicyRules policies) -> cspPolicyRules
+    def add_to_csp: (cspPolicyRules policies, String rule, (Symbol | String | Array[String | Symbol]) value) -> void
+    def config_key_base: -> String
+  end
+end
+
+module ActionDispatch
+  class ContentSecurityPolicy
+    def load_from_yml: -> ActionDispatch::ContentSecurityPolicy
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml_csp_config
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Stephen Ierodiaconou
@@ -80,7 +80,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: The CSP configuration can also be extended by environment variables.
+description: yaml_csp_config provides you with a way to manage your Rails 5.2+ CSP
+  configuration via a YAML file. The CSP configuration can also be extended by environment
+  variables.
 email:
 - stevegeek@gmail.com
 executables: []
@@ -100,6 +102,7 @@ files:
 - lib/yaml_csp_config/railtie.rb
 - lib/yaml_csp_config/version.rb
 - lib/yaml_csp_config/yaml_loader.rb
+- sig/types.rbs
 homepage: https://github.com/stevegeek/yaml_csp_config
 licenses:
 - MIT