results_keeper_rspec 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36cdc1060d91d057f084dac5578d4bb3e06eaeef
-  data.tar.gz: f73f981f7c0724d7b6a45478fcf9733f98ad553b
+  metadata.gz: f3cd9a3afd8dee63e52582d6c859e2ddfc512375
+  data.tar.gz: 278dd795b61ae28b30233b4236881a1fa07cac00
 SHA512:
-  metadata.gz: c1cddd66c279b5ea1653c8e27cb058993722cfa291eefcbb43e83c3e51d1f06cdbbe4d79f5e7acfefffc5de883f788925a54525d9ae79636824bc00a95ff488e
-  data.tar.gz: 70a4d7a0951395339a48f2a8cfc33df4211d75537022c945686051ec3d2de424ee4ebe7d3607bab5bd93bdf40d701939d777cc83df5f259205618522ef3381c7
+  metadata.gz: 370ec76222086a0a668aa4eefb3fbf1e5d1ea584bd1991d50f398c9c209ea713677de912ddbc102fb75333f739dca05d62ef6bb972f2825df06aed39b6177057
+  data.tar.gz: 2e1cebcd4d4ed7eb1f113238e14158b5ca9dc550d5751999d0bfd6f8ef503ec37cffd00cd7311e70c21d4f17d74efe47122bd5cba97fbb19149f0ba23c83c58d

data/lib/results_keeper_rspec.rb

@@ -1,96 +1,27 @@
-require 'net/http'
-require 'json'
-require 'rest_client'
-require_relative 'string'
+require_relative 'results_keeper_rspec/results_sender'
 require 'singleton'
 require 'fileutils'
 
 class ResultsKeeperRspec
   include Singleton
 
-  attr_reader :revision_name, :revision_project
-
-  DEFAULT_PORT = 80
-  DEFAULT_HOST = 'results-keeper-api.herokuapp.com'
+  attr_reader :results_sender
 
   def initialize
-    @revision_name = ENV['REVISION_NAME'] || "Result for #{Time.now}"
-    @revision_project = ENV['PROJECT_NAME'] || 'Default'
+    @results_sender = RkRspec::ResultsSender.new
   end
 
   def send_revision
-    data = { revision: @revision_name, project: project_name }
-    @revision = send_json(data, 'revisions')
+    @results_sender.send_revision
   end
 
   def send_revision_complete
-    data = { revision: @revision_name, project: project_name, completed: 1 }
-    send_json(data, 'revisions')
-    remove_screenshots
+    @results_sender.send_revision_complete
   end
 
   def send_test(scenario)
-    test_duration = Time.now - scenario.metadata[:execution_result].started_at
-    @screenshot_path = save_screenshot(scenario) if ENV['SEND_SCREENSHOTS']
-    status = scenario.exception ? 'failed' : 'passed'
-    scenario_error = scenario.exception.message if scenario.exception
-    run_path = "rspec #{scenario.location}"
-    data = {
-     name: "#{scenario.example_group.description} - #{scenario.description}",
-     status: status,
-     feature_name: scenario.example_group.description,
-     run_path: run_path,
-     error: scenario_error,
-     revision_id: @revision['revision_id'],
-     duration: test_duration
-    }
-    @test = send_json(data, 'tests')
-    send_screenshot(@screenshot_path) if @screenshot_path
-  end
-
-  def save_screenshot(scenario)
-    if scenario.exception
-      screenshot_name = "#{Time.now.to_i}_#{rand(1000..9999)}.png"
-      @file_path = "tmp/screenshots/#{screenshot_name}"
-      Capybara.page.save_screenshot(@file_path)
-      @file_path
-    end
-  end
-
-  def send_json(body, path)
-    @host = ENV['REPORT_SERVER_HOST'] || DEFAULT_HOST
-    @port = ENV['REPORT_SERVER_PORT'] || DEFAULT_PORT
-
-    body['secret_key'] = ENV['RK_SECRET_KEY']
-    @path = "/api/#{path}"
-    @body = body.to_json
-
-    request = Net::HTTP::Post.new(@path, initheader = {'Content-Type' =>'application/json'})
-    request.body = @body
-    response = Net::HTTP.new(@host, @port).start {|http| http.request(request) }
-    puts "    RK: #{response.code} - #{response.message}".blue
-    result_hash = JSON.parse(response.body) rescue console_message('There seems to be a problem. Are you authorized?')
-    result_hash
-  end
-
-  def send_screenshot(screenshot_path)
-    if ENV['SEND_SCREENSHOTS']
-      params = { project: @revision['project_id'], revision: @revision['revision_id'], test: @test['id'] }
-      RestClient.post("http://#{@host}:#{@port}/api/tests/upload_screenshot",
-                      :name_of_file_param => File.new(screenshot_path), :body => params)
-      FileUtils.rm(screenshot_path)
+    unless @results_sender.send_test(scenario)
+      @results_sender.add_test_to_tmp(scenario)
     end
   end
-
-  def project_name
-    ENV['PROJECT_NAME']
-  end
-
-  def console_message(text)
-    puts "    RK: #{text}".blue
-  end
-
-  def remove_screenshots
-    FileUtils.rm_rf(Dir.glob('tmp/screenshots/*'))
-  end
 end

data/lib/results_keeper_rspec/config.rb

@@ -0,0 +1,38 @@
+module RkRspec
+  class Config
+    class << self
+
+      def default
+        {
+          project_name: 'Default',
+          report_server_host: 'results-keeper.com',
+          report_server_port: 80,
+          api: {
+            revision_path: 'revisions',
+            test_path: 'tests'
+          }
+        }
+      end
+
+      def config
+        opts = {}
+        opts[:report_server_host] = ENV['RK_REPORT_SERVER_HOST'] if ENV['RK_REPORT_SERVER_HOST']
+        opts[:report_server_port] = ENV['RK_REPORT_SERVER_PORT'] if ENV['RK_REPORT_SERVER_PORT']
+        opts[:project_name] = ENV['RK_PROJECT_NAME'] || default_project_name
+        opts[:revision_name] = ENV['RK_REVISION_NAME'] || ENV['RK_REVISION_NAME'] = "Result for #{Time.now}"
+        opts[:secret_key] = ENV['RK_SECRET_KEY'] || raise(RkRspec::Messages.no_secret_key)
+        default.merge!(opts)
+      end
+
+      private
+
+      def default_project_name
+        begin
+          `pwd`.strip.split('/').last
+        rescue
+          'Default'
+        end
+      end
+    end
+  end
+end

data/lib/results_keeper_rspec/messages.rb

@@ -0,0 +1,50 @@
+require_relative 'string'
+require_relative 'config'
+
+module RkRspec
+  class Messages
+    class << self
+
+      # ERROR
+      def take_screenshot_error
+        console_warning_message('Could not take a screenshot :(')
+      end
+
+      def error_send_screenshot
+        console_warning_message("Could not send screenshot, there seems to be a problem with #{RkRspec::Config.config[:report_server_host]}:#{RkRspec::Config.config[:report_server_port]}")
+      end
+
+      def error_not_sent_scenario(amount)
+        console_warning_message("Not sent scenarios amount: #{amount}")
+      end
+
+      def no_secret_key
+        'RK_SECRET_KEY env var not found. Please use export RK_SECRET_KEY=<your secret key> to set it.'
+      end
+
+      # INFO
+      def info_trying_resend(scenario_name)
+        console_message("Trying to re-send '#{scenario_name}' once more")
+      end
+
+      def info_message_to_client(response, message_to_client=nil)
+        message_to_client ? console_message("#{message_to_client} - #{response.code} - #{response.message}") : console_message("#{response.code} - #{response.message}")
+      end
+
+      # WARN
+      def warn_problem_with_rk
+        console_warning_message("There seems to be a problem with #{RkRspec::Config.config[:report_server_host]}:#{RkRspec::Config.config[:report_server_port]}, make sure your RK_SECRET_KEY is correct and server is up.")
+      end
+
+      def console_message(text)
+        private
+        puts "    Results Keeper: #{text}".blue unless ENV['HIDE_RK_MESSAGES'] == 'true'
+      end
+
+      def console_warning_message(text)
+        private
+        puts "    Results Keeper: #{text}".yellow unless ENV['HIDE_RK_MESSAGES'] == 'true'
+      end
+    end
+  end
+end

data/lib/results_keeper_rspec/results_sender.rb

@@ -0,0 +1,88 @@
+require 'net/http'
+require 'json'
+require 'rest_client'
+require 'pry'
+require_relative 'messages'
+require_relative 'config'
+require_relative 'test_data_generator'
+
+module RkRspec
+  class ResultsSender
+
+    attr_reader :tmp_data
+
+    def initialize
+      @data_generator = RkRspec::TestDataGenerator.new
+      @tmp_data ||= {}
+      @tmp_data[:tests] ||= []
+    end
+
+    def send_revision
+      @revision = send_json(@data_generator.revision_data,
+                            RkRspec::Config.default[:api][:revision_path],
+                            "#{RkRspec::Config.config[:project_name]} > #{RkRspec::Config.config[:revision_name]} started")
+    end
+
+    def send_revision_complete
+      send_not_sent_scenarios
+      send_json(@data_generator.revision_completed_data,
+                RkRspec::Config.default[:api][:revision_path],
+                "#{RkRspec::Config.config[:revision_name]} completed")
+    end
+
+    def send_test(scenario)
+      # In case if the host is not available we need to send revision once more (when it comes back)
+      send_revision unless @revision
+      return unless @revision
+      screenshot_path = @data_generator.save_screenshot(scenario) if ENV['RK_SEND_SCREENSHOTS']
+      @test = send_json(@data_generator.test_data(scenario, @revision),
+                        RkRspec::Config.default[:api][:test_path], nil)
+      send_screenshot(screenshot_path) if screenshot_path
+      @test
+    end
+
+    def send_screenshot(screenshot_path)
+      begin
+        params = { project: @revision['project_id'], revision: @revision['revision_id'], test: @test['id'] }
+        RestClient.post("http://#{RkRspec::Config.config[:report_server_host]}:#{RkRspec::Config.config[:report_server_port]}/api/tests/upload_screenshot",
+                        :name_of_file_param => File.new(screenshot_path), :body => params)
+        File.delete(screenshot_path)
+      rescue
+        RkRspec::Messages.error_send_screenshot
+      end
+    end
+
+    def send_json(body, path, message_to_client=nil)
+      body['secret_key'] = RkRspec::Config.config[:secret_key]
+      @path = "/api/#{path}"
+      @body = body.to_json
+      begin
+        request = Net::HTTP::Post.new(@path, initheader = {'Content-Type' => 'application/json'})
+        request.body = @body
+        response = Net::HTTP.new(RkRspec::Config.config[:report_server_host],
+                                 RkRspec::Config.config[:report_server_port]).start { |http| http.request(request) }
+
+        RkRspec::Messages.info_message_to_client(response, message_to_client) if message_to_client
+        JSON.parse(response.body)
+      rescue
+        false
+      end
+    end
+
+    def send_not_sent_scenarios
+      if @revision
+        @tmp_data[:tests].each do |s|
+          s[:revision_id] = @revision['revision_id'] unless s[:revision_id]
+          RkRspec::Messages.info_trying_resend(s[:name])
+          send_json(s, RkRspec::Config.default[:api][:test_path]) if @revision
+        end
+      else
+        false
+      end
+    end
+
+    def add_test_to_tmp(scenario)
+      @tmp_data[:tests] << @data_generator.test_data(scenario, @revision)
+    end
+  end
+end

data/lib/results_keeper_rspec/test_data_generator.rb

@@ -0,0 +1,40 @@
+require_relative 'config'
+
+module RkRspec
+  class TestDataGenerator
+
+    def revision_data
+      { revision: RkRspec::Config.config[:revision_name], project: RkRspec::Config.config[:project_name] }
+    end
+
+    def revision_completed_data
+      { revision: RkRspec::Config.config[:revision_name], project: RkRspec::Config.config[:project_name], completed: 1 }
+    end
+
+    def test_data(scenario, revision)
+      revision ||= { revision_id: nil }
+      test_duration = Time.now - scenario.metadata[:execution_result].started_at
+      status = scenario.exception ? 'failed' : 'passed'
+      scenario_error = scenario.exception.message if scenario.exception
+      run_path = "rspec #{scenario.location}"
+      {
+        name: "#{scenario.example_group.description} - #{scenario.description}",
+        status: status,
+        feature_name: scenario.example_group.description,
+        run_path: run_path,
+        error: scenario_error,
+        revision_id: revision['revision_id'],
+        duration: test_duration
+      }
+    end
+
+    def save_screenshot(scenario)
+      if scenario.exception
+        screenshot_name = "#{Time.now.to_i}_#{rand(1000..9999)}.png"
+        @file_path = "tmp/screenshots/#{screenshot_name}"
+        Capybara.page.save_screenshot(@file_path)
+        @file_path
+      end
+    end
+  end
+end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: results_keeper_rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ivan Kozakov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flickraw
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Results Keeper is a application which can help you to track and manage
@@ -46,7 +46,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/results_keeper_rspec.rb
-- lib/string.rb
+- lib/results_keeper_rspec/config.rb
+- lib/results_keeper_rspec/messages.rb
+- lib/results_keeper_rspec/results_sender.rb
+- lib/results_keeper_rspec/string.rb
+- lib/results_keeper_rspec/test_data_generator.rb
 homepage: https://bitbucket.org/results_keeper/results_keeper_rspec/
 licenses:
 - MIT
@@ -57,17 +61,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Result Keeper Gem For Rspec Tests