restspec 0.0.1

data/docs/types.md

@@ -0,0 +1,134 @@
+# Types Documentation
+
+## Types Composition
+
+### Disjunction
+
+You can make a logical OR on types using `|`. In this way, an attribute can have a type or another. It generates information from the first type but, when validating, the check goes first to the first type and, if it fails, go to the next one. With this, you can do something like this:
+
+```ruby
+attribute :name, string | null
+```
+
+### Generic Types
+
+With the `of` method you can attach a type information into another type. Every time can decide if it does something with the aditional type. For example, the `array` type can look for the types of each one of his elements using `of`, in this way:
+
+```ruby
+schema :raffle do
+  attribute :name, string
+  attribute :participants, array.of(embedded_schema(:person))
+end
+```
+
+## Types
+
+### Array Type
+
+- It uses the method `array`.
+- It tests if the current attribute value is an array.
+- Currently, it generates an array depending on the length option and the parameterized type (specified with `of`) being used.
+- It only has the `length` option, that is fixed number.
+- It can be composed of other types using `of`. With `of`, it can test the content of the array more deeply.
+
+    ```ruby
+    attribute :matrix, array.of(array.of(decimal | decimal_string))
+    ```
+
+
+### Boolean Type
+
+- It uses the method `boolean`.
+- It tests if the current attribute value is `true` or `false`.
+- It generates randomly `true` or `false`.
+- It doesn't use any option.
+
+### Decimal String Type
+
+- It uses the method `decimal_string`.
+- It tests if the current attribute value is a string that looks like a decimal. (Eg: `"0.1"`)
+- It generates a decimal wrapped into a string.
+- It uses the following options:
+    + Example Options:
+        * **integer_part:** It specifies the integer part of the generated number.
+        * **decimal_part:** It specifies the decimal part of the generated number.
+    + Schema Options:
+        * **integer_part:** It specifies the expected integer part size of the given attribute value.
+        * **decimal_part:** It verifies the expected decimal part size of the given attribute value.
+
+### Decimal Type
+
+- It uses the method `decimal`.
+- In only tests if the attribute value is numeric.
+- It generates a decimal number.
+- It uses the following options:
+    + Example Options:
+        * **integer_part:** It specifies the integer part of the generated number.
+        * **decimal_part:** It specifies the decimal part of the generated number.
+
+### Hash Type
+
+- It uses the method `hash`.
+- It tests if the attribute is a hash containing some optional keys with an optional value type.
+- Currently, it generates an empty hash. (We should think further if they should generate more than this, and how)
+- It uses the following options:
+    + Schema Options:
+        * **keys:** Array of keys that should be in the hash.
+        * **value_type:** Type (method used by the type) of the values of the hash. With this, `hash` can be composed of other types.
+
+### Integer Type
+
+- It uses the method `integer`.
+- In only tests if the attribute value is a fixed number.
+- It generates a random integer number.
+- It doesn't use any option.
+
+### Null Type
+
+- It uses the method `null`.
+- It only test for null values.
+- It always generates null.
+- It doesn't use any option.
+- It's useful composed with any other type. For example, for a value that can a string but it's optional.
+
+    ```ruby
+    attribute :address, string | null
+    ```
+
+### 'One Of' Type
+- It uses the method `one_of`.
+- It checks if the attribute values is one of the items specified in the `elements` array option.
+- It returns one of the items in the `elements` array option.
+- It only has the `elements` option.
+
+    ```ruby
+    attribute :type, one_of(elements: ['water', 'fire', 'thunder', 'psychic'])
+    ```
+
+### 'Schema Id' Type
+
+- It uses the method `schema_id`. The first parameter of this method is the main schema to test.
+- It checks if the attribute value is an id of some element in the `index` endpoint associated to the given schema.
+- It generates an object by fetching one item in the `index` endpoint. If there's no item in that endpoint, it will create one item using the `create` endpoint. After this, it will return the id of the item.
+- It uses the following options:
+    + Schema Options:
+        * **perform_validation:** A boolean to specify if we should perform a schema validation or not. (In case we only want to generate information for tests but not to check against anytime).
+    + Example Options:
+        * **create_schema:** Name of the schema used to generate data.
+        * **hardcoded_fallback:** If we can't get or create the id, this option will be used instead of raise an error.
+        * **fetch_endpoint:** The endpoint to use to fetch. By default, it's the `index` endpoint of the namespace asociated with this schema.
+        * **create_endpoint:** The endpoint to use to create data. By default, it's the `create` endpoint of the namespace asociated with this schema.
+
+### String Type
+
+- It uses the method `string`.
+- It tests if the current attribute value is a string.
+- It generates a random word.
+- It doesn't use any option.
+
+### Embedded Schema
+
+- It uses the method `embedded_schema` with the name of the schema to embed.
+- It tests if the current attribute is a hash that have the shape of the schema.
+- It generates an example of the given schema.
+- It doesn't use any option.

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

@@ -0,0 +1,3 @@
+--color
+--format=doc
+

data/examples/store-api-tests/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'pry'
+gem 'restspec', path: '~/dev/projects/ruby/restspec'

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

@@ -0,0 +1,70 @@
+PATH
+  remote: ~/dev/projects/ruby/restspec
+  specs:
+    restspec (0.0.1)
+      activesupport (~> 4.0)
+      faker (~> 1.4)
+      hashie (~> 3.3)
+      httparty (~> 0.13)
+      rack (~> 1.0)
+      rspec (~> 3.0)
+      rspec-collection_matchers (~> 1.0)
+      rspec-its (~> 1.0)
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.7)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    faker (1.4.3)
+      i18n (~> 0.5)
+    hashie (3.3.1)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.11)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (5.4.3)
+    multi_xml (0.5.5)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-collection_matchers (1.0.0)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-its (1.1.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  restspec!

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

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+RSpec.describe :categories, :type => :api do
+  endpoint 'categories/create' do
+    test do
+      payload { schema_example(:category) }
+
+      it { should have_status(:created) }
+    end
+  end
+
+  endpoint 'categories/products', focus: true do
+    test do
+      # it { should have_status(:ok) }
+      # it { should be_like_schema_array }
+    end
+
+    test 'with an unexisting category' do
+      url_params id: '0'
+      it { should have_status(:not_found) }
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+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
+
+  endpoint 'products/show' do
+    test do
+      it { should have_status(:ok) }
+      it { should be_like_schema }
+    end
+  end
+
+  endpoint 'products/index' do
+    test do
+      it { should have_status(:ok) }
+      it { should be_like_schema_array }
+    end
+  end
+
+  endpoint 'products/update', resource: 'products/show' do
+    payload { { name: "#{initial_resource.name}-001" } }
+
+    test do
+      it 'updates the name' do
+        expect(final_resource.name).to_not eq(initial_resource.name)
+        expect(final_resource.name).to eq(request.payload.name)
+      end
+
+      it 'includes the payload' do
+        expect(final_resource).to include(payload)
+      end
+
+      it 'does not include the initial resource attributes' do
+        expect(final_resource.values).to_not include(initial_resource.values)
+      end
+    end
+  end
+
+  endpoint 'products/destroy', resource: 'products/show' do
+    test do
+      it { should have_status(:no_content) }
+
+      it 'actually destroyed the product' do
+        resource_after_destruction = resource_endpoint.execute
+        expect(resource_after_destruction).to have_status(:not_found)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+resource :products do
+  schema :product
+
+  collection do
+    post :create
+    get :index do
+      schema :product, without: [:category]
+    end
+  end
+
+  member do
+    url_param(:id) { schema_id(:product) }
+
+    get :show
+    put :update
+    delete :destroy
+  end
+end
+
+resource :categories do
+  schema :category
+
+  collection do
+    post :create
+    get :index
+  end
+
+  member do
+    url_param(:id) { schema_id(:category) }
+
+    get :show
+    put :update
+    delete :destroy
+
+    get :products, '/products' do
+      schema :product
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+Restspec.configure do |config|
+  config.base_url = 'http://localhost:3000'
+  config.schema_definition = "#{File.dirname __FILE__}/schemas.rb"
+  config.endpoints_definition = "#{File.dirname __FILE__}/endpoints.rb"
+  config.requirements_definition = "#{File.dirname __FILE__}/requirements.rb"
+end

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

@@ -0,0 +1,11 @@
+schema :product do
+  attribute :name, string
+  attribute :code, string
+  attribute :price, decimal | decimal_string
+  attribute :category_id, schema_id(:category)
+  attribute :category, embedded_schema(:category), :for => [:checks]
+end
+
+schema :category do
+  attribute :name, string
+end

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

@@ -0,0 +1,19 @@
+require 'restspec'
+
+Dir["#{File.dirname __FILE__}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.include Restspec::RSpec::ApiHelpers, :type => :api
+  config.extend Restspec::RSpec::ApiMacros, :type => :api
+  config.extend CustomMacros, :type => :api
+end
+
+require_relative './api/restspec/restspec_config'

data/examples/store-api-tests/spec/support/custom_macros.rb

@@ -0,0 +1,3 @@
+module CustomMacros
+  
+end

data/examples/store-api/.editorconfig

@@ -0,0 +1,24 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.js]
+indent_style = tab
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false

data/examples/store-api/.rbenv-vars.example

@@ -0,0 +1,3 @@
+DEV_DB_NAME=store-api
+DEV_DB_USER=root
+DEV_DB_PASSWORD=

data/examples/store-api/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--format=doc
+--format=Nc

data/examples/store-api/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/examples/store-api/Gemfile

@@ -0,0 +1,58 @@
+source 'https://rubygems.org'
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.1.6'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.3'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer',  platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0',          group: :doc
+
+# Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+gem 'spring',        group: :development
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]
+
+
+group :development, :test do
+  gem "rspec-rails"
+  gem "factory_girl_rails"
+  gem "byebug"
+  gem "zeus"
+  gem "guard-rspec", require: false
+  gem "rspec-nc", require: false
+  gem "pry-rails"
+  gem "faker"
+  gem "quiet_assets"
+  gem "better_errors"
+  gem "binding_of_caller"
+end
+
+group :test do
+  gem "shoulda-matchers"
+end