reqres 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dcbfdc4c9b951d7709d53447a2fdcfe5c59addf7
+  data.tar.gz: 59eb430301b10eb9d2bea0375bfef2ac1c9a9259
+SHA512:
+  metadata.gz: dc4cd71a62c773116690aff242895d36b1d7552f94665e0a80100ed2cf56a58d98da5235831ea753866734215bf619769ccf036a5ca175c7e33ae5b8d06c6a84
+  data.tar.gz: fa8bbb3e7eb178c1d74d9ca997093612e11786fa3c81c8f09a4edaf9ba060b8297cf308c33ac82e4257f10248f206f21b01e1e1d6368243ed2c4732ecddca4b2

data/README.md

@@ -1,6 +1,10 @@
 # Reqres
 
-TODO: Write a gem description
+Simple application for generating Request and Response YAML file from test.
+Can be used for creating fake API with sinatra.
+And for generating API documentation.
+
+__Only works on Rails and MiniTest::Unit for now__
 
 ## Installation
 
@@ -15,11 +19,71 @@ And then execute:
 Or install it yourself as:
 
     $ gem install reqres
+    
+Include `Reqres::Generator` module to `ActiveSupport::TestCase` in `test_helper.rb`:
+
+```ruby
+require 'reqres/generator'
+
+class ActiveSupport::TestCase
+  include Reqres::Generator
+  ...
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+For generating file run:
+
+    rake reqres:yaml
+
+By default for generating is used integration test but you can set a pattern
+in initializers:
+
+```ruby
+# initializers/reqres.rb
+Reqres.setup do |config|
+  config.test_files_pattern = "test/acceptance/**/*_test.rb"
+end    
+```
+
+Generated file saves to current dir, you can set this in settings: 
+
+```ruby
+config.file_name = File.join(Rails.root, "doc", "reqres.yml")
+```
+
+You can change default request header extraction, which is
+`%w{HTTP_AUTHORIZATION HTTP_ACCEPT CONTENT_TYPE}`:
+
+```ruby
+config.request_headers = %w{HTTP_AUTHORIZATION CONTENT_TYPE}
+```
 
+Generated file will have structure:
+```yaml
+ManageFooTest:
+  test_creates_foo:
+    request:
+      url: http://www.example.com/v1/foos
+      full_path: /v1/foos
+      params:
+        name: Bar
+        description: FooBar
+        action: create
+        controller: v1/foos
+      method: POST
+      body: '{"name":"Bar","description":"FooBar"}'
+      headers:
+        http_authorization: Token token="14d75ec70594d026de22f02502e74be9"
+        content_type: application/json
+        accept: application/json
+    response:
+      code: '201'
+      body: '{"id":974435878,"name":"Bar","description":"FooBar"}'
+  test_getting_foo:
+    request:
+    ....
+```
 ## Contributing
 
 1. Fork it

data/lib/reqres.rb

@@ -11,6 +11,10 @@ module Reqres
   mattr_accessor :test_files_pattern
   @@test_files_pattern = 'test/integration/**/*_test.rb'
 
+  # rake files pattern to run for generating yml file
+  mattr_accessor :request_headers
+  @@request_headers = %w{HTTP_AUTHORIZATION HTTP_ACCEPT CONTENT_TYPE}
+
   # Way to setup Reqres. Add file to initializers:
   #   initializers/reqres.rb
   #

data/lib/reqres/test_suit_additions.rb

@@ -26,21 +26,30 @@ module Reqres
              "params" => request.params.to_hash,
              "method" => request.method,
              "body" => request.body.read,
-             "headers" =>
-               {
-                 "http_authorization" => request.headers["HTTP_AUTHORIZATION"],
-                 "content_type" => request.headers["CONTENT_TYPE"],
-                 'accept' => request.headers["ACCEPT"]
-               }
+             "headers" => request_headers
            },
            "response" => {
              "code" => response.code,
-             "body" => response.body
+             "body" => response.body,
+             "headers" => response.headers
            }
          }
       }
     end
 
+    # request.headers is ActionDispatch::Http::Headers.
+    # It can't be serialized right to yaml
+    def request_headers
+      hdrs = Reqres.request_headers
+      request.headers.inject({}) do |memo,(k,v)|
+        if hdrs.include? k
+          memo.merge(k => v)
+        else
+          memo
+        end
+      end
+    end
+
     # collects data from all tests
     def collect
       if all_tests[self.class.name].nil?

data/lib/reqres/version.rb

@@ -1,3 +1,3 @@
 module Reqres
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: reqres
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Anton Versal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,17 +27,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Request and Response YAML file generator from test.
@@ -65,27 +60,26 @@ files:
 homepage: https://github.com/antonversal/reqres
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.9
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Request and Response YAML file generator from test. Can be used for creating
   fake API with sinatra. And for generating API documentation.
 test_files: []