trav3 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa4cd27e0c1a0343759dbcf4b96ababd0fcf179a99caa526b95e8e4b6fdf120e
-  data.tar.gz: 6b27403fca5fc20c3134b661b76e4747c60eb23973b6ee764468dc98ecf3d41b
+  metadata.gz: 83ffd60222c59e6dec4482f0dc8cf8f77084b6818522466ffc6459aa5609962a
+  data.tar.gz: 27bc3cd5c536d6b01214c722405f2fe443611041899cdcccb14cf1e555c04d29
 SHA512:
-  metadata.gz: 6ea902e6238e08d1708cd7f5f076cf1fca860c1ca82c0425d5a0e16b902f5771e641274c23daccf0f65b9fb38e2ba991c084528031e3053dce306fd8a627d781
-  data.tar.gz: 8fcf193c13837169146b79048c93cd38acd6435035543f35ed98e8e3e14aabca696382fb691323aac7ee529f376bbb32671fa8f2e9df2f8e0973f56eb8275ff2
+  metadata.gz: 99c350cc9fac49deacbfc369e04e3a671bf35e2ec4c2e015440091d929774701636131a71a78c13f783efe72ae613a0af57d0a06aa0b4c70467a681830464710
+  data.tar.gz: 6f765eff36c2ba82d592ee21e88bdf7609736f82b245893575a9f349b43db69f48962a6e21e0a0bb3f8b438e64f179b2c3ff9831899b86e90411d0d2480558d8

data/.gitignore

@@ -9,3 +9,4 @@
 **/*.swp
 /Gemfile.lock
 .byebug_history
+spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper --tty --color

data/.travis.yml

@@ -1,7 +1,20 @@
 language: ruby
+
 rvm:
-- 2.3.6
-- 2.4.3
-- 2.5.0
+- 2.4.5
+- 2.5.3
+- 2.6.0
+
 env:
-script: bundle exec rake test
+  global:
+    - CC_TEST_REPORTER_ID=bbc65a7f5858b221fbbb49617e4118dcce44703366ea64a49687214aed252cf3
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script: bundle exec rake
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -4,14 +4,11 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in trav3.gemspec
 gemspec
-group :test do
-  gem 'simplecov'
-  gem 'codeclimate-test-reporter', '~> 1.0.0'
-end
 
 group :test do
-  gem 'minitest', '~> 5.10'
-  gem 'minitest-reporters', '~> 1.1'
-  gem 'color_pound_spec_reporter', '~> 0.0.6'
+  gem 'simplecov', require: false, group: :test
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'webmock', '~> 3.5'
+  gem 'vcr', '~> 4.0'
+  gem 'byebug'
 end
-

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Daniel P. Clark
+Copyright (c) 2018-2019 Daniel P. Clark
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,8 @@
 [![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)
+[![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://www.rubydoc.info/github/danielpclark/trav3/master/Trav3/Travis)
 [![SayThanks.io](https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg)](https://saythanks.io/to/danielpclark)
 
 # Trav3

data/Rakefile

@@ -1,10 +1,10 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+  task :default => :spec
+rescue LoadError # no rspec available
+end

data/lib/trav3/get.rb

@@ -5,20 +5,22 @@ require 'json'
 
 module Trav3
   module GET
-    def self.call(url, headers = {})
+    def self.call(travis, url, raw_reply = false)
       uri = URI(url)
       req = Net::HTTP::Get.new(uri.request_uri)
-      headers.each_pair { |header, value|
+      travis.headers.each_pair { |header, value|
         req[header] = value
       }
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = (uri.scheme == "https")
       response = http.request(req)
 
-      if Net::HTTPOK == response.code_type
-        Success.new(response)
+      if raw_reply
+        response.body
+      elsif Net::HTTPOK == response.code_type
+        Success.new(travis, response)
       else
-        RequestError.new(response)
+        RequestError.new(travis, response)
       end
     end
   end

data/lib/trav3/headers.rb

@@ -15,6 +15,8 @@ module Trav3
       for (key, value) in args
         @heads[key] = value
       end
+
+      self
     end
 
     def remove(key)
@@ -24,6 +26,8 @@ module Trav3
     def +(other)
       raise ArgumentError, "Invalid type provided." unless other.is_a?(Headers)
       @heads.merge(other.instance_variable_get(:@heads))
+
+      self
     end
 
     def to_h

data/lib/trav3/options.rb

@@ -6,7 +6,7 @@ module Trav3
 
     def opts
       if @opts.empty?
-        ""
+        ''
       else
         "?#{@opts.join('&')}"
       end
@@ -19,6 +19,8 @@ module Trav3
         remove(key)
         @opts.push("#{key}=#{value}")
       end
+
+      self
     end
 
     def remove(key)
@@ -29,7 +31,10 @@ module Trav3
 
     def +(other)
       raise ArgumentError, "Invalid type provided." unless other.is_a?(Options)
+
       @opts += other.instance_variable_get(:@opts)
+
+      self
     end
 
     def to_s

data/lib/trav3/pagination.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 module Trav3
   class Pagination
-    def initialize(result)
+    def initialize(travis, result)
+      @travis = travis
       @result = result
     end
 
@@ -22,8 +23,11 @@ module Trav3
     end
 
     def get(x)
-      Trav3::GET.(x)
+      Trav3::GET.(travis, x)
     end
     private :get
+
+    attr_reader :travis
+    private :travis
   end
 end

data/lib/trav3/post.rb

@@ -5,21 +5,21 @@ require 'json'
 
 module Trav3
   module POST
-    def self.call(url, headers = {}, fields={})
+    def self.call(travis, url, fields={})
       uri = URI( url.sub(/\?.*$/, '') )
       req = Net::HTTP::Post.new(uri.request_uri)
-      headers.each_pair { |header, value|
+      travis.headers.each_pair { |header, value|
         req[header] = value
       }
-      req.set_form_data(**fields)
+      req.set_form_data(**fields) unless fields.empty?
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = (uri.scheme == "https")
       response = http.request(req)
-
-      if Net::HTTPOK == response.code_type
-        Success.new(response)
+      
+      if [Net::HTTPAccepted, Net::HTTPOK].include? response.code_type
+        Success.new(travis, response)
       else
-        RequestError.new(response)
+        RequestError.new(travis, response)
       end
     end
   end

data/lib/trav3/result.rb

@@ -10,21 +10,31 @@ module Trav3
     end
   end
 
+  class InvalidAPIEndpoint < StandardError
+    def message
+      "The API endpoint must be either
+      'https://api.travis-ci.com' or
+      'https://api.travis-ci.org'"
+    end
+  end
+
   class Unimplemented < StandardError
     def message
-      "You need to implement this method"
+      "This feature is not implemented."
     end
   end
 
   class Response
     extend Forwardable
+    attr_reader :travis
     def_delegators :@json, :[], :dig, :keys, :values, :has_key?
     def_delegators :@response, :code, :code_type, :uri, :message, :read_header,
                                :header, :value, :entity, :response, :body,
                                :decode_content, :msg, :reading_body, :read_body,
                                :http_version, :connection_close?, :connection_keep_alive?,
                                :initialize_http_header, :get_fields, :each_header
-    def initialize(response)
+    def initialize(travis, response)
+      @travis = travis
       @response = response
       @json = JSON.parse(response.body)
     end
@@ -35,11 +45,12 @@ module Trav3
 
     def success?; raise Unimplemented  end
     def failure?; raise Unimplemented  end
+    private :travis
   end
 
   class Success < Response
     def page
-      Trav3::Pagination.new(self)
+      Trav3::Pagination.new(travis, self)
     end
 
     def success?; true  end

data/lib/trav3/version.rb

@@ -1,3 +1,3 @@
 module Trav3
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/trav3.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'trav3/version'
+require 'trav3/pagination'
 require 'trav3/options'
 require 'trav3/headers'
 require 'trav3/result'
@@ -13,12 +14,15 @@ module Trav3
   # An abstraction for the Travis CI v3 API
   #
   # @author Daniel P. Clark https://6ftdan.com
+  # @!attribute [r] api_endpoint
+  #   @return [String] API endpoint
   # @!attribute [r] options
   #   @return [Options] Request options object
   # @!attribute [r] headers
   #   @return [Headers] Request headers object
   class Travis
     API_ENDPOINT = API_ROOT
+    attr_reader :api_endpoint
     attr_reader :options
     attr_reader :headers
 
@@ -30,9 +34,25 @@ module Trav3
       raise InvalidRepository unless repo.is_a?(String) and
         Regexp.new(/(^\d+$)|(^\w+(?:\/|%2F){1}\w+$)/) === repo
 
+      @api_endpoint = API_ENDPOINT
       @repo = repo.gsub(/\//, '%2F')
       defaults(limit: 25)
-      h("Travis-API-Version": 3)
+      h('Content-Type': 'application/json')
+      h('Accept': 'application/json')
+      h('Travis-API-Version': 3)
+    end
+
+    # @overload api_endpoint=(endpoint)
+    #   Set as the API endpoint
+    #   @param endpoint [String] name for value to set
+    # @return [self]
+    def api_endpoint= endpoint
+      if  /^https:\/\/api\.travis-ci\.(?:org|com)$/ === endpoint
+        @api_endpoint = endpoint
+      else
+        raise InvalidAPIEndpoint
+      end
+      self
     end
 
     # @overload defaults(key: value, ...)
@@ -135,7 +155,7 @@ module Trav3
     # @param owner [String] username or github ID
     # @return [Success, RequestError]
     def owner(owner = username)
-      if /^\d+$/ === owner
+      if /^\d+$/ === "#{owner}"
         get("#{self[]}/owner/github_id/#{owner}")
       else
         get("#{self[]}/owner/#{owner}")
@@ -281,7 +301,7 @@ module Trav3
     # @param owner [String] username or github ID
     # @return [Success, RequestError]
     def repositories(owner = username)
-      if /^\d+$/ === owner
+      if /^\d+$/ === "#{owner}"
         get("#{self[]}/owner/github_id/#{owner}/repos#{opts}")
       else
         get("#{self[]}/owner/#{owner}/repos#{opts}")
@@ -885,11 +905,11 @@ module Trav3
     #
     # @param id [String, Integer] the job id number
     # @param option [Symbol] options for :text or :delete
-    # @return [Success, RequestError]
+    # @return [Success, String, RequestError]
     def log(id, option = nil)
       case option
       when :text
-        get("#{self[]}/job/#{id}/log.txt")
+        get("#{self[]}/job/#{id}/log.txt", true)
       when :delete
         raise Unimplemented
       else
@@ -899,7 +919,7 @@ module Trav3
 
     private # @private
     def [](repository = false)
-      [API_ENDPOINT].tap {|a| a.push("repo/#{@repo}") if repository }.join('/')
+      [api_endpoint()].tap {|a| a.push("repo/#{@repo}") if repository }.join('/')
     end
 
     def repository_name
@@ -910,12 +930,12 @@ module Trav3
       @options
     end
 
-    def get(x)
-      Trav3::GET.(x, headers())
+    def get(x, raw_reply = false)
+      Trav3::GET.(self, x, raw_reply)
     end
 
     def post(x, fields = {})
-      Trav3::POST.(x, headers(), fields)
+      Trav3::POST.(self, x, fields)
     end
 
     def username

data/trav3.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "factory_bot", "~> 4.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trav3
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-25 00:00:00.000000000 Z
+date: 2019-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,19 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
 description: A Simple client abstraction for the Travis V3 API
 email:
 - 6ftdan@gmail.com
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - ".yardopts"
 - Gemfile
@@ -97,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.0
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Simple Travis V3 API Client