external_services 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTA5YzliMjZkZmUyYTY3ZTMzNzEwYTA0NGUxNWEwYjgyYTc4ZmFkOA==
+    ZDYyMjI3YWE3YjYwMzUzN2M3MzE3YzRhY2Y2ZDVlNDcwNWVjOWQwNw==
   data.tar.gz: !binary |-
-    MDk4MGE0ZWFjMTYzNzMyZDFiOTEyNTFjMmY5OGVlYmRlYmJiMjQwOA==
+    NmM3ZmUzZGEyOThjYTRkNDUzZTJhNmIzMDYwNWZlM2IxZGI2ZDk5Mg==
 SHA512:
   metadata.gz: !binary |-
-    ZTJmNmZmMjY1NTQ3MWNjNjIwYjM2ZWQyNmRkNDdkNDcwMjcxOGRhMTM2Yjc2
-    YThhODk2OGYyODZkZDlmZmM2MzRiMGNmNGQ0YmZjZDAxZjljNWE0ZGU2YmM3
-    ZGYzNDFjYmUyOWZkMTAxNzg1MjBmYTdiMzQxZjY5MjgzNzUxMzc=
+    NWVhMTliZDY4NjdjNjQ1ZjhlMjI4ZDMwZDhkZmY3MTEwOGViZGQxYzg5ODEx
+    NWNkMTA1NDhhNGI0Mjg3NTdlZDAxM2NhMDJjYjI2M2ZkZTEzODFlOGVlZTFh
+    MTAyNzE2YmMxYjgyMmYwMTY3MGI0OWU5ZTg4ZGU0MDU2YmE3NjA=
   data.tar.gz: !binary |-
-    N2Q5NjJlZjAyMmFmM2RhOWNjZTIyYTRkOGVhOWQ5ODZiZGMyMDE3MTJiZWUy
-    YThiZDMwMjQwZmQ3YzU0OThmMTRmY2VkY2Y1ZmZiNDQyMmM4NTNiNGMwZjVm
-    OGU1YWFmMGU5MWMyZmEwNjhjNTg3ODI4NjZlNDYyZTkyOTEyMzc=
+    ODkyZTljNjZlMjEwNTE5OGZiZTNjOWQ0ODc2ZjY5YzQzMWU5NmU3MjE2Mjky
+    YzgyZGUyYTg2NDY3ZWRiNjAzNjRkNmQ5YTVlNDQ2YWMwMWFjM2MyMzJjYTYw
+    ODhjZjg4Njk4M2VlM2Y2OWE5N2Q5YjU4MzU2M2FjNjk3YzQ0ZGY=

data/lib/external_services/version.rb

@@ -1,3 +1,3 @@
 module ExternalServices
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/external_services.rb

@@ -6,6 +6,11 @@ require 'external_services/api'
 require 'generators/install_generator'
 require 'generators/service_generator'
 
+if defined?(::RSpec)
+  require 'rspec/configuration'
+  require 'rspec/helpers'
+end
+
 Dir[File.join(File.expand_path('lib/external_services'), 'api', '*.rb')].each do |api|
   require api
 end

data/lib/rspec/configuration.rb

@@ -0,0 +1,21 @@
+module ExternalServices
+  module RSpec
+    module Configuration
+      extend ActiveSupport::Concern
+
+      def add_external_service(name)
+        Disabler.add_external_service name
+        
+        mod = Module.new do
+          define_method :"describe_#{name}_api" do |object:, **kwargs, &blk|
+            describe_external_service_api(object: object, api_name: name, **kwargs, &blk)
+          end
+        end
+
+        self.extend mod
+      end
+    end
+  end
+end
+
+RSpec::Core::Configuration.send(:include, ExternalServices::RSpec::Configuration)

data/lib/rspec/disabler.rb

@@ -0,0 +1,39 @@
+module ExternalServices
+  module RSpec
+    module Disabler
+      mattr_accessor :external_services
+
+      module_function
+
+      def add_external_service(name)
+        self.external_services ||= []
+        self.external_services << name.to_sym unless self.external_services.include? name.to_sym
+      end
+
+      def disable_external_services(except: [])
+        except = [except] unless except.is_a?(Array)
+        except = except.map(&:to_sym)
+
+        external_services.each do |name|
+          next if name.in? except
+
+          ::ActiveRecord::Base.descendants.each do |klass|
+            set_external_service_disabled_value klass, name, true
+          end
+        end
+      end
+
+      def enable_external_services
+        external_services.each do |name|
+          ::ActiveRecord::Base.descendants.each do |klass|
+            set_external_service_disabled_value klass, name, false
+          end
+        end
+      end
+
+      def set_external_service_disabled_value(klass, service, value)
+        klass.send("#{service}_api_disabled=", value) if klass.respond_to?("#{service}_api_disabled")
+      end
+    end
+  end
+end

data/lib/rspec/helpers.rb

@@ -0,0 +1,141 @@
+require 'rspec/disabler'
+
+module ExternalServices
+  module RSpec
+    module Helpers
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def disable_external_services(except = [])
+          before :all do
+            ExternalServices::RSpec::Disabler.disable_external_services except: except
+          end
+
+          after :all do
+            ExternalServices::RSpec::Disabler.enable_external_services
+          end
+        end
+
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+
+        def describe_external_service_api(object:, api_name:, **kwargs, &blk)
+          action_class = kwargs[:action_class] || "ExternalServices::ApiActions::#{api_name.to_s.camelize}".constantize
+          methods = [:create, :update, :destroy]
+          methods -= [kwargs[:except]].flatten if kwargs[:except]
+          methods &= [kwargs[:only]].flatten if kwargs[:only]
+
+          describe action_class.to_s do
+            before :all do
+              Disabler.enable_external_services
+              Disabler.disable_external_services except: [api_name]
+            end
+
+            after :all do
+              Disabler.enable_external_services
+            end
+
+            before do
+              @api_object = case object
+                            when Symbol
+                              send(object)
+                            else
+                              instance_exec(&object)
+                            end
+              @action_class = action_class
+              @id_key = kwargs[:id_key].try(:to_s) || "#{api_name.to_s.underscore}_id"
+              @methods = kwargs[:methods] || { create: :post, update: :put, destroy: :delete }
+
+              perform_unprocessed_actions
+            end
+
+            if :create.in? methods
+              it 'creates action on create' do
+                expect_api_action_on_create
+              end
+            end
+
+            if :update.in? methods
+              it 'creates action on update' do
+                @api_object.send("#{@id_key}=", SecureRandom.hex)
+                @api_object.save
+
+                expect_api_action_on_update(@api_object)
+              end
+            end
+
+            if :destroy.in? methods
+              it 'creates action on delete' do
+                if @api_object.respond_to?(:descendants)
+                  @api_object.reload.descendants.each(&:delete)
+                end
+                @api_object.destroy
+                expect_api_action_on_destroy(@api_object)
+              end
+            end
+
+            if kwargs[:descendants_identifier_check]
+              it 'create actions for all descendants on identifier change' do
+                @api_object.update_attributes! identifier: "#{@api_object.identifier}1"
+
+                @api_object.descendants.each do |c|
+                  expect_api_action_on_update(c)
+                end
+              end
+            end
+
+            instance_exec(&blk) if block_given?
+          end
+
+          # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+        end
+      end
+
+      def remove_api_actions(api_name)
+        "ExternalServices::ApiActions::#{api_name.to_s.camelize}".constantize.delete_all
+      end
+
+      def expect_api_action_on_create(obj = nil)
+        expect_api_action(initiator: obj, method: @methods[:create])
+      end
+
+      def expect_api_action_on_update(obj = nil)
+        expect_api_action(initiator: obj, method: @methods[:update])
+      end
+
+      def expect_api_action_on_destroy(obj = nil)
+        expect_api_action(initiator: obj, method: @methods[:destroy])
+      end
+
+      def expect_api_action(params)
+        params[:initiator] ||= @api_object
+        expectation = params.delete(:expectation)
+        expectation = true if expectation.nil?
+        count = params.delete(:count)
+        data = params.delete(:data) || {}
+
+        actions = @action_class.where(params).select do |a|
+          data.select { |k, v| a.data[k.to_s] != v }.empty?
+        end
+
+        if count
+          expect(actions.count).send expectation ? 'to' : 'not_to', eq(count)
+        else
+          expect(actions.any?).to eq(expectation)
+        end
+      end
+
+      def unexpect_api_action(params)
+        expect_api_action(params.merge(expectation: false))
+      end
+
+      def perform_unprocessed_actions
+        @action_class.unprocessed.each(&:execute!)
+        @api_object.reload
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include ExternalServices::RSpec::Helpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: external_services
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sergey Gnuskov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -78,6 +78,9 @@ files:
 - lib/generators/templates/services/api_action.rb
 - lib/generators/templates/services/api_job.rb
 - lib/generators/templates/services/model.rb
+- lib/rspec/configuration.rb
+- lib/rspec/disabler.rb
+- lib/rspec/helpers.rb
 homepage: https://github.com/flant/external_services
 licenses:
 - MIT