trav3 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c296d42d106927366d13fb6e1f35fc684a70c7dc75f1d9f9c0e78d2eb0cfa892
-  data.tar.gz: 6a11b0d89c2d16e6ff7d7b20717f08e3c1f06133d5b8018a06bc81acf50e951c
+  metadata.gz: 93d77ee47c7ed5e7c1f75e2acd89a0e54fb535a43f3d733e34846dc978221215
+  data.tar.gz: c4dd8fbb0fbdc9f49da8813658034fd4d267e2fed16fabc74bcf545b348df6dd
 SHA512:
-  metadata.gz: 9bbcb15fa5788684920be24d4fb0daf526ca79e4b44bb5401d36c622622fc9a89c544b6f6cd45c8d68dbda53641d0edbf3996f76eaf489c9727194c29499af90
-  data.tar.gz: 28eabbd1ef143bde815187a83d4aed45a419aae6d87a66c729bfe7e907a915ce657dfccc72764959d6c8e4d60ad5306d4c6d75cf4ac12b2f3ba6c4574d0dc629
+  metadata.gz: ecd602f45589d107c1c8b34389edb61b2b5b6b10e1849cc7fd867bd877e31ae2fe2dae5973e487c0e2b69814c9150d3030adcf3bd7c8b74220143b87cec22f9b
+  data.tar.gz: ff47d0c65e5b74e3992132b686d04eb539d384127485228533413992ac83214acad961dec1aba6000921d143360b6ac5b7fcea4cc5712ef40035e65cd3cf16e1

data/.rubocop.yml

@@ -2623,7 +2623,7 @@ Style/ExpandPathArguments:
   Enabled: true
   VersionAdded: '0.53'
 
-Style/FlipFlop:
+Lint/FlipFlop:
   Description: 'Checks for flip-flops'
   StyleGuide: '#no-flip-flops'
   Enabled: true
@@ -3790,12 +3790,12 @@ Style/YodaCondition:
   Description: 'Do not use literals as the first operand of a comparison.'
   Reference: 'https://en.wikipedia.org/wiki/Yoda_conditions'
   Enabled: true
-  EnforcedStyle: all_comparison_operators
+  EnforcedStyle: forbid_for_all_comparison_operators
   SupportedStyles:
-    # check all comparison operators
-    - all_comparison_operators
-    # check only equality operators: `!=` and `==`
-    - equality_operators_only
+    - forbid_for_all_comparison_operators
+    - forbid_for_equality_operators_only
+    - require_for_all_comparison_operators
+    - require_for_equality_operators_only
   VersionAdded: '0.49'
   VersionChanged: '0.50'
 

data/Gemfile

@@ -10,7 +10,7 @@ gemspec
 group :test do
   gem 'byebug'
   gem 'codeclimate-test-reporter', '~> 1.0.0'
-  gem 'rubocop', require: false
+  gem 'rubocop', '0.63.0', require: false
   gem 'simplecov', require: false
   gem 'vcr', '~> 4.0'
   gem 'webmock', '~> 3.5'

data/lib/trav3/pagination.rb

@@ -24,7 +24,7 @@ module Trav3
     end
 
     def get(url)
-      Trav3::GET.call(travis, url)
+      Trav3::REST.get(travis, url)
     end
     private :get
 

data/lib/trav3/{delete.rb → rest/delete.rb}

@@ -5,8 +5,8 @@ require 'net/http'
 require 'uri'
 
 module Trav3
-  module DELETE
-    def self.call(travis, url)
+  module REST
+    def self.delete(travis, url)
       uri = URI( url.sub(/\?.*$/, '') )
       req = Net::HTTP::Delete.new(uri.request_uri)
       travis.headers.each_pair do |header, value|

data/lib/trav3/{get.rb → rest/get.rb}

@@ -5,8 +5,8 @@ require 'net/http'
 require 'uri'
 
 module Trav3
-  module GET
-    def self.call(travis, url, raw_reply = false)
+  module REST
+    def self.get(travis, url, raw_reply = false)
       uri = URI(url)
       req = Net::HTTP::Get.new(uri.request_uri)
       travis.headers.each_pair do |header, value|

data/lib/trav3/rest/patch.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.patch(travis, url, data = {})
+      uri = URI( url.sub(/\?.*$/, '') )
+      req = Net::HTTP::Patch.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/{post.rb → rest/post.rb}

@@ -5,8 +5,8 @@ require 'net/http'
 require 'uri'
 
 module Trav3
-  module POST
-    def self.call(travis, url, **fields)
+  module REST
+    def self.post(travis, url, **fields)
       uri = URI( url.sub(/\?.*$/, '') )
       req = Net::HTTP::Post.new(uri.request_uri)
       travis.headers.each_pair do |header, value|

data/lib/trav3/rest.rb

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

data/lib/trav3/result.rb

@@ -37,7 +37,11 @@ module Trav3
     def initialize(travis, response)
       @travis = travis
       @response = response
-      @json = JSON.parse(response.body)
+      @json = begin
+                JSON.parse(response.body)
+              rescue JSON::ParserError
+                response.error!
+              end
     end
 
     def inspect

data/lib/trav3/version.rb

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

data/lib/trav3.rb

@@ -6,9 +6,7 @@ require 'trav3/pagination'
 require 'trav3/options'
 require 'trav3/headers'
 require 'trav3/result'
-require 'trav3/delete'
-require 'trav3/post'
-require 'trav3/get'
+require 'trav3/rest'
 
 # Trav3 project namespace
 module Trav3
@@ -79,6 +77,67 @@ module Trav3
       self
     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.
+    #
+    # ## Attributes
+    #
+    #     Name    Type    Description
+    #     builds  Builds  The active builds.
+    #
+    # ## Actions
+    #
+    # **For Owner**
+    #
+    # Returns a list of "active" builds for the owner.
+    #
+    # GET <code>/owner/{owner.login}/active</code>
+    #
+    #     Template Variable  Type    Description
+    #     owner.login        String  User or organization login set on GitHub.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    #     Example: GET /owner/danielpclark/active
+    #
+    # GET <code>/owner/{user.login}/active</code>
+    #
+    #     Template Variable  Type    Description
+    #     user.login         String  Login set on Github.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    #     Example: GET /owner/danielpclark/active
+    #
+    # GET <code>/owner/{organization.login}/active</code>
+    #
+    #     Template Variable   Type    Description
+    #     organization.login  String  Login set on GitHub.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    #     Example: GET /owner/travis-ci/active
+    #
+    # GET <code>/owner/github_id/{owner.github_id}/active</code>
+    #
+    #     Template Variable  Type     Description
+    #     owner.github_id    Integer  User or organization id set on GitHub.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    #     Example: GET /owner/github_id/639823/active
+    #
+    # @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
+    end
+
     # The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
     #
     # **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.**
@@ -122,7 +181,7 @@ module Trav3
     #     Query Parameter  Type      Description
     #     include          [String]  List of attributes to eager load.
     #
-    #     Example:GET /repo/891/branch/master
+    #     Example: GET /repo/891/branch/master
     #
     # GET <code>/repo/{repository.slug}/branch/{branch.name}</code>
     #
@@ -132,7 +191,7 @@ module Trav3
     #     Query Parameter  Type      Description
     #     include          [String]  List of attributes to eager load.
     #
-    #     Example:GET /repo/rails%2Frails/branch/master
+    #     Example: GET /repo/rails%2Frails/branch/master
     #
     # @param name [String] the branch name for the current repository
     # @return [Success, RequestError]
@@ -179,7 +238,7 @@ module Trav3
     #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
     #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
     #
-    #     Example:GET /repo/891/branches?limit=5&exists_on_github=true
+    #     Example: GET /repo/891/branches?limit=5&exists_on_github=true
     #
     # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
     # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
@@ -196,7 +255,7 @@ module Trav3
     #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
     #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
     #
-    #     Example:GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true
+    #     Example: GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true
     #
     # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
     # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
@@ -702,7 +761,7 @@ module Trav3
     #
     # POST <code>/lint</code>
     #
-    #     Example:POST /lint
+    #     Example: POST /lint
     #
     # @param yaml_content [String] the contents for the file `.travis.yml`
     # @return [Success, RequestError]
@@ -770,7 +829,7 @@ module Trav3
     #     include          [String]  List of attributes to eager load.
     #     log.token        Unknown   Documentation missing.
     #
-    #     Example:GET /job/86601347/log.txt
+    #     Example: GET /job/86601347/log.txt
     #
     # **Delete**
     #
@@ -848,7 +907,7 @@ module Trav3
     #     Query Parameter    Type      Description
     #     include            [String]  List of attributes to eager load.
     #
-    #     Example:GET /org/87
+    #     Example: GET /org/87
     #
     # @param org_id [String, Integer] the organization id
     # @raise [TypeError] if given organization id is not a number
@@ -897,7 +956,7 @@ module Trav3
     #     role               Unknown   Alias for organization.role.
     #     sort_by            [String]  Attributes to sort organizations by. Used for pagination.
     #
-    #     Example:GET /orgs?limit=5
+    #     Example: GET /orgs?limit=5
     #
     # **Sortable by:** <code>id</code>, <code>login</code>, <code>name</code>, <code>github_id</code>, append <code>:desc</code> to any attribute to reverse order.
     #
@@ -980,7 +1039,7 @@ module Trav3
     #
     #     Example: GET /owner/github_id/639823
     #
-    # @param owner [String] username or github ID
+    # @param owner [String] username or github id
     # @return [Success, RequestError]
     def owner(owner = username)
       if number? owner
@@ -1126,7 +1185,7 @@ 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.
     #
-    # @param owner [String] username or github ID
+    # @param owner [String] username or github id
     # @return [Success, RequestError]
     def repositories(owner = username)
       if number? owner
@@ -1318,7 +1377,7 @@ module Trav3
     #     Query Parameter  Type      Description
     #     include          [String]  List of attributes to eager load.
     #
-    #     Example:GET /build/86601346/stages
+    #     Example: GET /build/86601346/stages
     #
     # @param build_id [String, Integer] build id
     # @raise [TypeError] if given build id is not a number
@@ -1329,6 +1388,150 @@ module Trav3
       get("#{without_repo}/build/#{build_id}/stages")
     end
 
+    # An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify:
+    #
+    # * `builds_only_with_travis_yml` (boolean)
+    # * `build_pushes` (boolean)
+    # * `build_pull_requests` (boolean)
+    # * `maximum_number_of_builds` (integer)
+    # * `auto_cancel_pushes` (boolean)
+    # * `auto_cancel_pull_requests` (boolean)
+    #
+    # 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
+    #     name   String              The setting's name.
+    #     value  Boolean or integer  The setting's value.
+    #
+    # **Minimal Representation**
+    #
+    # Included when the resource is returned as part of another resource.
+    #
+    #   Name   Type                Description
+    #   name   String              The setting's name.
+    #   value  Boolean or integer  The setting's value.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # This returns a single setting. It is possible to use the repository id or slug in the request.
+    #
+    # GET <code>/repo/{repository.id}/setting/{setting.name}</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     setting.name       String   The setting's name.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    # GET <code>/repo/{repository.slug}/setting/{setting.name}</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     setting.name       String  The setting's name.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    # **Update**
+    #
+    # This updates a single setting. It is possible to use the repository id or slug in the request.
+    #
+    # Use namespaced params in the request body to pass the new setting:
+    #
+    # ```bash
+    # curl -X PATCH \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   -d '{ "setting.value": true }' \
+    #   https://api.travis-ci.com/repo/1234/setting/{setting.name}
+    # ```
+    #
+    # PATCH <code>/repo/{repository.id}/setting/{setting.name}</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     setting.name       String   The setting's name.
+    #     Accepted Parameter  Type                Description
+    #     setting.value       Boolean or integer  The setting's value.
+    #
+    # PATCH <code>/repo/{repository.slug}/setting/{setting.name}</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     setting.name       String  The setting's name.
+    #     Accepted Parameter  Type                Description
+    #     setting.value       Boolean or integer  The setting's value.
+    #
+    # @param name [String] the setting name for the current repository
+    # @param value [String] optional argument for setting a value for the setting name
+    # @return [Success, RequestError]
+    def setting(name, value = nil)
+      return get("#{with_repo}/setting/#{name}") if value.nil?
+
+      patch("#{with_repo}/setting/#{name}", 'setting.value' => value)
+    end
+
+    # A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently six different kinds of user settings:
+    #
+    # * `builds_only_with_travis_yml` (boolean)
+    # * `build_pushes` (boolean)
+    # * `build_pull_requests` (boolean)
+    # * `maximum_number_of_builds` (integer)
+    # * `auto_cancel_pushes` (boolean)
+    # * `auto_cancel_pull_requests` (boolean)
+    #
+    # 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
+    #     settings  [Setting]  List of settings.
+    #
+    # **Collection Items**
+    #
+    # Each entry in the settings array has the following attributes:
+    #
+    #     Name   Type                Description
+    #     name   String              The setting's name.
+    #     value  Boolean or integer  The setting's value.
+    #
+    # ## Actions
+    #
+    # **For Repository**
+    #
+    # This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.
+    #
+    # GET <code>/repo/{repository.id}/settings</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/settings
+    #
+    # GET <code>/repo/{repository.slug}/settings</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/settings
+    #
+    # @return [Success, RequestError]
+    def settings
+      get("#{with_repo}/settings")
+    end
+
     # An individual user.
     #
     # ## Attributes
@@ -1376,7 +1579,7 @@ module Trav3
     #     Query Parameter  Type      Description
     #     include          [String]  List of attributes to eager load.
     #
-    #     Example:GET /user/119240
+    #     Example: GET /user/119240
     #
     # **Sync**
     #
@@ -1387,7 +1590,7 @@ module Trav3
     #     Template Variable  Type     Description
     #     user.id            Integer  Value uniquely identifying the user.
     #
-    #     Example:POST /user/119240/sync
+    #     Example: POST /user/119240/sync
     #
     # **Current**
     #
@@ -1398,7 +1601,7 @@ module Trav3
     #     Query Parameter  Type      Description
     #     include          [String]  List of attributes to eager load.
     #
-    #     Example:GET /user
+    #     Example: GET /user
     #
     # @note sync feature may not be permitted
     # @note POST requests require an authorization token set in the headers. See: {h}
@@ -1422,11 +1625,11 @@ module Trav3
     private # @private
 
     def delete(url)
-      Trav3::DELETE.call(self, url)
+      Trav3::REST.delete(self, url)
     end
 
     def get(url, raw_reply = false)
-      Trav3::GET.call(self, url, raw_reply)
+      Trav3::REST.get(self, url, raw_reply)
     end
 
     def initial_defaults
@@ -1444,8 +1647,12 @@ module Trav3
       @options
     end
 
+    def patch(url, data)
+      Trav3::REST.patch(self, url, data)
+    end
+
     def post(url, fields = {})
-      Trav3::POST.call(self, url, fields)
+      Trav3::REST.post(self, url, fields)
     end
 
     def validate_api_endpoint(input)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trav3
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,12 +86,14 @@ files:
 - bin/console
 - bin/setup
 - lib/trav3.rb
-- lib/trav3/delete.rb
-- lib/trav3/get.rb
 - lib/trav3/headers.rb
 - lib/trav3/options.rb
 - lib/trav3/pagination.rb
-- lib/trav3/post.rb
+- lib/trav3/rest.rb
+- lib/trav3/rest/delete.rb
+- lib/trav3/rest/get.rb
+- lib/trav3/rest/patch.rb
+- lib/trav3/rest/post.rb
 - lib/trav3/result.rb
 - lib/trav3/version.rb
 - trav3.gemspec