leap_salesforce 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f223007c3c8d006fd9d639357756108c242a18f70a5843648ffe3393ce1928be
-  data.tar.gz: abe22b8c691f391158e38520476ed23e1378e54e2feabb4cac1ff366d422847b
+  metadata.gz: f2bdee6f535909036c914ded9bf6a3e558947795a7e2368a3cf0c9ba21901b3d
+  data.tar.gz: 26e600cd1fab6236d251738837e19c9034e0bb2e98cbfdfa7f535c93f4899a4e
 SHA512:
-  metadata.gz: 24fa2a866b764c494127fd2413c4a6f9c14d2faee72d0f47b3efec4a96295e9decdff0c2ebc8e701f880663c8777649d05a6fb5411a49255650106b75759c3f0
-  data.tar.gz: 1aad23255a4ee3233096a029962f24ecf7079850c67107834be0d11671c7165a673edb2733d8e586407a3dd68c368bd4ba52f1e23183127d4d3563b707eeb710
+  metadata.gz: 47508644606e0aa2b11a6654e4369ad469ae783df0f2c777a981b97332508420112e5a0e3297d959903f4a296bc306b891f95ce85ea5dd2680f4c6fd8b2ba3dd
+  data.tar.gz: fca8cb67769917a6542bbf27fc6047f9038d0078bd05ed1aa696f3215b45b84b114f2b87e82c66a8163432a8ac6c3aeddf0270548800f3848721bc1436f513c8

data/.idea/leap-salesforce.iml

@@ -22,7 +22,7 @@
     <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.3, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="domain_name (v0.5.20190701, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="factory_bot (v5.0.2, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="faker (v1.9.6, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="faker (v2.0.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="gyoku (v1.3.1, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="hashie (v3.6.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http-cookie (v1.0.3, RVM: ruby-2.6.0) [gem]" level="application" />
@@ -67,7 +67,7 @@
     <orderEntry type="library" scope="PROVIDED" name="sinatra (v2.0.4, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="sinatra-basic-auth (v0.1.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="sinatra-docdsl (v0.8.6, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="soaspec (v0.2.28, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="soaspec (v0.2.29, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="socksify (v1.7.1, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="thor (v0.20.3, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="thread_safe (v0.3.6, RVM: ruby-2.6.0) [gem]" level="application" />

data/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.1.13
+* Bug Fix
+  * Updated 'Delete' where must_pass of true was calling 'successful?' method on wrong object
+  * Account for new faker syntax of 2.0
+
 Version 0.1.12
 * Enhancements
   * Add contact factory to source control so it can be used to demonstrate traits and associations

data/PITCHME.md

@@ -78,12 +78,13 @@ metadata.
 ---?code=spec/integration/creating_spec.rb&lang=ruby&title=Creating entities
 
 @[1](Declare what it is you're testing)
-@[2](Define what 'it' is, a the object under test must do)
-@[3](Create an instance of the object class - nothing sent to Salesforce yet)
-@[4-5](Set the first and last name to random names)
-@[6](Create the object in Salesforce by sending request via API)
-@[7](Verify creation was successful)
-@[9-12](Creating through Factory)
+@[3](Define what 'it' is, a the object under test must do)
+@[4](Create an instance of the object class - nothing sent to Salesforce yet)
+@[5-6](Set the first and last name to random names)
+@[7](Create the object in Salesforce by sending request via API)
+@[8](Verify creation was successful)
+@[9](Verify first name set as expected)
+@[17-20](Creating through Factory)
 
 ---
 

data/README.md

@@ -55,6 +55,9 @@ this [here](https://asciinema.org/a/259098).
 
 ### Understanding how things work
  
+This section details what the most important files are, how to define test users
+ and how to create, read, update, and delete data. 
+ 
 #### Important files
 
 To see how things fit together, look at the [structure](#structure) section below.
@@ -111,6 +114,57 @@ LeapSalesforce.api_user = LeapSalesforce::Users.where username: /admin/
 LeapSalesforce.api_user = LeapSalesforce::Users.where description: /System Admin/
 ```
 
+#### CRUD of data
+
+To work data in Salesforce, an object inheriting from the `SoqlData` class is always used. The idea is
+that an object in Ruby code maps to the object in Salesforce and requests and updates to this object
+are reflected in Salesforce.
+
+When the initialisation script is run, it creates such classes in a folder called `soql_data`.
+
+Following a simple example of a class representing the 'ContentDocument' object in Salesforce. It 
+also requires a generated file that specifies accessors to set and retrieve information about the object.
+
+```ruby
+require_relative 'document_field_names'
+# An Document object mapping to a SOQL ContentDocument
+class Document < SoqlData
+  include Document::Fields
+  soql_object 'ContentDocument'
+end
+```
+
+For all interactions with Salesforce the API traffic logs are recorded in a log created in the `logs`
+folder of the suite.
+
+##### Creating entities
+
+There are several ways entities can be created. By instantiating the object with the `new` method a new
+object will be created in memory but in Salesforce. Only when the `save!` method is called will an object
+be created.
+
+For example
+
+```ruby
+@contact = Contact.new              # Create an object in memory
+@contact.last_name = 'Test Person'  # Set the last name field of that object to 'Test Person'
+@contact.save!                      # Calls Salesforce API to create a new object with the fields set in the object
+```
+
+The `log` for this call will look like the following:
+
+```verilog
+Leaps, [13:39:14] : Example Factory for 'Contact'
+Leaps, [13:39:14] : request body: {"FirstName":"Lewis","LastName":"Gleichner"}
+Leaps, [13:39:14] : RestClient.post "https://brave-otter-ttxype-dev-ed.my.salesforce.com/services/data/v45.0/sobjects/Contact", "{\"FirstName\":\"Lewis\",\"LastName\":\"Gleichner\"}", "Accept"=>"*/*", "Accept-Encoding"=>"gzip, deflate", "Authorization"=>"Bearer 00D2v000001eBDw!AREAQK_UWp9onsfZdv5ag5j70WIbwe_IG5tLJHKC1Ti0lpVZY0EsKcmpCE8bqTd7GtGx9WmN57PRpp06yhmfczK9TUR9rZx2", "Content-Length"=>"44", "Content-Type"=>"application/json", "User-Agent"=>"rest-client/2.0.2 (linux-gnu x86_64) ruby/2.6.0p0"
+
+Leaps, [13:39:16] : # => 201 Created | application/json 71 bytes
+
+Leaps, [13:39:16] : response: 
+  headers: {:date=>"Thu, 01 Aug 2019 01:39:15 GMT", :strict_transport_security=>"max-age=31536002; includeSubDomains", :public_key_pins_report_only=>"pin-sha256=\"9n0izTnSRF+W4W4JTq51avSXkWhQB8duS2bxVLfzXsY=\"; pin-sha256=\"5kJvNEMw0KjrCAu7eXY5HZdvyCS13BbA0VJG1RSP91w=\"; pin-sha256=\"njN4rRG+22dNXAi+yb8e3UMypgzPUPHlv4+foULwl1g=\"; max-age=86400; includeSubDomains; report-uri=\"https://a.forcesslreports.com/hpkp-report/00D2v000001eBDwm\";", :expect_ct=>"max-age=86400; report-uri=\"https://a.forcesslreports.com/Expect-CT-report/00D2v000001eBDwm\";", :x_content_type_options=>"nosniff", :x_xss_protection=>"1; mode=block", :x_robots_tag=>"none", :cache_control=>"no-cache,must-revalidate,max-age=0,no-store,private", :set_cookie=>["BrowserId=DOR6nshpQC659waq6EKS3A;Path=/;Domain=.salesforce.com;Expires=Mon, 30-Sep-2019 01:39:15 GMT;Max-Age=5184000"], :expires=>"Thu, 01 Jan 1970 00:00:00 GMT", :sforce_limit_info=>"api-usage=331/15000", :location=>"/services/data/v45.0/sobjects/Contact/0032v00002qU3hvAAC", :content_type=>"application/json;charset=UTF-8", :vary=>"Accept-Encoding", :content_encoding=>"gzip", :transfer_encoding=>"chunked"}
+  body: {"id":"0032v00002qU3hvAAC","success":true,"errors":[]}
+```
+
 ## Structure
 
 Following is the general structure of test automation suite that uses this approach. Details may vary depending on the

data/leap_salesforce.gemspec

@@ -33,12 +33,12 @@ It reads the Metadata from Salesforce and creates the foundation for API tests.'
   spec.add_dependency 'activerecord'
   spec.add_dependency 'colorize'
   spec.add_dependency 'factory_bot'
-  spec.add_dependency 'faker'
+  spec.add_dependency 'faker', '>= 2.0'
   spec.add_dependency 'humanize'
   spec.add_dependency 'rake'
   spec.add_dependency 'require_all'
   spec.add_dependency 'rubocop'
   spec.add_dependency 'rubykeyword'
-  spec.add_dependency 'soaspec', '>= 0.2.28'
+  spec.add_dependency 'soaspec', '>= 0.2.29'
   spec.add_dependency 'thor'
 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::SpecLogger.progname = 'Leaps'
 Soaspec::OAuth2.request_message = false
 Soaspec::OAuth2.retry_limit = 1 # Retrying for OAuth token too many times results in user locked out
 require 'active_support/core_ext/integer/time' # Creating time objects

data/lib/leap_salesforce/generator/default.rb

@@ -18,7 +18,7 @@ module LeapSalesforce
         def value_for(field, class_name)
           @field = field
           case field['type']
-          when 'string' then set("Faker::Lorem.paragraph_by_chars(#{field['length']})")
+          when 'string' then set("Faker::Lorem.paragraph_by_chars(number: #{field['length']})")
           when 'id' then set('Best to not hard code this', use_quotes: true)
           when 'boolean' then set('true')
           when 'picklist' then set("#{class_name}::#{field['label'].to_class_name}.sample")

data/lib/leap_salesforce/soql_data/soql_global_object_data.rb

@@ -162,17 +162,17 @@ module SoqlGlobalObjectData
   # Remove object from Salesforce with provided id
   # @param [String] id Id of element to remove
   # @param [Boolean] must_pass Whether to raise exception if call is not successful
-  # @return [Exchange] Exchange object making delete call
+  # @return [self] Exchange object making delete call
   def delete(id, must_pass: false)
     SoqlData.ids_to_delete.reject! { |table, id_to_remove| table == self && id_to_remove == id } # Remove id from list to delete
     remove_dependent_records(id)
 
     SoqlHandler.new("Delete #{id}").use
-    delete = new('SOQL Delete', method: :delete, suburl: "sobjects/#{soql_object_name}/#{id}")
+    delete = new("SOQL Delete #{id}", method: :delete, suburl: "sobjects/#{soql_object_name}/#{id}")
     delete.call
     return delete unless must_pass
 
-    successful?
+    delete.successful?
     delete
   end
 

data/lib/leap_salesforce/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2019-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: humanize
   requirement: !ruby/object:Gem::Requirement
@@ -199,14 +199,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.28
+        version: 0.2.29
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.28
+        version: 0.2.29
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement