apisync-rails 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38f143e80f7eeefc8f80b710b319435f7fc6c0bf
-  data.tar.gz: c7f569963767bc579f2545de3ab68bf6b25900ac
+  metadata.gz: 3ea28569d7864193a7d68b89a0a7429e0e7e8d9a
+  data.tar.gz: ed8b404b84538f8095d64e83362b1edddcd2fb8b
 SHA512:
-  metadata.gz: cb369dff486a556acfd6de4ed212a60c06bdf545b73eeed32969caf8a8e49246e1c5463d4ad3010b53b628d3da17d9d2ee0ae1fdb7f42a2c0ee376b85dd8b155
-  data.tar.gz: 75eaa44a224a335a72b94c484ea09feca8a1ebfad2f8647c2d74cf4a31d9a05b645e401a77a4e859e2e77aeeba77e37ae168b8863759e690993a268d3ab0af6e
+  metadata.gz: acb463131a3e52f011ed585fc22f290285bb8903f73fdb53f8850830d3d1b6af3626f8fe18a94d5841b347e6219edc3e8e56bc15e0251fed197eec333a755471
+  data.tar.gz: c8f715e69ee47ba68cec1d456972f0142f53e395595405f2bf0b961712fe1a6db543b10a6cfcadf38173085a4f5a78a9a2f0cea7e040c68aa7fb9ffde31c9a5b

data/README.md

@@ -41,6 +41,10 @@ the [API reference](https://docs.apisync.io/api/) for details.
 ```ruby
 class Product < ActiveRecord::Base
   apisync do
+    # should the current item be synchronized?
+    # remove it to always sync all items
+    sync_if :should_sync?
+
     # required attributes
     attribute :ad_template_type, from: :category
     attribute :available,        from: :active?
@@ -64,6 +68,10 @@ class Product < ActiveRecord::Base
 
   private
 
+  def should_sync?
+    true
+  end
+
   # required format (see reference docs)
   def images
     [{
@@ -93,6 +101,10 @@ end
 
 **Explanation**
 
+**sync_if** defines if the item should be synchronized. The method with the
+name of the symbol will be called. When `true`, the item will be saved on
+ApiSync. Remove this if you always want to push to ApiSync (recommended).
+
 **attribute** specifies one value to be sent to ApiSync. Pass the
 attribute name as parameter, e.g `attribute :brand`.
 

data/apisync-rails.gemspec

@@ -23,8 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport", ">= 4.2"
   spec.add_dependency "activerecord", ">= 4.2"
-  # in dev mode
-  spec.add_dependency "apisync"
+  spec.add_dependency "apisync", ">= 0.1.4"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/apisync/active_record_extension.rb

@@ -10,13 +10,13 @@ class Apisync
 
       private
 
-      def start_apisync
+      def apisync_on_after_initialize
         @apisync = Apisync::Rails::Model.new(self)
         @apisync.instance_eval(&self.class.apisync_block)
         @apisync.validate!
       end
 
-      def save_to_apisync
+      def apisync_on_after_commit
         @apisync.sync
       end
     end
@@ -27,15 +27,11 @@ class Apisync
       end
 
       def apisync(&block)
-        after_initialize :start_apisync
-        after_commit :save_to_apisync
+        after_initialize :apisync_on_after_initialize
+        after_commit :apisync_on_after_commit
 
         @apisync_block = block
       end
     end
   end
 end
-
-ActiveSupport.on_load(:active_record) do
-  ::ActiveRecord::Base.send(:include, Apisync::ActiveRecordExtension)
-end

data/lib/apisync/rails.rb

@@ -6,9 +6,16 @@ require "apisync/rails/version"
 require "apisync/rails/model"
 require "apisync/rails/http"
 require "apisync/active_record_extension"
+require "apisync/rails/sync_model_job/sidekiq"
+require "apisync/rails/extensions"
 
 class Apisync
   module Rails
-    # Your code goes here...
   end
 end
+
+# This class, Extensions, is responsible for including extensions into
+# our own classes (and ActiveRecord::Base). For example, if Sidekiq is defined
+# then we include it into our worker classes. That way we don't need to load
+# the Sidekiq gem and force it into client codebases.
+Apisync::Rails::Extensions.setup

data/lib/apisync/rails/extensions.rb

@@ -0,0 +1,21 @@
+class Apisync
+  module Rails
+    class Extensions
+      def self.setup
+
+        ActiveSupport.on_load(:active_record) do
+          ::ActiveRecord::Base.send(:include, Apisync::ActiveRecordExtension)
+        end
+
+        if defined?(::Sidekiq)
+          sidekiq_klass = ::Apisync::Rails::SyncModelJob::Sidekiq
+
+          # Don't include twice the same module
+          unless sidekiq_klass.included_modules.include?(::Sidekiq::Worker)
+            sidekiq_klass.send(:include, ::Sidekiq::Worker)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apisync/rails/http.rb

@@ -1,9 +1,30 @@
 class Apisync
   module Rails
     class Http
-      def self.post(attrs)
+      def self.post(attrs, request_concurrency:, too_many_requests_attempts: nil, concurrency_lib: nil)
+        headers = {}
+        headers["X-Request-Concurrency"] = request_concurrency.to_s
+
+        if ::Rails.respond_to?(:gem_version)
+          rails_version = ::Rails.gem_version.to_s
+        elsif Rails::VERSION.is_a?(String)
+          rails_version = Rails::VERSION
+        elsif Rails::VERSION::STRING
+          rails_version = Rails::VERSION::STRING
+        end
+
+        headers["X-Framework"] = "Ruby on Rails #{rails_version}"
+        headers["X-Client-Library"] = "apisync-rails #{Apisync::Rails::VERSION}"
+
+        if concurrency_lib
+          headers["X-Concurrency-Lib"] = concurrency_lib.to_s
+        end
+        if too_many_requests_attempts
+          headers["X-TooManyRequests-Attempts"] = too_many_requests_attempts.to_s
+        end
+
         client = Apisync.new
-        client.inventory_items.save(attributes: attrs)
+        client.inventory_items.save(attributes: attrs, headers: headers)
       end
     end
   end

data/lib/apisync/rails/model.rb

@@ -18,6 +18,11 @@ class Apisync
       def initialize(model)
         @model = model
         @attributes = {}
+        @should_sync = true
+      end
+
+      def sync_if(method_name)
+        @should_sync = @model.send(method_name.to_sym)
       end
 
       def attribute(attr_name, from: nil, value: nil)
@@ -35,13 +40,29 @@ class Apisync
       end
 
       def sync
-        set_reference_id
-        validate!
-        log_warnings
-        Apisync::Rails::Http.post(@attributes)
+        if sync?
+          set_reference_id
+          validate!
+          log_warnings
+
+          if defined?(::Sidekiq)
+            Apisync::Rails::SyncModelJob::Sidekiq.perform_async(
+              @model.class.name,
+              @model.id,
+              @attributes
+            )
+          else
+            Apisync::Rails::Http.post(
+              @attributes,
+              request_concurrency: :synchronous
+            )
+          end
+        end
       end
 
       def validate!
+        return unless sync?
+
         REQUIRED_ATTRS.each do |attr, message|
           if @attributes[attr].blank?
             raise MissingAttribute, "Please specify #{attr}. #{message}"
@@ -59,6 +80,10 @@ class Apisync
 
       private
 
+      def sync?
+        @should_sync
+      end
+
       def set_reference_id
         if @attributes[:reference_id].blank? && @model.id.present?
           @attributes[:reference_id] = @model.id.to_s

data/lib/apisync/rails/sync_model_job/sidekiq.rb

@@ -0,0 +1,43 @@
+class Apisync
+  module Rails
+    module SyncModelJob
+      class Sidekiq
+        # include ::Sidekiq::Worker (deferred)
+        #
+        # Sidekiq module is included in the Extensions class. We don't do it here
+        # because we don't know if Sidekiq is loaded or not. If it is not, we
+        # don't want to include it in this class.
+
+        def perform(model_name, id, attributes, attempt = 1)
+          unless defined?(::Sidekiq)
+            raise ArgumentError,
+              "Sidekiq is not defined but an ApiSync job is being spun up."
+          end
+
+          begin
+            Apisync::Rails::Http.post(
+              attributes,
+              request_concurrency: :asynchronous,
+              concurrency_lib: "Sidekiq #{::Sidekiq::VERSION}",
+              too_many_requests_attempts: attempt.to_s
+            )
+
+          # When there are too many requests and ApiSync's API cannot take it,
+          # this algorithm will push this job to be retried in the future.
+          rescue Apisync::TooManyRequests
+            ::Rails.logger.warn "[apisync] Too many simultaneous HTTP requests. Requests are being automatically throttled to solve this problem. Contact ApiSync support for details."
+
+            retry_in = Random.new.rand(270) + 30 # 30 seconds - 5 minutes
+            self.class.perform_in(
+              retry_in,
+              model_name,
+              id,
+              attributes,
+              attempt.to_i + 1
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apisync/rails/version.rb

@@ -1,5 +1,5 @@
 class Apisync
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apisync-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alexandre de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -200,8 +200,10 @@ files:
 - bin/setup
 - lib/apisync/active_record_extension.rb
 - lib/apisync/rails.rb
+- lib/apisync/rails/extensions.rb
 - lib/apisync/rails/http.rb
 - lib/apisync/rails/model.rb
+- lib/apisync/rails/sync_model_job/sidekiq.rb
 - lib/apisync/rails/version.rb
 homepage: https://github.com/apisync/apisync-rails
 licenses: