omni_parse_client_ruby 1.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4e6021e30306fb1f32578de382bac72ed381c4469e4607262dc9771fce78ff5
+  data.tar.gz: 48ec8a6616d12dfcebb97f640aee54243c484c51ab7217c1ed0e191e2bc6c836
+SHA512:
+  metadata.gz: 4da5ce3973fdbdc97da0d0179ea2047ea424e802cc2df3ea3337f85d11c586edab768ae3a14de3dac5d34f4495a9749c6c54827fb3499826ee241cee34671dcd
+  data.tar.gz: 2822ad0d8bc94b621d2b92d56d4c1d3888233cf9eec40ba2cd38b5390b69bacf7f978a1b4289cac96f9ff91c01d0d32475c01557a8bb8801794e965bc459b3e9

data/lib/omni_parse_client_ruby/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OmniparseClient
+  # Main Class for the library
+  # here all modules are beeing included into class
+  class Base
+    attr_reader :html, :vcf, :fixture
+
+    include Connection
+
+    def initialize(p = {})
+      setup_connection(p)
+      @html    = Parsers::HtmlParser.new(p)
+      @vcf     = Parsers::VcfParser.new(p)
+      @fixture = Parsers::OmniFixture.new(p)
+    end
+  end
+end

data/lib/omni_parse_client_ruby/connection.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module OmniparseClient
+  # Connection module
+  module Connection
+    class RetriesLimitReached < StandardError; end
+
+    attr_reader :api_key, :port, :version, :host
+
+    DEFAULT_URL           = 'www.omniparse.com'
+    DEFAULT_PORT          = 443
+    DEFAULT_VERSION       = '/api/v1'
+    # Retries count if network error occurs
+    MAX_RETRIES_COUNT     = ENV['OMNI_MAX_RETRIES_COUNT']&.to_i || 5
+    # Time in seconds for consequent delays for reconnection
+    RETRIES_DELAYS_ARRAY  =
+      ENV['OMNI_RETRIES_DELAYS_ARRAY']&.split(',')&.map(&:to_i) ||
+      [5, 30, 2 * 60, 10 * 60, 30 * 60].freeze
+    EXCEPTIONS_INCLUDING_MESSAGES = [
+      SocketError,
+      Net::OpenTimeout
+    ].freeze
+    EXCEPTIONS_EXCLUDING_MESSAGES = [
+      Net::HTTPFatalError
+    ].freeze
+    CLIENT_ERRORS = [
+      Net::HTTPInternalServerError,
+      Net::HTTPNotImplemented,
+      Net::HTTPBadGateway,
+      Net::HTTPServiceUnavailable,
+      Net::HTTPGatewayTimeout,
+      Net::HTTPInsufficientStorage,
+      Net::HTTPLoopDetected,
+      Net::HTTPRequestTimeout,
+      Net::HTTPBadRequest,
+      Net::HTTPNotFound
+    ].freeze
+
+    # constructor
+    def setup_connection(p = {})
+      @host       = p[:host] || DEFAULT_URL
+      @port       = p[:port] || DEFAULT_PORT
+      @version    = p[:version] || DEFAULT_VERSION
+      @api_key    = p[:api_key]
+    end
+
+    def omni_get(request_url, params = {}, headers = {})
+      uri = URI(request_url)
+      uri.port = port
+      uri.query = URI.encode_www_form(params)
+      req = Net::HTTP::Get.new(uri)
+      headers.each do |header, val|
+        req[header] = val
+      end
+
+      make_request(req)
+    end
+
+    def omni_post(request_url, params = {}, headers = {})
+      uri = URI(request_url)
+      uri.port = port
+      req = Net::HTTP::Post.new(uri)
+      req.set_form_data(params)
+      headers.each do |header, val|
+        req[header] = val
+      end
+
+      make_request(req)
+    end
+
+    # headers
+    def headers
+      {
+        'Authorization' => "Bearer #{@api_key}"
+      }
+    end
+
+    def base_url
+      # request = "localhost:3001//api/v1/html_parser/parse"
+      components = { host: host, port: port }
+      URI::HTTPS.build(components).to_s
+    end
+
+    # TEST connection
+    def test_connection
+      request_url = base_url + test_connection_path
+      response = omni_get(request_url, {}, headers)
+      response
+    end
+
+    # Paths
+    def test_connection_path
+      "/#{version}/test_connection"
+    end
+
+    private
+
+    def retry_on_server_error(&block)
+      @retry_index = 0
+      begin
+        yield block
+      rescue *EXCEPTIONS_INCLUDING_MESSAGES => e
+        raise RetriesLimitReached, e.message if retries_limit_reached?
+
+        sleep(RETRIES_DELAYS_ARRAY[@retry_index])
+        @retry_index += 1
+        retry
+      rescue *EXCEPTIONS_EXCLUDING_MESSAGES => e
+        if retries_limit_reached?
+          message = "#{e&.data&.code} #{e&.data&.code_type}"
+          raise RetriesLimitReached, message
+        end
+
+        sleep(RETRIES_DELAYS_ARRAY[@retry_index])
+        @retry_index += 1
+        retry
+      rescue Net::HTTPClientException => e
+        raise Net::HTTPClientException.new(e.message.tr('"', ''), e.response)
+      end
+    end
+
+    def make_request(request)
+      retry_on_server_error do
+        uri = request.uri
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+        res.error! if !res.is_a?(Net::HTTPSuccess) && CLIENT_ERRORS.include?(res.code_type)
+
+        res
+      end
+    end
+
+    def retries_limit_reached?
+      @retry_index >= MAX_RETRIES_COUNT
+    end
+  end
+end

data/lib/omni_parse_client_ruby/loggable.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OmniparseClient
+  # Log responses and requests methods
+  module Loggable
+    attr_accessor :last_request, :last_response
+  end
+end

data/lib/omni_parse_client_ruby/parsers/html_parser.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module OmniparseClient
+  module Parsers
+    # PARSER
+    # @omni = Omni::Client.new(url:     'www.example.com',
+    #                          version: 'v1',
+    #                          api_key: 'token')
+    # @omni_html = @omni.html
+    class HtmlParser
+      attr_reader :html, :omni_parser_id
+
+      include Connection
+      include Loggable
+
+      def initialize(p = {})
+        setup_connection(p)
+      end
+
+      # fetching all parsers
+      # @omni_html.all(parser_id)
+      def all
+        self.last_request = base_url + index_path
+        response = omni_get(last_request, {}, headers)
+        self.last_response = Response.new(response)
+        last_response
+      end
+
+      # preparing / building html params
+      # @omni_html.prepare(parser_id, html)
+      def prepare(p = {})
+        @html           = p[:html]
+        @omni_parser_id = p[:omni_parser_id]
+        true
+      end
+
+      # Post parse run
+      # @omni_html.parse(parser_id, html)
+      def parse(p = {})
+        return false unless p[:html]
+        return false unless p[:omni_parser_id]
+
+        prepare(p)
+
+        self.last_request = base_url + parse_path
+        response = omni_post(last_request,
+                             params,
+                             headers)
+        self.last_response = Response.new(response)
+        last_response
+      end
+
+      # Post trial run
+      # @omni_html.parse(parser_id, html)
+      def trial_run(p = {})
+        return false unless p[:omni_parser_id]
+
+        prepare(p)
+
+        self.last_request = base_url + trial_run_path
+        response = omni_post(last_request,
+                             params,
+                             headers)
+        self.last_response = Response.new(response)
+        last_response
+      end
+
+      # parsing params
+      def params
+        {
+          omni_parser_id: @omni_parser_id,
+          html: @html
+        }
+      end
+
+      # Paths
+      def parse_path
+        "/#{version}/html_parser/parse"
+      end
+
+      def trial_run_path
+        "/#{version}/html_parser/trial_run"
+      end
+
+      def index_path
+        "/#{version}/html_parsers"
+      end
+    end
+  end
+end

data/lib/omni_parse_client_ruby.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require_relative 'omni_parse_client_ruby/loggable'
+require_relative 'omni_parse_client_ruby/connection'
+require_relative 'omni_parse_client_ruby/base'
+require_relative 'omni_parse_client_ruby/response'
+require_relative 'omni_parse_client_ruby/parsers/html_parser'
+require_relative 'omni_parse_client_ruby/parsers/vcf_parser'
+require_relative 'omni_parse_client_ruby/parsers/omni_fixture'
+
+# Wrapper class
+# Example:
+# @omi = Omni::Client.new(url:     'www.example.com',
+#                         version: 'v1',
+#                         api_key: 'token')
+module Omni
+  class Client < OmniparseClient::Base; end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: omni_parse_client_ruby
+version: !ruby/object:Gem::Version
+  version: 1.3.1
+platform: ruby
+authors:
+- Brian Long
+- Michał Marzec
+- Paweł Jermalonek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+description: Client for omniparse API
+email: brian.long@firstmoversadvantage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/omni_parse_client_ruby.rb
+- lib/omni_parse_client_ruby/base.rb
+- lib/omni_parse_client_ruby/connection.rb
+- lib/omni_parse_client_ruby/loggable.rb
+- lib/omni_parse_client_ruby/parsers/html_parser.rb
+homepage: https://www.fmadata.com/
+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: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Client for omniparse API
+test_files: []