klaviyo_api 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 730043f0dcbac75ac8f28308931684bae022bb5d412f5f137410ef7a9c6d8b09
-  data.tar.gz: c9837c60aef92683d21db4b5868c8fb21ce309709692bf9f257ad308bafc7d6b
+  metadata.gz: fa973ac50c2f9d84ffea184bbe4ca030c7ff1ffc99fd1a76f0ab51f845140487
+  data.tar.gz: ac7b1cf169a606910eb51aa5736d92e926c60e5862b710027bdd3fa468af4bed
 SHA512:
-  metadata.gz: afefe3883a8a4f78c1fba19cd1ecc40792a0aeb9332029f9faa44adde1d03f6a4fdb3f80ed9bfad19504cca6b6fb4057c90402eebc408d7c85c01a1bb35d7c23
-  data.tar.gz: 558884db59de97077b7384f9d6d38a18652eb2883c99181a066585df7571550aac2719a22f06712dc2ef263d5efe374a615edeab88beda62320168546a91d896
+  metadata.gz: 2776400dcc29ef86aac04acb8c49a64d383e302ade62602666c6bb02d69573bde894ea785e61c045329c234c64d242f60182a043d3cc74729bf84ea35e67863c
+  data.tar.gz: 6b9b855da870f2de53a3090dcae65269986cb9bc87c5373873fff684fb57e4bb46f585a6ea3955f66d3b38b0b4b5d373a0dea650d8eb510fab36b40729e904a3

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## [1.4.0]
+
+### Added
+
+ - Support `/v1/metrics`, `/v1/metrics/timeline`
+ - Support `/v1/metrics/<id>/timeline`
+
 ## [1.3.1]
 
 ### Changed

data/lib/klaviyo_api/collections/next_marker_collection.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI::Collections
+  # This collection is used for item types that rely on
+  # 'next' markers to provide pagination.
+  class NextMarkerCollection < ActiveResource::Collection
+    attr_accessor :next, :count
+
+    def initialize(response = {})
+      @count  = response.delete 'count'
+      @next = response.delete 'next'
+
+      @elements = response['data'] || []
+    end
+  end
+end

data/lib/klaviyo_api/collections/{profile.rb → paginated_collection.rb}

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module KlaviyoAPI::Collections
-  class Profile < ActiveResource::Collection
+  # This collection is used for item types that rely on pagination and
+  # provide `page`, `page_size`, etc.
+  class PaginatedCollection < ActiveResource::Collection
     attr_accessor :total, :page, :page_size, :start, :end
     
     def initialize(response = {})

data/lib/klaviyo_api/resources/event.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  # Klaviyo has the concept of "timelines" on Metrics.
+  # A single entry in that timeline is an Event.
+  class Event < Base
+    ORIGINAL_PREFIX = '/api/v1/metric/:metric_id/'
+    self.prefix = ORIGINAL_PREFIX
+
+    self.element_name = 'timeline'
+    self.collection_name = 'timeline'
+    self.collection_parser = KlaviyoAPI::Collections::NextMarkerCollection
+
+    class << self
+      def find_single(scope, options)
+        raise KlaviyoAPI::InvalidOperation, 'Cannot get single Event via API. Please use KlaviyoAPI::Event#all.'
+      end
+
+      def collection_path(prefix_options = {}, query_options = {})
+        # This needs to support both `metrics/timeline` and `metric/<id>/timeline,
+        # through `Event.all` and `Event.all params {metric_id: <id>}`. It gets a
+        # little messy.
+        if prefix_options.empty?
+          self.prefix = '/api/v1/metrics/'
+        end
+
+        check_prefix_options(prefix_options)
+
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        query_options = query_options.deep_merge({ api_key: headers['api-key'] })
+
+        path = "#{prefix(prefix_options)}#{collection_name}#{format_extension}#{query_string(query_options)}"
+
+        self.prefix = ORIGINAL_PREFIX
+
+        path
+      end
+    end
+
+    def destroy
+      raise KlaviyoAPI::InvalidOperation, 'Cannot delete Events via API.'
+    end
+
+    def create
+      raise KlaviyoAPI::InvalidOperation, 'Cannot create Events via API.'
+    end
+
+    def update
+      raise KlaviyoAPI::InvalidOperation, 'Cannot update Events via API.'
+    end
+  end
+end

data/lib/klaviyo_api/resources/metric.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class Metric < Base
+    extend KlaviyoAPI::Support::Countable
+
+    self.prefix += 'v1/'
+
+    self.collection_parser = KlaviyoAPI::Collections::PaginatedCollection
+
+    has_many :events, class_name: 'KlaviyoAPI::Event'
+
+    class << self
+      def find_single(scope, options)
+        raise KlaviyoAPI::InvalidOperation, 'Cannot get single Metric via API. Please use KlaviyoAPI::Metric#all.'
+      end
+
+      def collection_path(prefix_options = {}, query_options = {})
+        super prefix_options, query_options.deep_merge({ api_key: headers['api-key'] })
+      end
+
+      # Get all Events for all Metrics
+      # https://www.klaviyo.com/docs/api/metrics#metrics-timeline
+      def events
+        KlaviyoAPI::Event.all
+      end
+    end
+
+    def destroy
+      raise KlaviyoAPI::InvalidOperation, 'Cannot delete Metrics via API.'
+    end
+
+    def create
+      raise KlaviyoAPI::InvalidOperation, 'Cannot create Metrics via API.'
+    end
+
+    def update
+      raise KlaviyoAPI::InvalidOperation, 'Cannot update Metrics via API.'
+    end
+  end
+end

data/lib/klaviyo_api/resources/profile.rb

@@ -7,7 +7,7 @@ module KlaviyoAPI
     self.prefix += 'v1/'
 
     self.element_name = 'person'
-    self.collection_parser = KlaviyoAPI::Collections::Profile
+    self.collection_parser = KlaviyoAPI::Collections::PaginatedCollection
 
     class << self
       def collection_path(prefix_options = {}, query_options = {})
@@ -20,11 +20,11 @@ module KlaviyoAPI
     end
 
     def destroy
-      raise KlaviyoAPI::InvalidOperation.new 'Cannot delete Profiles via API.'
+      raise KlaviyoAPI::InvalidOperation, 'Cannot delete Profiles via API.'
     end
 
     def create
-      raise KlaviyoAPI::InvalidOperation.new 'Cannot create Profiles via API.'
+      raise KlaviyoAPI::InvalidOperation, 'Cannot create Profiles via API.'
     end
 
     def update

data/lib/klaviyo_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo_api
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - rewind.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -205,7 +205,8 @@ files:
 - lib/active_resource/connection_ext.rb
 - lib/klaviyo_api.rb
 - lib/klaviyo_api/collections.rb
-- lib/klaviyo_api/collections/profile.rb
+- lib/klaviyo_api/collections/next_marker_collection.rb
+- lib/klaviyo_api/collections/paginated_collection.rb
 - lib/klaviyo_api/configuration.rb
 - lib/klaviyo_api/connection.rb
 - lib/klaviyo_api/detailed_log_subscriber.rb
@@ -213,8 +214,10 @@ files:
 - lib/klaviyo_api/json_formatter.rb
 - lib/klaviyo_api/resources.rb
 - lib/klaviyo_api/resources/base.rb
+- lib/klaviyo_api/resources/event.rb
 - lib/klaviyo_api/resources/list.rb
 - lib/klaviyo_api/resources/list_member.rb
+- lib/klaviyo_api/resources/metric.rb
 - lib/klaviyo_api/resources/profile.rb
 - lib/klaviyo_api/resources/support/countable.rb
 - lib/klaviyo_api/session.rb