Attachment #124479 for bug #28948

View | Details | Raw Unified | Return to bug 28948
Collapse All | Expand All




    };
}

=head3 api_privileged_attrs

This method returns the list of privileged access-only attributes. This is used
by $library->to_api($params) to render the object correctly, based on the passed I<$params>.

=cut

sub api_privileged_attrs {
    return [
        'illemail',
        'reply_to_email',
        'return_path_email',
        'ip',
        'notes',
        'marc_org_code'
    ];
}


=head3 get_hold_libraries

Return all libraries (including self) that belong to the same hold groups




                    ...
                }
            },
            public => 0|1,
            ...
         ]
        }

        }
    }

    # Remove forbidden attributes if required
    if (    $params->{public}
        and $self->can('api_privileged_attrs') )
    {
        foreach my $privileged_attr ( @{ $self->api_privileged_attrs } ) {
            delete $json_object->{$privileged_attr};
        }
    }

    # Make sure we duplicate the $params variable to avoid
    # breaking calls in a loop (Koha::Objects->to_api)
    $params    = {%$params};
    my $embeds = delete $params->{embed};

    if ($embeds) {
        foreach my $embed ( keys %{$embeds} ) {

                if ( defined $children and ref($children) eq 'ARRAY' ) {
                    my @list = map {
                        $self->_handle_to_api_child(
                            {
                                child  => $_,
                                next   => $next,
                                curr   => $curr,
                                params => $params
                            }
                        )
                    } @{$children};
                    $json_object->{$curr} = \@list;
                }
                else {
                    $json_object->{$curr} = $self->_handle_to_api_child(
                        {
                            child  => $children,
                            next   => $next,
                            curr   => $curr,
                            params => $params
                        }
                    );
                }
            }
        }
    }



    return $json_object;
}


sub _handle_to_api_child {
    my ($self, $args ) = @_;

    my $child  = $args->{child};
    my $next   = $args->{next};
    my $curr   = $args->{curr};
    my $params = $args->{params};

    my $res;


            if defined $next and blessed $child and !$child->can('to_api');

        if ( blessed $child ) {
            $params->{embed} = $next;
            $res = $child->to_api($params);
        }
        else {
            $res = $child;





subtest "to_api() tests" => sub {

    plan tests => 29;

    $schema->storage->txn_begin;


        'Koha::Exceptions::Object::MethodNotCoveredByTests',
        'Unknown method exception thrown if is_count not specified';

    subtest 'unprivileged request tests' => sub {

        my @privileged_attrs = @{ Koha::Library->api_privileged_attrs };

        plan tests => scalar @privileged_attrs * 2;

        # Create a sample library
        my $library = $builder->build_object( { class => 'Koha::Libraries' } );

        my $unprivileged_representation = $library->to_api({ public => 1 });
        my $privileged_representation   = $library->to_api;

        foreach my $privileged_attr ( @privileged_attrs ) {
            ok( exists $privileged_representation->{$privileged_attr},
                "Attribute $privileged_attr' is present" );
            ok( !exists $unprivileged_representation->{$privileged_attr},
                "Attribute '$privileged_attr' is not present" );
        }
    };

    $schema->storage->txn_rollback;
};






subtest "to_api() tests" => sub {

    plan tests => 19;

    $schema->storage->txn_begin;


        $i++;
    }

    subtest 'unprivileged request tests' => sub {

        my @privileged_attrs = @{ Koha::Library->api_privileged_attrs };

        # Create sample libraries
        my $library_1 = $builder->build_object({ class => 'Koha::Libraries' });
        my $library_2 = $builder->build_object({ class => 'Koha::Libraries' });
        my $library_3 = $builder->build_object({ class => 'Koha::Libraries' });
        my $libraries = Koha::Libraries->search(
            {
                branchcode => {
                    '-in' => [
                        $library_1->branchcode, $library_2->branchcode,
                        $library_3->branchcode
                    ]
                }
            }
        );

        plan tests => scalar @privileged_attrs * 2 * $libraries->count;

        my $libraries_unprivileged_representation = $libraries->to_api({ public => 1 });
        my $libraries_privileged_representation   = $libraries->to_api();

        for (my $i = 0; $i < $libraries->count; $i++) {
            my $privileged_representation   = $libraries_privileged_representation->[$i];
            my $unprivileged_representation = $libraries_unprivileged_representation->[$i];
            foreach my $privileged_attr ( @privileged_attrs ) {
                ok( exists $privileged_representation->{$privileged_attr},
                    "Attribute $privileged_attr' is present" );
                ok( !exists $unprivileged_representation->{$privileged_attr},
                    "Attribute '$privileged_attr' is not present" );
            }
        }
    };


    $schema->storage->txn_rollback;
};

- 

Return to bug 28948

Lines 258-263 sub to_api_mapping { Link Here

(-)a/Koha/Library.pm (+19 lines)
258	};	258	};
259	}	259	}
260		260
		261	=head3 api_privileged_attrs
		262
		263	This method returns the list of privileged access-only attributes. This is used
		264	by $library->to_api($params) to render the object correctly, based on the passed I<$params>.
		265
		266	=cut
		267
		268	sub api_privileged_attrs {
		269	return [
		270	'illemail',
		271	'reply_to_email',
		272	'return_path_email',
		273	'ip',
		274	'notes',
		275	'marc_org_code'
		276	];
		277	}
		278
		279
261	=head3 get_hold_libraries	280	=head3 get_hold_libraries
262		281
263	Return all libraries (including self) that belong to the same hold groups	282	Return all libraries (including self) that belong to the same hold groups

Lines 538-543 sub prefetch_whitelist { Link Here

(-)a/Koha/Object.pm (-9 / +34 lines)
538	...	538	...
539	}	539	}
540	},	540	},
		541	public => 0\|1,
541	...	542	...
542	]	543	]
543	}	544	}
Lines 572-578 sub to_api { Link Here
572	}	573	}
573	}	574	}
574		575
575	my $embeds = $params->{embed};	576	# Remove forbidden attributes if required
		577	if ( $params->{public}
		578	and $self->can('api_privileged_attrs') )
		579	{
		580	foreach my $privileged_attr ( @{ $self->api_privileged_attrs } ) {
		581	delete $json_object->{$privileged_attr};
		582	}
		583	}
		584
		585	# Make sure we duplicate the $params variable to avoid
		586	# breaking calls in a loop (Koha::Objects->to_api)
		587	$params = {%$params};
		588	my $embeds = delete $params->{embed};
576		589
577	if ($embeds) {	590	if ($embeds) {
578	foreach my $embed ( keys %{$embeds} ) {	591	foreach my $embed ( keys %{$embeds} ) {
Lines 591-610 sub to_api { Link Here
591	if ( defined $children and ref($children) eq 'ARRAY' ) {	604	if ( defined $children and ref($children) eq 'ARRAY' ) {
592	my @list = map {	605	my @list = map {
593	$self->_handle_to_api_child(	606	$self->_handle_to_api_child(
594	{ child => $_, next => $next, curr => $curr } )	607	{
		608	child => $_,
		609	next => $next,
		610	curr => $curr,
		611	params => $params
		612	}
		613	)
595	} @{$children};	614	} @{$children};
596	$json_object->{$curr} = \@list;	615	$json_object->{$curr} = \@list;
597	}	616	}
598	else {	617	else {
599	$json_object->{$curr} = $self->_handle_to_api_child(	618	$json_object->{$curr} = $self->_handle_to_api_child(
600	{ child => $children, next => $next, curr => $curr } );	619	{
		620	child => $children,
		621	next => $next,
		622	curr => $curr,
		623	params => $params
		624	}
		625	);
601	}	626	}
602	}	627	}
603	}	628	}
604	}	629	}
605		630
606
607
608	return $json_object;	631	return $json_object;
609	}	632	}
610		633
Lines 850-858 sub _type { } Link Here
850	sub _handle_to_api_child {	873	sub _handle_to_api_child {
851	my ($self, $args ) = @_;	874	my ($self, $args ) = @_;
852		875
853	my $child = $args->{child};	876	my $child = $args->{child};
854	my $next = $args->{next};	877	my $next = $args->{next};
855	my $curr = $args->{curr};	878	my $curr = $args->{curr};
		879	my $params = $args->{params};
856		880
857	my $res;	881	my $res;
858		882
Lines 862-868 sub _handle_to_api_child { Link Here
862	if defined $next and blessed $child and !$child->can('to_api');	886	if defined $next and blessed $child and !$child->can('to_api');
863		887
864	if ( blessed $child ) {	888	if ( blessed $child ) {
865	$res = $child->to_api({ embed => $next });	889	$params->{embed} = $next;
		890	$res = $child->to_api($params);
866	}	891	}
867	else {	892	else {
868	$res = $child;	893	$res = $child;

Lines 223-229 subtest 'TO_JSON tests' => sub { Link Here

(-)a/t/db_dependent/Koha/Object.t (-1 / +21 lines)
223		223
224	subtest "to_api() tests" => sub {	224	subtest "to_api() tests" => sub {
225		225
226	plan tests => 28;	226	plan tests => 29;
227		227
228	$schema->storage->txn_begin;	228	$schema->storage->txn_begin;
229		229
Lines 373-378 subtest "to_api() tests" => sub { Link Here
373	'Koha::Exceptions::Object::MethodNotCoveredByTests',	373	'Koha::Exceptions::Object::MethodNotCoveredByTests',
374	'Unknown method exception thrown if is_count not specified';	374	'Unknown method exception thrown if is_count not specified';
375		375
		376	subtest 'unprivileged request tests' => sub {
		377
		378	my @privileged_attrs = @{ Koha::Library->api_privileged_attrs };
		379
		380	plan tests => scalar @privileged_attrs * 2;
		381
		382	# Create a sample library
		383	my $library = $builder->build_object( { class => 'Koha::Libraries' } );
		384
		385	my $unprivileged_representation = $library->to_api({ public => 1 });
		386	my $privileged_representation = $library->to_api;
		387
		388	foreach my $privileged_attr ( @privileged_attrs ) {
		389	ok( exists $privileged_representation->{$privileged_attr},
		390	"Attribute $privileged_attr' is present" );
		391	ok( !exists $unprivileged_representation->{$privileged_attr},
		392	"Attribute '$privileged_attr' is not present" );
		393	}
		394	};
		395
376	$schema->storage->txn_rollback;	396	$schema->storage->txn_rollback;
377	};	397	};
378		398

Lines 313-319 subtest '->search() tests' => sub { Link Here

(-)a/t/db_dependent/Koha/Objects.t (-2 / +38 lines)
313		313
314	subtest "to_api() tests" => sub {	314	subtest "to_api() tests" => sub {
315		315
316	plan tests => 18;	316	plan tests => 19;
317		317
318	$schema->storage->txn_begin;	318	$schema->storage->txn_begin;
319		319
Lines 396-401 subtest "to_api() tests" => sub { Link Here
396	$i++;	396	$i++;
397	}	397	}
398		398
		399	subtest 'unprivileged request tests' => sub {
		400
		401	my @privileged_attrs = @{ Koha::Library->api_privileged_attrs };
		402
		403	# Create sample libraries
		404	my $library_1 = $builder->build_object({ class => 'Koha::Libraries' });
		405	my $library_2 = $builder->build_object({ class => 'Koha::Libraries' });
		406	my $library_3 = $builder->build_object({ class => 'Koha::Libraries' });
		407	my $libraries = Koha::Libraries->search(
		408	{
		409	branchcode => {
		410	'-in' => [
		411	$library_1->branchcode, $library_2->branchcode,
		412	$library_3->branchcode
		413	]
		414	}
		415	}
		416	);
		417
		418	plan tests => scalar @privileged_attrs * 2 * $libraries->count;
		419
		420	my $libraries_unprivileged_representation = $libraries->to_api({ public => 1 });
		421	my $libraries_privileged_representation = $libraries->to_api();
		422
		423	for (my $i = 0; $i < $libraries->count; $i++) {
		424	my $privileged_representation = $libraries_privileged_representation->[$i];
		425	my $unprivileged_representation = $libraries_unprivileged_representation->[$i];
		426	foreach my $privileged_attr ( @privileged_attrs ) {
		427	ok( exists $privileged_representation->{$privileged_attr},
		428	"Attribute $privileged_attr' is present" );
		429	ok( !exists $unprivileged_representation->{$privileged_attr},
		430	"Attribute '$privileged_attr' is not present" );
		431	}
		432	}
		433	};
		434
		435
399	$schema->storage->txn_rollback;	436	$schema->storage->txn_rollback;
400	};	437	};
401		438
402	-