upfluence-utils 0.7.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43f3f95b490a3c99f889f669ee021b0507b3675375edcf9109e00da1c21ee3c4
-  data.tar.gz: 8283a5a34eee43ca112ac1c1855715d83fc234c0e0b42598cde0dcd5d25ca76b
+  metadata.gz: c3bc57cd1a39618d9375c1e012443d9f5b700ab0f5ae821ccd634bc4d09a8c3f
+  data.tar.gz: ef52fa325dd39b37d053349e0adabea839cff25ad4cf1a3f24e56f8af79e3ca7
 SHA512:
-  metadata.gz: c78a34273c1cf57982cf9de5f91ea0059352302ff19ba8df90c55bb99aa70cae56113ced7a7aa94a7ef8ddc58320b5f45d1cc03c944733ce888245fdfa7f6b9d
-  data.tar.gz: 9aaff54cd0bfa01aa26749fc6c5aff3a2d024b61ed64eddf57bc1104ad1e530e185ca066a4d38f4636e1ec99f4d952a9a70d5a3a8660e421e206cdada4bebce1
+  metadata.gz: 3148ad418210609e1fadd1303f0a37b6e27865e67b85102d4828891359fcaeb23b2481d0ad1cc6aa4c0a7967ead1c6aec77b56a6f42dc1b66bc5466a0a0bbc9d
+  data.tar.gz: 3da77ccc075193d01908f5070026ab5b6408b06267bb72c3554704d1f5559316d6b2316f432e6e54de928a155d66227ccca4aaf8b28ddd75ca49e7998b5c3342

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/upfluence.rb

@@ -3,3 +3,4 @@ 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,10 +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
@@ -31,9 +36,9 @@ module Upfluence
             token = params[:access_token]
 
             unless token
-              pattern      = /^Bearer /
-              header       = request.env['HTTP_AUTHORIZATION']
-              token = header.gsub(pattern, '') if header && header.match(pattern)
+              pattern = /^Bearer /
+              header  = request.env['HTTP_AUTHORIZATION']
+              token   = header.gsub(pattern, '') if header&.match(pattern)
             end
 
             token
@@ -42,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
@@ -50,13 +55,17 @@ module Upfluence
               opts = args.first || {}
 
               result = if resource.is_a? Enumerable
-                         USerializer::ArraySerializer.new(resource, *args).to_json
+                         USerializer::ArraySerializer.new(
+                           resource, *args
+                         ).to_json
                        elsif opts[:serializer]
                          opts[:serializer].new(resource, *args).to_json
                        elsif resource.respond_to?(:serialize)
                          resource.serialize(*args).to_json
                        else
-                         USerializer.serializer_for(resource).new(resource, *args).to_json
+                         USerializer.serializer_for(resource).new(
+                           resource, *args
+                         ).to_json
                        end
             end
 
@@ -64,7 +73,9 @@ module Upfluence
           end
 
           def json_params
-            ActiveSupport::HashWithIndifferentAccess.new(JSON.parse(request_body))
+            ActiveSupport::HashWithIndifferentAccess.new(
+              JSON.parse(request_body)
+            )
           end
         end
 

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

@@ -5,6 +5,8 @@ module Upfluence
   module HTTP
     module Middleware
       class Prometheus
+        LABELS = %i[path method env].freeze
+
         def initialize(app, registry = ::Prometheus::Client.registry)
           @registry = registry
 
@@ -12,14 +14,16 @@ module Upfluence
             :uhttp_handler_requests_total
           ) || @registry.counter(
             :uhttp_handler_requests_total,
-            'Histogram of processed items',
+            docstring: 'Histogram of processed items',
+            labels:    LABELS + %i[status]
           )
 
           @request_histogram = @registry.get(
             :uhttp_handler_requests_duration_second
           ) || @registry.histogram(
             :uhttp_handler_requests_duration_second,
-            'Histogram of processing time',
+            docstring: 'Histogram of processing time',
+            labels:    LABELS
           )
 
           @app = app
@@ -41,19 +45,21 @@ module Upfluence
 
         def record(env, code, duration)
           @request_total_count.increment(
-            path: parse_route(env),
-            method: env['REQUEST_METHOD'].downcase,
-            status: code,
-            env: Upfluence.env.to_s
+            labels: {
+              path:   parse_route(env),
+              method: env['REQUEST_METHOD'].downcase,
+              status: code,
+              env:    Upfluence.env.to_s
+            }
           )
 
           @request_histogram.observe(
-            {
-              path: parse_route(env),
+            duration,
+            labels: {
+              path:   parse_route(env),
               method: env['REQUEST_METHOD'].downcase,
-              env: Upfluence.env.to_s
-            },
-            duration
+              env:    Upfluence.env.to_s
+            }
           )
         end
 
@@ -75,8 +81,8 @@ module Upfluence
 
           path = Rack::Request.new(env).path
 
-          splitted_template = route.split(' ').last.split('/').select do |v|
-            v != ''
+          splitted_template = route.split(' ').last.split('/').reject do |v|
+            v.eql?('')
           end.reverse
 
           path.split('/').reverse.map.with_index do |part, i|

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,14 @@ 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])
 
         @builder = Builder.new do
           use Middleware::Logger
@@ -54,13 +54,16 @@ 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] && opts[:base_handler_klass]
+            map '/base' do
+              run_thrift(
+                opts[:base_processor_klass],
+                opts[:base_handler_klass].new(@options[:interfaces])
+              )
+            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.7.2'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

data/rbutils.gemspec

@@ -17,10 +17,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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'
@@ -29,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'puma'
   spec.add_runtime_dependency 'rack'
   spec.add_runtime_dependency 'stackprof'
-  spec.add_runtime_dependency 'prometheus-client', '~> 0.9.0'
+  spec.add_runtime_dependency 'prometheus-client', '~> 2.1'
   spec.add_runtime_dependency 'userializer'
+  spec.add_runtime_dependency 'activerecord'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upfluence-utils
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Upfluence
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -198,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: userializer
   requirement: !ruby/object:Gem::Requirement
@@ -220,13 +206,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+description:
 email:
 - dev@upfluence.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -236,13 +237,11 @@ files:
 - Rakefile
 - 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
@@ -258,6 +257,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
@@ -274,7 +275,7 @@ homepage: https://github.com/upfluence/rbutils
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -290,7 +291,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