grape-resource-definition 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2031e9d1f495ef640ded0f17a64a2337e1770205
+  data.tar.gz: 8d3671247c86bc36da4d9c992280872d7c9c5ef4
+SHA512:
+  metadata.gz: c4260d343bce76cfcc4d1489b623a220eae46675e0385f707544002e233c29c633506759a094be0322c2ed5faf162205b8296c6b7868f1aba65a23e361613bcc
+  data.tar.gz: 29fcc0b5a98f2ff2e6be69a0b0fd0a77e085a92b4cbdd8d758be1a64fa2cfdc7bd1f7a72af2ca7bcbc2ab70e4bd00164eff552f0e18ef1394954a4a6c40eb88f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Joaquim Adráz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,4 @@
+grape-resource-definition
+=========================
+
+Grape Resource Definition Gem

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+task :default => :test
+RSpec::Core::RakeTask.new(:test)

data/grape-resource-definition.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape_resource_definition/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'grape-resource-definition'
+  gem.version       = ResourceDefinition::VERSION
+  gem.authors       = ['Joaquim Adráz']
+  gem.email         = ['joaquim.adraz@gmail.com']
+  gem.description   = %q{Grape Resource Definition, separating API design from implementation}
+  gem.summary       = %q{A simple way to define params validation and coercion outside API class}
+  gem.homepage      = 'https://github.com/joaquimadraz/grape_resource_definition'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'grape', ['= 0.9.0']
+
+  gem.add_development_dependency 'rspec', '~> 0'
+  gem.add_development_dependency 'rake', '~> 0'
+  gem.add_development_dependency 'pry', '~> 0'
+end

data/lib/grape-resource-definition.rb

@@ -0,0 +1 @@
+require "grape_resource_definition"

data/lib/grape_resource_definition.rb

@@ -0,0 +1 @@
+require "grape_resource_definition/resource_definition"

data/lib/grape_resource_definition/resource_definition.rb

@@ -0,0 +1,60 @@
+module Grape
+  module ResourceDefinition
+
+    module ClassMethods
+
+      def definitions
+        model_name = Grape::ResourceDefinition.get_class_name(self)
+        Grape::ResourceDefinition.definitions[model_name]
+      end
+
+      def resource_define(name, &params_block)     
+        definitions[name] = params_block
+      end
+
+      def define(name)
+        if definitions.nil?
+          raise "No ResourceDefinition defined for #{self}"
+        end
+        
+        if definitions[name].nil?
+          raise "Design ':#{name}' if not defined for #{self}"
+        end
+
+        self.instance_eval &definitions[name]
+      end
+
+    end
+
+    def self.definitions
+      @definitions
+    end
+        
+    def self.included(other)
+      model_name = get_class_name(other)
+
+      @definitions ||= {}
+      @definitions[model_name] = {}
+
+      other.include ClassMethods
+      other.extend  ClassMethods
+    end
+
+    def self.get_class_name(klass)
+      klass.name.split("::")[-1].to_sym  
+    end
+
+  end
+end
+
+module Grape
+  class API
+
+    def self.resource_definition(resource_definition_module)
+      self.class_eval do
+        extend resource_definition_module
+      end
+    end
+  
+  end
+end

data/lib/grape_resource_definition/version.rb

@@ -0,0 +1,3 @@
+module ResourceDefinition
+  VERSION = "0.0.1"
+end

data/spec/resource_definition_spec.rb

@@ -0,0 +1,39 @@
+require 'pry'
+require 'spec_helper'
+
+describe Grape::ResourceDefinition do 
+
+  module Resources
+    module Todos
+      
+      include Grape::ResourceDefinition
+
+      resource_define :show do          
+        desc 'Get a todo by id', 
+          http_codes: [
+            [200, 'Ok'],
+            [404, 'Not Found']
+          ]
+
+        params 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] }
+      end
+
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: grape-resource-definition
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joaquim Adráz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-06 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Grape Resource Definition, separating API design from implementation
+email:
+- joaquim.adraz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grape-resource-definition.gemspec
+- lib/grape-resource-definition.rb
+- lib/grape_resource_definition.rb
+- lib/grape_resource_definition/resource_definition.rb
+- lib/grape_resource_definition/version.rb
+- spec/resource_definition_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/joaquimadraz/grape_resource_definition
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple way to define params validation and coercion outside API class
+test_files:
+- spec/resource_definition_spec.rb
+- spec/spec_helper.rb