leap_salesforce 0.1.1 → 0.1.2

data/ChangeLog

@@ -1,5 +1,13 @@
+Version 0.1.2
+* Enhancements
+  * Added color to output messages
+  * Add ticks when successful
+  * Check for Salesforce connectivity and OAuth connection on initialisation
+  * Add picklist spec into initially created spec files
+
 Version 0.1.1
 * Enhancements
   * Suggestions for generated factory
   * Begin unit tests
-  * Handle Macrons by ensuring they're not copied into Ruby names / Modules
+  * Handle Macrons by ensuring they're not copied into Ruby names / Modules
+  * Created executable

data/README.md

@@ -23,7 +23,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After installing the gem, to get started in creating a fresh repository, the `leap_salesforce` executable can be used.
+
+E.g
+
+```
+leap_salesforce init
+```
+
+
 
 ## Docs
 

data/exe/leap_salesforce

@@ -6,6 +6,8 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'thor'
 require 'leap_salesforce/parameters'
 require 'leap_salesforce/generator/generator'
+require 'leap_salesforce/error'
+require 'colorize'
 
 module LeapSalesforce
   # Executable for setting up Leap Salesforce
@@ -26,26 +28,26 @@ module LeapSalesforce
     def init
       # Ask user to create OAuth application by following
       unless options[:setup_done]
-        oauth_setup = input_for "Have you set up OAuth application by following #{OAUTH_WIKI} (y/n)?"
+        oauth_setup = input_for "Have you set up OAuth application by following #{OAUTH_WIKI} (y/n)?", :red
         exit if oauth_setup.downcase == 'n'
       end
 
       query_for_parameters
       generate_files binding, ['Gemfile', 'Rakefile', '.leap_salesforce.yml', '.rspec',
                                { config: ['general.rb', { credentials: 'salesforce_oauth2.yml' }] },
-                               { spec: %w[spec_helper.rb limit_spec.rb crud_eg_spec.rb] }]
+                               { spec: %w[spec_helper.rb limit_spec.rb crud_eg_spec.rb picklists_spec.rb] }]
 
       environment_content = read_template File.join('config', 'environments', 'specific_file.rb.erb'),
                                           binding
-      generate_file File.join('config', 'environments', "#{@environment}.rb"), environment_content,
-                    overwrite: false
+      generate_file File.join('config', 'environments', "#{LeapSalesforce.environment}.rb"),
+                    environment_content, overwrite: false
 
-      puts 'Initial files created!'
-      puts 'Installing gems'
+      puts "\u2713 Initial files created!".colorize :green
+      puts 'Installing gems'.colorize :yellow
       puts `bundle install`
-      puts 'Creating initial Soql objects. See ".leap_salesforce.yml" for list'
+      puts 'Creating initial Soql objects. See ".leap_salesforce.yml" for list'.colorize :yellow
       puts `rake leaps:create_soql_objects`
-      puts 'Creating enums'
+      puts 'Creating enums'.colorize :yellow
       puts `rake leaps:create_enums`
     end
   end

data/leap_salesforce.gemspec

@@ -31,6 +31,7 @@ It reads the Metadata from Salesforce and creates the foundation for API tests.'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'topoisomerase'
   spec.add_dependency 'activerecord'
+  spec.add_dependency 'colorize'
   spec.add_dependency 'factory_bot'
   spec.add_dependency 'faker'
   spec.add_dependency 'rake'

data/lib/leap_salesforce/error.rb

@@ -0,0 +1,10 @@
+module LeapSalesforce
+  # Any error specific to LeapSalesforce
+  class Error < StandardError; end
+  # Error related to handling a response
+  class ResponseError < StandardError; end
+  # Error related to setup of test automation suite
+  class SetupError < Error; end
+  # Error related to Test Users
+  class UserError < Error; end
+end

data/lib/leap_salesforce/generator/exe_helpers.rb

@@ -1,29 +1,63 @@
 # frozen_string_literal: true
 
+require 'io/console'
+require 'rest-client'
+require 'soaspec'
+
 module LeapSalesforce
   # Helpers for LeapSalesforce executable
   module ExeHelpers
     # Return input for query
     # @param [String] query Query to ask on terminal
     # @return [String] User input to store
-    def input_for(query)
-      puts query
+    def input_for(query, color = nil)
+      if color
+        puts query.colorize(color)
+      else
+        puts query
+      end
       $stdin.gets.strip
     end
 
+    # Retrieve environment and ensure that environment can be connected to
+    def verify_environment
+      LeapSalesforce.environment = options[:environment] || input_for('Enter the environment you want to set things up for ' \
+'(This will be parameterised so can be changed later). For production used "prod". Otherwise preference is to use the' \
+' part of the URL that is unique for the environment')
+      # Verify connection to environment
+      RestClient.get(LeapSalesforce.general_url)
+    rescue SocketError
+      message = "Unable to connect to #{LeapSalesforce.general_url}. Potentially problem with" \
+      ' internet or proxy settings'.colorize :red
+      raise LeapSalesforce::SetupError, message
+    else
+      puts "\u2713 Connection to #{LeapSalesforce.general_url} successful".colorize :green
+    end
+
+    # Retrieve OAuth credentials and verify that they're correct
+    def verify_oauth
+      LeapSalesforce.client_id = options[:client_id] || input_for('Client id (Customer Id)')
+      LeapSalesforce.client_secret = options[:client_secret] || STDIN.getpass('Client secret (Consumer Secret)')
+      LeapSalesforce.api_user = options[:username] || input_for('Salesforce username. It is ideal to start with a System admin' \
+' so that any necessary metadata can be read. More users can be added later. You can use ERB to make name' \
+' vary according to environment (e.g., test.user@<%= LeapSalesforce.environment %>.my.company.com)')
+      LeapSalesforce.password = options[:password] || STDIN.getpass('Password (Recommendation is that 1 password' \
+' be shared across all test users to be easier to manage):')
+      Soaspec::OAuth2.debug_oauth = true
+      Soaspec::OAuth2.new(LeapSalesforce.oauth_settings).access_token
+    rescue StandardError
+      raise LeapSalesforce::SetupError, "Cannot perform OAuth. See 'logs' folder for details of what was sent"
+    else
+      puts "\u2713 OAuth successful".colorize :green
+    end
+
     # Ask user to enter parameters specific to their Salesforce environment
     def query_for_parameters
-      puts 'Please enter the following information to generate files for a new leap_salesforce testing repo'
-      # Ask for OAuth credential details
-      @client_id = options[:client_id] || input_for('Enter the client id')
-      @client_secret = options[:client_secret] || input_for('Enter the client secret')
-      @username = options[:username] || input_for('Enter the Salesforce username. It is ideal to start with a System admin' \
-' so that any necessary metadata can be read')
+      puts 'Please enter the following information to generate files for a new' \
+      ' leap_salesforce testing repo'.colorize(:green)
+      verify_environment
+      verify_oauth
       @user_key = options[:user_key] || input_for('Enter a key to refer to this user (This will be stored as a Symbol)')
-      @password = options[:password] || input_for('Enter password for this user. Recommendation is that 1 password be shared across' \
-' all test users to be easier to manage')
-      @environment = options[:environment] || input_for('Enter the environment you want to set things up for ' \
-'(This will be parameterised so can be changed later)')
     end
   end
 end

data/lib/leap_salesforce/generator/generator.rb

@@ -2,6 +2,7 @@
 require 'erb'
 require 'fileutils'
 require_relative 'exe_helpers'
+require 'colorize'
 
 module LeapSalesforce
   # Generators for creating code
@@ -18,10 +19,10 @@ module LeapSalesforce
     # @param [String] content Content to put within file
     def generate_file(filename, content, overwrite: true)
       FileUtils.mkdir_p File.dirname filename unless File.directory? File.dirname(filename)
-      return puts "File '#{filename}' already exists, skipping..." if (File.exist?(filename) && !overwrite)
+      return puts "File '#{filename}' already exists, skipping...".colorize :red if File.exist?(filename) && !overwrite
 
       File.write filename, content
-      puts "Created file at #{filename}"
+      puts "\u2713 Created file at #{filename}".colorize :green
     end
 
     # @example Create a spec_helper file and test file in spec folder

data/lib/leap_salesforce/generator/templates/.leap_salesforce.yml.erb

@@ -1,4 +1,4 @@
-environment: <%= @environment %>
+environment: <%= LeapSalesforce.environment %>
 # lib_folder: lib/leap_salesforce # Default folder where assets will be stored
 soql_objects:
   - Case

data/lib/leap_salesforce/generator/templates/config/credentials/salesforce_oauth2.yml.erb

@@ -1,3 +1,3 @@
-client_id: '<%= @client_id %>'
-client_secret: '<%= @client_secret %>'
-password: '<%= @password %>'
+client_id: '<%= LeapSalesforce.client_id %>'
+client_secret: '<%= LeapSalesforce.client_secret %>'
+password: '<%= LeapSalesforce.password %>'

data/lib/leap_salesforce/generator/templates/config/general.rb.erb

@@ -2,5 +2,5 @@
 
 # Add users to LeapSalesforce context. First user is the default
 module LeapSalesforce
-  Users.add User.new <%= ":#{@user_key}" %>, '<%= @username %>'
+  Users.add User.new <%= ":#{@user_key}" %>, '<%= LeapSalesforce.api_user %>'
 end

data/lib/leap_salesforce/generator/templates/spec/picklists_spec.rb.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Picklists' do
+  LeapSalesforce.objects_to_verify.each do |data_class|
+    SoqlEnum.values_for(data_class).each do |picklist|
+      it "#{picklist} has not changed values" do
+        expect(picklist.values).to match_array data_class.picklist_for(picklist.name)
+      end
+    end
+  end
+end

data/lib/leap_salesforce/parameters.rb

@@ -3,7 +3,7 @@
 require_relative 'users/users'
 require_relative 'soql_object'
 
-# Adding parameters to set for authentication
+# Adding parameters to set for authentication, environment and other common settings
 module LeapSalesforce
   @config_folder = 'config'
   @lib_folder = File.join('lib', 'leap_salesforce').freeze
@@ -20,6 +20,23 @@ module LeapSalesforce
       ENV['LEAP_ENV'] || @environment
     end
 
+    # @return [Hash] OAuth2 parameters used in connecting to salesforce
+    def oauth_settings
+      settings = {
+        username: '<%= LeapSalesforce.api_user %>', password: LeapSalesforce.password,
+        client_id: LeapSalesforce.client_id,
+        client_secret: LeapSalesforce.client_secret,
+        token_url: "#{LeapSalesforce.general_url}/services/oauth2/token"
+      }
+      settings[:security_token] = LeapSalesforce.security_token if LeapSalesforce.security_token
+      settings
+    end
+
+    # @return [String] General salesforce URL for logging in to
+    def general_url
+      "https://#{LeapSalesforce.environment == 'prod' ? 'login' : 'test'}.salesforce.com"
+    end
+
     # @param [String, LeapSalesforce::User] user User or email address of user
     def api_user=(user)
       @api_user = case user
@@ -47,6 +64,8 @@ module LeapSalesforce
     attr_accessor :client_id
     # @return [String] Client secret in Salesforce OAuth app
     attr_accessor :client_secret
+    # @return [String] Token specific to a user used for authentication
+    attr_accessor :security_token
     # @return [String] Path where library generated assets are stored. By default lib/leap_salesforce
     attr_accessor :lib_folder
     # @return [Array] List of objects to verify metadata for. This includes enums, required values

data/lib/leap_salesforce/soql_data/soql_handler.rb

@@ -2,14 +2,12 @@
 
 require 'soaspec'
 
-# Handles basic Soql interactions.
+# Handles basic Soql interactions. These are done through classes that are tied to this handler, i.e, the SoqlData
+# class.
 # Credentials are stored either in 'config/credentials' folder or via environment variables
 # To check out SOQL SCHEMA go to workbench.developerforce.com. Use Sandbox and login
 class SoqlHandler < Soaspec::RestHandler
-  oauth2 username: '<%= LeapSalesforce.api_user %>', password: LeapSalesforce.password,
-         client_id: LeapSalesforce.client_id,
-         client_secret: LeapSalesforce.client_secret,
-         token_url: "https://#{LeapSalesforce.environment == 'prod' ? 'login' : 'test'}.salesforce.com/services/oauth2/token"
+  oauth2 LeapSalesforce.oauth_settings
   base_url '<%= instance_url %>/services/data/v<%= api_version %>/'
 
   pascal_keys true

data/lib/leap_salesforce/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LeapSalesforce
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/leap_salesforce.rb

@@ -13,17 +13,7 @@ require 'require_all'
 require 'rake'
 require 'factory_bot' # For mass production of data
 require 'faker' # For fake data
-
-module LeapSalesforce
-  class Error < StandardError; end
-  # Error related to handling a response
-  class ResponseError < StandardError; end
-  # Error related to setup of test automation suite
-  class SetupError < Error; end
-  # Error related to Test Users
-  class UserError < Error;
-  end
-end
+require 'leap_salesforce/error'
 
 LEAP_CONFIG_FILE = '.leap_salesforce.yml'
 CREDENTIAL_FILE = File.join('config', 'credentials', 'salesforce_oauth2.yml')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - IQA
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -231,6 +245,7 @@ files:
 - exe/leap_salesforce
 - leap_salesforce.gemspec
 - lib/leap_salesforce.rb
+- lib/leap_salesforce/error.rb
 - lib/leap_salesforce/ext/string.rb
 - lib/leap_salesforce/ext/time.rb
 - lib/leap_salesforce/generator/default.rb
@@ -251,6 +266,7 @@ files:
 - lib/leap_salesforce/generator/templates/soql_object_field_names.rb.erb
 - lib/leap_salesforce/generator/templates/spec/crud_eg_spec.rb.erb
 - lib/leap_salesforce/generator/templates/spec/limit_spec.rb.erb
+- lib/leap_salesforce/generator/templates/spec/picklists_spec.rb.erb
 - lib/leap_salesforce/generator/templates/spec/spec_helper.rb.erb
 - lib/leap_salesforce/limits.rb
 - lib/leap_salesforce/parameters.rb