slack_resources 0.0.0

data/lib/slack_resources/raw_data/event_api/preset_schemas.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "definitions": {
+    "time_integer": {
+      "type": "number"
+    },
+    "timestamp": {
+      "type": "string"
+    },
+    "reaction_item_type": {
+      "type": "string"
+    },
+    "auto_type": {
+      "type": "string",
+      "description": "The auto_type parameter can be admins for a Workspace Admins group, owners for a Workspace Owners group or null for a custom group.",
+      "enum": [
+        "admins",
+        "owners",
+        null
+      ]
+    },
+    "user_count": {
+      "type": "string"
+    },
+    "emoji_changed_subtype": {
+      "type": "string",
+      "enum": [
+        "add",
+        "remove"
+      ]
+    }
+  }
+}

data/lib/slack_resources/resources/event_api.rb

@@ -0,0 +1,38 @@
+require 'pathname'
+
+module SlackResources
+  module Resources
+    module EventApi
+      BASE_PATH = Pathname(__dir__).join('event_api')
+
+      SUMMARY_PATH = BASE_PATH.join('summary.json')
+      DETAILS_PATH = BASE_PATH.join('details')
+      EXAMPLES_PATH = BASE_PATH.join('examples')
+      SCHEMAS_PATH = BASE_PATH.join('schemas')
+
+      class << self
+        def details(name)
+          File.read(DETAILS_PATH.join("#{name}.json"))
+        end
+
+        def example(name)
+          File.read(EXAMPLES_PATH.join("#{name}.json"))
+        end
+
+        def schemas(name)
+          File.read(SCHEMAS_PATH.join("#{name}.json"))
+        end
+
+        def event_types
+          summary_file.map { |h| h['event'] }
+        end
+
+        private
+
+        def summary_file
+          @summary_file = JSON.parse(File.read(SUMMARY_PATH))
+        end
+      end
+    end
+  end
+end

data/lib/slack_resources/resources/event_api/details/app_mention.json

@@ -0,0 +1,85 @@
+{
+  "url": "https://api.slack.com/events/app_mention",
+  "event": "app_mention",
+  "sub_schemas": {
+    "channel_id": {
+      "type": "string"
+    },
+    "timestamp": {
+      "type": "string"
+    },
+    "user_id": {
+      "type": "string"
+    },
+    "app_mention": {
+      "type": "object",
+      "description": "learn more: https://api.slack.com/events/app_mention",
+      "properties": {
+        "channel": {
+          "$ref": "#/definitions/channel_id"
+        },
+        "event_ts": {
+          "$ref": "#/definitions/timestamp"
+        },
+        "text": {
+          "type": "string"
+        },
+        "ts": {
+          "$ref": "#/definitions/timestamp"
+        },
+        "type": {
+          "const": "app_mention"
+        },
+        "user": {
+          "$ref": "#/definitions/user_id"
+        }
+      },
+      "example": {
+        "channel": "C0LAN2Q65",
+        "event_ts": "1515449522000016",
+        "text": "<@U0LAN0Z89> is it everything a river should be?",
+        "ts": "1515449522.000016",
+        "type": "app_mention",
+        "user": "U061F7AUR"
+      }
+    }
+  },
+  "schema": {
+    "type": "object",
+    "description": "learn more: https://api.slack.com/events/app_mention",
+    "properties": {
+      "channel": {
+        "$ref": "#/definitions/channel_id"
+      },
+      "event_ts": {
+        "$ref": "#/definitions/timestamp"
+      },
+      "text": {
+        "type": "string"
+      },
+      "ts": {
+        "$ref": "#/definitions/timestamp"
+      },
+      "type": {
+        "const": "app_mention"
+      },
+      "user": {
+        "$ref": "#/definitions/user_id"
+      }
+    },
+    "example": {
+      "channel": "C0LAN2Q65",
+      "event_ts": "1515449522000016",
+      "text": "<@U0LAN0Z89> is it everything a river should be?",
+      "ts": "1515449522.000016",
+      "type": "app_mention",
+      "user": "U061F7AUR"
+    }
+  },
+  "compatibility": [
+    "Events API"
+  ],
+  "scopes": [
+
+  ]
+}

data/lib/slack_resources/resources/event_api/details/app_rate_limited.json

@@ -0,0 +1,80 @@
+{
+  "url": "https://api.slack.com/events/app_rate_limited",
+  "event": "app_rate_limited",
+  "sub_schemas": {
+    "api_app_id": {
+      "type": "string"
+    },
+    "time_integer": {
+      "type": "number"
+    },
+    "team_id": {
+      "type": "string"
+    },
+    "token": {
+      "type": "string"
+    },
+    "app_rate_limited": {
+      "type": "object",
+      "description": "learn more: https://api.slack.com/events/app_rate_limited",
+      "properties": {
+        "api_app_id": {
+          "$ref": "#/definitions/api_app_id"
+        },
+        "minute_rate_limited": {
+          "$ref": "#/definitions/time_integer"
+        },
+        "team_id": {
+          "$ref": "#/definitions/team_id"
+        },
+        "token": {
+          "$ref": "#/definitions/token"
+        },
+        "type": {
+          "const": "app_rate_limited"
+        }
+      },
+      "example": {
+        "api_app_id": "A123456",
+        "minute_rate_limited": 1518467820,
+        "team_id": "T123456",
+        "token": "Jhj5dZrVaK7ZwHHjRyZWjbDl",
+        "type": "app_rate_limited"
+      }
+    }
+  },
+  "schema": {
+    "type": "object",
+    "description": "learn more: https://api.slack.com/events/app_rate_limited",
+    "properties": {
+      "api_app_id": {
+        "$ref": "#/definitions/api_app_id"
+      },
+      "minute_rate_limited": {
+        "$ref": "#/definitions/time_integer"
+      },
+      "team_id": {
+        "$ref": "#/definitions/team_id"
+      },
+      "token": {
+        "$ref": "#/definitions/token"
+      },
+      "type": {
+        "const": "app_rate_limited"
+      }
+    },
+    "example": {
+      "api_app_id": "A123456",
+      "minute_rate_limited": 1518467820,
+      "team_id": "T123456",
+      "token": "Jhj5dZrVaK7ZwHHjRyZWjbDl",
+      "type": "app_rate_limited"
+    }
+  },
+  "compatibility": [
+    "Events API"
+  ],
+  "scopes": [
+
+  ]
+}

data/lib/slack_resources/resources/event_api/details/app_uninstalled.json

@@ -0,0 +1,36 @@
+{
+  "url": "https://api.slack.com/events/app_uninstalled",
+  "event": "app_uninstalled",
+  "sub_schemas": {
+    "app_uninstalled": {
+      "type": "object",
+      "description": "learn more: https://api.slack.com/events/app_uninstalled",
+      "properties": {
+        "type": {
+          "const": "app_uninstalled"
+        }
+      },
+      "example": {
+        "type": "app_uninstalled"
+      }
+    }
+  },
+  "schema": {
+    "type": "object",
+    "description": "learn more: https://api.slack.com/events/app_uninstalled",
+    "properties": {
+      "type": {
+        "const": "app_uninstalled"
+      }
+    },
+    "example": {
+      "type": "app_uninstalled"
+    }
+  },
+  "compatibility": [
+    "Events API"
+  ],
+  "scopes": [
+
+  ]
+}

data/lib/slack_resources/resources/event_api/details/channel_archive.json

@@ -0,0 +1,59 @@
+{
+  "url": "https://api.slack.com/events/channel_archive",
+  "event": "channel_archive",
+  "sub_schemas": {
+    "channel_id": {
+      "type": "string"
+    },
+    "user_id": {
+      "type": "string"
+    },
+    "channel_archive": {
+      "type": "object",
+      "description": "learn more: https://api.slack.com/events/channel_archive",
+      "properties": {
+        "channel": {
+          "$ref": "#/definitions/channel_id"
+        },
+        "type": {
+          "const": "channel_archive"
+        },
+        "user": {
+          "$ref": "#/definitions/user_id"
+        }
+      },
+      "example": {
+        "channel": "C024BE91L",
+        "type": "channel_archive",
+        "user": "U024BE7LH"
+      }
+    }
+  },
+  "schema": {
+    "type": "object",
+    "description": "learn more: https://api.slack.com/events/channel_archive",
+    "properties": {
+      "channel": {
+        "$ref": "#/definitions/channel_id"
+      },
+      "type": {
+        "const": "channel_archive"
+      },
+      "user": {
+        "$ref": "#/definitions/user_id"
+      }
+    },
+    "example": {
+      "channel": "C024BE91L",
+      "type": "channel_archive",
+      "user": "U024BE7LH"
+    }
+  },
+  "compatibility": [
+    "RTM",
+    "Events API"
+  ],
+  "scopes": [
+    "channels:read"
+  ]
+}

data/lib/slack_resources/resources/event_api/details/channel_created.json

@@ -0,0 +1,82 @@
+{
+  "url": "https://api.slack.com/events/channel_created",
+  "event": "channel_created",
+  "sub_schemas": {
+    "time_integer": {
+      "type": "number"
+    },
+    "user_id": {
+      "type": "string"
+    },
+    "channel_id": {
+      "type": "string"
+    },
+    "channel_name": {
+      "type": "string"
+    },
+    "channel": {
+      "type": "object",
+      "description": "(defined by script)",
+      "properties": {
+        "created": {
+          "$ref": "#/definitions/time_integer"
+        },
+        "id": {
+          "$ref": "#/definitions/channel_id"
+        },
+        "name": {
+          "$ref": "#/definitions/channel_name"
+        }
+      }
+    },
+    "channel_created": {
+      "type": "object",
+      "description": "learn more: https://api.slack.com/events/channel_created",
+      "properties": {
+        "channel": {
+          "$ref": "#/definitions/channel"
+        },
+        "type": {
+          "const": "channel_created"
+        }
+      },
+      "example": {
+        "channel": {
+          "id": "C024BE91L",
+          "name": "fun",
+          "created": 1360782804,
+          "creator": "U024BE7LH"
+        },
+        "type": "channel_created"
+      }
+    }
+  },
+  "schema": {
+    "type": "object",
+    "description": "learn more: https://api.slack.com/events/channel_created",
+    "properties": {
+      "channel": {
+        "$ref": "#/definitions/channel"
+      },
+      "type": {
+        "const": "channel_created"
+      }
+    },
+    "example": {
+      "channel": {
+        "id": "C024BE91L",
+        "name": "fun",
+        "created": 1360782804,
+        "creator": "U024BE7LH"
+      },
+      "type": "channel_created"
+    }
+  },
+  "compatibility": [
+    "RTM",
+    "Events API"
+  ],
+  "scopes": [
+    "channels:read"
+  ]
+}

data/lib/slack_resources/resources/event_api/details/channel_deleted.json

@@ -0,0 +1,48 @@
+{
+  "url": "https://api.slack.com/events/channel_deleted",
+  "event": "channel_deleted",
+  "sub_schemas": {
+    "channel_id": {
+      "type": "string"
+    },
+    "channel_deleted": {
+      "type": "object",
+      "description": "learn more: https://api.slack.com/events/channel_deleted",
+      "properties": {
+        "channel": {
+          "$ref": "#/definitions/channel_id"
+        },
+        "type": {
+          "const": "channel_deleted"
+        }
+      },
+      "example": {
+        "channel": "C024BE91L",
+        "type": "channel_deleted"
+      }
+    }
+  },
+  "schema": {
+    "type": "object",
+    "description": "learn more: https://api.slack.com/events/channel_deleted",
+    "properties": {
+      "channel": {
+        "$ref": "#/definitions/channel_id"
+      },
+      "type": {
+        "const": "channel_deleted"
+      }
+    },
+    "example": {
+      "channel": "C024BE91L",
+      "type": "channel_deleted"
+    }
+  },
+  "compatibility": [
+    "RTM",
+    "Events API"
+  ],
+  "scopes": [
+    "channels:read"
+  ]
+}