circleci 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92e030c54f884f86c18121b16a7d5faf48a6fa1b
-  data.tar.gz: eac0613d6ef27641244bc9363855e58114ee8e44
+  metadata.gz: c271b9c2906c8719ddbe6aaeac6e81629d9645e8
+  data.tar.gz: c8abb1f29b0977cb64577db02d530b03911c1357
 SHA512:
-  metadata.gz: b8ebd62b3f3a224db444c2eaa403866217a0ca19fb1fc1ead80471e20510579d607296401735440cd4ab90822dd31411e737177cc60ce468e4a7d5185109886a
-  data.tar.gz: ce048495a73a7363d6c679f40202a3e3d733b913f6afc13f64a13b1117bcbd358d7ec466dff00981e986b17890acb769f84bc595f806cb65ce56b7439c5a7582
+  metadata.gz: b260e331a7d82d2ae8f5b437fe1672eb045680e15fc85235d4bd1825527bd41cedbf791fb0928776cb2c881977920a468bad50a456e433db7a1b213aa1ada1ab
+  data.tar.gz: 9befc960bc2353e0410e308375ea5a9b4677a152bcd205c72b7e69a1434f6ffbfaccd887e21ca1da1e496970cf3953d2d11770b17e83806a9dda253ab71e921e

data/README.md

@@ -731,7 +731,7 @@ Creates a new environment variable for a project
 
 ```ruby
 environment = { name: 'foo', value: 'bar' }
-res = CircleCi::Project.envvar 'username', 'repo', environment
+res = CircleCi::Project.set_envvar 'username', 'repo', environment
 res.success?
 ```
 

data/lib/circleci.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 require 'json'
+require 'logger'
 require 'net/http'
 require 'uri'
 
 files = %w[
+  api_resource
   build
   config
   project
+  projects
   recent_builds
   request
   response
@@ -38,7 +41,7 @@ module CircleCi
     @config ||= Config.new
   end
 
-  def request(path, params = {})
-    Request.new config, path, params
+  def request(conf, path, params = {})
+    Request.new conf, path, params
   end
 end

data/lib/circleci/api_resource.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module CircleCi
+  ##
+  #
+  # ApiResource is a parent class for rest resources for the
+  # CircleCI API. It allows for request conifugration to be
+  # set per request if needed, otherwise the default global
+  # CircleCi.config is used
+  class ApiResource
+    attr_reader :conf, :project, :username
+
+    def initialize(username = nil, project = nil, conf = nil)
+      @username = username
+      @project = project
+      @conf = conf ? conf : default_config
+    end
+
+    def self.default_config
+      CircleCi.config
+    end
+
+    def default_config
+      self.class.default_config
+    end
+  end
+end

data/lib/circleci/build.rb

@@ -3,66 +3,140 @@ module CircleCi
   ##
   #
   # Class for interacting with and managing builds
-  class Build
+  class Build < ApiResource
+    attr_reader :build
     ##
     #
-    # Get artifacts for a specific build of a project
+    # 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::Response] - Response object
-    def self.artifacts(username, project, build)
-      CircleCi.request("/project/#{username}/#{project}/#{build}/artifacts").get
+    # @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
+
+    ##
+    #
+    # 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
     end
 
     ##
     #
     # Cancel a specific build
     #
-    # @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 self.cancel(username, project, build)
-      CircleCi.request("/project/#{username}/#{project}/#{build}/cancel").post
+    # @return [CircleCi::Response] - Response object
+    def cancel
+      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}/cancel").post
     end
 
     ##
     #
     # Get a specific build for a project
     #
-    # @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 self.get(username, project, build)
-      CircleCi.request("/project/#{username}/#{project}/#{build}").get
+    # @return [CircleCi::Response] - Response object
+    def get
+      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}").get
     end
 
     ##
     #
     # Kick off a retry of a specific build
     #
-    # @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 self.retry(username, project, build)
-      CircleCi.request("/project/#{username}/#{project}/#{build}/retry").post
+    # @return [CircleCi::Response] - Response object
+    def retry
+      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}/retry").post
     end
 
     ##
     #
     # Get tests for a specific build of a project
     #
-    # @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 self.tests(username, project, build)
-      CircleCi.request("/project/#{username}/#{project}/#{build}/tests").get
+    def tests
+      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}/tests").get
     end
   end
 end

data/lib/circleci/config.rb

@@ -11,18 +11,22 @@ module CircleCi
     DEFAULT_PORT = 443
 
     attr_accessor :token, :host, :port, :request_overrides, :version, :proxy,
-                  :proxy_host, :proxy_port, :proxy_user, :proxy_pass
+                  :proxy_host, :proxy_port, :proxy_user, :proxy_pass, :logger
 
     ##
     #
     # @private
-    def initialize
-      @host = DEFAULT_HOST
-      @port = DEFAULT_PORT
-      @proxy = false
-      @version = DEFAULT_VERSION
-      @request_overrides = {}
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(host: DEFAULT_HOST, port: DEFAULT_PORT, proxy: nil, version: DEFAULT_VERSION, token: nil, request_overrides: {}, logger: nil)
+      @host = host
+      @port = port
+      @proxy = proxy.nil? ? false : proxy
+      @version = version
+      @token = token
+      @request_overrides = request_overrides
+      @logger = logger ? logger : Logger.new(STDOUT)
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def uri
       URI.parse("#{@host || DEFAULT_HOST}:#{@port || DEFAULT_PORT}/api/#{@version || DEFAULT_VERSION}")

data/lib/circleci/project.rb

@@ -3,76 +3,318 @@ module CircleCi
   ##
   #
   # Class for interacting with Projects
-  class Project
+  # rubocop:disable Metrics/ClassLength
+  class Project < ApiResource
     ##
     #
-    # Return all projects for your API key
-    #
-    # @return [CircleCi::Response] - Response object
-    def self.all
-      CircleCi.request('/projects').get
+    # 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
     end
 
     ##
     #
     # Build the latest master push for this project
     #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @return         [CircleCi::Response] - Response object
-    def self.build(username, project)
-      CircleCi.request("/project/#{username}/#{project}").post
+    # @return [CircleCi::Response] - Response object
+    def build
+      CircleCi.request(@conf, "/project/#{username}/#{project}").post
     end
 
     ##
     #
     # Build the latest push for this branch of a specific project
     #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
     # @param branch   [String] - Name of branch
+    # @param params   [Hash] - Optional params to send for building
     # @param body     [Hash] - Optional post body with build parameters
     # @return         [CircleCi::Response] - Response object
-    def self.build_branch(username, project, branch, params = {}, body = {})
-      CircleCi.request("/project/#{username}/#{project}/tree/#{branch}", params).post(body)
+    def build_branch(branch, params = {}, body = {})
+      CircleCi.request(@conf, "/project/#{username}/#{project}/tree/#{branch}", params).post(body)
     end
 
     ##
     #
     # Add a ssh key to a build
     #
-    # @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 self.build_ssh_key(username, project, build, key, hostname)
+    def build_ssh_key(build, key, hostname)
       body = { hostname: hostname, private_key: key }
-      CircleCi.request("/project/#{username}/#{project}/#{build}/ssh-users").post(body)
+      CircleCi.request(@conf, "/project/#{username}/#{project}/#{build}/ssh-users").post(body)
     end
 
     ##
     #
     # Clear the build cache for a specific project
     #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @return         [CircleCi::Response] - Response object
-    def self.clear_cache(username, project)
-      CircleCi.request("/project/#{username}/#{project}/build-cache").delete
+    # @return [CircleCi::Response] - Response object
+    def clear_cache
+      CircleCi.request(@conf, "/project/#{username}/#{project}/build-cache").delete
     end
 
     ##
     #
     # Delete a checkout key for a project
     #
-    # @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 self.delete_checkout_key(username, project, fingerprint)
-      CircleCi.request("/project/#{username}/#{project}/checkout-key/#{fingerprint}").delete
+    def delete_checkout_key(fingerprint)
+      CircleCi.request(@conf, "/project/#{username}/#{project}/checkout-key/#{fingerprint}").delete
     end
 
     ##
@@ -80,152 +322,117 @@ module CircleCi
     # Enable a project in CircleCI. Causes a CircleCI SSH key to be added to
     # the GitHub. Requires admin privilege to the repository.
     #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @return         [CircleCi::Response] - Response object
-    def self.enable(username, project)
-      CircleCi.request("/project/#{username}/#{project}/enable").post
+    # @return [CircleCi::Response] - Response object
+    def enable
+      CircleCi.request(@conf, "/project/#{username}/#{project}/enable").post
     end
 
     ##
     #
     # Get the project envvars
     #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @return         [CircleCi::Response] - Response object
-    def self.envvar(username, project)
-      CircleCi.request("/project/#{username}/#{project}/envvar").get
-    end
-
-    ##
-    #
-    # @deprecated Please use [CircleCi::Project#envvar]
-    def self.envvars(username, project)
-      # NOTE: Make logger configurable on config object?
-      logger = Logger.new(STDOUT)
-      logger.warn('[Deprecated] Project#envvars is deprecated please use Project#envvar')
-      envvar username, project
-    end
-
-    ##
-    #
-    # Sets an envvar for a project
-    #
-    # @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 self.set_envvar(username, project, envvar)
-      CircleCi.request("/project/#{username}/#{project}/envvar").post(envvar)
+    # @return [CircleCi::Response] - Response object
+    def envvar
+      CircleCi.request(@conf, "/project/#{username}/#{project}/envvar").get
     end
 
     ##
     #
     # Follow the project
     #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @return         [CircleCi::Response] - Response object
-    def self.follow(username, project)
-      CircleCi.request("/project/#{username}/#{project}/follow").post
+    # @return [CircleCi::Response] - Response object
+    def follow
+      CircleCi.request(@conf, "/project/#{username}/#{project}/follow").post
     end
 
     ##
     #
     # Get a checkout key for a project
     #
-    # @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 self.get_checkout_key(username, project, fingerprint)
-      CircleCi.request("/project/#{username}/#{project}/checkout-key/#{fingerprint}").get
+    def get_checkout_key(fingerprint)
+      CircleCi.request(@conf, "/project/#{username}/#{project}/checkout-key/#{fingerprint}").get
     end
 
     ##
     #
     # Get a list of checkout keys for project
     #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @return         [CircleCi::Response] - Response object
-    def self.list_checkout_keys(username, project)
-      CircleCi.request("/project/#{username}/#{project}/checkout-key").get
+    # @return [CircleCi::Response] - Response object
+    def list_checkout_keys
+      CircleCi.request(@conf, "/project/#{username}/#{project}/checkout-key").get
     end
 
     ##
     #
     # Create a checkout key for a project
     #
-    # @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 self.new_checkout_key(username, project, type)
-      CircleCi.request("/project/#{username}/#{project}/checkout-key").post(type: type)
+    # @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)
     end
 
     ##
     #
     # Get all recent builds for a specific project
     #
-    # @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 self.recent_builds(username, project, params = {})
-      CircleCi.request("/project/#{username}/#{project}", params).get
+    def recent_builds(params = {})
+      CircleCi.request(@conf, "/project/#{username}/#{project}", params).get
     end
 
     ##
     #
     # Get all recent builds for a specific branch of a project
     #
-    # @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 self.recent_builds_branch(username, project, branch)
-      CircleCi.request("/project/#{username}/#{project}/tree/#{branch}").get
+    # @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
     end
 
     ##
     #
     # Get the project configuration
     #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @return         [CircleCi::Response] - Response object
-    def self.settings(username, project)
-      CircleCi.request("/project/#{username}/#{project}/settings").get
+    # @return [CircleCi::Response] - Response object
+    def settings
+      CircleCi.request(@conf, "/project/#{username}/#{project}/settings").get
+    end
+
+    ##
+    #
+    # Adds an envvar for a project
+    #
+    # @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)
     end
 
     ##
     #
     # Add a ssh key to a project
     #
-    # @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 self.ssh_key(username, project, key, hostname)
+    def ssh_key(key, hostname)
       body = { hostname: hostname, private_key: key }
-      CircleCi.request("/project/#{username}/#{project}/ssh-key").post(body)
+      CircleCi.request(@conf, "/project/#{username}/#{project}/ssh-key").post(body)
     end
 
     ##
     #
     # Unfollow the project
     #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @return         [CircleCi::Response] - Response object
-    def self.unfollow(username, project)
-      CircleCi.request("/project/#{username}/#{project}/unfollow").post
+    # @return [CircleCi::Response] - Response object
+    def unfollow
+      CircleCi.request(@conf, "/project/#{username}/#{project}/unfollow").post
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/circleci/projects.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module CircleCi
+  ##
+  #
+  # Class for getting all your Projects on CircleCI
+  class Projects < ApiResource
+    ##
+    #
+    # Initialize a Projects resource to get all projects
+    #
+    # @param config   [CircleCi::Config] - Defaults to [default_config] if not provided
+    # @return         [CircleCi::Projects] - A Projects object
+    def initialize(conf = nil)
+      super(nil, nil, conf)
+    end
+
+    ##
+    #
+    # Get all projects for your API key
+    #
+    # @return [CircleCi::Response] - Response object
+    def get
+      CircleCi.request(@conf, '/projects').get
+    end
+  end
+end

data/lib/circleci/recent_builds.rb

@@ -3,15 +3,42 @@ module CircleCi
   ##
   #
   # Class for interacting with recent builds
-  class RecentBuilds
+  class RecentBuilds < ApiResource
+    ##
+    #
+    # Initialize a new RecentBuilds API interaction
+    #
+    # @param conf [CircleCi::Config] - Optional config to use for request
+    # @return     [CircleCi::RecentBuilds]
+    def initialize(conf = nil)
+      super(nil, nil, conf)
+    end
+
+    ##
+    #
+    # Deprecated class methods
+    class << self
+      ##
+      #
+      # Get get recent builds for your account
+      #
+      # @deprecated Please use instance method of [CircleCi::RecentBuilds] instead
+      # @param params [Hash] - Params to send for recent builds (limit, offset)
+      # @return         [CircleCi::Response] - Response object
+      def get(params = {})
+        default_config.logger.warn('[Deprecated] Use instance method CircleCi::RecentBuilds#get instead')
+        new(default_config).get(params)
+      end
+    end
+
     ##
     #
     # Get get recent builds for your account
     #
     # @param params [Hash] - Params to send for recent builds (limit, offset)
-    # @return         [CircleCi::Response] - Response object
-    def self.get(params = {})
-      CircleCi.request('/recent-builds', params).get
+    # @return       [CircleCi::Response] - Response object
+    def get(params = {})
+      CircleCi.request(@conf, '/recent-builds', params).get
     end
   end
 end

data/lib/circleci/user.rb

@@ -3,14 +3,49 @@ module CircleCi
   ##
   #
   # User class to access user details for a specific API key
-  class User
+  class User < ApiResource
+    ##
+    #
+    # Initialize a new RecentBuilds API interaction
+    #
+    # @param conf [CircleCi::Config] - Optional config to use for request
+    # @return     [CircleCi::RecentBuilds]
+    def initialize(conf = nil)
+      super(nil, nil, conf)
+    end
+
+    class << self
+      ##
+      #
+      # Get user account details
+      #
+      # @deprecated Please use instance method of [CircleCi::User] instead
+      # @return [CircleCi::Response] - Response object
+      def me
+        default_config.logger.warn('[Deprecated] Use instance method CircleCi::User#me instead')
+        new(default_config).me
+      end
+
+      ##
+      #
+      # Add a Heroku API key to CircleCI
+      #
+      # @deprecated Please use instance method of [CircleCi::User] instead
+      # @param apikey   [String] - The Heroku API key
+      # @return         [CircleCi::Response] - Response object
+      def heroku_key(apikey)
+        default_config.logger.warn('[Deprecated] Use instance method CircleCi::User#heroku_key instead')
+        new(default_config).heroku_key(apikey)
+      end
+    end
+
     ##
     #
     # Get user account details
     #
     # @return [CircleCi::Response] - Response object
-    def self.me
-      CircleCi.request('/me').get
+    def me
+      CircleCi.request(@conf, '/me').get
     end
 
     ##
@@ -19,8 +54,8 @@ module CircleCi
     #
     # @param apikey   [String] - The Heroku API key
     # @return         [CircleCi::Response] - Response object
-    def self.heroku_key(apikey)
-      CircleCi.request('/user/heroku-key').post(apikey: apikey)
+    def heroku_key(apikey)
+      CircleCi.request(@conf, '/user/heroku-key').post(apikey: apikey)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circleci
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Chavez
@@ -30,7 +30,7 @@ cert_chain:
   7DerzHxWdPmU1DsMCCh7B3R2HH0TONFQ67h7FuJPvLQkvbUuwzzjzpBwfhdCIEFn
   WUW78NBBFETQzQE3nG9TifbcEDrx/dODsAFzoQ==
   -----END CERTIFICATE-----
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -132,6 +132,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -321,9 +361,11 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/circleci.rb
+- lib/circleci/api_resource.rb
 - lib/circleci/build.rb
 - lib/circleci/config.rb
 - lib/circleci/project.rb
+- lib/circleci/projects.rb
 - lib/circleci/recent_builds.rb
 - lib/circleci/request.rb
 - lib/circleci/response.rb
@@ -350,7 +392,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Circle CI REST API gem