cb-api 17.4.0 → 18.0.0

data/lib/cb/responses/user/delete.rb

@@ -1,9 +1,18 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Responses
     module User
-
       class Delete < ApiResponse
-        class Model < Struct.new(:status) ; end
+        class Model < Struct.new(:status); end
 
         protected
 
@@ -36,7 +45,6 @@ module Cb
           'Status'
         end
       end
-
     end
   end
 end

data/lib/cb/responses/user/retrieve.rb

@@ -1,9 +1,17 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Responses
     module User
-
       class Retrieve < ApiResponse
-
         attr_reader :status
 
         def initialize(args)
@@ -48,7 +56,6 @@ module Cb
           'Status'
         end
       end
-
     end
   end
 end

data/lib/cb/responses/user/temporary_password.rb

@@ -1,9 +1,17 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Responses
     module User
-
       class TemporaryPassword < ApiResponse
-
         # there's really no response model here, so let's just
         # pass the new password along in a way that makes sense.
         alias_method :temp_password, :model
@@ -32,7 +40,6 @@ module Cb
           'TemporaryPassword'
         end
       end
-
     end
   end
 end

data/lib/cb/responses/work_status/list.rb

@@ -1,10 +1,19 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 require 'cb/responses/api_response'
 
 module Cb
   module Responses
     module WorkStatus
       class List < ApiResponse
-
         protected
 
         def hash_containing_metadata
@@ -16,19 +25,18 @@ module Cb
         end
 
         def extract_models
-          [ model_array ].flatten.map { |work_status| Cb::Models::WorkStatus.new work_status }
+          [model_array].flatten.map { |work_status| Cb::Models::WorkStatus.new work_status }
         end
 
         private
 
         def work_statuses_node
-          "WorkStatuses"
+          'WorkStatuses'
         end
 
         def model_array
           response[work_statuses_node]
         end
-
       end
     end
   end

data/lib/cb/utils/api.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 require 'httparty'
 require 'observer'
 
@@ -20,31 +30,31 @@ module Cb
       end
 
       def initialize
-        self.class.default_params :developerkey => Cb.configuration.dev_key,
-                                  :outputjson => Cb.configuration.use_json.to_s
+        self.class.default_params developerkey: Cb.configuration.dev_key,
+                                  outputjson: Cb.configuration.use_json.to_s
 
         self.class.default_timeout Cb.configuration.time_out
-        self.class.headers.merge! ({'developerkey' => Cb.configuration.dev_key})
-        self.class.headers.merge! ({'accept-encoding' => 'deflate, gzip'}) unless Cb.configuration.debug_api
+        self.class.headers.merge! ({ 'developerkey' => Cb.configuration.dev_key })
+        self.class.headers.merge! ({ 'accept-encoding' => 'deflate, gzip' }) unless Cb.configuration.debug_api
       end
 
-      def cb_get(path, options={}, &block)
+      def cb_get(path, options = {}, &block)
         execute_http_request(:get, nil, path, options, &block)
       end
 
-      def cb_post(path, options={}, &block)
+      def cb_post(path, options = {}, &block)
         execute_http_request(:post, nil, path, options, &block)
       end
 
-      def cb_put(path, options={}, &block)
+      def cb_put(path, options = {}, &block)
         execute_http_request(:put, nil, path, options, &block)
       end
 
-      def cb_delete(path, options={}, &block)
+      def cb_delete(path, options = {}, &block)
         execute_http_request(:delete, nil, path, options, &block)
       end
 
-      def execute_http_request(http_method, uri, path, options={}, &block)
+      def execute_http_request(http_method, uri, path, options = {}, &block)
         self.class.base_uri(uri || Cb.configuration.base_uri)
         api_caller = find_api_caller(caller)
         start_time = Time.now.to_f
@@ -84,7 +94,7 @@ module Cb
       end
 
       def self.criteria_to_hash(criteria)
-        params = Hash.new
+        params = {}
         if criteria.respond_to?(:instance_variables)
           criteria.instance_variables.each do |var|
             var_name = var.to_s
@@ -137,7 +147,7 @@ module Cb
 
       def self.camelize(input)
         input.sub!(/^[a-z\d]*/) { $&.capitalize }
-        input.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$2.capitalize}" }.gsub('/', '::')
+        input.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{Regexp.last_match(2).capitalize}" }.gsub('/', '::')
       end
 
       def set_api_error(validated_response)
@@ -145,7 +155,7 @@ module Cb
       end
 
       def format_hash_key(api_hash_key)
-        return String.new unless api_hash_key.respond_to?(:snakecase)
+        return '' unless api_hash_key.respond_to?(:snakecase)
         api_hash_key.snakecase
       end
     end

data/lib/cb/utils/console_observer.rb

@@ -1,10 +1,19 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Utils
     class ConsoleObserver
       def update(api_call)
-        puts "#{api_call.api_call_type.to_s} #{api_call.path}/#{api_call.options.to_s} response: #{api_call.response.to_json}"
+        puts "#{api_call.api_call_type} #{api_call.path}/#{api_call.options} response: #{api_call.response.to_json}"
       end
     end
   end
 end
-

data/lib/cb/utils/country.rb

@@ -1,11 +1,21 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Utils
     class Country
       # These aren't all country codes. We get it. Our naming scheme didn't hold up over time.
       def self.get_supported
         %w(AH BE CA CC CE CH CN CP CS CY DE DK E1 ER ES EU F1
-         FR GC GR I1 IE IN IT J1 JC JS LJ M1 MY NL NO PD PI
-         PL RM RO RX S1 SE SF SG T1 T2 UK US WH WM WR)
+           FR GC GR I1 IE IN IT J1 JC JS LJ M1 MY NL NO PD PI
+           PL RM RO RX S1 SE SF SG T1 T2 UK US WH WM WR)
       end
 
       def self.is_valid?(country)
@@ -15,7 +25,7 @@ module Cb
       def self.inject_convenience_methods
         get_supported.each do |country|
           unless self.respond_to? "#{country}"
-            self.define_singleton_method "#{country}" do
+            define_singleton_method "#{country}" do
               return country
             end
           end
@@ -23,4 +33,4 @@ module Cb
       end
     end
   end
-end
+end

data/lib/cb/utils/fluid_attributes.rb

@@ -1,10 +1,18 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Utils
     module FluidAttributes
-
       def fluid_attr_accessor(*names)
         names.each do |name|
-
           define_method :"#{name}" do |*args|
             return instance_variable_get(:"@#{name}") if args.length == 0
 
@@ -13,7 +21,7 @@ module Cb
               return self
             end
 
-            raise ArgumentError.new("Wrong number of arguments (#{args.length} for 1)")
+            fail ArgumentError.new("Wrong number of arguments (#{args.length} for 1)")
           end
 
           define_method :"#{name}=" do |*args|
@@ -22,7 +30,6 @@ module Cb
           end
         end
       end
-
     end
   end
 end

data/lib/cb/utils/meta_values.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Utils
     class MetaValues

data/lib/cb/utils/response_array_extractor.rb

@@ -1,15 +1,24 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Utils
     class ResponseArrayExtractor
-
       def self.extract(response_hash, key, singular_key = nil)
-        self.new(response_hash, key, singular_key).extract
+        new(response_hash, key, singular_key).extract
       end
 
       def initialize(response_hash, key, singular_key)
         @response_hash = response_hash
         @key = key
-        @singular_key = singular_key || key[0..key.length-2]
+        @singular_key = singular_key || key[0..key.length - 2]
       end
 
       def extract
@@ -40,10 +49,9 @@ module Cb
         if @response_hash[@key][@singular_key].is_a?(Array)
           @response_hash[@key][@singular_key]
         else
-          [ @response_hash[@key][@singular_key] ]
+          [@response_hash[@key][@singular_key]]
         end
       end
-
     end
   end
-end
+end

data/lib/cb/utils/response_map.rb

@@ -1,11 +1,21 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Utils
     class ResponseMap
       class << self
-        def response_for request_class
+        def response_for(request_class)
           response_class = response_hash[request_class]
           return response_class unless response_class.nil?
-          raise ResponseNotFoundError.new request_class
+          fail ResponseNotFoundError.new request_class
         end
 
         protected
@@ -60,7 +70,6 @@ module Cb
             Cb::Requests::State::Get => Cb::Responses::State
           }.merge response_hash_extension
         end
-
       end
     end
     class ResponseNotFoundError < StandardError

data/lib/cb/utils/validator.rb

@@ -1,9 +1,18 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 require 'json'
 require 'nori'
 
 module Cb
   module ResponseValidator
-    
     class << self
       def validate(response)
         raise_response_code_errors(response)
@@ -14,8 +23,8 @@ module Cb
 
       def raise_response_code_errors(response)
         code = response.code rescue nil
-        raise Cb::ServiceUnavailableError if (code == 503 || simulate_auth_outage?)
-        raise Cb::UnauthorizedError if code == 401
+        fail Cb::ServiceUnavailableError if code == 503 || simulate_auth_outage?
+        fail Cb::UnauthorizedError if code == 401
       end
 
       def simulate_auth_outage?
@@ -24,31 +33,24 @@ module Cb
 
       def process_response_body(response)
         body = response.response.body rescue nil
-        return Hash.new if !body
+        return {} unless body
+
+        return {} if body.include?('<!DOCTYPE html') if response.code != 200
 
-        if response.code != 200
-          return Hash.new if body.include?('<!DOCTYPE html')
-        end
-        
         try_parse_json(body) || try_parse_xml(body) || {}
       end
 
       def try_parse_json(body)
-        begin
-          JSON.parse(body)
-        rescue JSON::ParserError
-          nil
-        end
+        JSON.parse(body)
+      rescue JSON::ParserError
+        nil
       end
 
       def try_parse_xml(body)
-        begin
-          MultiXml.parse(body, KeepRoot: true)
-        rescue MultiXml::ParseError
-          nil
-        end
+        MultiXml.parse(body, KeepRoot: true)
+      rescue MultiXml::ParseError
+        nil
       end
     end
-    
   end
 end