Contribute: Plugins/ImportPluginsAWS - Revision history

Libjlrs: Code formatting

2021-05-24T11:13:59Z

Code formatting

← Older revision		Revision as of 11:13, 24 May 2021
Line 24:		Line 24:
	The code in the section below should be placed in a file called CSV.pm in the directory created previously, and MyPlugins should be changed to the name of that directory.		The code in the section below should be placed in a file called CSV.pm in the directory created previously, and MyPlugins should be changed to the name of that directory.

	<~~pre~~>		<syntaxhighlight lang="perl">
	package EPrints::Plugin::Import::MyPlugins::AWS;		package EPrints::Plugin::Import::MyPlugins::AWS;

Line 179:		Line 179:

	1;		1;
	</~~pre~~>		</syntaxhighlight>

	= In More Detail =		= In More Detail =

Pm705 at 13:34, 8 February 2010

2010-02-08T13:34:05Z

← Older revision		Revision as of 13:34, 8 February 2010
Line 1:		Line 1:
			[[Category:Contribute]]
			[[Category:Plugins]]
	= Import Plugin Tutorial 2: Amazon Web Services =		= Import Plugin Tutorial 2: Amazon Web Services =

Tom: /* In More Detail */

2007-09-28T19:16:02Z

In More Detail

← Older revision		Revision as of 19:16, 28 September 2007
Line 185:		Line 185:
	</pre>		</pre>

	Here we setup a number of values for parameters that will be part of our web service requests. The endpoint variable determines which server will be sent the request. Here we have used the UK server, but by changing the TLD we can use the US, Canadian, German or French servers.		Here we setup a number of values for parameters that will be part of our web service requests. The endpoint variable determines which server will be sent the request. Here we have used the UK server, but by changing the [http://en.wikipedia.org/wiki/TLD TLD] we can use the US, Canadian, German or French servers.

	The accesskey stores the access key you will have gained from signing up to Amazon earlier. You should use the normal access key and not the secret one.		The accesskey variable stores the access key you will have gained from signing up to Amazon earlier. You should use the normal access key and not the secret one.

	Here we use the ItemLookup operation of the AWSECommerceService with the 2007-07-16 version of the ~~service~~ API. Other operations allow searching for items, but here we want to look up specific products. Finally the variable responsegroup determines the amount and nature of the information returned, we select "Large" in this case, ~~giving a lot of~~ information about the item.		Here we use the ItemLookup operation of the AWSECommerceService with the 2007-07-16 version of the API. Other operations allow searching for items, but here we want to look up specific products. Finally the variable responsegroup determines the amount and nature of the information returned, we select "Large" in this case, which gives us more information about the item.

	<pre>		<pre>
Line 201:		Line 201:

	== Constructor ==		== Constructor ==
	The constructor is similar to the one used for the CSV plugin, except this one will import individual eprints, given an ASIN.		The constructor is similar to the one used for the [Contribute:_Plugins/ImportPluginsCSV CSV plugin], except this one will import individual eprints, given an [http://en.wikipedia.org/wiki/ASIN ASIN].
	<pre>		<pre>
	$self->{produce} = [ 'list/eprint' , 'dataobj/eprint'];		$self->{produce} = [ 'list/eprint' , 'dataobj/eprint'];
	</pre>		</pre>

	Like we imported Text::CSV in the last tutorial, here we import LWP::UserAgent which will be used for making requests to the web service.		Like we imported Text::CSV in the [Contribute:_Plugins/ImportPluginsCSV last tutorial], here we import LWP::UserAgent which will be used for making requests to the web service.
	<pre>		<pre>
	my $rc = EPrints::Utils::require_if_exists('LWP::UserAgent');		my $rc = EPrints::Utils::require_if_exists('LWP::UserAgent');
Line 218:		Line 218:
	== Input ==		== Input ==
	=== input_fh ===		=== input_fh ===
	This method is similar to the one used in the CSV plugin, but doesn't have to do quite so much work.		This method is similar to the one used in the [Contribute:_Plugins/ImportPluginsCSV CSV plugin], but doesn't have to do quite so much work.

	First we create the array to hold our imported eprint ids.		First we create the array to hold our imported eprint ids.
Line 257:		Line 257:
	=== convert_input ===		=== convert_input ===

	ASIN are strings which identify a product. Here we remove any non-alphanumerical characters which are surrounding the ASIN.		[http://en.wikipedia.org/wiki/ASIN ASINs] are strings which identify a product. Here we remove any non-alphanumerical characters which are surrounding the [http://en.wikipedia.org/wiki/ASIN ASIN].
	<pre>		<pre>
	$input =~ m/([A-Za-z0-9]+)/;		$input =~ m/([A-Za-z0-9]+)/;
Line 263:		Line 263:
	</pre>		</pre>

	We form the request from the variables we created earlier and the ASIN we have just obtained.		We form the request from the variables we created earlier and the [http://en.wikipedia.org/wiki/ASIN ASIN] we have just obtained.
	<pre>		<pre>
	my $request =		my $request =
Line 282:		Line 282:
	</pre>		</pre>

	We then create a DOM object from the XML document returned.		We then create a [http://en.wikipedia.org/wiki/Document_Object_Model DOM] object from the XML document returned.
	<pre>		<pre>
	my $dom = EPrints::XML::parse_xml_string($response->content);		my $dom = EPrints::XML::parse_xml_string($response->content);
Line 353:		Line 353:
	</pre>		</pre>

	We can set the ISBN. Note that the ISBN is often the same as the ASIN.		We can set the [http://en.wikipedia.org/wiki/ISBN ISBN]. Note that the [http://en.wikipedia.org/wiki/ISBN ISBN] is often the same as the [http://en.wikipedia.org/wiki/ASIN ASIN].
	<pre>		<pre>
	my $isbn = $attr->getElementsByTagName('ISBN')->item(0);		my $isbn = $attr->getElementsByTagName('ISBN')->item(0);

Tom: /* convert_input */

2007-09-28T19:11:22Z

convert_input

← Older revision		Revision as of 19:11, 28 September 2007
Line 257:		Line 257:
	=== convert_input ===		=== convert_input ===

	~~ASINs~~ are strings ~~of decimal digits which may have leading zeroes~~ which identify a product. Here we remove any non-~~numerical~~ characters which are surrounding the ASIN.		ASIN are strings which identify a product. Here we remove any non-alphanumerical characters which are surrounding the ASIN.
	<pre>		<pre>
	$input =~ m/([0-9]+)/;		$input =~ m/([A-Za-z0-9]+)/;
	$input = $1;		$input = $1;
	</pre>		</pre>

Tom: /* AWS.pm */

2007-09-28T19:10:29Z

AWS.pm

← Older revision		Revision as of 19:10, 28 September 2007
Line 87:		Line 87:
	my %output = ();		my %output = ();

	$input =~ m/([0-9]+)/;		$input =~ m/([A-Za-z0-9]+)/;
	$input = $1;		$input = $1;

Tom: /* AWS.pm */

2007-09-28T19:06:16Z

AWS.pm

← Older revision		Revision as of 19:06, 28 September 2007
Line 20:		Line 20:

	= AWS.pm =		= AWS.pm =
			The code in the section below should be placed in a file called CSV.pm in the directory created previously, and MyPlugins should be changed to the name of that directory.

	<pre>		<pre>
	package EPrints::Plugin::Import::MyPlugins::AWS;		package EPrints::Plugin::Import::MyPlugins::AWS;

Tom: /* Import Plugin Tutorial 2: Amazon Web Services */

2007-09-28T19:05:30Z

Import Plugin Tutorial 2: Amazon Web Services

← Older revision		Revision as of 19:05, 28 September 2007
Line 1:		Line 1:
	= Import Plugin Tutorial 2: Amazon Web Services =		= Import Plugin Tutorial 2: Amazon Web Services =

	In the [[Contribute:_Plugins/ImportPluginsCSV\|last tutorial]] we created an import plugin that took data which needed very little modification to import into the respository. The column names in the CSV file matched the names of metadata fields present in the repository. In this tutorial we'll look at importing data that needs some modification to be imported, needs more error checking and is obtained in a different way.		In the [[Contribute:_Plugins/ImportPluginsCSV\|last tutorial]] we created an import plugin that took data which needed very little modification to import into the respository. The column names in the [http://en.wikipedia.org/wiki/Comma-Separated_Values CSV] file matched the names of metadata fields present in the repository. In this tutorial we'll look at importing data that needs some modification to be imported, needs more error checking and is obtained in a different way.

	We will be using Amazon's E-Commerce Webservice to import books from their website into our respository given a list of ~~ASINs (Amazon Standard Identification Numbers)~~.		We will be using Amazon's E-Commerce Webservice to import books from their website into our respository given a list of [http://en.wikipedia.org/wiki/ASIN ASIN].

	We will be accessing the service using a REST approach, communicating with the server using URL parameters and retrieving an XML document in response to our request. It is also possible to access their services using SOAP, but that will not be discussed here.		We will be accessing the service using a [http://en.wikipedia.org/wiki/REST REST] approach, communicating with the server using URL parameters and retrieving an XML document in response to our request. It is also possible to access their services using [http://en.wikipedia.org/wiki/SOAP SOAP], but that will not be discussed here.

	= Before You Start =		= Before You Start =

Tom: /* Import Plugin Tutorial 2: Amazon Web Services */

2007-09-28T10:27:43Z

Import Plugin Tutorial 2: Amazon Web Services

← Older revision		Revision as of 10:27, 28 September 2007
Line 1:		Line 1:
	= Import Plugin Tutorial 2: Amazon Web Services =		= Import Plugin Tutorial 2: Amazon Web Services =

	In the last tutorial we created an import plugin that took data which needed very little modification to import into the respository. The column names in the CSV file matched the names of metadata fields present in the repository. In this tutorial we'll look at importing data that needs some modification to be imported, needs more error checking and is obtained in a different way.		In the [[Contribute:_Plugins/ImportPluginsCSV\|last tutorial]] we created an import plugin that took data which needed very little modification to import into the respository. The column names in the CSV file matched the names of metadata fields present in the repository. In this tutorial we'll look at importing data that needs some modification to be imported, needs more error checking and is obtained in a different way.

	We will be using Amazon's E-Commerce Webservice to import books from their website into our respository given a list of ASINs (Amazon Standard Identification Numbers).		We will be using Amazon's E-Commerce Webservice to import books from their website into our respository given a list of ASINs (Amazon Standard Identification Numbers).

Tom: User:Tom/Import Plugins/Web Services moved to Contribute: Plugins/ImportPluginsAWS

2007-09-27T20:59:54Z

User:Tom/Import Plugins/Web Services moved to Contribute: Plugins/ImportPluginsAWS

← Older revision	Revision as of 20:59, 27 September 2007
(No difference)

Tom: /* In More Detail */

2007-09-27T15:02:28Z

In More Detail

← Older revision		Revision as of 15:02, 27 September 2007
Line 195:		Line 195:
	my $operation = 'ItemLookup';		my $operation = 'ItemLookup';
	my $version = '2007-07-16';		my $version = '2007-07-16';
	my $responsegroup = "Large";		my $responsegroup = 'Large';
	</pre>		</pre>