id
int64
0
843k
repository_name
stringlengths
7
55
file_path
stringlengths
9
332
class_name
stringlengths
3
290
human_written_code
stringlengths
12
4.36M
class_skeleton
stringlengths
19
2.2M
total_program_units
int64
1
9.57k
total_doc_str
int64
0
4.2k
AvgCountLine
float64
0
7.89k
AvgCountLineBlank
float64
0
300
AvgCountLineCode
float64
0
7.89k
AvgCountLineComment
float64
0
7.89k
AvgCyclomatic
float64
0
130
CommentToCodeRatio
float64
0
176
CountClassBase
float64
0
48
CountClassCoupled
float64
0
589
CountClassCoupledModified
float64
0
581
CountClassDerived
float64
0
5.37k
CountDeclInstanceMethod
float64
0
4.2k
CountDeclInstanceVariable
float64
0
299
CountDeclMethod
float64
0
4.2k
CountDeclMethodAll
float64
0
4.2k
CountLine
float64
1
115k
CountLineBlank
float64
0
9.01k
CountLineCode
float64
0
94.4k
CountLineCodeDecl
float64
0
46.1k
CountLineCodeExe
float64
0
91.3k
CountLineComment
float64
0
27k
CountStmt
float64
1
93.2k
CountStmtDecl
float64
0
46.1k
CountStmtExe
float64
0
90.2k
MaxCyclomatic
float64
0
759
MaxInheritanceTree
float64
0
16
MaxNesting
float64
0
34
SumCyclomatic
float64
0
6k
6,100
Aplopio/django_rip
/Users/umroot/Documents/PhD_works/PhD-Core-Contents/Class-level-dataset-curation/data/git_repos_for_analysis/Aplopio_django_rip/tests/unit_tests/crud/test_crud_pipeline_factory.py
tests.unit_tests.crud.test_crud_pipeline_factory.TestCrudPipelineFactory
class TestCrudPipelineFactory(unittest.TestCase): @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_read_list_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): entity_actions = MagicMock() entity_actions.read_list = read_list = MagicMock() authentication = MagicMock() authentication.authenticate = MagicMock() authorization = MagicMock() authorization \ .add_read_list_filters = add_read_list_filters = MagicMock() request_params_validation = MagicMock() request_params_validation \ .validate_request_params = validate_request_params = \ MagicMock() cleaner = MagicMock() cleaner.clean_data_for_read_list = \ clean_data_for_read_list = MagicMock() serializer = MagicMock() serializer.serialize_list = \ serialize_list = MagicMock() response_converter = MagicMock() response_converter.convert_serialized_data_to_response = \ convert_serialized_data_to_response = MagicMock() post_action_hooks = MagicMock() post_action_hooks.read_list_hook = read_list_hook = MagicMock() compose_pipeline.return_value = expected_pipeline = MagicMock() configuration = { 'entity_actions': entity_actions, 'authentication': authentication, 'request_params_validation': request_params_validation, 'authorization': authorization, 'serializer': serializer, 'data_cleaner': cleaner, 'response_converter': response_converter, 'post_action_hooks': post_action_hooks } pipeline = crud_pipeline_factory.read_list_pipeline(configuration) assert_that(pipeline, equal_to(expected_pipeline)) compose_pipeline.assert_called_once_with( name=CrudActions.READ_LIST, pipeline=[ authentication.authenticate, validate_request_params, clean_data_for_read_list, add_read_list_filters, read_list, serialize_list, read_list_hook, convert_serialized_data_to_response ]) @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_read_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): entity_actions = MagicMock() entity_actions.read_detail = read_detail = MagicMock() authentication = MagicMock() authentication.authenticate = MagicMock() authorization = MagicMock() authorization \ .authorize_read_detail = authorize_read_detail = MagicMock() cleaner = MagicMock() cleaner.clean_data_for_read_detail = \ clean_data_for_read_detail = MagicMock() serializer = MagicMock() serializer.serialize_detail = serialize_detail = MagicMock() response_converter = MagicMock() response_converter.convert_serialized_data_to_response = \ convert_serialized_data_to_response = MagicMock() post_action_hooks = MagicMock() post_action_hooks.read_detail_hook = read_detail_hook = MagicMock() compose_pipeline.return_value = expected_pipeline = MagicMock() configuration = { 'entity_actions': entity_actions, 'authentication': authentication, 'authorization': authorization, 'serializer': serializer, 'data_cleaner': cleaner, 'response_converter': response_converter, 'post_action_hooks': post_action_hooks } pipeline = crud_pipeline_factory.read_detail_pipeline(configuration) assert_that(pipeline, equal_to(expected_pipeline)) compose_pipeline.assert_called_once_with( name=CrudActions.READ_DETAIL, pipeline=[ authentication.authenticate, clean_data_for_read_detail, read_detail, authorize_read_detail, serialize_detail, read_detail_hook, convert_serialized_data_to_response ]) @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_delete_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): entity_actions = MagicMock() entity_actions.delete_detail = delete_detail = MagicMock() entity_actions.read_detail = read_detail = MagicMock() authentication = MagicMock() authentication.authenticate = MagicMock() authorization = MagicMock() authorization \ .authorize_delete_detail = authorize_delete_detail = MagicMock() cleaner = MagicMock() cleaner.clean_data_for_delete_detail = \ clean_data_for_delete_detail = MagicMock() response_converter = MagicMock() post_action_hooks = MagicMock() post_action_hooks.delete_detail_hook = delete_detail_hook = MagicMock() response_converter.convert_to_simple_response = \ convert_to_simple_response = MagicMock() compose_pipeline.return_value = expected_pipeline = MagicMock() configuration = { 'entity_actions': entity_actions, 'authentication': authentication, 'authorization': authorization, 'data_cleaner': cleaner, 'response_converter': response_converter, 'post_action_hooks': post_action_hooks } pipeline = crud_pipeline_factory.delete_detail_pipeline(configuration) assert_that(pipeline, equal_to(expected_pipeline)) compose_pipeline.assert_called_once_with( name=CrudActions.DELETE_DETAIL, pipeline=[ authentication.authenticate, clean_data_for_delete_detail, read_detail, authorize_delete_detail, delete_detail, delete_detail_hook, convert_to_simple_response ]) @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_update_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): entity_actions = MagicMock() entity_actions.read_detail = read_detail = MagicMock() entity_actions.update_detail = update_detail = MagicMock() authentication = MagicMock() authorization = MagicMock() authorization.authorize_update_detail = \ authorize_update_detail = MagicMock() schema_validation = MagicMock() schema_validation.validate_request_data = \ validate_request_data = MagicMock() schema = MagicMock() serializer = MagicMock() serializer.serialize_detail = serialize_detail = MagicMock() serializer.serialize_detail_pre_update = serialize_detail_pre_update = \ MagicMock() data_cleaner = MagicMock() data_cleaner.clean_data_for_update_detail = \ clean_data_for_update_detail = MagicMock() data_cleaner.clean_data_for_read_detail = \ clean_data_for_read_detail = MagicMock() post_action_hooks = MagicMock() post_action_hooks.update_detail_hook = update_detail_hook = MagicMock() response_converter = MagicMock() response_converter.convert_serialized_data_to_response = \ convert_serialized_data_to_response = MagicMock() configuration = { 'entity_actions': entity_actions, 'authentication': authentication, 'authorization': authorization, 'schema': schema, 'schema_validation': schema_validation, 'serializer': serializer, 'data_cleaner': data_cleaner, 'post_action_hooks': post_action_hooks, 'response_converter': response_converter } compose_pipeline.return_value = expected_pipeline = MagicMock() pipeline = crud_pipeline_factory.update_detail_pipeline(configuration) assert_that(pipeline, equal_to(expected_pipeline)) compose_pipeline.assert_called_once_with( name=CrudActions.UPDATE_DETAIL, pipeline=[ authentication.authenticate, clean_data_for_read_detail, clean_data_for_update_detail, validate_request_data, read_detail, authorize_update_detail, serialize_detail_pre_update, update_detail, serialize_detail, update_detail_hook, convert_serialized_data_to_response]) @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_create_or_update_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): entity_actions = MagicMock() entity_actions.read_detail = read_detail = MagicMock() entity_actions.update_detail = update_detail = MagicMock() authentication = MagicMock() authorization = MagicMock() authorization.authorize_update_detail = \ authorize_update_detail = MagicMock() schema_validation = MagicMock() schema_validation.validate_request_data = \ validate_request_data = MagicMock() schema = MagicMock() serializer = MagicMock() serializer.serialize_detail = serialize_detail = MagicMock() serializer.serialize_detail_pre_update = serialize_detail_pre_update = \ MagicMock() data_cleaner = MagicMock() data_cleaner.clean_data_for_update_detail = \ clean_data_for_update_detail = MagicMock() data_cleaner.clean_data_for_read_detail = \ clean_data_for_read_detail = MagicMock() post_action_hooks = MagicMock() post_action_hooks.update_detail_hook = update_detail_hook = MagicMock() response_converter = MagicMock() response_converter.convert_serialized_data_to_response = \ convert_serialized_data_to_response = MagicMock() configuration = { 'entity_actions': entity_actions, 'authentication': authentication, 'authorization': authorization, 'schema': schema, 'schema_validation': schema_validation, 'serializer': serializer, 'data_cleaner': data_cleaner, 'post_action_hooks': post_action_hooks, 'response_converter': response_converter } compose_pipeline.return_value = expected_pipeline = MagicMock() pipeline = crud_pipeline_factory.create_or_update_detail_pipeline( configuration) assert_that(pipeline, equal_to(expected_pipeline)) compose_pipeline.assert_called_once_with( name=CrudActions.CREATE_OR_UPDATE_DETAIL, pipeline=[ authentication.authenticate, clean_data_for_read_detail, clean_data_for_update_detail, validate_request_data, read_detail, authorize_update_detail, serialize_detail_pre_update, update_detail, serialize_detail, update_detail_hook, convert_serialized_data_to_response]) @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_create_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): entity_actions = MagicMock() entity_actions.create_detail = create_detail = MagicMock() authentication = MagicMock() authentication.authenticate = MagicMock() authorization = MagicMock() authorization.authorize_create_detail = \ authorize_create_detail = MagicMock() schema_validation = MagicMock() schema_validation.validate_request_data = \ validate_request_data = MagicMock() schema = MagicMock() serializer = MagicMock() serializer.serialize_detail = serialize_detail = MagicMock() data_cleaner = MagicMock() data_cleaner.clean_data_for_create_detail = \ clean_data_for_create_detail = MagicMock() post_action_hooks = MagicMock() post_action_hooks.create_detail_hook = create_detail_hook = MagicMock() response_converter = MagicMock() response_converter.convert_serialized_data_to_response = \ convert_serialized_data_to_response = MagicMock() configuration = { 'entity_actions': entity_actions, 'authentication': authentication, 'authorization': authorization, 'schema': schema, 'schema_validation': schema_validation, 'serializer': serializer, 'data_cleaner': data_cleaner, 'post_action_hooks': post_action_hooks, 'response_converter': response_converter } compose_pipeline.return_value = expected_pipeline = MagicMock() pipeline = crud_pipeline_factory.create_detail_pipeline(configuration) assert_that(pipeline, equal_to(expected_pipeline)) compose_pipeline.assert_called_once_with( name=CrudActions.CREATE_DETAIL, pipeline=[ authentication.authenticate, clean_data_for_create_detail, validate_request_data, authorize_create_detail, create_detail, serialize_detail, create_detail_hook, convert_serialized_data_to_response ]) @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_get_aggregates_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): entity_actions = MagicMock() entity_actions.get_aggregates = get_aggregates = MagicMock() authentication = MagicMock() authentication.authenticate = MagicMock() authorization = MagicMock() authorization \ .add_read_list_filters = add_read_list_filters = MagicMock() request_params_validation = MagicMock() request_params_validation \ .validate_request_params = validate_request_params = \ MagicMock() cleaner = MagicMock() cleaner.clean_data_for_get_aggregates = \ clean_data_for_get_aggregates = MagicMock() serializer = MagicMock() serializer.serialize_entity_aggregates = \ serialize_entity_aggregates = MagicMock() response_converter = MagicMock() response_converter.convert_serialized_data_to_response = \ convert_serialized_data_to_response = MagicMock() post_action_hooks = MagicMock() post_action_hooks \ .get_aggregates_hook = get_aggregates_hook = MagicMock() compose_pipeline.return_value = expected_pipeline = MagicMock() configuration = { 'entity_actions': entity_actions, 'authentication': authentication, 'request_params_validation': request_params_validation, 'authorization': authorization, 'serializer': serializer, 'data_cleaner': cleaner, 'response_converter': response_converter, 'post_action_hooks': post_action_hooks } pipeline = crud_pipeline_factory.get_aggregates_pipeline(configuration) assert_that(pipeline, equal_to(expected_pipeline)) compose_pipeline.assert_called_once_with( name=CrudActions.GET_AGGREGATES, pipeline=[ authentication.authenticate, validate_request_params, clean_data_for_get_aggregates, add_read_list_filters, get_aggregates, serialize_entity_aggregates, get_aggregates_hook, convert_serialized_data_to_response ])
class TestCrudPipelineFactory(unittest.TestCase): @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_read_list_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): pass @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_read_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): pass @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_delete_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): pass @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_update_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): pass @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_create_or_update_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): pass @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_create_detail_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): pass @mock_patch.object(pipeline_composer, 'compose_pipeline') def test_get_aggregates_pipeline_has_all_steps_in_the_right_order( self, compose_pipeline): pass
15
0
53
3
49
0
1
0
1
1
1
0
7
0
7
79
384
30
354
158
326
0
157
78
149
1
2
0
7
6,101
Aplopio/django_rip
/Users/umroot/Documents/PhD_works/PhD-Core-Contents/Class-level-dataset-curation/data/git_repos_for_analysis/Aplopio_django_rip/tests/unit_tests/crud/test_crud_resource.py
tests.unit_tests.crud.test_crud_resource.TestCrudResourceConstruction.setUp.TestSchema
class TestSchema(ApiSchema): name = StringField(max_length=32) boolean = BooleanField()
class TestSchema(ApiSchema): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
7
3
0
3
3
2
0
3
3
2
0
2
0
0
6,102
Aplopio/django_rip
/Users/umroot/Documents/PhD_works/PhD-Core-Contents/Class-level-dataset-curation/data/git_repos_for_analysis/Aplopio_django_rip/tests/unit_tests/crud/test_crud_resource.py
tests.unit_tests.crud.test_crud_resource.TestCrudResourceConstruction.test_create_detail.DefaultTestResource
class DefaultTestResource(CrudResource): schema_cls = self.schema authentication_cls = custom_auth allowed_actions = [CrudActions.CREATE_DETAIL]
class DefaultTestResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
4
0
4
4
3
0
4
4
3
0
2
0
0
6,103
Aplopio/django_rip
/Users/umroot/Documents/PhD_works/PhD-Core-Contents/Class-level-dataset-curation/data/git_repos_for_analysis/Aplopio_django_rip/tests/unit_tests/crud/test_crud_resource.py
tests.unit_tests.crud.test_crud_resource.TestCrudResourceConstruction.test_create_or_update_detail.DefaultTestResource
class DefaultTestResource(CrudResource): schema_cls = self.schema authentication_cls = MagicMock() allowed_actions = [CrudActions.CREATE_OR_UPDATE_DETAIL]
class DefaultTestResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
4
0
4
4
3
0
4
4
3
0
2
0
0
6,104
Aplopio/django_rip
/Users/umroot/Documents/PhD_works/PhD-Core-Contents/Class-level-dataset-curation/data/git_repos_for_analysis/Aplopio_django_rip/tests/unit_tests/crud/test_crud_resource.py
tests.unit_tests.crud.test_crud_resource.TestCrudResourceConstruction.test_default_properties.DefaultTestResource
class DefaultTestResource(CrudResource): schema_cls = self.schema
class DefaultTestResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
2
0
2
2
1
0
2
2
1
0
2
0
0
6,105
Aplopio/django_rip
/Users/umroot/Documents/PhD_works/PhD-Core-Contents/Class-level-dataset-curation/data/git_repos_for_analysis/Aplopio_django_rip/tests/unit_tests/crud/test_crud_resource.py
tests.unit_tests.crud.test_crud_resource.TestCrudResourceConstruction.test_delete_detail.DefaultTestResource
class DefaultTestResource(CrudResource): schema_cls = self.schema authentication_cls = custom_auth allowed_actions = [CrudActions.DELETE_DETAIL]
class DefaultTestResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
4
0
4
4
3
0
4
4
3
0
2
0
0
6,106
Aplopio/django_rip
/Users/umroot/Documents/PhD_works/PhD-Core-Contents/Class-level-dataset-curation/data/git_repos_for_analysis/Aplopio_django_rip/tests/unit_tests/crud/test_crud_resource.py
tests.unit_tests.crud.test_crud_resource.TestCrudResourceConstruction.test_missing_schema_throws.TestResource
class TestResource(CrudResource): pass
class TestResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
2
0
2
1
1
0
2
1
1
0
2
0
0
6,107
Aplopio/django_rip
/Users/umroot/Documents/PhD_works/PhD-Core-Contents/Class-level-dataset-curation/data/git_repos_for_analysis/Aplopio_django_rip/tests/unit_tests/crud/test_crud_resource.py
tests.unit_tests.crud.test_crud_resource.TestCrudResourceConstruction
class TestCrudResourceConstruction(unittest.TestCase): def setUp(self): self.pipeline1 = MagicMock(spec=PipelineComposer) self.pipeline2 = MagicMock(spec=PipelineComposer) class TestSchema(ApiSchema): name = StringField(max_length=32) boolean = BooleanField() class TestResource(CrudResource): schema_cls = TestSchema self.TestResource = TestResource self.schema = TestSchema def test_missing_schema_throws(self): class TestResource(CrudResource): pass self.assertRaises(TypeError, TestResource) def test_default_properties(self): class DefaultTestResource(CrudResource): schema_cls = self.schema resource = DefaultTestResource() assert len(resource.configuration['allowed_actions']) == 2 assert isinstance(resource.configuration['authentication'], default_authentication.DefaultAuthentication) assert isinstance(resource.configuration['entity_actions'], DefaultEntityActions) @patch.object(crud_pipeline_factory, 'read_detail_pipeline') def test_read_detail(self, mock_create_pipeline): custom_auth = MagicMock() mock_create_pipeline.return_value = pipeline = MagicMock() request = MagicMock() class DefaultTestResource(CrudResource): schema_cls = self.schema authentication_cls = custom_auth test_resource = DefaultTestResource() test_resource.read_detail(request) pipeline.assert_called_once_with(request=request) @patch.object(crud_pipeline_factory, 'update_detail_pipeline') def test_update_detail(self, mock_create_pipeline): custom_auth = MagicMock() mock_create_pipeline.return_value = pipeline = MagicMock() request = MagicMock() class DefaultTestResource(CrudResource): schema_cls = self.schema authentication_cls = custom_auth allowed_actions = [CrudActions.UPDATE_DETAIL] test_resource = DefaultTestResource() test_resource.update_detail(request) pipeline.assert_called_once_with(request=request) @patch.object(crud_pipeline_factory, 'create_detail_pipeline') def test_create_detail(self, mock_create_pipeline): custom_auth = MagicMock() mock_create_pipeline.return_value = pipeline = MagicMock() request = MagicMock() class DefaultTestResource(CrudResource): schema_cls = self.schema authentication_cls = custom_auth allowed_actions = [CrudActions.CREATE_DETAIL] test_resource = DefaultTestResource() test_resource.create_detail(request) pipeline.assert_called_once_with(request=request) @patch.object(crud_pipeline_factory, 'delete_detail_pipeline') def test_delete_detail(self, mock_delete_pipeline): custom_auth = MagicMock() mock_delete_pipeline.return_value = pipeline = MagicMock() request = MagicMock() class DefaultTestResource(CrudResource): schema_cls = self.schema authentication_cls = custom_auth allowed_actions = [CrudActions.DELETE_DETAIL] test_resource = DefaultTestResource() test_resource.delete_detail(request) pipeline.assert_called_once_with(request=request) @patch.object(crud_pipeline_factory, 'create_or_update_detail_pipeline') def test_create_or_update_detail(self, create_or_update_detail_pipeline): pipeline = MagicMock() expected_response = MagicMock() request = MagicMock() create_or_update_detail_pipeline.return_value = pipeline pipeline.return_value = expected_response class DefaultTestResource(CrudResource): schema_cls = self.schema authentication_cls = MagicMock() allowed_actions = [CrudActions.CREATE_OR_UPDATE_DETAIL] test_resource = DefaultTestResource() response = test_resource.create_or_update_detail(request=request) assert response == expected_response pipeline.assert_called_once_with(request=request)
class TestCrudResourceConstruction(unittest.TestCase): def setUp(self): pass class TestSchema(ApiSchema): class TestResource(CrudResource): def test_missing_schema_throws(self): pass class TestResource(CrudResource): def test_default_properties(self): pass class DefaultTestResource(CrudResource): @patch.object(crud_pipeline_factory, 'read_detail_pipeline') def test_read_detail(self, mock_create_pipeline): pass class DefaultTestResource(CrudResource): @patch.object(crud_pipeline_factory, 'update_detail_pipeline') def test_update_detail(self, mock_create_pipeline): pass class DefaultTestResource(CrudResource): @patch.object(crud_pipeline_factory, 'create_detail_pipeline') def test_create_detail(self, mock_create_pipeline): pass class DefaultTestResource(CrudResource): @patch.object(crud_pipeline_factory, 'delete_detail_pipeline') def test_delete_detail(self, mock_delete_pipeline): pass class DefaultTestResource(CrudResource): @patch.object(crud_pipeline_factory, 'create_or_update_detail_pipeline') def test_create_or_update_detail(self, create_or_update_detail_pipeline): pass class DefaultTestResource(CrudResource):
23
0
13
3
10
0
1
0
1
13
12
0
8
4
8
80
114
28
86
67
63
0
79
58
61
1
2
0
8
6,108
Aplopio/django_rip
/Users/umroot/Documents/PhD_works/PhD-Core-Contents/Class-level-dataset-curation/data/git_repos_for_analysis/Aplopio_django_rip/tests/unit_tests/django_adapter/test_action_resolver.py
tests.unit_tests.django_adapter.test_action_resolver.MockSchema.Meta
class Meta: schema_name = 'mock'
class Meta: pass
1
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
2
0
2
2
1
0
2
2
1
0
0
0
0
6,109
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_schema_field.py
tests.unit_tests.schema.test_schema_field.TestSchemaField
class TestSchemaField(unittest.TestCase): def setUp(self): class TestSchema(ApiSchema): class Meta: schema_name = 'test_schema' name = StringField(max_length=10) self.test_schema_cls = TestSchema class TestEntity(object): def __init__(self, name, surname): self.name = name self.surname = surname self.test_entity_cls = TestEntity def test_should_serialize_with_default_serializer(self): field = SchemaField(of_type=self.test_schema_cls) serialized_dict = field.serialize( request_factory.get_request(), self.test_entity_cls('John', 'Smith')) assert_that(serialized_dict['name'], equal_to('John')) def test_should_serialize_with_overridden_serializer(self): test_schema_cls = self.test_schema_cls request = request_factory.get_request( context_params={'crud_action': CrudActions.UPDATE_DETAIL}) class TestSerializer(DefaultEntitySerializer): def serialize_entity(self, request, entity): return {'name': entity.surname} field = SchemaField(of_type=self.test_schema_cls, serializer_cls=TestSerializer) response_dict = field.serialize(request, self.test_entity_cls('John', 'Smith')) assert_that(response_dict['name'], equal_to('Smith')) def test_should_validate(self): field = SchemaField(self.test_schema_cls) request = request_factory.get_request( context_params={'crud_action': CrudActions.UPDATE_DETAIL}) result = field.validate(request, {'name': 1}) assert_that(result, instance_of(ValidationResult)) assert_that(result.is_success, equal_to(False)) assert_that(result.reason, has_entry('name', 'Expected type string')) def test_should_validate_with_overridden_validator(self): class TestValidator(DefaultSchemaValidation): def __init__(self, schema_cls): super(TestValidator, self).__init__(schema_cls) def validate_data(self, data, fields_to_validate=None): return {'name': 'Custom Validation Failed'} field = SchemaField(of_type=self.test_schema_cls, validator_cls=TestValidator) result = field.validate(None, {'name': 1}) assert_that(result, instance_of(ValidationResult)) assert_that(result.is_success, equal_to(False)) assert_that(result.reason, has_entry('name', 'Custom Validation Failed'))
class TestSchemaField(unittest.TestCase): def setUp(self): pass class TestSchemaField(unittest.TestCase): class Meta: class TestEntity(object): def __init__(self, name, surname): pass def test_should_serialize_with_default_serializer(self): pass def test_should_serialize_with_overridden_serializer(self): pass class TestSerializer(DefaultEntitySerializer): def serialize_entity(self, request, entity): pass def test_should_validate(self): pass def test_should_validate_with_overridden_validator(self): pass class TestValidator(DefaultSchemaValidation): def __init__(self, name, surname): pass def validate_data(self, data, fields_to_validate=None): pass
15
0
8
2
7
0
1
0
1
7
7
0
5
2
5
77
70
19
51
32
36
0
43
32
28
1
2
0
9
6,110
Aplopio/django_rip
Aplopio_django_rip/rip/schema/list_field.py
rip.schema.list_field.ListField
class ListField(BaseField): def __init__(self, field, required=False, field_type=FieldTypes.DEFAULT, \ nullable=True, show_in_list=True, entity_attribute=None): super(ListField, self).__init__(required=required, field_type=field_type, nullable=nullable, entity_attribute=entity_attribute, show_in_list=show_in_list) self.field = field self.field.field_type = field_type self.field.required = required self.field.nullable = nullable def validate(self, request, value): errors = [] validation_result = super(ListField, self).validate(request, value) if not validation_result.is_success: return validation_result value = value if value not in (DEFAULT_FIELD_VALUE, None) else [] if self.nullable and value is None: return ValidationResult(is_success=True) if type(value) != list: return ValidationResult(is_success=False, reason="This field should be an array.") for item in value: validation_result = self.field.validate(request, item) if not validation_result.is_success: errors.append(validation_result.reason) if errors: return ValidationResult(is_success=False, reason=errors) else: return ValidationResult(is_success=True) def clean(self, request, value): if value is None: return None return [self.field.clean(request, item) for item in value] def serialize(self, request, value): if value is None: return None return [self.field.serialize(request, item) for item in value]
class ListField(BaseField): def __init__(self, field, required=False, field_type=FieldTypes.DEFAULT, \ nullable=True, show_in_list=True, entity_attribute=None): pass def validate(self, request, value): pass def clean(self, request, value): pass def serialize(self, request, value): pass
5
0
11
1
10
0
3
0
1
5
2
0
4
1
4
8
48
8
40
11
33
0
32
9
27
8
2
2
13
6,111
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/django_adapter/test_action_resolver.py
tests.unit_tests.django_adapter.test_action_resolver.MockResource
class MockResource(CrudResource): schema_cls = MockSchema()
class MockResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
2
0
2
2
1
0
2
2
1
0
2
0
0
6,112
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/crud/test_crud_resource.py
tests.unit_tests.crud.test_crud_resource.TestMethodNotAllowed
class TestMethodNotAllowed(unittest.TestCase): def setUp(self): class TestResource(CrudResource): schema_cls = MagicMock() allowed_actions = () self.test_resource = TestResource() def assert_forbidden_response(self, response): assert not response.is_success assert response.reason == error_types.MethodNotAllowed def test_forbidden_response_if_methods_not_allowed(self): request = MagicMock() for action in CrudActions.get_all_actions(): response = getattr(self.test_resource, action)(request=request) self.assert_forbidden_response(response)
class TestMethodNotAllowed(unittest.TestCase): def setUp(self): pass class TestResource(CrudResource): def assert_forbidden_response(self, response): pass def test_forbidden_response_if_methods_not_allowed(self): pass
5
0
5
0
4
0
1
0
1
2
2
0
3
1
3
75
17
3
14
11
9
0
14
11
9
2
2
1
4
6,113
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/crud/test_crud_actions.py
tests.unit_tests.crud.test_crud_actions.TestResolveAction
class TestResolveAction(unittest.TestCase): def test_should_resolve_read_detail(self): assert CrudActions.resolve_action( 'read_detail') == CrudActions.READ_DETAIL def test_should_resolve_read_list(self): assert CrudActions.resolve_action( 'read_list') == CrudActions.READ_LIST def test_should_resolve_create_detail(self): assert CrudActions.resolve_action( 'create_detail') == CrudActions.CREATE_DETAIL def test_should_resolve_update_detail(self): assert CrudActions.resolve_action( 'update_detail') == CrudActions.UPDATE_DETAIL def test_should_resolve_delete_detail(self): assert CrudActions.resolve_action( 'delete_detail') == CrudActions.DELETE_DETAIL def test_should_get_aggregates(self): assert CrudActions.resolve_action( 'get_aggregates') == CrudActions.GET_AGGREGATES
class TestResolveAction(unittest.TestCase): def test_should_resolve_read_detail(self): pass def test_should_resolve_read_list(self): pass def test_should_resolve_create_detail(self): pass def test_should_resolve_update_detail(self): pass def test_should_resolve_delete_detail(self): pass def test_should_get_aggregates(self): pass
7
0
3
0
3
0
1
0
1
1
1
0
6
0
6
78
24
5
19
7
12
0
13
7
6
1
2
0
6
6,114
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/crud/test_crud_actions.py
tests.unit_tests.crud.test_crud_actions.TestAllActions
class TestAllActions(unittest.TestCase): def test_should_get_all_actions(self): all_actions = CrudActions.get_all_actions() assert len(all_actions) == 7 assert CrudActions.READ_DETAIL in all_actions assert CrudActions.READ_LIST in all_actions assert CrudActions.CREATE_DETAIL in all_actions assert CrudActions.UPDATE_DETAIL in all_actions assert CrudActions.CREATE_OR_UPDATE_DETAIL in all_actions assert CrudActions.DELETE_DETAIL in all_actions assert CrudActions.GET_AGGREGATES in all_actions
class TestAllActions(unittest.TestCase): def test_should_get_all_actions(self): pass
2
0
11
1
10
0
1
0
1
1
1
0
1
0
1
73
12
1
11
3
9
0
11
3
9
1
2
0
1
6,115
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_view_resource_end_to_end.py
tests.integration_tests.test_view_resource_end_to_end.TestApi
class TestApi(unittest.TestCase): def setUp(self): os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings' self.api = Api(name='api', version='v1') self.api.register_resource('dummy', DummyViewResource()) self.handler = create_http_handler(self.api) def test_view_resource(self): url = 'dummy' user = DummyUser() http_request = MagicMock(user=user, method='GET') response = self.handler(http_request, url) assert_that(response.status_code, equal_to(200)) assert_that(json.loads(response.content), equal_to({'name': 'dummy'}))
class TestApi(unittest.TestCase): def setUp(self): pass def test_view_resource(self): pass
3
0
8
2
6
0
1
0
1
3
3
0
2
2
2
74
17
4
13
9
10
0
13
9
10
1
2
0
2
6,116
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_view_resource_end_to_end.py
tests.integration_tests.test_view_resource_end_to_end.DummyViewResource
class DummyViewResource(ViewResource): schema_cls = DummySchema view_actions_cls = DummyViewActions authorization_cls = DummyViewAuthorization authentication_cls = DummyAuthentication
class DummyViewResource(ViewResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
5
5
0
5
5
4
0
5
5
4
0
2
0
0
6,117
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_view_resource_end_to_end.py
tests.integration_tests.test_view_resource_end_to_end.DummyViewAuthorization
class DummyViewAuthorization(DefaultViewAuthorization): pass
class DummyViewAuthorization(DefaultViewAuthorization): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
1
2
0
2
1
1
0
2
1
1
0
2
0
0
6,118
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/django_adapter/test_action_resolver.py
tests.unit_tests.django_adapter.test_action_resolver.MockViewResource
class MockViewResource(ViewResource): schema_cls = MockSchema()
class MockViewResource(ViewResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
5
2
0
2
2
1
0
2
2
1
0
2
0
0
6,119
Aplopio/django_rip
Aplopio_django_rip/rip/generic_steps/default_schema_validation.py
rip.generic_steps.default_schema_validation.DefaultSchemaValidation
class DefaultSchemaValidation(object): def __init__(self, schema_cls): self.schema_cls = schema_cls def _get_fields_to_validate_data(self, request, data): action = request.context_params['crud_action'] non_read_only_fields = self.schema_cls.non_readonly_fields() if action == CrudActions.UPDATE_DETAIL: updatable_fields = self.schema_cls.updatable_fields() field_names = set(data).intersection(set(updatable_fields)) elif action == CrudActions.CREATE_OR_UPDATE_DETAIL: field_names = self.schema_cls.updatable_fields() elif action == CrudActions.CREATE_DETAIL: field_names = non_read_only_fields.keys() else: field_names = [] return {field_name: non_read_only_fields[field_name] for field_name in field_names} def validate_data(self, request, data): errors = {} fields_to_validate = self._get_fields_to_validate_data(request, data) if data is not None and type(data) != dict: return "This item should be an object." for field_name, field in fields_to_validate.items(): validation_result = field.validate( request, data.get(field_name, DEFAULT_FIELD_VALUE)) if not validation_result.is_success: errors[field_name] = validation_result.reason if errors: return errors else: return None def validate_request_data(self, request): data_to_validate = request.data errors = self.validate_data(request, data=data_to_validate) if errors: return Response(is_success=False, reason=error_types.InvalidData, data=errors) else: return request
class DefaultSchemaValidation(object): def __init__(self, schema_cls): pass def _get_fields_to_validate_data(self, request, data): pass def validate_data(self, request, data): pass def validate_request_data(self, request): pass
5
0
11
1
10
0
3
0
1
5
2
1
4
1
4
4
46
6
40
16
35
0
31
16
26
5
1
2
12
6,120
Aplopio/django_rip
Aplopio_django_rip/rip/pipeline_composer.py
rip.pipeline_composer.PipelineComposer
class PipelineComposer(object): """ An action helps to compose a series of handlers into a pipeline. The output of a handler is passed as the input to the next handler. If a handler returns a reponse, the pipeline is exited and the response returned. """ def __init__(self, name=None, pipeline=None): self.name = name self.pipeline = pipeline or [] def __call__(self, request): pipeline = self.pipeline for counter, handler in enumerate(pipeline): response = handler(request=request) assert type(response) in [Request, Response], \ "handle_request of {handler_name} handler did not return a request or a response object".format( handler_name=str(handler)) if isinstance(response, Response): break assert isinstance(response, Response), \ "pipeline `{pipeline_name}` did not return a response object".format( pipeline_name=self.name) return response
class PipelineComposer(object): ''' An action helps to compose a series of handlers into a pipeline. The output of a handler is passed as the input to the next handler. If a handler returns a reponse, the pipeline is exited and the response returned. ''' def __init__(self, name=None, pipeline=None): pass def __call__(self, request): pass
3
1
10
2
8
0
2
0.24
1
5
2
0
2
2
2
2
27
6
17
8
14
4
13
8
10
3
1
2
4
6,121
Aplopio/django_rip
Aplopio_django_rip/rip/request.py
rip.request.Request
class Request(object): """ All actions objects when called create a request object before passing the call to a handler. A request object has a requesting_user, params of the call and the caller. Caller is the name of the action object making the call """ def __init__(self, user, request_params, data=None, context_params=None, request_headers=None, request_body=None): self.user = user or None self.request_params = request_params or {} self.data = data or {} self.context_params = context_params or {} self.request_headers = request_headers or {} self.request_body = request_body def __eq__(self, val): return self.user == val.user and \ self.request_params == val.request_params and \ self.data == self.data and \ self.context_params == val.context_params
class Request(object): ''' All actions objects when called create a request object before passing the call to a handler. A request object has a requesting_user, params of the call and the caller. Caller is the name of the action object making the call ''' def __init__(self, user, request_params, data=None, context_params=None, request_headers=None, request_body=None): pass def __eq__(self, val): pass
3
1
7
0
7
0
1
0.36
1
0
0
0
2
6
2
2
21
2
14
10
10
5
10
9
7
1
1
0
2
6,122
Aplopio/django_rip
Aplopio_django_rip/rip/response.py
rip.response.Response
class Response(object): def __init__(self, is_success=True, reason=None, data=None): """ :param is_success: :param reason: required if is_success is False :param data: supporting data. In case of success, this can be the data to be returned. For error responses, data contains additional details about the failure :return: """ self.is_success = is_success self.reason = reason self.data = data
class Response(object): def __init__(self, is_success=True, reason=None, data=None): ''' :param is_success: :param reason: required if is_success is False :param data: supporting data. In case of success, this can be the data to be returned. For error responses, data contains additional details about the failure :return: ''' pass
2
1
12
0
4
8
1
1.6
1
0
0
0
1
3
1
1
13
0
5
5
3
8
5
5
3
1
1
0
1
6,123
Aplopio/django_rip
Aplopio_django_rip/rip/schema/base_field.py
rip.schema.base_field.BaseField
class BaseField(six.with_metaclass(ABCMeta)): def __init__(self, required=False, field_type=FieldTypes.DEFAULT, nullable=True, entity_attribute=None, show_in_list=True): self.entity_attribute = entity_attribute self.nullable = nullable self.required = required self.field_type = field_type self.show_in_list = show_in_list def validate(self, request, value): """ This is not for business validation This should be only used for type validation Hence the only input is the value of the field :param value: :return: """ if self.required and value == DEFAULT_FIELD_VALUE: return ValidationResult(is_success=False, reason='This field is required') if not self.nullable and value is None: return ValidationResult(is_success=False, reason='null is not a valid value') return ValidationResult(is_success=True) def serialize(self, request, value): return value def clean(self, request, value): """ Called during update and create If there are deeper nesting within a field, which may have readonly fields, this function will be overridden :param request: :param value: :return: """ return value
class BaseField(six.with_metaclass(ABCMeta)): def __init__(self, required=False, field_type=FieldTypes.DEFAULT, nullable=True, entity_attribute=None, show_in_list=True): pass def validate(self, request, value): ''' This is not for business validation This should be only used for type validation Hence the only input is the value of the field :param value: :return: ''' pass def serialize(self, request, value): pass def clean(self, request, value): ''' Called during update and create If there are deeper nesting within a field, which may have readonly fields, this function will be overridden :param request: :param value: :return: ''' pass
5
2
10
0
6
4
2
0.7
1
2
2
10
4
5
4
4
43
4
23
14
14
16
17
10
12
3
1
1
6
6,124
Aplopio/django_rip
Aplopio_django_rip/rip/schema/base_field.py
rip.schema.base_field.DictionaryField
class DictionaryField(BaseField): field_type = dict
class DictionaryField(BaseField): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
4
2
0
2
2
1
0
2
2
1
0
2
0
0
6,125
Aplopio/django_rip
Aplopio_django_rip/rip/schema/base_field.py
rip.schema.base_field.FieldTypes
class FieldTypes(object): READONLY = 'readonly' DEFAULT = 'default' IMMUTABLE = 'immutable'
class FieldTypes(object): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
0
4
0
4
4
3
0
4
4
3
0
1
0
0
6,126
Aplopio/django_rip
Aplopio_django_rip/rip/schema/boolean_field.py
rip.schema.boolean_field.BooleanField
class BooleanField(BaseField): field_type = bool def validate(self, request, value): validation_result = super(BooleanField, self).validate(request, value) if not validation_result.is_success: return validation_result if self.nullable and value is None: return ValidationResult(is_success=True) if value == DEFAULT_FIELD_VALUE: return ValidationResult(is_success=True) if not isinstance(value, bool): return ValidationResult(is_success=False, reason='Expected type Boolean') return ValidationResult(is_success=True)
class BooleanField(BaseField): def validate(self, request, value): pass
2
0
12
0
12
0
5
0
1
3
1
0
1
0
1
5
15
1
14
4
12
0
13
4
11
5
2
1
5
6,127
Aplopio/django_rip
Aplopio_django_rip/rip/generic_steps/default_view_authorization.py
rip.generic_steps.default_view_authorization.DefaultViewAuthorization
class DefaultViewAuthorization(object): def authorize_read(self, request): return request
class DefaultViewAuthorization(object): def authorize_read(self, request): pass
2
0
2
0
2
0
1
0
1
0
0
2
1
0
1
1
3
0
3
2
1
0
3
2
1
1
1
0
1
6,128
Aplopio/django_rip
Aplopio_django_rip/rip/schema/choice_field.py
rip.schema.choice_field.ChoiceField
class ChoiceField(BaseField): """Restrict the value which is received. """ def __init__(self, choices, entity_attribute=None, required=False, field_type=FieldTypes.DEFAULT): """Pass list of allowed values. :param choices: `list` or `tuple` or `set` of values. Usage: ----- >>>choice_field = ChoiceField(choices=(1, 2)) >>>result = choice_field.validate(request=None, value=3) >>>result.is_success False >>>result = choice_field.validate(request=None, value=1) >>>result.is_success True >>>choice_field = ChoiceField(choices=[1, 2], required=True) >>>from rip.schema.default_field_value import DEFAULT_FIELD_VALUE >>>result = choice_field.validate(request=None, value=DEFAULT_FIELD_VALUE) >>>assert result.is_success False >>>result.reason 'This field is required' >>>result = choice_field.validate(request=None, value=1) >>>result.is_success True """ super(ChoiceField, self).__init__( required=required, field_type=field_type, entity_attribute=entity_attribute) self.choices = choices def _validate_choices_type(self): allowed_types = (list, tuple, set, ) # Prohibit user from giving any data type in choices attribute msg = u"choices: {} should of any one of the type {}".format( self.choices, allowed_types) if not isinstance(self.choices, allowed_types): return ValidationResult(is_success=False, reason=msg) return ValidationResult(is_success=True) def validate(self, request, value): validation_result = super(ChoiceField, self).validate(request, value) if not validation_result.is_success: return validation_result if value == DEFAULT_FIELD_VALUE: return ValidationResult(is_success=True) # Check it is possible to do validation. result = self._validate_choices_type() if not result.is_success: return result if value in self.choices: return ValidationResult(is_success=True) return ValidationResult( is_success=False, reason=u"{} isn't valid choice".format(value))
class ChoiceField(BaseField): '''Restrict the value which is received. ''' def __init__(self, choices, entity_attribute=None, required=False, field_type=FieldTypes.DEFAULT): '''Pass list of allowed values. :param choices: `list` or `tuple` or `set` of values. Usage: ----- >>>choice_field = ChoiceField(choices=(1, 2)) >>>result = choice_field.validate(request=None, value=3) >>>result.is_success False >>>result = choice_field.validate(request=None, value=1) >>>result.is_success True >>>choice_field = ChoiceField(choices=[1, 2], required=True) >>>from rip.schema.default_field_value import DEFAULT_FIELD_VALUE >>>result = choice_field.validate(request=None, value=DEFAULT_FIELD_VALUE) >>>assert result.is_success False >>>result.reason 'This field is required' >>>result = choice_field.validate(request=None, value=1) >>>result.is_success True ''' pass def _validate_choices_type(self): pass def validate(self, request, value): pass
4
2
20
4
9
8
3
0.96
1
6
2
0
3
1
3
7
66
13
27
10
22
26
22
9
18
5
2
1
8
6,129
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/django_adapter/test_action_resolver.py
tests.unit_tests.django_adapter.test_action_resolver.TestActionResolver
class TestActionResolver(unittest.TestCase): def test_resolve_update_action_on_api(self): mock_http_request = MagicMock() mock_http_request.method = 'PATCH' mock_api = MagicMock() mock_resource = MockResource() mock_api.resolve_resource.return_value = mock_resource mock_resource.update_detail = expected_action = MagicMock() action = action_resolver.resolve_action(mock_http_request, api=mock_api, url='foo/1') assert_that(action, equal_to(expected_action)) def test_resolve_put_action_on_api(self): mock_http_request = MagicMock() mock_http_request.method = 'PUT' mock_api = MagicMock() mock_resource = MockResource() mock_api.resolve_resource.return_value = mock_resource mock_resource.create_or_update_detail = expected_action = MagicMock() action = action_resolver.resolve_action(mock_http_request, api=mock_api, url='foo/1') assert_that(action, equal_to(expected_action)) def test_resolve_detail_action_on_api(self): mock_http_request = MagicMock() mock_http_request.method = 'DELETE' mock_api = MagicMock() mock_resource = MockResource() mock_api.resolve_resource.return_value = mock_resource mock_resource.delete_detail = expected_delete_action = MagicMock() action = action_resolver.resolve_action(mock_http_request, api=mock_api, url='foo/1') assert_that(action, equal_to(expected_delete_action)) def test_resolve_post_on_list_as_create_detail(self): mock_http_request = MagicMock() mock_http_request.method = 'POST' mock_api = MagicMock() mock_resource = MockResource() mock_api.resolve_resource.return_value = mock_resource mock_resource.create_detail = expected_create_action = MagicMock() action = action_resolver.resolve_action(mock_http_request, api=mock_api, url='foo') assert_that(action, equal_to(expected_create_action)) def test_resolve_non_existing_endpoint(self): mock_http_request = MagicMock() mock_http_request.method = 'DELETE' mock_api = MagicMock( spec_set=[]) action = action_resolver.resolve_action(mock_http_request, api=mock_api, url='foo') assert_that(action, equal_to(None)) def test_resolve_non_existing_action_delete(self): mock_http_request = MagicMock() mock_http_request.method = 'DELETE' mock_api = MagicMock() mock_resource = object() mock_api.resolve_resource.return_value = mock_resource action = action_resolver.resolve_action(mock_http_request, api=mock_api, url='foo') assert_that(action, equal_to(None)) def test_resolve_non_existing_action_put(self): mock_http_request = MagicMock() mock_http_request.method = 'PUT' mock_api = MagicMock() mock_resource = object() mock_api.resolve_resource.return_value = mock_resource action = action_resolver.resolve_action(mock_http_request, api=mock_api, url='foo') assert_that(action, equal_to(None)) def test_resolve_non_existing_action_options(self): mock_http_request = MagicMock() mock_http_request.method = 'OPTIONS' mock_api = MagicMock() mock_resource = object() mock_api.resolve_resource.return_value = mock_resource action = action_resolver.resolve_action(mock_http_request, api=mock_api, url='foo') assert_that(action, equal_to(None)) def test_resolve_view_action(self): mock_http_request = MagicMock() mock_http_request.method = 'GET' mock_api = MagicMock() mock_resource = MockViewResource() mock_api.resolve_resource.return_value = mock_resource mock_resource.read = expected_read_action = MagicMock() action = action_resolver.resolve_action(mock_http_request, api=mock_api, url='foo') assert_that(action, equal_to(expected_read_action))
class TestActionResolver(unittest.TestCase): def test_resolve_update_action_on_api(self): pass def test_resolve_put_action_on_api(self): pass def test_resolve_detail_action_on_api(self): pass def test_resolve_post_on_list_as_create_detail(self): pass def test_resolve_non_existing_endpoint(self): pass def test_resolve_non_existing_action_delete(self): pass def test_resolve_non_existing_action_put(self): pass def test_resolve_non_existing_action_options(self): pass def test_resolve_view_action(self): pass
10
0
10
1
9
0
1
0
1
2
2
0
9
0
9
81
103
17
86
50
76
0
76
45
66
1
2
0
9
6,130
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/generic_steps/test_default_authentication.py
tests.unit_tests.generic_steps.test_default_authentication.TestAuthenticationStep
class TestAuthenticationStep(unittest.TestCase): def test_authentication_for_a_valid_user(self): user = MagicMock() request = Request(user=user, request_params=None) returned_request = default_authentication.authenticate(request) assert_that(returned_request, equal_to(request)) def test_authentication_when_no_user(self): request = Request(user=None, request_params=None) response = default_authentication.authenticate(request) assert_that(response.is_success, equal_to(False)) assert_that(response.reason, equal_to(error_types.AuthenticationFailed))
class TestAuthenticationStep(unittest.TestCase): def test_authentication_for_a_valid_user(self): pass def test_authentication_when_no_user(self): pass
3
0
7
2
5
0
1
0
1
1
1
0
2
0
2
74
16
5
11
8
8
0
11
8
8
1
2
0
2
6,131
Aplopio/django_rip
Aplopio_django_rip/rip/generic_steps/default_schema_serializer.py
rip.generic_steps.default_schema_serializer.DefaultEntitySerializer
class DefaultEntitySerializer(object): entity_list_var = 'entities' entity_var = 'entity' aggregates_var = 'entity_aggregates' serialized_data_var = 'serialized_data' serialized_data_var_pre_update = 'serialized_data_pre_update' def __init__(self, schema_cls): self.schema_cls = schema_cls def get_fields_to_serialize(self, request): schema_fields = self.schema_cls._meta.fields if request.context_params.get('crud_action') == CrudActions.READ_LIST: return self.schema_cls.list_fields() elif request.context_params.get('crud_action') == \ CrudActions.GET_AGGREGATES: aggregate_by_fields = filter_operators.transform_to_list( request.request_params.get('aggregate_by', [])) return {key: schema_fields[key] for key in aggregate_by_fields} return schema_fields def serialize_aggregated_entity(self, request, aggregate_entity): aggregate_by_fields = self.get_fields_to_serialize(request) serialized = {} for field_name, field in aggregate_by_fields.items(): field_attribute = field.entity_attribute or field_name serialized[field_name] = \ attribute_getter.get_attribute(aggregate_entity, field_attribute) serialized['count'] = aggregate_entity['count'] return serialized def serialize_entity(self, request, entity): """ @param: entity -> entity object returned by the entity_actions step """ serialized = {} fields_to_serialize = self.get_fields_to_serialize(request) for field_name, field in fields_to_serialize.items(): field_override = getattr(self, 'serialize_%s' % field_name, None) if field_override: serialized_value = field_override(request, entity) else: entity_attribute = field.entity_attribute or field_name try: serialized_value = attribute_getter.get_attribute( entity, entity_attribute) except AttributeError as ex: if field.required: raise ex continue serialized[field_name] = field.serialize(request, serialized_value) return serialized def serialize_detail(self, request): """ @param: request -> request object that will be converted into a response @param: schema_obj_variable -> property name of the schema object on request obj that needs to be serialized """ schema_obj = request.context_params[self.entity_var] data = self.serialize_entity(request, schema_obj) request.context_params[self.serialized_data_var] = data return request def serialize_detail_pre_update(self, request): entity = request.context_params[self.entity_var] data = self.serialize_entity(request, entity) request.context_params[self.serialized_data_var_pre_update] = data return request def serialize_list(self, request): """ @param: request -> request object that will be converted into a response """ entity_list = request.context_params[self.entity_list_var] serialized_objects = [self.serialize_entity(request, entity) for entity in entity_list] request_filters = request.context_params.get('request_filters', {}) serialized_meta = {'offset': int(request_filters['offset']), # handles null case. Legacy requirements 'limit': int(request_filters['limit'] or 0), 'total': request.context_params['total_count']} data = dict(meta=serialized_meta, objects=serialized_objects) request.context_params[self.serialized_data_var] = data return request def serialize_entity_aggregates(self, request): aggregates = request.context_params[self.aggregates_var] serialized_data = [self.serialize_aggregated_entity(request, aggregate) for aggregate in aggregates] request.context_params[self.serialized_data_var] = serialized_data return request
class DefaultEntitySerializer(object): def __init__(self, schema_cls): pass def get_fields_to_serialize(self, request): pass def serialize_aggregated_entity(self, request, aggregate_entity): pass def serialize_entity(self, request, entity): ''' @param: entity -> entity object returned by the entity_actions step ''' pass def serialize_detail(self, request): ''' @param: request -> request object that will be converted into a response @param: schema_obj_variable -> property name of the schema object on request obj that needs to be serialized ''' pass def serialize_detail_pre_update(self, request): pass def serialize_list(self, request): ''' @param: request -> request object that will be converted into a response ''' pass def serialize_entity_aggregates(self, request): pass
9
3
11
1
9
2
2
0.16
1
4
1
1
8
1
8
8
101
15
74
39
65
12
62
38
53
5
1
4
15
6,132
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_resource_uri_field.py
tests.unit_tests.schema.test_resource_uri_field.TestResourceUriField
class TestResourceUriField(unittest.TestCase): def test_should_serialize_resource_uri(self): field = ResourceUriField() field.schema_cls = schema_cls = MagicMock() schema_cls._meta = schema_meta =MagicMock() schema_meta.schema_name='test' request = request_factory.get_request() value = field.serialize(request, 22) assert_that(value, equal_to('/api/v2/test/22/'))
class TestResourceUriField(unittest.TestCase): def test_should_serialize_resource_uri(self): pass
2
0
10
2
8
0
1
0
1
1
1
0
1
0
1
73
11
2
9
7
7
0
9
5
7
1
2
0
1
6,133
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_list_field.py
tests.unit_tests.schema.test_list_field.TestValidateListField
class TestValidateListField(unittest.TestCase): def test_return_success_if_nullable_and_value_is_none(self): field = ListField(field=StringField(), nullable=True) result = field.validate(request=None, value=None) assert result.is_success def test_return_failure_if_nullable_and_value_is_none(self): field = ListField(field=StringField(), nullable=False) result = field.validate(request=None, value=None) assert not result.is_success def test_return_failure_if_value_is_not_a_list(self): field = ListField(field=StringField(), nullable=False) result = field.validate(request=None, value='blah') assert not result.is_success def test_return_success_if_validation_passes(self): field = ListField(field=StringField(), nullable=True) result = field.validate(request=None, value=['foo', None]) assert result.is_success def test_return_success_if_validation_fails_on_child_field(self): field = ListField(field=StringField(), nullable=False) result = field.validate(request=None, value=['foo', None]) assert not result.is_success assert isinstance(result.reason, list) assert len(result.reason) == 1
class TestValidateListField(unittest.TestCase): def test_return_success_if_nullable_and_value_is_none(self): pass def test_return_failure_if_nullable_and_value_is_none(self): pass def test_return_failure_if_value_is_not_a_list(self): pass def test_return_success_if_validation_passes(self): pass def test_return_success_if_validation_fails_on_child_field(self): pass
6
0
7
2
4
0
1
0
1
3
2
0
5
0
5
77
39
16
23
16
17
0
23
16
17
1
2
0
5
6,134
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_float_field.py
tests.unit_tests.schema.test_float_field.TestFloatField
class TestFloatField(unittest.TestCase): def test_serialize_should_round_off_to_default_precision(self): float_field = FloatField() assert float_field.serialize(request={}, value=23.45667) == 23.46 def test_serialize_should_round_off_to_1(self): float_field = FloatField(precision=1) assert float_field.serialize(request={}, value=23.45667) == 23.5
class TestFloatField(unittest.TestCase): def test_serialize_should_round_off_to_default_precision(self): pass def test_serialize_should_round_off_to_1(self): pass
3
0
3
0
3
0
1
0
1
1
1
0
2
0
2
74
8
1
7
5
4
0
7
5
4
1
2
0
2
6,135
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_email_field.py
tests.unit_tests.schema.test_email_field.TestEmailField
class TestEmailField(unittest.TestCase): def test_validate_returns_error_if_required_and_value_is_default(self): email_field = EmailField(required=True) result = email_field.validate(None, DEFAULT_FIELD_VALUE) assert_that(result.is_success, equal_to(False)) assert_that(result.reason, equal_to('This field is required')) def test_validate_returns_error_for_invalid_type(self): email_field = EmailField(required=True) result = email_field.validate(None, 1212) assert_that(result.is_success, equal_to(False)) assert_that(result.reason, equal_to('Expected type string')) def test_validate_returns_error_if_email_is_invalid(self): email_field = EmailField(required=True) result_1 = email_field.validate(None, 'asd@asd') result_2 = email_field.validate(None, 'asd@asd.com,div@kar.co') assert_that(result_1.is_success, equal_to(False)) assert_that(result_1.reason, equal_to('Invalid email address')) assert_that(result_2.is_success, equal_to(False)) assert_that(result_2.reason, equal_to('Invalid email address')) def test_validate_returns_true_for_valid_email(self): email_field = EmailField(required=True) result_1 = email_field.validate(None, 'div.me@kar.boo') result_2 = email_field.validate(None, 'div@kar.co.in') result_3 = email_field.validate(None, 'div@kar.co') assert_that(result_1.is_success, equal_to(True)) assert_that(result_2.is_success, equal_to(True)) assert_that(result_3.is_success, equal_to(True)) def test_validate_returns_true_if_field_is_nullable_and_value_none(self): email_field = EmailField(nullable=True) result = email_field.validate(request=None, value=None) assert_that(result.is_success, equal_to(True))
class TestEmailField(unittest.TestCase): def test_validate_returns_error_if_required_and_value_is_default(self): pass def test_validate_returns_error_for_invalid_type(self): pass def test_validate_returns_error_if_email_is_invalid(self): pass def test_validate_returns_true_for_valid_email(self): pass def test_validate_returns_true_if_field_is_nullable_and_value_none(self): pass
6
0
8
2
6
0
1
0
1
1
1
0
5
0
5
77
45
14
31
19
25
0
31
19
25
1
2
0
5
6,136
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_choice_field.py
tests.unit_tests.schema.test_choice_field.TestChoiceField
class TestChoiceField(TestCase): def test_validate_for_invalid_choice(self): choice_field = ChoiceField(choices=(1, 2)) result = choice_field.validate(request=None, value=3) assert result.is_success is False def test_validate_for_valid_choice(self): choice_field = ChoiceField(choices=(1, 2)) result = choice_field.validate(request=None, value=1) assert result.is_success is True def test_validate_custom_object_in_choices(self): choice_field = ChoiceField(choices=(Foo(1), Foo(2))) result = choice_field.validate(request=None, value=Foo(1)) assert result.is_success is True def test_validate_custom_object_not_in_choices(self): choice_field = ChoiceField(choices=(Foo(1), Foo(2))) result = choice_field.validate(request=None, value=Foo("1")) assert result.is_success is False def test_pass_invalid_choices(self): choice_field = ChoiceField(choices='petromax lighte than venuma') result = choice_field.validate(request=None, value='than') assert result.is_success is False def test_check_required_field_when_value_is_empty(self): choice_field = ChoiceField(choices=[1, 2], required=True) result = choice_field.validate(request=None, value=DEFAULT_FIELD_VALUE) assert result.is_success is False assert result.reason == 'This field is required' def test_check_required_field_when_value_is_present(self): choice_field = ChoiceField(choices=[1, 2], required=True) result = choice_field.validate(request=None, value=1) assert result.is_success is True
class TestChoiceField(TestCase): def test_validate_for_invalid_choice(self): pass def test_validate_for_valid_choice(self): pass def test_validate_custom_object_in_choices(self): pass def test_validate_custom_object_not_in_choices(self): pass def test_pass_invalid_choices(self): pass def test_check_required_field_when_value_is_empty(self): pass def test_check_required_field_when_value_is_present(self): pass
8
0
6
2
4
0
1
0
1
2
2
0
7
0
7
79
50
20
30
22
22
0
30
22
22
1
2
0
7
6,137
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_choice_field.py
tests.unit_tests.schema.test_choice_field.Foo
class Foo: def __init__(self, id): self.id = id def __eq__(self, other): return (isinstance(other, self.__class__) and getattr(other, 'id', None) == self.id)
class Foo: def __init__(self, id): pass def __eq__(self, other): pass
3
0
3
0
3
0
1
0
0
0
0
0
2
1
2
2
7
1
6
4
3
0
5
4
2
1
0
0
2
6,138
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/django_adapter/test_django_response_builder.py
tests.unit_tests.django_adapter.test_django_response_builder.TestDjangoResponseBuilder
class TestDjangoResponseBuilder(unittest.TestCase): def test_should_return_not_authenticated_response_if_auth_fails(self): response = Response(is_success=False, reason=error_types.AuthenticationFailed, data={'asdf': 1121}) http_request = MagicMock() http_response = django_response_builder.build_http_response( http_request, response) self.assertEqual(http_response.status_code, 401) self.assertEqual(http_response.content, simplejson.dumps({'asdf': 1121})) def test_should_return_bad_request_for_invalid_data(self): response = Response(is_success=False, reason=error_types.InvalidData, data={'defg': 1121}) http_request = MagicMock() http_response = django_response_builder.build_http_response( http_request, response) self.assertEqual(http_response.status_code, 400) self.assertEqual(http_response.content, simplejson.dumps({'defg': 1121}))
class TestDjangoResponseBuilder(unittest.TestCase): def test_should_return_not_authenticated_response_if_auth_fails(self): pass def test_should_return_bad_request_for_invalid_data(self): pass
3
0
10
0
10
0
1
0
1
1
1
0
2
0
2
74
22
1
21
9
18
0
13
9
10
1
2
0
2
6,139
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_boolean_field.py
tests.unit_tests.schema.test_boolean_field.TestValidateBooleanField
class TestValidateBooleanField(unittest.TestCase): def test_return_success_if_nullable_and_value_is_none(self): field = BooleanField(nullable=True) result = field.validate(request=None, value=None) assert result.is_success def test_return_success_if_not_nullable_and_value_is_none(self): field = BooleanField(nullable=False) result = field.validate(request=None, value=None) assert not result.is_success assert result.reason == 'null is not a valid value' def test_return_failure_if_value_is_not_boolean(self): field = BooleanField() result = field.validate(request=None, value='foo') assert not result.is_success assert result.reason == 'Expected type Boolean' def test_return_success_if_value_is_default(self): field = BooleanField() result = field.validate(request=None, value=DEFAULT_FIELD_VALUE) assert result.is_success
class TestValidateBooleanField(unittest.TestCase): def test_return_success_if_nullable_and_value_is_none(self): pass def test_return_success_if_not_nullable_and_value_is_none(self): pass def test_return_failure_if_value_is_not_boolean(self): pass def test_return_success_if_value_is_default(self): pass
5
0
7
2
5
0
1
0
1
1
1
0
4
0
4
76
30
11
19
13
14
0
19
13
14
1
2
0
4
6,140
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/generic_steps/test_default_schema_validation.py
tests.unit_tests.generic_steps.test_default_schema_validation.TestSchemaFullValidation
class TestSchemaFullValidation(unittest.TestCase): def setUp(self): class RelatedSchema(ApiSchema): email = StringField(max_length=10) self.RelatedSchema = RelatedSchema class TestSchema(ApiSchema): name = StringField(max_length=5, required=True) is_active = BooleanField(required=True) country = StringField(required=False, max_length=5) related = SchemaField(of_type=self.RelatedSchema) class Meta: schema_name = 'asdf' self.TestSchema = TestSchema self.validation = DefaultSchemaValidation(schema_cls=self.TestSchema) def test_schema_validation_passes_with_all_fields(self): data = { 'name': 'John', 'is_active': True, 'country': 'India' } request = request_factory.get_request( data=data, context_params={'crud_action': CrudActions.UPDATE_DETAIL}) return_request = self.validation.validate_request_data(request) assert_that(return_request, equal_to(request)) def test_schema_validation_passes_with_required_fields(self): data = { 'name': 'John', 'is_active': True, } request = request_factory.get_request( data=data, context_params={'crud_action': CrudActions.UPDATE_DETAIL}) return_request = self.validation.validate_request_data(request) assert_that(return_request, equal_to(request)) def test_raises_bad_request_if_required_data_is_missing(self): data = {} request = request_factory.get_request( data=data, context_params={'crud_action': CrudActions.CREATE_DETAIL}) response = self.validation.validate_request_data(request) assert_that(response.is_success, equal_to(False)) assert_that(response.reason, equal_to(error_types.InvalidData)) assert_that(len(response.data), equal_to(2)) assert_that(response.data, has_items('name', 'is_active')) def test_raises_bad_request_if_field_greater_than_max_length(self): data = { 'name': 'John Smith', 'is_active': True, 'country': 'United States' } request = request_factory.get_request( data=data, context_params={'crud_action': CrudActions.UPDATE_DETAIL}) response = self.validation.validate_request_data(request) assert_that(response.is_success, equal_to(False)) assert_that(response.reason, equal_to(error_types.InvalidData)) assert_that(len(response.data), equal_to(2)) assert_that(response.data, has_items('name', 'country')) def test_input_data_is_not_a_dict(self): data = 'stupid random data' request = request_factory.get_request( data=data, context_params={'crud_action': CrudActions.UPDATE_DETAIL}) response = self.validation.validate_request_data(request) assert_that(response.is_success, equal_to(False)) assert_that(response.reason, equal_to(error_types.InvalidData)) def test_validate_schema_fields(self): pass
class TestSchemaFullValidation(unittest.TestCase): def setUp(self): pass class RelatedSchema(ApiSchema): class TestSchemaFullValidation(unittest.TestCase): class Meta: def test_schema_validation_passes_with_all_fields(self): pass def test_schema_validation_passes_with_required_fields(self): pass def test_raises_bad_request_if_required_data_is_missing(self): pass def test_raises_bad_request_if_field_greater_than_max_length(self): pass def test_input_data_is_not_a_dict(self): pass def test_validate_schema_fields(self): pass
11
0
11
1
10
0
1
0
1
4
4
0
7
3
7
79
86
17
69
35
58
0
48
35
37
1
2
0
7
6,141
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/generic_steps/test_default_schema_serializer.py
tests.unit_tests.generic_steps.test_default_schema_serializer.TestSerializeSchemaToResponse
class TestSerializeSchemaToResponse(unittest.TestCase): def setUp(self): class TestSchema(ApiSchema): id = StringField(required=True) name = StringField(max_length=32) is_active = BooleanField() class Meta: schema_name = 'asdf' self.TestSchema = TestSchema self.serializer = DefaultEntitySerializer(schema_cls=TestSchema) def test_should_serialize_to_response(self): request = Request(user=None, request_params=None) request.context_params['entity'] = dict(id='aaaa', name='asdf', is_active=True) request = self.serializer.serialize_detail(request) self.assertEqual(request.context_params['serialized_data'], dict(id='aaaa', name='asdf', is_active=True)) def test_should_not_throw_error_on_missing_non_required_fields(self): request = Request(user=None, request_params=None) request.context_params['entity'] = dict(id='aaaa', is_active=True) request = self.serializer.serialize_detail(request) self.assertEqual(request.context_params['serialized_data'], dict(id='aaaa', is_active=True)) def test_should_throw_error_on_missing_required_fields(self): request = Request(user=None, request_params=None) request.context_params['entity'] = dict(name='asdf', is_active=True) self.assertRaises(AttributeError, self.serializer.serialize_detail, request) def test_should_serialize_list_to_response(self): request = Request(user=None, request_params=None, context_params={}) request.context_params['total_count'] = 10 request.context_params['request_filters'] = {'offset': 0, 'limit': 20} request.context_params['entities'] = \ [dict(id='aaaa', name='asdf', is_active=True), dict(id='bbbb', name='asdf', is_active=False)] request = self.serializer.serialize_list(request) data = request.context_params['serialized_data']['objects'] self.assertEqual(len(data), 2) self.assertEqual(data[0], dict(id='aaaa', name='asdf', is_active=True)) self.assertEqual(data[1], dict(id='bbbb', name='asdf', is_active=False))
class TestSerializeSchemaToResponse(unittest.TestCase): def setUp(self): pass class TestSchema(ApiSchema): class Meta: def test_should_serialize_to_response(self): pass def test_should_not_throw_error_on_missing_non_required_fields(self): pass def test_should_throw_error_on_missing_required_fields(self): pass def test_should_serialize_list_to_response(self): pass
8
0
9
1
8
0
1
0
1
5
3
0
5
2
5
77
52
11
41
18
33
0
34
18
26
1
2
0
5
6,142
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/generic_steps/test_default_entity_actions.py
tests.unit_tests.generic_steps.test_default_entity_actions.TestEntityActionsUpdateDetail
class TestEntityActionsUpdateDetail(unittest.TestCase): def test_should_call_update_with_data(self): request = MagicMock() request.request_params = {'id': 1} request.context_params = {'entity': MagicMock(), 'data':{}} entity_actions = DefaultEntityActions(schema_cls=MagicMock(), default_offset=0, default_limit=20) update_entity = MagicMock() entity_actions.update_entity = update_entity update_entity.return_value = expected_entity = MagicMock() entity_actions.update_detail(request) self.assertEqual(request.context_params['entity'], expected_entity)
class TestEntityActionsUpdateDetail(unittest.TestCase): def test_should_call_update_with_data(self): pass
2
0
14
2
12
0
1
0
1
1
1
0
1
0
1
73
15
2
13
6
11
0
11
5
9
1
2
0
1
6,143
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/generic_steps/test_default_entity_actions.py
tests.unit_tests.generic_steps.test_default_entity_actions.TestEntityActionsReadList
class TestEntityActionsReadList(unittest.TestCase): def test_should_call_get_entity_list(self): request = MagicMock() request.request_params = {'id': 1} request.context_params = {} entity_actions = DefaultEntityActions(schema_cls=MagicMock(), default_offset=0, default_limit=20) entity_actions.get_entity_list = MagicMock() entity_actions.get_entity_list_total_count = MagicMock() entity_actions.get_entity_list_total_count.return_value = 1 entity_actions.get_entity_list.return_value = \ expected_list = [MagicMock()] return_request = entity_actions.read_list(request) self.assertEqual(return_request.context_params['entities'], expected_list)
class TestEntityActionsReadList(unittest.TestCase): def test_should_call_get_entity_list(self): pass
2
0
17
2
15
0
1
0
1
1
1
0
1
0
1
73
18
2
16
6
14
0
12
5
10
1
2
0
1
6,144
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/generic_steps/test_default_entity_actions.py
tests.unit_tests.generic_steps.test_default_entity_actions.TestEntityActionsReadDetail
class TestEntityActionsReadDetail(unittest.TestCase): def test_should_call_entity_getter(self): request = MagicMock() request.context_params = dict(request_filters={'id': 1}) entity_actions = DummyEntityActions(schema_cls=None, default_offset=0, default_limit=20) entity_actions.get_entity = MagicMock() entity_actions.get_entity.return_value = expected_obj = object() expected_request = entity_actions.read_detail(request=request) self.assertEqual(expected_request.context_params['asdf'], expected_obj) entity_actions.get_entity.assert_called_once_with(request, id=1) def test_should_apply_request_filters(self): request = MagicMock() request.context_params = dict(request_filters={'id': 1}) entity_actions = DefaultEntityActions(schema_cls=None, default_offset=0, default_limit=20) entity_actions.get_entity = MagicMock() entity_actions.get_entity.return_value = expected_obj = object() expected_request = entity_actions.read_detail(request=request) self.assertEqual(expected_request.context_params['entity'], expected_obj) entity_actions.get_entity.assert_called_once_with(request, id=1) def test_should_return_response_for_no_object_found(self): request = MagicMock() request.request_params = {'id': 1} entity_actions = DefaultEntityActions(schema_cls=None, default_offset=0, default_limit=20) entity_actions.get_entity = MagicMock() entity_actions.get_entity.return_value = expected_obj = None response = entity_actions.read_detail(request=request) self.assertIsInstance(response, Response) self.assertFalse(response.is_success) self.assertEqual(response.reason, ObjectNotFound)
class TestEntityActionsReadDetail(unittest.TestCase): def test_should_call_entity_getter(self): pass def test_should_apply_request_filters(self): pass def test_should_return_response_for_no_object_found(self): pass
4
0
14
3
11
0
1
0
1
4
3
0
3
0
3
75
46
11
35
16
31
0
29
13
25
1
2
0
3
6,145
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/generic_steps/test_default_entity_actions.py
tests.unit_tests.generic_steps.test_default_entity_actions.TestEntityActionsGetEntity
class TestEntityActionsGetEntity(unittest.TestCase): def test_should_raise_for_multiple_objects_found(self): entity_actions = DefaultEntityActions(schema_cls=None, default_offset=0, default_limit=20) entity_actions.get_entity_list = MagicMock() entity_actions.get_entity_list.return_value = [object(), object()] self.assertRaises(MultipleObjectsFound, entity_actions.get_entity, request=None, id=2) def test_should_return_entity(self): entity_actions = DefaultEntityActions(schema_cls=None, default_offset=0, default_limit=20) entity_actions.get_entity_list = MagicMock() entity_actions.get_entity_list.return_value = expected_objs = [object()] entity = entity_actions.get_entity(request=None) self.assertEqual(entity, expected_objs[0]) def test_should_return_none(self): entity_actions = DefaultEntityActions(schema_cls=None, default_offset=0, default_limit=20) entity_actions.get_entity_list = MagicMock() entity_actions.get_entity_list.return_value = [] entity = entity_actions.get_entity(request=None) self.assertEqual(entity, None)
class TestEntityActionsGetEntity(unittest.TestCase): def test_should_raise_for_multiple_objects_found(self): pass def test_should_return_entity(self): pass def test_should_return_none(self): pass
4
0
10
2
8
0
1
0
1
2
2
0
3
0
3
75
34
9
25
10
21
0
18
9
14
1
2
0
3
6,146
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/generic_steps/test_default_entity_actions.py
tests.unit_tests.generic_steps.test_default_entity_actions.DummyEntityActions
class DummyEntityActions(DefaultEntityActions): detail_property_name = 'asdf'
class DummyEntityActions(DefaultEntityActions): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
15
2
0
2
2
1
0
2
2
1
0
2
0
0
6,147
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/generic_steps/test_default_schema_validation.py
tests.unit_tests.generic_steps.test_default_schema_validation.TestSchemaPartialValidation
class TestSchemaPartialValidation(unittest.TestCase): class TestSchema(ApiSchema): name = StringField(max_length=5, required=True) is_active = BooleanField(required=True) country = StringField(required=False, max_length=5) class Meta: schema_name = 'asdf' def setUp(self): self.validation = DefaultSchemaValidation(schema_cls=self.TestSchema) def test_schema_validation_passes_with_some_fields(self): data = { 'country': 'India' } request = request_factory.get_request(data=data, context_params={ 'crud_action': CrudActions.UPDATE_DETAIL}) return_request = self.validation.validate_request_data(request) assert_that(return_request, equal_to(request)) def test_schema_validation_fails_for_wrong_datatype(self): data = { 'country': 1 } request = request_factory.get_request(data=data, context_params={ 'crud_action': CrudActions.UPDATE_DETAIL}) response = self.validation.validate_request_data(request) assert_that(response.is_success, equal_to(False)) assert_that(response.data, has_item('country'))
class TestSchemaPartialValidation(unittest.TestCase): class TestSchemaPartialValidation(unittest.TestCase): class Meta: def setUp(self): pass def test_schema_validation_passes_with_some_fields(self): pass def test_schema_validation_fails_for_wrong_datatype(self): pass
6
0
7
0
7
0
1
0
1
3
3
0
3
1
3
75
33
5
28
17
22
0
20
17
14
1
2
0
3
6,148
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_view_resource_end_to_end.py
tests.integration_tests.test_view_resource_end_to_end.DummyViewActions
class DummyViewActions(DefaultViewActions): def view(self, request): return { 'name': 'dummy' }
class DummyViewActions(DefaultViewActions): def view(self, request): pass
2
0
4
0
4
0
1
0
1
0
0
0
1
0
1
3
5
0
5
2
3
0
3
2
1
1
2
0
1
6,149
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_view_resource_end_to_end.py
tests.integration_tests.test_view_resource_end_to_end.DummyUser
class DummyUser(object): def is_anonymous(self): return False
class DummyUser(object): def is_anonymous(self): pass
2
0
2
0
2
0
1
0
1
0
0
0
1
0
1
1
3
0
3
2
1
0
3
2
1
1
1
0
1
6,150
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_view_resource_end_to_end.py
tests.integration_tests.test_view_resource_end_to_end.DummyAuthentication
class DummyAuthentication(DefaultAuthentication): pass
class DummyAuthentication(DefaultAuthentication): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
2
2
0
2
1
1
0
2
1
1
0
2
0
0
6,151
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/person_resource.py
tests.integration_tests.person_resource.CompanyResource
class CompanyResource(CrudResource): filter_by_fields = {'name': (EQUALS), 'person_name': (EQUALS)} schema_cls = CompanySchema allowed_actions = [CrudActions.READ_LIST, CrudActions.READ_DETAIL, CrudActions.UPDATE_DETAIL] entity_actions_cls = CompanyEntityActions authorization_cls = DefaultAuthorization
class CompanyResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
8
0
8
6
7
0
6
6
5
0
2
0
0
6,152
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/person_resource.py
tests.integration_tests.person_resource.CompanyEntityActions
class CompanyEntityActions(DefaultEntityActions): @classmethod def set_mocks(cls): cls.get_entity_list = mock.MagicMock() cls.get_entity_list_total_count = mock.MagicMock() cls.update_entity = mock.MagicMock()
class CompanyEntityActions(DefaultEntityActions): @classmethod def set_mocks(cls): pass
3
0
4
0
4
0
1
0
1
0
0
0
0
0
1
16
6
0
6
3
3
0
5
2
3
1
2
0
1
6,153
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/person_base_test_case.py
tests.integration_tests.person_base_test_case.PersonResourceBaseTestCase
class PersonResourceBaseTestCase(unittest.TestCase): def setUp(self): """ Sets the methods of of all entity actions to MagicMocks :return: """ PersonEntityActions.set_mocks() FriendEntityActions.set_mocks() CompanyEntityActions.set_mocks()
class PersonResourceBaseTestCase(unittest.TestCase): def setUp(self): ''' Sets the methods of of all entity actions to MagicMocks :return: ''' pass
2
1
8
0
4
4
1
0.8
1
3
3
7
1
0
1
73
9
0
5
2
3
4
5
2
3
1
2
0
1
6,154
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/blank_test_resource.py
tests.integration_tests.blank_test_resource.BlankTestSchema
class BlankTestSchema(ApiSchema): name = StringField(blank=False)
class BlankTestSchema(ApiSchema): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
7
2
0
2
2
1
0
2
2
1
0
2
0
0
6,155
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/blank_test_resource.py
tests.integration_tests.blank_test_resource.BlankTestResource
class BlankTestResource(CrudResource): schema_cls = BlankTestSchema allowed_actions = [ CrudActions.READ_LIST, CrudActions.READ_DETAIL, CrudActions.CREATE_OR_UPDATE_DETAIL, CrudActions.CREATE_DETAIL, ] entity_actions_cls = DefaultEntityActions
class BlankTestResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
9
0
9
4
8
0
4
4
3
0
2
0
0
6,156
Aplopio/django_rip
Aplopio_django_rip/setup.py
setup.PyTest
class PyTest(Command): user_options = [] def initialize_options(self): import subprocess return_code = subprocess.call( ['pip', 'install', '-r' 'test-requirements.txt']) if return_code != 0: raise SystemExit(return_code) def finalize_options(self): pass def run(self): import sys, subprocess errno = subprocess.call([sys.executable, 'runtests.py']) raise SystemExit(errno)
class PyTest(Command): def initialize_options(self): pass def finalize_options(self): pass def run(self): pass
4
0
5
1
4
0
1
0
1
1
0
0
3
0
3
42
19
5
14
9
8
0
13
9
7
2
2
1
4
6,157
Aplopio/django_rip
Aplopio_django_rip/rip/view/view_resource.py
rip.view.view_resource.ViewResource
class ViewResource(object): """ Defines a View Resource which like a plain old django view that returns a json. Additionally get options to override authentication, authorization Usually you don't have to override methods because steps can be overridden in the configuration attributes An example: class Tweet(ViewResource): schema_cls = TweetSchema allowed_actions= [ViewActions.read] # list of allowed actions view_actions_cls = TweetEntityActions # A mandatory hook class # that has methods for actions on # for the actual view logic serializer_cls = TweetEntitySerializer # A hook class # for serializing entity to json authentication_cls = TweetAuthentication # A hook class that authenticates # a request. # Default: it checks # if a valid user is present on the # request authorization_cls = TweetAuthorization # A hook class # that controls access to entities # Default: there is no authorization """ schema_cls = None allowed_actions = [ViewActions.READ] filter_by_fields = {} authentication_cls = DefaultAuthentication authorization_cls = DefaultViewAuthorization schema_validation_cls = DefaultSchemaValidation view_actions_cls = DefaultViewActions post_action_hooks_cls = DefaultPostActionHooks response_converter_cls = DefaultResponseConverter serializer_cls = DefaultEntitySerializer data_cleaner_cls = DefaultRequestCleaner def _setup_configuration(self): """ All steps are accepted as classes. Instantiate them with the right configuration and set them in a local property. """ self.configuration = dict( schema_cls=self.schema_cls, allowed_actions=self.allowed_actions, filter_by_fields=self.filter_by_fields) authentication = self.authentication_cls(schema_cls=self.schema_cls) authorization = self.authorization_cls() schema_validation = self.schema_validation_cls( schema_cls=self.schema_cls) view_actions = self.view_actions_cls() post_action_hooks = self.post_action_hooks_cls( schema_cls=self.schema_cls) response_converter = self.response_converter_cls( schema_cls=self.schema_cls) serializer = self.serializer_cls(schema_cls=self.schema_cls) data_cleaner = self.data_cleaner_cls(schema_cls=self.schema_cls) self.configuration.update(dict( authentication=authentication, authorization=authorization, schema_validation=schema_validation, view_actions=view_actions, post_action_hooks=post_action_hooks, response_converter=response_converter, data_cleaner=data_cleaner, serializer=serializer)) def __new__(cls, *args, **kwargs): if cls.schema_cls is None: raise TypeError('Missing configuration property `schema_cls` \ on Resource `{resource_name}`' .format(resource_name=cls.__name__)) obj = super(ViewResource, cls).__new__(cls, *args, **kwargs) return obj def __init__(self): super(ViewResource, self).__init__() self._setup_configuration() def is_action_allowed(self, action_name): """ Returns if a particular action is allowed on the resource as set in the allowed_actions attribute :param action_name:string :values as defined in ViewActions :return: bool """ if action_name not in self.allowed_actions: return False return True @validate_view_action def read(self, request): """ Implements HTTP GET :param request: rip.Request :return: rip.Response """ pipeline = view_pipeline_factory.read_pipeline( configuration=self.configuration) return pipeline(request=request)
class ViewResource(object): ''' Defines a View Resource which like a plain old django view that returns a json. Additionally get options to override authentication, authorization Usually you don't have to override methods because steps can be overridden in the configuration attributes An example: class Tweet(ViewResource): schema_cls = TweetSchema allowed_actions= [ViewActions.read] # list of allowed actions view_actions_cls = TweetEntityActions # A mandatory hook class # that has methods for actions on # for the actual view logic serializer_cls = TweetEntitySerializer # A hook class # for serializing entity to json authentication_cls = TweetAuthentication # A hook class that authenticates # a request. # Default: it checks # if a valid user is present on the # request authorization_cls = TweetAuthorization # A hook class # that controls access to entities # Default: there is no authorization ''' def _setup_configuration(self): ''' All steps are accepted as classes. Instantiate them with the right configuration and set them in a local property. ''' pass def __new__(cls, *args, **kwargs): pass def __init__(self): pass def is_action_allowed(self, action_name): ''' Returns if a particular action is allowed on the resource as set in the allowed_actions attribute :param action_name:string :values as defined in ViewActions :return: bool ''' pass @validate_view_action def read(self, request): ''' Implements HTTP GET :param request: rip.Request :return: rip.Response ''' pass
7
4
12
1
9
3
1
0.7
1
3
0
5
5
1
5
5
109
14
56
29
49
39
38
28
32
2
1
1
7
6,158
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/person_resource.py
tests.integration_tests.person_resource.FriendEntityActions
class FriendEntityActions(DefaultEntityActions): @classmethod def set_mocks(cls): cls.get_entity_list = mock.MagicMock() cls.update_entity = mock.MagicMock() cls.get_entity_list_total_count = mock.MagicMock()
class FriendEntityActions(DefaultEntityActions): @classmethod def set_mocks(cls): pass
3
0
4
0
4
0
1
0
1
0
0
0
0
0
1
16
6
0
6
3
3
0
5
2
3
1
2
0
1
6,159
Aplopio/django_rip
Aplopio_django_rip/rip/view/view_actions.py
rip.view.view_actions.ViewActions
class ViewActions(object): READ = 'read' _reverse_dictionary = None @classmethod def _get_reverse_dictionary(cls): if not cls._reverse_dictionary: cls._reverse_dictionary = _build_reverse_dictionary(cls) return cls._reverse_dictionary @classmethod def resolve_action(cls, name): cls_attr = cls._get_reverse_dictionary()[name] return getattr(cls, cls_attr) @classmethod def get_all_actions(cls): return ( cls.READ, )
class ViewActions(object): @classmethod def _get_reverse_dictionary(cls): pass @classmethod def resolve_action(cls, name): pass @classmethod def get_all_actions(cls): pass
7
0
4
0
4
0
1
0
1
0
0
0
0
0
3
3
21
4
17
10
10
0
12
7
8
2
1
1
4
6,160
Aplopio/django_rip
Aplopio_django_rip/rip/schema/url_field.py
rip.schema.url_field.UrlValidator
class UrlValidator(object): regex = None def __new__(cls, *args): if cls.regex is None: cls.regex = re.compile( r'^(?:http|ftp)s?://' # http:// or https:// r'(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}\.?)|' # domain... r'localhost|' #localhost... r'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})' # ...or ip r'(?::\d+)?' # optional port r'(?:/?|[/?]\S+)$', re.IGNORECASE) return object.__new__(cls, *args) def validate(self, url): if url != DEFAULT_FIELD_VALUE and url: url = u'http://{}'.format(url) if \ not urlparse.urlparse(url).scheme else url if self.regex.search(url): return True return False
class UrlValidator(object): def __new__(cls, *args): pass def validate(self, url): pass
3
0
9
0
9
3
3
0.26
1
0
0
0
2
0
2
2
21
2
19
4
16
5
12
4
9
4
1
2
6
6,161
Aplopio/django_rip
Aplopio_django_rip/rip/schema/url_field.py
rip.schema.url_field.UrlField
class UrlField(StringField): def validate(self, request, value): validation_result = super(UrlField, self).validate(request, value) if not validation_result.is_success: return validation_result if self.nullable and value is None: return ValidationResult(is_success=True) if value == DEFAULT_FIELD_VALUE: return ValidationResult(is_success=True) if not self.required and not value: return ValidationResult(is_success=True) if not UrlValidator().validate(url=value): return ValidationResult( is_success=False, reason=u"The url is not valid") return ValidationResult(is_success=True)
class UrlField(StringField): def validate(self, request, value): pass
2
0
17
3
14
0
6
0
1
3
2
0
1
0
1
8
18
3
15
3
13
0
14
3
12
6
3
1
6
6,162
Aplopio/django_rip
Aplopio_django_rip/rip/schema/sub_resource_field.py
rip.schema.sub_resource_field.SubResourceField
class SubResourceField(BaseField): def __init__(self, resource_cls, related_filter, required=False, nullable=True, entity_attribute='id', show_in_list=True): """ In case you want to show the content of resource1 as a part of resource2 sub-resource on resource2 is the way to go. This is not recommended at all. It is better to do views that collate information from multiple resources rather than adding sub resources. :param resource_cls: :param parent_schema_cls: the schema on which the sub-resource exists :param required: :param nullable: :param entity_attribute: the attribute on :return: """ super(SubResourceField, self).__init__(required=required, nullable=nullable, entity_attribute=entity_attribute, field_type=FieldTypes.READONLY, show_in_list=show_in_list) self.related_filter = related_filter self.resource_cls = resource_cls self.null_return_value = None def get_data(self, resource_obj, request): return resource_obj.read_detail(request) def get_data_from_response(self, response): return response.data def serialize(self, request, value): new_context_params = {} #make a copy of the api_breadcrumbs and append current resource breadcrumbs = copy.deepcopy( request.context_params.get('api_breadcrumbs', [])) breadcrumbs.append((self.schema_cls._meta.schema_name, value)) breadcrumb_filters = copy.deepcopy( request.context_params.get('api_breadcrumb_filters',{})) breadcrumb_filters.update({self.related_filter: value, 'offset': 0, 'limit': 0}) #get all objects new_context_params.update(api_breadcrumbs = breadcrumbs, api_breadcrumb_filters=breadcrumb_filters) for key, value in request.context_params.items(): if isinstance(value, (basestring, int, long)): new_context_params[key] = value request = Request(user=request.user, request_params=breadcrumb_filters, context_params=new_context_params) resource_obj = self.resource_cls() response = self.get_data(resource_obj, request) if response.is_success: return self.get_data_from_response(response) elif self.nullable: return self.null_return_value else: raise TypeError( "`{}` subResource returned unsuccessful response with {}".format( self.resource_cls, response))
class SubResourceField(BaseField): def __init__(self, resource_cls, related_filter, required=False, nullable=True, entity_attribute='id', show_in_list=True): ''' In case you want to show the content of resource1 as a part of resource2 sub-resource on resource2 is the way to go. This is not recommended at all. It is better to do views that collate information from multiple resources rather than adding sub resources. :param resource_cls: :param parent_schema_cls: the schema on which the sub-resource exists :param required: :param nullable: :param entity_attribute: the attribute on :return: ''' pass def get_data(self, resource_obj, request): pass def get_data_from_response(self, response): pass def serialize(self, request, value): pass
5
1
16
2
12
4
2
0.3
1
5
2
1
4
3
4
8
69
9
47
19
37
14
27
14
22
5
2
2
8
6,163
Aplopio/django_rip
Aplopio_django_rip/rip/schema/string_field.py
rip.schema.string_field.StringField
class StringField(BaseField): field_type = unicode def __init__( self, max_length=256, required=False, field_type=FieldTypes.DEFAULT, nullable=True, entity_attribute=None, show_in_list=True, blank=True, trim=False): self.max_length = max_length self.blank = blank self.trim = trim super(StringField, self).__init__( required=required, field_type=field_type, nullable=nullable, entity_attribute=entity_attribute, show_in_list=show_in_list) def validate(self, request, value): validation_result = super(StringField, self).validate(request, value) if not validation_result.is_success: return validation_result if self.blank is False and not value: return ValidationResult( is_success=False, reason='This field is required') if value == DEFAULT_FIELD_VALUE: return ValidationResult(is_success=True) if value is None and self.nullable: return ValidationResult(is_success=True) if not isinstance(value, basestring): return ValidationResult(is_success=False, reason=u'Expected type string') if self.max_length and len(value) > self.max_length: return ValidationResult(is_success=False, reason=u'Maxlength of {} exceeded' \ .format(self.max_length)) return ValidationResult(is_success=True) def clean(self, request, value): value = super(StringField, self).clean(request, value) if self.trim is True: return value.strip() elif self.trim: return value.strip(self.trim) else: return value
class StringField(BaseField): def __init__( self, max_length=256, required=False, field_type=FieldTypes.DEFAULT, nullable=True, entity_attribute=None, show_in_list=True, blank=True, trim=False): pass def validate(self, request, value): pass def clean(self, request, value): pass
4
0
14
2
13
0
4
0
1
3
2
4
3
3
3
7
48
8
40
13
32
0
28
9
24
7
2
1
11
6,164
Aplopio/django_rip
Aplopio_django_rip/rip/schema/schema_field.py
rip.schema.schema_field.SchemaField
class SchemaField(BaseField): def __init__(self, of_type, required=False, field_type=FieldTypes.DEFAULT, nullable=True, entity_attribute=None, validator_cls=DefaultSchemaValidation, serializer_cls=DefaultEntitySerializer, cleaner_cls=DefaultRequestCleaner, show_in_list=True): super(SchemaField, self).__init__(required=required, field_type=field_type, nullable=nullable, entity_attribute=entity_attribute, show_in_list=show_in_list) self.of_type = of_type self.validator = validator_cls(schema_cls=self.of_type) self.serializer = serializer_cls(schema_cls=self.of_type) self.cleaner = cleaner_cls(schema_cls=self.of_type) def validate(self, request, value): validation_result = super(SchemaField, self).validate(request, value) if not validation_result.is_success: return validation_result if value == DEFAULT_FIELD_VALUE: return ValidationResult(is_success=True) if value is None and self.nullable: return ValidationResult(is_success=True) errors = self.validator.validate_data(request, value) if errors: return ValidationResult(is_success=False, reason=errors) return ValidationResult(is_success=True) def serialize(self, request, value): if value is None: return None return self.serializer.serialize_entity(request, value) def clean(self, request, value): if value is None: return None return self.cleaner.clean(request, value)
class SchemaField(BaseField): def __init__(self, of_type, required=False, field_type=FieldTypes.DEFAULT, nullable=True, entity_attribute=None, validator_cls=DefaultSchemaValidation, serializer_cls=DefaultEntitySerializer, cleaner_cls=DefaultRequestCleaner, show_in_list=True): pass def validate(self, request, value): pass def serialize(self, request, value): pass def clean(self, request, value): pass
5
0
11
1
10
0
3
0
1
6
5
0
4
4
4
8
46
7
39
19
26
0
27
11
22
5
2
1
10
6,165
Aplopio/django_rip
Aplopio_django_rip/rip/schema/resource_uri_field.py
rip.schema.resource_uri_field.ResourceUriField
class ResourceUriField(StringField): """This field is to be used to add a resource with respect to parent resource. URI of the resource in context is appended to that of parent. """ def __init__(self, of_type=None, entity_attribute='id', field_type=FieldTypes.READONLY, required=False, nullable=False): super(ResourceUriField, self).__init__( max_length=1024, required=required, field_type=field_type, nullable=nullable, entity_attribute=entity_attribute) self.of_type = of_type def _get_url_parts(self, entity_name, value, parent_bread_crumbs): all_bread_crumbs = parent_bread_crumbs[:] all_bread_crumbs.append([entity_name, value]) return reduce(lambda url_parts, resource_tuple: url_parts + [unicode(val) for val in resource_tuple], all_bread_crumbs, []) def serialize(self, request, value): schema = self.of_type or self.schema_cls schema_name = schema._meta.schema_name return url_constructor.construct_url( api_name=request.context_params['api_name'], api_version=request.context_params['api_version'], schema_name=schema_name, entity_id=value, parents=request.context_params.get('api_breadcrumbs', []) ) def clean(self, request, value): if value is None: return value id_index = -2 if value.endswith('/') else -1 return value.split('/')[id_index]
class ResourceUriField(StringField): '''This field is to be used to add a resource with respect to parent resource. URI of the resource in context is appended to that of parent. ''' def __init__(self, of_type=None, entity_attribute='id', field_type=FieldTypes.READONLY, required=False, nullable=False): pass def _get_url_parts(self, entity_name, value, parent_bread_crumbs): pass def serialize(self, request, value): pass def clean(self, request, value): pass
5
1
9
0
9
0
2
0.11
1
2
1
0
4
1
4
11
44
5
35
13
27
4
17
10
12
3
3
1
6
6,166
Aplopio/django_rip
Aplopio_django_rip/rip/schema/resource_link_field.py
rip.schema.resource_link_field.ResourceLinkField
class ResourceLinkField(StringField): """This field is to be used to add independent resource. URI generated for this field is only for the resource in context and not related to parent resource. """ def __init__(self, of_type, entity_attribute='id', field_type=FieldTypes.READONLY, required=False, nullable=False): """Constructor for `ResourceLinkField`. :param of_type: this is schema class for which the field is defined :param entity_attribute: attribute of the schema defined by `of_type` which will be used to generate URI :param field_type: states the type of the field and can take pre-defined `FieldTypes` constants: READONLY, DEFAULT, IMMUTABLE, etc. :param required: ``True`` states this field is required when parent resource is created :param nullable: ``True`` states that this field can take Null values while creating/updating the parent resource """ super(ResourceLinkField, self).__init__( max_length=1024, required=required, field_type=field_type, nullable=nullable, entity_attribute=entity_attribute) self.of_type = of_type def serialize(self, request, value): if value is None: return value schema = self.of_type schema_name = schema._meta.schema_name return url_constructor.construct_url( api_name=request.context_params['api_name'], api_version=request.context_params['api_version'], schema_name=schema_name, entity_id=value) def clean(self, request, value): if value is None: return value id_index = -2 if value.endswith('/') else -1 url_parts = value.split('/') return url_parts[id_index]
class ResourceLinkField(StringField): '''This field is to be used to add independent resource. URI generated for this field is only for the resource in context and not related to parent resource. ''' def __init__(self, of_type, entity_attribute='id', field_type=FieldTypes.READONLY, required=False, nullable=False): '''Constructor for `ResourceLinkField`. :param of_type: this is schema class for which the field is defined :param entity_attribute: attribute of the schema defined by `of_type` which will be used to generate URI :param field_type: states the type of the field and can take pre-defined `FieldTypes` constants: READONLY, DEFAULT, IMMUTABLE, etc. :param required: ``True`` states this field is required when parent resource is created :param nullable: ``True`` states that this field can take Null values while creating/updating the parent resource ''' pass def serialize(self, request, value): pass def clean(self, request, value): pass
4
2
16
1
9
6
2
0.75
1
2
1
0
3
1
3
10
55
6
28
12
21
21
16
9
12
3
3
1
6
6,167
Aplopio/django_rip
Aplopio_django_rip/rip/schema/validation_result.py
rip.schema.validation_result.ValidationResult
class ValidationResult(object): def __init__(self, is_success, reason=None): self.is_success = is_success self.reason = reason
class ValidationResult(object): def __init__(self, is_success, reason=None): pass
2
0
3
0
3
0
1
0
1
0
0
0
1
2
1
1
4
0
4
4
2
0
4
4
2
1
1
0
1
6,168
Aplopio/django_rip
Aplopio_django_rip/rip/schema/id_field.py
rip.schema.id_field.IdField
class IdField(IntegerField): def __init__(self, entity_attribute='id'): super(IdField, self).__init__(field_type=FieldTypes.READONLY, required=False, nullable=False, entity_attribute=entity_attribute )
class IdField(IntegerField): def __init__(self, entity_attribute='id'): pass
2
0
6
0
6
0
1
0
1
2
1
0
1
0
1
5
7
0
7
2
5
0
3
2
1
1
3
0
1
6,169
Aplopio/django_rip
Aplopio_django_rip/rip/schema/float_field.py
rip.schema.float_field.FloatField
class FloatField(BaseField): field_type = float def __init__(self, required=False, field_type=FieldTypes.DEFAULT, nullable=True, entity_attribute=None, show_in_list=True, precision=2): super(FloatField, self).__init__(required, field_type, nullable, entity_attribute, show_in_list) self.precision = precision def serialize(self, request, value): format = '%.{}f'.format(self.precision) return float(format % value)
class FloatField(BaseField): def __init__(self, required=False, field_type=FieldTypes.DEFAULT, nullable=True, entity_attribute=None, show_in_list=True, precision=2): pass def serialize(self, request, value): pass
3
0
5
0
5
0
1
0
1
3
1
0
2
1
2
6
14
3
11
7
6
0
8
5
5
1
2
0
2
6,170
Aplopio/django_rip
Aplopio_django_rip/rip/schema/email_field.py
rip.schema.email_field.EmailValidator
class EmailValidator(object): regex = None def __new__(cls, *args): if cls.regex is None: cls.regex = re.compile( r"(^[-!#$%&'*+/=?^_`{}|~0-9A-Z]+(\.[-!#$%&'*+/=?^_`{}|~0-9A-Z]+)*" # dot-atom # quoted-string, see also http://tools.ietf.org/html/rfc2822#section-3.2.5 r'|^"([\001-\010\013\014\016-\037!#-\[\]-\177]|\\[\001-\011\013\014\016-\177])*"' r')@((?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+[A-Z]{2,6}\.?$)' # domain r'|\[(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\]$', re.IGNORECASE) return object.__new__(cls, *args) def validate(self, email): if email != DEFAULT_FIELD_VALUE and email and len(email) > 6: if self.regex.search(email): return True return False
class EmailValidator(object): def __new__(cls, *args): pass def validate(self, email): pass
3
0
8
0
7
2
3
0.25
1
0
0
0
2
0
2
2
19
2
16
4
13
4
11
4
8
3
1
2
5
6,171
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_view_resource.py
tests.integration_tests.test_view_resource.DummySchema
class DummySchema(ApiSchema): name = StringField(required=True)
class DummySchema(ApiSchema): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
7
2
0
2
2
1
0
2
2
1
0
2
0
0
6,172
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_view_resource.py
tests.integration_tests.test_view_resource.DummyResource
class DummyResource(ViewResource): schema_cls = DummySchema view_actions_cls = DummyViewActions authorization_cls = DummyAuthorization authentication_cls = DummyAuthentication
class DummyResource(ViewResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
5
5
0
5
5
4
0
5
5
4
0
2
0
0
6,173
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_view_resource.py
tests.integration_tests.test_view_resource.DummyAuthorization
class DummyAuthorization(DefaultViewAuthorization): pass
class DummyAuthorization(DefaultViewAuthorization): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
1
2
0
2
1
1
0
2
1
1
0
2
0
0
6,174
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_update_detail.py
tests.integration_tests.test_update_detail.UpdateCrudResourceIntegrationTest
class UpdateCrudResourceIntegrationTest(PersonResourceBaseTestCase): def test_should_update_fields(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entity = PersonEntity(name='John', email="foo@bar.com", phone='1234', address={'city': 'bangalore', 'country': 'India'}, company=None, nick_names=['Johnny', 'Papa']) entity_actions.get_entity_list.return_value = [expected_entity] entity_actions.update_entity.return_value = expected_entity request = request_factory.get_request(user=object(), data=expected_entity.__dict__) response = resource.update_detail(request) assert_that(response.is_success, equal_to(True)) expected_data = expected_entity.__dict__ expected_data.update(friends=[]) assert_that(response.data, equal_to(expected_data)) expected_update_kwargs = dict(name='John', email="foo@bar.com", address={'country': 'India'}, nick_names=['Johnny', 'Papa']) entity_actions.update_entity.assert_called_once_with( request, expected_entity, **expected_update_kwargs) def test_success_when_nullable_fields_set_to_none(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entity = PersonEntity(name='John', email=None, phone='1234', address=None, company=None, nick_names=['Johnny', 'Papa']) entity_actions.get_entity_list.return_value = [expected_entity] entity_actions.update_entity.return_value = expected_entity request = request_factory.get_request(user=object(), data=expected_entity.__dict__) response = resource.update_detail(request) assert_that(response.is_success, equal_to(True)) expected_data = expected_entity.__dict__ expected_data.update(friends=[]) expected_data.update(email=None) assert_that(response.data, equal_to(expected_data)) def test_success_when_one_required_fields_are_not_present(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entity = PersonEntity(email=None, phone='1234', address=None, company=None, nick_names=['Johnny', 'Papa']) data = expected_entity.__dict__ expected_entity.name = 'John' expected_entity.friends = [] entity_actions.get_entity_list.return_value = [expected_entity] entity_actions.update_entity.return_value = expected_entity request = request_factory.get_request(user=object(), data=data) response = resource.update_detail(request) assert_that(response.is_success, equal_to(True)) assert_that(response.data, equal_to(expected_entity.__dict__)) def test_update_when_non_nullable_fields_are_set_to_none(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entity = PersonEntity(name=None, email=None, phone='1234', address=None, company=None) entity_actions.get_entity_list.return_value = [expected_entity] entity_actions.update_entity.return_value = expected_entity request = request_factory.get_request(user=object(), data=expected_entity.__dict__) response = resource.update_detail(request) assert_that(response.is_success, equal_to(False)) assert_that(response.reason, equal_to(error_types.InvalidData)) assert_that(response.data, has_item('name'))
class UpdateCrudResourceIntegrationTest(PersonResourceBaseTestCase): def test_should_update_fields(self): pass def test_success_when_nullable_fields_set_to_none(self): pass def test_success_when_one_required_fields_are_not_present(self): pass def test_update_when_non_nullable_fields_are_set_to_none(self): pass
5
0
21
3
18
0
1
0
1
3
2
0
4
0
4
77
89
15
74
29
69
0
52
29
47
1
3
0
4
6,175
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_put_detail.py
tests.integration_tests.test_put_detail.PutCrudResourceIntegrationTest
class PutCrudResourceIntegrationTest(PersonResourceBaseTestCase): def test_should_update_fields(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entity = PersonEntity(name='John', email="foo@bar.com", phone='1234', address={'city': 'bangalore', 'country': 'India'}, company=None, nick_names=['Johnny', 'Papa']) entity_actions.get_entity_list.return_value = [expected_entity] entity_actions.update_entity.return_value = expected_entity request = request_factory.get_request(user=object(), data=expected_entity.__dict__) response = resource.create_or_update_detail(request) assert_that(response.is_success, equal_to(True)) expected_data = expected_entity.__dict__ expected_data.update(friends=[]) assert_that(response.data, equal_to(expected_data)) expected_update_kwargs = dict(name='John', email="foo@bar.com", address={'country': 'India'}, nick_names=['Johnny', 'Papa']) entity_actions.update_entity.assert_called_once_with( request, expected_entity, **expected_update_kwargs) def test_success_when_nullable_fields_set_to_none(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entity = PersonEntity(name='John', email=None, phone='1234', address=None, company=None, nick_names=['Johnny', 'Papa']) entity_actions.get_entity_list.return_value = [expected_entity] entity_actions.update_entity.return_value = expected_entity request = request_factory.get_request(user=object(), data=expected_entity.__dict__) response = resource.create_or_update_detail(request) assert_that(response.is_success, equal_to(True)) expected_data = expected_entity.__dict__ expected_data.update(friends=[]) expected_data.update(email=None) assert_that(response.data, equal_to(expected_data)) def test_failure_when_required_fields_are_not_present(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entity = PersonEntity(email=None, phone='1234', address=None, company=None, nick_names=['Johnny', 'Papa']) entity_actions.get_entity_list.return_value = [expected_entity] entity_actions.update_entity.return_value = expected_entity request = request_factory.get_request(user=object(), data=expected_entity.__dict__) response = resource.create_or_update_detail(request) assert_that(response.is_success, equal_to(False)) assert_that(response.reason, equal_to(error_types.InvalidData)) def test_update_when_non_nullable_fields_are_set_to_none(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entity = PersonEntity(name=None, email=None, phone='1234', address=None, company=None) entity_actions.get_entity_list.return_value = [expected_entity] entity_actions.update_entity.return_value = expected_entity request = request_factory.get_request(user=object(), data=expected_entity.__dict__) response = resource.create_or_update_detail(request) assert_that(response.is_success, equal_to(False)) assert_that(response.reason, equal_to(error_types.InvalidData)) assert_that(response.data, has_item('name'))
class PutCrudResourceIntegrationTest(PersonResourceBaseTestCase): def test_should_update_fields(self): pass def test_success_when_nullable_fields_set_to_none(self): pass def test_failure_when_required_fields_are_not_present(self): pass def test_update_when_non_nullable_fields_are_set_to_none(self): pass
5
0
21
3
18
0
1
0
1
3
2
0
4
0
4
77
86
15
71
28
66
0
49
28
44
1
3
0
4
6,176
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_get_list.py
tests.integration_tests.test_get_list.ListCrudResourceIntegrationTest
class ListCrudResourceIntegrationTest(PersonResourceBaseTestCase): def test_should_get_list(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entities = [PersonEntity(name='John', email=None, phone='1234', address={'city': 'bangalore', 'country': 'India'}, company=None, nick_names=['Johnny', 'Papa'])] entity_actions.get_entity_list.return_value = expected_entities entity_actions.get_entity_list_total_count.return_value = 1 request = request_factory.get_request(user=object()) response = resource.read_list(request) assert_that(response.is_success, equal_to(True)) expected_entity = expected_entities[0].__dict__.copy() expected_entity.pop('company') expected_data = [expected_entity] assert_that(response.data['objects'], equal_to(expected_data)) assert_that(response.data['meta']['total'], equal_to(1)) def test_should_get_list_fields_only(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entities = [PersonEntity(name='John', email=None, phone='1234', address={'city': 'bangalore', 'country': 'India'}, company=None, nick_names=['Johnny', 'Papa'])] entity_actions.get_entity_list.return_value = expected_entities entity_actions.get_entity_list_total_count.return_value = 1 request = request_factory.get_request(user=object()) response = resource.read_list(request) assert_that(response.is_success, equal_to(True)) response_data = response.data['objects'][0] self.assertTrue('company' not in response_data) def test_should_fail_ordering_by_non_order_by_fields(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entities = [PersonEntity(name='John', email=None, phone='1234', address={'city': 'bangalore', 'country': 'India'}, company=None)] entity_actions.get_entity_list.return_value = expected_entities entity_actions.get_entity_list_total_count.return_value = 1 user = object() request = request_factory.get_request(user=user, request_params={ 'order_by': 'email'}) response = resource.read_list(request) assert response.is_success is False assert response.reason is error_types.InvalidData assert ('email', 'Ordering not allowed') in response.data.items() def test_should_order_by_allowed_field(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entities = [PersonEntity(name='John', email=None, phone='1234', address={'city': 'bangalore', 'country': 'India'}, company=None, nick_names=['Johnny', 'Papa'])] entity_actions.get_entity_list.return_value = expected_entities entity_actions.get_entity_list_total_count.return_value = 1 user = object() request = request_factory.get_request(user=user, request_params={ 'order_by': 'name'}) response = resource.read_list(request) assert response.is_success is True def test_should_filter_by_list_field(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] expected_entities = [PersonEntity(name='John', email=None, phone='1234', address={'city': 'bangalore', 'country': 'India'}, company=None, nick_names=['Johnny', 'Papa'])] entity_actions.get_entity_list.return_value = expected_entities entity_actions.get_entity_list_total_count.return_value = 1 user = object() request = request_factory.get_request(user=user, request_params={ 'nick_names': 'Johnny'}) response = resource.read_list(request) assert response.is_success is True assert 'Johnny' in response.data['objects'][0]['nick_names']
class ListCrudResourceIntegrationTest(PersonResourceBaseTestCase): def test_should_get_list(self): pass def test_should_get_list_fields_only(self): pass def test_should_fail_ordering_by_non_order_by_fields(self): pass def test_should_order_by_allowed_field(self): pass def test_should_filter_by_list_field(self): pass
6
0
18
2
16
0
1
0
1
2
2
0
5
0
5
78
96
15
81
37
75
0
59
37
53
1
3
0
5
6,177
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_get_aggregates.py
tests.integration_tests.test_get_aggregates.GetCountsCrudResourceIntegrationTest
class GetCountsCrudResourceIntegrationTest(PersonResourceBaseTestCase): def test_should_get_aggregates_by_allowed_fields(self): resource = PersonResource() entity_actions = resource.configuration['entity_actions'] entity_actions.get_entity_aggregates.return_value = \ expected_aggregates = \ [{'name': 'asdf', 'count': 2}, {'name': 'asdf1', 'count': 10}] user = object() request = request_factory.get_request(user=user, request_params={ 'aggregate_by': 'name'}) response = resource.get_aggregates(request) assert response.is_success is True assert response.data == expected_aggregates
class GetCountsCrudResourceIntegrationTest(PersonResourceBaseTestCase): def test_should_get_aggregates_by_allowed_fields(self): pass
2
0
14
2
12
0
1
0
1
1
1
0
1
0
1
74
15
2
13
8
11
0
10
7
8
1
3
0
1
6,178
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_crud_resource_end_to_end.py
tests.integration_tests.test_crud_resource_end_to_end.TestApi
class TestApi(unittest.TestCase): def setUp(self): os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings' self.api = Api(name='api', version='v1') self.api.register_resource('dummy', DummyViewResource()) self.handler = create_http_handler(self.api) def test_crud_resource_get_list(self): url = 'dummy' user = DummyUser() http_request = MagicMock(user=user, method='GET') response = self.handler(http_request, url) assert_that(response.status_code, equal_to(200)) assert_that(json.loads(response.content), equal_to( {"objects": [{"name": "dummy"}], "meta": {"total": 1, "limit": 20, "offset": 0}}))
class TestApi(unittest.TestCase): def setUp(self): pass def test_crud_resource_get_list(self): pass
3
0
8
2
7
0
1
0
1
3
3
0
2
2
2
74
18
4
14
9
11
0
13
9
10
1
2
0
2
6,179
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_crud_resource_end_to_end.py
tests.integration_tests.test_crud_resource_end_to_end.DummyViewResource
class DummyViewResource(CrudResource): schema_cls = DummySchema entity_actions_cls = DummyEntityActions authorization_cls = DummyViewAuthorization authentication_cls = DummyAuthentication
class DummyViewResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
5
0
5
5
4
0
5
5
4
0
2
0
0
6,180
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_crud_resource_end_to_end.py
tests.integration_tests.test_crud_resource_end_to_end.DummyViewAuthorization
class DummyViewAuthorization(DefaultAuthorization): pass
class DummyViewAuthorization(DefaultAuthorization): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
6
2
0
2
1
1
0
2
1
1
0
2
0
0
6,181
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/test_crud_resource_end_to_end.py
tests.integration_tests.test_crud_resource_end_to_end.DummyEntityActions
class DummyEntityActions(DefaultEntityActions): def get_entity_list(self, request, **kwargs): return [{ 'name': 'dummy' }] def get_entity_list_total_count(self, request, **kwargs): return 1
class DummyEntityActions(DefaultEntityActions): def get_entity_list(self, request, **kwargs): pass def get_entity_list_total_count(self, request, **kwargs): pass
3
0
3
0
3
0
1
0
1
0
0
0
2
0
2
17
8
1
7
3
4
0
5
3
2
1
2
0
2
6,182
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/person_resource.py
tests.integration_tests.person_resource.PersonResource
class PersonResource(CrudResource): filter_by_fields = {'name': (EQUALS), 'nick_names': EQUALS} order_by_fields = ['name'] aggregate_by_fields = ['name'] schema_cls = PersonSchema allowed_actions = [CrudActions.READ_LIST, CrudActions.READ_DETAIL, CrudActions.UPDATE_DETAIL, CrudActions.CREATE_OR_UPDATE_DETAIL, CrudActions.CREATE_DETAIL, CrudActions.DELETE_DETAIL, CrudActions.GET_AGGREGATES] entity_actions_cls = PersonEntityActions
class PersonResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
13
0
13
7
12
0
7
7
6
0
2
0
0
6,183
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/person_resource.py
tests.integration_tests.person_resource.PersonEntityActions
class PersonEntityActions(DefaultEntityActions): @classmethod def set_mocks(cls): cls.get_entity_list = mock.MagicMock() cls.get_entity_list_total_count = mock.MagicMock() cls.get_entity_aggregates = mock.MagicMock() cls.update_entity = mock.MagicMock() cls.create_entity = mock.MagicMock() cls.delete_entity = mock.MagicMock()
class PersonEntityActions(DefaultEntityActions): @classmethod def set_mocks(cls): pass
3
0
7
0
7
0
1
0
1
0
0
0
0
0
1
16
9
0
9
3
6
0
8
2
6
1
2
0
1
6,184
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/person_resource.py
tests.integration_tests.person_resource.PersonEntity
class PersonEntity(object): def __init__(self, **kwargs): for key, value in kwargs.items(): setattr(self, key, value)
class PersonEntity(object): def __init__(self, **kwargs): pass
2
0
3
0
3
0
2
0
1
0
0
0
1
0
1
1
4
0
4
3
2
0
4
3
2
2
1
1
2
6,185
Aplopio/django_rip
Aplopio_django_rip/tests/integration_tests/person_resource.py
tests.integration_tests.person_resource.FriendResource
class FriendResource(CrudResource): filter_by_fields = {'friend_name': (EQUALS)} schema_cls = FriendSchema allowed_actions = [CrudActions.READ_LIST, CrudActions.READ_DETAIL, CrudActions.UPDATE_DETAIL] entity_actions_cls = FriendEntityActions
class FriendResource(CrudResource): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
11
7
0
7
5
6
0
5
5
4
0
2
0
0
6,186
Aplopio/django_rip
Aplopio_django_rip/rip/schema/datetime_field.py
rip.schema.datetime_field.DateTimeField
class DateTimeField(BaseField): field_type = datetime.datetime def serialize(self, request, value): if value is None: return value timezone = request.context_params['timezone'] return datetime_converter.datetime_to_timestamp( value, timezone=timezone) def clean(self, request, value): if value is None: return value timezone = request.context_params['timezone'] return datetime_converter.timestamp_to_datetime(float(value), timezone)
class DateTimeField(BaseField): def serialize(self, request, value): pass def clean(self, request, value): pass
3
0
6
0
6
0
2
0
1
1
0
0
2
0
2
6
15
2
13
6
10
0
12
6
9
2
2
1
4
6,187
Aplopio/django_rip
Aplopio_django_rip/rip/schema/email_field.py
rip.schema.email_field.EmailField
class EmailField(StringField): def validate(self, request, value): validation_result = super(EmailField, self).validate(request, value) if not validation_result.is_success: return validation_result if self.nullable and value is None: return ValidationResult(is_success=True) if value == DEFAULT_FIELD_VALUE: return ValidationResult(is_success=True) if not self.required and not value: return ValidationResult(is_success=True) if not EmailValidator().validate(email=value): return ValidationResult( is_success=False, reason=u"Invalid email address") return ValidationResult(is_success=True)
class EmailField(StringField): def validate(self, request, value): pass
2
0
17
3
14
0
6
0
1
3
2
0
1
0
1
8
18
3
15
3
13
0
14
3
12
6
3
1
6
6,188
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_string_field.py
tests.unit_tests.schema.test_string_field.TestCharField
class TestCharField(TestCase): def test_validate_returns_error_if_required_and_value_is_default(self): string_field = StringField(10, required=True) result = string_field.validate(None, DEFAULT_FIELD_VALUE) assert_that(result.is_success, equal_to(False)) assert_that(result.reason, equal_to('This field is required')) def test_validate_returns_error_for_invalid_type(self): string_field = StringField(10, required=True) result = string_field.validate(None, 1212) assert_that(result.is_success, equal_to(False)) assert_that(result.reason, equal_to('Expected type string')) def test_validate_returns_error_if_max_length_exceeds(self): string_field = StringField(max_length=1, required=True) result = string_field.validate(None, '1212') assert_that(result.is_success, equal_to(False)) assert_that(result.reason, equal_to('Maxlength of 1 exceeded')) def test_validate_returns_no_error_when_max_length_is_none(self): string_field = StringField(max_length=None, required=True) result = string_field.validate(None, '1212'* 1000) assert_that(result.is_success, equal_to(True)) def test_should_not_raise_if_not_a_required_field(self): string_field = StringField(max_length=100, required=False) result = string_field.validate(request=None, value=DEFAULT_FIELD_VALUE) assert_that(result.is_success, equal_to(True)) def test_should_return_true_when_nullable_and_value_is_none(self): string_field = StringField(max_length=100, nullable=True) result = string_field.validate(request=None, value=None) assert_that(result.is_success, equal_to(True)) def test_should_return_true_when_blank_is_true_and_value_is_blank(self): string_field = StringField() result = string_field.validate(request=None, value="") assert result.is_success is True def test_should_return_false_when_blank_is_false_and_value_is_blank(self): string_field = StringField(blank=False) result = string_field.validate(request=None, value="") assert result.is_success is False assert result.reason == "This field is required" def test_should_return_true_when_blank_is_false_and_value_is_not_blank( self): string_field = StringField(blank=False) result = string_field.validate(request=None, value="asd") assert result.is_success is True def test_should_not_strip_value(self): string_field = StringField() result = string_field.clean(request=None, value=" asd ") assert result == ' asd ' def test_should_strip_value(self): string_field = StringField(trim=True) result = string_field.clean(request=None, value=' asd ') assert result == 'asd' def test_should_strip_value_for_given_characters(self): string_field = StringField(trim=' ') result = string_field.clean(request=None, value=' asd ') assert result == 'asd'
class TestCharField(TestCase): def test_validate_returns_error_if_required_and_value_is_default(self): pass def test_validate_returns_error_for_invalid_type(self): pass def test_validate_returns_error_if_max_length_exceeds(self): pass def test_validate_returns_no_error_when_max_length_is_none(self): pass def test_should_not_raise_if_not_a_required_field(self): pass def test_should_return_true_when_nullable_and_value_is_none(self): pass def test_should_return_true_when_blank_is_true_and_value_is_blank(self): pass def test_should_return_false_when_blank_is_false_and_value_is_blank(self): pass def test_should_return_true_when_blank_is_false_and_value_is_not_blank( self): pass def test_should_not_strip_value(self): pass def test_should_strip_value(self): pass def test_should_strip_value_for_given_characters(self): pass
13
0
6
2
4
0
1
0
1
1
1
0
12
0
12
84
89
35
54
38
40
0
53
37
40
1
2
0
12
6,189
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/schema/test_url_field.py
tests.unit_tests.schema.test_url_field.TestUrlField
class TestUrlField(unittest.TestCase): def test_validate_returns_error_if_required_and_value_is_default(self): url_field = UrlField(required=True) result = url_field.validate(None, DEFAULT_FIELD_VALUE) assert_that(result.is_success, equal_to(False)) assert_that(result.reason, equal_to('This field is required')) def test_validate_returns_error_for_invalid_type(self): url_field = UrlField(required=True) result = url_field.validate(None, 1212) assert_that(result.is_success, equal_to(False)) assert_that(result.reason, equal_to('Expected type string')) def test_validate_returns_error_if_url_is_invalid(self): url_field = UrlField(required=True) result_1 = url_field.validate(None, 'hhhhh') result_2 = url_field.validate(None, 'gggg,gggg') assert_that(result_1.is_success, equal_to(False)) assert_that(result_1.reason, equal_to('The url is not valid')) assert_that(result_2.is_success, equal_to(False)) assert_that(result_2.reason, equal_to('The url is not valid')) def test_validate_returns_true_for_valid_url(self): url_field = UrlField(required=True) result_1 = url_field.validate(None, 'something.com') result_2 = url_field.validate(None, 'http://ffff.com') result_3 = url_field.validate(None, 'https://fsdfsdf.com') assert_that(result_1.is_success, equal_to(True)) assert_that(result_2.is_success, equal_to(True)) assert_that(result_3.is_success, equal_to(True)) def test_validate_returns_true_if_field_is_nullable_and_value_none(self): url_field = UrlField(nullable=True) result = url_field.validate(request=None, value=None) assert_that(result.is_success, equal_to(True))
class TestUrlField(unittest.TestCase): def test_validate_returns_error_if_required_and_value_is_default(self): pass def test_validate_returns_error_for_invalid_type(self): pass def test_validate_returns_error_if_url_is_invalid(self): pass def test_validate_returns_true_for_valid_url(self): pass def test_validate_returns_true_if_field_is_nullable_and_value_none(self): pass
6
0
8
2
6
0
1
0
1
1
1
0
5
0
5
77
45
14
31
19
25
0
31
19
25
1
2
0
5
6,190
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/test_api.py
tests.unit_tests.test_api.TestApi
class TestApi(unittest.TestCase): def setUp(self): self.http_api = Api(name='api', version='v1') self.action1 = MagicMock(spec=PipelineComposer) self.action2 = MagicMock(spec=PipelineComposer) class TestSchema(ApiSchema): name = StringField(max_length=100) class Meta: schema_name = 'test_objs' class TestResource(CrudResource): action1 = self.action1 action2 = self.action2 schema_cls = TestSchema class TestViewResource_1(ViewResource): schema_cls = TestSchema class TestViewResource_2(ViewResource): schema_cls = TestSchema self.TestResource = TestResource self.TestViewResource_1 = TestViewResource_1 self.TestViewResource_2 = TestViewResource_2 def test_registered_crud_resource_should_be_accessible_to_call(self): test_resource = self.TestResource() # Making an assumption that Resource schema name will be used to # access -> Useful for serialization self.http_api.register_resource('test_objs', test_resource) request = Request(user=None, request_params={}) resource = self.http_api.resolve_resource('test_objs') resource.action1(request=request) def test_registered_view_resources_should_be_accessible_to_call(self): test_view_resource_1 = self.TestViewResource_1() test_view_resource_2 = self.TestViewResource_2() self.http_api.register_resource('foo/bar', test_view_resource_1) self.http_api.register_resource('boo/car', test_view_resource_2) request = Request(user=None, request_params={}) resource_1 = self.http_api.resolve_resource('foo/bar') resource_2 = self.http_api.resolve_resource('boo/car') endpoint_1 = self.http_api.resolve_endpoint('foo/bar') endpoint_2 = self.http_api.resolve_endpoint('boo/car') assert isinstance(resource_1, self.TestViewResource_1) assert isinstance(resource_2, self.TestViewResource_2) assert endpoint_1 == 'foo/bar' assert endpoint_2 == 'boo/car' def test_register_with_mismatching_schema_raises(self): test_resource = self.TestResource() self.assertRaises(ValueError, self.http_api.register_resource, 'invalid_name', test_resource) def test_registered_action_should_be_accessible_to_call(self): pass
class TestApi(unittest.TestCase): def setUp(self): pass class TestSchema(ApiSchema): class Meta: class TestResource(CrudResource): class TestViewResource_1(ViewResource): class TestViewResource_2(ViewResource): def test_registered_crud_resource_should_be_accessible_to_call(self): pass def test_registered_view_resources_should_be_accessible_to_call(self): pass def test_register_with_mismatching_schema_raises(self): pass def test_registered_action_should_be_accessible_to_call(self): pass
11
0
12
2
9
0
1
0.04
1
7
6
0
5
6
5
77
64
16
46
35
35
2
45
35
34
1
2
0
5
6,191
Aplopio/django_rip
Aplopio_django_rip/tests/unit_tests/test_api_schema_construction.py
tests.unit_tests.test_api_schema_construction.TestApiSchemaConstruction
class TestApiSchemaConstruction(unittest.TestCase): def setUp(self): class TestSchema(ApiSchema): email = EmailField(max_length=50) char = StringField(required=True, max_length=100) boolean = BooleanField() class Meta: schema_name = 'asdf' self.TestSchema = TestSchema def test_should_generate_fields_attribute(self): TestSchema = self.TestSchema self.assertTrue(hasattr(TestSchema._meta, 'fields')) self.assertIn('email', TestSchema._meta.fields) self.assertIn('char', TestSchema._meta.fields) self.assertIn('boolean', TestSchema._meta.fields) def test_attributes_should_be_set_on_instance(self): test_schema_obj = self.TestSchema(email='a@b.com', char='asdf', boolean=True) self.assertEqual(test_schema_obj.email, 'a@b.com') self.assertEqual(test_schema_obj.char, 'asdf') self.assertTrue(test_schema_obj.boolean) def test_should_raise_exception_for_missing_name(self): class NameLessSchema(ApiSchema): email = EmailField(max_length=50) char = StringField(required=True, max_length=100) boolean = BooleanField() self.assertRaises(TypeError, NameLessSchema, email='asdf', char='char', boolean='boolean') def test_should_inherit_fields(self): class NewSchema(self.TestSchema): new_field = EmailField(max_length=20) self.assertTrue('new_field' in NewSchema._meta.fields) self.assertTrue('new_field' in NewSchema._meta.declared_fields)
class TestApiSchemaConstruction(unittest.TestCase): def setUp(self): pass class TestSchema(ApiSchema): class Meta: def test_should_generate_fields_attribute(self): pass def test_attributes_should_be_set_on_instance(self): pass def test_should_raise_exception_for_missing_name(self): pass class NameLessSchema(ApiSchema): def test_should_inherit_fields(self): pass class NewSchema(self.TestSchema):
10
0
8
1
7
0
1
0
1
4
3
0
5
1
5
77
44
10
34
21
24
0
31
21
21
1
2
0
5
6,192
Aplopio/django_rip
Aplopio_django_rip/rip/schema/list_sub_resource_field.py
rip.schema.list_sub_resource_field.ListSubResourceField
class ListSubResourceField(SubResourceField): """`ListSubResourceField` inherits from `SubResourceField`. This field enables one to many relationship between the parent resource and the """ def __init__(self, resource_cls, related_filter, required=False, nullable=True, entity_attribute='id', show_in_list=True): super(ListSubResourceField, self).__init__( resource_cls, related_filter, required, nullable, entity_attribute, show_in_list=show_in_list) self.null_return_value = [] def get_data(self, resource_obj, request): return resource_obj.read_list(request) def get_data_from_response(self, response): return response.data['objects']
class ListSubResourceField(SubResourceField): '''`ListSubResourceField` inherits from `SubResourceField`. This field enables one to many relationship between the parent resource and the ''' def __init__(self, resource_cls, related_filter, required=False, nullable=True, entity_attribute='id', show_in_list=True): pass def get_data(self, resource_obj, request): pass def get_data_from_response(self, response): pass
4
1
3
0
3
0
1
0.36
1
1
0
0
3
1
3
11
18
3
11
6
6
4
8
5
4
1
3
0
3
6,193
Aplopio/django_rip
Aplopio_django_rip/rip/api.py
rip.api.Api
class Api(object): def __init__(self, name, version='v1'): self.name = name self.version = version self.resources = {} self.actions = {} self.resources_lookup = {} def register_resource(self, endpoint, resource): if endpoint in self.resources or self.actions: raise AttributeError( '{endpoint} already registered for another resource/action'. format(endpoint=endpoint)) elif isinstance(resource, ViewResource): self.resources[endpoint] = resource self.resources_lookup[endpoint] = (endpoint, resource) elif endpoint.split('/')[-1] != resource.configuration['schema_cls'].\ _meta.schema_name: # This is a requirement to ensure resource_uri calculation and # serialization of related fields works correctly. # TODO: come up with a better way to solve this raise ValueError( 'endpoint name `{endpoint}` does match schema_name of resource'. format(endpoint=endpoint)) else: self.resources[endpoint] = resource endpoint_parts = endpoint.split('/')[::2] self.resources_lookup["/".join(endpoint_parts)] = ( endpoint, resource) def register_action(self, action): pass def resolve_resource(self, url): url_parts = url.split('/')[::2] lookup = self.resources_lookup.get("/".join(url_parts)) if not lookup: lookup = self.resources_lookup.get(url) return lookup[1] if lookup else None def resolve_endpoint(self, url): url_parts = url.split('/')[::2] lookup = self.resources_lookup.get("/".join(url_parts)) if not lookup: lookup = self.resources_lookup.get(url) return lookup[0] if lookup else None
class Api(object): def __init__(self, name, version='v1'): pass def register_resource(self, endpoint, resource): pass def register_action(self, action): pass def resolve_resource(self, url): pass def resolve_endpoint(self, url): pass
6
0
8
0
8
1
2
0.08
1
3
1
0
5
5
5
5
46
4
39
16
33
3
30
16
24
4
1
1
12
6,194
Aplopio/django_rip
Aplopio_django_rip/rip/api_schema.py
rip.api_schema.ApiSchema
class ApiSchema(six.with_metaclass(ApiSchemaMetaClass)): def __new__(cls, *args, **kwargs): if not hasattr(cls._meta, 'schema_name'): raise TypeError( 'Missing meta property `schema_name` on Schema `{schema_cls}`' .format(schema_cls=cls.__name__)) obj = super(ApiSchema, cls).__new__(cls, *args, **kwargs) return obj def __init__(self, **kwargs): for key, value in kwargs.items(): setattr(self, key, value) def __eq__(self, value): for field_name, field_object in self._meta.fields.items(): if getattr(self, field_name) != getattr(value, field_name): return False return True @classmethod def non_readonly_fields(cls): return {field_name: field for field_name, field in cls._meta.fields.items() if field.field_type != FieldTypes.READONLY} @classmethod def updatable_fields(cls): return {field_name: field for field_name, field in cls._meta.fields.items() if field.field_type == FieldTypes.DEFAULT} @classmethod def sub_resource_fields(cls): return {field_name: field for field_name, field in cls._meta.fields.items() if isinstance(field, SubResourceField)} @classmethod def list_fields(cls): return {field_name: field for field_name, field in cls._meta.fields.items() if field.show_in_list}
class ApiSchema(six.with_metaclass(ApiSchemaMetaClass)): def __new__(cls, *args, **kwargs): pass def __init__(self, **kwargs): pass def __eq__(self, value): pass @classmethod def non_readonly_fields(cls): pass @classmethod def updatable_fields(cls): pass @classmethod def sub_resource_fields(cls): pass @classmethod def list_fields(cls): pass
12
0
5
0
4
0
2
0
1
4
2
18
3
0
7
7
44
8
36
15
24
0
22
11
14
3
1
2
11
6,195
Aplopio/django_rip
Aplopio_django_rip/rip/api_schema.py
rip.api_schema.ApiSchemaMetaClass
class ApiSchemaMetaClass(type): def __new__(cls, name, bases, attrs): fields = {} declared_fields = {} # Inherit any fields from parent(s). try: parents = [b for b in bases if issubclass(b, ApiSchema)] # Simulate the MRO. parents.reverse() for p in parents: meta_on_parent = getattr(p, '_meta', None) fields_declared_on_parent = meta_on_parent.fields if meta_on_parent else {} for field_name, field in fields_declared_on_parent.items(): fields[field_name] = field except NameError: pass for field_name, field in attrs.copy().items(): # Runs only once during class construction. # Copy should not be a performance hit. if isinstance(field, BaseField): field = attrs.pop(field_name) declared_fields[field_name] = field fields.update(declared_fields) new_class = super(ApiSchemaMetaClass, cls).__new__(cls, name, bases, attrs) for field_name, field in fields.items(): field.schema_cls = new_class meta = getattr(new_class, 'Meta', None) new_class._meta = ApiSchemaOptions(meta, fields, declared_fields) return new_class
class ApiSchemaMetaClass(type): def __new__(cls, name, bases, attrs): pass
2
0
37
8
25
4
8
0.15
1
5
3
0
1
0
1
14
38
8
26
11
24
4
25
11
23
8
2
3
8
6,196
Aplopio/django_rip
Aplopio_django_rip/rip/api_schema.py
rip.api_schema.ApiSchemaOptions
class ApiSchemaOptions(object): def __init__(self, meta_options, fields, declared_fields): if meta_options: for override_name in dir(meta_options): override = getattr(meta_options, override_name) setattr(self, override_name, override) self.fields = fields self.declared_fields = declared_fields
class ApiSchemaOptions(object): def __init__(self, meta_options, fields, declared_fields): pass
2
0
8
1
7
0
3
0
1
0
0
0
1
2
1
1
9
1
8
6
6
0
8
6
6
3
1
2
3
6,197
Aplopio/django_rip
Aplopio_django_rip/rip/crud/crud_actions.py
rip.crud.crud_actions.CrudActions
class CrudActions(object): GET_AGGREGATES = 'get_aggregates' READ_LIST = 'read_list' READ_DETAIL = 'read_detail' CREATE_DETAIL = 'create_detail' DELETE_DETAIL = 'delete_detail' UPDATE_DETAIL = 'update_detail' CREATE_OR_UPDATE_DETAIL = 'create_or_update_detail' _reverse_dictionary = None @classmethod def _get_reverse_dictionary(cls): if not cls._reverse_dictionary: cls._reverse_dictionary = _build_reverse_dictionary(cls) return cls._reverse_dictionary @classmethod def resolve_action(cls, name): cls_attr = cls._get_reverse_dictionary()[name] return getattr(cls, cls_attr) @classmethod def get_all_actions(cls): return ( cls.GET_AGGREGATES, cls.READ_LIST, cls.READ_DETAIL, cls.CREATE_DETAIL, cls.DELETE_DETAIL, cls.UPDATE_DETAIL, cls.CREATE_OR_UPDATE_DETAIL )
class CrudActions(object): @classmethod def _get_reverse_dictionary(cls): pass @classmethod def resolve_action(cls, name): pass @classmethod def get_all_actions(cls): pass
7
0
6
0
6
0
1
0
1
0
0
0
0
0
3
3
32
3
29
16
22
0
18
13
14
2
1
1
4
6,198
Aplopio/django_rip
Aplopio_django_rip/rip/crud/crud_resource.py
rip.crud.crud_resource.CrudResource
class CrudResource(object): """ Defines a Resource with CRUD actions implemented in as as series of steps in a pipeline If your resource confirms to the basic CRUD actions in Rest, then inherit from this class Usually you don't have to override methods because steps can be overridden in the configuration attributes An example: class Tweet(CrudResource): schema_cls = TweetSchema allowed_actions= [CrudActions.READ_LIST, CrudActions.READ_DETAIL, CrudActions.UPDATE_DETAIL, CrudActions.CREATE_DETAIL, CrudActions.DELETE_DETAIL] # list of allowed actions entity_actions_cls = TweetEntityActions # A mandatory hook class # that has methods for actions on #entities serializer_cls = TweetEntitySerializer # A hook class # for serializing entity to json authentication_cls = TweetAuthentication # A hook class that authenticates # a request. # Default: it checks # if a valid user is present on the # request authorization_cls = TweetAuthorization # A hook class # that controls access to entities # Default: there is no authorization allowed_filters = {'id': (EQUALS)} # allowed filters on entity default_limit = 20 # page limit for get_list default_offset = 0 # default page offset for get_list """ schema_cls = None allowed_actions = [CrudActions.READ_DETAIL, CrudActions.READ_LIST] filter_by_fields = {} order_by_fields = [] aggregate_by_fields = [] default_offset = 0 default_limit = 20 authentication_cls = DefaultAuthentication authorization_cls = DefaultAuthorization request_params_validation_cls = DefaultRequestParamsValidation schema_validation_cls = DefaultSchemaValidation data_cleaner_cls = DefaultRequestCleaner entity_actions_cls = DefaultEntityActions post_action_hooks_cls = DefaultPostActionHooks response_converter_cls = DefaultResponseConverter serializer_cls = DefaultEntitySerializer def _setup_configuration(self): """ All steps are accepted as classes. Instantiate them with the right configuration and set them in a local property. """ self.configuration = dict( schema_cls=self.schema_cls, allowed_actions=self.allowed_actions, filter_by_fields=self.filter_by_fields, order_by_fields=self.order_by_fields, aggregate_by_fields=self.aggregate_by_fields, default_offset=self.default_offset, default_limit=self.default_limit) authentication = self.authentication_cls(schema_cls=self.schema_cls) authorization = self.authorization_cls(schema_cls=self.schema_cls) request_params_validation = self.request_params_validation_cls( schema_cls=self.schema_cls, filter_by_fields=self.filter_by_fields, order_by_fields=self.order_by_fields, aggregate_by_fields=self.aggregate_by_fields ) schema_validation = self.schema_validation_cls( schema_cls=self.schema_cls) data_cleaner = self.data_cleaner_cls(schema_cls=self.schema_cls) entity_actions = self.entity_actions_cls( schema_cls=self.schema_cls, default_limit=self.default_limit, default_offset=self.default_offset) post_action_hooks = self.post_action_hooks_cls( schema_cls=self.schema_cls) response_converter = self.response_converter_cls( schema_cls=self.schema_cls) serializer = self.serializer_cls(schema_cls=self.schema_cls) self.configuration.update(dict( authentication=authentication, authorization=authorization, request_params_validation=request_params_validation, schema_validation=schema_validation, data_cleaner=data_cleaner, entity_actions=entity_actions, post_action_hooks=post_action_hooks, response_converter=response_converter, serializer=serializer)) def __new__(cls, *args, **kwargs): if cls.schema_cls is None: raise TypeError('Missing configuration property `schema_cls` \ on Resource `{resource_name}`' .format(resource_name=cls.__name__)) obj = super(CrudResource, cls).__new__(cls, *args, **kwargs) return obj def __init__(self): super(CrudResource, self).__init__() self._setup_configuration() def is_action_allowed(self, action_name): """ Returns if a particular action is allowed on the resource as set in the allowed_actions attribute :param action_name:string :values as defined in CrudActions :return: bool """ if action_name not in self.allowed_actions: return False return True @validate_action def read_detail(self, request): """ Implements the Read Detail (read an object) maps to GET /api/objects/:id/ in rest semantics :param request: rip.Request :return: rip.Response """ pipeline = crud_pipeline_factory.read_detail_pipeline( configuration=self.configuration) return pipeline(request=request) @validate_action def update_detail(self, request): """ Implements the Update Detail (partially update an object) maps to PATCH /api/object/:id/ in rest semantics :param request: rip.Request :return: rip.Response """ pipeline = crud_pipeline_factory.update_detail_pipeline( configuration=self.configuration) return pipeline(request=request) @validate_action def read_list(self, request): """ Implements the List read (get a list of objects) maps to GET /api/objects/ in rest semantics :param request: rip.Request :return: rip.Response """ pipeline = crud_pipeline_factory.read_list_pipeline( configuration=self.configuration) return pipeline(request=request) @validate_action def create_detail(self, request): """ Implements the Create Detail (create an object) maps to POST /api/objects/ in rest semantics :param request: rip.Request :return: rip.Response """ pipeline = crud_pipeline_factory.create_detail_pipeline( configuration=self.configuration) return pipeline(request=request) @validate_action def delete_detail(self, request): """ Implements the Delete Detail (delete an object) maps to DELETE /api/object_name/:id/ in rest semantics :param request: rip.Request :return: rip.Response """ pipeline = crud_pipeline_factory.delete_detail_pipeline( configuration=self.configuration) return pipeline(request=request) @validate_action def get_aggregates(self, request): """ Implements the Get aggregates (total number of objects filtered) maps to PATCH /api/object_name/get_aggregates/ in rest semantics :param request: rip.Request :return: rip.Response """ pipeline = crud_pipeline_factory.get_aggregates_pipeline( configuration=self.configuration) return pipeline(request=request) @validate_action def create_or_update_detail(self, request): """ Implements Create/Update an object completely given an id maps to PUT /api/object/:id in rest semantics :param request: rip.Request :return: rip.Response """ pipeline = crud_pipeline_factory.create_or_update_detail_pipeline( configuration=self.configuration) return pipeline(request=request)
class CrudResource(object): ''' Defines a Resource with CRUD actions implemented in as as series of steps in a pipeline If your resource confirms to the basic CRUD actions in Rest, then inherit from this class Usually you don't have to override methods because steps can be overridden in the configuration attributes An example: class Tweet(CrudResource): schema_cls = TweetSchema allowed_actions= [CrudActions.READ_LIST, CrudActions.READ_DETAIL, CrudActions.UPDATE_DETAIL, CrudActions.CREATE_DETAIL, CrudActions.DELETE_DETAIL] # list of allowed actions entity_actions_cls = TweetEntityActions # A mandatory hook class # that has methods for actions on #entities serializer_cls = TweetEntitySerializer # A hook class # for serializing entity to json authentication_cls = TweetAuthentication # A hook class that authenticates # a request. # Default: it checks # if a valid user is present on the # request authorization_cls = TweetAuthorization # A hook class # that controls access to entities # Default: there is no authorization allowed_filters = {'id': (EQUALS)} # allowed filters on entity default_limit = 20 # page limit for get_list default_offset = 0 # default page offset for get_list ''' def _setup_configuration(self): ''' All steps are accepted as classes. Instantiate them with the right configuration and set them in a local property. ''' pass def __new__(cls, *args, **kwargs): pass def __init__(self): pass def is_action_allowed(self, action_name): ''' Returns if a particular action is allowed on the resource as set in the allowed_actions attribute :param action_name:string :values as defined in CrudActions :return: bool ''' pass @validate_action def read_detail(self, request): ''' Implements the Read Detail (read an object) maps to GET /api/objects/:id/ in rest semantics :param request: rip.Request :return: rip.Response ''' pass @validate_action def update_detail(self, request): ''' Implements the Update Detail (partially update an object) maps to PATCH /api/object/:id/ in rest semantics :param request: rip.Request :return: rip.Response ''' pass @validate_action def read_list(self, request): ''' Implements the List read (get a list of objects) maps to GET /api/objects/ in rest semantics :param request: rip.Request :return: rip.Response ''' pass @validate_action def create_detail(self, request): ''' Implements the Create Detail (create an object) maps to POST /api/objects/ in rest semantics :param request: rip.Request :return: rip.Response ''' pass @validate_action def delete_detail(self, request): ''' Implements the Delete Detail (delete an object) maps to DELETE /api/object_name/:id/ in rest semantics :param request: rip.Request :return: rip.Response ''' pass @validate_action def get_aggregates(self, request): ''' Implements the Get aggregates (total number of objects filtered) maps to PATCH /api/object_name/get_aggregates/ in rest semantics :param request: rip.Request :return: rip.Response ''' pass @validate_action def create_or_update_detail(self, request): ''' Implements Create/Update an object completely given an id maps to PUT /api/object/:id in rest semantics :param request: rip.Request :return: rip.Response ''' pass
19
10
13
1
7
5
1
0.81
1
3
0
16
11
1
11
11
221
31
105
53
86
85
62
46
50
2
1
1
13
6,199
Aplopio/django_rip
Aplopio_django_rip/rip/django_adapter/django_response_builder.py
rip.django_adapter.django_response_builder.HttpAuthenticationFailed
class HttpAuthenticationFailed(HttpResponse): status_code = 401
class HttpAuthenticationFailed(HttpResponse): pass
1
0
0
0
0
0
0
0
1
0
0
0
0
0
0
0
2
0
2
2
1
0
2
2
1
0
1
0
0