ruby_raider 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f699ce6dfbac0c7e24138755df16fcaaf27e3da351d6dfc4e5f7b1ad8df87e5
-  data.tar.gz: f3fb59894beaf8492d3e1cb608cf59b391363f85ed2a6846ff543e9988e2f7ad
+  metadata.gz: 73b511158597de3220db924f54274e1927bfc868354a14de1f1258fc9c5cbfe3
+  data.tar.gz: f767e96bbf74bcd1445c7df25015e4c3be0023665b563eb2d2c0ba52dfb0f2d9
 SHA512:
-  metadata.gz: 0aae1fa17d24a1e413356bfd2efa84581ec29c904c6b78311fabfb38975be8e2267497856f2cd9632ddbfa225f67e4ca0f3e964349d1ec94fb11627634b0b6ce
-  data.tar.gz: 16f14221f3c9753acce661104bae09299ff92c56c886ecad4f8113f023cc14ca5905f48da1404106f275e1ca77c9dc16d7cc7f2e602b6e65334740cf8e2c9da2
+  metadata.gz: 2d4b944d4d72e9fd3c2be66740a2b19d0c4db088161a10055a538c90c629a6383f670965ea8b99b7f50cd6ea8dfdd52477d9a093a772cb1cd81b6d6cbe5c542b
+  data.tar.gz: 9b3c33fd07290c620dae1624518b94e0f82fd2e5a204e8b930fd1939d1085ce002904a31ccfee55b24197207ae5efb71e5a1f92c22c02b1f9ae9e0c83db165be

data/.gitignore

@@ -1,4 +1,5 @@
 ruby_raider-*.gem
 .idea/
 ruby_raider.iml
-Gemfile.lock
+Gemfile.lock
+.env

data/CONTRIBUTING.md

@@ -1 +1,6 @@
 How to start contributing
+
+First fork the repository
+clone the repository  into a folder on your system
+create a working branch such a development
+then open the folder in the editor of your choice

data/README.md

@@ -58,7 +58,12 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
 
-***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.).***
+***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read
+more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.)
+.***
+
+***To use the open ai integration you need to set up the OPENAI_ACCESS_TOKEN environment variable and
+you can also set the optional OPENAI_ORGANIZATION_ID if you have an organization***
 
 This works in all the platforms (Tested on Mac OS, Linux and Windows).
 
@@ -78,52 +83,38 @@ gem install ruby_raider
 raider new [name_of_project]
 ```
 
-Then a TUI/CLI will appear where the configuration of which frameworks you want to be generated/scaffolded can be selected.
+Then a TUI/CLI will appear where the configuration of which frameworks you want to be generated/scaffolded can be
+selected.
 
 Select the ones you will like to work with.
 
-### Ruby raider provides the following list of commands
+### Ruby raider provides the following list of basic commands
 
 ###### Anything between square brackets([...]) is where your imput goes
 
 ```ruby
-Commands:
-  raider browser [BROWSER]          # Sets the default browser for a project
-  
-  raider browser_options [OPTIONS]  # Sets the browser options for the project
-
-  raider feature [FEATURE_NAME]     # Creates a new feature
-  
-  raider help [COMMAND]             # Describes available commands or one specific command
-  
-  raider helper [HELPER_NAME]       # Creates a new helper
-  
-  raider new [PROJECT_NAME]         # Creates a new framework based on settings picked
-
-  raider open_ai [REQUEST]          # Uses open AI to create a file or generate output
- 
-  raider page [PAGE_NAME]           # Creates a new page object
-  
-  raider path [PATH]                # Sets the default path for scaffolding
-
-  raider platform [PLATFORM]        # Sets the default platform for a cross-platform project
-  
-  raider raid                       # Runs all the tests in a project
-  
-  raider scaffold [SCAFFOLD_NAME]   # Generates everything needed to start automating
-  
-  raider spec [SPEC_NAME]           # Creates a new spec
-  
-  raider url [URL]                  # Sets the default url for a project
-  
-  raider version                    # It shows the version of Ruby Raider you are currently using
+Commands :
+  raider generate # Provides access to all the generators commands
+raider help [COMMAND] # Describe available commands or one specific command
+raider new [PROJECT_NAME] # Creates a new framework based on settings picked
+raider open_ai # Provides access to all the open ai commands
+raider utility # Provides access to all the utility commands
+raider version # It shows the version of Ruby Raider you are currently using
 ```
 
+All the basic commands have their corresponding shortcut:
+
+* g for generate
+* n for new
+* o for open_ai
+* u for utility
+* v for version
+
 Ruby raider also supports scaffolding:
 
-* To create a new page object you do: ```raider page [PAGE_NAME]```
-* To create a new spec you do: ```raider spec [SPEC_NAME]```
-* To create a new feature you do: ```raider feature [FEATURE_NAME]```
+* To create a new page object you do: ```raider g page [PAGE_NAME]```
+* To create a new spec you do: ```raider g spec [SPEC_NAME]```
+* To create a new feature you do: ```raider g feature [FEATURE_NAME]```
 
 It's possible to add the option --path or -p if you want to specify where to create your features, pages, helpers and
 specs.
@@ -131,9 +122,30 @@ specs.
 If you want to set the default path for the creation of your features, helpers and specs:
 
 ```ruby
-raider path [PATH_NAME] --feature or -f
-raider path [PATH_NAME] --spec or -s
-raider path [PATH_NAME] --helper or -h
+raider u path [PATH_NAME] - -feature or -f
+raider u path [PATH_NAME] - -spec or -s
+raider u path [PATH_NAME] - -helper or -h
 ```
 
 If you don't specify an option, path will assume you want to change the default path for pages.
+
+### Open AI Commands
+
+```ruby
+# Will print the result of the request on the terminal
+raider o make [REQUEST]
+# Will create a file with the result of your request as content
+raider o make [REQUEST] - -path or -p [PATH]
+# Will input the content of the chosen file into open ai and will edit it based on the result
+raider o make [PATH_NAME] - -edit or -e [FILE_PATH]
+# Creates a cucumber file and uses it to input into open ai and create a steps file
+# The prompt is not required because it uses a based prompt
+raider o cucumber [NAME] - -prompt or -p [PROMPT]
+# Creates a cucumber step definitions file based on an scenario file
+raider open_ai steps [NAME]
+Options : 
+  -p, [--path = PATH] # The path where your steps will be created
+  -pr, [--prompt = PROMPT] # This will create the selected steps based on your prompt using open ai
+  -i, [--input = INPUT] # It uses a file as input to create the steps
+
+```

data/Rakefile

@@ -17,3 +17,13 @@ desc 'Sets a browser'
 task :browser, [:type, :options] do |_t, args|
   ScaffoldingCommands.new.invoke(:browser, nil, %W[:#{args.type} --opts #{args.options}])
 end
+
+desc 'Updates a path'
+task :path, [:path] do |_t, args|
+  ScaffoldingCommands.new.invoke(:path, nil, %W[#{args.path} -s])
+end
+
+desc 'Download mobile builds'
+task :builds, [:type] do |_t, args|
+  ScaffoldingCommands.new.invoke(:download_builds, nil, %W[#{args.type}])
+end

data/bin/raider

@@ -3,4 +3,4 @@
 
 require_relative '../lib/ruby_raider'
 
-RubyRaider.start
+RubyRaider::Raider.start

data/lib/commands/open_ai_commands.rb

@@ -0,0 +1,59 @@
+require 'thor'
+require_relative '../open_ai/open_ai'
+
+class OpenAiCommands < Thor
+  desc 'open_ai [REQUEST]', 'Uses open AI to create a file or generate output'
+  option :path,
+         type: :string, required: false, desc: 'The path where your file will be created', aliases: '-p'
+  option :edit,
+         type: :string, required: false, desc: 'Path to the file you want to edit', aliases: '-e'
+
+  def make(request, path = nil)
+    path ||= options[:path]
+    if options[:edit]
+      pp 'Editing File...'
+      OpenAi.edit_file(options[:edit], request)
+      pp "File #{options[:edit]} edited"
+    elsif path
+      pp 'Generating File...'
+      OpenAi.create_file(path, request)
+      pp "File created in #{path}"
+    else
+      puts OpenAi.output(request)
+    end
+  end
+
+  desc 'cucumber [NAME]', 'Creates feature and step files only using open ai'
+  option :prompt,
+         type: :string,
+         required: false, desc: 'The prompt for open ai', aliases: '-p'
+
+  def cucumber(name)
+    feature_path = "features/#{name}.feature"
+    make(options[:prompt], feature_path)
+    prompt_step = "create cucumber steps for the following scenarios in ruby #{File.read(feature_path)}"
+    make(prompt_step, "features/step_definitions/#{name}_steps.rb")
+  end
+
+  desc 'steps [NAME]', 'Creates a new step definitions file'
+  option :path,
+         type: :string,
+         required: false, desc: 'The path where your steps will be created', aliases: '-p'
+  option :prompt,
+         type: :string, required: false,
+         desc: 'This will create the selected steps based on your prompt using open ai', aliases: '-pr'
+  option :input,
+         type: :string,
+         required: false, desc: 'It uses a file as input to create the steps', aliases: '-i'
+
+  def steps(name)
+    path = 'features/step_definitions'
+    if options[:input]
+      prompt = options[:prompt] || 'create cucumber steps for the following scenarios in ruby'
+      content = "#{prompt} #{File.read(options[:input])}"
+      make(content, "#{path}/#{name}_steps.rb")
+    else
+      make(options[:open_ai], "#{path}/#{name}_steps.rb")
+    end
+  end
+end

data/lib/commands/scaffolding_commands.rb

@@ -1,18 +1,11 @@
 # frozen_string_literal: true
 
+require 'thor'
 require_relative '../generators/menu_generator'
 require_relative '../scaffolding/scaffolding'
 require_relative '../commands/utility_commands'
 
-class ScaffoldingCommands < UtilityCommands
-  desc 'new [PROJECT_NAME]', 'Creates a new framework based on settings picked'
-
-  def new(project_name)
-    MenuGenerator.new(project_name).generate_choice_menu
-  end
-
-  map '-n' => 'new'
-
+class ScaffoldingCommands < Thor
   desc 'page [PAGE_NAME]', 'Creates a new page object'
   option :path,
          type: :string, required: false, desc: 'The path where your page will be created', aliases: '-p'
@@ -28,13 +21,13 @@ class ScaffoldingCommands < UtilityCommands
     end
   end
 
-  map '-pg' => 'page'
-
-  desc 'feature [FEATURE_NAME]', 'Creates a new feature'
+  desc 'feature [NAME]', 'Creates a new feature'
   option :path,
-         type: :string, required: false, desc: 'The path where your feature will be created', aliases: '-p'
+         type: :string,
+         required: false, desc: 'The path where your feature will be created', aliases: '-p'
   option :delete,
-         type: :boolean, required: false, desc: 'This will delete the selected feature', aliases: '-d'
+         type: :boolean,
+         required: false, desc: 'This will delete the selected feature', aliases: '-d'
 
   def feature(name)
     path = options[:path] || load_config_path('feature')
@@ -45,8 +38,6 @@ class ScaffoldingCommands < UtilityCommands
     end
   end
 
-  map '-f' => 'feature'
-
   desc 'spec [SPEC_NAME]', 'Creates a new spec'
   option :path,
          type: :string, required: false, desc: 'The path where your spec will be created', aliases: '-p'
@@ -62,8 +53,6 @@ class ScaffoldingCommands < UtilityCommands
     end
   end
 
-  map '-s' => 'spec'
-
   desc 'helper [HELPER_NAME]', 'Creates a new helper'
   option :path,
          type: :string, required: false, desc: 'The path where your helper will be created', aliases: '-p'
@@ -79,8 +68,6 @@ class ScaffoldingCommands < UtilityCommands
     end
   end
 
-  map '-h' => 'helper'
-
   desc 'scaffold [SCAFFOLD_NAME]', 'It generates everything needed to start automating'
 
   def scaffold(name)
@@ -92,22 +79,10 @@ class ScaffoldingCommands < UtilityCommands
     Scaffolding.new([name, load_config_path('page')]).generate_class
   end
 
-  map '-sf' => 'scaffold'
-
   desc 'config', 'Creates configuration file'
   option :delete,
          type: :boolean, required: false, desc: 'This will delete the config file', aliases: '-d'
 
-  def config
-    if options[:delete]
-      Scaffolding.new.delete_config
-    else
-      Scaffolding.new.generate_config
-    end
-  end
-
-  map '-c' => 'config'
-
   no_commands do
     def load_config_path(type)
       YAML.load_file('config/config.yml')["#{type}_path"] if Pathname.new('config/config.yml').exist?

data/lib/commands/utility_commands.rb

@@ -2,7 +2,6 @@
 
 require 'thor'
 require_relative '../utilities/utilities'
-require_relative '../utilities/open_ai'
 
 class UtilityCommands < Thor
   desc 'path [PATH]', 'Sets the default path for scaffolding'
@@ -15,19 +14,15 @@ class UtilityCommands < Thor
 
   def path(default_path)
     type = options.empty? ? 'page' : options.keys.first
-    Utilities.new.send("#{type}_path=", default_path)
+    Utilities.send("#{type}_path=", default_path)
   end
 
-  map '-p' => 'path'
-
   desc 'url [URL]', 'Sets the default url for a project'
 
   def url(default_url)
-    Utilities.new.url = default_url
+    Utilities.url = default_url
   end
 
-  map '-u' => 'url'
-
   desc 'browser [BROWSER]', 'Sets the default browser for a project'
   option :opts,
          type: :array, required: false, desc: 'The options you want your browser to run with', aliases: '-o'
@@ -35,23 +30,19 @@ class UtilityCommands < Thor
          type: :boolean, required: false, desc: 'This will delete your browser options', aliases: '-d'
 
   def browser(default_browser = nil)
-    Utilities.new.browser = default_browser if default_browser
+    Utilities.browser = default_browser if default_browser
     browser_options(options[:opts]) if options[:opts] || options[:delete]
   end
 
-  map '-b' => 'browser'
-
   desc 'browser_options [OPTIONS]', 'Sets the browser options for the project'
   option :delete,
          type: :boolean, required: false, desc: 'This will delete your browser options', aliases: '-d'
 
   def browser_options(*opts)
-    Utilities.new.browser_options = opts unless opts.empty?
-    Utilities.new.delete_browser_options if options[:delete]
+    Utilities.browser_options = opts unless opts.empty?
+    Utilities.delete_browser_options if options[:delete]
   end
 
-  map '-bo' => 'browser_options'
-
   desc 'raid', 'It runs all the tests in a project'
   option :parallel,
          type: :boolean, required: false, desc: 'It runs the tests in parallel', aliases: '-p'
@@ -60,14 +51,12 @@ class UtilityCommands < Thor
 
   def raid
     if options[:parallel]
-      Utilities.new.parallel_run(options[:opts])
+      Utilities.parallel_run(options[:opts])
     else
-      Utilities.new.run(options[:opts])
+      Utilities.run(options[:opts])
     end
   end
 
-  map '-r' => 'raid'
-
   desc 'config', 'Creates a new config file'
   option :path,
          type: :string, required: false, desc: 'The path where your config file will be created', aliases: '-p'
@@ -77,42 +66,13 @@ class UtilityCommands < Thor
   desc 'platform [PLATFORM]', 'Sets the default platform for a cross-platform project'
 
   def platform(platform)
-    Utilities.new.platform = platform
-  end
-
-  map '-pl' => 'platform'
-
-  desc 'download_builds [BUILD_TYPE]', 'It downloads the example builds for appium projects'
-  def download_builds(build_type)
-    if %w[android, ios, both].include?(build_type)
-      raise 'Please select one of the following build types: android, ios, both'
-    end
-
-    Utilities.new.download_builds build_type
+    Utilities.platform = platform
   end
 
-  map '-d' => 'download_builds'
+  desc 'builds [BUILD_TYPE]', 'It downloads the example builds for appium projects'
+  def builds(build_type)
+    raise 'Please select one of the following build types: android, ios, both' unless %w[android ios both].include?(build_type)
 
-  desc 'version', 'It shows the version of Ruby Raider you are currently using'
-  def version
-    puts 'The Ruby Raider version is 0.5.2, Happy testing!'
+    Utilities.download_builds build_type
   end
-
-  map '-v' => 'version'
-
-  desc 'open_ai [REQUEST]', 'Uses open AI to create a file or generate output'
-  option :path,
-         type: :string, required: false, desc: 'The path where your file will be created', aliases: '-p'
-
-  def open_ai(request)
-    if options[:path]
-      pp 'Generating File...'
-      OpenAi.create_file(choice = 0, options[:path], request)
-      pp "File created in #{options[:path]}"
-    else
-      OpenAi.output(request)
-    end
-  end
-
-  map '-oa' => 'open_ai'
 end

data/lib/generators/templates/common/read_me.tt

@@ -54,7 +54,12 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
 
-***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.).***
+***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read
+more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.)
+.***
+
+***To use the open ai integration you need to set up the OPENAI_ACCESS_TOKEN environment variable and
+you can also set the optional OPENAI_ORGANIZATION_ID if you have an organization***
 
 This works in all the platforms (Tested on Mac OS, Linux and Windows).
 
@@ -74,52 +79,38 @@ gem install ruby_raider
 raider new [name_of_project]
 ```
 
-Then a TUI/CLI will appear where the configuration of which frameworks you want to be generated/scaffolded can be selected.
+Then a TUI/CLI will appear where the configuration of which frameworks you want to be generated/scaffolded can be
+selected.
 
 Select the ones you will like to work with.
 
-### Ruby raider provides the following list of commands
+### Ruby raider provides the following list of basic commands
 
 ###### Anything between square brackets([...]) is where your imput goes
 
 ```ruby
-Commands:
-  raider browser [BROWSER]          # Sets the default browser for a project
-
-  raider browser_options [OPTIONS]  # Sets the browser options for the project
-
-  raider feature [FEATURE_NAME]     # Creates a new feature
-
-  raider help [COMMAND]             # Describes available commands or one specific command
-
-  raider helper [HELPER_NAME]       # Creates a new helper
-
-  raider new [PROJECT_NAME]         # Creates a new framework based on settings picked
-
-  raider open_ai [REQUEST]          # Uses open AI to create a file or generate output
-
-  raider page [PAGE_NAME]           # Creates a new page object
-
-  raider path [PATH]                # Sets the default path for scaffolding
-
-  raider platform [PLATFORM]        # Sets the default platform for a cross-platform project
-
-  raider raid                       # Runs all the tests in a project
-
-  raider scaffold [SCAFFOLD_NAME]   # Generates everything needed to start automating
-
-  raider spec [SPEC_NAME]           # Creates a new spec
+Commands :
+  raider generate # Provides access to all the generators commands
+raider help [COMMAND] # Describe available commands or one specific command
+raider new [PROJECT_NAME] # Creates a new framework based on settings picked
+raider open_ai # Provides access to all the open ai commands
+raider utility # Provides access to all the utility commands
+raider version # It shows the version of Ruby Raider you are currently using
+```
 
-  raider url [URL]                  # Sets the default url for a project
+All the basic commands have their corresponding shortcut:
 
-  raider version                    # It shows the version of Ruby Raider you are currently using
-```
+* g for generate
+* n for new
+* o for open_ai
+* u for utility
+* v for version
 
 Ruby raider also supports scaffolding:
 
-* To create a new page object you do: ```raider page [PAGE_NAME]```
-* To create a new spec you do: ```raider spec [SPEC_NAME]```
-* To create a new feature you do: ```raider feature [FEATURE_NAME]```
+* To create a new page object you do: ```raider g page [PAGE_NAME]```
+* To create a new spec you do: ```raider g spec [SPEC_NAME]```
+* To create a new feature you do: ```raider g feature [FEATURE_NAME]```
 
 It's possible to add the option --path or -p if you want to specify where to create your features, pages, helpers and
 specs.
@@ -127,9 +118,30 @@ specs.
 If you want to set the default path for the creation of your features, helpers and specs:
 
 ```ruby
-raider path [PATH_NAME] --feature or -f
-raider path [PATH_NAME] --spec or -s
-raider path [PATH_NAME] --helper or -h
+raider u path [PATH_NAME] - -feature or -f
+raider u path [PATH_NAME] - -spec or -s
+raider u path [PATH_NAME] - -helper or -h
 ```
 
 If you don't specify an option, path will assume you want to change the default path for pages.
+
+### Open AI Commands
+
+```ruby
+# Will print the result of the request on the terminal
+raider o make [REQUEST]
+# Will create a file with the result of your request as content
+raider o make [REQUEST] - -path or -p [PATH]
+# Will input the content of the chosen file into open ai and will edit it based on the result
+raider o make [PATH_NAME] - -edit or -e [FILE_PATH]
+# Creates a cucumber file and uses it to input into open ai and create a steps file
+# The prompt is not required because it uses a based prompt
+raider o cucumber [NAME] - -prompt or -p [PROMPT]
+# Creates a cucumber step definitions file based on an scenario file
+raider open_ai steps [NAME]
+Options :
+  -p, [--path = PATH] # The path where your steps will be created
+  -pr, [--prompt = PROMPT] # This will create the selected steps based on your prompt using open ai
+  -i, [--input = INPUT] # It uses a file as input to create the steps
+
+```

data/lib/open_ai/open_ai.rb

@@ -0,0 +1,61 @@
+require 'openai'
+require 'fileutils'
+
+module OpenAi
+  class << self
+    def client
+      @client ||= create_client
+    end
+
+    def create_client
+      configure_client
+      OpenAI::Client.new
+    end
+
+    def configure_client
+      OpenAI.configure do |config|
+        config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
+        config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID', nil)
+      end
+    end
+
+    def input(request, model = 'gpt-3.5-turbo', temperature = 0.7)
+      client.chat(
+        parameters: {
+          model: model,
+          messages: [{ role: 'user', content: request }],
+          temperature: temperature
+        })
+    end
+
+    def create_file(path, request, choice = 0)
+      File.write(path, output(request, choice))
+    end
+
+    def output(request, choice = 0)
+      extract_text(input(request), 'choices', choice, 'message', 'content')
+    end
+
+    def edit_file(path, request, choice = 0)
+      content = File.read(path)
+      response = edit(content, request)
+      File.write(path, extract_text(response, 'choices', choice, 'text'))
+    end
+
+    def edit(input, request, model = 'text-davinci-edit-001')
+      client.edits(
+        parameters: {
+          model: model,
+          input: input,
+          instruction: request
+        }
+      )
+    end
+
+    private
+
+    def extract_text(response, *keys)
+      response.dig(*keys)
+    end
+  end
+end

data/lib/ruby_raider.rb

@@ -1,9 +1,38 @@
 # frozen_string_literal: true
 
+require_relative '../lib/commands/open_ai_commands'
 require_relative '../lib/commands/scaffolding_commands'
+require_relative '../lib/commands/utility_commands'
 
 module RubyRaider
-  def self.start
-    ScaffoldingCommands.start
+  class Raider < Thor
+    desc 'new [PROJECT_NAME]', 'Creates a new framework based on settings picked'
+
+    def new(project_name)
+      MenuGenerator.new(project_name).generate_choice_menu
+    end
+
+    map '-n' => 'new'
+
+    desc 'version', 'It shows the version of Ruby Raider you are currently using'
+    def version
+      spec = Gem::Specification.load('ruby_raider.gemspec')
+      version = spec.version
+      puts "The Ruby Raider version is #{version}, Happy testing!"
+    end
+
+    map 'v' => 'version'
+
+    desc 'generate', 'Provides access to all the generators commands'
+    subcommand 'generate', ScaffoldingCommands
+    map 'g' => 'generate'
+
+    desc 'open_ai', 'Provides access to all the open ai commands'
+    subcommand 'open_ai', OpenAiCommands
+    map 'o' => 'open_ai'
+
+    desc 'utility', 'Provides access to all the utility commands'
+    subcommand 'utility', UtilityCommands
+    map 'u' => 'utility'
   end
 end

data/lib/utilities/utilities.rb

@@ -1,99 +1,106 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require 'open-uri'
+require 'faraday'
 
-class Utilities
-  def initialize
-    @path = 'config/config.yml'
-    @config = YAML.load_file(@path)
-  end
+module Utilities
+  @path = 'config/config.yml'
 
-  def browser=(browser)
-    @config['browser'] = browser
-    overwrite_yaml
-  end
+  class << self
+    def browser=(browser)
+      config['browser'] = browser
+      overwrite_yaml
+    end
 
-  def page_path=(path)
-    @config['page_path'] = path
-    overwrite_yaml
-  end
+    def page_path=(path)
+      config['page_path'] = path
+      overwrite_yaml
+    end
 
-  def spec_path=(path)
-    @config['spec_path'] = path
-    overwrite_yaml
-  end
+    def spec_path=(path)
+      config['spec_path'] = path
+      overwrite_yaml
+    end
 
-  def feature_path=(path)
-    @config['feature_path'] = path
-    overwrite_yaml
-  end
+    def feature_path=(path)
+      config['feature_path'] = path
+      overwrite_yaml
+    end
 
-  def helper_path=(path)
-    @config['helper_path'] = path
-    overwrite_yaml
-  end
+    def helper_path=(path)
+      config['helper_path'] = path
+      overwrite_yaml
+    end
 
-  def url=(url)
-    @config['url'] = url
-    overwrite_yaml
-  end
+    def url=(url)
+      config['url'] = url
+      overwrite_yaml
+    end
 
-  def platform=(platform)
-    @config['platform'] = platform
-    overwrite_yaml
-  end
+    def platform=(platform)
+      config['platform'] = platform
+      overwrite_yaml
+    end
 
-  def browser_options=(*opts)
-    @config['browser_options'] = opts.flatten
-    overwrite_yaml
-  end
+    def browser_options=(*opts)
+      config['browser_options'] = opts.flatten
+      overwrite_yaml
+    end
 
-  def delete_browser_options
-    @config.delete('browser_options')
-    overwrite_yaml
-  end
+    def delete_browser_options
+      config.delete('browser_options')
+      overwrite_yaml
+    end
 
-  def run(opts = nil)
-    command = File.directory?('spec') ? 'rspec spec/' : 'cucumber features'
-    system "#{command} #{opts}"
-  end
+    def run(opts = nil)
+      command = File.directory?('spec') ? 'rspec spec/' : 'cucumber features'
+      system "#{command} #{opts}"
+    end
 
-  def parallel_run(opts = nil, _settings = nil)
-    command = File.directory?('spec') ? 'parallel_rspec spec/' : 'parallel_cucumber features'
-    system "#{command} #{opts}"
-  end
+    def parallel_run(opts = nil, _settings = nil)
+      command = File.directory?('spec') ? 'parallel_rspec spec/' : 'parallel_cucumber features'
+      system "#{command} #{opts}"
+    end
 
-  def overwrite_yaml
-    File.open(@path, 'w') { |file| YAML.dump(@config, file) }
-  end
+    def download_builds(build_type)
+      case build_type
+      when 'android'
+        download_android_build
+      when 'ios'
+        download_ios_build
+      else
+        download_android_build
+        download_ios_build
+      end
+    end
+
+    private
 
-  def download_builds(build_type)
-    case build_type
-    when 'android'
-      download_android_build
-    when 'ios'
-      download_ios_build
-    else
-      download_android_build
-      download_ios_build
+    def overwrite_yaml
+      File.open(@path, 'w') { |file| YAML.dump(config, file) }
     end
-  end
 
-  private
+    def download_android_build
+      download_build('Android-MyDemoAppRN.1.3.0.build-244.apk',
+                     'https://github.com/saucelabs/my-demo-app-rn/releases/download/v1.3.0/Android-MyDemoAppRN.1.3.0.build-244.apk')
+    end
 
-  def download_android_build
-    download_build('Android-MyDemoAppRN.1.3.0.build-244.apk',
-                   'https://github.com/saucelabs/my-demo-app-rn/releases/download/v1.3.0/Android-MyDemoAppRN.1.3.0.build-244.apk')
-  end
+    def download_ios_build
+      download_build('iOS-Simulator-MyRNDemoApp.1.3.0-162.zip',
+                     'https://github.com/saucelabs/my-demo-app-rn/releases/download/v1.3.0/iOS-Simulator-MyRNDemoApp.1.3.0-162.zip')
+    end
 
-  def download_ios_build
-    download_build('iOS-Simulator-MyRNDemoApp.1.3.0-162.zip',
-                   'https://github.com/saucelabs/my-demo-app-rn/releases/download/v1.3.0/iOS-Simulator-MyRNDemoApp.1.3.0-162.zip')
-  end
-  def download_build(name, url)
-    open(name, 'wb') do |file|
-      file << open(url).read
+    def download_build(name, url)
+      response = Faraday.get(url)
+      build_url = Faraday.get(response.headers['location'])
+
+      File.open(name, 'wb') do |file|
+        file.write(build_url.body)
+      end
+    end
+
+    def config
+      @config ||= File.exist?(@path) ? YAML.load_file(@path) : nil
     end
   end
 end

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.5.2'
+  s.version     = '0.5.3'
   s.summary     = 'A gem to make setup and start of UI automation projects easier'
   s.description = 'This gem has everything you need to start working with test automation'
   s.authors     = ['Agustin Pequeno']
@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.files  = `git ls-files -z`.split("\x0")
   s.bindir = 'bin'
   s.executables << 'raider'
+  s.add_development_dependency 'dotenv', '~> 2.8'
   s.add_development_dependency 'rake', '~> 13.0.6'
   s.add_development_dependency 'reek', '~> 6.1.0'
   s.add_development_dependency 'rspec', '~> 3.11.0'
@@ -20,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop-performance', '~> 1.15.0'
   s.add_development_dependency 'rubocop-rspec', '~> 2.9.0'
 
+  s.add_runtime_dependency 'faraday', '~> 2.7'
   s.add_runtime_dependency 'ruby-openai', '~> 3.5'
   s.add_runtime_dependency 'thor', '~> 1.2.1'
   s.add_runtime_dependency 'tty-prompt', '~> 0.23.1'

data/spec/open_ai_commands_spec.rb

@@ -0,0 +1,36 @@
+require 'dotenv'
+require 'fileutils'
+require 'pathname'
+require 'yaml'
+require_relative '../lib/generators/common_generator'
+require_relative '../lib/commands/open_ai_commands'
+require_relative '../lib/scaffolding/scaffolding'
+require_relative 'spec_helper'
+
+describe OpenAiCommands do
+  let(:open_ai) { described_class }
+  let(:name) { 'test' }
+
+  orig_dir = Dir.pwd
+  Dotenv.load
+
+  after do
+    Dir.chdir orig_dir
+  end
+
+  context 'without any project' do
+    after do
+      FileUtils.rm_rf('joke.txt')
+    end
+
+    it 'creates a file using open ai' do
+      open_ai.new.invoke(:make, nil, ['tell me a joke', '--path', 'joke.txt'])
+      expect(File).to be_size('joke.txt')
+    end
+
+    it 'edits an existing file using open ai' do
+      FileUtils.touch('joke.txt')
+      open_ai.new.invoke(:make, nil, ['tell me a better joke', '--edit', 'joke.txt'])
+    end
+  end
+end

data/spec/scaffolding_commands_spec.rb

@@ -1,3 +1,4 @@
+require 'dotenv'
 require 'pathname'
 require 'yaml'
 require_relative '../lib/generators/common_generator'
@@ -49,30 +50,6 @@ describe ScaffoldingCommands do
       expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to be_file
     end
 
-    it 'changes the path for specs' do
-      scaffold.new.invoke(:path, nil, %W[#{path} -s])
-      config = YAML.load_file('config/config.yml')
-      expect(config['spec_path']).to eql path
-    end
-
-    it 'updates the url' do
-      scaffold.new.invoke(:url, nil, %w[test.com])
-      config = YAML.load_file('config/config.yml')
-      expect(config['url']).to eql 'test.com'
-    end
-
-    it 'updates the browser' do
-      scaffold.new.invoke(:browser, nil, %w[:firefox])
-      config = YAML.load_file('config/config.yml')
-      expect(config['browser']).to eql ':firefox'
-    end
-
-    it 'updates the browser options' do
-      scaffold.new.invoke(:browser, nil, %w[:firefox --opts headless start-maximized start-fullscreen])
-      config = YAML.load_file('config/config.yml')
-      expect(config['browser_options']).to eql %w[headless start-maximized start-fullscreen]
-    end
-
     it 'creates a page with a path' do
       scaffold.new.invoke(:page, nil, %W[#{name} --path #{new_path}])
       expect(Pathname.new("#{new_path}/#{name}_page.rb")).to be_file
@@ -118,37 +95,6 @@ describe ScaffoldingCommands do
       expect(Pathname.new('features/login.feature')).not_to be_file
     end
 
-    it 'changes the path for pages' do
-      scaffold.new.invoke(:path, nil, %W[#{path}])
-      config = YAML.load_file('config/config.yml')
-      expect(config['page_path']).to eql path
-    end
-
-    it 'changes the path for features' do
-      scaffold.new.invoke(:path, nil, %W[#{path} -f])
-      config = YAML.load_file('config/config.yml')
-      expect(config['feature_path']).to eql path
-    end
-
-    it 'updates only the browser options' do
-      scaffold.new.invoke(:browser, nil, %w[:firefox --opts headless])
-      config = YAML.load_file('config/config.yml')
-      expect(config['browser_options']).to eql %w[headless]
-    end
-
-    it 'deletes the browser options when passed with the delete parameter' do
-      scaffold.new.invoke(:browser, nil, %w[:firefox --opts headless --delete])
-      config = YAML.load_file('config/config.yml')
-      expect(config['browser_options']).to be_nil
-    end
-
-    it 'deletes the browser options' do
-      scaffold.new.invoke(:browser, nil, %w[:firefox --opts headless])
-      scaffold.new.invoke(:browser, nil, %w[--delete])
-      config = YAML.load_file('config/config.yml')
-      expect(config['browser_options']).to be_nil
-    end
-
     it 'creates a feature' do
       scaffold.new.invoke(:feature, nil, %W[#{name} --path #{new_path}])
       expect(Pathname.new("#{new_path}/#{name}.feature")).to be_file

data/spec/utility_commands_spec.rb

@@ -0,0 +1,94 @@
+require 'dotenv'
+require 'fileutils'
+require 'pathname'
+require 'yaml'
+require_relative '../lib/generators/common_generator'
+require_relative '../lib/commands/utility_commands'
+require_relative '../lib/scaffolding/scaffolding'
+require_relative 'spec_helper'
+
+describe UtilityCommands do
+  let(:utility) { described_class }
+  let(:name) { 'test' }
+
+  orig_dir = Dir.pwd
+
+  after do
+    Dir.chdir orig_dir
+  end
+
+  context 'with a spec folder' do
+    let(:new_path) { 'test_folder' }
+
+    path = "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
+
+    before do
+      Dir.chdir path
+    end
+
+    it 'changes the path for specs' do
+      utility.new.invoke(:path, nil, %W[#{path} -s])
+      config = YAML.load_file('config/config.yml')
+      expect(config['spec_path']).to eql path
+    end
+
+    it 'updates the url' do
+      utility.new.invoke(:url, nil, %w[test.com])
+      config = YAML.load_file('config/config.yml')
+      expect(config['url']).to eql 'test.com'
+    end
+
+    it 'updates the browser' do
+      utility.new.invoke(:browser, nil, %w[:firefox])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser']).to eql ':firefox'
+    end
+
+    it 'updates the browser options' do
+      utility.new.invoke(:browser, nil, %w[:firefox --opts headless start-maximized start-fullscreen])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser_options']).to eql %w[headless start-maximized start-fullscreen]
+    end
+  end
+
+  context 'with a features folder' do
+    let(:new_path) { 'test_folder' }
+
+    path = "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
+
+    before do
+      Dir.chdir path
+    end
+
+    it 'changes the path for pages' do
+      utility.new.invoke(:path, nil, %W[#{path}])
+      config = YAML.load_file('config/config.yml')
+      expect(config['page_path']).to eql path
+    end
+
+    it 'changes the path for features' do
+      utility.new.invoke(:path, nil, %W[#{path} -f])
+      config = YAML.load_file('config/config.yml')
+      expect(config['feature_path']).to eql path
+    end
+
+    it 'updates only the browser options' do
+      utility.new.invoke(:browser, nil, %w[:firefox --opts headless])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser_options']).to eql %w[headless]
+    end
+
+    it 'deletes the browser options when passed with the delete parameter' do
+      utility.new.invoke(:browser, nil, %w[:firefox --opts headless --delete])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser_options']).to be_nil
+    end
+
+    it 'deletes the browser options' do
+      utility.new.invoke(:browser, nil, %w[:firefox --opts headless])
+      utility.new.invoke(:browser, nil, %w[--delete])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser_options']).to be_nil
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +186,7 @@ files:
 - README.md
 - Rakefile
 - bin/raider
+- lib/commands/open_ai_commands.rb
 - lib/commands/scaffolding_commands.rb
 - lib/commands/utility_commands.rb
 - lib/generators/automation_generator.rb
@@ -225,22 +254,24 @@ files:
 - lib/generators/templates/helpers/visual_spec_helper.tt
 - lib/generators/templates/rspec/base_spec.tt
 - lib/generators/templates/rspec/spec.tt
+- lib/open_ai/open_ai.rb
 - lib/ruby_raider.rb
 - lib/scaffolding/scaffolding.rb
 - lib/scaffolding/templates/feature.tt
 - lib/scaffolding/templates/helper.tt
 - lib/scaffolding/templates/page_object.tt
 - lib/scaffolding/templates/spec.tt
-- lib/utilities/open_ai.rb
 - lib/utilities/utilities.rb
 - ruby_raider.gemspec
 - spec/automation_generator_spec.rb
 - spec/common_generator_spec.rb
 - spec/cucumber_generator_spec.rb
 - spec/helpers_generator_spec.rb
+- spec/open_ai_commands_spec.rb
 - spec/rspec_generator_spec.rb
 - spec/scaffolding_commands_spec.rb
 - spec/spec_helper.rb
+- spec/utility_commands_spec.rb
 homepage: https://github.com/RubyRaider/ruby_raider
 licenses:
 - MIT

data/lib/utilities/open_ai.rb

@@ -1,37 +0,0 @@
-require 'openai'
-require 'fileutils'
-
-module OpenAi
-  class << self
-    def create_client
-      configure_client
-      OpenAI::Client.new
-    end
-
-    def configure_client
-      OpenAI.configure do |config|
-        config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
-        config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID', nil)
-      end
-    end
-
-    def input(model = "gpt-3.5-turbo", temperature = 0.7, request)
-      create_client.chat(
-        parameters: {
-          model: model,
-          messages: [{ role: "user", content: request }],
-          temperature: temperature
-        })
-    end
-
-    def create_file(choice = 0, path, request)
-      response = input(request)
-      File.write(path, response.dig("choices", choice, "message", "content"))
-    end
-
-    def output(choice = 0, request)
-      response = input(request)
-      puts response.dig("choices", choice, "message", "content")
-    end
-  end
-end