slack_resources 0.1.3 → 0.1.4

data/lib/slack_resources/generator/event_api/type_detection.rb

@@ -0,0 +1,272 @@
+require 'active_support/core_ext/module/delegation'
+
+module SlackResources
+  module Generator
+    class TypeDetection
+      using StrongHash
+
+      SPECIAL_TYPE = '_type'.freeze
+      MULTIPLE_EXAMPLES = 'MULTIPLE_EXAMPLES'.freeze
+
+      CONST_TYPES = %w[
+        type
+        subtype
+      ].freeze
+
+      DEFAULT_TYPES = Set.new(%w[
+        string
+        number
+        object
+        array
+        boolean
+        null
+      ])
+
+      STRING_ID_PROPERTIES_MAP = {
+        item_user: 'user_id',
+        user: 'user_id',
+        creator: 'user_id',
+        inviter: 'user_id',
+        created_by: 'user_id',
+        updated_by: 'user_id',
+        deleted_by: 'user_id',
+        channel: 'channel_id',
+        comment: 'comment_id',
+        team: 'team_id',
+      }.stringify_keys!
+
+      STRING_ID_PROPERTIES = Set.new(STRING_ID_PROPERTIES_MAP.keys)
+
+      DIRECT_STRING_PROPERTIES = Set.new(%w[
+        email_domain
+        text
+        description
+        handle
+        url
+        domain
+        challenge
+      ])
+
+      USER_COUNT_PROPERTIES = Set.new(%w[
+        user_count
+        added_users_count
+        removed_users_count
+      ])
+
+      ARRAY_PROPERTIES_TYPE_MAP = {
+        authed_users: 'user_id',
+        users: 'user_id',
+        added_users: 'user_id',
+        removed_users: 'user_id',
+        authed_teams: 'team_id',
+        channels: 'channel_id',
+        groups: 'group_id',
+        scopes: 'scope',
+        links: 'link',
+        oauth: 'string',
+        bot: 'string',
+        resources: 'resource_item',
+      }.stringify_keys!
+
+      TOKENS_REVOKED_ARRAY_PROPERTIES = Set.new(%w[
+        oauth
+        bot
+      ])
+
+      ARRAY_PROPERTIES = Set.new(ARRAY_PROPERTIES_TYPE_MAP.keys - TOKENS_REVOKED_ARRAY_PROPERTIES.to_a)
+
+      BOOLEAN = Set.new([true, false])
+
+      AMBIENT_PROPERTIES = Set.new(%w[
+        id
+        type
+        name
+        subtype
+        value
+        item
+      ])
+
+      class << self
+        def default_type?(type)
+          DEFAULT_TYPES.include?(type)
+        end
+      end
+
+      def initialize(to_schema_instance:, parent_key:, prop_name:, value:, container:, preset:)
+        @to_schema = to_schema_instance
+        @parent_key = parent_key
+        @prop_name = prop_name
+        @value = value
+        @container = container
+        @preset = preset
+      end
+
+      def execute! # rubocop:disable Metrics/PerceivedComplexity,Metrics/CyclomaticComplexity
+        case
+        when root_schema? && constantable?
+          { 'const' => @value }
+        when item_schema? && type?
+          define_string("#{root_type_prefix}_#{@parent_key}_type")
+
+        when string_id?
+          define_string_id
+
+        when emoji_list?
+          define_string('emoji_name')
+          '[]emoji_name'
+        when emoji_alternative?
+          define_string('emoji_name')
+
+        when array?
+          define_array_type
+
+        when user_count?
+          'user_count'
+        when time_integer?
+          'time_integer'
+        when boolean?
+          'boolean'
+        when direct_string? || (on_url_verification? && @prop_name == 'token')
+          'string'
+        when timestamp?
+          'timestamp'
+
+        else
+          define_default_type(normalized_prop_name, @value, @container, const_type?)
+        end
+      end
+
+      private
+
+      delegate(
+        :root_schema?,
+        :define_string,
+        :root_type,
+        :root_type_prefix,
+        :define_default_type,
+        :define_object,
+        :define_enum,
+        :ref_to,
+        to: :@to_schema
+      )
+
+      def normalized_prop_name
+        if ambient?
+          root_schema? ? "#{root_type_prefix}_#{@prop_name}" : "#{@parent_key}_#{@prop_name}"
+        else
+          @prop_name
+        end
+      end
+
+      def type?
+        @prop_name == 'type'
+      end
+
+      def const_type?
+        CONST_TYPES.include?(@prop_name) || @prop_name.match(/_type$/)
+      end
+
+      def string?
+        @value.is_a?(String)
+      end
+
+      def constantable?
+        const_type? && (@value.is_a?(String) || @value.is_a?(Integer))
+      end
+
+      def emoji_alternative?
+        @prop_name == 'reaction'
+      end
+
+      def item_schema?
+        @parent_key == 'item'
+      end
+
+      def ambient?
+        AMBIENT_PROPERTIES.include?(@prop_name)
+      end
+
+      def time_integer?
+        @value.is_a?(Integer)
+      end
+
+      def boolean?
+        BOOLEAN.include?(@value)
+      end
+
+      def timestamp?
+        @prop_name == 'latest' || @prop_name.match(/.+_ts$/) || float_string?
+      end
+
+      def float_string?
+        @value.respond_to?(:to_f) && @value == @value.to_f.to_s
+      end
+
+      def array?
+        ARRAY_PROPERTIES.include?(@prop_name) || tokens_revoked_array?
+      end
+
+      def tokens_revoked_array?
+        on_tokens_revoked? && TOKENS_REVOKED_ARRAY_PROPERTIES.include?(@prop_name)
+      end
+
+      def user_count?
+        USER_COUNT_PROPERTIES.include?(@prop_name)
+      end
+
+      def direct_string?
+        DIRECT_STRING_PROPERTIES.include?(@prop_name)
+      end
+
+      def string_id?
+        @prop_name.match(/_id$/) || (string_value? && STRING_ID_PROPERTIES.include?(@prop_name))
+      end
+
+      def string_value?
+        @value.nil? || @value.is_a?(String)
+      end
+
+      def default_type?(type)
+        DEFAULT_TYPES.include?(type)
+      end
+
+      def emoji_list?
+        on_emoji_changed? && @prop_name == 'names'
+      end
+
+      def on_tokens_revoked?
+        root_type == 'tokens_revoked'
+      end
+
+      def on_url_verification?
+        root_type == 'url_verification'
+      end
+
+      def on_emoji_changed?
+        root_type == 'emoji_changed'
+      end
+
+      def define_array_type
+        type = ARRAY_PROPERTIES_TYPE_MAP[@prop_name]
+        array_type = "[]#{type}"
+
+        return array_type if default_type?(type)
+        return define_string(type) && array_type unless @value.is_a?(Hash)
+
+        to_child_schema(
+          prop_name: type,
+          example: @value.first,
+          key: @prop_name,
+          parent: @container
+        )
+
+        array_type
+      end
+
+      def define_string_id
+        type = STRING_ID_PROPERTIES_MAP[@prop_name] || @prop_name
+        define_string(type)
+      end
+    end
+  end
+end

data/lib/slack_resources/generator/event_api/write.rb

@@ -0,0 +1,123 @@
+require 'pathname'
+require 'rest-client'
+require 'nokogiri'
+require 'json'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
+
+module SlackResources
+  module Generator
+    class Writer
+      using StrongHash
+
+      def initialize(output_dir:, data_dir:)
+        @output_dir = Pathname(output_dir)
+        @details_output_dir = @output_dir.join('details')
+        @schemas_output_dir = @output_dir.join('schemas')
+        @example_output_dir = @output_dir.join('examples')
+
+        @data_dir = Pathname(data_dir)
+        @meta = JSON.parse(File.read(@data_dir.join('meta.json')))
+        @preset_schema = JSON.parse(File.read(@data_dir.join('preset_schemas.json')))
+        @preset_definitions = @preset_schema['definitions']
+
+        @examples_dir = @data_dir.join('examples')
+        @added_examples_dir = @data_dir.join('_added_examples')
+      end
+
+      def execute!
+        FileUtils.mkdir_p(@details_output_dir)
+        FileUtils.mkdir_p(@schemas_output_dir)
+        FileUtils.mkdir_p(@example_output_dir)
+
+        alt_event_type_mapped_examples = ExamplePreparation.new(
+          examples_dir: @examples_dir,
+          added_examples_dir: @added_examples_dir
+        ).execute!
+
+        examples_with_metadata = alt_event_type_mapped_examples.map do |alt_event_type, example|
+          info = @meta['subscriptions'][alt_event_type] || @meta['subscriptions'][example['type']] || {}
+          [info['url'], alt_event_type, example, info['compatibility'], info['scopes']]
+        end
+
+        all_sub_schemas = @preset_definitions.merge(
+          'scope' => {
+            "type": 'string',
+            "enum": @meta['scopes'],
+          }
+        )
+
+        main_schemas = {}
+
+        all_details = examples_with_metadata.map do |url, alt_event_type, example, compatibility, scopes|
+          raw_example = example.delete('_raw_example')
+          schema, new_definition, included_props_names = ToSchema.new(
+            example: example,
+            url: url,
+            preset: all_sub_schemas
+          ).execute!
+
+          all_sub_schemas.protect_merge!(new_definition)
+
+          included_schemas = included_props_names.inject({}) do |a, included_prop|
+            all_sub_schemas[included_prop] ? a.protect_merge!(included_prop => all_sub_schemas[included_prop]) : a
+          end
+
+          schema['description'] = "learn more: #{url}"
+          schema['example'] = raw_example
+
+          main_schemas[alt_event_type] = schema
+
+          [
+            alt_event_type,
+            {
+              url: url,
+              event: alt_event_type,
+              sub_schemas: included_schemas,
+              schema: schema,
+              compatibility: compatibility,
+              scopes: scopes,
+            },
+            {
+              "$schema": 'http://json-schema.org/draft-07/schema',
+              'definitions' => included_schemas.protect_merge!(alt_event_type => schema),
+            },
+            raw_example,
+          ]
+        end
+
+        write_each_data_json!(all_details)
+        write_all_schemas_json!(all_sub_schemas, main_schemas)
+        write_summary!(all_details.map { |d| d[1] })
+
+        all_details
+      end
+
+      # @output_dir = Pathname('./lib/slack_resources/resources/event_api/')
+
+      private
+
+      def write_each_data_json!(all_details)
+        all_details.each do |alt_event_type, data, single_schema, example|
+          File.write(@details_output_dir.join("#{alt_event_type}.json").to_s, JSON.pretty_generate(data))
+          File.write(@example_output_dir.join("#{alt_event_type}.json").to_s, JSON.pretty_generate(example))
+          File.write(@schemas_output_dir.join("#{alt_event_type}.json").to_s, JSON.pretty_generate(single_schema))
+        end
+      end
+
+      def write_all_schemas_json!(all_sub_schemas, main_schemas)
+        File.write(
+          @output_dir.join('schema.json').to_s,
+          JSON.pretty_generate(
+            "$schema": 'http://json-schema.org/draft-07/schema',
+            'definitions' => all_sub_schemas.protect_merge!(main_schemas).key_ordered
+          )
+        )
+      end
+
+      def write_summary!(data)
+        File.write(@output_dir.join('summary.json').to_s, JSON.pretty_generate(data.sort_by { |a| a[:type] }))
+      end
+    end
+  end
+end

data/lib/slack_resources/raw_data/event_api/_added_examples/emoji_changed.add.json

@@ -0,0 +1,7 @@
+{
+  "type": "emoji_changed",
+  "subtype": "add",
+  "name": "picard_facepalm",
+  "value": "https://my.slack.com/emoji/picard_facepalm/db8e287430eaa459.gif",
+  "event_ts" : "1361482916.000004"
+}

data/lib/slack_resources/raw_data/event_api/_added_examples/emoji_changed.remove.json

@@ -0,0 +1,6 @@
+{
+  "type": "emoji_changed",
+  "subtype": "remove",
+  "names": ["picard_facepalm"],
+  "event_ts" : "1361482916.000004"
+}

data/lib/slack_resources/raw_data/event_api/examples/app_mention.json

@@ -0,0 +1,8 @@
+{
+  "type": "app_mention",
+  "user": "U061F7AUR",
+  "text": "<@U0LAN0Z89> is it everything a river should be?",
+  "ts": "1515449522.000016",
+  "channel": "C0LAN2Q65",
+  "event_ts": "1515449522000016"
+}

data/lib/slack_resources/raw_data/event_api/examples/app_rate_limited.json

@@ -0,0 +1,7 @@
+{
+  "token": "Jhj5dZrVaK7ZwHHjRyZWjbDl",
+  "type": "app_rate_limited",
+  "team_id": "T123456",
+  "minute_rate_limited": 1518467820,
+  "api_app_id": "A123456"
+}

data/lib/slack_resources/raw_data/event_api/examples/app_uninstalled.json

@@ -0,0 +1,11 @@
+{
+  "token": "XXYYZZ",
+  "team_id": "TXXXXXXXX",
+  "api_app_id": "AXXXXXXXXX",
+  "event": {
+    "type": "app_uninstalled"
+  },
+  "type": "event_callback",
+  "event_id": "EvXXXXXXXX",
+  "event_time": 1234567890
+}

data/lib/slack_resources/raw_data/event_api/examples/channel_archive.json

@@ -0,0 +1,5 @@
+{
+  "type": "channel_archive",
+  "channel": "C024BE91L",
+  "user": "U024BE7LH"
+}