poisol 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01adcdf358dc975f241d3418e6d94d3752ed78a5
-  data.tar.gz: 72d25d1144f13a1caed03e389e234b31a8a022f2
+  metadata.gz: 8d298d18998b092b79bc87bbdc5b2287fb7c3862
+  data.tar.gz: 83177b3ad21fb80e97100611bac316019a649278
 SHA512:
-  metadata.gz: f22d84c6e23b0f2bf670e3f9975622fba90f5511f714562dbc7770f6c2c2b75d37940eee92bc1f1de76db688b62d5b18d54eee0997f1082781be3cabb6b1e98c
-  data.tar.gz: 2fcc93ff3123a06385c4f3c35cdca59a97e5c05d2bc4b46b583064031eb0ec81ca392c1ea433cde1cc9dfdfb9a2e67079cd1f488405b9cf0719fe24202869c59
+  metadata.gz: 5c593114f02e24cbd288566840f8d4baed2b58c12a89351c72589c91eedefbdf9c127688ff9203e3c9ec54eaf8cd3450e2ba6eb54e18a683f9d88e28b51c54f4
+  data.tar.gz: 36bb858a3f9df8547c6fe3a972db6d09076af64d977990efcff6b364305bab5c9b8b29bb75cafb434d8cb61e39d3752ef78fc588635f8e9a02b272145bba3d62

data/README.md

@@ -3,49 +3,50 @@
 
 #Poisol
 
-For tests suite that uses stubs for http calls, Poisol generates builder objects that could be used to setup http stubs, similar to data builders used to set up test data in database. 
+Poisol provides DSL, with default builders, to stub http endpoints.Similar to Active records and fixtures (factorygirl) used to set test data in database. 
 
-Hence, avoiding clumsy manual json manipulations and duplications, and keeping test stub data setup as part of test's code.
+Hence, avoiding clumsy manual manipulations and duplications of url's & json, and keeping test stub data setup as part of test's code.
 
 ###Example
 
 Stubbing a http service that provides user identification, gets as simple as 
 
 ```ruby
-  User.new.ofName('Joe').hasRole('buyer').build  
-  # => webmock that would return role as 'buyer' for http call user 'Joe'
+  User.new.for_name('Joe').has_role('buyer').build  
+  # => stub that would return with role as 'buyer' for http call for user 'Joe'
   
-  User.new.ofName('Mani').hasRole('Manager').build 
-  # => webmock that would return role as 'Manager' for http call user 'Mani'
+  User.new.for_name('Mani').has_role('Manager').build 
+  # => stub that would return with role as 'Manager' for http call for user 'Mani'
   
   User.new.build 
-  # => webmock that would return role as 'Singer' for http call user 'Raji'
+  # => stub that would return with role as 'Singer' for http call for user 'Raji'
 ```
 given a minimal configuration
 
 ```yaml
 #user.yml
-url: http://authentication.service:80/user
-query: 
-  name: "Raji"
-response_body:
-  '{
-      role : "singer"
-  }'
+request:
+  url: http://authentication.service:80/user
+  query: 
+    name: "Raji"
+response:
+  body:'{
+          role : "singer"
+        }'
 ```
-Poisol, dynamically generates class called 'User', with methods 'ofName' and 'hasRole', which can be used to build as many User's as we need for the tests.
+Poisol, dynamically generates class called 'User', with methods 'of_name' and 'has_role', which can be used to build as many User's as we need for the tests.
 
 It handles complex request and responses, like array, nested array, array having nested array etc..
 
-The following can be dynamically configured
+The following can be dynamically configured, through the builders available
 - Request 
   - url
-  - type
+  - method*
   - query params
   - request body
 - Response 
   - status code
-  - header
+  - header*
   - response body
 
 ## Prepositions
@@ -59,9 +60,79 @@ The following can be dynamically configured
 | has         | response body field/array item |
 | with        | response body array item field |
 
+##Usage
+
+In your project Gemfile add
+
+``` 
+gem 'poisol'
+```
+
+###Cucumber
+
+```ruby
+#features/support/env.rb
+require 'poisol'
+```
+```ruby
+#suppoert/hooks.rb
+Before do
+  if $poisol_loaded.blank?
+    Poisol.start #starts the stub server
+    Poisol.load "<--location of the stub configs folder-->" #loads the configs as stub builders 
+    #Poisol.load "features/stub_data/payment_gateway"
+    #Poisol.load "features/stub_data/exchange_service"
+    $poisol_loaded = true
+  end
+  Poisol.reset_data #clears the stubs configured prior, hence every test is independent
+end
+
+at_exit do
+  Poisol.stop
+end
+```
+###Rspec
+
+```ruby
+#spec/spec_helper.rb
+require 'poisol'
+
+RSpec.configure do |config|
+
+  config.before(:each) do
+    Poisol.reset_data #clears the stubs configured prior, hence every test is independent
+  end
+
+  config.before(:suite) do
+    Poisol.start #starts the stub server
+    Poisol.load "<--location of the stub configs folder-->" #loads the configs as stub builders 
+    #Poisol.load "spec/stub_data/payment_gateway"
+    #Poisol.load "spec/stub_data/exchange_service"
+  end
+
+  config.after(:suite) do
+    Poisol.stop
+  end
+
+end
+```
+### Port
+  By default, on Poisol.start will start the stub server in port localhost:3030, we can change the default port on server start by Poisol.start(:port=>3333)
+
+#### Sub Domain
+  Given all the external services stubbed will be handled 
+
+## Builders
+####URL  
+  ```yml
+  #user.yml
+  request:
+    url: user/{id|2}
+    ...
+```
+
+
+
 ##ToDo
-* Response code and header config
-* Generate Request Handler, based on Response Handler
-* Documentation for 'getting started' and details
-* Test coverage
-* Throw error when configured and input field values are different
+* Make header configurable 
+* Ensure contract mentioned to not changed

data/lib/poisol/server.rb

@@ -1,10 +1,25 @@
+require 'webrick'
+
+
 module Poisol 
+
+  class ExtendedServer  < WEBrick::HTTPServlet::AbstractServlet
+    def do_GET req,res
+      stub_response = Poisol::ResponseMapper.map(req)
+      res.status = stub_response.status
+      res.body = stub_response.body.to_json
+      res.content_type = 'application/json'
+    end
+    alias do_DELETE do_GET
+    alias do_POST do_GET
+    alias do_PUT do_GET
+  end
+
   module Server
     extend self
 
     def start port
       PoisolLog.info "Starting server...  as http://localhost:#{port}"
-      require 'webrick'
       @server =  WEBrick::HTTPServer.new :Port => port, :Logger => log, :AccessLog => access_log
       @port = port
       attach_shutdown
@@ -18,12 +33,7 @@ module Poisol
     end
 
     def attach_request_handling
-      @server.mount_proc '/' do |req, res|
-        stub_response = ResponseMapper.map(req)
-        res.status = stub_response.status
-        res.body = stub_response.body.to_json
-        res.content_type = 'application/json'
-      end
+      @server.mount '/', ExtendedServer
     end
 
     def attach_shutdown 

data/spec/data/main/delete.yml

@@ -0,0 +1,5 @@
+request:
+  url: 'delete_url'
+  method: delete
+response:
+  body: '{"hi": 1}'

data/spec/functional/delete_spec.rb

@@ -0,0 +1,7 @@
+describe "Delete" do 
+  it "for delete request" do
+    Delete.new.build
+    response = RestClient.delete "http://localhost:3030/delete_url"
+    expect(response.body).to eq({"hi"=>1}.to_json)
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
+require 'pry'
 require "rspec/expectations"
 require 'rest_client'
 
 require_relative '../lib/poisol'
-require 'pry'
 
 require 'simplecov'
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poisol
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Deepak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -158,6 +158,7 @@ files:
 - spec/data/domain/first/first.yml
 - spec/data/domain/second/domain.yml
 - spec/data/domain/second/second.yml
+- spec/data/main/delete.yml
 - spec/data/main/domain.yml
 - spec/data/main/key_value/explicit.yml
 - spec/data/main/key_value/key_value.yml
@@ -171,6 +172,7 @@ files:
 - spec/data/main/user/config.yml
 - spec/data/main/user/request.json
 - spec/data/main/user/response.json
+- spec/functional/delete_spec.rb
 - spec/functional/key_value/explicit_inclusion_spec.rb
 - spec/functional/key_value/implicit_inclusion_spec.rb
 - spec/functional/multi_domain_spec.rb
@@ -228,6 +230,7 @@ test_files:
 - spec/data/main/response/array/columns.yml
 - spec/data/main/response/array/rows.yml
 - spec/data/main/response/nested_array.yml
+- spec/data/main/delete.yml
 - spec/data/main/query/book_explicit.yml
 - spec/data/main/query/book.yml
 - spec/unit/extension/hash_spec.rb
@@ -237,6 +240,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/functional/wasted_spec.rb
 - spec/functional/multi_domain_spec.rb
+- spec/functional/delete_spec.rb
 - spec/functional/key_value/explicit_inclusion_spec.rb
 - spec/functional/key_value/implicit_inclusion_spec.rb
 - spec/functional/post_request_spec.rb