rspec-api-requests 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56121c96b1439ce85f3e8e8b31dda28b4c09f296
+  data.tar.gz: 59188cc6915288d1105851a14f5733e456a79e07
+SHA512:
+  metadata.gz: b7c4402a820271a69898767bf48d56e31b6d26d7b81bf34f0d9c466f3963bc4b421250673dec31671a0dee6530d814ec8edf46d788762b6a9d2619ffa7af492a
+  data.tar.gz: e02f853e29ed5db826ed8fb73012a73db40414890265da21deadd382d4a0af1cc3986b0c4696e4efc13059abadf94ea77e6a5313b4e99583ef3bf8f051619f1d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 claudiob
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,181 @@
+RSpec API Requests
+==================
+
+RSpecApi::Requests lets you make requests to web APIs and verify their expectations:
+
+    params = {host: 'http://api.example.com', route: '/concerts', attributes: {where: {type: :string}}
+
+    describe 'GET /concerts', rspec_api_params: params do
+      respond_with :ok
+    end
+
+More documentation and examples about RSpecApi are available at [http://rspec-api.github.io](http://rspec-api.github.io)
+
+[![Build Status](https://travis-ci.org/rspec-api/rspec-api-requests.png?branch=master)](https://travis-ci.org/rspec-api/rspec-api-requests)
+[![Code Climate](https://codeclimate.com/github/rspec-api/rspec-api-requests.png)](https://codeclimate.com/github/rspec-api/rspec-api-requests)
+[![Coverage Status](https://coveralls.io/repos/rspec-api/rspec-api-requests/badge.png)](https://coveralls.io/r/rspec-api/rspec-api-requests)
+[![Dependency Status](https://gemnasium.com/rspec-api/rspec-api-requests.png)](https://gemnasium.com/rspec-api/rspec-api-requests)
+
+
+Basic example
+-------------
+
+    # 1. Specify how to connect to the API and what to expect:
+    gists_params = {
+      host: 'https://api.github.com',
+      action: 'get',
+      authorize_with: {token: YOUR-GITHUB-TOKEN-HERE},
+      route: '/gists',
+      collection: true,
+      attributes: {url: {type: {string: :url}}},
+      extra_requests: [{
+        expect: {filter: {by: :updated_at, compare_with: :>=, value: '2012-10-10T00:00:00Z'}},
+        params: {since: '2012-10-10T00:00:00Z'}
+      }]
+    }
+
+    # 2. Use `respond_to` to send the request and verify the expectations
+    describe 'GitHub Gists', rspec_api_params: gists_params do
+      respond_with :ok
+    end
+
+Running the example above returns the following successful output:
+
+    Examples from GitHub API
+      GitHub Gists
+        GET /gists with {:since=>"2012-10-10T00:00:00Z"}
+          responds with a body that
+            should be a collection
+            should have attributes {:url=>{:type=>{:string=>:url}}}
+            should be filtered by updated_at>=2012-10-10T00:00:00Z
+          responds with a status code that
+            should be 200
+        GET /gists
+          responds with a body that
+            should have attributes {:url=>{:type=>{:string=>:url}}}
+            should be a collection
+          responds with a status code that
+            should be 200
+
+    Finished in 0.01056 seconds
+    7 examples, 0 failures
+
+Note that, in order run the example, above, you need to replace
+`YOUR-GITHUB-TOKEN-HERE` with your [GitHub Personal Access Token](https://github.com/settings/applications).
+
+
+Available request options
+=========================
+
+RSpecApi::Requests makes available one method `respond_to`, which sends the
+request to the API and verify the expectations specified using RSpec metadata
+`rspec_api_params` in the surrounding `describe` block, as shown above.
+The following are the valid request options for `rspec_api_params`.
+
+:host and :adapter (*either one or the other is required*)
+----------------------------------------------------------
+
+Respectively the URL where the API is hosted and the adapter to connect to it.
+By default, RSpecApi::Requests uses `Net::HTTP`, e.g:
+
+    host: 'http://example.com' # => connect via Net::HTTP
+
+This behavior can be overridden specifying a different adapter:
+
+    adapter: [:rack, app] # => connect via Rack::Test to a local Rack app
+
+Therefore, RSpecApi::Requests can be used both to send requests to **remote**
+and to **local** web API, making API development easier.
+
+:route (*required*)
+-------------------
+
+The API route to access a resource, e.g.:
+
+    host: 'http://example.com', route: '/concerts'
+    # => connect to 'http://example.com/concerts'
+
+:action (*required*)
+--------------------
+
+The HTTP method to access a resource, e.g.:
+
+    action: :delete, route: '/concerts'
+    # => sends 'DELETE /concerts'
+
+:authorize_with (*optional*)
+----------------------------
+
+The HTTP authentication payload to send with the request, e.g.:
+
+    authorize_with: {token: 'foo'}
+    # => sends [:token, 'foo'] as the HTTP authentication
+
+
+Available expectations
+======================
+
+The following are the valid expectations for `rspec_api_params`.
+
+:collection (*optional*)
+------------------------
+
+Whether the response body will include a *single* JSON object
+(`collection: false`) or a *collection* of objects (`collection: true`), e.g.:
+
+    action: :get, route: '/concerts', collection: true
+    # => expect `GET /concerts' to return a collection
+
+    action: :get, route: '/concerts/1', collection: false
+    # => expect `GET /concerts/1' to return an object
+
+:attributes (*optional*)
+------------------------
+
+Which attributes the JSON object or collection in the response body will contain, e.g.:
+
+    action: :get, route: '/concerts/1', attributes: {url: {type: {string: :url}}}
+    # => expect `GET /concerts/1' to return an object with a 'url' field
+    #    that should contain a URL-formatted string
+
+Extra requests
+==============
+
+The last option of `rspec_api_params` allows to send multiple API requests:
+
+:extra_requests (*optional*)
+----------------------------
+
+Which extra requests should be sent and what to expect from them, e.g.:
+
+    action: :get, route: '/concerts', extra_requests: [{
+      expect: {filter: {by: :created_at, compare_with: :>=, value: '2012-10-10T00:00:00Z'}},
+      params: {since: '2012-10-10T00:00:00Z'}
+    }]
+    # => expect `GET /concerts/1?since=2012-10-10T00:00:00Z' to only return
+    #    concerts created after October 10th, 2012.
+
+
+How to install
+==============
+
+To install on your system, run `gem install rspec-api-requests`.
+To use inside a bundled Ruby project, add this line to the Gemfile:
+
+    gem 'rspec-api-requests', '~> 0.7.0'
+
+The rspec-api-requests gem follows [Semantic Versioning](http://semver.org).
+Any new release that is fully backward-compatible bumps the *patch* version (0.0.x).
+Any new version that breaks compatibility bumps the *minor* version (0.x.0)
+
+Indicating the full version in your Gemfile (*major*.*minor*.*patch*) guarantees
+that your project won’t occur in any error when you `bundle update` and a new
+version of RSpecApi::Requests is released.
+
+
+How to contribute
+=================
+
+Don’t hesitate to send me code comments, issues or pull requests through GitHub!
+
+All feedback is appreciated. Thanks :)

data/lib/rspec-api-requests.rb

@@ -0,0 +1 @@
+require 'rspec-api/requests'

data/lib/rspec-api/http_client.rb

@@ -0,0 +1,21 @@
+require 'active_support/core_ext/object/blank'
+require 'faraday'
+require 'faraday_middleware' # TODO: use autoload, we only need EncodeJson
+
+module RSpecApi
+  module HttpClient
+    def send_request(options = {})
+      conn = Faraday.new options[:host] do |c|
+        c.use FaradayMiddleware::EncodeJson
+        c.adapter *(options.fetch :adapter, [:net_http])
+      end
+      conn.headers[:user_agent] = 'RSpec API'
+      conn.headers[:accept] = 'application/json'
+      conn.authorization *options[:authorize_with].flatten if options[:authorize_with]
+      sleep options[:throttle] if options[:throttle]
+      conn.send *options.values_at(:action, :route, :body)
+    rescue Faraday::Error::ConnectionFailed => e
+      pending "Could not connect: #{e}"
+    end
+  end
+end

data/lib/rspec-api/requests.rb

@@ -0,0 +1,31 @@
+require 'rspec/core'
+require 'rspec-api/respond_with'
+
+module RSpecApi
+  # Provides the `respond_with` method to RSpec Example groups, useful to
+  # make requests to web APIs and verify their expectations:
+  #
+  # To have these matchers available inside of an RSpec `describe` block,
+  # include that block inside a block with the `:rspec_api` metadata, or
+  # explicitly include the RSpecApi::Requests module.
+  #
+  # @example Tag a `describe` block as `:rspec_api`:
+  #   describe "Artists", rspec_api: true do
+  #     describe 'GET /artists', rspec_api_requests: {...}
+  #       ... # here you can write `respond_with :ok`
+  #     end
+  #   end
+  #
+  # @example Explicitly include the RSpecApi::Responses module
+  #   describe "Artists" do
+  #     include RSpecApi::Requests
+  #     describe 'GET /artists', rspec_api_requests: {...}
+  #       ... # here you can write `respond_with :ok`
+  #     end
+  #   end
+  module Requests
+    include RespondWith
+  end
+end
+
+RSpec.configuration.extend RSpecApi::Requests, rspec_api: true

data/lib/rspec-api/requests/pending.rb

@@ -0,0 +1,15 @@
+module RSpecApi
+  module Requests
+    module Pending
+      def pending_request
+        it {
+          pending <<-EOF
+            To use respond_with, specify the parameters for the request and
+            the expectations in the :rspec_api_params example metadata,
+            indicating the action, the route, and either host or adapter.
+          EOF
+        }
+      end
+    end
+  end
+end

data/lib/rspec-api/requests/valid.rb

@@ -0,0 +1,16 @@
+require 'rspec-api/http_client'
+require 'rspec-api/expectations'
+
+module RSpecApi
+  module Requests
+    module Valid
+      include RSpecApi::HttpClient
+      include RSpecApi::Expectations
+
+      def valid_request(request = {}, expectations = {}, prefix_params = {}, &block)
+        response = send_request request
+        expect_response response, expectations, prefix_params, &block
+      end
+    end
+  end
+end

data/lib/rspec-api/requests/version.rb

@@ -0,0 +1,5 @@
+module RSpecApi
+  module Requests
+    VERSION = '0.7.0'
+  end
+end

data/lib/rspec-api/respond_with.rb

@@ -0,0 +1,41 @@
+require 'rspec-api/respond_with/metadata'
+require 'rspec-api/respond_with/valid'
+require 'rspec-api/respond_with/request'
+
+module RSpecApi
+  module RespondWith
+    include Metadata
+    include Valid
+    include Request
+
+    def respond_with(status, values = {}, &block)
+      request_params = build_request_params
+      result = request status, request_params, values, &block
+
+      extra_requests(request_params).map do |extra_request|
+        body = values.merge extra_request.fetch(:params, {})
+        params = request_params.merge extra_request.fetch(:expect, {})
+        result = [*result] << request(status, params, body, &block)
+      end
+
+      result
+    end
+
+  private
+
+    def build_request_params
+      rspec_api_params.dup.tap do |params|
+        params[:route] = params[:route].dup if params[:route]
+        params[:extra] = {}
+      end
+    end
+
+    def extra_requests(params = {})
+      if valid?(params) && params[:collection]
+        params.fetch :extra_requests, {}
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/rspec-api/respond_with/metadata.rb

@@ -0,0 +1,9 @@
+module RSpecApi
+  module RespondWith
+    module Metadata
+      def rspec_api_params
+        metadata.fetch :rspec_api_params, {}
+      end
+    end
+  end
+end

data/lib/rspec-api/respond_with/request.rb

@@ -0,0 +1,61 @@
+require 'rspec-api/respond_with/valid'
+require 'rspec-api/requests/valid'
+require 'rspec-api/requests/pending'
+
+module RSpecApi
+  module RespondWith
+    module Request
+      include Valid
+
+      def request(status, params = {}, values = {}, &block)
+        valid = valid? params
+        expectations = expectations_for status, params
+        request, prefix_params = request_for params, values
+
+        describe description_for(request) do
+          if valid
+            extend RSpecApi::Requests::Valid
+            valid_request request, expectations, prefix_params, &block
+          else
+            extend RSpecApi::Requests::Pending
+            pending_request
+          end
+        end
+      end
+
+    private
+
+      def request_for(params, values)
+        keys = [:host, :action, :adapter, :authorize_with, :throttle]
+        route, body, extra = interpolate params[:route], values, params[:extra]
+        [params.slice(*keys).merge(route: route, body: body), params[:extra]]
+      end
+
+      def expectations_for(status, params)
+        keys = [:collection, :attributes, :sort, :filter, :page_links, :callback]
+        params.slice(*keys).delete_if{|k, v| v.blank?}.tap do |expectations|
+          expectations[:status] = status
+        end
+      end
+
+      def description_for(opts = {})
+        "#{opts.fetch(:action, '').upcase} #{opts[:route]}".tap do |desc|
+          desc << " with #{opts[:body]}" if opts.fetch(:body, {}).any?
+        end
+      end
+
+      def interpolate(route, values = {}, extra = {})
+        [route, values, extra].tap do |route, values, extra|
+          route = route.tap do |route|
+            values.keys.each do |param|
+              values.delete(param).tap do |value|
+                route.gsub! "/:#{param}", "/#{value}"
+                extra[param] = value
+              end if route.match "/:#{param}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec-api/respond_with/valid.rb

@@ -0,0 +1,9 @@
+module RSpecApi
+  module RespondWith
+    module Valid
+      def valid?(opts = {})
+        opts.any? && opts.key?(:route) && opts.key?(:action) && (opts.key?(:host) || opts.key?(:adapter))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: rspec-api-requests
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- claudiob
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-api-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- claudiob@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec-api/http_client.rb
+- lib/rspec-api/requests/pending.rb
+- lib/rspec-api/requests/valid.rb
+- lib/rspec-api/requests/version.rb
+- lib/rspec-api/requests.rb
+- lib/rspec-api/respond_with/metadata.rb
+- lib/rspec-api/respond_with/request.rb
+- lib/rspec-api/respond_with/valid.rb
+- lib/rspec-api/respond_with.rb
+- lib/rspec-api-requests.rb
+- MIT-LICENSE
+- README.md
+homepage: https://github.com/rspec-api/rspec-api-requests
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []