decidim-core 0.23.0 → 0.24.0.rc1

data/lib/decidim/api/{scopable_interface.rb → interfaces/scopable_interface.rb}

@@ -3,11 +3,11 @@
 module Decidim
   module Core
     # This interface represents a scopable object.
-    ScopableInterface = GraphQL::InterfaceType.define do
-      name "ScopableInterface"
+    module ScopableInterface
+      include Decidim::Api::Types::BaseInterface
       description "An interface that can be used in scopable objects."
 
-      field :scope, Decidim::Core::ScopeApiType, "The object's scope"
+      field :scope, Decidim::Core::ScopeApiType, "The object's scope", null: true
     end
   end
 end

data/lib/decidim/api/interfaces/timestamps_interface.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    # This interface represents an object with standard create_at and updated_at timestamps.
+    module TimestampsInterface
+      include Decidim::Api::Types::BaseInterface
+      description "An interface that can be used in objects with created_at and updated_at attributes"
+
+      field :created_at, Decidim::Core::DateTimeType, description: "The date and time this object was created", null: true
+
+      field :updated_at, Decidim::Core::DateTimeType, description: "The date and time this object was updated", null: true
+    end
+  end
+end

data/lib/decidim/api/interfaces/traceable_interface.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    # This interface represents an traceable object.
+    module TraceableInterface
+      include Decidim::Api::Types::BaseInterface
+      description "An interface that can be used in objects with traceability (versions)"
+
+      field :versions_count, Integer, "Total number of versions", null: false
+      field :versions, [Decidim::Core::TraceVersionType, { null: true }], "This object's versions", null: false
+    end
+  end
+end

data/lib/decidim/api/scalars/date_time_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class DateTimeType < Decidim::Api::Types::BaseScalar
+      description "An ISO8601 date with time"
+
+      def self.coerce_input(value, _ctx)
+        Time.iso8601(value)
+      end
+
+      def self.coerce_result(value, _ctx)
+        value.to_time.iso8601
+      end
+    end
+  end
+end

data/lib/decidim/api/scalars/date_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class DateType < Decidim::Api::Types::BaseScalar
+      description "An ISO8601 date"
+
+      def self.coerce_input(value, _ctx)
+        Date.iso8601(value)
+      end
+
+      def self.coerce_result(value, _ctx)
+        value.to_date.iso8601
+      end
+    end
+  end
+end

data/lib/decidim/api/types/amendment_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class AmendmentType < Decidim::Api::Types::BaseObject
+      description "An amendment"
+
+      field :id, GraphQL::Types::ID, "The id of this amendment", null: false
+      field :state, GraphQL::Types::String, "The status of this amendment", null: false
+      field :amender, Decidim::Core::AuthorInterface, "The author of this amendment", null: false
+
+      field :amendable_type, GraphQL::Types::String, method: :decidim_amendable_type, description: "Type of the amendable object", null: false
+      field :emendation_type, GraphQL::Types::String, method: :decidim_emendation_type, description: "Type of the emendation object", null: false
+
+      field :amendable, AmendableEntityInterface, "The original amended resource (currently, a proposal only)", null: false
+      field :emendation, AmendableEntityInterface, "The emendation (currently, a proposal only)", null: false
+    end
+  end
+end

data/lib/decidim/api/types/area_api_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class AreaApiType < Decidim::Api::Types::BaseObject
+      graphql_name "Area"
+      description "An area."
+
+      field :id, GraphQL::Types::ID, "Internal ID for this area", null: false
+      field :name, Decidim::Core::TranslatedFieldType, "The graphql_name of this area.", null: false
+      field :area_type, Decidim::Core::AreaTypeType, "The area type of this area", null: true
+      field :created_at, Decidim::Core::DateTimeType, "The time this assembly was created", null: false
+      field :updated_at, Decidim::Core::DateTimeType, "The time this assembly was updated", null: false
+    end
+  end
+end

data/lib/decidim/api/types/area_type_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class AreaTypeType < Decidim::Api::Types::BaseObject
+      description "An area type."
+
+      field :id, GraphQL::Types::ID, "Internal ID for this area type", null: false
+      field :name, Decidim::Core::TranslatedFieldType, "The name of this area type.", null: false
+      field :plural, Decidim::Core::TranslatedFieldType, "The plural name of this area type", null: false
+    end
+  end
+end

data/lib/decidim/api/types/attachment_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class AttachmentType < Decidim::Api::Types::BaseObject
+      description "A file attachment"
+
+      field :url, GraphQL::Types::String, "The url of this attachment", null: false
+      field :type, GraphQL::Types::String, "The type of this attachment", method: :file_type, null: false
+      field :thumbnail, GraphQL::Types::String, "A thumbnail of this attachment, if it's an image.", method: :thumbnail_url, null: true
+    end
+  end
+end

data/lib/decidim/api/types/category_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class CategoryType < Decidim::Api::Types::BaseObject
+      description "A category that can be applied to other resources."
+
+      field :id, GraphQL::Types::ID, null: false
+      field :name, Decidim::Core::TranslatedFieldType, "The name of this category.", null: false
+      field :subcategories, [Decidim::Core::CategoryType, { null: true }], "Subcategories of this category.", null: false
+      field :parent, Decidim::Core::CategoryType, "This category's parent category.", null: true
+    end
+  end
+end

data/{app/types/decidim/core → lib/decidim/api/types}/component_type.rb

@@ -2,10 +2,8 @@
 
 module Decidim
   module Core
-    ComponentType = GraphQL::ObjectType.define do
-      interfaces [-> { ComponentInterface }]
-
-      name "Component"
+    class ComponentType < Decidim::Api::Types::BaseObject
+      implements Decidim::Core::ComponentInterface
       description "A base component with no particular specificities."
     end
   end

data/lib/decidim/api/types/coordinates_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    # This type represents a Decidim's global property.
+    class CoordinatesType < Decidim::Api::Types::BaseObject
+      description "Physical coordinates for a location"
+
+      field :latitude, GraphQL::Types::Float, "Latitude of this coordinate", null: false
+      field :longitude, GraphQL::Types::Float, "Longitude of this coordinate", null: false
+
+      def latitude
+        object[0]
+      end
+
+      def longitude
+        object[1]
+      end
+    end
+  end
+end

data/lib/decidim/api/types/decidim_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    # This type represents a Decidim's global property.
+    class DecidimType < Decidim::Api::Types::BaseObject
+      description "Decidim's framework-related properties."
+
+      field :version, GraphQL::Types::String, "The current decidim's version of this deployment.", null: false
+      field :application_name, GraphQL::Types::String, "The current installation's name.", null: false
+    end
+  end
+end

data/lib/decidim/api/types/fingerprint_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class FingerprintType < Decidim::Api::Types::BaseObject
+      description "A fingerprint object"
+
+      field :value, GraphQL::Types::String, "The the hash value for the fingerprint", null: false
+      field :source, GraphQL::Types::String, description: "Returns the source String (usually a json) from which the fingerprint is generated.", null: false
+    end
+  end
+end

data/lib/decidim/api/types/hashtag_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    # This type represents a User.
+    class HashtagType < Decidim::Api::Types::BaseObject
+      graphql_name "HashtagType"
+      description "hashtags list"
+
+      field :name, GraphQL::Types::String, "The hashtag's name", null: false
+    end
+  end
+end

data/lib/decidim/api/types/localized_string_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    # This type represents a localized string in a single language.
+    class LocalizedStringType < Decidim::Api::Types::BaseObject
+      description "Represents a particular translation of a LocalizedStringType"
+
+      field :locale, GraphQL::Types::String, "The standard locale of this translation.", null: false
+      field :text, GraphQL::Types::String, "The content of this translation.", null: true
+    end
+  end
+end

data/lib/decidim/api/types/metric_history_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class MetricHistoryType < Decidim::Api::Types::BaseObject
+      field :key, GraphQL::Types::String, "The key value", null: false
+      field :value, GraphQL::Types::Int, "The value for each key", null: false
+
+      def key
+        MetricObjectPresenter.new(object).attr_date(0)
+      end
+
+      def value
+        MetricObjectPresenter.new(object).attr_int(1)
+      end
+    end
+  end
+end

data/lib/decidim/api/types/metric_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class MetricType < Decidim::Api::Types::BaseObject
+      description "Metric data"
+
+      field :name, GraphQL::Types::String, "The graphql_name of the metric", null: false
+      field :count, GraphQL::Types::Int, "The last value of the metric", null: false
+      field :history, [MetricHistoryType, { null: true }], "The historic values for this metric", null: false
+    end
+  end
+end

data/lib/decidim/api/types/organization_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class OrganizationType < Decidim::Api::Types::BaseObject
+      description "The current organization"
+
+      field :name, GraphQL::Types::String, "The name of the current organization", null: true
+
+      field :stats, [Core::StatisticType, { null: true }], description: "The statistics associated to this object", null: true
+
+      def stats
+        Decidim.stats.with_context(object)
+      end
+    end
+  end
+end

data/lib/decidim/api/types/participatory_space_link_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class ParticipatorySpaceLinkType < Decidim::Api::Types::BaseObject
+      description "A link representation between participatory spaces"
+
+      field :id, GraphQL::Types::ID, "The id of this participatory space link", null: false
+      field :from_type, GraphQL::Types::String, "The origin participatory space type for this participatory space link", null: false
+      field :to_type, GraphQL::Types::String, "The destination participatory space type for this participatory space link", null: false
+      field :name, GraphQL::Types::String, "The name (purpose) of this participatory space link", null: false
+      field :participatory_space, ParticipatorySpaceInterface, description: "The linked participatory space (polymorphic)", null: false
+
+      def participatory_space
+        manifest_name = object.name.partition("included_").last
+        object_class = "Decidim::#{manifest_name.classify}"
+        return object.to if object.to_type == object_class
+        return object.from if object.from_type == object_class
+      end
+    end
+  end
+end

data/lib/decidim/api/types/participatory_space_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class ParticipatorySpaceType < Decidim::Api::Types::BaseObject
+      implements ParticipatorySpaceInterface
+      description "A participatory space"
+    end
+  end
+end

data/lib/decidim/api/types/scope_api_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class ScopeApiType < Decidim::Api::Types::BaseObject
+      graphql_name "Scope"
+      description "A scope"
+
+      field :id, GraphQL::Types::ID, null: false
+      field :name, Decidim::Core::TranslatedFieldType, "The graphql_name of this scope.", null: false
+
+      field :children, [Decidim::Core::ScopeApiType, { null: true }], "Descendants of this scope", null: false
+      field :parent, Decidim::Core::ScopeApiType, "This scope's parent scope.", null: true
+    end
+  end
+end

data/lib/decidim/api/types/session_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    # This type represents the current user session.
+    class SessionType < Decidim::Api::Types::BaseObject
+      description "The current session"
+
+      field :user, UserType, "The current user", null: true
+
+      def user
+        object
+      end
+
+      field :verified_user_groups, [UserGroupType], "The current user verified user groups", null: false
+
+      def verified_user_groups
+        Decidim::UserGroups::ManageableUserGroups.for(object).verified
+      end
+    end
+  end
+end

data/lib/decidim/api/types/statistic_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class StatisticType < Decidim::Api::Types::BaseObject
+      description "Represents a single statistic"
+
+      field :name, GraphQL::Types::String, "The name of the statistic", null: false
+      field :value, GraphQL::Types::Int, "The actual value of the statistic", null: false
+
+      def name
+        object[0]
+      end
+
+      def value
+        object[1]
+      end
+    end
+  end
+end

data/lib/decidim/api/types/trace_version_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Core
+    class TraceVersionType < Decidim::Api::Types::BaseObject
+      description "A trace version type"
+
+      field :id, GraphQL::Types::ID, "The ID of the version", null: false
+      field :created_at, Decidim::Core::DateTimeType, description: "The date and time this version was created", null: true
+      field :editor, Decidim::Core::AuthorInterface, description: "The editor/author of this version", null: true
+
+      def editor
+        author = Decidim.traceability.version_editor(object)
+        author if author.is_a?(Decidim::User) || author.is_a?(Decidim::UserGroup)
+      end
+      field :changeset, GraphQL::Types::JSON, description: "Object with the changes in this version", null: true
+
+      delegate :changeset, to: :object
+    end
+  end
+end