her 0.6.8 → 0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f5ffa339d778a9e0c1bdf8284bb6df2452584b9
+  data.tar.gz: f37e2a93474b2290a0b676ec70c793232ad49eb7
+SHA512:
+  metadata.gz: 9d6670525bc4efb9c658cf9692ffda8fdb2c9ae24267f0b44c48980b39330b9b3fd51f47b73ad024f8cbb53f45ebff43d8adafe5adf6cae91f739a17aa5715bd
+  data.tar.gz: 45e82cff66d8f55e5887769a103a8015deff104c27e0d9e1fc0daff79dd53bc9e67681437ff3b692017d7c74596a9a2b3d5cd133906db0cbec9a01a3874057bb

data/.gitignore

@@ -1,3 +1,4 @@
 /Gemfile.lock
 /pkg
 /tmp
+/coverage

data/.travis.yml

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

data/Gemfile

@@ -1,2 +1,10 @@
 source "https://rubygems.org"
 gemspec
+
+if RbConfig::CONFIG['RUBY_PROGRAM_VERSION'] && RbConfig::CONFIG['RUBY_PROGRAM_VERSION'] >= '1.9.3'
+  gem 'activemodel', '>= 3.2.0'
+  gem 'activesupport', '>= 3.2.0'
+else
+  gem 'activemodel', '~> 3.2.0'
+  gem 'activesupport', '~> 3.2.0'
+end

data/README.md

@@ -1,11 +1,17 @@
-# 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.
+<p align="center">
+  <a href="https://github.com/remiprev/her">
+    <img src="http://i.imgur.com/43KEchq.png" alt="Her" />
+  </a>
+  <br />
+  Her is an ORM (Object Relational Mapper) that maps REST resources to Ruby objects.<br /> It is designed to build applications that are powered by a RESTful API instead of a database.
+  <br /><br />
+  <a href="https://rubygems.org/gems/her"><img src="http://img.shields.io/gem/v/her.svg" /></a>
+  <a href="https://codeclimate.com/github/remiprev/her"><img src="http://img.shields.io/codeclimate/github/remiprev/her.svg" /></a>
+  <a href='https://gemnasium.com/remiprev/her'><img src="http://img.shields.io/gemnasium/remiprev/her.svg" /></a>
+  <a href="https://travis-ci.org/remiprev/her"><img src="http://img.shields.io/travis/remiprev/her.svg" /></a>
+</p>
+
+---
 
 ## Installation
 
@@ -26,8 +32,13 @@ First, you have to define which API your models will be bound to. For example, w
 ```ruby
 # config/initializers/her.rb
 Her::API.setup url: "https://api.example.com" do |c|
+  # Request
   c.use Faraday::Request::UrlEncoded
+
+  # Response
   c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
   c.use Faraday::Adapter::NetHttp
 end
 ```
@@ -75,7 +86,7 @@ end
 # Update a fetched resource
 user = User.find(1)
 user.fullname = "Lindsay Fünke" # OR user.assign_attributes(fullname: "Lindsay Fünke")
-user.save
+user.save # returns false if it fails, errors in user.response_errors array
 # PUT "/users/1" with `fullname=Lindsay+Fünke`
 
 # Update a resource without fetching it
@@ -103,7 +114,7 @@ User.create(fullname: "Maeby Fünke")
 
 # Save a new resource
 user = User.new(fullname: "Maeby Fünke")
-user.save
+user.save! # raises Her::Errors::ResourceInvalid if it fails
 # POST "/users" with `fullname=Maeby+Fünke`
 ```
 
@@ -142,9 +153,14 @@ end
 require "lib/my_token_authentication"
 
 Her::API.setup url: "https://api.example.com" do |c|
+  # Request
   c.use MyTokenAuthentication
   c.use Faraday::Request::UrlEncoded
+
+  # Response
   c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
   c.use Faraday::Adapter::NetHttp
 end
 ```
@@ -175,8 +191,13 @@ TWITTER_CREDENTIALS = {
 }
 
 Her::API.setup url: "https://api.twitter.com/1/" do |c|
+  # Request
   c.use FaradayMiddleware::OAuth, TWITTER_CREDENTIALS
+
+  # Response
   c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
   c.use Faraday::Adapter::NetHttp
 end
 
@@ -225,7 +246,10 @@ class MyCustomParser < Faraday::Response::Middleware
 end
 
 Her::API.setup url: "https://api.example.com" do |c|
+  # Response
   c.use MyCustomParser
+
+  # Adapter
   c.use Faraday::Adapter::NetHttp
 end
 ```
@@ -246,8 +270,13 @@ In your Ruby code:
 
 ```ruby
 Her::API.setup url: "https://api.example.com" do |c|
+  # Request
   c.use FaradayMiddleware::Caching, Memcached::Rails.new('127.0.0.1:11211')
+
+  # Response
   c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
   c.use Faraday::Adapter::NetHttp
 end
 
@@ -668,7 +697,7 @@ class User
 end
 
 user = User.find("4fd89a42ff204b03a905c535")
-# GET "/users/1", response is { "_id": "4fd89a42ff204b03a905c535", "name": "Tobias" }
+# GET "/users/4fd89a42ff204b03a905c535", response is { "_id": "4fd89a42ff204b03a905c535", "name": "Tobias" }
 
 user.destroy
 # DELETE "/users/4fd89a42ff204b03a905c535"
@@ -748,13 +777,19 @@ It is possible to use different APIs for different models. Instead of calling `H
 # config/initializers/her.rb
 MY_API = Her::API.new
 MY_API.setup url: "https://my-api.example.com" do |c|
+  # Response
   c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
   c.use Faraday::Adapter::NetHttp
 end
 
 OTHER_API = Her::API.new
 OTHER_API.setup url: "https://other-api.example.com" do |c|
+  # Response
   c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
   c.use Faraday::Adapter::NetHttp
 end
 ```
@@ -786,7 +821,10 @@ When initializing `Her::API`, you can pass any parameter supported by `Faraday.n
 ```ruby
 ssl_options = { ca_path: "/usr/lib/ssl/certs" }
 Her::API.setup url: "https://api.example.com", ssl: ssl_options do |c|
+  # Response
   c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
   c.use Faraday::Adapter::NetHttp
 end
 ```

data/gemfiles/Gemfile.activemodel-3.2.x

@@ -3,3 +3,5 @@ source "https://rubygems.org"
 gemspec :path => "../"
 
 gem 'activemodel', '~> 3.2.0'
+gem 'activesupport', '~> 3.2.0'
+gem 'faraday', '~> 0.8.9'

data/gemfiles/Gemfile.activemodel-4.0

@@ -3,3 +3,5 @@ source "https://rubygems.org"
 gemspec :path => "../"
 
 gem 'activemodel', '~> 4.0.0'
+gem 'activesupport', '~> 4.0.0'
+gem 'faraday', '~> 0.8.9'

data/gemfiles/Gemfile.activemodel-4.1

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem 'activemodel', '~> 4.1.0'
+gem 'activesupport', '~> 4.1.0'
+gem 'faraday', '~> 0.8.9'

data/her.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec", "~> 2.13"
+  s.add_development_dependency "rspec-its", "~> 1.0"
   s.add_development_dependency "fivemat", "~> 1.2"
-  s.add_development_dependency "json", "~> 1.7.7"
+  s.add_development_dependency "json", "~> 1.8"
 
-  s.add_runtime_dependency "activemodel", ">= 3.0.0"
-  s.add_runtime_dependency "activesupport", ">= 3.0.0"
-  s.add_runtime_dependency "faraday", "~> 0.8"
+  s.add_runtime_dependency "activemodel", ">= 3.0.0", "< 4.2"
+  s.add_runtime_dependency "activesupport", ">= 3.0.0", "< 4.2"
+  s.add_runtime_dependency "faraday", ">= 0.8", "< 1.0"
   s.add_runtime_dependency "multi_json", "~> 1.7"
 end

data/lib/her/api.rb

@@ -5,6 +5,9 @@ module Her
     # @private
     attr_reader :base_uri, :connection, :options
 
+    # Constants
+    FARADAY_OPTIONS = [:request, :proxy, :ssl, :builder, :url, :parallel_manager, :params, :headers, :builder_class].freeze
+
     # Setup a default API connection. Accepted arguments and options are the same as {API#setup}.
     def self.setup(opts={}, &block)
       @default_api = new
@@ -42,12 +45,13 @@ module Her
     #   class MyAuthentication < Faraday::Middleware
     #     def call(env)
     #       env[:request_headers]["X-API-Token"] = "bb2b2dd75413d32c1ac421d39e95b978d1819ff611f68fc2fdd5c8b9c7331192"
-    #       @all.call(env)
+    #       @app.call(env)
     #     end
     #   end
     #   Her::API.setup :url => "https://api.example.com" do |connection|
     #     connection.use Faraday::Request::UrlEncoded
     #     connection.use Her::Middleware::DefaultParseJSON
+    #     connection.use MyAuthentication
     #     connection.use Faraday::Adapter::NetHttp
     #   end
     #
@@ -69,7 +73,9 @@ module Her
       opts[:url] = opts.delete(:base_uri) if opts.include?(:base_uri) # Support legacy :base_uri option
       @base_uri = opts[:url]
       @options = opts
-      @connection = Faraday.new(@options) do |connection|
+
+      faraday_options = @options.reject { |key, value| !FARADAY_OPTIONS.include?(key.to_sym) }
+      @connection = Faraday.new(faraday_options) do |connection|
         yield connection if block_given?
       end
       self

data/lib/her/errors.rb

@@ -14,5 +14,14 @@ module Her
 
     class ParseError < StandardError
     end
+
+    class ResourceInvalid < StandardError
+      attr_reader :resource
+      def initialize(resource)
+        @resource = resource
+        errors = @resource.response_errors.join(", ")
+        super("Remote validation failed: #{errors}")
+      end
+    end
   end
 end

data/lib/her/middleware/parse_json.rb

@@ -3,7 +3,7 @@ module Her
     class ParseJSON < Faraday::Response::Middleware
       # @private
       def parse_json(body = nil)
-        body ||= '{}'
+        body = '{}' if body.blank?
         message = "Response from the API must behave like a Hash or an Array (last JSON response was #{body.inspect})"
 
         json = begin

data/lib/her/model/associations.rb

@@ -1,4 +1,5 @@
 require "her/model/associations/association"
+require "her/model/associations/association_proxy"
 require "her/model/associations/belongs_to_association"
 require "her/model/associations/has_many_association"
 require "her/model/associations/has_one_association"

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

@@ -15,13 +15,22 @@ module Her
           @name = @opts[:name]
         end
 
+        # @private
+        def self.proxy(parent, opts = {})
+          AssociationProxy.new new(parent, opts)
+        end
+
         # @private
         def self.parse_single(association, klass, data)
           data_key = association[:data_key]
           return {} unless data[data_key]
 
           klass = klass.her_nearby_class(association[:class_name])
-          { association[:name] => klass.new(data[data_key]) }
+          if data[data_key].kind_of?(klass)
+            { association[:name] => data[data_key] }
+          else
+            { association[:name] => klass.new(data[data_key]) }
+          end
         end
 
         # @private
@@ -35,7 +44,8 @@ module Her
 
         # @private
         def fetch(opts = {})
-          return @opts[:default].try(:dup) if @parent.attributes.include?(@name) && @parent.attributes[@name].empty? && @params.empty?
+          attribute_value = @parent.attributes[@name]
+          return @opts[:default].try(:dup) if @parent.attributes.include?(@name) && (attribute_value.nil? || !attribute_value.nil? && attribute_value.empty?) && @params.empty?
 
           if @parent.attributes[@name].blank? || @params.any?
             path = build_association_path lambda { "#{@parent.request_path(@params)}#{@opts[:path]}" }
@@ -66,7 +76,7 @@ module Her
         #   user.comments.where(:approved => 1) # Fetched via GET "/users/1/comments?approved=1
         def where(params = {})
           return self if params.blank? && @parent.attributes[@name].blank?
-          self.clone.tap { |a| a.params = a.params.merge(params) }
+          AssociationProxy.new self.clone.tap { |a| a.params = a.params.merge(params) }
         end
         alias all where
 
@@ -86,32 +96,6 @@ module Her
           @klass.get(path, @params)
         end
 
-        # @private
-        def nil?
-          fetch.nil?
-        end
-
-        # @private
-        def kind_of?(thing)
-          fetch.kind_of?(thing)
-        end
-
-        # @private
-        def ==(other)
-          fetch.eql?(other)
-        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)
-        end
       end
     end
   end

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

@@ -0,0 +1,46 @@
+module Her
+  module Model
+    module Associations
+      class AssociationProxy < (ActiveSupport.const_defined?('ProxyObject') ? ActiveSupport::ProxyObject : ActiveSupport::BasicObject)
+
+        # @private
+        def self.install_proxy_methods(target_name, *names)
+          names.each do |name|
+            module_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{name}(*args, &block)
+                #{target_name}.#{name}(*args, &block)
+              end
+            RUBY
+          end
+        end
+
+        install_proxy_methods :association,
+          :build, :create, :where, :find, :all, :assign_nested_attributes
+
+        # @private
+        def initialize(association)
+          @_her_association = association
+        end
+
+        def association
+          @_her_association
+        end
+
+        # @private
+        def method_missing(name, *args, &block)
+          if :object_id == name # avoid redefining object_id
+            return association.fetch.object_id
+          end
+
+          # create a proxy to the fetched object's method
+          metaclass = (class << self; self; end)
+          metaclass.install_proxy_methods 'association.fetch', name
+
+          # resend message to fetched object
+          __send__(name, *args, &block)
+        end
+
+      end
+    end
+  end
+end

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

@@ -2,6 +2,7 @@ module Her
   module Model
     module Associations
       class BelongsToAssociation < Association
+
         # @private
         def self.attach(klass, name, opts)
           opts = {
@@ -19,7 +20,7 @@ module Her
               cached_name = :"@_her_association_#{name}"
 
               cached_data = (instance_variable_defined?(cached_name) && instance_variable_get(cached_name))
-              cached_data || instance_variable_set(cached_name, Her::Model::Associations::BelongsToAssociation.new(self, #{opts.inspect}))
+              cached_data || instance_variable_set(cached_name, Her::Model::Associations::BelongsToAssociation.proxy(self, #{opts.inspect}))
             end
           RUBY
         end
@@ -72,7 +73,8 @@ module Her
         # @private
         def fetch
           foreign_key_value = @parent.attributes[@opts[:foreign_key].to_sym]
-          return @opts[:default].try(:dup) if (@parent.attributes.include?(@name) && @parent.attributes[@name].nil? && @params.empty?) || (@parent.persisted? && foreign_key_value.blank?)
+          data_key_value = @parent.attributes[@opts[:data_key].to_sym]
+          return @opts[:default].try(:dup) if (@parent.attributes.include?(@name) && @parent.attributes[@name].nil? && @params.empty?) || (@parent.persisted? && foreign_key_value.blank? && data_key_value.blank?)
 
           if @parent.attributes[@name].blank? || @params.any?
             path_params = @parent.attributes.merge(@params.merge(@klass.primary_key => foreign_key_value))