locked-rb 0.0.1

data/spec/lib/Locked/extractors/client_id_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+describe Locked::Extractors::ClientId do
+  subject(:extractor) { described_class.new(request, cookies) }
+
+  let(:client_id_cookie) { 'abcd' }
+  let(:client_id_header) { 'abcde' }
+  let(:cookies) { request.cookies }
+  let(:request) { Rack::Request.new(env) }
+  let(:env) do
+    Rack::MockRequest.env_for('/', headers)
+  end
+
+  context 'with client_id' do
+    let(:headers) do
+      {
+        'HTTP_X_FORWARDED_FOR' => '1.2.3.4',
+        'HTTP_COOKIE' => "__cid=#{client_id_cookie};other=efgh"
+      }
+    end
+
+    it do
+      expect(extractor.call).to eql(client_id_cookie)
+    end
+  end
+
+  context 'with X-Locked-Client-Id header' do
+    let(:headers) do
+      {
+        'HTTP_X_FORWARDED_FOR' => '1.2.3.4',
+        'HTTP_X_LOCKED_CLIENT_ID' => client_id_header
+      }
+    end
+
+    it 'appends the client_id' do
+      expect(extractor.call).to eql(client_id_header)
+    end
+  end
+
+  context 'when cookies undefined' do
+    let(:cookies) { nil }
+    let(:headers) { {} }
+
+    it do
+      expect(extractor.call).to eql('')
+    end
+  end
+
+  context 'with X-Locked-Client-Id header and cookies client' do
+    let(:headers) do
+      {
+        'HTTP_X_FORWARDED_FOR' => '1.2.3.4',
+        'HTTP_X_LOCKED_CLIENT_ID' => client_id_header,
+        'HTTP_COOKIE' => "__cid=#{client_id_cookie};other=efgh"
+      }
+    end
+
+    it 'appends the client_id' do
+      expect(extractor.call).to eql(client_id_header)
+    end
+  end
+end

data/spec/lib/Locked/extractors/headers_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+describe Locked::Extractors::Headers do
+  subject(:extractor) { described_class.new(request) }
+
+  let(:client_id) { 'abcd' }
+  let(:env) do
+    Rack::MockRequest.env_for('/',
+                              'HTTP_X_FORWARDED_FOR' => '1.2.3.4',
+                              'HTTP_OK' => 'OK',
+                              'TEST' => '1',
+                              'HTTP_COOKIE' => "__cid=#{client_id};other=efgh")
+  end
+  let(:request) { Rack::Request.new(env) }
+
+  describe 'extract http headers with whitelisted and blacklisted support' do
+    before do
+      Locked.config.whitelisted += ['TEST']
+    end
+    it do
+      expect(extractor.call).to eql(
+        'X-Forwarded-For' => '1.2.3.4', 'Test' => '1'
+      )
+    end
+  end
+end

data/spec/lib/Locked/extractors/ip_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+describe Locked::Extractors::IP do
+  subject(:extractor) { described_class.new(request) }
+
+  let(:request) { Rack::Request.new(env) }
+
+  describe 'ip' do
+    context 'when regular ip' do
+      let(:env) { Rack::MockRequest.env_for('/', 'HTTP_X_FORWARDED_FOR' => '1.2.3.5') }
+
+      it { expect(extractor.call).to eql('1.2.3.5') }
+    end
+
+    context 'when cf remote_ip' do
+      let(:env) do
+        Rack::MockRequest.env_for(
+          '/',
+          'HTTP_CF_CONNECTING_IP' => '1.2.3.4',
+          'HTTP_X_FORWARDED_FOR' => '1.2.3.5'
+        )
+      end
+
+      it { expect(extractor.call).to eql('1.2.3.4') }
+    end
+  end
+end

data/spec/lib/Locked/header_formatter_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+describe Locked::HeaderFormatter do
+  subject(:formatter) { described_class.new }
+
+  it 'removes HTTP_' do
+    expect(formatter.call('HTTP_X_TEST')).to be_eql('X-Test')
+  end
+
+  it 'capitalizes header' do
+    expect(formatter.call('X_TEST')).to be_eql('X-Test')
+  end
+
+  it 'ignores letter case and -_ divider' do
+    expect(formatter.call('http-X_teST')).to be_eql('X-Test')
+  end
+
+  it 'does not remove http if there is no _- char' do
+    expect(formatter.call('httpX_teST')).to be_eql('Httpx-Test')
+  end
+
+  it 'removes HTTP_' do
+    expect(formatter.call(:clearance)).to be_eql('Clearance')
+  end
+end

data/spec/lib/Locked/review_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+describe Locked::Review do
+  # before do
+  #   stub_request(:any, /locked.jp/).with(
+  #     basic_auth: ['', 'key']
+  #   ).to_return(status: 200, body: '{}', headers: {})
+  # end
+  #
+  # describe '#retrieve' do
+  #   subject(:retrieve) { described_class.retrieve(review_id) }
+  #
+  #   let(:review_id) { '1234' }
+  #
+  #   before { retrieve }
+  #
+  #   it { assert_requested :get, "https://locked.jp/api/v1/client/reviews/#{review_id}", times: 1 }
+  # end
+end

data/spec/lib/Locked/secure_mode_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+describe Locked::SecureMode do
+  it 'has signature' do
+    expect(described_class.signature('test')).to eql(
+      '02afb56304902c656fcb737cdd03de6205bb6d401da2812efd9b2d36a08af159'
+    )
+  end
+end

data/spec/lib/Locked/utils/cloner_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+describe Locked::Utils::Cloner do
+  subject(:cloner) { described_class }
+
+  describe 'call' do
+    let(:nested) { { c: '3' } }
+    let(:first) { { test: { test1: { c: '4' }, test2: nested, a: '1', b: '2' } } }
+    let(:result) { { test: { test1: { c: '4' }, test2: { c: '3' }, a: '1', b: '2' } } }
+    let(:cloned) { cloner.call(first) }
+
+    before { cloned }
+    it do
+      nested[:test] = 'sample'
+      expect(cloned).to be_eql(result)
+    end
+  end
+end

data/spec/lib/Locked/utils/merger_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe Locked::Utils::Merger do
+  subject(:merger) { described_class }
+
+  describe 'call' do
+    let(:first) { { test: { test1: { c: '4' }, test2: { c: '3' }, a: '1', b: '2' } } }
+    let(:second) { { test2: '2', test: { 'test1' => { d: '5' }, test2: '6', a: nil, b: '3' } } }
+    let(:result) { { test2: '2', test: { test1: { c: '4', d: '5' }, test2: '6', b: '3' } } }
+
+    it { expect(merger.call(first, second)).to be_eql(result) }
+  end
+end

data/spec/lib/Locked/utils/timestamp_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+describe Locked::Utils::Timestamp do
+  subject { described_class.call }
+
+  let(:time_string) { '2018-01-10T14:14:24.407Z' }
+  let(:time) { Time.parse(time_string) }
+
+  before { Timecop.freeze(time) }
+  after { Timecop.return }
+
+  describe '#call' do
+    it do
+      is_expected.to eql(time_string)
+    end
+  end
+end

data/spec/lib/Locked/utils_spec.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+describe Locked::Utils do
+  let(:nested_strings) { { 'a' => { 'b' => { 'c' => 3 } } } }
+  let(:nested_symbols) { { a: { b: { c: 3 } } } }
+  let(:nested_mixed) { { 'a' => { b: { 'c' => 3 } } } }
+  let(:string_array_of_hashes) { { 'a' => [{ 'b' => 2 }, { 'c' => 3 }, 4] } }
+  let(:symbol_array_of_hashes) { { a: [{ b: 2 }, { c: 3 }, 4] } }
+  let(:mixed_array_of_hashes) { { a: [{ b: 2 }, { 'c' => 3 }, 4] } }
+
+  describe '#deep_symbolize_keys' do
+    subject { described_class.deep_symbolize_keys(hash) }
+
+    context 'when nested_symbols' do
+      let(:hash) { nested_symbols }
+
+      it { is_expected.to eq(nested_symbols) }
+    end
+
+    context 'when nested_strings' do
+      let(:hash) { nested_strings }
+
+      it { is_expected.to eq(nested_symbols) }
+    end
+
+    context 'when nested_mixed' do
+      let(:hash) { nested_mixed }
+
+      it { is_expected.to eq(nested_symbols) }
+    end
+
+    context 'when string_array_of_hashes' do
+      let(:hash) { string_array_of_hashes }
+
+      it { is_expected.to eq(symbol_array_of_hashes) }
+    end
+
+    context 'when symbol_array_of_hashes' do
+      let(:hash) { symbol_array_of_hashes }
+
+      it { is_expected.to eq(symbol_array_of_hashes) }
+    end
+
+    context 'when mixed_array_of_hashes' do
+      let(:hash) { mixed_array_of_hashes }
+
+      it { is_expected.to eq(symbol_array_of_hashes) }
+    end
+  end
+
+  describe '#deep_symbolize_keys' do
+    subject { described_class.deep_symbolize_keys!(Locked::Utils::Cloner.call(hash)) }
+
+    context 'when nested_symbols' do
+      let(:hash) { nested_symbols }
+
+      it { is_expected.to eq(nested_symbols) }
+    end
+
+    context 'when nested_strings' do
+      let(:hash) { nested_strings }
+
+      it { is_expected.to eq(nested_symbols) }
+    end
+
+    context 'when nested_mixed' do
+      let(:hash) { nested_mixed }
+
+      it { is_expected.to eq(nested_symbols) }
+    end
+
+    context 'when string_array_of_hashes' do
+      let(:hash) { string_array_of_hashes }
+
+      it { is_expected.to eq(symbol_array_of_hashes) }
+    end
+
+    context 'when symbol_array_of_hashes' do
+      let(:hash) { symbol_array_of_hashes }
+
+      it { is_expected.to eq(symbol_array_of_hashes) }
+    end
+
+    context 'when mixed_array_of_hashes' do
+      let(:hash) { mixed_array_of_hashes }
+
+      it { is_expected.to eq(symbol_array_of_hashes) }
+    end
+  end
+
+  describe '::replace_invalid_characters' do
+    subject { described_class.replace_invalid_characters(input) }
+
+    context 'when input is a string' do
+      let(:input) { '1234' }
+
+      it { is_expected.to eq input }
+    end
+
+    context 'when input is an array' do
+      let(:input) { [1, 2, 3, '4'] }
+
+      it { is_expected.to eq input }
+    end
+
+    context 'when input is a hash' do
+      let(:input) { { user_id: 1 } }
+
+      it { is_expected.to eq input }
+    end
+
+    context 'when input is nil' do
+      let(:input) { nil }
+
+      it { is_expected.to eq input }
+    end
+
+    context 'when input is a nested hash' do
+      let(:input) { { user: { id: 1 } } }
+
+      it { is_expected.to eq input }
+    end
+
+    context 'with invalid UTF-8 characters' do
+      context 'when input is a hash' do
+        let(:input) { { user_id: "inv\xC4lid" } }
+
+        it { is_expected.to eq(user_id: 'inv�lid') }
+      end
+
+      context 'when input is a nested hash' do
+        let(:input) { { user: { id: "inv\xC4lid" } } }
+
+        it { is_expected.to eq(user: { id: 'inv�lid' }) }
+      end
+
+      context 'when input is an array of hashes' do
+        let(:input) { [{ user: "inv\xC4lid" }] * 2 }
+
+        it { is_expected.to eq([{ user: 'inv�lid' }, { user: 'inv�lid' }]) }
+      end
+
+      context 'when input is an array' do
+        let(:input) { ["inv\xC4lid"] * 2 }
+
+        it { is_expected.to eq(['inv�lid', 'inv�lid']) }
+      end
+
+      context 'when input is a hash with array in key' do
+        let(:input) { { items: ["inv\xC4lid"] * 2 } }
+
+        it { is_expected.to eq(items: ['inv�lid', 'inv�lid']) }
+      end
+    end
+  end
+end

data/spec/lib/Locked/validators/not_supported_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+describe Locked::Validators::NotSupported do
+  describe '#call' do
+    subject(:call) { described_class.call({ first: 1 }, keys) }
+
+    context 'when keys is present' do
+      let(:keys) { %i[first second] }
+
+      it do
+        expect do
+          call
+        end.to raise_error(
+          Locked::InvalidParametersError,
+          'first is/are not supported'
+        )
+      end
+    end
+
+    context 'when key is not present' do
+      let(:keys) { %i[second third] }
+
+      it { expect { call }.not_to raise_error }
+    end
+  end
+end

data/spec/lib/Locked/validators/present_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+describe Locked::Validators::Present do
+  describe '#call' do
+    subject(:call) { described_class.call({ first: 1, second: '2', invalid: '' }, keys) }
+
+    context 'when keys is not present' do
+      let(:keys) { %i[second third] }
+
+      it do
+        expect do
+          call
+        end.to raise_error(Locked::InvalidParametersError, 'third is missing or empty')
+      end
+    end
+
+    context 'when keys is empty' do
+      let(:keys) { %i[second invalid] }
+
+      it do
+        expect do
+          call
+        end.to raise_error(Locked::InvalidParametersError, 'invalid is missing or empty')
+      end
+    end
+
+    context 'when key is present' do
+      let(:keys) { %i[first second] }
+
+      it { expect { call }.not_to raise_error }
+    end
+  end
+end