trav3 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbe80498ecdd8cdfc666b5d4aebdf93e95e17ab2b5abcb4a82cddabbe70849e2
-  data.tar.gz: ae6b79b2ac0378e1c3ada5cb55ce65d8564273f3700102f292f7e6e660fc8dd2
+  metadata.gz: ed23a93da595b3da695cb6caab54e75c06f8b0dad48f9765293a21698fe1893b
+  data.tar.gz: c6ca0a3472f8130457a2aadccdf757bfc4e8ba12c4ce43cc5bedf2e781c7a050
 SHA512:
-  metadata.gz: 719cf9281a7b5f76f7ae6acdd72b93baafdef8e8abf12d0c478d55fb0a2be1a63e5b3f0c5cba828736677472dc5debe183cf594526e3b6241aace6722b99ba7f
-  data.tar.gz: 63edbe4e649955a515288d3fe490a0e61113b8ce3589eac02fda43e8b031c670e9dcba07624651ec7ed84bcd5e7af6deb5b7395d1928ae9bf4e8a630c5fa49a6
+  metadata.gz: 57991342eb7e718ba0e4441a901e7765fd2bb19159eda1e124c2e214c86e60a7ee3a040ab931a8e5829c674035522126bfcaeb7f671570876baa9a5bc9414ea2
+  data.tar.gz: 235cbd08b2ec78926a8a142653ca98441c8063904e5686a37bf08d308c5c9495e9778023d9e8c5aac862b0ba9714f4d412e199474c7f29297297ef00899bf8b6

data/README.md

@@ -1,6 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/trav3.svg)](http://badge.fury.io/rb/trav3)
 [![Build Status](https://travis-ci.org/danielpclark/trav3.svg?branch=master)](https://travis-ci.org/danielpclark/trav3)
-[![Commits Since Release](https://img.shields.io/github/commits-since/danielpclark/trav3/v0.3.3.svg)](https://github.com/danielpclark/trav3/graphs/commit-activity)
+[![Commits Since Release](https://img.shields.io/github/commits-since/danielpclark/trav3/v0.3.4.svg)](https://github.com/danielpclark/trav3/graphs/commit-activity)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1ed07a4baea3832b6207/maintainability)](https://codeclimate.com/github/danielpclark/trav3/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/1ed07a4baea3832b6207/test_coverage)](https://codeclimate.com/github/danielpclark/trav3/test_coverage)
 [![Red The Docs](https://img.shields.io/badge/Read-the%20docs-blue.svg)](http://danielpclark.github.io/trav3/Trav3/Travis.html)

data/lib/trav3.rb

@@ -662,6 +662,232 @@ module Trav3
       get("#{with_repo}/caches")
     end
 
+    # An individual cron. There can be only one cron per branch on a repository.
+    #
+    # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
+    #
+    # ## Attributes
+    #
+    # **Minimal Representation**
+    #
+    # Included when the resource is returned as part of another resource.
+    #
+    #     Name  Type     Description
+    #     id    Integer  Value uniquely identifying the cron.
+    #
+    # **Standard Representation**
+    #
+    # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
+    #
+    #     Name                             Type        Description
+    #     id                               Integer     Value uniquely identifying the cron.
+    #     repository                       Repository  Github repository to which this cron belongs.
+    #     branch                           Branch      Git branch of repository to which this cron belongs.
+    #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
+    #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
+    #     last_run                         String      When the cron ran last.
+    #     next_run                         String      When the cron is scheduled to run next.
+    #     created_at                       String      When the cron was created.
+    #     active                           Unknown     The cron's active.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # This returns a single cron.
+    #
+    # GET <code>/cron/{cron.id}</code>
+    #
+    #     Template Variable  Type     Description
+    #     cron.id            Integer  Value uniquely identifying the cron.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    # **Delete**
+    #
+    # This deletes a single cron.
+    #
+    # DELETE <code>/cron/{cron.id}</code>
+    #
+    #     Template Variable  Type     Description
+    #     cron.id            Integer  Value uniquely identifying the cron.
+    #
+    # **For Branch**
+    #
+    # This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.
+    #
+    # GET <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     branch.name        String   Name of the git branch.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    #     Example: GET /repo/891/branch/master/cron
+    #
+    # GET <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     branch.name        String  Name of the git branch.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    #     Example: GET /repo/rails%2Frails/branch/master/cron
+    #
+    # **Create**
+    #
+    # This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.
+    #
+    # ```bash
+    # curl -X POST \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   -d '{ "cron.interval": "monthly" }' \
+    #   https://api.travis-ci.com/repo/1234/branch/master/cron
+    # ```
+    #
+    # POST <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     branch.name        String   Name of the git branch.
+    #     Accepted Parameter                    Type     Description
+    #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
+    #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
+    #
+    #     Example: POST /repo/891/branch/master/cron
+    #
+    # POST <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     branch.name        String  Name of the git branch.
+    #     Accepted Parameter                    Type     Description
+    #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
+    #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
+    #
+    #     Example: POST /repo/rails%2Frails/branch/master/cron
+    #
+    # @param id [String, Integer] cron id to get or delete
+    # @param branch_name [String] branch name to get cron or create
+    # @param create [Hash] Properties for creating the cron.  `branch_name` keyword argument required and `interval` key/value required.
+    # @param delete [Boolean] option for deleting cron.  Cron `id` keyword argument required.
+    # @return [Success, RequestError]
+    def cron(id: nil, branch_name: nil, create: nil, delete: false)
+      if id
+        validate_number id
+
+        delete and return delete("#{without_repo}/cron/#{id}")
+        return get("#{without_repo}/cron/#{id}")
+      end
+      raise ArgumentError, 'id or branch_name required' unless branch_name
+
+      create and return create("#{with_repo}/branch/#{branch_name}/cron", cron_keys(create))
+      get("#{with_repo}/branch/#{branch_name}/cron")
+    end
+
+    # A list of crons.
+    #
+    # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
+    #
+    # ## Attributes
+    #
+    #     Name   Type    Description
+    #     crons  [Cron]  List of crons.
+    #
+    # **Collection Items**
+    #
+    # Each entry in the crons array has the following attributes:
+    #
+    #     Name                             Type        Description
+    #     id                               Integer     Value uniquely identifying the cron.
+    #     repository                       Repository  Github repository to which this cron belongs.
+    #     branch                           Branch      Git branch of repository to which this cron belongs.
+    #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
+    #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
+    #     last_run                         String      When the cron ran last.
+    #     next_run                         String      When the cron is scheduled to run next.
+    #     created_at                       String      When the cron was created.
+    #     active                           Unknown     The cron's active.
+    #
+    # ## Actions
+    #
+    # **For Repository**
+    #
+    # This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.
+    #
+    # GET <code>/repo/{repository.id}/crons</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #     limit            Integer   How many crons to include in the response. Used for pagination.
+    #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
+    #
+    #     Example: GET /repo/891/crons?limit=5
+    #
+    # GET <code>/repo/{repository.slug}/crons</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #     limit            Integer   How many crons to include in the response. Used for pagination.
+    #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
+    #
+    #     Example: GET /repo/rails%2Frails/crons?limit=5
+    #
+    # @return [Success, RequestError]
+    def crons
+      get("#{with_repo}/crons")
+    end
+
+    # POST <code>/repo/{repository.id}/email_subscription</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #
+    #     Example: POST /repo/891/email_subscription
+    #
+    # POST <code>/repo/{repository.slug}/email_subscription</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #
+    #     Example: POST /repo/rails%2Frails/email_subscription
+    #
+    # @note requests require an authorization token set in the headers. See: {authorization=}
+    #
+    # @return [Success, RequestError]
+    def email_resubscribe
+      post("#{with_repo}/email_subscription")
+    end
+
+    # DELETE <code>/repo/{repository.id}/email_subscription</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #
+    #     Example: DELETE /repo/891/email_subscription
+    #
+    # DELETE <code>/repo/{repository.slug}/email_subscription</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #
+    #     Example: DELETE /repo/rails%2Frails/email_subscription
+    #
+    # @note requests require an authorization token set in the headers. See: {authorization=}
+    #
+    # @return [Success, RequestError]
+    def email_unsubscribe
+      delete("#{with_repo}/email_subscription")
+    end
+
     # An individual environment variable.
     #
     # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
@@ -1338,8 +1564,6 @@ module Trav3
     #
     #     Example: DELETE /job/86601347/log
     #
-    # @note DELETE is unimplemented
-    #
     # @param job_id [String, Integer] the job id number
     # @param option [Symbol] options for :text or :delete
     # @return [Success, String, RequestError]
@@ -1348,7 +1572,7 @@ module Trav3
       when :text
         get("#{without_repo}/job/#{job_id}/log.txt", true)
       when :delete
-        raise Unimplemented
+        delete("#{without_repo}/job/#{job_id}/log")
       else
         get("#{without_repo}/job/#{job_id}/log")
       end
@@ -2485,6 +2709,10 @@ module Trav3
       Trav3::REST.create(self, url, data)
     end
 
+    def cron_keys(hash)
+      inject_property_name('cron', hash)
+    end
+
     def delete(url)
       Trav3::REST.delete(self, url)
     end
@@ -2517,7 +2745,9 @@ module Trav3
     end
 
     def inject_property_name(name, hash)
-      hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/#{name}\.\w+/)
+      return hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/\A#{name}\.\w+\z/)
+
+      hash
     end
 
     def key_pair_keys(hash)

data/lib/trav3/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trav3
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trav3
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-26 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler