castle-rb 5.0.0 → 6.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: castle-rb
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Johan Brissmyr
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
+date: 2021-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -34,79 +34,127 @@ files:
 - lib/castle-rb.rb
 - lib/castle.rb
 - lib/castle/api.rb
-- lib/castle/api/connection.rb
-- lib/castle/api/request.rb
-- lib/castle/api/response.rb
-- lib/castle/api/session.rb
+- lib/castle/api/approve_device.rb
+- lib/castle/api/authenticate.rb
+- lib/castle/api/end_impersonation.rb
+- lib/castle/api/get_device.rb
+- lib/castle/api/get_devices_for_user.rb
+- lib/castle/api/identify.rb
+- lib/castle/api/report_device.rb
+- lib/castle/api/review.rb
+- lib/castle/api/start_impersonation.rb
+- lib/castle/api/track.rb
 - lib/castle/client.rb
+- lib/castle/client_id/extract.rb
 - lib/castle/command.rb
+- lib/castle/commands/approve_device.rb
 - lib/castle/commands/authenticate.rb
+- lib/castle/commands/end_impersonation.rb
+- lib/castle/commands/get_device.rb
+- lib/castle/commands/get_devices_for_user.rb
 - lib/castle/commands/identify.rb
-- lib/castle/commands/impersonate.rb
+- lib/castle/commands/report_device.rb
 - lib/castle/commands/review.rb
+- lib/castle/commands/start_impersonation.rb
 - lib/castle/commands/track.rb
 - lib/castle/configuration.rb
-- lib/castle/context/default.rb
-- lib/castle/context/merger.rb
-- lib/castle/context/sanitizer.rb
+- lib/castle/context/get_default.rb
+- lib/castle/context/merge.rb
+- lib/castle/context/prepare.rb
+- lib/castle/context/sanitize.rb
+- lib/castle/core/get_connection.rb
+- lib/castle/core/process_response.rb
+- lib/castle/core/process_webhook.rb
+- lib/castle/core/send_request.rb
 - lib/castle/errors.rb
 - lib/castle/events.rb
-- lib/castle/extractors/client_id.rb
-- lib/castle/extractors/headers.rb
-- lib/castle/extractors/ip.rb
-- lib/castle/failover_auth_response.rb
-- lib/castle/headers_filter.rb
-- lib/castle/headers_formatter.rb
-- lib/castle/review.rb
+- lib/castle/failover/prepare_response.rb
+- lib/castle/failover/strategy.rb
+- lib/castle/headers/extract.rb
+- lib/castle/headers/filter.rb
+- lib/castle/headers/format.rb
+- lib/castle/ip/extract.rb
+- lib/castle/logger.rb
+- lib/castle/payload/prepare.rb
 - lib/castle/secure_mode.rb
+- lib/castle/session.rb
+- lib/castle/singleton_configuration.rb
 - lib/castle/support/hanami.rb
 - lib/castle/support/padrino.rb
 - lib/castle/support/rails.rb
 - lib/castle/support/sinatra.rb
-- lib/castle/utils.rb
-- lib/castle/utils/cloner.rb
-- lib/castle/utils/merger.rb
-- lib/castle/utils/timestamp.rb
+- lib/castle/utils/clean_invalid_chars.rb
+- lib/castle/utils/clone.rb
+- lib/castle/utils/deep_symbolize_keys.rb
+- lib/castle/utils/get_timestamp.rb
+- lib/castle/utils/merge.rb
+- lib/castle/utils/secure_compare.rb
 - lib/castle/validators/not_supported.rb
 - lib/castle/validators/present.rb
+- lib/castle/verdict.rb
 - lib/castle/version.rb
+- lib/castle/webhooks/verify.rb
 - spec/integration/rails/rails_spec.rb
 - spec/integration/rails/support/all.rb
 - spec/integration/rails/support/application.rb
 - spec/integration/rails/support/home_controller.rb
-- spec/lib/castle/api/connection_spec.rb
-- spec/lib/castle/api/request_spec.rb
-- spec/lib/castle/api/response_spec.rb
-- spec/lib/castle/api/session_spec.rb
+- spec/lib/castle/api/approve_device_spec.rb
+- spec/lib/castle/api/authenticate_spec.rb
+- spec/lib/castle/api/end_impersonation_spec.rb
+- spec/lib/castle/api/get_device_spec.rb
+- spec/lib/castle/api/get_devices_for_user_spec.rb
+- spec/lib/castle/api/identify_spec.rb
+- spec/lib/castle/api/report_device_spec.rb
+- spec/lib/castle/api/review_spec.rb
+- spec/lib/castle/api/start_impersonation_spec.rb
+- spec/lib/castle/api/track_spec.rb
 - spec/lib/castle/api_spec.rb
+- spec/lib/castle/client_id/extract_spec.rb
 - spec/lib/castle/client_spec.rb
 - spec/lib/castle/command_spec.rb
+- spec/lib/castle/commands/approve_device_spec.rb
 - spec/lib/castle/commands/authenticate_spec.rb
+- spec/lib/castle/commands/end_impersonation_spec.rb
+- spec/lib/castle/commands/get_device_spec.rb
+- spec/lib/castle/commands/get_devices_for_user_spec.rb
 - spec/lib/castle/commands/identify_spec.rb
-- spec/lib/castle/commands/impersonate_spec.rb
+- spec/lib/castle/commands/report_device_spec.rb
 - spec/lib/castle/commands/review_spec.rb
+- spec/lib/castle/commands/start_impersonation_spec.rb
 - spec/lib/castle/commands/track_spec.rb
 - spec/lib/castle/configuration_spec.rb
-- spec/lib/castle/context/default_spec.rb
-- spec/lib/castle/context/merger_spec.rb
-- spec/lib/castle/context/sanitizer_spec.rb
+- spec/lib/castle/context/get_default_spec.rb
+- spec/lib/castle/context/merge_spec.rb
+- spec/lib/castle/context/prepare_spec.rb
+- spec/lib/castle/context/sanitize_spec.rb
+- spec/lib/castle/core/get_connection_spec.rb
+- spec/lib/castle/core/process_response_spec.rb
+- spec/lib/castle/core/process_webhook_spec.rb
+- spec/lib/castle/core/send_request_spec.rb
 - spec/lib/castle/events_spec.rb
-- spec/lib/castle/extractors/client_id_spec.rb
-- spec/lib/castle/extractors/headers_spec.rb
-- spec/lib/castle/extractors/ip_spec.rb
-- spec/lib/castle/headers_filter_spec.rb
-- spec/lib/castle/headers_formatter_spec.rb
-- spec/lib/castle/review_spec.rb
+- spec/lib/castle/failover/strategy_spec.rb
+- spec/lib/castle/headers/extract_spec.rb
+- spec/lib/castle/headers/filter_spec.rb
+- spec/lib/castle/headers/format_spec.rb
+- spec/lib/castle/ip/extract_spec.rb
+- spec/lib/castle/logger_spec.rb
+- spec/lib/castle/payload/prepare_spec.rb
 - spec/lib/castle/secure_mode_spec.rb
-- spec/lib/castle/utils/cloner_spec.rb
-- spec/lib/castle/utils/merger_spec.rb
-- spec/lib/castle/utils/timestamp_spec.rb
-- spec/lib/castle/utils_spec.rb
+- spec/lib/castle/session_spec.rb
+- spec/lib/castle/singleton_configuration_spec.rb
+- spec/lib/castle/utils/clean_invalid_chars_spec.rb
+- spec/lib/castle/utils/clone_spec.rb
+- spec/lib/castle/utils/deep_symbolize_keys_spec.rb
+- spec/lib/castle/utils/get_timestamp_spec.rb
+- spec/lib/castle/utils/merge_spec.rb
 - spec/lib/castle/validators/not_supported_spec.rb
 - spec/lib/castle/validators/present_spec.rb
+- spec/lib/castle/verdict_spec.rb
 - spec/lib/castle/version_spec.rb
+- spec/lib/castle/webhooks/verify_spec.rb
 - spec/lib/castle_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/configuration.rb
 homepage: https://castle.io
 licenses:
 - MIT
@@ -136,35 +184,59 @@ test_files:
 - spec/integration/rails/support/all.rb
 - spec/integration/rails/support/home_controller.rb
 - spec/integration/rails/rails_spec.rb
+- spec/support/shared_examples/configuration.rb
 - spec/lib/castle_spec.rb
-- spec/lib/castle/review_spec.rb
-- spec/lib/castle/headers_filter_spec.rb
+- spec/lib/castle/session_spec.rb
+- spec/lib/castle/verdict_spec.rb
 - spec/lib/castle/client_spec.rb
-- spec/lib/castle/context/default_spec.rb
-- spec/lib/castle/context/merger_spec.rb
-- spec/lib/castle/context/sanitizer_spec.rb
+- spec/lib/castle/context/get_default_spec.rb
+- spec/lib/castle/context/prepare_spec.rb
+- spec/lib/castle/context/sanitize_spec.rb
+- spec/lib/castle/context/merge_spec.rb
+- spec/lib/castle/core/get_connection_spec.rb
+- spec/lib/castle/core/process_webhook_spec.rb
+- spec/lib/castle/core/send_request_spec.rb
+- spec/lib/castle/core/process_response_spec.rb
 - spec/lib/castle/api_spec.rb
+- spec/lib/castle/logger_spec.rb
+- spec/lib/castle/client_id/extract_spec.rb
 - spec/lib/castle/configuration_spec.rb
 - spec/lib/castle/version_spec.rb
-- spec/lib/castle/utils/cloner_spec.rb
-- spec/lib/castle/utils/timestamp_spec.rb
-- spec/lib/castle/utils/merger_spec.rb
+- spec/lib/castle/payload/prepare_spec.rb
+- spec/lib/castle/utils/clean_invalid_chars_spec.rb
+- spec/lib/castle/utils/deep_symbolize_keys_spec.rb
+- spec/lib/castle/utils/get_timestamp_spec.rb
+- spec/lib/castle/utils/clone_spec.rb
+- spec/lib/castle/utils/merge_spec.rb
 - spec/lib/castle/command_spec.rb
-- spec/lib/castle/headers_formatter_spec.rb
-- spec/lib/castle/api/session_spec.rb
-- spec/lib/castle/api/request_spec.rb
-- spec/lib/castle/api/connection_spec.rb
-- spec/lib/castle/api/response_spec.rb
+- spec/lib/castle/headers/format_spec.rb
+- spec/lib/castle/headers/extract_spec.rb
+- spec/lib/castle/headers/filter_spec.rb
+- spec/lib/castle/api/review_spec.rb
+- spec/lib/castle/api/report_device_spec.rb
+- spec/lib/castle/api/authenticate_spec.rb
+- spec/lib/castle/api/track_spec.rb
+- spec/lib/castle/api/get_device_spec.rb
+- spec/lib/castle/api/start_impersonation_spec.rb
+- spec/lib/castle/api/approve_device_spec.rb
+- spec/lib/castle/api/get_devices_for_user_spec.rb
+- spec/lib/castle/api/end_impersonation_spec.rb
+- spec/lib/castle/api/identify_spec.rb
 - spec/lib/castle/commands/review_spec.rb
+- spec/lib/castle/commands/report_device_spec.rb
 - spec/lib/castle/commands/authenticate_spec.rb
 - spec/lib/castle/commands/track_spec.rb
-- spec/lib/castle/commands/impersonate_spec.rb
+- spec/lib/castle/commands/get_device_spec.rb
+- spec/lib/castle/commands/start_impersonation_spec.rb
+- spec/lib/castle/commands/approve_device_spec.rb
+- spec/lib/castle/commands/get_devices_for_user_spec.rb
+- spec/lib/castle/commands/end_impersonation_spec.rb
 - spec/lib/castle/commands/identify_spec.rb
 - spec/lib/castle/validators/not_supported_spec.rb
 - spec/lib/castle/validators/present_spec.rb
-- spec/lib/castle/extractors/ip_spec.rb
-- spec/lib/castle/extractors/headers_spec.rb
-- spec/lib/castle/extractors/client_id_spec.rb
-- spec/lib/castle/utils_spec.rb
+- spec/lib/castle/webhooks/verify_spec.rb
+- spec/lib/castle/ip/extract_spec.rb
+- spec/lib/castle/failover/strategy_spec.rb
 - spec/lib/castle/secure_mode_spec.rb
+- spec/lib/castle/singleton_configuration_spec.rb
 - spec/lib/castle/events_spec.rb

data/lib/castle/api/connection.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module API
-    # this module returns a new configured Net::HTTP object
-    module Connection
-      HTTPS_SCHEME = 'https'
-
-      class << self
-        def call
-          http = Net::HTTP.new(Castle.config.url.host, Castle.config.url.port)
-          http.read_timeout = Castle.config.request_timeout / 1000.0
-
-          if Castle.config.url.scheme == HTTPS_SCHEME
-            http.use_ssl = true
-            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          end
-
-          http
-        end
-      end
-    end
-  end
-end

data/lib/castle/api/request.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module API
-    # this class is responsible for making requests to api
-    module Request
-      # Default headers that we add to passed ones
-      DEFAULT_HEADERS = {
-        'Content-Type' => 'application/json'
-      }.freeze
-
-      private_constant :DEFAULT_HEADERS
-
-      class << self
-        def call(command, api_secret, headers, http = nil)
-          (http || Castle::API::Connection.call).request(
-            build(
-              command,
-              headers.merge(DEFAULT_HEADERS),
-              api_secret
-            )
-          )
-        end
-
-        def build(command, headers, api_secret)
-          request_obj = Net::HTTP.const_get(
-            command.method.to_s.capitalize
-          ).new("#{Castle.config.url.path}/#{command.path}", headers)
-
-          unless command.method == :get
-            request_obj.body = ::Castle::Utils.replace_invalid_characters(
-              command.data
-            ).to_json
-          end
-
-          request_obj.basic_auth('', api_secret)
-          request_obj
-        end
-      end
-    end
-  end
-end

data/lib/castle/api/session.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module API
-    # this module uses the Connection object
-    # and provides start method for persistent connection usage
-    # when there is a need of sending multiple requests at once
-    module Session
-      HTTPS_SCHEME = 'https'
-
-      class << self
-        def call(&block)
-          return unless block_given?
-
-          Connection.call.start(&block)
-        end
-      end
-    end
-  end
-end

data/lib/castle/commands/impersonate.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module Commands
-    # builder for impersonate command
-    class Impersonate
-      def initialize(context)
-        @context = context
-      end
-
-      def build(options = {})
-        Castle::Validators::Present.call(options, %i[user_id])
-        context = Castle::Context::Merger.call(@context, options[:context])
-        context = Castle::Context::Sanitizer.call(context)
-
-        Castle::Validators::Present.call(context, %i[user_agent ip])
-
-        Castle::Command.new(
-          'impersonate',
-          options.merge(context: context, sent_at: Castle::Utils::Timestamp.call),
-          options[:reset] ? :delete : :post
-        )
-      end
-    end
-  end
-end

data/lib/castle/failover_auth_response.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  # generate failover authentication response
-  class FailoverAuthResponse
-    def initialize(user_id, strategy: Castle.config.failover_strategy, reason:)
-      @strategy = strategy
-      @reason = reason
-      @user_id = user_id
-    end
-
-    def generate
-      {
-        action: @strategy.to_s,
-        user_id: @user_id,
-        failover: true,
-        failover_reason: @reason
-      }
-    end
-  end
-end

data/lib/castle/headers_filter.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  # used for preparing valuable headers list
-  class HeadersFilter
-    # headers filter
-    # HTTP_ - this is how Rack prefixes incoming HTTP headers
-    # CONTENT_LENGTH - for responses without Content-Length or Transfer-Encoding header
-    # REMOTE_ADDR - ip address header returned by web server
-    VALUABLE_HEADERS = /^
-      HTTP(?:_|-).*|
-      CONTENT(?:_|-)LENGTH|
-      REMOTE(?:_|-)ADDR
-    $/xi.freeze
-
-    private_constant :VALUABLE_HEADERS
-
-    # @param request [Rack::Request]
-    def initialize(request)
-      @request_env = request.env
-      @formatter = HeadersFormatter
-    end
-
-    # Serialize HTTP headers
-    # @return [Hash]
-    def call
-      @request_env.keys.each_with_object({}) do |header_name, acc|
-        next unless header_name.match(VALUABLE_HEADERS)
-
-        formatted_name = @formatter.call(header_name)
-        acc[formatted_name] = @request_env[header_name]
-      end
-    end
-  end
-end

data/lib/castle/headers_formatter.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  # formats header name
-  class HeadersFormatter
-    class << self
-      # @param header [String]
-      # @return [String]
-      def call(header)
-        format(header.to_s.gsub(/^HTTP(?:_|-)/i, ''))
-      end
-
-      private
-
-      # @param header [String]
-      # @return [String]
-      def format(header)
-        header.split(/_|-/).map(&:capitalize).join('-')
-      end
-    end
-  end
-end