doc_generation_wrapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47b79894b631a05f7be60adf2840b44836dc09c1
+  data.tar.gz: a7f9bc06b60667a92b80903e87922d07376d40b9
+SHA512:
+  metadata.gz: 316001e37e7ed1c034e13606574289b6953cd06a8f131dd8dc105fd98f6c2a2222043ec4095dbb55c15b0289d417916d23310b600b910b03af8a2243c24ea57e
+  data.tar.gz: bad10be0447cf0b48f0c37b903af827589f89b9df60c43ba918d513695f810634a2eba194a4eaac8732ec76cbf3150b3113149f0640b1bb0335556240faa34a5

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--format=doc
+--color
+--backtrace

data/.ruby-gemset

@@ -0,0 +1 @@
+doc_generation_wrapper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+### VERSION 0.0.1
+
+* bug fix
+  *
+
+* refactoring
+  *
+
+* enhancements
+  *
+
+* backwards incompatible changes
+  *
+
+* deprecations
+  *
+
+* todos
+  *

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doc_generation.gemspec
+gemspec
+
+group :test do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joel AZEMAR
+
+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,50 @@
+# DocGenerationWrapper
+
+DocGenerationWrapper is a library permit to abstract call for document generation, when you use DocRaptor for generate docuementation from HTML to PDF or XLS, but you want make generation faster on local machine, don't call DocRaptor service every time you develop, this library permit to switch on local generation and keep DocRaptor behavior on production.
+
+This library is simple adapter pattern for switching on local generation document service, you can install and run the service https://github.com/FinalCAD/doc_generation_service for locale use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doc_generation_wrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doc_generation_wrapper
+
+## Usage
+
+## Rails
+
+You can add file on app/config/initializers/doc_generation_wrapper.rb
+
+locale use with PrinceXML Service
+
+```
+  DocGenerationWrapper.configure do |config|
+    config.adapter      = :prince_xml
+    config.service_host = 'http://0.0.0.0:5000'
+  end
+```
+
+Production use with DocRaptor
+
+```
+  DocGenerationWrapper.configure do |config|
+    config.adapter = :doc_raptor
+  end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/doc_generation_wrapper/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'
+
+require 'rake'
+require 'rspec'
+
+require_relative 'lib/doc_generation_wrapper'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task default: :spec

data/doc_generation_wrapper.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/doc_generation_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'doc_generation_wrapper'
+  spec.version       = DocGenerationWrapper::VERSION
+  spec.authors       = ['Joel AZEMAR']
+  spec.email         = ['joel.azemar@gmail.com']
+  spec.summary       = %q{Wrapper for DocRaptor or Local PrinceXML generation}
+  spec.description   = %q{Wrapper for DocRaptor or Local PrinceXML generation of document, purpose is help to develop quickly}
+  spec.homepage      = 'https://github.com/FinalCAD/doc_generation_wrapper'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake',    '~> 10.3'
+  spec.add_development_dependency 'rspec',   '~> 2.14'
+
+  spec.add_dependency 'doc_raptor', '~> 0.3.2'
+  spec.add_dependency 'json', '~> 1.8'
+
+  spec.required_ruby_version = '~> 2.1'
+end

data/lib/doc_generation_wrapper/adapters/abstract.rb

@@ -0,0 +1,15 @@
+module DocGenerationWrapper
+  module Adapter
+    class Abstract
+
+      def create! options
+        raise NotImplementedError
+      end
+
+      def status status_id
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/doc_generation_wrapper/adapters/base.rb

@@ -0,0 +1,24 @@
+module DocGenerationWrapper
+  module Adapter
+    class Base
+
+      class UnsupportedAdapter < StandardError ; end
+
+      def self.create adapter_name
+        load "doc_generation_wrapper/adapters/#{adapter_name}_adapter.rb"
+        DocGenerationWrapper::Adapter.const_get(klass_adapter(adapter_name)).new
+      end
+
+      private
+
+      def self.klass_adapter adapter_symbol
+        case adapter_symbol
+        when :doc_raptor then :DocRaptorAdapter
+        when :prince_xml then :PrinceXmlAdapter
+        else raise UnsupportedAdapter.new
+        end
+      end
+
+    end
+  end
+end

data/lib/doc_generation_wrapper/adapters/doc_raptor_adapter.rb

@@ -0,0 +1,21 @@
+require_relative 'abstract'
+
+require_relative 'doc_raptor_service/proxy'
+require_relative 'doc_raptor_service/command'
+require_relative 'doc_raptor_service/query'
+
+module DocGenerationWrapper
+  module Adapter
+    class DocRaptorAdapter < Abstract
+
+      def create! options, &respond_callback
+        DocRaptorService::Command.new.create! options, &respond_callback
+      end
+
+      def status status_id
+        DocRaptorService::Query.new.status status_id
+      end
+
+    end
+  end
+end

data/lib/doc_generation_wrapper/adapters/doc_raptor_service/command.rb

@@ -0,0 +1,16 @@
+module DocGenerationWrapper
+  module Adapter
+    module DocRaptorService
+
+      class Command
+
+        def create! options, &respond_callback
+          Proxy.create! options
+          respond_callback.call Proxy.status_id if block_given?
+          nil
+        end
+
+      end
+    end
+  end
+end

data/lib/doc_generation_wrapper/adapters/doc_raptor_service/proxy.rb

@@ -0,0 +1,32 @@
+require 'doc_raptor'
+
+module DocGenerationWrapper
+  module Adapter
+    module DocRaptorService
+      module Proxy
+        extend self
+
+        def method_missing method, *args
+          tries = 0
+          begin
+            DocRaptor.send method, *args
+          rescue Errno::ETIMEDOUT, Errno::ENOENT, Errno::ECONNRESET, Timeout::Error
+            (tries += 1) < 3 ? retry : raise
+          rescue DocRaptorException::DocumentCreationFailure => exception
+            if exception.message.match(/Too many simultaneous document requests/) && (tries+=1) < 5
+              wait_before_retrying && retry
+            else
+              raise
+            end
+          end
+        end
+
+        def wait_before_retrying
+          Rails.logger.error '[DocGen] Docraptor can\'t accept more than 5 concurrent requests (auto-retry)'
+          sleep 5
+        end
+
+      end
+    end
+  end
+end

data/lib/doc_generation_wrapper/adapters/doc_raptor_service/query.rb

@@ -0,0 +1,14 @@
+module DocGenerationWrapper
+  module Adapter
+    module DocRaptorService
+
+      class Query
+
+        def status status_id
+          Proxy.status status_id
+        end
+
+      end
+    end
+  end
+end

data/lib/doc_generation_wrapper/adapters/prince_xml_adapter.rb

@@ -0,0 +1,20 @@
+require_relative 'abstract'
+
+require_relative 'prince_xml_service/command'
+require_relative 'prince_xml_service/query'
+
+module DocGenerationWrapper
+  module Adapter
+    class PrinceXmlAdapter < Abstract
+
+      def create! options, &respond_callback
+        PrinceXmlService::Command.new.create! options, &respond_callback
+      end
+
+      def status status_id
+        PrinceXmlService::Query.new.status status_id
+      end
+
+    end
+  end
+end

data/lib/doc_generation_wrapper/adapters/prince_xml_service/command.rb

@@ -0,0 +1,24 @@
+require 'rest-client'
+
+module DocGenerationWrapper
+  module Adapter
+    module PrinceXmlService
+
+      class Command
+
+        def create! options, &respond_callback
+          headers = {}
+          host    = DocGenerationWrapper.configuration.service_host
+          url     = host + '/docs'
+
+          request = RestClient::Request.new(method: :post, url: url, payload: options, headers: headers)
+          response = request.execute
+          respond_callback.call response.body
+
+          nil
+        end
+
+      end
+    end
+  end
+end

data/lib/doc_generation_wrapper/adapters/prince_xml_service/query.rb

@@ -0,0 +1,24 @@
+require 'rest-client'
+
+module DocGenerationWrapper
+  module Adapter
+    module PrinceXmlService
+
+      class Query
+
+        def status status_id
+          data    = { id: JSON.parse(status_id)['status_id'] }
+          headers = {}
+          host    = DocGenerationWrapper.configuration.service_host
+          url     = host + '/status'
+
+          request = RestClient::Request.new(method: :get, url: url, payload: data, headers: headers)
+          response = request.execute
+
+          JSON.parse(response)
+        end
+
+      end
+    end
+  end
+end

data/lib/doc_generation_wrapper/configuration.rb

@@ -0,0 +1,10 @@
+module DocGenerationWrapper
+  class Configuration
+    attr_accessor :adapter, :service_host
+
+    def initialize
+      @adapter = :doc_raptor
+      @service_host = 'http://0.0.0.0:5000'
+    end
+  end
+end

data/lib/doc_generation_wrapper/version.rb

@@ -0,0 +1,3 @@
+module DocGenerationWrapper
+  VERSION = '0.0.1'
+end

data/lib/doc_generation_wrapper.rb

@@ -0,0 +1,39 @@
+require_relative 'doc_generation_wrapper/version'
+require_relative 'doc_generation_wrapper/configuration'
+require_relative 'doc_generation_wrapper/adapters/base'
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require 'forwardable'
+
+module DocGenerationWrapper
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Wrapper
+    extend Forwardable
+
+    def_delegators :adapter, :create!, :status
+    attr_reader :adapter
+
+    def initialize
+      @adapter = Adapter::Base.create(DocGenerationWrapper.configuration.adapter)
+    end
+  end
+end

data/spec/doc_generation_wrapper/configuration_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module DocGenerationWrapper
+  describe Configuration do
+    let(:configuration) { Configuration.new }
+
+    describe 'default config' do
+      let(:adapter)      { :doc_raptor }
+      let(:service_host) { 'http://0.0.0.0:5000' }
+
+      it 'adapter is doc_raptor' do
+        expect(configuration.adapter).to eq(adapter)
+      end
+
+      it 'service host is local sinatra hosting' do
+        expect(configuration.service_host).to eq(service_host)
+      end
+    end
+
+  end
+end

data/spec/doc_generation_wrapper_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'doc_raptor'
+
+module DocGenerationWrapper
+
+  describe Wrapper do
+    let(:wrapper) { Wrapper.new }
+    let(:adapter) { :doc_raptor }
+
+    before do
+      DocGenerationWrapper.configure do |config|
+        config.adapter = adapter
+      end
+    end
+
+    describe '#create!' do
+      let(:options) {{}}
+
+      before do
+        expect(DocRaptor).to receive(:create!).with(options)
+      end
+
+      specify do
+        wrapper.create! options
+      end
+    end
+
+    describe '#status' do
+      let(:id) { :id }
+
+      before do
+        expect(DocRaptor).to receive(:status).with(id)
+      end
+
+      specify do
+        wrapper.status id
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require_relative '../lib/doc_generation_wrapper'
+
+RSpec.configure do |config|
+  # config.filter_run focused: true
+  config.run_all_when_everything_filtered = true
+  # config.before { }
+  # config.after  { }
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: doc_generation_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joel AZEMAR
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: doc_raptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Wrapper for DocRaptor or Local PrinceXML generation of document, purpose
+  is help to develop quickly
+email:
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc_generation_wrapper.gemspec
+- lib/doc_generation_wrapper.rb
+- lib/doc_generation_wrapper/adapters/abstract.rb
+- lib/doc_generation_wrapper/adapters/base.rb
+- lib/doc_generation_wrapper/adapters/doc_raptor_adapter.rb
+- lib/doc_generation_wrapper/adapters/doc_raptor_service/command.rb
+- lib/doc_generation_wrapper/adapters/doc_raptor_service/proxy.rb
+- lib/doc_generation_wrapper/adapters/doc_raptor_service/query.rb
+- lib/doc_generation_wrapper/adapters/prince_xml_adapter.rb
+- lib/doc_generation_wrapper/adapters/prince_xml_service/command.rb
+- lib/doc_generation_wrapper/adapters/prince_xml_service/query.rb
+- lib/doc_generation_wrapper/configuration.rb
+- lib/doc_generation_wrapper/version.rb
+- spec/doc_generation_wrapper/configuration_spec.rb
+- spec/doc_generation_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/FinalCAD/doc_generation_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+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: Wrapper for DocRaptor or Local PrinceXML generation
+test_files:
+- spec/doc_generation_wrapper/configuration_spec.rb
+- spec/doc_generation_wrapper_spec.rb
+- spec/spec_helper.rb