grape-resource-definition 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc29cdcd17ab1056fd6f6a9e08fbb879c2dab1d7
-  data.tar.gz: b86055b4cb1730c254a4134b6e0586e55bae9caa
+  metadata.gz: 40de937f06ba2db30211deeacb679f153cd3b6b2
+  data.tar.gz: 13319ff6f39caf4476ea3594f7e6b8267f41d8b6
 SHA512:
-  metadata.gz: a842f7c141e5f539b4cca0c2b13ff5be75df66e368e0e127c79158dccc5b8c38e607109132f6b57251a1a53cdffff6294aecba52878c94d2d275911a02cc17a8
-  data.tar.gz: e82cd175ffd05fa40e90818d72af9a520f39a19d457c79b24e5972d6eb3130fa9a18b82046191adb9b45c00efef93b4ebf0d6ca9f388aad76295fd757b8558b8
+  metadata.gz: ff1e623402da185d3f42d78987482db0e06ee09c54c69c24821d7635d07b2add634fda3ef0357d33156c4f9fc387f18510b2f48829bfeb0d4d4c10d860671e88
+  data.tar.gz: f60d82e4493ce4ca34a8a2f86c57024b09026cf1f43b3ce3e94b41478408f2ea1d139059348cad0ded6069685e15e9a4fb86b969a4a4d7b7f16b02bbf9e217f4

data/.rspec

@@ -1,2 +1,2 @@
---color
---format progress
+--colour
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+grape-resource-definition

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in usecasing.gemspec
 gemspec

data/README.md

@@ -1,4 +1,94 @@
-grape-resource-definition
+Grape::ResourceDefinition
 =========================
 
-Grape Resource Definition Gem
+(Still making the tests and the rest of the documentation)
+
+Based on Praxis principle, that design and implementation should be separated, I've created this gem to add the possibility to define the params validation & coercion outside the route's class.
+
+If you are using Grape to create a Blog API (of course), you should have something like this:
+
+```ruby
+class Posts < Grape::API
+
+  desc 'Get all blog posts',
+    http_codes: [
+      [200, 'Ok']
+    ]
+
+  params do
+    optional :q, type: Hash
+    optional :order_by, type: String
+    optional :order_dir, type: String
+  end
+  
+  get '/posts' do
+    # Logic to get those posts
+  end
+  
+end
+```
+
+If your Posts API have only this route, to get all posts, it's ok. But if you have all actions to CRUD your posts, and some more to handle your specific business logic, this will become a mess... for sure.
+
+This was a problem for me. I like my code to be as readable as possible and, with all these documentation and params definition that we need to create ou API, this is not possible.
+
+So.. with this gem you can define your resource definition outside your route and call it when you need it.
+
+```ruby
+module Resources
+    
+  module Posts
+  
+    include Grape::ResourceDefinition
+    
+    resource_define :index do
+    
+      desc 'Get all blog posts',
+        http_codes: [
+          [200, 'Ok']
+        ]
+
+      params do
+        optional :q, type: Hash
+        optional :order_by, type: String
+        optional :order_dir, type: String
+      end
+    
+    end
+  
+  end
+    
+end
+```
+    
+...and your route links to that resource:
+
+```ruby
+class Posts < Grape::API
+
+  resource_definition Resources::Posts
+
+  define :index
+  get '/posts' do
+    # Logic to get those posts
+  end
+  
+end
+```
+
+I've made this really simple, the rest it's up to you. I don't want to add constraints on that. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape-resource-definition'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-resource-definition
+

data/grape-resource-definition.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'grape', ['= 0.9.0']
+  gem.add_runtime_dependency 'grape', ['~> 0.10']
 
-  gem.add_development_dependency 'rspec', '~> 0'
+  gem.add_development_dependency 'rspec', '~> 3.1'
   gem.add_development_dependency 'rake', '~> 0'
   gem.add_development_dependency 'pry', '~> 0'
-end
+end

data/lib/grape_resource_definition.rb

@@ -1 +1,3 @@
-require "grape_resource_definition/resource_definition"
+require "grape_resource_definition/no_resource_defined"
+require "grape_resource_definition/no_resource_definition"
+require "grape_resource_definition/resource_definition"

data/lib/grape_resource_definition/no_resource_defined.rb

@@ -0,0 +1,3 @@
+class NoResourceDefined < StandardError
+
+end

data/lib/grape_resource_definition/no_resource_definition.rb

@@ -0,0 +1,3 @@
+class NoResourceDefinition < StandardError
+
+end

data/lib/grape_resource_definition/resource_definition.rb

@@ -5,20 +5,20 @@ module Grape
 
       def definitions
         model_name = Grape::ResourceDefinition.get_class_name(self)
-        Grape::ResourceDefinition.definitions[model_name]
+        Grape::ResourceDefinition.defined_resources[model_name]
       end
 
-      def resource_define(name, &params_block)     
+      def resource_define(name, &params_block)
         definitions[name] = params_block
       end
 
       def define(name)
         if definitions.nil?
-          raise "No ResourceDefinition defined for #{self}"
+          raise NoResourceDefinition, "No resource definition for #{self}"
         end
-        
+
         if definitions[name].nil?
-          raise "Design ':#{name}' if not defined for #{self}"
+          raise NoResourceDefined, "':#{name}' is not defined for #{self}"
         end
 
         self.instance_eval &definitions[name]
@@ -26,22 +26,22 @@ module Grape
 
     end
 
-    def self.definitions
-      @definitions
+    def self.defined_resources
+      @defined_resources
     end
-        
+
     def self.included(other)
       model_name = get_class_name(other)
 
-      @definitions ||= {}
-      @definitions[model_name] = {}
+      @defined_resources ||= {}
+      @defined_resources[model_name] = {}
 
       other.include ClassMethods
       other.extend  ClassMethods
     end
 
     def self.get_class_name(klass)
-      klass.name.split("::")[-1].to_sym  
+      klass.name.split("::")[-1].to_sym
     end
 
   end
@@ -55,6 +55,6 @@ module Grape
         extend resource_definition_module
       end
     end
-  
+
   end
-end
+end

data/lib/grape_resource_definition/version.rb

@@ -1,3 +1,3 @@
 module ResourceDefinition
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/resource_definition_spec.rb

@@ -1,15 +1,21 @@
 require 'pry'
 require 'spec_helper'
 
-describe Grape::ResourceDefinition do 
+describe Grape::ResourceDefinition do
 
   module Resources
     module Todos
-      
       include Grape::ResourceDefinition
 
-      resource_define :show do          
-        desc 'Get a todo by id', 
+      resource_define :index do
+        desc 'Get all todos',
+          http_codes: [
+            [200, 'Ok']
+          ]
+      end
+
+      resource_define :show do
+        desc 'Get a todo by id',
           http_codes: [
             [200, 'Ok'],
             [404, 'Not Found']
@@ -19,20 +25,75 @@ describe Grape::ResourceDefinition do
           requires :id, type: Integer
         end
       end
-    
     end
   end
 
-  class Todos < Grape::API
-    resource_definition Resources::Todos
-    resource :todos do
-      
-      define :show
-      get '/:id' do
-        { id: params[:id] }
+  context 'correct defined resource and link with resource_definition' do
+
+    subject do
+      class Todos < Grape::API
+        resource_definition Resources::Todos
+
+        define :show
+        get('/todos/:id') {}
       end
 
+      Todos.new
+    end
+
+    let(:defined_resources) do
+      Grape::ResourceDefinition.defined_resources
     end
+
+    it 'should have :Todos resource with :show definition' do
+
+      expect(defined_resources).to \
+        have_key(:Todos)
+
+      expect(defined_resources[:Todos]).to \
+        have_key(:index)
+
+      expect(defined_resources[:Todos]).to \
+        have_key(:show)
+
+      # expect(subject).to receive(:define).with(:show)
+
+    end
+
+  end
+
+  context 'correct defined resource but no link with resource_definition' do
+
+    it 'should raise NoMethodError for define :index' do
+
+      expect do
+        class Todos < Grape::API
+          define :index
+          get('/todos/:id') {}
+        end
+      end.to \
+        raise_error(NoMethodError, /undefined method `define'/)
+
+    end
+
+  end
+
+  context 'resource not defined but has link to resource_definition' do
+
+    it 'should raise NoResourceDefined error for define :update' do
+
+      expect do
+        class Todos < Grape::API
+          resource_definition Resources::Todos
+
+          define :update
+          put('/todos/:id') {}
+        end
+      end.to \
+        raise_error(NoResourceDefined, /':update' is not defined for Todos/)
+
+    end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -1,7 +1,2 @@
 require 'grape'
 require 'grape_resource_definition'
-
-# RSpec.configure do |config|
-#   config.treat_symbols_as_metadata_keys_with_true_values = true
-#   config.run_all_when_everything_filtered = true
-# end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: grape-resource-definition
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Joaquim Adráz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2015-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
@@ -82,6 +84,8 @@ files:
 - grape-resource-definition.gemspec
 - lib/grape-resource-definition.rb
 - lib/grape_resource_definition.rb
+- lib/grape_resource_definition/no_resource_defined.rb
+- lib/grape_resource_definition/no_resource_definition.rb
 - lib/grape_resource_definition/resource_definition.rb
 - lib/grape_resource_definition/version.rb
 - spec/resource_definition_spec.rb
@@ -105,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A simple way to define params validation and coercion outside API class