loops_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f72e2f62c89ee3d1ba4bf2803ce036d1bbaf0c5090cb59bc5dfed76310e0d64
+  data.tar.gz: 611b4184d555033ba4c4166426519a4bf9cea4fb47675b4b2b99ed0cafea9a58
+SHA512:
+  metadata.gz: 128ae813b6a85b3420a30f6400c9ab11151d1cb95d73518bf776f31e54a64aa6b17d0e548abb54048bb4e4446395a1b7e71b6d2f145b81ab18adf834ded6ba0f
+  data.tar.gz: 10d6820a08203cbac614de06c54f482b9beea538a73d0d9fa31543a43150cb8183552d52a7ae58a9bd4a82299edb2f807e7f8deb400060e0675c2c37e71c9534

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/ParameterLists:
+  Max: 6

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - [TBD]
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Loops
+
+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,59 @@
+# Loops Ruby SDK
+
+## Introduction
+
+This is the official Ruby SDK for [Loops](https://loops.so), an email platform for modern software companies.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+You will need a Loops API key to use the package.
+
+In your Loops account, go to the [API Settings page](https://app.loops.so/settings?page=api) and click "Generate key".
+
+Copy this key and save it in your application code (for example as `LOOPS_API_KEY` in an `.env` file).
+
+See the API documentation to learn more about [rate limiting](https://loops.so/docs/api-reference#rate-limiting) and [error handling](https://loops.so/docs/api-reference#debugging).
+
+In an initializer, import and configure the SDK:
+
+```ruby
+# config/initializers/loops.rb
+
+require "loops_sdk"
+
+LoopsSdk.configure do |config|
+  config.api_key = 'your_api_key'
+end
+```
+
+```ruby
+begin
+
+  response = LoopsSdk::Transactional.send(
+    transactional_id: "closfz8ui02yq......",
+    email: "dan@loops.so",
+    data_variables: {
+      loginUrl: "https://app.domain.com/login?code=1234567890"
+    }
+  )
+
+  render json: response
+
+rescue LoopsSdk::APIError => e
+  # Do something if there is an error from the API
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Loops-so/loops-rb.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/loops_sdk/base.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class Base
+    class << self
+      private
+
+      def handle_response(response)
+        case response.status
+        when 200
+          JSON.parse(response.body)
+        when 400, 404, 405, 409, 500
+          raise APIError.new(response.status, response.body)
+        else
+          raise APIError.new(response.status, "Unexpected error occurred")
+        end
+      end
+
+      def make_request(method, path, params = {}, body = nil)
+        response = LoopsSdk.configuration.connection.send(method, path, params) do |req|
+          req.body = body.to_json if body
+        end
+        handle_response(response)
+      end
+    end
+  end
+
+  # The `APIError` class in Ruby represents an error that occurs during an API request with specific
+  # status and response body information.
+  class APIError < StandardError
+    attr_reader :status, :body
+
+    def initialize(status, body)
+      @status = status
+      @body = body
+      super("API request failed with status #{status}: #{body}")
+    end
+  end
+end

data/lib/loops_sdk/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module LoopsSdk
+  class Configuration
+    attr_accessor :api_key
+
+    def connection
+      @connection ||= Faraday.new(url: "https://app.loops.so/api/") do |faraday|
+        faraday.adapter Faraday.default_adapter
+        faraday.headers["Authorization"] = "Bearer #{api_key}"
+        faraday.headers["Content-Type"] = "application/json"
+      end
+    end
+  end
+end

data/lib/loops_sdk/contacts.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class Contacts < Base
+    class << self
+      def create(email:, properties: {}, mailing_lists: {})
+        contact_data = {
+          email: email,
+          mailingLists: mailing_lists
+        }.merge(properties.compact).compact
+        make_request(:post, "v1/contacts/create", {}, contact_data)
+      end
+
+      def update(email:, properties: {}, mailing_lists: {})
+        contact_data = {
+          email: email,
+          mailingLists: mailing_lists
+        }.merge(properties.compact).compact
+        make_request(:put, "v1/contacts/update", {}, contact_data)
+      end
+
+      def find(email: nil, user_id: nil)
+        raise ArgumentError, "Only one parameter is permitted." if email && user_id
+        raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
+
+        params = email ? { email: email } : { userId: user_id }
+        make_request(:get, "v1/contacts/find", params)
+      end
+
+      def delete(email: nil, user_id: nil)
+        raise ArgumentError, "Only one parameter is permitted." if email && user_id
+        raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
+
+        body = email ? { email: email } : { userId: user_id }
+        make_request(:post, "v1/contacts/delete", {}, body)
+      end
+    end
+  end
+end

data/lib/loops_sdk/custom_fields.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class CustomFields < Base
+    class << self
+      def list
+        make_request(:get, "v1/customFields")
+      end
+    end
+  end
+end

data/lib/loops_sdk/events.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class Events < Base
+    class << self
+      def send(event_name:, email: nil, user_id: nil, contact_properties: {}, event_properties: {}, mailing_lists: {})
+        raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
+
+        event_data = {
+          email: email,
+          userId: user_id,
+          eventName: event_name,
+          eventProperties: event_properties.compact,
+          mailingLists: mailing_lists.compact
+        }.merge(contact_properties.compact).compact
+        make_request(:post, "v1/events/send", {}, event_data)
+      end
+    end
+  end
+end

data/lib/loops_sdk/mailing_lists.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class MailingLists < Base
+    class << self
+      def list
+        make_request(:get, "v1/lists")
+      end
+    end
+  end
+end

data/lib/loops_sdk/transactional.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class Transactional < Base
+    class << self
+      def send(transactional_id:, email:, add_to_audience: false, data_variables: {}, attachments: [])
+        attachments = attachments.map do |attachment|
+          attachment.transform_keys { |key| key == :content_type ? :contentType : key }
+        end
+        email_data = {
+          transactionalId: transactional_id,
+          email: email,
+          addToAudience: add_to_audience,
+          dataVariables: data_variables,
+          attachments: attachments
+        }.compact
+        make_request(:post, "v1/transactional", {}, email_data)
+      end
+    end
+  end
+end

data/lib/loops_sdk/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  VERSION = "0.1.0"
+end

data/lib/loops_sdk.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require_relative "loops_sdk/version"
+require_relative "loops_sdk/configuration"
+require_relative "loops_sdk/base"
+require_relative "loops_sdk/contacts"
+require_relative "loops_sdk/events"
+require_relative "loops_sdk/mailing_lists"
+require_relative "loops_sdk/transactional"
+require_relative "loops_sdk/custom_fields"
+
+module LoopsSdk
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/sig/loops_sdk.rbs

@@ -0,0 +1,4 @@
+module LoopsSdk
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: loops_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Rowden
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for interacting with the Loops API.
+email:
+- dan@loops.so
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/loops_sdk.rb
+- lib/loops_sdk/base.rb
+- lib/loops_sdk/configuration.rb
+- lib/loops_sdk/contacts.rb
+- lib/loops_sdk/custom_fields.rb
+- lib/loops_sdk/events.rb
+- lib/loops_sdk/mailing_lists.rb
+- lib/loops_sdk/transactional.rb
+- lib/loops_sdk/version.rb
+- sig/loops_sdk.rbs
+homepage: https://loops.so/docs/api-reference
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://loops.so/docs/api-reference
+  source_code_uri: https://github.com/Loops-so/loops-rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: The official Ruby SDK for Loops.
+test_files: []