any_channel_json_schemas 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2cda03b13f66c666aecc10835415c525f921692
+  data.tar.gz: f26e14d8bb3a81d117dab6b3494e439dc7421315
+SHA512:
+  metadata.gz: a6df76b9bb33a11a223d6be09ad048e82d01eaf5c009c298a037b4fbbbd8576e9ee944b662fd2c08487886e87261db1cf9dd7144633874ddf92b798bc1bd0cd1
+  data.tar.gz: 7e8e3582b3d27d545f2f0b1b8f5012d12019d745d08918f82298d29f90ad910a2fa9440bb78c7145204ae03511e1b90bd2412ad3614b21b3c22272cc95856a8a

data/README.md

@@ -0,0 +1,46 @@
+# Any Channel JSON Schemas
+
+This is a gem that lets you reference JSON Schema files for the [Zendesk AnyChannel Framework](https://developer.zendesk.com/apps/docs/channels-framework/introduction) in your ruby projects.
+
+### Installation
+
+```
+gem install any_channel_json_schemas
+```
+
+### Usage
+
+The gem exposes a single module with the following methods:
+
+```ruby
+  manifest
+  pull_payload
+  channelback_payload
+  push_parameters
+  event_base
+  event_pull_request
+  event_create_ris
+  event_resources_created_from_external_ids
+```
+
+Each of these returns an absolute path to a schema file. We use these in our own code base with the [json-schema](https://github.com/ruby-json-schema/json-schema) gem both in our test suite and to validate json payloads real-time.
+
+Here's an example of how use the schemas to validate a [manifest](https://developer.zendesk.com/apps/docs/channels-framework/integration_manifest).
+
+```ruby
+  validation_errors = JSON::Validator.fully_validate(AnyChannelJSONSchemas.manifest, manifest)
+
+  if validation_errors.empty?
+    # Manifest conforms to the published schema.
+  else
+    # There are validation erros and we can't proceed.
+  end
+```
+
+### Contributing
+
+Feel free to open an issue or fork the repo and submit a PR.
+
+### Contact
+
+jshay@zendesk.com

data/any_channel_json_schemas.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |gem|
+  gem.authors       = ['JaredShay']
+  gem.email         = ['jshay@zendesk.com']
+  gem.description   = %q{JSON schema files for the Zendesk Channels Framework.}
+  gem.summary       = %q{JSON schema files for the Zendesk Channels Framework.}
+  gem.homepage      = 'https://github.com/zendesk/any_channel_json_schemas/ruby'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- spec/*`.split("\n")
+  gem.name          = 'any_channel_json_schemas'
+  gem.require_paths = ['lib']
+  gem.version       = '0.0.0'
+  gem.license       = 'Apache-2.0'
+end

data/json_schemas

@@ -0,0 +1 @@
+./../json_schemas

data/lib/any_channel_json_schemas.rb

@@ -0,0 +1,16 @@
+# The AnyChannelJSONSchemas module exposes a single method for each json schema file in the json_schemas directory.
+# Each method returns the full file path as a string.
+#
+# eg.
+#   AnyChannelJSONSchemas.manifest
+#   => "<full_file_path_to_gem>/manifest.json"
+module AnyChannelJSONSchemas
+  Dir["#{File.dirname(File.expand_path(__FILE__))}/../json_schemas/*.json"].each do |file_path|
+    basename  = File.basename(file_path, '.json')
+
+    define_method(basename) do
+      file_path
+    end
+    module_function basename.to_sym
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: any_channel_json_schemas
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- JaredShay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-21 00:00:00.000000000 Z
+dependencies: []
+description: JSON schema files for the Zendesk Channels Framework.
+email:
+- jshay@zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- any_channel_json_schemas.gemspec
+- json_schemas
+- lib/any_channel_json_schemas.rb
+homepage: https://github.com/zendesk/any_channel_json_schemas/ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: JSON schema files for the Zendesk Channels Framework.
+test_files: []