her 0.2 → 0.2.1

data/lib/her/middleware.rb

@@ -2,5 +2,7 @@ module Her
   module Middleware
     autoload :FirstLevelParseJSON,  "her/middleware/first_level_parse_json"
     autoload :SecondLevelParseJSON, "her/middleware/second_level_parse_json"
+
+    DefaultParseJSON = FirstLevelParseJSON
   end
 end

data/lib/her/model.rb

@@ -16,12 +16,14 @@ module Her
     autoload :Relationships, "her/model/relationships"
     autoload :Hooks,         "her/model/hooks"
     autoload :Introspection, "her/model/introspection"
+    autoload :Paths,         "her/model/paths"
 
     extend ActiveSupport::Concern
 
     # Instance methods
     include Her::Model::ORM
     include Her::Model::Introspection
+    include Her::Model::Paths
 
     # Class methods
     included do
@@ -30,10 +32,11 @@ module Her
       extend Her::Model::ORM
       extend Her::Model::Relationships
       extend Her::Model::Hooks
+      extend Her::Model::Paths
 
       # Define default settings
-      collection_path "#{self.to_s.downcase.pluralize}"
-      item_path "#{self.to_s.downcase}"
+      collection_path "/#{self.to_s.downcase.pluralize}"
+      resource_path "/#{self.to_s.downcase.pluralize}/:id"
       uses_api Her::API.default_api
     end
   end

data/lib/her/model/http.rb

@@ -7,30 +7,6 @@ module Her
         @her_api = api
       end # }}}
 
-      # Defines a custom collection path for the resource
-      #
-      # @example
-      #  class User
-      #    include Her::Model
-      #    collection_path "users"
-      #  end
-      def collection_path(path=nil) # {{{
-        return @her_collection_path unless path
-        @her_collection_path = path
-      end # }}}
-
-      # Defines a custom item path for the resource
-      #
-      # @example
-      #  class User
-      #    include Her::Model
-      #    item_path "user"
-      #  end
-      def item_path(path=nil) # {{{
-        return @her_item_path unless path
-        @her_item_path = path
-      end # }}}
-
       # Main request wrapper around Her::API. Used to make custom request to the API.
       # @private
       def request(attrs={}, &block) # {{{
@@ -47,7 +23,7 @@ module Her
       #   @popular_users = User.get(:popular)
       #   # Fetched via GET "/users/popular"
       def get(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         get_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
@@ -59,13 +35,13 @@ module Her
 
       # Make a GET request and return the parsed JSON response (not mapped to objects)
       def get_raw(path, attrs={}, &block) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         request(attrs.merge(:_method => :get, :_path => path), &block)
       end # }}}
 
       # Make a GET request and return a collection of resources
       def get_collection(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         get_raw(path, attrs) do |parsed_data|
           new_collection(parsed_data)
         end
@@ -73,7 +49,7 @@ module Her
 
       # Make a GET request and return a collection of resources
       def get_resource(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         get_raw(path, attrs) do |parsed_data|
           new(parsed_data[:data])
         end
@@ -81,7 +57,7 @@ module Her
 
       # Make a POST request and return either a collection or a resource
       def post(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         post_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
@@ -93,13 +69,13 @@ module Her
 
       # Make a POST request and return the parsed JSON response (not mapped to objects)
       def post_raw(path, attrs={}, &block) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         request(attrs.merge(:_method => :post, :_path => path), &block)
       end # }}}
 
       # Make a POST request and return a collection of resources
       def post_collection(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         post_raw(path, attrs) do |parsed_data|
           new_collection(parsed_data)
         end
@@ -107,7 +83,7 @@ module Her
 
       # Make a POST request and return a collection of resources
       def post_resource(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         post_raw(path, attrs) do |parsed_data|
           new(parsed_data[:data])
         end
@@ -115,7 +91,7 @@ module Her
 
       # Make a PUT request and return either a collection or a resource
       def put(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         put_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
@@ -127,13 +103,13 @@ module Her
 
       # Make a PUT request and return the parsed JSON response (not mapped to objects)
       def put_raw(path, attrs={}, &block) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         request(attrs.merge(:_method => :put, :_path => path), &block)
       end # }}}
 
       # Make a PUT request and return a collection of resources
       def put_collection(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         put_raw(path, attrs) do |parsed_data|
           new_collection(parsed_data)
         end
@@ -141,7 +117,7 @@ module Her
 
       # Make a PUT request and return a collection of resources
       def put_resource(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         put_raw(path, attrs) do |parsed_data|
           new(parsed_data[:data])
         end
@@ -149,7 +125,7 @@ module Her
 
       # Make a PATCH request and return either a collection or a resource
       def patch(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         patch_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
@@ -161,13 +137,13 @@ module Her
 
       # Make a PATCH request and return the parsed JSON response (not mapped to objects)
       def patch_raw(path, attrs={}, &block) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         request(attrs.merge(:_method => :patch, :_path => path), &block)
       end # }}}
 
       # Make a PATCH request and return a collection of resources
       def patch_collection(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         patch_raw(path, attrs) do |parsed_data|
           new_collection(parsed_data)
         end
@@ -175,7 +151,7 @@ module Her
 
       # Make a PATCH request and return a collection of resources
       def patch_resource(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         patch_raw(path, attrs) do |parsed_data|
           new(parsed_data[:data])
         end
@@ -183,7 +159,7 @@ module Her
 
       # Make a DELETE request and return either a collection or a resource
       def delete(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         delete_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
@@ -195,13 +171,13 @@ module Her
 
       # Make a DELETE request and return the parsed JSON response (not mapped to objects)
       def delete_raw(path, attrs={}, &block) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         request(attrs.merge(:_method => :delete, :_path => path), &block)
       end # }}}
 
       # Make a DELETE request and return a collection of resources
       def delete_collection(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         delete_raw(path, attrs) do |parsed_data|
           new_collection(parsed_data)
         end
@@ -209,7 +185,7 @@ module Her
 
       # Make a DELETE request and return a collection of resources
       def delete_resource(path, attrs={}) # {{{
-        path = "#{@her_collection_path}/#{path}" if path.is_a?(Symbol)
+        path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         delete_raw(path, attrs) do |parsed_data|
           new(parsed_data[:data])
         end

data/lib/her/model/introspection.rb

@@ -11,9 +11,7 @@ module Her
       #   @user = User.find(1)
       #   p @user # => #<User(/users/1) id=1 name="Tobias Fünke">
       def inspect # {{{
-        resource_path = self.class.collection_path
-        resource_path << "/#{id}" if @data.include?(:id)
-        "#<#{self.class}(#{resource_path}) #{@data.inject([]) { |memo, item| key, value = item; memo << "#{key}=#{attribute_for_inspect(value)}"}.join(" ")}>"
+        "#<#{self.class}(#{self.class.build_request_path(@data)}) #{@data.inject([]) { |memo, item| key, value = item; memo << "#{key}=#{attribute_for_inspect(value)}"}.join(" ")}>"
       end # }}}
 
       private

data/lib/her/model/orm.rb

@@ -50,7 +50,7 @@ module Her
       #   @user = User.find(1)
       #   # Fetched via GET "/users/1"
       def find(id, params={}) # {{{
-        request(params.merge(:_method => :get, :_path => "#{@her_collection_path}/#{id}")) do |parsed_data|
+        request(params.merge(:_method => :get, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data|
           new(parsed_data[:data])
         end
       end # }}}
@@ -61,7 +61,7 @@ module Her
       #   @users = User.all
       #   # Fetched via GET "/users"
       def all(params={}) # {{{
-        request(params.merge(:_method => :get, :_path => "#{@her_collection_path}")) do |parsed_data|
+        request(params.merge(:_method => :get, :_path => "#{build_request_path(params)}")) do |parsed_data|
           new_collection(parsed_data)
         end
       end # }}}
@@ -76,7 +76,7 @@ module Her
         perform_hook(resource, :before, :create)
         perform_hook(resource, :before, :save)
         params = resource.instance_eval { @data }
-        request(params.merge(:_method => :post, :_path => "#{@her_collection_path}")) do |parsed_data|
+        request(params.merge(:_method => :post, :_path => "#{build_request_path(params)}")) do |parsed_data|
           resource.instance_eval do
             @data = parsed_data[:data]
           end
@@ -118,7 +118,7 @@ module Her
             perform_hook(resource, :before, :update)
             perform_hook(resource, :before, :save)
           end
-          self.class.request(params.merge(:_method => :put, :_path => "#{self.class.collection_path}/#{id}")) do |parsed_data|
+          self.class.request(params.merge(:_method => :put, :_path => "#{request_path}")) do |parsed_data|
             @data = parsed_data[:data]
           end
           self.class.class_eval do
@@ -131,7 +131,7 @@ module Her
             perform_hook(resource, :before, :create)
             perform_hook(resource, :before, :save)
           end
-          self.class.request(params.merge(:_method => :post, :_path => "#{self.class.collection_path}")) do |parsed_data|
+          self.class.request(params.merge(:_method => :post, :_path => "#{request_path}")) do |parsed_data|
             @data = parsed_data[:data]
           end
           self.class.class_eval do
@@ -152,7 +152,7 @@ module Her
         params = @data.dup
         resource = self
         self.class.class_eval { perform_hook(resource, :before, :destroy) }
-        self.class.request(params.merge(:_method => :delete, :_path => "#{self.class.collection_path}/#{id}")) do |parsed_data|
+        self.class.request(params.merge(:_method => :delete, :_path => "#{request_path}")) do |parsed_data|
           @data = parsed_data[:data]
         end
         self.class.class_eval { perform_hook(resource, :after, :destroy) }
@@ -164,9 +164,8 @@ module Her
       # @example
       #   User.destroy_existing(1)
       #   # Called via DELETE "/users/1"
-      def destroy_existing(id) # {{{
-        params = {}
-        request(params.merge(:_method => :delete, :_path => "#{collection_path}/#{id}")) do |parsed_data|
+      def destroy_existing(id, params={}) # {{{
+        request(params.merge(:_method => :delete, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data|
           new(parsed_data[:data])
         end
       end # }}}

data/lib/her/model/paths.rb

@@ -0,0 +1,59 @@
+module Her
+  module Model
+    module Paths
+      # Defines a custom collection path for the resource
+      #
+      # @example
+      #  class User
+      #    include Her::Model
+      #    collection_path "/users"
+      #  end
+      def collection_path(path=nil) # {{{
+        return @her_collection_path unless path
+        @her_resource_path = "#{path}/:id"
+        @her_collection_path = path
+      end # }}}
+
+      # Defines a custom resource path for the resource
+      #
+      # @example
+      #  class User
+      #    include Her::Model
+      #    resource_path "/users/:id"
+      #  end
+      def resource_path(path=nil) # {{{
+        return @her_resource_path unless path
+        @her_resource_path = path
+      end # }}}
+
+      # Return a custom path based on the collection path and variable parameters
+      #
+      # @example
+      #   class User
+      #     include Her::Model
+      #     collection_path "/utilisateurs"
+      #   end
+      #
+      #   User.all # Fetched via GET /utilisateurs
+      def build_request_path(parameters={}) # {{{
+        (path = parameters.include?(:id) ? @her_resource_path : @her_collection_path).gsub(/:([\w_]+)/) do
+          # Look for :key or :_key, otherwise raise an exception
+          parameters[$1.to_sym] || parameters["_#{$1}".to_sym] || raise(Her::Errors::PathError.new("Missing :_#{$1} parameter to build the request path (#{path})."))
+        end
+      end # }}}
+
+      # Return a path based on the collection path and a resource data
+      #
+      # @example
+      #   class User
+      #     include Her::Model
+      #     collection_path "/utilisateurs"
+      #   end
+      #
+      #   User.find(1) # Fetched via GET /utilisateurs/1
+      def request_path # {{{
+        self.class.build_request_path(@data)
+      end # }}}
+    end
+  end
+end

data/lib/her/model/relationships.rb

@@ -49,11 +49,10 @@ module Her
       def has_many(name, attrs={}) # {{{
         @her_relationships ||= {}
         (@her_relationships[:has_many] ||= []) << attrs.merge(:name => name)
-        collection_path = @her_collection_path
 
         define_method(name) do
           return @data[name] if @data.include?(name) # Do not fetch from API again if we have it in @data
-          self.class.get_collection("#{collection_path}/#{id}/#{Object.const_get(name.to_s.classify).collection_path}")
+          self.class.get_collection("#{self.class.build_request_path(:id => id)}/#{name.to_s.pluralize}")
         end
       end # }}}
 
@@ -78,11 +77,10 @@ module Her
       def has_one(name, attrs={}) # {{{
         @her_relationships ||= {}
         (@her_relationships[:has_one] ||= []) << attrs.merge(:name => name)
-        collection_path = @her_collection_path
 
         define_method(name) do
           return @data[name] if @data.include?(name) # Do not fetch from API again if we have it in @data
-          self.class.get_resource("#{collection_path}/#{id}/#{Object.const_get(name.to_s.classify).item_path}")
+          self.class.get_resource("#{self.class.build_request_path(:id => id)}/#{name.to_s.singularize}")
         end
       end # }}}
 
@@ -107,11 +105,10 @@ module Her
       def belongs_to(name, attrs={}) # {{{
         @her_relationships ||= {}
         (@her_relationships[:belongs_to] ||= []) << attrs.merge(:name => name)
-        collection_path = @her_collection_path
 
         define_method(name) do
           return @data[name] if @data.include?(name) # Do not fetch from API again if we have it in @data
-          self.class.get_resource("#{Object.const_get(name.to_s.classify).collection_path}/#{@data["#{name}_id".to_sym]}")
+          self.class.get_resource("#{Object.const_get(name.to_s.classify).build_request_path(:id => @data["#{name}_id".to_sym])}")
         end
       end # }}}
     end

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.2"
+  VERSION = "0.2.1"
 end

data/spec/api_spec.rb

@@ -16,36 +16,6 @@ describe Her::API do
         @api.setup :base_uri => "https://api.example.com"
         @api.base_uri.should == "https://api.example.com"
       end # }}}
-
-      it "sets additional middleware" do # {{{
-        class Foo < Faraday::Response::Middleware; end;
-        class Bar < Faraday::Response::Middleware; end;
-
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com", :add_middleware => [Foo, Bar]
-        @api.middleware.should == [Foo, Bar, Her::Middleware::FirstLevelParseJSON, Faraday::Request::UrlEncoded, Faraday::Adapter::NetHttp]
-
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com", :add_middleware => Foo
-        @api.middleware.should == [Foo, Her::Middleware::FirstLevelParseJSON, Faraday::Request::UrlEncoded, Faraday::Adapter::NetHttp]
-      end # }}}
-
-      it "overrides middleware" do # {{{
-        class Foo < Faraday::Response::Middleware; end;
-        class Bar < Faraday::Response::Middleware; end;
-
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com", :middleware => [Foo, Bar]
-        @api.middleware.should == [Foo, Bar]
-      end # }}}
-
-      it "sets a parse middleware" do # {{{
-        class Foo < Faraday::Response::Middleware; end;
-
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com", :parse_middleware => Foo
-        @api.middleware.should == [Foo, Faraday::Request::UrlEncoded, Faraday::Adapter::NetHttp]
-      end # }}}
     end
 
     describe "#request" do
@@ -59,22 +29,20 @@ describe Her::API do
         end
 
         @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com", :middleware => []
-        @api.request(:_method => :get, :_path => "/foo") do |parsed_data|
-          parsed_data[:data] == "Foo, it is."
-        end
+        @api.setup :base_uri => "https://api.example.com", :parse_middleware => Foo
+        parsed_data = @api.request(:_method => :get, :_path => "/foo")
+        parsed_data[:data] == "Foo, it is."
       end # }}}
 
       it "parses a request with the default parser" do # {{{
-        FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => MultiJson.dump(:data => { :id => 1, :name => "George Michael Bluth" }, :errors => ["This is a single error"], :metadata => { :page => 1, :per_page => 10 }))
+        FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => MultiJson.dump({ :id => 1, :name => "George Michael Bluth", :errors => ["This is a single error"], :metadata => { :page => 1, :per_page => 10 } }))
 
         @api = Her::API.new
         @api.setup :base_uri => "https://api.example.com"
-        @api.request(:_method => :get, :_path => "users/1") do |parsed_data|
-          parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }
-          parsed_data[:errors].should == ["This is a single error"]
-          parsed_data[:metadata].should == { :page => 1, :per_page => 10 }
-        end
+        parsed_data = @api.request(:_method => :get, :_path => "users/1")
+        parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }
+        parsed_data[:errors].should == ["This is a single error"]
+        parsed_data[:metadata].should == { :page => 1, :per_page => 10 }
       end # }}}
 
       it "parses a request with a custom parser" do # {{{
@@ -94,12 +62,14 @@ describe Her::API do
         end
 
         @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com", :parse_middleware => CustomParser
-        @api.request(:_method => :get, :_path => "users/1") do |parsed_data|
-          parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }
-          parsed_data[:errors].should == []
-          parsed_data[:metadata].should == {}
+        @api.setup :base_uri => "https://api.example.com" do |connection|
+          connection.delete Her::Middleware::DefaultParseJSON
+          connection.use CustomParser
         end
+        parsed_data = @api.request(:_method => :get, :_path => "users/1")
+        parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }
+        parsed_data[:errors].should == []
+        parsed_data[:metadata].should == {}
       end # }}}
     end
   end