Skip to content

Commit

Permalink
πŸ“ chore: add .rspec file to project root directory
Browse files Browse the repository at this point in the history
πŸ“ chore: add .rubocop.yml file to project root directory

πŸ“ chore: add Gemfile to project root directory

πŸ“ feat: add Curlify class to lib/curlify.rb

πŸ“ feat: add Curlify spec to spec/curlify_spec.rb

πŸ“ chore: add spec_helper.rb to spec directory
  • Loading branch information
marcuxyz committed Aug 31, 2023
0 parents commit 41e5f4b
Show file tree
Hide file tree
Showing 7 changed files with 279 additions and 0 deletions.
1 change: 1 addition & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--require spec_helper
22 changes: 22 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
AllCops:
NewCops: enable
SuggestExtensions: false
TargetRubyVersion: 3.2.0
Exclude:
- 'spec/spec_helper.rb'

Style/Documentation:
Enabled: false

Style/FrozenStringLiteralComment:
Enabled: false

Style/ClassAndModuleChildren:
Enabled: false

Metrics/BlockLength:
Max: 120

Layout/LineLength:
Exclude:
- 'spec/curlify_spec.rb'
11 changes: 11 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# frozen_string_literal: true

source 'https://rubygems.org'

# gem "rails"

gem 'rspec', '~> 3.12', group: :test

gem 'rubocop', '~> 1.56', groups: %i[development test], require: false

gem 'byebug', '~> 11.1', groups: %i[development test]
57 changes: 57 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
GEM
remote: https://rubygems.org/
specs:
ast (2.4.2)
base64 (0.1.1)
byebug (11.1.3)
diff-lcs (1.5.0)
json (2.6.3)
language_server-protocol (3.17.0.3)
parallel (1.23.0)
parser (3.2.2.3)
ast (~> 2.4.1)
racc
racc (1.7.1)
rainbow (3.1.1)
regexp_parser (2.8.1)
rexml (3.2.6)
rspec (3.12.0)
rspec-core (~> 3.12.0)
rspec-expectations (~> 3.12.0)
rspec-mocks (~> 3.12.0)
rspec-core (3.12.2)
rspec-support (~> 3.12.0)
rspec-expectations (3.12.3)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.12.0)
rspec-mocks (3.12.6)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.12.0)
rspec-support (3.12.1)
rubocop (1.56.2)
base64 (~> 0.1.1)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
parallel (~> 1.10)
parser (>= 3.2.2.3)
rainbow (>= 2.2.2, < 4.0)
regexp_parser (>= 1.8, < 3.0)
rexml (>= 3.2.5, < 4.0)
rubocop-ast (>= 1.28.1, < 2.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 2.4.0, < 3.0)
rubocop-ast (1.29.0)
parser (>= 3.2.1.0)
ruby-progressbar (1.13.0)
unicode-display_width (2.4.2)

PLATFORMS
ruby

DEPENDENCIES
byebug (~> 11.1)
rspec (~> 3.12)
rubocop (~> 1.56)

BUNDLED WITH
2.4.9
32 changes: 32 additions & 0 deletions lib/curlify.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# frozen_string_literal: true

class Curlify
attr_reader :request, :verify, :compressed

def initialize(request, compressed: false, verify: true)
@request = request
@compressed = compressed
@verify = verify
end

def to_curl
return curl_request << ' --compressed' if compressed
return curl_request << ' --insecure' unless verify

curl_request
end

private

def curl_request
"curl -X #{request.method} #{headers} #{body} #{request.uri}"
end

def headers
request.each_header.map { |key, value| "-H '#{key}: #{value}'" }.join(' ')
end

def body
"-d #{request.body}" unless request.body.nil?
end
end
56 changes: 56 additions & 0 deletions spec/curlify_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
require 'json'
require 'uri'
require 'net/http'
require './lib/curlify'

describe Curlify do
let(:context) { described_class.new(request) }
let(:uri) { URI('http://127.0.0.1') }

describe 'must transform request into curl command' do
context '#get' do
let(:request) { Net::HTTP::Get.new(uri, { 'content-type': 'application/json' }) }

it 'should return curl command to GET request' do
expect(context.to_curl).to eq "curl -X GET -H 'content-type: application/json' -H 'accept-encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3' -H 'accept: */*' -H 'user-agent: Ruby' -H 'host: 127.0.0.1' http://127.0.0.1"
end
end

context '#post' do
let(:request) do
Net::HTTP::Post.new(uri, { 'content-type': 'application/json' })
end

before do
request.body = { name: 'John' }.to_json
end

it 'should return curl command to Post request' do
expect(context.to_curl).to eq "curl -X POST -H 'content-type: application/json' -H 'accept-encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3' -H 'accept: */*' -H 'user-agent: Ruby' -H 'host: 127.0.0.1' -d {\"name\":\"John\"} http://127.0.0.1"
end
end

context '#put' do
let(:request) { Net::HTTP::Put.new(uri, { 'content-type': 'application/json' }) }

before do
request.body = { name: 'John', userId: 1 }.to_json
end

it 'should return curl command to Put request' do
expect(context.to_curl).to eq "curl -X PUT -H 'content-type: application/json' -H 'accept-encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3' -H 'accept: */*' -H 'user-agent: Ruby' -H 'host: 127.0.0.1' -d {\"name\":\"John\",\"userId\":1} http://127.0.0.1"
end
end
context '#delete' do
let(:request) { Net::HTTP::Delete.new(uri, { 'content-type': 'application/json' }) }

before do
request.body = { userId: 1 }.to_json
end

it 'should return curl command to Delete request' do
expect(context.to_curl).to eq "curl -X DELETE -H 'content-type: application/json' -H 'accept-encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3' -H 'accept: */*' -H 'user-agent: Ruby' -H 'host: 127.0.0.1' -d {\"userId\":1} http://127.0.0.1"
end
end
end
end
100 changes: 100 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# frozen_string_literal: true

require 'byebug'

# This file was generated by the `rspec --init` command. Conventionally, all
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
# The generated `.rspec` file contains `--require spec_helper` which will cause
# this file to always be loaded, without a need to explicitly require it in any
# files.
#
# Given that it is always loaded, you are encouraged to keep this file as
# light-weight as possible. Requiring heavyweight dependencies from this file
# will add to the boot time of your test suite on EVERY test run, even for an
# individual file that may not need all of that loaded. Instead, consider making
# a separate helper file that requires the additional dependencies and performs
# the additional setup, and require it from the spec files that actually need
# it.
#
# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
RSpec.configure do |config|
# rspec-expectations config goes here. You can use an alternate
# assertion/expectation library such as wrong or the stdlib/minitest
# assertions if you prefer.
config.expect_with :rspec do |expectations|
# This option will default to `true` in RSpec 4. It makes the `description`
# and `failure_message` of custom matchers include text for helper methods
# defined using `chain`, e.g.:
# be_bigger_than(2).and_smaller_than(4).description
# # => "be bigger than 2 and smaller than 4"
# ...rather than:
# # => "be bigger than 2"
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
end

# rspec-mocks config goes here. You can use an alternate test double
# library (such as bogus or mocha) by changing the `mock_with` option here.
config.mock_with :rspec do |mocks|
# Prevents you from mocking or stubbing a method that does not exist on
# a real object. This is generally recommended, and will default to
# `true` in RSpec 4.
mocks.verify_partial_doubles = true
end

# This option will default to `:apply_to_host_groups` in RSpec 4 (and will
# have no way to turn it off -- the option exists only for backwards
# compatibility in RSpec 3). It causes shared context metadata to be
# inherited by the metadata hash of host groups and examples, rather than
# triggering implicit auto-inclusion in groups with matching metadata.
config.shared_context_metadata_behavior = :apply_to_host_groups

# The settings below are suggested to provide a good initial experience
# with RSpec, but feel free to customize to your heart's content.
# # This allows you to limit a spec run to individual examples or groups
# # you care about by tagging them with `:focus` metadata. When nothing
# # is tagged with `:focus`, all examples get run. RSpec also provides
# # aliases for `it`, `describe`, and `context` that include `:focus`
# # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
# config.filter_run_when_matching :focus
#
# # Allows RSpec to persist some state between runs in order to support
# # the `--only-failures` and `--next-failure` CLI options. We recommend
# # you configure your source control system to ignore this file.
# config.example_status_persistence_file_path = "spec/examples.txt"
#
# # Limits the available syntax to the non-monkey patched syntax that is
# # recommended. For more details, see:
# # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
# config.disable_monkey_patching!
#
# # This setting enables warnings. It's recommended, but in some cases may
# # be too noisy due to issues in dependencies.
# config.warnings = true
#
# # Many RSpec users commonly either run the entire suite or an individual
# # file, and it's useful to allow more verbose output when running an
# # individual spec file.
# if config.files_to_run.one?
# # Use the documentation formatter for detailed output,
# # unless a formatter has already been configured
# # (e.g. via a command-line flag).
# config.default_formatter = "doc"
# end
#
# # Print the 10 slowest examples and example groups at the
# # end of the spec run, to help surface which specs are running
# # particularly slow.
# config.profile_examples = 10
#
# # Run specs in random order to surface order dependencies. If you find an
# # order dependency and want to debug it, you can fix the order by providing
# # the seed, which is printed after each run.
# # --seed 1234
# config.order = :random
#
# # Seed global randomization in this process using the `--seed` CLI option.
# # Setting this allows you to use `--seed` to deterministically reproduce
# # test failures related to randomization by passing the same `--seed` value
# # as the one that triggered the failure.
# Kernel.srand config.seed
end

0 comments on commit 41e5f4b

Please sign in to comment.