jsonapionify 0.12.8 → 0.12.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODg1ZmQxYmM1MzlhOGYwZWU5MmRkZDY5MjM5MzYxZjMyNzk1N2UzOQ==
+    ZDY5OTI1YzBhMWMzMjE1NmNiYjM3NTM5NWI2Y2FhNWJmMDI3ZDYyMQ==
   data.tar.gz: !binary |-
-    NzRiODY0OWUyZDJkNTAxMGYzYWJhNzI5NjZlNTc3M2JjYTRkYzEwZA==
+    MTRiNTI3NTI4ODhjZTk1NzNiNzExYzBmOTU5NjE2ZTliZjRmN2Y4Zg==
 SHA512:
   metadata.gz: !binary |-
-    MjI3NzFhZTcxZDM5MDVjZTZlZDhjY2VmZDgyZTVhNTgwYTU3OWRlMWFiOTVk
-    MDI2ZjgwYTQ4ODI5ODM4MDJlM2UxZWFhMzNiZGIxNDBhOTgxZjNmMGY1Mjdm
-    ZjM0ODMzN2M2NTI0YjhmN2RkNzJjZjJkYmQ3NTI0ODU2NTQxZDk=
+    ZGM4NTlkMDAxYWE5YjAwZDIwNjA4YjQ3NTE2MGU2MTM3MTI0ZTJlZTUzOWFk
+    OTFmODZjN2EzODhiYmU0ZjdjNWQ3YmU0YjdiNTIxZDI5NDRmMzRmMTAxYzFk
+    MjUxYjUyNjA3NTNlZjk1ZDIxNjgzNzJhM2RiNDM0MWU2ODkxNGY=
   data.tar.gz: !binary |-
-    MTMyNmE0N2RkM2RlMzMzZDA4ZGY5NjUwNmQxYmMzOTE1OGMzMGZhMTNlZDMz
-    ZTU4NGNhY2M1YjA0ZjYzNDI3NzQ2YTY3YmJkNDk4Y2VjZWFiZTkxNTgxMGEz
-    MjJhZmY2MDhmN2M2YzdhNjc2YjE0OTY0MGUxYjM5NmQ4MzMwNjk=
+    MzI4NDUyZTQyZTgyOTdiNWJiZjZkNzE0Y2JiYWRhZTYzMzY0MDVjNjM2ZWMy
+    MTAwOWFkNmJjZmJkNmUwZmMzZmE0MjQ3NTI1MjkyNTQ2M2U3MjJlMzBmMDQ1
+    MmNkNjY2OGVhZDBkMzY3NmU0NWY3NDU5ZjM5ZDQ1ZmFkNzRlNDc=

data/lib/jsonapionify/api/action/documentation.rb

@@ -16,26 +16,31 @@ module JSONAPIonify::Api
         request: request,
         context_definitions: sample_context(resource)
       ).exec { |c| c }
+      $pry = true if resource.type == 'organizations'
       case @example_input
       when :resource
         {
           'data' => resource.build_resource(
             context: context,
-            instance: resource.example_instance_for_action(name, context),
-            links:         false
+            instance: resource.example_instance_for_action(name, context, true),
+            links:    false,
+            write:    true
           ).as_json
         }.to_json
       when :resource_identifier
         {
-          'data' => resource.build_resource_identifier(
-            instance: resource.example_instance_for_action(name, context)
-          ).as_json
+          'data' => build_sample_resource_indentifier(name, resource, context).as_json
         }.to_json
       when Proc
         @example_input.call
       end
     end
 
+    def build_sample_resource_indentifier(name, resource, context)
+      rid = resource.build_resource_identifier(instance: resource.example_instance_for_action(name, context, true))
+      resource.respond_to?(:rel) && resource.rel.is_a?(JSONAPIonify::Api::Relationship::Many) ? [rid] : rid
+    end
+
     def example_requests(resource, url)
       responses.map do |response|
         opts                 = {}
@@ -57,6 +62,7 @@ module JSONAPIonify::Api
     end
 
     def sample_context(resource)
+      action = self
       resource.context_definitions.dup.tap do |defs|
         collection_context          = proc do |context|
           3.times.map { resource.example_instance_for_action(action.name, context) }
@@ -66,6 +72,7 @@ module JSONAPIonify::Api
         defs[:paginated_collection] = Context.new(:paginated_collection) { |collection:| collection }
         defs[:instance]             = Context.new(:instance, readonly: true) { |collection:| collection.first }
         defs[:owner_context]        = Context.new(:owner_context, readonly: true) { ContextDelegate::Mock.new } if defs.has_key? :owner_context
+        defs[:action]               = Context.new(:action, readonly: true) { action }
       end
     end
 

data/lib/jsonapionify/api/base/documentation.rb

@@ -26,7 +26,7 @@ module JSONAPIonify::Api
     end
 
     def documentation_output(request)
-      cache_store.fetch(resource_signature) do
+      cache_store.fetch(cache_key documentation: true) do
         JSONAPIonify::Documentation.new(documentation_object(request)).result
       end
     end

data/lib/jsonapionify/api/relationship/many.rb

@@ -83,6 +83,10 @@ module JSONAPIonify::Api
         end
       end
 
+      context :instance do
+        nil
+      end
+
       context :scope do |context, owner:|
         instance_exec(rel.name, owner, context, &rel.resolve.destructure)
       end

data/lib/jsonapionify/api/resource/builders/attribute_builder.rb

@@ -0,0 +1,37 @@
+module JSONAPIonify::Api
+  module Resource::Builders
+    class AttributeBuilder < BaseBuilder
+
+      UnsupportedError = Class.new(StandardError)
+
+      attr_reader :attribute, :write, :context, :instance, :example_id
+      delegate :action_name, to: :context
+
+      def initialize(resource, example_id:, instance:, attribute:, context:, write: false)
+        super(resource)
+        @instance   = instance
+        @context    = context
+        @attribute  = attribute
+        @write      = write
+        @example_id = example_id
+      end
+
+      def build
+        write ? build_writable : build_readable
+      end
+
+      private
+
+      def build_writable
+        raise UnsupportedError unless attribute&.supports_write_for_action?(action_name, context)
+        attribute.resolve(instance, context, example_id: example_id)
+      end
+
+      def build_readable
+        raise UnsupportedError unless attribute&.supports_read_for_action?(action_name, context)
+        attribute.resolve(instance, context, example_id: example_id)
+      end
+
+    end
+  end
+end

data/lib/jsonapionify/api/resource/builders/attributes_builder.rb

@@ -2,14 +2,21 @@ module JSONAPIonify::Api
   module Resource::Builders
     class AttributesBuilder < FieldsBuilder
 
+      attr_reader :write
+
+      def initialize(*args, write: false, **opts)
+        super(*args, **opts)
+        @write = write
+      end
+
       delegate :attributes, to: :resource, prefix: true
 
       private
 
       def build_default
         resource_attributes.each_with_object(Objects::Attributes.new) do |attribute, attrs|
-          if attribute.supports_read_for_action?(action_name, context) && !attribute.hidden_for_action?(action_name)
-            attrs[attribute.name] = attribute.resolve(instance, context, example_id: example_id)
+          if !attribute.hidden_for_action?(action_name)
+            build_attribute(attribute, attrs)
           end
         end
       end
@@ -18,12 +25,22 @@ module JSONAPIonify::Api
         resource_fields.each_with_object(Objects::Attributes.new) do |field, attrs|
           field = field.to_sym
           attribute = resource_attributes.find { |attr| attr.name == field }
-          if attribute&.supports_read_for_action?(action_name, context)
-            attrs[field] = attribute.resolve(instance, context, example_id: example_id)
-          end
+          build_attribute(attribute, attrs) if attribute
         end
       end
 
+      def build_attribute(attribute, attrs)
+        attrs[attribute.name] = AttributeBuilder.build(
+          resource,
+          instance: instance,
+          write: write,
+          attribute: attribute,
+          context: context,
+          example_id: example_id
+        )
+      rescue AttributeBuilder::UnsupportedError
+      end
+
     end
   end
 end

data/lib/jsonapionify/api/resource/builders/fields_builder.rb

@@ -8,8 +8,8 @@ module JSONAPIonify::Api
 
       def initialize(resource, instance:, context:, example_id:)
         super(resource)
-        @instance = instance
-        @context = context
+        @instance   = instance
+        @context    = context
         @example_id = example_id
       end
 

data/lib/jsonapionify/api/resource/builders/resource_builder.rb

@@ -4,13 +4,14 @@ module JSONAPIonify::Api
       delegate :attributes, :relationships, :type, :relationship, to: :resource, prefix: true
       delegate :params, :includes, :fields, :action_name, :request, to: :context
 
-      attr_reader :context, :links, :include_cursor, :block
+      attr_reader :context, :links, :include_cursor, :block, :write
 
-      def initialize(resource, context:, links: true, include_cursor: false, **opts, &block)
+      def initialize(resource, context:, links: true, include_cursor: false, write: false, **opts, &block)
         super(resource, **opts)
         @context = context
         @links = links
         @include_cursor = include_cursor
+        @write = write
         @block = block
       end
 
@@ -33,7 +34,8 @@ module JSONAPIonify::Api
           resource,
           instance:   instance,
           context:    context,
-          example_id: example_id
+          example_id: example_id,
+          write:      write
         )
       end
 

data/lib/jsonapionify/api/resource/defaults/actions.rb

@@ -11,7 +11,9 @@ module JSONAPIonify::Api
         path_actions.map(&:request_method)
       end
 
-      context(:action_name, persisted: true)
+      context(:action_name, persisted: true) do |action: nil|
+        action&.name
+      end
 
       define_action(:options, 'OPTIONS', '*', cacheable: true, callbacks: false) do
         cache 'options-request'

data/lib/jsonapionify/api/resource/defaults/options.rb

@@ -21,8 +21,7 @@ module JSONAPIonify::Api
       end
 
       new_instance do |scope|
-        raise NotImplementedError, 'new_instance not implemented' unless scope.respond_to?(:new)
-        scope.new
+        scope.new if scope.respond_to?(:new)
       end
 
       # Invoke validating contexts

data/lib/jsonapionify/api/resource/definitions/contexts.rb

@@ -17,5 +17,9 @@ module JSONAPIonify::Api
       )
     end
 
+    def remove_context name
+      self.context_definitions.delete(name)
+    end
+
   end
 end

data/lib/jsonapionify/api/resource/definitions/scopes.rb

@@ -17,9 +17,15 @@ module JSONAPIonify::Api
       define_singleton_method(:find_instance) do |id|
         instance_exec(current_scope, id, OpenStruct.new, &block.destructure(object: OpenStruct.new))
       end
-      context :instance, persisted: true do |context, scope:, id:|
-        $pry = true
-        instance_exec(scope, id, context, &block.destructure(object: context))
+      context :instance, persisted: true do |context, scope:, id:, action: nil|
+        case action&.name
+        when :create
+          new_instance
+        when :list
+          nil
+        else
+          instance_exec(scope, id, context, &block.destructure(object: context))
+        end
       end
     end
 

data/lib/jsonapionify/api/resource/documentation.rb

@@ -36,12 +36,16 @@ module JSONAPIonify::Api
       end
     end
 
-    def example_instance_for_action(action, context)
+    def example_instance_for_action(action, context, write = false)
       id = generate_id
       OpenStruct.new.tap do |instance|
         instance.send "#{id_attribute}=", id.to_s
         actionable_attributes = attributes.select do |attr|
-          attr.supports_read_for_action?(action, context)
+          if write
+            attr.supports_write_for_action?(action, context)
+          else
+            attr.supports_read_for_action?(action, context)
+          end
         end
         actionable_attributes.each do |attribute|
           instance.send "#{attribute.name}=", attribute.example(id)

data/lib/jsonapionify/version.rb

@@ -1,3 +1,3 @@
 module JSONAPIonify
-  VERSION = "0.12.8"
+  VERSION = "0.12.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapionify
 version: !ruby/object:Gem::Version
-  version: 0.12.8
+  version: 0.12.9
 platform: ruby
 authors:
 - Jason Waldrip
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -556,6 +556,7 @@ files:
 - lib/jsonapionify/api/relationship/one.rb
 - lib/jsonapionify/api/resource.rb
 - lib/jsonapionify/api/resource/builders.rb
+- lib/jsonapionify/api/resource/builders/attribute_builder.rb
 - lib/jsonapionify/api/resource/builders/attributes_builder.rb
 - lib/jsonapionify/api/resource/builders/base_builder.rb
 - lib/jsonapionify/api/resource/builders/cursor_builder.rb