Shop: Base Class get_one_order etwas ausführlicher dokumentiert

[mfinanz.git] / SL / ShopConnector / Base.pm

diff --git a/SL/ShopConnector/Base.pm b/SL/ShopConnector/Base.pm
index 4aa3b8905048517c60d55765f887e9d1cd8d8882..cf2f9f636bd92c838aacc5a65c4f5d37bd3b0b1e 100644 (file)
--- a/SL/ShopConnector/Base.pm
+++ b/SL/ShopConnector/Base.pm
@@ -7,7 +7,30 @@ use Rose::Object::MakeMethods::Generic (
   scalar => [ qw(config) ],
 );
 
-sub get_one_order  { die 'get_one_order needs to be implemented' }
+sub get_one_order  {
+  die 'get_one_order needs to be implemented';
+
+  my ($self, $ordnumber) = @_;
+  my %fetched_order;
+
+  # 1. fetch the order and import it as a kivi order
+  # 2. update the order state for report
+  # 3. return a hash with either success or error state
+  my $one_order; # REST call
+
+  my $error = $self->import_data_to_shop_order($one_order);
+
+  $self->set_orderstatus($one_order->{id}, "fetched") unless $error;
+
+  return \(
+      shop_id          => $self->config->id,
+      shop_description => $self->config->description,
+      number_of_orders => $error ? 0 : 1,
+      message          => $error ? "Error: $error->{msg}"  : '',
+      error            => $error ? 1 : 0,
+    );
+}
+
 
 sub get_new_orders { die 'get_order needs to be implemented' }
 
@@ -15,9 +38,20 @@ sub update_part    { die 'update_part needs to be implemented' }
 
 sub get_article    { die 'get_article needs to be implemented' }
 
-sub get_categories { die 'get_order needs to be implemented' }
+sub get_categories { die 'get_categories needs to be implemented' }
+
+sub get_version    {
+
+  die 'get_version needs to be implemented';
+  # has to return a hashref with this structure:
+  # version has to return the connection error message
+  my $connect = {};
+  $connect->{success}         = 0 || 1;
+  $connect->{data}->{version} = '1234';
+  return $connect;
+}
 
-sub get_version    { die 'get_order needs to be implemented' }
+sub set_orderstatus { die 'set_orderstatus needs to be implemented' }
 
 1;
 
@@ -38,7 +72,16 @@ __END__
 
 =over 4
 
-=item C<get_one_order>
+=item C<get_one_order $ordnumber>
+
+Needs a order number and fetch (one or more) orders
+which are returned by the Shop system. The function
+has to take care of getting the order including customer
+and item information to kivi.
+It has to return a hash with either the number of succesful
+imported order or within the same hash structure a error message.
+
+
 
 =item C<get_new_orders>
 
@@ -50,6 +93,23 @@ __END__
 
 =item C<get_version>
 
+IMPORTANT: This call is used to test the connection and if succesful
+it returns the version number of the shop. If not succesful the
+returning function has to make sure a error string is returned in
+the same data structure. Details of the returning hashref:
+
+ my $connect = {};
+ $connect->{success}         = 0 || 1;
+ $connect->{data}->{version} = '1234';
+ return $connect;
+
+=item C<set_orderstatus>
+
+Sets the state of the order in the Shop.
+Valid values are dependant on the Shop API, common states
+are delivered, fetched, paid, in progress ...
+
+
 =back
 
 =head1 SEE ALSO