slack_resources 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9dba64ad62d735b1fdd4d78bcc27d49dc0b542b6cc8396f9c242b0ed75957c4
-  data.tar.gz: 5d44a72526ca76e82b74bae7cbb43c0415ac3a3dcb507c1bae68263eb379f85a
+  metadata.gz: f8dc3db936e304bc7bbe9a46ca4f15abc27c9ae3633d233ed30125d1fa4f9dac
+  data.tar.gz: ac21512366ff00cbca6e1353ea629d8bcc763f21ee76fd72dab691f5d8067e0d
 SHA512:
-  metadata.gz: 3d89dc5724b52540c15d02b33f5c353dff4a8f1bb19924f03ceec801b68af309b47fbb5e62261b55af4b2f3861f3748c3763d0388f4c9be40be4603b3549362d
-  data.tar.gz: c42e4c9d96649cad665cf4c5e756379fbaeba9da8ab45555533cdd184d8d10fd70405d34a28ef8f9cc1c4bdfd858e5d661807205b230960adffe56fd2adc4f60
+  metadata.gz: 6996b10694f5a3e400dc90368865764ad0741ab549662ee836656bbd104e6da432645ff4945b84aec7d2158a463426ba5ac8367d71108783f9125bf3f2efc463
+  data.tar.gz: 2aaa56fa07cac1af32652c9c1086e8d4d26cfc04902b65405db3e7c68d134438cd0c2181e049bd3271996bf8e32687343df6f722dbafea64d23181f06d1fb8b1

data/.circleci/config.yml

@@ -1,62 +1,11 @@
 version: 2
 jobs:
-  test:
-    parallelism: 1
-    docker:
-      - image: circleci/ruby:2.5.1
-    steps:
-      - checkout
-
-      - restore_cache:
-          keys:
-            - rails-demo-bundle-v2-{{ checksum "Gemfile.lock" }}
-            - rails-demo-bundle-v2-
-
-      - run:
-          name: Bundle Install
-          command: bundle check || bundle install --path vendor/bundle
-
-      - save_cache:
-          key: rails-demo-bundle-v2-{{ checksum "Gemfile.lock" }}
-          paths:
-            - vendor/bundle
-
-      - run:
-          name: Test
-          command: bundle exec rspec -cfd
-      - run:
-          name: Rubocop
-          command: bundle exec rubocop
-
   deploy_gem:
     parallelism: 1
     docker:
-      - image: circleci/ruby:2.5.1
+      - image: circleci/ruby-2.5
     steps:
       - checkout
-      - run:
-          name: Deployment
-          command: ruby .circleci/gem_deployment.rb $RUBYGEMS_API_KEY
-
-  deploy_gem_minor:
-    parallelism: 1
-    docker:
-      - image: circleci/ruby:2.5.1
-    steps:
-      - checkout
-      - run:
-          name: Deployment
-          command: ruby .circleci/gem_deployment.rb $RUBYGEMS_API_KEY minor
-
-  deploy_gem_major:
-    parallelism: 1
-    docker:
-      - image: circleci/ruby:2.5.1
-    steps:
-      - checkout
-      - run:
-          name: Deployment
-          command: ruby .circleci/gem_deployment.rb $RUBYGEMS_API_KEY major
 
 
 workflows:
@@ -71,17 +20,3 @@ workflows:
                 - deployment/gem
           requires:
             - test
-      - deploy_gem_minor:
-          filters:
-            branches:
-              only:
-                - deployment/gem_minor
-          requires:
-            - test
-      - deploy_gem_major:
-          filters:
-            branches:
-              only:
-                - deployment/gem_major
-          requires:
-            - test

data/.circleci/preparation.rb

@@ -0,0 +1,11 @@
+class Preparation
+  def initialize(params)
+    @params = params
+  end
+
+  def execute!
+    p `gem search slack_resources`
+  end
+end
+
+Preparation.new(ARGV).execute! if __FILE__ == $0

data/.rubocop.yml

@@ -2,8 +2,6 @@ AllCops:
   TargetRubyVersion: 2.5
   Exclude:
     - tmp
-    - lib/slack_resources/generator/event_api/fetch.rb
-    - vendor/**/*
 
 Rails:
   Enabled: true
@@ -29,7 +27,7 @@ Metrics/BlockLength:
     - 'spec/**/*'
 
 Metrics/MethodLength:
-  Max: 200
+  Max: 40
   Exclude:
   - db/migrate/*.rb
 
@@ -37,7 +35,7 @@ Metrics/ModuleLength:
   Max: 150
 
 Metrics/ClassLength:
-  Max: 300
+  Max: 150
   Exclude:
   - db/migrate/*.rb
 
@@ -96,9 +94,3 @@ Naming/UncommunicativeMethodParamName:
 
 Layout/IndentArray:
   EnforcedStyle: consistent
-
-Metrics/ParameterLists:
-  Max: 20
-
-Style/RescueModifier:
-  Enabled: false

data/Gemfile

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
+# Specify your gem's dependencies in slack_app_request_handler.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack_resources (0.0.0)
+    slack_app_request_handler (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,24 +12,24 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.0)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.3)
     diff-lcs (1.3)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.5.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (1.3.0)
+    i18n (1.2.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2018.0812)
-    mini_portile2 (2.4.0)
+    mini_portile2 (2.3.0)
     minitest (5.11.3)
     netrc (0.11.0)
-    nokogiri (1.9.1)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
     onkcop (0.53.0.2)
       rubocop (>= 0.53.0)
       rubocop-rspec (>= 1.24.0)
@@ -73,7 +73,7 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)
-    unicode-display_width (1.4.1)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -87,7 +87,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rest-client (~> 2.0)
   rspec (~> 3.0)
-  slack_resources!
+  slack_app_request_handler!
 
 BUNDLED WITH
    1.16.1

data/lib/event_api/write.rb

@@ -0,0 +1,364 @@
+require 'pathname'
+require 'rest-client'
+require 'nokogiri'
+require 'json'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
+
+BASE_DIR = Pathname('./lib/slack_resources/resources/event_api/')
+EXAMPLES_DIR = BASE_DIR.join('examples')
+ADDED_EXAMPLES_DIR = BASE_DIR.join('_added_examples')
+DETAILS_DIR = BASE_DIR.join('details')
+SCHEMAS_DIR = BASE_DIR.join('schemas')
+
+FileUtils.mkdir_p(DETAILS_DIR)
+FileUtils.mkdir_p(SCHEMAS_DIR)
+
+PRESET_SCHEMA = JSON.parse(File.read('lib/schema.json'))
+PRESET_DEFINITIONS = PRESET_SCHEMA['definitions']
+
+class Hash
+  def protect_merge!(b)
+    (b.keys - keys).map do |new_key|
+      self[new_key] = b[new_key]
+    end
+
+    self
+  end
+
+  def key_ordered
+    keys.sort.inject({}) do |a, k|
+      a.merge!(k => self[k])
+    end
+  end
+end
+
+def to_schema(response, url, preset_schema = JSON.parse(PRESET_SCHEMA.to_json))
+  schema, defined, defined_used = to_schema_support(response, url, 'root', preset_schema)
+
+  [schema, defined, defined_used]
+end
+
+def string_k_v(k, v)
+  (v.nil? || v.is_a?(String)) && k
+end
+
+def to_schema_support(response, url, key = 'root', preset = {}, defined = {}, defined_used = [], parent = {})
+  types = JSON.parse(response.to_json).key_ordered
+
+  def_string = ->(id_key) { id_key.tap { defined.merge!(id_key => { 'type' => 'string' }) } }
+
+  properties = types.inject({}) do |a, (k, v)|
+    if v.is_a?(Hash)
+      if v['_type'] && v['_type'] == 'enum'
+        def_k = "#{key == 'root' ? types['type'] : key}_#{k}"
+        defined[def_k] = { 'type' => 'string', enum: v['items'] }
+        next a.merge(k => { '$ref' => "#/definitions/#{def_k}" })
+      end
+
+      def_k =
+        case
+        when k == 'item'
+          t = types['type'].split('_').shift
+          "#{t}_item"
+        else
+          k
+        end
+
+      schema, = to_schema_support(v, url, k, preset, defined, defined_used, types)
+      defined_used << def_k
+      defined[def_k] = schema
+      next a.merge(k => { '$ref' => "#/definitions/#{def_k}" })
+    end
+
+    type =
+      case k
+      when key == 'root' && 'type'
+        { 'const' => v }
+      when key == 'root' && 'subtype'
+        def_string.call('subscription_subtype')
+      when key == 'event' && 'type'
+        { 'const' => v }
+      when key == 'item' && 'type'
+        t = parent['type'].split('_').shift
+        def_string.call("#{t}_#{key}_type")
+      when 'type'
+        def_string.call("#{key}_type")
+
+      when 'name'
+        def_string.call("#{key}_name")
+      when 'id'
+        def_string.call("#{key}_id")
+      when /.+_id$/
+        def_string.call(k)
+
+      when types['type'] == 'emoji_changed' && 'names'
+        def_string.call('emoji_name')
+        '[]emoji_name'
+      when 'reaction'
+        def_string.call('emoji_name')
+        'emoji_name'
+      when types['type'] == 'team_rename' && 'name'
+        'team_name'
+
+      when string_k_v('item_user', v),
+        string_k_v('user', v),
+        string_k_v('creator', v),
+        string_k_v('inviter', v),
+        string_k_v('created_by', v),
+        string_k_v('updated_by', v),
+        string_k_v('deleted_by', v)
+        def_string.call('user_id')
+      when string_k_v('channel', v)
+        def_string.call('channel_id')
+      when string_k_v('comment', v)
+        def_string.call('comment_id')
+      when string_k_v('team', v)
+        def_string.call('team_id')
+
+      when 'authed_users', 'authed_users', 'users', 'added_users', 'removed_users'
+        def_string.call('user_id')
+        '[]user_id'
+      when 'authed_teams'
+        def_string.call('team_id')
+        '[]team_id'
+      when 'channels'
+        def_string.call('channel_id')
+        '[]channel_id'
+      when 'groups'
+        def_string.call('group_id')
+        '[]group_id'
+
+      when 'scopes'
+        '[]scope'
+      when 'links'
+        '[]link'
+
+      when 'user_count', 'added_users_count', 'removed_users_count'
+        'user_count'
+
+      when 'resources'
+        defined['resource_item'] = to_schema_support(v.first, url, k, preset, defined, defined_used, types)
+        '[]resource_item'
+
+      when v.is_a?(Integer) && k
+        'time_integer'
+      when (v == true || v == false) && k
+        'boolean'
+      when 'email_domain', 'text', 'description', 'handle', 'url', 'domain'
+        'string'
+      when parent['type'] == 'tokens_revoked' && 'oauth'
+        '[]string'
+      when parent['type'] == 'tokens_revoked' && 'bot'
+        '[]string'
+      when 'latest', /.+_ts$/
+        'timestamp'
+      when preset[k] && k
+        k
+      else
+        if v.respond_to?(:to_f) && v == v.to_f.to_s
+          'timestamp'
+        elsif v.is_a?(String)
+          def_string.call(k)
+          'string'
+        else
+          v
+        end
+      end
+
+    if default_type?(type)
+      a.merge(k => { 'type' => type })
+    elsif type.is_a?(Hash)
+      a.merge(k => type)
+    elsif type && type[0..1] == '[]'
+      item = type[2..-1]
+      if default_type?(item)
+        next a.merge(
+          k => {
+            'type' => 'array',
+            'items' => {
+              'type' => item,
+            },
+          }
+        )
+      else
+        if v.first.is_a?(Hash)
+          schema, = to_schema_support(v.first, url, item, preset, defined, defined_used, types)
+          defined[item] = schema
+        elsif v.first.is_a?(String)
+          def_string.call(item)
+        end
+
+        defined_used << item
+      end
+      a.merge(
+        k => {
+          'type' => 'array',
+          'items' => {
+            '$ref' => "#/definitions/#{item}",
+          },
+        }
+      )
+    else
+      defined_used << type
+      a.merge(
+        k => {
+          '$ref' => "#/definitions/#{type}",
+        }
+      )
+    end
+  end
+
+  [
+    {
+      'type' => 'object',
+      description: properties.blank? ? "definition snipped. learn more: #{url}" : '(defined by script)',
+      'properties' => properties,
+    },
+    defined,
+    defined_used,
+  ]
+end
+
+def default_type?(type)
+  type == 'string' || type == 'number' || type == 'object' || type == 'array' || type == 'boolean' || type == 'null'
+end
+
+def safe_merge(a, b)
+  (b.keys - a.keys).map do |new_key|
+    a[new_key] = b[new_key]
+  end
+
+  a
+end
+
+def prepare_data
+  Dir.glob(ADDED_EXAMPLES_DIR.join('**/*.json')).each do |f|
+    file_name = File.basename(f)
+    FileUtils.copy(f, EXAMPLES_DIR.join(file_name))
+  end
+
+  raw_examples = Dir.glob(EXAMPLES_DIR.join('**/*.json')).map do |f|
+    example = JSON.parse(File.read(f))
+    [File.basename(f, '.json'), (example['event'].presence || example).key_ordered]
+  end
+
+  raw_keys = Set.new(raw_examples.map(&:first))
+  real_set = Set.new
+  real_type = {}
+  raw_types = raw_examples.each_with_object({}) do |(name, v), a|
+    type = v['type']
+
+    real_type.protect_merge!(type => JSON.parse(v.to_json))
+
+    unless real_set.include?(type)
+      real_set.add(type)
+      raw_keys.delete(name)
+      next a.merge!(name => v)
+    end
+
+    raw_keys.delete(name) if name != type
+    already = real_type[type]
+
+    keys = (already.keys + v.keys).uniq
+
+    keys.each do |k|
+      vv = v[k]
+      pre_v = already[k]
+
+      if k.match?('.*_type')
+        if pre_v.is_a?(Hash) && pre_v['_type'] == 'enum'
+          pre_v['items'] << vv
+        else
+          already[k] = {
+            '_type' => 'enum',
+            'target' => k,
+            'items' => [pre_v],
+          }
+        end
+      else
+        # TODO: nil が許容されている場合は type を or にする
+      end
+    end
+  end
+
+  real_type.select { |k, _| raw_keys.include?(k) }.protect_merge!(raw_types)
+end
+
+def write_event_api_summary
+  meta = JSON.parse(File.read(BASE_DIR.join('meta.json')))
+
+  event_api_pages = prepare_data.map do |type, data|
+    info = meta['subscriptions'][type] || {}
+    [info['url'], type, data, info['compatibility'], info['scopes']]
+  end
+
+  preset = PRESET_DEFINITIONS.merge(
+    'subscription_type' => {
+      "type": 'string',
+      "enum": meta['types'],
+    },
+    'scope' => {
+      "type": 'string',
+      "enum": meta['scopes'],
+    }
+  )
+
+  all_defined = JSON.parse(preset.to_json)
+  all_schema = {}
+
+  all_details = event_api_pages.map do |url, type, response, compatibility, scopes|
+    schema, defined, used = to_schema(response, url, preset)
+    schema[:description] = "learn more: #{url}"
+
+    pre = preset.protect_merge!(defined)
+
+    all_defined.protect_merge!(defined)
+
+    base = used.uniq.inject({}) do |a, pre_key|
+      pre[pre_key] ? a.protect_merge!(pre_key => pre[pre_key]) : a
+    end
+
+    normalized_response = response.inject({}) do |a, (k, v)|
+      next a.protect_merge!(k => v) unless v.is_a?(Hash) && v['_type'] == 'enum'
+
+      a.merge!(v['target'] => v['items'].map { |s| s || 'null' }.join('|'))
+    end
+
+    {
+      url: url,
+      type: type,
+      response: normalized_response,
+      defined: base.protect_merge!(defined),
+      schema: schema.protect_merge!(example: normalized_response),
+      compatibility: compatibility,
+      scopes: scopes,
+    }
+  end
+
+  all_details.map do |data|
+    type = data[:type]
+    schema = data[:schema]
+    defined = data.delete(:defined)
+
+    all_schema[type] = schema
+
+    schema_data = {
+      "$schema": 'http://json-schema.org/draft-07/schema',
+      'definitions' => defined.protect_merge!(type => schema),
+    }
+
+    data[:schema] = schema_data
+
+    File.write(SCHEMAS_DIR.join("#{type}.json").to_s, JSON.pretty_generate(schema_data))
+    File.write(DETAILS_DIR.join("#{type}.json").to_s, JSON.pretty_generate(data))
+  end
+
+  File.write(BASE_DIR.join('schema.json').to_s, JSON.pretty_generate({
+                                                                       "$schema": 'http://json-schema.org/draft-07/schema',
+                                                                       'definitions' => all_defined.protect_merge!(all_schema).key_ordered,
+                                                                     }))
+  File.write(BASE_DIR.join('summary.json').to_s, JSON.pretty_generate(all_details.sort_by { |a| a[:type] }))
+end
+
+write_event_api_summary

data/lib/{slack_resources/raw_data/event_api/preset_schemas.json → schema.json}

@@ -21,13 +21,6 @@
     },
     "user_count": {
       "type": "string"
-    },
-    "emoji_changed_subtype": {
-      "type": "string",
-      "enum": [
-        "add",
-        "remove"
-      ]
     }
   }
 }