json_schema_rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6815f00fc76b0d36cdff144949a31a27bfc1713b
-  data.tar.gz: 3f8ef54b094edc0b14bacb96857ea4ef367da63b
+  metadata.gz: 30365db9f1e64bb272a6e68e5b82db4ffd5e3e75
+  data.tar.gz: 3fb83828166f3f10e5420d2e6b505167b175183d
 SHA512:
-  metadata.gz: f04c0e5d4c0d1f41af6a49b64f922faf592dbafbe6ee11ade859a23e558ba888e5ae6e7c22ca261ad361b5870a2b0b54a8d02f99e981d62aa9d5580d7ddb41f9
-  data.tar.gz: fb6c4568245c45e24ef30d981e5ec39a5af725995cd38841303d1ef206f888f198de54b740e5afb5d259b0b2a8994f5e25b1d66187dfa846cae0df22405d3e4c
+  metadata.gz: 8cddf1f935f4856c56cc4e3aad13cb05456e2be237022d033864969f498bb5428a550453c785501b063b7c64daa16005edffe19e26d4b5decd7026201311d41e
+  data.tar.gz: 09a91ab2023b4bf7ab367e5ed2efd6354089062985e1651cc40d84ee5723b18dd50d53241a1e43438ff257c3a3d2249e1ead879f0f8533aae3ad21de4a1ec879

data/README.md

@@ -1,6 +1,6 @@
 # json_schema_rails
 
-[![Build Status](https://travis-ci.org/kotas/json_schema_rails.svg?branch=master)](https://travis-ci.org/kotas/json_schema_rails) [![Code Climate](https://codeclimate.com/github/kotas/json_schema_rails.png)](https://codeclimate.com/github/kotas/json_schema_rails)
+[![Build Status](https://travis-ci.org/kotas/json_schema_rails.svg?branch=master)](https://travis-ci.org/kotas/json_schema_rails) [![Code Climate](https://codeclimate.com/github/kotas/json_schema_rails.png)](https://codeclimate.com/github/kotas/json_schema_rails) [![Gem Version](https://badge.fury.io/rb/json_schema_rails.svg)](http://badge.fury.io/rb/json_schema_rails)
 
 [JSON Schema v4](http://json-schema.org/) validator and generator for Rails 3+
 
@@ -114,11 +114,32 @@ 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 /schemas/posts/create
 
 # Get `app/schemas/posts/update.*` as text/yaml
 GET /schemas/posts/update.yaml
 ```
 
+To get a path to a specific schema's endpoint, call `json_schema_rails.schema_path(schema_name)` or `json_schema_rails.schema_url(schema_name)`.
+
+```ruby
+# In your controller or view
+json_schema_rails.schema_path("posts/create")  # "/schemas/posts/create"
+json_schema_rails.schema_url("posts/update")   # "http://example.com/schemas/posts/create"
+```
+
+You can change `json_schema_rails` part of above by specifying `as` parameter when mounting the route:
+
+```ruby
+Your::Application.routes.draw do
+  mount JsonSchemaRails::Engine => '/schemas', as: 'json_schema'
+end
+
+# And you can call the helpers as
+json_schema.schema_path("posts/create")
+json_schema.schema_url("posts/update")
+```
+
 ### Validate schema files
 
 json_schema_rails provides a rake task `schema:check` to validate your schema files.

data/app/controllers/json_schema_rails/schemas_controller.rb

@@ -1,7 +1,7 @@
 module JsonSchemaRails
   class SchemasController < ApplicationController
-    def get
-      schema = JsonSchemaRails.lookup_schema(params[:schema])
+    def show
+      schema = JsonSchemaRails.lookup_schema(params[:id])
       raise ActionController::RoutingError.new('No Such Schema') unless schema
 
       respond_to do |format|

data/config/routes.rb

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

data/lib/json_schema_rails/version.rb

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

data/spec/dummy_apps/rails3/app/controllers/helpers_controller.rb

@@ -0,0 +1,11 @@
+class HelpersController < ApplicationController
+  def show_schema_path
+    path = json_schema_rails.schema_path(params[:schema_name])
+    render text: path
+  end
+
+  def show_schema_url
+    url = json_schema_rails.schema_url(params[:schema_name])
+    render text: url
+  end
+end

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

@@ -2,6 +2,9 @@ Dummy::Application.routes.draw do
   mount JsonSchemaRails::Engine => '/schemas'
   resources :posts, only: [:create, :update]
 
+  get 'helpers/schema_path', to: 'helpers#show_schema_path'
+  get 'helpers/schema_url',  to: 'helpers#show_schema_url'
+
   # The priority is based upon order of creation:
   # first created -> highest priority.
 

data/spec/dummy_apps/rails4/app/controllers/helpers_controller.rb

@@ -0,0 +1,11 @@
+class HelpersController < ApplicationController
+  def show_schema_path
+    path = json_schema_rails.schema_path(params[:schema_name])
+    render text: path
+  end
+
+  def show_schema_url
+    url = json_schema_rails.schema_url(params[:schema_name])
+    render text: url
+  end
+end

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

@@ -2,6 +2,9 @@ Rails.application.routes.draw do
   mount JsonSchemaRails::Engine => '/schemas'
   resources :posts, only: [:create, :update]
 
+  get 'helpers/schema_path', to: 'helpers#show_schema_path'
+  get 'helpers/schema_url',  to: 'helpers#show_schema_url'
+
   # The priority is based upon order of creation: first created -> highest priority.
   # See how all your routes lay out with "rake routes".
 

data/spec/integration/helpers_controller_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe HelpersController, type: :controller do
+  describe "schema_path helper" do
+    it "returns a path to schema endpoint" do
+      get "show_schema_path", { "schema_name" => "posts/create" }
+      expect(response.body).to eq "/schemas/posts/create"
+    end
+  end
+
+  describe "schema_url helper" do
+    it "returns a URL to schema endpoint" do
+      get "show_schema_url", { "schema_name" => "posts/create" }
+      expect(response.body).to eq "#{request.base_url}/schemas/posts/create"
+    end
+  end
+end

data/spec/integration/schemas_controller_spec.rb

@@ -3,11 +3,20 @@ 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}" }
+      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" }
+        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 "without format" do
+        let(:format) { "" }
         it "returns the schema as json" do
           expect(response).to be_success
           expect(response.content_type).to eq :json
@@ -16,7 +25,7 @@ RSpec.describe JsonSchemaRails::SchemasController, type: :request do
       end
 
       context "as yaml" do
-        let(:format) { "yaml" }
+        let(:format) { ".yaml" }
         it "returns the schema as yaml" do
           expect(response).to be_success
           expect(response.content_type).to eq :yaml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kota Saito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -209,6 +209,7 @@ files:
 - spec/dummy_apps/rails3/app/assets/javascripts/application.js
 - spec/dummy_apps/rails3/app/assets/stylesheets/application.css
 - spec/dummy_apps/rails3/app/controllers/application_controller.rb
+- spec/dummy_apps/rails3/app/controllers/helpers_controller.rb
 - spec/dummy_apps/rails3/app/controllers/posts_controller.rb
 - spec/dummy_apps/rails3/app/helpers/application_helper.rb
 - spec/dummy_apps/rails3/app/schemas/posts/create.yml
@@ -248,6 +249,7 @@ files:
 - spec/dummy_apps/rails4/app/assets/stylesheets/posts.css
 - spec/dummy_apps/rails4/app/controllers/application_controller.rb
 - spec/dummy_apps/rails4/app/controllers/concerns/.keep
+- spec/dummy_apps/rails4/app/controllers/helpers_controller.rb
 - spec/dummy_apps/rails4/app/controllers/posts_controller.rb
 - spec/dummy_apps/rails4/app/helpers/application_helper.rb
 - spec/dummy_apps/rails4/app/mailers/.keep
@@ -288,6 +290,7 @@ files:
 - spec/fixtures/schemas/posts/search.json
 - spec/fixtures/schemas/posts/update.yaml
 - spec/fixtures/schemas/syntax_error.json
+- spec/integration/helpers_controller_spec.rb
 - spec/integration/posts_controller_spec.rb
 - spec/integration/schemas_controller_spec.rb
 - spec/lib/json_schema_rails/json_schema/parser_spec.rb
@@ -327,6 +330,7 @@ test_files:
 - spec/dummy_apps/rails3/app/assets/javascripts/application.js
 - spec/dummy_apps/rails3/app/assets/stylesheets/application.css
 - spec/dummy_apps/rails3/app/controllers/application_controller.rb
+- spec/dummy_apps/rails3/app/controllers/helpers_controller.rb
 - spec/dummy_apps/rails3/app/controllers/posts_controller.rb
 - spec/dummy_apps/rails3/app/helpers/application_helper.rb
 - spec/dummy_apps/rails3/app/schemas/posts/create.yml
@@ -366,6 +370,7 @@ test_files:
 - spec/dummy_apps/rails4/app/assets/stylesheets/posts.css
 - spec/dummy_apps/rails4/app/controllers/application_controller.rb
 - spec/dummy_apps/rails4/app/controllers/concerns/.keep
+- spec/dummy_apps/rails4/app/controllers/helpers_controller.rb
 - spec/dummy_apps/rails4/app/controllers/posts_controller.rb
 - spec/dummy_apps/rails4/app/helpers/application_helper.rb
 - spec/dummy_apps/rails4/app/mailers/.keep
@@ -406,6 +411,7 @@ test_files:
 - spec/fixtures/schemas/posts/search.json
 - spec/fixtures/schemas/posts/update.yaml
 - spec/fixtures/schemas/syntax_error.json
+- spec/integration/helpers_controller_spec.rb
 - spec/integration/posts_controller_spec.rb
 - spec/integration/schemas_controller_spec.rb
 - spec/lib/json_schema_rails/json_schema/parser_spec.rb