source: project/wiki/eggref/4/correios @ 30655

Last change on this file since 30655 was 30655, checked in by arthurmaciel, 7 years ago
File size: 9.7 KB
Line 
1[[tags: egg]]
2
3== correios
4
5[[toc:]]
6
7=== Description
8
9Correios is a Chicken Scheme library that implements shipping calculation (tax and estimated delivery time) for a Brazillian post office service with the same name. It is implemented according to the official [[http://www.correios.com.br/webServices/PDF/SCPP_manual_implementacao_calculo_remoto_de_precos_e_prazos.pdf|Correios web service specification]].
10
11=== Author
12
13[[/users/arthurmaciel|Arthur Maciel]]
14
15=== Requirements
16
17Requires the [[defstruct]], [[http-client]], [[ssax]] and [[uri-common]] eggs and the [[srfi-1]] unit.
18
19=== Documentation
20
21==== Requests
22
23<procedure>(make-request #!key service from-zip to-zip (company "") (password "") (pkg-weight 0.3) (pkg-format 1) (pkg-length 16) (pkg-height 2) (pkg-breadth 11) (pkg-diameter 0) (receiver-id-check #f) (declared-value 0) (return-receipt #f) (return-url "XML"))</procedure>
24Create a correios {{request}} object (a [[defstruct]] record) to be processed. It has many attributes that correspond to the official [[http://www.correios.com.br/webServices/PDF/SCPP_manual_implementacao_calculo_remoto_de_precos_e_prazos.pdf|Correios web service specification]]:
25
26; SERVICE: available delivery services: {{'PAC}}, {{'SEDEX}}, {{'SEDEX-10}}, {{'SEDEX-HOJE}} and {{'SEDEX-A-COBRAR}}. It can also be a list combining one or more of these symbols (ie. {{'(PAC SEDEX SEDEX-10)}}).
27; FROM-ZIP: sender's zip code and should be a string with 8 digits (only numbers allowed).
28; TO-ZIP: receiver's zip code and should be a string with 8 digits (only numbers allowed).
29; COMPANY: company code, if yours has one. It should be a string.
30; PASSWORD: company password, only if a company code is provided. It should be a string.
31; PKG-WEIGHT: package weight in kilograms. Should be a number.
32; PKG-FORMAT: package format and should be a number: 1 for box/package, 2 for roller/prism and 3 for envelope.
33; PKG-LENGTH: package length in centimeters (including packing size) and should be a number.
34; PKG-HEIGHT: package height in centimeters (including packing size) and should be a number.
35; PKG-BREADTH: package breadth in centimeters (including packing size) and should be a number.
36; PKG-DIAMETER: package diameter in centimeters (including packing size) and should be a number.
37; RECEIVER-ID-CHECK: a boolean and determines whether the package should be delivered only to the receiver's hand (Correios calls this service "Mão própria").
38; DECLARED-VALUE: package declared value in Brazillian Reais, to be returned in case of miscarriage. It should be a number - ex.: {{33.50}} (default is {{0}}, which means no use of service).
39; RETURN-RECEIPT: a boolean and determines whether the package should be delivered with additional service of a return receipt ({{#f}} means no use of the service).
40; RETURN-URL: request return URL or type - at the moment can only be "XML".
41
42'''Note:''' although all values returned use Brazillian decimal notation with a comma separating cents from integers (ex.: {{3,25}}), all the decimal values provided to {{make-request}} should have a dot (ex.: {{3.25}}) separating those parts.
43
44<procedure>(update-request old-request #!key service from-zip to-zip company password pkg-weight pkg-format pkg-length pkg-height pkg-breadth pkg-diameter receiver-id-check declared-value return-receipt return-url)</procedure>
45Like make-request, except this takes an old-request object as a template for values which are missing from the parameter list, thereby providing a way to do a purely functional update of that object.
46
47<procedure>(process-request REQUEST)</procedure>
48This is the core procedure for shipping cost calculation. It accepts a {{request}} object as a parameter and returns a ''list'' of {{response}} objects. The list can be processed (see [[#examples|Examples]] below) and data can be extracted from each response using its accessors (see [[#responses|{{response}}]] details below).
49
50For each {{request}} attribute there is a respective accessor procedure:
51
52<procedure>(request-service REQUEST) => SERVICE</procedure>
53<procedure>(request-from-zip REQUEST) => FROM-ZIP</procedure>
54<procedure>(request-to-zip REQUEST) => TO-ZIP</procedure>
55<procedure>(request-company REQUEST) => COMPANY</procedure>
56<procedure>(request-password REQUEST) => PASSWORD</procedure>
57<procedure>(request-pkg-weight REQUEST) => PKG-WEIGHT</procedure>
58<procedure>(request-pkg-format REQUEST) => PKG-FORMAT</procedure>
59<procedure>(request-pkg-length REQUEST) => PKG-LENGTH</procedure>
60<procedure>(request-pkg-height REQUEST) => PKG-HEIGHT</procedure>
61<procedure>(request-pkg-breadth REQUEST) => PKG-BREADTH</procedure>
62<procedure>(request-pkg-diameter REQUEST) => PKG-DIAMETER</procedure>
63<procedure>(request-receiver-id-check REQUEST) => RECEIVER-ID-CHECK</procedure>
64<procedure>(request-declared-value REQUEST) => DECLARED-VALUE</procedure>
65<procedure>(request-return-receipt REQUEST) => RETURN-RECEIPT</procedure>
66<procedure>(request-return-url REQUEST) => RETURN-URL</procedure>
67
68==== Responses
69
70<record>response</record>
71
72This is a correios shipping response object that is generated by {{process-request}}. It is a [[defstruct]] record and has a constructor {{make-response}} (used only internally). It has 10 attributes that can be retrieved using the respective accessor procedure:
73
74<procedure>(response-service RESPONSE) => SERVICE</procedure>
75Returns the delivery service type as a symbol - ie. {{'PAC}}, {{'SEDEX}} or {{SEDEX-10)}}.
76
77<procedure>(response-cost RESPONSE) => COST</procedure>
78Returns the total delivery cost in Brazillian Reais as a string - ie. {{"15,80"}}.
79
80<procedure>(response-delivery-time RESPONSE) => DELIVERY-TIME</procedure>
81Returns the delivery time in days as a number.
82
83<procedure>(response-receiver-id-check-cost RESPONSE) => RECEIVER-ID-CHECK-COST</procedure>
84Returns the cost of the {{receiver-id-check}} service (if used) in Brazillian Reais as a string - ie. {{"3,20"}}.
85
86<procedure>(response-return-receipt-cost RESPONSE) => RETURN-RECEIPT-COST</procedure>
87Returns the cost of the {{return-receipt-cost}} service (if used) in Brazillian Reais as a string - ie. {{"2,90"}}.
88
89<procedure>(response-declared-value-cost RESPONSE) => DECLARED-VALUE-COST</procedure>
90Returns the cost of {{declared-value}} service in Brazillian Reais as a string - ie. {{"32,50"}}.
91
92<procedure>(response-home-delivery RESPONSE) => HOME-DELIVERY</procedure>
93Returns a boolean indicating whether or not the {{home-delivery}} service is available (believe it or not there are still many inaccessible areas in Brazil!).
94
95<procedure>(response-saturday-delivery RESPONSE) => SATURDAY-DELIVERY</procedure>
96Returns a boolean indicating whether or not the {{saturday-delivery}} service is available.
97
98<procedure>(response-error RESPONSE) => ERROR</procedure>
99Returns {{"0"}} if there were no errors or other number (in a string format) if so (see pages 14 and 15 of the [[http://www.correios.com.br/webServices/PDF/SCPP_manual_implementacao_calculo_remoto_de_precos_e_prazos.pdf|Correios web service specification]] for a complete error code list).
100
101<procedure>(response-error-msg RESPONSE) => ERROR-MSG</procedure>
102Returns a {{#f}} if there were no errors or a string with the error message.
103
104There is also a procedure to check if there {{response}} generated by {{process-request}} is valid:
105
106<procedure>(valid-response? RESPONSE)</procedure>
107Check if a specific response has generated errors. Returns a boolean.
108
109===== Examples
110<enscript highlight="scheme">
111(use correios)
112
113;; Create a request
114(define ship-req (make-request
115                  service: (list 'SEDEX 'PAC)
116                  from-zip: "05412002"
117                  to-zip: "90035120"))
118
119;; Proccess it and iterate along the reponse list
120(let loop ((responses (process-request ship-req)))
121  (cond ((null? responses)
122         (printf "Finished processing responses.~N"))
123        (else
124         (let ((resp (car responses)))
125           (if (valid-response? resp)
126               (printf "Service ~A - Cost: R$~A  Estimated delivery (days): ~A~N"
127                 (response-service resp)
128                 (response-cost resp)
129                 (response-delivery-time resp))
130               (printf "Service ~A - Error:  ~A"
131                 (response-service resp)
132                 (response-error-msg resp))))
133         (loop (cdr responses)))))
134=>
135Service SEDEX - Cost: R$33,00  Estimated delivery (days): 1
136Service PAC - Cost: R$15,80  Estimated delivery (days): 4
137Finished processing responses.
138</enscript>
139
140=== Changelog
141
142* 0.1 Initial version
143
144=== License
145
146  Copyright (c) 2013, Arthur Maciel
147  All rights reserved.
148 
149  Redistribution and use in source and binary forms, with or without
150  modification, are permitted provided that the following conditions are
151  met:
152 
153  Redistributions of source code must retain the above copyright
154  notice, this list of conditions and the following disclaimer.
155 
156  Redistributions in binary form must reproduce the above copyright
157  notice, this list of conditions and the following disclaimer in the
158  documentation and/or other materials provided with the distribution.
159 
160  Neither the name of the author nor the names of its contributors may
161  be used to endorse or promote products derived from this software
162  without specific prior written permission.
163 
164  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
165  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
166  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
167  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
168  COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
169  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
170  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
171  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
172  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
173  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
174  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
175  OF THE POSSIBILITY OF SUCH DAMAGE.
Note: See TracBrowser for help on using the repository browser.