doc_raptor 0.2.2 → 0.2.3

data/.gitignore

@@ -0,0 +1,22 @@
+*~
+\#*
+.\#*
+.DS_Store
+*_flymake.*
+*.LCK
+.bundle
+vendor/bundle
+bin
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+_yardoc
+coverage
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@docraptor_gem --create

data/Changelog.md

@@ -1,38 +1,45 @@
-# DocRaptor gem Change Log
-
-## doc_raptor 0.2.2
-* bug: forgot a file in the gem
-
-## doc_raptor 0.2.1
-* bug: there were certain envs where .blank? wasn't defined. So,
+# DocRaptor Gem Changelog
+
+## 0.2.3 - 2012/03/15
+* major test refactor in preparation for bigger changes
+* use current gem packaging techniques
+* add rake into the mix so all the tests can be run with `rake` instead of `bundle exec ruby whatever`
+* readme cleanup
+* changelog cleanup
+* added dates for all the versions to the changelog
+* package all the files from the repo instead of just a few
+
+## 0.2.2 - 2011/12/07
+* BUG: forgot a file in the gem
+
+## 0.2.1 - 2011/12/07
+* BUG: there were certain envs where .blank? wasn't defined. So,
 pulling in the core_ext from activesupport
 
-## doc_raptor 0.2.0
-* tests!
+## 0.2.0 - 2011/09/01
+* added behavioral tests!
 * added a create! method which will raise an exception when doc creation fails
 * added a list_docs! method which will raise an exception when doc listing fails
 * added a status! method which will raise an exception when getting an async status fails
 * added a download! method which will raise an exception when getting an async status fails
 
-## doc_raptor 0.1.6
-* allow the gem to be used outside of places with activesupport
+## 0.1.6 - 2011/08/30
+* allow the gem to be used outside without activesupport
 
-## doc_raptor 0.1.5
-* fix bug caused by activesupport safebuffers in rails ~3.0.6 and up
+## 0.1.5 - 2011/08/29
+* BUG: activesupport safebuffers in rails ~3.0.6 and up were screwing up downloads
 
-## doc_raptor 0.1.4
+## 0.1.4 - 2011/06/24
 * add support for creating async jobs
 
-## doc_raptor 0.1.3
+## 0.1.3 - 2011/01/29
 * if a block is given to "create", make the value the block returns be the
   value create returns
 * add list_doc method, for the new api call to list created documents
 
-## doc_raptor 0.1.2
+## 0.1.2 - 2010/12/02
 * add support for the the document_url parameter to create
-
-## doc_raptor 0.1.1
 * reduce httparty requirement to 0.4.3
 
-## doc_raptor 0.1
-* Initial release
+## 0.1 - 2010/10/29
+* initial release

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    doc_raptor (0.2.3)
+      httparty (>= 0.4.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.2.7)
+    coderay (1.0.5)
+    crack (0.3.1)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    method_source (0.7.1)
+    minitest (2.11.3)
+    multi_json (1.1.0)
+    multi_xml (0.4.2)
+    pry (0.9.8.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    slop (2.4.4)
+    webmock (1.8.2)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  doc_raptor!
+  minitest
+  pry
+  rake
+  webmock

data/README.md

@@ -1,21 +1,20 @@
-DocRaptor
-==========
+# DocRaptor
 
-This is a Ruby gem providing a simple wrapper around the DocRaptor API. DocRaptor is a web service that allows you to convert [html to pdf](http://docraptor.com) or html to xls. 
+This is a Ruby gem providing a simple wrapper around the DocRaptor API. DocRaptor is a web service that allows you to convert [html to pdf](http://docraptor.com) or [html to xls](http://docraptor.com). 
 
 
-## Usage ######################################################################
+## Usage
 
-The gem will look for your api key in the ENV variable "DOCRAPTOR_API_KEY".  If it is 
+The gem will look for your api key in the `ENV` variable `DOCRAPTOR_API_KEY`.  If it is 
 not there, you can set it directly by calling:
 
-```ruby
+```
 DocRaptor.api_key "My API Key Here"
 ```
 
 Once an API key is set, you can create a PDF document by calling:
 
-```ruby
+```
 DocRaptor.create(:document_content => content)
 ```
 
@@ -26,13 +25,13 @@ You might want to set other options in that hash:
 * `:document_type` - "pdf" or "xls"; controls the type of document generated; default is "pdf"
 * `:name` - an identifier you can use for the document; shows up in doc logs; default is "default"
 * `:test` - test mode flag; set to true to while doing testing so the docs won't count against your monthly count; default is false
+* `:prince_options` - see [http://docraptor.com/documentation#pdf_options](http://docraptor.com/documentation#pdf_options) (PDFs only)
 * `:async` - create the document asynchonously; default is false
 * `:callback_url` - a url that we will hit with a status once the asynchronous document has been fully processed 
-* `:prince_options` - see http://docraptor.com/documentation#pdf_options (PDFs only)
 
 The only required parameter is one of `:document_content` or `:document_url`.
 
-`create` will return an HTTParty response object, the body of which will be the new file (or errors, if the request was not valid).
+`create` will return an [HTTParty](https://github.com/jnunemaker/httparty) response object, the body of which will be the new file (or errors, if the request was not valid).
 
 `create!` will raise an exception instead of return errors if there is a failure of any sort in the document generation process. It otherwise works in the same way as `create`.
 
@@ -40,56 +39,137 @@ If the document is processed asynchronously, a status id will be returned as opp
 
 The `create` call can also take a block, like so:
 
-```ruby
+```
 DocRaptor.create(:document_content => content) do |file, response|
   #file is a tempfile holding the response body
   #reponse is the HTTParty response object
-end 
+end
 ```
 
+### Async Doc Creation
 To get the status of an async request, you can call:
 
-```ruby  
+```
 # uses the id of the most recently created async job
 DocRaptor.status
+```
+```
 # query some other async job and make it the "active" async job for the DocRaptor class
 DocRaptor.status(status_id)
 ```
 
 `status_id` is the value returned from `DocRaptor.create` when `:async` is true.  If you have 
-just created a document, status_id defaults to the last status_id received from DocRaptor.
-This will return a hash containing, at the very least, a key of "status" with a value of 
-one of the following: { "completed", "failed", "killed", "queued", "working" }.  If the 
-status is "queued", no other information will be available.  If the status is "working", 
-there will be a human readable message contained in "message" that gives further details 
-as to the state of the document.  If the status is "complete" there will be a key of 
-"download_url" that will contain a 2 time use URL that, when visited, will provide your 
-document.  There will also be a key of "download_key" that can be given to the 
-DocRaptor.download function to obtain your document.  If the status is "killed", it means 
-the system had to abort your document generation process for an unknown reason, most 
-likely it was taking too long to generate.  If the status is "failed" you can check the 
-"messages" value for a message and the "validation_errors" value for a more detailed reason 
-for the failure to generate your document.
-
-To download an async document, you can visit the URL (download_url) provided via the status 
+just created a document, `status_id` defaults to the last `status_id` received from DocRaptor.
+This will return a hash containing, at the very least, a key of `status` with a value of 
+one of the following: `{"completed", "failed", "killed", "queued", "working"}`.
+
+* If the status is `queued`, no other information will be available.
+* If the status is `working`, there will be a human readable message contained in "message" that gives further details as to the state of the document.
+* If the status is `complete` there will be a key of "download_url" that will contain a 2 time use URL that, when visited, will provide your document.
+
+There will also be a key of `download_key` that can be given to the `DocRaptor.download` function to obtain your document.  If the status is `killed`, it means the system had to abort your document generation process for an unknown reason, most likely it was taking too long to generate.  If the status is `failed` you can check the `messages` value for a message and the `validation_errors` value for a more detailed reason for the failure to generate your document.
+
+To download an async document, you can visit the URL (`download_url`) provided via the `status` 
 function or you can call:
 
-```ruby
+```
 # uses the key of the most recently checked async job which is complete
 DocRaptor.download
+```
+```
 # use some other complete doc's download key
 DocRaptor.download(download_key)
 ```
 
-`download_key` is the value from the status hash of a call to DocRaptor.status of a completed job.  If you have just checked the status of a document and it is completed, `download_key` defaults to that of the document you just checked.  The download function works like DocRaptor.create in that you get back either an HTTParty response object or you can give it a block.
+`download_key` is the value from the status hash of a call to `DocRaptor.status` of a completed job.
 
-## Examples ###################################################################
-Check the examples directory for some simple examples. To make them work, you will need to have the docraptor gem installed (via bundler or gem install).
+* If you have just checked the status of a document and it is completed, `download_key` defaults to that of the document you just checked.
 
-For more examples including a full rails example, check https://github.com/expectedbehavior/doc_raptor_examples.
+The `download` function works like `DocRaptor.create` in that you get back either an HTTParty response object or you can give it a block.
 
-## Meta #######################################################################
+## Examples
 
-Maintained by Expected Behavior
+Check the examples directory for some simple examples. To make them work, you will need to have the docraptor gem installed (via bundler or gem install).
 
-Released under the MIT license. http://github.com/expected-behavior/docraptor-gem
+For more examples including a full rails example, check [https://github.com/expectedbehavior/doc_raptor_examples](https://github.com/expectedbehavior/doc_raptor_examples).
+
+## Meta
+
+Maintained by [Expected Behavior](http://expectedbehavior.com)
+
+Released under the MIT license. [http://github.com/expected-behavior/docraptor-gem](http://github.com/expected-behavior/docraptor-gem)
+
+## Obligatory Raptor
+
+                                                                                ''
+                                                                                -'
+                                                                               .-
+                                                                              .:'
+                                                                              :-
+                                                                             -s-
+                                                                            'sy.
+                                                                            .so'
+                                                                            -/-
+                                                                           '::.
+                                                                           .+o'
+                                                                          '+hs
+                                                                          .yh+
+                                                                          :ys-
+                                                                          :+/'
+                                                                         '/+:
+                                                                         :sy:
+                                                                        'shh.
+                                                                        -yyo
+                                                                        -//-
+                                                                       ':/:'
+                                                                       :+o/
+                                                                      'syy:
+                           '                                          :yyy.
+                        '':+-                                        '/oo+
+                    '..-++o++//-'                                    .///.
+                ./++oooooooso+oo+.                                  '/++/'
+               -oosssoosydddhhsosy+-                                :yyh+
+              .sssyssshddyhddhhhsyso'                              -yhhh-
+              -syyyyddmmmhyddhyhysyy/                             '+shho'
+             -syyydmmmddmddhhyyyysyhy-                           '-//+o-
+           ./yyhhmmddddhhhyysssyyyydhy.                         '/ooo+:
+          :syyydmhdddddhyyyssyyyyhhhhho                        .+hddhs.
+        '/ossyhhhhhddhhhhhhdhhyhhhhhhhh:       ''....''       .+shddd/
+        :syosyhhhyyyyhdmddhyyyyyyyhhdhhh-''.-:/++++oooo+/:. ':+ooooso'
+       .+ysoosyyyyyydNmmdyyyyyoosyhdddddho//+osooooosyhyooyoooyhhys+.
+       -oo+++sssyyhmNmmdyyyo-'-/osyhhdddddhssssyyyssyyhhhsyhhysshhy:
+      ':+++oossyhdNNmmhyy+.    -/+osyhhddddddhhhhhyyyhdddhhdmhhyyho'
+        '''.:yydNmmdhyy+.       ./+syyhhddddmddhdhhyyhdmmdddmmhhys.
+            /yydmmhyys:          .:+osyhdddddddddhhhhdmmddhyyddyy+
+           '+syhyssyo.           .+/+oshhdddddddhhhhhdNmhyysoohyyo'
+           '/+sooss/'            /oo+ooshddddhhhhyhhdmmhysyhdsshyo-
+            -/o++:'              /++osssyhhhhyyyyyyhdddhhhhmNyohys:
+              '                 :o+++osssyyyyyyssyyhdmmddmmmmhohhs+
+                               .oo++oosssyyyysyssyhmNNmmmmdhyooddyo'
+                               :/+ssysssyyysyyyyyhdmNNNmyyhyooshhys'
+                              ':/sddddhysyssyyyyhhhdmNNysosoooshhyy'
+                              ./oyddmmmmmhhyyyyssoosyhdy+ososyshhh+
+                              -+yhdddmNmNNmNNmmo/+oyyhhs+osshyshhh/
+                              :+hdhhddmmmmmmmNd'  '-syhyoshhhsyyyyo'
+                             .:odmddddmNmmdddmm+    ./ssoshdhsyysss/
+                             ./ohmmmy:smmddhhdmh'     ''-oshhysssyys'
+                             ./+hdmNd-:mmddhhddo        .osydhhyyhho'
+                             ./+ydmNMmydmmdddhh:        .ssyhddyyhh/
+                              odsydmNMNydmmddhh-        .ossyhdhyyy.
+                              ./'-sdmNN+/dmmddd:         +hyssysyyh-
+                                  'oyh/.'odddmm/         ohysoossyho'
+                                   ':hd:'/hhhdmo         '.-/+ooosys'
+                                     '-+osyhhdmy'            '/+osy/
+                                         .syyhhh.            '/+osy.
+                                         'osssys'            -+ooss.
+                                         '/ooos+'           '/oosss.
+                                          :oo+o+'          -shhhyyy/
+                                         '+ss+oy.         .yNmmmdhys.
+                                         smNdshd:          -ydmdhyys/'
+                                        .mNNdydms           :yhyyhy++/.
+                                       '+ddyyhdy:            -sddddo++s+'
+                                  '.-/ohdmNdyyy'             'odmyss+odd/
+                              -+oyhhhhdmmmmdhy+               ':-    '.:.
+                            'sMmoosshmmNdmmh/.
+                            -oo+---/ddmMhho'
+                                    :++:-'

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc "Default: run unit tests."
+task :default => :test
+
+desc "Test the eb-patches gem"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/doc_raptor.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push(File.expand_path "../lib", __FILE__)
+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.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"
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+  gem.version       = DocRaptor::VERSION
+
+  gem.add_dependency "httparty", ">=0.4.3"
+
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "webmock"
+end

data/examples/async_ruby_example.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'doc_raptor'
+
+TEN_SECONDS = 10
+FIVE_MINUTES = 300
+
+DocRaptor.api_key "YOUR_API_KEY_HERE"
+
+pdf_html = '<html><body>I am an asynchronously-created doc.</body></html>'
+
+def pretty_time; Time.now.strftime("%I:%M:%S %p"); end
+def print_status(status = {}); puts "#{pretty_time} - Status: #{status['status']}";end
+
+status_id = DocRaptor.create(:document_content => pdf_html,
+                             :name             => "docraptor_sample.pdf",
+                             :document_type    => "pdf",
+                             :test             => true,
+                             :async            => true)
+
+# This timeout is 5 minutes.
+# If there is no load on the background processors, this test should take (far) less than 20s. It's possible production will be backed up with real jobs, hence the timeout.
+timeout_time = Time.now + FIVE_MINUTES
+
+status = {'status' => 'queued'}
+
+print_status(status)
+while !(['completed','failed'].include? status['status']) && Time.now <= timeout_time
+  sleep TEN_SECONDS
+  status = DocRaptor.status
+  print_status(status)
+end
+
+if status['status'] == 'completed'
+  file = DocRaptor.download
+  File.open("docraptor_sample.pdf", "w+b") do |f|
+    f.write file.response.body
+  end
+  puts "#{pretty_time} - File downloaded to docraptor_sample.pdf"
+end

data/examples/docraptor_gem_example.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'doc_raptor'
+
+DocRaptor.api_key "YOUR_API_KEY_HERE"
+
+xls_html = "<table><tr><td>I am a test cell.</td><td>So am I</td></tr></table>"
+File.open("docraptor_sample.xls", "w+") do |f| 
+  f.write DocRaptor.create(:document_content => xls_html,
+                           :name             => "docraptor_sample.xls",
+                           :document_type    => "xls",
+                           :test             => true)
+end
+
+pdf_html = '<html><body>I am a test doc!</body></html>'
+File.open("docraptor_sample.pdf", "w+") do |f| 
+  f.write DocRaptor.create(:document_content => pdf_html,
+                           :name             => "docraptor_sample.pdf",
+                           :document_type    => "pdf",
+                           :test             => true)
+end

data/lib/doc_raptor.rb

@@ -1,34 +1,10 @@
 require "httparty"
 require "tempfile"
-require File.expand_path(File.dirname(__FILE__) + "/core_ext/object/blank")
 
-module DocRaptorError
-  class NoApiKeyProvidedError < RuntimeError; end
-  class NoContentError < ArgumentError; end
-end
-
-module DocRaptorException
-  class DocRaptorRequestException < StandardError
-    attr_accessor :status_code
-    attr_accessor :message
-    def initialize(message, status_code)
-      self.message = message
-      self.status_code = status_code
-      super message
-    end
-
-    def to_s
-      "#{self.class.name}\nHTTP Status: #{status_code}\nReturned: #{message}"
-    end
-
-    def inspect
-      self.to_s
-    end
-  end
-  class DocumentCreationFailure < DocRaptorRequestException; end
-  class DocumentListingFailure < DocRaptorRequestException; end
-  class DocumentStatusFailure < DocRaptorRequestException; end
-  class DocumentDownloadFailure < DocRaptorRequestException; end
+["/core_ext/object/blank",
+ "/doc_raptor/error",
+ "/doc_raptor/exception"].each do |filename|
+  require File.expand_path(File.dirname(__FILE__) + filename)
 end
 
 class DocRaptor

data/lib/doc_raptor/error.rb

@@ -0,0 +1,4 @@
+module DocRaptorError
+  class NoApiKeyProvidedError < RuntimeError; end
+  class NoContentError        < ArgumentError; end
+end

data/lib/doc_raptor/exception.rb

@@ -0,0 +1,23 @@
+module DocRaptorException
+  class DocRaptorRequestException < StandardError
+    attr_accessor :status_code
+    attr_accessor :message
+    def initialize(message, status_code)
+      self.message     = message
+      self.status_code = status_code
+      super message
+    end
+
+    def to_s
+      "#{self.class.name}\nHTTP Status: #{status_code}\nReturned: #{message}"
+    end
+
+    def inspect
+      self.to_s
+    end
+  end
+  class DocumentCreationFailure < DocRaptorRequestException; end
+  class DocumentListingFailure  < DocRaptorRequestException; end
+  class DocumentStatusFailure   < DocRaptorRequestException; end
+  class DocumentDownloadFailure < DocRaptorRequestException; end
+end

data/lib/doc_raptor/version.rb

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

data/test/api_key_test.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class ApiKeyTest < MiniTest::Unit::TestCase
+  describe "test API keys" do
+    before do
+      DocRaptor.default_options.delete :api_key
+      ENV.delete "DOCRAPTOR_API_KEY"
+      @test_key = "Test Key!"
+    end
+
+    it "should throw an error if no api key is provided via a key, set in the environment, or already set on the DocRaptor class object" do
+      assert_raises(DocRaptorError::NoApiKeyProvidedError) {DocRaptor.api_key}
+    end
+
+    it "should read the api key from the ENV" do
+      ENV["DOCRAPTOR_API_KEY"] = @test_key
+      assert_equal @test_key, DocRaptor.api_key
+    end
+
+    it "changes to the ENV variable shouldn't be implicitly picked up" do
+      ENV["DOCRAPTOR_API_KEY"] = @test_key
+      DocRaptor.api_key
+
+      ENV["DOCRAPTOR_API_KEY"] = "some other key"
+      assert_equal @test_key, DocRaptor.api_key
+    end
+
+    it "should use the passed in key" do
+      assert_equal @test_key, DocRaptor.api_key(@test_key)
+    end
+
+    it "should persist the passed in key on subsequent calls" do
+      DocRaptor.api_key(@test_key)
+      assert_equal @test_key, DocRaptor.api_key
+    end
+
+    it "should override keys when passed in explicitly" do
+      other_key = "some other key"
+      DocRaptor.api_key(@test_key)
+      assert_equal other_key, DocRaptor.api_key(other_key)
+    end
+
+    it "should persist overridden keys" do
+      other_key = "some other key"
+      DocRaptor.api_key(@test_key)
+      DocRaptor.api_key(other_key)
+      assert_equal other_key, DocRaptor.api_key
+    end
+  end
+end

data/test/create_bang_test.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class CreateBangTest < MiniTest::Unit::TestCase
+  describe "calling create!" do
+    before do
+      DocRaptor.api_key "something something"
+    end
+
+    describe "with bogus arguments" do
+      it "should raise an error if something other than an options hash is passed in" do
+        assert_raises(ArgumentError) {DocRaptor.create!(true)}
+        assert_raises(ArgumentError) {DocRaptor.create!(nil)}
+      end
+
+      it "should raise an error if document_content and document_url are both unset" do
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create!}
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create!({:herped => :the_derp})}
+      end
+
+      it "should raise an error if document_content is passed by is blank" do
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create!(:document_content => nil)}
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create!(:document_content => "")}
+      end
+
+      it "should raise an error if document_url is passed by is blank" do
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create!(:document_url => nil)}
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create!(:document_url => "")}
+      end
+    end
+
+    describe "with document_content" do
+      before do
+        @html_content = "<html><body>Hey</body></html>"
+      end
+
+      it "should give me some error message if pass some invalid content" do
+        invalid_html = "<herp"
+        stub_http_response_with("invalid_pdf", :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
+      end
+    end
+  end
+end

data/test/create_test.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class CreateTest < MiniTest::Unit::TestCase
+  describe "calling create" do
+    before do
+      DocRaptor.api_key "something something"
+    end
+
+    describe "with bogus arguments" do
+      it "should raise an error if something other than an options hash is passed in" do
+        assert_raises(ArgumentError) {DocRaptor.create(true)}
+        assert_raises(ArgumentError) {DocRaptor.create(nil)}
+      end
+
+      it "should raise an error if document_content and document_url are both unset" do
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create}
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create({:herped => :the_derp})}
+      end
+
+      it "should raise an error if document_content is passed by is blank" do
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create(:document_content => nil)}
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create(:document_content => "")}
+      end
+
+      it "should raise an error if document_url is passed by is blank" do
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create(:document_url => nil)}
+        assert_raises(DocRaptorError::NoContentError) {DocRaptor.create(:document_url => "")}
+      end
+    end
+
+    describe "with document_content" do
+      before do
+        @html_content = "<html><body>Hey</body></html>"
+      end
+
+      it "should give me some error message if pass some invalid content" do
+        invalid_html = "<herp"
+        stub_http_response_with("invalid_pdf", :post, 422)
+        response = DocRaptor.create(:document_content => invalid_html)
+        assert_equal file_fixture("invalid_pdf"), 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
+      end
+    end
+  end
+end

data/test/doc_raptor_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class DocRaptorTest < MiniTest::Unit::TestCase
+  describe "the public interface" do
+    methods = [:api_key,
+               :create,
+               :create!,
+               :list_docs,
+               :list_docs!,
+               :status,
+               :status!,
+               :download,
+               :download!].each do |method_name|
+      it "should respond to #{method_name}" do
+        assert DocRaptor.respond_to?(method_name)
+      end
+    end
+  end
+
+  # TODO basic tests of the various exception/error classes beyond
+  # what is used in the gem functionality tests
+end

data/test/download_bang_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class DownloadBangTest < MiniTest::Unit::TestCase
+  describe "download!" do
+    before do
+      DocRaptor.api_key "something something"
+    end
+
+    describe "with good arguments" do
+      it "should give me a valid response" do
+        stub_http_response_with("simple_download", :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)
+        assert_raises(DocRaptorException::DocumentDownloadFailure) {DocRaptor.download!("test-id")}
+      end
+    end
+  end
+end

data/test/download_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class DownloadTest < MiniTest::Unit::TestCase
+  describe "download" do
+    before do
+      DocRaptor.api_key "something something"
+    end
+
+    describe "with good arguments" do
+      it "should give me a valid response" do
+        stub_http_response_with("simple_download", :get)
+        DocRaptor.download("test-id")
+      end
+    end
+  end
+end

data/test/fixtures/invalid_download

@@ -0,0 +1,4 @@
+<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<errors>
+  <error>[Download Key Error] The supplied download key is not valid.</error>
+</errors>

data/test/fixtures/invalid_list_docs

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<errors>
+  <error>Something went horribly awry!</error>
+</errors>

data/test/fixtures/invalid_pdf

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<errors>
+  <error>Document Malformed: Tag herp invalid</error>
+  <error>Document Malformed: Couldn't find end of Start Tag herp</error>
+</errors>

data/test/fixtures/invalid_status

@@ -0,0 +1,4 @@
+<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<errors>
+  <error>[Authentication Error] You do not have permission to view the status of this document.</error>
+</errors>

data/test/fixtures/simple_list_docs

@@ -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/fixtures/simple_status

@@ -0,0 +1,6 @@
+{
+  "status":"completed",
+  "message":"Completed at Thu Sep 01 20:02:52 +0000 2011",
+  "download_url":"http://docraptor.com/download/ffffffffffd74b4a993fcae917699ed7",
+  "number_of_pages":1
+}

data/test/list_docs_bang_test.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class ListDocsBangTest < MiniTest::Unit::TestCase
+describe "list_docs!" do
+    before do
+      DocRaptor.api_key "something something"
+    end
+
+    describe "with bogus arguments" do
+      it "should raise an error if something other than an options hash is passed in" do
+        assert_raises(ArgumentError) {DocRaptor.list_docs!(true)}
+        assert_raises(ArgumentError) {DocRaptor.list_docs!(nil)}
+      end
+    end
+
+    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
+      end
+
+      it "raise an exception when the list get fails" do
+        stub_http_response_with("invalid_list_docs", :get, 422)
+        assert_raises(DocRaptorException::DocumentListingFailure) {DocRaptor.list_docs!}
+      end
+    end
+  end
+end

data/test/list_docs_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class ListDocsTest < MiniTest::Unit::TestCase
+  describe "list_docs" do
+    before do
+      DocRaptor.api_key "something something"
+    end
+
+    describe "with bogus arguments" do
+      it "should raise an error if something other than an options hash is passed in" do
+        assert_raises(ArgumentError) {DocRaptor.list_docs(true)}
+        assert_raises(ArgumentError) {DocRaptor.list_docs(nil)}
+      end
+    end
+
+    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
+      end
+    end
+  end
+end

data/test/status_bang_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class StatusBangTest < MiniTest::Unit::TestCase
+  describe "status!" do
+    before do
+      DocRaptor.api_key "something something"
+    end
+
+    describe "with good arguments" do
+      it "should give me a valid response" do
+        stub_http_response_with("simple_status", :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)
+        assert_raises(DocRaptorException::DocumentStatusFailure) {DocRaptor.status!("test-id")}
+      end
+    end
+  end
+end

data/test/status_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class StatusTest < MiniTest::Unit::TestCase
+  describe "status" do
+    before do
+      DocRaptor.api_key "something something"
+    end
+
+    describe "with good arguments" do
+      it "should give me a valid response" do
+        stub_http_response_with("simple_status", :get)
+        DocRaptor.status("test-id")
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+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")
+
+class MiniTest::Unit::TestCase
+  def stub_http_response_with(filename, method = :any, status = 200)
+    format = filename.split('.').last.intern
+    data = file_fixture(filename)
+
+    stub_request(method, /docraptor\.com/).to_return(:body => data, :status => status)
+  end
+
+  def file_fixture(filename)
+    open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read
+  end
+end

metadata

@@ -1,88 +1,162 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: doc_raptor
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.2.3
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
 platform: ruby
-authors: 
+authors:
 - Michael Kuehl
 - Joel Meador
 - Chris Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-29 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70205221784680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 0
-        - 4
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.4.3
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *70205221784680
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70205221784260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70205221784260
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70205221783620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70205221783620
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70205221783000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70205221783000
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70205221782340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70205221782340
 description: Provides a simple ruby wrapper around the DocRaptor API
-email: michael@expectedbehavior.com
+email:
+- michael@expectedbehavior.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .gitignore
+- .rvmrc
 - Changelog.md
-- README.md
+- Gemfile
+- Gemfile.lock
 - MIT-LICENSE
-- lib/doc_raptor.rb
+- README.md
+- Rakefile
+- doc_raptor.gemspec
+- examples/async_ruby_example.rb
+- examples/docraptor_gem_example.rb
 - lib/core_ext/object/blank.rb
-has_rdoc: true
+- lib/doc_raptor.rb
+- lib/doc_raptor/error.rb
+- lib/doc_raptor/exception.rb
+- lib/doc_raptor/version.rb
+- test/api_key_test.rb
+- test/create_bang_test.rb
+- test/create_test.rb
+- 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/list_docs_bang_test.rb
+- test/list_docs_test.rb
+- test/status_bang_test.rb
+- test/status_test.rb
+- test/test_helper.rb
 homepage: http://docraptor.com
 licenses: []
-
 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: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1035474426871719147
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1035474426871719147
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: wrap up the api for DocRaptor nicely
-test_files: []
-
+summary: Provides a simple ruby wrapper around the DocRaptor API
+test_files:
+- test/api_key_test.rb
+- test/create_bang_test.rb
+- test/create_test.rb
+- 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/list_docs_bang_test.rb
+- test/list_docs_test.rb
+- test/status_bang_test.rb
+- test/status_test.rb
+- test/test_helper.rb