neon_email 0.0.1 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbd091c753b505fe2db9ef77f45b12d098eb48a12f4fd4cf37a66281b2e06d37
-  data.tar.gz: a225077ecd4b16ff36442a010ed3a2b69a51fe23a41faee712061f25f3619992
+  metadata.gz: '08c8b22c41e226259fc405001baef9de188da57c0f281d32948d67fece337c6b'
+  data.tar.gz: e90c79d2a1ee993af5d0066d34732983e126b29f846b5237371808a585f36e0d
 SHA512:
-  metadata.gz: 05d9dd0adc3d29cd27f7b315f2e8a21c94ddd97b83bb0e9d4d1ae667e9654618235dec14bd3613aff5a95d3f28fdf58cec4709e529758ff34c6f4aaa6e9aea21
-  data.tar.gz: 52b9efbcbb865a4a3c51d7f17d51938b82af4395f0c4e7187397958b5e0bf9cfa50f285b3dc30cb84a7826a835ff0cba299ed586dfaf10b9424bf9dca2b79471
+  metadata.gz: e246399d8f834bb77145fe4537068747cb529b194996ed325cec3ced10a701f8509b446905ad18a0f6599195a6af130b76c55cc16ef6b3fa4e8d8c337c9921af
+  data.tar.gz: c141597c95755e79ce4a99044d83842ace1a83e98274bfe7c7f8312df55477fdfa774ffcc2db5d2d14d365cba4cf2a1ee38fba99e0a4009453861e532e730589

data/.gcloudignore

@@ -0,0 +1,17 @@
+# This file specifies files that are *not* uploaded to Google Cloud Platform
+# using gcloud. It follows the same syntax as .gitignore, with the addition of
+# "#!include" directives (which insert the entries of the given .gitignore-style
+# file at that point).
+#
+# For more information, run:
+#   $ gcloud topic gcloudignore
+#
+.gcloudignore
+# If you would like to upload your .git directory, .gitignore file or files
+# from your .gitignore file, remove the corresponding line
+# below:
+.git
+.gitignore
+
+node_modules
+#!include:.gitignore

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/Gemfile

@@ -15,6 +15,8 @@ gem "pry", "~> 0.14.1"
 
 gem "faker", "~> 2.17"
 
-gem "ruby-kafka", "~> 1.3"
-
 gem "sendgrid-ruby", "~> 6.4"
+
+gem "google-cloud-pubsub", "~> 2.6"
+
+gem "functions-framework-ruby", "~> 9001.0"

data/Gemfile.lock

@@ -1,23 +1,92 @@
 PATH
   remote: .
   specs:
-    neon_email (0.0.1)
+    neon_email (0.0.8)
+      functions_framework (= 0.9.0)
+      neon_schemas (= 0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    avro (1.10.2)
+      multi_json (~> 1)
+    cloud_events (0.4.0)
     coderay (1.1.3)
     concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    digest-crc (0.6.3)
-      rake (>= 12.0.0, < 14.0.0)
     faker (2.17.0)
       i18n (>= 1.6, < 2)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
     fixture_dependencies (1.10.0)
+    functions-framework-ruby (9001.0)
+    functions_framework (0.9.0)
+      cloud_events (~> 0.1)
+      puma (~> 4.3)
+      rack (~> 2.1)
+    gapic-common (0.4.1)
+      faraday (~> 1.3)
+      google-protobuf (~> 3.15, >= 3.15.2)
+      googleapis-common-protos (>= 1.3.11, < 2.0)
+      googleapis-common-protos-types (>= 1.0.6, < 2.0)
+      googleauth (~> 0.15, >= 0.15.1)
+      grpc (~> 1.36)
+    google-cloud-core (1.6.0)
+      google-cloud-env (~> 1.0)
+      google-cloud-errors (~> 1.0)
+    google-cloud-env (1.5.0)
+      faraday (>= 0.17.3, < 2.0)
+    google-cloud-errors (1.1.0)
+    google-cloud-pubsub (2.6.1)
+      concurrent-ruby (~> 1.1)
+      google-cloud-core (~> 1.5)
+      google-cloud-pubsub-v1 (~> 0.0)
+    google-cloud-pubsub-v1 (0.4.0)
+      gapic-common (~> 0.3)
+      google-cloud-errors (~> 1.0)
+      grpc-google-iam-v1 (>= 0.6.10, < 2.0)
+    google-protobuf (3.17.0)
+    googleapis-common-protos (1.3.11)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos-types (>= 1.0.6, < 2.0)
+      grpc (~> 1.27)
+    googleapis-common-protos-types (1.0.6)
+      google-protobuf (~> 3.14)
+    googleauth (0.16.2)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.14)
+    grpc (1.37.1)
+      google-protobuf (~> 3.15)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-google-iam-v1 (0.6.11)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos (>= 1.3.11, < 2.0)
+      grpc (~> 1.27)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    jwt (2.2.3)
+    memoist (0.16.2)
     method_source (1.0.0)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    neon_schemas (0.1.1)
+      avro (~> 1.10)
+    nio4r (2.5.7)
+    os (1.1.1)
     parallel (1.20.1)
     parser (3.0.1.0)
       ast (~> 2.4.1)
@@ -25,6 +94,10 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (4.0.6)
+    puma (4.3.8)
+      nio4r (~> 2.0)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (12.3.3)
     regexp_parser (2.1.1)
@@ -56,13 +129,17 @@ GEM
     rubocop-performance (1.10.1)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    ruby-kafka (1.3.0)
-      digest-crc
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
     ruby_http_client (3.5.2)
     sendgrid-ruby (6.4.0)
       ruby_http_client (~> 3.4)
     sequel (5.43.0)
+    signet (0.15.0)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
     standard (1.0.5)
       rubocop (= 1.12.1)
       rubocop-performance (= 1.10.1)
@@ -74,12 +151,13 @@ PLATFORMS
 DEPENDENCIES
   faker (~> 2.17)
   fixture_dependencies (~> 1.10)
+  functions-framework-ruby (~> 9001.0)
+  google-cloud-pubsub (~> 2.6)
   neon_email!
   pg (~> 1.2)
   pry (~> 0.14.1)
   rake (~> 12.0)
   rspec (~> 3.0)
-  ruby-kafka (~> 1.3)
   sendgrid-ruby (~> 6.4)
   sequel (~> 5.43)
   standard

data/README.md

@@ -3,10 +3,18 @@
 This gem is used to listen to email messages to Kafka and then interact with the
 Sendgrid API.
 
-## Necessary API Keys
+## Doppler Setup
 
-* Kafka URL - Where to consume email messages
-* Sendgrid API Key - The API Key for SendGrid
+You can use the `email` project in Doppler and access the `dev` environment when
+developing locally. The `stg` and `prd` environments are used for staging and
+production respectively.
+
+Local development requires you to start the GCP Pub/Sub locally if you want to
+test the gem end-to-end, _however_ you will most likely __not__ need to start the
+GCP server because we can depend on the arity defined in the `neon_schemas` gem
+as a contract that this is how objects in this gem will be initialized and have
+their methods invoked. You should be able to develop the functionality needed
+here fully using POROs and necessary email APIs like Sendgrid.
 
 ## Contributing
 

data/app.rb

@@ -0,0 +1,9 @@
+require "functions_framework"
+require "neon_email"
+require "logger"
+
+logger = Logger.new($stdout)
+
+FunctionsFramework.cloud_event "neon_law.welcome_email" do |event|
+  logger.info event
+end

data/lib/neon_email.rb

@@ -1,5 +1,4 @@
 require "neon_email/version"
-require "neon_email/listener"
 
 module NeonEmail
   class Error < StandardError; end

data/lib/neon_email/greeting_mailer.rb

@@ -1,4 +1,5 @@
 require "sendgrid-ruby"
+# require "neon_secrets"
 
 module NeonEmail
   class GreetingMailer
@@ -20,6 +21,7 @@ module NeonEmail
       mail = SendGrid::Mail.new(from, subject, to, content)
 
       sg = SendGrid::API.new(api_key: ENV["SENDGRID_API_KEY"])
+      # sg = SendGrid::API.new(api_key: NeonSecrets::Getter.get(secret_name: "sendgrid_api_key"))
       response = sg.client.mail._("send").post(request_body: mail.to_json)
 
       puts response

data/lib/neon_email/version.rb

@@ -1,3 +1,3 @@
 module NeonEmail
-  VERSION = "0.0.1"
+  VERSION = "0.0.8"
 end

data/neon_email.gemspec

@@ -6,9 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Neon Law"]
   spec.email = ["support@neonlaw.com"]
 
-  spec.summary = "A gem to test the Neon Law Postgres database."
-  spec.description = 'This gem contains tests and sequel setup to speak to
-  the Neon Law database'
+  spec.summary = "A gem to handle outbound_email messages in Neon Law software space."
+  spec.description = spec.summary
   spec.homepage = "https://github.com/neonlaw/codebase"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
@@ -22,4 +21,7 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "neon_schemas", "0.1.1"
+  spec.add_runtime_dependency "functions_framework", "0.9.0"
 end

metadata

@@ -1,35 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: neon_email
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.8
 platform: ruby
 authors:
 - Neon Law
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
-dependencies: []
-description: |-
-  This gem contains tests and sequel setup to speak to
-    the Neon Law database
+date: 2021-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: neon_schemas
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: functions_framework
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: A gem to handle outbound_email messages in Neon Law software space.
 email:
 - support@neonlaw.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gcloudignore"
 - ".gitignore"
 - ".rspec"
-- ".rspec_status"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
+- app.rb
 - lib/neon_email.rb
-- lib/neon_email/consumer.rb
 - lib/neon_email/greeting_mailer.rb
-- lib/neon_email/producer.rb
 - lib/neon_email/version.rb
 - neon_email.gemspec
 homepage: https://github.com/neonlaw/codebase
@@ -56,5 +82,5 @@ requirements: []
 rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
-summary: A gem to test the Neon Law Postgres database.
+summary: A gem to handle outbound_email messages in Neon Law software space.
 test_files: []

data/lib/neon_email/consumer.rb

@@ -1,30 +0,0 @@
-require "kafka"
-
-module NeonEmail
-  class Consumer
-    def self.consume_messages
-      kafka = Kafka.new(["localhost:9092"])
-
-      # Consumers with the same group id will form a Consumer Group together.
-      consumer = kafka.consumer(group_id: "email")
-
-      # It's possible to subscribe to multiple topics by calling `subscribe`
-      # repeatedly.
-      consumer.subscribe("greetings")
-
-      # Stop the consumer when the SIGTERM signal is sent to the process.
-      # It's better to shut down gracefully than to kill the process.
-      trap("TERM") { consumer.stop }
-
-      # This will loop indefinitely, yielding each message in turn.
-      consumer.each_message do |message|
-        case message.topic
-        when "greetings"
-          NeonEmail::GreetingMailer.deliver(message: message.value)
-        end
-      end
-    end
-  end
-end
-
-NeonEmail::Consumer.consume_messages

data/lib/neon_email/producer.rb

@@ -1,12 +0,0 @@
-require "kafka"
-
-module NeonEmail
-  class Producer
-    def self.produce_greeting
-      kafka = Kafka.new(["localhost:9092"])
-      kafka.deliver_message("Hello, World!", topic: "greetings")
-    end
-  end
-end
-
-NeonEmail::Producer.produce_greeting