api-spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13025c2c8d737b6ef9f3fcd35f0b91ea56497bfa
+  data.tar.gz: 01e12492405ea6e734df32921e6596ad442fa8a7
+SHA512:
+  metadata.gz: 1d154d6490b635275889107a5a8cbad347c01e64cc1097500af754bb6b9b3ad0f5e98c05586eba0983c13cafeb5a086774772585537ac6644e8f161c759406a0
+  data.tar.gz: 4722389b44a3a729758f0e31a47b16e2c3b48d6619f5e20c3fe913072c3fba8630e8f1f5814683eb5c958716348664c1d4cc6f900ed96077f2ada2f6b4a1eb70

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bruz Marzolf
+
+MIT License
+
+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,31 @@
+# API Spec
+
+Cucumber steps to make it easier to build API tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api-spec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api-spec
+
+## Usage
+
+TODO 
+
+## Contributing
+
+1. Fork it ( https://github.com/CXInc/api-spec/fork )
+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 a new Pull Request

data/Rakefile

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

data/api-spec.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api-spec"
+  spec.version       = ApiSpec::VERSION
+  spec.authors       = ["Bruz Marzolf"]
+  spec.email         = ["bruz@bruzilla.com"]
+  spec.summary       = %q{Helpers for writing cucumber API tests.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "rest-client", "~> 1.7"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/api-spec.rb

@@ -0,0 +1 @@
+require "api_spec"

data/lib/api_spec/cucumber.rb

@@ -0,0 +1,65 @@
+require "json_spec/cucumber"
+
+require_relative "../api_spec"
+
+World(ApiSpec::Helpers)
+
+Before do |scenario|
+  $test_name = scenario.name.downcase.gsub(" ", "_")
+  ApiSpec::State.reset
+end
+
+# For json_spec
+def last_json
+  @response.body
+end
+
+When(/^I GET "(.*?)"$/) do |path|
+  parameters = ApiSpec::Parameters.new(:get, path)
+  @response = RestClient.get parameters.url, test_headers
+  puts "@response = #{@response}"
+end
+
+When(/^I GET "(.*?)" with:$/) do |path, table|
+  make_request(:get, path, table)
+end
+
+When(/^I DELETE "(.*?)" with:$/) do |path, table|
+  make_request(:delete, path, table)
+end
+
+Then(/^the status code is (\d+)$/) do |code|
+  @response.code.to_s.should == code
+end
+
+Then(/^the Content\-Type is (.*)$/) do |content_type|
+  unless @response.respond_to?(:headers)
+    fail "Headers are not available on 4XX and 5XX responses"
+  end
+
+  @response.headers[:content_type].should match(content_type)
+end
+
+Then(/^the response contains an authentication cookie$/) do
+  @response.headers[:set_cookie].first.should match(/x-cx-auth/)
+end
+
+When(/^I POST to "(.*?)" with:$/) do |path, table|
+  make_request(:post, path, table)
+end
+
+When(/^I PUT to "(.*?)" with:$/) do |path, table|
+  make_request(:put, path, table)
+end
+
+Then(/^the JSON response at "(.*?)" should be variable "(.*?)"$/) do |path, key|
+  step "the JSON response at \"#{path}\" should be \"#{ ApiSpec::State.get(key) }\""
+end
+
+Then(/^the JSON response at "(.*?)" should include keys:$/) do |base_path, table|
+  table.hashes.each do |hash|
+    path = "#{ base_path }/#{ hash[:key] }"
+    value = hash[:value]
+    step "the JSON response at \"#{ path }\" should be #{ value }"
+  end
+end

data/lib/api_spec/helpers.rb

@@ -0,0 +1,45 @@
+require "rest-client"
+
+module ApiSpec
+  class ErrorResponse < Struct.new(:code, :body)
+  end
+
+  module Helpers
+    extend self
+
+    def test_headers
+      {"X-Test-Name" => $test_name}
+    end
+
+    def make_request(method, path, table)
+      parameters = ApiSpec::Parameters.new(method, path, table)
+      headers = parameters.headers.merge(test_headers)
+
+      begin
+        case method
+        when :get
+          @response = RestClient.get parameters.url,
+            headers.merge(params: parameters.query)
+        when :post
+          @response = RestClient.post parameters.url, parameters.body,
+            headers.merge(content_type: :json)
+        when :put
+          @response = RestClient.put parameters.url, parameters.body,
+            headers.merge(content_type: :json)
+        when :delete
+          @response = RestClient.delete parameters.url,
+            headers
+        else
+          fail "Unsupported method: #{method}"
+        end
+
+        if ENV["API_SPEC_DEBUG"]
+          puts "@response = #{@response}"
+        end
+      rescue RestClient::Exception => e
+        @response = ErrorResponse.new(e.http_code, e.http_body)
+        puts "Error response body: #{ @response.body }"
+      end
+    end
+  end
+end

data/lib/api_spec/parameters.rb

@@ -0,0 +1,115 @@
+module ApiSpec
+  class Parameters
+    attr_reader :query
+
+    def initialize(method, path, table = nil)
+      @method = method
+      @path = path
+
+      @path_params = {}
+      @query = {}
+      @form = {}
+      @json = {}
+      @cookie = {}
+      @header = {}
+
+      load_table(table) if table
+    end
+
+    def url
+      interpolated_path = @path.scan(/\{(.*?)\}/).reduce(@path) do |path, match|
+        key = match.first
+        value = @path_params[key]
+
+        raise StandardError.new("Missing #{key}") unless value
+
+        path.gsub /\{#{key}\}/, URI.encode(value)
+      end
+
+      "http://localhost:#{$port}#{interpolated_path}"
+    end
+
+    def method_missing(name)
+      State.get(name)
+    end
+
+    def body
+      if @json.any?
+        @json.to_json
+      elsif @form.any?
+        @form
+      else
+        ""
+      end
+    end
+
+    def headers
+      @header.merge(cookie_header)
+    end
+
+    def cookie_header
+      string = @cookie
+        .map { |key, value| "#{key}=#{value}" }
+        .join("; ")
+
+      { "Cookie" => string }
+    end
+
+    private
+
+    def load_table(table)
+      table.hashes.each do |hash|
+        matches = hash[:value].match(/\{(.*)\}/)
+        key = hash["parameter name"]
+
+        value = if matches
+          method = matches[1]
+          hash[:value].gsub(/\{#{method}\}/, send(method).to_s)
+        else
+          hash[:value]
+        end
+
+        set_param(hash["parameter type"], key, value)
+      end
+    end
+
+    def set_param(type, key, value)
+      case type
+      when "path"
+        @path_params[key] = value
+      when "query"
+        @query[key] = value
+      when "json"
+        parts = key.split("/")
+
+        hash = parts.reverse.reduce(nil) do |acc, part|
+          if part.match(/\d+/)
+            [acc || json_value(value)]
+          else
+            if acc
+              {part => acc}
+            else
+              {part => json_value(value)}
+            end
+          end
+        end
+
+        @json.merge!(hash)
+      when "form"
+        @form[key] = value
+      when "cookie"
+        @cookie[key] = value
+      when "header"
+        @header[key] = value
+      else
+        fail "Unrecognized parameter type: #{type}"
+      end
+    end
+
+    def json_value(value_string)
+      JSON.parse("{\"value\":#{value_string}}")["value"]
+    rescue JSON::ParserError
+      value_string
+    end
+  end
+end

data/lib/api_spec/state.rb

@@ -0,0 +1,23 @@
+module ApiSpec
+  class State
+    class << self
+      def set(key, value)
+        state[key.to_sym] = value
+      end
+
+      def get(key)
+        state[key.to_sym]
+      end
+
+      def reset
+        @state = {}
+      end
+
+      private
+
+      def state
+        @state ||= {}
+      end
+    end
+  end
+end

data/lib/api_spec/version.rb

@@ -0,0 +1,3 @@
+module ApiSpec
+  VERSION = "0.1.0"
+end

data/lib/api_spec.rb

@@ -0,0 +1,8 @@
+module ApiSpec
+end
+
+require_relative "api_spec/helpers"
+require_relative "api_spec/parameters"
+require_relative "api_spec/state"
+require_relative "api_spec/version"
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: api-spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruz Marzolf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- bruz@bruzilla.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-spec.gemspec
+- lib/api-spec.rb
+- lib/api_spec.rb
+- lib/api_spec/cucumber.rb
+- lib/api_spec/helpers.rb
+- lib/api_spec/parameters.rb
+- lib/api_spec/state.rb
+- lib/api_spec/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Helpers for writing cucumber API tests.
+test_files: []