cyrax 0.3.7 → 0.3.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWZlN2M4YjZiODVmYWUwNzQ4YjEzODRjZTZiOGJlZWI4NjcxZmI1Nw==
+    NGUwYzA1NjdmZDE3NTA2M2EzNDMzN2RmNmE3NWU3YmZjYTdjYWQ0NA==
   data.tar.gz: !binary |-
-    OGY1YjU5YmJkNTBkYWFiODc1NzVkMDMwMmU5Mzg2ZGQxZThkOWY2Ng==
+    ZTM5YWUzZWQ4YjViY2ZmZmY4MWMzZTI2NDgxNzIxNjNjZTAxNDBhZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NDdjMjg3MjI1ODkzZjk4MjRmODJhNzNjNjNlOWZkZTkwOWRlY2FlMjFmZWI0
-    YzY4MzE0ZDRiZmMxNDQ0NTdmODZkNzA2Y2RhMzJjNzI2MjZmYzA3ODMwN2M3
-    NDAzOGEwMDQ4NjY5ZThjYTI2NzEyYzkyNTNjZDM1NTllNTNmZGE=
+    Yzg2M2I5MzRlYjhjYWNlMTZmZTczYTZhNTA4YjEzN2YwZjk1OWE5OWY2M2Y1
+    M2E1ZmVmNDI2NjM0MzI3Y2FmZDE4Y2YyNWMwNWIwOTAyY2Q2YjA1NWZiNDcz
+    YTAwMmFhMmUzZDA3ODYyYTEyMDQ1MWUyMjg5N2U2NmVhNzBmODg=
   data.tar.gz: !binary |-
-    OTZlNmRiZjJlNzcwZThhMGFlMzRkMGFiY2NhNmQ3NDU0MGI4ZDgxNmJkODNm
-    NGMyNzRhZTc0MDM1MjYyMDY5MGE2NjY5MDVhMjY3N2ZmODU2NGE5ZjJhNjVl
-    MzQ2Yzg2NTBkZWRkMDY3NzNhODBlNTlmMWE5ZTBiNGI3MzMyZWM=
+    YjYzNWRjZDgxMmMxYThhNDI4MWFhMGNkZGI1ZGIzZmZiYTE0MDdiZTQ2MmQw
+    MzIyZjQ2YTc4YzU4MzgyNjNiNmNkNzJkM2JjZTFlNTliZjE3NzBmNmUwN2Rj
+    OGRjZDI3OGFhMzNmNTBhNGYzNWI1NmMxMTAzYmQzN2NkOGIyOGU=

data/lib/cyrax/base.rb

@@ -5,6 +5,14 @@ class Cyrax::Base
 
   attr_accessor :params, :accessor
 
+  # Creates a new Cyrax resource
+  #
+  # @param options [Hash] Options to pass in. You need `:as` and `:params`
+  #   :as defines the accessor
+  #   :params are parameters passed by the controller usually
+  #
+  # @example Instantiating a new resource
+  #     Products::UserResource.new(as: current_user, params: params)
   def initialize(options = {})
     @accessor = options[:as]
     @params = options[:params]

data/lib/cyrax/extensions/has_resource.rb

@@ -9,6 +9,7 @@ module Cyrax::Extensions
       class_attribute :collection_name
     end
 
+    # Returns the resource class as a constant - e.g. Product
     def resource_class
       if self.resource_class_name
         self.resource_class_name.constantize
@@ -17,6 +18,15 @@ module Cyrax::Extensions
       end
     end
 
+    # Returns the resource class - e.g. Product
+    # If you want your resource to return something interesting, you should override this in your resource by defining the method and returning your own scope
+    #
+    # @example Overriding resource_scope
+    #   class Products::UserResource < Products::BaseResource
+    #     def resource_scope
+    #       accessor.products
+    #     end
+    #   end
     def resource_scope
       resource_class
     end
@@ -30,6 +40,13 @@ module Cyrax::Extensions
     end
 
     module ClassMethods
+
+      # Class method for setting all the attributes that you want to access in the resource
+      #
+      # @example
+      #   accessible_attributes :description, :model, :price_in_cents, :vendor
+      #
+      # @param attrs [Array(Symbol)] Symbols of the attributes
       def accessible_attributes(*attrs)
         if attrs.blank?
           @accessible_attributes || []
@@ -39,6 +56,13 @@ module Cyrax::Extensions
         end
       end
 
+      # Class method for setting the resource that you want to access
+      #
+      # @example
+      #   resource :product
+      #
+      # @param name [Symbol] The name of the resource
+      # @param options Hash [Hash] Options
       def resource(name, options = {})
         self.resource_name = name.to_s
         self.resource_class_name = options[:class_name]

data/lib/cyrax/extensions/has_response.rb

@@ -36,6 +36,9 @@ module Cyrax::Extensions
       self.class.name.demodulize.underscore
     end
 
+    # Generates the response for to pass to the Rails controller
+    # @param result The data you want to respond with - can be an Active Record Relation, the class of the Model itself (e.g. Product)
+    # @param options [Hash] Options
     def respond_with(result, options = {})
       options[:as] ||= accessor
       name = options[:name] || response_name
@@ -43,7 +46,7 @@ module Cyrax::Extensions
       if respond_to?(:decorable?) && decorable?
         options = {decorator: decorator_class}.merge(options)
       end
-      if respond_to?(:seializable?) && seializable?
+      if respond_to?(:serializable?) && serializable?
         options = {serializer: serializer_class}.merge(options)
       end
       result = Cyrax::Presenter.present(result, options)

data/lib/cyrax/extensions/has_serializer.rb

@@ -6,7 +6,7 @@ module Cyrax::Extensions
       class_attribute :serializer_class_name
     end
 
-    def seializable?
+    def serializable?
       !self.class.serializer_class_name.nil?
     end
 

data/lib/cyrax/extensions/has_service.rb

@@ -2,17 +2,27 @@ module Cyrax::Extensions
   module HasService
     extend ActiveSupport::Concern
 
+    # Builds and returns a collection response for Rails
+    # @return [Cyrax::Response] response
     def collection
       respond_with build_collection, name: collection_name, present: :collection
     end
+    # Overrides collection with read_all
     alias_method :read_all, :collection
     alias_method :read_all!, :collection
 
+    # Builds a new resource without saving to DB
+    # Runs Model.new (before saving)
+    # Used for :new action in controller
+    # @return [Cyrax::Response] response
     def build
       respond_with build_resource(nil)
     end
     alias_method :build!, :build
 
+    # Creates a new resource and persists to DB
+    # Used for :create action in controller
+    # @return [Cyrax::Response] response
     def create(custom_attributes = nil, &block)
       resource = build_resource(nil, custom_attributes||resource_attributes)
       transaction do
@@ -31,6 +41,9 @@ module Cyrax::Extensions
     end
     alias_method :create!, :create
 
+    # Reads a single item from the DB
+    # Used for :show action in controller
+    # @return [Cyrax::Response] response
     def read
       respond_with find_resource(params[:id])
     end
@@ -38,7 +51,9 @@ module Cyrax::Extensions
     alias_method :edit, :read
     alias_method :edit!, :read
 
-
+    # Updates a single item and persists to DB
+    # Used for :update action in controller
+    # @return [Cyrax::Response] response
     def update(custom_attributes = nil, &block)
       resource = build_resource(params[:id], custom_attributes||resource_attributes)
       transaction do
@@ -57,6 +72,9 @@ module Cyrax::Extensions
     end
     alias_method :update!, :update
 
+    # Destroys a resource from the DB
+    # Used for :destroy action in controller
+    # @return [Cyrax::Response] response
     def destroy(&block)
       resource = find_resource(params[:id])
       transaction do
@@ -69,10 +87,17 @@ module Cyrax::Extensions
     end
     alias_method :destroy!, :destroy
 
+    # Finds and returns a single item from the DB
+    # @param id [int] ID of item
+    # @return [object] The object
     def find_resource(id)
       resource_scope.find(id)
     end
 
+    # Instantiates the resource
+    # @param id [int] ID or nil if you want a new object
+    # @param attributes [hash] Attributes you want to add to the resource
+    # @return [object] The object
     def build_resource(id, attributes = {})
       if id.present?
         resource = find_resource(id)
@@ -83,14 +108,25 @@ module Cyrax::Extensions
       end
     end
 
+    # Saves a resource
+    # @param resource [object] The resource to save
     def save_resource(resource)
       resource.save
     end
 
+    # Remove a resource
+    # Calls destroy method on resource
+    # @param resource [object] The resource to destroy
     def delete_resource(resource)
       resource.destroy
     end
 
+    # Returns a collection of the resource we are calling.
+    #
+    # If you want your resource to return something interesting, you should override the resource_scope method.
+    # Otherwise by default it will return the constantized model name and it will call .all on it during presentation.
+    #
+    # @return [type] The collection
     def build_collection
       resource_scope
     end

data/lib/cyrax/serializer.rb

@@ -13,6 +13,16 @@ class Cyrax::Serializer < Cyrax::Wrapper
       scope.namespace(name, &block)
     end
 
+    def relation(name, &block)
+      scope.relation(name, &block)
+    end
+    alias_method :has_many, :relation
+    alias_method :has_one, :relation
+
+    def default_attributes
+      scope.default_attributes
+    end
+
     def attributes(*attrs)
       scope.attributes(*attrs)
     end

data/lib/cyrax/serializers/scope.rb

@@ -3,11 +3,26 @@ module Cyrax::Serializers
     def initialize(&block)
       @attrs = {}
       @dynamic_attrs = {}
+      @relation_attrs = {}
+      @namespace_attrs = {}
+      @default_attributes = false
       instance_eval(&block) if block_given?
     end
 
     def namespace(name, &block)
-      @attrs[name] = self.class.new(&block)
+      @namespace_attrs[name] = self.class.new(&block)
+    end
+
+    def relation(attribute, &block)
+      if block_given?
+        @relation_attrs[attribute] = self.class.new(&block)
+      else
+        @attrs[attribute] = attribute
+      end
+    end
+
+    def default_attributes
+      @default_attributes = true
     end
 
     def attributes(*attrs)
@@ -25,8 +40,8 @@ module Cyrax::Serializers
     end
 
     def serialize(resource, options = {})
-      if resource.is_a?(Array)
-        resource.map{ |r| serialize_one(r, options) }
+      if resource.respond_to?(:to_a)
+        resource.to_a.map{ |r| serialize_one(r, options) }
       else
         serialize_one(resource, options)
       end
@@ -34,16 +49,22 @@ module Cyrax::Serializers
 
     def serialize_one(resource, options = {})
       result = {}
-      @attrs.map do |attribute, options|
-        value = resource.send(attribute)
-        if options.is_a?(Cyrax::Serializers::Scope)
-          value = options.serialize(value)
-        end
-        result[attribute] = value
+      if @default_attributes
+        result = resource.attributes rescue {}
       end
       @dynamic_attrs.map do |attribute, block|
         result[attribute] = options[:serializer].instance_exec(resource, &block)
       end
+      @relation_attrs.map do |attribute, scope|
+        value = resource.send(attribute)
+        result[attribute] = scope.serialize(value)
+      end
+      @namespace_attrs.map do |attribute, scope|
+        result[attribute] = scope.serialize(resource)
+      end
+      @attrs.map do |attribute, options|
+        result[attribute] = resource.send(attribute)
+      end
       result
     end
   end

data/lib/cyrax/version.rb

@@ -1,3 +1,3 @@
 module Cyrax
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
 end

data/spec/cyrax/serializer_spec.rb

@@ -5,16 +5,26 @@ class FooSerializer < Cyrax::Serializer
   namespace :some do
     attributes :foo, :bar
   end
+  relation :another do
+    attributes :another_foo, :another_bar
+  end
 end
 
 module Cyrax
   describe FooSerializer do
-    let(:serializable) { double(name: 'me', some: double(foo: '1234', bar: '1234')) }
+    let(:serializable) { 
+      double(
+        name: 'me',
+        foo: '2342',
+        bar: '4223',
+        another: double(another_foo: '1234', another_bar: '1234')) 
+    }
     subject { FooSerializer.new(serializable).serialize }
 
     it 'should serialize object' do
       subject[:name].should eq('me')
-      subject[:some][:foo].should eq('1234')
+      subject[:some][:foo].should eq('2342')
+      subject[:another][:another_foo].should eq('1234')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cyrax
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Droidlabs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport