external_services 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTA5YzliMjZkZmUyYTY3ZTMzNzEwYTA0NGUxNWEwYjgyYTc4ZmFkOA==
+  data.tar.gz: !binary |-
+    MDk4MGE0ZWFjMTYzNzMyZDFiOTEyNTFjMmY5OGVlYmRlYmJiMjQwOA==
+SHA512:
+  metadata.gz: !binary |-
+    ZTJmNmZmMjY1NTQ3MWNjNjIwYjM2ZWQyNmRkNDdkNDcwMjcxOGRhMTM2Yjc2
+    YThhODk2OGYyODZkZDlmZmM2MzRiMGNmNGQ0YmZjZDAxZjljNWE0ZGU2YmM3
+    ZGYzNDFjYmUyOWZkMTAxNzg1MjBmYTdiMzQxZjY5MjgzNzUxMzc=
+  data.tar.gz: !binary |-
+    N2Q5NjJlZjAyMmFmM2RhOWNjZTIyYTRkOGVhOWQ5ODZiZGMyMDE3MTJiZWUy
+    YThiZDMwMjQwZmQ3YzU0OThmMTRmY2VkY2Y1ZmZiNDQyMmM4NTNiNGMwZjVm
+    OGU1YWFmMGU5MWMyZmEwNjhjNTg3ODI4NjZlNDYyZTkyOTEyMzc=

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/dummy/log/
+/spec/dummy/tmp/
+/spec/dummy/db/*.sqlite3
+/spec/dummy/db/schema.rb

data/.overcommit.yml

@@ -0,0 +1,32 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+#PreCommit:
+#  RuboCop:
+#    enabled: true
+#    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+  - 'lib/generators/templates/**/*'
+
+Metrics/LineLength:
+  Max: 140
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+
+Style/Documentation:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+language: ruby
+rvm:
+- 2.2.4
+before_install: gem install bundler -v 1.12.5
+env:
+- RAILS_ENV=test
+script:
+- bundle exec rake db:create --trace
+- bundle exec rake db:migrate --trace
+- bundle exec rake
+deploy:
+  provider: rubygems
+  api_key:
+    secure: rgni1lDjNhUTL8NUdJA4oSYu+vzB1Fp8TJ5wVhJfW8E0NUD5YItodmc52RLv3Hwt2501Dqx4pt4WaIP3E71OAG3KzsPUY1NPoCqP4KpXo6c7T1qqFieKztDa8aGOCqjkQ/1to9yt6qdKg6PtjsSWtKu8f3ROhLpBmd4r2phnb1GucKRnH5yaQQtcoNb8AmnE0VBEF2wzALsMg2QdZRk/1qJInbgUldc10FG/33DW71h5IKR8/n2L0Ggm+/ZYe2Rg0aGUE3VHHSkHJFvoHIjwfYaNHu7FrUjYywM4XfZBdl+bdL3a6Op8p+2VRAPMb4Wdb6K0O+f5vGQyvntvR3pMuqFVLC0mL9mkz8RYK7VXVxBfxZk3LQvA15oN52uvN523iKTjM+VvzmEIhZ1+oozN5W9XxT6VSqZTo7rj4lQto0g6+9Ev4kVP92JGMT0GlJcPcZ8PlW7j9phvEXgy89IvLLvF63nVlWw7xAY4pZUlTd185sfSWWPFSyqX4W/djqHq963MB0H8k6lGNnwLf+xFCMScaM52hZ+TEvtapX7nCn7dzgWv8s6kwYqWPa9J0Tegxr364RL7pq0mXEf7JwNivAYv7aAR8PHAg7y15Qw/MXRzoUWG5G5AfZii+GY6cp0Cyo2am0ut05OudYcuohifP4DWkn0wlwDT/QYLv8bMhaE=
+  gem: external_services
+  on:
+    tags: true
+    repo: flant/external_services

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in external_services.gemspec
+gemspec
+
+gem 'sqlite3'
+gem 'bundler', '~> 1.12'
+gem 'rake', '~> 10.0'
+gem 'travis', '~> 1.8', '>= 1.8.2'
+
+gem 'rubocop', '~> 0.42', require: false
+gem 'overcommit'
+
+gem 'pry-rails'
+
+gem 'factory_girl_rails'
+gem 'rspec-rails'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sergey Gnuskov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# ExternalServices [![Build Status](https://travis-ci.org/flant/external_services.svg?branch=master)](https://travis-ci.org/flant/external_services)
+
+Gem helps syncronizing objects to different external services like Gitlab, Redmine and any other.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'external_services'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install external_services
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/flant/external_services.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Asdf'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/jobs/external_services/api_job.rb

@@ -0,0 +1,16 @@
+module ExternalServices
+  class ApiJob < ActiveJob::Base
+    queue_as :default
+
+    def action_class
+      "ExternalServices::ApiActions::#{self.class.to_s.demodulize.gsub(/ApiJob/, '')}".constantize
+    end
+
+    def perform(action_id)
+      action = action_class.find(action_id)
+      return if action.processed?
+
+      action.execute!
+    end
+  end
+end

data/app/models/external_services/api_action.rb

@@ -0,0 +1,86 @@
+module ExternalServices
+  class ApiAction < ::ActiveRecord::Base
+    self.table_name = :external_services_api_actions
+
+    belongs_to :initiator, polymorphic: true
+
+    validates :initiator_id, :initiator_type, :method, :path, :queue, presence: true
+    validate  :path_format_correctness
+
+    serialize :data,    JSON
+    serialize :options, JSON
+
+    scope :unprocessed, -> { where(processed_at: nil) }
+
+    before_validation :assign_queue
+    before_validation :process_data
+    after_commit      :kick_active_job
+
+    before_create :calculate_signature
+
+    def processed?
+      processed_at.present?
+    end
+
+    def set_processed!
+      update_attributes! processed_at: Time.now
+    end
+
+    def initiator_class
+      # Need to use initiator object for STI in polymorphic.. But still will be bugs with deleted STI object
+      initiator.try(:class) || initiator_type.constantize
+    end
+
+    def api_disabled?
+      initiator_class.send(:"#{self.class.to_s.demodulize.underscore}_api_disabled")
+    end
+
+    def change_external_id?
+      options['change_external_id']
+    end
+
+    def job_class
+      "ExternalServices::#{self.class.to_s.demodulize}ApiJob".constantize
+    end
+
+    def kick_active_job
+      return if api_disabled?
+
+      job_class.set(queue: queue).perform_later(id)
+    end
+
+    def self.perform_unprocessed
+      Rails.logger.info "Running unprocessed #{self.class.name.demodulize} api actions..."
+
+      unprocessed.each(&:kick_active_job)
+    end
+
+    def execute!
+      raise NotImplementedError
+    end
+
+    protected
+
+    def assign_queue
+      self.queue ||= case method.to_sym
+                     when :create
+                       :create
+                     when :destroy
+                       :delete
+                     else
+                       :default
+                     end
+    end
+
+    def process_data
+      self.data = nil if method.to_sym == :delete # DELETE has no body
+    end
+
+    def calculate_signature
+    end
+
+    def path_format_correctness
+      errors.add(:path, :invalid) if path =~ %r{//}
+    end
+  end
+end

data/app/models/external_services/service.rb

@@ -0,0 +1,40 @@
+module ExternalServices
+  class Service < ::ActiveRecord::Base
+    self.table_name = :external_services
+
+    belongs_to :subject, polymorphic: true
+    serialize :extra_data, JSON
+
+    after_update :on_first_sync, if: -> { external_id_was.nil? && external_id_changed? }
+
+    def self.to_sym
+      to_s.demodulize.underscore.to_sym
+    end
+
+    def on_subject_create(subj)
+      method = subj.send("#{api_name}_id").present? ? :put : :post
+      subj.send("#{api_name}_api_action", method)
+    end
+
+    def on_subject_update(subj)
+      method = subj.send("#{api_name}_id").present? ? :put : :post
+      return true if (subj.respond_to?(:became_archived?) && subj.became_archived?) && method == :post
+      subj.send("#{api_name}_api_action", method)
+    end
+
+    def on_subject_destroy(subj)
+      subj.send("#{api_name}_api_action", :delete)
+    end
+
+    def api_name
+      self.class.to_sym
+    end
+
+    protected
+
+    def on_first_sync
+      callback_name = "on_#{api_name}_first_sync"
+      subject.send(callback_name) if subject.respond_to?(callback_name)
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/external_services/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/external_services.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'external_services/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'external_services'
+  spec.version       = ExternalServices::VERSION
+  spec.authors       = ['Sergey Gnuskov']
+  spec.email         = ['sergey.gnuskov@flant.com']
+
+  spec.summary       = 'Gem helps syncronizing objects to different external services like Gitlab, Redmine and any other.'
+  spec.homepage      = 'https://github.com/flant/external_services'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '>= 0.9'
+  spec.add_dependency 'rails', ['>= 4.2.5', '< 6.0']
+end

data/lib/external_services/active_record.rb

@@ -0,0 +1,256 @@
+module ExternalServices
+  module ActiveRecord
+    module HasExternalService
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def has_external_service(name, options = {})
+          class_attribute :external_services unless respond_to?(:external_services)
+          self.external_services ||= {}
+          self.external_services[name.to_sym] = options
+
+          unless options[:only_api_actions] == true
+            service_class = get_service_class(name, options)
+            service_assoc = :"#{name}_service"
+            has_one service_assoc, class_name: service_class, as: :subject, dependent: :destroy, autosave: true
+
+            define_external_service_getset         name, options
+            define_external_service_sync_methods   name, options
+          end
+
+          define_external_service_callbacks      name, options
+          define_external_service_helper_methods name, options
+
+          extend  service_class::SubjectClassMethods if defined? service_class::SubjectClassMethods
+          include service_class::SubjectMethods if defined? service_class::SubjectMethods
+
+          # rubocop:disable Lint/HandleExceptions
+          begin
+            service_module = const_get(name.to_s.camelize)
+            include service_module
+          rescue NameError
+          end
+          # rubocop:enable Lint/HandleExceptions
+        end
+
+        def includes_external_services
+          includes(self.external_services.keys.map { |name| :"#{name}_service" })
+        end
+
+        def external_services_disabled
+          Thread.current[:external_services_disabled]
+        end
+
+        def external_services_disabled=(val)
+          Thread.current[:external_services_disabled] = val
+        end
+
+        def without_external_services
+          old = external_services_disabled
+          self.external_services_disabled = true
+
+          yield
+        ensure
+          self.external_services_disabled = old
+        end
+
+        private
+
+        def get_service_class(name, options = {})
+          (options[:class] || "ExternalServices::#{name.to_s.camelize}").constantize
+        end
+
+        def define_external_service_getset(name, _options = {})
+          service_assoc = :"#{name}_service"
+
+          define_method :"#{name}_id" do
+            public_send(service_assoc).try(:public_send, :external_id)
+          end
+
+          define_method :"#{name}_id=" do |val|
+            public_send(service_assoc).try(:public_send, :external_id=, val)
+          end
+
+          define_method :"#{name}_extra_data" do
+            public_send(service_assoc).try(:public_send, :extra_data)
+          end
+
+          define_method :"#{name}_extra_data=" do |val|
+            public_send(service_assoc).try(:public_send, :extra_data=, val)
+          end
+
+          define_singleton_method :"find_by_#{name}_id" do |id|
+            all.joins(service_assoc).find_by(external_services: { external_id: id })
+          end
+
+          define_method service_assoc do
+            super() || public_send(:"build_#{service_assoc}")
+          end
+        end
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def define_external_service_callbacks(name, options = {})
+          service_assoc = :"#{name}_service"
+          only_api_actions = (options[:only_api_actions] == true)
+
+          callbacks_module = Module.new do
+            extend ActiveSupport::Concern
+
+            included do
+              unless only_api_actions
+                before_save do
+                  public_send(:"build_#{service_assoc}") if public_send(service_assoc).blank?
+                end
+              end
+
+              after_save    :"#{name}_on_create", if: :id_changed?
+
+              after_save    :"#{name}_on_update", if: proc {
+                !id_changed?
+              }
+
+              after_destroy :"#{name}_on_destroy"
+            end
+
+            define_method :"#{name}_on_create" do
+              public_send(service_assoc).on_subject_create(self) unless only_api_actions
+            end
+            protected :"#{name}_on_create"
+
+            define_method :"#{name}_on_update" do
+              public_send(service_assoc).on_subject_update(self) unless only_api_actions
+            end
+
+            define_method :"#{name}_on_destroy" do
+              public_send(service_assoc).on_subject_destroy(self) unless only_api_actions
+            end
+            protected :"#{name}_on_destroy"
+
+            define_method :"#{name}_on_revive" do
+              public_send(service_assoc).on_subject_revive(self) unless only_api_actions
+            end
+            protected :"#{name}_on_revive"
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+          include callbacks_module
+        end
+
+        def define_external_service_sync_methods(name, _options = {})
+          service_assoc = :"#{name}_service"
+          synced_method = :"#{name}_service_synced?"
+          disabled_method = :"#{name}_api_disabled"
+
+          syncs_module = Module.new do
+            extend ActiveSupport::Concern
+
+            define_method synced_method do
+              public_send(service_assoc).external_id?
+            end
+
+            define_method :external_services_synced? do
+              result = (!defined?(super) || super())
+              result &&= public_send(synced_method) unless public_send(disabled_method)
+              result
+            end
+          end
+
+          include syncs_module
+        end
+
+        # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
+        def define_external_service_helper_methods(name, _options = {})
+          ## subject class methods
+          helpers_class_module = Module.new do
+            define_method :"with_#{name}_api_for" do |synced: [], for_syncing: [], &b|
+              return if ([synced] + [for_syncing]).flatten.select(&:"#{name}_api_disabled").any?
+
+              unsynced = [synced].flatten.select { |o| o.send("#{name}_id").nil? }
+              if unsynced.any?
+                objects = unsynced.map { |o| "#{o.class.name} (id=#{o.id})" }.join(', ')
+                raise "[#{name}] Trying to work with an unsynced objects: #{objects}"
+              end
+
+              b.call
+            end
+
+            define_method :"#{name}_api_name" do
+              to_s.demodulize.underscore
+            end
+
+            define_method :"#{name}_api_path" do
+              send(:"#{name}_api_name").pluralize
+            end
+
+            define_method :"#{name}_api_disabled" do
+              ENV["#{name}_api_disabled".upcase] == 'true' || Thread.current[:"#{name}_api_disabled"] || external_services_disabled
+            end
+
+            define_method :"#{name}_api_disabled=" do |val|
+              Thread.current[:"#{name}_api_disabled"] = val
+            end
+
+            define_method :"without_#{name}_api" do |&blk|
+              begin
+                old = send :"#{name}_api_disabled"
+                send :"#{name}_api_disabled=", true
+
+                blk.call
+              ensure
+                send :"#{name}_api_disabled=", old
+              end
+            end
+          end
+
+          ## subject methods
+          helpers_module = Module.new do
+            define_method :"#{name}_api_disabled" do
+              self.class.send :"#{name}_api_disabled"
+            end
+
+            define_method :"#{name}_api_path" do
+              if send(:"#{name}_id").present?
+                "#{self.class.send(:"#{name}_api_path")}/#{send(:"#{name}_id")}"
+              else
+                self.class.send(:"#{name}_api_path")
+              end
+            end
+
+            define_method :"#{name}_api_data" do
+              send(:"to_#{name}_api")
+            end
+
+            define_method :"#{name}_api_action" do |method, **args|
+              return if self.class.send(:"#{name}_api_disabled")
+              return if !args[:force] && send(:"#{name}_api_disabled")
+
+              path    = args[:path]    || send(:"#{name}_api_path")
+              data    = args[:data]    || send(:"#{name}_api_data")
+              options = args[:options] || {}
+
+              options[:change_external_id] = true if options[:change_external_id].nil?
+
+              "ExternalServices::ApiActions::#{name.to_s.camelize}".constantize.create!(
+                initiator: self,
+                name:      args[:name] || self.class.send(:"#{name}_api_name"),
+                method:    method,
+                path:      path,
+                data:      data,
+                queue:     args[:queue],
+                options:   options
+              )
+            end
+          end
+
+          extend  helpers_class_module
+          include helpers_module
+        end
+        # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::Base.send :include, ExternalServices::ActiveRecord::HasExternalService
+end

data/lib/external_services/api.rb

@@ -0,0 +1,78 @@
+module ExternalServices
+  module Api
+    class Error < StandardError
+      def initialize(response)
+        @response = response
+      end
+
+      def message
+        @response.inspect
+      end
+    end
+
+    def api_url
+      ENV["#{to_s.demodulize.upcase}_API_URL"]
+    end
+
+    def api_key
+      ENV["#{to_s.demodulize.upcase}_API_KEY"]
+    end
+
+    def auth_header
+      'Authorization'
+    end
+
+    def connection
+      return if api_url.blank?
+
+      @connection ||= Faraday.new(url: api_url) do |f|
+        f.request  :json
+        f.response :json
+
+        f.adapter  :net_http
+
+        f.headers['Content-Type'] = 'application/json'
+        f.headers['Accept']       = 'application/json'
+        f.headers[auth_header]    = api_key
+      end
+    end
+
+    def get(path, params: {}, **_kwargs)
+      request(:get, path, params)
+    end
+
+    def post(path, body:, params: {}, **_kwargs)
+      request(:post, path, params, body)
+    end
+
+    def put(path, body:, params: {}, **_kwargs)
+      request(:put, path, params, body)
+    end
+
+    def delete(path, params: {}, **_kwargs)
+      request(:delete, path, params)
+    end
+
+    def fake?
+      !connection
+    end
+
+    def fake_response_body(method, path, params = {})
+      (method == :post ? { 'id' => SecureRandom.hex } : {})
+    end
+
+    def request(method, path, params = {}, body = nil)
+      resp = if fake?
+               Struct.new(:success?, :body, :headers).new(true, fake_response_body(method, path, params), {})
+             else
+               connection.send(method, path, body) do |req|
+                 req.params = params
+               end
+             end
+
+      raise Error, resp unless resp.blank? || resp.success?
+
+      resp
+    end
+  end
+end

data/lib/external_services/engine.rb

@@ -0,0 +1,11 @@
+require 'rails'
+module ExternalServices
+  class Engine < ::Rails::Engine
+    isolate_namespace ExternalServices
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
+  end
+end

data/lib/external_services/version.rb

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

data/lib/external_services.rb

@@ -0,0 +1,14 @@
+require 'external_services/engine'
+require 'external_services/version'
+
+require 'external_services/active_record'
+require 'external_services/api'
+require 'generators/install_generator'
+require 'generators/service_generator'
+
+Dir[File.join(File.expand_path('lib/external_services'), 'api', '*.rb')].each do |api|
+  require api
+end
+
+module ExternalServices
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module ExternalServices
+  module Generators
+    # Installs ExternalServices in a rails app.
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc 'Generates migrations and directories.'
+
+      def create_migration_files
+        add_migration('create_external_services')
+        add_migration('create_external_services_api_actions')
+      end
+
+      def create_directories
+        create_directory 'app/models/external_services/api_actions'
+        create_directory 'app/jobs/external_services'
+        create_directory 'lib/external_services/api'
+      end
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      protected
+
+      def create_directory(dir)
+        dir = File.expand_path(dir)
+        empty_directory dir
+        add_file File.join(dir, '.keep')
+      end
+
+      def add_migration(template)
+        migration_dir = File.expand_path('db/migrate')
+        if self.class.migration_exists?(migration_dir, template)
+          ::Kernel.warn "Migration already exists: #{template}"
+        else
+          migration_template "migrations/#{template}.rb", "db/migrate/#{template}.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/service_generator.rb

@@ -0,0 +1,43 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module ExternalServices
+  module Generators
+    # Installs ExternalServices in a rails app.
+    class ServiceGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates/services', __FILE__)
+
+
+      class_option(
+        :only_api_actions,
+        type: :boolean,
+        default: false,
+        desc: "Do not generate service model class"
+      )
+
+      desc 'Generates specified model and API classes.'
+
+      def add_model
+        return if options.only_api_actions?
+
+        dir = File.expand_path('app/models/external_services')
+        template 'model.rb', File.join(dir, "#{file_name}.rb")
+      end
+
+      def add_api_action
+        dir = File.expand_path('app/models/external_services/api_actions')
+        template 'api_action.rb', File.join(dir, "#{file_name}.rb")
+      end
+
+      def add_api
+        dir = File.expand_path('lib/external_services/api')
+        template 'api.rb', File.join(dir, "#{file_name}.rb")
+      end
+
+      def add_api_job
+        dir = File.expand_path('app/jobs/external_services')
+        template 'api_job.rb', File.join(dir, "#{file_name}_api_job.rb")
+      end
+    end
+  end
+end

data/lib/generators/templates/migrations/create_external_services.rb

@@ -0,0 +1,12 @@
+class CreateExternalServices < ActiveRecord::Migration
+  def change
+    create_table :external_services do |t|
+      t.references :subject, null: false, polymorphic: true, index: true
+
+      t.string     :type,    null: false
+      t.string     :external_id
+      t.text       :extra_data
+    end
+    add_index :external_services, :external_id
+  end
+end

data/lib/generators/templates/migrations/create_external_services_api_actions.rb

@@ -0,0 +1,20 @@
+class CreateExternalServicesApiActions < ActiveRecord::Migration
+  def change
+    create_table :external_services_api_actions do |t|
+      t.references :initiator, null: false, polymorphic: true, index: { name: 'esaa_on_initiator_type_and_initiator_id' }
+      t.string     :type,      null: false
+
+      t.string     :name
+      t.string     :method,    null: false
+      t.string     :path,      null: false
+      t.text       :data
+      t.string     :signature
+      t.string     :queue, null: false
+
+      t.text       :options
+
+      t.timestamp  :created_at
+      t.timestamp  :processed_at
+    end
+  end
+end

data/lib/generators/templates/services/api.rb

@@ -0,0 +1,15 @@
+module ExternalServices
+  module Api
+    module <%= name %>
+      extend ExternalServices::Api
+      class Error < ExternalServices::Api::Error; end
+
+      # module_function
+      #
+      # Redefine everything unusual:
+      # def api_key
+      #   'my hardcoded key'
+      # end
+    end
+  end
+end

data/lib/generators/templates/services/api_action.rb

@@ -0,0 +1,9 @@
+module ExternalServices
+  module ApiActions
+    class <%= name %> < ApiAction
+      # def execute!
+      #   # TODO
+      # end
+    end
+  end
+end

data/lib/generators/templates/services/api_job.rb

@@ -0,0 +1,4 @@
+module ExternalServices
+  class <%= name %>ApiJob < ApiJob
+  end
+end

data/lib/generators/templates/services/model.rb

@@ -0,0 +1,9 @@
+module ExternalServices
+  class <%= name %> < Service
+    module SubjectClassMethods
+    end
+
+    module SubjectMethods
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: external_services
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Gnuskov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+    - - <
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+    - - <
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: 
+email:
+- sergey.gnuskov@flant.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .overcommit.yml
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/jobs/external_services/api_job.rb
+- app/models/external_services/api_action.rb
+- app/models/external_services/service.rb
+- bin/rails
+- external_services.gemspec
+- lib/external_services.rb
+- lib/external_services/active_record.rb
+- lib/external_services/api.rb
+- lib/external_services/engine.rb
+- lib/external_services/version.rb
+- lib/generators/install_generator.rb
+- lib/generators/service_generator.rb
+- lib/generators/templates/migrations/create_external_services.rb
+- lib/generators/templates/migrations/create_external_services_api_actions.rb
+- lib/generators/templates/services/api.rb
+- lib/generators/templates/services/api_action.rb
+- lib/generators/templates/services/api_job.rb
+- lib/generators/templates/services/model.rb
+homepage: https://github.com/flant/external_services
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Gem helps syncronizing objects to different external services like Gitlab,
+  Redmine and any other.
+test_files: []