her 0.6.1 → 0.6.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2RhYjBkODQ3ZjE1NmNlM2VmZTExNWJkNDU3NTI4YjI3OGNhN2RiZQ==
+    MDYyOTQxNDk5MmVhOGYxZDg4OTI0YTAxN2Y3MzBkYzliODc2MjgzZg==
   data.tar.gz: !binary |-
-    OTBmNmRjM2I2NDE3ZmQ4MjZmZDJjMzI5NjQ2ODJjODUwMDczNWRiNw==
+    ZWJmNTZiODg5ZWFkYjZjM2M3YmRkNzhhNzk5MzYzOWQxOTdkYmNjNw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YzZhZjExMWI1MmYwYTUwODU4OGM0OWM2OWI2NDgyOGU5OTM0ZWViY2UzYjdh
-    NTZmNTI1YmFhMDlmMzQ5YTBmZWQzMWZhZjRlOWUwMzcxZTY0NWQ5YWQ2ODk3
-    ZjA0M2ExMmMyM2UxNjMwYzJjOWNjNmVjYzY4MDJkZmM3NjM2NzY=
+    OTM0ZGNmYmRjODRiNDJhMzhkNTY2NGViNjU1Y2EzNzQwMGE2MTE3OWRlZDM4
+    N2Q4MWJlMjYxMjU5ZTg5MGU5MTdmZWEyZGY3ZmJmNThmYzY4NWNlMGQ5YzMw
+    ZGM1ZjcwYmRhZjA4ZWYyNjU4MTJiMzdkYjk4YzE0YmU3ZjY4MTc=
   data.tar.gz: !binary |-
-    ZDM4NWJjMzllNDdhZTc1NGI2NWVmMjlhYTAyYzgzYTIxOTkzNDgwNGEzZDVi
-    ZmI0OWRmYjdhNjVkNWMwNzVhYjIyYjg2YTM0ZjczMGY5OTBkNDU3Nzg4ZWVk
-    OWYwY2Y0NDk0Zjc1MDlkM2M1ZDJlNzkzZTA4NGMxNTI2M2FlODI=
+    YmU3ODE5Mzk0YmY4YWQxOTA4YjVkMGNlNmFkNzBmZGMzOTAwNTA2MTFmNThl
+    MDFkNDQ2MTlkY2FkNWNlYWE2ZjFjZjFkMmJjZmIxY2UyYjY1ZGUyNjExNjVl
+    ODlmMDUwN2Q2NjhiOGY4ZmMyNmJkNDI4Nzg4OWM5YjZlNWIyNzc=

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.9.2
-  - 2.0.0
+  - 1.8.7
 
 script: "echo 'COME ON!' && bundle exec rake spec"

data/README.md

@@ -1,14 +1,9 @@
 # Her
 
-[![Gem Version](https://badge.fury.io/rb/her.png)][gem]
-[![Build Status](https://secure.travis-ci.org/remiprev/her.png?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/remiprev/her.png?travis)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/remiprev/her.png)][codeclimate]
-
-[gem]: https://rubygems.org/gems/her
-[travis]: http://travis-ci.org/remiprev/her
-[gemnasium]: https://gemnasium.com/remiprev/her
-[codeclimate]: https://codeclimate.com/github/remiprev/her
+[![Gem Version](https://badge.fury.io/rb/her.png)](https://rubygems.org/gems/her)
+[![Build Status](https://secure.travis-ci.org/remiprev/her.png?branch=master)](http://travis-ci.org/remiprev/her)
+[![Dependency Status](https://gemnasium.com/remiprev/her.png?travis)](https://gemnasium.com/remiprev/her)
+[![Code Climate](https://codeclimate.com/github/remiprev/her.png)](https://codeclimate.com/github/remiprev/her)
 
 Her is an ORM (Object Relational Mapper) that maps REST resources to Ruby objects. It is designed to build applications that are powered by a RESTful API instead of a database.
 
@@ -53,17 +48,17 @@ User.find(1)
 # GET https://api.example.com/users/1 and return a User object
 
 @user = User.create(fullname: "Tobias Fünke")
-# POST "https://api.example.com/users" with the data and return a User object
+# POST "https://api.example.com/users" with `fullname=Tobias+Fünke` and return the saved User object
 
 @user = User.new(fullname: "Tobias Fünke")
 @user.occupation = "actor"
 @user.save
-# POST https://api.example.com/users with the data and return a User object
+# POST https://api.example.com/users with `fullname=Tobias+Fünke&occupation=actore` and return the saved User object
 
 @user = User.find(1)
 @user.fullname = "Lindsay Fünke"
 @user.save
-# PUT https://api.example.com/users/1 with the data and return+update the User object
+# PUT https://api.example.com/users/1 with `fullname=Lindsay+Fünke` and return the updated User object
 ```
 
 ### ActiveRecord-like methods
@@ -505,6 +500,7 @@ You can easily define custom requests for your models using `custom_get`, `custo
 ```ruby
 class User
   include Her::Model
+
   custom_get :popular, :unpopular
   custom_post :from_default
 end
@@ -518,7 +514,7 @@ User.unpopular
 # [#<User id=3>, #<User id=4>]
 
 User.from_default(name: "Maeby Fünke")
-# POST /users/from_default?name=Maeby+Fünke
+# POST /users/from_default with `name=Maeby+Fünke`
 # #<User id=5 name="Maeby Fünke">
 ```
 
@@ -538,7 +534,7 @@ User.get(:single_best)
 # #<User id=1>
 ```
 
-Also, `get_collection` (which maps the returned data to a collection of resources), `get_resource` (which maps the returned data to a single resource) or `get_raw` (which yields the parsed data return from the HTTP request) can also be used. Other HTTP methods are supported (`post_raw`, `put_resource`, etc.).
+Also, `get_collection` (which maps the returned data to a collection of resources), `get_resource` (which maps the returned data to a single resource) or `get_raw` (which yields the parsed data and the raw response from the HTTP request) can also be used. Other HTTP methods are supported (`post_raw`, `put_resource`, etc.).
 
 ```ruby
 class User
@@ -549,7 +545,7 @@ class User
   end
 
   def self.total
-    get_raw(:stats) do |parsed_data|
+    get_raw(:stats) do |parsed_data, response|
       parsed_data[:data][:total_users]
     end
   end
@@ -558,6 +554,7 @@ end
 User.popular
 # GET /users/popular
 # [#<User id=1>, #<User id=2>]
+
 User.total
 # GET /users/stats
 # => 42
@@ -605,7 +602,7 @@ end
 
 @user = User.new(fullname: "Tobias Fünke", organization_id: 2)
 @user.save
-# POST /organizations/2/users
+# POST /organizations/2/users with `fullname=Tobias+Fünke`
 ```
 
 ### Custom primary keys
@@ -656,9 +653,9 @@ Just like with ActiveRecord, you can define named scopes for your models. Scopes
 class User
   include Her::Model
 
-  scope :by_role, lambda { |role| where(:role => role) }
+  scope :by_role, lambda { |role| where(role: role) }
   scope :admins, lambda { by_role('admin') }
-  scope :active, lambda { where(:active => 1) }
+  scope :active, lambda { where(active: 1) }
 end
 
 @admins = User.admins

data/lib/her/model.rb

@@ -46,6 +46,10 @@ module Her
     included do
       # Assign the default API
       use_api Her::API.default_api
+      method_for :create, :post
+      method_for :update, :put
+      method_for :find, :get
+      method_for :destroy, :delete
 
       # Define the default primary key
       primary_key :id

data/lib/her/model/associations/association.rb

@@ -36,6 +36,12 @@ module Her
         end
         alias :eql? :==
 
+        # ruby 1.8.7 compatibility
+        # @private
+        def id
+          fetch.id
+        end
+
         # @private
         def method_missing(method, *args, &blk)
           fetch.send(method, *args, &blk)

data/lib/her/model/associations/belongs_to_association.rb

@@ -45,7 +45,7 @@ module Her
               return nil
             end
 
-            @klass.get_resource("#{path}", @query_attrs)
+            @klass.get_resource(path, @query_attrs)
           else
             @parent.attributes[@name]
           end

data/lib/her/model/attributes.rb

@@ -104,7 +104,7 @@ module Her
       # Override the method to prevent from returning the object ID
       # @private
       def id
-        attributes[self.class.primary_key] || super
+        attributes[self.class.primary_key]
       end
 
       # Return `true` if the other object is also a Her::Model and has matching data

data/lib/her/model/http.rb

@@ -38,7 +38,8 @@ module Her
         # - <method>_resource(path, attrs, &block)
         # - custom_<method>(path, attrs)
         METHODS.each do |method|
-          define_method method do |path, attrs={}|
+          define_method method do |path, *attrs|
+            attrs = attrs.first || {}
             path = build_request_path_from_string_or_symbol(path, attrs)
             send(:"#{method}_raw", path, attrs) do |parsed_data, response|
               if parsed_data[:data].is_a?(Array)
@@ -49,19 +50,23 @@ module Her
             end
           end
 
-          define_method :"#{method}_raw" do |path, attrs={}, &block|
+          define_method :"#{method}_raw" do |path, *attrs, &block|
+            attrs = attrs.first || {}
             path = build_request_path_from_string_or_symbol(path, attrs)
             request(attrs.merge(:_method => method, :_path => path), &block)
           end
 
-          define_method :"#{method}_collection" do |path=nil, attrs={}|
+          define_method :"#{method}_collection" do |*args|
+            path  = args.first
+            attrs = args[1] || {}
             path = build_request_path_from_string_or_symbol(path, attrs)
             send(:"#{method}_raw", build_request_path_from_string_or_symbol(path, attrs), attrs) do |parsed_data, response|
               new_collection(parsed_data)
             end
           end
 
-          define_method :"#{method}_resource" do |path, attrs={}|
+          define_method :"#{method}_resource" do |path, *attrs|
+            attrs = attrs.first || {}
             path = build_request_path_from_string_or_symbol(path, attrs)
             send(:"#{method}_raw", path, attrs) do |parsed_data, response|
               new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:metadata], :_errors => parsed_data[:errors])

data/lib/her/model/nested_attributes.rb

@@ -45,7 +45,7 @@ module Her
       def assign_nested_attributes_for_simple_association(association_type, association_name, attributes)
         association = self.class.associations[association_type].find { |association| association[:name] == association_name }
         if has_data?(association[:name])
-          self.send("#{association[:name]}").assign_data(attributes)
+          self.send(association[:name]).assign_data(attributes)
         else
           klass = self.class.her_nearby_class(association[:class_name])
           instance = klass.new(klass.parse(attributes))

data/lib/her/model/orm.rb

@@ -6,7 +6,7 @@ module Her
 
       # Return `true` if a resource was not saved yet
       def new?
-        attributes[self.class.primary_key].nil?
+        id.nil?
       end
 
       # Return `true` if a resource is not `#new?`
@@ -34,17 +34,13 @@ module Her
       #   @user.save
       #   # Called via POST "/users"
       def save
-        if new?
-          callback = :create
-          method = :post
-        else
-          callback = :update
-          method = :put
-        end
+        callback = new? ? :create : :update
+        method = self.class.method_for(callback)
 
         run_callbacks callback do
           run_callbacks :save do
-            self.class.request(to_params.merge(:_method => method, :_path => "#{request_path}")) do |parsed_data, response|
+            params = to_params
+            self.class.request(to_params.merge(:_method => method, :_path => request_path)) do |parsed_data, response|
               assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
               self.metadata = parsed_data[:metadata]
               self.response_errors = parsed_data[:errors]
@@ -65,9 +61,9 @@ module Her
       #   @user.destroy
       #   # Called via DELETE "/users/1"
       def destroy
-        resource = self
+        method = self.class.method_for(:destroy)
         run_callbacks :destroy do
-          self.class.request(:_method => :delete, :_path => "#{request_path}") do |parsed_data, response|
+          self.class.request(:_method => method, :_path => request_path) do |parsed_data, response|
             assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
             self.metadata = parsed_data[:metadata]
             self.response_errors = parsed_data[:errors]
@@ -91,7 +87,7 @@ module Her
           params = ids.last.is_a?(Hash) ? ids.pop : {}
           results = ids.flatten.compact.uniq.map do |id|
             resource = nil
-            request(params.merge(:_method => :get, :_path => "#{build_request_path(params.merge(primary_key => id))}")) do |parsed_data, response|
+            request(params.merge(:_method => method_for(:find), :_path => build_request_path(params.merge(primary_key => id)))) do |parsed_data, response|
               if response.success?
                 resource = new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:metadata], :_errors => parsed_data[:errors])
                 resource.run_callbacks :find
@@ -122,8 +118,12 @@ module Her
         #   User.admins # Called via GET "/users?admin=1"
         #   User.page(2).all # Called via GET "/users?page=2"
         def scope(name, code)
-          define_singleton_method(name) { |*args| instance_exec(*args, &code) }
+          # Add the scope method to the class
+          (class << self; self end).define_method(name) do |*args|
+            instance_exec(*args, &code)
+          end
 
+          # Add the scope method to the Relation class
           Relation.instance_eval do
             define_method(name) { |*args| instance_exec(*args, &code) }
           end
@@ -135,8 +135,8 @@ module Her
         end
 
         # Delegate the following methods to `scoped`
-        [:all, :where, :create].each do |method|
-          define_method(method) { |*attrs| scoped.send(method, attrs.first) }
+        [:all, :where, :create, :build, :first_or_create, :first_or_initialize].each do |method|
+          define_method(method) { |*attrs| scoped.send(method, *attrs) }
         end
 
         # Save an existing resource and return it
@@ -156,10 +156,24 @@ module Her
         #   User.destroy_existing(1)
         #   # Called via DELETE "/users/1"
         def destroy_existing(id, params={})
-          request(params.merge(:_method => :delete, :_path => "#{build_request_path(params.merge(primary_key => id))}")) do |parsed_data, response|
+          request(params.merge(:_method => method_for(:destroy), :_path => build_request_path(params.merge(primary_key => id)))) do |parsed_data, response|
             new(parse(parsed_data[:data]).merge(:_destroyed => true))
           end
         end
+
+        # Return or change the HTTP method used to create or update records
+        #
+        # @param [Symbol, String] action The behavior in question (`:create` or `:update`)
+        # @param [Symbol, String] method The HTTP method to use (`'PUT'`, `:post`, etc.)
+        def method_for(action = nil, method = nil)
+          @method_for ||= (superclass.respond_to?(:method_for) ? superclass.method_for : {})
+          return @method_for if action.nil?
+
+          action = action.to_s.downcase.to_sym
+
+          return @method_for[action] if method.nil?
+          @method_for[action] = method.to_s.downcase.to_sym
+        end
       end
     end
   end

data/lib/her/model/paths.rb

@@ -47,7 +47,7 @@ module Her
         #  end
         def collection_path(path = nil)
           if path.nil?
-            @_her_collection_path ||= "#{root_element.to_s.pluralize}"
+            @_her_collection_path ||= root_element.to_s.pluralize
           else
             @_her_collection_path = path
             @_her_resource_path = "#{path}/:id"

data/lib/her/model/relation.rb

@@ -51,7 +51,8 @@ module Her
       def fetch
         @_fetch ||= begin
           path = @parent.build_request_path(@query_attrs)
-          @parent.request(@query_attrs.merge(:_method => :get, :_path => path)) do |parsed_data, response|
+          method = @parent.method_for(:find)
+          @parent.request(@query_attrs.merge(:_method => method, :_path => path)) do |parsed_data, response|
             @parent.new_collection(parsed_data)
           end
         end
@@ -103,6 +104,7 @@ module Her
         fetch.first || build(attrs)
       end
 
+      # @private
       def clear_fetch_cache!
         instance_variable_set(:@_fetch, nil)
       end

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/spec/model/callbacks_spec.rb

@@ -15,6 +15,7 @@ describe "Her::Model and ActiveModel::Callbacks" do
     before do
       Her::API.default_api.connection.adapter :test do |stub|
         stub.post("/users") { |env| [200, {}, { :id => 1, :name => env[:body][:name] }.to_json] }
+        stub.put("/users/1") { |env| [200, {}, { :id => 1, :name => env[:body][:name] }.to_json] }
       end
     end
 
@@ -38,6 +39,23 @@ describe "Her::Model and ActiveModel::Callbacks" do
 
       its(:name) { should == "TOBIAS FUNKE" }
     end
+
+    context "when changing a value of an existing resource in a callback" do
+      before do
+        class Foo::User
+          before_save :alter_name
+          def alter_name
+            self.name = "Lumberjack" if persisted?
+          end
+        end
+      end
+
+      it "should call the server with the canged value" do
+        subject.name.should == "Tobias Funke"
+        subject.save
+        subject.name.should == "Lumberjack"
+      end
+    end
   end
 
   context :before_create do

data/spec/model/orm_spec.rb

@@ -156,6 +156,7 @@ describe Her::Model::ORM do
         builder.adapter :test do |stub|
           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&foo=bar") { |env| [200, {}, [{ :id => 3, :age => 42 }].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
@@ -195,9 +196,9 @@ describe Her::Model::ORM do
     end
 
     it "handles finding with other parameters" do
-      @users = User.where(:age => 42).all
+      @users = User.where(:age => 42, :foo => "bar").all
       @users.should be_kind_of(Array)
-      @users.should be_all { |u| u.age == 42 }
+      @users.first.id.should == 3
     end
 
     it "handles finding with other parameters and scoped" do
@@ -308,4 +309,68 @@ describe Her::Model::ORM do
       @user.should be_destroyed
     end
   end
+
+  context 'customizing HTTP methods' do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+      end
+    end
+
+    context 'create' do
+      before do
+        Her::API.default_api.connection.adapter :test do |stub|
+          stub.put('/users') { |env| [200, {}, { :id => 1, :fullname => 'Tobias Fünke' }.to_json] }
+        end
+        spawn_model 'Foo::User' do
+          attributes :fullname, :email
+          method_for :create, 'PUT'
+        end
+      end
+
+      context 'for top-level class' do
+        it 'uses the custom method (PUT) instead of default method (POST)' do
+          user = Foo::User.new(:fullname => 'Tobias Fünke')
+          user.should be_new
+          user.save.should be_true
+        end
+      end
+
+      context 'for children class' do
+        before do
+          class User < Foo::User; end
+          @spawned_models << :User
+        end
+
+        it 'uses the custom method (PUT) instead of default method (POST)' do
+          user = User.new(:fullname => 'Tobias Fünke')
+          user.should be_new
+          user.save.should be_true
+        end
+      end
+    end
+
+    context 'update' do
+      before do
+        Her::API.default_api.connection.adapter :test do |stub|
+          stub.get('/users/1') { |env| [200, {}, { :id => 1, :fullname => 'Lindsay Fünke' }.to_json] }
+          stub.post('/users/1') { |env| [200, {}, { :id => 1, :fullname => 'Tobias Fünke' }.to_json] }
+        end
+
+        spawn_model 'Foo::User' do
+          attributes :fullname, :email
+          method_for :update, :post
+        end
+      end
+
+      it 'uses the custom method (POST) instead of default method (PUT)' do
+        user = Foo::User.find(1)
+        user.fullname.should eq 'Lindsay Fünke'
+        user.fullname = 'Toby Fünke'
+        user.save
+        user.fullname.should eq 'Tobias Fünke'
+      end
+    end
+  end
 end

data/spec/support/macros/model_macros.rb

@@ -8,7 +8,7 @@ module Her
             base, submodel = klass.split(/::/).map{ |s| s.to_sym }
             Object.const_set(base, Module.new) unless Object.const_defined?(base)
             Object.const_get(base).module_eval do
-              remove_const submodel if constants.include?(submodel)
+              remove_const submodel if constants.map(&:to_sym).include?(submodel)
               submodel = const_set(submodel, Class.new)
               submodel.send(:include, Her::Model)
               submodel.class_eval(&block) if block_given?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-21 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake