cb-api 5.4.0 → 5.5.0

data/README.md

@@ -5,6 +5,18 @@ Now that you have a key, lets get to the good stuff.
 You can find an example rails site that uses the gem here:
 https://github.com/cbdr/ruby-cb-api-demo
 
+Installation
+================
+
+Install required gems:
+
+    gem install iconv
+    gem install cb-api
+
+Require the library in your Ruby script:
+
+    require 'cb'
+
 Configuration
 ================
 Set your dev key, and any other configuration settings in a place that will run prior to your API calls.

data/lib/cb/clients/user.rb

@@ -11,7 +11,13 @@ module Cb
           Cb::Responses::User::CheckExisting.new(response)
         end
 
-        def retrieve external_id, test_mode = false
+        def temporary_password(external_id)
+          query = { 'ExternalID' => external_id }
+          response = api_client.cb_get(Cb.configuration.uri_user_temp_password, query: query)
+          Cb::Responses::User::TemporaryPassword.new(response)
+        end
+
+        def retrieve(external_id, test_mode = false)
           my_api = Cb::Utils::Api.new
           json_hash = my_api.cb_post Cb.configuration.uri_user_retrieve, :body => build_retrieve_request(external_id, true)
           if json_hash.has_key? 'ResponseUserInfo'
@@ -24,7 +30,7 @@ module Cb
           my_api.append_api_responses user, json_hash
         end
 
-        def change_password external_id, old_password, new_password, test_mode = false
+        def change_password(external_id, old_password, new_password, test_mode = false)
           result = false
           my_api = Cb::Utils::Api.new
           json_hash = my_api.cb_post Cb.configuration.uri_user_change_password, :body => build_change_password_request(external_id, old_password, new_password, test_mode)
@@ -39,7 +45,7 @@ module Cb
           my_api.append_api_responses result, json_hash
         end
 
-        def delete external_id, password, test_mode = false
+        def delete(external_id, password, test_mode = false)
           result = false
           my_api = Cb::Utils::Api.new
           json_hash = my_api.cb_post Cb.configuration.uri_user_delete, :body => build_delete_request(external_id, password, test_mode)
@@ -67,7 +73,7 @@ module Cb
           eos
         end
 
-        def build_retrieve_request external_id, test_mode
+        def build_retrieve_request(external_id, test_mode)
           <<-eos
             <Request>
               <DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>
@@ -77,7 +83,7 @@ module Cb
           eos
         end
 
-        def build_change_password_request external_id, old_password, new_password, test_mode
+        def build_change_password_request(external_id, old_password, new_password, test_mode)
           <<-eos
             <Request>
               <DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>
@@ -89,7 +95,7 @@ module Cb
           eos
         end
 
-        def build_delete_request external_id, password, test_mode
+        def build_delete_request(external_id, password, test_mode)
           <<-eos
             <Request>
               <DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>

data/lib/cb/config.rb

@@ -8,7 +8,7 @@ module Cb
                   :uri_recommendation_for_company,
                   :uri_application, :uri_application_submit,
                   :uri_application_external,
-                  :uri_application_registered, :uri_user_change_password,
+                  :uri_application_registered, :uri_user_change_password, :uri_user_temp_password,
                   :uri_user_delete, :uri_user_retrieve, :uri_user_check_existing,
                   :uri_job_branding,
                   :uri_resume_own_all, :uri_resume_retrieve,
@@ -44,6 +44,7 @@ module Cb
       @uri_user_delete                    ||= '/v2/User/delete'
       @uri_user_retrieve                  ||= '/v2/user/retrieve'
       @uri_user_check_existing            ||= '/v2/user/checkexisting'
+      @uri_user_temp_password             ||= '/v1/user/temporarypassword'
       @uri_job_branding                   ||= '/branding'
       @uri_resume_own_all                 ||= '/v2/resume/ownall'
       @uri_resume_retrieve                ||= '/v2/resume/retrieve'

data/lib/cb/responses/timing.rb

@@ -29,7 +29,21 @@ module Cb
       end
 
       def parsed_time_elapsed
-        response.include?('TimeElapsed') ? response['TimeElapsed'].to_f : nil
+        elapsed_node_parsable? ? response[elapsed_node].to_f : nil
+      end
+
+      def elapsed_node_parsable?
+        response.include?(elapsed_node) &&
+        response[elapsed_node].respond_to?(:to_f) &&
+        timing_parses_to_nonzero?
+      end
+
+      def timing_parses_to_nonzero?
+        response[elapsed_node].to_f != 0.0
+      end
+      
+      def elapsed_node
+        'TimeElapsed'
       end
     end
 

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

@@ -0,0 +1,38 @@
+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
+
+        protected
+
+        def validate_api_hash
+          required_response_field(password_node, response)
+        end
+
+        def extract_models
+          response[password_node]
+        end
+
+        def hash_containing_metadata
+          response
+        end
+
+        def raise_on_timing_parse_error
+          false
+        end
+
+        private
+
+        def password_node
+          'TemporaryPassword'
+        end
+      end
+
+    end
+  end
+end

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '5.4.0'
+  VERSION = '5.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -218,6 +218,7 @@ files:
 - lib/cb/responses/spot/retrieve_response.rb
 - lib/cb/responses/api_response.rb
 - lib/cb/responses/user/check_existing.rb
+- lib/cb/responses/user/temporary_password.rb
 - lib/cb/responses/timing.rb
 - lib/cb/responses/saved_search/list.rb
 - lib/cb/responses/saved_search/singular.rb