api_models 0.1.0

data/lib/models/user_app_permission.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#
+# Holds the relationship between an app and a user, if the are in here, they have permission
+#
+class UserAppPermission
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  # Fast access to determine if this is added by belonging to a group.
+  field :group_app, default: false, type: Boolean
+
+  belongs_to :group, inverse_of: :user_app_permissions, optional: true
+  belongs_to :app, inverse_of: :user_app_permissions
+  belongs_to :user, inverse_of: :app_permissions
+end

data/lib/models/user_device.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+#
+# Device associated with a user's install of the app store. Held within the user object itself as
+# an embedded document
+#
+class UserDevice
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Searchable
+  #
+  # Constants
+  #
+  ENROLLING = 'enrolling' unless defined? ENROLLING
+  REGISTERING = 'registering' unless defined? REGISTERING
+  AUTHORIZING = 'authorizing' unless defined? AUTHORIZING
+  UNREGISTERED = 'unregistered' unless defined? UNREGISTERED
+  PENDING = 'pending' unless defined? PENDING
+  REJECTED = 'rejected' unless defined? REJECTED
+  APPROVED = 'approved' unless defined? APPROVED
+  REMOVED = 'removed' unless defined? REMOVED
+  DEREGISTERED = 'deregistered' unless defined? DEREGISTERED
+  KEEP_STATES = [UNREGISTERED, PENDING, REJECTED, APPROVED].freeze unless defined? KEEP_STATES
+  #
+  # Fields
+  #
+  field :unique_identifier, type: String
+  field :app47_identifier, type: String
+  field :description, type: String
+  field :state, type: String, default: UserDevice::ENROLLING
+  field :platform
+  field :model
+  field :manufacture
+  field :cpu_type
+  field :token
+  field :appstore_last_sign_in, type: Time
+  field :appstore_sign_in_count, type: Integer, default: 0
+  field :user_agent, type: String, default: 'Unknown'
+  field :os_version, type: Float
+  field :container_version, type: String, default: '1.0'
+  field :price, type: Float, default: 0.0
+  field :agent_id, type: String
+  #
+  # Relationships
+  #
+  belongs_to :user, inverse_of: :devices
+  #
+  # Validations
+  #
+  validates_presence_of :unique_identifier, message: 'Requires unique identifier of device.'
+
+  #
+  # Define which fields to include in search text
+  #
+  def search_fields
+    %w[state platform model manufacture os_version description]
+  end
+
+  #
+  # Is the device approved?
+  #
+  def approved?
+    UserDevice::APPROVED.eql? state
+  end
+
+  #
+  # Find a user device by safely trying a number of approaches
+  # 1. By ID
+  # 2. By unique identifier
+  # 3. By app47 identifier
+  # 4. By token
+  #
+  def self.find_device_by(device_id)
+    raise 'Invalid ID' if device_id.blank?
+
+    UserDevice.where(_id: device_id).first ||
+      UserDevice.where(unique_identifier: device_id).first ||
+      UserDevice.where(app47_identifier: device_id).first ||
+      UserDevice.where(token: device_id).first
+  rescue StandardError
+    nil
+  end
+end

data/lib/models/version_management_policy.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+#
+# Holds a version management policy for an app
+#
+class VersionManagementPolicy < AppPolicy
+  #
+  # Constants
+  #
+  NONE = 'none' unless defined? NONE
+  MINIMUM = 'min' unless defined? MINIMUM
+  STRICT = 'strict' unless defined? STRICT
+  CUSTOM = 'custom'
+  OPTIONS = [NONE, MINIMUM, CUSTOM, STRICT].freeze unless defined? OPTIONS
+  #
+  # Fields
+  #
+  field :allowed_ignores, type: Integer, default: 3
+  field :android_test, type: String, default: NONE
+  field :android_production, type: String, default: NONE
+  field :ios_test, type: String, default: NONE
+  field :ios_production, type: String, default: NONE
+  # For custom version setting
+  field :android_test_version, type: String
+  field :android_production_version, type: String
+  field :ios_test_version, type: String
+  field :ios_production_version, type: String
+  #
+  # return the version management policy
+  #
+  def enforce_policy(agent)
+    policy = super.merge(enforce_active_version: false)
+    if policy_enabled?(agent)
+      build = app_active_build(agent)
+      unless valid_version?(agent, build)
+        policy[:enforce_active_version] = true
+        policy[:version_management] = { active_version: { platform: build.platform,
+                                                          environment: build.environment,
+                                                          file_url: build.cdn_file_url,
+                                                          version: build.version },
+                                        message: message,
+                                        allowed_ignores: allowed_ignores }
+      end
+    end
+    policy
+  rescue StandardError => error
+    App47Logger.log_warn('VersionManagementPolicy#enforce_policy', error)
+    # Return the default set of policies
+    { enforce_active_version: false }
+  end
+
+  private
+
+  #
+  # return the policy for the platform and environment
+  #
+  def policy(agent)
+    send "#{agent.device.platform.downcase}_#{agent.app_environment.downcase}"
+  rescue StandardError
+    NONE
+  end
+
+  #
+  # Is the policy enabled for this platform and environment?
+  #
+  def policy_enabled?(agent)
+    my_policy = policy(agent)
+    [MINIMUM, CUSTOM, STRICT].include?(my_policy)
+  end
+
+  #
+  # Find the app's active build
+  #
+  def app_active_build(agent)
+    app.app_active_builds.where(platform: agent.device.platform, environment: agent.app_environment.downcase).first
+  rescue StandardError
+    # return nil if there is an error
+    nil
+  end
+
+  #
+  # test if the agent's version complies with the build and policy
+  # starting agent version ios 4.4 and android 3.2, we should use the version code, otherwise we should
+  # use the version
+  #
+  def valid_version?(agent, active_build)
+    if agent.use_version_code?
+      app_version = agent.app_version_code || agent.app_version
+      build_version = active_build.version_code
+    else
+      app_version = agent.app_version
+      build_version = active_build.version
+    end
+    case policy(agent)
+    when STRICT
+      app_version.eql?(build_version)
+    when MINIMUM
+      app_version.to_f >= build_version.to_f
+    when CUSTOM
+      custom_version = send([agent.device.platform, agent.app_environment, 'version'].join('_').downcase)
+      if agent.use_version_code?
+        agent.app_version_code.to_f >= custom_version.to_f
+      else
+        agent.app_version.to_f >= custom_version.to_f
+      end
+    else
+      true
+    end
+  rescue StandardError => error
+    App47Logger.log_error "Unable to determine valid version: #{self.inspect}", error
+    false
+  end
+end

data/lib/models/web_app.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#
+# Hold the definition of a WebApp
+#
+class WebApp < App
+  include App47AppAnalyzable
+  # Fields
+  field :uri, type: String
+  field :capture_usage, type: Boolean, default: true
+  field :version, type: String, default: '1.0'
+end

metadata

@@ -0,0 +1,408 @@
+--- !ruby/object:Gem::Specification
+name: api_models
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Schroeder
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_mongoid
+  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'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  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'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codacy-coverage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Core components used in the API Microservice.
+email:
+- chris@app47.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/api_models.rb
+- lib/api_models/version.rb
+- lib/models/account.rb
+- lib/models/agent.rb
+- lib/models/app.rb
+- lib/models/app47_cache.rb
+- lib/models/app_active_build.rb
+- lib/models/app_policy.rb
+- lib/models/app_shield_policy.rb
+- lib/models/authorized_user_policy.rb
+- lib/models/b2b_app.rb
+- lib/models/cat/customer.rb
+- lib/models/cat/customer_device.rb
+- lib/models/cl/customer.rb
+- lib/models/cl/customer_device.rb
+- lib/models/commerce_app_store.rb
+- lib/models/concerns/app47_app_analyzable.rb
+- lib/models/concerns/app47_app_buildable.rb
+- lib/models/concerns/app47_app_configurable.rb
+- lib/models/concerns/app47_app_policies.rb
+- lib/models/concerns/app47_cdn_url.rb
+- lib/models/concerns/app47_email_sendable.rb
+- lib/models/concerns/app47_logger.rb
+- lib/models/concerns/checkin_able.rb
+- lib/models/concerns/searchable.rb
+- lib/models/configuration_constraint.rb
+- lib/models/configuration_group.rb
+- lib/models/configuration_rule.rb
+- lib/models/device.rb
+- lib/models/external_app.rb
+- lib/models/gehc/customer.rb
+- lib/models/gehc/customer_device.rb
+- lib/models/group.rb
+- lib/models/internal_app.rb
+- lib/models/metric_data_job.rb
+- lib/models/option.rb
+- lib/models/pin_code_policy.rb
+- lib/models/platform.rb
+- lib/models/platform_model.rb
+- lib/models/product_app.rb
+- lib/models/product_support_app.rb
+- lib/models/queue_manager.rb
+- lib/models/redis_configuration.rb
+- lib/models/sso_ad_group.rb
+- lib/models/sso_ad_server.rb
+- lib/models/sso_ad_user.rb
+- lib/models/sso_azure_server.rb
+- lib/models/sso_directory_group.rb
+- lib/models/sso_directory_server.rb
+- lib/models/sso_google_server.rb
+- lib/models/sso_ldap_group.rb
+- lib/models/sso_ldap_rest_server.rb
+- lib/models/sso_ldap_server.rb
+- lib/models/sso_ldap_user.rb
+- lib/models/sso_oauth_server.rb
+- lib/models/sso_saml_v2_server.rb
+- lib/models/sso_server.rb
+- lib/models/sso_user.rb
+- lib/models/system_configuration.rb
+- lib/models/time_bomb_policy.rb
+- lib/models/user.rb
+- lib/models/user_app_permission.rb
+- lib/models/user_device.rb
+- lib/models/version_management_policy.rb
+- lib/models/web_app.rb
+homepage: https://app47.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: App47 API Model Library.
+test_files: []