circleci 1.1.0 → 2.0.0

data/lib/circleci.rb

@@ -6,6 +6,7 @@ require 'uri'
 
 files = %w[
   api_resource
+  api_project_resource
   build
   config
   project

data/lib/circleci/api_project_resource.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module CircleCi
+  ##
+  #
+  # Class for interacting with project API resources
+  class ApiProjectResource < ApiResource
+    VALID_VCS_TYPES = %w[github bitbucket].freeze
+    DEFAULT_VCS_TYPE = VALID_VCS_TYPES.first.freeze
+
+    attr_reader :build, :vcs_type
+
+    ##
+    #
+    # Initialize a new Project API interaction
+    #
+    # @param username [String] - The vcs username or org name for project
+    # @param project  [String] - The project name
+    # @param vcs_type [String] - The vcs type i.e. github or bitbucket
+    # @param build    [String] - The build number for a project
+    # @param conf     [CircleCi::Config] - Optional config to use for request
+    # @return         [CircleCi::Project]
+    def initialize(username = nil, project = nil, vcs_type = nil, build = nil, conf = nil)
+      super(username, project, conf)
+      @vcs_type = VALID_VCS_TYPES.include?(vcs_type) ? vcs_type : DEFAULT_VCS_TYPE
+      @build = build
+    end
+
+    def base_path
+      "/project/#{vcs_type}/#{username}/#{project}"
+    end
+  end
+end

data/lib/circleci/build.rb

@@ -3,104 +3,14 @@ module CircleCi
   ##
   #
   # Class for interacting with and managing builds
-  class Build < ApiResource
-    attr_reader :build
-    ##
-    #
-    # Initialize a Build object to interact with the Build API
-    #
-    # @param config   [CircleCi::Config] - Defaults to [default_config] if not provided
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @param build    [String] - Build ID
-    # @return         [CircleCi::Build] - A Build object
-    def initialize(username, project, build, conf = nil)
-      super(username, project, conf)
-      @build = build
-    end
-
-    ##
-    #
-    # Deprecated class methods
-    class << self
-      ##
-      #
-      # Get artifacts for a specific build of a project
-      #
-      # @deprecated Please use instance method of [CircleCi::Build] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param build    [String] - Build ID
-      # @return         [CircleCi::Response] - Response object
-      def artifacts(username, project, build)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Build#artifacts instead')
-        new(username, project, build, default_config).artifacts
-      end
-
-      ##
-      #
-      # Cancel a specific build
-      #
-      # @deprecated Please use instance method of [CircleCi::Build] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param build    [String] - Build ID
-      # @return         [CircleCi::Response] - Response object
-      def cancel(username, project, build)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Build#cancel instead')
-        new(username, project, build, default_config).cancel
-      end
-
-      ##
-      #
-      # Get a specific build for a project
-      #
-      # @deprecated Please use instance method of [CircleCi::Build] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param build    [String] - Build ID
-      # @return         [CircleCi::Response] - Response object
-      def get(username, project, build)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Build#get instead')
-        new(username, project, build, default_config).get
-      end
-
-      ##
-      #
-      # Kick off a retry of a specific build
-      #
-      # @deprecated Please use instance method of [CircleCi::Build] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param build    [String] - Build ID
-      # @return         [CircleCi::Response] - Response object
-      def retry(username, project, build)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Build#retry instead')
-        new(username, project, build, default_config).retry
-      end
-
-      ##
-      #
-      # Get tests for a specific build of a project
-      #
-      # @deprecated Please use instance method of [CircleCi::Build] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param build    [String] - Build ID
-      # @return         [CircleCi::Response] - Response object
-      def tests(username, project, build)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Build#tests instead')
-        new(username, project, build, default_config).tests
-      end
-    end
-
+  class Build < ApiProjectResource
     ##
     #
     # Get artifacts for a specific build of a project
     #
     # @return [CircleCi::Response] - Response object
     def artifacts
-      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}/artifacts").get
+      CircleCi.request(conf, "#{base_path}/#{build}/artifacts").get
     end
 
     ##
@@ -109,7 +19,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def cancel
-      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}/cancel").post
+      CircleCi.request(conf, "#{base_path}/#{build}/cancel").post
     end
 
     ##
@@ -118,7 +28,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def get
-      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}").get
+      CircleCi.request(conf, "#{base_path}/#{build}").get
     end
 
     ##
@@ -127,7 +37,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def retry
-      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}/retry").post
+      CircleCi.request(conf, "#{base_path}/#{build}/retry").post
     end
 
     ##
@@ -136,7 +46,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def tests
-      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}/tests").get
+      CircleCi.request(conf, "#{base_path}/#{build}/tests").get
     end
   end
 end

data/lib/circleci/config.rb

@@ -5,7 +5,7 @@ module CircleCi
   # Config class used internally.
   # Configure API calls using CircleCi.configure
   class Config
-    DEFAULT_VERSION = 'v1'.freeze
+    DEFAULT_VERSION = 'v1.1'.freeze
     DEFAULT_HOST = 'https://circleci.com'.freeze
     DEFAULT_URI = "#{DEFAULT_HOST}/api/#{DEFAULT_VERSION}".freeze
     DEFAULT_PORT = 443
@@ -33,18 +33,18 @@ module CircleCi
     end
 
     def proxy_userinfo?
-      @proxy_user && @proxy_pass
+      proxy_user && proxy_pass
     end
 
-    def proxy_port
-      @proxy_port ? @proxy_port : 80
+    def proxy_to_port
+      proxy_port ? proxy_port : 80
     end
 
     def proxy_uri
-      return unless @proxy && @proxy_host
-      host_uri = URI.parse(@proxy_host)
-      userinfo = proxy_userinfo? ? "#{@proxy_user}:#{@proxy_pass}@" : ''
-      URI.parse("#{host_uri.scheme}://#{userinfo}#{host_uri.host}:#{proxy_port}#{host_uri.path}")
+      return unless @proxy && proxy_host
+      host_uri = URI.parse(proxy_host)
+      userinfo = proxy_userinfo? ? "#{proxy_user}:#{proxy_pass}@" : ''
+      URI.parse("#{host_uri.scheme}://#{userinfo}#{host_uri.host}:#{proxy_to_port}#{host_uri.path}")
     end
   end
 end

data/lib/circleci/project.rb

@@ -3,265 +3,18 @@ module CircleCi
   ##
   #
   # Class for interacting with Projects
-  # rubocop:disable Metrics/ClassLength
-  class Project < ApiResource
+  class Project < ApiProjectResource
     ##
     #
-    # Deprecated class methods
-    class << self
-      ##
-      #
-      # Return all projects for your API key
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @return [CircleCi::Response] - Response object
-      def all
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Projects#get instead')
-        CircleCi::Projects.new.get
-      end
-
-      ##
-      #
-      # Build the latest master push for this project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @return         [CircleCi::Response] - Response object
-      def build(username, project)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#build instead')
-        new(username, project, default_config).build
-      end
-
-      ##
-      #
-      # Build the latest push for this branch of a specific project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param branch   [String] - Name of branch
-      # @param body     [Hash] - Optional post body with build parameters
-      # @return         [CircleCi::Response] - Response object
-      def build_branch(username, project, branch, params = {}, body = {})
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#build_branch instead')
-        new(username, project, default_config).build_branch(branch, params, body)
-      end
-
-      ##
-      #
-      # Add a ssh key to a build
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param build    [String] - Build number
-      # @param key      [String] - The ssh private key
-      # @param hostname [String] - The hostname identified by the key
-      # @return         [CircleCi::Response] - Response object
-      def build_ssh_key(username, project, build, key, hostname)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#build_ssh_key instead')
-        new(username, project, default_config).build_ssh_key(build, key, hostname)
-      end
-
-      ##
-      #
-      # Clear the build cache for a specific project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @return         [CircleCi::Response] - Response object
-      def clear_cache(username, project)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#clear_cache instead')
-        new(username, project, default_config).clear_cache
-      end
-
-      ##
-      #
-      # Delete a checkout key for a project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username     [String] - User or org name who owns project
-      # @param project      [String] - Name of project
-      # @param fingerprint  [String] - Fingerprint of a checkout key
-      # @return             [CircleCi::Response] - Response object
-      def delete_checkout_key(username, project, fingerprint)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#delete_checkout_key instead')
-        new(username, project, default_config).delete_checkout_key(fingerprint)
-      end
-
-      ##
-      #
-      # Enable a project in CircleCI. Causes a CircleCI SSH key to be added to
-      # the GitHub. Requires admin privilege to the repository.
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @return         [CircleCi::Response] - Response object
-      def enable(username, project)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#enable instead')
-        new(username, project, default_config).enable
-      end
-
-      ##
-      #
-      # Get the project envvars
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @return         [CircleCi::Response] - Response object
-      def envvar(username, project)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#envvar instead')
-        new(username, project, default_config).envvar
-      end
-
-      ##
-      #
-      # @deprecated Please use [CircleCi::Project#envvar]
-      def envvars(username, project)
-        default_config.logger.warn('[Deprecated] CircleCi::Project#envvars is deprecated please use CircleCi::Project#envvar')
-        envvar username, project
-      end
-
-      ##
-      #
-      # Follow the project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @return         [CircleCi::Response] - Response object
-      def follow(username, project)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#follow instead')
-        new(username, project, default_config).follow
-      end
-
-      ##
-      #
-      # Get a checkout key for a project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username     [String] - User or org name who owns project
-      # @param project      [String] - Name of project
-      # @param fingerprint  [String] - Fingerprint of a checkout key
-      # @return             [CircleCi::Response] - Response object
-      def get_checkout_key(username, project, fingerprint)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#get_checkout_key instead')
-        new(username, project, default_config).get_checkout_key(fingerprint)
-      end
-
-      ##
-      #
-      # Get a list of checkout keys for project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @return         [CircleCi::Response] - Response object
-      def list_checkout_keys(username, project)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#list_checkout_keys instead')
-        new(username, project, default_config).list_checkout_keys
-      end
-
-      ##
-      #
-      # Create a checkout key for a project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param type     [String] - The type of key to create. Can be 'deploy-key' or 'github-user-key'.
-      # @return         [CircleCi::Response] - Response object
-      def new_checkout_key(username, project, type)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#new_checkout_key instead')
-        new(username, project, default_config).new_checkout_key(type)
-      end
-
-      ##
-      #
-      # Get all recent builds for a specific project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param params   [Hash] - Parameters for builds (limit, offset, filter)
-      # @return         [CircleCi::Response] - Response object
-      def recent_builds(username, project, params = {})
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#recent_builds instead')
-        new(username, project, default_config).recent_builds(params)
-      end
-
-      ##
-      #
-      # Get all recent builds for a specific branch of a project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param branch   [String] - Name of branch
-      # @return         [CircleCi::Response] - Response object
-      def recent_builds_branch(username, project, branch)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#recent_builds_branch instead')
-        new(username, project, default_config).recent_builds_branch(branch)
-      end
-
-      ##
-      #
-      # Get the project configuration
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @return         [CircleCi::Response] - Response object
-      def settings(username, project)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#settings instead')
-        new(username, project, default_config).settings
-      end
-
-      ##
-      #
-      # Sets an envvar for a project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param envvar   [Hash] - {name: 'foo', value: 'bar'}
-      # @return         [CircleCi::Response] - Response object
-      def set_envvar(username, project, envvar)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#add_envvar instead')
-        new(username, project, default_config).add_envvar(envvar)
-      end
-
-      ##
-      #
-      # Add a ssh key to a project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @param key      [String] - The ssh private key
-      # @param hostname [String] - The hostname identified by the key
-      # @return         [CircleCi::Response] - Response object
-      def ssh_key(username, project, key, hostname)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#ssh_key instead')
-        new(username, project, default_config).ssh_key(key, hostname)
-      end
-
-      ##
-      #
-      # Unfollow the project
-      #
-      # @deprecated Please use instance method of [CircleCi::Project] instead
-      # @param username [String] - User or org name who owns project
-      # @param project  [String] - Name of project
-      # @return         [CircleCi::Response] - Response object
-      def unfollow(username, project)
-        default_config.logger.warn('[Deprecated] Use instance method CircleCi::Project#unfollow instead')
-        new(username, project, default_config).unfollow
-      end
+    # Initialize a new Project API interaction
+    #
+    # @param username [String] - The vcs username or org name for project
+    # @param project  [String] - The project name
+    # @param vcs_type [String] - The vcs type i.e. github or bitbucket
+    # @param conf     [CircleCi::Config] - Optional config to use for request
+    # @return         [CircleCi::Project]
+    def initialize(username = nil, project = nil, vcs_type = nil, conf = nil)
+      super(username, project, vcs_type, nil, conf)
     end
 
     ##
@@ -270,7 +23,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def build
-      CircleCi.request(@conf, "/project/#{username}/#{project}").post
+      CircleCi.request(conf, base_path).post
     end
 
     ##
@@ -282,7 +35,7 @@ module CircleCi
     # @param body     [Hash] - Optional post body with build parameters
     # @return         [CircleCi::Response] - Response object
     def build_branch(branch, params = {}, body = {})
-      CircleCi.request(@conf, "/project/#{username}/#{project}/tree/#{branch}", params).post(body)
+      CircleCi.request(conf, "#{base_path}/tree/#{branch}", params).post(body)
     end
 
     ##
@@ -295,7 +48,7 @@ module CircleCi
     # @return         [CircleCi::Response] - Response object
     def build_ssh_key(build, key, hostname)
       body = { hostname: hostname, private_key: key }
-      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}/ssh-users").post(body)
+      CircleCi.request(conf, "#{base_path}/#{build}/ssh-users").post(body)
     end
 
     ##
@@ -304,7 +57,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def clear_cache
-      CircleCi.request(@conf, "/project/#{username}/#{project}/build-cache").delete
+      CircleCi.request(conf, "#{base_path}/build-cache").delete
     end
 
     ##
@@ -314,7 +67,7 @@ module CircleCi
     # @param fingerprint  [String] - Fingerprint of a checkout key
     # @return             [CircleCi::Response] - Response object
     def delete_checkout_key(fingerprint)
-      CircleCi.request(@conf, "/project/#{username}/#{project}/checkout-key/#{fingerprint}").delete
+      CircleCi.request(conf, "#{base_path}/checkout-key/#{fingerprint}").delete
     end
 
     ##
@@ -324,7 +77,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def enable
-      CircleCi.request(@conf, "/project/#{username}/#{project}/enable").post
+      CircleCi.request(conf, "#{base_path}/enable").post
     end
 
     ##
@@ -333,7 +86,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def envvar
-      CircleCi.request(@conf, "/project/#{username}/#{project}/envvar").get
+      CircleCi.request(conf, "#{base_path}/envvar").get
     end
 
     ##
@@ -342,7 +95,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def follow
-      CircleCi.request(@conf, "/project/#{username}/#{project}/follow").post
+      CircleCi.request(conf, "#{base_path}/follow").post
     end
 
     ##
@@ -352,7 +105,7 @@ module CircleCi
     # @param fingerprint  [String] - Fingerprint of a checkout key
     # @return             [CircleCi::Response] - Response object
     def get_checkout_key(fingerprint)
-      CircleCi.request(@conf, "/project/#{username}/#{project}/checkout-key/#{fingerprint}").get
+      CircleCi.request(conf, "#{base_path}/checkout-key/#{fingerprint}").get
     end
 
     ##
@@ -361,7 +114,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def list_checkout_keys
-      CircleCi.request(@conf, "/project/#{username}/#{project}/checkout-key").get
+      CircleCi.request(conf, "#{base_path}/checkout-key").get
     end
 
     ##
@@ -371,7 +124,7 @@ module CircleCi
     # @param type [String] - The type of key to create. Can be 'deploy-key' or 'github-user-key'.
     # @return     [CircleCi::Response] - Response object
     def new_checkout_key(type)
-      CircleCi.request(@conf, "/project/#{username}/#{project}/checkout-key").post(type: type)
+      CircleCi.request(conf, "#{base_path}/checkout-key").post(type: type)
     end
 
     ##
@@ -381,7 +134,7 @@ module CircleCi
     # @param params   [Hash] - Parameters for builds (limit, offset, filter)
     # @return         [CircleCi::Response] - Response object
     def recent_builds(params = {})
-      CircleCi.request(@conf, "/project/#{username}/#{project}", params).get
+      CircleCi.request(conf, base_path, params).get
     end
 
     ##
@@ -391,7 +144,7 @@ module CircleCi
     # @param branch [String] - Name of branch
     # @return       [CircleCi::Response] - Response object
     def recent_builds_branch(branch)
-      CircleCi.request(@conf, "/project/#{username}/#{project}/tree/#{branch}").get
+      CircleCi.request(conf, "#{base_path}/tree/#{branch}").get
     end
 
     ##
@@ -400,7 +153,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def settings
-      CircleCi.request(@conf, "/project/#{username}/#{project}/settings").get
+      CircleCi.request(conf, "#{base_path}/settings").get
     end
 
     ##
@@ -410,7 +163,7 @@ module CircleCi
     # @param envvar [Hash] - {name: 'foo', value: 'bar'}
     # @return       [CircleCi::Response] - Response object
     def add_envvar(envvar)
-      CircleCi.request(@conf, "/project/#{username}/#{project}/envvar").post(envvar)
+      CircleCi.request(conf, "#{base_path}/envvar").post(envvar)
     end
 
     ##
@@ -422,7 +175,7 @@ module CircleCi
     # @return         [CircleCi::Response] - Response object
     def ssh_key(key, hostname)
       body = { hostname: hostname, private_key: key }
-      CircleCi.request(@conf, "/project/#{username}/#{project}/ssh-key").post(body)
+      CircleCi.request(conf, "#{base_path}/ssh-key").post(body)
     end
 
     ##
@@ -431,8 +184,7 @@ module CircleCi
     #
     # @return [CircleCi::Response] - Response object
     def unfollow
-      CircleCi.request(@conf, "/project/#{username}/#{project}/unfollow").post
+      CircleCi.request(conf, "#{base_path}/unfollow").post
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end