json_schema_spec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2e4dab0d8a9b42b0207788642574435b6638aff
+  data.tar.gz: 8b883259c69b57cfc5ebcb58362d8224813b15ab
+SHA512:
+  metadata.gz: b3eeb7ae1f605095dc0a2606e0530becf9abc70e42f76ba13523511ad11f29af490907efc342f4c1154861581119ca2d419c469f9d171ebf33db5226818af88c
+  data.tar.gz: dd9cab9f394957edd620b5f5ee9f70a4fca5dff6449b6d0e14ece7c989e14c70730f145f389c506eff106f5aaf6f4f84be4c31c0aecb7aaa28c8c44036c8c713

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+json_schema_spec

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0-preview1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013
+
+MIT License
+
+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,122 @@
+##JsonSchemaSpec
+
+Generate fixtures from JSON schemas
+
+###Goals
+
+* Generate webmock requests and responses from JSON schema
+* Easily alter parameters for testing
+* Automatically validate altered parameters against schema
+* Rake helpers for client code to download JSON schema
+
+###Requirements
+
+You serve a `schema.json` file at the root of a URL that describes your resources.
+
+####Example schema.json
+
+    {
+        "user.json": {
+            "get": {
+                "request": {
+                    "title": "GET user.json (request)",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "id":    { "type": "integer" },
+                        "token": { "type": "string" }
+                    }
+                },
+                "response": {
+                    "title": "GET user.json (response)",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "id":     { "type": "integer" },
+                        "avatar": { "type": "string", "optional": true },
+                        "name":   { "type": "string" }
+                    }
+                }
+            }
+        }
+    }
+
+###Install
+
+    gem install json_schema_spec
+
+###Require
+
+In your `spec_helper`:
+
+    require "json_schema_spec"
+
+###Client side project setup
+
+In your `Rakefile`:
+
+    require "json_schema_spec"
+    JsonSchemaSpec::Tasks.new("http://127.0.0.1:3000/schema.json")
+
+####Download schema
+
+Download `schema.json` from the URL specified in your `Rakefile`:
+
+    rake spec:schema
+
+The schema lives at `schema/fixtures/schema.yml`.
+
+###Server side project setup
+
+In Rails, your schema is automatically detected at `/schema.json`.
+
+###Generate test parameters
+
+    request, response = json_schema_params(:user, :get)
+
+The `request` hash looks like this:
+
+    { :id => 72238, :token => "token" }
+
+The `response` hash looks like this:
+
+    { :avatar => "avatar", :name => "name" }
+
+**Integer** values are given a random number.
+
+**String** values are given the same name as the key.
+
+**Optional** parameters are not included.
+
+###Modify test parameters
+
+    request, response = json_schema_params(:user, :get, :request => { :id => 1 })
+
+The `request` hash now looks like this:
+
+    { :id => 1, :token => "token" }
+
+Modified parameters are validated against your schema using [json-schema](https://github.com/hoxworth/json-schema).
+
+###Webmock example
+
+    request, response = json_schema_params(:user, :get)
+
+    request  = params[:request]
+    response = params[:response]
+
+    stub_request(:get, "http://127.0.0.1:3000/user.json").
+      with(:body => request).
+      to_return(:body => response.to_json)
+
+### Contribute
+
+[Create an issue](https://github.com/winton/json_schema_spec/issues/new) to discuss template changes.
+
+Pull requests for template changes and new branches are even better.
+
+### Stay up to date
+
+[Star this project](https://github.com/winton/json_schema_spec#) on Github.
+
+[Follow Winton Welsh](http://twitter.com/intent/user?screen_name=wintonius) on Twitter.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+require File.dirname(__FILE__) + "/lib/json_schema_spec"
+JsonSchemaSpec::Tasks.new("http://127.0.0.1:3000/schema.json")
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/json_schema_spec

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require File.expand_path("../../lib/json_schema_spec", __FILE__)

data/json_schema_spec.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_schema_spec"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Winton Welsh"]
+  spec.email         = ["mail@wintoni.us"]
+  spec.description   = %q{Generate fixtures from JSON schemas.}
+  spec.summary       = %q{Generate fixtures from JSON schemas}
+  spec.homepage      = "https://github.com/winton/json_schema_spec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json-schema"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end

data/lib/json_schema_spec/tasks.rb

@@ -0,0 +1,23 @@
+module JsonSchemaSpec
+  class Tasks
+
+    include Rake::DSL  if defined?(Rake::DSL)
+
+    def initialize(url)
+      return  unless defined?(Rake)
+
+      namespace :spec do
+
+        desc "Download JSON schema to `spec/fixtures`"
+        task :schema do
+          puts "\nDownloading JSON schema to `spec/fixtures`..."
+          
+          path = "#{Rake.original_dir}/spec/fixtures/schema.yml"
+          JsonSchemaSpec.download(path, url)
+          
+          puts "Finished!\n\n"
+        end
+      end
+    end
+  end
+end

data/lib/json_schema_spec/util.rb

@@ -0,0 +1,31 @@
+module JsonSchemaSpec
+  module Util
+    class <<self
+      def deep_dup(hash)
+        duplicate = hash.dup
+        duplicate.each_pair do |k,v|
+          tv = duplicate[k]
+          duplicate[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? deep_dup(tv) : v
+        end
+        duplicate
+      end
+
+      def deep_merge(hash, other_hash)
+        other_hash.each_pair do |k,v|
+          tv = hash[k]
+          hash[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? deep_merge(tv, v) : v
+        end
+        hash
+      end
+      
+      def symbolize_keys(hash)
+        hash.inject({}) do |memo, (key, value)|
+          key       = (key.to_sym rescue key) || key
+          value     = symbolize_keys(value)   if value.is_a?(Hash)
+          memo[key] = value
+          memo
+        end
+      end
+    end
+  end
+end

data/lib/json_schema_spec.rb

@@ -0,0 +1,97 @@
+require "json"
+require "json-schema"
+require "open-uri"
+require "yaml"
+
+$:.unshift File.dirname(__FILE__)
+
+require "json_schema_spec/tasks"
+require "json_schema_spec/util"
+
+module JsonSchemaSpec
+  class <<self
+
+    def download(path, url)
+      FileUtils.mkdir_p(File.dirname(path))
+      
+      File.open(path, 'w') do |f|
+        json = open(url).string
+        yaml = JSON.parse(json).to_yaml
+        f.write(yaml)
+      end
+    end
+  end
+
+  def json_schema(resource, method)
+    schema = pick_json_schema
+    schema = Util.symbolize_keys(schema)
+    schema[:"#{resource}.json"][method]
+  end
+
+  def json_schema_params(resource, method, merge={})
+    schema = json_schema(resource, method)
+    params = json_schema_to_params(schema)
+    params = Util.deep_merge(params, merge)
+
+    unless merge.empty?
+      validate_json_schema(resource, method, params)
+    end
+
+    params = Util.deep_dup(params)
+    [ params[:request], params[:response] ]
+  end
+
+  def json_schema_to_params(schema, prefix=[])
+    return schema  unless schema.is_a?(Hash)
+    
+    schema.inject({}) do |memo, (key, value)|
+      memo[key] = json_schema_value(key, value, prefix.dup)
+      memo.delete(key)  unless memo[key]
+      memo
+    end
+  end
+
+  def json_schema_value(key, value, prefix)
+    if !value.is_a?(Hash) || value[:optional]
+      nil
+    elsif value[:type] == 'string'
+      json_schema_value_prefix(prefix) + key.to_s
+    elsif value[:type] == 'integer'
+      Random.rand(1_000_000)
+    elsif value[:type] == 'object'
+      json_schema_to_params(value[:properties], prefix << key)
+    else
+      json_schema_to_params(value)
+    end
+  end
+
+  def json_schema_value_prefix(prefix)
+    prefix = prefix.join(':')
+    prefix = "#{prefix}:"  unless prefix.empty? 
+    prefix.gsub(/^[^:]*:*/, '')
+  end
+
+  def pick_json_schema
+    if defined?(Rails) && defined?(get)
+      JSON.parse(get("/schema.json"))
+    else
+      path = "#{File.expand_path(".")}/spec/fixtures/schema.yml"
+      YAML.load(File.read(path))
+    end
+  end
+
+  def validate_json_schema(resource, method, params)
+    return  if RUBY_VERSION =~ /^1\.8\./
+
+    schema = json_schema(resource, method)
+
+    [ :request, :response ].each do |direction|
+      validates = JSON::Validator.fully_validate(
+        schema[direction],
+        params[direction],
+        :validate_schema => true
+      )
+      expect(validates).to eq([])
+    end
+  end
+end

data/spec/fixtures/schema.yml

@@ -0,0 +1,30 @@
+---
+user.json:
+  get:
+    request:
+      title: GET user.json (request)
+      type: object
+      additionalProperties: false
+      properties:
+        id:
+          type: integer
+        token:
+          type: string
+    response:
+      title: GET user.json (response)
+      type: object
+      additionalProperties: false
+      properties:
+        id:
+          type: integer
+        avatar:
+          type: string
+          optional: true
+        name:
+          type: string
+        company:
+          type: object
+          additionalProperties: false
+          properties:
+            name:
+              type: string

data/spec/json_schema_spec_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe JsonSchemaSpec do
+  describe "#json_schema_params" do
+
+    it "generates proper params" do
+      request, response = json_schema_params(:user, :get)
+
+      expect(request).to eq(
+        :id    => request[:id],
+        :token => "token"
+      )
+      
+      expect(response).to eq(
+        :id      => response[:id],
+        :name    => "name",
+        :company => {
+          :name  => "company:name"
+        }
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+unless ENV['CI']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+$root = File.expand_path('../../', __FILE__)
+require "#{$root}/lib/json_schema_spec"
+
+RSpec.configure do |c|
+  c.include JsonSchemaSpec
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: json_schema_spec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Winton Welsh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate fixtures from JSON schemas.
+email:
+- mail@wintoni.us
+executables:
+- json_schema_spec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/json_schema_spec
+- json_schema_spec.gemspec
+- lib/json_schema_spec.rb
+- lib/json_schema_spec/tasks.rb
+- lib/json_schema_spec/util.rb
+- spec/fixtures/schema.yml
+- spec/json_schema_spec_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/winton/json_schema_spec
+licenses:
+- MIT
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Generate fixtures from JSON schemas
+test_files:
+- spec/fixtures/schema.yml
+- spec/json_schema_spec_spec.rb
+- spec/spec_helper.rb