bima-shark-sdk 2.3.0

data/lib/shark/configuration.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Shark
+  module AssetService
+    module Resource
+      mattr_accessor :site
+    end
+  end
+
+  module ContactService
+    module Resource
+      mattr_accessor :site
+    end
+  end
+
+  module ConsentService
+    module Resource
+      mattr_accessor :site
+    end
+  end
+
+  module DoubleOptIn
+    class ExceededNumberOfVerificationRequestsError < Error; end
+    class RequestedUnverifiedExecutionError < Error; end
+    class VerificationExpiredError < Error; end
+
+    module Resource
+      mattr_accessor :site
+    end
+  end
+
+  module NotificationService
+    module Resource
+      mattr_accessor :site
+    end
+  end
+
+  module SubscriptionService
+    module Resource
+      mattr_accessor :site
+    end
+  end
+
+  module SurveyService
+    module Resource
+      mattr_accessor :site
+    end
+  end
+
+  class Configuration
+    class Service
+      attr_accessor :site
+      attr_reader :headers
+
+      def initialize
+        @headers = {}
+      end
+
+      def headers=(value)
+        @headers.merge!(value)
+      end
+    end
+
+    #
+    # Shark Configuration
+    #
+    attr_accessor :cache, :logger
+    attr_reader :contact_service
+    attr_reader :consent_service
+    attr_reader :double_opt_in
+    attr_reader :form_service
+    attr_reader :survey_service
+    attr_reader :notification_service
+    attr_reader :subscription_service
+    attr_reader :asset_service
+    attr_reader :mailing_service
+
+    def initialize
+      @asset_service = AssetService::Resource
+      @contact_service = ContactService::Resource
+      @consent_service = ConsentService::Resource
+      @double_opt_in = DoubleOptIn::Resource
+      @form_service = Service.new
+      @mailing_service = Service.new
+      @notification_service = NotificationService::Resource
+      @subscription_service = SubscriptionService::Resource
+      @survey_service = SurveyService::Resource
+    end
+  end
+end

data/lib/shark/consent.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Shark
+  class Consent < Base
+    extend ConsentService::Resource
+
+    def self.all
+      raise Shark::ActionNotSupportedError,
+            'Shark::ConsentService::Consent.all is not supported'
+    end
+
+    def update_attributes(_attributes = {})
+      raise Shark::ActionNotSupportedError,
+            'Shark::ConsentService::Consent#update_attributes is not supported'
+    end
+
+    def destroy
+      raise Shark::ActionNotSupportedError,
+            'Shark::ConsentService::Consent#destroy is not supported'
+    end
+
+    def save
+      if self['id'].present?
+        raise Shark::ActionNotSupportedError,
+              'Shark::ConsentService::Consent#save is not supported for persisted consents'
+      else
+        super
+      end
+    end
+  end
+end

data/lib/shark/contact.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Shark
+  class Contact < Base
+    extend ContactService::Resource
+    include Shark::NormalizedEmail
+
+    custom_endpoint :avatar, on: :collection, request_method: :get
+
+    property :account_id
+
+    has_many :memberships
+    has_many :groups
+    has_one :permission
+
+    def self.find_by_email(email)
+      normalized_email = normalize_email(email)
+      options = { filter: { equals: { email: normalized_email } } }
+      where(options).first
+    end
+
+    # @example
+    #   contacts = Shark::ContactService::Contact.find_by_permissions([
+    #     { resource: 'paragraph::contract', privilege: 'admin' },
+    #     { resource: 'datenraum', privilege: 'admin'}
+    #   ])
+    #
+    # @param permissions_filter [Array] the filter of resources and privileges.
+    # @api public
+    def self.find_by_permissions(permissions_filter)
+      includes('permission').where(permissions: permissions_filter)
+    end
+
+    def account
+      return nil if account_id.blank?
+
+      Shark::Account.find(account_id).first
+    end
+  end
+end

data/lib/shark/contact_log.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Shark
+  class ContactLog < Base
+    extend ContactService::Resource
+  end
+end

data/lib/shark/double_opt_in/execution.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Shark
+  module DoubleOptIn
+    class Execution < Base
+      extend DoubleOptIn::Resource
+
+      attr_accessor :payload, :request_type
+
+      def self.verify(verification_token)
+        response = connection.run(:post, "/executions/#{verification_token}/verify")
+        new(response.body['data'])
+      rescue UnprocessableEntity => e
+        if caused_by_error_code?(e.errors, 'exceeded_number_of_verification_requests')
+          raise ExceededNumberOfVerificationRequestsError
+        end
+
+        raise VerificationExpiredError if caused_by_error_code?(e.errors, 'verification_expired')
+
+        raise e
+      end
+
+      def self.find(verification_token)
+        response = connection.run(:get, "/executions/#{verification_token}")
+        new(response.body['data'])
+      rescue UnprocessableEntity => e
+        if caused_by_error_code?(e.errors, 'requested_unverified_execution')
+          raise RequestedUnverifiedExecutionError
+        end
+
+        raise e
+      end
+
+      def self.terminate(verification_token)
+        response = connection.run(:delete, "/executions/#{verification_token}")
+        new(response.body['data'])
+      end
+
+      def initialize(data)
+        %w[payload request_type].each do |key|
+          public_send("#{key}=", data['attributes'][key])
+        end
+      end
+
+      def self.caused_by_error_code?(errors, error_code)
+        errors.detect { |error| error['code'] == error_code }
+      end
+    end
+  end
+end

data/lib/shark/double_opt_in/request.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Shark
+  module DoubleOptIn
+    class Request < Base
+      extend DoubleOptIn::Resource
+
+      ATTRIBUTES = %w[
+        payload
+        request_type
+        recipient
+        subject
+        header
+        sub_header
+        message
+        verification_url
+        verification_link_text
+        message_footer_html
+        timeout
+        leeway_to_terminate
+        max_verifications
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def self.create(attributes)
+        body = {
+          data: {
+            type: 'requests',
+            attributes: attributes
+          }
+        }
+
+        response = connection.request(:post, '/requests/', body: body)
+        new(response.body['data'])
+      end
+
+      def initialize(data)
+        ATTRIBUTES.each do |key|
+          public_send("#{key}=", data['attributes'][key])
+        end
+      end
+    end
+  end
+end

data/lib/shark/error.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Shark
+  class Error < StandardError; end
+
+  class ApiError < Error
+    attr_reader :code, :env
+
+    def initialize(code, env)
+      @code = code
+      @env = env
+    end
+
+    def body
+      env[:body]
+    end
+
+    def url
+      env[:url]
+    end
+
+    def message
+      body.to_s
+    end
+  end
+
+  class ConnectionError < ApiError
+    def initialize(env)
+      @env = env
+    end
+  end
+
+  class ClientError < ApiError; end
+
+  class AccessDenied < ClientError; end
+
+  class NotAuthorized < ClientError; end
+
+  class ResourceConflict < ClientError; end
+
+  class ResourceNotFound < ClientError
+    def message
+      "Couldn't find resource at: #{url}"
+    end
+  end
+
+  class UnprocessableEntity < ClientError
+    def errors
+      body['errors'] || {}
+    end
+
+    def message
+      errors.to_json
+    end
+  end
+
+  class ServerError < ApiError; end
+
+  class UnexpectedStatus < ServerError
+    def message
+      "Unexpected response status: #{code} from: #{url}"
+    end
+  end
+
+  #
+  # Other errors
+  #
+  class ActionNotSupportedError < Error; end
+end

data/lib/shark/form_service/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    class Base < ::Shark::Base
+      def self.site
+        File.join(::Shark.configuration.form_service.site, '/api')
+      end
+    end
+  end
+end

data/lib/shark/form_service/form/container.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module Form
+      class Container < Element
+      end
+    end
+  end
+end

data/lib/shark/form_service/form/element.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module Form
+      class Element
+        attr_reader :parent, :children
+
+        def initialize(element, parent = nil)
+          @element = element.except('elements') || {}
+          @parent = parent
+          @children = parse_children(element['elements'] || [])
+        end
+
+        def id
+          @element['id']
+        end
+
+        def label
+          %w[label legend].each do |attr|
+            next unless attribute_defined?(attr)
+
+            return attribute_definition(attr)['value']
+          end
+          ''
+        end
+
+        def type
+          @element['type']
+        end
+
+        def text
+          return '' unless attribute_defined?('text')
+
+          attribute_definition('text')['value']
+        end
+
+        def attribute_definitions
+          @element['attribute_definitions'] || []
+        end
+
+        def attribute_definition(name)
+          attribute_definitions.detect { |a| a['name'] == name }
+        end
+
+        def attribute_defined?(name)
+          attribute_definition(name).present?
+        end
+
+        def ancestors
+          return parent.ancestors << self if parent.present?
+
+          [self]
+        end
+
+        protected
+
+        attr_reader :element
+
+        def parse_children(elements)
+          elements.map do |e|
+            case e['type']
+            when 'form_container'
+              Container.new(e, self)
+            when 'form_multiple_choice'
+              MultipleChoice.new(e, self)
+            when 'form_rating_scale'
+              RatingScale.new(e, self)
+            when 'form_rating_star'
+              RatingStar.new(e, self)
+            when 'form_text_field'
+              TextField.new(e, self)
+            when 'form_textarea'
+              TextArea.new(e, self)
+            else
+              raise ArgumentError, "Unknown form element type: #{e['type']}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service/form/multiple_choice.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module Form
+      class MultipleChoice < Element
+        def values
+          element['valid_values']
+        end
+
+        def more_on_choice?
+          more_on_choice = attribute('more_on_choice')
+
+          return values.include?(more_on_choice['value']) if more_on_choice.present?
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service/form/rating_scale.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module Form
+      class RatingScale < Element
+        def values
+          scale_start = element['scale_start'].to_i
+          scale_end = element['scale_end'].to_i
+          allow_no_information = element['allow_no_information']
+
+          scale_values = (scale_start..scale_end).to_a
+          scale_values << -1 if allow_no_information == true
+
+          scale_values
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service/form/rating_star.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module Form
+      class RatingStar < Element
+        def values
+          element['valid_values']
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service/form/structure.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module Form
+      class Structure < Element
+        def initialize(structure)
+          super(structure)
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service/form/text_area.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module Form
+      class TextArea < Element
+      end
+    end
+  end
+end

data/lib/shark/form_service/form/text_field.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module Form
+      class TextField < Element
+        def pre_text
+          attribute_definition('pre_text')['value']
+        end
+
+        def post_text
+          attribute_definition('post_text')['value']
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service/v2/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module V2
+      class Base < FormService::Base
+        def self.site
+          File.join(::Shark.configuration.form_service.site, '/api/v2')
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service/v2/form.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module V2
+      class Form < V2::Base
+        # @example
+        #   form = Shark::FormService::V2::Form.find(id)
+        #   form.activate
+        #
+        # @api public
+        def activate
+          update(state: 'active')
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service/v2/form_input.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module V2
+      class FormInput < V2::Base
+        belongs_to :form
+
+        def self.table_name
+          'inputs'
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service/v2/form_version.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Shark
+  module FormService
+    module V2
+      class FormVersion < V2::Base
+        belongs_to :form
+
+        def self.table_name
+          'versions'
+        end
+
+        def form_structure
+          @form_structure ||= FormService::Form::Structure.new(structure)
+        end
+      end
+    end
+  end
+end

data/lib/shark/form_service.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'shark/form_service/base'
+require 'shark/form_service/form/element'
+require 'shark/form_service/form/container'
+require 'shark/form_service/form/multiple_choice'
+require 'shark/form_service/form/rating_scale'
+require 'shark/form_service/form/rating_star'
+require 'shark/form_service/form/text_area'
+require 'shark/form_service/form/text_field'
+require 'shark/form_service/form/structure'
+
+require 'shark/form_service/v2/base'
+require 'shark/form_service/v2/form'
+require 'shark/form_service/v2/form_input'
+require 'shark/form_service/v2/form_version'
+
+module Shark
+  module FormService
+  end
+end

data/lib/shark/group.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Shark
+  class Group < Base
+    extend ContactService::Resource
+
+    has_many :contacts
+
+    def contact?(contact_id)
+      contacts = relationships['contacts']
+      return false if contacts.blank? || contacts['data'].blank?
+
+      contacts['data'].any? { |c| c['type'] == 'contacts' && c['id'].to_s == contact_id.to_s }
+    end
+
+    alias has_contact? contact?
+  end
+end

data/lib/shark/mailing_service/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Shark
+  module MailingService
+    class Base < ::Shark::Base
+      def self.site
+        ::Shark.configuration.mailing_service.site
+      end
+    end
+  end
+end

data/lib/shark/mailing_service/configuration.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Shark
+  module MailingService
+    class Configuration
+      attr_accessor :context_helpers, :default_layout, :default_template_root
+    end
+  end
+end

data/lib/shark/mailing_service/mail.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Shark
+  module MailingService
+    class Mail < Base
+    end
+  end
+end