punk 0.0.3 → 0.2.0

data/spec/actions/sessions/punk/verify_session_action_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+describe PUNK::VerifySessionAction do
+  context 'with no session provided' do
+    it 'returns a validation error' do
+      view = described_class.run.result.render(:json)
+      expect(view).to match('session is not present')
+    end
+  end
+
+  context 'with no secret provided' do
+    it 'returns a validation error' do
+      session = create(:session)
+      view = described_class.run(session: session).result.render(:json)
+      expect(view).to match('secret is not present')
+    end
+  end
+
+  context 'with an inactive session provided' do
+    it 'returns a validation error' do
+      session = create(:session)
+      view = described_class.run(session: session, secret: 'xyzzy').result.render(:json)
+      expect(view).to match('session is not in pending state')
+      expect(view).to match('session may not verify')
+    end
+  end
+
+  context 'with a pending session provided' do
+    let(:session) { create(:session) }
+
+    before do
+      allow_any_instance_of(PUNK::SecretService).to receive(:process).and_return("xyzzy") # rubocop:disable RSpec/AnyInstance
+      PUNK::ChallengeClaimService.run(session: session)
+    end
+
+    it 'returns an error if the secret is not correct' do
+      expect { described_class.run(session: session, secret: 'qwerty') }.to raise_error(PUNK::BadRequest, "Secret is incorrect")
+    end
+
+    it 'expires the session after three failed attempts' do
+      described_class.run(session: session, secret: 'qwerty') rescue nil # rubocop:disable Style/RescueModifier
+      described_class.run(session: session, secret: 'qwerty') rescue nil # rubocop:disable Style/RescueModifier
+      expect { described_class.run(session: session, secret: 'qwerty') }.to raise_error(PUNK::BadRequest, "Too many attempts")
+    end
+
+    it 'expires the session if it is more than five minutes old' do
+      Timecop.travel(5.minutes.from_now)
+      view = described_class.run(session: session, secret: 'xyzzy').result.render(:json)
+      expect(view).to match('session may not verify')
+      expect(session.expired?).to be(true)
+    end
+
+    it 'verifies the session if the secret is correct' do
+      view = described_class.run(session: session, secret: 'xyzzy').result.render(:json)
+      expect(view).to match('We have succesfully verified your identity')
+      expect(session.active?).to be(true)
+    end
+  end
+end

data/spec/actions/tenants/punk/list_tenants_action_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+describe PUNK::ListTenantsAction do
+  context 'with no user provided' do
+    it 'returns a validation error' do
+      view = described_class.run.result.render(:json)
+      expect(view).to match('user is not present')
+    end
+  end
+
+  context 'with a user provided' do
+    let(:user) { create(:user) }
+
+    before do
+      create_list(:tenant, 3)
+      3.times { create(:tenant).add_user(user) }
+    end
+
+    it 'returns tenants that the user belongs to' do
+      expect(PUNK::Tenant.count).to eq(6)
+      view = JSON.parse(described_class.run(user: user).result.render(:json))
+      expect(view.map { |h| h['id'] }.sort).to eq(user.tenants.map(&:id).sort)
+    end
+  end
+end

data/spec/actions/users/punk/list_group_users_action_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+describe PUNK::ListGroupUsersAction do
+  context 'with no group provided' do
+    it 'returns a validation error' do
+      view = described_class.run.result.render(:json)
+      expect(view).to match('group is not present')
+    end
+  end
+
+  context 'with valid arguments' do
+    let(:group) { create(:group) }
+    let(:users) { create_list(:user, 3) }
+
+    before do
+      create_list(:user, 2)
+      users.each { |user| group.add_user(user) }
+    end
+
+    it 'returns users that are members of the given group' do
+      expect(PUNK::User.count).to eq(5)
+      view = JSON.parse(described_class.run(group: group).result.render(:json))
+      expect(view.map { |h| h['id'] }.sort).to eq(group.users.map(&:id).sort)
+    end
+  end
+end

data/spec/actions/users/punk/list_tenant_users_action_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+describe PUNK::ListTenantUsersAction do
+  context 'with no tenant provided' do
+    it 'returns a validation error' do
+      view = described_class.run.result.render(:json)
+      expect(view).to match('tenant is not present')
+    end
+  end
+
+  context 'with valid arguments' do
+    let(:tenant) { create(:tenant) }
+    let(:users) { create_list(:user, 3) }
+
+    before do
+      create_list(:user, 2)
+      users.each { |user| tenant.add_user(user) }
+    end
+
+    it 'returns users that are members of the given tenant' do
+      expect(PUNK::User.count).to eq(5)
+      view = JSON.parse(described_class.run(tenant: tenant).result.render(:json))
+      expect(view.map { |h| h['id'] }.sort).to eq(tenant.users.map(&:id).sort)
+    end
+  end
+end

data/spec/factories/group.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :group, class: 'PUNK::Group' do
+    to_create(&:save)
+
+    tenant
+
+    name { Faker::Name.name }
+    icon { Faker::Internet.url }
+  end
+end

data/spec/factories/group_user_metadata.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :group_user_metadata, class: 'PUNK::GroupUserMetadata' do
+    to_create(&:save)
+
+    group
+    user
+  end
+end

data/spec/factories/identity.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :identity, class: 'PUNK::Identity' do
+    to_create(&:save)
+
+    user
+
+    claim_type { ['email', 'phone'].sample }
+    claim do
+      case claim_type
+      when 'email'
+        Faker::Internet.email
+      when 'phone'
+        generate(:phone)
+      end
+    end
+  end
+end

data/spec/factories/session.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :session, class: 'PUNK::Session' do
+    to_create(&:save)
+
+    identity
+
+    remote_addr { Faker::Internet.ip_v4_address }
+    user_agent { Faker::Internet.user_agent }
+  end
+end

data/spec/factories/tenant.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :tenant, class: 'PUNK::Tenant' do
+    to_create(&:save)
+
+    name { Faker::Name.name }
+    icon { Faker::Internet.url }
+  end
+end

data/spec/factories/tenant_user_metadata.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :tenant_user_metadata, class: 'PUNK::TenantUserMetadata' do
+    to_create(&:save)
+
+    tenant
+    user
+  end
+end

data/spec/factories/user.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user, class: 'PUNK::User' do
+    to_create(&:save)
+
+    name { Faker::Name.name }
+    icon { Faker::Internet.url }
+    email { Faker::Internet.email }
+    phone { generate(:phone) }
+  end
+end

data/spec/lib/commands/auth_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# describe 'auth', type: :feature do
+#   describe 'login command', type: :feature do
+#     it 'displays "not yet implemented"'
+#   end
+
+#   describe 'logout command', type: :feature do
+#     it 'displays "not yet implemented"'
+#   end
+# end

data/spec/lib/commands/generate_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+describe 'generate command', type: :feature do
+  context 'when no tests have been written' do
+    it 'displays "not yet implemented"'
+  end
+end

data/spec/lib/commands/http_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# describe 'http', type: :feature do
+#   describe 'GET command', type: :feature do
+#     it 'displays "not yet implemented"'
+#   end
+
+#   describe 'PATCH command', type: :feature do
+#     it 'displays "not yet implemented"'
+#   end
+
+#   describe 'POST command', type: :feature do
+#     it 'displays "not yet implemented"'
+#   end
+
+#   describe 'PUT command', type: :feature do
+#     it 'displays "not yet implemented"'
+#   end
+
+#   describe 'DELETE command', type: :feature do
+#     it 'displays "not yet implemented"'
+#   end
+# end

data/spec/lib/commands/list_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+describe 'list command', type: :feature do
+  context 'when no tests have been written' do
+    it 'displays "not yet implemented"'
+  end
+end

data/spec/lib/commands/swagger_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+describe 'swagger command', type: :feature do
+  context 'when no tests have been written' do
+    it 'displays "not yet implemented"'
+  end
+end

data/spec/lib/engine/punk_env_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe PUNK do
+  describe '.env' do
+    it 'loads environment' do
+      expect(described_class.get.trace).to eq('spec_test')
+    end
+
+    it 'loads configuration' do
+      expect(described_class.env.to_sym).to eq(:test)
+    end
+  end
+end

data/spec/lib/engine/punk_exec_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+describe PUNK do
+  describe '.exec' do
+    it 'starts the PUNK engine' do
+      expect(described_class.store.state).to eq(:started)
+    end
+  end
+end

data/spec/lib/engine/punk_init_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+describe PUNK do
+  describe '.init' do
+    it 'cannot be called twice' do
+      expect { described_class.init }.to raise_error(PUNK::InternalServerError, "Cannot call PUNK.init multiple times!")
+    end
+  end
+end

data/spec/lib/engine/punk_store_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+describe PUNK do
+  describe '.store' do
+    it 'acts like a dotted hash' do
+      described_class.store["foo"] = "bar"
+      expect(described_class.store.foo).to eq("bar")
+    end
+  end
+end

data/spec/lib/punk.env

@@ -0,0 +1,7 @@
+describe PUNK do
+  context 'env' do
+    it 'is populated' do
+      puts PUNK.get.log.to_h
+    end
+  end
+end

data/spec/models/punk/group_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+describe PUNK::Group do
+  it "is valid with valid attributes" do
+    expect { create(:group) }.not_to raise_error
+  end
+
+  it "is assigned a uuid on save" do
+    group = build(:group)
+    expect(group.id).to be_nil
+    group.save
+    expect(valid_uuid?(group.id)).to be(true)
+  end
+
+  it "can be saved with a custom uuid" do
+    uuid = generate(:uuid)
+    group = create(:group, id: uuid)
+    expect(group.id).to eq(uuid)
+  end
+
+  it "is invalid without a name" do
+    group = build(:group, name: nil)
+    expect(group.valid?).to be(false)
+    expect(group.errors[:name].first).to eq('is not present')
+  end
+
+  it "is valid without an icon" do
+    group = build(:group, icon: nil)
+    expect(group.valid?).to be(true)
+  end
+
+  it "is invalid if the icon is not a URL" do
+    group = build(:group, icon: Faker::Alphanumeric.alpha)
+    expect(group.valid?).to be(false)
+    expect(group.errors[:icon].first).to eq('is not a URL')
+  end
+
+  it "must belong to a tenant" do
+    group = build(:group, tenant: nil)
+    expect(group.valid?).to be(false)
+    expect(group.errors[:tenant].first).to eq('is not present')
+  end
+
+  it "can have multiple members" do
+    group = create(:group)
+    expect(group.users.count).to eq(0)
+    3.times { create(:user).add_group(group) }
+    expect(group.users.count).to eq(3)
+  end
+end

data/spec/models/punk/group_user_metadata_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+describe PUNK::GroupUserMetadata do
+  it "is valid with valid attributes" do
+    expect { create(:group_user_metadata) }.not_to raise_error
+  end
+
+  it "is invalid without a group" do
+    group_user_metadata = build(:group_user_metadata, group: nil)
+    expect(group_user_metadata.valid?).to be(false)
+    expect(group_user_metadata.errors[:group].first).to eq('is not present')
+  end
+
+  it "is invalid without a user" do
+    group_user_metadata = build(:group_user_metadata, user: nil)
+    expect(group_user_metadata.valid?).to be(false)
+    expect(group_user_metadata.errors[:user].first).to eq('is not present')
+  end
+
+  it "displays as the two IDs concatenated" do
+    group_user_metadata = create(:group_user_metadata)
+    expect(group_user_metadata.to_s).to include(group_user_metadata.group.id)
+    expect(group_user_metadata.to_s).to include(group_user_metadata.user.id)
+  end
+
+  context "when a user and a group exist" do
+    let(:user) { create(:user) }
+    let(:group) { create(:group) }
+
+    context "when a user is added to a group" do
+      let(:group_user_metadata) do
+        described_class[group: group, user: user]
+      end
+
+      before do
+        group.add_user(user)
+      end
+
+      it "is created automatically" do
+        expect(group_user_metadata).not_to be_nil
+        expect(group.users).to include(user)
+      end
+
+      it "destroying it will remove the user from the group" do
+        expect(group.users).to include(user)
+        group_user_metadata.destroy
+        group.reload
+        expect(group.users).not_to include(user)
+      end
+    end
+
+    context "when it is created" do
+      it "adds a user to a group" do
+        expect(group.users).not_to include(user)
+        create(:group_user_metadata, group: group, user: user)
+        group.reload
+        expect(group.users).to include(user)
+      end
+    end
+  end
+end