RubyGems - restful_press - Versions diffs - 0.0.1 - Mend

restful_press 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

data/LICENSE +20 -0
data/README.rdoc +71 -0
data/VERSION +1 -0
data/lib/restful_press.rb +23 -0
data/lib/restful_press/client.rb +100 -0
data/lib/restful_press/connection.rb +139 -0
data/lib/restful_press/endpoint.rb +27 -0
data/lib/restful_press/hash_utils.rb +28 -0
data/lib/restfulpress.rb +2 -0
data/spec/restful_press_spec.rb +7 -0
data/spec/spec_helper.rb +9 -0
metadata +126 -0

data/LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gemini SBS, LLC
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc ADDED

@@ -0,0 +1,71 @@
+= Resftul Press
+Ruby client for the Resful Press API. Uses the YAJL library for fast JSON decoding.
+== About Restful Press
+Restful Press is an automated service for converting your app's views into PDFs. There is no special PDF DSL required.
+You simply write your views in HAML, ERB or Mustache as you always have and Restful Press takes care of the rest.
+Each request to render your PDF is referred to as a *job* by the Restful Press service. This client follows that nomenclature.
+== Install
+  gem install restful_press
+== Usage
+=== Initialize the client
+  require 'restful_press'
+  ➔ true
+  RestfulPress::Client.set_credentials('my_api_key')
+  ➔ true
+=== View your jobs
+  RestfulPress::Client.get_jobs
+  ➔ [{:complete=>false, :id=>9, :filename=>"export.pdf"}, {:complete=>true, :id=>10, :filename=>"products.pdf"}]
+  RestfulPress::Client.get_job(9)
+  ➔ {:complete=>false, :id=>9, :filename=>"export.pdf"}
+  RestfulPress::Client.job_url(9)
+  ➔ "http://restfulpress.com/jobs/9/download"
+  RestfulPress::Client.job_complete?(9)
+  ➔ false
+=== Deleting jobs
+  RestfulPress::Client.delete_job(9)
+  ➔ true
+=== Creating Jobs
+  RestfulPress::Client.add_job(:html_doc => "<html><h1>Hello,</h1> this is a test</html>", :pdf_options => { :page_size => "Letter" })
+  ➔ true
+Note: For a full list of supported PDF options, please see the *Supported PDF Options* section of this document
+== Integration with Rails
+Coming soon.
+== Supported PDF Options
+Coming soon.
+== Dependencies
+* {yajl-ruby}[http://github.com/brianmario/yajl-ruby] (Ruby wrapper around the great {yajl}[http://lloyd.github.com/yajl])
+* {rest-client}[http://github.com/archiloque/rest-client]
+== Copyright
+Copyright (c) 2010 Gemini SBS. See LICENSE for details.
+== Authors
+* {Mauricio Gomes}[http://github.com/mgomes]

data/VERSION ADDED

	@@ -0,0 +1 @@
1	+ 0.0.1

data/lib/restful_press.rb ADDED

@@ -0,0 +1,23 @@
+require 'uri'
+require 'yajl'
+require 'rest_client'
+require 'restful_press/connection'
+require 'restful_press/endpoint'
+require 'restful_press/hash_utils'
+require 'restful_press/client'
+module RestfulPress
+  REALM = "http://quick-pdf.geminisbs.net"
+  VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
+  class RestfulPressError < StandardError; end
+  class Unauthorized < RestfulPressError; end
+  class NotFound < RestfulPressError; end
+  class APIKeyExpired < RestfulPressError; end
+  class MethodNotAllowed < RestfulPressError; end
+  class ServerError < RestfulPressError; end
+  class Unavailable < RestfulPressError; end
+  class DecodeError < RestfulPressError; end
+  class NoConnectionEstablished < RestfulPressError; end
+end

data/lib/restful_press/client.rb ADDED

@@ -0,0 +1,100 @@
+module RestfulPress
+  class Client
+    @@connection = nil
+    @@debug = false
+    class << self
+      def set_credentials(api_key)
+        @@connection = Connection.new(api_key)
+        @@connection.debug = @@debug
+        true
+      end
+      def debug=(debug_flag)
+        @@debug = debug_flag
+        @@connection.debug = @@debug if @@connection
+      end
+      def debug
+        @@debug
+      end
+      def add_job(*args)
+        options = extract_options!(args)
+        params = Hash.new
+        params[:job] = options
+        response = post(Endpoint.jobs, params)
+        HashUtils.recursively_symbolize_keys(response)
+      end
+      def get_job(id)
+        response = get(Endpoint.job(id))
+        HashUtils.recursively_symbolize_keys(response)
+      end
+      def get_jobs
+        response = get(Endpoint.jobs)
+        HashUtils.recursively_symbolize_keys(response)
+      end
+      def delete_job(id)
+        response = delete(Endpoint.job(id))
+        if response.nil?
+          return true
+        else
+          HashUtils.recursively_symbolize_keys(response)
+        end
+      end
+      def job_url(id)
+        Endpoint.download_job(id)
+      end
+      def job_download(id)
+        response = get(Endpoint.download_job(id))
+        HashUtils.recursively_symbolize_keys(response)
+      end
+      def job_complete?(id)
+        get_job(id)[:complete]
+      end
+      def get(endpoint, data=nil)
+        raise NoConnectionEstablished  if @@connection.nil?
+        @@connection.get endpoint, data
+      end
+      def delete(endpoint, data=nil)
+        raise NoConnectionEstablished  if @@connection.nil?
+        @@connection.delete endpoint, data
+      end
+      def post(endpoint, data=nil)
+        raise NoConnectionEstablished  if @@connection.nil?
+        @@connection.post endpoint, data
+      end
+      def put(endpoint, data=nil)
+        raise NoConnectionEstablished  if @@connection.nil?
+        @@connection.put endpoint, data
+      end
+    private
+      def extract_options!(args)
+        if args.last.is_a?(Hash)
+          return args.pop
+        else
+          return {}
+        end
+      end
+    end
+  end
+end

data/lib/restful_press/connection.rb ADDED

@@ -0,0 +1,139 @@
+module RestfulPress
+  class Connection
+    attr_accessor :debug
+    attr_reader :api_key, :default_options
+    def initialize(api_key)
+      @api_key = api_key
+      @default_options = { :api_key => @api_key }
+      @debug = false
+    end
+    def get(endpoint, data=nil)
+      request :get, endpoint, data
+    end
+    def delete(endpoint, data=nil)
+      request :delete, endpoint, data
+    end
+    def post(endpoint, data=nil)
+      request :post, endpoint, data
+    end
+    def put(endpoint, data=nil)
+      request :put, endpoint, data
+    end
+  private
+    def request(method, endpoint, data=nil)
+      headers = { 'User-Agent' => "RestfulPress Ruby Client v#{VERSION}",
+                  'Content-Type' => "application/json"
+                }
+      if data.nil?
+        data = @default_options
+      else
+        data.merge!(@default_options)
+      end
+      if [:get, :delete].include?(method)
+        endpoint = endpoint + '?' + build_query(data)
+      end
+      if debug
+        puts "request: #{method.to_s.upcase} #{endpoint}"
+        puts "headers:"
+        headers.each do |key, value|
+          puts "#{key}=#{value}"
+        end
+        if [:post, :put].include?(method)
+          puts "data:"
+          puts Yajl::Encoder.encode data
+        end
+      end
+      case method
+        when :get, :delete
+          response = send_request(method, endpoint, headers)
+        when :post, :put
+          data = Yajl::Encoder.encode data
+          response = send_request(method, endpoint, headers, data)
+      end
+      if debug
+        puts "\nresponse: #{response.code}"
+        puts "headers:"
+        response.header.each do |key, value|
+          puts "#{key}=#{value}"
+        end
+        puts "body:"
+        puts response.body
+      end
+      if response.body.empty?
+        content = nil
+      else
+        begin
+          content = Yajl::Parser.new.parse(response.body)
+        rescue Yajl::ParseError
+          raise DecodeError, "content: <#{response.body}>"
+        end
+      end
+      content
+    end
+    def build_query(data)
+      data = data.to_a if data.is_a?(Hash)
+      data.map do |key, value|
+        [key.to_s, URI.escape(value.to_s)].join('=')
+      end.join('&')
+    end
+    def send_request(method, endpoint, headers, data=nil)
+      begin
+        case method
+          when :get
+            response = RestClient.get endpoint, headers
+          when :delete
+            response = RestClient.delete endpoint, headers
+          when :post
+            response = RestClient.post endpoint, data, headers
+          when :put
+            response = RestClient.put endpoint, data, headers
+        end
+      rescue => e
+        raise_errors(e.response)
+      end
+      response
+    end
+    def raise_errors(response)
+      case response.code
+        when 401
+          raise Unauthorized
+        when 403
+          raise APIKeyExpired
+        when 404
+          raise NotFound
+        when 405
+          raise MethodNotAllowed
+        when 422
+          raise RestfulPressError, "#{response.description}\n#{response.body}"
+        when 500
+          raise ServerError, "RestfulPress had an internal error. #{response.description}"
+        when 502..503
+          raise Unavailable, response.description
+        else
+          raise RestfulPressError, response.description
+      end
+    end
+  end
+end

data/lib/restful_press/endpoint.rb ADDED

@@ -0,0 +1,27 @@
+module RestfulPress
+  class Endpoint
+    class << self
+      def job(id)
+        endpoint_url ["jobs", "#{id}.json"].join('/')
+      end
+      def jobs
+        endpoint_url "jobs.json"
+      end
+      def download_job(id)
+        endpoint_url ["jobs", id, "download"].join('/')
+      end
+      def endpoint_url(path)
+        [REALM, path].join('/')
+      end
+    end
+  end
+end

data/lib/restful_press/hash_utils.rb ADDED

@@ -0,0 +1,28 @@
+module RestfulPress
+  class HashUtils
+    def self.symbolize_keys(hash)
+      hash.inject({}) do |options, (key, value)|
+        options[(key.to_sym rescue key) || key] = value
+        options
+      end
+    end
+    def self.recursively_symbolize_keys(object)
+      if object.is_a? Hash
+        symbolized_hash = symbolize_keys(object)
+        symbolized_hash.each do |key, value|
+          symbolized_hash[key] = recursively_symbolize_keys(value)
+        end
+        symbolized_hash
+      elsif object.is_a? Array
+        object.map {|value| recursively_symbolize_keys(value) }
+      else
+        object
+      end
+    end
+  end
+end

data/lib/restfulpress.rb ADDED

	@@ -0,0 +1,2 @@
1	+ # So you can require "restfulpress" instead of "restful_press"
2	+ require File.dirname(__FILE__) + '/restclient'

data/spec/restful_press_spec.rb ADDED

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe "RestfulPress" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'restful_press'
+require 'spec'
+require 'spec/autorun'
+Spec::Runner.configure do |config|
+end

metadata ADDED

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: restful_press
+version: !ruby/object:Gem::Version
+  hash: 29
+  prerelease: false
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors:
+- Mauricio Gomes
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-08-25 00:00:00 -04:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 13
+        segments:
+        - 0
+        - 7
+        - 7
+        version: 0.7.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 15
+        segments:
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 13
+        segments:
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+description: "Restful Press is an automated service for converting your app's views into PDFs. "
+email: mauricio@geminisbs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- LICENSE
+- README.rdoc
+- VERSION
+- lib/restful_press.rb
+- lib/restful_press/client.rb
+- lib/restful_press/connection.rb
+- lib/restful_press/endpoint.rb
+- lib/restful_press/hash_utils.rb
+- lib/restfulpress.rb
+- spec/restful_press_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/geminisbs/restful_press
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Ruby client for the Restful Press API
+test_files:
+- spec/restful_press_spec.rb
+- spec/spec_helper.rb