materialist 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e1d3d42e45eb0a9130ca412078f6df11e29da53
-  data.tar.gz: 0041f0349dfce34d055ff59a5a4f2d4fc694bb26
+  metadata.gz: 1816eac41c61b0649d368f678affea67e2e58b01
+  data.tar.gz: 326dee47ecc2f228212ffd474b153eb2bd5de7b9
 SHA512:
-  metadata.gz: 0df7a1d5dab2b2d6f4fe9769e73b67028b2398dca4b309081d172e7b97c3b8729088957ffb8fcd24c1e045f6eba287cd1af96f81d9811fb2fa5470f36800e6e5
-  data.tar.gz: bfaf53768945dc8b98cad7a6191aa9ef588b680898546353d5a756f4e4286a867ae3f00067c69961fe2efb9c5b820457ac620df2cf74f5ca1db5bb2983090ed9
+  metadata.gz: 9443b581e97f752ef7d70922d38625e1019f825bb3bd9abcd0522143de8bea8cd947d0c7fa01b5abdf534611ccf24a3937c353e8e3b8e916edfe3efa976de16d
+  data.tar.gz: acd16b5c0a34c3b2be365223f67d92c5506c927f0fd47efc7be3db48118810eb0b764395d30f66ef7288da75741b7e71be88b4caf3274eba873e56e0e3a5057a

data/.gitignore

@@ -10,3 +10,4 @@ tags
 coverage/
 .byebug_history
 *.gem
+Gemfile.lock

data/Gemfile

@@ -2,25 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in routemaster_client.gemspec
 gemspec
-
-gem 'activesupport'
-gem 'sidekiq'
-gem 'routemaster-drain', '~> 3.0'
-
-# Just here to avoid a safety warning
-gem 'psych',                      require: false
-
-# Used in builds and tests
-gem 'bundler',                    require: false
-gem 'dotenv',                     require: false
-gem 'simplecov',                  require: false
-gem 'codecov',                    require: false
-gem 'webmock',                    require: false
-
-gem 'guard-rspec',                require: false
-gem 'pry',                        require: false
-gem 'byebug',                     require: false
-gem 'rspec',                      require: false
-gem 'appraisal',                  require: false
-gem 'dogstatsd',                  require: false
-gem 'fork_break',                 require: false

data/README.md

@@ -8,7 +8,51 @@ materializing the remote resource (described by the event) in database.
 This library is a set of utilities that provide both the wiring and the DSL to
 painlessly do so.
 
-### Configuration
+### Install
+
+In your `gemfile`
+
+```ruby
+gem 'materialist'
+```
+
+Then do
+
+```bash
+bundle
+```
+
+### Entity
+
+Your materialised entity need to have a **unique** `source_url` column, alongside any other field you wish to materialise.
+
+```ruby
+class CreateZones < ActiveRecord::Migration[5.0]
+  def change
+    create_table :zones do |t|
+      t.integer :orderweb_id
+      t.string :code, null: false
+      t.string :name
+      t.string :timezone
+      t.string :country_name
+      t.string :country_iso_alpha2_code
+      t.string :source_url
+
+      t.timestamps
+
+      t.index :code, unique: true
+      t.index :source_url, unique: true
+    end
+  end
+end
+```
+
+```ruby
+class Zone < ApplicationRecord
+end
+```
+
+### Routemaster Configuration
 
 First you need an "event handler":
 
@@ -102,7 +146,7 @@ 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.
 
-#### `after_upsert <method>`
+#### `after_upsert <method>` -- also `after_destroy`
 describes the name of the instance method to be invoked after a record was materialized.
 
 ```ruby
@@ -133,10 +177,17 @@ class Rider
 end
 ```
 
-Above will give you `.source`, `.city` and `.country` on any instances of `Rider`, allowing you to access remote keys.
+#### DSL
+
+- `source_link_reader <key>, via: <key> (default: none), allow_nil: true/false (default: false)`: Adds a method named `<key>` to the class giving access to the specified linked resource. If `allow_nil` is set to `false` (default) and error is raised if the resource is missing.
+
+The above example will give you `.source`, `.city` and `.country` on any instances of `Rider`, allowing you to access remote resources.
 
 e.g.
 
 ```ruby
-Rider.last.country.created_at
+rider = Rider.last
+rider.source.name
+rider.city.code
+rider.country.created_at
 ```

data/lib/materialist/errors.rb

@@ -0,0 +1,3 @@
+module Materialist
+  class ResourceNotFound < StandardError; end
+end

data/lib/materialist/materialized_record.rb

@@ -1,4 +1,5 @@
 require 'routemaster/api_client'
+require_relative './errors'
 
 module Materialist
   module MaterializedRecord
@@ -8,12 +9,20 @@ module Materialist
     end
 
     module ClassMethods
-      def source_link_reader(*keys, via: nil)
+      def source_link_reader(*keys, via: nil, allow_nil: false)
         keys.each do |key|
           define_method(key) do
-            raw = source_raw
-            raw = raw.send(via).show if via
-            raw.send(key).show.body
+            (via ? [via, key] : [key])
+              .inject(source_raw) do |res, path|
+                begin
+                  (res && res.body._links.include?(path)) ?
+                    res.send(path).show :
+                    (allow_nil ? nil : raise(ResourceNotFound))
+                rescue Routemaster::Errors::ResourceNotFound
+                  (allow_nil ? nil : raise(ResourceNotFound))
+                end
+              end
+              &.body
           end
         end
       end
@@ -23,14 +32,12 @@ module Materialist
       source_raw.body
     end
 
-    def source_raw
-      api_client.get(source_url)
-    end
+    private
 
-    def api_client
-      @_api_client ||= Routemaster::APIClient.new(
+    def source_raw
+      Routemaster::APIClient.new(
         response_class: Routemaster::Responses::HateoasResponse
-      )
+      ).get(source_url)
     end
   end
 end

data/lib/materialist/materializer.rb

@@ -76,10 +76,19 @@ module Materialist
           @options = klass.materialist_options
         end
 
-        def upsert
+        def upsert(retry_on_race_condition: true)
           upsert_record.tap do |entity|
             instance.send(after_upsert, entity) if after_upsert
           end
+        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
+          # so we simply try upsert again
+          # if error is due to another type of uniqueness constraint
+          # second call will also fail and error would bubble up
+          retry_on_race_condition ?
+            upsert(retry_on_race_condition: false) :
+            raise
         end
 
         def destroy

data/lib/materialist.rb

@@ -1,3 +1,3 @@
 module Materialist
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/materialist.gemspec

@@ -17,4 +17,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w(lib)
 
   spec.add_runtime_dependency 'sidekiq'
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'routemaster-drain', '>= 3.0'
+
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'appraisal'
 end

data/spec/materialist/materialized_record_spec.rb

@@ -10,8 +10,11 @@ RSpec.describe Materialist::MaterializedRecord do
       include Materialist::MaterializedRecord
 
       attr_accessor :source_url
+
       source_link_reader :city
+      source_link_reader :device, allow_nil: true
       source_link_reader :country, via: :city
+      source_link_reader :region, via: :city, allow_nil: true
     end
   end
 
@@ -48,17 +51,125 @@ RSpec.describe Materialist::MaterializedRecord do
       expect(record.source.name).to eq 'jack'
       expect(record.source.age).to eq 30
     end
+
+    context "when remote source returns 404" do
+      before do
+        stub_request(:get, source_url).to_return(status: 404)
+      end
+
+      it "bubbles up routemaster error" do
+        expect{ record.source }.to raise_error(Routemaster::Errors::ResourceNotFound)
+      end
+    end
   end
 
   describe "simple link reader" do
     it "returns the representation of the link source" do
       expect(record.city.timezone).to eq 'Europe/Paris'
     end
+
+    context "when linked resource returns 404" do
+      before do
+        stub_request(:get, city_url).to_return(status: 404)
+      end
+
+      it { expect{ record.city }.to raise_error Materialist::ResourceNotFound }
+    end
+
+    context "remote source is not linked to city" do
+      let(:source_body) {{ _links: { }, name: 'jack', age: 30 }}
+
+      it { expect{ record.city }.to raise_error Materialist::ResourceNotFound }
+    end
+
+    context "when nil is allowed" do
+      let(:device_url) { 'https://service.dev/devices/1' }
+      let(:source_body) {{ _links: { device: { href: device_url }}, name: 'jack', age: 30 }}
+
+      context "when linked resource returns 404" do
+        before do
+          stub_request(:get, device_url).to_return(status: 404)
+        end
+
+        it { expect(record.device).to be_nil }
+      end
+
+      context "remote source is not linked to device" do
+        let(:source_body) {{ _links: { }, name: 'jack', age: 30 }}
+
+        it { expect(record.device).to be_nil }
+      end
+    end
+
   end
 
   describe "simple link reader via another link" do
     it "returns the representation of the link source" do
       expect(record.country.tld).to eq 'fr'
     end
+
+    context "when remote city returns 404" do
+      before do
+        stub_request(:get, city_url).to_return(status: 404)
+      end
+
+      it { expect{ record.country }.to raise_error Materialist::ResourceNotFound }
+    end
+
+    context "when remote country returns 404" do
+      before do
+        stub_request(:get, country_url).to_return(status: 404)
+      end
+
+      it { expect{ record.country }.to raise_error Materialist::ResourceNotFound }
+    end
+
+    context "remote source is not linked to city" do
+      let(:source_body) {{ _links: { }, name: 'jack', age: 30 }}
+
+      it { expect{ record.country }.to raise_error Materialist::ResourceNotFound }
+    end
+
+    context "remote city is not linked to country" do
+      let(:city_body) {{ _links: { }, timezone: 'Europe/Paris' }}
+
+      it { expect{ record.country }.to raise_error Materialist::ResourceNotFound }
+    end
+
+    context "when nil is allowed" do
+
+      context "when remote city returns 404" do
+        before do
+          stub_request(:get, city_url).to_return(status: 404)
+        end
+
+        it { expect(record.region).to be_nil }
+      end
+
+      context "remote city is not linked to region" do
+        let(:city_body) {{ _links: { }, timezone: 'Europe/Paris' }}
+
+        it { expect(record.region).to be_nil }
+      end
+
+      context "when region is defined" do
+        let(:region_url) { 'https://service.dev/regions/1' }
+        let(:city_body) {{ _links: { region: { href: region_url }}, timezone: 'Europe/Paris' }}
+
+        context "when remote region returns 404" do
+          before do
+            stub_request(:get, region_url).to_return(status: 404)
+          end
+
+          it { expect(record.region).to be_nil }
+        end
+
+        context "remote source is not linked to city" do
+          let(:city_body) {{ _links: {}, timezone: 'Europe/Paris' }}
+
+          it { expect(record.region).to be_nil }
+        end
+      end
+    end
   end
 end

data/spec/materialist/materializer_spec.rb

@@ -49,7 +49,14 @@ RSpec.describe Materialist::Materializer do
       end
 
       class << self
+        attr_accessor :error_to_throw_once_in_find_or_initialize_by
+
         def find_or_initialize_by(source_url:)
+          if(err = error_to_throw_once_in_find_or_initialize_by)
+            self.error_to_throw_once_in_find_or_initialize_by = nil
+            raise err
+          end
+
           (all[source_url] || Foobar.new).tap do |record|
             record.source_url = source_url
           end
@@ -80,6 +87,11 @@ RSpec.describe Materialist::Materializer do
       end
     end
 
+    module ActiveRecord
+      class RecordNotUnique < StandardError; end
+      class RecordInvalid < StandardError; end
+    end
+
     let(:country_url) { 'https://service.dev/countries/1' }
     let(:country_body) {{ tld: 'fr' }}
     let(:city_url) { 'https://service.dev/cities/1' }
@@ -134,6 +146,34 @@ RSpec.describe Materialist::Materializer do
       end
     end
 
+    context "when there is a race condition between a create and update" do
+      let(:error) {   }
+      let!(:record) { Foobar.create!(source_url: source_url, name: 'mo') }
+
+      before { Foobar.error_to_throw_once_in_find_or_initialize_by = error }
+
+      [ ActiveRecord::RecordNotUnique, ActiveRecord::RecordInvalid ].each do |error_type|
+        context "when error of type #{error_type.name} is thrown" do
+          let(:error) { error_type }
+
+          it "still updates the record" do
+            expect{ perform }.to change { record.reload.name }
+              .from('mo').to('jack')
+          end
+
+          context "if error was thrown second time" do
+            before { allow(Foobar).to receive(:find_or_initialize_by).and_raise error }
+
+            it "bubbles up the error" do
+              expect{ perform }.to raise_error error
+            end
+          end
+
+        end
+      end
+
+    end
+
     %i(create update noop).each do |action_name|
       context "when action is :#{action_name}" do
         let(:action) { action_name }

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@ SimpleCov.formatter = SimpleCov::Formatter::Codecov if ENV['CI']
 require 'webmock/rspec'
 require 'dotenv'
 require 'pry'
-require 'byebug'
 Dotenv.overload('.env.test')
 
 # This file was generated by the `rspec --init` command. Conventionally, all

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mo Valipour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2017-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -24,6 +24,132 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: routemaster-drain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: simplecov
+  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: codecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: appraisal
+  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: 
 email:
 - valipour@gmail.com
@@ -38,13 +164,13 @@ files:
 - ".travis.yml"
 - Appraisals
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - appraise
 - lib/materialist.rb
+- lib/materialist/errors.rb
 - lib/materialist/event_handler.rb
 - lib/materialist/event_worker.rb
 - lib/materialist/materialized_record.rb

data/Gemfile.lock

@@ -1,165 +0,0 @@
-PATH
-  remote: .
-  specs:
-    materialist (0.0.1)
-      sidekiq
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.1.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.5.0)
-      public_suffix (~> 2.0, >= 2.0.2)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    byebug (9.1.0)
-    codecov (0.1.10)
-      json
-      simplecov
-      url
-    coderay (1.1.1)
-    concurrent-ruby (1.0.5)
-    connection_pool (2.2.1)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    dogstatsd (2.0.0)
-    dotenv (2.2.1)
-    ethon (0.10.1)
-      ffi (>= 1.3.0)
-    faraday (0.13.1)
-      multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.12.2)
-      faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.18)
-    fork (1.0.1)
-    fork_break (0.1.4)
-      fork (= 1.0.1)
-    formatador (0.2.5)
-    guard (2.14.1)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    hashdiff (0.3.2)
-    hashie (3.5.6)
-    i18n (0.8.6)
-    json (2.1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
-    method_source (0.8.2)
-    minitest (5.10.3)
-    multipart-post (2.0.0)
-    nenv (0.3.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    psych (2.2.4)
-    public_suffix (2.0.5)
-    rack (2.0.3)
-    rack-protection (2.0.0)
-      rack
-    rake (12.0.0)
-    rb-fsevent (0.10.2)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    redis (3.3.3)
-    redis-namespace (1.5.3)
-      redis (~> 3.0, >= 3.0.4)
-    routemaster-drain (3.0.1)
-      addressable
-      concurrent-ruby
-      faraday (>= 0.9.0)
-      faraday_middleware
-      hashie
-      rack (>= 1.4.5)
-      redis-namespace
-      typhoeus (~> 1.1)
-      wisper (~> 1.6.1)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    ruby_dep (1.5.0)
-    safe_yaml (1.0.4)
-    shellany (0.0.1)
-    sidekiq (5.0.4)
-      concurrent-ruby (~> 1.0)
-      connection_pool (~> 2.2, >= 2.2.0)
-      rack-protection (>= 1.5.0)
-      redis (~> 3.3, >= 3.3.3)
-    simplecov (0.15.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    slop (3.6.0)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    typhoeus (1.3.0)
-      ethon (>= 0.9.0)
-    tzinfo (1.2.3)
-      thread_safe (~> 0.1)
-    url (0.3.2)
-    webmock (2.3.2)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-    wisper (1.6.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport
-  appraisal
-  bundler
-  byebug
-  codecov
-  dogstatsd
-  dotenv
-  fork_break
-  guard-rspec
-  materialist!
-  pry
-  psych
-  routemaster-drain (~> 3.0)
-  rspec
-  sidekiq
-  simplecov
-  webmock
-
-BUNDLED WITH
-   1.15.4