spaceborne 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7e3361faaa6b37ac545afafdf24df2e6b918f62
+  data.tar.gz: 8d68d8cb74c1623e35d48fd95a233b112e7a3d7a
+SHA512:
+  metadata.gz: 1cb4c4fb2fa7f220101dddfce7a1081b5af2c5001cf2a72101cdab49d1b9f4240bc1aa743f08802c3cd61acfeaa057590e9fc5c86de0ba36067446b512eaddcb
+  data.tar.gz: b53ca43bbe086026693037ca45ce914eece1b29ff064566af1fedfc6ba035f815fc621d47bacd28af2e8b8b0594e18094ae5baa98efcd623a54cca2d0fd271d9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Keith Williams
+
+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,64 @@
+# Spaceborne
+
+Welcome to spaceborne. Your new tool for testing of RESTful APIs. This builds on the great work of brooklyn/airborne, which I think is very useful, but has some major shortcomings. It also leverages curlyrest which allows easily adding a header parameter to an API request, and causes the request to be processed/exposed as a curl command.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spaceborne'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spaceborne
+
+## Creating API tests
+
+```ruby
+require 'spaceborne'
+
+describe 'sample spec' do
+  it 'should validate types' do
+    wrap_request do
+      get 'http://example.com/api/v1/simple_get' #json api that returns { "name" : "John Doe" }
+      expect_json_types(name: :string)
+    end
+  end
+
+  it 'should validate values' do
+    wrap_request do
+      get 'http://example.com/api/v1/simple_get' #json api that returns { "name" : "John Doe" }
+      expect_json(name: 'John Doe')
+    end
+  end
+end
+```
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Extensions to Airborne
+
+1. Uses curlyrest to allow extension of rest-client with curl requests
+2. Bundles groups of expectations so that if any fail, you will actually see the request and response printed out, rather than just seeing the expectation that failed
+3. json_body is only calculated once after request rather than on each call
+4. Expectations for headers use the same form as the expectations for json bodies
+  * `expect_header same arguments/handling as expect_json`
+  * `expect_header_types same arguments/handling as expect_json_types`
+5. Expectations returning a hash with keys that are unknown, but that have a defined structure are supported
+6. It is possible to use non-json data in a request
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/keithrw54/spaceborne.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/spaceborne.rb

@@ -0,0 +1,127 @@
+require "spaceborne/version"
+require 'rest-client'
+require 'byebug'
+require 'json'
+
+module Spaceborne
+  def wrap_request(&block)
+    block.call
+  rescue Exception => e
+    puts "REQUEST: #{response.request.method.upcase} #{response.request.url}"
+    puts "  HEADERS:\n#{JSON::pretty_generate(response.request.headers)}" 
+    puts "  PAYLOAD:\n#{response.request.payload}" if response.request.payload
+    puts "RESPONSE: #{response.code}"
+    puts "  HEADERS:\n#{JSON::pretty_generate(response.headers)}"
+    is_json = response.headers[:content_type].include?('application/json')
+    puts "  JSON_BODY\n#{JSON::pretty_generate(json_body)}" if is_json
+    puts "  BODY\n#{response.body}" unless is_json
+    raise e
+  end
+end
+
+module Airborne
+  def json_body
+    @json_body ||= JSON.parse(response.body, symbolize_names: true)
+  rescue 
+    fail InvalidJsonError, 'Api request returned invalid json'
+  end
+  module RestClientRequester
+    def make_request(method, url, options = {})
+      @json_body = nil
+      headers = base_headers.merge(options[:headers] || {})
+      res = if method == :post || method == :patch || method == :put
+        begin
+          request_body = options[:body].nil? ? '' : options[:body]
+          request_body = request_body.to_json if options[:body].is_a?(Hash)
+          RestClient.send(method, get_url(url), request_body, headers)
+        rescue RestClient::Exception => e
+          e.response
+        end
+      else
+        begin
+          RestClient.send(method, get_url(url), headers)
+        rescue RestClient::Exception => e
+          e.response
+        end
+      end
+      res
+    end
+  end
+  module RequestExpectations
+    def call_with_relative_path(data, args)
+      if args.length == 2
+        get_by_path(args[0], data) do |json_chunk|
+          yield(args[1], json_chunk)
+        end
+      else
+        yield(args[0], data)
+      end
+    end
+
+    def expect_json_types(*args)
+      call_with_relative_path(json_body, args) do |param, body|
+        expect_json_types_impl(param, body)
+      end
+    end
+
+    def expect_json(*args)
+      call_with_relative_path(json_body, args) do |param, body|
+        expect_json_impl(param, body)
+      end
+    end
+
+    def expect_header_types(*args)
+      call_with_relative_path(response.headers, args) do |param, body|
+        expect_json_types_impl(param, body)
+      end
+    end
+
+    def expect_header(*args)
+      call_with_relative_path(response.headers, args) do |param, body|
+        expect_json_impl(param, body)
+      end
+    end
+  end
+
+  module PathMatcher
+    def get_by_path(path, json, &block)
+      fail PathError, "Invalid Path, contains '..'" if /\.\./ =~ path
+      type = false
+      parts = path.split('.')
+      parts.each_with_index do |part, index|
+        if part == '*' || part == '?'
+          ensure_array_or_hash(path, json)
+          type = part
+          if index < parts.length.pred
+            walk_with_path(type, index, path, parts, json, &block) && return
+          end
+          next
+        end
+        begin
+          json = process_json(part, json)
+        rescue
+          raise PathError, "Expected #{json.class}\nto be an object with property #{part}"
+        end
+      end
+      if type == '*'
+        case json.class.name
+        when 'Array'
+          expect_all(json, &block)
+        when 'Hash'
+          json.each do |k,v|
+            yield json[k]
+          end
+        end
+      elsif type == '?'
+        expect_one(path, json, &block)
+      else
+        yield json
+      end
+    end
+
+    def ensure_array_or_hash(path, json)
+      fail RSpec::Expectations::ExpectationNotMetError, "Expected #{path} to be array or hash, got #{json.class} from JSON response" unless
+        json.class == Array || json.class == Hash
+    end
+  end
+end

data/lib/spaceborne/version.rb

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

data/spaceborne.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spaceborne/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spaceborne"
+  spec.version       = Spaceborne::VERSION
+  spec.authors       = ["Keith Williams"]
+  spec.email         = ["keithrw@comcast.net"]
+
+  spec.summary       = 'Gem supporting API testing'
+  spec.description   = 'Extends brooklynDev/airborne'
+  spec.homepage      = "https://github.com/keithrw54/spaceborne.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rest-client", "~> 2.0"
+  spec.add_development_dependency "byebug", "~> 2.0"
+  spec.add_development_dependency "airborne", "~> 0.2.13"
+  spec.add_development_dependency "curlyrest", "~> 0.1.0"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: spaceborne
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keith Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: airborne
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.13
+- !ruby/object:Gem::Dependency
+  name: curlyrest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Extends brooklynDev/airborne
+email:
+- keithrw@comcast.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spaceborne.rb
+- lib/spaceborne/version.rb
+- spaceborne.gemspec
+homepage: https://github.com/keithrw54/spaceborne.git
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Gem supporting API testing
+test_files: []