trav3 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df20e3328d17a3337d9a09631285a18d5aa3d59381651c09db938f0e95edd324
-  data.tar.gz: 583fc08a041c80d8ebee2bc0684b7cea15a8888defdb6bd3bc5d17165406c1ae
+  metadata.gz: 97c7a3e7bbfb1ec5effd12bf275cf1e0bff1e39ed6676531648fb77c8ea329b4
+  data.tar.gz: '0683ce386cf9c469fb9f404321cb9de550141106a70dd4f12454d51f5ace73ed'
 SHA512:
-  metadata.gz: 4c08c5042a02094911029e1ddfab0cfb3e2f960f2fcc54222ddc5c020a9dff19f973f8b6593a893dd95e27c5fc389546115b4bf732ba9861c2dfa947f800b55d
-  data.tar.gz: d7cf95030b983f865874cfc033954597222af945b3c11a00e907fea4463caf6b5187c50059e17e94e4f893897cb221b2cb4bf9cafe10413c21a3d40c177d68d4
+  metadata.gz: 4c0c20dead40f8acff9ba0002e0e87b11fea7f8451ef425b4fff3d27a29cc5896484c6fc0297a757ab525cf1964d625492fdc85cc11162dcb3ef069b7675e7ba
+  data.tar.gz: 4dab80633ae6036f7574e92fc599db46e669627b9812fea3464f4689909c1872a230770f14c4acef3d606ed79c604bb86902d97253327578d2485ee6e02f8a92

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.2.5.svg)](https://github.com/danielpclark/trav3/graphs/commit-activity)
+[![Commits Since Release](https://img.shields.io/github/commits-since/danielpclark/trav3/v0.3.1.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

@@ -31,17 +31,16 @@ module Trav3
     #   conform to valid repository identifier format
     # @return [Travis]
     def initialize(repo)
-      validate_repo_format repo
-
       @api_endpoint = 'https://api.travis-ci.org'
-      @repo = sanitize_repo_name repo
+
+      self.repository = repo
 
       initial_defaults
     end
 
-    # @overload api_endpoint=(endpoint)
-    #   Set as the API endpoint
-    #   @param endpoint [String] name for value to set
+    # Set as the API endpoint
+    #
+    # @param endpoint [String] name for value to set
     # @return [self]
     # rubocop:disable Lint/Void
     def api_endpoint=(endpoint)
@@ -53,9 +52,10 @@ module Trav3
     end
     # rubocop:enable Lint/Void
 
+    # Set as many options as you'd like for collections queried via an API request
+    #
     # @overload defaults(key: value, ...)
-    #   Set as many options as you'd like for collections queried via an API request
-    #   @param key [Symbol, String] name for value to set
+    #   @param key [Symbol] name for value to set
     #   @param value [Symbol, String, Integer] value for key
     # @return [self]
     def defaults(**args)
@@ -68,7 +68,7 @@ module Trav3
     #     h("Authorization": "token xxxxxxxxxxxxxxxxxxxxxx")
     #
     # @overload h(key: value, ...)
-    #   @param key [Symbol, String] name for value to set
+    #   @param key [Symbol] name for value to set
     #   @param value [Symbol, String, Integer] value for key
     # @return [self]
     def h(**args)
@@ -76,6 +76,14 @@ module Trav3
       self
     end
 
+    # Change the repository this instance of `Trav3::Travis` uses.
+    #
+    # @param repo_name [String] github_username/repository_name
+    def repository=(repo_name)
+      validate_repo_format repo_name
+      @repo = sanitize_repo_name repo_name
+    end
+
     # Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.
     #
     # A list of all the builds in an "active" state, either created or started.
@@ -746,6 +754,234 @@ module Trav3
       end
     end
 
+    # Users may add a public/private RSA key pair to a repository.
+    # This can be used within builds, for example to access third-party services or deploy code to production.
+    # Please note this feature is only available on the travis-ci.com domain.
+    #
+    # ## Attributes
+    #
+    # **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
+    #     description  String  A text description.
+    #     public_key   String  The public key.
+    #     fingerprint  String  The fingerprint.
+    #
+    # **Minimal Representation**
+    #
+    # Included when the resource is returned as part of another resource.
+    #
+    #     Name         Type    Description
+    #     description  String  A text description.
+    #     public_key   String  The public key.
+    #     fingerprint  String  The fingerprint.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # Return the current key pair, if it exists.
+    #
+    # GET <code>/repo/{repository.id}/key_pair</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.
+    #
+    #     Example: GET /repo/891/key_pair
+    #
+    # GET <code>/repo/{repository.slug}/key_pair</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.
+    #
+    #     Example: GET /repo/rails%2Frails/key_pair
+    #
+    # **Create**
+    #
+    # Creates a new key pair.
+    #
+    # ```bash
+    # curl -X POST \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   -d '{ "key_pair.description": "FooBar", "key_pair.value": "xxxxx"}' \
+    #   https://api.travis-ci.com/repo/1234/key_pair
+    # ```
+    #
+    # POST <code>/repo/{repository.id}/key_pair</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     Accepted Parameter    Type    Description
+    #     key_pair.description  String  A text description.
+    #     key_pair.value        String  The private key.
+    #
+    #     Example: POST /repo/891/key_pair
+    #
+    # POST <code>/repo/{repository.slug}/key_pair</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     Accepted Parameter    Type    Description
+    #     key_pair.description  String  A text description.
+    #     key_pair.value        String  The private key.
+    #
+    #     Example: POST /repo/rails%2Frails/key_pair
+    #
+    # **Update**
+    #
+    # Update the key pair.
+    #
+    # ```bash
+    # curl -X PATCH \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   -d '{ "key_pair.description": "FooBarBaz" }' \
+    #   https://api.travis-ci.com/repo/1234/key_pair
+    # ```
+    #
+    # PATCH <code>/repo/{repository.id}/key_pair</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     Accepted Parameter    Type    Description
+    #     key_pair.description  String  A text description.
+    #     key_pair.value        String  The private key.
+    #
+    #     Example: PATCH /repo/891/key_pair
+    #
+    # PATCH <code>/repo/{repository.slug}/key_pair</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     Accepted Parameter    Type    Description
+    #     key_pair.description  String  A text description.
+    #     key_pair.value        String  The private key.
+    #
+    #     Example: PATCH /repo/rails%2Frails/key_pair
+    #
+    # **Delete**
+    #
+    # Delete the key pair.
+    #
+    # DELETE <code>/repo/{repository.id}/key_pair</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #
+    #     Example: DELETE /repo/891/key_pair
+    #
+    # DELETE <code>/repo/{repository.slug}/key_pair</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #
+    #     Example: DELETE /repo/rails%2Frails/key_pair
+    #
+    # @note requests require an authorization token set in the headers. See: {h}
+    # @note API enpoint needs to be set to `https://api.travis-ci.com` See: {api_endpoint=}
+    #
+    # @overload key_par()
+    #   Gets current key_pair if any
+    # @overload key_pair(action: params)
+    #   Performs action per specific key word argument
+    #   @param create [Hash] Create a new key pair from provided private key { description: "name", value: "private key" }
+    #   @param update [Hash] Update key pair with hash { description: "new name" }
+    #   @param delete [Boolean] Use truthy value to delete current key pair
+    # @return [Success, RequestError]
+    def key_pair(create: nil, update: nil, delete: nil)
+      raise 'Too many options specified' unless [create, update, delete].compact.count < 2
+
+      create and return create("#{with_repo}/key_pair", key_pair_keys(create))
+      update and return patch("#{with_repo}/key_pair", key_pair_keys(update))
+      delete and return delete("#{with_repo}/key_pair")
+      get("#{with_repo}/key_pair")
+    end
+
+    # Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client.
+    #
+    # Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.
+    #
+    # ## Attributes
+    #
+    # **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
+    #     description  String  A text description.
+    #     public_key   String  The public key.
+    #     fingerprint  String  The fingerprint.
+    #
+    # **Minimal Representation**
+    #
+    # Included when the resource is returned as part of another resource.
+    #
+    #     Name         Type    Description
+    #     description  String  A text description.
+    #     public_key   String  The public key.
+    #     fingerprint  String  The fingerprint.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # Return the current key pair.
+    #
+    # GET <code>/repo/{repository.id}/key_pair/generated</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.
+    #
+    #     Example: GET /repo/891/key_pair/generated
+    #
+    # GET <code>/repo/{repository.slug}/key_pair/generated</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.
+    #
+    #     Example: GET /repo/rails%2Frails/key_pair/generated
+    #
+    # **Create**
+    #
+    # Generate a new key pair, replacing the previous one.
+    #
+    # POST <code>/repo/{repository.id}/key_pair/generated</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #
+    #     Example: POST /repo/891/key_pair/generated
+    #
+    # POST <code>/repo/{repository.slug}/key_pair/generated</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #
+    #     Example: POST /repo/rails%2Frails/key_pair/generated
+    #
+    # @note requests require an authorization token set in the headers. See: {h}
+    #
+    # @param action [String, Symbol] defaults to getting current key pair, use `:create` if you would like to generate a new key pair
+    # @return [Success, RequestError]
+    def key_pair_generated(action = :get)
+      return post("#{with_repo}/key_pair/generated") if action.match?(/create/i)
+
+      get("#{with_repo}/key_pair/generated")
+    end
+
     # This validates the `.travis.yml` file and returns any warnings.
     #
     # The request body can contain the content of the .travis.yml file directly as a string, eg "foo: bar".
@@ -863,6 +1099,58 @@ module Trav3
       end
     end
 
+    # A list of messages. Messages belong to resource types.
+    #
+    # ## Attributes
+    #
+    #     Name      Type       Description
+    #     messages  [Message]  List of messages.
+    #
+    # **Collection Items**
+    #
+    # Each entry in the messages array has the following attributes:
+    #
+    #     Name   Type     Description
+    #     id     Integer  The message's id.
+    #     level  String   The message's level.
+    #     key    String   The message's key.
+    #     code   String   The message's code.
+    #     args   Json     The message's args.
+    #
+    # ## Actions
+    #
+    # **For Request**
+    #
+    # This will return a list of messages created by `travis-yml` for a request, if any exist.
+    #
+    # GET <code>/repo/{repository.id}/request/{request.id}/messages</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.
+    #     limit            Integer   How many messages to include in the response. Used for pagination.
+    #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
+    #
+    # GET <code>/repo/{repository.slug}/request/{request.id}/messages</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.
+    #     limit            Integer   How many messages to include in the response. Used for pagination.
+    #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
+    #
+    # @param request_id [String, Integer] the request id
+    # @return [Success, RequestError]
+    def messages(request_id)
+      validate_number request_id
+
+      get("#{with_repo}/request/#{request_id}/messages")
+    end
+
     # An individual organization.
     #
     # ## Attributes
@@ -1113,6 +1401,8 @@ module Trav3
     #     Query Parameter  Type      Description
     #     include          [String]  List of attributes to eager load.
     #
+    # @note requests require an authorization token set in the headers. See: {h}
+    #
     # @param key [String] preference name to get or set
     # @param value [String] optional value to set preference
     # @param org_id [String, Integer] optional keyword argument for an organization id
@@ -1163,6 +1453,8 @@ module Trav3
     #
     #     Example: GET /preferences
     #
+    # @note requests require an authorization token set in the headers. See: {h}
+    #
     # @param org_id [String, Integer] optional organization id
     # @return [Success, RequestError]
     def preferences(org_id = nil)
@@ -1950,8 +2242,8 @@ module Trav3
 
     private # @private
 
-    def create(url, **data)
-      Trav3::REST.create(self, url, **data)
+    def create(url, data = {})
+      Trav3::REST.create(self, url, data)
     end
 
     def delete(url)
@@ -1981,6 +2273,10 @@ module Trav3
       h('Travis-API-Version': 3)
     end
 
+    def key_pair_keys(hash)
+      hash.map { |k, v| ["key_pair.#{k}", v] }.to_h unless hash.keys.first.match?(/key_pair\.\w+/)
+    end
+
     def number?(input)
       /^\d+$/.match? input.to_s
     end
@@ -2014,7 +2310,7 @@ module Trav3
     end
 
     def repo_slug_or_id?(input)
-      Regexp.new(/(^\d+$)|(^\w+(?:\/|%2F){1}\w+$)/).match? input
+      Regexp.new(/(^\d+$)|(^[A-Za-z0-9_.-]+(?:\/|%2F){1}[A-Za-z0-9_.-]+$)/i).match? input
     end
 
     def repository_name

data/lib/trav3/response/response.rb

@@ -16,7 +16,7 @@ module Trav3
       @travis = travis
       @response = response
       @collection = begin
-                      result = JSON.parse(response.body)
+                      result = JSON.parse(response&.body || '{}')
                       ResponseCollection.new(travis, result)
                     rescue JSON::ParserError
                       response.error!

data/lib/trav3/response/response_collection.rb

@@ -3,7 +3,7 @@
 module Trav3
   class ResponseCollection
     extend Forwardable
-    def_delegators :@collection, :count, :keys, :values, :has_key?, :key?
+    def_delegators :@collection, :count, :keys, :values, :has_key?, :key?, :empty?
     def initialize(travis, collection)
       @travis = travis
       @collection = collection

data/lib/trav3/rest.rb

@@ -6,8 +6,9 @@ require 'json'
 
 module Trav3
   module REST
+    extend Net
     class << self
-      def create(travis, url, **data)
+      def create(travis, url, data)
         uri = as_uri url
         req = request_post uri
         set_headers travis, req
@@ -64,13 +65,13 @@ module Trav3
       end
 
       def get_response(uri, request)
-        http = Net::HTTP.new(uri.host, uri.port)
+        http = HTTP.new(uri.host, uri.port)
         http.use_ssl = (uri.scheme == 'https')
         http.request(request)
       end
 
       def output(travis, response)
-        if [Net::HTTPAccepted, Net::HTTPOK].include? response.code_type
+        if [HTTPAccepted, HTTPOK, HTTPCreated, HTTPNoContent].include? response.code_type
           Success.new(travis, response)
         else
           RequestError.new(travis, response)
@@ -78,19 +79,19 @@ module Trav3
       end
 
       def request_delete(uri)
-        Net::HTTP::Delete.new(uri.request_uri)
+        HTTP::Delete.new(uri.request_uri)
       end
 
       def request_get(uri)
-        Net::HTTP::Get.new(uri.request_uri)
+        HTTP::Get.new(uri.request_uri)
       end
 
       def request_patch(uri)
-        Net::HTTP::Patch.new(uri.request_uri)
+        HTTP::Patch.new(uri.request_uri)
       end
 
       def request_post(uri)
-        Net::HTTP::Post.new(uri.request_uri)
+        HTTP::Post.new(uri.request_uri)
       end
 
       def set_headers(travis, request)

data/lib/trav3/version.rb

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

metadata

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