http-test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79768f0376dc837f5e788e57d82c9231da3e4183
+  data.tar.gz: 9cce9c94af55413c8c38309d967f872ffe19085f
+SHA512:
+  metadata.gz: e6354d69fbef44b0e24be44d5dba140149dc5549805b49d5d05f88bc8f3d9be0fd2dc21d04942cd87cae77123ac0ba071c8ceb53200bca569e1e588c01bc093d
+  data.tar.gz: 329e2cdf4250dbf4d4b570bda2716a9eb50903fb6bf94845c632e6ac69a52e2034484e7d0f1daaeb1a5dd8198a22ba63b967eabd2f3c323681bea8abe04ef27b

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 eno
+
+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,72 @@
+# Http::Test
+
+The `http-test` ruby gem lets you define HTTP API tests in ruby code. Note that the server can be 
+implemented any way you want, as long as it is either available on a proper URL, or can be started
+in non-daemonized mode with a single command.
+
+## Running HTTP tests against a remove server
+
+    require_relative "./test_helper"
+
+    class RemoteHttpTest < HttpTest::TestCase
+      url_base "http://jsonplaceholder.typicode.com"
+
+      def test_get
+        GET "/posts/1"
+        assert_equal(200, response.status)
+        assert_equal(1, response["userId"])
+      end
+
+      def test_head
+        HEAD "/posts/1"
+        assert_equal(200, response.status)
+        assert(response.body.empty?)
+      end
+
+      def test_post
+        POST "/posts", title: "test title", body: "test body"
+        assert_equal(201, response.status)
+        assert_equal("test title", response["title"])
+      end
+
+      def test_put
+        PUT "/posts/1", title: "new title"
+        assert_equal(200, response.status)
+      end
+
+      def test_delete
+        DELETE "/posts/1"
+        assert_equal(200, response.status)
+      end
+    end
+
+## Running HTTP tests against a local server
+
+test-http can also be used to run tests against a local test server. For this, the
+you must define a command to start the server. For this mode you must define a command
+to start the server in a non-daemonized mode.
+
+    class LocalHttpTest < HttpTest::TestCase
+      test_server "#{File.dirname(__FILE__)}/local-http"
+      ...
+    end
+
+**Limitations:**
+
+- The command should read the PORT to listen on from the "PORT" environment value.
+- Currently the only supported port is 4444. Expect this to change to a randomized port number.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/radiospiel/http-test.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new :test do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "http/test"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/http-test.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http-test/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "http-test"
+  spec.version       = HttpTest::VERSION
+  spec.authors       = ["eno"]
+  spec.email         = ["eno@open-lab.org"]
+
+  spec.summary       = "Simple to use HTTP API tests"
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.11"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", "~> 3.2"
+end

data/lib/http-test.rb

@@ -0,0 +1,35 @@
+require "test-unit"
+require "forwardable"
+
+module HttpTest
+  PORT = 4444
+
+  def self.url_base(url_base = nil)
+    @url_base = url_base if url_base
+    return @url_base if @url_base
+    STDERR.puts <<-MSG
+Either define a API endpoint via url_base <url>, or define a command to start a test_server via test_server "command"'
+    MSG
+    exit 1
+  end
+
+  def self.test_server(command)
+    Server.start!(command)
+    url_base "http://localhost:#{PORT}"
+  end
+
+  module TestUnitAdapter
+    extend Forwardable
+
+    delegate url_base: HttpTest
+    delegate test_server: HttpTest
+  end
+end
+
+require_relative "http-test/http_methods"
+require_relative "http-test/server"
+
+class HttpTest::TestCase < Test::Unit::TestCase
+  include HttpTest::HttpMethods # include HTTP helper methods, like GET, PUT etc.
+  extend HttpTest::TestUnitAdapter
+end

data/lib/http-test/http_methods.rb

@@ -0,0 +1,79 @@
+require "faraday"
+
+require "net/http"
+require "json"
+
+# :status - HTTP response status code, such as 200
+# :body   - the response body
+# :response_headers
+#
+#
+module HttpTest::HttpMethods
+  module Response
+    module FaradayHelper
+      attr_accessor :faraday_response
+
+      extend Forwardable
+      delegate [:status, :body, :headers] => :faraday_response
+
+      alias code status
+    end
+
+    class BlankResponse
+      include FaradayHelper
+
+      def initialize(faraday_response)
+        self.faraday_response = faraday_response
+      end
+    end
+
+    def self.create(faraday_response)
+      body, headers = faraday_response.body, faraday_response.headers
+      return BlankResponse.new(faraday_response) unless body && body.length > 0
+
+      response = case content_type = headers["content-type"]
+      when /\Aapplication\/json/ then JSON.parse faraday_response.body
+      when /\Atext\//            then faraday_response.body
+      else                            raise "unsupported content_type: #{content_type.inspect}"
+      end
+
+      response.extend FaradayHelper
+      response.faraday_response = faraday_response
+      response
+    end
+  end
+
+  def url(path)
+    return path if path =~ /\Ahttp(s)?:/
+
+    File.join(HttpTest.url_base, path)
+  end
+
+  # rubocop:disable Style/MethodName
+  def HEAD(path)
+    @response = Response.create Faraday.head(url(path))
+  end
+
+  def GET(path)
+    @response = Response.create Faraday.get(url(path))
+  end
+
+  def POST(path, body = {})
+    @response = Response.create Faraday.post(url(path), body)
+  end
+
+  def PUT(path, body = {})
+    @response = Response.create Faraday.put(url(path), body)
+  end
+
+  def DELETE(path)
+    @response = Response.create Faraday.delete(url(path))
+  end
+
+  attr_reader :response
+
+  def asset_redirect_to(url)
+    assert_equal(302, response.code)
+    assert_equal(url, response.headers["location"])
+  end
+end

data/lib/http-test/server.rb

@@ -0,0 +1,62 @@
+require "socket"
+require "timeout"
+
+module HttpTest::Server
+  extend self
+
+  PORT = HttpTest::PORT
+
+  def available!(timeout = 0.1)
+    s = nil
+    Timeout.timeout(timeout) do
+      STDERR.print "."
+      s = TCPSocket.new("127.0.0.1", PORT)
+    end
+
+    STDERR.puts "[http-test] test server became available on http://127.0.0.1:#{PORT}"
+  ensure
+    s&.close
+  end
+
+  def available?(timeout = 0.1)
+    available!(timeout)
+    true
+  rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Timeout::Error
+    false
+  end
+
+  def wait_for_port(timeout = 10)
+    (timeout / 0.1).to_i.times do
+      return true if available?(PORT)
+      sleep(0.1)
+    end
+
+    available!
+  end
+
+  def started?
+    @started ? true : false
+  end
+
+  def start!(command)
+    return if started?
+
+    pid = fork do
+      # Signal.trap("HUP") { STDERR.puts "Exiting web server"; exit }
+      # # ... do some work ...
+      ENV["RACK_ENV"] = "test"
+      ENV["PORT"] = PORT.to_s
+
+      STDERR.puts "[http-test] Trying to start test server via '#{command}'"
+      exec command
+    end
+
+    at_exit do
+      Process.kill("TERM", pid)
+      Process.wait
+    end
+
+    wait_for_port
+    @started = true
+  end
+end

data/lib/http-test/version.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: http-test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- eno
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- eno@open-lab.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- http-test.gemspec
+- lib/http-test.rb
+- lib/http-test/http_methods.rb
+- lib/http-test/server.rb
+- lib/http-test/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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple to use HTTP API tests
+test_files: []