droneio 1.0.0

data/lib/drone/models/build.rb

@@ -0,0 +1,111 @@
+#
+# 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 `build` JSON as a model
+  #
+  class Build
+    # Workaround to include virtus without YARD warning
+    send :include, Virtus.model
+
+    # @!attribute id
+    #   @return [Integer] the ID of the build
+    attribute :id, Integer
+
+    # @!attribute number
+    #   @return [Integer] the number of the build
+    attribute :number, Integer
+
+    # @!attribute event
+    #   @return [String] the event of the build
+    attribute :event, String
+
+    # @!attribute status
+    #   @return [String] the status of the build
+    attribute :status, String
+
+    # @!attribute deploy_to
+    #   @return [String] the target of the deploy
+    attribute :deploy_to, String
+
+    # @!attribute commit
+    #   @return [String] the commit hash of the build
+    attribute :commit, String
+
+    # @!attribute branch
+    #   @return [String] the branch of the build
+    attribute :branch, String
+
+    # @!attribute ref
+    #   @return [String] the reference of the build
+    attribute :ref, String
+
+    # @!attribute refspec
+    #   @return [String] the reference spec of the build
+    attribute :refspec, String
+
+    # @!attribute remote
+    #   @return [String] the remote name of the build
+    attribute :remote, String
+
+    # @!attribute title
+    #   @return [String] the title of the build
+    attribute :title, String
+
+    # @!attribute message
+    #   @return [String] the commit message of the build
+    attribute :message, String
+
+    # @!attribute link
+    #   @return [String] the link to the current build
+    attribute :link, String
+
+    # @!attribute author
+    #   @return [String] the commit author
+    attribute :author, String
+
+    # @!attribute author_avatar
+    #   @return [String] the link to author avatar
+    attribute :author_avatar, String
+
+    # @!attribute author_email
+    #   @return [String] the email of the author
+    attribute :author_email, String
+
+    # @!attribute timestamp
+    #   @return [Time] the timestamp of the build
+    attribute :timestamp, Time
+
+    # @!attribute enqueued_at
+    #   @return [Time] the time when the build have been enqueued
+    attribute :enqueued_at, Time
+
+    # @!attribute created_at
+    #   @return [Time] the time when the build have been created
+    attribute :created_at, Time
+
+    # @!attribute started_at
+    #   @return [Time] the time when the build have been started
+    attribute :started_at, Time
+
+    # @!attribute finished_at
+    #   @return [Time] the time when the build have been finished
+    attribute :finished_at, Time
+  end
+end

data/lib/drone/models/build_representer.rb

@@ -0,0 +1,136 @@
+#
+# 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 `build` JSON payload
+  #
+  class BuildRepresenter < Representable::Decorator
+    include Representable::JSON
+
+    # @!attribute id
+    #   @return [Integer] the ID of the build
+    property :id
+
+    # @!attribute number
+    #   @return [Integer] the number of the build
+    property :number
+
+    # @!attribute event
+    #   @return [String] the event of the build
+    property :event
+
+    # @!attribute status
+    #   @return [String] the status of the build
+    property :status
+
+    # @!attribute deploy_to
+    #   @return [String] the target of the deploy
+    property :deploy_to
+
+    # @!attribute commit
+    #   @return [String] the commit hash of the build
+    property :commit
+
+    # @!attribute branch
+    #   @return [String] the branch of the build
+    property :branch
+
+    # @!attribute ref
+    #   @return [String] the reference of the build
+    property :ref
+
+    # @!attribute refspec
+    #   @return [String] the reference spec of the build
+    property :refspec
+
+    # @!attribute remote
+    #   @return [String] the remote name of the build
+    property :remote
+
+    # @!attribute title
+    #   @return [String] the title of the build
+    property :title
+
+    # @!attribute message
+    #   @return [String] the commit message of the build
+    property :message
+
+    # @!attribute link
+    #   @return [String] the link to the current build
+    property :link,
+      as: :link_url
+
+    # @!attribute author
+    #   @return [String] the commit author
+    property :author
+
+    # @!attribute author_avatar
+    #   @return [String] the link to author avatar
+    property :author_avatar
+
+    # @!attribute author_email
+    #   @return [String] the email of the author
+    property :author_email
+
+    # @!attribute timestamp
+    #   @return [Time] the timestamp of the build
+    property :timestamp,
+      setter: lambda { |options| # rubocop:disable Style/BlockDelimiters
+        options[:represented].timestamp = Time.at(
+          options[:fragment]
+        ).utc
+      }
+
+    # @!attribute enqueued_at
+    #   @return [Time] the time when the build have been enqueued
+    property :enqueued_at,
+      setter: lambda { |options| # rubocop:disable Style/BlockDelimiters
+        options[:represented].enqueued_at = Time.at(
+          options[:fragment]
+        ).utc
+      }
+
+    # @!attribute created_at
+    #   @return [Time] the time when the build have been created
+    property :created_at,
+      setter: lambda { |options| # rubocop:disable Style/BlockDelimiters
+        options[:represented].created_at = Time.at(
+          options[:fragment]
+        ).utc
+      }
+
+    # @!attribute started_at
+    #   @return [Time] the time when the build have been started
+    property :started_at,
+      setter: lambda { |options| # rubocop:disable Style/BlockDelimiters
+        options[:represented].started_at = Time.at(
+          options[:fragment]
+        ).utc
+      }
+
+    # @!attribute finished_at
+    #   @return [Time] the time when the build have been finished
+    property :finished_at,
+      setter: lambda { |options| # rubocop:disable Style/BlockDelimiters
+        options[:represented].finished_at = Time.at(
+          options[:fragment]
+        ).utc
+      }
+  end
+end

data/lib/drone/models/key.rb

@@ -0,0 +1,35 @@
+#
+# 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 `key` JSON as a model
+  #
+  class Key
+    # Workaround to include virtus without YARD warning
+    send :include, Virtus.model
+
+    # @!attribute public
+    #   @return [String] the public SSH key
+    attribute :public, String
+
+    # @!attribute private
+    #   @return [String] the private SSH key
+    attribute :private, String
+  end
+end

data/lib/drone/models/key_representer.rb

@@ -0,0 +1,34 @@
+#
+# 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 `key` JSON payload
+  #
+  class KeyRepresenter < Representable::Decorator
+    include Representable::JSON
+
+    # @!attribute public
+    #   @return [String] the public SSH key
+    property :public
+
+    # @!attribute private
+    #   @return [String] the private SSH key
+    property :private
+  end
+end

data/lib/drone/models/netrc.rb

@@ -0,0 +1,39 @@
+#
+# 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 `netrc` JSON as a model
+  #
+  class Netrc
+    # Workaround to include virtus without YARD warning
+    send :include, Virtus.model
+
+    # @!attribute machine
+    #   @return [String] the host for the netrc
+    attribute :machine, String
+
+    # @!attribute login
+    #   @return [String] the username for the netrc
+    attribute :login, String
+
+    # @!attribute password
+    #   @return [String] the password for the netrc
+    attribute :password, String
+  end
+end

data/lib/drone/models/netrc_representer.rb

@@ -0,0 +1,38 @@
+#
+# 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 `netrc` JSON payload
+  #
+  class NetrcRepresenter < Representable::Decorator
+    include Representable::JSON
+
+    # @!attribute machine
+    #   @return [String] the host for the netrc
+    property :machine
+
+    # @!attribute login
+    #   @return [String] the username for the netrc
+    property :login
+
+    # @!attribute password
+    #   @return [String] the password for the netrc
+    property :password
+  end
+end

data/lib/drone/models/payload.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 "hashie"
+require "virtus"
+
+module Drone
+  #
+  # Represent toplevel JSON as a model
+  #
+  class Payload
+    # Workaround to include virtus without YARD warning
+    send :include, Virtus.model
+
+    # @!attribute repo
+    #   @return [Drone::Repo] the repo configuration
+    attribute :repo, Repo
+
+    # @!attribute system
+    #   @return [Drone::System] the system configuration
+    attribute :system, System
+
+    # @!attribute build
+    #   @return [Drone::Build] the build configuration
+    attribute :build, Build
+
+    # @!attribute workspace
+    #   @return [Drone::Workspace] the workspace configuration
+    attribute :workspace, Workspace
+
+    # @!attribute vargs
+    #   @return [Hash] the plugin specific payload
+    attribute :vargs, Hash
+
+    # @return [Hashie::Mash] the plugin specific payload
+    def vargs
+      Hashie::Mash.new(
+        super
+      )
+    end
+  end
+end