shakedown 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 941f63c53eb308c3cdba21c483a4cdfa69b64c7e
4
+ data.tar.gz: 0b56d8da3f43ea88b90a2263965542e6dafd3df5
5
+ SHA512:
6
+ metadata.gz: 828098bc619487211b165214b8b56e4e908495cbcd70d9452238c04020542ef2ba20ea56995347f1ea39343dc89b78c896ec7e0171b1288b822f06aacb668a95
7
+ data.tar.gz: 26d2b98c36686808b3807e4f15a34d8c980456a504d6b6eb49768e79deeff7bdbb5e423ca50a9fe78f4059df302f4f78e2c8779936e3a80c3635b3db40860aa6
data/.gitignore ADDED
@@ -0,0 +1,15 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.bundle
11
+ *.so
12
+ *.o
13
+ *.a
14
+ mkmf.log
15
+ .DS_Store
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in shakedown.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2015 Camber
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,31 @@
1
+ # Shakedown
2
+
3
+ TODO: Write a gem description
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'shakedown'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install shakedown
20
+
21
+ ## Usage
22
+
23
+ TODO: Write usage instructions here
24
+
25
+ ## Contributing
26
+
27
+ 1. Fork it ( https://github.com/[my-github-username]/shakedown/fork )
28
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
29
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
30
+ 4. Push to the branch (`git push origin my-new-feature`)
31
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
@@ -0,0 +1,30 @@
1
+ module Shakedown
2
+ class Configuration
3
+ attr_accessor :host, :namespace
4
+ attr_reader :start, :stop
5
+
6
+ def initialize
7
+ @host = "http://localhost:1234"
8
+ @namespace = nil
9
+ @start = lambda {}
10
+ @stop = lambda {}
11
+ end
12
+
13
+ def start(&block)
14
+ @start = block
15
+ end
16
+
17
+ def start!
18
+ @start.call()
19
+ end
20
+
21
+ def stop(&block)
22
+ @stop = block
23
+ end
24
+
25
+ def stop!
26
+ @start.call()
27
+ end
28
+ end
29
+ end
30
+
@@ -0,0 +1,10 @@
1
+ module Shakedown
2
+ class NotEqualError < StandardError
3
+ attr_reader :got, :expected
4
+ def initialize(got, expected)
5
+ @got = got
6
+ @expected = expected
7
+ end
8
+ end
9
+ end
10
+
@@ -0,0 +1,100 @@
1
+ module Shakedown
2
+ class Runner
3
+ COLORS = {
4
+ pending: 'yellow',
5
+ success: 'green',
6
+ failed: 'red'
7
+ }
8
+
9
+ SYMBOLS = {
10
+ pending: '–',
11
+ success: '✔',
12
+ failed: '✖'
13
+ }
14
+
15
+ attr_reader :type, :url, :params
16
+
17
+ def initialize(type, url, params)
18
+ @url = url
19
+ @params = params
20
+ @type = type
21
+ @json = nil
22
+ @status = nil
23
+ end
24
+
25
+ def run
26
+ print_status(:pending)
27
+ @json = JSON.parse(response.body)
28
+ @status = response.code.to_i
29
+ return self
30
+ end
31
+
32
+ def print_status(status, update=false)
33
+ message = "[#{COLORS[status]}]#{SYMBOLS[status]} #{type.to_s.upcase.ljust(8)} #{url}[/]"
34
+
35
+ if update
36
+ Formatador.redisplay(message)
37
+ puts
38
+ else
39
+ Formatador.display(message)
40
+ end
41
+ end
42
+
43
+ def uri
44
+ URI.parse(@url)
45
+ end
46
+
47
+ def http
48
+ Net::HTTP.new(uri.host, uri.port)
49
+ end
50
+
51
+ def request
52
+ case type
53
+ when :get
54
+ request = Net::HTTP::Get.new(uri.request_uri)
55
+ when :post
56
+ request = Net::HTTP::Post.new(uri.request_uri)
57
+ when :delete
58
+ request = Net::HTTP::Delete.new(uri.request_uri)
59
+ end
60
+
61
+ request.set_form_data(params)
62
+ request
63
+ end
64
+
65
+ def response
66
+ http.request(request)
67
+ end
68
+
69
+ def json(expected)
70
+ assert_equal(@json, JSON.parse(expected.to_json))
71
+ end
72
+
73
+ def status(expected)
74
+ assert_equal(@status, expected)
75
+ end
76
+
77
+ def assert(assertions=nil)
78
+ print_status(:success, true)
79
+
80
+ if assertions.nil?
81
+ return self
82
+ end
83
+
84
+ begin
85
+ instance_eval &assertions
86
+ rescue NotEqualError => e
87
+ print_status(:failed, true)
88
+ puts
89
+ puts "Expected: #{e.expected}"
90
+ puts " Got: #{e.got}"
91
+ puts
92
+ exit
93
+ end
94
+ end
95
+
96
+ def assert_equal(a, b)
97
+ raise NotEqualError.new(a, b) unless a == b
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,35 @@
1
+ module Shakedown
2
+ class Sequence
3
+ attr_reader :config
4
+
5
+ def initialize(config, block)
6
+ @config = config
7
+ @runnable = block
8
+ end
9
+
10
+ def run!
11
+ instance_eval &@runnable
12
+ end
13
+
14
+ def base_url
15
+ [config.host, config.namespace].compact.join('/')
16
+ end
17
+
18
+ def url_for(url)
19
+ [base_url, url].join
20
+ end
21
+
22
+ def get(url, params={}, &assertions)
23
+ Runner.new(:get, url_for(url), params).run.assert(assertions)
24
+ end
25
+
26
+ def post(url, params={}, &assertions)
27
+ Runner.new(:post, url_for(url), params).run.assert(assertions)
28
+ end
29
+
30
+ def delete(url, params={}, &assertions)
31
+ Runner.new(:delete, url_for(url), params).run.assert(assertions)
32
+ end
33
+ end
34
+ end
35
+
@@ -0,0 +1,3 @@
1
+ module Shakedown
2
+ VERSION = "0.0.1"
3
+ end
data/lib/shakedown.rb ADDED
@@ -0,0 +1,33 @@
1
+ require "net/http"
2
+ require "uri"
3
+ require "json"
4
+ require "formatador"
5
+
6
+ require "shakedown/version"
7
+ require "shakedown/configuration"
8
+ require "shakedown/errors"
9
+ require "shakedown/runner"
10
+ require "shakedown/sequence"
11
+
12
+
13
+ module Shakedown
14
+ def self.configure
15
+ yield config
16
+ end
17
+
18
+ def self.config
19
+ @config ||= Configuration.new
20
+ end
21
+
22
+ def self.sequence(&block)
23
+ sequence = Sequence.new(config, block)
24
+
25
+ begin
26
+ config.start!
27
+ sequence.run!
28
+ ensure
29
+ config.stop!
30
+ end
31
+ end
32
+ end
33
+
data/shakedown.gemspec ADDED
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'shakedown/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "shakedown"
8
+ spec.version = Shakedown::VERSION
9
+ spec.authors = ["Casey O'Hara"]
10
+ spec.email = ["casey@camber.io"]
11
+ spec.summary = "Lightweight, implementation-agnostic JSON API tests"
12
+ spec.description = ""
13
+ spec.homepage = "https://github.com/camber/shakedown"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.7"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ spec.add_dependency "formatador", "~> 0.2.5"
24
+ end
25
+
metadata ADDED
@@ -0,0 +1,98 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: shakedown
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Casey O'Hara
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-03-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.7'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.7'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: formatador
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.2.5
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.2.5
55
+ description: ''
56
+ email:
57
+ - casey@camber.io
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - Gemfile
64
+ - LICENSE.txt
65
+ - README.md
66
+ - Rakefile
67
+ - lib/shakedown.rb
68
+ - lib/shakedown/configuration.rb
69
+ - lib/shakedown/errors.rb
70
+ - lib/shakedown/runner.rb
71
+ - lib/shakedown/sequence.rb
72
+ - lib/shakedown/version.rb
73
+ - shakedown.gemspec
74
+ homepage: https://github.com/camber/shakedown
75
+ licenses:
76
+ - MIT
77
+ metadata: {}
78
+ post_install_message:
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: '0'
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubyforge_project:
94
+ rubygems_version: 2.4.2
95
+ signing_key:
96
+ specification_version: 4
97
+ summary: Lightweight, implementation-agnostic JSON API tests
98
+ test_files: []