castle-her 1.0.1

data/spec/model/relation_spec.rb

@@ -0,0 +1,226 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Her::Model::Relation do
+  describe :where do
+    context "for base classes" do
+      before do
+        Her::API.setup :url => "https://api.example.com" do |builder|
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.adapter :test do |stub|
+            stub.get("/users?foo=1&bar=2") { |env| ok! [{ :id => 2, :fullname => "Tobias Fünke" }] }
+            stub.get("/users?admin=1") { |env| ok! [{ :id => 1, :fullname => "Tobias Fünke" }] }
+
+            stub.get("/users") do |env|
+              ok! [
+                { :id => 1, :fullname => "Tobias Fünke" },
+                { :id => 2, :fullname => "Lindsay Fünke" },
+                @created_user,
+              ].compact
+            end
+
+            stub.post('/users') do |env|
+              @created_user = { :id => 3, :fullname => 'George Michael Bluth' }
+              ok! @created_user
+            end
+          end
+        end
+
+        spawn_model "Foo::User"
+      end
+
+      it "doesn't fetch the data immediatly" do
+        expect(Foo::User).not_to receive(:request)
+        @users = Foo::User.where(:admin => 1)
+      end
+
+      it "fetches the data and passes query parameters" do
+        expect(Foo::User).to receive(:request).once.and_call_original
+        @users = Foo::User.where(:admin => 1)
+        expect(@users).to respond_to(:length)
+        expect(@users.size).to eq(1)
+      end
+
+      it "chains multiple where statements" do
+        @user = Foo::User.where(:foo => 1).where(:bar => 2).first
+        expect(@user.id).to eq(2)
+      end
+
+      it "does not reuse relations" do
+        expect(Foo::User.all.size).to eq(2)
+        expect(Foo::User.create(:fullname => 'George Michael Bluth').id).to eq(3)
+        expect(Foo::User.all.size).to eq(3)
+      end
+    end
+
+    context "for parent class" do
+      before do
+        Her::API.setup :url => "https://api.example.com" do |builder|
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.adapter :test do |stub|
+            stub.get("/users?page=2") { |env| ok! [{ :id => 1, :fullname => "Tobias Fünke" }, { :id => 2, :fullname => "Lindsay Fünke" }] }
+          end
+        end
+
+        spawn_model("Foo::Model") do
+          scope :page, lambda { |page| where(:page => page) }
+        end
+
+        class User < Foo::Model; end
+        @spawned_models << :User
+      end
+
+      it "propagates the scopes through its children" do
+        @users = User.page(2)
+        expect(@users.length).to eq(2)
+      end
+    end
+  end
+
+  describe :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.post("/users") { |env| ok! :id => 1, :fullname => params(env)[:fullname], :email => params(env)[:email] }
+        end
+      end
+
+      spawn_model "Foo::User"
+    end
+
+    context "with a single where call" do
+      it "creates a resource and passes the query parameters" do
+        @user = Foo::User.where(:fullname => "Tobias Fünke", :email => "tobias@bluth.com").create
+        expect(@user.id).to eq(1)
+        expect(@user.fullname).to eq("Tobias Fünke")
+        expect(@user.email).to eq("tobias@bluth.com")
+      end
+    end
+
+    context "with multiple where calls" do
+      it "creates a resource and passes the query parameters" do
+        @user = Foo::User.where(:fullname => "Tobias Fünke").create(:email => "tobias@bluth.com")
+        expect(@user.id).to eq(1)
+        expect(@user.fullname).to eq("Tobias Fünke")
+        expect(@user.email).to eq("tobias@bluth.com")
+      end
+    end
+  end
+
+  describe :build do
+    before { spawn_model "Foo::User" }
+
+    it "handles new resource with build" do
+      @new_user = Foo::User.where(:fullname => "Tobias Fünke").build
+      expect(@new_user.new?).to be_truthy
+      expect(@new_user.fullname).to eq("Tobias Fünke")
+    end
+  end
+
+  describe :scope do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.adapter :test do |stub|
+          stub.get("/users?what=4&where=3") { |env| ok! [{ :id => 3, :fullname => "Maeby Fünke" }] }
+          stub.get("/users?what=2") { |env| ok! [{ :id => 2, :fullname => "Lindsay Fünke" }] }
+          stub.get("/users?where=6") { |env| ok! [{ :id => 4, :fullname => "Tobias Fünke" }] }
+        end
+      end
+
+      spawn_model 'Foo::User' do
+        scope :foo, lambda { |v| where(:what => v) }
+        scope :bar, lambda { |v| where(:where => v) }
+        scope :baz, lambda { bar(6) }
+      end
+    end
+
+    it "passes query parameters" do
+      @user = Foo::User.foo(2).first
+      expect(@user.id).to eq(2)
+    end
+
+    it "passes multiple query parameters" do
+      @user = Foo::User.foo(4).bar(3).first
+      expect(@user.id).to eq(3)
+    end
+
+    it "handles embedded scopes" do
+      @user = Foo::User.baz.first
+      expect(@user.id).to eq(4)
+    end
+  end
+
+  describe :default_scope do
+    context "for new objects" do
+      before do
+        spawn_model 'Foo::User' do
+          default_scope lambda { where(:active => true) }
+          default_scope lambda { where(:admin => true) }
+        end
+      end
+
+      it "should apply the scope to the attributes" do
+        expect(Foo::User.new).to be_active
+        expect(Foo::User.new).to be_admin
+      end
+    end
+
+    context "for fetched resources" 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 => 3, :active => (params(env)[:active] == "true" ? true : false) }
+          end
+        end
+
+        spawn_model 'Foo::User' do
+          default_scope lambda { where(:active => true) }
+        end
+      end
+
+      it("should apply the scope to the request") { expect(Foo::User.create).to be_active }
+    end
+
+    context "for fetched collections" 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?active=true") { |env| ok! [{ :id => 3, :active => (params(env)[:active] == "true" ? true : false) }] }
+          end
+        end
+
+        spawn_model 'Foo::User' do
+          default_scope lambda { where(:active => true) }
+        end
+      end
+
+      it("should apply the scope to the request") { expect(Foo::User.all.first).to be_active }
+    end
+  end
+
+  describe :map do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.adapter :test do |stub|
+          stub.get("/users") do |env|
+            ok! [{ :id => 1, :fullname => "Tobias Fünke" }, { :id => 2, :fullname => "Lindsay Fünke" }]
+          end
+        end
+      end
+
+      spawn_model 'Foo::User'
+    end
+
+    it "delegates the method to the fetched collection" do
+      expect(Foo::User.all.map(&:fullname)).to eq(["Tobias Fünke", "Lindsay Fünke"])
+    end
+  end
+end

data/spec/model/validations_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe "Her::Model and ActiveModel::Validations" do
+  context "validating attributes" do
+    before do
+      spawn_model "Foo::User" do
+        attributes :fullname, :email
+        validates_presence_of :fullname
+        validates_presence_of :email
+      end
+    end
+
+    it "validates attributes when calling #valid?" do
+      user = Foo::User.new
+      expect(user).not_to be_valid
+      expect(user.errors.full_messages).to include("Fullname can't be blank")
+      expect(user.errors.full_messages).to include("Email can't be blank")
+      user.fullname = "Tobias Fünke"
+      user.email = "tobias@bluthcompany.com"
+      expect(user).to be_valid
+    end
+  end
+
+  context "handling server errors" do
+    before do
+      spawn_model("Foo::Model") do
+        def errors
+          @response_errors
+        end
+      end
+
+      class User < Foo::Model; end
+      @spawned_models << :User
+    end
+
+    it "validates attributes when calling #valid?" do
+      user = User.new(:_errors => ["Email cannot be blank"])
+      expect(user.errors).to include("Email cannot be blank")
+    end
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Her::Model do
+  before do
+    Her::API.setup :url => "https://api.example.com" do |connection|
+      connection.use Her::Middleware::FirstLevelParseJSON
+      connection.adapter :test do |stub|
+        stub.get("/users/1") { |env| [200, {}, { :id => 1, :name => "Tobias Fünke" }.to_json] }
+        stub.get("/users/1/comments") { |env| [200, {}, [{ :id => 4, :body => "They're having a FIRESALE?" }].to_json] }
+      end
+    end
+
+    spawn_model("Foo::User") { has_many :comments }
+    spawn_model("Foo::Comment")
+  end
+  subject { Foo::User.find(1) }
+
+  describe :has_key? do
+    it { should_not have_key(:unknown_method_for_a_user) }
+    it { should_not have_key(:unknown_method_for_a_user) }
+    it { should have_key(:name) }
+    it { should have_key(:comments) }
+  end
+
+  describe :serialization do
+    it 'should be serialized without an error' do
+      expect { Marshal.dump(subject.comments) }.not_to raise_error
+    end
+
+    it 'should correctly load serialized object' do
+       serialized_comments = Marshal.load(Marshal.dump(subject.comments))
+       expect(subject.comments.size).to eq(serialized_comments.size)
+       expect(subject.comments.first.id).to eq(serialized_comments.first.id)
+       expect(subject.comments.first.body).to eq(serialized_comments.first.body)
+    end
+  end
+
+  describe :[] do
+    it { should_not have_key(:unknown_method_for_a_user) }
+    specify { expect(subject[:name]).to eq("Tobias Fünke") }
+    specify { expect(subject[:comments].first.body).to eq("They're having a FIRESALE?") }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "rspec"
+require "rspec/its"
+require "castle-her"
+
+# Require everything in `spec/support`
+Dir[File.expand_path('../../spec/support/**/*.rb', __FILE__)].map(&method(:require))
+
+# Remove ActiveModel deprecation message
+I18n.enforce_available_locales = false
+
+RSpec.configure do |config|
+  config.include Her::Testing::Macros::ModelMacros
+  config.include Her::Testing::Macros::RequestMacros
+
+  config.before :each do
+    @spawned_models = []
+  end
+
+  config.after :each do
+    @spawned_models.each do |model|
+      Object.instance_eval { remove_const model } if Object.const_defined?(model)
+    end
+  end
+end

data/spec/support/extensions/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def to_json
+    MultiJson.dump(self)
+  end
+end

data/spec/support/extensions/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def to_json
+    MultiJson.dump(self)
+  end
+end

data/spec/support/macros/her_macros.rb

@@ -0,0 +1,17 @@
+module Her
+  module Testing
+    module Macros
+      def ok!(body)
+        [200, {}, body.to_json]
+      end
+
+      def error!(body)
+        [400, {}, body.to_json]
+      end
+
+      def params(env)
+        Faraday::Utils.parse_query(env[:body])
+      end
+    end
+  end
+end

data/spec/support/macros/model_macros.rb

@@ -0,0 +1,36 @@
+module Her
+  module Testing
+    module Macros
+      module ModelMacros
+        # Create a class and automatically inject Her::Model into it
+        def spawn_model(klass, options={}, &block)
+          super_class = options[:super_class]
+          model_type = options[:type] || Her::Model
+          new_class = if super_class
+                        Class.new(super_class)
+                      else
+                        Class.new
+                      end
+          if klass =~ /::/
+            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.map(&:to_sym).include?(submodel)
+              submodel = const_set(submodel, new_class)
+              submodel.send(:include, model_type)
+              submodel.class_eval(&block) if block_given?
+            end
+
+            @spawned_models << base
+          else
+            Object.instance_eval { remove_const klass } if Object.const_defined?(klass)
+            Object.const_set(klass, Class.new).send(:include, model_type)
+            Object.const_get(klass).class_eval(&block) if block_given?
+
+            @spawned_models << klass.to_sym
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/macros/request_macros.rb

@@ -0,0 +1,27 @@
+module Her
+  module Testing
+    module Macros
+      module RequestMacros
+        def ok!(body)
+          [200, {}, body.to_json]
+        end
+
+        def error!(body)
+          [400, {}, body.to_json]
+        end
+
+        def params(env)
+          @params ||= begin
+            parsed_query = Faraday::Utils.parse_nested_query(env[:body])
+
+            if parsed_query
+              parsed_query.with_indifferent_access.merge(env[:params])
+            else
+              env[:params].with_indifferent_access
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,290 @@
+--- !ruby/object:Gem::Specification
+name: castle-her
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Rémi Prévost
+- Filip Tepper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Her is an ORM that maps REST resources and collections to Ruby objects
+email:
+- remi@exomel.com
+- filip@tepper.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- UPGRADE.md
+- castle-her.gemspec
+- gemfiles/Gemfile.activemodel-3.2.x
+- gemfiles/Gemfile.activemodel-4.0
+- gemfiles/Gemfile.activemodel-4.1
+- gemfiles/Gemfile.activemodel-4.2
+- gemfiles/Gemfile.activemodel-5.0.x
+- lib/castle-her.rb
+- lib/castle-her/api.rb
+- lib/castle-her/collection.rb
+- lib/castle-her/errors.rb
+- lib/castle-her/json_api/model.rb
+- lib/castle-her/middleware.rb
+- lib/castle-her/middleware/accept_json.rb
+- lib/castle-her/middleware/first_level_parse_json.rb
+- lib/castle-her/middleware/json_api_parser.rb
+- lib/castle-her/middleware/parse_json.rb
+- lib/castle-her/middleware/second_level_parse_json.rb
+- lib/castle-her/model.rb
+- lib/castle-her/model/associations.rb
+- lib/castle-her/model/associations/association.rb
+- lib/castle-her/model/associations/association_proxy.rb
+- lib/castle-her/model/associations/belongs_to_association.rb
+- lib/castle-her/model/associations/has_many_association.rb
+- lib/castle-her/model/associations/has_one_association.rb
+- lib/castle-her/model/attributes.rb
+- lib/castle-her/model/base.rb
+- lib/castle-her/model/deprecated_methods.rb
+- lib/castle-her/model/http.rb
+- lib/castle-her/model/introspection.rb
+- lib/castle-her/model/nested_attributes.rb
+- lib/castle-her/model/orm.rb
+- lib/castle-her/model/parse.rb
+- lib/castle-her/model/paths.rb
+- lib/castle-her/model/relation.rb
+- lib/castle-her/version.rb
+- spec/api_spec.rb
+- spec/collection_spec.rb
+- spec/json_api/model_spec.rb
+- spec/middleware/accept_json_spec.rb
+- spec/middleware/first_level_parse_json_spec.rb
+- spec/middleware/json_api_parser_spec.rb
+- spec/middleware/second_level_parse_json_spec.rb
+- spec/model/associations/association_proxy_spec.rb
+- spec/model/associations_spec.rb
+- spec/model/attributes_spec.rb
+- spec/model/callbacks_spec.rb
+- spec/model/dirty_spec.rb
+- spec/model/http_spec.rb
+- spec/model/introspection_spec.rb
+- spec/model/nested_attributes_spec.rb
+- spec/model/orm_spec.rb
+- spec/model/parse_spec.rb
+- spec/model/paths_spec.rb
+- spec/model/relation_spec.rb
+- spec/model/validations_spec.rb
+- spec/model_spec.rb
+- spec/spec_helper.rb
+- spec/support/extensions/array.rb
+- spec/support/extensions/hash.rb
+- spec/support/macros/her_macros.rb
+- spec/support/macros/model_macros.rb
+- spec/support/macros/request_macros.rb
+homepage: http://her-rb.org
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple Representational State Transfer-based Hypertext Transfer Protocol-powered
+  Object Relational Mapper. Her?
+test_files:
+- spec/api_spec.rb
+- spec/collection_spec.rb
+- spec/json_api/model_spec.rb
+- spec/middleware/accept_json_spec.rb
+- spec/middleware/first_level_parse_json_spec.rb
+- spec/middleware/json_api_parser_spec.rb
+- spec/middleware/second_level_parse_json_spec.rb
+- spec/model/associations/association_proxy_spec.rb
+- spec/model/associations_spec.rb
+- spec/model/attributes_spec.rb
+- spec/model/callbacks_spec.rb
+- spec/model/dirty_spec.rb
+- spec/model/http_spec.rb
+- spec/model/introspection_spec.rb
+- spec/model/nested_attributes_spec.rb
+- spec/model/orm_spec.rb
+- spec/model/parse_spec.rb
+- spec/model/paths_spec.rb
+- spec/model/relation_spec.rb
+- spec/model/validations_spec.rb
+- spec/model_spec.rb
+- spec/spec_helper.rb
+- spec/support/extensions/array.rb
+- spec/support/extensions/hash.rb
+- spec/support/macros/her_macros.rb
+- spec/support/macros/model_macros.rb
+- spec/support/macros/request_macros.rb