Metadata query params #34

kleinjm · 2021-08-11T23:14:02Z

What

Generating the SDK after changes to the swagger.json file
Adds ability to query orders index with metadata
Set up a toggle for running specs locally

Why

Adds the ability to query orders via metadata.

SDK Release Checklist

Have you added an integration test for the changes?
Have you built the gem locally and made queries against it successfully?
Did you update the changelog?
Did you bump the package version?
For breaking changes, did you plan for the release of the new SDK versions and deploy the API to production?

kleinjm · 2021-08-17T19:17:16Z

.github/workflows/test.yml

@@ -13,6 +13,7 @@ jobs:
    strategy:
      matrix:
        ruby-version: [3.0.1, 2.7.4, 2.6.8]
+      max-parallel: 1


this will slow down CI but reduce the amount of "collisions" we may see due to the same tests running on the same endpoints in parallel. Considering we don't run CI on these projects very frequently, I feel the stability is worth the extra 2 minutes until we change up the test suite to not hit the real API

This makes sense!

kleinjm · 2021-08-17T19:17:54Z

spec/integration/estimates_spec.rb

@@ -33,7 +27,7 @@
    )

    expect(flight_estimate.data.type).to eq 'flight'
-    expect(flight_estimate.data.mass_g).to eq 1_031_697
+    expect(flight_estimate.data.mass_g).to eq 1_000_622


I confirmed this change is correct with Brendan

As discussed, we will probably want to remove this type of tests from the SDK itself.

kleinjm · 2021-08-17T19:18:59Z

spec/integration/orders_spec.rb

@@ -71,15 +65,24 @@
    expect(order.registry_url).not_to be_empty
  end

-  it 'supports create with metadata' do
+  it 'supports creation with and querying by metadata' do


I feel this is the most stable strategy for now. Creating an order with metadata and then querying for it in the same spec reduces the chance of the order being on a following page

kleinjm · 2021-08-17T19:19:30Z

spec/integration/projects_spec.rb

@@ -43,20 +39,12 @@
  end

  describe 'returned fields' do


combining specs here for performance and stability

kleinjm · 2021-08-17T19:19:59Z

spec/spec_helper.rb

+      if ENV.fetch('LOCAL_SDK_TEST', false)
+        config.access_token = ENV.fetch('LOCAL_PATCH_API_KEY')


set these 2 env vars to run tests against your local patch instance

pcothenet

To confirm: Ruby was handling the metadata object quite nicely out of the box?

If so, looks good to go!

pcothenet · 2021-08-17T21:59:26Z

lib/patch_ruby/api/orders_api.rb

+    # @option opts [String] :metadata_ext_id 
+    # @option opts [String] :metadata_disregarded 


Those two feel a little confusing here. Any chance we could rename those two examples?

pcothenet · 2021-08-17T22:00:12Z

lib/patch_ruby/models/create_ethereum_estimate_request.rb

@@ -27,6 +29,7 @@ def self.attribute_map
      {
        :'timestamp' => :'timestamp',
        :'gas_used' => :'gas_used',
+        :'transaction_value_eth_gwei' => :'transaction_value_eth_gwei',


@kleinjm can you add this one to the changelog?

pcothenet · 2021-08-17T22:00:58Z

spec/integration/preferences_spec.rb

-  before do
-    Patch.configure do |config|
-      config.access_token = ENV['SANDBOX_API_KEY']
-    end
-  end


Moved to the helper

pcothenet · 2021-08-17T22:01:15Z

spec/integration/projects_spec.rb

-    it 'returns average_price_per_tonne_cents_usd' do
-      expect(@project.average_price_per_tonne_cents_usd).to be_an_instance_of(Integer)
-    end
+    it 'returns the expected fields' do


pcothenet · 2021-08-17T22:03:18Z

Note: please add the new ETH parameter to the changelog!

kleinjm · 2021-08-17T23:07:25Z

Ruby was handling the metadata object quite nicely out of the box?

yep! Which makes sense since it's ruby to ruby

bspellacy · 2021-08-18T08:55:46Z

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

+## [1.9.0] - 2021-08-17


Thoughts on having this be Unreleased until we tag main ?

@bspellacy not sure I follow. What's the release flow you have in mind? I'm planning on releasing all the SDKs then the changes to patch (docs)

update sdk post-addition of metadata query param

7f587c2

kleinjm requested a review from pcothenet August 11, 2021 23:14

kleinjm added 2 commits August 12, 2021 18:01

toggle local dev env + test for metadata

3fb156a

use metadata method signature

5073430

kleinjm removed the request for review from pcothenet August 13, 2021 16:01

kleinjm added 4 commits August 13, 2021 18:45

remove error model

ef8337f

fix specs

fcccd4c

do not run the tests in parallel

67adf5f

bump version and update changelog

2172df6

kleinjm commented Aug 17, 2021

View reviewed changes

kleinjm requested a review from pcothenet August 17, 2021 19:21

pcothenet approved these changes Aug 17, 2021

View reviewed changes

add ruby version, regenerate sdk, and update changelog

c11b163

bspellacy reviewed Aug 18, 2021

View reviewed changes

kleinjm merged commit ae67c8d into main Aug 18, 2021

kleinjm deleted the jklein/metadata_query branch August 18, 2021 17:16

		if ENV.fetch('LOCAL_SDK_TEST', false)
		config.access_token = ENV.fetch('LOCAL_PATCH_API_KEY')

		# @option opts [String] :metadata_ext_id
		# @option opts [String] :metadata_disregarded

Metadata query params #34

Metadata query params #34

Uh oh!

Conversation

kleinjm commented Aug 11, 2021 • edited by pcothenet Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

SDK Release Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pcothenet left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pcothenet commented Aug 17, 2021

Uh oh!

kleinjm commented Aug 17, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kleinjm commented Aug 11, 2021 •

edited by pcothenet

Loading