grape-entity 0.1.0 → 0.2.0

data/.gitignore

@@ -30,6 +30,7 @@ pkg
 .yardoc/*
 dist
 Gemfile.lock
+tmp
 
 ## Rubinius
 .rbx

data/README.markdown

@@ -1,17 +1,10 @@
-# GrapeEntity
+# Grape::Entity
 
-## CI
 [![Build Status](https://travis-ci.org/agileanimal/grape-entity.png?branch=master)](https://travis-ci.org/agileanimal/grape-entity)
 
 ## Introduction
 
-This gem is the Entity extracted out of [Grape](https://github.com/intridea/grape).
-
-Grape's Entity is a great idea: a API focussed Facade that sits on top of a model object.
-
-The intend is to allow the Entity to be used outside of Grape and provide additional exposure to parts of the entity needed to simplify testing parts of an API.
-
-We intend to use the specs from grape to ensure we maintain compatability with Grape through our changes so that we can use the Entity to replace Grape's internal Entity.
+This gem adds Entity support to API frameworks, such as [Grape](https://github.com/intridea/grape). Grape's Entity is an API focussed facade that sits on top of an object model.
 
 ## Goals
 
@@ -23,10 +16,6 @@ There is probably something heavier than an Entity that exists as well. A way to
 
 In this spirit I want to give Entities a life of their own.
 
-## Project Tracking
-
-* - Need to setup something up for this - 
-
 ## Reusable Responses with Entities
 
 Entities are a reusable means for converting Ruby objects to API responses.
@@ -35,7 +24,7 @@ ever larger responses, using inheritance.
 
 ### Defining Entities
 
-Entities inherit from GrapeEntity::Entity, and define a simple DSL. Exposures can use
+Entities inherit from Grape::Entity, and define a simple DSL. Exposures can use
 runtime options to determine which fields should be visible, these options are
 available to `:if`, `:unless`, and `:proc`. The option keys `:version` and `:collection`
 will always be defined. The `:version` key is defined as `api.version`. The
@@ -61,7 +50,7 @@ array.
 ```ruby
 module API
   module Entities
-    class Status < GrapeEntity::Entity
+    class Status < Grape::Entity
       expose :user_name
       expose :text, :documentation => { :type => "string", :desc => "Status update text." }
       expose :ip, :if => { :type => :full }
@@ -88,7 +77,7 @@ of an existing class:
 
 ```ruby
 class Status
-  include GrapeEntity::Entity::DSL
+  include Grape::Entity::DSL
 
   entity :text, :user_id do
     expose :detailed, if: :conditional
@@ -110,7 +99,7 @@ If the entity includes documentation it can be included in an endpoint's descrip
 
 ```ruby
 module API
-  class Statuses < GrapeEntity::API
+  class Statuses < Grape::API
     version 'v1'
 
     desc 'Statuses index', {
@@ -136,7 +125,7 @@ class Status
     Status.new(self)
   end
 
-  class Entity < GrapeEntity::Entity
+  class Entity < Grape::Entity
     expose :text, :user_id
   end
 end
@@ -157,7 +146,7 @@ However, when `object.check` equals "bar" both `field_b` and `foo` will be expos
 ```ruby
 module API
   module Entities
-    class Status < GrapeEntity::Entity
+    class Status < Grape::Entity
       expose :field_a, :foo, :if => lambda { |object, options| object.check == "foo" }
       expose :field_b, :foo, :if => lambda { |object, options| object.check == "bar" }
     end
@@ -170,7 +159,7 @@ This can be problematic, when you have mixed collections. Using `respond_to?` is
 ```ruby
 module API
   module Entities
-    class Status < GrapeEntity::Entity
+    class Status < Grape::Entity
       expose :field_a, :if => lambda { |object, options| object.check == "foo" }
       expose :field_b, :if => lambda { |object, options| object.check == "bar" }
       expose :foo, :if => lambda { |object, options| object.respond_to?(:foo) }

data/grape-entity.gemspec

@@ -7,21 +7,16 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Michael Bleigh"]
   s.email       = ["michael@intridea.com"]
-  s.homepage    = "https://github.com/intridea/grape"
+  s.homepage    = "https://github.com/agileanimal/grape-entity"
   s.summary     = %q{A simple facade for managing the relationship between your model and API.}
   s.description = %q{Extracted from Grape, A Ruby framework for rapid API development with great conventions.}
   s.license     = "MIT"
 
   s.rubyforge_project = "grape-entity"
 
-  # s.add_runtime_dependency 'activesupport'
-  # s.add_runtime_dependency 'rack-jsonp'
-  # s.add_runtime_dependency 'multi_json', '>= 1.3.2'
-  # s.add_runtime_dependency 'multi_xml', '>= 0.5.2'
-  # s.add_runtime_dependency 'hashie', '~> 1.2'
-  # s.add_runtime_dependency 'virtus'
-  # s.add_runtime_dependency 'builder'
-
+  s.add_runtime_dependency 'activesupport'
+  s.add_runtime_dependency 'multi_json', '>= 1.3.2'
+  
   s.add_development_dependency 'rake'
   s.add_development_dependency 'maruku'
   s.add_development_dependency 'yard'

data/lib/grape_entity.rb

@@ -1,5 +1,6 @@
 require "grape_entity/version"
 
-module GrapeEntity
+module Grape
   autoload :Entity, 'grape_entity/entity'
 end
+

data/lib/grape_entity/entity.rb

@@ -1,4 +1,4 @@
-module GrapeEntity
+module Grape
   # An Entity is a lightweight structure that allows you to easily
   # represent data from your application in a consistent and abstracted
   # way in your API. Entities can also provide documentation for the
@@ -8,7 +8,7 @@ module GrapeEntity
   #
   #   module API
   #     module Entities
-  #       class User < GrapeEntity::Entity
+  #       class User < Grape::Entity
   #         expose :first_name, :last_name, :screen_name, :location
   #         expose :field, :documentation => {:type => "string", :desc => "describe the field"}
   #         expose :latest_status, :using => API::Status, :as => :status, :unless => {:collection => true}
@@ -27,7 +27,7 @@ module GrapeEntity
   # @example Usage in the API Layer
   #
   #   module API
-  #     class Users < GrapeEntity::API
+  #     class Users < Grape::API
   #       version 'v2'
   #
   #       desc 'User index', { :object_fields => API::Entities::User.documentation }
@@ -47,7 +47,7 @@ module GrapeEntity
       def self.included(base)
         base.extend ClassMethods
         ancestor_entity_class = base.ancestors.detect{|a| a.entity_class if a.respond_to?(:entity_class)}
-        base.const_set(:Entity, Class.new(ancestor_entity_class || GrapeEntity::Entity)) unless const_defined?(:Entity)
+        base.const_set(:Entity, Class.new(ancestor_entity_class || Grape::Entity)) unless const_defined?(:Entity)
       end
 
       module ClassMethods
@@ -61,13 +61,13 @@ module GrapeEntity
 
         # Call this to make exposures to the entity for this Class.
         # Can be called with symbols for the attributes to expose,
-        # a block that yields the full Entity DSL (See GrapeEntity::Entity),
+        # a block that yields the full Entity DSL (See Grape::Entity),
         # or both.
         #
         # @example Symbols only.
         #
         #   class User
-        #     include GrapeEntity::Entity::DSL
+        #     include Grape::Entity::DSL
         #     
         #     entity :name, :email
         #   end
@@ -75,7 +75,7 @@ module GrapeEntity
         # @example Mixed.
         #
         #   class User
-        #     include GrapeEntity::Entity::DSL
+        #     include Grape::Entity::DSL
         #     
         #     entity :name, :email do
         #       expose :latest_status, using: Status::Entity, if: :include_status
@@ -109,7 +109,7 @@ module GrapeEntity
     #   it will yield the object being represented and the options passed to the
     #   representation call. Return true to prevent exposure, false to allow it.
     # @option options :using This option allows you to map an attribute to another Grape
-    #   Entity. Pass it a GrapeEntity::Entity class and the attribute in question will
+    #   Entity. Pass it a Grape::Entity class and the attribute in question will
     #   automatically be transformed into a representation that will receive the same
     #   options as the parent entity when called. Note that arrays are fine here and
     #   will automatically be detected and handled appropriately.
@@ -180,7 +180,7 @@ module GrapeEntity
     #
     #   module API
     #     module Entities
-    #       class User < GrapeEntity::Entity
+    #       class User < Grape::Entity
     #         format_with :timestamp do |date|
     #           date.strftime('%m/%d/%Y')
     #         end
@@ -192,7 +192,7 @@ module GrapeEntity
     #
     # @example Formatters are available to all decendants
     #
-    #   GrapeEntity::Entity.format_with :timestamp do |date|
+    #   Grape::Entity.format_with :timestamp do |date|
     #     date.strftime('%m/%d/%Y')
     #   end
     #
@@ -225,7 +225,7 @@ module GrapeEntity
     #
     #   module API
     #     module Entities
-    #       class User < GrapeEntity::Entity
+    #       class User < Grape::Entity
     #         root 'users', 'user'
     #         expose :id
     #       end
@@ -235,7 +235,7 @@ module GrapeEntity
     # @example Usage in the API Layer
     #
     #   module API
-    #     class Users < GrapeEntity::API
+    #     class Users < Grape::API
     #       version 'v2'
     #
     #       # this will render { "users": [ {"id":"1"}, {"id":"2"} ] }

data/lib/grape_entity/version.rb

@@ -1,3 +1,3 @@
 module GrapeEntity
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/grape_entity/entity_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe GrapeEntity::Entity do
-  let(:fresh_class) { Class.new(GrapeEntity::Entity) }
+describe Grape::Entity do
+  let(:fresh_class) { Class.new(Grape::Entity) }
 
   context 'class methods' do
     subject { fresh_class }
@@ -379,7 +379,7 @@ describe GrapeEntity::Entity do
         it 'disables root key name for child representations' do
         
           module EntitySpec
-            class FriendEntity < GrapeEntity::Entity
+            class FriendEntity < Grape::Entity
               root 'friends', 'friend'
               expose :name, :email
             end
@@ -398,7 +398,7 @@ describe GrapeEntity::Entity do
 
         it 'passes through custom options' do
           module EntitySpec
-            class FriendEntity < GrapeEntity::Entity
+            class FriendEntity < Grape::Entity
               root 'friends', 'friend'
               expose :name
               expose :email, :if => { :user_type => :admin }
@@ -424,7 +424,7 @@ describe GrapeEntity::Entity do
 
         it 'ignores the :collection parameter in the source options' do
           module EntitySpec
-            class FriendEntity < GrapeEntity::Entity
+            class FriendEntity < Grape::Entity
               root 'friends', 'friend'
               expose :name
               expose :email, :if => { :collection => true }
@@ -533,12 +533,12 @@ describe GrapeEntity::Entity do
 
       it 'creates an Entity class when called' do
         subject.should_not be_const_defined :Entity
-        subject.send(:include, GrapeEntity::Entity::DSL)
+        subject.send(:include, Grape::Entity::DSL)
         subject.should be_const_defined :Entity
       end
 
       context 'pre-mixed' do
-        before{ subject.send(:include, GrapeEntity::Entity::DSL) }
+        before{ subject.send(:include, Grape::Entity::DSL) }
 
         it 'is able to define entity traits through DSL' do
           subject.entity do

data/spec/spec_helper.rb

@@ -2,11 +2,9 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
 
-# $stdout = StringIO.new
-
 require 'rubygems'
 require 'bundler'
+
 Bundler.require :default, :test
 
 require 'pry'
-require 'base64'

metadata

@@ -2,7 +2,7 @@
 name: grape-entity
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Bleigh
@@ -11,6 +11,38 @@ bindir: bin
 cert_chain: []
 date: 2013-01-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: multi_json
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.2
 - !ruby/object:Gem::Dependency
   type: :development
   prerelease: false
@@ -116,8 +148,7 @@ files:
 - lib/grape_entity/version.rb
 - spec/grape_entity/entity_spec.rb
 - spec/spec_helper.rb
-- tmp/rspec_guard_result
-homepage: https://github.com/intridea/grape
+homepage: https://github.com/agileanimal/grape-entity
 licenses:
 - MIT
 post_install_message: 
@@ -131,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -2128325401316221325
+      hash: -1479047909720369637
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
@@ -140,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -2128325401316221325
+      hash: -1479047909720369637
       version: '0'
 requirements: []
 rubyforge_project: grape-entity

data/tmp/rspec_guard_result

@@ -1 +0,0 @@
-