httpspec_simple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5514ba53d9108406aac1f80530b6926bddbedb58
+  data.tar.gz: 273a467cd18a9e54e10dd80266202167ab9a2889
+SHA512:
+  metadata.gz: 1120cc25e2addd35c536fb37f60936538193b4cda2bfedff8c35abcbe76a1e056ca6db2814ccf225df11dcebda2ac2c0e51fbfd176aec693059d14f80ed16e34
+  data.tar.gz: 71bc7074b5b87acf5a1c687ef923898c9e14449fd07d9ab068725766b68ddfb9a753fffd38708f2a5f2dda4e150bdabb8d6a3aa6be13b6b66f01571e64359f23

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Koji NAKAMURA
+
+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,39 @@
+# HttpspecSimple
+
+RSpec extension for HTTP request
+
+## Usage
+
+```
+require 'httpspec_simple'
+
+base_url 'http://kozy4324.github.io'
+
+describe request('/') do
+  it { should be_http_ok }
+  it { should respond_within(2).seconds }
+end
+
+describe request('/blog/archives/') do
+  it { should be_http_ok }
+  it { should respond_within(2).seconds }
+end
+```
+
+## Custom matcher
+
+### be_http_ok
+
+Example passes if response is 200 ok
+
+### resond_within(n).seconds
+
+Example passes if response time is less than n seconds
+
+## 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/Rakefile

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

data/httpspec_simple.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'httpspec_simple/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "httpspec_simple"
+  spec.version       = HttpspecSimple::VERSION
+  spec.authors       = ["Koji NAKAMURA"]
+  spec.email         = ["kozy4324@gmail.com"]
+  spec.description   = %q{RSpec extension for HTTP request}
+  spec.summary       = %q{RSpec extension for HTTP request}
+  spec.homepage      = "https://github.com/kozy4324/httpspec_simple"
+  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_dependency "rspec", "~> 2.14.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/httpspec_simple/custom_matchers.rb

@@ -0,0 +1,33 @@
+module HttpspecSimple
+  RSpec::Matchers.define :be_http_ok do
+    match do |actual|
+      actual.status == '200'
+    end
+
+    failure_message_for_should do |actual|
+      "expected: 200\n     got: #{actual.status}"
+    end
+
+    failure_message_for_should_not do |actual|
+      "#{actual.to_s} would not be http ok"
+    end
+  end
+
+  RSpec::Matchers.define :respond_within do |expected|
+    match do |actual|
+      actual.response_time < expected
+    end
+
+    failure_message_for_should do |actual|
+      "expected: #{"%7.3f" % expected} seconds\n  result: #{"%7.3f" % actual.response_time} seconds"
+    end
+
+    define_method :seconds do
+      self
+    end
+
+    define_method :description do
+      "respond within #{expected} seconds"
+    end
+  end
+end

data/lib/httpspec_simple/request.rb

@@ -0,0 +1,48 @@
+require 'net/http'
+require 'uri'
+
+module HttpspecSimple
+  class Request
+    attr_reader :response_time, :status
+
+    def initialize(url, opt = {})
+      @url = URI.parse(url)
+      http = Net::HTTP.new(@url.host, @url.port)
+      unless opt[:timeout].nil?
+        http.read_timeout = opt[:timeout]
+        http.open_timeout = opt[:timeout]
+      end
+      retry_count = opt[:retry].to_i
+      @status, @response_time = http.start do |http|
+        res, response_time = process_time do
+          open_timeout_error = if Net.const_defined?(:OpenTimeout) then Net::OpenTimeout else Timeout::Error end
+          read_timeout_error = if Net.const_defined?(:ReadTimeout) then Net::ReadTimeout else Timeout::Error end
+          begin
+            res = http.request(Net::HTTP::Get.new(@url.path))
+            raise RequestError.new if res.kind_of?(Net::HTTPClientError) or res.kind_of?(Net::HTTPServerError)
+          rescue open_timeout_error, read_timeout_error, RequestError
+            retry if (retry_count-=1) > 0
+          end
+          res
+        end
+        unless res.nil?
+          [res.code, response_time]
+        else
+          ['timeout', response_time]
+        end
+      end
+    end
+
+    def process_time
+      start_time = Time.now
+      ret = yield
+      [ret, Time.now - start_time]
+    end
+
+    def to_s
+      @url.to_s
+    end
+  end
+
+  class RequestError < StandardError; end
+end

data/lib/httpspec_simple/version.rb

@@ -0,0 +1,3 @@
+module HttpspecSimple
+  VERSION = "0.0.1"
+end

data/lib/httpspec_simple.rb

@@ -0,0 +1,14 @@
+require "httpspec_simple/version"
+require "httpspec_simple/request"
+require "httpspec_simple/custom_matchers"
+
+RSpec.configure do |config|
+  config.add_setting :base_url, :default => 'http://localhost:10080'
+end
+
+def base_url url
+  RSpec.configuration.base_url = url
+end
+def request path
+  HttpspecSimple::Request.new("#{RSpec.configuration.base_url}#{path}")
+end

data/spec/httpspec_simple/custom_matcher_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'custom matchers' do
+  describe '#be_http_ok' do
+    it "should check status code" do
+      response = nil
+      server_start { response = request('/') }
+      expect {
+        response.should be_http_ok
+      }.not_to raise_error
+    end
+  end
+
+  describe '#respond_within(num).seconds' do
+    it "should check response time" do
+      requests, response = server_start('/' => Proc.new {|req, res| sleep 2 }) do
+        request('/')
+      end
+      response.should respond_within(3).seconds
+      expect {
+        response.should respond_within(1).seconds
+      }.to raise_error(RSpec::Expectations::ExpectationNotMetError)
+    end
+  end
+end

data/spec/httpspec_simple/request_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe HttpspecSimple::Request do
+  it "should request the url passed to 1st argument of constructor" do
+    requests, response = server_start do
+      HttpspecSimple::Request.new('http://localhost:10080/')
+    end
+    requests.should have(1).items
+    requests.should include('http://localhost:10080/')
+    response.status.should == "200"
+  end
+
+  describe "initialize with :timeout option" do
+    it "should timeout within a specific time" do
+      requests, response = server_start( '/' => Proc.new {|req, res| sleep 2 } ) do
+        HttpspecSimple::Request.new('http://localhost:10080/', :timeout => 1)
+      end
+      response.status.should == "timeout"
+    end
+  end
+
+  it "should not retry a request by the default option" do
+    requests, response = server_start( '/' => Proc.new {|req, res| res.status = "503" } ) do
+      HttpspecSimple::Request.new('http://localhost:10080/')
+    end
+    requests.should have(1).items
+    response.status.should == "503"
+  end
+
+  describe "initialize with :retry option" do
+    context ":retry is 3, and the server will respond a status ok at 3rd time" do
+      it "should retry requests while response is not ok" do
+        response_codes = %w{503 404 200}
+        requests, response = server_start( '/' => Proc.new {|req, res| res.status = response_codes.shift } ) do
+          HttpspecSimple::Request.new('http://localhost:10080/', :retry => 3)
+        end
+        requests.should have(3).items
+        response.status.should == "200"
+      end
+    end
+
+    context ":retry is 3, and the server will not respond a status ok" do
+      it "should retry requests 3 times" do
+        response_codes = %w{503 500 404}
+        requests, response = server_start( '/' => Proc.new {|req, res| res.status = response_codes.shift } ) do
+          HttpspecSimple::Request.new('http://localhost:10080/', :retry => 3)
+        end
+        requests.should have(3).items
+        response.status.should == "404"
+      end
+    end
+  end
+end

data/spec/httpspec_simple_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe "RSpec configuration" do
+  describe "#base_url" do
+    it "should be callable" do
+      expect {
+        base_url 'http://www.example.com'
+      }.not_to raise_error
+    end
+  end
+  describe "#request" do
+    it "should be callable" do
+      expect {
+        server_start { request '/' }
+      }.not_to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'webrick'
+require 'httpspec_simple'
+
+def server_start mount_procs = {}
+    unless mount_procs.has_key?('/')
+      mount_procs['/'] = Proc.new {|req, res| res.status = "200" }
+    end
+    captured = []
+    server_thread = Thread.new do
+      server = WEBrick::HTTPServer.new(
+        Port: 10080,
+        Logger: WEBrick::Log.new('/dev/null'),
+        AccessLog: [],
+        StartCallback: Proc.new { Thread.main.wakeup }
+      )
+      mount_procs.each {|path, proc|
+        server.mount_proc(path) {|req, res|
+          captured.push(req.request_uri.to_s)
+          proc.call(req, res)
+        }
+      }
+      Thread.current[:server] = server
+      server.start
+    end
+    Thread.stop
+    begin
+      ret_val = yield
+    ensure
+      server_thread[:server].shutdown
+    end
+    [captured, ret_val]
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: httpspec_simple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Koji NAKAMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !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'
+description: RSpec extension for HTTP request
+email:
+- kozy4324@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- httpspec_simple.gemspec
+- lib/httpspec_simple.rb
+- lib/httpspec_simple/custom_matchers.rb
+- lib/httpspec_simple/request.rb
+- lib/httpspec_simple/version.rb
+- spec/httpspec_simple/custom_matcher_spec.rb
+- spec/httpspec_simple/request_spec.rb
+- spec/httpspec_simple_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kozy4324/httpspec_simple
+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.0.2
+signing_key: 
+specification_version: 4
+summary: RSpec extension for HTTP request
+test_files:
+- spec/httpspec_simple/custom_matcher_spec.rb
+- spec/httpspec_simple/request_spec.rb
+- spec/httpspec_simple_spec.rb
+- spec/spec_helper.rb