http-api-tools 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTExZDgwZjc0ZDQ3M2NiYjlhZDI2NGZlNWIxMWRiOGU2ZGI1MTlkNA==
+    YTBjYWE0MmIwNjVlOTJlNGJkOWJmZjJlMzViNGI5YjBlMDQ0YWM4Yg==
   data.tar.gz: !binary |-
-    YWU4ZTczYzliMjQwZjhjYWJhMDI0MTEzODlmZTIxM2I2ODhlNmVhYQ==
+    YzE2M2U4MGZjMzUzNGViOTE4YjAwYjdmN2FhZDgyZjU3YThkMjBjOQ==
 SHA512:
   metadata.gz: !binary |-
-    YzYxODgxNWEyY2YxYmY5MDVhOTdkNTgxNTdkZjUyNmIyOTM2YWJkOGJkNjRk
-    YTJiNTYwMzczM2U3NzNmZjczNzU1Y2E5MzczZDk2MDU3ODI5NGE4N2RkNWJi
-    YzdjOWI1YjdjYWViMWJjYzFiNTU4MzA0Nzg5MTQxMGRmODk2YmU=
+    MWY0NGQ4NDQ5NzdiMTExZmM4NzYwNTgxZWY2ZGFiMDk5MmJhNzZlNGZiNjA2
+    NjA3MGMwY2QyODQ3MTIzNDAwOTQxYjNhMTg3MTNmMDk1MzcwYTk4Njg2ZGE1
+    NGQwY2Y1NmM2ZmQyYjgzNzBlMjdlMjYwZWNiNTA0ZDk3YzJlZmM=
   data.tar.gz: !binary |-
-    ZDUyNmQ1YjYxYjI1YTgzN2E0ZjA3ZGI5ZjEzN2VkNTljODM4OTZlODE4M2Jj
-    MmM5MWUzM2EwZjk0ODM1YTU1MzlkMDEwYTQwNWZmNjZlZmUzZmVlMzQ0Nzc1
-    MmYwNDc1MDNmZDI4NTMxZmM3OTY1ZjRmZmRhZTQwOGVmYTJiNmU=
+    MjRmNTgxNmFjYzEyYzcyNDhlOTZkMTg0OTU1MTcyZDE4ZGFlYzE0YzhjYTc3
+    MWUzODkyZjFlNmNmOWEwNmM3MGQ5NzQzZjNlOTlhZWZkODkxZWIxMDBiMTMz
+    NWQ2NmU5ZDM2MjZkZDY4ZTc1NWJkYzU2NDBmMWZhNGI3ODM1YTM=

data/README.md

@@ -244,15 +244,17 @@ and splat into the serializer includes:
 
 and/or active record queries:
 
-`User.find(params[:id]).includes(*user_serializer.includes_for_query)`
+`User.find(params[:id]).includes(*relation_includes.for_query(UserSerializer))`
 
 When providing the includes for an active record query, we actually want a deeper set of includes in order to account for the ids fetched for has_many relationships. If we passed the same set of includes to the query as we pass to the serializer, we'd end up with n+1 queries when fetching the ids for the has_many relationships.
 
-Calling `user_serializer.includes_for_query` will figure out the minimum set of includes that are required based on the following:
+Calling `relation_includes.for_query(UserSerializer)` will figure out the minimum set of includes that are required based on the following:
 
 * The models and their relationships
 * The relationships actually being serialized
 
+**** Note that this particular API is pretty rough at the moment and likely to change once we find a nicer way of describing this feature.
+
 ##### Restricting what is included
 Once you expose what can be included as a query string parameter you risk exposing too much information or poorly considered api calls that fetch too much. This can be countered by defining what is `includable` for each serializer when it's being used as the root serializer for a json response.
 

data/lib/hat.rb

@@ -1,4 +1,5 @@
 require "hat/version"
+require 'hat/nesting/json_serializer'
 require 'hat/sideloading/json_serializer'
 require 'hat/sideloading/json_deserializer'
 require 'hat/model'

data/lib/hat/base_json_serializer.rb

@@ -74,10 +74,6 @@ module Hat
       self.class._includable
     end
 
-    def includes_for_query
-      RelationIncludes.new(*ExpandedRelationIncludes.new(relation_includes, self))
-    end
-
     protected
 
     attr_accessor :identity_map

data/lib/hat/expanded_relation_includes.rb

@@ -3,22 +3,22 @@
 module Hat
   class ExpandedRelationIncludes
 
-    def initialize(relation_includes, serializer)
+    def initialize(relation_includes, serializer_class)
       @relation_includes = relation_includes
-      @serializer = serializer
+      @serializer_class = serializer_class
     end
 
     def to_a
       @expanded_includes ||= begin
         expanded_includes = []
-        expand_includes(serializer.class, relation_includes, expanded_includes)
+        expand_includes(serializer_class, relation_includes, expanded_includes)
         expanded_includes
       end
     end
 
     private
 
-    attr_reader :serializer, :relation_includes
+    attr_reader :serializer_class, :relation_includes
 
     def expand_includes(target_serializer_class, base_includes, expanded_includes)
 

data/lib/hat/relation_includes.rb

@@ -77,6 +77,12 @@ module Hat
       end
     end
 
+    #Return an expanded version of the includes for use in a query.
+    #This api is still pretty rough and likely to change
+    def for_query(serializer_class)
+      RelationIncludes.new(*ExpandedRelationIncludes.new(self, serializer_class))
+    end
+
     private
 
     attr_accessor :includes

data/lib/hat/version.rb

@@ -1,3 +1,3 @@
 module Hat
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/hat/expanded_relation_includes_spec.rb

@@ -6,8 +6,7 @@ module Hat
 
     describe "#to_a" do
 
-      let(:serializer) { Hat::Sideloading::PersonSerializer.new(Person.new) }
-      let(:expanded_includes) { ExpandedRelationIncludes.new(includes, serializer) }
+      let(:expanded_includes) { ExpandedRelationIncludes.new(includes, Hat::Sideloading::PersonSerializer) }
 
       context 'with single-level includes' do
 

data/spec/hat/relation_includes_spec.rb

@@ -181,5 +181,16 @@ module Hat
       end
     end
 
+    describe "#for_query" do
+
+      let(:includes) { RelationIncludes.new(:employer, { skills: [:person] }).for_query(Hat::Sideloading::PersonSerializer) }
+
+      it "creates includes for included relationships and has_many relationships for fetching ids" do
+        expect(includes.find(:employer)).to eq({ employer: [:employees] })
+        expect(includes.find(:skills)).to eq({ skills: [{ person: [:skills] }] })
+      end
+
+    end
+
   end
 end

data/spec/hat/sideloading/json_serializer_spec.rb

@@ -78,17 +78,6 @@ module Hat
               expect(serialized[:linked][:skills].first[:name]).to eql person.skills.first.name
             end
 
-            describe "#includes_for_query" do
-
-              let(:includes_for_query) { serializer.includes_for_query }
-
-              it "expands includes for included relationships and has_many relationships for fetching ids" do
-                expect(includes_for_query.find(:employer)).to eq({ employer: [:employees] })
-                expect(includes_for_query.find(:skills)).to eq({ skills: [{ person: [:skills] }] })
-              end
-
-            end
-
           end
 
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-api-tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob Monie