customerio_api 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6091d1158347650e87f732c7e733f0db28b0832e80d28df0b4b645648bddcd06
-  data.tar.gz: 00a16c715091dbdef658965c64244b18cde75248ed766b7e878825788633cb7a
+  metadata.gz: 55d2eb57401ec393eb20828ae5bf0f8b0c976eb71e2687ceab6f00ad6a5ba4a3
+  data.tar.gz: d54b39470b1e03f6eabb0834587fb0670f35c1072d8346df8b676e56d9dd3771
 SHA512:
-  metadata.gz: a12e7858737966bd0b05245b323b661e2959b19e358e1da381ae5942f70ccac9dc298219dabe4c62b7a7480c980cfc4182a063ba019f9b3b50d97869172ff07e
-  data.tar.gz: 8339cfd265bba418b73a8f186543a68351f58047745ce415970142d8f1b32fe51a32c99c44aaf2e846ae4031e17131cfb4e7c2193fef16652f993ded52479f35
+  metadata.gz: 411e4e3e895be49da5bfb74689141c9c29f59451956c2f7a21667c5eedfb910d8c17b95204496075444a418b9ad1de42acda32390842d9cfbf047f854d2abff1
+  data.tar.gz: 74193ecf0712a3507f19d4ee63cace92de371e8550a2abf95142deebc3ed1bfeb8615b0ee3ac184fa66d4c5a158cc9dc8cc265a23f41296c9f4fe24b4ff281aa

data/.env.sample

@@ -0,0 +1,3 @@
+API_KEY=
+SITE_ID=
+API_KEY=

data/README.md

@@ -50,6 +50,29 @@ customers = v1_client.customer.where(email: 'test@example.com')
 # => returns a list of CustomerioAPI::Customer
 ```
 
+#### 2. Use s set of filter conditions to find customer
+
+```ruby
+attributes =
+  {
+    filter: {
+      and:
+          [
+            {
+              attribute: {
+                field: 'cio_id',
+                operator: 'eq',
+                value: 'd7a90a000a0b'
+              }
+            }
+          ]
+    }
+  }
+customer_identifiers = v1_client.customer.search(attributes: attributes)
+
+# => returns a CustomerioAPI::Customer object, containing arrays of identifiers and ids
+```
+
 ### CustomerioObject
 
 #### 1. Use a set of filter conditions to find object

data/lib/customerio_api/resources/customer_event_resource.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CustomerioAPI
+  class CustomerEventResource < Resource
+    # client.customer_event.create(identifier: id | email | cio_id, attributes: {name: "event_a", data: {"key": "value"}})
+    def create(identifier:, attributes:)
+      post_request("customers/#{identifier}/events", body: attributes)
+    end
+  end
+end

data/lib/customerio_api/resources/customer_resource.rb

@@ -10,5 +10,11 @@ module CustomerioAPI
       response_body = get_request('customers', params: { email: email }).body
       response_body['results'].map { |customers| Customer.new(customers) }
     end
+
+    # client.customer.search(attributes: attributes)
+    def search(attributes:, start: nil, limit: nil)
+      response_body = post_request("customers?start=#{start}&limit=#{limit}", body: attributes).body
+      Customer.new(response_body)
+    end
   end
 end

data/lib/customerio_api/track_v1_client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module CustomerioAPI
+  class TrackV1Client
+    BASE_URL = 'https://customer.io/api/v1/'
+    attr_reader :site_id, :track_api_key, :adapter
+
+    def initialize(site_id:, track_api_key:, adapter: Faraday.default_adapter)
+      @site_id = site_id
+      @track_api_key = track_api_key
+      @adapter = adapter
+    end
+
+    def customer_event
+      CustomerEventResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.request :json
+        conn.response :json, content_type: 'application/json'
+        conn.adapter adapter
+        conn.request :authorization, :basic, site_id, track_api_key
+      end
+    end
+  end
+end

data/lib/customerio_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CustomerioAPI
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - linhho0702
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".rspec"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -128,10 +129,12 @@ files:
 - lib/customerio_api/objects/customerio_object.rb
 - lib/customerio_api/objects/object_relationship.rb
 - lib/customerio_api/resource.rb
+- lib/customerio_api/resources/customer_event_resource.rb
 - lib/customerio_api/resources/customer_resource.rb
 - lib/customerio_api/resources/customerio_object_resource.rb
 - lib/customerio_api/resources/object_relationship_resource.rb
 - lib/customerio_api/resources/track_resource.rb
+- lib/customerio_api/track_v1_client.rb
 - lib/customerio_api/v1_client.rb
 - lib/customerio_api/v2_client.rb
 - lib/customerio_api/version.rb