trav3 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97c7a3e7bbfb1ec5effd12bf275cf1e0bff1e39ed6676531648fb77c8ea329b4
-  data.tar.gz: '0683ce386cf9c469fb9f404321cb9de550141106a70dd4f12454d51f5ace73ed'
+  metadata.gz: 1c8f0f2a7f7113828e1f3099a0fb788f72edc9d884d24e3c78eb7a783b19bf51
+  data.tar.gz: 43dcf547f4ac6c76c41dd22c761b68f8bfd955eee2d03add7b490eae22e5ca67
 SHA512:
-  metadata.gz: 4c0c20dead40f8acff9ba0002e0e87b11fea7f8451ef425b4fff3d27a29cc5896484c6fc0297a757ab525cf1964d625492fdc85cc11162dcb3ef069b7675e7ba
-  data.tar.gz: 4dab80633ae6036f7574e92fc599db46e669627b9812fea3464f4689909c1872a230770f14c4acef3d606ed79c604bb86902d97253327578d2485ee6e02f8a92
+  metadata.gz: 953961e841c122143f2943baf20364dfbff7ee2e6d7d3620b1dd347508eef73a2639199f730c1f1aa49b73255c979c5092bc038bb1e69c0ca5086c0faef332fa
+  data.tar.gz: caf9a299840303e51b18d91185e2f210b9cf4b8a3a01adc92b1e1b7013c3fab7000a810594c075998d503b9073cd1e0a6a4878a1bc88c5c6ccb612f148a8928e

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

@@ -37,12 +37,12 @@ module Trav3
 
       initial_defaults
     end
+    # rubocop:disable Lint/Void
 
     # Set as the API endpoint
     #
     # @param endpoint [String] name for value to set
     # @return [self]
-    # rubocop:disable Lint/Void
     def api_endpoint=(endpoint)
       validate_api_endpoint endpoint
 
@@ -50,7 +50,16 @@ module Trav3
 
       self
     end
-    # rubocop:enable Lint/Void
+
+    # Set the authorization token in the requests' headers
+    #
+    # @param token [String] sets authorization token header
+    # @return [self]
+    def authorization=(token)
+      validate_string token
+      h('Authorization': "token #{token}")
+      self
+    end
 
     # Set as many options as you'd like for collections queried via an API request
     #
@@ -79,10 +88,13 @@ module Trav3
     # Change the repository this instance of `Trav3::Travis` uses.
     #
     # @param repo_name [String] github_username/repository_name
+    # @return [self]
     def repository=(repo_name)
       validate_repo_format repo_name
       @repo = sanitize_repo_name repo_name
+      self
     end
+    # rubocop:enable Lint/Void
 
     # 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.
     #
@@ -111,7 +123,7 @@ module Trav3
     # GET <code>/owner/{user.login}/active</code>
     #
     #     Template Variable  Type    Description
-    #     user.login         String  Login set on Github.
+    #     user.login         String  Login set on GitHub.
     #     Query Parameter  Type      Description
     #     include          [String]  List of attributes to eager load.
     #
@@ -138,11 +150,8 @@ module Trav3
     # @param owner [String] username, organization name, or github id
     # @return [Success, RequestError]
     def active(owner = username)
-      if number? owner
-        get("#{without_repo}/owner/github_id/#{owner}/active")
-      else
-        get("#{without_repo}/owner/#{owner}/active")
-      end
+      number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/active")
+      get("#{without_repo}/owner/#{owner}/active")
     end
 
     # The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
@@ -354,7 +363,7 @@ module Trav3
     #
     #     Example: POST /build/86601346/restart
     #
-    # @note POST requests require an authorization token set in the headers. See: {h}
+    # @note POST requests require an authorization token set in the headers. See: {authorization=}
     #
     # @param build_id [String, Integer] the build id number
     # @param option [Symbol] options for :cancel or :restart
@@ -644,16 +653,262 @@ module Trav3
     #
     #     Example: DELETE /repo/rails%2Frails/caches
     #
-    # @note DELETE requests require an authorization token set in the headers. See: {h}
+    # @note DELETE requests require an authorization token set in the headers. See: {authorization=}
     #
     # @param delete [Boolean] option for deleting cache(s)
     # @return [Success, RequestError]
     def caches(delete = false)
-      if delete
-        without_limit { delete("#{with_repo}/caches#{opts}") }
-      else
-        get("#{with_repo}/caches")
+      delete and return without_limit { delete("#{with_repo}/caches#{opts}") }
+      get("#{with_repo}/caches")
+    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.**
+    #
+    # ## 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
+    #     id      String   The environment variable id.
+    #     name    String   The environment variable name, e.g. FOO.
+    #     value   String   The environment variable's value, e.g. bar.
+    #     public  Boolean  Whether this environment variable should be publicly visible or not.
+    #
+    # **Minimal Representation**
+    #
+    # Included when the resource is returned as part of another resource.
+    #
+    #     Name    Type     Description
+    #     id      String   The environment variable id.
+    #     name    String   The environment variable name, e.g. FOO.
+    #     public  Boolean  Whether this environment variable should be publicly visible or not.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # This returns a single environment variable. It is possible to use the repository id or slug in the request.
+    #
+    # GET <code>/repo/{repository.id}/env_var/{env_var.id}</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     env_var.id         String   The environment variable id.
+    #     Query Parameter  Type      Description
+    #     env_var.id       String    The environment variable id.
+    #     id               String    Alias for env_var.id.
+    #     include          [String]  List of attributes to eager load.
+    #     repository.id    Integer   Value uniquely identifying the repository.
+    #
+    # GET <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     env_var.id         String  The environment variable id.
+    #     Query Parameter  Type      Description
+    #     env_var.id       String    The environment variable id.
+    #     id               String    Alias for env_var.id.
+    #     include          [String]  List of attributes to eager load.
+    #     repository.id    Integer   Value uniquely identifying the repository.
+    #
+    # **Update**
+    #
+    # This updates a single environment variable. It is possible to use the repository id or slug in the request.
+    #
+    # Use namespaced params in the request body to pass the new environment variable:
+    #
+    # ```bash
+    # curl -X PATCH \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   -d '{ "env_var.value": "bar", "env_var.public": false }' \
+    #   https://api.travis-ci.com/repo/1234/{env_var.id}
+    # ```
+    #
+    # PATCH <code>/repo/{repository.id}/env_var/{env_var.id}</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     env_var.id         String   The environment variable id.
+    #     Accepted Parameter  Type     Description
+    #     env_var.name        String   The environment variable name, e.g. FOO.
+    #     env_var.value       String   The environment variable's value, e.g. bar.
+    #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
+    #
+    # PATCH <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     env_var.id         String  The environment variable id.
+    #     Accepted Parameter  Type     Description
+    #     env_var.name        String   The environment variable name, e.g. FOO.
+    #     env_var.value       String   The environment variable's value, e.g. bar.
+    #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
+    #
+    # **Delete**
+    #
+    # This deletes a single environment variable. It is possible to use the repository id or slug in the request.
+    #
+    # DELETE <code>/repo/{repository.id}/env_var/{env_var.id}</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     env_var.id         String   The environment variable id.
+    #
+    # DELETE <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     env_var.id         String  The environment variable id.
+    #
+    # @overload env_var(env_var_id)
+    #   Gets current env var
+    #   @param env_var_id [String] environment variable id
+    # @overload env_var(env_var_id, action: params)
+    #   Performs action per specific key word argument
+    #   @param env_var_id [String] environment variable id
+    #   @param update [Hash] Optional keyword argument. Update key pair with hash `{ value: "new value" }`
+    #   @param delete [Boolean] Optional keyword argument. Use truthy value to delete current key pair
+    # @return [Success, RequestError]
+    def env_var(env_var_id, update: nil, delete: nil)
+      raise 'Too many options specified' unless [update, delete].compact.count < 2
+
+      validate_string env_var_id
+
+      update and return patch("#{with_repo}/env_var/#{env_var_id}", env_var_keys(update))
+      delete and return delete("#{with_repo}/env_var/#{env_var_id}")
+      get("#{with_repo}/env_var/#{env_var_id}")
+    end
+
+    # A list of environment variables.
+    #
+    # **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
+    #     env_vars  [Env var]  List of env_vars.
+    #
+    # ## Actions
+    #
+    # **For Repository**
+    #
+    # This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.
+    #
+    # GET <code>/repo/{repository.id}/env_vars</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/env_vars
+    #
+    # GET <code>/repo/{repository.slug}/env_vars</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/env_vars
+    #
+    # **Create**
+    #
+    # This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.
+    #
+    # Use namespaced params in the request body to pass the new environment variables:
+    #
+    # ```bash
+    # curl -X POST \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   -d '{ "env_var.name": "FOO", "env_var.value": "bar", "env_var.public": false }' \
+    #   https://api.travis-ci.com/repo/1234/env_vars
+    # ```
+    #
+    # POST <code>/repo/{repository.id}/env_vars</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     Accepted Parameter  Type     Description
+    #     env_var.name        String   The environment variable name, e.g. FOO.
+    #     env_var.value       String   The environment variable's value, e.g. bar.
+    #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
+    #
+    #     Example: POST /repo/891/env_vars
+    #
+    # POST <code>/repo/{repository.slug}/env_vars</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     Accepted Parameter  Type     Description
+    #     env_var.name        String   The environment variable name, e.g. FOO.
+    #     env_var.value       String   The environment variable's value, e.g. bar.
+    #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
+    #
+    #     Example: POST /repo/rails%2Frails/env_vars
+    #
+    # @note requests require an authorization token set in the headers. See: {authorization=}
+    #
+    # @param create [Hash] Optional argument.  A hash of the `name`, `value`, and `public` visibleness for a env var to create
+    # @return [Success, RequestError]
+    def env_vars(create = nil)
+      if create
+        validate_env_var create
+
+        return create("#{with_repo}/env_vars", env_var_keys(create))
       end
+
+      get("#{with_repo}/env_vars")
+    end
+
+    # A GitHub App installation.
+    #
+    # ## Attributes
+    #
+    # **Minimal Representation**
+    #
+    # Included when the resource is returned as part of another resource.
+    #
+    #     Name       Type     Description
+    #     id         Integer  The installation id.
+    #     github_id  Integer  The installation's id on GitHub.
+    #
+    # **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  The installation id.
+    #     github_id  Integer  The installation's id on GitHub.
+    #     owner      Owner    GitHub user or organization the installation belongs to.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # This returns a single installation.
+    #
+    # GET <code>/installation/{installation.github_id}</code>
+    #
+    #     Template Variable       Type     Description
+    #     installation.github_id  Integer  The installation's id on GitHub.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    # @param installation_id [String, Integer] GitHub App installation id
+    # @return [Success, RequestError]
+    def installation(installation_id)
+      validate_number installation_id
+
+      get("#{without_repo}/installation/#{installation_id}")
     end
 
     # An individual job.
@@ -736,7 +991,7 @@ module Trav3
     #
     #     Example: POST /job/86601347/debug
     #
-    # @note POST requests require an authorization token set in the headers. See: {h}
+    # @note POST requests require an authorization token set in the headers. See: {authorization=}
     #
     # @param job_id [String, Integer] the job id number
     # @param option [Symbol] options for :cancel, :restart, or :debug
@@ -886,16 +1141,16 @@ module Trav3
     #
     #     Example: DELETE /repo/rails%2Frails/key_pair
     #
-    # @note requests require an authorization token set in the headers. See: {h}
+    # @note requests require an authorization token set in the headers. See: {authorization=}
     # @note API enpoint needs to be set to `https://api.travis-ci.com` See: {api_endpoint=}
     #
-    # @overload key_par()
+    # @overload key_pair()
     #   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
+    #   @param create [Hash] Optional keyword argument.  Create a new key pair from provided private key `{ description: "name", value: "private key" }`
+    #   @param update [Hash] Optional keyword argument.  Update key pair with hash `{ description: "new name" }`
+    #   @param delete [Boolean] Optional keyword argument.  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
@@ -972,7 +1227,7 @@ module Trav3
     #
     #     Example: POST /repo/rails%2Frails/key_pair/generated
     #
-    # @note requests require an authorization token set in the headers. See: {h}
+    # @note requests require an authorization token set in the headers. See: {authorization=}
     #
     # @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]
@@ -1300,7 +1555,7 @@ module Trav3
     # GET <code>/owner/{user.login}</code>
     #
     #     Template Variable  Type      Description
-    #     user.login         String    Login set on Github.
+    #     user.login         String    Login set on GitHub.
     #
     #     Query Parameter    Type      Description
     #     include            [String]  List of attributes to eager load.
@@ -1330,11 +1585,8 @@ module Trav3
     # @param owner [String] username or github id
     # @return [Success, RequestError]
     def owner(owner = username)
-      if number? owner
-        get("#{without_repo}/owner/github_id/#{owner}")
-      else
-        get("#{without_repo}/owner/#{owner}")
-      end
+      number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}")
+      get("#{without_repo}/owner/#{owner}")
     end
 
     # Document `resources/preference/overview` not found.
@@ -1401,7 +1653,7 @@ 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}
+    # @note requests require an authorization token set in the headers. See: {authorization=}
     #
     # @param key [String] preference name to get or set
     # @param value [String] optional value to set preference
@@ -1413,11 +1665,8 @@ module Trav3
         org_id = "/org/#{org_id}"
       end
 
-      if value.nil?
-        get("#{without_repo}#{org_id}/preference/#{key}")
-      else
-        patch("#{without_repo}#{org_id}/preference/#{key}", 'preference.value' => value)
-      end
+      value and return patch("#{without_repo}#{org_id}/preference/#{key}", 'preference.value' => value)
+      get("#{without_repo}#{org_id}/preference/#{key}")
     end
 
     # Document `resources/preferences/overview` not found.
@@ -1453,7 +1702,7 @@ module Trav3
     #
     #     Example: GET /preferences
     #
-    # @note requests require an authorization token set in the headers. See: {h}
+    # @note requests require an authorization token set in the headers. See: {authorization=}
     #
     # @param org_id [String, Integer] optional organization id
     # @return [Success, RequestError]
@@ -1521,7 +1770,7 @@ module Trav3
     # GET <code>/owner/{user.login}/repos</code>
     #
     #     Template Variable  Type    Description
-    #     user.login         String  Login set on Github.
+    #     user.login         String  Login set on GitHub.
     #
     #     Query Parameter     Type       Description
     #     active              [Boolean]  Alias for repository.active.
@@ -1606,11 +1855,8 @@ module Trav3
     # @param owner [String] username or github id
     # @return [Success, RequestError]
     def repositories(owner = username)
-      if number? owner
-        get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
-      else
-        get("#{without_repo}/owner/#{owner}/repos#{opts}")
-      end
+      number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
+      get("#{without_repo}/owner/#{owner}/repos#{opts}")
     end
 
     # An individual repository.
@@ -1740,7 +1986,7 @@ module Trav3
     #
     #     Example: POST /repo/rails%2Frails/unstar
     #
-    # @note POST requests require an authorization token set in the headers. See: {h}
+    # @note POST requests require an authorization token set in the headers. See: {authorization=}
     #
     # @param repo [String] github_username/repository_name
     # @param action [String, Symbol] Optional argument for star/unstar/activate/deactivate
@@ -1751,13 +1997,9 @@ module Trav3
       validate_repo_format repo
 
       repo = sanitize_repo_name repo
-      action = '' unless %w[star unstar activate deactivate].include? action.to_s
 
-      if action.empty?
-        get("#{without_repo}/repo/#{repo}")
-      else
-        post("#{without_repo}/repo/#{repo}/#{action}")
-      end
+      action and return post("#{without_repo}/repo/#{repo}/#{action}")
+      get("#{without_repo}/repo/#{repo}")
     end
 
     # An individual request
@@ -2160,7 +2402,7 @@ module Trav3
     #
     #     Name  Type     Description
     #     id    Integer  Value uniquely identifying the user.
-    #     login String   Login set on Github.
+    #     login String   Login set on GitHub.
     #
     # **Standard Representation**
     #
@@ -2168,13 +2410,13 @@ module Trav3
     #
     #     Name              Type     Description
     #     id                Integer  Value uniquely identifying the user.
-    #     login             String   Login set on Github.
+    #     login             String   Login set on GitHub.
     #     name              String   Name set on GitHub.
     #     github_id         Integer  Id set on GitHub.
     #     avatar_url        String   Avatar URL set on GitHub.
     #     education         Boolean  Whether or not the user has an education account.
     #     allow_migration   Unknown  The user's allow_migration.
-    #     is_syncing        Boolean  Whether or not the user is currently being synced with Github.
+    #     is_syncing        Boolean  Whether or not the user is currently being synced with GitHub.
     #     synced_at         String   The last time the user was synced with GitHub.
     #
     # **Additional Attributes**
@@ -2222,10 +2464,10 @@ module Trav3
     #     Example: GET /user
     #
     # @note sync feature may not be permitted
-    # @note POST requests require an authorization token set in the headers. See: {h}
+    # @note POST requests require an authorization token set in the headers. See: {authorization=}
     #
     # @param user_id [String, Integer] optional user id
-    # @param sync [Boolean] optional argument for syncing your Travis CI account with Github
+    # @param sync [Boolean] optional argument for syncing your Travis CI account with GitHub
     # @raise [TypeError] if given user id is not a number
     # @return [Success, RequestError]
     def user(user_id = nil, sync = false)
@@ -2233,11 +2475,8 @@ module Trav3
 
       validate_number user_id
 
-      if sync
-        get("#{without_repo}/user/#{user_id}/sync")
-      else
-        get("#{without_repo}/user/#{user_id}")
-      end
+      sync and return get("#{without_repo}/user/#{user_id}/sync")
+      get("#{without_repo}/user/#{user_id}")
     end
 
     private # @private
@@ -2250,6 +2489,10 @@ module Trav3
       Trav3::REST.delete(self, url)
     end
 
+    def env_var_keys(hash)
+      inject_property_name('env_var', hash)
+    end
+
     def get(url, raw_reply = false)
       Trav3::REST.get(self, url, raw_reply)
     end
@@ -2273,8 +2516,12 @@ module Trav3
       h('Travis-API-Version': 3)
     end
 
+    def inject_property_name(name, hash)
+      hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/#{name}\.\w+/)
+    end
+
     def key_pair_keys(hash)
-      hash.map { |k, v| ["key_pair.#{k}", v] }.to_h unless hash.keys.first.match?(/key_pair\.\w+/)
+      inject_property_name('key_pair', hash)
     end
 
     def number?(input)
@@ -2297,6 +2544,21 @@ module Trav3
       raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? input
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def validate_env_var(input)
+      raise TypeError, "Hash expected, #{input.class} given" unless input.is_a? Hash
+      raise EnvVarError unless input.all? do |k, v|
+        k.match?(/name|value|public/) &&
+        case k.to_s
+        when /name/ then v.is_a? String
+        when /value/ then v.is_a? String
+        when /public/ then [true, false].include? v
+        else false
+        end
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+
     def validate_number(input)
       raise TypeError, "Integer expected, #{input.class} given" unless number? input
     end

data/lib/trav3/error/env_var_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trav3
+  class EnvVarError < StandardError
+    def message
+      "You must provide the keys `name`, `value`, and `public`\
+      where name and value are given String values and public is a Boolean."
+    end
+  end
+end

data/lib/trav3/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trav3
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Daniel P. Clark
@@ -86,6 +86,7 @@ files:
 - bin/console
 - bin/setup
 - lib/trav3.rb
+- lib/trav3/error/env_var_error.rb
 - lib/trav3/error/invalid_api_endpoint.rb
 - lib/trav3/error/invalid_repository.rb
 - lib/trav3/error/unimplemented.rb