restspec 0.0.4 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b14366420ef12b0045f219c192a5346c0ff20e67
-  data.tar.gz: 579f30c0dfb646bbd366cb1a279e663df4894fb8
+  metadata.gz: 9b4a864e3d5e797b04cd65a9e2a441314d2a0d7a
+  data.tar.gz: ea3719da1f15f76e1491b17052cb6258d137ae79
 SHA512:
-  metadata.gz: d73c7968b21b7370351c196ba873554366f08cf15c71c3d85dffea7a49a56a096592fd7c92fb6edb1c0e35869d2f71d461d97b24fde0ae393aa2d42a752a7281
-  data.tar.gz: 6c12400eae60a5ea62fc2eabf2551f536c0e95dd217adf64556fd414b6b896505f028181984cc08a01a1ae4b064eb1dfe6d26d6c46e8f49da4ade60278a60c94
+  metadata.gz: a1407bf290ee76305617826cff5e0cf92185ce82e7e545876bb487c8124700f26bff1a6896028f1b9eeaebdca3d4317931b344955149190aa58809d1693ffe9e
+  data.tar.gz: f0bee71a932bbb1e767da9cb95041c59d98a391d652a56ec4a633675efb79d61cb1e72253ad6b7ffc76cf4a0e9460f29a6fe3d5368d7fabb3ac4d6e245e29c6d

data/.yardopts

@@ -0,0 +1,5 @@
+--protected
+--markup markdown
+--no-private
+--exclude runners/docs/templates/
+--exclude runners/install/templates/

data/README.md

@@ -11,7 +11,7 @@ Install it globally like this:
 
 ## Usage
 
-For a basic tutorial of how to use Restspec, please check [this file](https://github.com/platanus/restspec/blob/master/docs/tutorial.md).
+For a basic tutorial of how to use Restspec, please check [this file](https://github.com/platanus/restspec/blob/master/guides/tutorial.md).
 
 ### The Restspec Approach
 
@@ -72,7 +72,7 @@ resources :products do
 end
 ```
 
-Check the endpoint DSL documentation [here](https://github.com/platanus/restspec/blob/master/docs/endpoints.md) for more details of the available methods and options. The only important thing about them is that they are the endpoints we have to test.
+Check the endpoint DSL documentation [here](https://github.com/platanus/restspec/blob/master/guides/endpoints.md) for more details of the available methods and options. The only important thing about them is that they are the endpoints we have to test.
 
 ### Schemas
 
@@ -92,9 +92,9 @@ schema :category do
 end
 ```
 
-As you can see, a schema is compound of attributes that are attached to one type. The types are useful for many things. The types documentation is located [here](https://github.com/platanus/restspec/blob/master/docs/types.md).
+As you can see, a schema is compound of attributes that are attached to one type. The types are useful for many things. The types documentation is located [here](https://github.com/platanus/restspec/blob/master/guides/types.md).
 
-The schemas DSL documentation is located [here](https://github.com/platanus/restspec/blob/master/docs/schemas.md). Schemas are a very important part of Restspec but they are not as necesary as the endpoints.
+The schemas DSL documentation is located [here](https://github.com/platanus/restspec/blob/master/guides/schemas.md). Schemas are a very important part of Restspec but they are not as necesary as the endpoints.
 
 ### Tests
 
@@ -155,7 +155,7 @@ endpoint 'products/update', resource: 'products/show' do
 end
 ```
 
-For more information about what can you do in your tests, you can see what are the [available matchers](https://github.com/platanus/restspec/blob/master/docs/matchers.md), the [available helpers](https://github.com/platanus/restspec/blob/master/docs/helpers.md) and the [available macros](https://github.com/platanus/restspec/blob/master/docs/macros.md).
+For more information about what can you do in your tests, you can see what are the [available matchers](https://github.com/platanus/restspec/blob/master/guides/matchers.md), the [available helpers](https://github.com/platanus/restspec/blob/master/guides/helpers.md) and the [available macros](https://github.com/platanus/restspec/blob/master/guides/macros.md).
 
 ### Requirements
 
@@ -180,9 +180,13 @@ endpoint 'products/create' do
 end
 ```
 
-## A note about the Roadmap
+## If you have some issue
 
-Because the scope of this library is not small, we couldn't make a first release as small as we are acostumed. Anyway, we love to be able to deliver in small iterations, so there a [ROADMAP](https://github.com/platanus/restspec/blob/master/ROADMAP.md) file that we use to keep track of the objectives that we have. Althought many of the objectives of the gem are already done, there are more objectives that will expect to the following releases.
+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.
 
 ## Contribute
 

data/Rakefile

@@ -5,13 +5,20 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
+desc "generate rdoc"
+task :rdoc do
+  sh "bundle exec yardoc"
+end
+
 namespace :restspec do
+  desc 'Run the example application defined in examples/store-api'
   task :run_example_app do
     Dir.chdir("examples/store-api") do
       exec("BUNDLE_GEMFILE=Gemfile bundle exec rails s -p 3000")
     end
   end
 
+  desc 'Run the example application tests defined in examples/store-api-tests'
   task :run_example_tests do
     Dir.chdir("examples/store-api-tests") do
       exec("BUNDLE_GEMFILE=Gemfile bundle exec rspec spec/")

data/bin/restspec

@@ -11,7 +11,7 @@ require 'restspec/runners/docs/docs_runner'
 
 class RestspecCLI < Thor
   register(Restspec::InstallRunner, 'install', 'install [your_test_folder]', 'Type restspec install for more help.')
-  # register(Restspec::DocsRunner, 'docs', 'docs [your_docs_location]', 'Type restspec docs for more help.')
+  register(Restspec::DocsRunner, 'docs', 'docs [your_docs_location]', 'Type restspec docs for more help.')
 end
 
 RestspecCLI.start(ARGV)

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

@@ -1,7 +1,7 @@
 PATH
   remote: ~/dev/projects/ruby/restspec
   specs:
-    restspec (0.0.3)
+    restspec (0.0.4)
       activesupport (~> 4.0)
       faker (~> 1.4)
       hashie (~> 3.3)
@@ -11,6 +11,7 @@ PATH
       rspec-collection_matchers (~> 1.0)
       rspec-its (~> 1.0)
       thor (~> 0.19)
+      tilt (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -59,6 +60,7 @@ GEM
     slop (3.6.0)
     thor (0.19.1)
     thread_safe (0.3.4)
+    tilt (2.0.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
 

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

@@ -10,13 +10,13 @@ Returns schema **product**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | libero |
-| code | string | expedita |
-| price | decimal | 49.18 |
-| category_id | schema_id | 1 |
-| category | embedded_schema | {:name=>"rerum"} |
-| created_at | date_time | 2014-12-15T12:37:23-05:00 |
-| updated_at | date_time | 2014-12-14T18:01:19-05:00 |
+| 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"} |
 
 ### Index [GET /products]
 
@@ -25,13 +25,13 @@ Returns schema **product**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | voluptatum |
-| code | string | blanditiis |
-| price | decimal | 77.09 |
-| category_id | schema_id | 2 |
-| category | embedded_schema | {:name=>"ipsam"} |
-| created_at | date_time | 2014-12-11T18:07:45-05:00 |
-| updated_at | date_time | 2014-12-20T22:30:23-05:00 |
+| 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"} |
 
 ### Show [GET /products/:id]
 
@@ -40,13 +40,13 @@ Returns schema **product**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | distinctio |
-| code | string | blanditiis |
-| price | decimal | 55.84 |
-| category_id | schema_id | 4 |
-| category | embedded_schema | {:name=>"iure"} |
-| created_at | date_time | 2014-12-07T13:39:53-05:00 |
-| updated_at | date_time | 2014-12-07T13:45:22-05:00 |
+| 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"} |
 
 ### Update [PUT /products/:id]
 
@@ -55,13 +55,13 @@ Returns schema **product**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | sit |
-| code | string | ut |
-| price | decimal | 85.80 |
-| category_id | schema_id | 5 |
-| category | embedded_schema | {:name=>"qui"} |
-| created_at | date_time | 2014-12-02T15:11:53-05:00 |
-| updated_at | date_time | 2014-11-29T13:55:04-05:00 |
+| 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]
 
@@ -70,13 +70,13 @@ Returns schema **product**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | aut |
-| code | string | illo |
-| price | decimal | 81.59 |
-| category_id | schema_id | 3 |
-| category | embedded_schema | {:name=>"quis"} |
-| created_at | date_time | 2014-11-25T07:30:09-05:00 |
-| updated_at | date_time | 2014-11-30T22:45:02-05:00 |
+| 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"} |
 
 
 ## Categories
@@ -88,7 +88,7 @@ Returns schema **category**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | voluptate |
+| name | string | nam |
 
 ### Index [GET /categories]
 
@@ -97,7 +97,7 @@ Returns schema **category**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | odit |
+| name | string | ut |
 
 ### Show [GET /categories/:id]
 
@@ -106,7 +106,7 @@ Returns schema **category**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | explicabo |
+| name | string | tempore |
 
 ### Update [PUT /categories/:id]
 
@@ -115,7 +115,7 @@ Returns schema **category**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | quos |
+| name | string | vel |
 
 ### Destroy [DELETE /categories/:id]
 
@@ -124,7 +124,7 @@ Returns schema **category**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | fuga |
+| name | string | rerum |
 
 ### Products [GET /categories/:id/products]
 
@@ -133,12 +133,12 @@ Returns schema **product**
 
 |  Attribute  |             Type           |     Example    |
 |-------------|:--------------------------:|---------------:|
-| name | string | eos |
-| code | string | odit |
-| price | decimal | 41.37 |
-| category_id | schema_id | 8 |
-| category | embedded_schema | {:name=>"et"} |
-| created_at | date_time | 2014-11-24T12:34:34-05:00 |
-| updated_at | date_time | 2014-11-25T02:07:06-05:00 |
+| 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"} |
 
 

data/examples/store-api-tests/spec/api/product_spec.rb

@@ -3,8 +3,6 @@ require 'spec_helper'
 RSpec.describe :products, :type => :api do
   endpoint 'products/create' do
     test do
-      payload { schema_example(:product) }
-
       it { should have_status(:created) }
     end
   end

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

@@ -1,10 +1,11 @@
 resource :products do
-  schema :product
-
   collection do
-    post :create
+    post :create do
+      schema :product, :for => [:payload, :response]
+    end
+
     get :index do
-      schema :product, without: [:category]
+      schema :product, :for => [:response], :without => [:category]
     end
   end
 
@@ -13,7 +14,7 @@ resource :products do
 
     get :show
     put :update
-    delete :destroy
+    delete(:destroy) { no_schema }
   end
 end
 

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

@@ -4,12 +4,13 @@ mixin :timestamps do
 end
 
 schema :product do
+  include_attributes :timestamps
+
   attribute :name, string
   attribute :code, string
   attribute :price, decimal | decimal_string
   attribute :category_id, schema_id(:category)
   attribute :category, embedded_schema(:category), :for => [:checks]
-  include_attributes :timestamps
 end
 
 schema :category do

data/{docs → guides}/tutorial.md

@@ -24,7 +24,7 @@ $ tree
 
 ```
 
-If you're familiar with the regular use of RSpec, this initial structure should look normal except from the the files in the `api/restspec` folder.
+If you're familiar with the regular use of RSpec, this initial structure should look normal except for the files in the `api/restspec` folder.
 
 - **endpoints.rb**: This is the place to describe your endpoints. One important thing is that your tests **won't define your endpoints**. In this way, we have a graph of the structure of your api *always* and this can help you to visualize your api structure and create better matchers.
 - **schemas.rb**: The schemas are the shape of the resources you are manipulating in the api. It's a centralized place to put how your data should be.

data/lib/restspec/configuration.rb

@@ -4,6 +4,30 @@ module Restspec
   include ActiveSupport::Configurable
 
   class << self
+    # Configure Restspec and loads the information of the API defined in the DSL definitions if the DSL definitions are defined.
+    #
+    # The following options are available:
+    #
+    #   - **base_url**: The base url of the API. It is a full url, not only a domain, so it can include more than just the api url but a version path like: `http://localhost:3000/api/v1`.
+    #   - **schema_definition**: The file location where the file describing the schemas is located.
+    #   - **endpoints_definition**: The file location where the file describing the endpoints is located.
+    #   - **requirements_definition**: The file location where the file describing the requirements is located.
+    #   - **request**: An object that configures the default request. It has a header hash inside to set default headers for every request.
+    #   - **custom**: An object to hold custom configuration. It can be accessed anywhere using `Restspec.custom`.
+    #
+    # @yield [config] A block describing the Restspec configuration
+    #
+    # @example Defines some configuration options:
+    #   Restspec.configure do |config|
+    #     config.base_url = 'http://localhost:3000/api/v1'
+    #
+    #     config.schema_definition = "#{File.dirname __FILE__}/schemas.rb"
+    #     config.endpoints_definition = "#{File.dirname __FILE__}/endpoints.rb"
+    #     config.requirements_definition = "#{File.dirname __FILE__}/requirements.rb"
+    #
+    #     config.custom.api_key = ENV['API_KEY']
+    #     config.request.headers['AUTHORIZATION'] = "Token token=\"#{config.custom.api_key}\""
+    #   end
     def configure
       config.request = OpenStruct.new(headers: {})
       config.request.headers['Content-Type'] = 'application/json'
@@ -16,15 +40,15 @@ module Restspec
       populate_stores
     end
 
+    private
+
     def populate_stores
-      load_schemas
+      load_schemas_definition
       load_endpoint_definition
       load_requirement_definition
     end
 
-    private
-
-    def load_schemas
+    def load_schemas_definition
       eval_file Schema::DSL.new, config.schema_definition
     end