acfs 0.30.0.1.b260 → 0.30.0.1.b261

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzFkODNlZWExZDEzODUwYTIyOTQ4NGM1ZmUwYjI0NzhjYzlhYmZmNg==
+    MDBhNGMzOTliN2YzYWNiZjZiMmM5ZjZhODMxYzk5NmU4MDU2ODA2Mg==
   data.tar.gz: !binary |-
-    Y2EyMGRlNTNjMGQxODBkNDVhZmQwOWUwMmZkMjJkOWIyMjY1OTUzMA==
+    NTAyZDVkZDEzOWFhY2I1OTM0OTQwMjk5MmE4YzIyZTQ4ZmJhNmY2MA==
 SHA512:
   metadata.gz: !binary |-
-    MWU5OTNjYWY1YTMxOWE5ODVlMzBhYzg1ZDgzYzcyN2I5YjkwMDBmNGMxOTNk
-    MTczZDFlOThjODAyMWQzMWY3M2RkYmYyOThkNmVjMDU1NDc5MGZmMjk2ZmE4
-    N2ZiZTQ3NjczMTgzZmZjNDFiMDNiZDVkZTUzMGQzODNlOTg2MDY=
+    N2M4YTAwOTZmMWNkY2E1NWVjYzcxNjFlY2QwN2MwMGU5YmM5ZWEwNjA0MTEy
+    OTY4OWZhZjliZjI1ZGM3ZWY2OGE1ZjUwNjc5NjUyMTI1OWI2NDUyODgyNDg1
+    MmU3ODYxMmZhNTAyMWUxOGFiZjA2YzRjMWNkNjgxNmU2YWIxNjY=
   data.tar.gz: !binary |-
-    YjFjZWJlYzlmNjQ2M2E2ZTlkZjlhMWE1NmExZDE3M2UyNDJhMjk3ZDk1ZjNl
-    NmZiMDgyNTBiZDZmNjY1ZWM2YzkzZDc1ZmJmYjc0ZGM4NDg1YzliMGQ2YWU2
-    MTljMjg1ZDAwYmE2NWJlNmI1NDE3ZTZkZWEyYmE1Yzk3ODA3N2Q=
+    MmEyYWRlODQyODNlNWNkNTQ2NmFjZjhiNDliNTc1ZTA5M2QwMWRiNTljOTUz
+    YjBmYmQzMGQ1M2Q3ZjYyZWUxM2U5OTAwMDIwZDZhMWU3Y2QyMmRmYzMxMmJl
+    MDdmOTRjMmJmYjRiMjUxYmY4YzI1YmZmNDhhMjRhNmNkMTczN2M=

data/lib/acfs.rb

@@ -13,6 +13,7 @@ module Acfs
 
   require 'acfs/collection'
   require 'acfs/configuration'
+  require 'acfs/location'
   require 'acfs/model'
   require 'acfs/operation'
   require 'acfs/request'

data/lib/acfs/location.rb

@@ -0,0 +1,75 @@
+module Acfs
+
+  # @api private
+  #
+  # Describes a URL with placeholders.
+  #
+  class Location
+    attr_reader :arguments, :raw, :struct, :args
+
+    REGEXP= /^:([A-z][A-z0-9_]*)$/
+
+    def initialize(uri, args = {})
+      @raw       = URI.parse uri
+      @args      = args
+      @struct    = raw.path.split('/').reject(&:empty?).map{|s| s =~ REGEXP ? $1.to_sym : s }
+      @arguments = struct.select{|s| Symbol === s }
+    end
+
+    def build(args = {})
+      unless Hash === args
+        raise ArgumentError.new "URI path arguments must be a hash, `#{args.inspect}' given."
+      end
+
+      self.class.new raw.to_s, args.merge(self.args)
+    end
+
+    def extract_from(*args)
+      args = Hash.new.tap do |collect|
+        arguments.each{|key| collect[key] = extract_arg key, args }
+      end
+
+      build args
+    end
+
+    def str
+      uri = raw.dup
+      uri.path = '/' + struct.map{|s| lookup_arg(s, args) }.join('/')
+      uri.to_s
+    end
+
+    def to_s
+      raw.to_s
+    end
+
+    private
+    def extract_arg(key, hashes)
+      hashes.each_with_index do |hash, index|
+        return (index == 0 ? hash.delete(key) : hash.fetch(key)) if hash.has_key?(key)
+      end
+    end
+
+    def lookup_arg(arg, args)
+      Symbol === arg ? lookup_replacement(arg, args) : arg
+    end
+
+    def lookup_replacement(sym, args)
+      value = get_replacement(sym, args).to_s
+      return value unless value.empty?
+
+      raise ArgumentError.new "Cannot replace path argument `#{sym}' with empty string."
+    end
+
+    def get_replacement(sym, args)
+      args.fetch(sym.to_s) do
+        args.fetch(sym) do
+          if args[:raise].nil? || args[:raise]
+            raise ArgumentError.new "URI path argument `#{sym}' missing on `#{to_s}'. Given: `#{args}.inspect'"
+          else
+            ":#{sym}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acfs/model/locatable.rb

@@ -14,18 +14,83 @@ module Acfs::Model
 
     module ClassMethods
 
-      # Return URL for this class of resource. Given suffix will be appended.
+      # @overload url(suffix)
+      #   @deprecated
+      #   Return URL for this class of resource. Given suffix will be appended.
+      #
+      #   @example
+      #     User.url    # => "http://users.srv.org/users"
+      #     User.url(5) # => "http://users.srv.org/users/5"
+      #
+      #   @param [ String ] suffix Suffix to append to URL.
+      #   @return [ String ] Generated URL.
+      #
+      # @overload url(opts = {})
+      #   Return URL for this class of resources. Given options will be used to replace
+      #   URL path arguments and to determine the operation action.
+      #
+      #   @example
+      #     User.url(id: 5, action: :read) # => "http://users.srv.org/users/5"
+      #     User.url(action: :list) # => "http://users.srv.org/users"
+      #
+      #   @param opts [Hash] Options.
+      #   @option opts [Symbol] :action Operation action, usually `:list`, `:create`, `:read`,
+      #     `:update` or`:delete`.
+      #   @return [ String ] Generated URL.
+      #
+      def url(suffix = nil, opts = {})
+        if Hash === suffix
+          opts, suffix = suffix, nil
+        end
+
+        opts[:action] = :list if suffix
+
+        url  = location(opts).build(opts).str
+        url += "/#{suffix}" if suffix.to_s.present?
+        url
+      end
+
+      # Return a location object able to build the URL for this resource and
+      # given action.
       #
       # @example
-      #   User.url    # => "http://users.srv.org/users"
-      #   User.url(5) # => "http://users.srv.org/users/5"
+      #   class Identity < ::Acfs::Resource
+      #     service MyService, path: 'users/:user_id/identities'
+      #   end
+      #
+      #   location = Identity.location(action: :read)
+      #   location.arguments
+      #   => [:user_id, :id]
       #
-      # @param [ String ] suffix Suffix to append to URL.
-      # @return [ String ] Generated URL.
-      # @see Acfs::Service#url_for Delegates to Service#url_for with `suffix` option.
+      #   location.raw_url
+      #   => 'http://service/users/:user_id/identities/:id'
       #
-      def url(suffix = nil)
-        service.url_for(self, suffix: suffix)
+      #   location = Identity.location(action: :list)
+      #   location.arguments
+      #   => [:user_id]
+      #
+      #   location.build(user_id: 42)
+      #   => 'http://service/users/42/identities'
+      #
+      # @param opts [Hash] Options.
+      # @option opts [Symbol] :action Operation action, usually `:list`, `:create`, `:read`,
+      #   `:update` or`:delete`.
+      #
+      # @return [Location] Location object.
+      #
+      def location(opts = {})
+        service.location(self, opts)
+      end
+
+      # @api private
+      def path_defaults
+        {
+            list: '/:path',
+            create: '/:path',
+            read: '/:path/:id',
+            update: '/:path/:id',
+            delete: '/:path/:id'
+        }
       end
     end
 
@@ -42,9 +107,22 @@ module Acfs::Model
     # @return [ String ] Generated URL.
     # @see ClassMethods#url
     #
-    def url
-      return nil if id.nil?
-      self.class.service.url_for self, suffix: read_attribute(:id)
+    def url(opts = {})
+      return nil if need_primary_key? && !has_primary_key?
+
+      self.class.service.location(self.class, opts.reverse_merge(action: :read)).build(attributes).str
+    end
+
+    # @api private
+    # Return true if resource needs a primary key (id) for singular actions.
+    def need_primary_key?
+      true
+    end
+
+    # @api private
+    # Return true if resource has a primary key (id) set.
+    def has_primary_key?
+      respond_to?(:id) && !id.nil?
     end
   end
 end

data/lib/acfs/operation.rb

@@ -6,7 +6,7 @@ module Acfs
   # processing as well as error handling and stubbing.
   #
   class Operation
-    attr_reader :action, :params, :resource, :data, :callback
+    attr_reader :action, :params, :resource, :data, :callback, :location
     delegate :service, to: :resource
     delegate :call, to: :callback
 
@@ -19,6 +19,8 @@ module Acfs
       @params   = (opts[:params] || {}).dup
       @data     = (opts[:data]   || {}).dup
 
+      @location = resource.location(action: @action).extract_from(@params, @data)
+
       @callback = block
     end
 
@@ -36,11 +38,7 @@ module Acfs
     end
 
     def full_params
-      id ? params.merge(id: id) : params
-    end
-
-    def url
-      single? ? resource.url(id) : resource.url
+      (id ? params.merge(id: id) : params).merge location.args
     end
 
     def method
@@ -48,7 +46,7 @@ module Acfs
     end
 
     def request
-      request = ::Acfs::Request.new url, method: method, params: params, data: data
+      request = ::Acfs::Request.new location.str, method: method, params: params, data: data
       request.on_complete do |response|
         handle_failure response unless response.success?
         callback.call response.data

data/lib/acfs/request.rb

@@ -12,7 +12,7 @@ module Acfs
     include Request::Callbacks
 
     def initialize(url, options = {}, &block)
-      @url = URI.parse(url).tap do |url|
+      @url = URI.parse(url.to_s).tap do |url|
         @data    = options.delete(:data) || nil
         @format  = options.delete(:format) || :json
         @headers = options.delete(:headers) || {}

data/lib/acfs/service.rb

@@ -32,15 +32,18 @@ module Acfs
     end
 
     # @api private
-    # @return [String]
+    # @return [Location]
     #
-    def url_for(resource_class, options = {})
-      options.reverse_merge! self.options
+    def location(resource_class, opts = {})
+      opts.reverse_merge! self.options
 
       url  = self.class.base_url.to_s
-      url += "/#{(options[:path] || resource_class.name.pluralize.underscore).to_s}"
-      url += "/#{options[:suffix].to_s}" if options[:suffix]
-      url
+      url += resource_class.path_defaults[opts[:action] || :list] || '/:path'
+
+      path = opts[:path]
+      path ||= (resource_class.name || 'class').pluralize.underscore
+
+      Location.new Location.new(url).build(raise: false, path: path).str
     end
 
     class << self

data/lib/acfs/singleton_resource.rb

@@ -49,6 +49,11 @@ module Acfs
       end
     end
 
+    # @api private
+    def need_primary_key?
+      false
+    end
+
     class << self
       # @api public
       #
@@ -90,6 +95,17 @@ module Acfs
       undef_method :where
       undef_method :find_by
       undef_method :find_by!
+
+      # @api private
+      def path_defaults
+        {
+            list: '/:path',
+            create: '/:path',
+            read: '/:path',
+            update: '/:path',
+            delete: '/:path'
+        }
+      end
     end
   end
 end

data/lib/acfs/stub.rb

@@ -111,12 +111,35 @@ module Acfs
         stub = stub_for op
         unless stub
           return false if allow_requests?
-          raise RealRequestsNotAllowedError, "No stub found for #{op.action} on #{op.resource.name} with params #{op.full_params.inspect}, data #{op.data.inspect} and id #{op.id}."
+          raise RealRequestsNotAllowedError.new <<-MSG.strip.gsub(/^[ ]{12}/, '')
+            No stub found for `#{op.action}' on `#{op.resource.name}' with params `#{op.full_params.inspect}', data `#{op.data.inspect}' and id `#{op.id}'.
+
+            Available stubs:
+            #{pretty_print}
+          MSG
         end
 
         stub.call op
         true
       end
+
+      private
+      def pretty_print
+        out = String.new
+        stubs.each do |klass, actions|
+          out << '  ' << klass.name << ":\n"
+          actions.each do |action, stubs|
+            stubs.each do |stub|
+              out << "    #{action}"
+              out << " with #{stub.opts[:with].inspect}" if stub.opts[:with]
+              out << " and return #{stub.opts[:return].inspect}" if stub.opts[:return]
+              out << " and raise #{stub.opts[:raise].inspect}" if stub.opts[:raise]
+              out << "\n"
+            end
+          end
+        end
+        out
+      end
     end
   end
 end

data/spec/acfs/model/locatable_spec.rb

@@ -3,7 +3,8 @@ require 'spec_helper'
 describe Acfs::Model::Locatable do
   let(:model) { MyUser }
   before do
-    stub_request(:get, "http://users.example.org/users/1").to_return response({ id: 1, name: "Anon", age: 12 })
+    stub_request(:get, 'http://users.example.org/users/1').to_return response({id: 1, name: 'Anon', age: 12})
+    stub_request(:get, 'http://users.example.org/users/1/profile').to_return response({user_id: 2, twitter_handle: '@anon'})
   end
 
   describe '.url' do
@@ -14,23 +15,43 @@ describe Acfs::Model::Locatable do
     it 'should return URL with id path part if specified' do
       expect(model.url(5)).to be == 'http://users.example.org/users/5'
     end
+
+    context 'with attribute in path' do
+      let(:model) { Profile }
+
+      it 'should replace placeholder' do
+        expect(model.url(user_id: 1)).to eq 'http://users.example.org/users/1/profile'
+      end
+
+      context 'without attributes' do
+        it 'should raise an error if attribute is missing' do
+          expect{ model.url }.to raise_error ArgumentError
+        end
+      end
+    end
   end
 
   describe '#url' do
     context 'new resource' do
       let(:m) { model.new }
 
-      it "should return nil" do
+      it 'should return nil' do
         expect(m.url).to be == nil
       end
 
       context 'new resource with id' do
         let(:m) { model.new id: 475 }
 
-        it "should return resource URL" do
+        it 'should return resource URL' do
           expect(m.url).to be == 'http://users.example.org/users/475'
         end
       end
+
+      context 'with attribute in path' do
+        it 'should return nil' do
+          expect(m.url).to be == nil
+        end
+      end
     end
 
     context 'loaded resource' do
@@ -40,6 +61,15 @@ describe Acfs::Model::Locatable do
       it "should return resource's URL" do
         expect(m.url).to be == 'http://users.example.org/users/1'
       end
+
+      context 'with attribute in path' do
+        let(:model) { Profile }
+        let(:m) { model.find user_id: 1 }
+
+        it "should return resource's URL" do
+          expect(m.url).to be == 'http://users.example.org/users/2/profile'
+        end
+      end
     end
   end
 end

data/spec/acfs/service_spec.rb

@@ -17,16 +17,19 @@ describe Acfs::Service do
     end
   end
 
-  describe '#url_for' do
+  describe '#location' do
+    let(:resource) { Class.new }
+    before { allow(resource).to receive(:path_defaults).and_return({}) }
+
     it 'should extract resource path name from given class' do
-      expect(service.url_for(Class)).to eq('/classes')
+      expect(service.location(resource).to_s).to eq('/classes')
     end
 
     context 'with path options' do
       let(:options) { { path: 'abc' } }
 
       it 'should have custom resource path' do
-        expect(service.url_for(Class)).to eq('/abc')
+        expect(service.location(resource).to_s).to eq('/abc')
       end
     end
   end

data/spec/support/service.rb

@@ -25,6 +25,13 @@ class MyUser < Acfs::Resource
   attribute :age, :integer
 end
 
+class Profile < Acfs::SingletonResource
+  service UserService, path: 'users/:user_id/profile'
+
+  attribute :user_id, :integer
+  attribute :twitter_handle, :string
+end
+
 class Customer < MyUser
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.30.0.1.b260
+  version: 0.30.0.1.b261
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -126,6 +126,7 @@ files:
 - lib/acfs/configuration.rb
 - lib/acfs/errors.rb
 - lib/acfs/global.rb
+- lib/acfs/location.rb
 - lib/acfs/middleware/base.rb
 - lib/acfs/middleware/json_decoder.rb
 - lib/acfs/middleware/json_encoder.rb