cloudfactory 0.0.13

data/example/sample_yaml_files/term_extraction_robot.yaml

@@ -0,0 +1,20 @@
+api_key: f488a62d0307e79ec4f1e6131fa220be47e83d44
+title: manish
+description: Describe the line what its purpose is and what it does. You got the idea, right?
+department: Survey
+
+input_formats:
+  - name: url
+    required: true
+    valid_type: url
+      
+stations:
+  - station:
+      station_index: 1
+      station_type: work
+      worker:
+        worker_type: term_extraction_robot
+        settings:
+          url: ["{url}"]
+          max_retrieve: 5
+          show_source_text: true

data/example/sample_yaml_files/tournament_station_and_form_fields.yaml

@@ -0,0 +1,40 @@
+api_key: f488a62d0307e79ec4f1e6131fa220be47e83d44
+title: manish
+description: Describe the line what its purpose is and what it does. You got the idea, right?
+department: Survey
+
+input_formats:
+  - name: text
+    required: true
+    valid_type: general
+      
+stations:
+  - station:
+      station_index: 1
+      station_type: tournament
+      jury_worker:
+        max_judges: 10
+      auto_judge: 
+        enabled: true
+      worker:
+        worker_type: human
+        num_workers: 1
+        reward: 10
+      task_form:
+        form_title: Enter text from a business card image
+        instruction: Description should be written here
+        form_fields:
+          - label: First Name
+            required: true
+            field_type: SA
+          - label: Middle Name
+            field_type: SA
+          - label: Last Name
+            required: true
+            field_type: SA
+          - label: Gender
+            required: true
+            field_type: RB
+            option_values: 
+              - male
+              - female

data/features/form_generation.feature

@@ -0,0 +1,46 @@
+Feature: Generate Custom Task Forms
+  In order to generate custom task forms
+  As a CLI user
+  I want to generate custom task forms
+  
+  Scenario: Scaffolding a custom task form but outside of the line directory
+    Given a directory named "brandiator"
+    When I run `cf form generate --station 1 --labels company,website --fields ceo:string email:email`
+    Then the output should contain:
+    """
+    The current directory is not a valid line directory.
+    """
+
+  Scenario: Warn if the given station already has the form created
+    Given an empty file named "brandiator/line.yml"
+    And a directory named "brandiator/station_2"
+    And I cd to "brandiator"
+    When I run `cf form generate --station 2 --labels company,website --fields ceo:string email:email`
+    Then the output should contain:
+      """
+      Skipping the form generation because the station_2 already exists with its custom form.
+      Use the -f flag to force it to overwrite or check and delete the station_2 folder manually.
+      """
+
+  Scenario: Overwrite forcefully if the given station already has the form created
+    Given an empty file named "brandiator/line.yml"
+    And a directory named "brandiator/station_2"
+    And I cd to "brandiator"
+    When I run `cf form generate --force --station 2 --labels company,website --fields ceo:string email:email`
+    Then the output should contain:
+      """
+      A new custom task form created in station_2.
+      """
+
+  Scenario: Scaffolding a custom task form with all the parameters and valid conditions
+    Given an empty file named "brandiator/line.yml"
+    And I cd to "brandiator"
+    When I run `cf form generate --station 2 --labels company,website --fields ceo:string email:email`
+    Then the following files should exist:
+      | station_2/form.html |
+      | station_2/form.css  |
+      | station_2/form.js   |
+    And the output should contain:
+      """
+      A new custom task form created in station_2.
+      """

data/features/form_preview.feature

@@ -0,0 +1,98 @@
+Feature: Preview a generated custom form
+  In order to preview the generated custom task form
+  As a CLI user
+  I want to preview the custom task form
+
+  Scenario: Previewing the generated form in the browser with the non-existing station
+    Given an empty file named "brandiator/line.yml"
+    And I cd to "brandiator"
+    When I run `cf form preview --station 2`
+    Then the output should contain:
+      """
+      No form exists for station 2
+      Generate the form for station 2 and then preview it.
+      """
+    
+  Scenario: Trying to preview the form for the empty station directory
+    Given an empty file named "brandiator/line.yml"
+    And a directory named "station_2"
+    And I cd to "brandiator"
+    When I run `cf form preview --station 2`
+    Then the output should contain:
+      """
+      No form exists for station 2
+      Generate the form for station 2 and then preview it.
+      """
+  @announce
+  Scenario: Previewing the generated form in the browser
+    Given an empty file named "brandiator/line.yml"
+    # And a directory named "station_2"
+    And I cd to "brandiator"
+
+    And a file named "station_2/form.html" with:
+      """
+      <div id="my_form_instructions" class="brandiator cf_form_instruction">
+        <ul>
+          <li>Sample bullet list of instruction</li>
+          <li>Sample bullet list of instruction</li>
+          <li>Sample bullet list of instruction</li>
+        </ul>
+      </div>
+
+      <div id="my_form" class="brandiator cf_form_content">
+      <label>{{company}}</label>
+      <label>{{website}}</label>
+
+      <div id = "field-panel">
+      <p><label>ceo</label><input id="ceo" type="text" name="output[ceo]" data-valid-type="string" /></p>
+      <p><label>email</label><input id="email" type="text" name="output[email]" data-valid-type="email" /></p>
+      </div>
+      </div>
+      """
+    And a file named "station_2/form.css" with:
+      """
+      body { background-color: #777; color: #fefefe; }
+      """
+    And a file named "station_2/form.js" with:
+      """
+      alert("Hey! If you see me, it means I work.")
+      """
+  
+    When I run `cf form preview --station 2`
+    Then a file named "station_2/form_preview.html" should exist
+    # And the file ".cf/brandiator/my_form_preview.html" should contain:
+    #   """
+    #   <!DOCTYPE html>
+    #   <html lang="en">
+    #     <head>
+    #       <title>Form Preview</title>
+    #       <link href="my_form.css" media="screen, projection" rel="stylesheet" type="text/css" />
+    #       <script src="my_formjs" type="text/javascript"></script>
+    #     </head>
+    #     <!--[if lt IE 7 ]> <body class="ie6"> <![endif]-->
+    #     <!--[if IE 7 ]>    <body class="ie7"> <![endif]-->
+    #     <!--[if IE 8 ]>    <body class="ie8"> <![endif]-->
+    #     <!--[if IE 9 ]>    <body class="ie9"> <![endif]-->
+    #     <!--[if (gt IE 9)|!(IE)]><!--> <body> <!--<![endif]-->
+    #     <div id="container">
+    #       <div id="my_form_instructions" class="brandiator cf_form_instruction">
+    #         <ul>
+    #           <li>Sample bullet list of instruction</li>
+    #           <li>Sample bullet list of instruction</li>
+    #           <li>Sample bullet list of instruction</li>
+    #         </ul>
+    #       </div>
+    # 
+    #       <div id="my_form" class="brandiator cf_form_content">
+    #       <label>{{company}}</label>
+    #       <label>{{website}}</label>
+    # 
+    #       <div id = "field-panel">
+    #       <p><label>ceo</label><input id="ceo" type="text" name="output[ceo]" data-valid-type="string" /></p>
+    #       <p><label>email</label><input id="email" type="text" name="output[email]" data-valid-type="email" /></p>
+    #       </div>
+    #       </div>
+    #     </div>
+    #   </body>
+    #   </html>
+    #   """

data/features/line_creation.feature

@@ -0,0 +1,99 @@
+Feature: Create a new line on CF
+  In order to create a line with the generated line file
+  As a CLI user
+  I want to create a line via cli for the line
+
+  @announce, @too_slow_process
+  Scenario: Creating a Line
+    Given a file named ".cf_credentials" with:
+    """
+    ---
+    :target_url: http://lvh.me:3000/api/
+    :api_version: v1
+  
+    """
+    And a file named "brandiator/line.yml" with:
+    """
+    api_key: 89ceebf739adbf59d34911f4f28b2fa0e1564fb6
+    title: brandiator
+    description: Describe the line what its purpose is and what it does. You got the idea, right?
+    department: Survey
+
+    input_formats:
+      - name: company
+        required: true
+        valid_type: general
+      - name: website
+        required: false
+        valid_type: url
+
+    stations:
+      - station:
+          station_index: 1
+          station_type: work
+          worker:
+            worker_type: human
+            num_workers: 2
+            reward: 5
+          task_form:
+            form_title: Enter text from a business card image for TASKFORM
+            instruction: Read the business card image and the fill the fields for TASKFORM
+            form_fields:
+              - label: CEO Name
+                field_type: short_answer
+                required: true
+              - label: CEO Email
+                field_type: email
+                required: true
+      - station:
+          station_index: 2
+          station_type: work
+          worker:
+            worker_type: human
+            num_workers: 1
+            reward: 3
+          custom_task_form:
+            form_title: Enter text from a business card image for CUSTOMTASKFORM
+            instruction: Read the business card image and the fill the fields for CUSTOMTASKFORM
+            html: form.html
+            css: form.css
+            js: form.js
+    """
+    And a file named "brandiator/station_2/form.html" with:
+    """
+    <div id="my_form_instructions" class="brandiator cf_form_instruction">
+      <ul>
+        <li>Sample bullet list of instruction</li>
+      </ul>
+    </div>
+    <div id="my_form" class="brandiator cf_form_content">
+    <label>{{company}}</label>
+    <label>{{website}}</label>
+    <div id = "field-panel">
+    <p><label>ceo</label><input id="ceo" type="text" name="output[ceo]" data-valid-type="string" /></p>
+    <p><label>email</label><input id="email" type="text" name="output[email]" data-valid-type="email" /></p>
+    </div>
+    </div>
+    """
+    And a file named "brandiator/station_2/form.css" with:
+    """
+    body { background: #e0e0d8; color: #000; }
+    """
+    And a file named "brandiator/station_2/form.js" with:
+    """
+    <script type="text/javascript">
+    $(document).ready(function(){
+      //do your stuff here
+    });
+    </script>
+    """
+  
+    And I cd to "brandiator"
+    When I run `cf line create`
+    Then the output should match:
+      """
+      Congrats! brandiator was successfully created.
+      View your line at http://taken.lvh.me:3000/lines/taken/brandiator
+      Now you can do production runs with: cf production start <your_run_title>
+      Note: Make sure your-run-title.csv file is in the input directory.
+      """

data/features/line_deletion.feature

@@ -0,0 +1,50 @@
+Feature: Deleting a line on CF
+  In order to delete a line
+  As a CLI user
+  I want to delete a line via cli for the line
+
+  @announce, @too_slow_process
+  Scenario: Creating then deleting a Line
+    Given a file named ".cf_credentials" with:
+    """
+    ---
+    :target_url: http://lvh.me:3000/api/
+    :api_version: v1
+    """
+    And a file named "brandiator/line.yml" with:
+    """
+    api_key: 89ceebf739adbf59d34911f4f28b2fa0e1564fb6
+    title: brandiator-deletion
+    description: Describe the line what its purpose is and what it does. You got the idea, right?
+    department: Survey
+    input_formats:
+      - name: company
+        required: true
+        valid_type: general
+    stations:
+      - station:
+          station_index: 1
+          station_type: work
+          worker:
+            worker_type: human
+            num_workers: 2
+            reward: 5
+          task_form:
+            form_title: Enter text from a business card image for TASKFORM
+            instruction: Read the business card image and the fill the fields for TASKFORM
+            form_fields:
+              - label: CEO Name
+                field_type: short_answer
+                required: true
+  """
+  And I cd to "brandiator"
+  When I run `cf line create`
+  Then the output should match:
+    """
+    Congrats! brandiator-deletion was successfully created.
+    """
+  When I run `cf line delete`
+  Then the output should match:
+    """
+    The line brandiator-deletion is deleted successfully!
+    """

data/features/line_generation.feature

@@ -0,0 +1,57 @@
+Feature: Line manage
+  In order to generate a line yaml scaffold
+  As a CLI user
+  I want to scaffold a line
+  
+  @slow_process, @announce
+  Scenario: Scaffolding a line
+    Given a directory named "cf_apps"
+    And I cd to "cf_apps"
+    When I run `cf line generate brandiator`
+    Then a file named "brandiator/line.yml" should exist
+    And the following files should exist:
+      | brandiator/station_2/form.html |
+      | brandiator/station_2/form.css  |
+      | brandiator/station_2/form.js   |
+      | brandiator/input/brandiator.csv |
+
+    And a directory named "brandiator/output" should exist
+    And the output should contain:
+      """
+      A new line named brandiator generated.
+      Modify the brandiator/line.yml file and you can create this line with: cf line create
+      """
+
+  @slow_process, @no-clobber
+  Scenario: Overwriting with a --force (-f) flag for an existing line
+    And I cd to "cf_apps"
+    When I run `cf line generate brandiator`
+    Then the output should match:
+    """
+    Skipping brandiator/line.yml because it already exists.
+    Use the -f flag to force it to overwrite or check and delete it manually.
+    """
+
+  Scenario: No api_key present in the yaml file
+    Given a file named ".cf_credentials" with:
+    """
+    ---
+    :target_url: http://lvh.me:3000/api/
+    :api_version: v1
+    
+    """
+    
+    Given a directory named "cf_apps"
+    And I cd to "cf_apps"
+    And a file named "brandiator/line.yml" with:
+      """
+      api_key:
+      title: brandiator
+      department: Survey
+      """
+    And I cd to "brandiator"
+    When I run `cf line create`
+    Then the output should match:
+      """
+      The api_key is missing in the line.yml file
+      """

data/features/run.feature

@@ -0,0 +1,141 @@
+Feature: Create a production run on CF
+  In order to create a run with the generated line
+  As a CLI user
+  I want to make a production run
+
+  @announce
+  Scenario: Creating a production run without run title
+    Given an empty file named "brandiator/line.yml"
+    And I cd to "brandiator"
+    When I run `cf production start`
+    Then the output should contain:
+      """
+      The run title is required to start the production.
+      """
+
+  @announce
+  Scenario: Warn about the missing input/input_data.csv input file if not present
+    Given a file named "brandiator/line.yml" with:
+    """
+    api_key: 89ceebf739adbf59d34911f4f28b2fa0e1564fb6
+    title: brandiator
+    """
+    And I cd to "brandiator"
+    And a directory named "input"
+    When I run `cf production start my_first-run -i input_data.csv`
+    Then the output should contain:
+      """
+      The input data csv file named input/input_data.csv is missing.
+      """
+
+  @announce
+  Scenario: Warn about the missing input/run-title.csv input file if not present when -i optional value is not passed
+    Given a file named "brandiator/line.yml" with:
+    """
+    api_key: 89ceebf739adbf59d34911f4f28b2fa0e1564fb6
+    title: brandiator
+    """
+    And I cd to "brandiator"
+    And a directory named "input"
+    When I run `cf production start my_first-run`
+    Then the output should contain:
+      """
+      The input data csv file named input/my-first-run.csv is missing.
+      """
+
+  @announce, @too_slow_process
+  Scenario: Starting a production
+    Given a file named ".cf_credentials" with:
+    """
+    ---
+    :target_url: http://lvh.me:3000/api/
+    :api_version: v1
+  
+    """
+    And a file named "brandiator/station_2/form.html" with:
+    """
+    <div id="my_form_instructions" class="brandiator cf_form_instruction">
+      <ul>
+        <li>Sample bullet list of instruction</li>
+      </ul>
+    </div>
+    <div id="my_form" class="brandiator cf_form_content">
+    <label>{{company}}</label>
+    <label>{{website}}</label>
+    <div id = "field-panel">
+    <p><label>ceo</label><input id="ceo" type="text" name="output[ceo]" data-valid-type="string" /></p>
+    <p><label>email</label><input id="email" type="text" name="output[email]" data-valid-type="email" /></p>
+    </div>
+    </div>
+    """
+    And a file named "brandiator/station_2/form.css" with:
+    """
+    body { background: #e0e0d8; color: #000; }
+    """
+    And a file named "brandiator/station_2/form.js" with:
+    """
+    <script type="text/javascript">
+    $(document).ready(function(){
+      //do your stuff here
+    });
+    </script>
+    """
+    
+    And a file named "brandiator/line.yml" with:
+    """
+    api_key: 89ceebf739adbf59d34911f4f28b2fa0e1564fb6
+    title: brandiator
+    description: Describe the line what its purpose is and what it does. You got the idea, right?
+    department: Survey
+
+    input_formats:
+      - name: company
+        required: true
+        valid_type: general
+      - name: website
+        required: false
+        valid_type: url
+
+    stations:
+      - station:
+          station_index: 1
+          station_type: work
+          worker:
+            worker_type: human
+            num_workers: 2
+            reward: 5
+          task_form:
+            form_title: Enter text from a business card image for TASKFORM
+            instruction: Read the business card image and the fill the fields for TASKFORM
+            form_fields:
+              - label: CEO Name
+                field_type: short_answer
+                required: true
+              - label: CEO Email
+                field_type: email
+                required: true
+      - station:
+          station_index: 2
+          station_type: work
+          worker:
+            worker_type: human
+            num_workers: 1
+            reward: 3
+          custom_task_form:
+            form_title: Enter text from a business card image for CUSTOMTASKFORM
+            instruction: Read the business card image and the fill the fields for CUSTOMTASKFORM
+            html: form.html
+            css: form.css
+            js: form.js
+    """
+    And a file named "brandiator/input/my-run-title.csv" with:
+    """
+    company,website,meta_data_company
+    Apple,apple.com,Apple
+    """
+    And I cd to "brandiator"
+    When I run `cf production start my_run_title`
+    Then the output should match:
+      """
+      A run with title my-run-title using the line brandiator was successfully created.
+      """