cb-api 18.3.0 → 18.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aad8d025acb65f7575a58a2bb1880663595ef11
-  data.tar.gz: a097d8832a886c01bf1c26b37ed1684281ad3eea
+  metadata.gz: 92b64824e96c472291ad8e31393461dfd84e3d3d
+  data.tar.gz: fd70916fec02c781ea0e753d89250e24bdd3c65b
 SHA512:
-  metadata.gz: f6e788b98e5a67b7bb3a6e3e9df1c24308978efa1b11b4d1b642cd7a1d974e9c2a4195a6e3a9d2253fd41efdab9e39af7adbe90e9c84816bad599c1abca2e9af
-  data.tar.gz: 0dcad0f383cb10bb3bdb1e24a2adfa66872960cf6dc5668bbc34c3490b07e20a2341f318e710e0dc12d206c6937932ccb0091a2161bccfe7f858e30b9ae0d4e2
+  metadata.gz: dceeb0718cdc7037c7f07cdff7cac2f163d453544a3c8bb0fdb784f430fb55dd8e3e0b2b3e4250ffaf0f71445638b0038f9a1b5f239efff66e104e9d6ff80ac3
+  data.tar.gz: a8e73cba18fd993a25b2e4c61c4d4663bf007adad635397dae338e7e26938bbf181f0d31e8fd96393e04812190bda8a29eec3f1c39cf8b1b3e7523347e2d81bb

data/CHANGELOG.md

@@ -3,6 +3,7 @@ Version History
     * All Version bumps are required to update this file as well!!
 ----
 
+* 18.4.0 Adding support for Cover Letter APIs - Retrieve, List, and Delete.
 * 18.3.0 Correcting report a job to use xml request and correctly map model from response.
 * 18.2.2 Filter out release directory related information when getting the API caller.
 * 18.2.1 No functional changes, just renamed `execute_http_request` to `timed_http_request`.

data/lib/cb/config.rb

@@ -105,6 +105,9 @@ module Cb
       @uri_desired_job_type ||= '/consumer/datalist/desiredjobtype'
       @uri_state_list ||= '/ajax/citysuggest.aspx'
       @uri_report_job ||= '/v1/job/report'
+      @uri_cover_letter_list ||= '/v1/coverletter/list'
+      @uri_cover_letter_retrieve ||= '/coverletter/retrieve'
+      @uri_cover_letter_delete ||= '/coverletter/delete'
     end
 
     def set_attr_accessors

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

@@ -0,0 +1,25 @@
+# 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 CoverLetter
+      attr_reader :id, :name, :text, :created, :modified
+
+      def initialize(api_cover_letter)
+        @id = api_cover_letter['CoverLetterDID'] || api_cover_letter['ExternalId']
+        @name = api_cover_letter['CoverLetterName'] || api_cover_letter['Name']
+        @text = api_cover_letter['CoverLetterText'] || api_cover_letter['Text']
+        @created = api_cover_letter['CreatedDate'] || api_cover_letter['CreatedDT']
+        @modified = api_cover_letter['ModifiedDate'] || api_cover_letter['ModifiedDT']
+      end
+    end
+  end
+end

data/lib/cb/requests/cover_letter/delete.rb

@@ -0,0 +1,38 @@
+# 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/requests/base'
+
+module Cb
+  module Requests
+    module CoverLetter
+      class Delete < Base
+        def endpoint_uri
+          Cb.configuration.uri_cover_letter_delete
+        end
+
+        def http_method
+          :post
+        end
+
+        def body
+          <<-eos
+            <Request>
+              <DeveloperKey>#{ Cb.configuration.dev_key }</DeveloperKey>
+              <ExternalID>#{ args[:external_id] }</ExternalID>
+              <ExternalUserID>#{ args[:external_user_id] }</ExternalUserID>
+              <Test>#{ args[:test] || false }</Test>
+            </Request>
+          eos
+        end
+      end
+    end
+  end
+end

data/lib/cb/requests/cover_letter/list.rb

@@ -0,0 +1,31 @@
+# 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/requests/base'
+
+module Cb
+  module Requests
+    module CoverLetter
+      class List < Base
+        def endpoint_uri
+          Cb.configuration.uri_cover_letter_list
+        end
+
+        def http_method
+          :get
+        end
+
+        def query
+          { ExternalUserId: args[:external_user_id] }
+        end
+      end
+    end
+  end
+end

data/lib/cb/requests/cover_letter/retrieve.rb

@@ -0,0 +1,34 @@
+# 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/requests/base'
+
+module Cb
+  module Requests
+    module CoverLetter
+      class Retrieve < Base
+        def endpoint_uri
+          Cb.configuration.uri_cover_letter_retrieve
+        end
+
+        def http_method
+          :get
+        end
+
+        def query
+          {
+            ExternalId: args[:external_id],
+            ExternalUserId: args[:external_user_id]
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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 CoverLetter
+      class Delete < ApiResponse
+        def status
+          response[root_node]['Status']
+        end
+
+        private
+
+        def extract_models
+          nil
+        end
+
+        def validate_api_hash
+          required_response_field(root_node, response)
+        end
+
+        def hash_containing_metadata
+          response
+        end
+
+        def root_node
+          'ResponseUserDelete'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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 CoverLetter
+      class List < ApiResponse
+        private
+
+        def extract_models
+          [ cover_letters_node ].flatten.map { |api_cover_letter| Models::CoverLetter.new api_cover_letter }
+        end
+
+        def validate_api_hash
+          required_response_field(root_node, response)
+        end
+
+        def hash_containing_metadata
+          response
+        end
+
+        def cover_letters_node
+          response[root_node]['CoverLetters'].nil? ? [] : response[root_node]['CoverLetters']['CoverLetter']
+        end
+
+        def root_node
+          'ResponseListCoverLetters'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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 CoverLetter
+      class Retrieve < ApiResponse
+        private
+
+        def extract_models
+          Models::CoverLetter.new api_cover_letter
+        end
+
+        def validate_api_hash
+          required_response_field(root_node, response)
+        end
+
+        def hash_containing_metadata
+          response
+        end
+
+        def api_cover_letter
+          response[root_node]['CoverLetter']
+        end
+
+        def root_node
+          'ResponseRetrieve'
+        end
+      end
+    end
+  end
+end

data/lib/cb/utils/response_map.rb

@@ -44,6 +44,10 @@ module Cb
 
             Cb::Requests::Company::Find => Cb::Responses::Company::Find,
 
+            Cb::Requests::CoverLetter::List => Cb::Responses::CoverLetter::List,
+            Cb::Requests::CoverLetter::Retrieve => Cb::Responses::CoverLetter::Retrieve,
+            Cb::Requests::CoverLetter::Delete => Cb::Responses::CoverLetter::Delete,
+
             Cb::Requests::Education::Get => Cb::Responses::Education::Get,
 
             Cb::Requests::EmailSubscription::Retrieve => Cb::Responses::EmailSubscription::Response,

data/lib/cb/version.rb

@@ -9,5 +9,5 @@
 # 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
-  VERSION = '18.3.0'
+  VERSION = '18.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 18.3.0
+  version: 18.4.0
 platform: ruby
 authors:
 - The CareerBuilder.com Niche and Consumer Development teams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -262,6 +262,7 @@ files:
 - lib/cb/models/implementations/collapsed_job_results.rb
 - lib/cb/models/implementations/collapsed_jobs.rb
 - lib/cb/models/implementations/company.rb
+- lib/cb/models/implementations/cover_letter.rb
 - lib/cb/models/implementations/data_lists/resume_data_list.rb
 - lib/cb/models/implementations/education.rb
 - lib/cb/models/implementations/email_subscription.rb
@@ -300,6 +301,9 @@ files:
 - lib/cb/requests/base.rb
 - lib/cb/requests/category/search.rb
 - lib/cb/requests/company/find.rb
+- lib/cb/requests/cover_letter/delete.rb
+- lib/cb/requests/cover_letter/list.rb
+- lib/cb/requests/cover_letter/retrieve.rb
 - lib/cb/requests/data_lists/countries.rb
 - lib/cb/requests/data_lists/data_list_base.rb
 - lib/cb/requests/data_lists/desired_job_type.rb
@@ -333,6 +337,9 @@ files:
 - lib/cb/responses/application_external/submit_application.rb
 - lib/cb/responses/category/search.rb
 - lib/cb/responses/company/find.rb
+- lib/cb/responses/cover_letter/delete.rb
+- lib/cb/responses/cover_letter/list.rb
+- lib/cb/responses/cover_letter/retrieve.rb
 - lib/cb/responses/data_list/state.rb
 - lib/cb/responses/data_lists/resume_data_list.rb
 - lib/cb/responses/education/get.rb