frenetic 1.0.0.alpha.1 → 1.0.0

data/lib/frenetic/concerns/member_rest_methods.rb

@@ -5,21 +5,18 @@ class Frenetic
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def find( params )
-        params = { id:params } unless params.is_a? Hash
+      def find(params)
+        params = { id:params } unless params.is_a?(Hash)
         return as_mock(params) if test_mode?
-        if response = api.get( member_url(params) ) and response.success?
-          new response.body
-        end
+        response = api.get(member_url(params))
+        new(response.body) if response.success?
       end
 
       def all
         return [] if test_mode?
-
-        if response = api.get( collection_url ) and response.success?
-          Frenetic::ResourceCollection.new self, response.body
-        end
+        response = api.get(collection_url)
+        Frenetic::ResourceCollection.new(self, response.body) if response.success?
       end
     end
   end
-end
+end

data/lib/frenetic/concerns/structured.rb

@@ -28,7 +28,7 @@ class Frenetic
     def rebuild_structure!
       destroy_structure!
       @@signatures[struct_key] = signature
-      Struct.new( struct_key, *@attrs.keys )
+      Struct.new(struct_key, *@attrs.keys)
     end
 
     def structure_expired?
@@ -45,4 +45,4 @@ class Frenetic
       Struct.send :remove_const, struct_key
     end
   end
-end
+end

data/lib/frenetic/connection.rb

@@ -29,15 +29,8 @@ class Frenetic
 
     def process_config(raw_cfg)
       @config = {}.merge(raw_cfg.to_hash)
-      @config[:url] = Addressable::URI.parse(raw_cfg[:url])
-      cfgs = @config.inject({builder:{}, conn:{}}) do |conf, (k,v)|
-        if ConnectionConfigKeys.include?(k)
-          conf[:conn][k] = v
-        else
-          conf[:builder][k] = v
-        end
-        conf
-      end
+      @config[:url] = process_url_config(raw_cfg)
+      cfgs = process_config_options(@config)
       [
         @builder_config = cfgs[:builder],
         @connection_config = cfgs[:conn]
@@ -66,8 +59,25 @@ class Frenetic
 
   private
 
+    def process_url_config(raw_cfg)
+      url = Addressable::URI.parse(raw_cfg[:url])
+      return if !url
+      url.port = url.inferred_port if url.port.nil?
+      url
+    end
+
+    def process_config_options(options)
+      options.each_with_object(builder:{}, conn:{}) do |(k, v), conf|
+        if ConnectionConfigKeys.include?(k)
+          conf[:conn][k] = v
+        else
+          conf[:builder][k] = v
+        end
+      end
+    end
+
     def validate_configuration!
-      raise ConfigError.new(self) if !valid?
+      fail ConfigError.new(self) if !valid?
     end
 
     def use_basic_auth(builder)
@@ -83,11 +93,9 @@ class Frenetic
       builder.use(
         FaradayMiddleware::RackCompatible,
         Rack::Cache::Context,
-        {
-          metastore:     "file:tmp/rack/meta/#{cache_key}",
-          entitystore:   "file:tmp/rack/body/#{cache_key}",
-          ignore_headers: %w{Authorization Set-Cookie X-Content-Digest}
-        }
+        metastore:     "file:tmp/rack/meta/#{cache_key}",
+        entitystore:   "file:tmp/rack/body/#{cache_key}",
+        ignore_headers: %w(Authorization Set-Cookie X-Content-Digest)
       )
     end
 
@@ -104,7 +112,7 @@ class Frenetic
       lib ? require(lib) : yield
     rescue NameError, LoadError => err
       context ||= self
-      raise ConfigError, "Could not load required `#{lib}` dependency for #{context}: #{err.message}"
+      raise MissingDependency.new(lib, context, err)
     end
   end
-end
+end

data/lib/frenetic/errors.rb

@@ -24,9 +24,74 @@ class Frenetic
     end
   end
 
+  class MissingDependency < ConfigError
+    def initialize(lib, context, err)
+      @lib, @context, @err = lib, context, err
+      super(message)
+    end
+
+    def message
+      "Could not load required `#{@lib}` dependency for " \
+        "#{@context} (#{@err.class}: #{@err.message})"
+    end
+  end
+
   # Raised when there is a Hypermedia error
   HypermediaError = Class.new(Error)
 
+  # Raised when there is no _link entry for the desired resource
+  class MissingRelevantLink < HypermediaError
+    def initialize(tmpl_vars, link_set)
+      @tmpl_vars = tmpl_vars
+      @link_set = link_set
+    end
+
+    def message
+      "Could not find a relevant link for the data provided.\n" \
+      "Are any of the links missing the templated:true property?\n" \
+      "  Template Data: #{@tmpl_vars}\n" \
+      "  Link Set: #{@link_set.collect(&:as_json)}"
+    end
+  end
+
+  # Raised when a Resource's GET Url is not included in the _links hash
+  class MissingResourceUrl < HypermediaError
+    def initialize(resource)
+      @resource = resource
+      super(message)
+    end
+
+    def message
+      %("No Hypermedia GET Url found for the resource "#{@resource}")
+    end
+  end
+
+  # Raised when there is no schema defined by the Api root for the given resource
+  class MissingSchemaDefinition < HypermediaError
+    def initialize(namespace)
+      @namespace = namespace
+      super(message)
+    end
+
+    def message
+      %(Could not find schema definition for the resource "#{@namespace}")
+    end
+  end
+
+  # Raised when an expanded URL template is passed the wrong number of arguments
+  class UnfulfilledLinkTemplate < HypermediaError
+    def initialize(template, data)
+      @template = template
+      @data = data
+    end
+
+    def message
+      "The data provided could not satisfy the template requirements.\n" \
+      "  Template: #{@template.pattern}\n" \
+      "  Data: #{@data}"
+    end
+  end
+
   # Raised when there is a Link Template error
   LinkTemplateError = Class.new(Error)
 
@@ -52,7 +117,7 @@ class Frenetic
     def message
       "Mock resource not defined for `#{namespace}`." \
         " Create a new class that inherits from `#{resource}` and mixin" \
-        " `Frenetic::ResourceMockery` to define a mock."
+        ' `Frenetic::ResourceMockery` to define a mock.'
     end
   end
 
@@ -109,4 +174,4 @@ class Frenetic
       @original_exception.message
     end
   end
-end
+end

data/lib/frenetic/hypermedia_link.rb

@@ -3,35 +3,33 @@ require 'active_support/core_ext/hash/indifferent_access'
 
 class Frenetic
   class HypermediaLink
-    def initialize( link )
+    def initialize(link)
       @link = link.with_indifferent_access
     end
 
-    def href( tmpl_data = {} )
+    def href(tmpl_data = {})
       if templated?
-        expand tmpl_data
+        expand(tmpl_data)
       else
         @link['href']
       end
     end
-    alias :to_url :href
+    alias_method :to_url, :href
 
     def templated?
       return false unless hash?
-
       @link['templated'] == true
     end
 
-    def expandable?( tmpl_data )
+    def expandable?(tmpl_data)
       return false unless templated?
-
       tmpl_data = normalize_data(tmpl_data)
-
-      (template.variables & tmpl_data.keys.map(&:to_s)).size == template.variables.size
+      tmpl_dataset = template.variables & tmpl_data.keys.map(&:to_s)
+      tmpl_dataset.size == template.variables.size
     end
 
     def template
-      @template ||= Addressable::Template.new @link['href']
+      @template ||= Addressable::Template.new(@link['href'])
     end
 
     def as_json
@@ -44,31 +42,26 @@ class Frenetic
 
   private
 
-    def expand( tmpl_data )
+    def expand(tmpl_data)
       tmpl_data = normalize_data(tmpl_data)
-
-      return template.expand( tmpl_data ).to_s if expandable? tmpl_data
-
-      raise Frenetic::HypermediaError,
-              "The data provided could not satisfy the template requirements.\n" \
-              "  Template: #{template.pattern}\n" \
-              "  Data: #{tmpl_data}"
+      return template.expand(tmpl_data).to_s if expandable?(tmpl_data)
+      fail UnfulfilledLinkTemplate.new(template, tmpl_data)
     end
 
     def hash?
-      @link.is_a? Hash
+      @link.is_a?(Hash)
     end
 
-    def normalize_data( data )
-      return data if data.is_a? Hash
-
+    def normalize_data(data)
+      return data if data.is_a?(Hash)
       infer_template_values data
     end
 
-    def infer_template_values( data )
+    def infer_template_values(data)
       key = template.variables.first
-
-      { key => data }
+      {
+        key => data
+      }
     end
   end
-end
+end

data/lib/frenetic/hypermedia_link_set.rb

@@ -5,7 +5,7 @@ require 'frenetic/hypermedia_link'
 
 class Frenetic
   class HypermediaLinkSet < Delegator
-    def initialize( link_set = [] )
+    def initialize(link_set = [])
       link_set = [link_set] unless link_set.is_a? Array
 
       @link_set = link_set.map do |link|
@@ -17,27 +17,24 @@ class Frenetic
       end
     end
 
-    def href( tmpl_vars = {} )
+    def href(tmpl_vars = {})
       return @link_set.first.href if tmpl_vars.blank?
-
-      link = find_relevant_link( tmpl_vars ) and link.href( tmpl_vars )
+      link = find_relevant_link(tmpl_vars)
+      link && link.href(tmpl_vars)
     end
 
-    def []( relation )
-      @link_set.find{ |link| link.rel == relation.to_s }
+    def [](relation)
+      @link_set.find { |link| link.rel == relation.to_s }
     end
 
-    def find_relevant_link( tmpl_vars )
-      @link_set.find{ |link| link.expandable? tmpl_vars } or
-        raise Frenetic::HypermediaError,
-                "Could not find a relevant link for the data provided.\n" \
-                "Are any of the links missing the templated:true property?\n" \
-                "  Template Data: #{tmpl_vars}\n" \
-                "  Link Set: #{@link_set.collect(&:as_json)}"
+    def find_relevant_link(tmpl_vars)
+      @link_set.find do |link|
+        link.expandable?(tmpl_vars)
+      end || fail(Frenetic::MissingRelevantLink.new(tmpl_vars, @link_set))
     end
 
     def __getobj__
       @link_set
     end
   end
-end
+end

data/lib/frenetic/middleware/hal_json.rb

@@ -3,13 +3,12 @@ require 'faraday_middleware/response_middleware'
 class Frenetic
   module Middleware
     class HalJson < FaradayMiddleware::ParseJson
-
       def process_response(env)
         super
 
         case env[:status]
-        when 500...599 then raise ServerError.new(env)
-        when 400...499 then raise ClientError.new(env)
+        when 500...599 then fail ServerError.new(env)
+        when 400...499 then fail ClientError.new(env)
         end
       rescue Faraday::Error::ParsingError => err
         case env[:status]
@@ -23,4 +22,4 @@ class Frenetic
 end
 
 Faraday::Response.register_middleware \
-  hal_json:lambda { Frenetic::Middleware::HalJson }
+  hal_json: -> { Frenetic::Middleware::HalJson }

data/lib/frenetic/resource.rb

@@ -13,7 +13,7 @@ class Frenetic
     include HalLinked
     include MemberRestMethods
 
-    def self.api_client( client = nil )
+    def self.api_client(client = nil)
       if client
         @api_client = client
       elsif block_given?
@@ -24,33 +24,37 @@ class Frenetic
         @api_client
       end
     end
+
     # Alias class method hack
-    def self.api; api_client; end
+    def self.api
+      api_client
+    end
 
-    def self.namespace( namespace = nil )
+    def self.namespace(namespace = nil)
       if namespace
         @namespace = namespace.to_s
       elsif @namespace
         @namespace
       else
-        @namespace = self.to_s.demodulize.underscore
+        @namespace = to_s.demodulize.underscore
       end
     end
 
     def self.properties
       return mock_class.default_attributes if test_mode?
-      (api.schema[namespace]||{})['properties'] or raise HypermediaError, %Q{Could not find schema definition for the resource "#{namespace}"}
+      props = (api.schema[namespace] || {})['properties']
+      props || fail(MissingSchemaDefinition.new(namespace))
     end
 
     def self.mock_class
-      @mock_class or raise Frenetic::UndefinedResourceMock.new(namespace, self)
+      @mock_class || fail(Frenetic::UndefinedResourceMock.new(namespace, self))
     end
 
-    def self.as_mock( params = {} )
+    def self.as_mock(params = {})
       mock_class.new params
     end
 
-    def initialize( p = {} )
+    def initialize(p = {})
       build_params p
       @attrs = {}
 
@@ -66,11 +70,11 @@ class Frenetic
     def api_client
       self.class.api_client
     end
-    alias :api :api_client
+    alias_method :api, :api_client
 
     def attributes
       @attributes ||= begin
-        @structure.each_pair.each_with_object({}) do |(k,v), attrs|
+        @structure.each_pair.each_with_object({}) do |(k, v), attrs|
           attrs[k.to_s] = v
         end
       end
@@ -80,14 +84,14 @@ class Frenetic
       @structure
     end
 
-    def __setobj__( obj )
+    def __setobj__(obj)
       @attributes = nil
 
       @structure = obj
     end
 
     def inspect
-      attrs = attributes.collect do |k,v|
+      attrs = attributes.collect do |k, v|
         val = v.is_a?(String) ? "\"#{v}\"" : v || 'nil'
         "#{k}=#{val}"
       end.join(' ')
@@ -99,35 +103,37 @@ class Frenetic
         "#{k}=#{val}"
       end.join(' ')
 
-      "#<#{self.class}:0x#{"%x" % self.object_id}" \
+      "#<#{self.class}:0x#{format('%x', object_id)}" \
         " #{attrs}" \
         " #{ivars}" \
-      ">"
+      '>'
     end
 
   private
 
-    def build_params( p )
+    def build_params(p)
       @params = (p || {}).with_indifferent_access
     end
 
     def extract_embedded_resources
       class_namespace = self.class.to_s.deconstantize
-
-      @params.fetch('_embedded',{}).each do |k,v|
+      @params.fetch('_embedded', {}).each do |k, attrs|
         class_name = "#{class_namespace}::#{k.classify}"
-        klass      = class_name.constantize rescue OpenStruct
-
-        @attrs[k] = if self.class.test_mode? || is_a?(ResourceMockery)
-          klass.as_mock v
+        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
-          klass.new v
+          @attrs[k] = klass.new(attrs)
         end
       end
     end
 
     def build_structure
-      @structure = structure.new( *@attrs.values )
+      @structure = structure.new(*@attrs.values)
     end
 
     def namespace
@@ -139,7 +145,7 @@ class Frenetic
     end
 
     def self.test_mode?
-      api_client.config.test_mode
+      !api_client || api_client.config.test_mode
     end
   end
-end
+end