trav3 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec72696776f9747858b7651d1995adae3f75846de1078f79d166dceb9cebd3aa
-  data.tar.gz: 2640ff730d6fe51bd4898f1f62690a24b48230dea7e03c6eda122a358fb66c62
+  metadata.gz: c296d42d106927366d13fb6e1f35fc684a70c7dc75f1d9f9c0e78d2eb0cfa892
+  data.tar.gz: 6a11b0d89c2d16e6ff7d7b20717f08e3c1f06133d5b8018a06bc81acf50e951c
 SHA512:
-  metadata.gz: 3cb082ad8b24ca68f5e03c76a92de944e61dfe46fcf66f631cfc5cf4c6ed4b6f2e5613021a09628e8ff0f9af95cf614cdc9d076b78424b6ce876a5a019bb02ca
-  data.tar.gz: a5a282d39eeaa1d12e14179a91d53ee49396ed04e55fa65153468fa2fc8defead7fd3f085d9dda510d9d324e5f9431db07e2fb8d2e9dc5b592097a1ff47ea72f
+  metadata.gz: 9bbcb15fa5788684920be24d4fb0daf526ca79e4b44bb5401d36c622622fc9a89c544b6f6cd45c8d68dbda53641d0edbf3996f76eaf489c9727194c29499af90
+  data.tar.gz: 28eabbd1ef143bde815187a83d4aed45a419aae6d87a66c729bfe7e907a915ce657dfccc72764959d6c8e4d60ad5306d4c6d75cf4ac12b2f3ba6c4574d0dc629

data/.rubocop.yml

@@ -15,6 +15,7 @@ AllCops:
     - '**/Rakefile'
   Exclude:
     - '.git/**/*'
+    - 'vendor/**/*'
   # Default formatter will be used if no `-f/--format` option is given.
   DefaultFormatter: progress
   # Cop names are displayed in offense messages by default. Change behavior
@@ -78,7 +79,7 @@ AllCops:
   # is specified in the Gemfile or gems.rb file, RuboCop reads the final value
   # from the lock file.) If the Ruby version is still unresolved, RuboCop will
   # use the oldest officially supported Ruby version (currently Ruby 2.2).
-  TargetRubyVersion: ~
+  TargetRubyVersion: 2.3
 
 #################### Bundler ###############################
 

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 
 rvm:
 - 2.4.5

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'trav3'

data/lib/trav3/delete.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/MethodLength
+require 'net/http'
+require 'uri'
+
+module Trav3
+  module DELETE
+    def self.call(travis, url)
+      uri = URI( url.sub(/\?.*$/, '') )
+      req = Net::HTTP::Delete.new(uri.request_uri)
+      travis.headers.each_pair do |header, value|
+        req[header] = value
+      end
+      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/get.rb

@@ -3,7 +3,6 @@
 # rubocop:disable Metrics/MethodLength
 require 'net/http'
 require 'uri'
-require 'json'
 
 module Trav3
   module GET

data/lib/trav3/headers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Trav3

data/lib/trav3/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Trav3
   class Options
     def initialize(**args)
@@ -23,6 +25,22 @@ module Trav3
       self
     end
 
+    def fetch(key)
+      @opts.each do |item|
+        return item if key.to_s == split.call(item).first
+      end
+
+      raise KeyError, "key not found #{key}" unless block_given?
+
+      yield
+    end
+
+    def fetch!(key, &block)
+      result = fetch(key, &block)
+      remove(key)
+      result
+    end
+
     def remove(key)
       return_value = nil
 
@@ -37,6 +55,8 @@ module Trav3
 
     def reset!
       @opts = []
+
+      self
     end
 
     def +(other)

data/lib/trav3/post.rb

@@ -3,7 +3,6 @@
 # rubocop:disable Metrics/MethodLength
 require 'net/http'
 require 'uri'
-require 'json'
 
 module Trav3
   module POST

data/lib/trav3/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Trav3
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.3'
 end

data/lib/trav3.rb

@@ -6,12 +6,13 @@ require 'trav3/pagination'
 require 'trav3/options'
 require 'trav3/headers'
 require 'trav3/result'
+require 'trav3/delete'
 require 'trav3/post'
 require 'trav3/get'
 
 # Trav3 project namespace
 module Trav3
-  API_ROOT = 'https://api.travis-ci.org'.freeze
+  API_ROOT = 'https://api.travis-ci.org'
 
   # An abstraction for the Travis CI v3 API
   #
@@ -33,7 +34,7 @@ module Trav3
     #   conform to valid repository identifier format
     # @return [Travis]
     def initialize(repo)
-      raise InvalidRepository unless repo_slug_or_id? repo
+      validate_repo_format repo
 
       @api_endpoint = API_ENDPOINT
       @repo = sanitize_repo_name repo
@@ -47,7 +48,7 @@ module Trav3
     # @return [self]
     # rubocop:disable Lint/Void
     def api_endpoint=(endpoint)
-      raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? endpoint
+      validate_api_endpoint endpoint
 
       @api_endpoint = endpoint
 
@@ -136,7 +137,7 @@ module Trav3
     # @param name [String] the branch name for the current repository
     # @return [Success, RequestError]
     def branch(name)
-      get("#{with_repo}/branch/#{name}#{opts}")
+      get("#{with_repo}/branch/#{name}")
     end
 
     # A list of branches.
@@ -289,10 +290,21 @@ module Trav3
     #
     # @note POST requests require an authorization token set in the headers. See: {h}
     #
-    # @param id [String, Integer] the build id number
+    # @param build_id [String, Integer] the build id number
+    # @param option [Symbol] options for :cancel or :restart
+    # @raise [TypeError] if given build id is not a number
     # @return [Success, RequestError]
-    def build(id)
-      get("#{without_repo}/build/#{id}")
+    def build(build_id, option = nil)
+      validate_number build_id
+
+      case option
+      when :cancel
+        post("#{without_repo}/build/#{build_id}/cancel")
+      when :restart
+        post("#{without_repo}/build/#{build_id}/restart")
+      else
+        get("#{without_repo}/build/#{build_id}")
+      end
     end
 
     # A list of builds.
@@ -472,10 +484,109 @@ module Trav3
     # **Sortable by:** <code>id</code>, append <code>:desc</code> to any attribute to reverse order.
     # The default value is id:desc.
     #
-    # @param id [String, Integer] the build id number
+    # @param build_id [String, Integer] the build id number
+    # @return [Success, RequestError]
+    def build_jobs(build_id)
+      get("#{without_repo}/build/#{build_id}/jobs")
+    end
+
+    # A list of caches.
+    #
+    # 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
+    #     branch  String  The branch the cache belongs to.
+    #     match   String  The string to match against the cache name.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # This returns all the caches for a repository.
+    #
+    # It's possible to filter by branch or by regexp match of a string to the cache name.
+    #
+    # ```bash
+    # curl \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   https://api.travis-ci.com/repo/1234/caches?branch=master
+    # ```
+    #
+    # ```bash
+    # curl \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   https://api.travis-ci.com/repo/1234/caches?match=linux
+    # ```
+    #
+    # GET <code>/repo/{repository.id}/caches</code>
+    #
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #     Query Parameter  Type      Description
+    #     branch           [String]  Alias for caches.branch.
+    #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
+    #     caches.match     [String]  Filters caches by the string to match against the cache name.
+    #     include          [String]  List of attributes to eager load.
+    #     match            [String]  Alias for caches.match.
+    #
+    #     Example: GET /repo/891/caches
+    #
+    # GET <code>/repo/{repository.slug}/caches</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #     Query Parameter  Type      Description
+    #     branch           [String]  Alias for caches.branch.
+    #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
+    #     caches.match     [String]  Filters caches by the string to match against the cache name.
+    #     include          [String]  List of attributes to eager load.
+    #     match            [String]  Alias for caches.match.
+    #
+    #     Example: GET /repo/rails%2Frails/caches
+    #
+    # **Delete**
+    #
+    # This deletes all caches for a repository.
+    #
+    # As with `find` it's possible to delete by branch or by regexp match of a string to the cache name.
+    #
+    # ```bash
+    # curl -X DELETE \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   https://api.travis-ci.com/repo/1234/caches?branch=master
+    # ```
+    #
+    # DELETE <code>/repo/{repository.id}/caches</code>
+    #     Template Variable  Type     Description
+    #     repository.id      Integer  Value uniquely identifying the repository.
+    #
+    #     Example: DELETE /repo/891/caches
+    #
+    # DELETE <code>/repo/{repository.slug}/caches</code>
+    #
+    #     Template Variable  Type    Description
+    #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
+    #
+    #     Example: DELETE /repo/rails%2Frails/caches
+    #
+    # @note DELETE requests require an authorization token set in the headers. See: {h}
+    #
+    # @param delete [Boolean] option for deleting cache(s)
     # @return [Success, RequestError]
-    def build_jobs(id)
-      get("#{without_repo}/build/#{id}/jobs")
+    def caches(delete = false)
+      if delete
+        without_limit { delete("#{with_repo}/caches#{opts}") }
+      else
+        get("#{with_repo}/caches")
+      end
     end
 
     # An individual job.
@@ -560,19 +671,19 @@ module Trav3
     #
     # @note POST requests require an authorization token set in the headers. See: {h}
     #
-    # @param id [String, Integer] the job id number
+    # @param job_id [String, Integer] the job id number
     # @param option [Symbol] options for :cancel, :restart, or :debug
     # @return [Success, RequestError]
-    def job(id, option = nil)
+    def job(job_id, option = nil)
       case option
       when :cancel
-        post("#{without_repo}/job/#{id}/cancel")
+        post("#{without_repo}/job/#{job_id}/cancel")
       when :restart
-        post("#{without_repo}/job/#{id}/restart")
+        post("#{without_repo}/job/#{job_id}/restart")
       when :debug
-        post("#{without_repo}/job/#{id}/debug")
+        post("#{without_repo}/job/#{job_id}/debug")
       else
-        get("#{without_repo}/job/#{id}")
+        get("#{without_repo}/job/#{job_id}")
       end
     end
 
@@ -596,8 +707,7 @@ module Trav3
     # @param yaml_content [String] the contents for the file `.travis.yml`
     # @return [Success, RequestError]
     def lint(yaml_content)
-      raise TypeError, "String expected, #{yaml_content.class} given" unless \
-        yaml_content.is_a? String
+      validate_string yaml_content
 
       ct = headers.remove(:'Content-Type')
       result = post("#{without_repo}/lint", body: yaml_content)
@@ -680,17 +790,17 @@ module Trav3
     #
     # @note DELETE is unimplemented
     #
-    # @param id [String, Integer] the job id number
+    # @param job_id [String, Integer] the job id number
     # @param option [Symbol] options for :text or :delete
     # @return [Success, String, RequestError]
-    def log(id, option = nil)
+    def log(job_id, option = nil)
       case option
       when :text
-        get("#{without_repo}/job/#{id}/log.txt", true)
+        get("#{without_repo}/job/#{job_id}/log.txt", true)
       when :delete
         raise Unimplemented
       else
-        get("#{without_repo}/job/#{id}/log")
+        get("#{without_repo}/job/#{job_id}/log")
       end
     end
 
@@ -744,7 +854,7 @@ module Trav3
     # @raise [TypeError] if given organization id is not a number
     # @return [Success, RequestError]
     def organization(org_id)
-      raise TypeError, 'Integer expected for organization id' unless /^\d+$/.match? org_id.to_s
+      validate_number org_id
 
       get("#{without_repo}/org/#{org_id}")
     end
@@ -796,7 +906,7 @@ module Trav3
       get("#{without_repo}/orgs")
     end
 
-    # This will be either a user or organization.
+    # This will be either a {https://developer.travis-ci.com/resource/user user} or {https://developer.travis-ci.com/resource/organization organization}.
     #
     # ## Attributes
     #
@@ -810,7 +920,7 @@ module Trav3
     #
     # **Standard Representation**
     #
-    # Included when the resource is the main response of a request, or is eager loaded.
+    # 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 owner.
@@ -873,7 +983,7 @@ module Trav3
     # @param owner [String] username or github ID
     # @return [Success, RequestError]
     def owner(owner = username)
-      if /^\d+$/.match? owner.to_s
+      if number? owner
         get("#{without_repo}/owner/github_id/#{owner}")
       else
         get("#{without_repo}/owner/#{owner}")
@@ -1019,7 +1129,7 @@ module Trav3
     # @param owner [String] username or github ID
     # @return [Success, RequestError]
     def repositories(owner = username)
-      if /^\d+$/.match? owner.to_s
+      if number? owner
         get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
       else
         get("#{without_repo}/owner/#{owner}/repos#{opts}")
@@ -1161,7 +1271,7 @@ module Trav3
     #   conform to valid repository identifier format
     # @return [Success, RequestError]
     def repository(repo = repository_name, action = nil)
-      raise InvalidRepository unless repo_slug_or_id? repo
+      validate_repo_format repo
 
       repo = sanitize_repo_name repo
       action = '' unless %w[star unstar activate deavtivate].include? action.to_s
@@ -1214,7 +1324,7 @@ module Trav3
     # @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
+      validate_number build_id
 
       get("#{without_repo}/build/#{build_id}/stages")
     end
@@ -1299,7 +1409,8 @@ module Trav3
     # @return [Success, RequestError]
     def user(user_id = nil, sync = false)
       return get("#{without_repo}/user") if !user_id && !sync
-      raise TypeError, 'Integer expected for user id' unless /^\d+$/.match? user_id.to_s
+
+      validate_number user_id
 
       if sync
         get("#{without_repo}/user/#{user_id}/sync")
@@ -1310,6 +1421,10 @@ module Trav3
 
     private # @private
 
+    def delete(url)
+      Trav3::DELETE.call(self, url)
+    end
+
     def get(url, raw_reply = false)
       Trav3::GET.call(self, url, raw_reply)
     end
@@ -1321,6 +1436,10 @@ module Trav3
       h('Travis-API-Version': 3)
     end
 
+    def number?(input)
+      /^\d+$/.match? input.to_s
+    end
+
     def opts
       @options
     end
@@ -1329,8 +1448,24 @@ module Trav3
       Trav3::POST.call(self, url, fields)
     end
 
-    def repo_slug_or_id?(repo)
-      Regexp.new(/(^\d+$)|(^\w+(?:\/|%2F){1}\w+$)/).match? repo
+    def validate_api_endpoint(input)
+      raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? input
+    end
+
+    def validate_number(input)
+      raise TypeError, "Integer expected, #{input.class} given" unless number? input
+    end
+
+    def validate_repo_format(input)
+      raise InvalidRepository unless repo_slug_or_id? input
+    end
+
+    def validate_string(input)
+      raise TypeError, "String expected, #{input.class} given" unless input.is_a? String
+    end
+
+    def repo_slug_or_id?(input)
+      Regexp.new(/(^\d+$)|(^\w+(?:\/|%2F){1}\w+$)/).match? input
     end
 
     def repository_name
@@ -1352,6 +1487,13 @@ module Trav3
     def without_repo
       api_endpoint
     end
+
+    def without_limit
+      limit = opts.remove(:limit)
+      result = yield
+      opts.build(limit: limit) if limit
+      result
+    end
   end
 end
 # rubocop:enable Metrics/ClassLength

data/trav3.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'trav3/version'
@@ -23,7 +25,7 @@ Gem::Specification.new do |spec|
   # Generate YARD DOC on install
   spec.metadata['yard.run'] = 'yri'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '> 1.16'
   spec.add_development_dependency 'factory_bot', '~> 4.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.8'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trav3
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Daniel P. Clark
@@ -14,14 +14,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
@@ -86,6 +86,7 @@ files:
 - bin/console
 - bin/setup
 - lib/trav3.rb
+- lib/trav3/delete.rb
 - lib/trav3/get.rb
 - lib/trav3/headers.rb
 - lib/trav3/options.rb