V3 updates #50

daria-lamberson · 2017-03-24T20:18:58Z

As according to V3 cleanup page; endpoint modification should not be done in the wrapper.

wenwei1030 · 2017-03-24T20:24:43Z

README.md

-#                     "messages" => [],
-#              "carrier_account" => "4b1940bc69524163b669asd361842db",
-#                         "test" => true
+# { 


Did you add anything or modify anything or just adjust the syntax? If it is the former, could you please point out which one you added or modified?

all that changed is 1. styling so it's more readable imo, and 2. fields for v3 were changed according to the confluence page

fields that were changed:

servicelevel_[attr] go into a servicelevel dict

delete trackable

delete insurance fields (this info is in the shipment)

remove delivery_attempts, outbound_endpoint and inbound_endpoint

wenwei1030 · 2017-03-24T20:25:20Z

README.md


 ```ruby
-ap @shipment.rates_list.first
+ap @shipment.rates.first


So we change the key from rates_list to rates in the response?

wenwei1030 · 2017-03-24T20:25:46Z

README.md

-#               "rates_url" => "https://api.goshippo.com/v1/shipments/a336daf87a8e442992a68daa6622758f/rates/",
-#                "messages" => [ ] # ommitted for brevity,
-#              "rates_list" => [ ] # ommitted for brevity.
+#   "carrier_accounts"    => [],


Same as my another comment.

yeah just the spacing seemed strange to me, and here's what changed apart from that:

address fields are expanded instead of being ids

submission_date --> shipment_date

return_of --> is_return

insurance and references inside extra

delete rates_url

rates_list --> rates

wenwei1030 · 2017-03-24T20:26:29Z

README.md

              address_from:   {
-                object_purpose: 'PURCHASE',
+                is_complete:    true,


Just to make sure. No more object_purpose in the payload, huh?

right but also refresh to the last commit -- no is_complete, either.

glsoda-zz · 2017-03-24T20:29:49Z

README.md

+#   :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>,


object_state and object_purpose should be removed from shipment

ooh thank you

glsoda-zz · 2017-03-24T20:35:51Z

README.md

@@ -94,66 +90,62 @@ params   = { object_purpose: 'PURCHASE',
 Let's take a quick look at what the `Shipment` object looks like:


should remove @shipment.state from here, 5 lines up ^

daria-lamberson · 2017-03-24T21:22:52Z

lib/shippo/api/api_object.rb

@@ -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


per Guozhen's notes: object_purpose and object_source are removed everywhere, object_state is removed from address, shipment and rates

… status in v3

glsoda-zz · 2017-03-24T21:50:26Z

README.md

+#       "content"   => "",
+#       "provider"  => "FEDEX"
+#     },
+#     "is_return"   => nil,


we're looking to have is_return have a default False value (schema migration pending) - so it shouldn't ever end up being null

… into v3-updates

…client into v3-updates

wenwei1030 · 2017-03-31T00:45:29Z

spec/shippo/api/request_spec.rb

    it 'should include Shippo-API-Version in header if one is specified' do
-      expect(api_request.headers[:'Shippo-API-Version']).to eql("2016-10-25")
+      expect(api_request.headers[:'Shippo-API-Version']).to eql("2017-03-29")


So the test should always use v3?

this one does to test the headers (see line 18 above)

wenwei1030 · 2017-03-31T00:48:38Z

README.md

@@ -213,18 +201,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`:


Good catch. lolol

wenwei1030 · 2017-03-31T00:51:37Z

README.md

-#                "messages" => [ ] # ommitted for brevity,
-#              "rates_list" => [ ] # ommitted for brevity.
+#   "carrier_accounts"    => [],
+#   "address_from"        => [ ... ],   # omitted for brevity


Are we sure to omit the addresses? Maybe show one of them at least?

in v3 they should be expanded fields and not object ids (which is why I removed them and put ...)
if you think there should be an example instead, I can put it in

Yeah, I think it would be better. :)

wenwei1030

Over looks good. Just a couple small comments.

wenwei1030 · 2017-03-31T00:55:32Z

Also, one last thing, you want to update the version of the gem too.

wenwei1030 · 2017-03-31T16:31:13Z

Also, it might be out of scope your task, but we should update readme for v3 or at least mention the response are for v3? Did I miss that?

wenwei1030 · 2017-03-31T19:01:56Z

Just one comment on expanding parcel, but I am gonna approve now. Thanks for making the changes. :)

daria-lamberson added 3 commits March 24, 2017 12:58

v3 changes (all just example changes in the README)

0866750

cleaned up styling

a9c38ea

last few changes by searching for changed fields

06eb599

daria-lamberson requested review from glsoda-zz, vinhhv and wenwei1030 March 24, 2017 20:18

wenwei1030 reviewed Mar 24, 2017

View reviewed changes

removed object purpose from address param examples

97542aa

wenwei1030 reviewed Mar 24, 2017

View reviewed changes

glsoda-zz reviewed Mar 24, 2017

View reviewed changes

daria-lamberson added 4 commits March 24, 2017 13:38

removed object_[x] attrs from shipment apiobject example

bbb35cb

removed shipment.state example

3198a43

fixed requirement

2c38c58

updated api_object file

358bf8e

daria-lamberson commented Mar 24, 2017

View reviewed changes

daria-lamberson added 2 commits March 24, 2017 14:26

removed object_status, since it will just be in the object dict under…

4380589

… status in v3

added back status because it's used in a few places still

b37ff8e

glsoda-zz reviewed Mar 24, 2017

View reviewed changes

daria-lamberson and others added 8 commits March 27, 2017 10:04

chnged is_return example value from nil to false

a338e77

Merge branch 'master' into v3-updates

cc5fb6c

Merge branch 'master' of https://github.com/goshippo/shippo-ruby-client…

110e5dc

… into v3-updates

removed fields for v3 update in examples

57627d2

Merge branch 'v3-updates' of https://github.com/goshippo/shippo-ruby-…

b40344e

…client into v3-updates

Update Shippo version to v3 in tests

ddda4ce

Update object_status to status

278ad80

Update fixtures

d0bcc81

wenwei1030 reviewed Mar 31, 2017

View reviewed changes

daria-lamberson added 3 commits March 31, 2017 10:25

updated changelog and readme before updating gem

fa3764a

updated gem version

52f754a

updated changelog header size inconsistency

4e46846

wenwei1030 approved these changes Mar 31, 2017

View reviewed changes

daria-lamberson added 2 commits March 31, 2017 13:04

expanded parcel and changed to plural

60f9f20

changed more 'parcel's to be plural

dcea188

daria-lamberson merged commit 2486419 into master Mar 31, 2017

daria-lamberson deleted the v3-updates branch March 31, 2017 20:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

V3 updates #50

V3 updates #50

daria-lamberson commented Mar 24, 2017

wenwei1030 Mar 24, 2017

daria-lamberson Mar 24, 2017

daria-lamberson Mar 24, 2017

wenwei1030 Mar 24, 2017

daria-lamberson Mar 24, 2017

wenwei1030 Mar 24, 2017

daria-lamberson Mar 24, 2017

wenwei1030 Mar 24, 2017

daria-lamberson Mar 24, 2017

glsoda-zz Mar 24, 2017

daria-lamberson Mar 24, 2017

daria-lamberson Mar 24, 2017

glsoda-zz Mar 24, 2017

daria-lamberson Mar 24, 2017

daria-lamberson Mar 24, 2017

glsoda-zz Mar 24, 2017

daria-lamberson Mar 27, 2017

wenwei1030 Mar 31, 2017

daria-lamberson Mar 31, 2017

wenwei1030 Mar 31, 2017

wenwei1030 Mar 31, 2017

wenwei1030 Mar 31, 2017

daria-lamberson Mar 31, 2017

wenwei1030 Mar 31, 2017

wenwei1030 left a comment

wenwei1030 commented Mar 31, 2017

wenwei1030 commented Mar 31, 2017

wenwei1030 commented Mar 31, 2017

		@@ -94,66 +90,62 @@ params = { object_purpose: 'PURCHASE',
		Let's take a quick look at what the `Shipment` object looks like:

V3 updates #50

V3 updates #50

Conversation

daria-lamberson commented Mar 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wenwei1030 left a comment

Choose a reason for hiding this comment

wenwei1030 commented Mar 31, 2017

wenwei1030 commented Mar 31, 2017

wenwei1030 commented Mar 31, 2017