vng 2.4.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaf5c18372847d998d4e0d4c25e7bfe79ce17a11df1e573c66771cd963b3cb0a
-  data.tar.gz: 3cb76db925bd75bc8568607e3375ee18c6ed41f1c689b0624e2fc6de642e4be2
+  metadata.gz: 15e3e4b9f188fa73d3cdea696d1fac21c02ce00f1f67ada372fd328e0b1f1fac
+  data.tar.gz: 5d12461918e68ef048dc8ac0b7111d8a1337000c1815d2273fbe15409b0fd732
 SHA512:
-  metadata.gz: 527b1ced6a89489422f020b7745b6b38026d8b8187c9f3fd36abd9b55fffc21f9247a7af492c957419fe48bef126a0a3bc2894304fc23ebdb77e950446de9109
-  data.tar.gz: 86024f32fa8d9c432225d7b0a655336e5894e0ebfc13c11b4f39f18ce5cb9df2836ca06cb056135a86f7e52253f096cc2a0607a305d38241e4992799d87e6a00
+  metadata.gz: 3610cb024f1fcfaddd1d26fcfa82052bd43431a1890d2bed429c9eb0c8e1a7622a4be507bd57cec0c14c0cb08c03eda72f0d45a4acf97884b13c8b57004ed7f6
+  data.tar.gz: a0c5144d0e2458ec4830814d0689cf24a8cc3ce00915ba2c6649795fc3a45e6c5325c2f8a52ab650af03b522d73a92e1aca2efe93ffb11ded2b80855216704df

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [3.0.1] - 2025-01-10
+
+- Make Contact.edited_since lazy
+
+## [3.0.0] - 2025-01-09
+
+- Add Contact.edited_since(timestamp)
+
+**Breaking changes**
+
+- Remove Contact.all
+
 ## [2.4.0] - 2025-01-09
 
 - Add Contact.all

data/lib/vng/contact.rb

@@ -1,38 +1,65 @@
 require 'vng/resource'
 
+require ENV['VNG_MOCK'] ? 'vng/mock_request' : 'vng/http_request'
+require 'vng/relation'
+
 module Vng
   # Provides methods to interact with Vonigo contacts.
   class Contact < Resource
     PATH = '/api/v1/data/Contacts/'
 
-    attr_reader :id, :first_name, :last_name, :email, :phone, :client_id
+    # @param [Hash<Symbol, String>] data the options to initialize a resource.
+    # @option data [String] :object_id The unique ID of a Vonigo resource.
+    # @option data [Array] :fields The fields of a Vonigo resource.
+    def initialize(data = {})
+      @data = data
+    end
+
+    # @return [String] the resource’s unique ID.
+    def id
+      @data['objectID']
+    end
+
+    def active?
+      @data['isActive'] != 'false'
+    end
+
+    def first_name
+      self.class.value_for_field @data, 127
+    end
+
+    def last_name
+      self.class.value_for_field @data, 128
+    end
 
-    def initialize(id:, first_name:, last_name:, email:, phone:, client_id:)
-      @id = id
-      @first_name = first_name
-      @last_name = last_name
-      @email = email
-      @phone = phone
-      @client_id = client_id
+    def email
+      self.class.value_for_field @data, 97
     end
 
-    def self.all # TODO: add (edited_after: param)
-      body = { isCompleteObject: 'true' }
+    def phone
+      self.class.value_for_field @data, 96
+    end
 
-      data = request path: PATH, body: body, returning: 'Contacts'
+    def client_id
+      self.class.value_for_relation @data, 'client'
+    end
 
-      data.filter_map do |body|
-        next unless body['isActive']
+    def edited_at
+      Time.at Integer(@data['dateLastEdited']), in: 'UTC'
+    end
 
-        id = body['objectID']
-        first_name = value_for_field body, 127
-        last_name = value_for_field body, 128
-        email = value_for_field body, 97
-        phone = value_for_field body, 96
-        client_id = value_for_relation body, 'client'
+    # @return [Vng::Relation] the resources matching the conditions.
+    def self.where(conditions = {})
+      @where ||= Relation.new
+      @where.where conditions
+    end
 
-        new id: id, first_name: first_name, last_name: last_name, email: email, phone: phone, client_id: client_id
-      end
+    def self.edited_since(timestamp)
+      contacts = where isCompleteObject: 'true', dateStart: timestamp.to_i, dateMode: 2
+      # TODO: select should accept sub-hash, e.g.
+      # .select :date_last_edited, fields: [134, 1036], relations: ['client']
+      contacts = contacts.select 'dateLastEdited', 'Fields', 'Relations'
+      contacts.lazy.filter(&:active?)
     end
 
     def self.create(first_name:, last_name:, email:, phone:, client_id:)
@@ -48,14 +75,7 @@ module Vng
       }
 
       data = request path: PATH, body: body
-
-      id = data['Contact']['objectID']
-      first_name = value_for_field data, 127
-      last_name = value_for_field data, 128
-      email = value_for_field data, 97
-      phone = value_for_field data, 96
-
-      new id: id, first_name: first_name, last_name: last_name, email: email, phone: phone, client_id: client_id
+      new data['Contact']
     end
   end
 end

data/lib/vng/mock_request.rb

@@ -123,7 +123,7 @@ module Vng
       when '/api/v1/data/Contacts/'
         if @body[:pageNo].eql? 1
           {"Contacts" => [
-            {"objectID" => "2201007", "isActive" => "true", "Fields" => [
+            {"objectID" => "2201007", "dateLastEdited" => "1736479080", "isActive" => "true", "Fields" => [
               {"fieldID"=>127, "fieldValue"=>"Vng" },
               {"fieldID"=>128, "fieldValue"=>"Example" },
               {"fieldID"=>97, "fieldValue"=>"vng@example.com" },

data/lib/vng/relation.rb

@@ -0,0 +1,89 @@
+module Vng
+  # Provides methods to iterate through collections of Vonigo resources.
+  # @private
+  class Relation
+    include Enumerable
+
+    # @yield [Hash] the options to change which items to iterate through.
+    def initialize(options = {}, &item_block)
+      @options = {parts: ['objectID', 'isActive'], next_page: 1}
+      @options.merge! options
+      @item_block = item_block
+    end
+
+    # Specifies which items to fetch when hitting the data API.
+    # @param [Hash<Symbol, String>] conditions The conditions for the items.
+    # @return [Vng::Relation] itself.
+    def where(conditions = {})
+      if @options[:conditions] != conditions
+        @items = []
+        @options.merge! conditions: conditions
+      end
+      self
+    end
+
+    # Specifies which parts of the resource to fetch when hitting the data API.
+    # @param [Array<Symbol>] parts The parts to fetch.
+    # @return [Vng::Relation] itself.
+    def select(*parts)
+      if @options[:parts] != parts + ['objectID', 'isActive']
+        @items = nil
+        @options.merge! parts: (parts + ['objectID', 'isActive'])
+      end
+      self
+    end
+
+    def each
+      @last_index = 0
+      while next_item = find_next
+        yield next_item
+      end
+    end
+
+  private
+
+    def request(path:, body: {}, query: {}, include_security_token: true)
+      if query.none? && include_security_token
+        body = body.merge securityToken: Vng.configuration.security_token
+      end
+
+      response_for path:, body:, query:
+    end
+
+    def response_for(path:, body: {}, query: {})
+      instrument do |data|
+        Request.new(host: Vng.configuration.host, path: path, query: query, body: body).run
+      end
+    end
+
+    def find_next
+      @items ||= []
+      if @items[@last_index].nil? && more_pages?
+        body = @options[:conditions].merge pageSize: 500, pageNo: @options[:next_page], sortMode: 3, sortDirection: 0
+
+        response_body = request path: '/api/v1/data/Contacts/', body: body
+
+        more_items = response_body['Contacts'].map do |contact_data|
+          Vng::Contact.new contact_data.slice(*@options[:parts])
+        end
+        @options.merge! next_page: (more_items.size == 500 ? @options[:next_page] + 1 : 1)
+        @items.concat more_items
+      end
+      @items[(@last_index +=1) -1]
+    end
+
+    def more_pages?
+      @last_index.zero? || @options[:next_page] > 1
+    end
+
+    # Provides instrumentation to ActiveSupport listeners
+    def instrument(&block)
+      data = { class_name: 'Vng::Contact' }
+      if defined?(ActiveSupport::Notifications)
+        ActiveSupport::Notifications.instrument 'Vng.request', data, &block
+      else
+        block.call data
+      end
+    end
+  end
+end

data/lib/vng/resource.rb

@@ -29,7 +29,7 @@ module Vng
     end
 
     def self.response_for(path:, body: {}, query: {})
-      instrument do |data|
+      instrument do
         Request.new(host: host, path: path, query: query, body: body).run
       end
     end
@@ -55,10 +55,10 @@ module Vng
     # Provides instrumentation to ActiveSupport listeners
     def self.instrument(&block)
       data = { class_name: name }
-      if defined?(ActiveSupport::Notifications)
+      if defined? ActiveSupport::Notifications
         ActiveSupport::Notifications.instrument 'Vng.request', data, &block
       else
-        block.call data
+        block.call
       end
     end
   end

data/lib/vng/version.rb

@@ -1,3 +1,3 @@
 module Vng
-  VERSION = '2.4.0'
+  VERSION = '3.0.1'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.1
 platform: ruby
 authors:
 - claudiob
 bindir: exe
 cert_chain: []
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -83,6 +83,7 @@ files:
 - lib/vng/price_block.rb
 - lib/vng/price_item.rb
 - lib/vng/price_list.rb
+- lib/vng/relation.rb
 - lib/vng/resource.rb
 - lib/vng/route.rb
 - lib/vng/security_token.rb