appsignal 2.1.0.alpha.3 → 2.1.0.beta.1

data/lib/appsignal/transmitter.rb

@@ -1,13 +1,13 @@
-require 'net/http'
-require 'net/https'
-require 'uri'
-require 'rack/utils'
-require 'json'
+require "net/http"
+require "net/https"
+require "uri"
+require "rack/utils"
+require "json"
 
 module Appsignal
   class Transmitter
-    CONTENT_TYPE = 'application/json; charset=UTF-8'.freeze
-    CONTENT_ENCODING = 'gzip'.freeze
+    CONTENT_TYPE = "application/json; charset=UTF-8".freeze
+    CONTENT_ENCODING = "gzip".freeze
 
     HTTP_ERRORS = [
       EOFError,
@@ -23,20 +23,18 @@ module Appsignal
 
     attr_reader :config, :action
 
-    def initialize(action, config=Appsignal.config)
+    def initialize(action, config = Appsignal.config)
       @action = action
       @config = config
     end
 
     def uri
       @uri ||= URI("#{config[:endpoint]}/1/#{action}").tap do |uri|
-        uri.query = ::Rack::Utils.build_query({
-          :api_key => config[:push_api_key],
+        uri.query = ::Rack::Utils.build_query(:api_key => config[:push_api_key],
           :name => config[:name],
           :environment => config.env,
           :hostname => config[:hostname],
-          :gem_version => Appsignal::VERSION
-        })
+          :gem_version => Appsignal::VERSION)
       end
     end
 
@@ -49,22 +47,23 @@ module Appsignal
 
     def http_post(payload)
       Net::HTTP::Post.new(uri.request_uri).tap do |request|
-        request['Content-Type'] = CONTENT_TYPE
-        request['Content-Encoding'] = CONTENT_ENCODING
+        request["Content-Type"] = CONTENT_TYPE
+        request["Content-Encoding"] = CONTENT_ENCODING
         request.body = Appsignal::Utils::Gzip.compress \
           Appsignal::Utils::JSON.generate(payload)
       end
     end
 
     def http_client
-      client = if config[:http_proxy]
-        Net::HTTP.new(uri.host, uri.port, proxy_addr, proxy_port)
-      else
-        Net::HTTP.new(uri.host, uri.port)
-      end
+      client =
+        if config[:http_proxy]
+          Net::HTTP.new(uri.host, uri.port, proxy_addr, proxy_port)
+        else
+          Net::HTTP.new(uri.host, uri.port)
+        end
 
       client.tap do |http|
-        if uri.scheme == 'https'
+        if uri.scheme == "https"
           http.use_ssl     = true
           http.ssl_version = :TLSv1
           http.verify_mode = OpenSSL::SSL::VERIFY_PEER
@@ -85,19 +84,13 @@ module Appsignal
     end
 
     def proxy_addr
-      if config[:http_proxy]
-        proxy_uri.host
-      else
-        nil
-      end
+      return unless config[:http_proxy]
+      proxy_uri.host
     end
 
     def proxy_port
-      if config[:http_proxy]
-        proxy_uri.port
-      else
-        nil
-      end
+      return unless config[:http_proxy]
+      proxy_uri.port
     end
   end
 end

data/lib/appsignal/utils.rb

@@ -1,5 +1,5 @@
-require 'appsignal/utils/params_sanitizer'
-require 'appsignal/utils/query_params_sanitizer'
+require "appsignal/utils/params_sanitizer"
+require "appsignal/utils/query_params_sanitizer"
 
 module Appsignal
   module Utils
@@ -101,7 +101,7 @@ module Appsignal
 
         def encode_utf8(value)
           value.encode(
-            'utf-8'.freeze,
+            "utf-8".freeze,
             :invalid => :replace,
             :undef   => :replace
           )

data/lib/appsignal/utils/params_sanitizer.rb

@@ -1,7 +1,7 @@
 module Appsignal
   module Utils
     class ParamsSanitizer
-      FILTERED = '[FILTERED]'.freeze
+      FILTERED = "[FILTERED]".freeze
 
       class << self
         def sanitize(params, options = {})

data/lib/appsignal/utils/query_params_sanitizer.rb

@@ -1,7 +1,7 @@
 module Appsignal
   module Utils
     class QueryParamsSanitizer
-      REPLACEMENT_KEY = '?'.freeze
+      REPLACEMENT_KEY = "?".freeze
 
       module ClassMethods
         def sanitize(params, only_top_level = false, key_sanitizer = nil)

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
-require 'yaml'
+require "yaml"
 
 module Appsignal
-  VERSION = '2.1.0.alpha.3'
+  VERSION = "2.1.0.beta.1"
 end

data/spec/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../.rubocop.yml
+
+# Metrics/LineLength:
+#   Max: 100

data/spec/lib/appsignal/auth_check_spec.rb

@@ -5,18 +5,18 @@ describe Appsignal::AuthCheck do
 
   describe "#perform_with_result" do
     it "should give success message" do
-      auth_check.should_receive(:perform).and_return('200')
-      auth_check.perform_with_result.should eq ['200', 'AppSignal has confirmed authorization!']
+      auth_check.should_receive(:perform).and_return("200")
+      auth_check.perform_with_result.should eq ["200", "AppSignal has confirmed authorization!"]
     end
 
     it "should give 401 message" do
-      auth_check.should_receive(:perform).and_return('401')
-      auth_check.perform_with_result.should eq ['401', 'API key not valid with AppSignal...']
+      auth_check.should_receive(:perform).and_return("401")
+      auth_check.perform_with_result.should eq ["401", "API key not valid with AppSignal..."]
     end
 
     it "should give an error message" do
-      auth_check.should_receive(:perform).and_return('402')
-      auth_check.perform_with_result.should eq ['402', 'Could not confirm authorization: 402']
+      auth_check.should_receive(:perform).and_return("402")
+      auth_check.perform_with_result.should eq ["402", "Could not confirm authorization: 402"]
     end
   end
 
@@ -24,7 +24,7 @@ describe Appsignal::AuthCheck do
     before do
       @transmitter = double
       Appsignal::Transmitter.should_receive(:new).with(
-        'auth',
+        "auth",
         kind_of(Appsignal::Config)
       ).and_return(@transmitter)
     end

data/spec/lib/appsignal/capistrano2_spec.rb

@@ -1,7 +1,7 @@
 if DependencyHelper.capistrano2_present?
-  require 'capistrano'
-  require 'capistrano/configuration'
-  require 'appsignal/capistrano'
+  require "capistrano"
+  require "capistrano/configuration"
+  require "appsignal/capistrano"
 
   describe "Capistrano 2 integration" do
     let(:out_stream) { std_stream }
@@ -9,11 +9,11 @@ if DependencyHelper.capistrano2_present?
     let(:config) { project_fixture_config }
     let(:capistrano_config) do
       Capistrano::Configuration.new.tap do |c|
-        c.set(:rails_env, 'production')
-        c.set(:repository, 'master')
-        c.set(:deploy_to, '/home/username/app')
-        c.set(:current_release, '')
-        c.set(:current_revision, '503ce0923ed177a3ce000005')
+        c.set(:rails_env, "production")
+        c.set(:repository, "master")
+        c.set(:deploy_to, "/home/username/app")
+        c.set(:current_release, "")
+        c.set(:current_revision, "503ce0923ed177a3ce000005")
         c.dry_run = false
       end
     end
@@ -21,18 +21,18 @@ if DependencyHelper.capistrano2_present?
 
     def run
       capture_stdout(out_stream) do
-        capistrano_config.find_and_execute_task('appsignal:deploy')
+        capistrano_config.find_and_execute_task("appsignal:deploy")
       end
     end
 
     it "should have a deploy task" do
-      capistrano_config.find_task('appsignal:deploy').should_not be_nil
+      capistrano_config.find_task("appsignal:deploy").should_not be_nil
     end
 
     describe "appsignal:deploy task" do
       before do
-        ENV['USER'] = 'batman'
-        ENV['PWD'] = project_fixture_path
+        ENV["USER"] = "batman"
+        ENV["PWD"] = project_fixture_path
       end
 
       context "config" do
@@ -43,7 +43,7 @@ if DependencyHelper.capistrano2_present?
         it "should be instantiated with the right params" do
           Appsignal::Config.should_receive(:new).with(
             project_fixture_path,
-            'production',
+            "production",
             {},
             kind_of(Logger)
           )
@@ -51,14 +51,14 @@ if DependencyHelper.capistrano2_present?
 
         context "when appsignal_config is available" do
           before do
-            capistrano_config.set(:appsignal_config, :name => 'AppName')
+            capistrano_config.set(:appsignal_config, :name => "AppName")
           end
 
           it "should be instantiated with the right params" do
             Appsignal::Config.should_receive(:new).with(
               project_fixture_path,
-              'production',
-              {:name => 'AppName'},
+              "production",
+              { :name => "AppName" },
               kind_of(Logger)
             )
           end
@@ -66,14 +66,14 @@ if DependencyHelper.capistrano2_present?
           context "when rack_env is used instead of rails_env" do
             before do
               capistrano_config.unset(:rails_env)
-              capistrano_config.set(:rack_env, 'rack_production')
+              capistrano_config.set(:rack_env, "rack_production")
             end
 
             it "should be instantiated with the right params" do
               Appsignal::Config.should_receive(:new).with(
                 project_fixture_path,
-                'rack_production',
-                {:name => 'AppName'},
+                "rack_production",
+                { :name => "AppName" },
                 kind_of(Logger)
               )
             end
@@ -82,14 +82,14 @@ if DependencyHelper.capistrano2_present?
           context "when stage is used instead of rack_env / rails_env" do
             before do
               capistrano_config.unset(:rails_env)
-              capistrano_config.set(:stage, 'stage_production')
+              capistrano_config.set(:stage, "stage_production")
             end
 
             it "should be instantiated with the right params" do
               Appsignal::Config.should_receive(:new).with(
                 project_fixture_path,
-                'stage_production',
-                {:name => 'AppName'},
+                "stage_production",
+                { :name => "AppName" },
                 kind_of(Logger)
               )
             end
@@ -97,16 +97,16 @@ if DependencyHelper.capistrano2_present?
 
           context "when appsignal_env is set" do
             before do
-              capistrano_config.set(:rack_env, 'rack_production')
-              capistrano_config.set(:stage, 'stage_production')
-              capistrano_config.set(:appsignal_env, 'appsignal_production')
+              capistrano_config.set(:rack_env, "rack_production")
+              capistrano_config.set(:stage, "stage_production")
+              capistrano_config.set(:appsignal_env, "appsignal_production")
             end
 
             it "should prefer the appsignal_env rather than stage, rails_env and rack_env" do
               Appsignal::Config.should_receive(:new).with(
                 project_fixture_path,
-                'appsignal_production',
-                {:name => 'AppName'},
+                "appsignal_production",
+                { :name => "AppName" },
                 kind_of(Logger)
               )
             end
@@ -118,13 +118,13 @@ if DependencyHelper.capistrano2_present?
 
       describe "markers" do
         def stub_marker_request(data = {})
-          stub_api_request config, 'markers', marker_data.merge(data)
+          stub_api_request config, "markers", marker_data.merge(data)
         end
 
         let(:marker_data) do
           {
-            :revision => '503ce0923ed177a3ce000005',
-            :user => 'batman'
+            :revision => "503ce0923ed177a3ce000005",
+            :user => "batman"
           }
         end
 
@@ -134,21 +134,21 @@ if DependencyHelper.capistrano2_present?
             run
 
             expect(output).to include \
-              'Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman',
-              'AppSignal has been notified of this deploy!'
+              "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman",
+              "AppSignal has been notified of this deploy!"
           end
 
           context "with overridden revision" do
             before do
-              capistrano_config.set(:appsignal_revision, 'abc123')
-              stub_marker_request(:revision => 'abc123').to_return(:status => 200)
+              capistrano_config.set(:appsignal_revision, "abc123")
+              stub_marker_request(:revision => "abc123").to_return(:status => 200)
               run
             end
 
             it "transmits the overriden revision" do
               expect(output).to include \
-                'Notifying AppSignal of deploy with: revision: abc123, user: batman',
-                'AppSignal has been notified of this deploy!'
+                "Notifying AppSignal of deploy with: revision: abc123, user: batman",
+                "AppSignal has been notified of this deploy!"
             end
           end
 
@@ -160,9 +160,9 @@ if DependencyHelper.capistrano2_present?
 
             it "does not transmit marker" do
               expect(output).to include \
-                'Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman',
-                'Something went wrong while trying to notify AppSignal:'
-              expect(output).to_not include 'AppSignal has been notified of this deploy!'
+                "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman",
+                "Something went wrong while trying to notify AppSignal:"
+              expect(output).to_not include "AppSignal has been notified of this deploy!"
             end
           end
 
@@ -174,14 +174,14 @@ if DependencyHelper.capistrano2_present?
 
             it "does not transmit marker" do
               expect(output).to include \
-                'Dry run: AppSignal deploy marker not actually sent.'
+                "Dry run: AppSignal deploy marker not actually sent."
             end
           end
         end
 
         context "when not active for this environment" do
           before do
-            capistrano_config.set(:rails_env, 'nonsense')
+            capistrano_config.set(:rails_env, "nonsense")
             run
           end
 

data/spec/lib/appsignal/capistrano3_spec.rb

@@ -1,11 +1,10 @@
 if DependencyHelper.capistrano3_present?
-  require 'capistrano/all'
-  require 'capistrano/deploy'
-  require 'appsignal/capistrano'
-
-  include Capistrano::DSL
+  require "capistrano/all"
+  require "capistrano/deploy"
+  require "appsignal/capistrano"
 
   describe "Capistrano 3 integration" do
+    let(:capistrano) { Class.new.extend(Capistrano::DSL) }
     let(:config) { project_fixture_config }
     let(:out_stream) { std_stream }
     let(:output) { out_stream.read }
@@ -15,36 +14,36 @@ if DependencyHelper.capistrano3_present?
       Capistrano::Configuration.env.tap do |c|
         c.set(:log_level, :error)
         c.set(:logger, logger)
-        c.set(:rails_env, 'production')
-        c.set(:repository, 'master')
-        c.set(:deploy_to, '/home/username/app')
-        c.set(:current_release, '')
-        c.set(:current_revision, '503ce0923ed177a3ce000005')
+        c.set(:rails_env, "production")
+        c.set(:repository, "master")
+        c.set(:deploy_to, "/home/username/app")
+        c.set(:current_release, "")
+        c.set(:current_revision, "503ce0923ed177a3ce000005")
       end
     end
-    before { Rake::Task['appsignal:deploy'].reenable }
+    before { Rake::Task["appsignal:deploy"].reenable }
 
     def run
       capture_std_streams(out_stream, out_stream) do
-        invoke('appsignal:deploy')
+        capistrano.invoke("appsignal:deploy")
       end
     end
 
     it "should have a deploy task" do
-      Rake::Task.task_defined?('appsignal:deploy').should be_true
+      Rake::Task.task_defined?("appsignal:deploy").should be_true
     end
 
     describe "appsignal:deploy task" do
       before do
-        ENV['USER'] = 'batman'
-        ENV['PWD'] = project_fixture_path
+        ENV["USER"] = "batman"
+        ENV["PWD"] = project_fixture_path
       end
 
       context "config" do
         it "should be instantiated with the right params" do
           Appsignal::Config.should_receive(:new).with(
             project_fixture_path,
-            'production',
+            "production",
             {},
             kind_of(Logger)
           )
@@ -52,14 +51,14 @@ if DependencyHelper.capistrano3_present?
 
         context "when appsignal_config is available" do
           before do
-            capistrano_config.set(:appsignal_config, :name => 'AppName')
+            capistrano_config.set(:appsignal_config, :name => "AppName")
           end
 
           it "should be instantiated with the right params" do
             Appsignal::Config.should_receive(:new).with(
               project_fixture_path,
-              'production',
-              {:name => 'AppName'},
+              "production",
+              { :name => "AppName" },
               kind_of(Logger)
             )
           end
@@ -67,14 +66,14 @@ if DependencyHelper.capistrano3_present?
           context "when rack_env is the only env set" do
             before do
               capistrano_config.delete(:rails_env)
-              capistrano_config.set(:rack_env, 'rack_production')
+              capistrano_config.set(:rack_env, "rack_production")
             end
 
             it "should be instantiated with the rack env" do
               Appsignal::Config.should_receive(:new).with(
                 project_fixture_path,
-                'rack_production',
-                {:name => 'AppName'},
+                "rack_production",
+                { :name => "AppName" },
                 kind_of(Logger)
               )
             end
@@ -82,15 +81,15 @@ if DependencyHelper.capistrano3_present?
 
           context "when stage is set" do
             before do
-              capistrano_config.set(:rack_env, 'rack_production')
-              capistrano_config.set(:stage, 'stage_production')
+              capistrano_config.set(:rack_env, "rack_production")
+              capistrano_config.set(:stage, "stage_production")
             end
 
             it "should prefer the stage rather than rails_env and rack_env" do
               Appsignal::Config.should_receive(:new).with(
                 project_fixture_path,
-                'stage_production',
-                {:name => 'AppName'},
+                "stage_production",
+                { :name => "AppName" },
                 kind_of(Logger)
               )
             end
@@ -98,16 +97,16 @@ if DependencyHelper.capistrano3_present?
 
           context "when appsignal_env is set" do
             before do
-              capistrano_config.set(:rack_env, 'rack_production')
-              capistrano_config.set(:stage, 'stage_production')
-              capistrano_config.set(:appsignal_env, 'appsignal_production')
+              capistrano_config.set(:rack_env, "rack_production")
+              capistrano_config.set(:stage, "stage_production")
+              capistrano_config.set(:appsignal_env, "appsignal_production")
             end
 
             it "should prefer the appsignal_env rather than stage, rails_env and rack_env" do
               Appsignal::Config.should_receive(:new).with(
                 project_fixture_path,
-                'appsignal_production',
-                {:name => 'AppName'},
+                "appsignal_production",
+                { :name => "AppName" },
                 kind_of(Logger)
               )
             end
@@ -119,13 +118,13 @@ if DependencyHelper.capistrano3_present?
 
       describe "markers" do
         def stub_marker_request(data = {})
-          stub_api_request config, 'markers', marker_data.merge(data)
+          stub_api_request config, "markers", marker_data.merge(data)
         end
 
         let(:marker_data) do
           {
-            :revision => '503ce0923ed177a3ce000005',
-            :user => 'batman'
+            :revision => "503ce0923ed177a3ce000005",
+            :user => "batman"
           }
         end
 
@@ -135,21 +134,21 @@ if DependencyHelper.capistrano3_present?
             run
 
             expect(output).to include \
-              'Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman',
-              'AppSignal has been notified of this deploy!'
+              "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman",
+              "AppSignal has been notified of this deploy!"
           end
 
           context "with overridden revision" do
             before do
-              capistrano_config.set(:appsignal_revision, 'abc123')
-              stub_marker_request(:revision => 'abc123').to_return(:status => 200)
+              capistrano_config.set(:appsignal_revision, "abc123")
+              stub_marker_request(:revision => "abc123").to_return(:status => 200)
               run
             end
 
             it "transmits the overriden revision" do
               expect(output).to include \
-                'Notifying AppSignal of deploy with: revision: abc123, user: batman',
-                'AppSignal has been notified of this deploy!'
+                "Notifying AppSignal of deploy with: revision: abc123, user: batman",
+                "AppSignal has been notified of this deploy!"
             end
           end
 
@@ -161,16 +160,16 @@ if DependencyHelper.capistrano3_present?
 
             it "does not transmit marker" do
               expect(output).to include \
-                'Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman',
-                'Something went wrong while trying to notify AppSignal:'
-              expect(output).to_not include 'AppSignal has been notified of this deploy!'
+                "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman",
+                "Something went wrong while trying to notify AppSignal:"
+              expect(output).to_not include "AppSignal has been notified of this deploy!"
             end
           end
         end
 
         context "when not active for this environment" do
           before do
-            capistrano_config.set(:rails_env, 'nonsense')
+            capistrano_config.set(:rails_env, "nonsense")
             run
           end