goodall 0.0.1 → 0.0.2

data/.rvmrc

@@ -1,2 +1,3 @@
 rvm --create use 1.9.3@goodall
 #rvm --create use ree@goodall
+#rvm --create use 2.0.0@goodall

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.9.2
   - rbx-18mode

data/README.md

@@ -124,6 +124,9 @@ For cucumber, the best way is to have often-reused methods in each scenario, and
   Given /^I get \"(.+)\"$/ do |path|
     get(path)
     Goodall.document_request(:get, path)
+    # If this were a POST, we would so something like this:
+    #
+    #   Goodall.document_request(:post, path, posted_data)
   end
 
   Given /^the response should be valid json$/ do
@@ -167,9 +170,16 @@ for the get/post/put/delete/patch verbs:
   # spec_helper.rb
 
   def documented_get(*args)
+    
     Goodall.document_request(:get, args[0])
+    # If this were a POST, we would so something like this:
+    #
+    #   Goodall.document_request(:post, args[0], posted_data)
+
     get_response = get(args)
+
     Goodall.document_response(response.body)
+
     get_response
   end
 
@@ -300,8 +310,22 @@ handled, and self is the **class** of the handler.
 
 ## Methods
 
-Documented with rdoc.
+These are the method you will use most with Goodall.
+
+#### Goodall.document_request(method, path, payload=nil)
+
+Document a request.
 
+* :method  - a symbol of the verb: :get, :post, :put, :delete, :patch
+* :path    - a string of the path (URL/URI) of the request
+* :payload - the parameters sent, e.g. post body. Usually a hash. For things with no payload, like a GET, it can be nil.
+
+#### Goodalldocument_response(payload)
+
+Document a response.
+
+* :payload - the data returned from the request, e.g. response.body. "payload" will be run through the current handler and be pretty-printed to the output file.
+  
 ## Contributing
 
 1. Fork it

data/goodall.gemspec

@@ -20,6 +20,7 @@ write your tests.}
   spec.require_paths = ["lib"]
 
   spec.add_dependency "multi_json", ">= 1.6"
+  spec.add_dependency "tolerate_json"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/goodall/handler/json.rb

@@ -1,9 +1,11 @@
 require 'multi_json'
 require "goodall/handler/base"
+require 'tolerate_json'
 
 class Goodall
   module Handler
     class Json < Base
+      include TolerateJson
       Goodall.register_handler :json, self
 
       def parse_payload(payload)
@@ -18,47 +20,15 @@ class Goodall
         else
           payload
         end
-  
+
         # detect "pretty" json by seeing if there are CRs in here
         if (json = MultiJson.dump(payload)) =~ /\n/
           json
         else
-          pretty_print(json)
+          pretty_print_json(json)
           # json
         end
       end
-    
-
-    private
-
-      # We're doing this outselves because it's too unreliable detecting which parsers support pretty-print and whoch one don't. If this method is broken, at least it will be *consitently* broken.
-      def pretty_print(json)
-        return json if json.to_s.size < 1
-
-        str = json.to_s.gsub("},", "},\n").gsub("],", "],\n").gsub("{[", "{\n[").gsub("}]", "}\n]").gsub("[{", "[\n{").gsub("]}", "]\n}").gsub("{\"", "{\n\"").gsub("\"}", "\"\n}").gsub("\",\"", "\",\n\"")
-
-        if str.match(/[^\n]\}$/)
-          str.gsub!(/\}$/, "\n}")
-        end
-
-        output = []
-
-        indent_level = 0
-        str.split("\n").each do |s|
-          indent_level -= 1 if ["]", "}"].include?(s.split('').first) && indent_level > 0
-          output << ("  "*indent_level) + s
-          if ["{", "["].include?(s.split('').last)
-            indent_level += 1 
-            next
-          end
-
-          if ["{", "["].include?(s.split('').first)
-            indent_level += 1 
-            next
-          end
-        end
-        output.join("\n")
-      end
     end
   end
 end

data/lib/goodall/version.rb

@@ -1,3 +1,3 @@
 class Goodall
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/goodall/handler/json_spec.rb

@@ -8,12 +8,12 @@ describe Goodall::Handler::Json do
       context 'string is valid json' do
 
         let(:valid_json_string) { '{"foo":"bar"}' }
-        
+
         it 'should return it as pretty-printed json' do
           expect(
             subject.parse_payload(valid_json_string)
-          ).to eq("{\n  \"foo\":\"bar\"\n}")
-        end        
+          ).to eq("{\n  \"foo\":\"bar\"\n}\n")
+        end
       end
       context 'the string not valid json' do
 
@@ -34,7 +34,7 @@ describe Goodall::Handler::Json do
       it 'should return it as pretty-printed json' do
         expect(
             subject.parse_payload(payload)
-          ).to eq("{\n  \"foo\":\"bar\"\n}")
+          ).to eq("{\n  \"foo\":\"bar\"\n}\n")
       end
     end
   end

metadata

@@ -1,93 +1,105 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: goodall
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Matthew Nielsen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-08-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: tolerate_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 10
-        version: "2.10"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.10'
   type: :development
-  version_requirements: *id004
-description: |-
-  An easy interface for documenting your API while you
-  write your tests.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: ! 'An easy interface for documenting your API while you
+
+  write your tests.'
+email:
 - xunker@pyxidis.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .rvmrc
@@ -113,39 +125,34 @@ files:
 - spec/lib/goodall_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/xunker/goodall
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Goodall provides an easy interface for documenting your API while you write your tests. It is compatible with Rspec, Cucumber and test-unit, as well as others. Goodall is named after Jane Goodall who has spent her life observing and documenting the behviour of chimpanzees.
-test_files: 
+summary: Goodall provides an easy interface for documenting your API while you write
+  your tests. It is compatible with Rspec, Cucumber and test-unit, as well as others.
+  Goodall is named after Jane Goodall who has spent her life observing and documenting
+  the behviour of chimpanzees.
+test_files:
 - spec/lib/goodall/handler/json_spec.rb
 - spec/lib/goodall_spec.rb
 - spec/spec_helper.rb