RubyGems - pdfthat-client - Versions diffs - 0.0.1 → 0.0.2 - Mend

pdfthat-client 0.0.1 → 0.0.2

Files changed (6) hide show

data/README.rdoc +111 -1
data/VERSION +1 -1
data/lib/pdfthat-client.rb +14 -4
data/pdfthat-client.gemspec +58 -0
data/spec/pdfthat-client_spec.rb +35 -34
metadata +3 -2

data/README.rdoc CHANGED

@@ -1,7 +1,117 @@
 = pdfthat-client
-Description goes here.
+This gem allows you to play nicely with http://pdfth.at
+== Overview
+pdfTH.AT is a HTML to PDF rendering system that allows you to hand in HTML or a URL and have that rendered into a PDF.   This can be done on a queue and posted back to your system, or rendered in real time and returned as base64 encoded data.
+You'll need a free account from http://pdfth.at to play along, log in and get your token to access the system.
+== Requirements
+* HTTParty >= 0.5.2
+== Installation
+This library is intended to be installed as a Gem.
+  $ gem install pdfthat-client
+You might need administrator privileges on your system to install it.
+== Getting Started
+You'll need an API token to use this gem, head over to http://pdfth.at to sign up for one, development accounts are free and can be used straight away.
+Include the gem in your Gemfile, if you are running Rails
+  gem "pdfthat-client", :require => "pdfthat"
+Include it like any other gem otherwise
+  require 'pdfthat'
+If using rails, Initialise the library in a preinitializer
+  Pdfthat.configure do |pdf|
+    pdf.token = "<token goes here>"
+  end
+Otherwise, initialise it before you use it.
+By Default, the client will be talking to the pdfthat DEVELOPMENT api, to override this setting:
+  Pdfthat.configure do |pdf|
+    pdf.token = "<token goes here>"
+    pdf.production = true
+  end
+== Usage
+Using the pdfTHAT Queue for a URL
+  Pdfthat.create_document(:document => {:url => "http://google.com.au/"})
+Using the pdfTHAT Queue for a URL with a postback
+  Pdfthat.create_document(:document => {:url => "http://google.com.au/", :postback_url => "http://exampl.com/documents/done"})
+Using the pdfTHAT Queue for HTML
+  Pdfthat.create_document(:document => {:html_string => "<html><head><title>My Page</title></head><body><strong>This is my page</strong></body></html>"})
+Using the pdfTHAT Queue for HTML with a postback
+  Pdfthat.create_document(:document => {:html_string => "<html><head><title>My Page</title></head><body><strong>This is my page</strong></body></html>", :postback_url => "http://exampl.com/documents/done"})
+Using pdfTHAT in real-time for a URL
+  Pdfthat.create_document(:document => {:url => "http://google.com.au/",:wait_for_pdf => true})
+Using pdfTHAT in real-time for HTML
+  Pdfthat.create_document(:document => {:url => "<html><head><title>My Page</title></head><body><strong>This is my page</strong></body></html>",:wait_for_pdf => true})
+The results of these calls will be similar to:
+  {"s3_bucket"=>"bucket",
+   "media_type"=>"screen",
+   "created_at"=>"Mon Feb 22 00:30:56 UTC 2010",
+   "upload_time"=>nil,
+   "upload_results"=>nil,
+   "error_messages"=>[],
+   "uuid"=>"76f93970-0177-012d-4131-0026b0d759a2",
+   "updated_at"=>"Mon Feb 22 00:30:56 UTC 2010",
+   "postback_url"=>nil,
+   "url"=>"http://google.com.au/",
+   "render_time"=>nil,
+   "storage_url"=>
+    "http://s3.amazonaws.com/bucket/76f93970-0177-012d-4131-0026b0d759a2.pdf",
+   "return_pdf"=>false,
+   "id"=>202,
+   "successful"=>true,
+   "user_id"=>1,
+   "styles"=>nil,
+   "render_results"=>nil,
+   "media"=>"screen",
+   "development"=>false,
+   "workflow_state"=>"new",
+   "wait_for_pdf"=>false,
+   "postback_time"=>nil,
+   "html_string"=>nil,
+   "postback_results"=>nil}
+To query the document at a later date, use:
+  Pdfthat.get_document(:id => "76f93970-0177-012d-4131-0026b0d759a2")
+It'll return the same result as the create_document method.
+NOTE: If you are using the wait_for_pdf method, you will also get an attribute called "base64_pdf_data" that includes the PDF file encoded in base64.  This is only available in the results of the create method, to access the document after that, use the storage_url attribute
 == Note on Patches/Pull Requests
 * Fork the project.

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 0.0.1
1	+ 0.0.2

data/lib/pdfthat-client.rb CHANGED

@@ -3,6 +3,12 @@ class Pdfthat
   include HTTParty
   class << self
     attr :token,true
+    attr :production,true
+    def production(d)
+      @production = d
+    end
     def token(t)
       @token = t
     end
@@ -15,19 +21,23 @@ class Pdfthat
     def configure
       yield self
-    end
+    end
+    def api_uri
+      dev_uri = @production == true ?  "" :  "/development"
+      "/api/v1#{dev_uri}"
+    end
     def create_document(options)
       return false unless @token
-      results = post('/documents.json', :query => options.merge(:token => @token))
+      results = post(api_uri + "/documents.json", :query => options.merge(:token => @token))
       return results
     end
     def get_document(options)
       return false unless @token
-      results = get("/documents/#{options[:id]}.json", :query => options.merge(:token => @token))
+      results = get(api_uri + "/documents/#{options[:id]}.json", :query => options.merge(:token => @token))
       return results
     end
   end
 end
 # Pdfthat.configure do |pdf|

data/pdfthat-client.gemspec ADDED

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{pdfthat-client}
+  s.version = "0.0.2"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mattallen"]
+  s.date = %q{2010-02-22}
+  s.description = %q{Client to intereact with the pdfTH.AT services}
+  s.email = %q{matt@devlogic.com.au}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/pdfthat-client.rb",
+     "pdfthat-client.gemspec",
+     "spec/pdfthat-client_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mattallen/pdfthat-client}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Client for http://pdfth.at}
+  s.test_files = [
+    "spec/pdfthat-client_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<httparty>, [">= 0.5.2"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+  end
+end

data/spec/pdfthat-client_spec.rb CHANGED

@@ -1,40 +1,41 @@
-require 'httparty'
-class Pdfthat
-  include HTTParty
-  class << self
-    attr :token,true
-    def token(t)
-      @token = t
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe "Pdfth.atRubyClient" do
+  context 'defaults' do
+    it "should set it's default URL" do
+      Pdfthat.base_uri.should == "http://pdfth.at"
     end
-    def default_options
-      @default_options[:timeout]  ||= 10000
-      @default_options[:base_uri] ||= "http://pdfth.at"
-      super
+    it "should set the default timeout to 10 seconds" do
+      Pdfthat.default_options[:timeout].should == 10000
     end
-    def configure
-      yield self
-    end
-    def create_document(options)
-      return false unless @token
-      results = post('/documents.json', :query => options.merge(:token => @token))
-      return results
+    it "should default to development" do
+      Pdfthat.api_uri.should == "/api/v1/development"
     end
-    def get_document(options)
-      return false unless @token
-      results = get("/documents/#{options[:id]}.json", :query => options.merge(:token => @token))
-      return results
+    it "should allow development to be over-written" do
+      Pdfthat.configure do |pdf|
+        pdf.production true
+      end
+      Pdfthat.api_uri.should == "/api/v1"
+    end
+  end
+  context '#get_document' do
+    it "should fail without a token" do
+      Pdfthat.get_document(:id => "abc").should == false
+    end
+    it "should pass with a token" do
+      Pdfthat.configure do |pdf|
+        pdf.token "629f29cb8d7c3de87fc248ea400b679688b3d5a128c01c981c"
+        pdf.base_uri "http://pdf.local"
+      end
+      Pdfthat.get_document(:id => "2f5321a0-0163-012d-412f-0026b0d759a2").should be_a(Hash)
+    end
+  end
+  context '#create_document' do
+    it "should fail without a token" do
+      Pdfthat.configure do |pdf|
+        pdf.token = nil
+      end
+      Pdfthat.create_document(:document => {:url => "http://google.com.au/"}).should == false
     end
   end
 end
-# Pdfthat.configure do |pdf|
-#   pdf.token = "629f29cb8d7c3de87fc248ea400b679688b3d5a128c01c981c"
-#   pdf.default_options = {:timeout => 1}
-#   pdf.base_uri 'http://pdf.local'
-#
-# end
-# p = Pdfthat.new
-# puts p.get_document(:id => "2f5321a0-0163-012d-412f-0026b0d759a2")

metadata CHANGED

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments:
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors:
 - mattallen
@@ -62,6 +62,7 @@ files:
 - Rakefile
 - VERSION
 - lib/pdfthat-client.rb
+- pdfthat-client.gemspec
 - spec/pdfthat-client_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb