her 0.5.5 → 0.6

data/lib/her/model/parse.rb

@@ -36,6 +36,7 @@ module Her
           return @_her_include_root_in_json unless value
           @_her_include_root_in_json = value
         end
+        alias :include_root_in_json? :include_root_in_json
 
         # Return or change the value of `parse_root_in`
         #
@@ -52,6 +53,7 @@ module Her
           return @_her_parse_root_in_json unless value
           @_her_parse_root_in_json = value
         end
+        alias :parse_root_in_json? :parse_root_in_json
 
         # Return or change the value of `root_element`. Always defaults to the base name of the class.
         #
@@ -72,24 +74,14 @@ module Her
           end
         end
 
-        # @private
-        def parse_root_in_json?
-          parse_root_in_json
-        end
-
-        # @private
-        def include_root_in_json?
-          include_root_in_json
-        end
-
         # @private
         def included_root_element
-          include_root_in_json == true ? root_element.to_sym : include_root_in_json
+          include_root_in_json == true ? root_element : include_root_in_json
         end
 
         # @private
         def parsed_root_element
-          parse_root_in_json == true ? root_element.to_sym : parse_root_in_json
+          parse_root_in_json == true ? root_element : parse_root_in_json
         end
       end
     end

data/lib/her/model/paths.rb

@@ -31,7 +31,7 @@ module Her
         # @param [Symbol] value
         def primary_key(value = nil)
           @_her_primary_key ||= begin
-            superclass.primary_key.to_sym if superclass.respond_to?(:primary_key)
+            superclass.primary_key if superclass.respond_to?(:primary_key)
           end
 
           return @_her_primary_key unless value
@@ -110,7 +110,8 @@ module Her
 
           path.gsub(/:([\w_]+)/) do
             # Look for :key or :_key, otherwise raise an exception
-            parameters.delete($1.to_sym) || parameters.delete("_#{$1}".to_sym) || raise(Her::Errors::PathError.new("Missing :_#{$1} parameter to build the request path. Path is `#{path}`. Parameters are `#{parameters.inspect}`.", $1))
+            value = $1.to_sym
+            parameters.delete(value) || parameters.delete(:"_#{value}") || raise(Her::Errors::PathError.new("Missing :_#{$1} parameter to build the request path. Path is `#{path}`. Parameters are `#{parameters.inspect}`.", $1))
           end
         end
 

data/lib/her/model/relation.rb

@@ -0,0 +1,113 @@
+module Her
+  module Model
+    class Relation
+      attr_accessor :query_attrs
+
+      # @private
+      def initialize(parent)
+        @parent = parent
+        @query_attrs = {}
+      end
+
+      # Build a new resource
+      def build(attrs = {})
+        @parent.new(@query_attrs.merge(attrs))
+      end
+
+      # Add a query string parameter
+      def where(attrs = {})
+        return self if attrs.blank?
+        self.clone.tap { |a| a.query_attrs = a.query_attrs.merge(attrs) }
+      end
+      alias :all :where
+
+      def page(page)
+        where(:page => page)
+      end
+
+      def per_page(per_page)
+        where(:per_page => per_page)
+      end
+      alias :per :per_page
+
+      # Bubble all methods to the fetched collection
+      def method_missing(method, *args, &blk)
+        fetch.send(method, *args, &blk)
+      end
+
+      # @private
+      def nil?
+        fetch.nil?
+      end
+
+      # @private
+      def kind_of?(thing)
+        fetch.kind_of?(thing)
+      end
+
+      # Fetch a collection of resources
+      #
+      # @example
+      #   @users = User.all
+      #   # Fetched via GET "/users"
+      #
+      # @example
+      #   @users = User.where(:approved => 1).all
+      #   # Fetched via GET "/users?approved=1"
+      def fetch
+        @_fetch ||= begin
+          path = @parent.build_request_path(@query_attrs)
+          @parent.request(@query_attrs.merge(:_method => :get, :_path => path)) do |parsed_data, response|
+            @parent.new_collection(parsed_data)
+          end
+        end
+      end
+
+      # Create a resource and return it
+      #
+      # @example
+      #   @user = User.create(:fullname => "Tobias Fünke")
+      #   # Called via POST "/users/1" with `&fullname=Tobias+Fünke`
+      #
+      # @example
+      #   @user = User.where(:email => "tobias@bluth.com").create(:fullname => "Tobias Fünke")
+      #   # Called via POST "/users/1" with `&email=tobias@bluth.com&fullname=Tobias+Fünke`
+      def create(attrs = {})
+        attrs ||= {}
+        resource = @parent.new(@query_attrs.merge(attrs))
+        resource.save
+
+        resource
+      end
+
+      # Fetch a resource and create it if it's not found
+      #
+      # @example
+      #   @user = User.where(:email => "remi@example.com").find_or_create
+      #
+      #   # Returns the first item of the collection if present:
+      #   # GET "/users?email=remi@example.com"
+      #
+      #   # If collection is empty:
+      #   # POST /users with `email=remi@example.com`
+      def first_or_create(attrs = {})
+        fetch.first || create(attrs)
+      end
+
+      # Fetch a resource and build it if it's not found
+      #
+      # @example
+      #   @user = User.where(:email => "remi@example.com").find_or_initialize
+      #
+      #   # Returns the first item of the collection if present:
+      #   # GET "/users?email=remi@example.com"
+      #
+      #   # If collection is empty:
+      #   @user.email # => "remi@example.com"
+      #   @user.new? # => true
+      def first_or_initialize(attrs = {})
+        fetch.first || build(attrs)
+      end
+    end
+  end
+end

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.5.5"
+  VERSION = "0.6"
 end

data/spec/model/associations_spec.rb

@@ -151,11 +151,12 @@ describe Her::Model::Associations do
     end
 
     it "fetches has_many data even if it was included, only if called with parameters" do
-      @user_with_included_data.comments(:foo_id => 1).length.should == 1
+      @user_with_included_data.comments.where(:foo_id => 1).length.should == 1
     end
 
     it "maps an array of included data through has_one" do
       @user_with_included_data.role.should be_a(Foo::Role)
+      @user_with_included_data.role.object_id.should == @user_with_included_data.role.object_id
       @user_with_included_data.role.id.should == 1
       @user_with_included_data.role.body.should == "Admin"
     end
@@ -167,7 +168,7 @@ describe Her::Model::Associations do
     end
 
     it "fetches has_one data even if it was included, only if called with parameters" do
-      @user_with_included_data.role(:foo_id => 2).id.should == 3
+      @user_with_included_data.role.where(:foo_id => 2).id.should == 3
     end
 
     it "maps an array of included data through belongs_to" do
@@ -183,7 +184,7 @@ describe Her::Model::Associations do
     end
 
     it "fetches belongs_to data even if it was included, only if called with parameters" do
-      @user_with_included_data.organization(:foo_id => 1).name.should == "Bluth Company Foo"
+      @user_with_included_data.organization.where(:foo_id => 1).name.should == "Bluth Company Foo"
     end
 
     it "can tell if it has a association" do
@@ -197,7 +198,8 @@ describe Her::Model::Associations do
     end
 
     it "pass query string parameters when additional arguments are passed" do
-      @user_without_included_data.organization(:admin => true).name.should == "Bluth Company (admin)"
+      @user_without_included_data.organization.where(:admin => true).name.should == "Bluth Company (admin)"
+      @user_without_included_data.organization.name.should == "Bluth Company"
     end
 
     [:create, :save_existing, :destroy].each do |type|
@@ -260,4 +262,46 @@ describe Her::Model::Associations do
       @user_without_included_data.company.name.should == "Bluth Company"
     end
   end
+
+  context "building and creating association data" do
+    before do
+      spawn_model "Foo::Comment"
+      spawn_model "Foo::User" do
+        has_many :comments
+      end
+    end
+
+    context "with #build" do
+      it "takes the parent primary key" do
+        @comment = Foo::User.new(:id => 10).comments.build(:body => "Hello!")
+        @comment.body.should == "Hello!"
+        @comment.user_id.should == 10
+      end
+    end
+
+    context "with #create" do
+      before do
+        Her::API.setup :url => "https://api.example.com" do |builder|
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.use Faraday::Request::UrlEncoded
+          builder.adapter :test do |stub|
+            stub.get("/users/10") { |env| [200, {}, { :id => 10 }.to_json] }
+            stub.post("/comments") { |env| [200, {}, { :id => 1, :body => Faraday::Utils.parse_query(env[:body])['body'], :user_id => Faraday::Utils.parse_query(env[:body])['user_id'].to_i }.to_json] }
+          end
+        end
+
+        Foo::User.use_api Her::API.default_api
+        Foo::Comment.use_api Her::API.default_api
+      end
+
+      it "takes the parent primary key and saves the resource" do
+        @user = Foo::User.find(10)
+        @comment = @user.comments.create(:body => "Hello!")
+        @comment.id.should == 1
+        @comment.body.should == "Hello!"
+        @comment.user_id.should == 10
+        @user.comments.should == [@comment]
+      end
+    end
+  end
 end

data/spec/model/introspection_spec.rb

@@ -44,7 +44,7 @@ describe Her::Model::Introspection do
 
     describe "#inspect with errors in resource path" do
       it "prints the resource path as “unknown”" do
-        @comment = Foo::Comment.all(:project_id => 1).first
+        @comment = Foo::Comment.where(:project_id => 1).first
         path = '<unknown path, missing `project_id`>'
         ["#<Foo::Comment(#{path}) body=\"Hello!\" id=1>", "#<Foo::Comment(#{path}) id=1 body=\"Hello!\">"].should include(@comment.inspect)
       end

data/spec/model/orm_spec.rb

@@ -157,6 +157,7 @@ describe Her::Model::ORM do
           stub.get("/users/1") { |env| [200, {}, { :id => 1, :age => 42 }.to_json] }
           stub.get("/users/2") { |env| [200, {}, { :id => 2, :age => 34 }.to_json] }
           stub.get("/users?age=42") { |env| [200, {}, [{ :id => 1, :age => 42 }].to_json] }
+          stub.get("/users?age=40") { |env| [200, {}, [{ :id => 1, :age => 40 }].to_json] }
         end
       end
 
@@ -194,10 +195,26 @@ describe Her::Model::ORM do
     end
 
     it "handles finding with other parameters" do
-      @users = User.all(:age => 42)
+      @users = User.where(:age => 42).all
       @users.should be_kind_of(Array)
       @users.should be_all { |u| u.age == 42 }
     end
+
+    it "handles finding with other parameters and scoped" do
+      @users = User.scoped
+      @users.where(:age => 42).should be_all { |u| u.age == 42 }
+      @users.where(:age => 40).should be_all { |u| u.age == 40 }
+    end
+
+    it "handles finding with paging parameters" do
+      @users = User.page(2).per_page(20)
+      @users.query_attrs[:page].should == 2
+      @users.query_attrs[:per_page].should == 20
+
+      @users = User.all.page(2).per_page(20)
+      @users.query_attrs[:page].should == 2
+      @users.query_attrs[:per_page].should == 20
+    end
   end
 
   context "creating resources" do
@@ -206,7 +223,7 @@ describe Her::Model::ORM do
         builder.use Her::Middleware::FirstLevelParseJSON
         builder.use Faraday::Request::UrlEncoded
         builder.adapter :test do |stub|
-          stub.post("/users") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
+          stub.post("/users") { |env| [200, {}, { :id => 1, :fullname => Faraday::Utils.parse_query(env[:body])['fullname'], :email => Faraday::Utils.parse_query(env[:body])['email'] }.to_json] }
           stub.post("/companies") { |env| [200, {}, { :errors => ["name is required"] }.to_json] }
         end
       end
@@ -216,9 +233,10 @@ describe Her::Model::ORM do
     end
 
     it "handle one-line resource creation" do
-      @user = Foo::User.create(:fullname => "Tobias Fünke")
+      @user = Foo::User.create(:fullname => "Tobias Fünke", :email => "tobias@bluth.com")
       @user.id.should == 1
       @user.fullname.should == "Tobias Fünke"
+      @user.email.should == "tobias@bluth.com"
     end
 
     it "handle resource creation through Model.new + #save" do
@@ -300,103 +318,4 @@ describe Her::Model::ORM do
       @user.should be_destroyed
     end
   end
-
-  context "saving resources with overridden to_params" do
-    before do
-      Her::API.setup :url => "https://api.example.com" do |builder|
-        builder.use Her::Middleware::FirstLevelParseJSON
-        builder.use Faraday::Request::UrlEncoded
-        builder.adapter :test do |stub|
-          stub.post("/users") do |env|
-            body = {
-              :id => 1,
-              :fullname => Faraday::Utils.parse_query(env[:body])['fullname']
-            }.to_json
-            [200, {}, body]
-          end
-        end
-      end
-
-      spawn_model "Foo::User" do
-        def to_params
-          { :fullname => "Lindsay Fünke" }
-        end
-      end
-    end
-
-    it "changes the request parameters for one-line resource creation" do
-      @user = Foo::User.create(:fullname => "Tobias Fünke")
-      @user.fullname.should == "Lindsay Fünke"
-    end
-
-    it "changes the request parameters for Model.new + #save" do
-      @user = Foo::User.new(:fullname => "Tobias Fünke")
-      @user.save
-      @user.fullname.should == "Lindsay Fünke"
-    end
-  end
-
-  context "checking resource equality" do
-    before do
-      Her::API.setup :url => "https://api.example.com" do |builder|
-        builder.use Her::Middleware::FirstLevelParseJSON
-        builder.use Faraday::Request::UrlEncoded
-        builder.adapter :test do |stub|
-          stub.get("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke" }.to_json] }
-          stub.get("/users/2") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
-          stub.get("/admins/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke" }.to_json] }
-        end
-      end
-
-      spawn_model "Foo::User"
-      spawn_model "Foo::Admin"
-    end
-
-    let(:user) { Foo::User.find(1) }
-
-    it "returns true for the exact same object" do
-      user.should == user
-    end
-
-    it "returns true for the same resource via find" do
-      user.should == Foo::User.find(1)
-    end
-
-    it "returns true for the same class with identical data" do
-      user.should == Foo::User.new(:id => 1, :fullname => "Lindsay Fünke")
-    end
-
-    it "returns true for a different resource with the same data" do
-      user.should == Foo::Admin.find(1)
-    end
-
-    it "returns false for the same class with different data" do
-      user.should_not == Foo::User.new(:id => 2, :fullname => "Tobias Fünke")
-    end
-
-    it "returns false for a non-resource with the same data" do
-      fake_user = stub(:data => { :id => 1, :fullname => "Lindsay Fünke" })
-      user.should_not == fake_user
-    end
-
-    it "delegates eql? to ==" do
-      other = Object.new
-      user.should_receive(:==).with(other).and_return(true)
-      user.eql?(other).should be_true
-    end
-
-    it "treats equal resources as equal for Array#uniq" do
-      user2 = Foo::User.find(1)
-      [user, user2].uniq.should == [user]
-    end
-
-    it "treats equal resources as equal for hash keys" do
-      Foo::User.find(1)
-      hash = { user => true }
-      hash[Foo::User.find(1)] = false
-      hash.size.should == 1
-      hash.should == { user => false }
-    end
-  end
-
 end

data/spec/model/parse_spec.rb

@@ -2,8 +2,8 @@
 require File.join(File.dirname(__FILE__), "../spec_helper.rb")
 
 describe Her::Model::Parse do
-  context "when include_root_in_json is true" do
-    context "when include_root_in_json is true" do
+  context "when include_root_in_json is set" do
+    context "to true" do
       before do
         spawn_model "Foo::User" do
           include_root_in_json true
@@ -16,7 +16,7 @@ describe Her::Model::Parse do
       end
     end
 
-    context "when include_root_in_json is set to another value" do
+    context "to a symbol" do
       before do
         spawn_model "Foo::User" do
           include_root_in_json :person
@@ -29,7 +29,7 @@ describe Her::Model::Parse do
       end
     end
 
-    context "when include_root_in_json is set in the parent class" do
+    context "in the parent class" do
       before do
         spawn_model("Foo::Model") { include_root_in_json true }
 
@@ -52,7 +52,7 @@ describe Her::Model::Parse do
       end
     end
 
-    context "when parse_root_in_json is true" do
+    context "to true" do
       before do
         Her::API.default_api.connection.adapter :test do |stub|
           stub.post("/users") { |env| [200, {}, { :user => { :id => 1, :fullname => "Lindsay Fünke" } }.to_json] }
@@ -87,7 +87,7 @@ describe Her::Model::Parse do
       end
     end
 
-    context "when parse_root_in_json is set to a symbol" do
+    context "to a symbol" do
       before do
         Her::API.default_api.connection.adapter :test do |stub|
           stub.post("/users") { |env| [200, {}, { :person => { :id => 1, :fullname => "Lindsay Fünke" } }.to_json] }
@@ -102,7 +102,7 @@ describe Her::Model::Parse do
       end
     end
 
-    context "when parse_root_in_json is set from the parent class" do
+    context "in the parent class" do
       before do
         Her::API.default_api.connection.adapter :test do |stub|
           stub.post("/users") { |env| [200, {}, { :user => { :id => 1, :fullname => "Lindsay Fünke" } }.to_json] }
@@ -122,4 +122,33 @@ describe Her::Model::Parse do
       end
     end
   end
+
+  context "when to_params is set" do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.adapter :test do |stub|
+          stub.post("/users") { |env| ok! :id => 1, :fullname => params(env)['fullname'] }
+        end
+      end
+
+      spawn_model "Foo::User" do
+        def to_params
+          { :fullname => "Lindsay Fünke" }
+        end
+      end
+    end
+
+    it "changes the request parameters for one-line resource creation" do
+      @user = Foo::User.create(:fullname => "Tobias Fünke")
+      @user.fullname.should == "Lindsay Fünke"
+    end
+
+    it "changes the request parameters for Model.new + #save" do
+      @user = Foo::User.new(:fullname => "Tobias Fünke")
+      @user.save
+      @user.fullname.should == "Lindsay Fünke"
+    end
+  end
 end