endicia_ruby 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d2352e0018c792c02ab16e388921dc2be0c8d83
-  data.tar.gz: 1a64011a110382bba544e96a6d58a693f6d1cfb7
+  metadata.gz: 5fb91179ab61ca85d2be358f857dc75087705833
+  data.tar.gz: 553918dd580eb1b3f718bbe57d507a4bd3058bb1
 SHA512:
-  metadata.gz: 64e34143b6818f14f0a80ac4c54503845ed9a063c352e57e0c0a87df97ede042723f141a49a5df06a8d47ae4316c9e2d00e9503e430df3503e92c65742405bce
-  data.tar.gz: 9ee6c205d02d970af776a5355711ca085d8c2b78a9b489ba8b5c6a74a529ab5e3714fbd2184d6be0b116b6ff5414ecf9f74359f0286a0c70792fe396f03dc0ff
+  metadata.gz: 2e269c9314fdfecdbdffe9a7e320ca09e9dec3d3cf5145441c244884740591474fa791e195665184a6e378cd3fc1d3f72789bd1eb06dabc7c3500f945f7b1277
+  data.tar.gz: 825622ba69c2c9184ec65aad7d4fbec2b93305068076883386fbbb6cf0585bb870e2df96e8e34384bccbddbba2f2bf0fc890f5fb5e4ac3cc657cb9b63f590afa

data/.env.example

@@ -0,0 +1,4 @@
+ENDICIA_ACCOUNT_ID=
+ENDICIA_REQUESTER_ID=
+ENDICIA_PASSPHRASE=
+ENDICIA_ENV=sandbox

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 *.sw?
+.env

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.2.2

data/config/endicia.yml

@@ -1,9 +1,9 @@
 development: &development
   credentials:
-    AccountID: <%= ENV['ENDICIA_ACCOUNT_ID'] || '2500334' %>
-    RequesterID: <%= ENV['ENDICIA_REQUESTER_ID'] || 'lxxx' %>
-    PassPhrase: <%= ENV['ENDICIA_PASSPHRASE'] || 'endicia.com' %>
-  environment: <%= ENV['ENDICIA_ENV'] || 'test' %>
+    AccountID: <%= ENV['ENDICIA_ACCOUNT_ID'] || '' %>
+    RequesterID: <%= ENV['ENDICIA_REQUESTER_ID'] || '' %>
+    PassPhrase: <%= ENV['ENDICIA_PASSPHRASE'] || '' %>
+  environment: <%= ENV['ENDICIA_ENV'] || 'sandbox' %>
 
 test:
   <<: *development

data/endicia_ruby.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "faker"
+  spec.add_development_dependency("dotenv")
 end

data/lib/endicia_ruby/label_response.rb

@@ -10,6 +10,7 @@ module Endicia
                   :transaction_id,
                   :postmark_date,
                   :postage_balance,
+                  :postage_price,
                   :pic,
                   :error_message,
                   :reference_id,
@@ -21,6 +22,7 @@ module Endicia
                   :request_body,
                   :request_url,
                   :response_body
+
     def initialize(result)
       self.response_body = filter_response_body(result.body.dup)
       data = result["LabelRequestResponse"] || {}

data/lib/endicia_ruby/refund.rb

@@ -6,6 +6,8 @@ require_relative 'refund_response'
 module Endicia
   class Refund < Request
 
+    # LEGACY - NO LONGER USED
+
     # Request a refund for the given tracking number(s)
     #
     # tracking_numbers can be an array of strings or a single string
@@ -13,6 +15,8 @@ module Endicia
     # Returns an Endicia::RefundResponse
     #
     def request_refund(tracking_numbers, options = {})
+      raise StandardError.new('Not supported.')
+
       # Build the options for this method with passed in values overriding defaults
       options.reverse_merge!(default_options)
 

data/lib/endicia_ruby/request.rb

@@ -106,18 +106,22 @@ module Endicia
       nodes.each do |key, value|
         node_name = key.to_s.sub(/^./,&:upcase) # convert "fooBar" to "FooBar"
         case value
-        when Hash
-          xml.send(node_name) do
-            recursive_build_xml_nodes!(xml, value)
-          end
-        when Array
-          xml.send(node_name) do
-            value.each do |v|
-              recursive_build_xml_nodes!(xml, v)
+          when Hash
+            if node_name == 'ResponseOptions'
+              xml.ResponseOptions(value)
+            else
+              xml.send(node_name) do
+                recursive_build_xml_nodes!(xml, value)
+              end
             end
-          end
-        else
-          xml.send(node_name, value)
+          when Array
+            xml.send(node_name) do
+              value.each do |v|
+                recursive_build_xml_nodes!(xml, v)
+              end
+            end
+          else
+            xml.send(node_name, value)
         end
       end
     end

data/lib/endicia_ruby/version.rb

@@ -1,3 +1,3 @@
 module Endicia
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/label_spec.rb

@@ -19,6 +19,11 @@ describe Endicia::Label do
         MailpieceShape: "Parcel",
         ToZIP4: '1234',
         WeightOz: "32", # 2 pounds
+        DeliveryTimeDays: 'TRUE',
+        EstimatedDeliveryDate: 'TRUE',
+        ResponseOptions: {
+          PostagePrice: 'TRUE',
+        },
         MailpieceDimensions: {
           Length: "12",
           Width:  "16",
@@ -54,6 +59,9 @@ describe Endicia::Label do
       expect(response.cost_center).to_not be_blank
       expect(response.request_url).to_not be_blank
       expect(response.request_body).to_not be_blank
+      expect(response.postage_price['Postage']['Zone']).to_not be_blank
+      expect(response.postage_price['EstimatedDeliveryDate']).to_not be_blank
+      expect(response.postage_price['DeliveryTimeDays']).to_not be_blank
     end
 
     it "handles a nonsense request" do

data/spec/refund_spec.rb

@@ -44,7 +44,7 @@ describe Endicia::Refund, vcr: { record: :none } do # XXX: Hand-crafted, artisan
       }
       @response = refund.request_refund(@tracking_numbers)
     end
-    it "returns info about each tracking number" do # XXX: Do not rename this test as we had to hand-craft
+    xit "returns info about each tracking number" do # XXX: Do not rename this test as we had to hand-craft
                                                     # the VCR file, since the test server doesn't support
                                                     # refund requests
       expect(@response.success).to eq(true)

data/spec/spec_helper.rb

@@ -6,6 +6,9 @@ require 'faker'
 
 require 'endicia_ruby'
 
+require 'dotenv'
+Dotenv.load
+
 WebMock.disable_net_connect!
 VCR.configure do |c|
   c.cassette_library_dir     = 'spec/vcr-cassettes'
@@ -19,6 +22,8 @@ VCR.configure do |c|
     http_message.body.encoding.name == 'ASCII-8BIT' ||
     !http_message.body.valid_encoding?
   end
+  c.filter_sensitive_data('PassPhrase') { ENV['ENDICIA_PASSPHRASE'] }
+  c.filter_sensitive_data('AccountID') { ENV['ENDICIA_ACCOUNT_ID'] }
 end
 
 RSpec.configure do |config|

data/spec/vcr-cassettes/Endicia_Label/_request_label/handles_a_nonsense_request.yml

@@ -8,88 +8,17 @@ http_interactions:
       string: |
         labelRequestXML=<?xml version="1.0"?>
         <LabelRequest Test="YES" LabelType="Default">
-          <AccountID>2500334</AccountID>
+          <AccountID>AccountID</AccountID>
           <RequesterID>lxxx</RequesterID>
-          <PassPhrase>endicia.com</PassPhrase>
+          <PassPhrase>PassPhrase</PassPhrase>
         </LabelRequest>
-    headers: {}
-  response:
-    status:
-      code: 200
-      message: OK500 Internal Server Error
     headers:
-      Connection:
-      - close
-      Date:
-      - Wed, 22 Oct 2014 20:50:28 GMT
-      Server:
-      - Microsoft-IIS/6.0
-      X-Powered-By:
-      - ASP.NET
-      X-Aspnet-Version:
-      - 4.0.30319
-      Endicia-Label-Format:
-      - 'Cache-Control: private'
-      Content-Type:
-      - text/html; charset=utf-8
-      Content-Length:
-      - '3042'
-    body:
-      encoding: UTF-8
-      string: "<html>\r\n    <head>\r\n        <title>Runtime Error</title>\r\n        <style>\r\n
-        \        body {font-family:\"Verdana\";font-weight:normal;font-size: .7em;color:black;}
-        \r\n         p {font-family:\"Verdana\";font-weight:normal;color:black;margin-top:
-        -5px}\r\n         b {font-family:\"Verdana\";font-weight:bold;color:black;margin-top:
-        -5px}\r\n         H1 { font-family:\"Verdana\";font-weight:normal;font-size:18pt;color:red
-        }\r\n         H2 { font-family:\"Verdana\";font-weight:normal;font-size:14pt;color:maroon
-        }\r\n         pre {font-family:\"Lucida Console\";font-size: .9em}\r\n         .marker
-        {font-weight: bold; color: black;text-decoration: none;}\r\n         .version
-        {color: gray;}\r\n         .error {margin-bottom: 10px;}\r\n         .expandable
-        { text-decoration:underline; font-weight:bold; color:navy; cursor:hand; }\r\n
-        \       </style>\r\n    </head>\r\n\r\n    <body bgcolor=\"white\">\r\n\r\n
-        \           <span><H1>Server Error in '/LabelService' Application.<hr width=100%
-        size=1 color=silver></H1>\r\n\r\n            <h2> <i>Runtime Error</i> </h2></span>\r\n\r\n
-        \           <font face=\"Arial, Helvetica, Geneva, SunSans-Regular, sans-serif
-        \">\r\n\r\n            <b> Description: </b>An application error occurred
-        on the server. The current custom error settings for this application prevent
-        the details of the application error from being viewed remotely (for security
-        reasons). It could, however, be viewed by browsers running on the local server
-        machine.\r\n            <br><br>\r\n\r\n            <b>Details:</b> To enable
-        the details of this specific error message to be viewable on remote machines,
-        please create a &lt;customErrors&gt; tag within a &quot;web.config&quot; configuration
-        file located in the root directory of the current web application. This &lt;customErrors&gt;
-        tag should then have its &quot;mode&quot; attribute set to &quot;Off&quot;.<br><br>\r\n\r\n
-        \           <table width=100% bgcolor=\"#ffffcc\">\r\n               <tr>\r\n
-        \                 <td>\r\n                      <code><pre>\r\n\r\n&lt;!--
-        Web.Config Configuration File --&gt;\r\n\r\n&lt;configuration&gt;\r\n    &lt;system.web&gt;\r\n
-        \       &lt;customErrors mode=&quot;Off&quot;/&gt;\r\n    &lt;/system.web&gt;\r\n&lt;/configuration&gt;</pre></code>\r\n\r\n
-        \                 </td>\r\n               </tr>\r\n            </table>\r\n\r\n
-        \           <br>\r\n\r\n            <b>Notes:</b> The current error page you
-        are seeing can be replaced by a custom error page by modifying the &quot;defaultRedirect&quot;
-        attribute of the application&#39;s &lt;customErrors&gt; configuration tag
-        to point to a custom error page URL.<br><br>\r\n\r\n            <table width=100%
-        bgcolor=\"#ffffcc\">\r\n               <tr>\r\n                  <td>\r\n
-        \                     <code><pre>\r\n\r\n&lt;!-- Web.Config Configuration
-        File --&gt;\r\n\r\n&lt;configuration&gt;\r\n    &lt;system.web&gt;\r\n        &lt;customErrors
-        mode=&quot;RemoteOnly&quot; defaultRedirect=&quot;mycustompage.htm&quot;/&gt;\r\n
-        \   &lt;/system.web&gt;\r\n&lt;/configuration&gt;</pre></code>\r\n\r\n                  </td>\r\n
-        \              </tr>\r\n            </table>\r\n\r\n            <br>\r\n\r\n
-        \   </body>\r\n</html>\r\n"
-    http_version: 
-  recorded_at: Wed, 22 Oct 2014 20:50:26 GMT
-- request:
-    method: post
-    uri: https://www.envmgr.com/LabelService/EwsLabelService.asmx/GetPostageLabelXML
-    body:
-      encoding: UTF-8
-      string: |
-        labelRequestXML=<?xml version="1.0"?>
-        <LabelRequest Test="YES" LabelType="Default">
-          <AccountID>2500334</AccountID>
-          <RequesterID>lxxx</RequesterID>
-          <PassPhrase>endicia.com</PassPhrase>
-        </LabelRequest>
-    headers: {}
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
   response:
     status:
       code: 200
@@ -99,26 +28,43 @@ http_interactions:
       - private, max-age=0
       Content-Type:
       - text/xml; charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Server:
+      - Microsoft-IIS/7.5
+      Endicia-Partner:
+      - lxxx
+      Endicia-Account:
+      - AccountID
+      Endicia-Response:
+      - failure
       X-Aspnet-Version:
       - 4.0.30319
       X-Powered-By:
       - ASP.NET
       Date:
-      - Mon, 27 Oct 2014 16:25:54 GMT
+      - Wed, 29 Nov 2017 21:33:12 GMT
+      Connection:
+      - close
       Content-Length:
-      - '572'
-      Set-Cookie:
-      - TS01f3408d=017b1809615f96bb14189a5af4bc475ddcf412dbb1637c14e6b5ae7d00beae8ac6f59c48c7;
-        Path=/
+      - '466'
     body:
-      encoding: UTF-8
-      string: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<LabelRequestResponse
-        xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
-        xmlns=\"www.envmgr.com/LabelService\">\r\n  <Status>1001</Status>\r\n  <ErrorMessage>Missing
-        or invalid data element: MailClassLabelRequest. Error encountered (Log ID:
-        34422)</ErrorMessage>\r\n  <FinalPostage>0.0</FinalPostage>\r\n  <TransactionID>0</TransactionID>\r\n
-        \ <PostageBalance>0.00</PostageBalance>\r\n  <CostCenter>0</CostCenter>\r\n
-        \ <ReferenceID2 />\r\n  <ReferenceID3 />\r\n  <ReferenceID4 />\r\n</LabelRequestResponse>"
+      encoding: ASCII-8BIT
+      base64_string: |
+        PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxMYWJl
+        bFJlcXVlc3RSZXNwb25zZSB4bWxuczp4c2Q9Imh0dHA6Ly93d3cudzMub3Jn
+        LzIwMDEvWE1MU2NoZW1hIiB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3Jn
+        LzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0id3d3LmVudm1nci5j
+        b20vTGFiZWxTZXJ2aWNlIj4NCiAgPFN0YXR1cz40MDU8L1N0YXR1cz4NCiAg
+        PEVycm9yTWVzc2FnZT5JbnZhbGlkIG1haWwgY2xhc3MgKE51bGwgb3IgZW1w
+        dHkgbWFpbENsYXNzIHBhcmFtZXRlciBub3QgYWxsb3dlZC4pLiBFcnJvciBl
+        bmNvdW50ZXJlZCAoTG9nIElEOiA0NTEzMik8L0Vycm9yTWVzc2FnZT4NCiAg
+        PEZpbmFsUG9zdGFnZT4wLjA8L0ZpbmFsUG9zdGFnZT4NCiAgPFRyYW5zYWN0
+        aW9uSUQ+MDwvVHJhbnNhY3Rpb25JRD4NCiAgPFBvc3RhZ2VCYWxhbmNlPjAu
+        MDA8L1Bvc3RhZ2VCYWxhbmNlPg0KICA8Q29zdENlbnRlcj4wPC9Db3N0Q2Vu
+        dGVyPg0KICA8UmVmZXJlbmNlSUQyIC8+DQogIDxSZWZlcmVuY2VJRDMgLz4N
+        CiAgPFJlZmVyZW5jZUlENCAvPg0KICA8U0RSVmFsdWUgLz4NCjwvTGFiZWxS
+        ZXF1ZXN0UmVzcG9uc2U+
     http_version: 
-  recorded_at: Mon, 27 Oct 2014 16:26:02 GMT
+  recorded_at: Wed, 29 Nov 2017 21:33:17 GMT
 recorded_with: VCR 2.9.3