researchable-pdf-renderer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46ac20c1bae093f3f5243631635911cb49e775256297f304591de0521f478b3d
+  data.tar.gz: bc05f3afacfae35204051d2fa12d09647992d2aa686595c07d8cee39b9a785a4
+SHA512:
+  metadata.gz: e95c4240e96569dfbe81c68cb606cead1bc84d11b454885bce647b81b7ce71ac7df979e9ba82166ff376ca576dabe6902e0d78507227e7a9957cadd9b8ce74da
+  data.tar.gz: 2dad00551ac0bb379c5f9e3b7a0de62b327ccf1ad1a30d231aaaf4cabfe0f9c3c75d6777d677cf42b9883dcaf6d15aebb0e27278419dca7730d8387a5c6fa60e

data/.gitignore

@@ -0,0 +1,53 @@
+Gemfile.lock
+gemfiles
+
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/lib/researchable-pdf-renderer.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'researchable/pdf_renderer'

data/lib/researchable/pdf_renderer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'active_interaction'
+require 'researchable/pdf_renderer/version'
+require 'researchable/pdf_renderer/sessions'
+require 'researchable/pdf_renderer/endpoint'
+require 'researchable/pdf_renderer/get_pdf'
+
+module Researchable
+  module PdfRenderer
+  end
+end

data/lib/researchable/pdf_renderer/endpoint.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Researchable
+  module PdfRenderer
+    # @api private
+    class Endpoint < ActiveInteraction::Base
+      object :basic_auth_session,
+             default: -> { Researchable::PdfRenderer.basic_auth_session },
+             class: Researchable::PdfRenderer::Sessions::BasicAuthSession
+
+      def validate_response_for
+        response = yield
+        return deal_with_errors if response.parsed_response.is_a?(Hash) && response['errors'].present?
+        return deal_with_unprocessable_entity if response.code == 422
+        response_to_result response
+      end
+
+      # This function is used so it can be mocked later, and so
+      # that it can be specified for each subclass
+      def response_to_result(response)
+        response
+      end
+
+      private
+
+      def deal_with_unprocessable_entity
+        errors.add :base, 'Validations failed!'
+        nil
+      end
+
+      def deal_with_errors
+        response['errors'].each do |attribute, attribute_errors|
+          attribute_errors.each do |error|
+            if respond_to?(attribute.to_sym) || attribute.to_sym == :base
+              errors.add attribute.to_sym, error
+            else
+              errors.add :base, error
+            end
+          end
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/researchable/pdf_renderer/get_pdf.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Researchable
+  module PdfRenderer
+    require 'tempfile'
+    require 'yaml'
+    class GetPdf < Endpoint
+      string :template
+      hash :report_data, strip: false
+
+      def execute
+        template_file = convert_to_file('template.md', template)
+        report_data_file = convert_to_file('report_data.yml', report_data.to_yaml)
+
+        result = validate_response_for do
+          basic_auth_session.post(
+            '/render',
+            template: template_file,
+            report_data: report_data_file
+          )
+        end
+        report_data_file.close
+        template_file.close
+        result
+      end
+
+      private
+
+      def convert_to_file(filename, data)
+        data_file = Tempfile.new(filename)
+        data_file.write(data)
+        data_file.rewind
+        data_file
+      end
+    end
+  end
+end

data/lib/researchable/pdf_renderer/sessions.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+require 'researchable/pdf_renderer/sessions/basic_auth_session'
+
+module Researchable
+  module PdfRenderer
+    def self.basic_auth_session(*arguments, &block)
+      Sessions::BasicAuthSession.new(*arguments, &block)
+    end
+  end
+end

data/lib/researchable/pdf_renderer/sessions/basic_auth_session.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Researchable
+  module PdfRenderer
+    module Sessions
+      class BasicAuthSession
+        attr_reader :api_url
+        attr_reader :username
+        attr_reader :password
+
+        def initialize(api_url: ENV['SVC_PDFRENDERER_URL'],
+                       username: ENV['SVC_PDFRENDERER_BASICAUTH_ID'],
+                       password: ENV['SVC_PDFRENDERER_BASICAUTH_SECRET'])
+          @api_url = api_url
+          @username = username
+          @password = password
+        end
+
+        def get(path, params = {})
+          perform_request_or_fail do
+            HTTParty.get(full_url_for(path),
+                         query: params,
+                         basic_auth: basic_auth)
+          end
+        end
+
+        def post(path, params = {})
+          perform_request_or_fail do
+            HTTParty.post(full_url_for(path),
+                          #headers: { 'Content-Type' => 'multip' },
+                          multipart: true,
+                          body: params,
+                          basic_auth: basic_auth)
+          end
+        end
+
+        def patch(path, params = {})
+          perform_request_or_fail do
+            HTTParty.patch(full_url_for(path),
+                           headers: { 'Content-Type' => 'application/json' },
+                           body: params.to_json,
+                           basic_auth: basic_auth)
+          end
+        end
+
+        def delete(path, params = {})
+          perform_request_or_fail do
+            HTTParty.delete(full_url_for(path),
+                            query: params,
+                            basic_auth: basic_auth)
+          end
+        end
+
+        private
+
+        def perform_request_or_fail
+          response = yield
+          case response.code
+          when 200..299, 422
+            response
+          when 401
+            access_denied(response)
+          else
+            raise response.parsed_response || "Received HTTP response code #{response.code}!"
+          end
+        end
+
+        def access_denied(response)
+          if response.headers['WWW-Authenticate']
+            raise NoSession
+          else
+            raise Unauthorized
+          end
+        end
+
+        def full_url_for(path)
+          api_url + api_base + path
+        end
+
+        def api_base
+          '/api/v1'
+        end
+
+        def basic_auth
+          { username: username, password: password }
+        end
+      end
+    end
+  end
+end

data/lib/researchable/pdf_renderer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Researchable
+  module PdfRenderer
+    VERSION = '0.0.1'
+  end
+end

data/researchable_pdf_renderer.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/researchable/pdf_renderer/version', __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'researchable-pdf-renderer'
+  gem.version       = Researchable::PdfRenderer::VERSION
+  gem.license       = 'Unlicensed'
+  gem.summary       = 'Gem for rendering result PDFs'
+  gem.authors       = ['Frank Blaauw']
+  gem.email         = 'pdf-renderer@researchable.nl'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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_dependency 'active_interaction'
+  gem.add_dependency 'httparty'
+
+  gem.add_development_dependency 'appraisal'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'factory_bot'
+end

data/spec/factories/basic_auth_sessions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :basic_auth_session do
+    initialize_with { new(username: 'some_username',
+                          password: 'some_password',
+                          api_url: 'http://svc-pdfrenderer') }
+  end
+end

data/spec/lib/researchable/pdf_renderer/endpoint_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Endpoint do
+  class TestEndpoint < Endpoint
+    object :response, class: RSpec::Mocks::Double
+
+    def execute
+      validate_response_for do
+        response
+      end
+    end
+
+    def response_to_result(response)
+      response['key']
+    end
+  end
+
+  describe '#initialize' do
+    it 'calls PdfRenderer.basic_auth_session to fill in basic_auth_session if the basic_auth_session is not passed in' do
+      bas_double = Researchable::PdfRenderer::Sessions::BasicAuthSession.new # doubles dont pass AI default type checking
+      allow(Researchable::PdfRenderer).to receive(:basic_auth_session).and_return bas_double
+      endpoint = TestEndpoint.new
+      expect(endpoint.instance_variable_get :@basic_auth_session).to eq(bas_double)
+    end
+
+    it 'sets basic_auth_session to the passed basic_auth_session' do
+      bas_double = double("BasicAuthSession")
+      endpoint = TestEndpoint.new(basic_auth_session: bas_double)
+      expect(endpoint.instance_variable_get :@basic_auth_session).to eq(bas_double)
+    end
+  end
+
+  describe 'with validations' do
+    let(:response) do
+      double('httparty_repsonse', code: 200, parsed_response: {}).tap do |response|
+        allow(response).to receive(:[]).with('key').and_return ['values']
+        allow(response).to receive(:[]).with('errors').and_return []
+      end
+    end
+
+    it 'returns the parsed response' do
+      outcome = TestEndpoint.run response: response
+      expect(outcome.result).to eq(['values'])
+    end
+
+    it 'is valid' do
+      result = TestEndpoint.run response: response
+      expect(result).to be_valid
+    end
+
+    context 'when the response contains errors' do
+      before do
+        allow(response).to receive(:[]).with('errors').and_return('base' => ['Some annoying error'])
+      end
+
+      it 'adds the errors' do
+        outcome = TestEndpoint.run response: response
+        expect(outcome.errors.full_messages.first).to match('Some annoying error')
+      end
+
+      it 'marks the outcome as invalid' do
+        outcome = TestEndpoint.run response: response
+        expect(outcome).not_to be_valid
+      end
+
+      it 'does not return a result' do
+        outcome = TestEndpoint.run response: response
+        expect(outcome.result).to be_nil
+      end
+    end
+
+    context 'when the response code is 422 but the response contains no errors' do
+      it 'adds an error to base' do
+        allow(response).to receive(:code).and_return 422
+        outcome = TestEndpoint.run response: response
+        expect(outcome).not_to be_valid
+        expect(outcome.errors.full_messages).to include('Validations failed!')
+      end
+    end
+  end
+end

data/spec/lib/researchable/pdf_renderer/get_pdf_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe GetPdf do
+  let(:options) { { content: '# Some markdown' } }
+  let(:api_path) { '/render' }
+  let(:response) do
+    httparty_response \
+      'filename' => 'filename.pdf',
+      'binary_content' => 'binarycontent'
+  end
+  let(:session) { FactoryBot.build(:basic_auth_session) }
+
+  before { allow(BasicAuthSession).to receive(:new).and_return session }
+
+  it 'returns a respondent object' do
+    expect(session).to receive(:post).with(api_path, options).and_return response
+    result = GetPdf.run(options).result.parsed_response
+
+    expect(result['filename']).to eq 'filename.pdf'
+    expect(result['binary_content']).to eq 'binarycontent'
+  end
+end

data/spec/lib/researchable_pdf_renderer_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Researchable::PdfRenderer do
+  it "should have a VERSION constant" do
+    expect(subject.const_get('VERSION')).to_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+require 'rspec'
+require 'factory_bot'
+require 'researchable-pdf-renderer'
+
+include Researchable::PdfRenderer
+include Researchable::PdfRenderer::Sessions
+
+
+Dir[File.join(File.expand_path(File.dirname(__FILE__)), 'support', '*.rb')].each {|f| require f}
+Dir[File.join(File.expand_path(File.dirname(__FILE__)), 'factories', '*.rb')].each {|f| require f}
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.warnings = true
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 1
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/httparty_response.rb

@@ -0,0 +1,8 @@
+def httparty_response(response_data)
+  response = double('reponse')
+  allow(response).to receive(:[]).and_return []
+  allow(response).to receive(:body).and_return response_data
+  allow(response).to receive(:code).and_return 200
+  allow(response).to receive(:parsed_response).and_return response_data
+  response
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: researchable-pdf-renderer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Frank Blaauw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_interaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: pdf-renderer@researchable.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- lib/researchable-pdf-renderer.rb
+- lib/researchable/pdf_renderer.rb
+- lib/researchable/pdf_renderer/endpoint.rb
+- lib/researchable/pdf_renderer/get_pdf.rb
+- lib/researchable/pdf_renderer/sessions.rb
+- lib/researchable/pdf_renderer/sessions/basic_auth_session.rb
+- lib/researchable/pdf_renderer/version.rb
+- researchable_pdf_renderer.gemspec
+- spec/factories/basic_auth_sessions.rb
+- spec/lib/researchable/pdf_renderer/endpoint_spec.rb
+- spec/lib/researchable/pdf_renderer/get_pdf_spec.rb
+- spec/lib/researchable_pdf_renderer_spec.rb
+- spec/spec_helper.rb
+- spec/support/httparty_response.rb
+homepage: 
+licenses:
+- Unlicensed
+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: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Gem for rendering result PDFs
+test_files:
+- spec/factories/basic_auth_sessions.rb
+- spec/lib/researchable/pdf_renderer/endpoint_spec.rb
+- spec/lib/researchable/pdf_renderer/get_pdf_spec.rb
+- spec/lib/researchable_pdf_renderer_spec.rb
+- spec/spec_helper.rb
+- spec/support/httparty_response.rb