trav3 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93d77ee47c7ed5e7c1f75e2acd89a0e54fb535a43f3d733e34846dc978221215
-  data.tar.gz: c4dd8fbb0fbdc9f49da8813658034fd4d267e2fed16fabc74bcf545b348df6dd
+  metadata.gz: f0e2d396b8b3a4e5aa159cf69661b88b2d3919bb7e9aceac6658251592e69f02
+  data.tar.gz: e3956e9b90b658689b21026d4e69c1198eb2ad10d15f9376bef4c16bb95eae6f
 SHA512:
-  metadata.gz: ecd602f45589d107c1c8b34389edb61b2b5b6b10e1849cc7fd867bd877e31ae2fe2dae5973e487c0e2b69814c9150d3030adcf3bd7c8b74220143b87cec22f9b
-  data.tar.gz: ff47d0c65e5b74e3992132b686d04eb539d384127485228533413992ac83214acad961dec1aba6000921d143360b6ac5b7fcea4cc5712ef40035e65cd3cf16e1
+  metadata.gz: 111a2df7f87c5748c86d319231f6b0a09c0dd47507ecabcb20844fb8b4335cc2841377e52d01f82305e3111329dc81470b8bfee126289df068ccb174d2483390
+  data.tar.gz: 2dda90b5419e0f1761344ba6ce1d365e2af5565ca8e9095cd123d6c2d1eb9f17f706b1f10d4b8ef22599fa6a2a982a7949937185f761c52afebf679b960cf3d9

data/lib/trav3.rb

@@ -624,6 +624,7 @@ module Trav3
     # ```
     #
     # DELETE <code>/repo/{repository.id}/caches</code>
+    #
     #     Template Variable  Type     Description
     #     repository.id      Integer  Value uniquely identifying the repository.
     #
@@ -1164,7 +1165,8 @@ module Trav3
     #
     # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
     #
-    # **For Current User**<br />
+    # **For Current User**
+    #
     # This returns a list of repositories the current user has access to.
     #
     # GET <code>/repos</code>
@@ -1333,7 +1335,7 @@ module Trav3
       validate_repo_format repo
 
       repo = sanitize_repo_name repo
-      action = '' unless %w[star unstar activate deavtivate].include? action.to_s
+      action = '' unless %w[star unstar activate deactivate].include? action.to_s
 
       if action.empty?
         get("#{without_repo}/repo/#{repo}")
@@ -1342,6 +1344,206 @@ module Trav3
       end
     end
 
+    # An individual request
+    #
+    # ## Attributes
+    #
+    # **Minimal Representation**
+    #
+    # Included when the resource is returned as part of another resource.
+    #
+    #     Name     Type     Description
+    #     id       Integer  Value uniquely identifying the request.
+    #     state    String   The state of a request (eg. whether it has been processed or not).
+    #     result   String   The result of the request (eg. rejected or approved).
+    #     message  String   Travis-ci status message attached to the request.
+    #
+    # **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 request.
+    #     state        String      The state of a request (eg. whether it has been processed or not).
+    #     result       String      The result of the request (eg. rejected or approved).
+    #     message      String      Travis-ci status message attached to the request.
+    #     repository   Repository  GitHub user or organization the request belongs to.
+    #     branch_name  String      Name of the branch requested to be built.
+    #     commit       Commit      The commit the request is associated with.
+    #     builds       [Build]     The request's builds.
+    #     owner        Owner       GitHub user or organization the request belongs to.
+    #     created_at   String      When Travis CI created the request.
+    #     event_type   String      Origin of request (push, pull request, api).
+    #     base_commit  String      The base commit the request is associated with.
+    #     head_commit  String      The head commit the request is associated with.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # Document `resources/request/actions/find` not found.
+    #
+    # GET <code>/repo/{repository.id}/request/{request.id}</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     request.id         Integer  Value uniquely identifying the request.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    # GET <code>/repo/{repository.slug}/request/{request.id}</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
+    #     request.id         Integer  Value uniquely identifying the request.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    # @param request_id [String, Integer] request id
+    # @return [Success, RequestError]
+    def request(request_id)
+      validate_number request_id
+
+      get("#{with_repo}/request/#{request_id}")
+    end
+
+    # A list of requests.
+    #
+    # 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
+    #     requests  [Request]  List of requests.
+    #
+    # **Collection Items**
+    #
+    # Each entry in the **requests** array has the following attributes:
+    #
+    #     Name         Type        Description
+    #     id           Integer     Value uniquely identifying the request.
+    #     state        String      The state of a request (eg. whether it has been processed or not).
+    #     result       String      The result of the request (eg. rejected or approved).
+    #     message      String      Travis-ci status message attached to the request.
+    #     repository   Repository  GitHub user or organization the request belongs to.
+    #     branch_name  String      Name of the branch requested to be built.
+    #     commit       Commit      The commit the request is associated with.
+    #     builds       [Build]     The request's builds.
+    #     owner        Owner       GitHub user or organization the request belongs to.
+    #     created_at   String      When Travis CI created the request.
+    #     event_type   String      Origin of request (push, pull request, api).
+    #     base_commit  String      The base commit the request is associated with.
+    #     head_commit  String      The head commit the request is associated with.
+    #     yaml_config  Unknown     The request's yaml_config.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # This will return a list of requests belonging to a repository.
+    #
+    # GET <code>/repo/{repository.id}/requests</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 requests to include in the response. Used for pagination.
+    #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
+    #
+    #     Example: GET /repo/891/requests?limit=5
+    #
+    # GET <code>/repo/{repository.slug}/requests</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 requests to include in the response. Used for pagination.
+    #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
+    #
+    #     Example: GET /repo/rails%2Frails/requests?limit=5
+    #
+    # **Create**
+    #
+    # This will create a request for an individual repository, triggering a build to run on Travis CI.
+    #
+    # Use namespaced params in JSON format in the request body to pass any accepted parameters. Any keys in the request's config will override keys existing in the `.travis.yml`.
+    #
+    # ```bash
+    # curl -X POST \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   -d '{ "request": {
+    #         "message": "Override the commit message: this is an api request", "branch": "master" }}'\
+    #   https://api.travis-ci.com/repo/1/requests
+    # ```
+    #
+    # The response includes the following body:
+    #
+    # ```json
+    # {
+    #   "@type":              "pending",
+    #   "remaining_requests": 1,
+    #   "repository":         {
+    #     "@type":            "repository",
+    #     "@href":            "/repo/1",
+    #     "@representation":  "minimal",
+    #     "id":               1,
+    #     "name":             "test",
+    #     "slug":             "owner/repo"
+    #   },
+    #   "request":            {
+    #     "repository":       {
+    #       "id":             1,
+    #       "owner_name":     "owner",
+    #       "name":           "repo"
+    #     },
+    #     "user":             {
+    #       "id":             1
+    #     },
+    #     "id":               1,
+    #     "message":          "Override the commit message: this is an api request",
+    #     "branch":           "master",
+    #     "config":           { }
+    #   },
+    #   "resource_type":      "request"
+    # }
+    # ```
+    #
+    # POST <code>/repo/{repository.id}/requests</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     Accepted Parameter  Type    Description
+    #     request.config      String  Build configuration (as parsed from .travis.yml).
+    #     request.message     String  Travis-ci status message attached to the request.
+    #     request.branch      String  Branch requested to be built.
+    #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
+    #
+    #     Example: POST /repo/891/requests
+    #
+    # POST <code>/repo/{repository.slug}/requests</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     Accepted Parameter  Type    Description
+    #     request.config      String  Build configuration (as parsed from .travis.yml).
+    #     request.message     String  Travis-ci status message attached to the request.
+    #     request.branch      String  Branch requested to be built.
+    #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
+    #
+    #     Example: POST /repo/rails%2Frails/requests
+    #
+    # @param attributes [Hash] request attributes
+    # @return [Success, RequestError]
+    def requests(**attributes)
+      return get("#{with_repo}/requests") if attributes.empty?
+
+      create("#{with_repo}/requests", 'request': attributes)
+    end
+
     # A list of stages.
     #
     # Currently this is nested within a build.
@@ -1624,6 +1826,10 @@ module Trav3
 
     private # @private
 
+    def create(url, **data)
+      Trav3::REST.create(self, url, **data)
+    end
+
     def delete(url)
       Trav3::REST.delete(self, url)
     end

data/lib/trav3/rest.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'rest/create'
 require_relative 'rest/delete'
 require_relative 'rest/get'
 require_relative 'rest/patch'

data/lib/trav3/rest/create.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/MethodLength
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Trav3
+  module REST
+    def self.create(travis, url, **data)
+      uri = URI( url.sub(/\?.*$/, '') )
+      req = Net::HTTP::Post.new(uri.request_uri)
+      travis.headers.each_pair do |header, value|
+        req[header] = value
+      end
+      req.body = JSON.generate(data) unless data.empty?
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == 'https')
+      response = http.request(req)
+
+      if [Net::HTTPAccepted, Net::HTTPOK].include? response.code_type
+        Success.new(travis, response)
+      else
+        RequestError.new(travis, response)
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/MethodLength

data/lib/trav3/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trav3
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-19 00:00:00.000000000 Z
+date: 2019-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ files:
 - lib/trav3/options.rb
 - lib/trav3/pagination.rb
 - lib/trav3/rest.rb
+- lib/trav3/rest/create.rb
 - lib/trav3/rest/delete.rb
 - lib/trav3/rest/get.rb
 - lib/trav3/rest/patch.rb