loops_email 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10a833456d991fba24c9c68791fb263245e0ca826ee100046f181895fccf3d6b
+  data.tar.gz: 3e6a1e223a2fed620a47430bf913e3d15091568325c9f7ec5a3f0de26861bd45
+SHA512:
+  metadata.gz: 4a368d0e58f371592e9b56e77dd51d54cb6df95d18fd9c99acd98cb4a6b1805ff5ad701eb361a2f949356f77a883c2eaebfe99b6fea4229db1a3cf90808deb09
+  data.tar.gz: 8ce818668344081046bbea6aad1e466f063caa7a1a32c746786e38253816006b3ed425f4c1c59db0f4829a7b6ab1449ae83430fe9419b8e1e8c9e810c21f4d25

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/README.md

@@ -0,0 +1,50 @@
+# LoopsEmail
+Unofficial loops email sdk. Official docs: https://loops.so/docs/start-here
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add loops_email
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install loops_email
+
+## Usage
+
+Create initializer `config/initializers/loops_email.rb`:
+```ruby
+LoopsEmail.configure do |config|
+  config.api_key = "xxxxx" # if you're using rails, it's better to use built-in Credential
+  # config.stub = Rails.env.development? && ENV["LOOPS_EMAIL_ENABLE"]&.empty?
+  # config.log_file_path = "log/loops_email.log"
+end
+```
+
+### Send transaction email
+```ruby
+result = LoopsEmail::Sdk::TransactionalEmail.new(
+  receiver: "your_receiver_email",
+  transaction_id: "your_transaction_id",
+  variables: {
+    your_variable_name: "your_variable_value"
+  }
+).call
+
+if result.success?
+  # handle success
+else
+  puts result.error
+end
+```
+
+## Development
+
+After checking out the repo, 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/loops_email.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/loops_email/client.rb

@@ -0,0 +1,59 @@
+
+class LoopsEmail::Client
+  def initialize; end
+
+  def post(endpoint, body: {}, other_headers: {})
+    return if LoopsEmail.stub?
+
+    response = Net::HTTP.post(
+      endpoint_uri(endpoint),
+      body.to_json,
+      headers.merge(other_headers)
+    )
+    log_response(response)
+    LoopsEmail::Result.new(response)
+  end
+
+  def get(endpoint, other_headers: {})
+    return if LoopsEmail.stub?
+
+    response = Net::HTTP.get(
+      endpoint_uri(endpoint),
+      headers.merge(other_headers)
+    )
+    log_response(response)
+    LoopsEmail::Result.new(response)
+  end
+
+  private
+
+  def success?(response)
+    response.is_a? Net::HTTPSuccess
+  end
+
+  def log_response(response)
+    if response.is_a? Net::HTTPSuccess
+      LoopsEmail.logger.info "[LoopsEmail] send email success: #{response.body}"
+    else
+      LoopsEmail.logger.error "[LoopsEmail] send email failed: #{response.body}"
+    end
+  end
+
+  def endpoint_uri(endpoint)
+    slash = endpoint.start_with?('/') ? '' : '/'
+    URI("#{LoopsEmail::Configuration::API_HOST}#{slash}#{endpoint}")
+  end
+
+  def headers
+    {
+      "Authorization": "Bearer #{api_key}",
+      "Content-Type": 'application/json'
+    }
+  end
+
+  def api_key
+    LoopsEmail.api_key ||
+      ENV["LOOPS_EMAIL_API_KEY"] ||
+      raise(LoopsEmail::Error.new("api_key is not set"))
+  end
+end

data/lib/loops_email/configuration.rb

@@ -0,0 +1,23 @@
+
+class LoopsEmail::Configuration
+  attr_writer :api_key, :stub, :log_file_path
+
+  API_HOST = "https://app.loops.so"
+
+  class Error < LoopsEmail::Error; end
+
+  def initialize; end
+
+  def api_key
+    @api_key || ENV["LOOPS_EMAIL_API_KEY"] || raise(LoopsEmail::Configuration::Error.new("api_key is not set"))
+  end
+
+  def log_file_path
+    @log_file_path || "log/loops_email.log"
+  end
+
+  def stub
+    false
+  end
+  alias stub? stub
+end

data/lib/loops_email/error.rb

@@ -0,0 +1,3 @@
+
+class LoopsEmail::Error < StandardError
+end

data/lib/loops_email/result.rb

@@ -0,0 +1,51 @@
+
+class LoopsEmail::Result
+  attr_accessor :response
+
+  def initialize(response)
+    @response = response
+  end
+
+  def success?
+    response_success? && operation_success?
+  end
+
+  def failed?
+    !success?
+  end
+
+  def response_success?
+    response.is_a? Net::HTTPSuccess
+  end
+
+  def operation_success?
+    body.dig(:body, :success)
+  end
+
+  def http_code
+    response.code
+  end
+
+  def message
+    body[:content] || body.dig(:error, :message) || body
+  end
+
+  def error
+    body[:error]
+  end
+
+  def body
+    JSON.parse(response.body, symbolize_names: true)
+  rescue JSON::ParserError
+    { content: response.body }
+  end
+
+  def as_json
+    {
+      success: success?,
+      http_code: http_code,
+      body: body
+    }
+  end
+  alias to_h as_json
+end

data/lib/loops_email/sdk/transactional_email.rb

@@ -0,0 +1,25 @@
+
+class LoopsEmail::Sdk::TransactionalEmail
+  attr_accessor :receiver,
+                :transaction_id,
+                :variables
+
+
+  def initialize(receiver:, transaction_id:, variables: {})
+    @receiver = receiver
+    @transaction_id = transaction_id
+    @variables = variables
+  end
+
+  def call
+    LoopsEmail::Client.new.post("/api/v1/transactional", body: payload)
+  end
+
+  def payload
+    {
+      transactionalId: transaction_id,
+      email: receiver,
+      dataVariables: variables
+    }
+  end
+end

data/lib/loops_email/sdk.rb

@@ -0,0 +1,2 @@
+
+module LoopsEmail::Sdk; end

data/lib/loops_email/version.rb

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

data/lib/loops_email.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "loops_email/version"
+require_relative "loops_email/error"
+require_relative "loops_email/configuration"
+require_relative "loops_email/result"
+require_relative "loops_email/client"
+require_relative "loops_email/sdk"
+require_relative "loops_email/sdk/transactional_email"
+
+module LoopsEmail
+  class << self
+    def configure
+      yield configuration if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def api_key
+      configuration.api_key
+    end
+
+    def stub?
+      configuration.stub?
+    end
+
+    def logger
+      @looger ||= if ENV["RAILS_LOG_TO_STDOUT"] || ENV["LOOPS_EMAIL_LOG_TO_STDOUT"]
+                    Logger.new(STDOUT)
+                  else
+                    Logger.new(configuration.log_file_path)
+                  end
+    end
+  end
+end

data/sig/loops_email.rbs

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

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: loops_email
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-18 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- ianlynxk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- lib/loops_email.rb
+- lib/loops_email/client.rb
+- lib/loops_email/configuration.rb
+- lib/loops_email/error.rb
+- lib/loops_email/result.rb
+- lib/loops_email/sdk.rb
+- lib/loops_email/sdk/transactional_email.rb
+- lib/loops_email/version.rb
+- sig/loops_email.rbs
+homepage: https://github.com/getfrl/loops_email
+licenses: []
+metadata: {}
+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.7
+signing_key:
+specification_version: 4
+summary: 'unofficial loops email sdk. Official docs: https://loops.so/docs/start-here'
+test_files: []