dock_test 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6428ec4296e609ae46c0982e22596bf1eb73e7ae
-  data.tar.gz: 34eedfb10543be92875c61c432dddf804a71aaaf
+  metadata.gz: 8df485fce515216c5708b86194832e7d86b4f86c
+  data.tar.gz: df50712cf65788a3abe2bbf4206bc7fa94325c4a
 SHA512:
-  metadata.gz: 6ae1e4fb5dadb27b972499c2bca9ea639e88a456821ef39ab569ccd6973f27fa6ee6d3e32e721402c88cc64b0da90ac3453a54174faf250eb6b910e0d22a9074
-  data.tar.gz: b4270bc7898e55ee98ecf4680e3171975b2aa3fe9244f92ef5fc51db4815e4223585a0d0078eeb4208a592a6d9c351b8bed3909855e37742bc6989c518c2cd3f
+  metadata.gz: 80d74479fa3106f0aaaa56a3a39a4e049dab36bf2306c9c5281b514a62ef18e0bc547c8f3d88cf5577907b15629733be3d834ac0288512af25c57edb155c1134
+  data.tar.gz: 0a43901742776345a2936b6d5534b0dd8b6d8774e2ee9951c435c678e6f6ff6559c37b43389b2b84d94ef3a3fe9e86cbf68ed469cdf9ff5fbae1485ae01f7d3e

data/README.md

@@ -1,29 +1,69 @@
-# DockTest
+# DockTest Gem
+<img src="https://raw.githubusercontent.com/jackxxu/dock_test/master/dock_test_logo.jpeg" alt="DockTest Gem" align="right" height="300" width="320"/>
 
-TODO: Write a gem description
+### Description
 
-## Installation
+DockTest is an outside-in testing framework for ruby service api applications.
+
+### Features
+
+Different from the popular [Rack::Test], DockTest focuses on just on service applications and tests 100% from outside.
+
+1. 100% end-to-end as it is based on HTTP requests/responses. When testing in local mode, it also racks up the local rack server.
+2. same tests can run for all deployment environments - development, test, staging, and production.
+3. environment-specific `skippy` setting to automatically skip tests with requests that create side-effects in production environments.
+4. focuses on service applications to strip out sessions, cookies, javascript, file uploads, and other browser-related features.
+5. provides custom assertions that are specific to api responses, including schema validation.
+6. same methods as [Rack::Test] for easy test reuse.
+
+### Sample Application
+
+1. [newark] app: [https://github.com/jackxxu/sample_dock_tested_app](https://github.com/jackxxu/sample_dock_tested_app)
+2. [grape] app: [https://github.com/jackxxu/grape_dock_tested_app](https://github.com/jackxxu/grape_dock_tested_app)
+3. [rails-api] app: [https://github.com/jackxxu/rails_api_dock_tested_app](https://github.com/jackxxu/rails_api_dock_tested_app)
+
+### Install
 
 Add this line to your application's Gemfile:
 
+```ruby
+  group :test do
     gem 'dock_test'
+  end
+```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+In your test helper file (often `test/test_helper.rb`), include the following DockTest configuration:
+
+```ruby
+DockTest.configure do |c|
+  c.url = case ENV['DOCK_ENV']
+          when 'production'
+            'http://vast-reaches-9635.herokuapp.com/' # your production service url
+          when ...
+          else
+            'http://localhost:9871' # your local service url with abitary unbound port number
+          end
+  c.skippy = :production # in production mode, skip all the post, delete, put requests.
+end
+```
+
+Add `include DockTest::Methods` to give your integration tests access to all the verb test methods and also assertions.
+
+Now you can excute your test collectively or individually, such as:
 
-    $ gem install dock_test
+    $ bundle exec rake test
+    $ DOCK_ENV=product bundle exec rake test
 
-## Usage
+### Assumptions
 
-TODO: Write usage instructions here
+1. when testing local application, a `config.ru` exists that can be used to `rackup` the server.
 
-## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/dock_test/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
+[Rack::Test]: https://github.com/brynary/rack-test
+[newark]: https://github.com/mje113/newark
+[grape]: https://github.com/intridea/grape
+[rails-api]: https://github.com/rails-api/rails-api

data/lib/dock_test/methods.rb

@@ -10,7 +10,7 @@ module DockTest
           skip_test_to_avoid_side_efforts
         end
 
-        uri = URI.join(DockTest.url, path)
+        uri = URI.parse(full_url(DockTest.url, path))
 
         if DockTest.localhost?
           uri.port = DockTest.port
@@ -71,5 +71,12 @@ module DockTest
       def skip_test_to_avoid_side_efforts
         skip('this test is skipped in order to avoid potential side effects.')
       end
+
+      # cleanse and combine url and path to retrieve a valid full url
+      def full_url(url, path)
+        url = url[0..1] if url.end_with?('/')
+        path = path[1..-1] if path.start_with?('/')
+        "#{url}/#{path}"
+      end
   end
 end

data/lib/dock_test/version.rb

@@ -1,3 +1,3 @@
 module DockTest
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dock_test
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jack Xu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -95,6 +95,7 @@ files:
 - Rakefile
 - config.ru
 - dock_test.gemspec
+- dock_test_logo.jpeg
 - lib/dock_test.rb
 - lib/dock_test/assertions.rb
 - lib/dock_test/dsl.rb