docraptor-cli 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3861beebf73e13d32696baab15abdcfd024ee27e
-  data.tar.gz: 6bb03d210ddc751d310f01480290f8b39ca28fa5
+  metadata.gz: 728d1be587631813091655e13ceaad145e55ece5
+  data.tar.gz: a159b7a50d484292fe2f64160d09960909fab681
 SHA512:
-  metadata.gz: d4d8a642ca6e6fb4fdb6dafaeb2c677006049a12cb3e2bd7ea97d846e744656da733426c05e956291bb349a0fefa429af1072b567d9d58e42590f5d8561c7beb
-  data.tar.gz: a00392e4d111a2646b0699a258fb189f7e6d8dc35b0fd0969c637057dff6489b4243d946f51e3a995c30d987a357506c7ee75555e911ede378d7c9aa2e41b31f
+  metadata.gz: eaf07e23b371c5c50298201e7287a8b34f8d65265444cb5233b3386c7f9b055c31df70de5674c57ae57dfe426863affacc683ea0174df6a2077e676f05c5abf5
+  data.tar.gz: 3c7fca6ccddc55604e018c339a4bc79d0290b6b9f4fd2b7a5c73edeadaf5d4da8c6384dcbd149a96464802a28bfc94fb69c939b576d273435780e2acd1ad4bd4

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 0.1.0 [July 14, 2016]
+* add [`callback_url` option](https://docraptor.com/documentation/api#api_callback_url)
+
 ### 0.0.4 [May 23, 2016]
 * Don't use bundler to load gems during execution
 * Use short binary name when showing help

data/README.md

@@ -54,6 +54,38 @@ We have guides for doing some of the common things:
 * [CSS Media Selector](https://docraptor.com/documentation/api#api_basic_pdf) to make the page look exactly as it does in your browser
 * Protect content with [HTTP authentication](https://docraptor.com/documentation/api#api_http_user) or [proxies](https://docraptor.com/documentation/api#api_http_proxy) so only DocRaptor can access them
 
+## Testing Callbacks
+
+The `--callback-url` option can be used to set a URL that will receive a POST request after your document has successfully been processed. You can simulate this in your *nix development environment using a couple of simple tools: [`nc`](http://linux.die.net/man/1/nc) and [`ngrok`](https://ngrok.com/).
+
+Let's say you had some document content in a file named `test.html`. To test the callback URL, start a new console and type:
+
+```
+nc -lk 9001
+```
+
+This will listen on port `9001` for requests. Now open another console and type in:
+```
+ngrok http 9001
+```
+
+This will setup an external URL that port forwards to port `9001` on your computer (conveniently being listened to by `nc`). Note the ngrok http URL. It should look something like `http://87654321.ngrok.io`. Copy that URL and open a third console where we will generate our document:
+```
+bin/docraptor test.html --async --callback_url "http://87654321.ngrok.io"
+```
+
+After the document has been generated, if we go to our console running `nc`, we should see we got an HTTP POST request that looks something like this:
+
+```
+POST / HTTP/1.1
+Connection: close
+Host: d94c779c.ngrok.io
+Content-Length: 139
+Content-Type: application/x-www-form-urlencoded
+X-Forwarded-For: 54.158.114.123
+
+download_url=https%3A%2F%2Fdocraptor.com%2Fdownload%2Fe4eabaca-f811-49f8-9375-fcb9cdeae5aa&download_id=e4eabaca-f811-49f8-9375-fcb9cdeae5aa
+```
 
 ## More Help
 

data/bin/docraptor

@@ -53,6 +53,10 @@ opt_parser = OptionParser.new do |opts|
     options[:async] = async
   end
 
+  opts.on("--callback_url url", "Set a callback URL to be notified upon success.") do |callback_url|
+    options[:callback_url] = callback_url
+  end
+
   opts.on("-d", "--debug", "Enable debug logging.") do
     options[:debug] = true
   end
@@ -236,6 +240,8 @@ all_doc_attributes = {
   ignore_resource_errors: options[:ignore_resource_errors],
 }
 
+all_doc_attributes[:callback_url] = options[:callback_url] if options[:callback_url]
+
 all_doc_attributes[:prince_options][:version]       = options[:prince_version] if options[:prince_version]
 all_doc_attributes[:prince_options][:javascript]    = options[:prince_javascript] if options[:prince_javascript]
 all_doc_attributes[:prince_options][:media]         = options[:prince_media] if options[:prince_media]

data/lib/docraptor-cli/version.rb

@@ -1,3 +1,3 @@
 module DocRaptorCli
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docraptor-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Elijah Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docraptor