jast 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b89c4b7e50ecf55dd5d7fddf6e12973625343e05
+  data.tar.gz: eeec861ef26db9ddee01e1ec4bb0acc5214fd40a
+SHA512:
+  metadata.gz: 693673073b03cd26747fe11ea24570ac7cc70fcec350e773004ee394188d3d72df6144b7a79ba30357303dcc66a217ef978a9309cf6d10b40e06b18ea9db85f1
+  data.tar.gz: a550e73cd46c914c4167f6c580cbdec83f5917b82bd66517afd06cd1a51b09aedf4f57b449b7f5d89db6abb3bc831ed65f9ea7c19416f8d49293b478a6b78927

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jast.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Daniel Schweighoefer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Jast
+
+Json-Api Schema Tools support you to specify [JSON-API](http://jsonapi.org/ "jsonapi webside") compliant APIs with [JSON-Schema](http://json-schema.org/ "json-schema webside").
+
+It is initially written with the aim to support your rspec test-setup in an rails application but didn't have those as dependencies so it can be used in any other context, too.
+
+## Usage
+
+jast expects that the files will be stored in the spec/support/api/v1/schemas/ directory.
+
+To render schemas do:
+
+    jast schemas name attr1:type attr2:type
+
+You can set required attributes by adding :required to the call, e.g.:
+
+    jast schemas name attr1:type attr2:type attr3:type:required
+
+Please consult the JSON-Schema documentation for a [list of attribute types](http://json-schema.org/latest/json-schema-core.html#anchor8 "jsonapi docs"), is it also possible to have an attributes of type object containing a JSON-object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jast'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jast
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/POSpulse/jast. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jast"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/jast

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "jast"
+
+class JastCLI < Thor
+  class_option :path, desc: "set the base path", type: :string, default: nil, aliases: "-p"
+  class_option :api_version, desc: "set the api version", type: :string, default: 1, aliases: "-a"
+
+  desc "schemas name property:type[:required] ...", "render all schema files"
+  def schemas( name, *schemaspecs)
+    properties = {}
+    required = []
+    schemaspecs.each do |opt|
+      props = opt.split(":")
+      properties[props[0].to_sym] = props[1]
+      if props.size > 2
+        required << props[0]
+      end
+    end
+    generator = Jast::Generator.new api_version: options[:api_version], base_path: options[:path]
+    generator.render_schemas name, properties, required
+  end
+
+end
+
+JastCLI.start

data/jast.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jast"
+  spec.version       = Jast::VERSION
+  spec.authors       = ["Daniel Schweighoefer"]
+  spec.email         = ["daniel.schweighoefer@pospulse.com"]
+  spec.required_ruby_version = ">= 2.2.3"
+
+  spec.summary       = "JSON Api Schema Tools"
+  spec.description   = "A Collection of Tools for building JSON-Api comliant Api definitions ready to be tested with JSON-schema"
+  spec.homepage      = "https://github.com/POSpulse/jast"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+end

data/lib/jast.rb

@@ -0,0 +1,18 @@
+require "jast/version"
+require "jast/schema_renderer"
+
+module Jast
+  class Generator
+    attr_accessor :api_version, :base_path, :definitions_path
+
+    def initialize api_version: 1, base_path: nil
+      @api_version = api_version
+      @base_path = base_path.nil? ? "spec/support/api/v#{api_version}/schemas/" : base_path
+    end
+
+    def render_schemas name, properties, required
+      schema_renderer = Jast::SchemaRenderer.new name, base_path
+      schema_renderer.render_resource properties, required
+    end
+  end
+end

data/lib/jast/schema_renderer.rb

@@ -0,0 +1,42 @@
+require "erb"
+
+module Jast
+  class SchemaRenderer
+    def initialize name, path
+      @name = name
+      @path = path
+    end
+
+    def build_json file, properties = {}, required = []
+      filename = "#{file}.json.erb"
+      template_path = "#{File.expand_path(File.dirname(__FILE__))}/templates/#{filename}"
+      ERB.new(File.read(template_path), nil, ">").result(binding)
+    end
+
+    def render_definition properties, required
+      render_file :definition, {path: "#{@path}definitions/", properties: properties, required: required, filename: @name}
+    end
+
+    def render_file file, fileopts = {}
+      content = build_json(file, fileopts[:properties], fileopts[:required])
+      path = fileopts[:path].nil? ? @path : fileopts[:path]
+      FileUtils.mkdir_p(path)
+      filename = fileopts[:filename].nil? ? "#{@name}_#{file}.json" : fileopts[:filename]
+      IO.write("#{path}#{filename}", content)
+    end
+
+    def render_list_response
+      render_file :list_response
+    end
+
+    def render_resource properties, required
+      render_definition(properties, required)
+      render_list_response
+      render_response
+    end
+
+    def render_response
+      render_file :response
+    end
+  end
+end

data/lib/jast/templates/definition.json.erb

@@ -0,0 +1,15 @@
+{
+    "definitions": {
+        "<%= @name%>_attributes": {
+            "attributes": {
+                "type": "object",
+                "required": <%= required %>,
+                "properties": {
+                    <% properties.each_with_index do |(key, value), i| %>
+                        "<%= key.to_s %>": { "type": "<%= value.to_s %>" }<%= i < properties.size - 1 ? "," : "" %>
+                    <% end %>
+                }
+            }
+        }
+    }
+}

data/lib/jast/templates/list_response.json.erb

@@ -0,0 +1,19 @@
+{
+  "type": "object",
+  "required": [ "data" ],
+  "properties": {
+    "data": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [ "attributes" ],
+        "properties": {
+          "id": { "type": "string" },
+          "type": { "type": "string" },
+          "attributes": { "$ref": "definitions/<%= @name%>.json#/definitions/<%= @name%>_attributes" },
+          "relationships": { "type": "object"}
+        }
+      }
+    }
+  }
+}

data/lib/jast/templates/response.json.erb

@@ -0,0 +1,16 @@
+{
+  "type": "object",
+  "required": [ "data" ],
+  "properties": {
+    "data": {
+      "type": "object",
+      "required": [ "attributes" ],
+      "properties": {
+        "id": { "type": "string" },
+        "type": { "type": "string" },
+        "attributes": { "$ref": "definitions/<%= @name%>.json#/definitions/<%= @name%>_attributes" },
+        "relationships": { "type": "object"}
+      }
+    }
+  }
+}

data/lib/jast/version.rb

@@ -0,0 +1,3 @@
+module Jast
+  VERSION = "0.1.4"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: jast
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Daniel Schweighoefer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: A Collection of Tools for building JSON-Api comliant Api definitions
+  ready to be tested with JSON-schema
+email:
+- daniel.schweighoefer@pospulse.com
+executables:
+- jast
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/jast
+- jast.gemspec
+- lib/jast.rb
+- lib/jast/schema_renderer.rb
+- lib/jast/templates/definition.json.erb
+- lib/jast/templates/list_response.json.erb
+- lib/jast/templates/response.json.erb
+- lib/jast/version.rb
+homepage: https://github.com/POSpulse/jast
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: JSON Api Schema Tools
+test_files: []