air_test 0.1.5.5 → 0.1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8814b0e5adb17e2636d7da5b58d8c2f472c78fa31325d1d415ef30de9993104
-  data.tar.gz: d1e48aa3bb971eaecb093b97a247197e4138b02ed5d9cb41c00d3f202c22afcb
+  metadata.gz: ad53fd406fa863853dea5408851219dee4651ed0f36565eea406e0e1ac8218a2
+  data.tar.gz: 04c60aa2b2a9db1203440e26f4d95f166826dc887865d997f9e94fe7b132bf54
 SHA512:
-  metadata.gz: 1e2fee67f17bb43db86a10d981f73d033429ce2da0d55481eb56356c1fe979777cccf72e59e6a24fc79e3468cc681f12081c8ec9fa125394b2ae35ff8e00cf7b
-  data.tar.gz: 65138b6b62ad47c68fb0abc70ca9670687fd0d595c7de55b4e8e7a1817f54e8e17cc1159bfcdc34b3394f2bf125c670c42faaab3b360c868e496b96d51408999
+  metadata.gz: 6bfe5096f73ad09e186863a51e279ab5e415d2dd3b3e09be7441fdd581634097152d249d5fe51fc802115b80081a12e25b65a93245a14694f75b1e0ca6dcbfdf
+  data.tar.gz: 67b13d6c175daf0360e7987e4432cd5eeb09e417bb9d2f9c3cf832926eb652be77cd14daea8dc27dd62a7284bca50aea58ef07dacc7da2546f08bc2bac7be765

data/README.md

@@ -49,6 +49,47 @@ Make sure your environment variables are set (in `.env`, your shell, or your CI/
 
 ---
 
+## 📝 Creating Notion Tickets with Gherkin Format
+
+To ensure that your Notion tickets are compatible with the air_test automation, follow these guidelines when creating your tickets:
+
+### 1. Create a New Page in Notion
+
+- Start by creating a new page in your Notion workspace for each ticket.
+
+### 2. Use the Gherkin Syntax
+
+- Each ticket should follow the Gherkin syntax, which includes the following keywords:
+  - **Feature**: A high-level description of the feature being implemented.
+  - **Scenario**: A specific situation or case that describes how the feature should behave.
+  - **Given**: The initial context or state before the scenario starts.
+  - **When**: The action that triggers the scenario.
+  - **Then**: The expected outcome or result of the action.
+
+### 3. Example Structure
+
+Here’s an example of how to structure a ticket in Notion:
+
+Feature: User Login
+Scenario: Successful login with valid credentials
+Given the user is on the login page
+When the user enters valid credentials
+Then the user should be redirected to the dashboard
+Scenario: Unsuccessful login with invalid credentials
+Given the user is on the login page
+When the user enters invalid credentials
+Then an error message should be displayed
+
+### 4. Additional Tips
+
+- Ensure that each ticket is clearly titled and contains all necessary scenarios.
+- Use bullet points or toggle lists in Notion to organize multiple scenarios under a single feature.
+- Make sure to keep the Gherkin syntax consistent across all tickets for better parsing.
+
+By following these guidelines, you can create Notion tickets that are ready to be parsed by the air_test automation tool.
+
+---
+
 ## 🛠 Usage
 
 Run the automated workflow from your Rails project terminal:
@@ -74,17 +115,6 @@ bundle exec rake air_test:generate_specs_from_notion
 
 ---
 
-## 🧩 Gem Structure
-
-- `lib/air_test/configuration.rb`: centralized configuration
-- `lib/air_test/notion_parser.rb`: Notion extraction and parsing
-- `lib/air_test/spec_generator.rb`: spec and step file generation
-- `lib/air_test/github_client.rb`: git and GitHub PR management
-- `lib/air_test/runner.rb`: workflow orchestrator
-- `lib/tasks/air_test.rake`: Rake task to launch the automation
-
----
-
 ## 📝 Example .env
 
 ```
@@ -103,17 +133,6 @@ GITHUB_BOT_TOKEN=ghp_xxx
 
 ---
 
-## 📦 Publishing the Gem (optional)
-
-To publish the gem on RubyGems:
-
-```sh
-gem build air_test.gemspec
-gem push air_test-x.y.z.gem
-```
-
----
-
 ## 👨‍💻 Author & License
 
 - Author: [Airtest]

data/lib/air_test/configuration.rb

@@ -4,13 +4,46 @@
 module AirTest
   # Handles configuration for AirTest, including API tokens and environment variables.
   class Configuration
-    attr_accessor :notion_token, :notion_database_id, :github_token, :repo
+    attr_accessor :tool, :notion, :jira, :monday, :github, :repo
 
     def initialize
-      @notion_token = ENV.fetch("NOTION_TOKEN", nil)
-      @notion_database_id = ENV.fetch("NOTION_DATABASE_ID", nil)
-      @github_token = ENV["GITHUB_BOT_TOKEN"] || ENV.fetch("GITHUB_TOKEN", nil)
+      @tool = ENV.fetch("AIRTEST_TOOL", "notion")
+      @notion = {
+        token: ENV.fetch("NOTION_TOKEN", nil),
+        database_id: ENV.fetch("NOTION_DATABASE_ID", nil)
+      }
+      @jira = {
+        token: ENV.fetch("JIRA_TOKEN", nil),
+        project_id: ENV.fetch("JIRA_PROJECT_ID", nil),
+        domain: ENV.fetch("JIRA_DOMAIN", nil),
+        email: ENV.fetch("JIRA_EMAIL", nil)
+      }
+      @monday = {
+        token: ENV.fetch("MONDAY_TOKEN", nil),
+        board_id: ENV.fetch("MONDAY_BOARD_ID", nil),
+        domain: ENV.fetch("MONDAY_DOMAIN", nil)
+      }
+      @github = {
+        token: ENV["GITHUB_BOT_TOKEN"] || ENV.fetch("GITHUB_TOKEN", nil)
+      }
       @repo = ENV.fetch("REPO", nil)
     end
+
+    def validate!
+      case tool.to_s.downcase
+      when "notion"
+        raise "Missing NOTION_TOKEN" unless notion[:token]
+        raise "Missing NOTION_DATABASE_ID" unless notion[:database_id]
+      when "jira"
+        raise "Missing JIRA_TOKEN" unless jira[:token]
+        raise "Missing JIRA_PROJECT_ID" unless jira[:project_id]
+        raise "Missing JIRA_DOMAIN" unless jira[:domain]
+        raise "Missing JIRA_EMAIL" unless jira[:email]
+      when "monday"
+        raise "Missing MONDAY_TOKEN" unless monday[:token]
+        raise "Missing MONDAY_BOARD_ID" unless monday[:board_id]
+        raise "Missing MONDAY_DOMAIN" unless monday[:domain]
+      end
+    end
   end
 end

data/lib/air_test/github_client.rb

@@ -6,9 +6,9 @@ module AirTest
   # Handles GitHub API interactions for AirTest, such as commits and pull requests.
   class GithubClient
     def initialize(config = AirTest.configuration)
-      @github_token = config.github_token
+      @token = config.github[:token]
       @repo = config.repo || detect_repo_from_git
-      @client = Octokit::Client.new(access_token: @github_token) if @github_token
+      @client = Octokit::Client.new(access_token: @token) if @token
     end
 
     def commit_and_push_branch(branch, files, commit_message)
@@ -21,9 +21,9 @@ module AirTest
       system('git config user.name "air-test-bot"')
       system('git config user.email "airtest.bot@gmail.com"')
       # Set remote to use bot token if available
-      if @github_token
+      if @token
         repo_url = "github.com/#{@repo}.git"
-        system("git remote set-url origin https://#{@github_token}@#{repo_url}")
+        system("git remote set-url origin https://#{@token}@#{repo_url}")
       end
       files.each { |f| system("git add -f #{f}") }
       has_changes = !system("git diff --cached --quiet")

data/lib/air_test/jira_ticket_parser.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+require_relative "ticket_parser"
+
+module AirTest
+  class JiraTicketParser
+    include TicketParser
+    def initialize(config = AirTest.configuration)
+      @domain = config.jira[:domain]
+      @api_key = config.jira[:token]
+      @project_key = config.jira[:project_id]
+      @email = config.jira[:email]
+    end
+
+    def fetch_tickets(limit: 5)
+      # Try different status names (English and French)
+      statuses = ["To Do", "À faire", "Open", "New"]
+      all_issues = []
+
+      statuses.each do |status|
+        jql = "project = #{@project_key} AND status = '#{status}' ORDER BY created DESC"
+        uri = URI("#{@domain}/rest/api/3/search?jql=#{URI.encode_www_form_component(jql)}&maxResults=#{limit}")
+        request = Net::HTTP::Get.new(uri)
+        request.basic_auth(@email, @api_key)
+        request["Accept"] = "application/json"
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        response = http.request(request)
+
+        next unless response.code == "200"
+
+        data = JSON.parse(response.body)
+        issues = data["issues"] || []
+        all_issues.concat(issues)
+        puts "Found #{issues.length} issues with status '#{status}'" if issues.any?
+      end
+
+      all_issues.first(limit)
+    end
+
+    def parse_ticket_content(issue_id)
+      # Fetch issue details (description, etc.)
+      uri = URI("#{@domain}/rest/api/3/issue/#{issue_id}")
+      request = Net::HTTP::Get.new(uri)
+      request.basic_auth(@email, @api_key)
+      request["Accept"] = "application/json"
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      response = http.request(request)
+      return nil unless response.code == "200"
+
+      issue = JSON.parse(response.body)
+      # Example: parse description as feature, steps, etc. (customize as needed)
+      {
+        feature: issue.dig("fields", "summary") || "",
+        scenarios: [
+          {
+            title: "Scenario",
+            steps: [issue.dig("fields", "description", "content")&.map do |c|
+              c["content"]&.map do |t|
+                t["text"]
+              end&.join(" ")
+            end&.join(" ") || ""]
+          }
+        ],
+        meta: { tags: [], priority: "", estimate: nil,
+                assignee: issue.dig("fields", "assignee", "displayName") || "" }
+      }
+    end
+
+    def extract_ticket_title(ticket)
+      ticket.dig("fields", "summary") || "No title"
+    end
+
+    def extract_ticket_id(ticket)
+      ticket["key"] || "No ID"
+    end
+
+    def extract_ticket_url(ticket)
+      "#{@domain}/browse/#{ticket["key"]}"
+    end
+  end
+end

data/lib/air_test/monday_ticket_parser.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+require_relative "ticket_parser"
+
+module AirTest
+  class MondayTicketParser
+    include TicketParser
+    def initialize(config = AirTest.configuration)
+      @api_token = config.monday[:token]
+      @board_id = config.monday[:board_id]
+      @domain = config.monday[:domain]
+      @base_url = "https://api.monday.com/v2"
+    end
+
+    def fetch_tickets(limit: 5)
+      # First, get all items from the board
+      query = <<~GRAPHQL
+        query {
+          boards(ids: "#{@board_id}") {
+            items_page {
+              items {
+                id
+                name
+                column_values {
+                  id
+                  text
+                  value
+                }
+              }
+            }
+          }
+        }
+      GRAPHQL
+
+      response = make_graphql_request(query)
+      return [] unless response["data"]
+
+      items = response.dig("data", "boards", 0, "items_page", "items") || []
+
+      # Filter for items with "Not Started" status
+      not_started_items = items.select do |item|
+        status_column = item["column_values"].find { |cv| cv["id"] == "project_status" }
+        status_column && status_column["text"] == "Not Started"
+      end
+
+      not_started_items.first(limit)
+    end
+
+    def parse_ticket_content(item_id)
+      # For Monday, we'll use the item name as feature and create a simple scenario
+      # In the future, you could add a description column to Monday and parse it like Notion
+      {
+        feature: "Feature: #{extract_ticket_title({ "id" => item_id, "name" => "Loading..." })}",
+        scenarios: [
+          {
+            title: "Scenario",
+            steps: ["Implement the feature"]
+          }
+        ],
+        meta: { tags: [], priority: "", estimate: nil, assignee: "" }
+      }
+    end
+
+    def extract_ticket_title(ticket)
+      ticket["name"] || "No title"
+    end
+
+    def extract_ticket_id(ticket)
+      ticket["id"] || "No ID"
+    end
+
+    def extract_ticket_url(ticket)
+      "https://#{@domain}/boards/#{@board_id}/pulses/#{ticket["id"]}"
+    end
+
+    private
+
+    def make_graphql_request(query)
+      uri = URI(@base_url)
+      request = Net::HTTP::Post.new(uri)
+      request["Authorization"] = @api_token
+      request["Content-Type"] = "application/json"
+      request.body = { query: query }.to_json
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      response = http.request(request)
+
+      return {} unless response.code == "200"
+
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      {}
+    end
+  end
+end

data/lib/air_test/{notion_parser.rb → notion_ticket_parser.rb}

@@ -1,23 +1,33 @@
-# Parses Notion tickets and extracts relevant information for spec generation in AirTest.
-# rubocop:disable Metrics/ClassLength
 # frozen_string_literal: true
 
 require "net/http"
 require "json"
 require "uri"
+require_relative "ticket_parser"
 
 module AirTest
-  # Parses Notion tickets and extracts relevant information for spec generation in AirTest.
-  class NotionParser
+  # Implements TicketParser for Notion integration.
+  class NotionTicketParser
+    include TicketParser
     def initialize(config = AirTest.configuration)
-      @database_id = config.notion_database_id
-      @notion_token = config.notion_token
+      @database_id = config.notion[:database_id]
+      @notion_token = config.notion[:token]
       @base_url = "https://api.notion.com/v1"
     end
 
     def fetch_tickets(limit: 5)
       uri = URI("#{@base_url}/databases/#{@database_id}/query")
-      response = make_api_request(uri, { page_size: 100 })
+      # Add filter for 'Not started' status
+      request_body = {
+        page_size: 100,
+        filter: {
+          property: "Status",
+          select: {
+            equals: "Not started"
+          }
+        }
+      }
+      response = make_api_request(uri, request_body)
       return [] unless response.code == "200"
 
       data = JSON.parse(response.body)
@@ -26,16 +36,16 @@ module AirTest
 
     def parse_ticket_content(page_id)
       blocks = get_page_content(page_id)
-      puts "\n===== RAW NOTION BLOCKS ====="
-      puts JSON.pretty_generate(blocks)
+      # puts "\n===== RAW NOTION BLOCKS ====="
+      # puts JSON.pretty_generate(blocks)
       return nil unless blocks
+
       normalized_blocks = normalize_blocks(blocks)
-      puts "\n===== NORMALIZED BLOCKS ====="
-      puts JSON.pretty_generate(normalized_blocks)
-      parsed_data = parse_content(normalized_blocks)
-      puts "\n===== PARSED DATA ====="
-      puts JSON.pretty_generate(parsed_data)
-      parsed_data
+      # puts "\n===== NORMALIZED BLOCKS ====="
+      # puts JSON.pretty_generate(normalized_blocks)
+      parse_content(normalized_blocks)
+      # puts "\n===== PARSED DATA ====="
+      # puts JSON.pretty_generate(parsed_data)
     end
 
     def extract_ticket_title(ticket)
@@ -93,7 +103,11 @@ module AirTest
 
       blocks.each do |block|
         block_type = block["type"]
-        text = extract_text(block[block_type]["rich_text"]) rescue ""
+        text = begin
+          extract_text(block[block_type]["rich_text"])
+        rescue StandardError
+          ""
+        end
 
         if %w[heading_1 heading_2 heading_3].include?(block_type)
           heading_text = text.strip
@@ -127,19 +141,19 @@ module AirTest
           parsed_data[:scenarios] << current_scenario
         elsif %w[paragraph bulleted_list_item numbered_list_item].include?(block_type)
           next if text.empty?
+
           if in_feature_block
             parsed_data[:feature] += "\n#{text}"
           elsif in_background_block
             background_steps << text
           elsif in_scenario_block && current_scenario
             # Only add as step if not a scenario heading
-            unless text.strip.downcase.start_with?("scenario:")
-              current_scenario[:steps] << text
-            end
+            current_scenario[:steps] << text unless text.strip.downcase.start_with?("scenario:")
           end
         elsif block_type == "callout"
           text = extract_text(block["callout"]["rich_text"])
           next if text.empty?
+
           if text.downcase.include?("tag")
             tags = extract_tags(text)
             parsed_data[:meta][:tags].concat(tags)
@@ -166,23 +180,19 @@ module AirTest
         in_steps = false
         blocks.each do |block|
           block_type = block["type"]
-          text = extract_text(block[block_type]["rich_text"] || block["paragraph"]["rich_text"]) rescue ""
+          text = begin
+            extract_text(block[block_type]["rich_text"] || block["paragraph"]["rich_text"])
+          rescue StandardError
+            ""
+          end
           if %w[heading_1 heading_2 heading_3].include?(block_type)
             heading_text = text.strip
-            if heading_text.downcase.include?("feature")
-              in_steps = true
-            elsif heading_text.downcase.include?("scenario")
-              in_steps = true
-            else
-              in_steps = false
-            end
+            in_steps = heading_text.downcase.include?("feature")) || heading_text.downcase.include?("scenario")
           elsif %w[paragraph bulleted_list_item numbered_list_item].include?(block_type)
             steps << text if in_steps && !text.empty? && !text.strip.downcase.start_with?("scenario:")
           end
         end
-        if steps.any?
-          parsed_data[:scenarios] << { title: "Scenario", steps: steps }
-        end
+        parsed_data[:scenarios] << { title: "Scenario", steps: steps } if steps.any?
       end
 
       parsed_data[:feature] = parsed_data[:feature].strip
@@ -234,10 +244,10 @@ module AirTest
       blocks.each do |block|
         block_type = block["type"]
         text = if block[block_type] && block[block_type]["rich_text"]
-          block[block_type]["rich_text"].map { |rt| rt["plain_text"] }.join("")
-        else
-          ""
-        end
+                 block[block_type]["rich_text"].map { |rt| rt["plain_text"] }.join
+               else
+                 ""
+               end
         lines = text.split("\n").map(&:strip).reject(&:empty?)
         if lines.size > 1
           lines.each do |line|
@@ -254,5 +264,3 @@ module AirTest
     end
   end
 end
-
-# rubocop:enable Metrics/ClassLength

data/lib/air_test/runner.rb

@@ -6,20 +6,32 @@ module AirTest
   # Runs the main automation workflow for AirTest, orchestrating Notion parsing and GitHub actions.
   class Runner
     def initialize(config = AirTest.configuration)
-      @notion = NotionParser.new(config)
+      @config = config
+      @parser = case config.tool.to_s.downcase
+                when "notion"
+                  NotionTicketParser.new(config)
+                when "jira"
+                  JiraTicketParser.new(config)
+                when "monday"
+                  MondayTicketParser.new(config)
+                else
+                  raise "Unknown tool: #{config.tool}"
+                end
       @spec = SpecGenerator.new
       @github = GithubClient.new(config)
     end
 
     def run(limit: 5)
-      tickets = @notion.fetch_tickets(limit: limit)
+      @config.validate!
+      tickets = @parser.fetch_tickets(limit: limit)
+      # Filter for 'Not started' tickets (assuming each parser returns only those, or filter here if needed)
       puts "🔍 Found #{tickets.length} tickets"
       tickets.each do |ticket|
-        ticket_id = @notion.extract_ticket_id(ticket)
-        title = @notion.extract_ticket_title(ticket)
-        url = @notion.extract_ticket_url(ticket)
+        ticket_id = @parser.extract_ticket_id(ticket)
+        title = @parser.extract_ticket_title(ticket)
+        url = @parser.extract_ticket_url(ticket)
         puts "\n📋 Processing: FDR#{ticket_id} - #{title}"
-        parsed_data = @notion.parse_ticket_content(ticket["id"])
+        parsed_data = @parser.parse_ticket_content(ticket["id"])
         unless parsed_data && parsed_data[:feature] && !parsed_data[:feature].empty?
           puts "⚠️  Skipping ticket FDR#{ticket_id} due to missing or empty feature."
           next
@@ -43,6 +55,9 @@ module AirTest
               - **Feature** : #{parsed_data[:feature]}
               - **Scénarios** :
             #{scenarios_md}
+            - **Want to help us improve airtest?**
+            Leave feedback [here](http://bit.ly/4o5rinU)
+            or [join the community](https://discord.gg/ggnBvhtw7E)
           MD
           pr = @github.create_pull_request(branch, pr_title, pr_body)
           puts "✅ Pull Request créée : #{pr.html_url}" if pr

data/lib/air_test/ticket_parser.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module AirTest
+  # Interface for ticket parsers (Notion, Jira, Monday, etc.)
+  module TicketParser
+    def fetch_tickets(limit: 5)
+      raise NotImplementedError
+    end
+
+    def parse_ticket_content(page_id)
+      raise NotImplementedError
+    end
+
+    def extract_ticket_title(ticket)
+      raise NotImplementedError
+    end
+
+    def extract_ticket_id(ticket)
+      raise NotImplementedError
+    end
+
+    def extract_ticket_url(ticket)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/air_test/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AirTest
-  VERSION = "0.1.5.5"
+  VERSION = "0.1.6.0"
 end

data/lib/air_test.rb

@@ -14,7 +14,10 @@ end
 
 require_relative "air_test/version"
 require_relative "air_test/configuration"
-require_relative "air_test/notion_parser"
+require_relative "air_test/ticket_parser"
+require_relative "air_test/notion_ticket_parser"
+require_relative "air_test/jira_ticket_parser"
+require_relative "air_test/monday_ticket_parser"
 require_relative "air_test/spec_generator"
 require_relative "air_test/github_client"
 require_relative "air_test/runner"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: air_test
 version: !ruby/object:Gem::Version
-  version: 0.1.5.5
+  version: 0.1.6.0
 platform: ruby
 authors:
 - julien bouland
 bindir: exe
 cert_chain: []
-date: 2025-07-23 00:00:00.000000000 Z
+date: 2025-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -72,10 +72,13 @@ files:
 - lib/air_test/configuration.rb
 - lib/air_test/engine.rb
 - lib/air_test/github_client.rb
-- lib/air_test/notion_parser.rb
+- lib/air_test/jira_ticket_parser.rb
+- lib/air_test/monday_ticket_parser.rb
+- lib/air_test/notion_ticket_parser.rb
 - lib/air_test/runner.rb
 - lib/air_test/spec_generator.rb
 - lib/air_test/tasks/air_test.rake
+- lib/air_test/ticket_parser.rb
 - lib/air_test/version.rb
 - sig/air_test.rbs
 homepage: https://github.com/airtest-dev/airtest