frenetic 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9feae0cbb4a8f08f8e7cc97d8417e0e3f1347778
-  data.tar.gz: 71b2c0f9ced48a48dba39177a52e1fa7a0da6f43
+  metadata.gz: 65214340421c9e57778a07e6c7f3d59770a8f310
+  data.tar.gz: 9bd8412c8fa0c265f203f737be2a93bb24263c4c
 SHA512:
-  metadata.gz: 9b54379136e8dbac6c6be19a6dfe75e21bc4f715c2197ca53a57b0743c005469c3d46c788fb839f94c79d386ce3ecbe971b47d6038f5bd44f6fb26f2b31ef515
-  data.tar.gz: 5caddca24783caeb5d1f2a163b9a77c65b094a420d576f93f25e176ea22adb471548845934cf782163e0e11922b8840022be5f1146867bbd88d375dd9e6336a1
+  metadata.gz: fe042a279bed164972d0f50e1d9f4a71eb734817cb5bec09c56cce481f4c30d6f6a4cc135ad41061748bcb3dc4fe6398ece30aa51c277ff61c6569cd38b3e1e0
+  data.tar.gz: 35ed3d01a7d3be35e3a2452385ad50e9ceb0df61b61cbe92ad4e53dada9a4c50ecf8a149bd55b35600f43fb420204166c5ff9bbab704077ac8951567414b01ec

data/frenetic.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency             'addressable',         '~> 2.3.4'
 
   gem.add_development_dependency 'awesome_print'
-  gem.add_development_dependency 'rspec',               '~> 3.0.0'
+  gem.add_development_dependency 'rspec',               '~> 3.3.0'
   gem.add_development_dependency 'rack-cache',          '~> 1.2'
   gem.add_development_dependency 'faraday-http-cache',  '~> 0.4.2'
   gem.add_development_dependency 'webmock',             '~> 1.18.0'

data/lib/frenetic.rb

@@ -13,6 +13,8 @@ require 'frenetic/middleware/hal_json'
 require 'frenetic/resource'
 require 'frenetic/resource_collection'
 
+require 'frenetic/structure_registry'
+
 class Frenetic
   extend Forwardable
   include ActiveSupport::Configurable
@@ -33,6 +35,7 @@ class Frenetic
   config_accessor :username
 
   def_delegators :connection, :delete, :get, :head, :options, :patch, :post, :put
+  def_delegators :structure_registry, :construct
 
   # Can't explicitly use config_accessor because we need defaults and
   # ActiveSupport < 4 does not support them
@@ -85,7 +88,11 @@ class Frenetic
   briefly_memoize :description
 
   def schema
-    description['_embedded']['schema']
+    description.fetch('_embedded', {}).fetch('schema')
+  end
+
+  def structure_registry
+    @structure_registry ||= StructureRegistry.new
   end
 
   def reset_connection!

data/lib/frenetic/concerns/hal_linked.rb

@@ -7,12 +7,12 @@ class Frenetic
     extend ActiveSupport::Concern
 
     def links
-      @params['_links']
+      @raw_attributes.fetch('_links', {})
     end
 
     def member_url(params = {})
       resource = @resource_type || self.class.to_s.demodulize.underscore
-      return self.class.member_url(params) unless links.is_a?(Hash)
+      return self.class.member_url(params) if links.empty?
       link = links[resource] || links['self']
       fail MissingResourceUrl.new(resource) if !link
       HypermediaLinkSet.new(link).href params

data/lib/frenetic/concerns/related.rb

@@ -0,0 +1,54 @@
+require 'active_support/core_ext/array/wrap'
+
+class Frenetic
+  module Related
+    extend Frenetic::StructureMethodDefiner
+
+    structure do |resource|
+      resource.send(:relations).each do |relation, props|
+        define_method(relation) do
+          resource.fetch_related_resource(relation, props)
+        end
+      end
+    end
+
+    def extract_related_resources
+      links.each do |k, attrs|
+        next if k == 'self'
+        Array.wrap(attrs).each do |relation|
+          relations[k] = relation
+        end
+      end
+    end
+
+    def fetch_related_resource(relation, props)
+      begin
+        response = api.get(props['href'])
+      rescue ClientParsingError, ClientError => ex
+        raise if ex.status != 404
+        raise ResourceNotFound.new(self, props)
+      end
+      return nil unless response.success?
+      resource_class = self.class.find_resource_class(relation)
+      if collection?(relation)
+        self.class.extract_embedded_resources(response.body).fetch(relation, [])
+      else
+        resource_class.new(response.body)
+      end
+    end
+
+  private
+
+    def collection?(relation)
+      relation != relation.singularize
+    end
+
+    def relations
+      @_relations ||= {}
+    end
+
+    def schema
+      api.description.fetch('_embedded', {}).fetch('schema', {})
+    end
+  end
+end

data/lib/frenetic/concerns/structure_method_definer.rb

@@ -0,0 +1,7 @@
+class Frenetic
+  module StructureMethodDefiner
+    def structure
+      @_structure_block = Proc.new if block_given?
+    end
+  end
+end

data/lib/frenetic/resource.rb

@@ -3,18 +3,21 @@ require 'ostruct'
 require 'active_support/inflector'
 require 'active_support/core_ext/hash/indifferent_access'
 
-require 'frenetic/concerns/structured'
+require 'frenetic/concerns/structure_method_definer'
+require 'frenetic/concerns/related'
 require 'frenetic/concerns/hal_linked'
 require 'frenetic/concerns/member_rest_methods'
 require 'frenetic/concerns/persistence'
 
 class Frenetic
   class Resource < Delegator
-    include Structured
+    include Related
     include HalLinked
     include MemberRestMethods
     include Persistence
 
+    attr_reader :known_attributes, :raw_attributes
+
     def self.api_client(client = nil)
       if client
         @api_client = client
@@ -32,6 +35,32 @@ class Frenetic
       api_client
     end
 
+    def self.extract_embedded_resources(resource)
+      resource.fetch('_embedded', {}).each_with_object({}) do |(resource_name, attrs), embeds|
+        resource_class = find_resource_class(resource_name)
+        if test_mode? && resource_class.respond_to?(:as_mock)
+          embeds[resource_name] = resource_class.as_mock(attrs)
+        elsif attrs.is_a?(Array)
+          embeds[resource_name] = attrs.map do |a|
+            resource_class.new(a)
+          end
+        else
+          embeds[resource_name] = resource_class.new(attrs)
+        end
+      end
+    end
+
+    def self.find_resource_class(resource_name)
+      class_namespace = self.to_s.deconstantize
+      class_name = "#{class_namespace}::#{resource_name.classify}"
+      begin
+        class_name.constantize
+      rescue NameError => ex
+        raise if ex.message !~ /uninitialized constant/
+        OpenStruct
+      end
+    end
+
     def self.namespace(namespace = nil)
       if namespace
         @namespace = namespace.to_s
@@ -52,20 +81,21 @@ class Frenetic
       @mock_class || fail(Frenetic::UndefinedResourceMock.new(namespace, self))
     end
 
-    def self.as_mock(params = {})
-      mock_class.new params
+    def self.as_mock(attributes = {})
+      mock_class.new(attributes)
     end
 
-    def initialize(params = {})
-      @attrs = {}
-      initialize_with(params)
+    def initialize(attributes = nil)
+      @raw_attributes = {}
+      @known_attributes = {}
+      initialize_with(attributes || {})
     end
 
-    def initialize_with(p)
-      build_params(p)
-      assign_attributes(@params)
+    def initialize_with(attributes)
+      assign_attributes(attributes)
       extract_embedded_resources
-      build_structure
+      extract_related_resources
+      init_structure
     end
 
     def api_client
@@ -73,10 +103,16 @@ class Frenetic
     end
     alias_method :api, :api_client
 
-    def assign_attributes(params)
-      properties.keys.each do |k|
-        @attrs[k] = params[k]
+    def attributes=(attributes)
+      assign_attributes(attributes)
+    end
+
+    def assign_attributes(new_attributes)
+      if !new_attributes.respond_to?(:stringify_keys)
+        raise ArgumentError, "When assigning attributes, you must pass a hash as an argument."
       end
+      @raw_attributes.merge!(new_attributes.stringify_keys)
+      _assign_attributes(@raw_attributes)
     end
 
     def attributes
@@ -87,13 +123,16 @@ class Frenetic
       end
     end
 
+    def extract_embedded_resources
+      @known_attributes.merge!(self.class.extract_embedded_resources(@raw_attributes))
+    end
+
     def __getobj__
       @structure
     end
 
     def __setobj__(obj)
       @attributes = nil
-
       @structure = obj
     end
 
@@ -103,7 +142,7 @@ class Frenetic
         "#{k}=#{val}"
       end.join(' ')
 
-      ivars = (instance_variables - [:@structure, :@attributes]).map do |k|
+      ivars = (instance_variables - [:@structure, :@attributes, :@known_attributes, :@raw_attributes, :@_relations]).map do |k|
         val = instance_variable_get k
         val = val.is_a?(String) ? "\"#{val}\"" : val || 'nil'
 
@@ -118,29 +157,22 @@ class Frenetic
 
   private
 
-    def build_params(p)
-      @params = (p || {}).with_indifferent_access
+    def _assign_attributes(attributes)
+      properties.keys.each do |k|
+        _assign_attribute(k, attributes[k])
+      end
     end
 
-    def extract_embedded_resources
-      class_namespace = self.class.to_s.deconstantize
-      @params.fetch('_embedded', {}).each do |k, attrs|
-        class_name = "#{class_namespace}::#{k.classify}"
-        klass = begin
-          class_name.constantize
-        rescue
-          OpenStruct
-        end
-        if self.class.test_mode? && klass.respond_to?(:as_mock)
-          @attrs[k] = klass.as_mock(attrs)
-        else
-          @attrs[k] = klass.new(attrs)
-        end
-      end
+    def _assign_attribute(key, value)
+      @known_attributes[key] = value
+    end
+
+    def init_structure
+      @structure = api_client.construct(self, @known_attributes, struct_key)
     end
 
-    def build_structure
-      @structure = structure.new(*@attrs.values)
+    def struct_key
+      "#{self.class}::FreneticResourceStruct".gsub('::', '')
     end
 
     def namespace

data/lib/frenetic/resource_collection.rb

@@ -6,10 +6,10 @@ class Frenetic
     include HalLinked
     include CollectionRestMethods
 
-    def initialize(resource, params = {})
+    def initialize(resource, attributes = {})
       @resource_class = resource
-      @resources      = []
-      @params         = params || {}
+      @resources = []
+      @raw_attributes = (attributes || {}).stringify_keys
 
       extract_resources!
     end
@@ -43,7 +43,7 @@ class Frenetic
     end
 
     def embedded_collection
-      @params.fetch('_embedded', {}).fetch(collection_key, [])
+      @raw_attributes.fetch('_embedded', {}).fetch(collection_key, [])
     end
   end
 end

data/lib/frenetic/resource_mockery.rb

@@ -8,7 +8,7 @@ class Frenetic
     extend Forwardable
     extend ActiveSupport::Concern
 
-    def_delegators :@params, :as_json, :to_json
+    def_delegators :@raw_params, :as_json, :to_json
 
     included do
       # I'm sure this violates some sort of CS principle or best practice,
@@ -17,11 +17,11 @@ class Frenetic
     end
 
     def attributes
-      @params
+      @known_attributes
     end
 
     def properties
-      @params.each_with_object({}) do |(k, v), props|
+      @known_attributes.each_with_object({}) do |(k, v), props|
         props[k] = v.class.to_s.underscore
       end
     end
@@ -44,14 +44,13 @@ class Frenetic
 
   private
 
-    def build_params(params)
-      raw_params = (params || {}).with_indifferent_access
+    def _assign_attributes(attributes)
       defaults = default_attributes.with_indifferent_access
-      @params = cast_types(defaults.deep_merge(raw_params))
+      @known_attributes = cast_types(defaults.deep_merge(@raw_attributes))
     end
 
-    def build_structure
-      @structure = OpenStruct.new(@attrs)
+    def init_structure
+      @structure = OpenStruct.new(@known_attributes)
     end
 
     # A naive attempt to cast the attribute types of the incoming mock data

data/lib/frenetic/structure_registry.rb

@@ -0,0 +1,20 @@
+require 'frenetic/structure_registry/retriever'
+
+class Frenetic
+  class StructureRegistry
+    attr_reader :signatures
+
+    def initialize(retriever_class: Frenetic::StructureRegistry::Retriever)
+      @signatures = {}
+      @retriever_class = retriever_class
+    end
+
+    def construct(resource, attributes, key)
+      fetch(resource, attributes, key).new(*attributes.values)
+    end
+
+    def fetch(resource, attributes, key)
+      @retriever_class.new(signatures, resource, attributes, key).call
+    end
+  end
+end

data/lib/frenetic/structure_registry/rebuilder.rb

@@ -0,0 +1,41 @@
+class Frenetic
+  class StructureRegistry
+    class Rebuilder
+      attr_reader :signatures, :resource
+
+      def initialize(signatures, resource, attributes, key, signature)
+        @signatures, @resource, @attributes, @key, @signature = signatures, resource, attributes, key, signature
+      end
+
+      def call
+        destroy!
+        signatures[@key] = @signature
+        Struct.new(@key, *@attributes.keys, &structure_instance_methods)
+      end
+
+      def destroy!
+        return unless exists?
+        signatures.delete(@key)
+        Struct.send(:remove_const, @key)
+      end
+
+      def exists?
+        Struct.constants.include?(@key.to_sym)
+      end
+
+    private
+
+      def structure_instance_methods
+        method_builders = resource.class.ancestors[1..-1].map do |ancestor|
+          ancestor.instance_variable_get('@_structure_block')
+        end.compact
+        _resource = resource
+        Proc.new do
+          method_builders.each do |builder|
+            instance_exec(_resource, &builder)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/frenetic/structure_registry/retriever.rb

@@ -0,0 +1,35 @@
+require 'frenetic/structure_registry/rebuilder'
+
+class Frenetic
+  class StructureRegistry
+    class Retriever
+      def initialize(signatures, resource, attributes, key, rebuilder_class: Rebuilder)
+        if key.blank?
+          raise ArgumentError, "When registering a resource structure, you must provide a non-blank key"
+        end
+        @signatures, @resource, @attributes, @key = signatures, resource, attributes, key
+        @rebuilder_class = rebuilder_class
+      end
+
+      def call
+        if expired?
+          @rebuilder_class.new(@signatures, @resource, @attributes, @key, struct_signature).call
+        else
+          fetch_structure
+        end
+      end
+
+      def expired?
+        @signatures[@key] != struct_signature
+      end
+
+      def fetch_structure
+        Struct.const_get(@key)
+      end
+
+      def struct_signature
+        Digest::SHA1.hexdigest(@attributes.keys.sort.join(''))
+      end
+    end
+  end
+end