materialist 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30db9921aa96b1a36a26893c7307a0101f251fcc
-  data.tar.gz: 8d18da5698d852c385bc37e9884c096ac0792620
+  metadata.gz: e31feaccf5642f29d194ad98a70c05c1866b95f7
+  data.tar.gz: c167c306353e46a47954a53b8e52d88d467c8297
 SHA512:
-  metadata.gz: eff72d3f1c95a140244848e98f3024e4565b30b909b61e535acb9d5b0d59f4e531b81525f3b50fbc1123e2e072971ac506528870c2f001eaf8c69de647faf969
-  data.tar.gz: 97283f7df24d20f69d2a0b5720d493a188ff1fdb1f0ec4994e70650f0710a65ff695ad68eee34f6c1d99541847f21e5557dba6b7af9d119ef86ad33442cce73f
+  metadata.gz: 4c34a1cf91ef09e4cced09aeec849fa6078f3cc9ac96400461aa553039f3a90d83a328ac10335a8af35961f3222305dd9e139b2cc2ee2df0e805a0d549462d82
+  data.tar.gz: 44fd0116938583b3876c0cd6e4e4ab13bf3d40fa5b71b820e46ce93f61683f127889c1fbd8df26ee210273283e96d02a132fb4cae4c5e09817a687a963fdb7fb

data/README.md

@@ -136,7 +136,9 @@ end
 Here is what each part of the DSL mean:
 
 #### `use_model <model_name>`
-describes the name of the active record model to be used.
+describes the name of the active record model to be used.  
+If missing, materialist skips materialising the resource itself, but will continue
+with any other functionality -- such as `materialize_link`.
 
 #### `materialize <key>, as: <column> (default: key)`
 describes mapping a resource key to database column.
@@ -146,6 +148,11 @@ describes materializing from a relation of the resource. This can be nested to a
 
 When inside the block of a `link` any other part of DSL can be used and will be evaluated in the context of the relation resource.
 
+### `materialize_link <key>, topic: <topic> (default: key)`
+describes materializing the linked entity.
+This simulates a `:noop` event on the given topic and the `url` if the
+liked resource `<key>` as it appears on the response (`_links`)
+
 #### `after_upsert <method>` -- also `after_destroy`
 describes the name of the instance method to be invoked after a record was materialized.
 

data/lib/materialist/materializer.rb

@@ -1,5 +1,6 @@
 require 'active_support/inflector'
 require 'routemaster/api_client'
+require_relative './event_worker'
 
 module Materialist
   module Materializer
@@ -9,7 +10,10 @@ module Materialist
       base.extend(Internals::DSL)
 
       root_mapping = []
-      base.instance_variable_set(:@materialist_options, { mapping: root_mapping })
+      base.instance_variable_set(:@__materialist_options, {
+        mapping: root_mapping,
+        links_to_materialize: {}
+      })
       base.instance_variable_set(:@__materialist_dsl_mapping_stack, [root_mapping])
     end
 
@@ -33,7 +37,7 @@ module Materialist
       end
 
       module ClassMethods
-        attr_reader :materialist_options, :__materialist_dsl_mapping_stack
+        attr_reader :__materialist_options, :__materialist_dsl_mapping_stack
 
         def perform(url, action)
           materializer = Materializer.new(url, self)
@@ -43,6 +47,10 @@ module Materialist
 
       module DSL
 
+        def materialize_link(key, topic: key)
+          __materialist_options[:links_to_materialize][key] = { topic: topic }
+        end
+
         def materialize(key, as: key)
           __materialist_dsl_mapping_stack.last << FieldMapping.new(key: key, as: as)
         end
@@ -56,15 +64,15 @@ module Materialist
         end
 
         def use_model(klass)
-          materialist_options[:model_class] = klass
+          __materialist_options[:model_class] = klass
         end
 
         def after_upsert(method_name)
-          materialist_options[:after_upsert] = method_name
+          __materialist_options[:after_upsert] = method_name
         end
 
         def after_destroy(method_name)
-          materialist_options[:after_destroy] = method_name
+          __materialist_options[:after_destroy] = method_name
         end
       end
 
@@ -73,13 +81,19 @@ module Materialist
         def initialize(url, klass)
           @url = url
           @instance = klass.new
-          @options = klass.materialist_options
+          @options = klass.__materialist_options
         end
 
         def upsert(retry_on_race_condition: true)
-          upsert_record.tap do |entity|
-            instance.send(after_upsert, entity) if after_upsert
+          return unless root_resource
+
+          if materialize_self?
+            upsert_record.tap do |entity|
+              instance.send(after_upsert, entity) if after_upsert
+            end
           end
+
+          materialize_links
         rescue ActiveRecord::RecordNotUnique, ActiveRecord::RecordInvalid
           # when there is a race condition and uniqueness of :source_url
           # is enforced by database index, this error is raised
@@ -92,6 +106,7 @@ module Materialist
         end
 
         def destroy
+          return unless materialize_self?
           model_class.find_by(source_url: url).tap do |entity|
             entity.destroy!.tap do |entity|
               instance.send(after_destroy, entity) if after_destroy
@@ -103,6 +118,10 @@ module Materialist
 
         attr_reader :url, :instance, :options
 
+        def materialize_self?
+          options.include? :model_class
+        end
+
         def upsert_record
           model_class.find_or_initialize_by(source_url: url).tap do |entity|
             entity.update_attributes attributes
@@ -110,6 +129,24 @@ module Materialist
           end
         end
 
+        def materialize_links
+          (options[:links_to_materialize] || [])
+            .each { |key, opts| materialize_link(key, opts) }
+        end
+
+        def materialize_link(key, opts)
+          return unless root_resource.body._links.include?(key)
+
+          # this can't happen asynchronously
+          # because the handler options are unavailable in this context
+          # :(
+          ::Materialist::EventWorker.new.perform({
+            'topic' => opts[:topic],
+            'url' => root_resource.body._links[key].href,
+            'type' => 'noop'
+          })
+        end
+
         def mapping
           options.fetch :mapping
         end
@@ -127,7 +164,11 @@ module Materialist
         end
 
         def attributes
-          build_attributes resource_at(url), mapping
+          build_attributes root_resource, mapping
+        end
+
+        def root_resource
+          @_root_resource ||= resource_at(url)
         end
 
         def build_attributes(resource, mapping)
@@ -139,7 +180,7 @@ module Materialist
               result.tap { |r| r[m.as] = resource.body[m.key] }
             when LinkMapping
               resource.body._links.include?(m.key) ?
-                result.merge(build_attributes(resource_at(resource.send(m.key).url, allow_nil: true), m.mapping || [])) :
+                result.merge(build_attributes(resource_at(resource.send(m.key).url), m.mapping || [])) :
                 result
             else
               result
@@ -147,10 +188,13 @@ module Materialist
           end
         end
 
-        def resource_at(url, allow_nil: false)
+        def resource_at(url)
           api_client.get(url, options: { enable_caching: false })
         rescue Routemaster::Errors::ResourceNotFound
-          raise unless allow_nil
+          # this is due to a race condition between an upsert event
+          # and a :delete event
+          # when this happens we should silently ignore the case
+          nil
         end
 
         def api_client

data/lib/materialist.rb

@@ -1,3 +1,3 @@
 module Materialist
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/materialist/materializer_spec.rb

@@ -14,6 +14,8 @@ RSpec.describe Materialist::Materializer do
         materialize :name
         materialize :age, as: :how_old
 
+        materialize_link :city
+
         link :city do
           materialize :timezone
 
@@ -22,12 +24,17 @@ RSpec.describe Materialist::Materializer do
           end
         end
       end
+
+      class CityMaterializer
+        include Materialist::Materializer
+
+        use_model :city
+        materialize :name
+      end
     end
 
     # this class mocks active record behaviour
-    class Foobar
-      attr_accessor :source_url, :name, :how_old, :age, :timezone, :country_tld
-
+    class BaseModel
       def update_attributes(attrs)
         attrs.each { |k, v| send("#{k}=", v) }
       end
@@ -57,7 +64,7 @@ RSpec.describe Materialist::Materializer do
             raise err
           end
 
-          (all[source_url] || Foobar.new).tap do |record|
+          (all[source_url] || self.new).tap do |record|
             record.source_url = source_url
           end
         end
@@ -74,11 +81,15 @@ RSpec.describe Materialist::Materializer do
         end
 
         def all
-          @@_store ||= {}
+          store[self.name] ||= {}
         end
 
-        def flush_all
-          @@_store = {}
+        def destroy_all
+          store[self.name] = {}
+        end
+
+        def store
+          @@_store ||= {}
         end
 
         def count
@@ -87,6 +98,14 @@ RSpec.describe Materialist::Materializer do
       end
     end
 
+    class Foobar < BaseModel
+      attr_accessor :source_url, :name, :how_old, :age, :timezone, :country_tld
+    end
+
+    class City < BaseModel
+      attr_accessor :source_url, :name
+    end
+
     module ActiveRecord
       class RecordNotUnique < StandardError; end
       class RecordInvalid < StandardError; end
@@ -95,32 +114,31 @@ RSpec.describe Materialist::Materializer do
     let(:country_url) { 'https://service.dev/countries/1' }
     let(:country_body) {{ tld: 'fr' }}
     let(:city_url) { 'https://service.dev/cities/1' }
-    let(:city_body) {{ _links: { country: { href: country_url }}, timezone: 'Europe/Paris' }}
+    let(:city_body) {{ _links: { country: { href: country_url }}, name: 'paris', timezone: 'Europe/Paris' }}
     let(:source_url) { 'https://service.dev/foobars/1' }
     let(:source_body) {{ _links: { city: { href: city_url }}, name: 'jack', age: 30 }}
-    before do
-      Foobar.flush_all
-      stub_request(:get, source_url).to_return(
-        status: 200,
-        body: source_body.to_json,
-        headers:  { 'Content-Type' => 'application/json' }
-      )
-      stub_request(:get, country_url).to_return(
-        status: 200,
-        body: country_body.to_json,
-        headers:  { 'Content-Type' => 'application/json' }
-      )
-      stub_request(:get, city_url).to_return(
+
+    def stub_resource(url, body)
+      stub_request(:get, url).to_return(
         status: 200,
-        body: city_body.to_json,
+        body: body.to_json,
         headers:  { 'Content-Type' => 'application/json' }
       )
     end
 
+    before do
+      Foobar.destroy_all
+      City.destroy_all
+
+      stub_resource source_url, source_body
+      stub_resource country_url, country_body
+      stub_resource city_url, city_body
+    end
+
     let(:action) { :create }
     let(:perform) { FoobarMaterializer.perform(source_url, action) }
 
-    it "inserts record in db" do
+    it "materializes record in db" do
       expect{perform}.to change{Foobar.count}.by 1
       inserted = Foobar.find_by(source_url: source_url)
       expect(inserted.name).to eq source_body[:name]
@@ -129,6 +147,13 @@ RSpec.describe Materialist::Materializer do
       expect(inserted.country_tld).to eq country_body[:tld]
     end
 
+    it "materializes linked record separately in db" do
+      expect{perform}.to change{City.count}.by 1
+
+      inserted = City.find_by(source_url: city_url)
+      expect(inserted.name).to eq city_body[:name]
+    end
+
     context "when record already exists" do
       let!(:record) { Foobar.create!(source_url: source_url, name: 'mo') }
 
@@ -194,8 +219,8 @@ RSpec.describe Materialist::Materializer do
     context "if resource returns 404" do
       before { stub_request(:get, source_url).to_return(status: 404) }
 
-      it "bubbles up routemaster not found error" do
-        expect { perform }.to raise_error Routemaster::Errors::ResourceNotFound
+      it "does not add anything to db" do
+        expect{perform}.to change{Foobar.count}.by 0
       end
     end
 
@@ -276,12 +301,38 @@ RSpec.describe Materialist::Materializer do
 
         context "when resource doesn't exist locally" do
           it "does not raise error" do
-            Foobar.flush_all
+            Foobar.destroy_all
             expect{ perform }.to_not raise_error
           end
         end
       end
 
     end
+
+    context "when not materializing self but materializing linked parent" do
+      class CitySettingsMaterializer
+        include Materialist::Materializer
+
+        materialize_link :city
+      end
+
+      let(:city_settings_url) { 'https://service.dev/city_settings/1' }
+      let(:city_settings_body) {{ _links: { city: { href: city_url }}}}
+      before { stub_resource city_settings_url, city_settings_body }
+
+      let(:perform) { CitySettingsMaterializer.perform(city_settings_url, action) }
+
+      it "materializes linked parent" do
+        expect{perform}.to change{City.count}.by 1
+      end
+
+      context "when action is :delete" do
+        let(:action) { :delete }
+
+        it "does not materialize linked parent" do
+          expect{perform}.to_not change{City.count}
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Mo Valipour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq