initial commit for bookish-server and local environment

bookish-server/renter/errors.go

@@ -0,0 +1,10 @@
+package renter
+
+import (
+	"errors"
+)
+
+var (
+	ErrNotFound      = errors.New("no renter found")
+	ErrInvalidRenter = errors.New("invalid renter provided")
+)

bookish-server/renter/renter.go

@@ -0,0 +1,45 @@
+package renter
+
+import (
+	bookish "github.com/davidlick/bookish/bookish-server"
+)
+
+// Storage defines behavior for interacting with the renter store.
+type Storage interface {
+	ListAll() (rr []bookish.Renter, err error)
+	FetchDetails(id int) (r bookish.Renter, err error)
+	New(name string, address string, email string, phoneNumber string) (id int, err error)
+}
+
+type service struct {
+	store Storage
+}
+
+// Service defines behavior for interacting with the renter service.
+type Service interface {
+	ListRenters() (rr []bookish.Renter, err error)
+	FetchRenter(id int) (r bookish.Renter, err error)
+	RegisterRenter(fullName string, address string, email string, phoneNumber string) (id int, err error)
+}
+
+// NewService creates a new renter service.
+func NewService(s Storage) *service {
+	return &service{
+		s,
+	}
+}
+
+// ListRenters returns all renters from the renter store.
+func (s *service) ListRenters() (rr []bookish.Renter, err error) {
+	return s.store.ListAll()
+}
+
+// FetchRenter returns a specific renter from the renter store.
+func (s *service) FetchRenter(id int) (r bookish.Renter, err error) {
+	return s.store.FetchDetails(id)
+}
+
+// RegisterRenter registers a new renter in the renter store.
+func (s *service) RegisterRenter(fullName string, address string, email string, phoneNumber string) (id int, err error) {
+	return s.store.New(fullName, address, email, phoneNumber)
+}

bookish-server/renter/renter_mock.go

@@ -0,0 +1,79 @@
+// Code generated by MockGen. DO NOT EDIT.
+// Source: ./renter.go
+
+// Package renter is a generated GoMock package.
+package renter
+
+import (
+	bookish_server "github.com/davidlick/bookish/bookish-server"
+	gomock "github.com/golang/mock/gomock"
+	reflect "reflect"
+)
+
+// MockStorage is a mock of Storage interface
+type MockStorage struct {
+	ctrl     *gomock.Controller
+	recorder *MockStorageMockRecorder
+}
+
+// MockStorageMockRecorder is the mock recorder for MockStorage
+type MockStorageMockRecorder struct {
+	mock *MockStorage
+}
+
+// NewMockStorage creates a new mock instance
+func NewMockStorage(ctrl *gomock.Controller) *MockStorage {
+	mock := &MockStorage{ctrl: ctrl}
+	mock.recorder = &MockStorageMockRecorder{mock}
+	return mock
+}
+
+// EXPECT returns an object that allows the caller to indicate expected use
+func (m *MockStorage) EXPECT() *MockStorageMockRecorder {
+	return m.recorder
+}
+
+// ListAll mocks base method
+func (m *MockStorage) ListAll() ([]bookish_server.Renter, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "ListAll")
+	ret0, _ := ret[0].([]bookish_server.Renter)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// ListAll indicates an expected call of ListAll
+func (mr *MockStorageMockRecorder) ListAll() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListAll", reflect.TypeOf((*MockStorage)(nil).ListAll))
+}
+
+// FetchDetails mocks base method
+func (m *MockStorage) FetchDetails(id int) (bookish_server.Renter, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "FetchDetails", id)
+	ret0, _ := ret[0].(bookish_server.Renter)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// FetchDetails indicates an expected call of FetchDetails
+func (mr *MockStorageMockRecorder) FetchDetails(id interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "FetchDetails", reflect.TypeOf((*MockStorage)(nil).FetchDetails), id)
+}
+
+// New mocks base method
+func (m *MockStorage) New(name, address, email, phoneNumber string) (int, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "New", name, address, email, phoneNumber)
+	ret0, _ := ret[0].(int)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// New indicates an expected call of New
+func (mr *MockStorageMockRecorder) New(name, address, email, phoneNumber interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "New", reflect.TypeOf((*MockStorage)(nil).New), name, address, email, phoneNumber)
+}

bookish-server/renter/renter_test.go

@@ -0,0 +1,129 @@
+package renter
+
+import (
+	"errors"
+	"testing"
+
+	bookish "github.com/davidlick/bookish/bookish-server"
+	"github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRenter_ListRenters(t *testing.T) {
+	testCases := []struct {
+		TestName string
+		Renters  []bookish.Renter
+		Error    error
+	}{
+		{
+			TestName: "success",
+			Renters: []bookish.Renter{
+				{
+					Name:        "John Doe",
+					Address:     "123 Main Way",
+					Email:       "john@doe.com",
+					PhoneNumber: "5551234567",
+				},
+				{
+					Name:        "Jack Doe",
+					Address:     "123 Elm Street",
+					Email:       "jack@doe.com",
+					PhoneNumber: "1112223333",
+				},
+			},
+		},
+		{
+			TestName: "error",
+			Error:    errors.New("test error"),
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.TestName, func(t *testing.T) {
+			ctrl := gomock.NewController(t)
+			defer ctrl.Finish()
+
+			mockStorage := NewMockStorage(ctrl)
+			mockStorage.EXPECT().ListAll().Return(tc.Renters, tc.Error)
+
+			service := NewService(mockStorage)
+			renters, err := service.ListRenters()
+
+			assert.Equal(t, tc.Renters, renters)
+			assert.Equal(t, tc.Error, err)
+		})
+	}
+}
+
+func TestRenter_FetchRenter(t *testing.T) {
+	testCases := []struct {
+		TestName string
+		ID       int
+		Renter   bookish.Renter
+		Error    error
+	}{
+		{
+			TestName: "success",
+			ID:       1,
+			Renter: bookish.Renter{
+				Name:        "John Smith",
+				Address:     "123 Main Way",
+				Email:       "john@smith.com",
+				PhoneNumber: "5551234567",
+			},
+		},
+		{
+			TestName: "error",
+			ID:       1,
+			Error:    errors.New("test error"),
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.TestName, func(t *testing.T) {
+			ctrl := gomock.NewController(t)
+			defer ctrl.Finish()
+
+			mockStorage := NewMockStorage(ctrl)
+			mockStorage.EXPECT().FetchDetails(tc.ID).Return(tc.Renter, tc.Error)
+
+			service := NewService(mockStorage)
+			renter, err := service.FetchRenter(tc.ID)
+
+			assert.Equal(t, tc.Renter, renter)
+			assert.Equal(t, tc.Error, err)
+		})
+	}
+}
+
+func TestRenter_RegisterRenter(t *testing.T) {
+	testCases := []struct {
+		TestName    string
+		Name        string
+		Address     string
+		Email       string
+		PhoneNumber string
+		ReturnID    int
+		Error       error
+	}{
+		{
+			TestName: "success",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.TestName, func(t *testing.T) {
+			ctrl := gomock.NewController(t)
+			defer ctrl.Finish()
+
+			mockStorage := NewMockStorage(ctrl)
+			mockStorage.EXPECT().New(tc.Name, tc.Address, tc.Email, tc.PhoneNumber).Return(tc.ReturnID, tc.Error)
+
+			service := NewService(mockStorage)
+			id, err := service.RegisterRenter(tc.Name, tc.Address, tc.Email, tc.PhoneNumber)
+
+			assert.Equal(t, tc.ReturnID, id)
+			assert.Equal(t, tc.Error, err)
+		})
+	}
+}