rspec-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 302b0ee6e8cfaf3d3e65b088f190e1c36cd210af
-  data.tar.gz: 4f27c81817901a1108c8d0fc6e28706fcb06cecd
+  metadata.gz: 80ddaf39a5b7ad64bec2e973e89771183f139ed2
+  data.tar.gz: c5b3280cd6f9b23bd127fd43db4487ded01c8a9c
 SHA512:
-  metadata.gz: f15362494296d9866eaba1fc49100e7f2031ab78cd8a76d26336851909ea1a65f5fd273379a573e527e88f1dec62180575b4b38ee8ba9eaf9014c0e9bbe61341
-  data.tar.gz: 6d94a2b103b77e0fd61affaac2a48c89fcea87731237fc2f5e7709772228cdfee7d5da4278c37ed494b4911cab056c9c5ac7b524fdbca760dfbfee9394c4cfa1
+  metadata.gz: fe877acbc40ca26a6dde50984ce03c62a485d7833fc2c175389a323a74debb9c189fd531a120cb83cf8541d8e6461afefeb36a43954a4a8d208ad9520e35f52a
+  data.tar.gz: d80f970b130815b361bac32f81f6d4623ae6345a514c6a0917a709596fc066bea127f6a1e2fbc112b6cf5597c33ab1e273972fadc5da1887ed8cfbe1391ed728

data/{LICENSE.txt → MIT-LICENSE}

@@ -1,6 +1,4 @@
-Copyright (c) 2013 claudiob
-
-MIT License
+Copyright 2013 claudiob
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,29 +1,2 @@
-# Rspec::Api
+# RSpec API
 
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'rspec-api'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rspec-api
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/lib/rspec-api/accept_helper.rb

@@ -0,0 +1,59 @@
+def accepts(options = {}, &block)
+  parameters = block_given? ? options.merge(block: block) : options
+  (metadata[:query_parameters] ||= []).push parameters
+end
+
+RSpec::Matchers.define :be_sorted_by do |attribute|
+  match do |items|
+    values = items.map{|item| item[attribute.to_s]}
+    values.reverse! if example.metadata[:request_params][:sort][0] == '-'
+    values == values.sort
+  end
+end
+
+def assert_pagination_links
+  expect(response_headers).to have_key 'Link'
+  links = response_headers['Link'].split(',')
+  rels = links.map{|link| link[/<.+?>; rel="(.*)"$/, 1]}
+  expect(rels).to match_array ['last', 'next']
+end
+
+def query_parameters_requests
+  metadata.fetch(:query_parameters, []).map do |params|
+    if params.has_key? :filter
+      filter_parameters_requests params
+    elsif params.has_key? :sort
+      sort_parameters_requests params
+    elsif params.has_key? :page
+      page_parameters_requests params
+    end
+  end.flatten
+end
+
+def filter_parameters_requests(params)
+  params.except(:given, :block).tap do |req|
+    value = params.fetch :given, apply(:as_json, to: existing(params[:on]))
+    req[:description] = " filtered by #{params[:filter]}"
+    req[:request_params] = {params[:filter] => value}
+    req[:block] = params[:block]
+  end
+end
+
+def sort_parameters_requests(params)
+  [true, false].map do |ascending|
+    params.except(:block).tap do |req|
+      req[:description] = " sorted by #{params[:sort]} #{ascending ? '↑' : '↓'}"
+      req[:request_params] = {sort: "#{ascending ? '' : '-'}#{params[:sort]}"}
+      req[:block] = params[:block]
+    end
+  end
+end
+
+def page_parameters_requests(params)
+  {}.tap do |req|
+    req[:description] = " paginated by #{params[:page]}"
+    (req[:request_params] = {})[params[:page]] = 1
+    req[:min_pages] = 2
+    req[:block] = -> _ { assert_pagination_links }
+  end
+end

data/lib/rspec-api/api_helper.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+shared_context 'accept_json', accepts: :json do
+  header 'Accept', 'application/json'
+end
+
+shared_context 'return_json', returns: :json do
+  after { expect(json_response?) }
+end
+
+def request(description, request_params = {})
+  default_request = {}
+  example_requests = [default_request]
+  example_requests.concat query_parameters_requests if metadata[:array]
+
+  example_requests.each do |request_metadata|
+    (request_metadata[:description] ||= '').prepend description
+    (request_metadata[:request_params] ||= {}).merge! request_params
+    metadata.merge! request_metadata
+    yield if block_given?
+  end
+end
+
+def request_params
+  example.metadata[:request_params]
+end
+
+def respond_with(expected_status, &block)
+  description = metadata[:description]
+  example description do
+    setup_instances
+    evaluate_request_params!
+    do_request request_params.dup
+    assert_response expected_status, &example.metadata.fetch(:block, block)
+  end
+end
+
+def assert_response(expected_status, &block)
+  assert_status expected_status
+  if block_given? || success? && returns_content?
+    json = JSON response_body
+    assert_attributes json if success?
+    assert_instances json
+    instance_exec(json, &block) if block_given?
+  end
+end
+
+def evaluate_request_params!
+  request_params.each do |name, value|
+    request_params[name] = instance_exec(&value) if value.is_a? Proc
+  end
+end
+
+def success?
+  status < 400
+end
+
+def returns_content?
+  [100, 101, 102, 204, 205, 304].exclude? status
+end
+
+def assert_status(expected_status)
+  expect(status).to be Rack::Utils.status_code(expected_status)
+end
+
+def json_response?
+ response_headers['Content-Type'] == 'application/json; charset=utf-8'
+end

data/lib/rspec-api/attributes_helper.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'rspec_api_documentation/dsl'
+
+def has_attribute(name, type, options = {})
+  (metadata[:attributes] ||= {})[name] = options.merge(type: type)
+end
+
+def assert_attributes(json)
+  expect(json).to be_a (example.metadata[:array] ? Array : Hash)
+  example.metadata[:attributes].each do |name, options|
+    values = Array.wrap(json).map{|item| item[name.to_s]}
+    assert_attribute_types(values, options[:type], options[:can_be_nil])
+  end
+end
+
+def random_values_for_attributes
+  {}.tap do |values|
+    example.metadata[:attributes].each do |name, options|
+      can_be_nil = options[:can_be_nil] && (name != example.metadata[:on])
+      values[name] = random_attribute_value options.merge(can_be_nil: can_be_nil)
+    end
+  end
+end
+
+def random_attribute_value(options)
+  if options[:can_be_nil] && [true, false].sample
+    nil
+  else
+    case options[:type]
+      when :string then [*('a'..'z'), *('A'..'Z')].sample(Random.rand 32).join
+      when :integer then Random.rand(2**16)
+      when :url then "http://example.com/#{SecureRandom.urlsafe_base64}"
+    end
+  end
+end
+
+def assert_attribute_types(values, expected_type, can_be_nil)
+  values.compact! if can_be_nil
+  expect(values).to all_match_type expected_type
+end
+
+def matches_type?(value, type)
+  case type
+    when :url then value =~ URI::regexp
+    else value.is_a? type.to_s.classify.constantize
+  end
+end
+
+RSpec::Matchers.define :all_match_type do |type|
+  match do |values|
+    values.all? {|value| matches_type? value, type}
+  end
+end

data/lib/rspec-api/description_helper.rb

@@ -0,0 +1,55 @@
+def existing(key)
+  metadata[:description_attribute] = 'an existing'
+  -> { instances.any key }
+end
+
+def unknown(key)
+  metadata[:description_attribute] = 'an unknown'
+  -> { instances.none key }
+end
+
+def apply(method_name, options = {})
+  proc = options[:to]
+  -> { proc.call.send method_name }
+end
+
+def with(request_params = {})
+  request_params[:attribute] ||= metadata.delete :description_attribute
+  request description_for(request_params), request_params, &Proc.new
+end
+
+def no_params
+  {}
+end
+
+def valid(request_params)
+  request_params.merge attribute: 'an valid'
+end
+
+def invalid(request_params)
+  request_params.merge attribute: 'an invalid'
+end
+
+def description_for(request_params = {})
+  [description_verb, description_object(request_params)].join ' '
+end
+
+def description_verb
+  case metadata[:method]
+  when :get then 'Getting'
+  when :post then 'Creating'
+  when :put then 'Updating'
+  when :delete then 'Deleting'
+  end
+end
+
+def description_object(request_params = {})
+  attribute = request_params.delete :attribute
+  if metadata[:array]
+    "a list of #{metadata[:resource_name]}".tap do |objects|
+      objects << " by #{request_params.keys.join(', ')}" if request_params.any?
+    end
+  else
+    [attribute, metadata[:resource_name].singularize].join ' '
+  end.downcase
+end

data/lib/rspec-api/dsl.rb

@@ -0,0 +1,8 @@
+require 'rspec_api_documentation'
+require 'rspec_api_documentation/dsl'
+
+require 'rspec-api/accept_helper'
+require 'rspec-api/attributes_helper'
+require 'rspec-api/description_helper'
+require 'rspec-api/api_helper'
+require 'rspec-api/instances_helper'

data/lib/rspec-api/instances_helper.rb

@@ -0,0 +1,37 @@
+def setup_instances
+  instances.create random_values_for_attributes
+  instances.create random_values_for_attributes
+  stub_instances_total_pages example.metadata[:min_pages]
+end
+
+def instances
+  example.metadata[:resource_name].singularize.constantize
+end
+
+def assert_instances(json)
+  expect(json).not_to be_empty
+end
+
+def existing(key)
+  -> { instances.pluck(key).first }
+end
+
+def unknown(key)
+  keys = 0.downto(-Float::INFINITY).lazy
+  -> { keys.reject {|value| instances.exists? key => value}.first }
+end
+
+def apply(method_name, options = {})
+  proc = options[:to]
+  -> { proc.call.send method_name }
+end
+
+def stub_instances_total_pages(total_pages)
+  return unless instances.respond_to?(:page) and total_pages.present?
+  page_method = instances.method :page
+  instances.stub(:page) do |page|
+    page_method.call(page).tap do |proxy|
+      proxy.stub(:total_pages).and_return total_pages
+    end
+  end
+end

data/lib/rspec-api/version.rb

@@ -0,0 +1,3 @@
+module RspecApi
+  VERSION = '0.0.2'
+end

metadata

@@ -1,59 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - claudiob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-28 00:00:00.000000000 Z
+date: 2013-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-api-documentation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Write a gem description
+description: Helpers to write specs for web APIs
 email:
 - claudiob@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE.txt
+- lib/rspec-api/accept_helper.rb
+- lib/rspec-api/api_helper.rb
+- lib/rspec-api/attributes_helper.rb
+- lib/rspec-api/description_helper.rb
+- lib/rspec-api/dsl.rb
+- lib/rspec-api/instances_helper.rb
+- lib/rspec-api/version.rb
+- MIT-LICENSE
 - README.md
-- Rakefile
-- lib/rspec/api.rb
-- lib/rspec/api/version.rb
-- rspec-api.gemspec
-homepage: ''
+homepage: https://github.com/claudiob/rspec-api
 licenses:
 - MIT
 metadata: {}
@@ -65,16 +52,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.0
 signing_key: 
 specification_version: 4
-summary: Write a gem summary
+summary: Extends rspec_api_documentation with methods to write more compact and meaningful,
+  auto-documented specs for web APIs.
 test_files: []
+has_rdoc: 

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rspec-api.gemspec
-gemspec

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/lib/rspec/api.rb

@@ -1,7 +0,0 @@
-require "rspec/api/version"
-
-module Rspec
-  module Api
-    # Your code goes here...
-  end
-end

data/lib/rspec/api/version.rb

@@ -1,5 +0,0 @@
-module Rspec
-  module Api
-    VERSION = "0.0.1"
-  end
-end

data/rspec-api.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rspec/api/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "rspec-api"
-  spec.version       = Rspec::Api::VERSION
-  spec.authors       = ["claudiob"]
-  spec.email         = ["claudiob@gmail.com"]
-  spec.description   = %q{Write a gem description}
-  spec.summary       = %q{Write a gem summary}
-  spec.homepage      = ""
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-end