cb-api 17.4.0 → 18.0.0

data/lib/cb/models/implementations/saved_search.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 Models
     class SavedSearch
@@ -8,21 +18,21 @@ module Cb
                     :external_user_id, :job_search_url, :jrdid, :errors, :browser_id, :session_id, :test, :email_address,
                     :country, :search_parameters, :did, :user_oauth_token, :email_delivery_day
 
-      def initialize(args={})
-        @host_site                  = args['HostSite']         || args[:host_site]            || String.new
-        @cobrand                    = args['Cobrand']          || args[:cobrand]              || String.new
-        @search_name                = args['SearchName']       || args[:search_name]          || String.new
-        @site_id                    = args['SiteId']           || args[:site_id]              || String.new
-        @is_daily_email             = args['IsDailyEmail']     || args[:is_daily_email]       || false
-        @email_delivery_day         = args['EmailDeliveryDay'] || args[:email_delivery_day]   || String.new
-        @job_search_url             = args['JobSearchUrl']     || args[:job_search_url]       || String.new
-        @external_id                = args['ExternalID']       || args[:external_id]          || String.new
-        @external_user_id           = args['ExternalUserID']   || args[:external_user_id]     || String.new
-        @browser_id                 = args['BrowserID']        || args[:browser_id]           || nil
-        @session_id                 = args['SessionID']        || args[:session_id]           || String.new
-        @email_address              = args['EmailAddress']     || args[:email_address]        || String.new
-        @did                        = args['DID']              || args[:did]                  || String.new
-        @user_oauth_token           = args['userOAuthToken']   || args[:user_oauth_token]     || String.new
+      def initialize(args = {})
+        @host_site                  = args['HostSite'] || args[:host_site] || ''
+        @cobrand                    = args['Cobrand'] || args[:cobrand] || ''
+        @search_name                = args['SearchName'] || args[:search_name] || ''
+        @site_id                    = args['SiteId'] || args[:site_id] || ''
+        @is_daily_email             = args['IsDailyEmail'] || args[:is_daily_email] || false
+        @email_delivery_day         = args['EmailDeliveryDay'] || args[:email_delivery_day] || ''
+        @job_search_url             = args['JobSearchUrl'] || args[:job_search_url] || ''
+        @external_id                = args['ExternalID'] || args[:external_id] || ''
+        @external_user_id           = args['ExternalUserID'] || args[:external_user_id] || ''
+        @browser_id                 = args['BrowserID'] || args[:browser_id] || nil
+        @session_id                 = args['SessionID'] || args[:session_id] || ''
+        @email_address              = args['EmailAddress'] || args[:email_address] || ''
+        @did                        = args['DID'] || args[:did] || ''
+        @user_oauth_token           = args['userOAuthToken'] || args[:user_oauth_token] || ''
         @search_parameters          = SearchParameters.new(args['SavedSearchParameters'] || {})
       end
 
@@ -59,18 +69,19 @@ module Cb
 
       def update_to_json
         hash = {
-            "DID" => did,
-            "SearchName" => search_name,
-            "HostSite" => host_site,
-            "SiteID" => site_id,
-            "Cobrand" => cobrand,
-            "IsDailyEmail" => is_daily_email,
-            "userOAuthToken" => user_oauth_token,
-            "SavedSearchParameters" => search_parameters.to_hash
+          'DID' => did,
+          'SearchName' => search_name,
+          'HostSite' => host_site,
+          'SiteID' => site_id,
+          'Cobrand' => cobrand,
+          'IsDailyEmail' => is_daily_email,
+          'userOAuthToken' => user_oauth_token,
+          'SavedSearchParameters' => search_parameters.to_hash
         }
-        hash["EmailDeliveryDay"] = email_delivery_day unless is_daily_email
+        hash['EmailDeliveryDay'] = email_delivery_day unless is_daily_email
         hash.to_json
       end
+
       def delete_anon_to_xml
         <<-eos
           <Request>
@@ -97,35 +108,35 @@ module Cb
                       :jc_position_level, :jc_location, :jc_advertiser_flags, :jc_job_nature
 
         def initialize(args = {})
-          @boolean_operator      = args['BooleanOperator']     || String.new
-          @category              = args['Category']            || String.new
-          @job_category          = args['JobCategory']         || String.new
-          @education_code        = args['EducationCode']       || String.new
-          @emp_type              = args['EmpType']             || String.new
-          @exclude_company_names = args['ExcludeCompanyNames'] || String.new
-          @exclude_job_titles    = args['ExcludeJobTitles']    || String.new
-          @exclude_keywords      = args['ExcludeKeywords']     || String.new
-          @exclude_national      = args['ExcludeNational'].nil?   ? false : args['ExcludeNational']
-          @industry_codes        = args['IndustryCodes']       || String.new
-          @job_title             = args['JobTitle']            || String.new
-          @keywords              = args['Keywords']            || String.new
-          @location              = args['Location']            || String.new
-          @order_by              = args['OrderBy']             || String.new
-          @order_direction       = args['OrderDirection']      || String.new
-          @pay_high              = args['PayHigh']             || 0
-          @pay_low               = args['PayLow']              || 0
-          @pay_info_only         = args['PayInfoOnly'].nil?       ? false : args['PayInfoOnly']
-          @posted_within         = args['PostedWithin']        || 30
-          @radius                = args['Radius']              || 30
+          @boolean_operator      = args['BooleanOperator'] || ''
+          @category              = args['Category'] || ''
+          @job_category          = args['JobCategory'] || ''
+          @education_code        = args['EducationCode'] || ''
+          @emp_type              = args['EmpType'] || ''
+          @exclude_company_names = args['ExcludeCompanyNames'] || ''
+          @exclude_job_titles    = args['ExcludeJobTitles'] || ''
+          @exclude_keywords      = args['ExcludeKeywords'] || ''
+          @exclude_national      = args['ExcludeNational'].nil? ? false : args['ExcludeNational']
+          @industry_codes        = args['IndustryCodes'] || ''
+          @job_title             = args['JobTitle'] || ''
+          @keywords              = args['Keywords'] || ''
+          @location              = args['Location'] || ''
+          @order_by              = args['OrderBy'] || ''
+          @order_direction       = args['OrderDirection'] || ''
+          @pay_high              = args['PayHigh'] || 0
+          @pay_low               = args['PayLow'] || 0
+          @pay_info_only         = args['PayInfoOnly'].nil? ? false : args['PayInfoOnly']
+          @posted_within         = args['PostedWithin'] || 30
+          @radius                = args['Radius'] || 30
           @specific_education    = args['SpecificEducation'].nil? ? false : args['SpecificEducation']
-          @city                  = args['City']                || String.new
-          @state                 = args['State']               || String.new
-          @country               = args['Country']             || String.new
-          @company               = args['Company']             || String.new
-          @jc_position_level     = args['JCPositionLevel']     || String.new
-          @jc_location           = args['JCLocation']          || String.new
-          @jc_advertiser_flags   = args['JCAdvertiserFlags']   || String.new
-          @jc_job_nature         = args['JCJobNature']         || String.new
+          @city                  = args['City'] || ''
+          @state                 = args['State'] || ''
+          @country               = args['Country'] || ''
+          @company               = args['Company'] || ''
+          @jc_position_level     = args['JCPositionLevel'] || ''
+          @jc_location           = args['JCLocation'] || ''
+          @jc_advertiser_flags   = args['JCAdvertiserFlags'] || ''
+          @jc_job_nature         = args['JCJobNature'] || ''
         end
 
         def to_xml
@@ -158,30 +169,29 @@ module Cb
 
         def to_hash
           {
-              "BooleanOperator" => boolean_operator,
-              "JobCategory" => job_category,
-              "EducationCode" => education_code,
-              "EmpType" => emp_type,
-              "ExcludeCompanyNames" => exclude_company_names,
-              "ExcludeJobTitles" => exclude_job_titles,
-              "Country" => country,
-              "IndustryCodes" => industry_codes,
-              "JobTitle" => job_title,
-              "Keywords" => keywords,
-              "Location" => location,
-              "OrderBy" => order_by,
-              "OrderDirection" => order_direction,
-              "PayHigh" => pay_high,
-              "PayLow" => pay_low,
-              "PostedWithin" => posted_within,
-              "Radius" => radius,
-              "SpecificEducation" => specific_education,
-              "ExcludeNational" => exclude_national,
-              "PayInfoOnly" => pay_info_only
+            'BooleanOperator' => boolean_operator,
+            'JobCategory' => job_category,
+            'EducationCode' => education_code,
+            'EmpType' => emp_type,
+            'ExcludeCompanyNames' => exclude_company_names,
+            'ExcludeJobTitles' => exclude_job_titles,
+            'Country' => country,
+            'IndustryCodes' => industry_codes,
+            'JobTitle' => job_title,
+            'Keywords' => keywords,
+            'Location' => location,
+            'OrderBy' => order_by,
+            'OrderDirection' => order_direction,
+            'PayHigh' => pay_high,
+            'PayLow' => pay_low,
+            'PostedWithin' => posted_within,
+            'Radius' => radius,
+            'SpecificEducation' => specific_education,
+            'ExcludeNational' => exclude_national,
+            'PayInfoOnly' => pay_info_only
           }
         end
       end
     end
-
   end
 end

data/lib/cb/models/implementations/state.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 Models
     class State < ApiResponseModel
@@ -6,11 +16,10 @@ module Cb
       def set_model_properties
         @key = api_response['StateId']
         @value = api_response['StateName']
-
       end
 
       def required_fields
-        ['StateId', 'StateName']
+        %w(StateId StateName)
       end
     end
   end

data/lib/cb/models/implementations/talent_network.rb

@@ -1,10 +1,20 @@
+# 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 Models
     class TalentNetwork
       attr_accessor :join_form_questions
-      def initialize(args={})
-        @join_form_questions = Array.new
-        if args.has_key?('JoinQuestions')
+      def initialize(args = {})
+        @join_form_questions = []
+        if args.key?('JoinQuestions')
           args['JoinQuestions'].each do |question|
             @join_form_questions << TalentNetwork::Questions.new(question)
           end
@@ -16,48 +26,47 @@ module Cb
       attr_accessor :dev_key, :tn_did, :preferred_language, :accept_privacy, :accept_terms, :resume_word_doc,
                     :join_values
 
-      def initialize(args={})
+      def initialize(args = {})
         @dev_key                = args['DeveloperKey'] || Cb.configuration.dev_key
         @tn_did                 = args['TNDID'] || ''
         @preferred_language     = args['PreferredLanguage'] || 'USEnglish'
         @accept_privacy         = args['AcceptPrivacy'] || true
         @accept_terms           = args['AcceptTerms'] || true
         @resume_word_doc        = args['ResumeWordDoc'] || ''
-        @join_values            = args['JoinValues'] || Array.new
+        @join_values            = args['JoinValues'] || []
       end
 
       def to_xml
-        ret =  "<Request>"
+        ret =  '<Request>'
         ret += "<DeveloperKey>#{@dev_key}</DeveloperKey>"
         ret += "<TalentNetworkDID>#{@tn_did}</TalentNetworkDID>"
         ret += "<PreferredLanguage>#{@preferred_language}</PreferredLanguage>"
         ret += "<AcceptPrivacy>#{@accept_privacy}</AcceptPrivacy>"
         ret += "<AcceptTerms>#{@accept_terms}</AcceptTerms>"
         ret += "<ResumeWordDoc>#{@resume_word_doc}</ResumeWordDoc>"
-        ret += "<JoinValues>"
-        @join_values.each { | k,v |
-          ret += "<JoinValue>"
+        ret += '<JoinValues>'
+        @join_values.each do |k, v|
+          ret += '<JoinValue>'
           ret += "<Key>#{k}</Key>"
           ret += "<Value>#{v}</Value>"
-          ret += "</JoinValue>"
-        }
-        ret += "</JoinValues>"
-        ret += "</Request>"
+          ret += '</JoinValue>'
+        end
+        ret += '</JoinValues>'
+        ret += '</Request>'
       end
     end
 
-
     class TalentNetwork::Questions
       attr_accessor :text, :form_value, :option_display_type, :order, :required, :options
 
-      def initialize(args={})
+      def initialize(args = {})
         @text                 = args['Text'] || ''
         @form_value           = args['FormValue'] || ''
         @option_display_type  = args['OptionDisplayType'] || ''
         @order                = args['Order'] || ''
         @required             = args['Required'].to_s || ''
-        @options              = Array.new
-        if args.has_key?('Options')
+        @options              = []
+        if args.key?('Options')
           args['Options'].each do |option_values|
             @options << TalentNetwork::Options.new(option_values)
           end
@@ -68,7 +77,7 @@ module Cb
     class TalentNetwork::Options
       attr_accessor :value, :order, :display_text
 
-      def initialize(args={})
+      def initialize(args = {})
         @value          = args['Value'] || ''
         @order          = args['Order'] || ''
         @display_text   = args['DisplayText'] || ''
@@ -78,7 +87,7 @@ module Cb
     class TalentNetwork::JobInfo
       attr_accessor :join_form_url, :tn_did, :join_form_intercept_enabled
 
-      def initialize(args={})
+      def initialize(args = {})
         @join_form_url                    = args['JoinFormUrl'] || ''
         @tn_did                           = args['sTNDID'] || ''
         @join_form_intercept_enabled      = args['JoinFormInterceptEnabled'].to_s || ''
@@ -88,52 +97,52 @@ module Cb
     class TalentNetwork::JoinFormGeo
       attr_accessor :countries, :states
 
-      def initialize(args={})
-        @countries = Hash.new
-        @states = Hash.new
+      def initialize(args = {})
+        @countries = {}
+        @states = {}
 
-        if args.has_key?('Countries')
+        if args.key?('Countries')
           @countries = TalentNetwork::JoinFormGeoLocation.new(args['Countries'])
         end
 
-        if args.has_key?('States')
+        if args.key?('States')
           @states = TalentNetwork::JoinFormGeoLocation.new(args['States'])
         end
-
       end
     end
 
     class TalentNetwork::JoinFormGeoLocation
       attr_accessor :geo_hash
 
-      def initialize(args={})
-        value = Array.new
-        display_val = Array.new
-        @geo_hash = Hash.new
+      def initialize(args = {})
+        value = []
+        display_val = []
+        @geo_hash = {}
 
-        if args.has_key?('Value')
+        if args.key?('Value')
           args['Value'].each do |val|
             value << val
           end
         end
 
-        if args.has_key?('Display')
+        if args.key?('Display')
           args['Display'].each do |display|
             display_val << display
           end
         end
 
         unless value.nil? || display_val.nil?
-          @geo_hash = convert_to_hash(display_val,value)
+          @geo_hash = convert_to_hash(display_val, value)
         end
       end
 
       private
+
       def convert_to_hash(keys, values)
-        geo_hash = Hash.new
+        geo_hash = {}
         geo_hash = Hash[keys.zip(values)]
 
-        return geo_hash
+        geo_hash
       end
     end
 
@@ -141,7 +150,7 @@ module Cb
       attr_accessor :stylesheet_url, :join_logo_image_url, :join_custom_msg_html, :button_color,
                     :mobile_logo_image_url, :nav_color, :site_path
 
-      def initialize(args={})
+      def initialize(args = {})
         @stylesheet_url                   = args['StylesheetURL'] || ''
         @join_logo_image_url              = args['JoinLogoImageURL'] || ''
         @join_custom_msg_html             = args['JoinCustomMsgHTML'] || ''
@@ -151,6 +160,5 @@ module Cb
         @site_path                        = args['SitePath'] || ''
       end
     end
-
   end
 end

data/lib/cb/models/implementations/user.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 Models
     class User
@@ -41,7 +51,7 @@ module Cb
         @work_status                  = args['WorkStatus'] || ''
       end
 
-      def custom_value custom_value_key
+      def custom_value(custom_value_key)
         custom_value = nil
 
         if @custom_values['CustomValue'].is_a? Array
@@ -52,7 +62,7 @@ module Cb
           custom_value = @custom_values['CustomValue']['Value'] if @custom_values['CustomValue']['Key'] == custom_value_key
         end
 
-        return custom_value
+        custom_value
       end
     end
   end

data/lib/cb/models/implementations/work_status.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 Models
     class WorkStatus
@@ -6,7 +16,7 @@ module Cb
       def initialize(args = {})
         return if args.nil?
         @key          = args['Key'] || ''
-        @translations = [ args['Description'] ].flatten.map { |translation| Translation.new translation }
+        @translations = [args['Description']].flatten.map { |translation| Translation.new translation }
       end
 
       class Translation
@@ -15,10 +25,9 @@ module Cb
         def initialize(args = {})
           return if args.nil?
           @language = args['Language'] || ''
-          @value    = args['Value']    || ''
+          @value    = args['Value'] || ''
         end
       end
-      
     end
   end
 end