Styling fixes for rubocop warnings

lib/circleci.rb

@@ -2,23 +2,25 @@
 require 'rest-client'
 require 'net/http'
 
-files = [
-  'build',
-  'config',
-  'http',
-  'project',
-  'request_error',
-  'response',
-  'user'
+files = %w[
+  build
+  config
+  http
+  project
+  request_error
+  response
+  user
 ]
 
 files.each { |path| require_relative "./circleci/#{path}" }
 
-
+##
+#
+# CircleCi module configured to for endpoint interactions
 module CircleCi
+  module_function
 
-  extend self
-
+  ##
   #
   # @example Configure CircleCi with your token
   #   CircleCi.configure do |config|
@@ -29,6 +31,7 @@ def configure
     yield config
   end
 
+  ##
   #
   # @return [CircleCi::Config]
 
@@ -53,5 +56,4 @@ def http # @private
   def organization(name, params = {})
     http.get "/organization/#{name}", params
   end
-
 end

lib/circleci/build.rb

@@ -1,15 +1,8 @@
 module CircleCi
-
-    ##
-    #
-    # Class for managing builds for a project
-
+  ##
+  #
+  # Class for interacting with and managing builds
   class Build
-
-    ##
-    #
-    # Class for interacting with and managing builds
-
     ##
     #
     # Get artifacts for a specific build of a project
@@ -19,7 +12,7 @@ class Build
     # @param build    [String] - Build ID
     # @return         [CircleCi::Response] - Response object
 
-    def self.artifacts username, project, build
+    def self.artifacts(username, project, build)
       CircleCi.http.get "/project/#{username}/#{project}/#{build}/artifacts"
     end
 
@@ -32,7 +25,7 @@ def self.artifacts username, project, build
     # @param build    [String] - Build ID
     # @return         [CircleCi::Response] - Response object
 
-    def self.cancel username, project, build
+    def self.cancel(username, project, build)
       CircleCi.http.post "/project/#{username}/#{project}/#{build}/cancel"
     end
 
@@ -45,7 +38,7 @@ def self.cancel username, project, build
     # @param build    [String] - Build ID
     # @return         [CircleCi::Response] - Response object
 
-    def self.get username, project, build
+    def self.get(username, project, build)
       CircleCi.http.get "/project/#{username}/#{project}/#{build}"
     end
 
@@ -58,7 +51,7 @@ def self.get username, project, build
     # @param build    [String] - Build ID
     # @return         [CircleCi::Response] - Response object
 
-    def self.retry username, project, build
+    def self.retry(username, project, build)
       CircleCi.http.post "/project/#{username}/#{project}/#{build}/retry"
     end
 
@@ -71,10 +64,8 @@ def self.retry username, project, build
     # @param build [String] - Build ID
     # @return [CircleCi::Response] - Response object
 
-    def self.tests username, project, build
+    def self.tests(username, project, build)
       CircleCi.http.get "/project/#{username}/#{project}/#{build}/tests"
     end
-
   end
-
 end

lib/circleci/config.rb

@@ -3,14 +3,13 @@ module CircleCi
   #
   # Config class used internally.
   # Configure API calls using AlPapi.configure
-
   class Config
-
-    VERSION = 'v1'
-    DEFAULT_HOST = "https://circleci.com/api/#{VERSION}"
+    VERSION = 'v1'.freeze
+    DEFAULT_HOST = "https://circleci.com/api/#{VERSION}".freeze
     DEFAULT_PORT = 80
 
-    attr_accessor :token, :host, :port
+    attr_accessor :token
+    attr_reader :host, :port
 
     ##
     #
@@ -20,7 +19,5 @@ def initialize
       @host = DEFAULT_HOST
       @port = DEFAULT_PORT
     end
-
   end
-
 end

lib/circleci/http.rb

@@ -1,13 +1,18 @@
 # encoding: utf-8
 
 module CircleCi
-
+  ##
+  #
+  # Http class handles all HTTP requests
   class Http # @private
-
     attr_accessor :errors, :response, :success, :config, :over_limit, :suspended
 
-    def initialize(_config)
-      @config, @errors, @success, @over_limit, @suspended = _config, [], false, false, false
+    def initialize(config)
+      @config = config
+      @errors = []
+      @success = false
+      @over_limit = false
+      @suspended = false
     end
 
     def get(path, params = {})
@@ -31,18 +36,15 @@ def build_params(params = {})
     end
 
     def create_request_args(http_verb, url, body)
-      if http_verb == "post"
-        return [http_verb, url, body, headers]
-      end
-
+      return [http_verb, url, body, headers] if http_verb == 'post'
       [http_verb, url, headers]
     end
 
     def request(http_verb, path, body = {})
       url  = "#{@config.host}#{path}"
       args = create_request_args http_verb, url, body
 
-      RestClient.send(*args) do |res, req, raw_res|
+      RestClient.send(*args) do |res, _, raw_res|
         body = res.body.to_s
         body.force_encoding(Encoding::UTF_8)
         code = raw_res.code.to_i
@@ -55,22 +57,27 @@ def request(http_verb, path, body = {})
       end
     end
 
+    def parsed_body(body)
+      JSON.parse(body)
+    rescue
+      nil
+    end
+
     def handle_response(body, code, path)
-      parsed = JSON.parse(body) rescue nil
-      successful_code = (200..299).include?(code)
+      parsed = parsed_body(body)
+      successful_code = (200..299).cover?(code)
       self.response = parsed if parsed
+      self.success = true
 
       # Some responses are empty but are successful
       if body == '""' && successful_code
         self.response = ''
-        self.success = true
       elsif parsed && successful_code
-        self.success = true
+        # Response is successful
       else
-        self.errors << RequestError.new(body, code, path)
+        self.success = false
+        self.errors = [RequestError.new(body, code, path)]
       end
     end
-
   end
-
 end

lib/circleci/project.rb

@@ -1,11 +1,8 @@
 module CircleCi
-
   ##
   #
   # Class for interacting with Projects
-
   class Project
-
     ##
     #
     # Return all projects for your API key
@@ -24,7 +21,7 @@ def self.all
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.build username, project
+    def self.build(username, project)
       CircleCi.http.post "/project/#{username}/#{project}"
     end
 
@@ -38,9 +35,9 @@ def self.build username, project
     # @param build_parameters   [Hash] - Optional Build Parameters
     # @return         [CircleCi::Response] - Response object
 
-    def self.build_branch username, project, branch, build_parameters = {}
+    def self.build_branch(username, project, branch, build_parameters = {})
       body = {}
-      body["build_parameters"] = build_parameters unless build_parameters.empty?
+      body['build_parameters'] = build_parameters unless build_parameters.empty?
       CircleCi.http.post "/project/#{username}/#{project}/tree/#{branch}", {}, body
     end
 
@@ -54,7 +51,7 @@ def self.build_branch username, project, branch, build_parameters = {}
     # @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 self.build_ssh_key(username, project, build, key, hostname)
       body = { hostname: hostname, private_key: key }
       CircleCi.http.post "/project/#{username}/#{project}/#{build}/ssh-users", {}, body
     end
@@ -67,7 +64,7 @@ def self.build_ssh_key username, project, build, key, hostname
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.clear_cache username, project
+    def self.clear_cache(username, project)
       CircleCi.http.delete "/project/#{username}/#{project}/build-cache"
     end
 
@@ -80,7 +77,7 @@ def self.clear_cache username, project
     # @param fingerprint  [String] - Fingerprint of a checkout key
     # @return             [CircleCi::Response] - Response object
 
-    def self.delete_checkout_key username, project, fingerprint
+    def self.delete_checkout_key(username, project, fingerprint)
       CircleCi.http.delete "/project/#{username}/#{project}/checkout-key/#{fingerprint}"
     end
 
@@ -93,7 +90,7 @@ def self.delete_checkout_key username, project, fingerprint
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.enable username, project
+    def self.enable(username, project)
       CircleCi.http.post "/project/#{username}/#{project}/enable"
     end
 
@@ -105,7 +102,7 @@ def self.enable username, project
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.envvars username, project
+    def self.envvars(username, project)
       CircleCi.http.get "/project/#{username}/#{project}/envvar"
     end
 
@@ -118,7 +115,7 @@ def self.envvars username, project
     # @param envvar   [Hash] - {name: 'foo', value: 'bar'}
     # @return         [CircleCi::Response] - Response object
 
-    def self.set_envvar username, project, envvar
+    def self.set_envvar(username, project, envvar)
       body = envvar
       CircleCi.http.post "/project/#{username}/#{project}/envvar", {}, body
     end
@@ -131,7 +128,7 @@ def self.set_envvar username, project, envvar
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.follow username, project
+    def self.follow(username, project)
       CircleCi.http.post "/project/#{username}/#{project}/follow"
     end
 
@@ -144,7 +141,7 @@ def self.follow username, project
     # @param fingerprint  [String] - Fingerprint of a checkout key
     # @return             [CircleCi::Response] - Response object
 
-    def self.get_checkout_key username, project, fingerprint
+    def self.get_checkout_key(username, project, fingerprint)
       CircleCi.http.get "/project/#{username}/#{project}/checkout-key/#{fingerprint}"
     end
 
@@ -156,7 +153,7 @@ def self.get_checkout_key username, project, fingerprint
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.list_checkout_keys username, project
+    def self.list_checkout_keys(username, project)
       CircleCi.http.get "/project/#{username}/#{project}/checkout-key"
     end
 
@@ -169,7 +166,7 @@ def self.list_checkout_keys username, 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
+    def self.new_checkout_key(username, project, type)
       body = { type: type }
       CircleCi.http.post "/project/#{username}/#{project}/checkout-key", {}, body
     end
@@ -182,7 +179,7 @@ def self.new_checkout_key username, project, type
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.recent_builds username, project
+    def self.recent_builds(username, project)
       CircleCi.http.get "/project/#{username}/#{project}"
     end
 
@@ -195,7 +192,7 @@ def self.recent_builds username, project
     # @param branch   [String] - Name of branch
     # @return         [CircleCi::Response] - Response object
 
-    def self.recent_builds_branch username, project, branch
+    def self.recent_builds_branch(username, project, branch)
       CircleCi.http.get "/project/#{username}/#{project}/tree/#{branch}"
     end
 
@@ -207,7 +204,7 @@ def self.recent_builds_branch username, project, branch
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.settings username, project
+    def self.settings(username, project)
       CircleCi.http.get "/project/#{username}/#{project}/settings"
     end
 
@@ -220,7 +217,8 @@ def self.settings username, 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 self.ssh_key(username, project, key, hostname)
       body = { hostname: hostname, private_key: key }
       CircleCi.http.post "/project/#{username}/#{project}/ssh-key", {}, body
     end
@@ -233,11 +231,8 @@ def self.ssh_key username, project, key, hostname
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.unfollow username, project
+    def self.unfollow(username, project)
       CircleCi.http.post "/project/#{username}/#{project}/unfollow"
     end
-
   end
-
 end
-