lurker 0.6.2 → 0.6.3

data/lib/lurker/service.rb

@@ -15,9 +15,9 @@ class Lurker::Service
     @service_dir = File.expand_path(service_dir)
     @service_filename = service_name
     @schema = if persisted? && (schema = YAML.load_file(service_path)).is_a?(Hash)
-      Lurker::Schema.new(schema)
+      Lurker::Json::Schema.new(schema)
     else
-      Lurker::Schema.new(
+      Lurker::Json::Schema.new(
         'name'        => service_filename,
         'basePath'    => '',
         'description' => '',
@@ -39,8 +39,8 @@ class Lurker::Service
   end
 
   def persist!
-    schema.write_to(service_path) unless File.exist?(service_path)
-    @opened_endpoints.each { |e| e.persist! if e.respond_to? :persist! }
+    Lurker::Json::Writter.write(schema, service_path) unless File.exist?(service_path)
+    @opened_endpoints.each { |ep| ep.persist! if ep.respond_to?(:persist!) }
   end
 
   def verify!(verb, path, request_params,

data/lib/lurker/version.rb

@@ -1,3 +1,3 @@
 module Lurker
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

data/lib/lurker.rb

@@ -48,12 +48,6 @@ module Lurker
 end
 
 require 'lurker/jaml_descriptor'
-require 'lurker/schema'
-require 'lurker/json_schema_hash'
-require 'lurker/schema_modifier'
-require 'lurker/schema_modifier/hash'
-require 'lurker/schema_modifier/array'
-require 'lurker/schema_modifier/atom'
 require 'lurker/ref_object'
 require 'lurker/erb_schema_context'
 require 'lurker/service'
@@ -61,8 +55,6 @@ require 'lurker/validator'
 require 'lurker/validation_error'
 require 'lurker/utils'
 require 'lurker/endpoint'
-require 'lurker/endpoint/response_codes'
-require 'lurker/endpoint/http_parameters'
 require 'lurker/rendering_controller'
 require 'lurker/form_builder'
 require 'lurker/presenters/json_presenter'
@@ -71,6 +63,25 @@ require 'lurker/presenters/service_presenter'
 require 'lurker/presenters/endpoint_presenter'
 require 'lurker/presenters/schema_presenter'
 require 'lurker/presenters/response_code_presenter'
+require 'lurker/json/reader'
+require 'lurker/json/writter'
+require 'lurker/json/orderer'
+require 'lurker/json/parser'
+require 'lurker/json/parser/expertise'
+require 'lurker/json/parser/plain_strategy'
+require 'lurker/json/parser/typed_strategy'
+require 'lurker/json/concerns/validatable'
+require 'lurker/json/schema'
+require 'lurker/json/schema/object'
+require 'lurker/json/schema/list'
+require 'lurker/json/schema/attribute'
+require 'lurker/json/schema/tuple'
+require 'lurker/json/schema/tuple/all_of'
+require 'lurker/json/schema/tuple/any_of'
+require 'lurker/json/schema/tuple/one_of'
+require 'lurker/json/schema/extensions'
+require 'lurker/json/schema/response_codes'
+require 'lurker/json/schema/reference'
 require 'lurker/spy'
 require 'lurker/request'
 require 'lurker/response'

data/spec/lurker/json/list_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Lurker::Json::List do
+  let(:klass) { described_class }
+
+  describe '#merge!' do
+    context 'when list is an array of attributes' do
+      let(:list) { klass.new([1, 2, 3]) }
+
+      context 'when merge an array' do
+        let(:expected) do
+          {
+            'type' => 'array',
+            'items' => {
+              'description' => '',
+              'type' => 'integer',
+              'example' => 1
+            }
+          }
+        end
+        before { list.merge!([42]) }
+
+        it { expect(list.to_hash).to eq expected }
+      end
+
+      context 'when merge a fixnum' do
+        let(:expected) do
+          {
+            'type' => 'array',
+            'items' => {
+              'description' => '',
+              'type' => 'integer',
+              'example' => 1
+            }
+          }
+        end
+        before { list.merge!(999) }
+
+        it { expect(list.to_hash).to eq expected }
+      end
+
+      context 'when merge a string' do
+        let(:expected) do
+          {
+            'type' => 'array',
+            'items' => {
+              'anyOf' => [
+                {
+                  'description' => '',
+                  'type' => 'integer',
+                  'example' => 1
+                },
+                {
+                  'description' => '',
+                  'type' => 'string',
+                  'example' => 'razum2um'
+                }
+              ]
+            }
+          }
+        end
+        before { list.merge!('razum2um') }
+
+        it { expect(list.to_hash).to eq expected }
+      end
+
+      context 'when merge a hash' do
+        let(:expected) do
+          {
+            'type' => 'array',
+            'items' => {
+              'anyOf' => [
+                {
+                  'description' => '',
+                  'type' => 'integer',
+                  'example' => 1
+                },
+                {
+                  'description' => '',
+                  'type' => 'object',
+                  'additionalProperties' => false,
+                  'required' => [],
+                  'properties' => {
+                    'name' => {
+                      'description' => '',
+                      'type' => 'string',
+                      'example' => 'razum2um'
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        end
+        before { list.merge!('name' => 'razum2um') }
+
+        it { expect(list.to_hash).to eq expected }
+      end
+    end
+  end
+end

data/spec/lurker/json/schema_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe Lurker::Json::Schema do
+  let(:klass) { described_class }
+
+  describe 'Merge request/response parameters' do
+    let(:schema) { klass.new('responseParameters' => {}) }
+
+    context 'when request parameters is an object' do
+      let(:parameters) do
+        {
+          'id' => 1,
+          'name' => 'Bob',
+          'repos' => [{'id' => 1, 'name' => 'gem-gon'}]
+        }
+      end
+      let(:expected) do
+        {
+          'description' => '',
+          'type' => 'object',
+          'additionalProperties' => false,
+          'required' => [],
+          'properties' => {
+            'id' => {
+              'description' => '',
+              'type' => 'integer',
+              'example' => 1
+            },
+            'name' => {
+              'description' => '',
+              'type' => 'string',
+              'example' => 'Bob'
+            },
+            'repos' => {
+              'type' => 'array',
+              'items' => {
+                'description' => '',
+                'type' => 'object',
+                'additionalProperties' => false,
+                'required' => [],
+                'properties' => {
+                  'id' => {
+                    'description' => '',
+                    'type' => 'integer',
+                    'example' => 1
+                  },
+                  'name' => {
+                    'description' => '',
+                    'type' => 'string',
+                    'example' => 'gem-gon'
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+      before { schema['responseParameters'].merge! parameters }
+
+      it { expect(schema['responseParameters'].to_hash).to eq expected }
+    end
+
+    context 'when request parameters is an array of objects' do
+      let(:parameters) { [{'id' => 1, 'name' => 'Bob'}, {'id' => 2, 'name' => 'Tom'}] }
+      let(:expected) do
+        {
+          'type' => 'array',
+          'items' => {
+            'description' => '',
+            'type' => 'object',
+            'additionalProperties' => false,
+            'required' => [],
+            'properties' => {
+              'id' => {
+                'description' => '',
+                'type' => 'integer',
+                'example' => 1
+              },
+              'name' => {
+                'description' => '',
+                'type' => 'string',
+                'example' => 'Bob'
+              }
+            }
+          }
+        }
+      end
+      before { schema['responseParameters'].merge! parameters }
+
+      it { expect(schema['responseParameters'].to_hash).to eq expected }
+    end
+
+    context 'when request parameters is an object with array of strings' do
+      let(:parameters) { {'errors' => {'name' => ['Couldn`t be blank']}} }
+      let(:expected) do
+        {
+          'description' => '',
+          'type' => 'object',
+          'additionalProperties' => false,
+          'required' => [],
+          'properties' => {
+            'errors' => {
+              'description' => '',
+              'type' => 'object',
+              'additionalProperties' => false,
+              'required' => [],
+              'properties' => {
+                'name' => {
+                  'type' => 'array',
+                  'items' => {
+                    'description' => '',
+                    'type' => 'string',
+                    'example' => 'Couldn`t be blank'
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+      before { schema['responseParameters'].merge! parameters }
+
+      it { expect(schema['responseParameters'].to_hash).to eq expected }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -12,6 +12,8 @@ SimpleCov.start do
   end
 end
 
+Dir[File.expand_path '../support/**/*.rb', __FILE__].each { |file| require file }
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/support/matchers/json_attribute.rb

@@ -0,0 +1,27 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :be_a_json_attribute do
+  match do |attribute|
+    expect(attribute).to have_key 'type'
+
+    expect(attribute['type']).to eq @type if @type.present?
+    expect(attribute['example']).to eq @example if @example.present?
+
+    true
+  end
+
+  chain :with_type do |type|
+    @type = type
+  end
+
+  chain :with_example do |example|
+    @example = example
+  end
+
+  failure_message_for_should do |attribute|
+    "expected that #{attribute.try(:to_hash) || attribute} to be a json attribute".tap do |message|
+      message << " with type '#{@type}'" if @type.present?
+      message << " with example '#{@example}'"  if @example.present?
+    end
+  end
+end

data/spec/support/matchers/json_object.rb

@@ -0,0 +1,33 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :be_a_json_object do
+  @properties = []
+
+  match do |object|
+    expect(object).to have_key 'type'
+    expect(object).to have_key 'properties'
+    expect(object['type']).to eq 'object'
+
+    if @properties.present?
+      @properties.each do |property|
+        expect(object['properties']).to have_key property
+      end
+    end
+
+    true
+  end
+
+  chain :with_properties do |*properties|
+    @properties |= properties
+  end
+
+  chain :with_property do |property|
+    @properties << property
+  end
+
+  failure_message_for_should do |object|
+    "expected that #{object.try(:to_hash) || object} to be a json object".tap do |message|
+      message << " with properties #{@properties}" if @properties.present?
+    end
+  end
+end

data/templates/generate_stuff.rb

@@ -59,6 +59,12 @@ route <<-ROUTE
         resources :repos
       end
     end
+
+    namespace :v3 do
+      resources :users do
+        resources :repos
+      end
+    end
   end
 
   get '/robots.txt', to: proc { |env| [
@@ -90,7 +96,8 @@ file 'config/initializers/serializer.rb', force: true do
         else
           options[:methods] = attributes.keys.sort + methods
         end
-        options[:only] = []
+        options[:methods] -= Array.wrap(options[:except])
+        options[:only] = options[:except] = []
 
         super(options)
       end
@@ -259,16 +266,18 @@ file 'app/controllers/api/v1/repos_controller.rb', 'Api::V1::ReposController', f
   CODE
 end
 
-file 'app/controllers/api/v2/users_controller.rb', 'Api::V2::UsersController', force: true do
-  <<-CODE
-    class Api::V2::UsersController < Api::V1::UsersController;end
-  CODE
-end
+[2, 3].each do |version|
+  file "app/controllers/api/v#{version}/users_controller.rb", "Api::V#{version}::UsersController", force: true do
+    <<-CODE
+      class Api::V#{version}::UsersController < Api::V1::UsersController; end
+    CODE
+  end
 
-file 'app/controllers/api/v2/repos_controller.rb', 'Api::V2::ReposController', force: true do
-  <<-CODE
-    class Api::V2::ReposController < Api::V1::ReposController; end
-  CODE
+  file "app/controllers/api/v#{version}/repos_controller.rb", "Api::V#{version}::ReposController", force: true do
+    <<-CODE
+      class Api::V#{version}::ReposController < Api::V1::ReposController; end
+    CODE
+  end
 end
 
 # FIXME: uninitialized constant User (NameError) in last creation line

data.tar.gz.sig

@@ -1,4 +1,2 @@
-+&���B���\~��ƕ5M���ܥ$�,5]s�v�MDm��7D�(T��
-zd���D�(�Or
-2��K�9�����#�FV�D��
-\�+^�k"�n�
+����=��@r]0Z�P+-Y:�s�~UR�6���.dM�Ւ��ȼ�A������
+��ƙ|��

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lurker
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Vlad Bokov
@@ -30,7 +30,7 @@ cert_chain:
   vzKbYclpJ7gENr/xiTjGqA/Md3zJMzmsFrzUXt4RVmo5SaCyZjC6gFfhSr+PODc7
   ZaSbckvH/+m4boAsg0JkGGFcS3j5fgNmdwgA1A==
   -----END CERTIFICATE-----
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -461,6 +461,7 @@ files:
 - features/atom_persistent_within_the_same_type.feature
 - features/controller_nested_schema_scaffolding.feature
 - features/controller_schema_scaffolding.feature
+- features/dereferencing_through_inlining.feature
 - features/html_generation.feature
 - features/minitest.feature
 - features/multidomain_support.feature
@@ -472,6 +473,7 @@ files:
 - features/schema_updating_within_test_suite.feature
 - features/step_definitions/additional_cli_steps.rb
 - features/support/env.rb
+- features/support/files_helper.rb
 - features/test_endpoint.feature
 - gemfiles/Gemfile32.ci
 - gemfiles/Gemfile40.ci
@@ -481,12 +483,29 @@ files:
 - lib/lurker/capistrano.rb
 - lib/lurker/cli.rb
 - lib/lurker/endpoint.rb
-- lib/lurker/endpoint/http_parameters.rb
-- lib/lurker/endpoint/response_codes.rb
 - lib/lurker/engine.rb
 - lib/lurker/erb_schema_context.rb
 - lib/lurker/form_builder.rb
 - lib/lurker/jaml_descriptor.rb
+- lib/lurker/json/concerns/validatable.rb
+- lib/lurker/json/orderer.rb
+- lib/lurker/json/parser.rb
+- lib/lurker/json/parser/expertise.rb
+- lib/lurker/json/parser/plain_strategy.rb
+- lib/lurker/json/parser/typed_strategy.rb
+- lib/lurker/json/reader.rb
+- lib/lurker/json/schema.rb
+- lib/lurker/json/schema/attribute.rb
+- lib/lurker/json/schema/extensions.rb
+- lib/lurker/json/schema/list.rb
+- lib/lurker/json/schema/object.rb
+- lib/lurker/json/schema/reference.rb
+- lib/lurker/json/schema/response_codes.rb
+- lib/lurker/json/schema/tuple.rb
+- lib/lurker/json/schema/tuple/all_of.rb
+- lib/lurker/json/schema/tuple/any_of.rb
+- lib/lurker/json/schema/tuple/one_of.rb
+- lib/lurker/json/writter.rb
 - lib/lurker/json_schema_hash.rb
 - lib/lurker/presenters/base_presenter.rb
 - lib/lurker/presenters/endpoint_presenter.rb
@@ -499,11 +518,6 @@ files:
 - lib/lurker/request.rb
 - lib/lurker/response.rb
 - lib/lurker/sandbox.rb
-- lib/lurker/schema.rb
-- lib/lurker/schema_modifier.rb
-- lib/lurker/schema_modifier/array.rb
-- lib/lurker/schema_modifier/atom.rb
-- lib/lurker/schema_modifier/hash.rb
 - lib/lurker/server.rb
 - lib/lurker/service.rb
 - lib/lurker/spec_helper.rb
@@ -560,8 +574,12 @@ files:
 - lib/lurker/version.rb
 - lurker.gemspec
 - spec/lurker/endpoint_spec.rb
+- spec/lurker/json/list_spec.rb
+- spec/lurker/json/schema_spec.rb
 - spec/lurker/yaml_spec.rb
 - spec/spec_helper.rb
+- spec/support/matchers/json_attribute.rb
+- spec/support/matchers/json_object.rb
 - tasks/build.rake
 - tasks/deploy.rake
 - tasks/generate.rake
@@ -597,6 +615,7 @@ test_files:
 - features/atom_persistent_within_the_same_type.feature
 - features/controller_nested_schema_scaffolding.feature
 - features/controller_schema_scaffolding.feature
+- features/dereferencing_through_inlining.feature
 - features/html_generation.feature
 - features/minitest.feature
 - features/multidomain_support.feature
@@ -608,8 +627,13 @@ test_files:
 - features/schema_updating_within_test_suite.feature
 - features/step_definitions/additional_cli_steps.rb
 - features/support/env.rb
+- features/support/files_helper.rb
 - features/test_endpoint.feature
 - spec/lurker/endpoint_spec.rb
+- spec/lurker/json/list_spec.rb
+- spec/lurker/json/schema_spec.rb
 - spec/lurker/yaml_spec.rb
 - spec/spec_helper.rb
+- spec/support/matchers/json_attribute.rb
+- spec/support/matchers/json_object.rb
 has_rdoc: 

data/lib/lurker/endpoint/http_parameters.rb

@@ -1,77 +0,0 @@
-module Lurker
-  class Endpoint
-    class HttpParameters
-      extend Forwardable
-      include Lurker::Utils
-
-      ID = 'id'.freeze
-      TYPE = 'type'.freeze
-      OBJECT = 'object'.freeze
-      PROPERTIES = 'properties'.freeze
-      ADDITIONAL_PROPERTIES = 'additionalProperties'.freeze
-
-      delegate [:[], :key?, :keys, :empty?] => :http_parameters
-
-      attr_reader :errors
-
-      def initialize(schema, options = {})
-        @schema = schema
-
-        @schema_key = options.fetch(:schema_key)
-        @schema_id = options.fetch(:schema_id)
-        @human_name = options.fetch(:human_name, @schema_key)
-
-        @schema[@schema_key] ||= {}
-        @errors = []
-      end
-
-      def add(parameters)
-        @schema[@schema_key] = Lurker::SchemaModifier.merge!(
-          Lurker::JsonSchemaHash.new(http_parameters, @schema_id), stringify_keys(parameters)
-        ).to_h
-      end
-
-      # TODO : Split the collecting of errors and representations of errors
-      def validate(parameters)
-        errors = Lurker::Validator.new(schemify(http_parameters), stringify_keys(parameters),
-          record_errors: true).validate
-
-        @errors = errors.map { |error| "- #{error}" }
-        @errors.unshift(@human_name) unless @errors.empty?
-      end
-
-      private
-
-      def http_parameters
-        @schema[@schema_key]
-      end
-
-      def schemify(object)
-        set_additional_properties_false_on(object).tap do |schema|
-          schema[ID] = "file://#{@schema_id}"
-        end
-      end
-
-      def set_additional_properties_false_on(object)
-        if object.is_a? Hash
-          copy = object.dup
-
-          if object[TYPE] == OBJECT || object.key?(PROPERTIES)
-            copy[ADDITIONAL_PROPERTIES] ||= false
-          end
-
-          object.each do |key, value|
-            next if key == ADDITIONAL_PROPERTIES
-            copy[key] = set_additional_properties_false_on(value)
-          end
-
-          copy
-        elsif object.is_a? Array
-          copy = object.map { |value| set_additional_properties_false_on(value) }
-        else
-          object
-        end
-      end
-    end
-  end
-end