napa 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69c7c3558aa04559c34f050ada2fac044daebd6c
-  data.tar.gz: 5b9c79fe39d53ecee82f3c5f083e8335d29021aa
+  metadata.gz: e4f80b689c9f468319a5344e2659ee3da3dc0160
+  data.tar.gz: fae65a84303bb8594fedc3304e8738adc2bf8930
 SHA512:
-  metadata.gz: f8038327e34d0395944aa5c81b3aa3e46f5aa6120bccc0cefefe0ed2e102d13d34a30228937a0a96123a12bcabcd50f587b04a490e20b288f4a3b7a2b7818108
-  data.tar.gz: e518656ddf2ca3e57dedc315dcc480ae524e91efe7eb6a95001fdc70055586f78f3e0cbdf48de3deb4ab97fe098f72cda5e53911262239d07bf78d65723b1490
+  metadata.gz: 6e7c700701738067b6f95a8cca9d10e21dab86f1fbbf339750207e0fc911d95e46b714914110d9b20eddb18033e334e1f6625a981379d8017e5f81a7eccc30cc
+  data.tar.gz: b161248d7731dfd51f173403c2825e9a0d02683ca13264ffc2345db4d114eb7f511623e5d89918399598c40f726532d4b3c17dcecdf7eece9dd3c67cb1b91eb8

data/lib/napa/active_record_extensions/filter_by_hash.rb

@@ -0,0 +1,20 @@
+if defined?(ActiveRecord)
+  module Napa
+    module FilterByHash
+      module ClassMethods
+        def filter(search_hash = {})
+          # pass an empty where clause to force results to be a relation that will be lazy evaluated
+          results = where({})
+          search_hash.each do |k, v|
+            results = results.where(k => v) if v.present?
+          end
+          results
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/napa/cli.rb

@@ -5,5 +5,7 @@ module Napa
   class CLI < Thor
     register(Generators::ScaffoldGenerator, 'new', 'new <app_name> [app_path]',
              'Create a new Napa scaffold')
+    register(Generators::ApiGenerator, 'generate', 'generate api <generator_name> <name>',
+             'Create a Grape API and model')
   end
 end

data/lib/napa/generators/api_generator.rb

@@ -0,0 +1,27 @@
+require 'thor'
+require 'active_support/all'
+
+module Napa
+  module Generators
+    class ApiGenerator < Thor::Group
+      include Thor::Actions
+      argument :generator_name # allows us to type reasonable CLI commands
+      argument :name
+
+      def name_underscore
+        name.underscore
+      end
+
+      def name_tableize
+        name.tableize
+      end
+
+      def generate
+        self.class.source_root "#{File.dirname(__FILE__)}/templates/api"
+        say 'Generating api...'
+        directory '.', '.'
+        say 'Done!', :green
+      end
+    end
+  end
+end

data/lib/napa/generators/templates/api/app/apis/%name_tableize%_api.rb.tt

@@ -0,0 +1,46 @@
+class <%= name.classify.pluralize %>Api < Grape::API
+  represent <%= name.classify %>, with: <%= name.classify %>Entity
+  desc 'Get a list of <%= name.underscore.tableize %>', entity: <%= name.classify %>Entity
+  params do
+    optional :ids, type: String, desc: 'comma separated <%= name.underscore %> ids'
+  end
+  get do
+    <%= name.underscore.tableize %> = <%= name.classify %>.filter(declared(params))
+    present <%= name.underscore.tableize %>
+  end
+
+  desc 'Create an <%= name.underscore %>', entity: <%= name.classify %>Entity
+  params do
+  end
+
+  post do
+    begin
+      <%= name.underscore %> = <%= name.classify %>.create(declared(params))
+    rescue NameError
+      error!(present_error(:kind_not_found))
+    end
+    error!(present_error(:record_invalid, <%= name.underscore %>.errors.full_messages)) unless <%= name.underscore %>.errors.empty?
+    present <%= name.underscore %>
+  end
+
+  params do
+    requires :id, desc: 'ID of the <%= name.underscore %>'
+  end
+  route_param :id do
+    desc 'Get an <%= name.underscore %>', entity: <%= name.classify %>Entity
+    get do
+      <%= name.underscore %> = <%= name.classify %>.find(params[:id])
+      present <%= name.underscore %>
+    end
+
+    desc 'Update an <%= name.underscore %>', entity: <%= name.classify %>Entity
+    params do
+    end
+    put do
+      # fetch <%= name.underscore %> record and update attributes.  exceptions caught in app.rb
+      <%= name.underscore %> = <%= name.classify %>.find(params[:id])
+      <%= name.underscore %>.update_attributes!(declared(params).select { |param, value| value.present? })
+      present <%= name.underscore %>
+    end
+  end
+end

data/lib/napa/generators/templates/api/app/entities/%name_underscore%_entity.rb.tt

@@ -0,0 +1,6 @@
+class <%= name.classify %>Entity < Grape::Entity
+  root :data, :data
+  expose :id, proc: lambda { |o, opts| o.id.to_s }, documentation:
+    { type: 'String', description: 'ID' }
+  expose :type, proc: lambda { |o, opts| o.class.name.underscore }, documentation:
+    { type: 'String', description: '"<%= name.underscore %>"' }

data/lib/napa/generators/templates/api/app/models/%name_underscore%.rb.tt

@@ -0,0 +1,3 @@
+class <%= name.classify %> < ActiveRecord::Base
+  include Napa::FilterByHash
+end

data/lib/napa/generators.rb

@@ -1 +1,2 @@
 require 'napa/generators/scaffold_generator'
+require 'napa/generators/api_generator'

data/lib/napa/version.rb

@@ -1,5 +1,5 @@
 module Napa
-  VERSION = '0.1.14'
+  VERSION = '0.1.15'
 
   class Version
     class << self

data/napa.gemspec

@@ -27,8 +27,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'unicorn'
   gem.add_dependency 'statsd-ruby'
 
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "git"
-  gem.add_development_dependency "rubocop"
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'git'
+  gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'activerecord', '~>3.2.2'
 end

data/spec/active_record_extensions/filter_by_hash_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'active_record'
+require 'napa/active_record_extensions/filter_by_hash'
+
+class Foo < ActiveRecord::Base
+  include Napa::FilterByHash
+end
+
+describe Napa::FilterByHash do
+  context 'when a hash is provided' do
+    it 'returns an AR relation' do
+      expect(Foo.filter).to be_a(ActiveRecord::Relation)
+    end
+  end
+
+  context 'when nothing is provided' do
+    it 'returns an AR relation' do
+      expect(Foo.filter).to be_a(ActiveRecord::Relation)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: napa
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Darby Frey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-30 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -206,6 +206,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
 description: A simple framework for building APIs with Grape
 email:
 - darby@bellycard.com
@@ -222,11 +236,16 @@ files:
 - Rakefile
 - bin/napa
 - lib/napa.rb
+- lib/napa/active_record_extensions/filter_by_hash.rb
 - lib/napa/activerecord.rb
 - lib/napa/authentication.rb
 - lib/napa/cli.rb
 - lib/napa/generators.rb
+- lib/napa/generators/api_generator.rb
 - lib/napa/generators/scaffold_generator.rb
+- lib/napa/generators/templates/api/app/apis/%name_tableize%_api.rb.tt
+- lib/napa/generators/templates/api/app/entities/%name_underscore%_entity.rb.tt
+- lib/napa/generators/templates/api/app/models/%name_underscore%.rb.tt
 - lib/napa/generators/templates/scaffold/.env
 - lib/napa/generators/templates/scaffold/.env.test
 - lib/napa/generators/templates/scaffold/.gitignore.tt
@@ -262,6 +281,7 @@ files:
 - lib/tasks/git.rake
 - lib/tasks/routes.rake
 - napa.gemspec
+- spec/active_record_extensions/filter_by_hash_spec.rb
 - spec/authentication_spec.rb
 - spec/grape_extensions/error_formatter_spec.rb
 - spec/identity_spec.rb
@@ -297,6 +317,7 @@ signing_key:
 specification_version: 4
 summary: A simple framework for building APIs with Grape
 test_files:
+- spec/active_record_extensions/filter_by_hash_spec.rb
 - spec/authentication_spec.rb
 - spec/grape_extensions/error_formatter_spec.rb
 - spec/identity_spec.rb