restspec 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b4a864e3d5e797b04cd65a9e2a441314d2a0d7a
-  data.tar.gz: ea3719da1f15f76e1491b17052cb6258d137ae79
+  metadata.gz: aee8d567251582d1e11bf1360b2539e2d8f9621c
+  data.tar.gz: 8746f5961969356e821728543118f4baa694b4aa
 SHA512:
-  metadata.gz: a1407bf290ee76305617826cff5e0cf92185ce82e7e545876bb487c8124700f26bff1a6896028f1b9eeaebdca3d4317931b344955149190aa58809d1693ffe9e
-  data.tar.gz: f0bee71a932bbb1e767da9cb95041c59d98a391d652a56ec4a633675efb79d61cb1e72253ad6b7ffc76cf4a0e9460f29a6fe3d5368d7fabb3ac4d6e245e29c6d
+  metadata.gz: 275c8062f82f7b72fa200ecae179b5ef668fc6bd09b0eaa4b57a2d4322e43ce8a2aae6a0eb8a323d84ba6864dc8593eae7772c6f3ac175925f92fb8ab7c97ae1
+  data.tar.gz: 8667413094c1599d61dbf84dd129a0a6b2cbd1abf9e0aeb7429f3052fbcbb2a7d6014b96f7effc7bbf479d7d04e780bb3a7579c1437a4918891b6e440405fe52

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+0.1
+---
+
+- Added `:for` option to `schema` methods on the endpoint definition. This allows to specify schemas for payloads, schemas for responses and schemas for whatever. See: https://github.com/platanus/restspec/issues/2.
+- Added `no_schema` method to endpoint definitions. This is a subtask of https://github.com/platanus/restspec/issues/2..
+
+0.2
+---
+- Fixed a problem with schema extensions (`:without`) not working due to the fact that endpoints saved schema clones that just were shallow clones. They still were sharing the internal attributes hash.
+- Fixed `no_schema`. It was not working because the schema setting of the namepsace were happening after the `no_schema` call. From now, `all` definitions will happen before the specific schema definitions.
+- Changed abilities of schemas related to endpoints to just be the same as the schema roles. It's preferrable to have attributes only for payload or only for responses than attributes only for examples or only for checks. This is the new feature of the release.

data/README.md

@@ -83,8 +83,8 @@ schema :product do
   attribute :name, string
   attribute :code, string
   attribute :price, decimal | decimal_string
-  attribute :category_id, schema_id(:category), :for => [:examples]
-  attribute :category, embedded_schema(:category), :for => [:checks]
+  attribute :category_id, schema_id(:category), :for => [:payload]
+  attribute :category, embedded_schema(:category), :for => [:response]
 end
 
 schema :category do
@@ -186,7 +186,7 @@ Be sure to add your issue with a `bug` label or the `question` one.
 
 ## A note about SemVer
 
-We are using SemVer from 0.0.4 onwards. Versions before 0.0.4 doesn't use Semver and they add some features (intended for MINOR releases, not for PATCH releases). With the addition of 0.0.5, we will be using a CHANGELOG.md file with the track of the commits that made their way to that version.
+We are using SemVer from 0.0.4 onwards. Versions before 0.0.4 doesn't use Semver and they add some features (intended for MINOR releases, not for PATCH releases). With the addition of 0.1, we will be using a CHANGELOG.md file with the track of the commits that made their way to that version.
 
 ## Contribute
 

data/examples/store-api-tests/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ~/dev/projects/ruby/restspec
   specs:
-    restspec (0.0.4)
+    restspec (0.1)
       activesupport (~> 4.0)
       faker (~> 1.4)
       hashie (~> 3.3)
@@ -10,6 +10,7 @@ PATH
       rspec (~> 3.0)
       rspec-collection_matchers (~> 1.0)
       rspec-its (~> 1.0)
+      ruby_deep_clone (~> 0.6)
       thor (~> 0.19)
       tilt (~> 2.0)
 
@@ -57,6 +58,7 @@ GEM
     rspec-mocks (3.1.3)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.2)
+    ruby_deep_clone (0.6.0)
     slop (3.6.0)
     thor (0.19.1)
     thread_safe (0.3.4)

data/examples/store-api-tests/api.md

@@ -5,140 +5,185 @@
 
 ### Create [POST /products]
 
-Returns schema **product**
+#### Payload
 
+The payload is an instance of the **product** schema.
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| created_at | date_time | 2014-12-08T22:35:55-05:00 |
-| updated_at | date_time | 2014-12-02T07:52:23-05:00 |
-| name | string | doloremque |
-| code | string | voluptatem |
-| price | decimal | 61.76 |
-| category_id | schema_id | 51 |
-| category | embedded_schema | {:name=>"deserunt"} |
+
+  ```json
+  {
+    "name": "consequatur",
+    "code": "corporis",
+    "price": 86.56,
+    "category_id": "5"
+  }
+  ```
+
+
+#### Response
+  Returns schema **product**
+
+
+  ```json
+  {
+    "created_at": "2014-12-08T20:04:00-05:00",
+    "updated_at": "2014-12-02T21:02:47-05:00",
+    "name": "ut",
+    "code": "nobis",
+    "price": 13.52,
+    "category_id": "1",
+    "category": {
+      "name": "delectus"
+    }
+  }
+  ```
 
 ### Index [GET /products]
 
-Returns schema **product**
+
+#### Response
+  Returns schema **product**
 
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| created_at | date_time | 2014-11-27T10:18:05-05:00 |
-| updated_at | date_time | 2014-11-25T14:47:53-05:00 |
-| name | string | quaerat |
-| code | string | et |
-| price | decimal | 70.28 |
-| category_id | schema_id | 51 |
-| category | embedded_schema | {:name=>"rerum"} |
+  ```json
+  {
+    "created_at": "2014-12-27T12:23:04-05:00",
+    "updated_at": "2014-12-04T23:20:43-05:00",
+    "name": "voluptatem",
+    "code": "facilis",
+    "price": 41.47,
+    "category_id": "8"
+  }
+  ```
 
 ### Show [GET /products/:id]
 
-Returns schema **product**
 
+#### Response
+  Returns schema **product**
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| created_at | date_time | 2014-12-05T13:39:27-05:00 |
-| updated_at | date_time | 2014-12-23T13:04:47-05:00 |
-| name | string | sed |
-| code | string | quam |
-| price | decimal | 81.56 |
-| category_id | schema_id | 51 |
-| category | embedded_schema | {:name=>"commodi"} |
+
+  ```json
+  {
+    "created_at": "2014-11-28T20:21:40-05:00",
+    "updated_at": "2014-12-28T08:10:27-05:00",
+    "name": "quasi",
+    "code": "rerum",
+    "price": 39.48,
+    "category_id": "0",
+    "category": {
+      "name": "saepe"
+    }
+  }
+  ```
 
 ### Update [PUT /products/:id]
 
-Returns schema **product**
 
+#### Response
+  Returns schema **product**
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| created_at | date_time | 2014-12-11T19:55:48-05:00 |
-| updated_at | date_time | 2014-12-01T18:33:17-05:00 |
-| name | string | possimus |
-| code | string | omnis |
-| price | decimal | 13.37 |
-| category_id | schema_id | 51 |
-| category | embedded_schema | {:name=>"tempora"} |
 
-### Destroy [DELETE /products/:id]
+  ```json
+  {
+    "created_at": "2014-12-27T02:32:32-05:00",
+    "updated_at": "2014-12-05T22:31:32-05:00",
+    "name": "iure",
+    "code": "autem",
+    "price": 47.17,
+    "category_id": "1",
+    "category": {
+      "name": "ut"
+    }
+  }
+  ```
 
-Returns schema **product**
+### Destroy [DELETE /products/:id]
 
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| created_at | date_time | 2014-12-17T17:29:46-05:00 |
-| updated_at | date_time | 2014-12-22T08:20:22-05:00 |
-| name | string | quos |
-| code | string | aut |
-| price | decimal | 32.84 |
-| category_id | schema_id | 51 |
-| category | embedded_schema | {:name=>"saepe"} |
+#### Response
+  The response is empty.
 
 
 ## Categories
 
 ### Create [POST /categories]
 
-Returns schema **category**
+
+#### Response
+  Returns schema **category**
 
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| name | string | nam |
+  ```json
+  {
+    "name": "quaerat"
+  }
+  ```
 
 ### Index [GET /categories]
 
-Returns schema **category**
 
+#### Response
+  Returns schema **category**
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| name | string | ut |
+
+  ```json
+  {
+    "name": "amet"
+  }
+  ```
 
 ### Show [GET /categories/:id]
 
-Returns schema **category**
+
+#### Response
+  Returns schema **category**
 
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| name | string | tempore |
+  ```json
+  {
+    "name": "consequatur"
+  }
+  ```
 
 ### Update [PUT /categories/:id]
 
-Returns schema **category**
 
+#### Response
+  Returns schema **category**
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| name | string | vel |
 
-### Destroy [DELETE /categories/:id]
+  ```json
+  {
+    "name": "voluptatem"
+  }
+  ```
 
-Returns schema **category**
+### Destroy [DELETE /categories/:id]
 
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| name | string | rerum |
+#### Response
+  The response is empty.
 
 ### Products [GET /categories/:id/products]
 
-Returns schema **product**
+
+#### Response
+  Returns schema **product**
 
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-| created_at | date_time | 2014-12-23T23:47:07-05:00 |
-| updated_at | date_time | 2014-11-29T07:40:59-05:00 |
-| name | string | corrupti |
-| code | string | aut |
-| price | decimal | 03.80 |
-| category_id | schema_id | 51 |
-| category | embedded_schema | {:name=>"qui"} |
+  ```json
+  {
+    "created_at": "2014-12-13T00:42:13-05:00",
+    "updated_at": "2014-12-12T18:31:59-05:00",
+    "name": "labore",
+    "code": "exercitationem",
+    "price": 15.84,
+    "category_id": "0",
+    "category": {
+      "name": "incidunt"
+    }
+  }
+  ```
 
 

data/examples/store-api-tests/spec/api/restspec/endpoints.rb

@@ -31,7 +31,7 @@ resource :categories do
 
     get :show
     put :update
-    delete :destroy
+    delete(:destroy) { no_schema }
 
     get :products, '/products' do
       schema :product

data/examples/store-api-tests/spec/api/restspec/schemas.rb

@@ -1,6 +1,6 @@
 mixin :timestamps do
-  attribute :created_at, datetime, :for => [:checks]
-  attribute :updated_at, datetime, :for => [:checks]
+  attribute :created_at, datetime, :for => [:response]
+  attribute :updated_at, datetime, :for => [:response]
 end
 
 schema :product do
@@ -10,7 +10,7 @@ schema :product do
   attribute :code, string
   attribute :price, decimal | decimal_string
   attribute :category_id, schema_id(:category)
-  attribute :category, embedded_schema(:category), :for => [:checks]
+  attribute :category, embedded_schema(:category), :for => [:response]
 end
 
 schema :category do

data/lib/restspec/endpoints/dsl.rb

@@ -83,12 +83,12 @@ module Restspec
         endpoint_dsl = EndpointDSL.new(endpoint)
         namespace.add_endpoint(endpoint)
 
-        endpoint_dsl.instance_eval(&block)
-
         endpoint_config_blocks.each do |config_block|
           endpoint_dsl.instance_eval(&config_block)
         end
 
+        endpoint_dsl.instance_eval(&block)
+
         Restspec::EndpointStore.store(endpoint)
       end
 

data/lib/restspec/endpoints/has_schemas.rb

@@ -1,4 +1,5 @@
 require 'active_support/concern'
+require 'deep_clone'
 
 module Restspec
   module Endpoints
@@ -16,7 +17,12 @@ module Restspec
         roles = options.delete(:for) || DEFAULT_ROLES
 
         roles.each do |role|
-          schema_roles[role] = Restspec::SchemaStore.fetch(schema_name).clone
+          schema_found = Restspec::SchemaStore.fetch(schema_name)
+
+          schema_roles[role] = DeepClone.clone(schema_found)
+          schema_roles[role].intention = role
+          schema_roles[role].original_schema = schema_found
+
           if options.any?
             schema_roles[role].extend_with(options)
           end

data/lib/restspec/runners/docs/templates/docs.md.erb

@@ -7,14 +7,30 @@
 <% namespace.all_endpoints.each do |endpoint| %>
 ### <%= endpoint.name.capitalize %> [<%= endpoint.method.upcase %> <%= endpoint.full_path %>]
 
-Returns schema **<%= endpoint.schema_name %>**
+<% if payload_schema = endpoint.schema_for(:payload) %>
+#### Payload
 
-<% schema = schema_store.get(endpoint.schema_name) %>
+The payload is an instance of the **<%= payload_schema.name %>** schema.
 
-|  Attribute  |             Type           |     Example    |
-|-------------|:--------------------------:|---------------:|
-<% schema.attributes.each do |name, attribute| %>
-| <%= name %> | <%= attribute.type.to_s %> | <%= attribute.type.example_for(attribute) %> |
+<% sample = Restspec::Schema::SchemaExample.new(payload_schema).value %>
+
+  ```json
+<%= JSON.pretty_generate(sample).gsub(/^/, '  ') %>
+  ```
+
+<% end %>
+
+#### Response
+<% if response_schema = endpoint.schema_for(:response) %>
+  Returns schema **<%= response_schema.name %>**
+
+  <% sample = Restspec::Schema::SchemaExample.new(response_schema).value %>
+
+  ```json
+<%= JSON.pretty_generate(sample).gsub(/^/, '  ') %>
+  ```
+<% else %>
+  The response is empty.
 <% end %>
 
 <% end %>

data/lib/restspec/schema/attribute.rb

@@ -36,15 +36,15 @@ module Restspec
       #   - **example**: A callable object (eg: a lambda) that returns something.
       #   - **for**: Defines what abilities this attributes has.
       #     This is an array that can contains none, some or all the symbols
-      #     `:checks` and `:examples`. This option defaults to `[:checks, :examples]`,
-      #     allowing the attribute to be used for run validations from {Checker#check!}
-      #     and for generating examples from {SchemaExample#value}.
+      #     `:response` and `:payload`. This option defaults to `[:response, :payload]`,
+      #     allowing the attribute to be used for run validations from {Checker#check!} (`:response`)
+      #     and for generating payload from {SchemaExample#value} (`:payload`).
       # @return A new instance of Attribtue.
       def initialize(name, type, options = {})
         self.name = name
         self.type = type
         self.example_override = options.fetch(:example, nil)
-        self.allowed_abilities = options.fetch(:for, [:checks, :examples])
+        self.allowed_abilities = options.fetch(:for, [:response, :payload])
       end
 
       # The inner example in the attribute created calling the :example option
@@ -55,14 +55,14 @@ module Restspec
         @example ||= example_override
       end
 
-      # @return [true, false] if the attribute has the ability to generate examples or not
-      def can_generate_examples?
-        allowed_abilities.include?(:examples)
+      # @return [true, false] if the attribute has the ability to be used in payloads.
+      def can_be_checked?
+        allowed_abilities.include?(:payload)
       end
 
-      # @return [true, false] if the attribute has the ability to be checked
-      def can_be_checked?
-        allowed_abilities.include?(:checks)
+      # @return [true, false] if the attribute has the ability being passed
+      def can?(ability)
+        allowed_abilities.include?(ability)
       end
 
       private

data/lib/restspec/schema/dsl.rb

@@ -78,7 +78,7 @@ module Restspec
       #
       #  schema :books do
       #   attribute :title, string
-      #   attribute :created_at, datetime, :for => [:checks]
+      #   attribute :created_at, datetime, :for => [:response]
       #  end
       #
       # @param (see Attribute#initialize)

data/lib/restspec/schema/schema.rb

@@ -10,6 +10,10 @@ module Restspec
       # The set of attributes that conforms the schema.
       attr_reader :attributes
 
+      # TODO: Document
+      attr_accessor :intention
+      attr_accessor :original_schema
+
       # @param name [Symbol] The name of the schema
       # @return a new {Restspec::Schema::Schema Schema} object
       def initialize(name)
@@ -25,6 +29,14 @@ module Restspec
         self
       end
 
+      def attributes_for_intention
+        return attributes if intention.blank?
+
+        attributes.inject({}) do |hash, (name, attribute)|
+          attribute.can?(intention) ? hash.merge(name => attribute) : hash
+        end
+      end
+
       private
 
       attr_writer :name, :attributes

data/lib/restspec/schema/schema_example.rb

@@ -16,18 +16,14 @@ module Restspec
       # @return [Restspec::Values::SuperHash] generated example.
       def value
         attributes.inject({}) do |sample, (_, attribute)|
-          if attribute.can_generate_examples?
-            sample.merge(attribute.name => AttributeExample.new(attribute).value)
-          else
-            sample
-          end
+          sample.merge(attribute.name => AttributeExample.new(attribute).value)
         end.merge(extensions)
       end
 
       private
 
       def attributes
-        schema.attributes
+        schema.attributes_for_intention
       end
     end
   end

data/lib/restspec/version.rb

@@ -1,3 +1,3 @@
 module Restspec
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/restspec.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rspec-collection_matchers", "~> 1.0"
   spec.add_dependency "thor", "~> 0.19"
   spec.add_dependency "tilt", "~> 2.0"
+  spec.add_dependency "ruby_deep_clone", "~> 0.6"
 end

data/spec/restspec/schema/attribute_spec.rb

@@ -14,20 +14,6 @@ describe Attribute do
     end
   end
 
-  describe '#can_generate_examples?' do
-    subject { attribute.can_generate_examples? }
-
-    context 'without the option' do
-      let(:attribute) { Attribute.new(:name, type, example: 'example', :for => []) }
-      it { should eq(false) }
-    end
-
-    context 'with the option' do
-      let(:attribute) { Attribute.new(:name, type, example: 'example', :for => [:examples]) }
-      it { should eq(true) }
-    end
-  end
-
   describe '#can_be_checked?' do
     subject { attribute.can_be_checked? }
 
@@ -37,7 +23,7 @@ describe Attribute do
     end
 
     context 'with the option' do
-      let(:attribute) { Attribute.new(:name, type, :for => [:checks]) }
+      let(:attribute) { Attribute.new(:name, type, :for => [:payload]) }
       it { should eq(true) }
     end
   end

data/spec/restspec/schema/dsl_spec.rb

@@ -50,30 +50,6 @@ describe SingleSchemaDSL do
       expect(attribute.name).to eq('attr_name')
       expect(attribute.type).to eq(type_instance)
     end
-
-    context 'when the :for option is just for checks' do
-      let(:attribute) { dsl.attribute('attr_name', type_instance, for: [:checks]) }
-
-      it 'is not allowed to generate examples' do
-        expect(attribute.can_generate_examples?).to eq(false)
-      end
-
-      it 'is allowed to run in validations' do
-        expect(attribute.can_be_checked?).to eq(true)
-      end
-    end
-
-    context 'when the :for option is just for examples' do
-      let(:attribute) { dsl.attribute('attr_name', type_instance, for: [:examples]) }
-
-      it 'is allowed to generate examples' do
-        expect(attribute.can_generate_examples?).to eq(true)
-      end
-
-      it 'is not allowed to run in validations' do
-        expect(attribute.can_be_checked?).to eq(false)
-      end
-    end
   end
 
   describe '#include_attributes' do

data/spec/restspec/schema/schema_example_spec.rb

@@ -19,16 +19,6 @@ describe SchemaExample do
     let(:schema_example) { SchemaExample.new(schema) }
 
     it { should eq(name: 'name', age: 18)}
-
-    context 'with an attribute not allowed to generate examples' do
-      before do
-        schema.attributes['hidden'] = Attribute.new(:hidden, hidden_type, :for => [:checks])
-      end
-
-      it 'does not include the hidden attribute' do
-        expect(subject).to_not include(:hidden)
-      end
-    end
   end
 
   context 'with extensions' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restspec
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - juliogarciag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-27 00:00:00.000000000 Z
+date: 2014-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -262,6 +262,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ruby_deep_clone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: RSpec macros, helpers and matchers to work with APIs
 email:
 - julioggonz@gmail.com