vng 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ce0b4bfa1bc71ea60e74d3ded65c3a610a5a9bd02d867fab27d0e59c7272a24
-  data.tar.gz: 85345a62558558d22899adcdf1f052d42ef19b61d160dc0d49a87604f1292695
+  metadata.gz: 44bfc4eff4a138fc21a6058eb634d08e8be4bca032b43807c15fea355dfa5fe1
+  data.tar.gz: 414e83652f42d05171fc1413c17d9a817ab02bcd49d340164338e682b886d028
 SHA512:
-  metadata.gz: a1d3770ed3fe0ef347ec57deb447af38ac3b93885fee6f20e557a61c7ea788001dd1d01485b4c95b9232ca7ae3e74397aaf382b77a21fb05304a33c20c6dd34a
-  data.tar.gz: 53d11a0458c95f71a557531821141ec120b58dafe266952a06149fac84e348c0cd1e0a80d86298dfb242a20bfeb69010f8fad53f9e026fc7cb6418c123bd7666
+  metadata.gz: c64946b9ea2609929eb2b89b241dc93fa221df17c081e3548357eb94187d3d58215c59a6522a27d248c53c9009c5df7ec2fe64047b53367748be71988e653d60
+  data.tar.gz: 917f9edb608a9488bd95896fad8e11803494f5598236f8271abc08853159b5a6821c328d99c4db5c9f5fcb138fb4632c99fa5349569e87355edc2a09f013d45f

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [3.0.0] - 2024-12-26
+## [3.1.0] - 2025-01-11
+
+- Add Client.find(id)
+
+## [3.0.1] - 2025-01-10
+
+- Make Contact.edited_since lazy
+
+## [3.0.0] - 2025-01-09
 
 - Add Contact.edited_since(timestamp)
 

data/lib/vng/client.rb

@@ -0,0 +1,28 @@
+require 'vng/availability'
+
+module Vng
+  # Provides methods to interact with Vonigo clients.
+  class Client < Resource
+    PATH = '/api/v1/data/Clients/'
+
+    attr_reader :id, :email
+
+    def initialize(id:, email:)
+      @id = id
+      @email = email
+    end
+
+
+    def self.find(contact_id)
+      body = {
+        method: '1',
+        objectID: contact_id,
+      }
+
+      data = request path: PATH, body: body
+
+      email = value_for_field data, 238
+      new id: contact_id, email: email
+    end
+  end
+end

data/lib/vng/contact.rb

@@ -1,40 +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, :edited_at
+    # @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
 
-    def initialize(id:, first_name:, last_name:, email:, phone:, client_id:, edited_at: nil)
-      @id = id
-      @first_name = first_name
-      @last_name = last_name
-      @email = email
-      @phone = phone
-      @client_id = client_id
-      @edited_at = edited_at
+    # @return [String] the resource’s unique ID.
+    def id
+      @data['objectID']
     end
 
-    def self.edited_since(timestamp)
-      body = { isCompleteObject: 'true', dateStart: timestamp.to_i, dateMode: 2 }
+    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 email
+      self.class.value_for_field @data, 97
+    end
 
-      data = request path: PATH, body: body, returning: 'Contacts'
+    def phone
+      self.class.value_for_field @data, 96
+    end
 
-      data.filter_map do |body|
-        next unless body['isActive']
+    def client_id
+      self.class.value_for_relation @data, 'client'
+    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'
-        edited_at = Time.at Integer(body['dateLastEdited']), in: 'UTC'
+    def edited_at
+      Time.at Integer(@data['dateLastEdited']), in: 'UTC'
+    end
 
-        new id: id, first_name: first_name, last_name: last_name, email: email, phone: phone, client_id: client_id, edited_at: edited_at
-      end
+    # @return [Vng::Relation] the resources matching the conditions.
+    def self.where(conditions = {})
+      @where ||= Relation.new
+      @where.where conditions
+    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:)
@@ -50,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

@@ -130,7 +130,14 @@ module Vng
               {"fieldID"=>96, "fieldValue"=>"8648648640" },
             ], "Relations" => [
               {"objectID" => 915738, "relationType" => "client", "isActive" => "true"},
-            ]}
+            ]},
+            {"objectID" => "2201008", "dateLastEdited" => "1736479081", "isActive" => "true", "Fields" => [
+              {"fieldID"=>127, "fieldValue"=>"No" },
+              {"fieldID"=>128, "fieldValue"=>"Email" },
+              {"fieldID"=>96, "fieldValue"=>"8648648640" },
+            ], "Relations" => [
+              {"objectID" => 916758, "relationType" => "client", "isActive" => "true"},
+            ]},
           ]}
         elsif @body[:pageNo].nil?
           { "Contact"=>{ "objectID"=>"2201007" }, "Fields"=> [
@@ -144,6 +151,10 @@ module Vng
         end
       when '/api/v1/data/Locations/'
         { "Location"=>{ "objectID"=>995681 } }
+      when '/api/v1/data/Clients/'
+        { "Client" => { "objectID" => "916758" }, "Fields" => [
+          { "fieldID" => 238, "fieldValue" => "vng@example.com", "optionID" => 0 }
+        ] }
       when '/api/v1/data/Assets/'
         if @body[:method].eql? '3'
           if @body[:Fields].find{|field| field[:fieldID] == 1014}[:optionID].eql? 304

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 = '3.0.0'
+  VERSION = '3.1.0'
 end

data/lib/vng.rb

@@ -10,6 +10,7 @@ require_relative 'vng/availability'
 require_relative 'vng/breed'
 require_relative 'vng/case'
 require_relative 'vng/connection_error'
+require_relative 'vng/client'
 require_relative 'vng/contact'
 require_relative 'vng/franchise'
 require_relative 'vng/lead'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 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
@@ -69,6 +69,7 @@ files:
 - lib/vng/availability.rb
 - lib/vng/breed.rb
 - lib/vng/case.rb
+- lib/vng/client.rb
 - lib/vng/config.rb
 - lib/vng/configuration.rb
 - lib/vng/connection_error.rb
@@ -83,6 +84,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