Refactor merchant proposal Github issue template

- Create a new `MerchantProposal#to_osm` method to match model keys to OSM ones.
- Use JSON instead of YAML to render data as OSM keys uses ":" and YAML keys
were confused.
- Add a new description section that renders formatted content (eg: \n) and
allows easy copy/paste.
- Refactor the way proposer email is sent to the mailer to separate it from
merchant data.

Author: TrumanBlurbank

app/controllers/merchant_proposals_controller.rb

@@ -48,7 +48,10 @@ def create
       end
 
       MerchantMailer
-        .with(data: merchant_proposal_params)
+        .with(
+          data: @merchant_proposal.to_osm,
+          proposition_from: @merchant_proposal.proposition_from
+        )
         .send_new_merchant
         .deliver_later
 

app/mailers/merchant_mailer.rb

@@ -3,6 +3,7 @@ class MerchantMailer < ApplicationMailer
 
   def send_new_merchant
     @data = params[:data]
+    @proposition_from = params[:proposition_from]
 
     # Store a TXT copy version of the mail in backup waiting
     # to have a working SMTP configuration.
@@ -11,7 +12,7 @@ def send_new_merchant
       data: @data
     )
 
-    mail reply_to: @data['proposition_from']
+    mail reply_to: @proposition_from
   end
 
   def send_report_merchant

app/models/merchant_proposal.rb

@@ -68,4 +68,76 @@ def other_category_selected?
   def decorate
     MerchantProposalDecorator.new(self)
   end
+
+  # Match model attributes to OSM keys
+  def to_osm
+    model = decorate
+
+    extra_keys = {}
+    properties = {
+      name: name,
+      category: other_category_selected? ? other_category : I18n.t(category, scope: 'categories', default: category),
+      description: description&.squish
+    }
+
+    # Address and geolocation
+    properties['addr:street'] = street if street
+    properties['addr:postcode'] = postcode if postcode
+    properties['addr:city'] = city if city
+
+    if country
+      properties['addr:country'] = country
+      extra_keys['country'] = model.pretty_country(show_flag: true)
+    end
+
+    extra_keys['latitude'] = latitude if latitude
+    extra_keys['longitude'] = longitude if longitude
+
+    # Contact
+    properties[:email] = email if email
+    properties[:phone] = phone if phone
+    properties[:website] = website if website
+    properties[:opening_hours] = opening_hours if opening_hours
+
+    # Coins
+    if 'bitcoin'.in?(coins)
+      properties['currency:XBT'] = 'yes'
+      properties['payment:onchain'] = 'yes'
+    end
+
+    properties['currency:XMR'] = 'yes' if 'monero'.in?(coins)
+    properties['payment:lightning'] = 'yes' if 'lightning'.in?(coins)
+    properties['payment:lightning_contactless'] = 'yes' if 'contact_less'.in?(coins)
+    properties['payment:silver'] = 'yes' if 'silver'.in?(coins)
+    properties['payment:gold'] = 'yes' if 'gold'.in?(coins)
+
+    properties['payment:XG1'] = 'yes' if 'june'.in?(coins)
+    properties['payment:kyc'] = 'yes' if ask_kyc
+
+    # Social networks
+    properties['contact:facebook'] = contact_facebook if contact_facebook
+    properties['contact:twitter'] = contact_twitter if contact_twitter
+    properties['contact:telegram'] = contact_telegram if contact_telegram
+    properties['contact:signal'] = contact_signal if contact_signal
+    properties['contact:session'] = contact_session if contact_session
+    properties['contact:odysee'] = contact_odysee if contact_odysee
+    properties['contact:crowdbunker'] = contact_crowdbunker if contact_crowdbunker
+    properties['contact:francelibretv'] = contact_francelibretv if contact_francelibretv
+    properties['contact:tripadvisor'] = contact_tripadvisor if contact_tripadvisor
+    properties['contact:matrix'] = contact_matrix if contact_matrix
+    properties['contact:jabber'] = contact_jabber if contact_jabber
+    properties['contact:youtube'] = contact_youtube if contact_youtube
+    properties['contact:linkedin'] = contact_linkedin if contact_linkedin
+    properties['contact:instagram'] = contact_instagram if contact_instagram
+    properties['contact:tiktok'] = contact_tiktok if contact_tiktok
+
+    # Other
+    properties[:delivery] = 'yes' if delivery
+    properties[:delivery_zone] = delivery_zone if delivery_zone
+    properties['survey:date'] = last_survey_on if last_survey_on
+
+    properties[:_extra_keys] = extra_keys if extra_keys.present?
+
+    properties.as_json.compact_blank
+  end
 end

app/services/merchant_proposal_issue.rb

@@ -1,17 +1,4 @@
 class MerchantProposalIssue < ApplicationService
-  ALLOWED_ATTRIBUTES = %w[
-    name category other_category
-    street postcode city country
-    latitude longitude
-    phone website description coins ask_kyc
-    contact_facebook contact_twitter contact_telegram
-    contact_signal contact_session contact_tripadvisor
-    contact_matrix contact_jabber contact_youtube
-    contact_linkedin contact_instagram contact_tiktok
-    contact_odysee contact_crowdbunker contact_francelibretv
-    delivery delivery_zone last_survey_on
-  ].freeze
-
   attr_reader :merchant_proposal
 
   def initialize(merchant_proposal)
@@ -36,8 +23,13 @@ def body
     <<~MARKDOWN
       A new proposition for a merchant has been submitted. Please take a look and add it to OpenStreetMap if relevant:
 
-      ```yaml
-      #{attributes.compact.to_yaml}
+      ```json
+      #{JSON.pretty_generate(merchant_proposal.to_osm)}
+      ```
+
+      Description:
+      ```
+      #{merchant_proposal.description}
       ```
 
       ---
@@ -53,17 +45,4 @@ def labels
       I18n.t(I18n.locale, scope: 'languages', locale: :en)
     ]
   end
-
-  def attributes
-    hash = merchant_proposal.attributes.slice(*ALLOWED_ATTRIBUTES)
-
-    hash['category'] = if merchant_proposal.other_category_selected?
-                         merchant_proposal.other_category
-                       else
-                         I18n.t(merchant_proposal.category, scope: 'categories', default: merchant_proposal.category)
-                       end
-
-    hash['country'] = merchant_proposal.pretty_country if merchant_proposal.country.present?
-    hash
-  end
 end

app/views/merchant_mailer/send_new_merchant.html.slim

@@ -4,37 +4,7 @@ p Bonjour,
 
 p Un nouveau commerçant vient d'être proposé depuis le site. Voici les informations renseignées:
 
-ul style="background-color: #EEE; padding: 20px; border-radius: 10px"
-  - @data.each do |data|
-    - next if data.first == 'nickname'
-    - next if data.first == 'category' && @data['other_category'].present?
-
-    li
-      strong
-        = I18n.t(data.first, scope: i18n_scope)
-        |> :
-
-      - if data.first == 'ask_kyc'
-        - if data.last == 'on'
-          span style="color: red" Oui
-        - else
-          span style="color: green" Non
-      - else
-        - case data.last
-        - when '0'
-          span style="color: red"= 'Non'
-        - when '1'
-          span style="color: green"= 'Oui'
-        - else
-          - if data.first == 'coins'
-            span style="color: green"
-              = data.last.map { |coin| I18n.t(coin, scope: i18n_scope).delete_suffix(' ?') }.join(', ')
-          - elsif data.first == 'category'
-            = I18n.t(data.last, scope: 'categories')
-          - elsif data.first == 'country'
-            = pretty_country_html(data.last, show_flag: true)
-          - else
-            = data.last
+pre= JSON.pretty_generate(@data)
 
 p style="font-size: 12px; font-style: italic"
   | Ce message a été auto-généré par Rails, merci de ne pas y répondre

app/views/merchant_mailer/send_new_merchant.text.slim

@@ -5,28 +5,7 @@
 | Un nouveau commerçant vient d'être proposé depuis le site. Voici les informations renseignées:
 = "\n\n"
 
-- @data.each do |data|
-  - next if data.first == 'nickname'
-  - next if data.first == 'category' && @data['other_category'].present?
-
-  = I18n.t(data.first, scope: i18n_scope)
-  |> :
-
-  - case data.last
-  - when '0'
-    = 'Non'
-  - when '1', 'on'
-    = 'Oui'
-  - else
-    - if data.first == 'coins'
-      = data.last.map { |coin| I18n.t(coin, scope: i18n_scope).delete_suffix(' ?') }.join(', ')
-    - elsif data.first == 'category'
-      = I18n.t(data.last, scope: 'categories')
-    - elsif data.first == 'country'
-      = pretty_country_html(data.last)
-    - else
-      = data.last
-  = "\n"
+== JSON.pretty_generate(@data)
 
 = "\n\n"
 | Ce message a été auto-généré par Rails, merci de ne pas y répondre

spec/mailers/merchant_mailer_spec.rb

@@ -10,15 +10,17 @@
   describe '#send_new_merchant' do
     subject(:mail) do
       described_class
-        .with(data: merchant_data)
+        .with(
+          data: merchant_proposal.to_osm,
+          proposition_from: 'foobar@example.com'
+        )
         .send_new_merchant
     end
 
-    let(:merchant_data) do
-      {
-        name: 'Great merchant XMR',
-        proposition_from: 'foobar@example.com'
-      }.as_json
+    let(:merchant_proposal) do
+      build :merchant_proposal,
+            name: 'Great merchant XMR',
+            proposition_from: 'foobar@example.com'
     end
 
     it 'renders the headers', :aggregate_failures do

spec/mailers/previews/merchant_mailer_preview.rb

@@ -1,6 +1,6 @@
 class MerchantMailerPreview < ActionMailer::Preview
   def send_new_merchant
-    data = {
+    merchant_proposal = MerchantProposal.new(
       name: 'Carla Wolfe',
       category: 'jewelry',
       # category: 'other',
@@ -11,31 +11,36 @@ def send_new_merchant
       country: 'CH',
       latitude: '46.232192999999995',
       longitude: '2.209666999999996',
-      description: 'Eos est harum archit',
+      description: "Eos est harum archit\nMy second line",
       coins: MerchantProposal::ALLOWED_COINS,
       website: 'https://mywebsite.com',
       phone: '0102030405',
-      contact_session: 'Aut esse quis atque',
-      contact_signal: 'Eum lorem ipsum adi',
-      contact_matrix: 'Qui et ut neque quis',
-      contact_jabber: 'Nisi voluptatem Pos',
-      contact_telegram: 'Nemo Nam magna velit',
-      contact_facebook: 'Ipsa quisquam iusto',
-      contact_instagram: 'Nulla asperiores ali',
-      contact_twitter: 'Alias ut ut ipsam om',
-      contact_youtube: 'Pariatur Et qui num',
-      contact_tiktok: 'Quaerat sit libero ',
-      contact_linkedin: 'Unde quae quia quos ',
-      contact_tripadvisor: 'Architecto sit simi',
-      delivery: '0',
+      contact_session: Faker::Internet.url,
+      contact_signal: Faker::Internet.url,
+      contact_matrix: Faker::Internet.url,
+      contact_jabber: Faker::Internet.url,
+      contact_telegram: Faker::Internet.url,
+      contact_facebook: Faker::Internet.url,
+      contact_instagram: Faker::Internet.url,
+      contact_twitter: Faker::Internet.url,
+      contact_youtube: Faker::Internet.url,
+      contact_tiktok: Faker::Internet.url,
+      contact_linkedin: Faker::Internet.url,
+      contact_tripadvisor: Faker::Internet.url,
+      delivery: '1',
       delivery_zone: 'Consequatur sunt se',
       last_survey_on: '1993-03-16',
       nickname: 'Bot',
       ask_kyc: '1',
       proposition_from: 'johndoe@example.com'
-    }.as_json
+    )
 
-    MerchantMailer.with(data: data).send_new_merchant
+    MerchantMailer
+      .with(
+        data: merchant_proposal.to_osm,
+        proposition_from: 'johndoe@example.com'
+      )
+      .send_new_merchant
   end
 
   def send_report_merchant

spec/requests/merchant_proposals_spec.rb

@@ -34,15 +34,15 @@
       let(:params) do
         {
           merchant_proposal: {
-            name: 'Foobar name',
-            street: 'Foobar',
-            postcode: 'Foobar',
-            city: 'Foobar',
+            name: 'Bonhomme de Bois',
+            street: '1 Toys street',
+            postcode: '1234',
+            city: 'Toyzz',
             country: 'FR',
-            category: 'dentist',
-            description: 'Foobar description',
+            category: 'toys',
+            description: "Best toys.\nSolid.\nKids and olders.",
             coins: %w[bitcoin monero],
-            contact_odysee: 'https://www.odysee.com/JohnDoe'
+            contact_odysee: 'https://www.odysee.com/WoodToys'
           }
         }
       end
@@ -51,8 +51,40 @@
         before do
           stub_request(:post, /api.github.com/)
             .with(body: {
-              title: 'Proposal for a new merchant: `Foobar name`',
-              body: "A new proposition for a merchant has been submitted. Please take a look and add it to OpenStreetMap if relevant:\n\n```yaml\n---\nname: Foobar name\ncategory: Dentist\nstreet: Foobar\npostcode: Foobar\ncity: Foobar\ncountry: France\ndescription: Foobar description\ncoins:\n- bitcoin\n- monero\nask_kyc: false\ncontact_odysee: https://www.odysee.com/JohnDoe\ndelivery: false\n\n```\n\n---\n\n*Note: this issue has been automatically opened from bank-exit website using the Github API.*\n",
+              title: 'Proposal for a new merchant: `Bonhomme de Bois`',
+              body: <<~MARKDOWN,
+                A new proposition for a merchant has been submitted. Please take a look and add it to OpenStreetMap if relevant:
+
+                ```json
+                {
+                  "name": "Bonhomme de Bois",
+                  "category": "Toy",
+                  "description": "Best toys. Solid. Kids and olders.",
+                  "addr:street": "1 Toys street",
+                  "addr:postcode": "1234",
+                  "addr:city": "Toyzz",
+                  "addr:country": "FR",
+                  "currency:XBT": "yes",
+                  "payment:onchain": "yes",
+                  "currency:XMR": "yes",
+                  "contact:odysee": "https://www.odysee.com/WoodToys",
+                  "_extra_keys": {
+                    "country": "🇫🇷 France"
+                  }
+                }
+                ```
+
+                Description:
+                ```
+                Best toys.
+                Solid.
+                Kids and olders.
+                ```
+
+                ---
+
+                *Note: this issue has been automatically opened from bank-exit website using the Github API.*
+              MARKDOWN
               labels: %w[merchant proposal english]
             }.to_json)
         end