doc_raptor 0.2.3 → 0.3.0

data/Changelog.md

@@ -1,5 +1,11 @@
 # DocRaptor Gem Changelog
 
+## 0.3.0 - 2012/03/29
+* BUGFIX async create calls were incorrectly returning the status id
+  instead of the response object
+* More test (fixture) refactoring
+* A little production code cleanup
+
 ## 0.2.3 - 2012/03/15
 * major test refactor in preparation for bigger changes
 * use current gem packaging techniques

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    doc_raptor (0.2.3)
+    doc_raptor (0.3.0)
       httparty (>= 0.4.3)
 
 GEM

data/doc_raptor.gemspec

@@ -5,7 +5,7 @@ require "doc_raptor/version"
 Gem::Specification.new do |gem|
   gem.name          = "doc_raptor"
   gem.authors       = ["Michael Kuehl", "Joel Meador", "Chris Moore"]
-  gem.email         = ["michael@expectedbehavior.com"]
+  gem.email         = ["michael@expectedbehavior.com", "joel@expectedbehavior.com"]
   gem.description   = %q{Provides a simple ruby wrapper around the DocRaptor API}
   gem.summary       = %q{Provides a simple ruby wrapper around the DocRaptor API}
   gem.homepage      = "http://docraptor.com"

data/lib/doc_raptor.rb

@@ -39,11 +39,6 @@ class DocRaptor
     raise_exception_on_failure = options[:raise_exception_on_failure]
     options.delete :raise_exception_on_failure
 
-    query = { }
-    if options[:async]
-      query[:output => 'json']
-    end
-
     # HOTFIX
     # convert safebuffers to plain old strings so the gsub'ing that has to occur
     # for url encoding works
@@ -54,12 +49,16 @@ class DocRaptor
     end
     # /HOTFIX
 
-    response = post("/docs", :body => {:doc => options}, :basic_auth => { :username => api_key }, :query => query)
+    response = post("/docs", :body => {:doc => options}, :basic_auth => {:username => api_key})
 
     if raise_exception_on_failure && !response.success?
       raise DocRaptorException::DocumentCreationFailure.new response.body, response.code
     end
 
+    if response.success? && options[:async]
+      self.status_id = response.parsed_response["status_id"]
+    end
+
     if block_given?
       ret_val = nil
       Tempfile.open("docraptor") do |f|
@@ -70,8 +69,6 @@ class DocRaptor
         ret_val = yield f, response
       end
       ret_val
-    elsif options[:async]
-      self.status_id = response.parsed_response["status_id"]
     else
       response
     end
@@ -97,6 +94,7 @@ class DocRaptor
     if raise_exception_on_failure && !response.success?
       raise DocRaptorException::DocumentListingFailure.new response.body, response.code
     end
+
     response
   end
 

data/lib/doc_raptor/version.rb

@@ -1,3 +1,3 @@
 class DocRaptor
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/test/create_bang_test.rb

@@ -35,13 +35,13 @@ class CreateBangTest < MiniTest::Unit::TestCase
 
       it "should give me some error message if pass some invalid content" do
         invalid_html = "<herp"
-        stub_http_response_with("invalid_pdf", :post, 422)
+        stub_http_response_with("invalid_pdf.xml", :post, 422)
         assert_raises(DocRaptorException::DocumentCreationFailure) {DocRaptor.create!(:document_content => invalid_html)}
       end
 
       it "should give me a valid response if I pass some valid content" do
-        stub_http_response_with("simple_pdf", :post)
-        assert_equal file_fixture("simple_pdf"), DocRaptor.create!(:document_content => @html_content).body
+        stub_http_response_with("simple_pdf.pdf", :post)
+        assert_equal file_fixture("simple_pdf.pdf"), DocRaptor.create!(:document_content => @html_content).body
       end
     end
   end

data/test/create_test.rb

@@ -4,6 +4,7 @@ class CreateTest < MiniTest::Unit::TestCase
   describe "calling create" do
     before do
       DocRaptor.api_key "something something"
+      DocRaptor.status_id = nil
     end
 
     describe "with bogus arguments" do
@@ -35,15 +36,54 @@ class CreateTest < MiniTest::Unit::TestCase
 
       it "should give me some error message if pass some invalid content" do
         invalid_html = "<herp"
-        stub_http_response_with("invalid_pdf", :post, 422)
+        stub_http_response_with("invalid_pdf.xml", :post, 422)
         response = DocRaptor.create(:document_content => invalid_html)
-        assert_equal file_fixture("invalid_pdf"), response.body
+        assert_equal file_fixture("invalid_pdf.xml"), response.body
         assert_equal 422, response.code
       end
 
       it "should give me a valid response if I pass some valid content" do
-        stub_http_response_with("simple_pdf", :post)
-        assert_equal file_fixture("simple_pdf"), DocRaptor.create(:document_content => @html_content).body
+        stub_http_response_with("simple_pdf.pdf", :post)
+        assert_equal file_fixture("simple_pdf.pdf"), DocRaptor.create(:document_content => @html_content).body
+      end
+    end
+
+
+    describe "with async" do
+      it "should give me a response object on successful enqueue" do
+        stub_http_response_with("simple_enqueue.json", :post, 200)
+        response = DocRaptor.create(:document_url => "http://example.com",
+                                    :async => true)
+        # HTTParty parties all over kind_of?/is_a?, so we can't use
+        # them here.
+        assert_equal HTTParty::Response, response.class
+        assert_equal response.code, 200
+      end
+
+      it "should set the status_id on successful enqueue" do
+        stub_http_response_with("simple_enqueue.json", :post,
+                                200, 'Content-Type' => "application/json")
+        response = DocRaptor.create(:document_url => "http://example.com",
+                                    :async => true)
+
+        expected_status_id = JSON.parse(file_fixture("simple_enqueue.json"))["status_id"]
+        assert_equal expected_status_id, DocRaptor.status_id
+      end
+
+      it "should give me a response object on failure to enqueue" do
+        stub_http_response_with("invalid_enqueue.xml", :post, 422)
+        response = DocRaptor.create(:document_url => "http://example.com",
+                                    :async => true)
+        # HTTParty parties all over kind_of?/is_a?, so we can't use
+        # them here.
+        assert_equal HTTParty::Response, response.class
+      end
+
+      it "should not set the status_id on failure to enqueue" do
+        stub_http_response_with("invalid_enqueue.xml", :post, 422)
+        response = DocRaptor.create(:document_url => "http://example.com",
+                                    :async => true)
+        assert DocRaptor.status_id.nil?, DocRaptor.status_id
       end
     end
   end

data/test/download_bang_test.rb

@@ -8,14 +8,14 @@ class DownloadBangTest < MiniTest::Unit::TestCase
 
     describe "with good arguments" do
       it "should give me a valid response" do
-        stub_http_response_with("simple_download", :get)
+        stub_http_response_with("simple_download.pdf", :get)
         DocRaptor.download!("test-id")
       end
     end
 
     describe "with invalid arguments" do
       it "should raise an exception" do
-        stub_http_response_with("invalid_download", :get, 400)
+        stub_http_response_with("invalid_download.xml", :get, 400)
         assert_raises(DocRaptorException::DocumentDownloadFailure) {DocRaptor.download!("test-id")}
       end
     end

data/test/download_test.rb

@@ -8,7 +8,7 @@ class DownloadTest < MiniTest::Unit::TestCase
 
     describe "with good arguments" do
       it "should give me a valid response" do
-        stub_http_response_with("simple_download", :get)
+        stub_http_response_with("simple_download.pdf", :get)
         DocRaptor.download("test-id")
       end
     end

data/test/fixtures/invalid_enqueue.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<errors>
+  <error>[Document Queueing Error] There was an error queueing your document.</error>
+</errors>

data/test/fixtures/simple_enqueue.json

@@ -0,0 +1,3 @@
+{
+  "status_id":"28a1d7a050fe012f4f92723c91dfe57c"
+}

data/test/fixtures/simple_list_docs.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<docs type="array">
+  <doc>
+    <created-at type="datetime">2011-09-01T19:22:42Z</created-at>
+    <document-type>pdf</document-type>
+    <ip-address>192.168.0.1</ip-address>
+    <javascript type="boolean">false</javascript>
+    <name>try_it_now_doc</name>
+    <tag nil="true"></tag>
+    <test type="boolean">true</test>
+  </doc>
+</docs>

data/test/list_docs_bang_test.rb

@@ -15,12 +15,12 @@ describe "list_docs!" do
 
     describe "with good arguments" do
       it "should give me a valid response" do
-        stub_http_response_with("simple_list_docs", :get)
-        assert_equal file_fixture("simple_list_docs"), DocRaptor.list_docs!.body
+        stub_http_response_with("simple_list_docs.xml", :get)
+        assert_equal file_fixture("simple_list_docs.xml"), DocRaptor.list_docs!.body
       end
 
       it "raise an exception when the list get fails" do
-        stub_http_response_with("invalid_list_docs", :get, 422)
+        stub_http_response_with("invalid_list_docs.xml", :get, 422)
         assert_raises(DocRaptorException::DocumentListingFailure) {DocRaptor.list_docs!}
       end
     end

data/test/list_docs_test.rb

@@ -15,8 +15,8 @@ class ListDocsTest < MiniTest::Unit::TestCase
 
     describe "with good arguments" do
       it "should give me a valid response" do
-        stub_http_response_with("simple_list_docs", :get)
-        assert_equal file_fixture("simple_list_docs"), DocRaptor.list_docs.body
+        stub_http_response_with("simple_list_docs.xml", :get)
+        assert_equal file_fixture("simple_list_docs.xml"), DocRaptor.list_docs.body
       end
     end
   end

data/test/status_bang_test.rb

@@ -8,14 +8,14 @@ class StatusBangTest < MiniTest::Unit::TestCase
 
     describe "with good arguments" do
       it "should give me a valid response" do
-        stub_http_response_with("simple_status", :get)
+        stub_http_response_with("simple_status.json", :get)
         DocRaptor.status!("test-id")
       end
     end
 
     describe "with invalid arguments" do
       it "should raise an exception" do
-        stub_http_response_with("invalid_status", :get, 403)
+        stub_http_response_with("invalid_status.xml", :get, 403)
         assert_raises(DocRaptorException::DocumentStatusFailure) {DocRaptor.status!("test-id")}
       end
     end

data/test/status_test.rb

@@ -8,7 +8,7 @@ class StatusTest < MiniTest::Unit::TestCase
 
     describe "with good arguments" do
       it "should give me a valid response" do
-        stub_http_response_with("simple_status", :get)
+        stub_http_response_with("simple_status.json", :get)
         DocRaptor.status("test-id")
       end
     end

data/test/test_helper.rb

@@ -1,24 +1,22 @@
 require 'rubygems'
 
-# minitest setup
 gem 'minitest'
 require 'minitest/autorun'
 require 'minitest/spec'
 require 'minitest/mock'
 require 'webmock/minitest'
-
-# pull in the docraptor code
-require File.expand_path(File.dirname(__FILE__) + "/../lib/doc_raptor")
+require 'pry'
+require "doc_raptor"
 
 class MiniTest::Unit::TestCase
-  def stub_http_response_with(filename, method = :any, status = 200)
+  def stub_http_response_with(filename, method = :any, status = 200, headers = nil)
     format = filename.split('.').last.intern
     data = file_fixture(filename)
 
-    stub_request(method, /docraptor\.com/).to_return(:body => data, :status => status)
+    stub_request(method, /docraptor\.com/).to_return(:body => data, :status => status, :headers => headers)
   end
 
   def file_fixture(filename)
-    open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read
+    open(File.join(File.dirname(__FILE__), "fixtures", "#{filename.to_s}")).read.strip
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_raptor
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-15 00:00:00.000000000Z
+date: 2012-03-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70205221784680 !ruby/object:Gem::Requirement
+  requirement: &70165480596960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 0.4.3
   type: :runtime
   prerelease: false
-  version_requirements: *70205221784680
+  version_requirements: *70165480596960
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70205221784260 !ruby/object:Gem::Requirement
+  requirement: &70165480595860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205221784260
+  version_requirements: *70165480595860
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70205221783620 !ruby/object:Gem::Requirement
+  requirement: &70165480594760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205221783620
+  version_requirements: *70165480594760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70205221783000 !ruby/object:Gem::Requirement
+  requirement: &70165480593840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205221783000
+  version_requirements: *70165480593840
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70205221782340 !ruby/object:Gem::Requirement
+  requirement: &70165480592920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,11 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205221782340
+  version_requirements: *70165480592920
 description: Provides a simple ruby wrapper around the DocRaptor API
 email:
 - michael@expectedbehavior.com
+- joel@expectedbehavior.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -97,14 +98,16 @@ files:
 - test/doc_raptor_test.rb
 - test/download_bang_test.rb
 - test/download_test.rb
-- test/fixtures/invalid_download
-- test/fixtures/invalid_list_docs
-- test/fixtures/invalid_pdf
-- test/fixtures/invalid_status
-- test/fixtures/simple_download
-- test/fixtures/simple_list_docs
-- test/fixtures/simple_pdf
-- test/fixtures/simple_status
+- test/fixtures/invalid_download.xml
+- test/fixtures/invalid_enqueue.xml
+- test/fixtures/invalid_list_docs.xml
+- test/fixtures/invalid_pdf.xml
+- test/fixtures/invalid_status.xml
+- test/fixtures/simple_download.pdf
+- test/fixtures/simple_enqueue.json
+- test/fixtures/simple_list_docs.xml
+- test/fixtures/simple_pdf.pdf
+- test/fixtures/simple_status.json
 - test/list_docs_bang_test.rb
 - test/list_docs_test.rb
 - test/status_bang_test.rb
@@ -124,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1035474426871719147
+      hash: -2661456971242108702
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1035474426871719147
+      hash: -2661456971242108702
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17
@@ -147,14 +150,16 @@ test_files:
 - test/doc_raptor_test.rb
 - test/download_bang_test.rb
 - test/download_test.rb
-- test/fixtures/invalid_download
-- test/fixtures/invalid_list_docs
-- test/fixtures/invalid_pdf
-- test/fixtures/invalid_status
-- test/fixtures/simple_download
-- test/fixtures/simple_list_docs
-- test/fixtures/simple_pdf
-- test/fixtures/simple_status
+- test/fixtures/invalid_download.xml
+- test/fixtures/invalid_enqueue.xml
+- test/fixtures/invalid_list_docs.xml
+- test/fixtures/invalid_pdf.xml
+- test/fixtures/invalid_status.xml
+- test/fixtures/simple_download.pdf
+- test/fixtures/simple_enqueue.json
+- test/fixtures/simple_list_docs.xml
+- test/fixtures/simple_pdf.pdf
+- test/fixtures/simple_status.json
 - test/list_docs_bang_test.rb
 - test/list_docs_test.rb
 - test/status_bang_test.rb

data/test/fixtures/simple_list_docs

@@ -1,12 +0,0 @@
-<?xml version=\"1.0\" encoding=\"UTF-8\"?>
-<docs type=\"array\">
-  <doc>
-    <created-at type=\"datetime\">2011-09-01T19:22:42Z</created-at>
-    <document-type>pdf</document-type>
-    <ip-address>192.168.0.1</ip-address>
-    <javascript type=\"boolean\">false</javascript>
-    <name>try_it_now_doc</name>
-    <tag nil=\"true\"></tag>
-    <test type=\"boolean\">true</test>
-  </doc>
-</docs>