Updated Mailinator to support Private Domain #13

mattrobbins · 2018-05-23T16:33:49Z

Along with updating the gem to support the Private Domain I also updated the gem to handle the updated responses, added tests for the private domain upgrade, cleaned up a bunch of Rubocop errors and updated the documentation. This is a major change to I updated the version to 1.0.0.

Let me know if you approve or what you would like to see different.
Thanks!

…d up Rubocop errors, added CircleCI support, updated Gems and version

Add Support for Private Domain

mattrobbins · 2018-05-31T19:59:16Z

@ainformatico Can you take a look at this PR?

ainformatico · 2018-06-07T13:33:07Z

Hey @mattrobbins I've been busy these days, I'm really sorry!

I see the CI build is red, can you maybe please check why?

I will take a look to this PR before the end of this week.

ainformatico · 2018-06-10T21:25:00Z

Hi again @mattrobbins! thanks a lot for your PR, I've taken a look and I also think that it makes sense to release v1 and include some improvements such:

Remove deprecated Ruby versions support
Fix Rubocop issues
Update gems
Add the private_domain option
General coding improvements

I have created #14 and pointed your PR to that PR where I got some of your changes and also enabled some Code Analysis tools.
When I changed the destination of your branch I ran into some conflicts and had to solve them hence the new commit in your PR.

I would suggest we keep this PR only with the changed needed for the private_domain option and leave the #14 for the general changes of v1. What do you say?

ainformatico

@mattrobbins I just left some minor comments, please let me know if you need some help on applying them, for now I will focus on making the other changes needed for v1

ainformatico · 2018-06-10T21:26:38Z

.rubocop.yml

@@ -0,0 +1,40 @@
+Lint/DuplicateMethods:


I would say we can go with the default community options, so no need for this file.

Makes sense to me.

ainformatico · 2018-06-10T21:35:41Z

lib/mailinator/models/email.rb

          body: @data['data']['parts'].first['body'],
-          body_html: retrieve_body_html,


Any special reason for removing f17d5b837f674eada25fe9e3e85cf262?

It appears the JSON has been updated to no longer have separate body and body_html elements. just the 'body'

ainformatico · 2018-06-10T21:37:15Z

spec/lib/mailinator/email_spec.rb

+    expect(message.orig_from).to eq('Sender <sender@example.com>')
+    expect(message.id).to eq('1419696967-44152505-recipient')
+    expect(message.time).to eq(1_526_072_140_000)
+    expect(message.seconds_ago).to eq(15_258)
  end

  it 'should return nil for #body_html when no html body' do


If body_html needs to be removed then this test probably too.

ainformatico · 2018-06-10T21:37:58Z

spec/support/fake_web.rb

  file_path = File.join(__dir__, '../', 'fixtures/', filename)
+


Oops, my bad in the merge.

ainformatico · 2018-06-10T21:39:36Z

README.md

+inbox = Mailinator::Inbox.get('inbox-abcd1234', private_domain: true)
+```
+
+The 'download' and 'delete' work the same with private domain.


I think it's worth to also add a section where it's explained that it is possible to pass any custom option, not only private_domain.

houndci-bot · 2018-06-11T21:14:29Z

spec/support/fake_web.rb

@@ -32,3 +34,5 @@ def register_uri(url, file, method = :get)
 register_uri('http://api.mailinator.com:443/api/error?token=ABCD', 'error.response')
 register_uri('http://api.mailinator.com:443/api/delete?msgid=abcd1234&token=ABCD', 'delete.response')
 register_uri('http://api.mailinator.com:443/api/delete?msgid=1419696967-44152505-recipient&token=ABCD', 'delete.response')
+register_uri('http://api.mailinator.com:443/api/inbox?private_domain=true&to=abcd1234&token=ABCD', 'inbox_private.response')
+register_uri('http://api.mailinator.com:443/api/email?private_domain=true&msgid=1419696967-44152505-recipient&token=ABCD', 'email_private.response')


Metrics/LineLength: Line is too long. [148/80]

houndci-bot · 2018-06-11T21:14:29Z

spec/support/fake_web.rb

@@ -32,3 +34,5 @@ def register_uri(url, file, method = :get)
 register_uri('http://api.mailinator.com:443/api/error?token=ABCD', 'error.response')
 register_uri('http://api.mailinator.com:443/api/delete?msgid=abcd1234&token=ABCD', 'delete.response')
 register_uri('http://api.mailinator.com:443/api/delete?msgid=1419696967-44152505-recipient&token=ABCD', 'delete.response')
+register_uri('http://api.mailinator.com:443/api/inbox?private_domain=true&to=abcd1234&token=ABCD', 'inbox_private.response')


Metrics/LineLength: Line is too long. [124/80]

houndci-bot · 2018-06-11T21:14:29Z

spec/support/fake_web.rb

@@ -21,6 +21,8 @@ def register_uri(url, file, method = :get)
 register_uri('https://api.mailinator.com/api/error?token=ABCD', 'error.response')
 register_uri('https://api.mailinator.com/api/delete?msgid=abcd1234&token=ABCD', 'delete.response')
 register_uri('https://api.mailinator.com/api/delete?msgid=1419696967-44152505-recipient&token=ABCD', 'delete.response')
+register_uri('https://api.mailinator.com/api/inbox?private_domain=true&to=abcd1234&token=ABCD', 'inbox_private.response')
+register_uri('https://api.mailinator.com/api/email?private_domain=true&msgid=1419696967-44152505-recipient&token=ABCD', 'email_private.response')


Metrics/LineLength: Line is too long. [145/80]

houndci-bot · 2018-06-11T21:14:29Z

spec/support/fake_web.rb

@@ -21,6 +21,8 @@ def register_uri(url, file, method = :get)
 register_uri('https://api.mailinator.com/api/error?token=ABCD', 'error.response')
 register_uri('https://api.mailinator.com/api/delete?msgid=abcd1234&token=ABCD', 'delete.response')
 register_uri('https://api.mailinator.com/api/delete?msgid=1419696967-44152505-recipient&token=ABCD', 'delete.response')
+register_uri('https://api.mailinator.com/api/inbox?private_domain=true&to=abcd1234&token=ABCD', 'inbox_private.response')


Metrics/LineLength: Line is too long. [121/80]

houndci-bot · 2018-06-11T21:14:29Z

spec/support/fake_web.rb

  file_path = File.join(__dir__, '../', 'fixtures/', filename)
+


Layout/TrailingWhitespace: Trailing whitespace detected.

houndci-bot · 2018-06-11T21:14:29Z

spec/lib/mailinator/inbox_private_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Mailinator::Inbox do


Metrics/BlockLength: Block has too many lines. [29/25]

houndci-bot · 2018-06-11T21:14:30Z

spec/lib/mailinator/inbox_private_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'


Style/FrozenStringLiteralComment: Missing magic comment # frozen_string_literal: true.

houndci-bot · 2018-06-11T21:14:30Z

spec/lib/mailinator/email_spec.rb

+        expect(message.subject).to eq('This is a Subject')
+        expect(message.request_id).to eq('638363')
+        expect(message.body).to include('<p>This is a body</p>')
+        expect(message.body_base_64).to include('This is a BASE64 body JVBERi0xLjUKJe')


Metrics/LineLength: Line is too long. [87/80]

houndci-bot · 2018-06-11T21:14:30Z

spec/lib/mailinator/email_spec.rb

-        expect(message.forwards_left).to eq(10)
-        expect(message.original).to be_a(Hash)
+        expect(message.received)
+        .to include('from bmta1.example.com([9.9.9.9]) by mail.mailinator.com with SMTP (Postfix) for receipient@example.com; Fri, 11 May 2018 20:55:36 +0000 (UTC)')


Layout/MultilineMethodCallIndentation: Use 2 (not 0) spaces for indenting an expression spanning multiple lines.
Metrics/LineLength: Line is too long. [165/80]

houndci-bot · 2018-06-11T21:14:30Z

lib/mailinator/models/email.rb

@@ -7,31 +7,21 @@ module Models
    class Email < Base
      def transform_data
        {
-          id: @data['data']['id'],
+          from_full: @data['data']['fromfull'],
+          date: DateTime.parse(@data['data']['headers']['date']),


Style/DateTime: Prefer Date or Time over DateTime.

coveralls · 2018-06-11T21:16:52Z

Pull Request Test Coverage Report for Build 96

36 of 36 (100.0%) changed or added relevant lines in 3 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 100.0%

Totals
Change from base Build 94:	0.0%
Covered Lines:	149
Relevant Lines:	149

💛 - Coveralls

mattrobbins · 2018-06-20T19:13:38Z

@ainformatico That sounds good to me. Sorry I was out on vacation all week last week and still getting caught up, which is why I haven't responded sooner. Do you want me to do another PR with just the private_domain updates or just update this one to have only the PR updates?

ainformatico · 2018-06-21T16:50:29Z

@mattrobbins I started to copy your changes over to #14 and wanted to validate the new JSON provided by the API so I asked the Mailinator team for a trial token and still waiting for them to reply back. If you have a token already I would say let's use yours to get those fixtures updated (they already look updated in this very PR).
I would say we can just update this PR to have only the changes needed for the private_domain feature and tweak the couple of comments left.

mattrobbins · 2018-06-21T17:05:23Z

Ok Makes sense. I can update it to only have the private_domain feature. I do have a token as we are a paid customer. I won't be able to send you the token but I can send you the JSON's? One without the private_domain and one with. Will that work?

ainformatico · 2018-06-21T19:50:38Z

I just need the token so we can update all the fixtures, so if you can take care of that then perfect! Just remove the old fixtures and create the new ones. Don't forget to change the token from the fixtures as it is recorded in the url.

This reverts commit a5d1704.

…N options for Email

mattrobbins · 2018-06-25T22:17:05Z

@ainformatico I have updated the PR and merged the changes from you and resolved any conflicts. Looks like we are good to go. Let me know if I missed anything. Thanks!

ainformatico

Just left some cosmetic changes so we can ensure we don't have conflicts or repeated lines between branches.
I would say after these comments are addressed you can just go ahead and squash everything into a shorter list of commits that make sense or just a single commit. In case you prefer we can do it when merging by using Github's built-in button for merging with rebasing.

ainformatico · 2018-06-26T06:41:46Z

.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
 /.yardoc
+/Gemfile.lock


This change should not be needed as it's already on my branch: https://github.com/ainformatico/mailinator/blob/v1-release/.gitignore#L3

ainformatico · 2018-06-26T06:42:05Z

README.md

@@ -1,6 +1,5 @@
 [![Build Status](https://travis-ci.org/ainformatico/mailinator.svg)](https://travis-ci.org/ainformatico/mailinator)
 [![Code Climate](https://codeclimate.com/github/ainformatico/mailinator/badges/gpa.svg)](https://codeclimate.com/github/ainformatico/mailinator)
-[![Coverage Status](https://coveralls.io/repos/github/ainformatico/mailinator/badge.svg?branch=master)](https://coveralls.io/github/ainformatico/mailinator?branch=master)


This should not be removed as it has been added in the v1 branch.

ainformatico · 2018-06-26T06:43:13Z

Rakefile

@@ -7,4 +7,4 @@ RSpec::Core::RakeTask.new(:spec) do |task|
  task.rspec_opts = ['--color', '--format', 'documentation']
 end

-task default: :spec


I think this should be the good one.

ainformatico · 2018-06-26T06:43:25Z

lib/mailinator/api.rb

@@ -4,6 +4,7 @@
 require 'json'

 module Mailinator
+


Not really needed.

ainformatico · 2018-06-26T06:44:25Z

mailinator.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
  spec.version       = Mailinator::VERSION
  spec.authors       = ['Alejandro Dev.']
  spec.email         = ['aeinformatico@gmail.com']
-  spec.summary       = 'Mailinator REST API wrapper'
+  spec.summary       = %q{Mailinator REST API wrapper}


Should not be changed, I think it comes from the old Rubocop config you had.

ainformatico · 2018-06-26T06:45:27Z

spec/lib/mailinator/email_spec.rb

@@ -52,6 +50,7 @@
    let(:response) { subject.delete('abcd1234') }

    it 'deletes an email' do
+      response = Mailinator::Email.delete('abcd1234')


This should be covered by the let(:response) { subject.delete('abcd1234') } on the lines above.

ainformatico · 2018-06-26T06:46:05Z

spec/lib/mailinator/model_spec.rb

@@ -3,7 +3,8 @@
 require 'spec_helper'

 describe Mailinator::Models::Base do
-  let(:data) { { custom: :custom } }
+
+  let(:data) { {custom: :custom} }


Not really necessary change IMHO.

ainformatico · 2018-06-26T06:46:33Z

spec/support/fake_web.rb

  file_path = File.join(__dir__, '../', 'fixtures/', filename)
+


These lines should not be in this PR.

ainformatico · 2018-06-26T06:50:44Z

I think you should also merge my branch to ensure you have the latest changes.

houndci-bot · 2018-06-29T17:59:30Z

spec/lib/mailinator/model_spec.rb

@@ -3,6 +3,7 @@
 require 'spec_helper'

 describe Mailinator::Models::Base do
+


Layout/EmptyLinesAroundBlockBody: Extra empty line detected at block body beginning.

houndci-bot · 2018-06-29T17:59:30Z

lib/mailinator/api.rb

+        when 404
+          fail NotFound
+        else
+          fail RequestError, {status: response.message, code: response.code}


Style/SignalException: Always use raise to signal exceptions.
Layout/SpaceInsideHashLiteralBraces: Space inside { missing.
Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.
Layout/SpaceInsideHashLiteralBraces: Space inside } missing.

houndci-bot · 2018-06-29T17:59:30Z

lib/mailinator/api.rb

+        when 200
+          JSON.parse(response.body)
+        when 404
+          fail NotFound


Style/SignalException: Always use raise to signal exceptions.

houndci-bot · 2018-06-29T17:59:30Z

lib/mailinator/api.rb

-        raise RequestError, status: response.message, code: response.code
+        when 200
+          JSON.parse(response.body)
+        when 404


Layout/CaseIndentation: Indent when as deep as case.

houndci-bot · 2018-06-29T17:59:30Z

lib/mailinator/api.rb

-        raise NotFound
-      else
-        raise RequestError, status: response.message, code: response.code
+        when 200


Layout/CaseIndentation: Indent when as deep as case.

houndci-bot · 2018-06-29T17:59:30Z

lib/mailinator/api.rb

@@ -39,7 +39,7 @@ def generate_url(url)
    end

    def generate_params(params)
-      URI.encode_www_form(params.merge(token: token))
+      URI.encode_www_form(params.merge({token: token}))


Layout/SpaceInsideHashLiteralBraces: Space inside { missing.
Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.
Layout/SpaceInsideHashLiteralBraces: Space inside } missing.

mattrobbins · 2018-06-29T18:03:51Z

@ainformatico I made the changes requested. I appreciate the help you have given me. I think it would be easiest to do the squash with the Github button. Let me know if any other changes are needed. Thanks I am looking forward to this being complete.

mattrobbins added 6 commits May 21, 2018 16:19

updated the gem to support private domain, updated Rubocop and cleane…

721cb41

…d up Rubocop errors, added CircleCI support, updated Gems and version

Created Mailinator Gem file for 0.0.5

ea2617d

removing gem file

02f3993

Merge pull request #2 from octanner/add_private_domain_support

5e64541

Add Support for Private Domain

Bump to 1.0.0

95a6fda

cleaned up and made ready for release

a5d1704

ainformatico changed the base branch from master to v1-release June 10, 2018 21:11

Merge branch 'v1-release' into update_mailinator

af88f3e

ainformatico mentioned this pull request Jun 10, 2018

Allow other options to be passed into the inbox call #6

Closed

ainformatico suggested changes Jun 10, 2018

View reviewed changes

Merge branch 'v1-release' into update_mailinator

c659c00

houndci-bot reviewed Jun 11, 2018

View reviewed changes

ainformatico mentioned this pull request Jun 24, 2018

V1 release #14

Merged

2 tasks

mattrobbins added 9 commits June 25, 2018 10:53

Revert "cleaned up and made ready for release"

77bc008

This reverts commit a5d1704.

Reverting back to beginning to only implment the private_domain

78700b1

updated email.rb to handle private_domain

4276f73

updated inbox.rb to handle private_domain

719da0a

updated model/email.rb to the current json response

3ae5f80

updated model/entry.rb to handle private_domain

6f6030b

updated the spec and the fixtures

d69a967

merging the v! changes made

d839946

updated the README.md file with Private Domain support and update JSO…

4cba8b2

…N options for Email

ainformatico suggested changes Jun 26, 2018

View reviewed changes

mattrobbins added 2 commits June 29, 2018 11:34

Merge branch 'v1-release' into update_mailinator

512f6c6

Made the cosmetic changes suggested

750ca94

houndci-bot reviewed Jun 29, 2018

View reviewed changes

ainformatico merged commit e661b4d into ainformatico:v1-release Jul 3, 2018

		body: @data['data']['parts'].first['body'],
		body_html: retrieve_body_html,

		file_path = File.join(__dir__, '../', 'fixtures/', filename)

		@@ -0,0 +1,37 @@
		require 'spec_helper'

		describe Mailinator::Inbox do

		@@ -3,6 +3,7 @@
		require 'spec_helper'

		describe Mailinator::Models::Base do

Updated Mailinator to support Private Domain #13

Updated Mailinator to support Private Domain #13

Conversation

mattrobbins commented May 23, 2018

mattrobbins commented May 31, 2018

ainformatico commented Jun 7, 2018

ainformatico commented Jun 10, 2018

ainformatico left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Jun 11, 2018 • edited

Pull Request Test Coverage Report for Build 96

💛 - Coveralls

mattrobbins commented Jun 20, 2018

ainformatico commented Jun 21, 2018

mattrobbins commented Jun 21, 2018

ainformatico commented Jun 21, 2018

mattrobbins commented Jun 25, 2018

ainformatico left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ainformatico commented Jun 26, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattrobbins commented Jun 29, 2018

coveralls commented Jun 11, 2018 •

edited