slack_resources 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9dba64ad62d735b1fdd4d78bcc27d49dc0b542b6cc8396f9c242b0ed75957c4
+  data.tar.gz: 5d44a72526ca76e82b74bae7cbb43c0415ac3a3dcb507c1bae68263eb379f85a
+SHA512:
+  metadata.gz: 3d89dc5724b52540c15d02b33f5c353dff4a8f1bb19924f03ceec801b68af309b47fbb5e62261b55af4b2f3861f3748c3763d0388f4c9be40be4603b3549362d
+  data.tar.gz: c42e4c9d96649cad665cf4c5e756379fbaeba9da8ab45555533cdd184d8d10fd70405d34a28ef8f9cc1c4bdfd858e5d661807205b230960adffe56fd2adc4f60

data/.circleci/config.yml

@@ -0,0 +1,87 @@
+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
+    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:
+  version: 2
+  build_and_test:
+    jobs:
+      - test
+      - deploy_gem:
+          filters:
+            branches:
+              only:
+                - 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/gem_deployment.rb

@@ -0,0 +1,53 @@
+class GemDeployment
+  CREDENTIAL_DIR_PATH = '~/.gem/credentials'
+  CREDENTIAL_FILE_PATH = '~/.gem/credentials'
+  VERSION_FILE_PATH = './lib/slack_resources/version.rb'
+
+  def initialize(api_key = '', version = 'tiny')
+    @api_key = api_key
+    @version = version
+  end
+
+  def execute!
+    major, minor, tiny = fetch_version
+
+    major += 1 if major?
+    minor += 1 if minor?
+    tiny += 1 if tiny?
+
+    next_version = [major, minor, tiny].join('.')
+
+    `echo "---\n:rubygems_api_key: #{@api_key}\n" > ~/.gem/credentials && chmod 600 ~/.gem/credentials`
+
+    File.write(VERSION_FILE_PATH, <<~VER)
+      module SlackResources
+        VERSION = '#{next_version}'.freeze
+      end
+    VER
+
+    result = `gem build slack_resources.gemspec`
+    puts result
+    gem_file = result.match(/File: *(.+)\n/m)[1]
+    puts `gem push #{gem_file}`
+  end
+
+  private
+
+  def fetch_version
+    `gem search slack_resources`.match(/\(([\d.]+)\)/)[1].split('.').map(&:to_i)
+  end
+
+  def major?
+    @version == 'major'
+  end
+
+  def minor?
+    @version == 'minor'
+  end
+
+  def tiny?
+    @version == 'tiny'
+  end
+end
+
+GemDeployment.new(*ARGV).execute! if __FILE__ == $0

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env
+.circleci/config.*.yml

data/.rubocop.yml

@@ -0,0 +1,104 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - tmp
+    - lib/slack_resources/generator/event_api/fetch.rb
+    - vendor/**/*
+
+Rails:
+  Enabled: true
+
+Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 40
+  Exclude:
+  - db/migrate/*.rb
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 250
+  Exclude:
+  - db/migrate/*.rb
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 200
+  Exclude:
+  - db/migrate/*.rb
+
+Metrics/ModuleLength:
+  Max: 150
+
+Metrics/ClassLength:
+  Max: 300
+  Exclude:
+  - db/migrate/*.rb
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/BlockComments:
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/OptionHash:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Rails/DynamicFindBy:
+  Whitelist:
+  - find_by_param
+  - find_by_param!
+
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Semicolon:
+  Exclude:
+    - 'spec/**/*'
+Naming/UncommunicativeMethodParamName:
+  MinNameLength: 1
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Metrics/ParameterLists:
+  Max: 20
+
+Style/RescueModifier:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    slack_resources (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.1.4)
+    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)
+      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)
+    minitest (5.11.3)
+    netrc (0.11.0)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    onkcop (0.53.0.2)
+      rubocop (>= 0.53.0)
+      rubocop-rspec (>= 1.24.0)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.61.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.30.1)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 5.2)
+  bundler (~> 1.16)
+  dotenv (~> 2.5)
+  nokogiri (~> 1.8)
+  onkcop (~> 0.53)
+  rake (~> 10.0)
+  rest-client (~> 2.0)
+  rspec (~> 3.0)
+  slack_resources!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,29 @@
+# Slack resources
+
+We create JSON schemas from Slack document and api examples.
+
+# Event api
+
+Most event api examples are not wrapped meta data. But some examples are already wrapped. (e.x. `token_revoked` )
+
+Our JSON schema did not include wrapping meta data.
+
+```json
+{
+        "token": "XXYYZZ",
+        "team_id": "TXXXXXXXX",
+        "api_app_id": "AXXXXXXXXX",
+        "event": {}, // Examples are inserted here.
+        "type": "event_callback",
+        "authed_users": [
+                "UXXXXXXX1",
+                "UXXXXXXX2"
+        ],
+        "event_id": "Ev08MFMKH6",
+        "event_time": 1234567890
+}
+```
+
+## message.foo
+
+`message` events have `channel_type` . They are mapped `message.${channel_type}.json` .

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generate_event_api_resources.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'slack_resources'
+
+FileUtils.rm_r('./lib/slack_resources/resources/event_api')
+SlackResources::Generator::Writer.new(
+  output_dir: './lib/slack_resources/resources/event_api',
+  data_dir: './lib/slack_resources/raw_data/event_api'
+).execute!

data/lib/slack_resources.rb

@@ -0,0 +1,11 @@
+module SlackResources
+  require 'slack_resources/version' if File.exist?('./lib/slack_resources/version')
+
+  require 'slack_resources/generator/event_api/strong_hash'
+  require 'slack_resources/generator/event_api/examples_preparation'
+  require 'slack_resources/generator/event_api/to_schema'
+  require 'slack_resources/generator/event_api/type_detection'
+  require 'slack_resources/generator/event_api/write'
+
+  require 'slack_resources/resources/event_api'
+end

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

@@ -0,0 +1,71 @@
+module SlackResources
+  module Generator
+    class ExamplePreparation
+      using StrongHash
+
+      def initialize(examples_dir:, added_examples_dir:)
+        @added_examples_dir = added_examples_dir
+        @examples_dir = examples_dir
+      end
+
+      def execute! # rubocop:disable Metrics/AbcSize
+        single_events = Set.new(raw_examples.map(&:first))
+
+        defined = Set.new
+        event_typed_examples = {}
+        alt_typed_examples = {}
+
+        raw_examples.each do |alt_event_type, event_type, example|
+          example['_raw_example'] = JSON.parse(example.to_json)
+          event_typed_examples.protect_merge!(event_type => example)
+          alt_typed_examples[alt_event_type] = JSON.parse(example.to_json)
+
+          next if defined.add?(event_type)
+
+          single_events.delete(event_type)
+          defined_example = event_typed_examples[event_type]
+
+          Set.new(defined_example.keys + example.keys).each do |k|
+            next if k == '_raw_example'
+
+            defined_value = defined_example[k]
+            additional_value = example[k]
+
+            next if defined_value == additional_value
+
+            if defined_value.is_a?(Hash) && defined_value[TypeDetection::SPECIAL_TYPE] == TypeDetection::MULTIPLE_EXAMPLES
+              (defined_value['items'] << additional_value).sort! { |a, b| a.to_s <=> b.to_s }
+            else
+              defined_example.merge!(
+                k => {
+                  TypeDetection::SPECIAL_TYPE => TypeDetection::MULTIPLE_EXAMPLES,
+                  'target' => k,
+                  'items' => [defined_value, additional_value].sort! { |a, b| a.to_s <=> b.to_s },
+                }
+              )
+            end
+          end
+        end
+
+        alt_typed_examples.select { |k, _| single_events.include?(k) }.protect_merge!(event_typed_examples)
+      end
+
+      private
+
+      def all_files
+        Dir.glob(@added_examples_dir.join('**/*.json')) + Dir.glob(@examples_dir.join('**/*.json'))
+      end
+
+      def raw_examples
+        @raw_examples ||= all_files.map do |f|
+          example = JSON.parse(File.read(f))
+          alt_event_type = File.basename(f, '.json')
+          event_body = example['event'].presence || example
+          event_type = event_body['type']
+
+          [alt_event_type, event_type, event_body.key_ordered]
+        end
+      end
+    end
+  end
+end