oxy 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8a7625f338127548d91d41d4e8b764a6e3a1014
-  data.tar.gz: e89478f9b9d9c9d4d3fc3edea133212c0a403151
+  metadata.gz: 02a23f55b9b4cf46d59ef0f671a472a225153ac8
+  data.tar.gz: a2e6b315527a05744f8bc523d6066118cbcc186d
 SHA512:
-  metadata.gz: a17585335722e4519d79197fe7856bcc6b2a099b7fb836cf20797b94d8a63fb57e61bd288d5e1c32778aac2ca7102200719b32d6950559f0f8fb15dc7a3f76ee
-  data.tar.gz: 6c01096e3f53919248603bdf4c8f1ab69164729883fa288a23431224f415fe6a9659f7ed1d2cac9d6431553e16ea78ecc30ee320af533e953c794d023ce09aa9
+  metadata.gz: 9497cc4a6a0342b8005970df6005cdd3093dc9f7a5f31115d0b1f9f2daa172ec324125c60c5658d19ee0f928ddcb7a671439c4fd7853ab0ac40752a319894b87
+  data.tar.gz: de94ce90f57007c111b57c666dbddc3cdac9bc0ad73e323c4d3b292bcc259fc5f5c0ac0b361fd80fc67ae3204a8a6a3e6ea88a370e598f5b4e717e321231b637

data/.gitignore

@@ -7,3 +7,65 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+# Created by https://www.gitignore.io/api/osx
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# End of https://www.gitignore.io/api/osx
+
+# Created by https://www.gitignore.io/api/osx
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# End of https://www.gitignore.io/api/osx

data/bin/console

@@ -7,8 +7,8 @@ require "oxy"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require "irb"
+# IRB.start(__FILE__)

data/lib/oxy/firebase/submission.rb

@@ -0,0 +1,2 @@
+# Submission model
+Submission = Struct.new(:email_address, :first_name, :last_name)

data/lib/oxy/firebase/submissions.rb

@@ -0,0 +1,68 @@
+require "httparty"
+
+class Submissions
+  include HTTParty
+
+  format :json
+
+  def self.find_by(email_address)
+    # fabricate lookup key based on MD5 hash of the email address
+    lookup_key = to_lookup_key(email_address)
+    # fetch response from Firebase
+    response = get("/submissions/#{lookup_key}.json", default_options)
+    # parse it into JSON
+    parse(response)
+  end
+
+  def self.find_submission(email_address)
+    # fabricate lookup key based on MD5 hash of the email address
+    lookup_key = to_lookup_key(email_address)
+    # fetch response from Firebase
+    response = get("/submissions/#{lookup_key}.json", default_options)
+    # return response's parsed body
+    response.parsed_response
+  end
+
+  def self.push(submission)
+    # fabricate lookup key based on MD5
+    lookup_key = to_lookup_key(submission["email_address"])
+    # build body
+    json_string = { "#{lookup_key}" => submission }.to_json
+    # merge options
+    options = default_options.merge(:body => json_string)
+    # push the submission entry to Firebase
+    put("/submissions.json", options)
+  end
+
+  def self.drop(email_address = nil)
+    # prepare
+    path = "/submissions"
+    # fabricate lookup key based on MD5
+    if email_address
+      lookup_key = to_lookup_key(email_address)
+      path += "/#{lookup_key}"
+    end
+    # delete the entry
+    delete("#{path}.json", default_options)
+  end
+
+private
+  def self.parse(response)
+    # yield nil if response is not parseable
+    return nil unless response && response.parsed_response
+    # parse it from JSON
+    JSON.parse(response.body, { :object_class => Submission })
+  end
+
+  def self.to_lookup_key(email_address)
+    Digest::MD5.hexdigest(email_address)
+  end
+
+  def self.default_options
+    {
+      :base_uri => ENV["FIREBASE_URL"],
+      :query => { :auth => ENV["FIREBASE_SECRET"] },
+      :headers => { "Content-Type" => "application/json" }
+    }
+  end
+end

data/lib/oxy/middleware/rsvp.rb

@@ -5,7 +5,7 @@ require "threaded"
 class Oxy::RSVP
   # The set of allowed fields. Requests that do not have fields
   # present in this list will not be eligible to be enqueued.
-  ELIGIBLE_FORMS_FIELDS = ['email_address']
+  ELIGIBLE_FORMS_FIELDS = ['email_address', 'first_name', 'last_name']
 
   # ctor.
   def initialize(app, logger = $stderr)
@@ -17,10 +17,10 @@ class Oxy::RSVP
   def call(env)
     # instantiate the request object
     req = Rack::Request.new(env)
-    if req.path == "/rsvp" && req.post? && valid_form(req.POST)
-      # enqueue the new registration request
-      Threaded.enqueue(GoogleContact, req.POST["email_address"], @logger)
-      # redirect
+    if req.path == "/rsvp" && req.post?
+      # enqueue background processing for valid submissions only
+      Threaded.enqueue(Subscribe, req.POST, @logger) if valid_form(req.POST)
+      # redirect anyways
       [302, { "Location" => "/thank-you" }, []]
     else
       @app.call(env)
@@ -30,7 +30,7 @@ class Oxy::RSVP
 private
   # only request with eligible form fields are valid
   def valid_form(form)
-    unless ELIGIBLE_FORMS_FIELDS.all? { |field| form.include?(field) }
+    unless form.all? { |key, _| ELIGIBLE_FORMS_FIELDS.include?(key) }
       @logger.write("[RSVP]: Received an invalid form ~> #{form.inspect}\n")
       return false
     end

data/lib/oxy/module/subscribe.rb

@@ -0,0 +1,9 @@
+# Very simple subscribe-alike module that uses Firebase to store the data
+class Subscribe
+  def self.call(form, logger = $stderr)
+    # push new submission
+    Submissions.push(form)
+    # log the request
+    logger.write("[Oxy::Subscribe]: #{form["email_address"]} has requested to be subscribed...\n")
+  end
+end

data/lib/oxy/version.rb

@@ -1,3 +1,3 @@
 module Oxy
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/oxy.rb

@@ -2,4 +2,6 @@ require "oxy/version"
 
 require "oxy/server"
 require "oxy/middleware/rsvp"
-require "oxy/google_contact"
+require "oxy/module/subscribe"
+require "oxy/firebase/submissions"
+require "oxy/firebase/submission"

data/oxy.gemspec

@@ -23,11 +23,11 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rack-contrib", "~> 1.2"
   spec.add_runtime_dependency "puma", "~> 3.10"
   spec.add_runtime_dependency "threaded", "~> 0.0.4"
+  spec.add_runtime_dependency "httparty", "~> 0.15.6"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "httparty"
   spec.add_development_dependency "rack-test"
 
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxy
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Pavel Tsurbeleu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2017-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: httparty
-  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: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -225,8 +225,10 @@ files:
 - bin/oxy
 - bin/setup
 - lib/oxy.rb
-- lib/oxy/google_contact.rb
+- lib/oxy/firebase/submission.rb
+- lib/oxy/firebase/submissions.rb
 - lib/oxy/middleware/rsvp.rb
+- lib/oxy/module/subscribe.rb
 - lib/oxy/server.rb
 - lib/oxy/version.rb
 - oxy.gemspec

data/lib/oxy/google_contact.rb

@@ -1,6 +0,0 @@
-# Create new contact
-class GoogleContact
-  def self.call(email_address, logger = $stderr)
-    logger.write("[GoogleContact]: #{email_address}...\n")
-  end
-end