active_remote 1.7.1 → 1.8.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e0a0b815dc24d0ba8c884b135055cc9fb42fbc0
-  data.tar.gz: 59144b3bb85ecebf7e660e0b5a93a27db60f7751
+  metadata.gz: f15daf36d3c8b8835e43b8fdbb36558e9272bf62
+  data.tar.gz: ac509c0f6b2a10444c9b7fe1c8fc6a29dec7350e
 SHA512:
-  metadata.gz: ac81f4a6f6f7206306e2712a0fb5fe6d90f72228ce63667f480f609d32243e3bee20ad3465cd2766893994ee01c34733a411c9ee5e047cb89781de47d4262d78
-  data.tar.gz: 471a29c7b76006c8d8fd86835196a3ad5dbbbe76c419c9e5cca6d7f1b86e195fb9b2b149185348fa34df1e8875aba8260a9821838e689ced9d75c9b2b0cd3062
+  metadata.gz: 30d4f0bef9362330f7a52adf478766d4a4c9a24c4a9b1e92c359d12f4824444b4d4a55b9a78e85fbfc70f448086dd366467dba82952d99728e552c1635e7d13b
+  data.tar.gz: 3f65730eb838053732644492642d4bd32d69d82cfe1be1452b75be61c08ca8f95212832364844d1b31c9b3acc885f7d09c2fcbfb0aeb5f4be873ef9bd01b767f

data/lib/active_remote/association.rb

@@ -39,9 +39,12 @@ module ActiveRemote
       #
       def belongs_to(belongs_to_klass, options={})
         perform_association(belongs_to_klass, options) do |klass, object|
-          foreign_key = options.fetch(:foreign_key) { :"#{belongs_to_klass}_guid" }
-          association_guid = object.read_attribute(foreign_key)
-          klass.search(:guid => association_guid).first if association_guid
+          foreign_key = options.fetch(:foreign_key) { :"#{klass.name.demodulize.underscore}_guid" }
+          search_hash = {}
+          search_hash[:guid] = object.read_attribute(foreign_key)
+          search_hash[options[:scope]] = object.read_attribute(options[:scope]) if options.has_key?(:scope)
+
+          search_hash.values.any?(&:nil?) ? nil : klass.search(search_hash).first
         end
       end
 
@@ -76,9 +79,13 @@ module ActiveRemote
       #   end
       #
       def has_many(has_many_class, options={})
-        perform_association( has_many_class, options ) do |klass, object|
+        perform_association(has_many_class, options) do |klass, object|
           foreign_key = options.fetch(:foreign_key) { :"#{object.class.name.demodulize.underscore}_guid" }
-          object.guid ? klass.search(foreign_key => object.guid) : []
+          search_hash = {}
+          search_hash[foreign_key] = object.guid
+          search_hash[options[:scope]] = object.read_attribute(options[:scope]) if options.has_key?(:scope)
+
+          search_hash.values.any?(&:nil?) ? [] : klass.search(search_hash)
         end
       end
 
@@ -99,8 +106,6 @@ module ActiveRemote
       #
       #   class User
       #     has_one :client
-      #   end
-      #
       # An equivalent code snippet without a `has_one` declaration would be:
       #
       # ====Examples
@@ -114,19 +119,34 @@ module ActiveRemote
       def has_one(has_one_klass, options={})
         perform_association(has_one_klass, options) do |klass, object|
           foreign_key = options.fetch(:foreign_key) { :"#{object.class.name.demodulize.underscore}_guid" }
-          klass.search(foreign_key => object.guid).first if object.guid
+          search_hash = {}
+          search_hash[foreign_key] = object.guid
+          search_hash[options[:scope]] = object.read_attribute(options[:scope]) if options.has_key?(:scope)
+
+          search_hash.values.any?(&:nil?) ? nil : klass.search(search_hash).first
         end
       end
 
+      # when requiring an attribute on your search, we verify the attribute
+      # exists on both models
+      def validate_scoped_attributes(associated_class, object_class, options)
+        raise "Could not find attribute: '#{options[:scope]}' on #{object_class}" unless object_class.public_instance_methods.include?(options[:scope])
+        raise "Could not find attribute: '#{options[:scope]}' on #{associated_class}" unless associated_class.public_instance_methods.include?(options[:scope])
+      end
+
     private
 
-      def perform_association(associated_klass, optionz={})
+      def perform_association(associated_klass, options={})
+
         define_method(associated_klass) do
+          klass_name = options.fetch(:class_name){ associated_klass }
+          klass = klass_name.to_s.classify.constantize
+
+          self.class.validate_scoped_attributes(klass, self.class, options) if options.has_key?(:scope)
+
           value = instance_variable_get(:"@#{associated_klass}")
 
           unless value
-            klass_name = optionz.fetch(:class_name){ associated_klass }
-            klass = klass_name.to_s.classify.constantize
             value = yield( klass, self )
             instance_variable_set(:"@#{associated_klass}", value)
           end
@@ -134,6 +154,7 @@ module ActiveRemote
           return value
         end
       end
+
     end
   end
 end

data/lib/active_remote/version.rb

@@ -1,3 +1,3 @@
 module ActiveRemote
-  VERSION = "1.7.1"
+  VERSION = "1.8.0.rc1"
 end

data/spec/lib/active_remote/association_spec.rb

@@ -7,8 +7,9 @@ describe ActiveRemote::Association do
   describe ".belongs_to" do
     context "simple association" do
       let(:author_guid) { "AUT-123" }
-
-      subject { Post.new(:author_guid => author_guid) }
+      let(:user_guid) { "USR-123" }
+      let(:default_category_guid) { "CAT-123" }
+      subject { Post.new(:author_guid => author_guid, :user_guid => user_guid) }
 
       it { should respond_to(:author) }
 
@@ -36,6 +37,32 @@ describe ActiveRemote::Association do
           subject.author.should be_nil
         end
       end
+
+      context 'scoped field' do
+        it { should respond_to(:user) }
+
+        it "searches the associated model for multiple records" do
+          Author.should_receive(:search).with(:guid => subject.author_guid, :user_guid => subject.user_guid).and_return(records)
+          subject.user.should eq(record)
+        end
+
+        context 'when user_guid doesnt exist on model 'do
+          before { subject.stub(:respond_to?).with("user_guid").and_return(false) }
+
+          it 'raises an error' do
+            expect {subject.user}.to raise_error
+          end
+        end
+
+        context 'when user_guid doesnt exist on associated model 'do
+          before { Author.stub_chain(:public_instance_methods, :include?).with(:user_guid).and_return(false) }
+
+          it 'raises an error' do
+            expect {subject.user}.to raise_error
+          end
+        end
+      end
+
     end
 
     context "specific association with class name" do
@@ -46,19 +73,19 @@ describe ActiveRemote::Association do
 
       it "searches the associated model for a single record" do
         Author.should_receive(:search).with(:guid => subject.author_guid).and_return(records)
-        subject.author.should eq record
+        subject.coauthor.should eq record
       end
     end
 
     context "specific association with class name and foreign_key" do
       let(:author_guid) { "AUT-456" }
 
-      subject { Post.new(:author_guid => author_guid) }
+      subject { Post.new(:bestseller_guid => author_guid) }
       it { should respond_to(:bestseller) }
 
       it "searches the associated model for a single record" do
         Author.should_receive(:search).with(:guid => subject.bestseller_guid).and_return(records)
-        subject.author.should eq record
+        subject.bestseller.should eq record
       end
     end
   end
@@ -66,8 +93,9 @@ describe ActiveRemote::Association do
   describe ".has_many" do
     let(:records) { [ record, record, record ] }
     let(:guid) { "AUT-123" }
+    let(:user_guid) { "USR-123" }
 
-    subject { Author.new(:guid => guid) }
+    subject { Author.new(:guid => guid, :user_guid => user_guid) }
 
     it { should respond_to(:posts) }
 
@@ -113,55 +141,112 @@ describe ActiveRemote::Association do
         subject.bestseller_posts.should eq(records)
       end
     end
+
+    context 'scoped field' do
+      it { should respond_to(:user_posts) }
+
+      it "searches the associated model for multiple records" do
+        Post.should_receive(:search).with(:author_guid => subject.guid, :user_guid => subject.user_guid).and_return(records)
+        subject.user_posts.should eq(records)
+      end
+
+      context 'when user_guid doesnt exist on model 'do
+        before { subject.stub(:respond_to?).with("user_guid").and_return(false) }
+
+        it 'raises an error' do
+          expect {subject.user_posts}.to raise_error
+        end
+      end
+
+      context 'when user_guid doesnt exist on associated model 'do
+        before { Post.stub_chain(:public_instance_methods, :include?).with(:user_guid).and_return(false) }
+
+        it 'raises an error' do
+          expect {subject.user_posts}.to raise_error
+        end
+      end
+    end
   end
 
   describe ".has_one" do
-    let(:guid) { "PST-123" }
+    let(:guid) { "CAT-123" }
+    let(:user_guid) { "USR-123" }
+    let(:category_attributes) {
+      {
+        :guid => guid,
+        :user_guid => user_guid
+      }
+    }
 
-    subject { Post.new(:guid => guid) }
+    subject { Category.new(category_attributes) }
 
-    it { should respond_to(:category) }
+    it { should respond_to(:author) }
 
     it "searches the associated model for all associated records" do
-      Category.should_receive(:search).with(:post_guid => subject.guid).and_return(records)
-      subject.category.should eq record
+      Author.should_receive(:search).with(:category_guid => subject.guid).and_return(records)
+      subject.author.should eq record
     end
 
     it "memoizes the result record" do
-      Category.should_receive(:search).once.with(:post_guid => subject.guid).and_return(records)
-      3.times { subject.category.should eq record }
+      Author.should_receive(:search).once.with(:category_guid => subject.guid).and_return(records)
+      3.times { subject.author.should eq record }
     end
 
     context "when guid is nil" do
-      subject { Post.new }
+      subject { Category.new }
 
       it "returns nil" do
-        subject.category.should be_nil
+        subject.author.should be_nil
       end
     end
 
     context "when the search is empty" do
       it "returns a nil value" do
-        Category.should_receive(:search).with(:post_guid => subject.guid).and_return([])
-        subject.category.should be_nil
+        Author.should_receive(:search).with(:category_guid => subject.guid).and_return([])
+        subject.author.should be_nil
       end
     end
 
     context "specific association with class name" do
-      it { should respond_to(:main_category) }
+      it { should respond_to(:senior_author) }
 
       it "searches the associated model for a single record" do
-        Category.should_receive(:search).with(:post_guid => subject.guid).and_return(records)
-        subject.main_category.should eq record
+        Author.should_receive(:search).with(:category_guid => subject.guid).and_return(records)
+        subject.senior_author.should eq record
       end
     end
 
     context "specific association with class name and foreign_key" do
-      it { should respond_to(:default_category) }
+      it { should respond_to(:primary_editor) }
 
       it "searches the associated model for a single record" do
-        Category.should_receive(:search).with(:template_post_guid => subject.guid).and_return(records)
-        subject.default_category.should eq record
+        Author.should_receive(:search).with(:editor_guid => subject.guid).and_return(records)
+        subject.primary_editor.should eq record
+      end
+    end
+
+    context 'scoped field' do
+      it { should respond_to(:chief_editor) }
+
+      it "searches the associated model for multiple records" do
+        Author.should_receive(:search).with(:chief_editor_guid => subject.guid, :user_guid => subject.user_guid).and_return(records)
+        subject.chief_editor.should eq(record)
+      end
+
+      context 'when user_guid doesnt exist on model 'do
+        before { subject.stub(:respond_to?).with("user_guid").and_return(false) }
+
+        it 'raises an error' do
+          expect {subject.chief_editor}.to raise_error
+        end
+      end
+
+      context 'when user_guid doesnt exist on associated model 'do
+        before { Author.stub_chain(:public_instance_methods, :include?).with(:user_guid).and_return(false) }
+
+        it 'raises an error' do
+          expect {subject.chief_editor}.to raise_error
+        end
       end
     end
   end

data/spec/support/definitions/author.proto

@@ -6,6 +6,7 @@ message Author {
   optional string guid = 1;
   optional string name = 2;
   repeated Error errors = 3;
+  optional string user_guid = 4;
 }
 
 message Authors {

data/spec/support/definitions/post.proto

@@ -3,12 +3,13 @@ package generic.remote;
 import "support/protobuf/error.proto";
 import "support/protobuf/category.proto";
 
-message Post { 
+message Post {
   optional string guid = 1;
   optional string name = 2;
   optional string author_guid = 3;
   optional Category category = 4;
   repeated Error errors = 5;
+  optional string user_guid = 6;
 }
 
 message Posts {
@@ -19,6 +20,7 @@ message PostRequest {
   repeated string guid = 1;
   repeated string name = 2;
   repeated string author_guid = 3;
+  repeated string user_guid = 4;
 }
 
 service PostService {

data/spec/support/definitions/support/protobuf/category.proto

@@ -2,10 +2,14 @@ package generic.remote;
 
 import "support/protobuf/error.proto";
 
-message Category { 
+message Category {
   optional string guid = 1;
   optional string name = 2;
   repeated Error errors = 3;
+  optional string user_guid = 4;
+  optional string author_guid = 4;
+  optional string chief_editor_guid = 4;
+  optional string editor_guid = 4;
 }
 
 message Categories {

data/spec/support/models/author.rb

@@ -8,9 +8,15 @@ class Author < ::ActiveRemote::Base
 
   attribute :guid
   attribute :name
+  attribute :user_guid
+  attribute :chief_editor_guid
+  attribute :editor_guid
+  attribute :category_guid
 
   has_many :posts
+  has_many :user_posts, :class_name => "::Post", :scope => :user_guid
   has_many :flagged_posts, :class_name => "::Post"
   has_many :bestseller_posts, :class_name => "::Post", :foreign_key => :bestseller_guid
 
+  belongs_to :category
 end

data/spec/support/models/category.rb

@@ -7,10 +7,14 @@ class Category < ::ActiveRemote::Base
   service_class ::Generic::Remote::CategoryService
 
   attribute :guid
-  attribute :name
-  attribute :post_id
+  attribute :user_guid
+  attribute :chief_editor_guid
 
-  belongs_to :post
+  has_many :posts
+
+  has_one :author
+  has_one :senior_author, :class_name => "::Author"
+  has_one :primary_editor, :class_name => "::Author", :foreign_key => :editor_guid
+  has_one :chief_editor, :class_name => "::Author", :scope => :user_guid, :foreign_key => :chief_editor_guid
 
-  alias_method :template_post_guid, :post_id
 end

data/spec/support/models/post.rb

@@ -9,13 +9,11 @@ class Post < ::ActiveRemote::Base
   attribute :guid
   attribute :name
   attribute :author_guid
+  attribute :user_guid
+  attribute :bestseller_guid
 
   belongs_to :author
   belongs_to :coauthor, :class_name => '::Author'
   belongs_to :bestseller, :class_name => '::Author', :foreign_key => :bestseller_guid
-  has_one :category
-  has_one :main_category, :class_name => '::Category'
-  has_one :default_category, :class_name => '::Category', :foreign_key => :template_post_guid
-
-  alias_method :bestseller_guid, :author_guid
+  belongs_to :user, :class_name => '::Author', :scope => :user_guid
 end

data/spec/support/protobuf/author.pb.rb

@@ -4,6 +4,7 @@
 require 'protobuf/message'
 require 'protobuf/rpc/service'
 
+
 ##
 # Imports
 #
@@ -11,14 +12,15 @@ require 'support/protobuf/error.pb'
 
 module Generic
   module Remote
-    
+
     ##
     # Message Classes
     #
     class Author < ::Protobuf::Message; end
     class Authors < ::Protobuf::Message; end
     class AuthorRequest < ::Protobuf::Message; end
-    
+
+
     ##
     # Message Fields
     #
@@ -26,19 +28,21 @@ module Generic
       optional ::Protobuf::Field::StringField, :guid, 1
       optional ::Protobuf::Field::StringField, :name, 2
       repeated ::Generic::Error, :errors, 3
+      optional ::Protobuf::Field::StringField, :user_guid, 4
     end
-    
+
     class Authors
       repeated ::Generic::Remote::Author, :records, 1
     end
-    
+
     class AuthorRequest
       repeated ::Protobuf::Field::StringField, :guid, 1
       repeated ::Protobuf::Field::StringField, :name, 2
     end
-    
+
+
     ##
-    # Services
+    # Service Classes
     #
     class AuthorService < ::Protobuf::Rpc::Service
       rpc :search, ::Generic::Remote::AuthorRequest, ::Generic::Remote::Authors
@@ -50,5 +54,8 @@ module Generic
       rpc :delete_all, ::Generic::Remote::Authors, ::Generic::Remote::Authors
       rpc :destroy_all, ::Generic::Remote::Authors, ::Generic::Remote::Authors
     end
+
   end
+
 end
+

data/spec/support/protobuf/post.pb.rb

@@ -4,6 +4,7 @@
 require 'protobuf/message'
 require 'protobuf/rpc/service'
 
+
 ##
 # Imports
 #
@@ -12,14 +13,15 @@ require 'support/protobuf/category.pb'
 
 module Generic
   module Remote
-    
+
     ##
     # Message Classes
     #
     class Post < ::Protobuf::Message; end
     class Posts < ::Protobuf::Message; end
     class PostRequest < ::Protobuf::Message; end
-    
+
+
     ##
     # Message Fields
     #
@@ -29,20 +31,23 @@ module Generic
       optional ::Protobuf::Field::StringField, :author_guid, 3
       optional ::Generic::Remote::Category, :category, 4
       repeated ::Generic::Error, :errors, 5
+      optional ::Protobuf::Field::StringField, :user_guid, 6
     end
-    
+
     class Posts
       repeated ::Generic::Remote::Post, :records, 1
     end
-    
+
     class PostRequest
       repeated ::Protobuf::Field::StringField, :guid, 1
       repeated ::Protobuf::Field::StringField, :name, 2
       repeated ::Protobuf::Field::StringField, :author_guid, 3
+      repeated ::Protobuf::Field::StringField, :user_guid, 4
     end
-    
+
+
     ##
-    # Services
+    # Service Classes
     #
     class PostService < ::Protobuf::Rpc::Service
       rpc :search, ::Generic::Remote::PostRequest, ::Generic::Remote::Posts
@@ -54,5 +59,8 @@ module Generic
       rpc :delete_all, ::Generic::Remote::Posts, ::Generic::Remote::Posts
       rpc :destroy_all, ::Generic::Remote::Posts, ::Generic::Remote::Posts
     end
+
   end
+
 end
+

data/spec/support/protobuf/tag.pb.rb

@@ -4,6 +4,7 @@
 require 'protobuf/message'
 require 'protobuf/rpc/service'
 
+
 ##
 # Imports
 #
@@ -11,14 +12,15 @@ require 'support/protobuf/error.pb'
 
 module Generic
   module Remote
-    
+
     ##
     # Message Classes
     #
     class Tag < ::Protobuf::Message; end
     class Tags < ::Protobuf::Message; end
     class TagRequest < ::Protobuf::Message; end
-    
+
+
     ##
     # Message Fields
     #
@@ -27,18 +29,19 @@ module Generic
       optional ::Protobuf::Field::StringField, :name, 2
       repeated ::Generic::Error, :errors, 3
     end
-    
+
     class Tags
       repeated ::Generic::Remote::Tag, :records, 1
     end
-    
+
     class TagRequest
       repeated ::Protobuf::Field::StringField, :guid, 1
       repeated ::Protobuf::Field::StringField, :name, 2
     end
-    
+
+
     ##
-    # Services
+    # Service Classes
     #
     class TagService < ::Protobuf::Rpc::Service
       rpc :search, ::Generic::Remote::TagRequest, ::Generic::Remote::Tags
@@ -50,5 +53,8 @@ module Generic
       rpc :delete_all, ::Generic::Remote::Tags, ::Generic::Remote::Tags
       rpc :destroy_all, ::Generic::Remote::Tags, ::Generic::Remote::Tags
     end
+
   end
+
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_remote
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0.rc1
 platform: ruby
 authors:
 - Adam Hutchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
@@ -235,12 +235,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Active Record for your platform