klaviyo_api 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74537aa6edf57066528bfcefcf4fcb883ed5e85f68ed3bf562892dad33913d7d
-  data.tar.gz: a885389e5301c6377a244a8a78af4c25b70981859f789cd4e53e2d72f69b8fe7
+  metadata.gz: bb1fb4019e0ab815eed1cc24a427e97125369040f7e08821aeab66927f941b55
+  data.tar.gz: bed43a2800399a3136dfe3c139882d132a50e8a56746aa912d178c5e9e58675b
 SHA512:
-  metadata.gz: cd11a8738de6446e4d3619a1b703528021dbcd07328ceb3d01d3f335fff14bc3a21409995423b2f15f3356adb9a2a3a6702cf9db89549f2f59b59cbfefa91466
-  data.tar.gz: 6a4c7bf744142bed009aa223e297b19f15d5073a57faaa123def8304b75d9e415ad85fd86e7e10eb59027148c750adbdc6cc452944dc89eba8c95432aac9fafc
+  metadata.gz: 443aad88c951bc24b23b08adde05179352edca3f2fd8fdeb38b41ceb1de0374d09b5328ef28c5b606807abbd55413eee262a9bf62fc4d7d988ad4befc0d284e1
+  data.tar.gz: 196cf5de54d6c9d4f7fc53d20863d2e97fc3b1073f27ff4c6f1986dbd3c12b5943fdc354bdc454f5a17324cbfabccfd87a59abbe5d9be377e581ff286e7aa6b0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## [1.3.0]
+
+### Added
+
+ - Support `/v1/person/<id>`
+ - Support `/v1/people`
+ - Support `.count` on Profile
+
 ## [1.2.0]
 
 ### Added

data/lib/klaviyo_api.rb

@@ -21,4 +21,5 @@ require 'klaviyo_api/detailed_log_subscriber'
 require 'klaviyo_api/exceptions'
 require 'klaviyo_api/session'
 
+require 'klaviyo_api/collections'
 require 'klaviyo_api/resources'

data/lib/klaviyo_api/collections.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.dirname(__FILE__)}/collections/*").each { |file| require file if file.end_with? '.rb' }

data/lib/klaviyo_api/collections/profile.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI::Collections
+  class Profile < ActiveResource::Collection
+    attr_accessor :total, :page, :page_size, :start, :end
+    
+    def initialize(response = {})
+      @total  = response.delete 'total'
+      @page = response.delete 'page'
+      @page_size = response.delete 'page_size'
+      @start = response.delete 'start'
+      @end = response.delete 'end'
+      
+      @elements = response['data'] || []
+    end
+  end
+end

data/lib/klaviyo_api/resources/profile.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class Profile < Base
+    extend KlaviyoAPI::Support::Countable
+
+    self.prefix += 'v1/'
+
+    self.element_name = 'person'
+    self.collection_parser = KlaviyoAPI::Collections::Profile
+
+    class << self
+      def collection_path(prefix_options = {}, query_options = {})
+        super prefix_options, query_options.deep_merge({ api_key: headers['api-key'] })
+      end
+
+      def element_path(id, prefix_options = {}, query_options = {})
+        super id, prefix_options, query_options.deep_merge({ api_key: headers['api-key'] })
+      end
+    end
+
+    def destroy
+      raise KlaviyoAPI::InvalidOperation.new 'Cannot delete Profiles via API.'
+    end
+
+    def create
+      raise KlaviyoAPI::InvalidOperation.new 'Cannot create Profiles via API.'
+    end
+
+    def update
+      run_callbacks :update do
+        # This endpoint does not accept JSON bodies. Additionally, if the API key is in the URL, the rest of the attributes
+        # MUST be in the URL as well. The other option is to have the API key and all attributes in the body as `key=value` pairs.
+        #
+        # To reduce friction, as we already need the API key in the URL for other operations, let's just add all the attributes
+        # to the URL. Unfortunately we will need to include ALL the attributes, not just the changed ones, because it seems
+        # ActiveResource has no support for dirty models. https://github.com/rails/activeresource/issues/308
+        path = self.class.element_path(id, prefix_options, attributes)
+
+        connection.put(path, nil, self.class.headers).tap do |response|
+          load_attributes_from_response(response)
+        end
+      end
+    end
+
+    private
+
+    def method_missing(method_symbol, *arguments)
+      method_name = method_symbol.to_s
+
+      # Some fields start with a $ (e.g., '$title'). The methods `title`, `title?`
+      # and `title=` should act upon the attribute `$title` if present. Otherwise,
+      # they should act upon the attribute `title`
+      #
+      # Not a whole lot we can do if the item contains both `title` and `$title` -
+      # this will prioritize the version with the $.
+      if attributes.keys.any? { |attribute| attribute == "$#{method_name.sub(/\?|=$/, '')}" }
+        method_symbol = "$#{method_name}".to_sym
+      end
+
+      super
+    end
+  end
+end

data/lib/klaviyo_api/resources/support/countable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI::Support
+  module Countable
+    def count(params = {})
+      all(params).total
+    end
+  end
+end

data/lib/klaviyo_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KlaviyoAPI
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo_api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - rewind.io
@@ -204,6 +204,8 @@ files:
 - README.md
 - lib/active_resource/connection_ext.rb
 - lib/klaviyo_api.rb
+- lib/klaviyo_api/collections.rb
+- lib/klaviyo_api/collections/profile.rb
 - lib/klaviyo_api/configuration.rb
 - lib/klaviyo_api/connection.rb
 - lib/klaviyo_api/detailed_log_subscriber.rb
@@ -213,6 +215,8 @@ files:
 - lib/klaviyo_api/resources/base.rb
 - lib/klaviyo_api/resources/list.rb
 - lib/klaviyo_api/resources/list_member.rb
+- lib/klaviyo_api/resources/profile.rb
+- lib/klaviyo_api/resources/support/countable.rb
 - lib/klaviyo_api/session.rb
 - lib/klaviyo_api/version.rb
 homepage: https://github.com/rewindio/klaviyo_api.git