frenetic 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c762ec3d9f1ece32685aa4e6e6acf19d02db55fe
-  data.tar.gz: 44c50996e3b1b7e8a8261d7d2919636383f0de70
+  metadata.gz: 9feae0cbb4a8f08f8e7cc97d8417e0e3f1347778
+  data.tar.gz: 71b2c0f9ced48a48dba39177a52e1fa7a0da6f43
 SHA512:
-  metadata.gz: 17ca597ab9f13709f63067da856c157ae6505256ce9ec1f0feee51acb2be029c933da95fd6ce2868138f6fe0399824cf5755214845b914303685b2e2378ed539
-  data.tar.gz: 7d0571cd0e36780c57b4a9edd6e6d805fcfdbc0f0b58fddbc4b9258d642a2c5970d33ae7e3d9ff28f714c9c64fdb6abce317030a753f63a07505152df5687f58
+  metadata.gz: 9b54379136e8dbac6c6be19a6dfe75e21bc4f715c2197ca53a57b0743c005469c3d46c788fb839f94c79d386ce3ecbe971b47d6038f5bd44f6fb26f2b31ef515
+  data.tar.gz: 5caddca24783caeb5d1f2a163b9a77c65b094a420d576f93f25e176ea22adb471548845934cf782163e0e11922b8840022be5f1146867bbd88d375dd9e6336a1

data/.travis.yml

@@ -1,3 +1,3 @@
 rvm:
   - 2.1.2
-script: bundle exec rspec --require spec_helper --order rand --color --format documentation
+script: bundle exec rake

data/README.md

@@ -349,6 +349,15 @@ like so:
 > Order.find(1)
 # <Order id=1 total=54.47>
 
+> Order.find_by(id:1)
+# <Order id=1 total=54.47>
+
+> Order.find_by!(id:-1, state:'active')
+# Frenetic::ResourceNotFound: Couldn't find Order with id=-1, state=active
+
+> Order.find_by(id:-1)
+# nil
+
 > Order.all
 # [<Order id=1 total=54.47>,<Order id=2 total=42.00>]
 ```

data/Rakefile

@@ -1,2 +1,6 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
+
+Dir['tasks/**/*.rake'].each { |task| load task }
+
+task default: %w(rubocop spec)

data/frenetic.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'webmock',             '~> 1.18.0'
   gem.add_development_dependency 'timecop',             '~> 0.7.1'
   gem.add_development_dependency 'appraisal',           '~> 1.0.2'
+  gem.add_development_dependency 'rubocop',             '~> 0.29.1'
 end

data/lib/frenetic.rb

@@ -6,6 +6,7 @@ require 'active_support/core_ext/hash/reverse_merge'
 
 require 'frenetic/version'
 require 'frenetic/errors'
+require 'frenetic/behaviors'
 require 'frenetic/briefly_memoizable'
 require 'frenetic/connection'
 require 'frenetic/middleware/hal_json'

data/lib/frenetic/behaviors.rb

@@ -0,0 +1,6 @@
+require 'frenetic/behaviors/alternate_string_identifier'
+
+class Frenetic
+  module Behaviors
+  end
+end

data/lib/frenetic/behaviors/alternate_string_identifier.rb

@@ -0,0 +1,56 @@
+# Allows a resource to be found by a string-based alternative key
+#
+# For example
+#
+# module MyClient
+#   module MyResource < Frenetic::Resource
+#     extend Frenetic::Behaviors::AlternateStringIdentifier
+#
+#     def self.find(id)
+#       super(finder_params(id, :username))
+#     end
+#   end
+# end
+#
+# Given an Api Schema such as:
+#
+# {
+#   _links: {
+#     my_resource: [{
+#       { href: '/api/my_resource/{id}', rel: 'id' },
+#       { href: '/api/my_resource/{username}?specific_to=username', rel: 'username' },
+#     }]
+#   }
+# }
+#
+# MyClient::MyResource.find will choose the alternate link relation based on
+# the string-based ID passed in.
+#
+# MyClient::MyResource.find(1)
+# # Executes /api/my_resource/1
+#
+# MyClient::MyResource.find('100')
+# # Executes /api/my_resource/100
+#
+# MyClient::MyResource.find('jdoe')
+# Executes /api/my_resource/jdoe?specific_to=username
+#
+class Frenetic
+  module Behaviors
+    module AlternateStringIdentifier
+      def finder_params(unique_id, alternate_key)
+        return unique_id if unique_id.is_a? Hash
+        params = {}
+        return params if unique_id.blank?
+        key =
+          if unique_id.to_i.to_s == unique_id.to_s
+            :id
+          elsif !unique_id.nil?
+            alternate_key
+          end
+        params[key] = unique_id
+        params
+      end
+    end
+  end
+end

data/lib/frenetic/concerns/hal_linked.rb

@@ -12,6 +12,7 @@ class Frenetic
 
     def member_url(params = {})
       resource = @resource_type || self.class.to_s.demodulize.underscore
+      return self.class.member_url(params) unless links.is_a?(Hash)
       link = links[resource] || links['self']
       fail MissingResourceUrl.new(resource) if !link
       HypermediaLinkSet.new(link).href params
@@ -25,13 +26,13 @@ class Frenetic
       def member_url(params = {})
         link = links[namespace]
         fail MissingResourceUrl.new(namespace) if !link
-        HypermediaLinkSet.new(link).href params
+        HypermediaLinkSet.new(link).href(params)
       end
 
-      def collection_url
+      def collection_url(*params)
         link = links[namespace.pluralize]
         fail MissingResourceUrl.new(namespace.pluralize) if !link
-        HypermediaLinkSet.new(link).href
+        HypermediaLinkSet.new(link).href(*params)
       end
     end
   end

data/lib/frenetic/concerns/member_rest_methods.rb

@@ -6,17 +6,39 @@ class Frenetic
 
     module ClassMethods
       def find(params)
+        fail ResourceNotFound.new(self, params) if params.blank?
         params = { id:params } unless params.is_a?(Hash)
         return as_mock(params) if test_mode?
-        response = api.get(member_url(params))
-        new(response.body) if response.success?
+        fetch_resource(params)
+      end
+
+      def find_by!(params)
+        find(params)
+      end
+
+      def find_by(params)
+        find_by!(params)
+      rescue ClientError
+        nil
       end
 
-      def all
+      def all(*params)
         return [] if test_mode?
-        response = api.get(collection_url)
+        response = api.get(collection_url(*params))
         Frenetic::ResourceCollection.new(self, response.body) if response.success?
       end
+
+    private
+
+      def fetch_resource(params)
+        begin
+          response = api.get(member_url(params))
+        rescue ClientParsingError, ClientError => ex
+          raise if ex.status != 404
+          raise ResourceNotFound.new(self, params)
+        end
+        new(response.body) if response.success?
+      end
     end
   end
 end

data/lib/frenetic/concerns/persistence.rb

@@ -0,0 +1,36 @@
+class Frenetic
+  module Persistence
+    def save
+      persist_resource
+    end
+
+    def save!
+      save || fail(ResourceInvalid.new(self))
+    end
+
+    def errors=( errs )
+      @_errors = errs
+    end
+
+    def errors
+      @_errors
+    end
+
+    def valid?
+      @_errors ? @_errors.empty? : true
+    end
+
+  private
+
+    def persist_resource
+      response = api.post(member_url(attributes), note:attributes)
+      initialize_with(response.body) if response.success?
+    rescue ClientError => ex
+      raise if ex.status != 422
+      self.errors = ex.body.fetch('errors', base: ex.error )
+      return false
+    else
+      return true
+    end
+  end
+end

data/lib/frenetic/errors.rb

@@ -124,15 +124,17 @@ class Frenetic
   # Parent class for all specific exceptions which are raised as a result of a
   # network response.
   class ResponseError < Error
-    attr_reader :env, :error, :method, :status, :url
+    attr_reader :body, :env, :error, :method, :status, :url
     def initialize(env)
       env ||= {}
-      body = env.fetch(:body, {})
-      @env = env
-      @error = body['error']
-      @method = env[:method]
-      @status = env[:status]
-      @url = env[:url]
+      if env.respond_to?(:fetch)
+        @body = env.fetch(:body, {})
+        @env = env
+        @error = @body['error']
+        @method = env[:method]
+        @status = env[:status]
+        @url = env[:url]
+      end
       super(message)
     end
 
@@ -144,6 +146,65 @@ class Frenetic
   # Raised when a network response returns a 400-level error
   ClientError = Class.new(ResponseError)
 
+  # Raise when a network reponse returns a 404 Not Found error
+  class ResourceNotFound < ClientError
+    def initialize(resource, params)
+      @resource = resource.to_s.demodulize
+      @params = params
+      @status = 404
+      super(message)
+    end
+
+    def message
+      if @params.blank?
+        "Couldn't find #{@resource} without an ID"
+      else
+        "Couldn't find #{@resource} with #{stringified_params}"
+      end
+    end
+
+  private
+
+    def stringified_params
+      pairs = @params.each_with_object([]) do |*tuple, agg|
+        agg.concat(tuple)
+      end
+      assignments = pairs.map do |pair|
+        pair.join('=')
+      end
+      assignments.join(', ')
+    end
+  end
+
+  # Raise when Resource#save! is called and the request fails with a 422
+  class ResourceInvalid < ClientError
+    attr_reader :errors
+
+    def initialize(resource)
+      @errors = resource.errors
+      @status = 422
+      super(message)
+    end
+
+    def message
+      "Validation failed: #{validation_errors}"
+    end
+
+  private
+
+    def validation_errors
+      errors.map do |attribute, error_messages|
+        error_messages.map do |error_message|
+          if attribute == 'base'
+            error_message.capitalize
+          else
+            "#{attribute.titleize} #{error_message}"
+          end
+        end
+      end.flatten.join(', ')
+    end
+  end
+
   # Raised when a network response returns a 500-level error
   ServerError = Class.new(ResponseError)
 

data/lib/frenetic/resource.rb

@@ -6,12 +6,14 @@ require 'active_support/core_ext/hash/indifferent_access'
 require 'frenetic/concerns/structured'
 require 'frenetic/concerns/hal_linked'
 require 'frenetic/concerns/member_rest_methods'
+require 'frenetic/concerns/persistence'
 
 class Frenetic
   class Resource < Delegator
     include Structured
     include HalLinked
     include MemberRestMethods
+    include Persistence
 
     def self.api_client(client = nil)
       if client
@@ -54,16 +56,15 @@ class Frenetic
       mock_class.new params
     end
 
-    def initialize(p = {})
-      build_params p
+    def initialize(params = {})
       @attrs = {}
+      initialize_with(params)
+    end
 
-      properties.keys.each do |k|
-        @attrs[k] = @params[k]
-      end
-
+    def initialize_with(p)
+      build_params(p)
+      assign_attributes(@params)
       extract_embedded_resources
-
       build_structure
     end
 
@@ -72,6 +73,12 @@ class Frenetic
     end
     alias_method :api, :api_client
 
+    def assign_attributes(params)
+      properties.keys.each do |k|
+        @attrs[k] = params[k]
+      end
+    end
+
     def attributes
       @attributes ||= begin
         @structure.each_pair.each_with_object({}) do |(k, v), attrs|

data/lib/frenetic/resource_mockery.rb

@@ -8,7 +8,7 @@ class Frenetic
     extend Forwardable
     extend ActiveSupport::Concern
 
-    def_delegators :@params, :to_json
+    def_delegators :@params, :as_json, :to_json
 
     included do
       # I'm sure this violates some sort of CS principle or best practice,
@@ -47,11 +47,26 @@ class Frenetic
     def build_params(params)
       raw_params = (params || {}).with_indifferent_access
       defaults = default_attributes.with_indifferent_access
-      @params = defaults.deep_merge(raw_params)
+      @params = cast_types(defaults.deep_merge(raw_params))
     end
 
     def build_structure
       @structure = OpenStruct.new(@attrs)
     end
+
+    # A naive attempt to cast the attribute types of the incoming mock data
+    # based on any available type information provided in :default_attributes
+    def cast_types(params)
+      default_attributes.each do |key, value|
+        params[key] =
+          case value
+          when String then String(params[key])
+          when Float then Float(params[key])
+          when Integer then Integer(params[key])
+          else params[key]
+          end
+      end
+      params
+    end
   end
 end

data/lib/frenetic/version.rb

@@ -1,3 +1,3 @@
 class Frenetic
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/spec/behaviors/alternate_string_identifier_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Frenetic::Behaviors::AlternateStringIdentifier do
+  let(:my_temp_resource) do
+    Class.new(Frenetic::Resource)
+  end
+
+  before do
+    stub_const 'MyTempResource', my_temp_resource
+    MyTempResource.send(:extend, described_class)
+  end
+
+  describe '.finder_params' do
+    let(:id) { }
+    let(:alternate_key) { }
+
+    subject { MyTempResource.finder_params(id, alternate_key) }
+
+    context 'with a Fixnum identifier' do
+      let(:id) { 1 }
+
+      it 'uses :id for the finder key' do
+        expect(subject).to include id:id
+      end
+    end
+
+    context 'with a String identifier representing a Fixnum' do
+      let(:id) { '100' }
+
+      it 'uses :id for the finder key' do
+        expect(subject).to include id:id
+      end
+    end
+
+    context 'with a String identifier' do
+      let(:id) { 'foo' }
+      let(:alternate_key) { 'alt' }
+
+      it 'uses :id for the finder key' do
+        expect(subject).to include 'alt' => id
+      end
+    end
+  end
+end