easy_pdf_cloud 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWM2NDlmYWQ3YzcwYWQwYmFhMDE4NmQ5NmRiNzI5NjA2MWEzOWZhNg==
+  data.tar.gz: !binary |-
+    Y2JmOTQxMTliYWI3YzdhN2Y2ZjMyMzYwMjhkODk0OTlhYmU4MjA5ZQ==
+SHA512:
+  metadata.gz: !binary |-
+    NjQ4OGFiZGJkOWVhN2NkZDkzOTVhMjFhMmM4OWY2NDQyNzRkMjg3MmVlZDdl
+    ZWQ2OGM0ZDhmNjY0NjRjNTdiYWYxZjVkMTY4Y2RjN2YxZDAwOGU5NWMyZTE0
+    N2NjNDkxOWMyNzRiNzFhNTJmZjcxMmY0MDM1ZDU5ODFhMzA3OTI=
+  data.tar.gz: !binary |-
+    ZjYzZDQyOThjMjMwN2EwMjdmNTU5MDJjZDYyNjQxMjI4NjRjMzVkOThmOGUw
+    NTljOWNmZDhiMjBiNDhkYzIyYzEyNjZmMjdjYTc3YzQ3OWViNmE1MmEyOWVj
+    N2Q5YWFiYzA3NGViMjAwNmUzNjU5MTYwNzk5YzZmN2Y0YzZhZTI=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pdf_cloud.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joe Heth
+
+MIT License
+
+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.md

@@ -0,0 +1,65 @@
+# EasyPDFCloud
+
+[easypdfcloud.com](https://www.easypdfcloud.com/) provides a RESTful API for accessing
+
+This branch supports version 1 of api.easypdfcloud.com.
+
+[Developer API Reference](https://www.easypdfcloud.com/developer/reference)
+
+This gem assumes you've gone through the OAuth process and have a refresh token.  
+The easypdfcloud.com access token expires in an hour so this gem requires a refresh token to be configured
+so it can automatically refresh when needed.
+
+Configuration:
+
+    client_id: '...'
+    client_secret: '...'
+    workflow_id: '0000000000000001'
+    refresh_token: '...'
+    version: 'v1'
+
+Usage:
+
+    pdf_cloud_config = YAML.load_file(File.join(Rails.root, "config", "easypdfcloud.yml"))
+    pdf_cloud = EasyPdfCloud::Client.new(pdf_cloud_config)
+
+    # Local File System conversion. Uses configured workflow id.  
+    out_filepath = pdf_cloud.convert("/path/to/filename.pdf", 'pdf', 'doc')  
+    # Optionally pass a workflow id  
+    out_filepath = pdf_cloud.convert("/path/to/filename.pdf", 'pdf', 'doc', workflow_id)  
+
+    # Raw Data transform
+    pdf_data = File.open("somefile.pdf") { |f| f.read }
+    # This method uses the configured workflow id.
+    doc_data = pdf_cloud.pdf2word("#{Time.now.to_i}.pdf", pdf_data)
+    File.open('test.doc', 'wb') {|f| f.write(doc_data)}
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_pdf_cloud'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_pdf_cloud
+
+## Usage
+
+~~~
+client = EasyPdfCloud::Client.new(client_id, client_secret, access_token)
+puts client.workflows
+client.workflow(workflow_id).convert(filename, 'pdf', 'doc')
+~~~
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/easy_pdf_cloud.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_pdf_cloud/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "easy_pdf_cloud"
+  gem.version       = EasyPdfCloud::VERSION
+  gem.authors       = ["Joe Heth"]
+  gem.email         = ["joeheth@gmail.com"]
+  gem.description   = %q{Simplified access to the easypdfcloud.com RESTful API}
+  gem.summary       = %q{Document conversion using easypdfcloud.com}
+  gem.homepage      = "https://github.com/TinderBox/easy_pdf_cloud"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "oauth2", "~> 0.9"
+end

data/lib/easy_pdf_cloud.rb

@@ -0,0 +1,214 @@
+require "easy_pdf_cloud/version"
+require 'oauth2'
+
+module EasyPdfCloud
+
+  class Client
+
+    # The client id (aka "Consumer Key") to use for OAuth2 authentication
+    attr_accessor :client_id
+    # The client secret (aka "Consumer Secret" to use for OAuth2 authentication)
+    attr_accessor :client_secret
+    # The OAuth access token in use by the client
+    attr_accessor :access_token
+    # The OAuth refresh token in use by the client
+    attr_accessor :refresh_token
+    # The host to use for OAuth2 authentication. Defaults to www.easypdfcloud.com
+    attr_accessor :host
+    # The host to use for API requests. Defaults to api.easypdfcloud.com
+    attr_accessor :api_host
+    # The API version the client is using. Defaults to v1
+    attr_accessor :version
+    # The base URL to the workflow API
+    attr_reader :workflow_url
+    # The base URL to the Base API https://{api_host}/{version}
+    attr_reader :api_url
+
+    def initialize(options)
+
+      @options = options
+      @host = options['host'] || 'https://www.easypdfcloud.com'
+      @api_host = options['api_host'] || "https://api.easypdfcloud.com"
+      @version = options['version'] || "v1"
+      @api_url = "#{@api_host}/#{@version}"
+      @workflow_url = "#{@api_url}/workflows"
+      @client_id = options['client_id']
+      @client_secret = options['client_secret']
+      @access_token = options['access_token']
+      @refresh_token = options['refresh_token']
+
+      client_options = {
+        :site => @host,
+        :authorize_url    => '/oauth2/authorize',
+        :token_url        => '/oauth2/token'
+      }
+      @client = OAuth2::Client.new(@client_id, @client_secret, client_options)
+      #@client.auth_code.authorize_url(:redirect_uri => 'http://localhost', :scope => "epc.api", :state => "EasyPDFCloud")
+
+      @access_token = OAuth2::AccessToken.from_hash(@client, {:access_token => @access_token, :refresh_token => @refresh_token})
+    end
+
+    def verify_access_token
+      begin
+        workflows()
+      rescue => e
+        puts e.message
+        raise "Access denied to easypdfcloud.com API. Verify your access and/or refresh token."
+      end
+    end
+
+    def check_access_token
+      if @access_token.expired? || @access_token.token.empty?
+        puts "Refreshing EasyPdfCloud Access Token"
+        # For older versions of oauth2 the refresh_token is not properly carried over after the call to refresh!
+        @access_token = OAuth2::AccessToken.from_hash(@client, {:access_token => @options["access_token"], :refresh_token => @options["refresh_token"]})
+        @access_token = @access_token.refresh!
+        verify_access_token
+      end
+    end
+
+    def convert(filename, input_type, output_type, workflow_id=nil)
+      check_access_token
+      out_filepath = nil
+      wid = workflow_id || @options["workflow_id"]
+      if wid
+        out_filepath = workflow(wid).convert(filename, input_type, output_type)
+      else
+        raise "No workflow id was specified"
+      end
+      return out_filepath
+    end
+
+    def pdf2word(filename, pdf_data, workflow_id=nil)
+      check_access_token
+      word_data = ""
+      if @options.has_key?("workflow_id") || workflow_id
+        id = (workflow_id ? workflow_id : @options["workflow_id"])
+        word_data = workflow(id).convert_data(filename, pdf_data, 'pdf', 'doc')
+      else
+        raise "No workflow id was specified"
+      end
+      return word_data
+    end
+
+    def workflows
+      check_access_token
+      response = @access_token.get(@workflow_url)
+      hash = response.parsed
+      hash["workflows"]
+    end
+
+    def workflow_details(id)
+      response = @access_token.get("#{@workflow_url}/#{id}")
+      workflow_id = response.parsed["workflowID"].to_i
+      Workflow.new(self, workflow_id)
+    end
+
+    def workflow(id)
+      Workflow.new(self, id)
+    end
+
+  end
+
+  class Workflow
+    def initialize(client, workflow_id, options = {})
+      @client = client
+      @access_token = client.access_token
+      @workflow_id = workflow_id
+      @workflow_url = "#{client.workflow_url}/#{@workflow_id}"
+      @jobs_url = "#{client.api_url}/jobs"
+      @event_id = nil
+      @debug = options[:debug]
+    end
+
+    def convert(filepath, source_extension, dest_extension)
+      raise "Invalid file: #{filepath}" if !File.file?(filepath)
+
+      file_data = File.open(filepath, 'rb') {|f| f.read}
+      filename = File.basename(filepath)
+
+      out_data = convert_data(filename, file_data, source_extension, dest_extension)
+
+      out_filepath = filepath.sub(".#{source_extension}", ".#{dest_extension}")
+      File.open(out_filepath, "wb") {|f| f.write(out_data)}
+      return out_filepath
+    end
+
+    def convert_data(filename, data, source_extension, dest_extension)
+      job_id = create_job_from_file(filename, data)
+      wait_for_completion(job_id)
+      output_file = filename.sub(".#{source_extension}", ".#{dest_extension}")
+      response = retrieve_file(job_id, output_file)
+      # The job stays around after execution. We can either delete or keep a history some where.
+      # delete_job(job_id)
+      # Delete the output file so it doesn't take up storage space.
+      delete_output_file(job_id, output_file)
+      response.body
+    end
+
+    def create_job_from_file(filename, file_data)
+      create_job_url = "#{@workflow_url}/jobs?file=#{filename}"
+      response = @access_token.put(create_job_url, {:body => file_data, :headers => {"Content-Type" => "application/pdf"}})
+      return response.parsed["jobID"]
+    end
+
+    # Download Output File
+    def download(job_id, filename, destination_path = nil)
+      response = retrieve_file(job_id, filename)
+      filepath = (destination_path ? File.join(destination_path, filename) : filename)
+
+      File.open(filepath, "wb") {|f| f.write(response.body)}
+      delete_output_file(job_id, filename)
+      true
+    end
+
+    def retrieve_file(job_id, filename)
+      file_url = "#{@jobs_url}/#{job_id}/output/#{filename}"
+      response = @access_token.get(file_url)
+    end
+
+    # Delete File from output folder.
+    def delete_output_file(job_id, filename)
+      file_url = "#{@jobs_url}/#{job_id}/output/#{filename}"
+      response = @access_token.delete(file_url)
+      return response.parsed.is_a?(Hash)
+    end
+
+    # There is no response from this command.
+    def start_job(id)
+      response = @access_token.post("#{@jobs_url}/#{id}")
+      response.status
+    end
+
+    def delete_job(id)
+      response = @access_token.delete("#{@jobs_url}/#{id}")
+      response.status
+    end
+
+    def wait_for_completion(job_id)
+      count = 0
+      while (job_event(job_id) == false)
+        if count == 6
+          delete_job(job_id)
+          raise "Failed to convert after 180 seconds."
+        end
+        count += 1
+      end
+    end
+
+    def job_status(job_id)
+      response = @access_token.get("#{@jobs_url}/#{job_id}")
+      response.parsed
+    end
+
+    # https://www.easypdfcloud.com/developer/reference#jobs_event
+    # This API waits for an event for up to 30 seconds.
+    # If the job execution does not complete within this duration, returns HTTP status code 202 (Accepted).
+    def job_event(job_id)
+      response = @access_token.post("#{@jobs_url}/#{job_id}/event")
+      hash = response.parsed
+      return hash["status"] == "completed"
+    end
+  end
+
+end

data/lib/easy_pdf_cloud/version.rb

@@ -0,0 +1,3 @@
+module EasyPdfCloud
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: easy_pdf_cloud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Heth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Simplified access to the easypdfcloud.com RESTful API
+email:
+- joeheth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_pdf_cloud.gemspec
+- lib/easy_pdf_cloud.rb
+- lib/easy_pdf_cloud/version.rb
+homepage: https://github.com/TinderBox/easy_pdf_cloud
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Document conversion using easypdfcloud.com
+test_files: []