her 0.6.7 → 0.6.8

data/.travis.yml

@@ -7,14 +7,14 @@ rvm:
   - 1.8.7
 
 gemfile:
-  - Gemfile
-  - gemfiles/activemodel-4.0.gemfile
+  - gemfiles/Gemfile.activemodel-4.0
+  - gemfiles/Gemfile.activemodel-3.2.x
 
 matrix:
   exclude:
   - rvm: 1.8.7
-    gemfile: gemfiles/activemodel-4.0.gemfile
+    gemfile: gemfiles/Gemfile.activemodel-4.0
   - rvm: 1.9.2
-    gemfile: gemfiles/activemodel-4.0.gemfile
+    gemfile: gemfiles/Gemfile.activemodel-4.0
 
 script: "echo 'COME ON!' && bundle exec rake spec"

data/README.md

@@ -534,6 +534,25 @@ article.title # => "Hello world."
 
 Of course, you can use both `include_root_in_json` and `parse_root_in_json` at the same time.
 
+#### ActiveModel::Serializers support
+
+If the API returns data in the default format used by the
+[ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers)
+project you need to configure Her as follows:
+
+```ruby
+class User
+  include Her::Model
+  parse_root_in_json true, format: :active_model_serializers
+end
+
+user = Users.find(1)
+# GET "/users/1", response is { "user": { "id": 1, "fullname": "Lindsay Fünke"} }
+
+users = Users.all
+# GET "/users", response is { "users": [{ "id": 1, "fullname": "Lindsay Fünke"}] }
+```
+
 ### Custom requests
 
 You can easily define custom requests for your models using `custom_get`, `custom_post`, etc.
@@ -906,6 +925,7 @@ These [fine folks](https://github.com/remiprev/her/contributors) helped with Her
 * [@jonkarna](https://github.com/jonkarna)
 * [@aclevy](https://github.com/aclevy)
 * [@stevschmid](https://github.com/stevschmid)
+* [@prognostikos](https://github.com/prognostikos)
 
 ## License
 

data/gemfiles/Gemfile.activemodel-3.2.x

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem 'activemodel', '~> 3.2.0'

data/gemfiles/Gemfile.activemodel-4.0

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem 'activemodel', '~> 4.0.0'

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

@@ -70,6 +70,22 @@ module Her
         end
         alias all where
 
+        # Fetches the data specified by id
+        #
+        # @example
+        #   class User
+        #     include Her::Model
+        #     has_many :comments
+        #   end
+        #
+        #   user = User.find(1)
+        #   user.comments.find(3) # Fetched via GET "/users/1/comments/3
+        def find(id)
+          return nil if id.blank?
+          path = build_association_path lambda { "#{@parent.request_path(@params)}#{@opts[:path]}/#{id}" }
+          @klass.get(path, @params)
+        end
+
         # @private
         def nil?
           fetch.nil?

data/lib/her/model/attributes.rb

@@ -32,7 +32,7 @@ module Her
       #
       # @private
       def self.initialize_collection(klass, parsed_data={})
-        collection_data = parsed_data[:data].map do |item_data|
+        collection_data = klass.extract_array(parsed_data).map do |item_data|
           resource = klass.new(klass.parse(item_data))
           resource.run_callbacks :find
           resource

data/lib/her/model/http.rb

@@ -64,7 +64,7 @@ module Her
               path = build_request_path_from_string_or_symbol(path, params)
               params = to_params(params) unless #{method.to_sym.inspect} == :get
               send(:'#{method}_raw', path, params) do |parsed_data, response|
-                if parsed_data[:data].is_a?(Array)
+                if parsed_data[:data].is_a?(Array) || active_model_serializers_format?
                   new_collection(parsed_data)
                 else
                   new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:metadata], :_errors => parsed_data[:errors])

data/lib/her/model/orm.rb

@@ -115,7 +115,7 @@ module Her
         #   User.all # Called via GET "/users?admin=1"
         #   User.new.admin # => 1
         def default_scope(block=nil)
-          @_her_default_scope ||= superclass.respond_to?(:default_scope) ? superclass.default_scope : scoped
+          @_her_default_scope ||= (!respond_to?(:default_scope) && superclass.respond_to?(:default_scope)) ? superclass.default_scope : scoped
           @_her_default_scope = @_her_default_scope.instance_exec(&block) unless block.nil?
           @_her_default_scope
         end

data/lib/her/model/parse.rb

@@ -19,7 +19,7 @@ module Her
         # @param [Hash] data
         # @private
         def parse(data)
-          parse_root_in_json? ? data[parsed_root_element] : data
+          parse_root_in_json? ? data.fetch(parsed_root_element) { data } : data
         end
 
         # @private
@@ -51,13 +51,14 @@ module Her
         #     include Her::Model
         #     parse_root_in_json true
         #   end
-        def parse_root_in_json(value = nil)
+        def parse_root_in_json(value = nil, options = {})
           @_her_parse_root_in_json ||= begin
             superclass.parse_root_in_json if superclass.respond_to?(:parse_root_in_json)
           end
 
           return @_her_parse_root_in_json unless value
           @_her_parse_root_in_json = value
+          @_her_parse_root_in_json_format = options[:format]
         end
         alias parse_root_in_json? parse_root_in_json
 
@@ -97,6 +98,38 @@ module Her
           end
         end
 
+        # Extract an array from the request data
+        #
+        # @example
+        #   # with parse_root_in_json true, :format => :active_model_serializers
+        #   class User
+        #     include Her::Model
+        #     parse_root_in_json true, :format => :active_model_serializers
+        #   end
+        #
+        #   users = User.all # { :users => [ { :id => 1, :name => "Tobias" } ] }
+        #   users.first.name # => "Tobias"
+        #
+        #   # without parse_root_in_json
+        #   class User
+        #     include Her::Model
+        #   end
+        #
+        #   users = User.all # [ { :id => 1, :name => "Tobias" } ]
+        #   users.first.name # => "Tobias"
+        def extract_array(request_data)
+          if active_model_serializers_format?
+            request_data[:data][pluralized_parsed_root_element]
+          else
+            request_data[:data]
+          end
+        end
+
+        # @private
+        def pluralized_parsed_root_element
+          parsed_root_element.to_s.pluralize.to_sym
+        end
+
         # @private
         def included_root_element
           include_root_in_json == true ? root_element : include_root_in_json
@@ -106,6 +139,11 @@ module Her
         def parsed_root_element
           parse_root_in_json == true ? root_element : parse_root_in_json
         end
+
+        # @private
+        def active_model_serializers_format?
+          @_her_parse_root_in_json_format == :active_model_serializers
+        end
       end
     end
   end

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.6.7"
+  VERSION = "0.6.8"
 end

data/spec/model/associations_spec.rb

@@ -91,6 +91,7 @@ describe Her::Model::Associations do
           stub.get("/users/2") { |env| [200, {}, { :id => 2, :name => "Lindsay Fünke", :organization_id => 2 }.to_json] }
           stub.get("/users/1/comments") { |env| [200, {}, [{ :comment => { :id => 4, :body => "They're having a FIRESALE?" } }].to_json] }
           stub.get("/users/2/comments") { |env| [200, {}, [{ :comment => { :id => 4, :body => "They're having a FIRESALE?" } }, { :comment => { :id => 5, :body => "Is this the tiny town from Footloose?" } }].to_json] }
+          stub.get("/users/2/comments/5") { |env| [200, {}, { :comment => { :id => 5, :body => "Is this the tiny town from Footloose?" } }.to_json] }
           stub.get("/users/2/role") { |env| [200, {}, { :id => 2, :body => "User" }.to_json] }
           stub.get("/users/1/role") { |env| [200, {}, { :id => 3, :body => "User" }.to_json] }
           stub.get("/users/1/posts") { |env| [200, {}, [{:id => 1, :body => 'blogging stuff', :admin_id => 1 }].to_json] }
@@ -211,6 +212,11 @@ describe Her::Model::Associations do
       @user_without_included_data.organization.name.should == "Bluth Company"
     end
 
+    it "fetches data with the specified id when calling find" do
+      comment = @user_without_included_data.comments.find(5)
+      comment.id.should eq(5)
+    end
+
     [:create, :save_existing, :destroy].each do |type|
       context "after #{type}" do
         let(:subject) { self.send("user_with_included_data_after_#{type}")}

data/spec/model/parse_spec.rb

@@ -150,6 +150,50 @@ describe Her::Model::Parse do
         @new_user.fullname.should == "Lindsay Fünke"
       end
     end
+
+    context "to true with :format => :active_model_serializers" 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] }
+          stub.get("/users") { |env| [200, {}, { :users => [ { :id => 1, :fullname => "Lindsay Fünke" } ] }.to_json] }
+          stub.get("/users/admins") { |env| [200, {}, { :users => [ { :id => 1, :fullname => "Lindsay Fünke" } ] }.to_json] }
+          stub.get("/users/1") { |env| [200, {}, { :user => { :id => 1, :fullname => "Lindsay Fünke" } }.to_json] }
+          stub.put("/users/1") { |env| [200, {}, { :user => { :id => 1, :fullname => "Tobias Fünke Jr." } }.to_json] }
+        end
+
+        spawn_model("Foo::User") do
+          parse_root_in_json true, :format => :active_model_serializers
+          custom_get :admins
+        end
+      end
+
+      it "parse the data from the JSON root element after .create" do
+        @new_user = Foo::User.create(:fullname => "Lindsay Fünke")
+        @new_user.fullname.should == "Lindsay Fünke"
+      end
+
+      it "parse the data from the JSON root element after an arbitrary HTTP request" do
+        @users = Foo::User.admins
+        @users.first.fullname.should == "Lindsay Fünke"
+      end
+
+      it "parse the data from the JSON root element after .all" do
+        @users = Foo::User.all
+        @users.first.fullname.should == "Lindsay Fünke"
+      end
+
+      it "parse the data from the JSON root element after .find" do
+        @user = Foo::User.find(1)
+        @user.fullname.should == "Lindsay Fünke"
+      end
+
+      it "parse the data from the JSON root element after .save" do
+        @user = Foo::User.find(1)
+        @user.fullname = "Tobias Fünke"
+        @user.save
+        @user.fullname.should == "Tobias Fünke Jr."
+      end
+    end
   end
 
   context "when to_params is set" do

data/spec/model/paths_spec.rb

@@ -125,6 +125,28 @@ describe Her::Model::Paths do
       end
     end
 
+    context "children model" 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/foo") { |env| [200, {}, { :id => 'foo' }.to_json] }
+          end
+        end
+
+        spawn_model("Foo::Model") { include_root_in_json true }
+
+        class User < Foo::Model; end
+        @spawned_models << :User
+      end
+
+      it "builds path using the children model name" do
+        User.find('foo').id.should == 'foo'
+        User.find('foo').id.should == 'foo'
+      end
+    end
+
     context "nested model" do
       before do
         spawn_model "Foo::User"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-27 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -156,7 +156,8 @@ files:
 - README.md
 - Rakefile
 - UPGRADE.md
-- gemfiles/activemodel-4.0.gemfile
+- gemfiles/Gemfile.activemodel-3.2.x
+- gemfiles/Gemfile.activemodel-4.0
 - her.gemspec
 - lib/her.rb
 - lib/her/api.rb
@@ -223,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1578317715926145011
+      hash: 2536489429371279776
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -232,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1578317715926145011
+      hash: 2536489429371279776
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/gemfiles/activemodel-4.0.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: "../"
-
-gem 'activemodel', '~> 4.0.0.rc1'