airbrake-api 3.3.0 → 4.0.0

data/lib/airbrake-api/error.rb

@@ -1,58 +1,43 @@
+require 'airbrake-api/base'
+
 module AirbrakeAPI
-  class Error < AirbrakeAPI::Base
+  class Error < Base
 
+    # @deprecated Please use {AirbrakeAPI::Client::error} and {AirbrakeAPI::Client::errors} instead
     def self.find(*args)
-      setup
+      deprecate('Error.find has been deprecated; use AibrakeAPI::Client#error and AibrakeAPI::Client#errors instead')
 
       results = case args.first
         when Fixnum
-          find_individual(args)
+          id = args.shift
+          options = args.last.is_a?(::Hash) ? args.pop : {}
+          AirbrakeAPI::Client.new.error(id, options)
         when :all
-          find_all(args)
+          options = args.last.is_a?(::Hash) ? args.pop : {}
+          AirbrakeAPI::Client.new.errors(options)
         else
           raise AirbrakeError.new('Invalid argument')
       end
 
-      raise AirbrakeError.new('No results found.') if results.nil?
-      raise AirbrakeError.new(results.errors.error) if results.errors
-
-      results.group || results.groups
+      results
     end
 
+    # @deprecated Please use {AirbrakeAPI::Client::update} instead
     def self.update(error, options)
-      setup
-
-      response = put(error_path(error), :body => options)
-      if response.code == 403
-        raise AirbrakeError.new('SSL should be enabled - use Airbrake.secure = true in configuration')
-      end
-      results = Hashie::Mash.new(response)
-
-      raise AirbrakeError.new(results.errors.error) if results.errors
-      results.group
-    end
-
-    private
-
-    def self.find_all(args)
-      options = args.extract_options!
-
-      fetch(collection_path, options)
-    end
-
-    def self.find_individual(args)
-      id = args.shift
-      options = args.extract_options!
-
-      fetch(error_path(id), options)
+      deprecate('Error.update has been deprecated; use AibrakeAPI::Client#update instead')
+      AirbrakeAPI::Client.new.update(error, options)
     end
 
+    # @deprecated Please use {AirbrakeAPI::Client::errors_path} instead
     def self.collection_path
-      '/errors.xml'
+      deprecate('Error.collection_path has been deprecated; use AibrakeAPI::Client#errors_path instead')
+      AirbrakeAPI::Client.new.errors_path
     end
 
+    # @deprecated Please use {AirbrakeAPI::Client::error_path} instead
     def self.error_path(error_id)
-      "/errors/#{error_id}.xml"
+      deprecate('Error.error_path has been deprecated; use AibrakeAPI::Client#error_path instead')
+      AirbrakeAPI::Client.new.error_path(error_id)
     end
 
   end

data/lib/airbrake-api/middleware/raise_response_error.rb

@@ -0,0 +1,17 @@
+require 'faraday'
+
+module AirbrakeAPI
+  module Middleware
+    class RaiseResponseError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        raise AirbrakeError.new('No results found.') if env[:body].nil?
+
+        if env[:body].errors && env[:body].errors.error
+          raise AirbrakeError.new(env[:body].errors.error)
+        end
+      end
+
+    end
+  end
+end

data/lib/airbrake-api/middleware/raise_server_error.rb

@@ -0,0 +1,16 @@
+require 'faraday'
+
+module AirbrakeAPI
+  module Middleware
+    class RaiseServerError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        case env[:status].to_i
+        when 403
+          raise AirbrakeError.new('SSL should be enabled - use AirbrakeAPI.secure = true in configuration')
+        end
+      end
+
+    end
+  end
+end

data/lib/airbrake-api/middleware/scrub_response.rb

@@ -0,0 +1,15 @@
+require 'faraday'
+
+module AirbrakeAPI
+  module Middleware
+    class ScrubResponse < Faraday::Response::Middleware
+
+      def parse(body)
+        body.gsub!(/<__utmz>.*?<\/__utmz>/m,'')
+        body.gsub!(/<[0-9]+.*?>.*?<\/[0-9]+.*?>/m,'')
+        body
+      end
+
+    end
+  end
+end

data/lib/airbrake-api/notice.rb

@@ -1,66 +1,38 @@
 require 'parallel'
+require 'airbrake-api/base'
 
 module AirbrakeAPI
-  class Notice < AirbrakeAPI::Base
-    PER_PAGE = 30
-    PARALLEL_WORKERS = 10
+  class Notice < Base
 
-    def self.find(id, error_id, options={})
-      setup
-
-      hash = fetch(find_path(id, error_id), options)
-
-      if hash.errors
-        raise AirbrakeError.new(results.errors.error)
-      end
-
-      hash.notice
+    # @deprecated Please use {AirbrakeAPI::Client::notice} instead
+    def self.find(id, error_id, options = {})
+      deprecate('Notice.find has been deprecated; use AibrakeAPI::Client#notice instead')
+      AirbrakeAPI::Client.new.notice(id, error_id, options)
     end
 
-    def self.find_all_by_error_id(error_id, notice_options = {})
-      setup
-
-      options = {}
-      notices = []
-      page = 1
-      while !notice_options[:pages] || page <= notice_options[:pages]
-        options[:page] = page
-        hash = fetch(all_path(error_id), options)
-        if hash.errors
-          raise AirbrakeError.new(hash.errors.error)
-        end
-
-        batch = Parallel.map(hash.notices, :in_threads => PARALLEL_WORKERS) do |notice_stub|
-          find(notice_stub.id, error_id)
-        end
-        yield batch if block_given?
-        batch.each{|n| notices << n }
-
-        break if batch.size < PER_PAGE
-        page += 1
-      end
-      notices
+    # @deprecated Please use {AirbrakeAPI::Client::all_notices} instead
+    def self.find_all_by_error_id(error_id, notice_options = {}, &block)
+      deprecate('Notice.find_all_by_error_id has been deprecated; use AibrakeAPI::Client#all_notices instead')
+      AirbrakeAPI::Client.new.notices(error_id, notice_options, &block)
     end
 
-    def self.find_by_error_id(error_id, options={ 'page' => 1})
-      setup
-
-      hash = fetch(all_path(error_id), options)
-      if hash.errors
-        raise AirbrakeError.new(results.errors.error)
-      end
-
-      hash.notices
+    # @deprecated Please use {AirbrakeAPI::Client::notices} instead
+    def self.find_by_error_id(error_id, options = {})
+      deprecate('Notice.find_by_error_id has been deprecated; use AibrakeAPI::Client#notices instead')
+      AirbrakeAPI::Client.new.notices(error_id, options)
     end
 
-    private
-
+    # @deprecated Please use {AirbrakeAPI::Client::notice_path} instead
     def self.find_path(id, error_id)
-      "/errors/#{error_id}/notices/#{id}.xml"
+      deprecate('Notice.find_path has been deprecated; use AibrakeAPI::Client#notice_path instead')
+      AirbrakeAPI::Client.new.notice_path(id, error_id)
     end
 
+    # @deprecated Please use {AirbrakeAPI::Client::notices_path} instead
     def self.all_path(error_id)
-      "/errors/#{error_id}/notices.xml"
+      deprecate('Notice.all_path has been deprecated; use AibrakeAPI::Client#notices_path instead')
+      AirbrakeAPI::Client.new.notices_path(error_id)
     end
+
   end
 end

data/lib/airbrake-api/project.rb

@@ -1,18 +1,19 @@
+require 'airbrake-api/base'
+
 module AirbrakeAPI
-  class Project < AirbrakeAPI::Base
+  class Project < Base
 
+    # @deprecated Please use {AirbrakeAPI::Client::projects} instead
     def self.find(*args)
-      setup
-      options = args.extract_options!
-
-      results = fetch(collection_path, options)
-
-      raise AirbrakeError.new(results.errors.error) if results.errors
-      results.projects.project
+      deprecate('Project.find has been deprecated; use AibrakeAPI::Client.projects instead')
+      options = args.last.is_a?(::Hash) ? args.pop : {}
+      AirbrakeAPI::Client.new.projects(options)
     end
 
+    # @deprecated Please use {AirbrakeAPI::Client::projects_path} instead
     def self.collection_path
-      '/data_api/v1/projects.xml'
+      deprecate('Project.collection_path has been deprecated; use AibrakeAPI::Client.projects_path instead')
+      AirbrakeAPI::Client.new.projects_path
     end
 
   end

data/lib/airbrake-api/version.rb

@@ -1,3 +1,3 @@
 module AirbrakeAPI
-  VERSION = '3.3.0'
+  VERSION = '4.0.0'
 end

data/spec/airbrake_api/client_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+describe AirbrakeAPI::Client do
+  describe 'initialization' do
+    before do
+      @keys = AirbrakeAPI::Configuration::VALID_OPTIONS_KEYS
+    end
+
+    context "with module configuration" do
+      before do
+        AirbrakeAPI.configure do |config|
+          @keys.each do |key|
+            config.send("#{key}=", key)
+          end
+        end
+      end
+
+      after do
+        AirbrakeAPI.reset
+      end
+
+      it "should inherit module configuration" do
+        api = AirbrakeAPI::Client.new
+        @keys.each do |key|
+          api.send(key).should == key
+        end
+      end
+
+      context "with class configuration" do
+
+        before do
+          @configuration = {
+            :account => 'test',
+            :auth_token => 'token',
+            :secure => true,
+            :connection_options => {},
+            :adapter => :em_http,
+            :user_agent => 'Airbrake API Tests'
+          }
+        end
+
+        context "during initialization" do
+          it "should override module configuration" do
+            api = AirbrakeAPI::Client.new(@configuration)
+            @keys.each do |key|
+              api.send(key).should == @configuration[key]
+            end
+          end
+        end
+
+        context "after initilization" do
+          it "should override module configuration after initialization" do
+            api = AirbrakeAPI::Client.new
+            @configuration.each do |key, value|
+              api.send("#{key}=", value)
+            end
+            @keys.each do |key|
+              api.send(key).should == @configuration[key]
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe 'api requests'do
+    before(:all) do
+      options = { :account => 'myapp', :auth_token => 'abcdefg123456', :secure => false }
+      AirbrakeAPI.configure(options)
+
+      @client = AirbrakeAPI::Client.new
+    end
+
+    it "should fail with errors" do
+      expect {
+        @client.notices(1696172)
+      }.to raise_error(AirbrakeAPI::AirbrakeError, /You are not authorized to see that page/)
+    end
+
+    describe '#deploys' do
+      it 'returns an array of deploys' do
+        @client.deploys('12345').should be_kind_of(Array)
+      end
+
+      it 'returns deploy data' do
+        deploys = @client.deploys('12345')
+        first_deploy = deploys.first
+
+        first_deploy.rails_env.should eq('production')
+      end
+      
+      it 'returns empty when no data' do
+        @client.deploys('67890').should be_kind_of(Array)
+      end      
+    end
+
+    describe '#projects' do
+      it 'returns an array of projects' do
+        @client.projects.should be_kind_of(Array)
+      end
+
+      it 'returns project data' do
+        projects = @client.projects
+        projects.size.should == 4
+        projects.first.id.should == '1'
+        projects.first.name.should == 'Venkman'
+      end
+    end
+
+    describe '#update' do
+      it 'should update the status of an error' do
+        error = @client.update(1696170, :group => { :resolved => true})
+        error.resolved.should be_true
+      end
+    end
+
+    describe '#errors' do
+      it "should find a page of the 30 most recent errors" do
+        errors = @client.errors
+        ordered = errors.sort_by(&:most_recent_notice_at).reverse
+        ordered.should == errors
+        errors.size.should == 30
+      end
+
+      it "should paginate errors" do
+        errors = @client.errors(:page => 2)
+        ordered = errors.sort_by(&:most_recent_notice_at).reverse
+        ordered.should == errors
+        errors.size.should == 2
+      end
+    end
+
+    describe '#error' do
+      it "should find an individual error" do
+        error = @client.error(1696170)
+        error.action.should == 'index'
+        error.id.should == 1696170
+      end
+    end
+
+    describe '#notice' do
+      it "finds individual notices" do
+        @client.notice(1234, 1696170).should_not be_nil
+      end
+
+      it "finds broken notices" do
+        @client.notice(666, 1696170).should_not be_nil
+      end
+    end
+
+    describe '#notices' do
+      it "finds all error notices" do
+        notices = @client.notices(1696170)
+        notices.size.should == 42
+      end
+
+      it "finds error notices for a specific page" do
+        notices = @client.notices(1696170, :page => 1)
+        notices.size.should == 30
+        notices.first.id.should == 1234
+      end
+
+      it "finds all error notices with a page limit" do
+        notices = @client.notices(1696171, :pages => 2)
+        notices.size.should == 60
+      end
+
+      it "yields batches" do
+        batches = []
+        notices = @client.notices(1696171, :pages => 2) do |batch|
+          batches << batch
+        end
+        notices.size.should == 60
+        batches.map(&:size).should == [30,30]
+      end
+    end
+  end
+end

data/spec/airbrake_api/notice_spec.rb

@@ -9,7 +9,7 @@ describe AirbrakeAPI::Notice do
 
   it "should find error notices" do
     notices = AirbrakeAPI::Notice.find_by_error_id(1696170)
-    notices.size.should == 30
+    notices.size.should == 42
     notices.first.id.should == 1234
   end
 
@@ -45,4 +45,12 @@ describe AirbrakeAPI::Notice do
   it "should find a broken notices" do
     AirbrakeAPI::Notice.find(666, 1696170).should_not == nil
   end
+
+  it 'defines the notices path' do
+    AirbrakeAPI::Notice.all_path(1696170).should eq('/errors/1696170/notices.xml')
+  end
+
+  it 'defines the an individual notices path' do
+    AirbrakeAPI::Notice.find_path(666, 1696170).should eq('/errors/1696170/notices/666.xml')
+  end
 end