Conversation
I also converted the application from an API only to a regular rails app, assuming that a backend challenge would also be ok without the heavy frontend work needed to use an API.
The command was
rails new backend-challenge
That overrides the existing files and adds the missing ones to have a regular frontend + backend rails app.
Substitute default rails welcome page
We are already testing the behavior on the members controller spec but still...
Devise already tests the authenticate_member! method we are using so we don't need to test it again
It will handle the authentication The code is the result of running rails generate devise:install rails generate devise Member
Our .rspec file already requires the spec_helper on every spec file so move all the test config there to avoid having to require it on every file individually
It provides a classless styles, so good defaults with minimal changes to the markup
I went with sucker punch and not Sidekiq to avoid adding the broker dependency(again, Redis) and to allow easy testing for the reviewer
It will be used to store the member headings
We will be accessing urls so we need a way to record the results to have a completely offline test suite
This job will pull the headings for a member to be called after the member creation
We need to override the Devise controller to be able to access the newly created member
Part of the requirements, i used my own personal url shortner chiq.me
This class will help us explore the connections between members to find connecting paths between them.
This class will return those friend of a friend with maybe shared interests that a member can connect with.
We will need other column to display the potential friends search
The fuzzystrmatch module provides several functions to determine similarities and distance between strings, helpful for our search feature.
Generally application.css only imports others
Merged
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
| # so we can query it about those relationships and build connections | ||
| class MembersSocialGraph | ||
| def initialize | ||
| @members = Member.all |
There was a problem hiding this comment.
Fetching all members in initialize may become a performance bottleneck on large datasets since the graph is rebuilt on every search.
| end | ||
| end | ||
|
|
||
| context 'some members have headings that are a substring o the query' do |
There was a problem hiding this comment.
Typo in context description: 'a substring o the query' should be 'a substring of the query'
| include_examples 'successful search' | ||
| end | ||
|
|
||
| context 'some members have headings that are sound very to the query' do |
There was a problem hiding this comment.
Grammatical error in context description: 'are sound very to the query' is incorrect
| returned_member = subject.first | ||
|
|
||
| expect(returned_member.path_to_other_member).to be_present | ||
| expect(returned_member.path_to_other_member).to eql [ |
There was a problem hiding this comment.
Test doesn't verify the actual path-finding functionality, only that a path exists
|
|
||
| shared_examples 'successful search' do | ||
| it 'returns the friend of a friend interested in dog breeding' do | ||
| expect(subject).to eql [friend_of_friend] |
There was a problem hiding this comment.
All three matching strategies use identical test assertions without verifying specific matching behavior
| let(:personal_website_url) { 'https://www.joshwcomeau.com/' } | ||
| let(:member) { create(:member, personal_website_url: personal_website_url) } | ||
| let(:vcr_mode) { :new_episodes } # :all, :none, :new_episodes | ||
| let(:vcr_cassette) { :successfull_url_shortner_job } |
There was a problem hiding this comment.
Rule violated: Avoid Logging Sensitive Information
VCR cassette will record sensitive API credentials
| uri: http://chiq.me/ | ||
| body: | ||
| encoding: US-ASCII | ||
| string: password=ik3%7Dcj6WoQLxKvFbMNnnUu7bq&url=https%3A%2F%2Fwww.joshwcomeau.com%2F |
There was a problem hiding this comment.
Rule violated: Avoid Logging Sensitive Information
Password exposed in VCR cassette
| # Fetch Request | ||
| res = http.request(req) | ||
| res | ||
| rescue StandardError => e |
There was a problem hiding this comment.
Rule violated: Avoid Logging Sensitive Information
Error logging might expose sensitive information including API credentials
| name: 'Josh Comeau', | ||
| email: 'hello@joshwcomeau.com', | ||
| personal_website_url: 'https://www.joshwcomeau.com/', | ||
| password: '123456', |
There was a problem hiding this comment.
Rule violated: Avoid Logging Sensitive Information
Test contains hardcoded password credentials
| last_name: 'Metz', | ||
| url: 'http://www.example.com' | ||
| name: 'Josh Comeau', | ||
| email: 'hello@joshwcomeau.com', |
There was a problem hiding this comment.
Rule violated: Avoid Logging Sensitive Information
Test exposes real email address which may be logged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR includes all the code of the original PR and the missing requirement:
Technical decisions
I solved it building a Graph each time a search for potential friends is performed, we could easily cache that graph and just update its connections each time a friendship is made. But for now it should be a good example of the bread first search algorithm used to find the shortest path between two nodes.