droneio 1.0.0

data/lib/drone/models/payload_representer.rb

@@ -0,0 +1,54 @@
+#
+# Copyright 2016 Drone.io Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "representable/json"
+
+module Drone
+  #
+  # Transform toplevel JSON payload
+  #
+  class PayloadRepresenter < Representable::Decorator
+    include Representable::JSON
+
+    # @!attribute repo
+    #   @return [Drone::Repo] the repo configuration
+    property :repo,
+      decorator: RepoRepresenter,
+      class: Repo
+
+    # @!attribute system
+    #   @return [Drone::System] the system configuration
+    property :system,
+      decorator: SystemRepresenter,
+      class: System
+
+    # @!attribute build
+    #   @return [Drone::Build] the build configuration
+    property :build,
+      decorator: BuildRepresenter,
+      class: Build
+
+    # @!attribute workspace
+    #   @return [Drone::Workspace] the workspace configuration
+    property :workspace,
+      decorator: WorkspaceRepresenter,
+      class: Workspace
+
+    # @!attribute vargs
+    #   @return [Hash] the plugin specific payload
+    property :vargs
+  end
+end

data/lib/drone/models/repo.rb

@@ -0,0 +1,87 @@
+#
+# Copyright 2016 Drone.io Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "virtus"
+
+module Drone
+  #
+  # Represent `repo` JSON as a model
+  #
+  class Repo
+    # Workaround to include virtus without YARD warning
+    send :include, Virtus.model
+
+    # @!attribute id
+    #   @return [Integer] the ID of the repo
+    attribute :id, Integer
+
+    # @!attribute owner
+    #   @return [String] the owner name
+    attribute :owner, String
+
+    # @!attribute name
+    #   @return [String] the repo name
+    attribute :name, String
+
+    # @!attribute full_name
+    #   @return [String] the full repo name
+    attribute :full_name, String
+
+    # @!attribute avatar
+    #   @return [String] the URL to the repo avatar
+    attribute :avatar, String
+
+    # @!attribute link
+    #   @return [String] the URL to the repo website
+    attribute :link, String
+
+    # @!attribute clone
+    #   @return [String] the URL to the repo SCM system
+    attribute :clone, String
+
+    # @!attribute branch
+    #   @return [String] the repo default branch
+    attribute :branch, String
+
+    # @!attribute timeout
+    #   @return [Integer] the timeout value
+    attribute :timeout, Integer
+
+    # @!attribute private
+    #   @return [Boolean] the flag if repo is private
+    attribute :private, Boolean
+
+    # @!attribute trusted
+    #   @return [Boolean] the flag if the repo is trusted
+    attribute :trusted, Boolean
+
+    # @!attribute pr
+    #   @return [Boolean] the flag if pull requests are allowed
+    attribute :pr, Boolean
+
+    # @!attribute push
+    #   @return [Boolean] the flag if pushs are allowed
+    attribute :push, Boolean
+
+    # @!attribute deploys
+    #   @return [String] the flag if deploys are allowed
+    attribute :deploys, Boolean
+
+    # @!attribute tags
+    #   @return [String] the flag if tags are allowed
+    attribute :tags, Boolean
+  end
+end

data/lib/drone/models/repo_representer.rb

@@ -0,0 +1,94 @@
+#
+# Copyright 2016 Drone.io Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "representable/json"
+
+module Drone
+  #
+  # Transform `repo` JSON payload
+  #
+  class RepoRepresenter < Representable::Decorator
+    include Representable::JSON
+
+    # @!attribute id
+    #   @return [Integer] the ID of the repo
+    property :id
+
+    # @!attribute owner
+    #   @return [String] the owner name
+    property :owner
+
+    # @!attribute name
+    #   @return [String] the repo name
+    property :name
+
+    # @!attribute full_name
+    #   @return [String] the full repo name
+    property :full_name
+
+    # @!attribute avatar
+    #   @return [String] the URL to the repo avatar
+    property :avatar,
+      as: :avatar_url
+
+    # @!attribute link
+    #   @return [String] the URL to the repo website
+    property :link,
+      as: :link_url
+
+    # @!attribute clone
+    #   @return [String] the URL to the repo SCM system
+    property :clone,
+      as: :clone_url
+
+    # @!attribute branch
+    #   @return [String] the repo default branch
+    property :branch,
+      as: :default_branch
+
+    # @!attribute timeout
+    #   @return [Integer] the timeout value
+    property :timeout
+
+    # @!attribute private
+    #   @return [Boolean] the flag if repo is private
+    property :private
+
+    # @!attribute trusted
+    #   @return [Boolean] the flag if the repo is trusted
+    property :trusted
+
+    # @!attribute pr
+    #   @return [Boolean] the flag if pull requests are allowed
+    property :pr,
+      as: :allow_pr
+
+    # @!attribute push
+    #   @return [Boolean] the flag if pushs are allowed
+    property :push,
+      as: :allow_push
+
+    # @!attribute deploys
+    #   @return [String] the flag if deploys are allowed
+    property :deploys,
+      as: :allow_deploys
+
+    # @!attribute tags
+    #   @return [String] the flag if tags are allowed
+    property :tags,
+      as: :allow_tags
+  end
+end

data/lib/drone/models/system.rb

@@ -0,0 +1,47 @@
+#
+# Copyright 2016 Drone.io Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "virtus"
+
+module Drone
+  #
+  # Represent `system` JSON as a model
+  #
+  class System
+    # Workaround to include virtus without YARD warning
+    send :include, Virtus.model
+
+    # @!attribute version
+    #   @return [String] the version of the Drone server
+    attribute :version, String
+
+    # @!attribute link
+    #   @return [String] the link to the Drone server
+    attribute :link, String
+
+    # @!attribute plugins
+    #   @return [Array] the used plugins within the build
+    attribute :plugins, Array[String]
+
+    # @!attribute privileged
+    #   @return [Array] the list of privileged plugins
+    attribute :privileged, Array[String]
+
+    # @!attribute globals
+    #   @return [Array] the used global environment vars
+    attribute :globals, Array[String]
+  end
+end

data/lib/drone/models/system_representer.rb

@@ -0,0 +1,48 @@
+#
+# Copyright 2016 Drone.io Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "representable/json"
+
+module Drone
+  #
+  # Transform `system` JSON payload
+  #
+  class SystemRepresenter < Representable::Decorator
+    include Representable::JSON
+
+    # @!attribute version
+    #   @return [String] the version of the Drone server
+    property :version
+
+    # @!attribute link
+    #   @return [String] the link to the Drone server
+    property :link,
+      as: :link_url
+
+    # @!attribute plugins
+    #   @return [Array] the used plugins within the build
+    collection :plugins
+
+    # @!attribute privileged
+    #   @return [Array] the list of privileged plugins
+    collection :privileged,
+      as: :privileged_plugins
+
+    # @!attribute globals
+    #   @return [Array] the used global environment vars
+    collection :globals
+  end
+end

data/lib/drone/models/workspace.rb

@@ -0,0 +1,43 @@
+#
+# Copyright 2016 Drone.io Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "virtus"
+
+module Drone
+  #
+  # Represent `workspace` JSON as a model
+  #
+  class Workspace
+    # Workaround to include virtus without YARD warning
+    send :include, Virtus.model
+
+    # @!attribute root
+    #   @return [String] the root path of the workspace
+    attribute :root, String
+
+    # @!attribute path
+    #   @return [String] the absolute path to the source
+    attribute :path, String
+
+    # @!attribute netrc
+    #   @return [Drone::Netrc] the netrc configuration
+    attribute :netrc, Netrc
+
+    # @!attribute keys
+    #   @return [Drone::Key] the key configuration
+    attribute :keys, Key
+  end
+end

data/lib/drone/models/workspace_representer.rb

@@ -0,0 +1,46 @@
+#
+# Copyright 2016 Drone.io Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "representable/json"
+
+module Drone
+  #
+  # Transform `workspace` JSON payload
+  #
+  class WorkspaceRepresenter < Representable::Decorator
+    include Representable::JSON
+
+    # @!attribute root
+    #   @return [String] the root path of the workspace
+    property :root
+
+    # @!attribute path
+    #   @return [String] the absolute path to the source
+    property :path
+
+    # @!attribute netrc
+    #   @return [Drone::Netrc] the netrc configuration
+    property :netrc,
+      decorator: NetrcRepresenter,
+      class: Netrc
+
+    # @!attribute keys
+    #   @return [Drone::Key] the key configuration
+    property :keys,
+      decorator: KeyRepresenter,
+      class: Key
+  end
+end

data/lib/drone/plugin.rb

@@ -0,0 +1,55 @@
+#
+# Copyright 2016 Drone.io Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "json"
+
+module Drone
+  #
+  # Plugin payload parser for Drone
+  #
+  class Plugin
+    attr_accessor :input
+    attr_accessor :result
+
+    # Initialize the plugin parser
+    #
+    # @param input [String] the JSON as a string to parse
+    # @return [Drone::Plugin] the instance of that class
+    def initialize(input)
+      self.input = input
+
+      yield(
+        parse
+      ) if block_given?
+    end
+
+    # Parse the provided payload
+    #
+    # @return [Drone::Payload] the parsed payload within model
+    # @raise [Drone::InvalidJsonError] if the provided JSON is invalid
+    def parse
+      self.result ||= Payload.new.tap do |payload|
+        PayloadRepresenter.new(
+          payload
+        ).from_json(
+          input
+        )
+      end
+    rescue MultiJson::ParseError
+      raise InvalidJsonError
+    end
+  end
+end