upfluence-utils 0.8.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef4e2db1636205d5dc5985b0ba6fd5a42f73e6e09f59bc8726af03c860ccf106
-  data.tar.gz: a5ae9ce7e4c35d4cdae827307587a60c9b70ce1ec04b552cf030913d9a9254d1
+  metadata.gz: 35be0f17a3c73784afa8e178a740bed54d6491d182d592177904bbfbf31e0b83
+  data.tar.gz: 9d7bebee3fbdead4d8b32e3314adbfba61e282811249b023fc2d0488dfb0a538
 SHA512:
-  metadata.gz: 90e59aac5789abe24831bae11947388a76696fb33bc85e8bf0f781e77010b59d3feee76d21a97cf6986d16d4070b07297da7ff2dc981dae30b071cd64ba20d9a
-  data.tar.gz: 7c321b4f2e7dfa24ba3ad4fc618cd8acded86ba22d87a9d68cc92990d196ef847949e2fd88c529d302c571c8fe437f5ee0a20c0b6a16fa17ddfb662a8f425597
+  metadata.gz: 423c2ef58a5363705bb5f90ec629648000a2d25c14c2536da02afb1def3f14c946db657ca244887ec3cc5400d2b78feaf6be5c92103b8853a0af420cdf6bbffc
+  data.tar.gz: e559829e31729eaa0ed30bde6d3d4fcda417d7833324a93c1ac923e4bf9e8ff3fcbf0abd0b4f0357f4c967e2d9a9b165d1c33c2fe542a4bb9f36ac5212ac836c

data/.github/pull_request_template.md

@@ -0,0 +1,30 @@
+### What does this PR do?
+
+<!-- A brief description of the context of this pull request and its purpose. -->
+
+Fixes #<!-- enter issue number here -->
+
+### What are the observable changes?
+<!-- This question could be adequate with multiple use cases, for example: -->
+
+<!-- Frontend: explain the feature created / updated, give instructions telling how to see the change in staging -->
+<!-- Performance: what metric should be impacted, link to the right graphana dashboard for exemple -->
+<!-- Bug: a given issue trail on sentry should stop happening -->
+<!-- Feature: Implements X thrift service / Z HTTP REST API added, provide instructions on how leverage your feature from staging or your workstation -->
+
+### Good PR checklist
+
+- [ ] Title makes sense
+- [ ] Is against the correct branch
+- [ ] Only addresses one issue
+- [ ] Properly assigned
+- [ ] Added/updated tests
+- [ ] Added/updated documentation
+- [ ] Properly labeled
+
+### Additional Notes
+
+<!--
+    You can add anything you want here, an explanation on the way you built your implementation,
+    precisions on the origin of the bug, gotchas you need to mention.
+ -->

data/lib/test.rb

@@ -0,0 +1,4 @@
+require 'upfluence/http/server'
+
+Upfluence::HTTP::Server.new do
+end.serve

data/lib/upfluence.rb

@@ -2,4 +2,4 @@ require 'upfluence/utils'
 require 'upfluence/endpoint/api_endpoint'
 require 'upfluence/mixin/strong_parameters'
 require 'upfluence/mixin/pagination'
-require 'upfluence/base/exceptions/validation_error'
+require 'upfluence/resources'

data/lib/upfluence/http/endpoint/api_endpoint.rb

@@ -1,12 +1,15 @@
 require 'sinatra'
 require 'active_record'
 require 'active_support/hash_with_indifferent_access'
+require 'upfluence/http/endpoint/validation_error'
 
 module Upfluence
   module HTTP
     module Endpoint
       class BadRequest < StandardError; end
       class APIEndpoint < Sinatra::Base
+        VALIDATION_ERROR_KLASS = ValidationError
+
         disable :show_exceptions
         disable :logging
         disable :dump_errors
@@ -44,7 +47,7 @@ module Upfluence
           def respond_with(resource, *args)
             if resource.respond_to?(:errors) && resource.errors.any?
               status = 422
-              result = Base::Exceptions::ValidationError.from_model(
+              result = VALIDATION_ERROR_KLASS.from_model(
                 resource
               ).to_json
             else

data/lib/upfluence/http/endpoint/validation_error.rb

@@ -0,0 +1,31 @@
+module Upfluence
+  module HTTP
+    module Endpoint
+      class ValidationError
+        def initialize(validations)
+          @validations = validations
+        end
+
+        class << self
+          def from_model(model)
+            validations = model.errors.details.map do |error_field, errors|
+              errors.map do |error|
+                OpenStruct.new(
+                  ressource: model.model_name.singular,
+                  field:     error_field.to_s,
+                  code:      error[:error].to_s
+                )
+              end
+            end.flatten
+
+            new(validations)
+          end
+        end
+
+        def to_json
+          { errors: @validations }.to_json
+        end
+      end
+    end
+  end
+end

data/lib/upfluence/http/middleware/application_headers.rb

@@ -4,10 +4,7 @@ module Upfluence
       class ApplicationHeaders
         def initialize(app, handler)
           @app = app
-          @headers = {
-            "X-Upfluence-Unit-Name" => handler.getName,
-            "X-Upfluence-Version" => build_version(handler.getVersion)
-          }
+          @headers = handler ? build_headers(handler) : {}
         end
 
         def call(env)
@@ -17,14 +14,19 @@ module Upfluence
 
         private
 
+        def build_headers(handler)
+          {
+            'X-Upfluence-Unit-Name' => handler.getName,
+            'X-Upfluence-Version'   => build_version(handler.getVersion)
+          }
+        end
+
         def build_version(thrift_version)
-          if v = thrift_version.semantic_version
-            return "v#{v.major}.#{v.minor}.#{v.patch}"
-          end
+          v = thrift_version.semantic_version
+          return "v#{v.major}.#{v.minor}.#{v.patch}" if v
 
-          if v = thrift_version.git_version
-            return "v0.0.0-#{v.commit}"
-          end
+          v = thrift_version.git_version
+          return "v0.0.0-#{v.commit}" if v
 
           'undefined'
         end

data/lib/upfluence/http/server.rb

@@ -14,7 +14,6 @@ require 'upfluence/http/middleware/application_headers'
 require 'upfluence/http/middleware/handle_exception'
 require 'upfluence/http/middleware/prometheus'
 require 'upfluence/http/middleware/cors'
-require 'upfluence/handler/base'
 
 module Upfluence
   module HTTP
@@ -29,13 +28,19 @@ module Upfluence
         push_gateway_interval: 15, # sec
         app_name: ENV['APP_NAME'] || 'uhttp-rb-server',
         unit_name: ENV['UNIT_NAME'] || 'uhttp-rb-server-anonymous',
+        base_processor_klass: nil,
+        base_handler_klass: nil,
         debug: ENV['DEBUG']
-      }.freeze
+      }
 
       def initialize(options = {}, &block)
         @options = DEFAULT_OPTIONS.dup.merge(options)
         opts = @options
-        base_handler = Handler::Base.new(opts[:interfaces])
+        base_handler = nil
+
+        if opts[:base_handler_klass]
+          base_handler = opts[:base_handler_klass].new(@options[:interfaces])
+        end
 
         @builder = Builder.new do
           use Middleware::Logger
@@ -54,13 +59,13 @@ module Upfluence
             run(opts[:healthcheck_endpoint] || Endpoint::Healthcheck.new)
           end
 
-          map '/base' do
-            run_thrift Base::Base_service::BaseService::Processor, base_handler
+          if opts[:base_processor_klass] && base_handler
+            map '/base' do
+              run_thrift(opts[:base_processor_klass], base_handler)
+            end
           end
 
-          map '/debug' do
-            run Endpoint::Profiler.new
-          end if opts[:debug]
+          map('/debug') { run(Endpoint::Profiler.new) } if opts[:debug]
 
           instance_eval(&block)
         end

data/lib/upfluence/resources.rb

@@ -0,0 +1 @@
+require 'upfluence/resources/countries'

data/lib/upfluence/resources/countries.rb

@@ -0,0 +1,23 @@
+module Upfluence
+  module Resources
+    COUNTRIES = %w[
+      US FR GB DE CH AF AL DZ AS AD AO AI
+      AG AR AM AW AU AT AZ BS BH BD BB BY
+      BE BZ BJ BM BT BO BA BW BR BN BG BF
+      BI CV KH CM CA KY CF TD CL CN CO KM
+      CG CD CK CI HR CU CY CZ DK DJ DM DO
+      GW GY HT VA HN HK HU IS IN ID IR IQ
+      IE IM IL IT JM JP JE JO KZ KE KI KP
+      KR KW KG LA LV LB LI LS LR LY LT LU
+      MO MK MG MW MY MV ML MT MH MQ MR MU
+      MX FM MD MC MN ME MS MA MZ MM NA NR
+      NP NL NC NZ NI NE NG NO OM PK PW PS
+      PA PG PY PE PH PL PT PR QA RE RO RU
+      RW KN LC VC WS SM ST SA SN RS SC SL
+      SG SK SI SB SO ZA ES LK SD SR SZ SE
+      SY TW TJ TZ TH TL TG TO TT TN TR TM
+      TC TV UG UA AE GB UY UZ VU VE VN VG
+      VI EH YE ZM ZW CR
+    ].freeze
+  end
+end

data/lib/upfluence/utils/version.rb

@@ -1,5 +1,5 @@
 module Upfluence
   module Utils
-    VERSION = '0.8.1'.freeze
+    VERSION = '0.9.2'.freeze
   end
 end

data/rbutils.gemspec

@@ -19,8 +19,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_runtime_dependency 'upfluence-thrift', '~> 2.1'
-  spec.add_runtime_dependency 'base-thrift', '>= 0.1.0'
+  spec.add_runtime_dependency 'upfluence-thrift'
   spec.add_runtime_dependency 'sinatra'
   spec.add_runtime_dependency 'redis'
   spec.add_runtime_dependency 'sentry-raven'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upfluence-utils
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Upfluence
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,32 +54,18 @@ dependencies:
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: upfluence-thrift
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: base-thrift
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -234,13 +220,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - dev@upfluence.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -248,19 +235,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/test.rb
 - lib/upfluence.rb
 - lib/upfluence/amqp/server.rb
-- lib/upfluence/base/exceptions/validation_error.rb
 - lib/upfluence/endpoint/api_endpoint.rb
 - lib/upfluence/environment.rb
 - lib/upfluence/error_logger.rb
 - lib/upfluence/error_logger/null.rb
 - lib/upfluence/error_logger/sentry.rb
-- lib/upfluence/handler/base.rb
 - lib/upfluence/http/builder.rb
 - lib/upfluence/http/endpoint/api_endpoint.rb
 - lib/upfluence/http/endpoint/healthcheck.rb
 - lib/upfluence/http/endpoint/profiler.rb
+- lib/upfluence/http/endpoint/validation_error.rb
 - lib/upfluence/http/middleware/application_headers.rb
 - lib/upfluence/http/middleware/cors.rb
 - lib/upfluence/http/middleware/handle_exception.rb
@@ -272,6 +259,8 @@ files:
 - lib/upfluence/mixin/strong_parameters.rb
 - lib/upfluence/peer.rb
 - lib/upfluence/pool.rb
+- lib/upfluence/resources.rb
+- lib/upfluence/resources/countries.rb
 - lib/upfluence/utils.rb
 - lib/upfluence/utils/http/middleware/null.rb
 - lib/upfluence/utils/semaphore.rb
@@ -288,7 +277,7 @@ homepage: https://github.com/upfluence/rbutils
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -304,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Upfluence common utils for Ruby projects
 test_files: []

data/lib/upfluence/base/exceptions/validation_error.rb

@@ -1,35 +0,0 @@
-require 'thrift/exceptions'
-require 'base/exceptions/exceptions_types'
-
-module Base
-  module Exceptions
-    class ValidationError < ::Thrift::Exception
-      class << self
-        attr_accessor :domain
-
-        def from_model(model)
-          validation_errors = model.errors.details.map do |error_field, errors|
-            errors.map do |error|
-              Base::Exceptions::Validation.new(
-                domain: domain,
-                model: model.model_name.singular,
-                field: error_field.to_s,
-                error: error[:error].to_s
-              )
-            end
-          end.flatten
-
-          new(validations: validation_errors)
-        end
-      end
-
-      def to_json
-        {
-          errors: validations.map do |v|
-            { resource: v.model, field: v.field, code: v.error }
-          end
-        }.to_json
-      end
-    end
-  end
-end

data/lib/upfluence/handler/base.rb

@@ -1,56 +0,0 @@
-require 'base/base_service/base_service'
-require 'base/version/version_types'
-require 'base/version'
-
-module Upfluence
-  module Handler
-    class Base
-      def initialize(modules = [])
-        @alive_since = Time.now.to_i
-        @modules = modules.reduce({ 'base' => ::Base::VERSION }) do |acc, cur|
-          acc.merge cur.name.downcase => cur::VERSION
-        end
-      end
-
-      def getVersion
-        semantic_version = if ENV['SEMVER_VERSION']
-          major, minor, patch = ENV['SEMVER_VERSION'].split('.')
-          ::Base::Version::SemanticVersion.new(
-            major: major[1..-1].to_i,
-            minor: minor.to_i,
-            patch: patch.to_i
-          )
-        end
-
-        git_version = if ENV['GIT_COMMIT']
-          ::Base::Version::GitVersion.new(
-            commit: ENV['GIT_COMMIT'],
-            branch: ENV['GIT_BRANCH'],
-            remote: ENV['GIT_REMOTE']
-          )
-        end
-
-        ::Base::Version::Version.new(
-          semantic_version: semantic_version,
-          git_version: git_version
-        )
-      end
-
-      def getName
-        ENV['UNIT_NAME'] || 'default'
-      end
-
-      def getStatus
-        ::Base::Base_service::Status::ALIVE
-      end
-
-      def aliveSince
-        @alive_since
-      end
-
-      def getInterfaceVersions
-        @modules
-      end
-    end
-  end
-end