apisync-rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88abcef0b707a5935bc1c96d7ed9590a40d1b925
-  data.tar.gz: b9f0d57c8b2ce5529cb0bb2c3e0f078e0d761a56
+  metadata.gz: 38f143e80f7eeefc8f80b710b319435f7fc6c0bf
+  data.tar.gz: c7f569963767bc579f2545de3ab68bf6b25900ac
 SHA512:
-  metadata.gz: a68e29abe9082c255baf4aaf44b5b9842cc86ea59d8c37b251385c0a72ed8a30bac5b824e3740d7a134030372c3a16e153fd96e2977d6bc6b878857eeb7a9fb5
-  data.tar.gz: fa4fea27b22ef896a08171640f7346ac19488eca67d305dccdb9d9b1244a1c0081ec63baaafd46ace67e415da358cd888822eddac13de99eca201ad68674aef6
+  metadata.gz: cb369dff486a556acfd6de4ed212a60c06bdf545b73eeed32969caf8a8e49246e1c5463d4ad3010b53b628d3da17d9d2ee0ae1fdb7f42a2c0ee376b85dd8b155
+  data.tar.gz: 75eaa44a224a335a72b94c484ea09feca8a1ebfad2f8647c2d74cf4a31d9a05b645e401a77a4e859e2e77aeeba77e37ae168b8863759e690993a268d3ab0af6e

data/.gitignore

@@ -12,3 +12,6 @@
 .rspec_status
 
 *.gem
+spec/test_app/db/*.sqlite*
+spec/test_app/log
+spec/test_app/tmp

data/Gemfile

@@ -1,6 +1,9 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in apisync-rails.gemspec
 gemspec
+
+# For development
+# gem "apisync", path: "./../apisync-ruby", group: :development

data/README.md

@@ -1,4 +1,15 @@
-# Apisync::Rails
+# apisync-rails
+
+This gem gives you the tools to keep your product models synchronized with
+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.
+
+If you're not using Rails with ActiveRecord, please use
+[apisync-ruby](https://github.com/apisync/apisync-ruby) instead.
 
 ## Installation
 
@@ -14,6 +25,106 @@ And then execute:
 
 ## Usage
 
+**Step 1: API Key:** in `config/initializers/apisync.rb`, define your
+key:
+
+```ruby
+Apisync.api_key = ENV["APISYNC_API_KEY"];
+```
+
+**Step 2: setup your models:** you need to define which attributes in your
+product models map to the attributes in ApiSync.
+
+Some attributes are required. See
+the [API reference](https://docs.apisync.io/api/) for details.
+
+```ruby
+class Product < ActiveRecord::Base
+  apisync do
+    # required attributes
+    attribute :ad_template_type, from: :category
+    attribute :available,        from: :active?
+    attribute :content_language, value: "pt-br"
+
+    # recommended attributes
+    attribute :brand,        from: :manufacturer
+    attribute :condition,    from: :normalize_condition
+    attribute :description
+    attribute :images
+    attribute :link
+    attribute :model
+    attribute :price
+    attribute :reference_id, from: :id # optional, defaults to :id
+    attribute :title
+    attribute :year
+
+    # these are other attributes that you can send
+    custom_attribute :city,  name: :city_attr_name
+  end
+
+  private
+
+  # required format (see reference docs)
+  def images
+    [{
+      uri: "https://page.com/image1.jpg",
+      order: 1
+    }, {
+      uri: "https://page.com/image2.jpg",
+      order: 2
+    }]
+  end
+
+  # required format (see reference docs)
+  def price
+    {
+      amount: 1234, # equivalent to R$12,34
+      currency: "BRL"
+    }
+  end
+
+  # these give a human name to the custom attributes,
+  # called based on :name parameters
+  def city_attr_name
+    "Delivery city"
+  end
+end
+```
+
+**Explanation**
+
+**attribute** specifies one value to be sent to ApiSync. Pass the
+attribute name as parameter, e.g `attribute :brand`.
+
+**from** specifies what method has the values for the
+respective attribute. If you leave it blank then we'll default to the attribute
+name, e.g `attribute :brand` will call `def brand` whereas `attribute :brand, from:
+:manufacturer` will call `def manufacturer`.
+
+**value** specifies a value for the respective attribute. Ideal for values that
+don't change.
+
+**custom_attribute** allows you to specify an attribute that is not part
+of the documentation. You can use these to create richer ad templates.
+
+### Reference ID
+
+The **reference_id** attribute is extremely important. We use the attribute to
+keep track of the record's state. The first time a record is sent, ApiSync
+creates it and saves the reference id. The second time a record is sent it
+knows that it only needs to be updated, not created.
+If you omit `reference_id`, we will keep creating the same record
+over and over.
+
+By default, `reference_id` is set to whatever **id** value is. You can
+customize it, e.g `attribute :reference_id, from: :my_custom_id`.
+
+### Note on callbacks
+
+This gem uses Rails' callbacks to trigger synchronization.
+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.
 
 ## Development
 
@@ -23,7 +134,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kurko/apisync-rails.
+Bug reports and pull requests are welcome on GitHub at https://github.com/apisync/apisync-rails.
 
 ## License
 

data/apisync-rails.gemspec

@@ -21,7 +21,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport", ">= 4.2"
+  spec.add_dependency "activerecord", ">= 4.2"
+  # in dev mode
+  spec.add_dependency "apisync"
+
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "rails", "~> 5.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
 end

data/lib/apisync/active_record_extension.rb

@@ -0,0 +1,41 @@
+class Apisync
+  module ActiveRecordExtension
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      klass.include(InstanceMethods)
+    end
+
+    module InstanceMethods
+      attr_accessor :apisync
+
+      private
+
+      def start_apisync
+        @apisync = Apisync::Rails::Model.new(self)
+        @apisync.instance_eval(&self.class.apisync_block)
+        @apisync.validate!
+      end
+
+      def save_to_apisync
+        @apisync.sync
+      end
+    end
+
+    module ClassMethods
+      def apisync_block
+        @apisync_block
+      end
+
+      def apisync(&block)
+        after_initialize :start_apisync
+        after_commit :save_to_apisync
+
+        @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

@@ -1,6 +1,13 @@
+require "bundler/setup"
+
+require "active_support"
+require "apisync"
 require "apisync/rails/version"
+require "apisync/rails/model"
+require "apisync/rails/http"
+require "apisync/active_record_extension"
 
-module Apisync
+class Apisync
   module Rails
     # Your code goes here...
   end

data/lib/apisync/rails/http.rb

@@ -0,0 +1,10 @@
+class Apisync
+  module Rails
+    class Http
+      def self.post(attrs)
+        client = Apisync.new
+        client.inventory_items.save(attributes: attrs)
+      end
+    end
+  end
+end

data/lib/apisync/rails/model.rb

@@ -0,0 +1,86 @@
+class Apisync
+  module Rails
+    class Model
+      class MissingAttribute < StandardError; end
+
+      REQUIRED_ATTRS = {
+        available: "This is required to enable/disable your item in our database.",
+        content_language: "This is required to show your item to the correct audience.",
+        ad_template_type: "This is required to generate the correct ads for this item."
+      }.freeze
+
+      WARNING_ATTRS = {
+        reference_id: "This is required to track your record, otherwise it will be created every time."
+      }
+
+      attr_reader :attributes
+
+      def initialize(model)
+        @model = model
+        @attributes = {}
+      end
+
+      def attribute(attr_name, from: nil, value: nil)
+        @attributes.delete(attr_name)
+        @attributes[attr_name] = attr_value(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)
+        }
+      end
+
+      def sync
+        set_reference_id
+        validate!
+        log_warnings
+        Apisync::Rails::Http.post(@attributes)
+      end
+
+      def validate!
+        REQUIRED_ATTRS.each do |attr, message|
+          if @attributes[attr].blank?
+            raise MissingAttribute, "Please specify #{attr}. #{message}"
+          end
+        end
+      end
+
+      def log_warnings
+        WARNING_ATTRS.each do |attr, message|
+          if @attributes[attr].blank?
+            ::Rails.logger.warn "Please specify #{attr}. #{message}"
+          end
+        end
+      end
+
+      private
+
+      def set_reference_id
+        if @attributes[:reference_id].blank? && @model.id.present?
+          @attributes[:reference_id] = @model.id.to_s
+        end
+      end
+
+      def attr_value(attr_name, from:, value:)
+        if value.blank?
+          if from.present?
+            value = @model.send(from)
+          else
+            value = @model.send(attr_name)
+          end
+        end
+        value
+      end
+
+      def localized_name(name)
+        if name.present?
+          @model.send(name)
+        end
+      end
+    end
+  end
+end

data/lib/apisync/rails/version.rb

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

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: apisync-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexandre de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-08 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: apisync
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +94,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Use this gem if you're using Rails. If you're not using Rails, then use
   apisync-ruby gem.
 email:
@@ -72,7 +198,10 @@ files:
 - apisync-rails.gemspec
 - bin/console
 - bin/setup
+- lib/apisync/active_record_extension.rb
 - lib/apisync/rails.rb
+- lib/apisync/rails/http.rb
+- lib/apisync/rails/model.rb
 - lib/apisync/rails/version.rb
 homepage: https://github.com/apisync/apisync-rails
 licenses: