apisync-rails 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ea28569d7864193a7d68b89a0a7429e0e7e8d9a
-  data.tar.gz: ed8b404b84538f8095d64e83362b1edddcd2fb8b
+  metadata.gz: 34ddbfb8791d1f24a61b9c7944494f006c2b543a
+  data.tar.gz: ec710fff7c676929cfd11d70d958aa1b56ca768d
 SHA512:
-  metadata.gz: acb463131a3e52f011ed585fc22f290285bb8903f73fdb53f8850830d3d1b6af3626f8fe18a94d5841b347e6219edc3e8e56bc15e0251fed197eec333a755471
-  data.tar.gz: c8f715e69ee47ba68cec1d456972f0142f53e395595405f2bf0b961712fe1a6db543b10a6cfcadf38173085a4f5a78a9a2f0cea7e040c68aa7fb9ffde31c9a5b
+  metadata.gz: cd78a4b8aed59f148678befaa4e9e27eb08f32448aedb1a5cfff6783ca6eb74354f3dc494c959043a8f31ca96a73dc80b6af4b9dda46c3416530653835cb2d14
+  data.tar.gz: '091e34cb46df93b256f10b2811548facbd597d02d75dcdbe29fc61fc9d64c760691c3d97601f271923fd993785f3cfae812b1ec023fb0d89a69d5e04b1bc5742'

data/README.md

@@ -6,7 +6,8 @@ ApiSync.
 * **DSL:** built-in DSL for ActiveRecord models that pushes your data
 automatically to apisync.io.
 * **Sidekiq:** when Sidekiq is present, this gem will push data asynchronously.
-Otherwise, it will fallback to pushing data synchronously.
+Otherwise, it will fallback to pushing data synchronously. We strongly recommend
+using Sidekiq so errors are handled automatically for you.
 
 If you're not using Rails with ActiveRecord, please use
 [apisync-ruby](https://github.com/apisync/apisync-ruby) instead.
@@ -138,6 +139,20 @@ If you're bypassing methods like `after_commit`,
 no data will be sent to ApiSync. For example, `update_attribute` doesn't
 perform validations checks, so please use `update_attributes` instead.
 
+### TooManyRequests
+
+When too many simultaneous requests are being made, a 429 status code will be
+returned from the server to indicate to the client to slow down.
+
+When using Sidekiq, this lib's algorithm will automatically throttle (slow down)
+the requests. When not using any queue gem, `Apisync::TooManyRequests` exception
+will be raised and you will have to catch it, therefore
+**we strongly recommend using Sidekiq**.
+
+Without Sidekiq, an ActiveRecord's `after_commit` callback is used so the exception
+shouldn't prevent your record from being saved to the database, but you have
+to rescue it manually.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/apisync/active_record_extension.rb

@@ -13,7 +13,6 @@ class Apisync
       def apisync_on_after_initialize
         @apisync = Apisync::Rails::Model.new(self)
         @apisync.instance_eval(&self.class.apisync_block)
-        @apisync.validate!
       end
 
       def apisync_on_after_commit

data/lib/apisync/rails/model.rb

@@ -18,6 +18,7 @@ class Apisync
       def initialize(model)
         @model = model
         @attributes = {}
+        @payload = {}
         @should_sync = true
       end
 
@@ -27,67 +28,98 @@ class Apisync
 
       def attribute(attr_name, from: nil, value: nil)
         @attributes.delete(attr_name)
-        @attributes[attr_name] = attr_value(attr_name, from: from, value: value)
+        @attributes[attr_name] = { attr_name: attr_name, from: from, value: value }
       end
 
       def custom_attribute(attr_name, from: nil, value: nil, name: nil)
         @attributes[:custom_attributes] ||= []
         @attributes[:custom_attributes] << {
-          name: localized_name(name),
-          identifier: attr_name.to_s,
-          value: attr_value(attr_name, from: from, value: value)
+          attr_name: attr_name,
+          from: from,
+          value: value,
+          name: name
         }
       end
 
       def sync
         if sync?
-          set_reference_id
-          validate!
-          log_warnings
+          payload = generate_payload
+          payload = set_reference_id(payload)
+          validate!(payload)
+          log_warnings(payload)
 
           if defined?(::Sidekiq)
             Apisync::Rails::SyncModelJob::Sidekiq.perform_async(
               @model.class.name,
               @model.id,
-              @attributes
+              payload
             )
           else
             Apisync::Rails::Http.post(
-              @attributes,
+              payload,
               request_concurrency: :synchronous
             )
           end
         end
       end
 
-      def validate!
+      def validate!(payload)
         return unless sync?
 
         REQUIRED_ATTRS.each do |attr, message|
-          if @attributes[attr].blank?
-            raise MissingAttribute, "Please specify #{attr}. #{message}"
+          if payload[attr].blank?
+            raise MissingAttribute, "Please specify '#{attr}'. #{message}"
           end
         end
       end
 
-      def log_warnings
+      def log_warnings(payload)
         WARNING_ATTRS.each do |attr, message|
-          if @attributes[attr].blank?
-            ::Rails.logger.warn "Please specify #{attr}. #{message}"
+          if payload[attr].blank?
+            ::Rails.logger.warn "Please specify '#{attr}'. #{message}"
           end
         end
       end
 
       private
 
+      def generate_payload
+        @payload = {}
+        @attributes.each do |attr, properties|
+          if attr == :custom_attributes
+            custom_attrs = []
+            properties.each do |custom_attr|
+              from      = custom_attr[:from]
+              value     = custom_attr[:value]
+              attr_name = custom_attr[:attr_name]
+              name      = custom_attr[:name]
+
+              custom_attrs << {
+                name: localized_name(name),
+                identifier: attr_name.to_s,
+                value: attr_value(attr_name, from: from, value: value)
+              }
+            end
+            @payload[:custom_attributes] = custom_attrs
+          else
+            from  = properties[:from]
+            value = properties[:value]
+            @payload[attr] = attr_value(attr, from: from, value: value)
+          end
+        end
+
+        @payload
+      end
+
       def sync?
         @should_sync
       end
 
-      def set_reference_id
-        if @attributes[:reference_id].blank? && @model.id.present?
-          @attributes[:reference_id] = @model.id.to_s
+      def set_reference_id(payload)
+        if payload[:reference_id].blank? && @model.id.present?
+          payload[:reference_id] = @model.id.to_s
         end
+        payload
       end
 
       def attr_value(attr_name, from:, value:)

data/lib/apisync/rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apisync-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alexandre de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2017-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport