rainforest-cli 1.10.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aefdfe1a4a5ecf73e5b919dbbf6da1bb7d13f5c1
-  data.tar.gz: 88ee5992a58f3340535f3b1d21ed54f8fea53cc8
+  metadata.gz: 2b75c82906788c8a2ee74b5d0ddb6311c7b644dd
+  data.tar.gz: 3a80fd662427ed53bc4e850d85f13a0ad7e4ae96
 SHA512:
-  metadata.gz: 4787e5a59c11fe612a982f2aabb51e6ed5386e2fef18fb5771aad337d54334b7514dfe4ea82d5738c51fb39496e28e13a5f3d440ac0773298eba2082c724969f
-  data.tar.gz: 64c1ef609db5add1c02c19e04d241e73520123b15d5c3fc60c0388875e3994b670f934c6b78b52c5f3750edc829445477a8b71ed544a6a676d4b9dd9d6ebf1b7
+  metadata.gz: 837d61212b55d32434c933547c50224522e5c0da42d10ed5da14f8db6784242927861815fa724d1bf8eeade388f2feedc74b06ec70a0336224e93a490b32db1e
+  data.tar.gz: 6dcf90bfca52ee02e8c1f72df2fd471bfef755c52cb374a8995b994e5d7605b159f63fd85b0947ba0a57904175d8a6e24b71a243fe9b97ca3e501c9e4b689d25

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Rainforest CLI Changelog
 
+## 1.10.1 - 10th October 2016
+- Add documentation for commands to `--help` text. (fe3fddbe7086a6b914ffe74f65ae128a14277f82, @epaulet)
+- Use more efficient CSV upload method. (e716e76b7627b334c4f8b50fd0afdad6fadd162e, @epaulet)
+
 ## 1.10.0 - 19th September 2016
 - Add `--overwrite-variable` option to overwrite existing tabular variables if the
 desired variable name is already taken when uploading CSVs. (ebf4ab90c5db2589695eaf6c3d4c4206bad17e7b,

data/lib/rainforest_cli.rb

@@ -5,6 +5,7 @@ require 'logger'
 require 'rainforest_cli/version'
 require 'rainforest_cli/constants'
 require 'rainforest_cli/options'
+require 'rainforest_cli/commands'
 require 'rainforest_cli/runner'
 require 'rainforest_cli/http_client'
 require 'rainforest_cli/git_trigger'
@@ -23,9 +24,24 @@ require 'rainforest_cli/reporter'
 module RainforestCli
   def self.start(args)
     options = OptionParser.new(args)
+    commands = Commands.new do |c|
+      c.add('run', 'Run your tests on Rainforest') { Runner.new(options).run }
+      c.add('new', 'Create a new RFML test') { TestFiles.new(options).create_file }
+      c.add('validate', 'Validate your RFML tests') { Validator.new(options).validate }
+      c.add('upload', 'Upload your RFML tests') { Uploader.new(options).upload }
+      c.add('rm', 'Remove an RFML test locally and remotely') { Deleter.new(options).delete }
+      c.add('export', 'Export your remote Rainforest tests to RFML') { Exporter.new(options).export }
+      c.add('csv-upload', 'Upload a new tabular variable from a CSV file') { CSVImporter.new(options).import }
+      c.add('report', 'Create a JUnit report from your run results') { Reporter.new(options).report }
+    end
+
     @http_client = HttpClient.new(token: options.token)
     ::Rainforest.api_key = options.token
-    OptionParser.new(['--help']) if args.size == 0
+
+    if args.size == 0
+      commands.print_documentation
+      options.print_documentation
+    end
 
     begin
       options.validate!
@@ -34,22 +50,7 @@ module RainforestCli
       exit 2
     end
 
-    case options.command
-    when 'run' then Runner.new(options).run
-    when 'new' then TestFiles.new(options).create_file
-    when 'validate' then Validator.new(options).validate
-    when 'upload' then Uploader.new(options).upload
-    when 'rm' then Deleter.new(options).delete
-    when 'export' then Exporter.new(options).export
-    when 'csv-upload' then CSVImporter.new(options).import
-    when 'report' then Reporter.new(options).report
-    when 'sites', 'folders', 'browsers'
-      Resources.new(options).public_send(options.command)
-    else
-      logger.fatal 'Unknown command'
-      exit 2
-    end
-
+    commands.call(options.command) if options.command
     true
   end
 

data/lib/rainforest_cli/commands.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RainforestCli
+  class Commands
+    Command = Struct.new(:name, :description, :block)
+
+    attr_reader :commands
+
+    def initialize
+      @commands = []
+      yield(self) if block_given?
+    end
+
+    def add(command, description, &blk)
+      @commands << Command.new(command, description, blk)
+    end
+
+    def call(command_name)
+      command = @commands.find { |c| c.name == command_name }
+
+      if command.nil?
+        logger.fatal "Unknown command: #{command_name}"
+        exit 2
+      end
+
+      command.block.call
+    end
+
+    def print_documentation
+      command_col_width = @commands.map { |c| c.name.length }.max
+      puts 'Usage: Rainforest CLI commands:'
+      @commands.each do |command|
+        puts "\t#{command.name.ljust(command_col_width)}\t\t#{command.description}"
+      end
+    end
+
+    private
+
+    def logger
+      RainforestCli.logger
+    end
+  end
+end

data/lib/rainforest_cli/csv_importer.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 require 'csv'
-require 'parallel'
-require 'ruby-progressbar'
 
 module RainforestCli
   class CSVImporter
@@ -24,7 +22,7 @@ module RainforestCli
 
       # Create the generator
       columns = rows.shift.map do |column|
-        {name: column.downcase.strip.gsub(/\s/, '_')}
+        column.downcase.strip.gsub(/\s/, '_')
       end
       raise 'Invalid schema in CSV. You must include headers in first row.' if !columns
 
@@ -45,17 +43,15 @@ module RainforestCli
       raise "Error creating tabular variable: #{response['error']}" if response['error']
       puts "\t[OK]"
 
-      @columns = response['columns']
-      @generator_id = response['id']
+      columns = response['columns']
+      generator_id = response['id']
+      data = rows.map { |row| row_data(columns, row) }
 
       puts 'Uploading data...'
-      p = ProgressBar.create(title: 'Rows', total: rows.count, format: '%a %B %p%% %t')
-
-      # Insert the data
-      Parallel.each(rows, in_threads: RainforestCli::THREADS, finish: lambda { |_item, _i, _result| p.increment }) do |row|
-        response = http_client.post("/generators/#{@generator_id}/rows", {data: row_data(@columns, row)})
-        raise response['error'] if response['error']
-      end
+      response = http_client.post("/generators/#{generator_id}/rows/batch", data: data)
+      # NOTE: Response for this endpoint will usually be an array representing all the rows created
+      raise response['error'] if response.is_a?(Hash) && response['error']
+      puts 'Upload complete.'
     end
 
     private

data/lib/rainforest_cli/options.rb

@@ -128,7 +128,7 @@ module RainforestCli
           exit 0
         end
 
-        opts.on_tail('--version', 'Display gem version') do
+        opts.on_tail('--version', '-v', 'Display gem version') do
           puts opts.ver
           exit 0
         end
@@ -150,6 +150,10 @@ module RainforestCli
       @tests = @args.dup
     end
 
+    def print_documentation
+      self.class.new(['--help'])
+    end
+
     def tests
       @tests
     end
@@ -175,7 +179,7 @@ module RainforestCli
     end
 
     def validate!
-      if !TOKEN_NOT_REQUIRED.include?(command)
+      unless command.nil? || TOKEN_NOT_REQUIRED.include?(command)
         unless token
           raise ValidationError, 'You must pass your API token using: --token TOKEN'
         end

data/lib/rainforest_cli/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module RainforestCli
-  VERSION = '1.10.0'
+  VERSION = '1.10.1'
 end

data/spec/rainforest_cli/commands_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+describe RainforestCli::Commands do
+  subject { described_class.new }
+
+  describe '#initialize' do
+    it 'works without giving a block' do
+      expect { described_class.new }.to_not raise_error
+    end
+
+    it 'adds commands to list' do
+      commands = described_class.new do |c|
+        c.add('foo', 'bar') { 'baz' }
+        c.add('blah', 'blah') { 'blah' }
+      end
+
+      expect(commands.commands.length).to eq(2)
+    end
+  end
+
+  describe '#add' do
+    let(:first_command) { subject.commands.first }
+
+    it 'properly adds a command to the list of commands' do
+      subject.add('foo', 'bar') { 'baz' }
+      expect(first_command.name).to eq('foo')
+      expect(first_command.description).to eq('bar')
+      expect(first_command.block.call).to eq('baz')
+    end
+  end
+
+  describe '#call' do
+    let(:service_object) { double }
+
+    before do
+      subject.add('my_command', 'desc') { service_object.my_method }
+    end
+
+    it "calls the corresponding command's block" do
+      expect(service_object).to receive(:my_method)
+      subject.call('my_command')
+    end
+
+    it 'raises a fatal error if the command does not exist' do
+      expect { subject.call('my_other_command') }.to raise_error(SystemExit)
+    end
+  end
+end

data/spec/rainforest_cli/csv_importer_spec.rb

@@ -31,24 +31,22 @@ describe RainforestCli::CSVImporter do
                                 .with('/generators', {
                                         name: 'variables',
                                         description: 'variables',
-                                        columns: columns.map {|col| { name: col } },
+                                        columns: columns,
                                       })
                                 .and_return success_response
 
         expect(http_client).to receive(:post)
-                                .with("/generators/#{generator_id}/rows", {
-                                        data: {
-                                          0 => 'russ@rainforestqa.com',
-                                          1 => 'abc123',
-                                        },
-                                      }).and_return({})
-
-        expect(http_client).to receive(:post)
-                                .with("/generators/#{generator_id}/rows", {
-                                        data: {
-                                          0 => 'bob@example.com',
-                                          1 => 'hunter2',
-                                        },
+                                .with("/generators/#{generator_id}/rows/batch", {
+                                        data: [
+                                          {
+                                            0 => 'russ@rainforestqa.com',
+                                            1 => 'abc123',
+                                          },
+                                          {
+                                            0 => 'bob@example.com',
+                                            1 => 'hunter2',
+                                          },
+                                        ],
                                       }).and_return({})
         subject.import
       end

data/spec/rainforest_cli/options_spec.rb

@@ -143,12 +143,12 @@ describe RainforestCli::OptionParser do
     end
 
     context 'with valid arguments' do
-      let(:args) { %w(--token foo) }
+      let(:args) { %w(new) }
       it { does_not_raise_a_validation_exception }
     end
 
     context 'with missing token' do
-      let(:args) { %w() }
+      let(:args) { %w(upload) }
       it { raises_a_validation_exception }
     end
 

data/spec/rainforest_cli_spec.rb

@@ -40,6 +40,15 @@ describe RainforestCli do
       end
     end
 
+    context 'no parameters' do
+      let(:params) { %w() }
+      it 'prints out the help docs' do
+        expect_any_instance_of(RainforestCli::Commands).to receive(:print_documentation)
+        expect_any_instance_of(RainforestCli::OptionParser).to receive(:print_documentation)
+        described_class.start(params)
+      end
+    end
+
     context 'git-trigger' do
       let(:params) { %w(run --token x --git-trigger) }
       let(:commit_message) { 'a test commit message' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.10.1
 platform: ruby
 authors:
 - Russell Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -190,6 +190,7 @@ files:
 - bin/rainforest
 - examples/inline_files.md
 - lib/rainforest_cli.rb
+- lib/rainforest_cli/commands.rb
 - lib/rainforest_cli/constants.rb
 - lib/rainforest_cli/csv_importer.rb
 - lib/rainforest_cli/deleter.rb
@@ -220,6 +221,7 @@ files:
 - spec/multiple-rainforest-examples/example_test.rfml
 - spec/multiple-rainforest-examples/example_test_2.rfml
 - spec/rainforest-example/example_test.rfml
+- spec/rainforest_cli/commands_spec.rb
 - spec/rainforest_cli/csv_importer_spec.rb
 - spec/rainforest_cli/deleter_spec.rb
 - spec/rainforest_cli/exporter_spec.rb
@@ -290,6 +292,7 @@ test_files:
 - spec/multiple-rainforest-examples/example_test.rfml
 - spec/multiple-rainforest-examples/example_test_2.rfml
 - spec/rainforest-example/example_test.rfml
+- spec/rainforest_cli/commands_spec.rb
 - spec/rainforest_cli/csv_importer_spec.rb
 - spec/rainforest_cli/deleter_spec.rb
 - spec/rainforest_cli/exporter_spec.rb