Create requests, with specs!

maxhollmann · maxhollmann · commit 4cd924f56808 · 2020-05-01T18:53:07.000+02:00
diff --git a/.env.test b/.env.test
@@ -0,0 +1,5 @@
+DATABASE_URL=postgres://podify:FJJuo5onaohF8rp@localhost/podify_test
+
+HOST=localhost
+PORT=3000
+SSL=no
diff --git a/.gitignore b/.gitignore
@@ -27,3 +27,4 @@
 yarn-debug.log*
 .yarn-integrity
 /.env.*.local
+/spec/examples.txt
diff --git a/.rspec b/.rspec
@@ -0,0 +1 @@
+--require spec_helper
diff --git a/Gemfile b/Gemfile
@@ -48,6 +48,10 @@ group :development, :test do
   gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
   gem 'pry-rails'
   gem 'amazing_print'
+
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'factory_bot_rails'
 end
 
 group :development do
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -84,6 +84,7 @@ GEM
       responders
       warden (~> 1.2.3)
     devise-bootstrap-views (1.1.0)
+    diff-lcs (1.3)
     dotenv (2.7.5)
     dotenv-rails (2.7.5)
       dotenv (= 2.7.5)
@@ -163,6 +164,11 @@ GEM
       dry-inflector (~> 0.1)
       tilt (~> 2.0, >= 2.0.6)
     erubi (1.9.0)
+    factory_bot (5.2.0)
+      activesupport (>= 4.2.0)
+    factory_bot_rails (5.2.0)
+      factory_bot (~> 5.2.0)
+      railties (>= 4.2.0)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     ffi (1.12.2)
@@ -260,6 +266,27 @@ GEM
     responders (3.0.0)
       actionpack (>= 5.0)
       railties (>= 5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (4.0.0)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.9)
+      rspec-expectations (~> 3.9)
+      rspec-mocks (~> 3.9)
+      rspec-support (~> 3.9)
+    rspec-support (3.9.2)
     ruby_dep (1.5.0)
     sass-rails (6.0.0)
       sassc-rails (~> 2.1, >= 2.1.1)
@@ -345,6 +372,7 @@ DEPENDENCIES
   dry-monads
   dry-rails
   dry-view
+  factory_bot_rails
   jbuilder (~> 2.7)
   letter_opener
   listen (>= 3.0.5, < 3.2)
@@ -355,6 +383,8 @@ DEPENDENCIES
   pry-rails
   puma (~> 4.1)
   rails (~> 6.0.2, >= 6.0.2.2)
+  rspec
+  rspec-rails
   sass-rails (>= 6)
   sentry-raven
   sequel-devise
diff --git a/config/routes.rb b/config/routes.rb
@@ -4,7 +4,9 @@
   root to: 'sources#index'
   devise_for :user, class_name: 'DeviseUser'
 
-  resources :sources, only: %i[index show create] do
+  resources :requests, only: %i[create]
+
+  resources :sources, only: %i[index show] do
     resources :downloads, only: [] do
       member do
         get 'download', action: :serve, as: :serve
diff --git a/lib/events/publisher.rb b/lib/events/publisher.rb
@@ -2,6 +2,9 @@ module Events
   class Publisher
     include Dry::Events::Publisher[:podify]
 
+    register_event('requests.created')
+    register_event('requests.destroyed')
+
     register_event('sources.created')
     register_event('sources.destroyed')
 
diff --git a/lib/requests/contract.rb b/lib/requests/contract.rb
@@ -0,0 +1,8 @@
+module Requests
+  class Contract < ApplicationContract
+    params do
+      required(:user_id).value(:integer)
+      required(:source_id).value(:integer)
+    end
+  end
+end
diff --git a/lib/requests/create.rb b/lib/requests/create.rb
@@ -0,0 +1,18 @@
+module Requests
+  class Create
+    include Dry::Monads[:result, :do]
+
+    include Podify::Import['events', 'requests.contract']
+
+    def call(attrs)
+      attrs = yield(contract.call(attrs).to_monad).to_h
+      request = yield create_request(attrs)
+      events.publish('requests.created', request: request)
+      Success(request)
+    end
+
+    def create_request(attrs)
+      Success(Request.create(attrs))
+    end
+  end
+end
diff --git a/lib/requests/create_for_url.rb b/lib/requests/create_for_url.rb
@@ -0,0 +1,18 @@
+module Requests
+  class CreateForUrl
+    include Dry::Monads[:result, :do, :maybe]
+
+    include Podify::Import[
+      create_request: 'requests.create',
+      find_or_create_source: 'sources.find_or_create',
+    ]
+
+    def call(user:, url:)
+      DB.transaction do
+        source = yield find_or_create_source.call(url)
+        request = yield create_request.call(user_id: user.id, source_id: source.id)
+        Success(request)
+      end
+    end
+  end
+end
diff --git a/lib/sources/find_or_create.rb b/lib/sources/find_or_create.rb
@@ -0,0 +1,20 @@
+module Sources
+  class FindOrCreate
+    include Dry::Monads[:result, :do, :maybe]
+
+    include Podify::Import[
+      'sources.create',
+    ]
+
+    def call(url)
+      find(url).or do
+        source = yield create.call(url: url)
+        Success(source)
+      end
+    end
+
+    def find(url)
+      Maybe(Source.by_url(url).first)
+    end
+  end
+end
diff --git a/lib/sources/import_file.rb b/lib/sources/import_file.rb
@@ -4,7 +4,7 @@ class ImportFile
 
     include Podify::Import[
       'expand_path',
-      create_source: 'sources.create',
+      find_or_create_source: 'sources.find_or_create',
     ]
 
     def call(path)
@@ -22,15 +22,8 @@ def assert_file(path)
     end
 
     def get_source(path)
-      url = "file://#{path}"
-      find_existing_source(url).or do
-        source = yield create_source.call(url: url)
-        Success(source)
-      end
-    end
-
-    def find_existing_source(url)
-      Maybe(Source.by_url(url).first)
+      source = yield find_or_create_source.call("file://#{path}")
+      Success(source)
     end
   end
 end
diff --git a/spec/factories/sources.rb b/spec/factories/sources.rb
@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :source do
+    url { generate(:url) }
+  end
+
+  sequence :url do |n|
+    "https://youtube.com/watch?v=#{n}"
+  end
+end
diff --git a/spec/factories/users.rb b/spec/factories/users.rb
@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :user do
+    email { generate(:email) }
+  end
+
+  sequence :email do |n|
+    "#{n}@example.com"
+  end
+end
diff --git a/spec/fixtures/files/example.mp4 b/spec/fixtures/files/example.mp4
@@ -0,0 +1 @@
+dummy mp4
diff --git a/spec/integration/lib/requests/create_for_url_spec.rb b/spec/integration/lib/requests/create_for_url_spec.rb
@@ -0,0 +1,35 @@
+require 'rails_helper'
+
+RSpec.describe Requests::CreateForUrl do
+  let(:url) { 'https://example.com/some-video' }
+  let(:user) { create(:user) }
+
+  let(:result) { subject.call(user: user, url: url) }
+  let(:request) { result.value! }
+
+  context 'when a source with the url does not exist yet' do
+    it 'creates a source and request' do
+      expect { result }
+        .to change(Source, :count).by(1)
+        .and change(Request, :count).by(1)
+      expect(result).to be_success
+      expect(request.source.url).to eq(url)
+      expect(request.user).to eq(user)
+    end
+  end
+
+  context 'when a source with the url already exists' do
+    before do
+      create(:source, url: url)
+    end
+
+    it 'creates the request' do
+      expect { result }
+        .to change(Source, :count).by(0)
+        .and change(Request, :count).by(1)
+      expect(result).to be_success
+      expect(request.source.url).to eq(url)
+      expect(request.user).to eq(user)
+    end
+  end
+end
diff --git a/spec/integration/lib/sources/import_file_spec.rb b/spec/integration/lib/sources/import_file_spec.rb
@@ -0,0 +1,26 @@
+require 'rails_helper'
+
+RSpec.describe Sources::ImportFile do
+  let(:path) { file_fixture('example.mp4') }
+  let(:result) { subject.call(path) }
+
+  context 'when a source with the file does not exist yet' do
+    it 'creates a source' do
+      expect { result }.to change(Source, :count).by(1)
+      expect(result).to be_success
+      expect(result.value!.url).to eq("file://#{path.expand_path.realpath}")
+    end
+  end
+
+  context 'when a source with the file already exists' do
+    before do
+      subject.call(path)
+    end
+
+    it 'returns the source' do
+      expect { result }.not_to change(Source, :count)
+      expect(result).to be_success
+      expect(result.value!.url).to eq("file://#{path.expand_path.realpath}")
+    end
+  end
+end
diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb
@@ -0,0 +1,65 @@
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../config/environment', __dir__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each { |f| require f }
+
+FactoryBot.define do
+  to_create(&:save)
+end
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+
+
+  # Remove this line to enable support for ActiveRecord
+  config.use_active_record = false
+
+  config.around(:each) do |example|
+    DB.transaction(rollback: :always, auto_savepoint: true) { example.run }
+  end
+
+  # If you enable ActiveRecord support you should unncomment these lines,
+  # note if you'd prefer not to run each example within a transaction, you
+  # should set use_transactional_fixtures to false.
+  #
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  # config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, type: :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
