trav3 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5b7f9b00d0891a4baef42f3001d0d213e3fabc8a12c04d1d9c011ff3be1c55e
-  data.tar.gz: c4236a392320c3e7e54cae05dfb8cf16ae32d3f32fe102d8725ae74fe887abd5
+  metadata.gz: ec72696776f9747858b7651d1995adae3f75846de1078f79d166dceb9cebd3aa
+  data.tar.gz: 2640ff730d6fe51bd4898f1f62690a24b48230dea7e03c6eda122a358fb66c62
 SHA512:
-  metadata.gz: f99540fcc00032b646f42c371e7a72c27b93b20ecbaf533f2ae87ded0baaea75eb99ee94a8edabd043bd4ea08fbccb4c08dcaffc007418d23afc3c735cf5c5f1
-  data.tar.gz: 0256075e0a45c631429ef676c5a730b888001c5266aee7216abba0c6f27ecb8934f980fc0fbe41156aa1e7c72bdd796cf65a3f98d2776bedf17ee1a524d8f562
+  metadata.gz: 3cb082ad8b24ca68f5e03c76a92de944e61dfe46fcf66f631cfc5cf4c6ed4b6f2e5613021a09628e8ff0f9af95cf614cdc9d076b78424b6ce876a5a019bb02ca
+  data.tar.gz: a5a282d39eeaa1d12e14179a91d53ee49396ed04e55fa65153468fa2fc8defead7fd3f085d9dda510d9d324e5f9431db07e2fb8d2e9dc5b592097a1ff47ea72f

data/.travis.yml

@@ -17,6 +17,7 @@ before_script:
 script:
   - bundle exec rake
   - bundle exec rubocop
+  - bundle exec yard | if grep warn; then exit 1; else exit 0; fi
 
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -12,4 +12,5 @@ group :test do
   gem 'simplecov', require: false
   gem 'vcr', '~> 4.0'
   gem 'webmock', '~> 3.5'
+  gem 'yard', require: false
 end

data/README.md

@@ -2,7 +2,7 @@
 [![Build Status](https://travis-ci.org/danielpclark/trav3.svg?branch=master)](https://travis-ci.org/danielpclark/trav3)
 [![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)](https://www.rubydoc.info/github/danielpclark/trav3/0af161/Trav3/Travis)
+[![Red The Docs](https://img.shields.io/badge/Read-the%20docs-blue.svg)](http://danielpclark.github.io/trav3/Trav3/Travis.html)
 [![SayThanks.io](https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg)](https://saythanks.io/to/danielpclark)
 
 # Trav3

data/lib/trav3.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ClassLength
 require 'trav3/version'
 require 'trav3/pagination'
 require 'trav3/options'
@@ -21,7 +22,6 @@ module Trav3
   #   @return [Options] Request options object
   # @!attribute [r] headers
   #   @return [Headers] Request headers object
-  # rubocop:disable Metrics/ClassLength
   class Travis
     API_ENDPOINT = API_ROOT
     attr_reader :api_endpoint
@@ -133,7 +133,7 @@ module Trav3
     #
     #     Example:GET /repo/rails%2Frails/branch/master
     #
-    # @param id [String] the branch name for the current repository
+    # @param name [String] the branch name for the current repository
     # @return [Success, RequestError]
     def branch(name)
       get("#{with_repo}/branch/#{name}#{opts}")
@@ -1173,6 +1173,52 @@ module Trav3
       end
     end
 
+    # A list of stages.
+    #
+    # Currently this is nested within a build.
+    #
+    # ## Attributes
+    #
+    #     Name    Type     Description
+    #     stages  [Stage]  List of stages.
+    #
+    # **Collection Items**
+    #
+    # Each entry in the stages array has the following attributes:
+    #
+    #     Name         Type     Description
+    #     id           Integer  Value uniquely identifying the stage.
+    #     number       Integer  Incremental number for a stage.
+    #     name         String   The name of the stage.
+    #     state        String   Current state of the stage.
+    #     started_at   String   When the stage started.
+    #     finished_at  String   When the stage finished.
+    #     jobs         [Job]    The jobs of a stage.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # This returns a list of stages belonging to an individual build.
+    #
+    # GET <code>/build/{build.id}/stages</code>
+    #
+    #     Template Variable  Type     Description
+    #     build.id           Integer  Value uniquely identifying the build.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    #     Example:GET /build/86601346/stages
+    #
+    # @param build_id [String, Integer] build id
+    # @raise [TypeError] if given build id is not a number
+    # @return [Success, RequestError]
+    def stages(build_id)
+      raise TypeError, 'Integer expected for build id' unless /^\d+$/.match? build_id.to_s
+
+      get("#{without_repo}/build/#{build_id}/stages")
+    end
+
     # An individual user.
     #
     # ## Attributes
@@ -1307,5 +1353,5 @@ module Trav3
       api_endpoint
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end
+# rubocop:enable Metrics/ClassLength

data/lib/trav3/get.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/MethodLength
 require 'net/http'
 require 'uri'
 require 'json'
 
 module Trav3
   module GET
-    # rubocop:disable Metrics/MethodLength
     def self.call(travis, url, raw_reply = false)
       uri = URI(url)
       req = Net::HTTP::Get.new(uri.request_uri)
@@ -25,6 +25,6 @@ module Trav3
         RequestError.new(travis, response)
       end
     end
-    # rubocop:enable Metrics/MethodLength
   end
 end
+# rubocop:enable Metrics/MethodLength

data/lib/trav3/options.rb

@@ -26,13 +26,10 @@ module Trav3
     def remove(key)
       return_value = nil
 
-      @opts = @opts.keep_if do |item, value|
-        if entry_match?(key, item)
-          return_value = value
-          false
-        else
-          true
-        end
+      @opts = @opts.delete_if do |item|
+        head, tail = split.call item
+
+        return_value = tail if head == key.to_s
       end
 
       return_value
@@ -55,13 +52,13 @@ module Trav3
     end
 
     def to_h
-      @opts.map { |item| item.split('=') }.to_h
+      @opts.map(&split).to_h
     end
 
     private
 
-    def entry_match?(entry, item)
-      /^#{entry}=/.match? item.to_s
+    def split
+      ->(entry) { entry.split('=') }
     end
   end
 end

data/lib/trav3/post.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/MethodLength
 require 'net/http'
 require 'uri'
 require 'json'
 
 module Trav3
   module POST
-    # rubocop:disable Metrics/MethodLength
     def self.call(travis, url, **fields)
       uri = URI( url.sub(/\?.*$/, '') )
       req = Net::HTTP::Post.new(uri.request_uri)
@@ -26,6 +26,6 @@ module Trav3
         RequestError.new(travis, response)
       end
     end
-    # rubocop:enable Metrics/MethodLength
   end
 end
+# rubocop:enable Metrics/MethodLength

data/lib/trav3/version.rb

@@ -1,3 +1,3 @@
 module Trav3
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trav3
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel P. Clark