blazingdocs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b91b8015b41363e73016f083c266037b25d78cdc36aaa3b7b8e7cd5625ecadfe
+  data.tar.gz: d0135b8cfc006264cae8ce41f4247dd22745103009aec6055a5828ceb6d08ea3
+SHA512:
+  metadata.gz: e467a216544d7632643b97e693e381c8c4479d462f8792f2d36408b150f35f78a175af1f3725ec88b010d0526a1015aee48555b932bd93ca5b23425a513c0089
+  data.tar.gz: fb03c1237a1a534ed97eb2deb7d50da7883503bb5bc0288085a8fdff4a1ae0abd6d1083323f93a0a17da88cc432c0505624d901124d9d536130c56aac46817b9

data/Gemfile

@@ -0,0 +1 @@
+gem 'multipart-post'

data/Gemfile.lock

@@ -0,0 +1,12 @@
+GEM
+  specs:
+    multipart-post (2.1.1)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  multipart-post
+
+BUNDLED WITH
+   2.2.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 BlazingDocs
+
+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,56 @@
+# BlazingDocs Ruby client
+High-performance document generation API. Generate documents and reports from СSV, JSON, XML with 99,9% uptime and 24/7 monitoring.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blazingdocs'
+```
+## Integration basics
+
+### Setup
+
+You can get your API Key at https://app.blazingdocs.com
+```ruby
+client = BlazingDocs.create_client('api-key')
+```
+### Getting account info
+
+```ruby
+account = client.get_account
+```
+
+### Getting merge templates list
+
+```ruby
+templates = client.get_templates
+
+# with parent folder path
+templates = client.get_templates('parentfolder')
+```
+
+### Getting usage info
+
+```ruby
+usage = client.get_usage
+```
+
+### Executing merge
+
+```ruby
+data = File.open('PO-Template.json').read
+template = File.open('PO-Template.docx')
+
+merge_parameters = BlazingDocs::MergeParameters.new
+merge_parameters.sequence = false # data is object
+merge_parameters.data_source_type = 'json' # data in json format
+merge_parameters.strict = true # keep json types
+
+merge_result = client.merge(data, 'output.pdf', merge_parameters, template)
+```
+
+## Documentation
+
+See more details here https://docs.blazingdocs.com

data/blazingdocs.gemspec

@@ -0,0 +1,51 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'blazingdocs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blazingdocs'
+  spec.version       = BlazingDocs::VERSION
+  spec.authors       = ['Mentalstack']
+  spec.email         = ['hello@blazingdocs.com']
+
+  spec.summary       = 'BlazingDocs Ruby client'
+  spec.description   = 'BlazingDocs Ruby client. High-performance document generation API. Generate documents and reports from СSV, JSON, XML with 99,9% uptime and 24/7 monitoring'
+  spec.homepage      = 'https://blazingdocs.com'
+  spec.license       = 'MIT'
+  spec.metadata = {
+    "bug_tracker_uri"   => "https://github.com/blazingdocs/blazingdocs-ruby/issues",
+    "changelog_uri"     => "https://github.com/blazingdocs/blazingdocs-ruby/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://docs.blazingdocs.com",
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => "https://github.com/blazingdocs/blazingdocs-ruby"
+  }
+
+  ignored = Regexp.union(
+    /\.editorconfig/,
+    /\.git/,
+    /\.vscode/,
+    /^test/,
+    /^examples/,
+    /^templates/
+  )
+  spec.files = `git ls-files`.split("\n").reject { |f| ignored.match(f) }
+  puts(spec.files)
+  #spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  #  f.match(%r{^(test|spec|features|examples|templates)/})
+  #end
+  #spec.files.reject! { |fn| fn.include? "gitignore" }
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.extra_rdoc_files = Dir["README.md", "CHANGELOG.md", "LICENSE.txt"]
+  spec.rdoc_options    += [
+    "--title", "BlazingDocs Ruby client",
+    "--main", "README.md",
+    "--line-numbers",
+    "--inline-source",
+    "--quiet"
+  ]
+end

data/lib/blazingdocs/blazing_client.rb

@@ -0,0 +1,152 @@
+require 'net/https'
+require 'uri'
+require 'cgi'
+require 'json'
+require 'net/http/post/multipart'
+require 'blazingdocs/utils/hash_utils'
+require 'blazingdocs/models/account_model'
+require 'blazingdocs/models/usage_model'
+require 'blazingdocs/models/template_model'
+require 'blazingdocs/models/operation_model'
+require 'blazingdocs/parameters/merge_parameters'
+require 'blazingdocs/errors/blazing_error'
+
+module BlazingDocs
+  class BlazingClient
+    API_KEY_HEADER ||= 'X-API-Key'
+
+    DEFAULT_HEADERS ||= {
+      'Accept' => 'application/json'
+    }
+
+    def initialize(api_key, config)
+      raise TypeError, 'api_key expects a string' unless api_key.kind_of?(String)
+
+      @configuration = config.nil? ? Configuration.new : config.clone
+      @configuration.api_key = api_key
+    end
+
+    def get_account
+      hash = get('/account')
+      AccountModel.new(to_snake_keys(hash))
+    end
+
+    def get_templates(path = nil)
+      hashes = get("/templates/#{path or ''}")
+      hashes.map { |hash| TemplateModel.new(to_snake_keys(hash)) }
+    end
+
+    def get_usage
+      hash = get('/usage')
+      UsageModel.new(to_snake_keys(hash))
+    end
+
+    def merge(data, file_name, merge_parameters, template)
+      form_data = {}
+
+      raise ArgumentError, 'data is not provided' if data.nil?
+      raise ArgumentError, 'data expects a string' unless data.kind_of?(String)
+
+      form_data['Data'] = data
+
+      raise ArgumentError, 'file_name is not provided' if file_name.nil?
+
+      form_data['OutputName'] = file_name
+
+      raise ArgumentError, 'merge_parameters is not provided' if merge_parameters.nil?
+
+      if merge_parameters.is_a?(Hash)
+        form_data['MergeParameters'] = to_camel_keys(merge_parameters).to_json
+      elsif merge_parameters.is_a?(BlazingDocs::MergeParameters)
+        form_data['MergeParameters'] = to_camel_keys(to_hash(merge_parameters)).to_json
+      else
+        raise ArgumentError, 'merge_parameters expects Hash or MergeParameters'
+      end
+
+      raise ArgumentError, 'template is not provided' if template.nil?
+
+      options = default_options
+      if template.is_a?(File)
+        form_data['Template'] = UploadIO.new(template, 'application/octet-stream', File.basename(template))
+        options = upload_options
+      elsif template.is_a?(String)
+        form_data['Template'] = template
+      end
+
+      hash = multipart_post('/operation/merge', form_data, options)
+      OperationModel.new(to_snake_keys(hash))
+    end
+
+    private
+
+    include BlazingDocs::Utils
+
+    attr_accessor :configuration
+
+    def get(path, params = {}, options = {})
+      handle_response do
+        headers = DEFAULT_HEADERS.merge({ API_KEY_HEADER => @configuration.api_key })
+        request = Net::HTTP::Get.new(request_uri(path, params), headers)
+
+        http(options).request(request)
+      end
+    end
+
+    def multipart_post(path, form_data, options = {})
+      handle_response do
+        headers = DEFAULT_HEADERS.merge({ API_KEY_HEADER => @configuration.api_key })
+        request = Net::HTTP::Post::Multipart.new(path, form_data, headers)
+
+        http(options).request(request)
+      end
+    end
+
+    def handle_response
+      response = yield
+      status = response.code.to_i
+
+      if status != 200
+        raise(
+          BlazingError,
+          status: status,
+          body: response.body,
+          headers: response.each_header.to_h,
+          )
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def http(options = {})
+      options = default_options if options.empty?
+
+      http = Net::HTTP.new(base_uri.host, base_uri.port)
+      http.open_timeout = options.fetch(:open_timeout)
+      http.read_timeout = options.fetch(:read_timeout)
+      http.use_ssl = base_uri.scheme == 'https'
+      # http.set_debug_output $stderr
+      http
+    end
+
+    def request_uri(path, params = {})
+      query = URI.encode_www_form(params)
+      base_uri.path + path + '?' + query
+    end
+
+    def base_uri
+      @configuration.base_uri
+    end
+
+    def default_options
+      options = { read_timeout: @configuration.read_timeout }
+      options[:open_timeout] = @configuration.connect_timeout if RUBY_VERSION > '2.2.0'
+      options
+    end
+
+    def upload_options
+      options = default_options
+      options[:read_timeout] = @configuration.upload_timeout
+      options
+    end
+  end
+end

data/lib/blazingdocs/configuration.rb

@@ -0,0 +1,19 @@
+require 'uri'
+
+module BlazingDocs
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :connect_timeout
+    attr_accessor :read_timeout
+    attr_accessor :upload_timeout
+
+    attr_reader :base_uri
+
+    def initialize
+      @base_uri = URI('https://api.blazingdocs.com')
+      @connect_timeout = 5
+      @read_timeout = 60
+      @upload_timeout = 1800
+    end
+  end
+end

data/lib/blazingdocs/errors/blazing_error.rb

@@ -0,0 +1,41 @@
+module BlazingDocs
+  class BlazingError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def to_s
+      return "the server responded with status #{http_status}" unless json?
+
+      "Status: #{http_status}. Error message: #{error_message}. Errors: #{errors}".strip
+    end
+
+    def error_message
+      response_json['message']
+    end
+
+    def errors
+      response_json['errors']
+    end
+
+    def http_status
+      response[:status]
+    end
+
+    def response_json
+      @response_json ||= begin
+                           JSON.parse(response[:body])
+                         rescue JSON::ParserError
+                           {}
+                         end
+    end
+
+    private
+
+    def json?
+      response[:headers]['content-type'] =~ /json/
+    end
+  end
+end

data/lib/blazingdocs/models/account_model.rb

@@ -0,0 +1,42 @@
+require 'date'
+require 'blazingdocs/models/base_model'
+require 'blazingdocs/models/plan_model'
+
+module BlazingDocs
+  class AccountModel < BaseModel
+    attr_accessor :id
+    attr_accessor :api_key
+    attr_accessor :obsolete_api_key
+    attr_accessor :name
+    attr_accessor :is_disabled
+
+    attr_reader :plan
+    attr_reader :created_at
+    attr_reader :last_synced_at
+    attr_reader :updated_at
+
+    def plan=(plan_hash)
+      @plan = PlanModel.new(plan_hash)
+    end
+
+    def created_at=(created_at_str)
+      @created_at = DateTime.iso8601(created_at_str)
+    end
+
+    def last_synced_at=(last_synced_at_str)
+      @last_synced_at = if !last_synced_at_str.nil?
+                          DateTime.iso8601(last_synced_at_str)
+                        else
+                          nil
+                        end
+    end
+
+    def updated_at=(updated_at_str)
+      @updated_at = if !updated_at_str.nil?
+                      DateTime.iso8601(updated_at_str)
+                    else
+                      nil
+                    end
+    end
+  end
+end

data/lib/blazingdocs/models/base_model.rb

@@ -0,0 +1,9 @@
+module BlazingDocs
+  class BaseModel
+    def initialize(hash = {})
+      hash.each do |option, value|
+        self.send("#{option}=", value)
+      end
+    end
+  end
+end

data/lib/blazingdocs/models/file_model.rb

@@ -0,0 +1,36 @@
+require 'date'
+require 'blazingdocs/models/base_model'
+
+module BlazingDocs
+  class FileModel < BaseModel
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :content_type
+    attr_accessor :download_url
+    attr_accessor :length
+
+    attr_reader :created_at
+    attr_reader :last_modified_at
+    attr_reader :last_accessed_at
+
+    def created_at=(created_at_str)
+      @created_at = DateTime.iso8601(created_at_str)
+    end
+
+    def last_modified_at=(last_modified_at_str)
+      @last_modified_at = if !last_modified_at_str.nil?
+                            DateTime.iso8601(last_modified_at_str)
+                          else
+                            nil
+                          end
+    end
+
+    def last_accessed_at=(last_accessed_at_str)
+      @last_accessed_at = if !last_accessed_at_str.nil?
+                            DateTime.iso8601(last_accessed_at_str)
+                          else
+                            nil
+                          end
+    end
+  end
+end

data/lib/blazingdocs/models/operation_model.rb

@@ -0,0 +1,23 @@
+require 'blazingdocs/models/base_model'
+require 'blazingdocs/models/file_model'
+require 'blazingdocs/models/operation_type_model'
+
+module BlazingDocs
+  class OperationModel < BaseModel
+    attr_accessor :id
+    attr_accessor :page_count
+    attr_accessor :elapsed_milliseconds
+    attr_accessor :remote_ip_address
+
+    attr_reader :files
+    attr_reader :type
+
+    def files=(file_hashes)
+      @files = file_hashes.map { |hash| FileModel.new(hash) }
+    end
+
+    def type=(type_hash)
+      @type = OperationTypeModel.new(type_hash)
+    end
+  end
+end

data/lib/blazingdocs/models/operation_type_model.rb

@@ -0,0 +1,7 @@
+require 'blazingdocs/models/base_model'
+
+module BlazingDocs
+  class OperationTypeModel < BaseModel
+    attr_accessor :name
+  end
+end

data/lib/blazingdocs/models/plan_model.rb

@@ -0,0 +1,11 @@
+require 'blazingdocs/models/base_model'
+
+module BlazingDocs
+  class PlanModel < BaseModel
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :price
+    attr_accessor :price_per_unit
+    attr_accessor :quota
+  end
+end

data/lib/blazingdocs/models/template_model.rb

@@ -0,0 +1,6 @@
+require 'blazingdocs/models/file_model'
+
+module BlazingDocs
+  class TemplateModel < FileModel
+  end
+end

data/lib/blazingdocs/models/usage_model.rb

@@ -0,0 +1,9 @@
+require 'blazingdocs/models/base_model'
+
+module BlazingDocs
+  class UsageModel < BaseModel
+    attr_accessor :quota
+    attr_accessor :page_count
+    attr_accessor :usage
+  end
+end

data/lib/blazingdocs/parameters/merge_parameters.rb

@@ -0,0 +1,43 @@
+module BlazingDocs
+  DATA_SOURCE_TYPES ||= {
+    'csv' => 'Csv',
+    'json' => 'Json',
+    'xml' => 'Xml'
+  }
+
+  class MergeParameters
+    attr_accessor :data_source_name
+    attr_accessor :parse_columns
+    attr_accessor :sequence
+    attr_accessor :data_source_type
+    attr_accessor :strict
+
+    def initialize(sequence = false, data_source_type = 'json', strict = false, data_source_name = 'data', parse_columns = false)
+      @data_source_name = data_source_name
+
+      if !!sequence == sequence
+        @sequence = sequence
+      else
+        raise TypeError, 'sequence expects to be boolean'
+      end
+
+      if !DATA_SOURCE_TYPES[data_source_type.downcase].nil?
+        @data_source_type = DATA_SOURCE_TYPES[data_source_type.downcase]
+      else
+        raise TypeError, 'data_source_type expects csv, json or xml'
+      end
+
+      if !!strict == strict
+        @strict = strict
+      else
+        raise TypeError, 'strict expects to be boolean'
+      end
+
+      if !!parse_columns == parse_columns
+        @parse_columns = parse_columns
+      else
+        raise TypeError, 'parse_columns expects to be boolean'
+      end
+    end
+  end
+end

data/lib/blazingdocs/utils/hash_utils.rb

@@ -0,0 +1,82 @@
+module BlazingDocs
+  module Utils
+
+    def to_snake_keys(value = {})
+      case value
+      when Array
+        value.map { |v| to_snake_keys(v) }
+      when Hash
+        snake_hash(value)
+      else
+        value
+      end
+    end
+
+    def to_camel_keys(value = {})
+      case value
+      when Array
+        value.map { |v| to_camel_keys(v) }
+      when Hash
+        camel_hash(value)
+      else
+        value
+      end
+    end
+
+    def to_hash(obj)
+      hash = {}
+      obj.instance_variables.each { |var| hash[var.to_s.delete('@')] = obj.instance_variable_get(var) }
+      hash
+    end
+
+    private
+
+    def snake_hash(value)
+      value.map { |k, v| [underscore_key(k), to_snake_keys(v)] }.to_h
+    end
+
+    def underscore_key(key)
+      case key
+      when Symbol
+        underscore(key.to_s).to_sym
+      when String
+        underscore(key)
+      else
+        key
+      end
+    end
+
+    def underscore(string)
+      @__memoize_underscore ||= {}
+
+      return @__memoize_underscore[string] if @__memoize_underscore[string]
+
+      @__memoize_underscore[string] =
+        string.tr("::", "/")
+              .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+              .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+              .tr("-", "_")
+              .downcase
+      @__memoize_underscore[string]
+    end
+
+    def camel_hash(value)
+      value.map { |k, v| [camel_case_key(k), to_camel_keys(v)] }.to_h
+    end
+
+    def camel_case_key(key)
+      case key
+      when Symbol
+        camel_case_lower(key.to_s).to_sym
+      when String
+        camel_case_lower(key)
+      else
+        key
+      end
+    end
+
+    def camel_case_lower(string)
+      string.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+    end
+  end
+end

data/lib/blazingdocs/version.rb

@@ -0,0 +1,3 @@
+module BlazingDocs
+  VERSION = '1.0.0'
+end

data/lib/blazingdocs.rb

@@ -0,0 +1,19 @@
+require 'blazingdocs/version'
+require 'blazingdocs/configuration'
+require 'blazingdocs/blazing_client'
+
+module BlazingDocs
+  module_function
+
+  def configure
+    yield(config)
+  end
+
+  def config
+    @config ||= Configuration.new
+  end
+
+  def create_client(api_key)
+    BlazingClient.new(api_key, config)
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: blazingdocs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mentalstack
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-19 00:00:00.000000000 Z
+dependencies: []
+description: BlazingDocs Ruby client. High-performance document generation API. Generate
+  documents and reports from СSV, JSON, XML with 99,9% uptime and 24/7 monitoring
+email:
+- hello@blazingdocs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- blazingdocs.gemspec
+- lib/blazingdocs.rb
+- lib/blazingdocs/blazing_client.rb
+- lib/blazingdocs/configuration.rb
+- lib/blazingdocs/errors/blazing_error.rb
+- lib/blazingdocs/models/account_model.rb
+- lib/blazingdocs/models/base_model.rb
+- lib/blazingdocs/models/file_model.rb
+- lib/blazingdocs/models/operation_model.rb
+- lib/blazingdocs/models/operation_type_model.rb
+- lib/blazingdocs/models/plan_model.rb
+- lib/blazingdocs/models/template_model.rb
+- lib/blazingdocs/models/usage_model.rb
+- lib/blazingdocs/parameters/merge_parameters.rb
+- lib/blazingdocs/utils/hash_utils.rb
+- lib/blazingdocs/version.rb
+homepage: https://blazingdocs.com
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/blazingdocs/blazingdocs-ruby/issues
+  changelog_uri: https://github.com/blazingdocs/blazingdocs-ruby/blob/master/CHANGELOG.md
+  documentation_uri: https://docs.blazingdocs.com
+  homepage_uri: https://blazingdocs.com
+  source_code_uri: https://github.com/blazingdocs/blazingdocs-ruby
+post_install_message:
+rdoc_options:
+- "--title"
+- BlazingDocs Ruby client
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+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.2.22
+signing_key:
+specification_version: 4
+summary: BlazingDocs Ruby client
+test_files: []