klaviyo_api 1.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8a948d59877f23eb97d2f6c53a8438892694862f7428d298151da0d1f26bfa3
+  data.tar.gz: e97ef135e895594a65bcc6f75c919f4ae89ad106220936eda08b925209fba615
+SHA512:
+  metadata.gz: 33760c4bd9d18fa3f0f582a78558fb3d6bc84548ea5889e9c3fd81cde4a6257c8c122809020b1080e3258c92d7d6b109b418db8a0d45fcc4121952005c0fcc94
+  data.tar.gz: 33372e47db2bfa551fc166ed859ca8dbb42f51b419a0a76ee1722eca79188e7dae991f4f64668df95a65e7d82fb23738256a5eafc4fa8e6c520b842c59d6ec7c

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+## [1.0.0]
+
+### Added
+
+- Created

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Third Blink Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# KlaviyoAPI
+
+[![Build Status](https://travis-ci.org/rewindio/klaviyo_api.svg?branch=master)](https://travis-ci.org/rewindio/klaviyo_api)
+
+The best way to consume Klaviyo's v1 & v2 APIs!
+
+## Installation
+
+### Add this line to your application's Gemfile
+
+```ruby
+gem 'klaviyo_api'
+```
+
+## Usage
+
+### Basic Account object
+
+```ruby
+# frozen_string_literal: true
+
+require 'klaviyo_api'
+
+class Account
+  attr_accessor :api_key
+
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  def with_klaviyo_session(&block)
+    KlaviyoAPI::Session.temp api_key, &block
+  end
+end
+
+account = Account.new 'pk_xxxyyyzzz'
+```
+
+### GET `/lists`
+
+```ruby
+account.with_klaviyo_session { KlaviyoAPI::List.all }
+```
+
+### GET `/list/:list_id`
+
+```ruby
+account.with_klaviyo_session { KlaviyoAPI::List.find 'AbC123xYz' }
+```
+
+## Development
+
+After checking out the repository, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment. You can create a file in the root of the project called `dev-config.yml` and add your API key to it:
+
+```yaml
+api_key: <your-api-key>
+```
+
+This will tell the console to pre-authenticate the Klaviyo session, making it easier to test.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/rewindio/klaviyo_api>.

data/lib/active_resource/connection_ext.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'klaviyo_api/connection'
+
+module ActiveResource
+  class Connection
+    attr_reader :response
+
+    prepend KlaviyoAPI::Connection::ResponseCapture
+    prepend KlaviyoAPI::Connection::RequestNotification
+  end
+end

data/lib/klaviyo_api.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+# gem requires
+require 'activeresource'
+require 'caching_enumerator'
+
+# gem extensions
+require 'active_resource/connection_ext'
+
+require 'klaviyo_api/version'
+require 'klaviyo_api/configuration'
+
+module KlaviyoAPI
+end
+
+require 'klaviyo_api/json_formatter'
+require 'klaviyo_api/connection'
+require 'klaviyo_api/detailed_log_subscriber'
+require 'klaviyo_api/exceptions'
+require 'klaviyo_api/session'
+
+require 'klaviyo_api/resources'

data/lib/klaviyo_api/configuration.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class Configuration
+    attr_accessor :url
+
+    def initialize
+      # base url
+      @url = 'https://a.klaviyo.com/api/'
+    end
+  end
+
+  class << self
+    def configure
+      yield configuration
+
+      KlaviyoAPI::Base.site = configuration.url
+
+      configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/klaviyo_api/connection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class Connection < ActiveResource::Connection
+    attr_reader :response
+
+    module ResponseCapture
+      def handle_response(response)
+        @response = super
+      end
+    end
+
+    include ResponseCapture
+
+    module RequestNotification
+      def request(method, path, *arguments)
+        super.tap do |response|
+          notify_about_request response, arguments
+        end
+      rescue => e
+        notify_about_request e.response, arguments if e.respond_to? :response
+
+        raise
+      end
+
+      def notify_about_request(response, arguments)
+        ActiveSupport::Notifications.instrument('request.active_resource_detailed') do |payload|
+          payload[:response] = response
+          payload[:data]     = arguments
+        end
+      end
+    end
+
+    include RequestNotification
+  end
+end

data/lib/klaviyo_api/detailed_log_subscriber.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveResource
+  class DetailedLogSubscriber < ActiveSupport::LogSubscriber
+    def request(event)
+      data = event.payload[:data]
+      request_body = data.first
+
+      log_level_method = event.payload[:response].code.to_i < 400 ? :info : :error
+
+      send log_level_method, "Request: #{request_body}" if request_body
+      send log_level_method, "Response: #{event.payload[:response].body}" unless event.payload[:response].header['content-type'] == 'text/html'
+    end
+
+    def logger
+      ActiveResource::Base.logger
+    end
+  end
+end
+
+ActiveResource::DetailedLogSubscriber.attach_to :active_resource_detailed

data/lib/klaviyo_api/exceptions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class MissingParameter < StandardError
+    def initialize(msg = 'Missing Parameter(s)')
+      super
+    end
+  end
+
+  class InvalidOperation < StandardError
+    def initialize(msg = 'The requested operation is not valid')
+      super
+    end
+  end
+end

data/lib/klaviyo_api/json_formatter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class JsonFormatter
+    include ActiveResource::Formats::JsonFormat
+
+    attr_reader :collection_name
+
+    def initialize(collection_name)
+      @collection_name = collection_name.to_s
+    end
+
+    def decode(json)
+      ActiveSupport::JSON.decode json.presence
+    end
+  end
+end

data/lib/klaviyo_api/resources.rb

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

data/lib/klaviyo_api/resources/base.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class Base < ActiveResource::Base
+    headers['User-Agent'] = "KlaviyoAPI/#{KlaviyoAPI::VERSION}"
+    headers['Accept'] = 'application/json'
+
+    self.site = KlaviyoAPI.configuration.url
+
+    self.include_format_in_path = false
+
+    self.format = KlaviyoAPI::JsonFormatter.new :result
+
+    class << self
+      def activate_session(session)
+        self.headers['api-key'] = session.api_key.to_s # rubocop:disable Style/RedundantSelf
+
+        KlaviyoAPI::Base.site = KlaviyoAPI.configuration.url
+      end
+
+      def reset_session
+        self.headers['api-key'] = nil # rubocop:disable Style/RedundantSelf
+
+        KlaviyoAPI::Base.site = KlaviyoAPI.configuration.url
+      end
+
+      def headers
+        return _headers            if _headers_defined?
+        return superclass.headers  if superclass != Object && superclass.headers
+
+        _headers || {}
+      end
+
+      def element_path(id, prefix_options = {}, query_options = nil)
+        check_prefix_options(prefix_options)
+
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}#{element_name}/#{URI.parser.escape id.to_s}#{format_extension}#{query_string(query_options)}"
+      end
+    end
+
+    def to_h
+      JSON.parse(attributes.to_json).symbolize_keys
+    end
+  end
+end

data/lib/klaviyo_api/resources/list.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class List < Base
+    self.prefix += 'v2/'
+    self.primary_key = :list_id
+
+    class << self
+      # Override this from ActiveResource#base in order to inject the id into the response
+      # because its not returned
+      def find_single(scope, options)
+        super.tap { |record| record.id = scope }
+      end
+    end
+  end
+end

data/lib/klaviyo_api/session.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class Session
+    attr_accessor :api_key
+
+    def initialize(api_key)
+      self.api_key = api_key
+    end
+
+    class << self
+      def temp(api_key)
+        session = new api_key
+
+        KlaviyoAPI::Base.activate_session session
+
+        yield
+      ensure
+        KlaviyoAPI::Base.reset_session
+      end
+    end
+  end
+end

data/lib/klaviyo_api/version.rb

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

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: klaviyo_api
+version: !ruby/object:Gem::Version
+  version: 1.1.4
+platform: ruby
+authors:
+- rewind.io
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: caching_enumerator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: http_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.0
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+description: Consume Klaviyo's API using ActiveResource
+email:
+- team@rewind.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/active_resource/connection_ext.rb
+- lib/klaviyo_api.rb
+- lib/klaviyo_api/configuration.rb
+- lib/klaviyo_api/connection.rb
+- lib/klaviyo_api/detailed_log_subscriber.rb
+- lib/klaviyo_api/exceptions.rb
+- lib/klaviyo_api/json_formatter.rb
+- lib/klaviyo_api/resources.rb
+- lib/klaviyo_api/resources/base.rb
+- lib/klaviyo_api/resources/list.rb
+- lib/klaviyo_api/session.rb
+- lib/klaviyo_api/version.rb
+homepage: https://github.com/rewindio/klaviyo_api.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Consume Klaviyo's API using ActiveResource
+test_files: []