materialist 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddfdebe864838d6fdb912aee5d3002417aca969b
-  data.tar.gz: 13ebd4c0bad48a307820aaa28c81d674335da88c
+  metadata.gz: 2369c3f2842a7dc8cc9ff3efe2339328b7cf14aa
+  data.tar.gz: d043d9df4eda5667d6a09b040a485c39e7c16449
 SHA512:
-  metadata.gz: c082a2dfffdae443aaafb41d20f4a12da3203a90bbae0e4bd8075f77364fdc67d2386de3373572d1a0b6b46bbb93d0e7a1adca2df59777f15de7c9eb9fbf0d02
-  data.tar.gz: 80d88005986ec167b4d599085e9fcd424c37b4cab98baacc44a38deed1731e035c8acc8da118e0be286b17f5c2de1adf95ddd4a45253b43ba9648169b4f79113
+  metadata.gz: 78c9b1b5683feadc832ac2184b0b79b1a52f421697b4d921af7e776da7607218093e6a7f9aa12cb5fc2ddf8147c4752c0b4649fc3ea748e408ccc01aec98d9ff
+  data.tar.gz: 7f9b3b1a197b8c793a040b3d1cb894282bc58446055910c3727d08fea83678de23c7823bcdb613b57b5ec8161c360a00518e96dfc1dd8444641fe6a683399bd9

data/README.md

@@ -143,7 +143,10 @@ If missing, materialist skips materialising the resource itself, but will contin
 with any other functionality -- such as `materialize_link`.
 
 #### `capture <key>, as: <column> (default: key)`
-describes mapping a resource key to database column.
+describes mapping a resource key to a database column.
+
+#### `capture_link_href <key>, as: <column>`
+describes mapping a link href (as it appears on the hateous response) to a database column.
 
 #### `link <key>`
 describes materializing from a relation of the resource. This can be nested to any depth as shown above.
@@ -155,17 +158,20 @@ describes materializing the linked entity.
 This simulates a `:noop` event on the given topic and the `url` of the
 liked resource `<key>` as it appears on the response (`_links`) -- meaning the materializer for the given topic will be invoked.
 
-#### `after_upsert <method>` -- also `after_destroy`
-describes the name of the instance method to be invoked after a record was materialized.
+#### `after_upsert <method> (, <method>(, ...))` -- also `after_destroy`
+describes the name of the instance method(s) to be invoked after a record was materialized.
 
 ```ruby
 class ZoneMaterializer
   include Materialist::Materializer
 
-  after_upsert :my_method
+  after_upsert :my_method, :my_second_method
 
   def my_method(record)
   end
+  
+  def my_second_method(record)
+  end
 end
 ```
 

data/lib/materialist.rb

@@ -1,3 +1,3 @@
 module Materialist
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/materialist/materializer.rb

@@ -36,6 +36,15 @@ module Materialist
         attr_reader :key, :mapping
       end
 
+      class LinkHrefMapping
+        def initialize(key:, as:)
+          @key = key
+          @as = as
+        end
+
+        attr_reader :key, :as
+      end
+
       module ClassMethods
         attr_reader :__materialist_options, :__materialist_dsl_mapping_stack
 
@@ -55,6 +64,10 @@ module Materialist
           __materialist_dsl_mapping_stack.last << FieldMapping.new(key: key, as: as)
         end
 
+        def capture_link_href(key, as:)
+          __materialist_dsl_mapping_stack.last << LinkHrefMapping.new(key: key, as: as)
+        end
+
         def link(key)
           link_mapping = LinkMapping.new(key: key)
           __materialist_dsl_mapping_stack.last << link_mapping
@@ -67,12 +80,12 @@ module Materialist
           __materialist_options[:model_class] = klass
         end
 
-        def after_upsert(method_name)
-          __materialist_options[:after_upsert] = method_name
+        def after_upsert(*method_array)
+          __materialist_options[:after_upsert] = method_array
         end
 
-        def after_destroy(method_name)
-          __materialist_options[:after_destroy] = method_name
+        def after_destroy(*method_array)
+          __materialist_options[:after_destroy] = method_array
         end
       end
 
@@ -89,7 +102,7 @@ module Materialist
 
           if materialize_self?
             upsert_record.tap do |entity|
-              instance.send(after_upsert, entity) if after_upsert
+              send_messages(after_upsert, entity) unless after_upsert.nil?
             end
           end
 
@@ -109,7 +122,7 @@ module Materialist
           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
+              send_messages(after_destroy, entity) unless after_destroy.nil?
             end if entity
           end
         end
@@ -177,7 +190,13 @@ module Materialist
           mapping.inject({}) do |result, m|
             case m
             when FieldMapping
-              result.tap { |r| r[m.as] = resource.body[m.key] }
+              result.tap { |r| r[m.as] = serializable_value(resource.body[m.key]) }
+            when LinkHrefMapping
+              result.tap do |r|
+                if resource.body._links.include?(m.key)
+                  r[m.as] = resource.body._links[m.key].href
+                end
+              end
             when LinkMapping
               resource.body._links.include?(m.key) ?
                 result.merge(build_attributes(resource_at(resource.send(m.key).url), m.mapping || [])) :
@@ -188,6 +207,11 @@ module Materialist
           end
         end
 
+        def serializable_value(value)
+          value_is_complex_object = value.is_a?(Hash) || value.is_a?(Array)
+          value_is_complex_object ? value.to_json : value
+        end
+
         def resource_at(url)
           api_client.get(url, options: { enable_caching: false })
         rescue Routemaster::Errors::ResourceNotFound
@@ -202,6 +226,10 @@ module Materialist
             response_class: Routemaster::Responses::HateoasResponse
           )
         end
+
+        def send_messages(messages, arguments)
+            messages.each { |message| instance.send(message, arguments) }
+        end
       end
     end
   end

data/spec/materialist/materializer_spec.rb

@@ -13,6 +13,8 @@ RSpec.describe Materialist::Materializer do
         persist_to :foobar
         capture :name
         capture :age, as: :how_old
+        capture_link_href :city, as: :city_url
+        capture_link_href :account, as: :account_url
 
         materialize_link :city
 
@@ -99,7 +101,8 @@ RSpec.describe Materialist::Materializer do
     end
 
     class Foobar < BaseModel
-      attr_accessor :source_url, :name, :how_old, :age, :timezone, :country_tld
+      attr_accessor :source_url, :name, :how_old, :age, :timezone,
+        :country_tld, :city_url, :account_url
     end
 
     class City < BaseModel
@@ -117,6 +120,8 @@ RSpec.describe Materialist::Materializer do
     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 }}
+    let(:complex_url) { 'https://service.dev/hashes/1' }
+    let(:complex_body) {{ _links: { city: { href: city_url }}, name: { first_name: 'Mo', last_name: 'Town' }, age: [30,31,44] }}
 
     def stub_resource(url, body)
       stub_request(:get, url).to_return(
@@ -133,6 +138,7 @@ RSpec.describe Materialist::Materializer do
       stub_resource source_url, source_body
       stub_resource country_url, country_body
       stub_resource city_url, city_body
+      stub_resource complex_url, complex_body
     end
 
     let(:action) { :create }
@@ -145,6 +151,7 @@ RSpec.describe Materialist::Materializer do
       expect(inserted.how_old).to eq source_body[:age]
       expect(inserted.timezone).to eq city_body[:timezone]
       expect(inserted.country_tld).to eq country_body[:tld]
+      expect(inserted.account_url).to be_nil
     end
 
     it "materializes linked record separately in db" do
@@ -154,6 +161,17 @@ RSpec.describe Materialist::Materializer do
       expect(inserted.name).to eq city_body[:name]
     end
 
+    context "when there are complex value types" do
+      let(:perform) { FoobarMaterializer.perform(complex_url, action) }
+
+      it "serialises the complex value into json" do
+        expect{perform}.to change{Foobar.count}.by 1
+        inserted = Foobar.find_by(source_url: complex_url)
+        expect(inserted.name).to eq complex_body[:name].to_json
+        expect(inserted.how_old).to eq complex_body[:age].to_json
+      end
+    end
+
     context "when record already exists" do
       let!(:record) { Foobar.create!(source_url: source_url, name: 'mo') }
 
@@ -255,6 +273,18 @@ RSpec.describe Materialist::Materializer do
           it "calls after_upsert method" do
             expect{ perform }.to change { record.actions_called[:after_upsert] }
           end
+
+          it "calls more than one after_upsert method" do
+            class FoobarMaterializer
+              after_upsert :my_method, :my_method2
+
+              def my_method2(entity)
+                entity.actions_called[:after_upsert2] = true
+              end
+            end
+            expect{ perform }.to  change { record.actions_called[:after_upsert]  }
+                             .and change { record.actions_called[:after_upsert2] }
+          end
         end
       end
 
@@ -299,6 +329,18 @@ RSpec.describe Materialist::Materializer do
           expect{ perform }.to change { record.actions_called[:after_destroy] }
         end
 
+        it "calls more than one after_destroy method" do
+          class FoobarMaterializer
+            after_destroy :my_method, :my_method2
+
+            def my_method2(entity)
+              entity.actions_called[:after_destroy2] = true
+            end
+          end
+          expect{ perform }.to change  { record.actions_called[:after_destroy]  }
+                           .and change { record.actions_called[:after_destroy2] }
+        end
+
         context "when resource doesn't exist locally" do
           it "does not raise error" do
             Foobar.destroy_all

metadata

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