json_schema_rails 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7586adefa32b8ade20089a506a91e2e3796e5d4
-  data.tar.gz: 611060b68ac2ddd13368875353817d3657890a3f
+  metadata.gz: 6815f00fc76b0d36cdff144949a31a27bfc1713b
+  data.tar.gz: 3f8ef54b094edc0b14bacb96857ea4ef367da63b
 SHA512:
-  metadata.gz: 855c76fe2a38e2fe3a96cd564d2aca119b84289e4c3a641f072b1c16c5b28ce600f9726791880869e11824f6b232e75caef3f6692d70b9c54d71968d6eea9b64
-  data.tar.gz: f9c1087696a00f0593208e533256addc2c6af06f4d329da07f7523bd814dc4928db0c8ff59ba3275c17ba6a291423ae4c431fd3002ee6a466c5620f6217f00f2
+  metadata.gz: f04c0e5d4c0d1f41af6a49b64f922faf592dbafbe6ee11ade859a23e558ba888e5ae6e7c22ca261ad361b5870a2b0b54a8d02f99e981d62aa9d5580d7ddb41f9
+  data.tar.gz: fb6c4568245c45e24ef30d981e5ec39a5af725995cd38841303d1ef206f888f198de54b740e5afb5d259b0b2a8994f5e25b1d66187dfa846cae0df22405d3e4c

data/.travis.yml

@@ -1,12 +1,13 @@
 language: ruby
+cache: bundler
 rvm:
+  - 1.9.3-p547
   - 2.1.2
+env:
+  - RAILS_VERSION=3.2.18
+  - RAILS_VERSION=4.1.1
 
 install:
   - "travis_retry bundle install"
 
 script: "bundle exec rspec"
-
-env:
-  - RAILS_VERSION=3.2.18
-  - RAILS_VERSION=4.1.1

data/README.md

@@ -97,6 +97,28 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+### Serve schemas in your application
+
+If you want to use your schemas in your client JavaScript, the mountable engine `JsonSchemaRails::Engine` provides a route for serving schemas in you application.
+
+To use it, write the following in your `config/routes.rb`:
+
+```ruby
+Your::Application.routes.draw do
+  mount JsonSchemaRails::Engine => '/schemas'
+end
+```
+
+And you can get your schemas through the path `/schemas` like following:
+
+```
+# Get `app/schemas/posts/create.*` as application/json
+GET /schemas/posts/create.json
+
+# Get `app/schemas/posts/update.*` as text/yaml
+GET /schemas/posts/update.yaml
+```
+
 ### Validate schema files
 
 json_schema_rails provides a rake task `schema:check` to validate your schema files.

data/app/controllers/json_schema_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module JsonSchemaRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/json_schema_rails/schemas_controller.rb

@@ -0,0 +1,13 @@
+module JsonSchemaRails
+  class SchemasController < ApplicationController
+    def get
+      schema = JsonSchemaRails.lookup_schema(params[:schema])
+      raise ActionController::RoutingError.new('No Such Schema') unless schema
+
+      respond_to do |format|
+        format.yaml { render text: schema.to_hash.to_yaml, content_type: 'text/yaml' }
+        format.json { render json: schema }
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+JsonSchemaRails::Engine.routes.draw do
+  get '/:schema(.:format)', to: 'schemas#get', constraints: { schema: /[\/a-zA-Z0-9_-]+/ }
+end

data/lib/json_schema_rails.rb

@@ -2,7 +2,9 @@ require "json_schema_rails/version"
 require "json_schema_rails/errors"
 require "json_schema_rails/loaders"
 require "json_schema_rails/schema_validator"
-require "json_schema_rails/railtie" if defined?(Rails)
+require "json_schema_rails/engine" if defined?(Rails)
+require "json_schema_rails/json_schema/schema"
+require "json_schema_rails/json_schema/parser"
 
 module JsonSchemaRails
   def self.schema_loader

data/lib/json_schema_rails/{railtie.rb → engine.rb}

@@ -1,7 +1,9 @@
 require "json_schema_rails/helpers"
 
 module JsonSchemaRails
-  class Railtie < ::Rails::Railtie
+  class Engine < ::Rails::Engine
+    isolate_namespace JsonSchemaRails
+
     initializer "json_schema_rails.set_schema_loader" do |app|
       if schema_file = Dir[app.root.join('app', 'schema.*')].first
         loader = JsonSchemaRails::Loaders::HyperSchema.new(schema_file)

data/lib/json_schema_rails/json_schema/parser.rb

@@ -0,0 +1,15 @@
+# Patch for JsonSchema::Parser to memorize schema data
+
+require "json_schema/parser"
+
+module JsonSchema
+  class Parser
+    alias_method :_super_parse_data, :parse_data
+
+    def parse_data(data, parent, fragment)
+      schema = _super_parse_data(data, parent, fragment)
+      schema.data = data
+      schema
+    end
+  end
+end

data/lib/json_schema_rails/json_schema/schema.rb

@@ -0,0 +1,13 @@
+# Patch for JsonSchema::Schema to memorize schema data
+
+require "json_schema/schema"
+
+module JsonSchema
+  class Schema
+    attr_accessor :data
+
+    def to_hash
+      data
+    end
+  end
+end

data/lib/json_schema_rails/version.rb

@@ -1,3 +1,3 @@
 module JsonSchemaRails
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/dummy_apps/rails3/config/routes.rb

@@ -1,4 +1,5 @@
 Dummy::Application.routes.draw do
+  mount JsonSchemaRails::Engine => '/schemas'
   resources :posts, only: [:create, :update]
 
   # The priority is based upon order of creation:

data/spec/dummy_apps/rails4/config/routes.rb

@@ -1,4 +1,5 @@
 Rails.application.routes.draw do
+  mount JsonSchemaRails::Engine => '/schemas'
   resources :posts, only: [:create, :update]
 
   # The priority is based upon order of creation: first created -> highest priority.

data/spec/integration/schemas_controller_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe JsonSchemaRails::SchemasController, type: :request do
+  describe "GET #get" do
+    context "with existing schema" do
+      before { get "/schemas/posts/create.#{format}" }
+      let(:expected_schema) { YAML.load_file(Rails.root.join('app', 'schemas', 'posts', 'create.yml').to_s) }
+
+      context "as json" do
+        let(:format) { "json" }
+        it "returns the schema as json" do
+          expect(response).to be_success
+          expect(response.content_type).to eq :json
+          expect(response.body).to eq expected_schema.to_json
+        end
+      end
+
+      context "as yaml" do
+        let(:format) { "yaml" }
+        it "returns the schema as yaml" do
+          expect(response).to be_success
+          expect(response.content_type).to eq :yaml
+          expect(response.body).to eq expected_schema.to_yaml
+        end
+      end
+    end
+
+    context "with nonexisting schema" do
+      subject { -> { get "/schemas/posts/nonexist.json" } }
+
+      it "raises ActionController::RoutingError" do
+        expect(subject).to raise_error ActionController::RoutingError
+      end
+    end
+  end
+end

data/spec/lib/json_schema_rails/json_schema/parser_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'yaml'
+
+RSpec.describe JsonSchema::Parser do
+  describe "#parse!" do
+    let(:schema_content) { YAML.load_file(File.join(TEST_SCHEMAS_DIR, 'posts/create.yml')) }
+    subject(:schema)     { JsonSchema.parse!(schema_content) }
+
+    it "sets original schema data to schema#data" do
+      expect(schema.data).to eq schema_content
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Kota Saito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-21 00:00:00.000000000 Z
+date: 2014-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -176,6 +176,9 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/json_schema_rails/application_controller.rb
+- app/controllers/json_schema_rails/schemas_controller.rb
+- config/routes.rb
 - json_schema_rails.gemspec
 - lib/generators/schema/action/USAGE
 - lib/generators/schema/action/action_generator.rb
@@ -184,13 +187,15 @@ files:
 - lib/generators/schema/controller/controller_generator.rb
 - lib/generators/schema/controller/templates/schema.yml.erb
 - lib/json_schema_rails.rb
+- lib/json_schema_rails/engine.rb
 - lib/json_schema_rails/errors.rb
 - lib/json_schema_rails/helpers.rb
+- lib/json_schema_rails/json_schema/parser.rb
+- lib/json_schema_rails/json_schema/schema.rb
 - lib/json_schema_rails/loaders.rb
 - lib/json_schema_rails/loaders/base.rb
 - lib/json_schema_rails/loaders/directory.rb
 - lib/json_schema_rails/loaders/hyper_schema.rb
-- lib/json_schema_rails/railtie.rb
 - lib/json_schema_rails/schema_validator.rb
 - lib/json_schema_rails/version.rb
 - lib/tasks/schema_tasks.rake
@@ -283,11 +288,13 @@ files:
 - spec/fixtures/schemas/posts/search.json
 - spec/fixtures/schemas/posts/update.yaml
 - spec/fixtures/schemas/syntax_error.json
+- spec/integration/posts_controller_spec.rb
+- spec/integration/schemas_controller_spec.rb
+- spec/lib/json_schema_rails/json_schema/parser_spec.rb
 - spec/lib/json_schema_rails/loaders/directory_spec.rb
 - spec/lib/json_schema_rails/loaders/hyper_schema_spec.rb
 - spec/lib/json_schema_rails/schema_validator_spec.rb
 - spec/lib/json_schema_rails_spec.rb
-- spec/railtie/controllers/posts_controller_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kotas/json_schema_rails
 licenses:
@@ -399,9 +406,11 @@ test_files:
 - spec/fixtures/schemas/posts/search.json
 - spec/fixtures/schemas/posts/update.yaml
 - spec/fixtures/schemas/syntax_error.json
+- spec/integration/posts_controller_spec.rb
+- spec/integration/schemas_controller_spec.rb
+- spec/lib/json_schema_rails/json_schema/parser_spec.rb
 - spec/lib/json_schema_rails/loaders/directory_spec.rb
 - spec/lib/json_schema_rails/loaders/hyper_schema_spec.rb
 - spec/lib/json_schema_rails/schema_validator_spec.rb
 - spec/lib/json_schema_rails_spec.rb
-- spec/railtie/controllers/posts_controller_spec.rb
 - spec/spec_helper.rb