icalia-sdk-core 0.3.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2c6ba327f08a61953f9ce3f7d95c09ba037e2167daa384f385cb711f7b6ddc9
+  data.tar.gz: 8396528464a67afbbbf6c485626dace26d9be95a4789d1d75a614708c9900307
+SHA512:
+  metadata.gz: 234af0f52008503f81f1032c9d54447d839e2c8e40e7304e780443f03dcf26584959a3164649a1b9896db72a52c4ce2f3d5639ef8e557ccbf69a0f5c909cea91
+  data.tar.gz: 5fe21de198dc7de1fc6f96cada4ed5c3482d6484c999d20d8a6db1f6a638f5e23960b642988d8970ed9144feaa2492a91ca27dfbf33bb2dc2fe8e8db3da35219

data/lib/icalia-sdk-core.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'icalia-sdk-core/version'
+
+require 'icalia/models'
+require 'icalia/serialization'

data/lib/icalia-sdk-core/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Icalia
+  module SDK
+    CORE_VERSION = '0.3.6'
+  end
+end

data/lib/icalia/models.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Icalia
+  autoload :ModelBase, 'icalia/models/model_base'
+  autoload :ModelProxy, 'icalia/models/model_proxy'
+  autoload :ModelCollectionProxy, 'icalia/models/model_collection_proxy'
+
+  autoload :ResourceAction, 'icalia/models/resource_action'
+  autoload :ResourceIdentity, 'icalia/models/resource_identity'
+  autoload :ResourceTimestamps, 'icalia/models/resource_timestamps'
+
+  # Core Models:
+  autoload :Person, 'icalia/models/person'
+  autoload :Organization, 'icalia/models/organization'
+
+  autoload :EmailAccount, 'icalia/models/email_account'
+  autoload :CloudIdentity, 'icalia/models/cloud_identity'
+
+  autoload :Membership, 'icalia/models/membership'
+
+  autoload :CodeCommit, 'icalia/models/code_commit'
+  autoload :CodeRepository, 'icalia/models/code_repository'
+  autoload :CodeRepositoryReference, 'icalia/models/code_repository_reference'
+
+  autoload :CodeMergeRequest, 'icalia/models/code_merge_request'
+  autoload :OAuthAccessToken, 'icalia/models/oauth_access_token'
+
+  # Event Models:
+  autoload :MembershipEvent, 'icalia/models/events/membership_event'
+  autoload :OrganizationEvent, 'icalia/models/events/organization_event'
+  autoload :AuthorizationEvent, 'icalia/models/events/authorization_event'
+  autoload :CodeRepositoryEvent, 'icalia/models/events/code_repository_event'
+  autoload :CodeMergeRequestEvent, 'icalia/models/events/code_merge_request_event'
+end

data/lib/icalia/models/cloud_identity.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Icalia
+  class CloudIdentity < ModelBase
+    attr_reader :provider,
+                :id_at_provider,
+                :created_at,
+                :updated_at,
+                :name,
+                :identity_type
+
+    has_one :owner
+  end
+end

data/lib/icalia/models/code_commit.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Icalia
+  class CodeCommit < ModelBase
+    attr_reader :sha
+
+    has_one :repository
+  end
+end

data/lib/icalia/models/code_merge_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Icalia
+  class CodeMergeRequest < ModelBase
+    attr_reader :number,
+                :provider,
+                :id_at_provider,
+                :created_at,
+                :updated_at,
+                :number,
+                :body,
+                :state,
+                :title,
+                :url,
+                :additions,
+                :deletions,
+                :added_line_count,
+                :deleted_line_count,
+                :changed_file_count
+
+    has_one :base, :head, :author, :committer
+
+    def closed?; state == 'closed'; end
+  end
+end

data/lib/icalia/models/code_repository.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Icalia
+  class CodeRepository < ModelBase
+    include ResourceIdentity
+    
+    has_one :owner # DeserializablePropertyResource   # has one owner
+
+    attr_reader :created_at, :updated_at
+
+    attr_reader :name, :private, :fork, :provider, :description, :url, :fork,
+                :exists, :archived, :html_url, :full_name, :id_at_provider,
+                :default_branch
+  end
+end

data/lib/icalia/models/code_repository_reference.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Icalia
+  class CodeRepositoryReference < ModelBase
+    include ResourceIdentity
+    attr_reader :name, :label
+
+    has_one :commit
+
+    delegate :sha, :repository, to: :commit, allow_nil: true
+  end
+end

data/lib/icalia/models/email_account.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Icalia
+  class EmailAccount < ModelBase
+    attr_reader :address,
+                :created_at
+    
+    has_one :owner
+  end
+end

data/lib/icalia/models/events/authorization_event.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Icalia
+  class AuthorizationEvent < ModelBase
+    attr_reader :action, :timestamp
+
+    has_one :token
+  end
+end

data/lib/icalia/models/events/code_merge_request_event.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Icalia
+  class CodeMergeRequestEvent < ModelBase
+    include ResourceAction
+    attr_reader :merge_request
+
+    def opened?; action == 'opened'; end
+    def updated?; action == 'updated'; end
+    def merged?; action == 'merged'; end
+    def declined?; action == 'declined'; end
+  end
+end

data/lib/icalia/models/events/code_repository_event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Icalia
+  class CodeRepositoryEvent < ModelBase
+    include ResourceAction
+    attr_reader :repository
+
+    %i[created deleted archived unarchived edited renamed transferred publicized
+    privatized].each do |action_name|
+      define_method "#{action_name}?".to_sym do
+        action == action_name
+      end
+    end
+  end
+end

data/lib/icalia/models/events/membership_event.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Icalia
+  class MembershipEvent < ModelBase
+    include ResourceAction
+    has_one :membership
+
+    def added?; action == 'added'; end
+    def removed?; action == 'removed'; end
+  end
+end

data/lib/icalia/models/events/organization_event.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Icalia
+  class OrganizationEvent < ModelBase
+    include ResourceAction
+    
+    has_one :organization
+
+    def created?; action == 'created'; end
+    def deleted?; action == 'deleted'; end
+    def renamed?; action == 'renamed'; end
+    def updated?; action == 'updated'; end
+  end
+end

data/lib/icalia/models/membership.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Icalia
+  class Membership < ModelBase
+    attr_reader :created_at
+                
+    has_one :member, :group
+  end
+end

data/lib/icalia/models/model_base.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module Icalia
+  class ModelBase
+    extend ActiveModel::Naming
+    include ResourceIdentity
+
+    attr_reader :serialization_context
+
+    cattr_reader(:associated_resources) { [] }
+    cattr_reader(:associated_resource_collections) { [] }
+
+    def initialize(object_attributes = {})
+      @serialization_context = object_attributes.delete :serialization_context
+      
+      object_attributes.each do |key, value|
+        attribute_name = "#{key}".underscore
+        next register_stand_in(attribute_name, value) if value.is_a? ModelProxy
+        next register_collection(attribute_name, value) if value.is_a? Array
+        instance_variable_set("@#{attribute_name}", value)
+      end
+    end
+
+    class << self
+      def has_one(*associations)
+        associations.each do |association|
+          attr_reader association
+          associated_resources << association
+        end
+      end
+
+      def has_many(*associations)
+        associations.each do |association|
+          attr_reader association
+          associated_resource_collections << association
+        end
+      end
+    end
+
+    private
+
+    def register_collection(association, collection)
+      instance_variable_set("@#{association}", collection)
+      collection.each_with_index do |item, index|
+        next unless item.is_a? ModelProxy
+        serialization_context.register_stand_in model: self,
+                                                index: index,
+                                                stand_in: item,
+                                                association: association
+      end
+    end
+
+    def register_stand_in(association, stand_in)
+      instance_variable_set("@#{association}", stand_in)
+      serialization_context.register_stand_in model: self,
+                                              stand_in: stand_in,
+                                              association: association
+    end
+  end
+end

data/lib/icalia/models/model_collection_proxy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Icalia
+  # ModelCollectionProxy: Acts as a stand-in for an associated model collection,
+  # which may be awaiting for de-serialization at the time the parent object was
+  # being de-serialized
+  class ModelCollectionProxy
+    
+    def initialize(links: {})
+      @links = links
+    end
+  end
+end

data/lib/icalia/models/model_proxy.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Icalia
+  # ModelProxy: Acts as a stand-in for an associated model, which may be
+  # awaiting for de-serialization at the time the parent object was being 
+  # de-serialized
+  class ModelProxy
+    include ResourceIdentity
+
+    def initialize(id:, type:)
+      @id = id
+      @type = type
+    end
+  end
+end

data/lib/icalia/models/oauth_access_token.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Icalia
+  class OAuthAccessToken < ModelBase
+    attr_reader :scopes, :created_at, :expires_at
+
+    has_one :application, :resource_owner
+  end
+end

data/lib/icalia/models/organization.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Icalia
+  class Organization < ModelBase
+    include ResourceTimestamps
+    attr_reader :name
+
+    has_many :email_accounts, :cloud_identities
+  end
+end

data/lib/icalia/models/person.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Icalia
+  class Person < ModelBase
+    include ResourceTimestamps
+    attr_reader :full_name, :given_name, :family_name,
+                :gender_type, :custom_gender,
+                :date_of_birth
+
+    alias name full_name
+
+    has_many :email_accounts, :cloud_identities
+  end
+end

data/lib/icalia/models/resource_action.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Icalia
+  module ResourceAction
+    extend ActiveSupport::Concern
+    
+    included do
+      attr_reader :action, :timestamp
+      has_one :actor
+    end
+  end
+end

data/lib/icalia/models/resource_identity.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Icalia
+  module ResourceIdentity
+    extend ActiveSupport::Concern
+    
+    included do
+      attr_reader :id, :type
+    end
+
+    def to_key
+      { id: id, type: type }
+    end
+  end
+end

data/lib/icalia/models/resource_timestamps.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Icalia
+  module ResourceTimestamps
+    extend ActiveSupport::Concern
+    
+    included do
+      attr_reader :created_at, :updated_at
+    end
+  end
+end

data/lib/icalia/serialization.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'jsonapi/deserializable'
+
+module Icalia
+  autoload :Deserializer, 'icalia/serialization/deserializer'
+
+  # Deserialization Modules:
+  autoload :DeserializableResourceAction,
+           'icalia/serialization/deserializable_resource_action'
+
+  autoload :DeserializableResourceCreationTimestamp,
+           'icalia/serialization/deserializable_resource_creation_timestamp'
+
+  autoload :DeserializableResourceTimestamps,
+           'icalia/serialization/deserializable_resource_timestamps'
+
+  autoload :DeserializablePropertyResource,
+           'icalia/serialization/deserializable_property_resource'
+
+  # Event deserialization
+  autoload :DeserializableMembershipEvent,
+           'icalia/serialization/deserializable_membership_event'
+
+  autoload :DeserializableOrganizationEvent,
+           'icalia/serialization/deserializable_organization_event'
+
+  autoload :DeserializableAuthorizationEvent,
+           'icalia/serialization/deserializable_authorization_event'
+
+  autoload :DeserializableCodeMergeRequestEvent,
+           'icalia/serialization/deserializable_code_merge_request_event'
+
+  # Deserializable Objects
+  autoload :DeserializableResource,
+           'icalia/serialization/deserializable_resource'
+
+  autoload :DeserializableEmailAccount,
+           'icalia/serialization/deserializable_email_account'
+
+  autoload :DeserializableUser,
+           'icalia/serialization/deserializable_user'
+  
+  autoload :DeserializableMembership,
+           'icalia/serialization/deserializable_membership'
+
+  autoload :DeserializablePerson,
+           'icalia/serialization/deserializable_person'
+
+  autoload :DeserializableOAuthAccessToken,
+           'icalia/serialization/deserializable_oauth_access_token'
+
+  autoload :DeserializableOauthApplication,
+           'icalia/serialization/deserializable_oauth_application'
+
+  autoload :DeserializableOrganization,
+           'icalia/serialization/deserializable_organization'
+
+  autoload :DeserializableCodeRepositoryEvent,
+           'icalia/serialization/deserializable_code_repository_event'
+
+  autoload :DeserializableCodeMergeRequest,
+           'icalia/serialization/deserializable_code_merge_request'
+
+  autoload :DeserializableCodeCommit,
+           'icalia/serialization/deserializable_code_commit'
+
+  autoload :DeserializableCodeRepository,
+           'icalia/serialization/deserializable_code_repository'
+
+  autoload :DeserializableCodeRepositoryReference,
+           'icalia/serialization/deserializable_code_repository_reference'
+
+  autoload :DeserializableCloudIdentity,
+           'icalia/serialization/deserializable_cloud_identity'
+end