cucoo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c785eb8e5a8993bd6aae1db703047d0cbabf617
-  data.tar.gz: 634f9f70b65aeb031994644b2f129f3b3afa9133
+  metadata.gz: 66bad9fda5aed0527088b95c9908af54d44cf771
+  data.tar.gz: ccb0bb323e5d3e1f1a8680d3bac96500790558e9
 SHA512:
-  metadata.gz: 660f32172f08fba6ca9e3fd9452b667916b90be3112753b4727bacd24ea3f1c59fe737429de856d641feb25f2165c1fb4959fc7defc13dadd22df10c83043dcc
-  data.tar.gz: 16fa9e30ffc24b4638f437f93a0c592ce5669d457420c5c74ce906ecb333d8432ecc765834cbdf04ccf0d1ae2e510962c78e998c65be8f0f74eeacd17d58d7b3
+  metadata.gz: 6de3dd6e1cb365bbbf39301ca233fa29ef26ba63b75f3d26fd0a4c19559ef46210dab2f28d3e6cd9d84a02050080108a03865fcfe0e9c3e2c334f99a035adf76
+  data.tar.gz: e31cdaace674706c95f2312c0be8c7b0ab1e73e69cd14e016ba1a56b92088520a24e3376067c489e408644da9df92d8bd6f51ab8a55773ea80a24f3bab770544

data/.ruby-gemset

@@ -0,0 +1 @@
+cucoo

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.3

data/README.md

@@ -1,6 +1,6 @@
 # Cucoo
 
-TODO: Write a gem description
+Cucumber steps and assertions for testing your APIs. This gem offers a DSL on top of webmock, cucumber and json_spec to make testing APIs on rails easier.
 
 ## Installation
 
@@ -18,9 +18,167 @@ Or install it yourself as:
 
     $ gem install cucoo
 
-## Usage
+## Configuration
 
-TODO: Write usage instructions here
+Cucoo comes as a package with the following gems installed
+
+* [json_spec](https://github.com/collectiveidea/json_spec)
+* [cucumber](https://github.com/cucumber/cucumber-rails)
+* [webmock](https://github.com/bblimke/webmock)
+
+A typical env.rb would look like this:
+ 
+```ruby
+require 'cucoo/rails'
+
+ActionController::Base.allow_rescue = false
+
+require File.expand_path('../../../config/environment', __FILE__)
+
+Capybara.default_driver = :selenium
+
+Cucumber::Rails::Database.javascript_strategy = :truncation
+
+Cucoo.config do |config|
+  config.app_port = 6666
+  config.stub_host = 'localhost'
+  config.stub_port = 4080
+end
+```
+
+This will start your application on port 6666 on localhost and assume the external services are stubbed at specified host and port.
+
+## Ping Pong Test
+Our app responds to a url `/health/ping.json` with ping. The test to assert this is as follows
+```cucumber
+Scenario: Health Checker
+    Given I make a GET to "/health/ping.json"
+    Then the response should be OK
+    And the response body must be "pong"
+```
+
+## More examples
+
+In all the examples, lets assume we are asserting calls to an external service with the url `/external_service/***`
+
+1) Simple hello world service that accepts two post body params `message` and `says` and calls an external service. 
+```cucumber
+Scenario: Post Hello World
+    Given I expect a POST to "/external_service/post_hello" with:
+      | request                                   |
+      | {"message":"Hello World", "says": "John"} |
+    When I make a POST to "/hello_world" with:
+      | message     | says |
+      | Hello World | John |
+    Then the response should be OK
+```
+
+The last line does two things. It checks if the response code is 200 and also if the expectations were satisfied. So, this must be called at the end of each scenario.
+
+2) Let's build on top of previous example and let the app return back what the external service returns.
+
+```cucumber
+Scenario: Post Hello World and accept response
+    Given I expect a POST to "/external_service/post_hello" with:
+      | request                                  | response                                |
+      | {"message":"Hello World","says": "John"} | {"reply":"Get some life John"}         |
+    When I make a POST to "/hello_world" with:
+      | message     | says |
+      | Hello World | John |
+    Then the response should be OK
+    Then the JSON should be:
+    """
+    {
+       "reply": "Get some life John"
+    }
+    """
+```
+
+Note that if the response from an external service is huge and can be read from a file, the POST expectation step can read from the file
+
+```cucumber
+Given I expect a POST to "/external_service/post_hello" with:
+      | request                                  | file                                |
+      | {"message":"Hello World","says": "John"} | stub/json/hello_world/response.json |
+```
+
+The file will be read relative to the rails root path.
+
+3) Asserting a request body larger than hello world.
+
+```cucumber
+Scenario: Add a new movie
+    Given I expect a POST to "/external_service/add_movie" with json request:
+    """
+     {
+        "name": "The Godfather",
+        "director": "Francis Coppola",
+        "year": 1972,
+        "rating": 9.2,
+        "runtime": 175
+     }
+    """
+    When I make a POST to "/movies" with:
+      | name          | director        | year | rating | runtime | 
+      | The Godfather | Francis Coppola | 1972 | 9.2    | 175     |
+    Then the response should be OK
+```
+
+4) GET and json assertions
+
+```cucumber
+Scenario: Get next token number
+    Given I expect a GET to "/external_service/next_free_slot" with:
+    | response                                           |
+    | {"number": 42, "stats": {"total": 110, "free": 54} |
+    When I make a GET to "/next_id"
+    Then the response should be OK
+    And the JSON response at "stats" should be:
+    """
+    {"total": 110, "free": 54}
+    """
+```
+
+In the above example, we have seen a slightly advanced version of asserting for json response. Please refer [json_spec doc](https://github.com/collectiveidea/json_spec#cucumber) for more examples of json response assertion.
+
+We can also check for other response codes:
+
+```cucumber
+Then the response should be NOT FOUND #404
+Then the response should be BAD REQUEST #400
+Then the response code should be "302" #custom response code
+```
+
+5) PUT request
+
+```cucumber
+Scenario: Update employee details
+    Given I expect a PUT to "/external_service/employee/" with json request:
+    """
+        {
+            "id": 812,
+            "name": "Steve Balmer",
+            "status": "unemployed"
+        }
+    """
+    When I make a PUT to "employees" with:
+    | id  | name          | status     |  
+    | 812 | Steve Balmer  | unemployed |
+    Then the response should be OK
+```
+
+6) DELETE request
+
+```cucumber
+Scenario: Delete device token
+    Given I expect a DELETE to "/external_service/device/ab112321adceadcdf"
+    When I make a DELETE to "devices" with:
+    | token             |
+    | ab112321adceadcdf |
+    Then the response should be OK
+```
+
+This gem is very much a work-in-progress. We will keep adding more assertions with usage. Contributions welcome
 
 ## Contributing
 

data/cucoo.gemspec

@@ -23,6 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json_spec'
   spec.add_dependency 'capybara'
   spec.add_dependency 'webmock'
+  spec.add_dependency 'rspec-rails', '~> 3.0'
+  spec.add_dependency 'cucumber-rails'
+  spec.add_dependency 'selenium-webdriver'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/cucoo/config.rb

@@ -1,7 +1,7 @@
 module Cucoo
   class Config
     class << self
-      attr_accessor :app_port, :stub_port
+      attr_accessor :app_port, :stub_host, :stub_port
     end
   end
 end

data/lib/cucoo/rails.rb

@@ -1,9 +1,12 @@
+require 'capybara'
+require 'json_spec/cucumber'
+require 'webmock/cucumber'
+require 'cucumber/rails'
+require 'rspec/mocks'
 require 'cucoo/stub_helper'
 require 'cucoo/step_definitions/api_steps'
 require 'cucoo/step_definitions/stub_steps'
 require 'cucoo/step_definitions/json_spec_steps'
-require 'capybara'
-require 'webmock/cucumber'
 
 Before do
   clear_stubs!

data/lib/cucoo/step_definitions/api_steps.rb

@@ -1,4 +1,4 @@
-When(/^I make a POST to "([^"]*)" with the following:$/) do |url, params|
+When(/^I make a POST to "([^"]*)" with:$/) do |url, params|
   Cucoo::Driver.post url, params.hashes.first
 end
 
@@ -15,11 +15,11 @@ When(/^I make a GET to "([^"]*)"$/) do |url|
   Cucoo::Driver.get url
 end
 
-When(/^I send a DELETE to "([^"]*)"$/) do |url|
+When(/^I make a DELETE to "([^"]*)"$/) do |url|
   Cucoo::Driver.delete url
 end
 
-When(/^I send a DELETE to "([^"]*)" with params:$/) do |url, params|
+When(/^I make a DELETE to "([^"]*)" with:$/) do |url, params|
   Cucoo::Driver.delete url, params.hashes.first
 end
 
@@ -31,7 +31,7 @@ And(/^the response body must be "([^"]*)"$/) do |body|
   expect(Cucoo::Driver.response.to_s).to eq(body)
 end
 
-When(/^I send a PUT request to "([^"]*)" with the following:$/) do |url, params|
+When(/^I send a PUT request to "([^"]*)" with:$/) do |url, params|
   Cucoo::Driver.put url, params.hashes.first
 end
 

data/lib/cucoo/stub_helper.rb

@@ -1,6 +1,6 @@
 module StubHelper
   def expand_url(url)
-    ['http://localhost:', Cucoo::Config.stub_port, url].join
+    ['http://', Cucoo::Config.stub_host, ':', Cucoo::Config.stub_port, url].join
   end
 
   def assert_all_stubs!

data/lib/cucoo/version.rb

@@ -1,3 +1,3 @@
 module Cucoo
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucoo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - RC
@@ -80,6 +80,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +158,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md