DRAFT Twilio API by hectron · Pull Request #96 · happy-software/happy_house

hectron · 2019-11-04T05:44:45Z

No description provided.

This commit adds the ability to have a variety of different numbers that belong to a property. In order for someone to send an SMS/MMS to HH, they need to be configured in their proper property.

hectron · 2019-11-04T05:46:36Z

lib/happy_house/mms/actions/create_property_expense_item.rb

+          end
+        end
+
+        def perform


This assumes a message of the form:

"500.00 new door for the living room" # expenses it the moment it was texted "45.00 replaced water faucet @ 11/13" # creates an entry for 11/13/2019

This can change. This is just a first pass at what a text message could be formatted as.

If we want to change it, we can. The cool thing is that since we have specs, we don't have to do a full end-to-end test to verify the success.

hectron · 2019-11-04T05:48:40Z

app/controllers/mms_controller.rb

@@ -0,0 +1,20 @@
+class MMSController < ApplicationController
+  def process_message
+    handler = HappyHouse::MMS::Interface.handler_for(inbound_message)


The way that this works is that we set up some webhooks in a SMS/MMS provider such as Twilio or Telnyx.

Those webhooks will send JSON payloads to this endpoint. Depending on what the target number is, we can categorize them.

So we have a phone number for submitting expense reports, another for who knows what, etc.

The number that has submitted the MMS should belong to a property. Later, we can support the need for one number, multiple properties.

hectron · 2019-11-04T05:49:12Z

config/application.rb

+    # Auto-load lib
+    config.autoload_paths   << config.root.join('lib')
+    config.eager_load_paths << config.root.join('lib')


I had to keep require'ing files in the spec directory, so I just autoloaded + eager loaded the lib directory.

What's the spec directory have to do with lib?

By default, rails doesn’t load the lib directory. Even with rails_helper, I had to explicitly require the lib directory files.

These lines auto-load the lib directory on rails boot. To auto-include the lib directory in the specs, we simply have to require 'rails_helper'

hectron · 2019-11-04T05:49:53Z

lib/happy_house/mms/interface.rb

+      # @param inbound_message [HappyHouse::MMS::InboundMessage] The message to process
+      # @return [nil]
+      def self.handler_for(inbound_message)
+        case inbound_message.to


Routes the message based on who the recipient should be.

hebron-george · 2019-11-06T04:47:16Z

db/migrate/20191104045203_add_phone_numbers_to_properties.rb

@@ -0,0 +1,5 @@
+class AddPhoneNumbersToProperties < ActiveRecord::Migration[5.2]
+  def change
+    add_column :properties, :phone_numbers, :string, null: false, array: true, default: []


Seems like a weird way to add a phone number to a property. hmmm

Yeah, this is kinda funky. I didn't want to create another table for just phone numbers, but :shurg:

I think a properties_phone_numbers table might make sense.

hebron-george · 2019-11-06T04:47:37Z

dip.yml

@@ -0,0 +1,23 @@
+version: '2'


What's this file all about?

I meant to mention this! This is a dip file. Dip is a tool to work with docker-compose much easier.

hebron-george · 2019-11-06T04:49:24Z

lib/happy_house/mms/actions/create_property_expense_item.rb

+        def perform
+          raise HappyHouse::MMS::Errors::BadRequestError, errors.join(', ').capitalize unless valid?
+
+          property.expense_items.create(name:         expense_name,


I know Rails lets do you do this but I'm not a fan of model.association.create or model.association.build methods tbh

hebron-george · 2019-11-06T04:52:46Z

lib/happy_house/mms/inbound_message.rb

+# MMS providers such as Twilio.
+module HappyHouse
+  module MMS
+    class InboundMessage


So this class is responsible for parsing an inbound message?

Yeah! If we wanted to set up a new MMS provider, we just have to map what they send us to the attr_accessor that we need.

hebron-george · 2019-11-06T04:53:07Z

lib/happy_house/mms/interface.rb

+module HappyHouse
+  module MMS
+    class Interface
+      PHONE_NUMBER_FOR_EXPENSES = ENV['PHONE_NUMBER_FOR_EXPENSES'].freeze


Is this an array?

Nah, it's a single number.

hebron-george · 2019-11-09T00:47:24Z

Got a working demo you can screenshot?

hectron · 2019-11-09T14:37:20Z

db/migrate/20191104045203_add_phone_numbers_to_properties.rb

@@ -0,0 +1,5 @@
+class AddPhoneNumbersToProperties < ActiveRecord::Migration[5.2]
+  def change
+    add_column :properties, :phone_numbers, :string, null: false, array: true, default: []


Yeah, this is kinda funky. I didn't want to create another table for just phone numbers, but :shurg:

I think a properties_phone_numbers table might make sense.

hectron · 2019-11-09T14:38:05Z

lib/happy_house/mms/interface.rb

+module HappyHouse
+  module MMS
+    class Interface
+      PHONE_NUMBER_FOR_EXPENSES = ENV['PHONE_NUMBER_FOR_EXPENSES'].freeze


Nah, it's a single number.

hectron · 2019-11-09T14:41:43Z

dip.yml

@@ -0,0 +1,23 @@
+version: '2'


I meant to mention this! This is a dip file. Dip is a tool to work with docker-compose much easier.

hectron · 2019-11-09T14:43:44Z

dip.yml

+  bash:
+    service: website
+    command: '/bin/bash'
+  rake:
+    service: website
+    command: bundle exec rake
+  rails:
+    service: website
+    command: bundle exec rails
+  rspec:
+    service: website
+    command: bundle exec rspec
+  psql:


E.g. dip rspec spec/lib/<> == docker-compose run --rm website bundle exec rspec spec/lib/<>

This is basically saying -- whenever I type in dip <interaction>, actually run the command within the docker-compose service.

hectron · 2019-11-09T14:44:45Z

dip.yml

+    service: db
+    # The following is set to mirror `config/database.yml`
+    command: psql -h db -U postgres -d happy_house_development


This is awesome because if you have Postgres in a Docker container, you can simply run dip psql to get the psql console inside your postgres container.

hectron · 2019-11-09T14:46:49Z

lib/happy_house/mms/inbound_message.rb

+# MMS providers such as Twilio.
+module HappyHouse
+  module MMS
+    class InboundMessage


Yeah! If we wanted to set up a new MMS provider, we just have to map what they send us to the attr_accessor that we need.

hebron-george

Let's get it out and test it.
Looks like your last push broke some migration tests though.

Hector Rios added 6 commits November 3, 2019 23:37

Load lib directory in specs

1a94b33

Add phone numbers to Property

10625a9

This commit adds the ability to have a variety of different numbers that belong to a property. In order for someone to send an SMS/MMS to HH, they need to be configured in their proper property.

Add dip for easier docker-compose dev

deffc7f

Add MMS Interface

0720755

Expose a controller for MMS webhooks

1144501

Fix dip

bce885f

hectron commented Nov 4, 2019

View reviewed changes

hebron-george reviewed Nov 6, 2019

View reviewed changes

hectron commented Nov 9, 2019

View reviewed changes

Revert migration

790a42b

hebron-george approved these changes Nov 9, 2019

View reviewed changes

hebron-george added 2 commits January 20, 2020 13:22

Merge branch 'master' into use_twilio

59647dd

migrate before running test suite

f15d8bd

Conversation

hectron commented Nov 4, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hebron-george commented Nov 9, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hebron-george left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants