apollo-federation 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a8a1aec191839f10fc35c1184f6d8c8a1a307dff82ba96a159ef5e140260ba0
-  data.tar.gz: fb9ae5a4a02e97973d4a107050f8190a9f22dbe90ca26017ce7d528f80440965
+  metadata.gz: 8c7f0082fb2aa33917e92171264675d2ac09cbce6b88a4f8cbcf78a0ba87c85e
+  data.tar.gz: e4a21a9eb9866c43c25dd799b032e296a115cbda7e48fdc49dfa4695b7bafb4e
 SHA512:
-  metadata.gz: 3f920513b88d57be072ed9348b9ebea3054c16c9c137f38b30174e6d5d4c768a35f781c7129546f37603563e123486df3782fb51c1fb96cde65a8fa464b8cb5d
-  data.tar.gz: 18de702e8ddc5b0173369cd8b106a95c7d14ff929d31f91fc3ae7c758fcecd1ab3c0f4e9425d712b3c07e7dbad70c6407d60f0dcd6448cc6708d453490e49cc2
+  metadata.gz: fa0445989376adf48a2f32af007bc05522f4d404b43dba8fefb542e8bc2700c83f59a931e9cb15fae2d0e30c68b99fa9e33c1c3e05e562f84b455563ed78fc5d
+  data.tar.gz: 5d4f7b51e6115e92b9aa89b5c59b68e9442867d653381823929c2c16a2ec9c51a74746d5c81092dfb5bfe7d3f56710462c3785b0279593752ceb0577b6237aa6

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [2.2.0](https://github.com/Gusto/apollo-federation-ruby/compare/v2.1.0...v2.2.0) (2022-02-04)
+
+
+### Features
+
+* Get Apollo Federation to work with GraphQL 1.13.x ([#160](https://github.com/Gusto/apollo-federation-ruby/issues/160)) ([800001b](https://github.com/Gusto/apollo-federation-ruby/commit/800001baa5a54ab377998c651e7049da254c451b)), closes [#147](https://github.com/Gusto/apollo-federation-ruby/issues/147)
+
+# [2.1.0](https://github.com/Gusto/apollo-federation-ruby/compare/v2.0.3...v2.1.0) (2022-02-02)
+
+
+### Features
+
+* snake case field references ([f5506ae](https://github.com/Gusto/apollo-federation-ruby/commit/f5506aecd10ea0c4a72744be07e0a9ad5cd45b16))
+
+## [2.0.3](https://github.com/Gusto/apollo-federation-ruby/compare/v2.0.2...v2.0.3) (2022-02-02)
+
+
+### Bug Fixes
+
+* Attempt to remove platform specific lock on google-protobuf ([#171](https://github.com/Gusto/apollo-federation-ruby/issues/171)) ([7898c28](https://github.com/Gusto/apollo-federation-ruby/commit/7898c2851aca06f08fa2559652375769bb98dfd8))
+
+## [2.0.2](https://github.com/Gusto/apollo-federation-ruby/compare/v2.0.1...v2.0.2) (2022-01-31)
+
+
+### Bug Fixes
+
+* Use `bundle install` to avoid `bundle check` that changes our lockfiles ([#170](https://github.com/Gusto/apollo-federation-ruby/issues/170)) ([5c89ff1](https://github.com/Gusto/apollo-federation-ruby/commit/5c89ff1545dd1e6668fcdcf5b6fa89188cbb3ab4))
+
 ## [2.0.1](https://github.com/Gusto/apollo-federation-ruby/compare/v2.0.0...v2.0.1) (2022-01-27)
 
 

data/README.md

@@ -105,10 +105,20 @@ Call `key` within your class definition:
 
 ```ruby
 class User < BaseObject
-  key fields: 'id'
+  key fields: :id
 end
 ```
 
+Compound keys are also supported:
+
+```ruby
+class User < BaseObject
+  key fields: [:id, { organization: :id }]
+end
+```
+
+See [field set syntax](#field-set-syntax) for more details on the format of the `fields` option.
+
 ### The `@external` directive
 
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/federation/core-concepts/#referencing-external-types)
@@ -131,10 +141,12 @@ Pass the `requires:` option to your field definition:
 class Product < BaseObject
   field :price, Int, null: true, external: true
   field :weight, Int, null: true, external: true
-  field :shipping_estimate, Int, null: true, requires: { fields: "price weight"}
+  field :shipping_estimate, Int, null: true, requires: { fields: [:price, :weight] }
 end
 ```
 
+See [field set syntax](#field-set-syntax) for more details on the format of the `fields` option.
+
 ### The `@provides` directive
 
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/federation/advanced-features/#using-denormalized-data)
@@ -143,9 +155,25 @@ Pass the `provides:` option to your field definition:
 
 ```ruby
 class Review < BaseObject
-  field :author, 'User', null: true, provides: { fields: 'username' }
+  field :author, 'User', null: true, provides: { fields: :username }
 end
 ```
+See [field set syntax](#field-set-syntax) for more details on the format of the `fields` option.
+
+### Field set syntax
+
+Field sets can be either strings encoded with the Apollo Field Set [syntax]((https://www.apollographql.com/docs/apollo-server/federation/federation-spec/#scalar-_fieldset)) or arrays, hashes and snake case symbols that follow the graphql-ruby conventions:
+
+```ruby
+# Equivalent to the "organizationId" field set
+:organization_id
+
+# Equivalent to the "price weight" field set
+[:price, :weight]
+
+# Equivalent to the "id organization { id }" field set
+[:id, { organization: :id }]
+```
 
 ### Reference resolvers
 

data/lib/apollo-federation/field.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'apollo-federation/field_set_serializer'
 require 'apollo-federation/has_directives'
 
 module ApolloFederation
@@ -15,7 +16,7 @@ module ApolloFederation
           name: 'requires',
           arguments: [
             name: 'fields',
-            values: requires[:fields],
+            values: ApolloFederation::FieldSetSerializer.serialize(requires[:fields]),
           ],
         )
       end
@@ -24,7 +25,7 @@ module ApolloFederation
           name: 'provides',
           arguments: [
             name: 'fields',
-            values: provides[:fields],
+            values: ApolloFederation::FieldSetSerializer.serialize(provides[:fields]),
           ],
         )
       end

data/lib/apollo-federation/field_set_serializer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'graphql'
+
+module ApolloFederation
+  module FieldSetSerializer
+    extend self
+
+    def serialize(fields)
+      case fields
+      when Hash
+        fields.map do |field, nested_selections|
+          "#{camelize(field)} { #{serialize(nested_selections)} }"
+        end.join(' ')
+      when Array
+        fields.map do |field|
+          serialize(field)
+        end.join(' ')
+      when String
+        fields
+      when Symbol
+        camelize(fields)
+      else
+        raise ArgumentError, "Unexpected field set type: #{fields.class}"
+      end
+    end
+
+    private
+
+    def camelize(field)
+      GraphQL::Schema::Member::BuildType.camelize(field.to_s)
+    end
+  end
+end

data/lib/apollo-federation/interface.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'apollo-federation/field_set_serializer'
 require 'apollo-federation/has_directives'
 
 module ApolloFederation
@@ -22,7 +23,7 @@ module ApolloFederation
           name: 'key',
           arguments: [
             name: 'fields',
-            values: fields,
+            values: ApolloFederation::FieldSetSerializer.serialize(fields),
           ],
         )
       end

data/lib/apollo-federation/object.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'apollo-federation/field_set_serializer'
 require 'apollo-federation/has_directives'
 
 module ApolloFederation
@@ -20,7 +21,7 @@ module ApolloFederation
           name: 'key',
           arguments: [
             name: 'fields',
-            values: fields,
+            values: ApolloFederation::FieldSetSerializer.serialize(fields),
           ],
         )
       end

data/lib/apollo-federation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApolloFederation
-  VERSION = '2.0.1'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Noa Elad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -198,6 +198,7 @@ files:
 - lib/apollo-federation/entity.rb
 - lib/apollo-federation/federated_document_from_schema_definition.rb
 - lib/apollo-federation/field.rb
+- lib/apollo-federation/field_set_serializer.rb
 - lib/apollo-federation/has_directives.rb
 - lib/apollo-federation/interface.rb
 - lib/apollo-federation/object.rb