leap_salesforce 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457d0417a4b8be95ecd61db1b0ac53616900b504ce8c1eecc333c1e7ea5abfe9
-  data.tar.gz: 792af4fccfe7d765c7885cec8c3a4ff359bdcf1acf929869a2c4aa754173f885
+  metadata.gz: b19edc03763b60a2d097dde77935d9db5c5aed17ee22d0c3978f695a861cf603
+  data.tar.gz: 7c6487aa730adc662ab69109aa9a0f49270746e2dfd06b15989c5fb064b5693e
 SHA512:
-  metadata.gz: 8f2dce774c2571a06064ea7c2f865dc77719eb889df63d03f86313bb37c52b3360a48ab58c8183f6644cbbf70ec221db5759f5274a91c4f0d6f913835613221b
-  data.tar.gz: c96e12f15cdd3857d5b5766d95a70f443c6f8054345c2acf4c69ff6a640213f03173262b6dcd57b2fa779cf223f8c23cdf891ed5b95319c3c217c3a64273d1e4
+  metadata.gz: 5c9b6f9ed699b7f8708523e4d31cf03e5a2e34794d2050429dc463997b2f49a5b1f52c4ee23048355eb59086c153d1983a128eaade27ee332c40c8f41e0cd8a9
+  data.tar.gz: dc89cb3970f516154ef2fd6e72173e2cca4c13ef313ef7840d24b447887ce2d689400867f9203b342dfe4fc1bfbad8ad089c392e9b497fab72e34fc7f8069e55

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.1.9
+* Enhancements
+  * Updated logs handling so that the user used for API is not unnecessarily repeated
+* Bug Fix
+  * Fixed issue with handling a string with '$Number' by updating order
+
 Version 0.1.8
 * Bug Fix
   * Numbers at start of picklist names were not working and having different label and backend names broke things too

data/README.md

@@ -7,6 +7,8 @@ In the future it will also planned to be used to create page objects based on me
 
 [![Build Status](https://gitlab.com/leap-dojo/leap_salesforce/badges/master/build.svg)](https://gitlab.com/leap-dojo/leap_salesforce/pipelines)
 
+> Note this documentation is a work in progress. Look at `spec` for code examples.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -48,17 +50,89 @@ E.g.,
 
 `rake` # Run all tests
 
-API Traffic logs can be seen in the `logs` folder.
+API Traffic logs can be seen in the `logs` folder. You can see an example of running through this [here](https://asciinema.org/a/259098)
+
+### Understanding how things work
+ 
+#### Important files
+
+To see how things fit together, look at the [structure](#structure) section below.
+
+##### `.leap_salesforce.yml` 
+
+This YAML file describes common configuration for the project.
+
+Following is a description of each key in this file:
+* `environment`: Specifies the default environment for this suite. This can be overwritten with the `LEAP_ENV` environment variable.
+* `lib_folder`: Can be set to change the default location (`lib/leap_salesforce`) of where all generated code is put 
+and read from.
+* `soql_objects`: List of SOQL objects that the generator will create for and update
+
+##### `salesforce_oauth2.yml`
+
+* client_id: OAuth2 client id / customer id obtained from your Test App
+* client_secret: OAuth2 client_secret / customer secret obtained from your Test App 
+* password: Password expected to be generic across test users and the same as what's used on the UI to logon with
+
+This file is read and sets attributes of `LeapSalesforce` globally. These can also be set with the following format
+
+```ruby
+LeapSalesforce.password = 'PASS'
+```
+
+##### `config/general.rb`
+
+This is where common code is stored for all the environments. This is where you would usually put your test users 
+as described in the next section.
+
+#### Test Users
+Test users are defined using the `LeapSalesforce::Users` module. Following is an example of setting up a few test
+users:
+
+```ruby
+module LeapSalesforce
+  # Example where email address changes according to environment
+  # Users can be added by passing an array or passing a LeapSalesforce::User object 
+  Users.add [:admin, 'admin@<%= LeapSalesforce.environment %>.email.com', description: 'System Admin User']
+  Users.add User.new :sales, 'test.sales@test<%= LeapSalesforce.environment %>.com'
+end
+``` 
 
-TODO: Finish this. A lot more needed
+The first user defined will be the default user. Following users can be set by using the `api_user` attribute.
+
+```ruby
+# Using key to specify user
+LeapSalesforce.api_user = LeapSalesforce::Users.where(key: :sales)
+# Using username that has a partial match with a Regex
+LeapSalesforce.api_user = LeapSalesforce::Users.where username: /admin/
+# Using description that has a partial match with a Regex. This might be helpful if you're setting users from 
+# a Cucumber step definition where readability is important 
+LeapSalesforce.api_user = LeapSalesforce::Users.where description: /System Admin/
+```
 
 ## Structure
 
-    .
-    ├──  config         # Code for the configuration of the automation suite
-    │   ├── general.rb  # Code loaded for common (non confidential code) setup across environments
-    │   ├── credentials #   
+Following is the general structure of test automation suite that uses this approach. Details may vary depending on the
+test framework used and other preferences.
 
+    .
+    ├──  config                         # Code for the configuration of the automation suite
+    │   ├── general.rb                  # Code loaded for common (non confidential code) setup across environments
+    │   ├── credentials                 # Setting of secret properties like passwords
+    │   │  └── salesforce_oauth2.yml    # Credentials for connecting to Salesforce via OAuth2
+    │   └── environments                # Contains ruby files loaded specific to environment following `ENVIRONMENT_NAME.rb` 
+    ├──  lib                            # Common library code
+    │   └── leap_salesforce             # Code generated by or specific to leap_salesforce
+    │      ├── factories                # FactoryBot definitions, describing how to mass produce objects
+    │      ├── metadata                 # Code generated and updated automatically from metadata
+    │      │  └── enum                  # Picklist enumeration objects are stored here 
+    │      └── soql_data                # Objects for handling each object in the backend specified in '.leap_salesforce.yml'
+    ├──  logs                           # Contains API traffic logs for transactions against Salesforce
+    ├──  spec                           # Where RSpec automated tests are stored
+    ├──  .leap_salesforce.yml           # Where common configuration is stored regarding your project. This complements and is read before what's in 'config'
+    ├──  Gemfile                        # Where required ruby gems/libraries are specified
+    ├──  Gemfile.lock                   # Generated file specified details of versions installed by `Gemfile`
+    └──  Rakefile                       # Where common `Rake` tasks are specified. LeapSalesforce specific tasks are required from here
 
 ## Docs
 
@@ -72,7 +146,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://gitlab.com/leap-dojo/leap_salesforce. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/leap-dojo/leap_salesforce. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/leap_salesforce.gemspec

@@ -39,6 +39,6 @@ It reads the Metadata from Salesforce and creates the foundation for API tests.'
   spec.add_dependency 'require_all'
   spec.add_dependency 'rubocop'
   spec.add_dependency 'rubykeyword'
-  spec.add_dependency 'soaspec'
+  spec.add_dependency 'soaspec', '>= 0.2.26'
   spec.add_dependency 'thor'
 end

data/lib/leap_salesforce/ext/string.rb

@@ -13,9 +13,9 @@ class String
   def to_ruby_friendly
     tr('&|=', '_').gsub('<', '_lt_').gsub('>', '_gt_')
                   .remove_macrons
-                  .humanize_numbered_string
                   .gsub(/[\s]+/, '_')
                   .gsub(/[\W]/, '') # Remove any other special characters
+                  .humanize_numbered_string
   end
 
   # @return [String] Convert String to form a class could use

data/lib/leap_salesforce/parameters.rb

@@ -46,6 +46,7 @@ module LeapSalesforce
                   else
                     raise ArgumentError, "Unable to use class '#{user.class}' to set api_user"
                   end
+      Soaspec::SpecLogger.info "Using user '#{@api_user}'"
     end
 
     # @return [String] Salesforce username used to execute API tests. This can be changed during tests

data/lib/leap_salesforce/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module LeapSalesforce
-  VERSION = '0.1.8'
+  # @return [String] Version of leap salesforce
+  VERSION = '0.1.9'
 end

data/lib/leap_salesforce.rb

@@ -5,6 +5,7 @@ require 'leap_salesforce/version'
 require 'soaspec'
 Soaspec::OAuth2.refresh_token = :once # Save access token and reuse it
 Soaspec.log_warnings = false # Log any API warnings
+Soaspec::OAuth2.request_message = false
 require 'active_support/core_ext/integer/time' # Creating time objects
 require 'leap_salesforce/parameters'
 require 'leap_salesforce/ext/string'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - IQA
@@ -199,14 +199,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.26
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.26
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement