Merge pull request #50 from goshippo/v3-updates

V3 updates
goshippo · Mar 31, 2017 · 2486419 · 2486419
2 parents 01249c9 + dcea188
commit 2486419
Show file tree

Hide file tree

Showing 33 changed files with 1,540 additions and 317 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,9 @@
-### 2.0.8 release, Feb 15th, 2017
+#### 3.0.0 release, Mar 31st, 2017
+- Version 3 changes
+    - Object fields removed/updated
+    - Credentials inserted for tests
+
+#### 2.0.8 release, Feb 15th, 2017
 - Add Batch API with example code
     - Creation
     - Retrieval
@@ -11,12 +16,12 @@
 - Add mock tests using VCR (for Batch and Track API)
     - https://github.com/vcr/vcr
 
-### 2.0.7 release, Jan 2nd, 2017
+#### 2.0.7 release, Jan 2nd, 2017
 - Fixed bug preventing address validation
 - Removed trailing slash from base URL, added spec test to ensure this configuration
 - Added address validation example
 - Updated basic shipment example to include how to access the Shippo object id
-### 2.0.6 release, Nov 22nd, 2016
+#### 2.0.6 release, Nov 22nd, 2016
 - Fixed bug to send request with correct API version header
 
 #### 2.0.5 release, Oct 24th, 2016

diff --git a/README.md b/README.md
@@ -45,10 +45,8 @@ require 'shippo'
 Shippo::API.token = 'aff988f77afa0fdfdfadf'  # not an actual valid token
 
 # Setup query parameter hash
-params   = { object_purpose: 'PURCHASE',
-              async:          false,
+params   = {  async:          false,
               address_from:   {
-                object_purpose: 'PURCHASE',
                 name:           'Mr Hippo',
                 company:        'Shippo',
                 street1:        '215 Clayton St.',
@@ -57,10 +55,8 @@ params   = { object_purpose: 'PURCHASE',
                 state:          'CA',
                 zip:            '94117',
                 country:        'US',
-                phone:          '+1 555 341 9393',
-                email:          'support@goshippo.com' },
+                phone:          '+1 555 341 9393' },
               address_to:     {
-                object_purpose: 'PURCHASE',
                 name:           'Mrs Hippo"',
                 company:        'San Diego Zoo',
                 street1:        '2920 Zoo Drive',
@@ -70,7 +66,7 @@ params   = { object_purpose: 'PURCHASE',
                 country:        'US',
                 phone:          '+1 555 341 9393',
                 email:          'hippo@goshippo.com' },
-              parcel:         {
+              parcels:         {
                 length:        5,
                 width:         2,
                 height:        5,
@@ -83,12 +79,8 @@ params   = { object_purpose: 'PURCHASE',
 @shipment = Shippo::Shipment.create(params)
 @shipment.success?
 # => true
-@shipment.object.status
-# => 'SUCCESS'
-@shipment.status # forwarded to #object
+@shipment.status
 # => 'SUCCESS'
-@shipment.state
-# => 'VALID'
 ```
 
 Let's take a quick look at what the `Shipment` object looks like:
@@ -97,63 +89,76 @@ Let's take a quick look at what the `Shipment` object looks like:
 require 'awesome_print'
 ap @shipment
 # {
-#        "carrier_accounts" => [],
-#            "address_from" => "a704eada7494bb1be6184ef64b1646db",
-#              "address_to" => "92b43fbfa3641644beb32996042eb57a",
-#          "address_return" => "a1f64ba14b7e41b86a0446de4ebbd769",
-#                  "parcel" => "92df4baac73ea6131940c0d315d70a7d",
-#         "submission_date" => "2016-07-06T20:33:02.211Z",
-#               "return_of" => nil,
-#     "customs_declaration" => nil,
-#        "insurance_amount" => "0",
-#      "insurance_currency" => nil,
-#                   "extra" => {},
-#             "reference_1" => "",
-#             "reference_2" => "",
-#               "rates_url" => "https://api.goshippo.com/v1/shipments/a336daf87a8e442992a68daa6622758f/rates/",
-#                "messages" => [ ] # ommitted for brevity,
-#              "rates_list" => [ ] # ommitted for brevity.
+#   "carrier_accounts"    => [],
+#   "address_from"        => {
+#     "name"    => "Mr Hippo",
+#     "company" => "Shippo",
+#     "street1" => "215 Clayton St.",
+#     "street2" => "",
+#     "city"    => "San Francisco",
+#     "state"   => "CA",
+#     "zip"     => "94117",
+#     "country" => "US",
+#     "phone"   => "+1 555 341 9393"
+#   },
+#   "address_to"          => { ... },   # omitted for brevity
+#   "address_return"      => { ... },
+#   "parcels"             => [{
+#     "length"        => 5,
+#     "width"         => 2,
+#     "height"        => 5,
+#     "distance_unit" => in,
+#     "weight"        => 2,
+#     "mass_unit"     => lb,
+#   }],
+#   "shipment_date"       => "2016-07-06T20:33:02.211Z",
+#   "customs_declaration" => nil,
+#   "extra"               => {
+#     "insurance"   => {
+#       "amount"    => 10,
+#       "currency"  => "USD",
+#       "content"   => "",
+#       "provider"  => "FEDEX"
+#     },
+#     "is_return"   => false,
+#     "reference_1" => "",
+#     "reference_2" => "",
+#   },
+#   "messages"            => [ ... ],
+#   "rates"               => [ ... ]
 # }
 ```
 
 #### List Handling
 
 In the case when the API returns a hash with one of the hash values being an array of entities, and if the corresponding key can be mapped into one of the existing API models, then each of the members of the array is coerced from a hash into an object of the model's type.
 
-In the example below we are showing the result of such transformation where the `rates_list` contains a list of fully constructed objects of type `Shippo::Rate` after being coerced from a hash.
+In the example below we are showing the result of such transformation where `rates` contains a list of fully constructed objects of type `Shippo::Rate` after being coerced from a hash.
 
 ```ruby
-ap @shipment.rates_list.first
+ap @shipment.rates.first
 # =>
-# {
-#                     "shipment" => "20f25e44b16b4051b6dd910cb66fd27b",
-#             "available_shippo" => true,
-#                   "attributes" => [],
-#                       "amount" => "8.51",
-#                     "currency" => "USD",
-#                 "amount_local" => "8.51",
-#               "currency_local" => "USD",
-#                     "provider" => "FedEx",
-#            "provider_image_75" => "https://shippo-static.s3.amazonaws.com/providers/75/FedEx.png",
-#           "provider_image_200" => "https://shippo-static.s3.amazonaws.com/providers/200/FedEx.png",
-#            "servicelevel_name" => "Ground",
-#           "servicelevel_token" => "fedex_ground",
-#           "servicelevel_terms" => "",
-#                         "days" => 2,
-#                   "arrives_by" => nil,
-#               "duration_terms" => "",
-#                    "trackable" => true,
-#                    "insurance" => false,
-#       "insurance_amount_local" => "0.00",
-#     "insurance_currency_local" => nil,
-#             "insurance_amount" => "0.00",
-#           "insurance_currency" => nil,
-#            "delivery_attempts" => nil,
-#            "outbound_endpoint" => "door",
-#             "inbound_endpoint" => "door",
-#                     "messages" => [],
-#              "carrier_account" => "4b1940bc69524163b669asd361842db",
-#                         "test" => true
+# { 
+#   "shipment"            => "20f25e44b16b4051b6dd910cb66fd27b",
+#   "attributes"          => [],
+#   "amount"              => "8.51",
+#   "currency"            => "USD",
+#   "amount_local"        => "8.51",
+#   "currency_local"      => "USD",
+#   "provider"            => "FedEx",
+#   "provider_image_75"   => "https://shippo-static.s3.amazonaws.com/providers/75/FedEx.png",
+#   "provider_image_200"  => "https://shippo-static.s3.amazonaws.com/providers/200/FedEx.png",
+#   "servicelevel"        => {
+#     "name"  => "Ground",
+#     "token" => "fedex_ground",
+#     "terms" => ""
+#   }
+#   "days"                => 2,
+#   "arrives_by"          => nil,
+#   "duration_terms"      => "",
+#   "messages"            => [],
+#   "carrier_account"     => "4b1940bc69524163b669asd361842db",
+#   "test"                => true
 # }
 @shipment.rates.first.owner
 # ⤷ unittest@gmail.com
@@ -170,10 +175,10 @@ You can retrieve a list of objects for many endpoints (e.g. Transactions, Shipme
 @transactions
 # =>
 # {
-#     "count" => 3055,
-#      "next" => "https://api.goshippo.com/v1/transactions/?page=2",
-#  "previous" => nil,
-#  "results"  => [ ... list of Transaction objects ... ]
+#   "count"     => 3055,
+#   "next"      => "https://api.goshippo.com/v1/transactions/?page=2",
+#   "previous"  => nil,
+#   "results"   => [ ... list of Transaction objects ... ]
 # }
 ```
 
@@ -213,18 +218,15 @@ Finally, here is how we access the rest of the `object_` fields:
 # ⤷ valued_customer@gmail.com
 ```
 
-Here is the fully construted `ApiObject` instance, attached to our `@shipment`:
+Here is the fully constructed `ApiObject` instance, attached to our `@shipment`:
 
 ```ruby
 ap @shipment.object
 # {
-#     :created => 2016-07-06 20:44:47 UTC,
-#     :updated => 2016-07-06 20:44:47 UTC,
-#       :owner => "valued_customer@gmail.com",
-#       :state => #<Shippo::API::Category::State:0x007fd88be8aa38 @name=:state, @value=:valid>,
-#      :status => #<Shippo::API::Category::Status:0x007fd88be82e28 @name=:status, @value=:success>,
-#     :purpose => #<Shippo::API::Category::Purpose:0x007fd88be985e8 @name=:purpose, @value=:purchase>,
-#          :id => "20f25e44b16b4051b6dd910cb66fd27b"
+#   :created  => 2016-07-06 20:44:47 UTC,
+#   :updated  => 2016-07-06 20:44:47 UTC,
+#   :owner    => "valued_customer@gmail.com",
+#   :id       => "20f25e44b16b4051b6dd910cb66fd27b"
 # }
 ```
 
@@ -247,9 +249,9 @@ NOTE: this environment variable is only used by the included `bin/example` scrip
 
 ## Gem Versioning Notes
 
-Version 2 and up of this library works with Ruby 2.2 and later, and is not backwards compatible. __Version 1.0.4__ of this library is the last version supporting ruby 1.8 and 1.9.
+Version 3 and up of this library works with Ruby 2.2 and later, and is not backwards compatible. __Version 1.0.4__ of this library is the last version supporting ruby 1.8 and 1.9.
 
-__Warning:__ Version 2 brings potential backwards incompatibility issues. Please be prepared to update your usages (if necessary) when you migrate.
+__Warning:__ Version 3 brings potential backwards incompatibility issues. Please be prepared to update your usages (if necessary) when you migrate.
 
 ### If you are still using Ruby 1.8 or 1.9
 

diff --git a/bin/address_validation_example b/bin/address_validation_example
@@ -52,7 +52,6 @@ end
 
 # Create address object
 address = {
-  :object_purpose => 'PURCHASE',
   :name           => 'Mr Hippo',
   :company        => 'Shippo',
   :street1        => '215 Clayton St.',

diff --git a/bin/basic_shipment_example b/bin/basic_shipment_example
@@ -52,7 +52,6 @@ end
 
 # Create address_from object
 address_from = {
-  :object_purpose => 'PURCHASE',
   :name           => 'Mr Hippo',
   :company        => 'Shippo',
   :street1        => '215 Clayton St.',
@@ -66,7 +65,6 @@ address_from = {
 
 # Create address_to object
 address_to   = {
-  :object_purpose => 'PURCHASE',
   :name           => 'Mrs Hippo"',
   :company        => 'San Diego Zoo',
   :street1        => '2920 Zoo Drive',
@@ -86,8 +84,7 @@ parcel       = {
   :weight        => 2,
   :mass_unit     => :lb }
 
-hash = { :object_purpose => 'PURCHASE',
-         :address_from   => address_from,
+hash = { :address_from   => address_from,
          :address_to     => address_to,
          :parcel         => parcel,
          :async          => false }
@@ -120,7 +117,7 @@ end
 
 # Get the desired rate according to your business logic
 # We select the first rate in this example
-rate = shipment.rates_list.first
+rate = shipment.rates.first
 ExampleHelper.dump_object(rate, 'First rate returned')
 
 transaction = ExampleHelper.log_operation 'Creating a label with the first rate in the list... ' do

diff --git a/bin/batch_example b/bin/batch_example
@@ -65,7 +65,6 @@ end
 
 # Create address_from object
 address_from = {
-  :object_purpose => 'PURCHASE',
   :name           => 'Mr Hippo',
   :company        => 'Shippo',
   :street1        => '215 Clayton St.',
@@ -79,7 +78,6 @@ address_from = {
 
 # Create address_to object
 address_to   = {
-  :object_purpose => 'PURCHASE',
   :name           => 'Mrs Hippo"',
   :company        => 'San Diego Zoo',
   :street1        => '2920 Zoo Drive',
@@ -106,7 +104,6 @@ hash = { :default_carrier_account => DEFAULT_CARRIER_ACCOUNT,
          :batch_shipments => [
            {
              :shipment => {
-               :object_purpose => 'PURCHASE',
                :address_from   => address_from,
                :address_to     => address_to,
                :parcel         => parcel,
@@ -116,8 +113,7 @@ hash = { :default_carrier_account => DEFAULT_CARRIER_ACCOUNT,
          ]
        }
 
-shipment_params = { :object_purpose => 'PURCHASE',
-                    :address_from   => address_from,
+shipment_params = { :address_from   => address_from,
                     :address_to     => address_to,
                     :parcel         => parcel,
                     :async          => false }

diff --git a/bin/track_example b/bin/track_example
@@ -49,7 +49,6 @@ end
 
 # Create address_from object
 address_from = {
-  :object_purpose => 'PURCHASE',
   :name           => 'Mr Hippo',
   :company        => 'Shippo',
   :street1        => '215 Clayton St.',
@@ -63,7 +62,6 @@ address_from = {
 
 # Create address_to object
 address_to   = {
-  :object_purpose => 'PURCHASE',
   :name           => 'Mrs Hippo"',
   :company        => 'San Diego Zoo',
   :street1        => '2920 Zoo Drive',
@@ -83,8 +81,7 @@ parcel       = {
   :weight        => 2,
   :mass_unit     => :lb }
 
-hash = { :object_purpose => 'PURCHASE',
-         :address_from   => address_from,
+hash = { :address_from   => address_from,
          :address_to     => address_to,
          :parcel         => parcel,
          :async          => false }

diff --git a/lib/shippo/api.rb b/lib/shippo/api.rb
@@ -12,7 +12,7 @@
 module Shippo
   module API
     @base     = 'https://api.goshippo.com'
-    @version  = nil
+    @version  = ''
     @token    = ''
     @debug    = Integer(ENV['SHIPPO_DEBUG'] || 0) > 0 ? true : false
     @warnings = true

diff --git a/lib/shippo/api/api_object.rb b/lib/shippo/api/api_object.rb
@@ -21,9 +21,7 @@ module API
     #
     # ```ruby
     # response = {
-    #       "object_state" => "VALID",
-    #     "object_purpose" => "PURCHASE",
-    #      "object_source" => "FULLY_ENTERED",
+    #       "object_state" => "VALID",    # not available for address, shipment or rates
     #     "object_created" => "2014-07-16T23:20:31.089Z",
     #     "object_updated" => "2014-07-16T23:20:31.089Z",
     #          "object_id" => "747207de2ba64443b645d08388d0309c",
@@ -49,8 +47,6 @@ module API
     # # ⤷
     # {
     #       :state => #<Shippo::API::Category::State:0x007fd374b4d0d0 @name=:state, @value=:valid>,
-    #     :purpose => #<Shippo::API::Category::Purpose:0x007fd373df2070 @name=:purpose, @value=:purchase>,
-    #      :source => #<Shippo::API::Category::Source:0x007fd374b4fbf0 @name=:source, @value=:fully_entered>,
     #     :created => 2014-07-16 23:20:31 UTC,
     #     :updated => 2014-07-16 23:20:31 UTC,
     #          :id => "747207de2ba64443b645d08388d0309c",
@@ -78,7 +74,7 @@ def mk_opts(property)
 
       # list of allowed properties, of a given type.
       PROPS_ID         = %i(id).freeze
-      PROPS_CATEG      = %i(state purpose source status results).freeze
+      PROPS_CATEG      = %i(state status results).freeze
       PROPS_EMAIL      = %i(owner).freeze
       PROPS_TIMED      = %i(created updated).freeze
 

diff --git a/lib/shippo/api/transformers/list.rb b/lib/shippo/api/transformers/list.rb
@@ -13,7 +13,7 @@ class List
         # mapped to an array of hashes, into a word that represents an existing model.
         #
         # Each matcher receives a key as a parameter, and (if matches) it extracts the candidate word to be
-        # attempted to +constantize+. For example, +rates_list+ matcher will return +rates+ as output.
+        # attempted to +constantize+. For example, +rates+ matcher will return +rates+ as output.
 
         MATCHERS = [
           ->(key) {