leap_salesforce 0.2.12 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf476f468493821057b919e67cec01450df2e4776edeae3cf94ddccaac1d1539
-  data.tar.gz: '0364379e8b68a5873451b01411ae32346468e651729f8b6e883ca9393fb4b156'
+  metadata.gz: b3feb0e688629698af297a150795edc17670b52fdfc8660f8b2bd61c8459b69c
+  data.tar.gz: fcb2b17118935240b16cab2411396d1fef974f6d8a1bc8d8bc78939a10ed904f
 SHA512:
-  metadata.gz: feb85dd56212f73a939b83f3e5bd0c6c92ad366580b986b24e55acfeb01ab476fca9c9547bf0cb002dea17c1d430520913357274b37ff33ec05110990f306a55
-  data.tar.gz: 2ac29878de67c8f57b03025f901dd09bf53556eb1493c120b53a3e8466c55fa5dcaeee7111b58464a3b07150a8d92b2aa5bdd1a9ecc256095965a704e3757cb2
+  metadata.gz: 921f6485c50ed5afcc6a1f85e28ef135beac369d1deb7f7ed67e21cf2cab551bd59b23033dc4864b2db46228fcbb44e2eee73949bb5ff84600b9ba1d395fdd45
+  data.tar.gz: 28c1803bc0e76cb8b333fdfbc898f24c26887d228a2a3f39c29f5d0d24d493dd3e99a48b89f9f805d70d4a1ab3a16df121912a2867921495e835920107c22681

data/ChangeLog

@@ -1,3 +1,10 @@
+Version 0.2.13
+* Enhancement
+  * 'Leaps::User'
+    * Method to extract actual information regarding user, having accessor
+      for first name
+    * 'each' method to iterate over all/subset of users
+
 Version 0.2.12
 * Enhancement
   * Made optional alias 'Leaps' as shorter form of LeapSalesforce

data/lib/leap_salesforce/users/user.rb

@@ -22,17 +22,20 @@ module LeapSalesforce
       self.description = description
     end
 
+    # @return [User] Salesforce soql object for User
+    def soql_object
+      admin_query_user { ::User.find username: username }
+    end
+
+    # @return [String] First name of user
+    def first_name
+      admin_query_user { soql_object.first_name }
+    end
+
     # Query for user in Salesforce instance
     # @return [Boolean] Whether Salesforce user exists in environment running against
     def exists?
-      if defined? ::User
-        Users.execute_as_if_present key: :admin do
-          ::User.any?(username: username)
-        end
-      else
-        raise LeapSalesforce::SetupError, "'User' class must be defined " \
-        " to check presence of user in environment #{LeapSalesforce.environment}"
-      end
+      admin_query_user { ::User.any?(username: username) }
     end
 
     # @return [String] Username of User interpreted by ERB (in email address format).
@@ -52,5 +55,19 @@ module LeapSalesforce
         actual_value == criteria
       end
     end
+
+    private
+
+    # Execute block as admin user, raising error if User class is not defined
+    def admin_query_user
+      if defined? ::User
+        Users.execute_as_if_present key: :admin do
+          yield
+        end
+      else
+        raise LeapSalesforce::SetupError, "'User' class must be defined " \
+        " to check presence of user in environment #{LeapSalesforce.environment}"
+      end
+    end
   end
 end

data/lib/leap_salesforce/users/users.rb

@@ -22,29 +22,41 @@ module LeapSalesforce
         @list << User.new(*user)
       end
 
-      # @return [LeapSalesforce::User] A user that meets the criteria
-      def where(filter)
+      # @param [Symbol, Hash, String, Regexp, LeapSalesforce::User] filter Filter to find users by
+      # @param [Boolean] all Whether to return all users matching criteria, not just first
+      # @return [LeapSalesforce::User, Array] A user that meets the criteria
+      def where(filter, all: false)
+        @all = all
         case filter
         when :default then list.first # Will then use first user defined
         when Hash then match_params filter
         when String then match_params(username: filter)
         when Symbol then match_params(key: filter)
         when Regexp then match_params(description: filter)
-        when LeapSalesforce::User then filter
+        when User then filter
         else
-          raise "Unable to find user using class #{filter.class}"
+          raise UserError, "Unable to find user using class #{filter.class}"
         end
       end
 
-      # @return [LeapSalesforce::User] A user that meets the criteria
+      # Iterate through each user, narrowing on filter if provided
+      def each(filter = nil)
+        if filter
+          where(filter, all: true).each { yield }
+        else
+          list.each { yield }
+        end
+      end
+
+      # @return [LeapSalesforce::User, Array] A user that meets the criteria
       def match_params(hash_filter)
         lookup_key, lookup_value = hash_filter.first
-        user = list.find { |user_queried| user_queried.match?(lookup_key, lookup_value) }
-        unless user
+        users = list.find_all { |user_queried| user_queried.match?(lookup_key, lookup_value) }
+        if users.empty?
           raise UserError, "Unable to find user based on filer #{hash_filter}. " \
           "Users are: #{list}"
         end
-        user
+        @all ? users : users.first
       end
 
       # Execute block as user matching filter if that user is present

data/lib/leap_salesforce/version.rb

@@ -2,5 +2,5 @@
 
 module LeapSalesforce
   # @return [String] Version of leap salesforce
-  VERSION = '0.2.12'
+  VERSION = '0.2.13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.2.13
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2019-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler