her 0.5.5 → 0.6

data/spec/model/paths_spec.rb

@@ -194,7 +194,7 @@ describe Her::Model::Paths do
 
     describe "fetching a collection" do
       it "maps a collection of resources to an array of Ruby objects" do
-        @users = Foo::User.all(:_organization_id => 2)
+        @users = Foo::User.where(:_organization_id => 2).all
         @users.length.should == 2
         @users.first.fullname.should == "Tobias Fünke"
       end
@@ -285,7 +285,7 @@ describe Her::Model::Paths do
 
     describe "fetching a collection" do
       it "maps a collection of resources to an array of Ruby objects" do
-        @users = Foo::User.all(:_organization_id => 2)
+        @users = Foo::User.where(:_organization_id => 2).all
         @users.length.should == 2
         @users.first.fullname.should == "Tobias Fünke"
       end
@@ -303,7 +303,7 @@ describe Her::Model::Paths do
     describe "fetching a collection with absolute path" do
       it "maps a collection of resources to an array of Ruby objects" do
         Foo::User.collection_path '/api/' + Foo::User.collection_path
-        @users = Foo::User.all(:_organization_id => 2)
+        @users = Foo::User.where(:_organization_id => 2).all
         @users.length.should == 2
         @users.first.fullname.should == "Tobias Fünke"
       end

data/spec/model/relation_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Her::Model::Relation do
+  describe :where 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") { |env| ok! [{ :id => 1, :fullname => "Tobias Fünke" }, { :id => 2, :fullname => "Lindsay Fünke" }] }
+          stub.get("/users?admin=1") { |env| ok! [{ :id => 1, :fullname => "Tobias Fünke" }] }
+        end
+      end
+
+      spawn_model "Foo::User"
+    end
+
+    it "doesn't fetch the data immediatly" do
+      Her::Model::Relation.any_instance.should_receive(:fetch).never
+      @users = Foo::User.where(:admin => 1)
+    end
+
+    it "fetches the data and passes query parameters" do
+      Her::Model::Relation.any_instance.should_receive(:fetch).once.and_call_original
+      @users = Foo::User.where(:admin => 1)
+      @users.length.should == 2
+    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
+        @user.id.should == 1
+        @user.fullname.should == "Tobias Fünke"
+        @user.email.should == "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")
+        @user.id.should == 1
+        @user.fullname.should == "Tobias Fünke"
+        @user.email.should == "tobias@bluth.com"
+      end
+    end
+  end
+
+  describe "#page and #per_page" 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&per_page=1") { |env| ok! [{ :id => 2, :fullname => "Lindsay Fünke" }] }
+        end
+      end
+
+      spawn_model "Foo::User"
+    end
+
+    it "passes the pagination parameters" do
+      @user = Foo::User.page(2).per_page(1).first
+      @user.id.should == 2
+    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
+      @new_user.new?.should be_true
+      @new_user.fullname.should == "Tobias Fünke"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ Dir[File.expand_path('../../spec/support/**/*.rb', __FILE__)].map(&method(:requi
 
 RSpec.configure do |config|
   config.include Her::Testing::Macros::ModelMacros
+  config.include Her::Testing::Macros::RequestMacros
 
   config.before :each do
     @spawned_models = []

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/request_macros.rb

@@ -0,0 +1,19 @@
+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 ||= Faraday::Utils.parse_query(env[:body]).with_indifferent_access
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: '0.6'
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -124,41 +124,6 @@ files:
 - README.md
 - Rakefile
 - UPGRADE.md
-- examples/grape-and-her/.env.default
-- examples/grape-and-her/Procfile
-- examples/grape-and-her/README.md
-- examples/grape-and-her/api/Gemfile
-- examples/grape-and-her/api/Rakefile
-- examples/grape-and-her/api/app/api.rb
-- examples/grape-and-her/api/app/models/organization.rb
-- examples/grape-and-her/api/app/models/user.rb
-- examples/grape-and-her/api/app/views/organizations/_base.rabl
-- examples/grape-and-her/api/app/views/organizations/index.rabl
-- examples/grape-and-her/api/app/views/organizations/show.rabl
-- examples/grape-and-her/api/app/views/users/_base.rabl
-- examples/grape-and-her/api/app/views/users/index.rabl
-- examples/grape-and-her/api/app/views/users/show.rabl
-- examples/grape-and-her/api/config.ru
-- examples/grape-and-her/api/config/boot.rb
-- examples/grape-and-her/api/config/unicorn.rb
-- examples/grape-and-her/api/db/migrations/001_create_users.rb
-- examples/grape-and-her/api/db/migrations/002_create_organizations.rb
-- examples/grape-and-her/consumer/Gemfile
-- examples/grape-and-her/consumer/app/assets/stylesheets/application.scss
-- examples/grape-and-her/consumer/app/assets/stylesheets/reset.scss
-- examples/grape-and-her/consumer/app/consumer.rb
-- examples/grape-and-her/consumer/app/models/organization.rb
-- examples/grape-and-her/consumer/app/models/user.rb
-- examples/grape-and-her/consumer/app/views/index.haml
-- examples/grape-and-her/consumer/app/views/layout.haml
-- examples/grape-and-her/consumer/app/views/organizations/index.haml
-- examples/grape-and-her/consumer/app/views/organizations/show.haml
-- examples/grape-and-her/consumer/app/views/users/index.haml
-- examples/grape-and-her/consumer/app/views/users/show.haml
-- examples/grape-and-her/consumer/config.ru
-- examples/grape-and-her/consumer/config/boot.rb
-- examples/grape-and-her/consumer/config/unicorn.rb
-- examples/grape-and-her/consumer/lib/response_logger.rb
 - her.gemspec
 - lib/her.rb
 - lib/her/api.rb
@@ -171,6 +136,10 @@ files:
 - lib/her/middleware/second_level_parse_json.rb
 - lib/her/model.rb
 - lib/her/model/associations.rb
+- lib/her/model/associations/association.rb
+- lib/her/model/associations/belongs_to_association.rb
+- lib/her/model/associations/has_many_association.rb
+- lib/her/model/associations/has_one_association.rb
 - lib/her/model/attributes.rb
 - lib/her/model/base.rb
 - lib/her/model/http.rb
@@ -179,6 +148,7 @@ files:
 - lib/her/model/orm.rb
 - lib/her/model/parse.rb
 - lib/her/model/paths.rb
+- lib/her/model/relation.rb
 - lib/her/version.rb
 - spec/api_spec.rb
 - spec/collection_spec.rb
@@ -195,12 +165,15 @@ files:
 - 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://remiprev.github.com/her
 licenses:
 - MIT
@@ -242,9 +215,12 @@ test_files:
 - 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

data/examples/grape-and-her/.env.default

@@ -1,3 +0,0 @@
-RACK_ENV=development
-API_PORT=3100
-CONSUMER_PORT=3200

data/examples/grape-and-her/Procfile

@@ -1,2 +0,0 @@
-api: ruby -C ./api -S bundle exec unicorn -p $API_PORT -c ./config/unicorn.rb -E $RACK_ENV
-consumer: ruby -C ./consumer -S bundle exec unicorn -p $CONSUMER_PORT -c ./config/unicorn.rb -E $RACK_ENV

data/examples/grape-and-her/README.md

@@ -1,27 +0,0 @@
-# Grape + Her example
-
-This is an example of how to use Her to consume a simple API. It consists of two separate applications, a REST API (powered by `grape` and `activerecord`) and a consumer application (powered by `sinatra` and `her`).
-
-![](http://i.imgur.com/AGfYwzl.png)
-
-## Installation and Usage
-
-```shell
-# Clone the repository
-$ git clone git://github.com/remiprev/her.git
-
-# Go to the example directory
-$ cd her/examples/grape-and-her
-
-# Go to each application and run `bundle install`
-$ cd api; bundle install; cd ..
-$ cd consumer; bundle install; cd ..
-
-# Create the API database
-$ cd api; sqlite3 db/development.db ""; bundle exec rake db:migrate; cd ..
-
-# Start foreman with the Procfile
-$ foreman start
-```
-
-This should start the API on `http://0.0.0.0:3100` and the consumer on `http://0.0.0.0:3200`

data/examples/grape-and-her/api/Gemfile

@@ -1,11 +0,0 @@
-source 'https://rubygems.org'
-
-# Server
-gem 'unicorn'
-
-# App
-gem 'grape'
-gem 'sqlite3'
-gem 'activerecord', '~> 3.2'
-gem 'portugal'
-gem 'grape-rabl'

data/examples/grape-and-her/api/Rakefile

@@ -1,14 +0,0 @@
-require 'portugal/tasks'
-Portugal.configure do |config|
-  config.migrations_path = File.expand_path("../db/migrations", __FILE__)
-end
-
-# This task is called before Portugal executes its tasks.
-# It should require ActiveRecord somehow and establish the database connection
-#
-# Change it so it works for your application
-task :environment do
-  require 'bundler'
-  Bundler.require
-  ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: File.expand_path('../db/development.db', __FILE__)
-end

data/examples/grape-and-her/api/app/api.rb

@@ -1,49 +0,0 @@
-class API < Grape::API
-  content_type :json, "application/json; charset=UTF-8"
-  format :json
-  formatter :json, Grape::Formatter::Rabl
-  use(Rack::Config) { |env| env['api.tilt.root'] = File.expand_path('../views',  __FILE__) }
-  rescue_from :all
-
-  resources :users do
-    desc 'Return all users'
-    get nil, :rabl => "users/index" do
-      @users = User.all
-    end
-
-    desc 'Return a specific user'
-    get ':id', :rabl => "users/show" do
-      @user = User.find(params[:id])
-    end
-
-    desc 'Create a new user'
-    post nil, :rabl => "users/show" do
-      @user = User.new(params[:user])
-      error!({ :errors => @user.errors.full_messages }, 400) unless @user.save
-    end
-  end
-
-  resources :organizations do
-    desc 'Return all organizations'
-    get nil, :rabl => "organizations/index" do
-      @organizations = Organization.all
-    end
-
-    desc 'Return a specific organization'
-    get ':id', :rabl => "organizations/show" do
-      @organization = Organization.find(params[:id])
-    end
-
-    desc 'Return all users for specific organization'
-    get ':id/users', :rabl => "users/index" do
-      organization = Organization.find(params[:id])
-      @users = organization.users
-    end
-
-    desc 'Create a new organization'
-    post nil, :rabl => "organizations/show" do
-      @organization = Organization.new(params[:organization])
-      error!({ :errors => @organization.errors.full_messages }, 400) unless @organization.save
-    end
-  end
-end

data/examples/grape-and-her/api/app/models/organization.rb

@@ -1,7 +0,0 @@
-class Organization < ActiveRecord::Base
-  # Associations
-  has_many :users
-
-  # Validations
-  validates :name, presence: true
-end

data/examples/grape-and-her/api/app/models/user.rb

@@ -1,9 +0,0 @@
-class User < ActiveRecord::Base
-  # Associations
-  belongs_to :organization
-
-  # Validations
-  validates :email, presence: true
-  validates :fullname, presence: true
-  validates :organization, presence: true
-end

data/examples/grape-and-her/api/app/views/organizations/_base.rabl

@@ -1,2 +0,0 @@
-attribute :id
-attribute :name

data/examples/grape-and-her/api/app/views/organizations/index.rabl

@@ -1,3 +0,0 @@
-collection @organizations
-
-extends("organizations/base")

data/examples/grape-and-her/api/app/views/organizations/show.rabl

@@ -1,3 +0,0 @@
-object @organization
-
-extends("organizations/base")

data/examples/grape-and-her/api/app/views/users/_base.rabl

@@ -1,8 +0,0 @@
-attribute :id
-attribute :email
-attribute :fullname
-attribute :organization_id
-
-child :organization do
-  extends("organizations/base")
-end

data/examples/grape-and-her/api/app/views/users/index.rabl

@@ -1,3 +0,0 @@
-collection @users
-
-extends("users/base")

data/examples/grape-and-her/api/app/views/users/show.rabl

@@ -1,3 +0,0 @@
-object @user
-
-extends("users/base")

data/examples/grape-and-her/api/config.ru

@@ -1,5 +0,0 @@
-require File.expand_path('../config/boot',  __FILE__)
-
-map "/" do
-  run API
-end