doc_raptor 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58186bb6094b8f82f50d22db0144652bc6497d15
-  data.tar.gz: 44b495b22e81a2bdc7ae25207a1d2aae692e8690
+  metadata.gz: 8279d25ef018cd3b58f8c7f350f4da05ca82c473
+  data.tar.gz: 4507a790ea7e62c4f344006d77ec0ac2e8805b36
 SHA512:
-  metadata.gz: f0962a54f963bfd1920a629410b562faf55758704fa32548ec7aec3fd34700c4df4367831d1f42b9c1abf49b0b51d9dbefca87f996e5df93d3589a7ab56d22cb
-  data.tar.gz: 7857b237d2cd941c80487d4cc1188a9e6beb3f544b2d7c8931a20ec1fe39af127a96ccade6f4162ea22eb57c023358eaa8609d249279a1829cea58c42b17e50a
+  metadata.gz: b1b2a4186acbf8a2549349c7a1ef63ca4af0fc5555a38e72cfcf3b4d4044533dbe4e0f8222c07f6b54fd2bf18dc1d93e657eea448ae0f47d804b190119a95cfc
+  data.tar.gz: ded0a40ad621bfb035203c7cc9591a515ca5f74d7b09e3fb61b8c0cc3387ba7adad02a53016148c542266a87b0615aefad9818b3398f50f99117c6d3f831ae1d

data/Changelog.md

@@ -1,5 +1,9 @@
 # DocRaptor Gem Changelog
 
+## 0.4.0 - 2015/06/24
+* Add user agent for calls `expectedbehavior_doc_raptor_gem/<gem version> <ruby platform>/<version>`
+* Update development dependencies to be more modern and not have as many warnings when generating new gems
+
 ## 0.3.4 - 2015/02/20
 * Remove confusing Gemfile.lock.
 

data/README.md

@@ -9,13 +9,13 @@ The gem will look for your api key in the `ENV` variable `DOCRAPTOR_API_KEY`.  I
 not there, you can set it directly by calling:
 
 ```
-DocRaptor.api_key "My API Key Here"
+DocRaptor.api_key "YOUR_API_KEY_HERE"
 ```
 
 Once an API key is set, you can create a PDF document by calling:
 
 ```
-DocRaptor.create(:document_content => content)
+DocRaptor.create(:document_content => content, :test => true)
 ```
 
 You might want to set other options in that hash:
@@ -87,6 +87,13 @@ DocRaptor.download(download_key)
 
 The `download` function works like `DocRaptor.create` in that you get back either an HTTParty response object or you can give it a block.
 
+
+## Privacy
+
+To help us improve and support DocRaptor, this library will send DocRaptor information about the version of the gem you are using, as well as your ruby runtime. If you would like to not report that data, you can do so by calling `DocRaptor.disable_agent_tracking` when you initialize the library.
+
+At the time of writing, an example user agent string for mri ruby would be `expectedbehavior_doc_raptor_gem/0.4.3 ruby/2.2.2`.
+
 ## 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).

data/doc_raptor.gemspec

@@ -6,19 +6,20 @@ Gem::Specification.new do |gem|
   gem.name          = "doc_raptor"
   gem.authors       = ["Michael Kuehl", "Joel Meador", "Chris Moore"]
   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.description   = %q{Easily create PDF and Excel files from html in your Ruby application using 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.licenses      = ["MIT"]
 
   gem.add_dependency "httparty", ">=0.7.0"
 
-  gem.add_development_dependency "minitest", "~> 2.11.3"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "webmock", "~> 1.8.2"
+  gem.add_development_dependency "minitest", "~> 5.7"
+  gem.add_development_dependency "pry", "~> 0.10"
+  gem.add_development_dependency "rake", "~> 10"
+  gem.add_development_dependency "webmock", "~> 1.21"
 end

data/lib/doc_raptor.rb

@@ -10,11 +10,17 @@ end
 class DocRaptor
   include HTTParty
 
+  default_options[:headers] = { "User-Agent" => "expectedbehavior_doc_raptor_gem/#{DocRaptor::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION}"}
+
   def self.api_key(key = nil)
     default_options[:api_key] = key ? key : default_options[:api_key] || ENV["DOCRAPTOR_API_KEY"]
     default_options[:api_key] || raise(DocRaptorError::NoApiKeyProvidedError.new("No API key provided"))
   end
 
+  def self.disable_agent_tracking
+    default_options[:headers].delete("User-Agent")
+  end
+
   def self.create!(options = {})
     raise ArgumentError.new "please pass in an options hash" unless options.is_a? Hash
     self.create(options.merge({:raise_exception_on_failure => true}))

data/lib/doc_raptor/version.rb

@@ -1,3 +1,3 @@
 class DocRaptor
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/test/api_key_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class ApiKeyTest < MiniTest::Unit::TestCase
+class ApiKeyTest < MiniTest::Test
   describe "test API keys" do
     before do
       DocRaptor.default_options.delete :api_key

data/test/create_bang_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class CreateBangTest < MiniTest::Unit::TestCase
+class CreateBangTest < MiniTest::Test
   describe "calling create!" do
     before do
       DocRaptor.api_key "something something"

data/test/create_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class CreateTest < MiniTest::Unit::TestCase
+class CreateTest < MiniTest::Test
   describe "calling create" do
     before do
       DocRaptor.api_key "something something"
@@ -29,6 +29,24 @@ class CreateTest < MiniTest::Unit::TestCase
       end
     end
 
+    describe "user agent testing" do
+      it "sends a user agent in the header" do
+        stub_request(:post, /docraptor\.com/).with(:headers => { "User-Agent" => "expectedbehavior_doc_raptor_gem/#{DocRaptor::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION}" }).to_return(:body => "", :status => 200, :headers => nil)
+        DocRaptor.create(:document_content => "Hey")
+      end
+
+      it "doesn't send a user agent in the header if .disable_agent_tracking has been called" do
+        agent_headers = DocRaptor.default_options[:headers]["User-Agent"]
+        begin
+          stub_request(:post, /docraptor\.com/).with(:headers => {}).to_return(:body => "", :status => 200, :headers => nil)
+          DocRaptor.disable_agent_tracking
+          DocRaptor.create(:document_content => "Hey")
+        ensure
+          DocRaptor.default_options[:headers]["User-Agent"] = agent_headers
+        end
+      end
+    end
+
     describe "with document_content" do
       before do
         @html_content = "<html><body>Hey</body></html>"

data/test/doc_raptor_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class DocRaptorTest < MiniTest::Unit::TestCase
+class DocRaptorTest < MiniTest::Test
   describe "the public interface" do
     methods = [:api_key,
                :create,

data/test/download_bang_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class DownloadBangTest < MiniTest::Unit::TestCase
+class DownloadBangTest < MiniTest::Test
   describe "download!" do
     before do
       DocRaptor.api_key "something something"

data/test/download_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class DownloadTest < MiniTest::Unit::TestCase
+class DownloadTest < MiniTest::Test
   describe "download" do
     before do
       DocRaptor.api_key "something something"

data/test/list_docs_bang_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class ListDocsBangTest < MiniTest::Unit::TestCase
-describe "list_docs!" do
+class ListDocsBangTest < MiniTest::Test
+  describe "list_docs!" do
     before do
       DocRaptor.api_key "something something"
     end

data/test/list_docs_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class ListDocsTest < MiniTest::Unit::TestCase
+class ListDocsTest < MiniTest::Test
   describe "list_docs" do
     before do
       DocRaptor.api_key "something something"

data/test/status_bang_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class StatusBangTest < MiniTest::Unit::TestCase
+class StatusBangTest < MiniTest::Test
   describe "status!" do
     before do
       DocRaptor.api_key "something something"

data/test/status_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
-class StatusTest < MiniTest::Unit::TestCase
+class StatusTest < MiniTest::Test
   describe "status" do
     before do
       DocRaptor.api_key "something something"

data/test/test_helper.rb

@@ -8,7 +8,7 @@ require 'webmock/minitest'
 require 'pry'
 require "doc_raptor"
 
-class MiniTest::Unit::TestCase
+class MiniTest::Test
   def stub_http_response_with(filename, method = :any, status = 200, headers = nil)
     format = filename.split('.').last.intern
     data = file_fixture(filename)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_raptor
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Kuehl
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -32,57 +32,58 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.3
+        version: '5.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.3
+        version: '5.7'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.2
-description: Provides a simple ruby wrapper around the DocRaptor API
+        version: '1.21'
+description: Easily create PDF and Excel files from html in your Ruby application
+  using the DocRaptor API.
 email:
 - michael@expectedbehavior.com
 - joel@expectedbehavior.com
@@ -129,7 +130,8 @@ files:
 - test/status_test.rb
 - test/test_helper.rb
 homepage: http://docraptor.com
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -147,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Provides a simple ruby wrapper around the DocRaptor API