docx_manager_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 220ebbb2f4e89ea757e7deef16d1df7a3b8f0108105fd3c7bf4d92db66a62322
+  data.tar.gz: 9302f4d2a0d7033dbbdaba79c37343070d720fe8fcae88903945fbb6cdae30b5
+SHA512:
+  metadata.gz: 151a4e8ab801e8099138cb1606b137dbcf9f43461a8d85eabe8cee3b1d6adbb0c06f53b87a789568800d45a7cbc27493f549a43d89f059e2a02cafb67362b948
+  data.tar.gz: 40261aac0d5239ae89c71705367544f88cb2a1298ff61b8eefc74820c04d13300d21b6c328d57d1e2d306e6319e0f1fe79d8278c4b9e91e1d4dba445d07544db

data/docx_manager_client.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docx_manager_client/version'
+
+Gem::Specification.new do |s|
+  s.name          = "docx_manager_client"
+  s.version       = DocxManagerClient::VERSION
+  s.authors       = ["Bader Sader"]
+  s.email         = ["bader.bahjat@gmail.com"]
+
+  s.homepage      = 'https://github.com/baderSader/docx_manager_client'
+  s.summary       = 'a rails client for the project DocxManagerServer'
+  s.description   = 'a client for the porject DocxManagerServer that server docx into pdf and png ..etc please check:{{URL}}'
+  s.platform      = Gem::Platform::RUBY
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files lib init.rb docx_manager_client.gemspec`.split($INPUT_RECORD_SEPARATOR)
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.4.0'
+
+  s.add_runtime_dependency 'activemodel', '>= 5'
+  s.add_runtime_dependency 'faraday_middleware', '~> 1.0.0'
+  s.add_runtime_dependency 'hashie', '~> 4.1', '>= 4.0.0'
+end

data/lib/docx_manager_client.rb

@@ -0,0 +1,18 @@
+require "docx_manager_client/version"
+
+require "docx_manager_client/logger"
+require "docx_manager_client/connection"
+require "docx_manager_client/model"
+
+module DocxManagerClient
+  class DependencyError < StandardError; end
+end
+include DocxManagerClient::Logger
+include DocxManagerClient::Connection
+
+require "active_model/callbacks"
+ActiveModel::Callbacks.include(DocxManagerClient::Model)
+
+ActiveSupport.on_load(:active_record) do
+  extend DocxManagerClient::Model
+end

data/lib/docx_manager_client/connection.rb

@@ -0,0 +1,66 @@
+require 'faraday_middleware'
+require 'hashie'
+
+module DocxManagerClient
+  module Connection
+    class ConfigMissing < StandardError; end
+
+    def self.docx_server_api(method, path, body = {})
+      response = docx_server_json.send(method, path, body)
+      [response.status, Hashie::Mash.new(response.body)]
+    end
+
+    def self.docx_server_api_multipart(method, path, payload)
+      response = docx_server_multipart.send(method, path, payload)
+      [response.status, Hashie::Mash.new(response.body)]
+    end
+
+    def self.docx_server_headers
+      {
+        'client'        => docx_manager_api_key,
+        'Authorization' => docx_manager_token,
+        'User-Agent'    => "DocxManagerClient #{DocxManagerClient::VERSION}"
+      }
+    end
+
+    def self.docx_server_json
+      @docx_server_json ||= Faraday.new(url: "#{docx_manager_server_path}/api/v1", headers: docx_server_headers) do |f|
+        f.request   :json
+        f.use       :instrumentation
+        f.response  :json
+        f.adapter   :net_http
+      end
+    end
+
+    def self.docx_server_multipart
+      @docx_server_multipart ||= Faraday.new(url: "#{docx_manager_server_path}/api/v1", headers: docx_server_headers) do |f|
+        f.request   :multipart
+        f.request   :url_encoded
+        f.use       :instrumentation
+        f.response  :json
+        f.adapter   :net_http
+      end
+    end
+
+    def self.docx_manager_server_path
+      exist = ENV['DOCX_MANAGER_SERVER_PATH'] || Rails.application.secrets[:docx_manager_server_path]
+      raise ConfigMissing.new("ENV['DOCX_MANAGER_SERVER_PATH'] or Rails.application.secrets[:docx_manager_server_path] not exist") if exist.blank?
+
+      exist.to_s
+    end
+
+    def self.docx_manager_api_key
+      exist = ENV['DOCX_MANAGER_API_KEY'] || Rails.application.secrets[:docx_manager_api_key]
+      raise ConfigMissing.new("ENV['DOCX_MANAGER_API_KEY'] or Rails.application.secrets[:docx_manager_api_key] not exist") if exist.blank?
+
+      exist.to_s
+    end
+
+    def self.docx_manager_token
+      exist = ENV['DOCX_MANAGER_TOKEN'] || Rails.application.secrets[:docx_manager_token]
+      raise ConfigMissing.new("ENV['DOCX_MANAGER_TOKEN'] or Rails.application.secrets[:docx_manager_token] not exist") if exist.blank?
+
+      exist.to_s
+    end
+  end
+end

data/lib/docx_manager_client/logger.rb

@@ -0,0 +1,23 @@
+module DocxManagerClient
+  module Logger
+
+    def self.logger
+      @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+
+    def self.logger=(logger)
+      @@logger = logger
+    end
+
+    ActiveSupport::Notifications.subscribe('request.faraday') do |name, starts, ends, _, env|
+      url         = env[:url]
+      http_method = env[:method].to_s.upcase
+      duration    = (ends - starts)
+      response    = env.response.body
+      info        = "\e[96m \e[1m DocxManagerClient \e[0m \e[33m #{url.host} #{http_method}\e[0m \e[92m #{env.status}\e[0m \e[1m \e[32m(#{duration} seconds) \e[0m \e[4m#{url.request_uri}\e[0m"
+      debug       = "DocxManagerClient::#{response}"
+      DocxManagerClient::Logger.logger.info  info
+      DocxManagerClient::Logger.logger.debug debug
+    end
+  end
+end

data/lib/docx_manager_client/model.rb

@@ -0,0 +1,9 @@
+require_relative './model_additions/belongs_to_docx_template.rb'
+require_relative './model_additions/docx_template.rb'
+
+module DocxManagerClient
+  module Model
+    include DocxManagerClient::ModelAdditions::BelongsToDocxTemplate
+    include DocxManagerClient::ModelAdditions::DocxTemplate
+  end
+end

data/lib/docx_manager_client/model_additions/belongs_to_docx_template.rb

@@ -0,0 +1,73 @@
+module DocxManagerClient
+  module ModelAdditions
+    module BelongsToDocxTemplate
+
+      def belongs_to_docx_template(name:, belongs_to:, template_type:)
+        # dependency check
+        raise DocxManagerClient::DependencyError.new("#{self.name} dose not have relation 'belongs_to :#{belongs_to}'") unless self.reflect_on_all_associations(:belongs_to).map(&:name).include?(belongs_to.to_sym)
+
+        # attr_accessor
+        attr_accessor :"#{name}_docx_file"
+
+        # callbacks
+        after_save    :"post_#{name}_docx"
+        after_destroy :"delete_#{name}_docx"
+
+        # instance methods
+        define_method "#{name}_docx_path" do
+          status, response = DocxManagerClient::Connection.docx_server_api(:get, send("#{name}_docx_request_paht"))
+          docx_response_attr(status, response, :docx_url)
+        end
+
+        define_method "#{name}_pdf_path" do
+          status, response = DocxManagerClient::Connection.docx_server_api(:get, send("#{name}_docx_request_paht"))
+          docx_response_attr(status, response, :pdf_url)
+        end
+
+        define_method "#{name}_png_path" do
+          status, response = DocxManagerClient::Connection.docx_server_api(:get, send("#{name}_docx_request_paht"))
+          docx_response_attr(status, response, :png_url)
+        end
+
+        define_method "post_#{name}_docx" do
+          status, response = DocxManagerClient::Connection.docx_server_api(:post, send("#{name}_docx_request_paht"), send("#{name}_request_attributes"))
+          docx_response_attr(status, response)
+        end
+
+        define_method "delete_#{name}_docx" do
+          status, response = DocxManagerClient::Connection.docx_server_api(:delete, send("#{name}_docx_request_paht"), send("#{name}_request_attributes"))
+          docx_response_attr(status, response)
+        end
+
+        # private methods
+        define_method :docx_response_attr do |status, response, attr = nil|
+          if status < 300
+            attr.nil? ? response.data : response.data.attributes.send(attr)
+          else
+            response.errors
+          end
+        end
+
+        define_method "#{name}_docx_request_paht" do
+          reference_record_id   = send("#{belongs_to}_id")
+          reference_record_type = self.class.reflect_on_association(belongs_to).klass.name
+          record_id             = id
+          record_type           = self.class.name
+          "templates/#{template_type}/#{reference_record_type}/#{reference_record_id}/generated_documents/#{record_type}/#{record_id}"
+        end
+
+        define_method "#{name}_request_attributes" do
+          { request_attributes: send("#{name}_docx_hash") }
+        end
+
+        define_method "#{name}_docx_hash" do
+          raise NotImplementedError,
+          "\e[1m\e[91m#{self.class}\e[0m belongs_to_docx_template :#{name} but didn't define \e[91m'#{name}_docx_hash'\e[0m"
+        end
+
+        private :docx_response_attr, "#{name}_docx_hash".to_sym, "#{name}_docx_request_paht".to_sym, "#{name}_request_attributes".to_sym
+
+      end
+    end
+  end
+end

data/lib/docx_manager_client/model_additions/docx_template.rb

@@ -0,0 +1,54 @@
+module DocxManagerClient
+  module ModelAdditions
+    module DocxTemplate
+      def docx_template(template_type:)
+
+        # attr_accessor
+        attr_accessor :"#{template_type}_docx_file"
+
+        # callbacks
+        after_save    :"post_#{template_type}_document"
+        after_destroy :"delete_#{template_type}_document"
+
+        # instance methods
+        define_method "#{template_type}_docx_path" do
+          status, response = DocxManagerClient::Connection.docx_server_api(:get, send("#{template_type}_docx_request_paht"))
+          docx_response_attr(status, response, :docx_url)
+        end
+
+        define_method "post_#{template_type}_document" do
+          return unless send("#{template_type}_docx_file").present?
+
+          file = Faraday::FilePart.new(
+            send("#{template_type}_docx_file").tempfile.path,
+            send("#{template_type}_docx_file").content_type,
+            send("#{template_type}_docx_file").original_filename
+          )
+          payload = { template: { document: file } }
+          status, response = DocxManagerClient::Connection.docx_server_api_multipart(:post, send("#{template_type}_docx_request_paht"), payload)
+          docx_response_attr(status, response, :docx_url)
+        end
+
+        define_method "delete_#{template_type}_document" do
+          status, response = DocxManagerClient::Connection.docx_server_api(:delete, send("#{template_type}_docx_request_paht"))
+          docx_response_attr(status, response)
+        end
+
+        # private methods
+        define_method :docx_response_attr do |status, response, attr = nil|
+          if status < 300
+            attr.nil? ? response.data : response.data.attributes.send(attr)
+          else
+            response.errors
+          end
+        end
+
+        define_method "#{template_type}_docx_request_paht" do
+          "templates/#{template_type}/#{self.class.name}/#{id}"
+        end
+
+        private :docx_response_attr, "#{template_type}_docx_request_paht".to_sym
+      end
+    end
+  end
+end

data/lib/docx_manager_client/version.rb

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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: docx_manager_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bader Sader
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: a client for the porject DocxManagerServer that server docx into pdf
+  and png ..etc please check:{{URL}}
+email:
+- bader.bahjat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- docx_manager_client.gemspec
+- lib/docx_manager_client.rb
+- lib/docx_manager_client/connection.rb
+- lib/docx_manager_client/logger.rb
+- lib/docx_manager_client/model.rb
+- lib/docx_manager_client/model_additions/belongs_to_docx_template.rb
+- lib/docx_manager_client/model_additions/docx_template.rb
+- lib/docx_manager_client/version.rb
+homepage: https://github.com/baderSader/docx_manager_client
+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.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: a rails client for the project DocxManagerServer
+test_files: []