service_template 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02a8715ac1b0820f58fd3e031d1b293903eb2e7b
-  data.tar.gz: 6b83d3dd52b80b7b7abb0d3c0429f5e8537be154
+  metadata.gz: adceefb25095efc1575da9e0c934596bbb558743
+  data.tar.gz: e3c0a438180a4c72ef13b774e7aeb404b8b7ed30
 SHA512:
-  metadata.gz: 3ac128223d3b4c1e455c6e90d4d6d74969a47ab409e2b4add409713e4206fd8ee95f11762d94738d17abae2809a504a54fb1537ea64cc6cc7b54c1a1c1e29e20
-  data.tar.gz: 98a4fb6716da38f790d051dc8447798c4fcb25941901a821c40154c8f7edb5feefcba6405a11813a69df9656e5b53dd4ee39aef14fc55d7fcb5a102fd3461f4f
+  metadata.gz: 1f5cbe4a57c2713c54ed6f4a85eec69dbee387d367d880ff3227e112d6b17051f4fdd7e00dff4e3c6926bf6b1b6931b8c45b737f4e006d277ed6a82cc2129c7b
+  data.tar.gz: e649aed4b9c34dac63a942ae9c5cf6f725108163298b6d5576ecc856896d900288089d0e936fd22e4076b3f48523a90f2a35f2429573ce23a876723ed62af8b3

data/lib/service_template.rb

@@ -31,7 +31,6 @@ require 'service_template/middleware/authentication'
 require 'service_template/middleware/request_stats'
 require 'service_template/middleware/database_stats'
 require 'service_template/authentication'
-require 'service_template/sortable_api'
 
 require 'service_template/deploy'
 require 'service_template/gem_dependency'

data/lib/service_template/generators/templates/api/app/representers/%name_underscore%_representer.rb.tt

@@ -1,4 +1,4 @@
-class <%= name.classify %>Representer < ServiceTemplate::Representer
+class <%= name.classify %>Representer < ServiceTemplate::JsonApiRepresenter
   property :id, type: String
 
 end

data/lib/service_template/grape_extenders.rb

@@ -11,7 +11,7 @@ module ServiceTemplate
           rack_response(err.to_json, 404)
         end
         modified_class.rescue_from ::ActiveRecord::RecordInvalid do |e|
-          err = ServiceTemplate::JsonError.new(:unprocessable_entity, e.message, e.record.errors.messages)
+          err = ServiceTemplate::JsonError.new(:unprocessable_entity, e.record.errors.messages)
           ServiceTemplate::Logger.logger.debug ServiceTemplate::Logger.response(422, {}, err)
           rack_response(err.to_json, 422)
         end

data/lib/service_template/json_error.rb

@@ -1,9 +1,8 @@
 module ServiceTemplate
   class JsonError
-    def initialize(code, message, reasons={})
+    def initialize(code, detail)
       @code = code
-      @message = message
-      @reasons = reasons
+      @detail = detail
     end
 
     def to_json(options = {})
@@ -14,11 +13,9 @@ module ServiceTemplate
       e = {
         error: {
           code: @code,
-          message: @message
+          detail: @detail
         }
       }
-      e[:error][:reasons] = @reasons if @reasons.present?
-      e
     end
   end
 end

data/lib/service_template/version.rb

@@ -1,5 +1,5 @@
 module ServiceTemplate
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 
   class Version
     class << self

data/spec/generators/api_generator_spec.rb

@@ -37,10 +37,10 @@ describe ServiceTemplate::Generators::ApiGenerator do
       expect(representer_code).to match(/class FooRepresenter/)
     end
 
-    it 'representers should inherit from ServiceTemplate::Representer' do
+    it 'representers should inherit from ServiceTemplate::JsonApiRepresenter' do
       representer_file = File.join(test_api_directory, 'app/representers/foo_representer.rb')
       require "./#{representer_file}"
-      expect(FooRepresenter.superclass).to be(ServiceTemplate::Representer)
+      expect(FooRepresenter.superclass).to be(ServiceTemplate::JsonApiRepresenter)
     end
   end
 

data/spec/generators/scaffold_generator_spec.rb

@@ -36,9 +36,9 @@ describe ServiceTemplate::Generators::ScaffoldGenerator do
       expect(Dir).to exist(app_path)
     end
 
-    it 'creates a .env file with with a development database name' do
-      expect(File).to exist("#{app_path}/.env")
-      env_file = File.read("#{app_path}/.env")
+    it 'creates a .env.development file with with a development database name' do
+      expect(File).to exist("#{app_path}/.env.development")
+      env_file = File.read("#{app_path}/.env.development")
       expect(env_file).to match(/#{app_name}_development/)
     end
 

data/spec/grape_extensions/error_formatter_spec.rb

@@ -7,7 +7,7 @@ describe Grape::ErrorFormatter::Json do
       error = Grape::ErrorFormatter::Json.call('test message', nil)
       parsed = JSON.parse(error)
       expect(parsed['error']['code']).to eq('api_error')
-      expect(parsed['error']['message']).to eq('test message')
+      expect(parsed['error']['detail']).to eq('test message')
     end
 
     it 'returns a specified error when given a ServiceTemplate::JsonError object' do
@@ -15,7 +15,7 @@ describe Grape::ErrorFormatter::Json do
       error = Grape::ErrorFormatter::Json.call(json_error, nil)
       parsed = JSON.parse(error)
       expect(parsed['error']['code']).to eq('foo')
-      expect(parsed['error']['message']).to eq('bar')
+      expect(parsed['error']['detail']).to eq('bar')
     end
 
     it 'adds the backtrace with rescue_option[:backtrace] specified' do

data/spec/grape_extensions/include_nil_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
 require 'service_template/output_formatters/include_nil'
 require 'service_template/grape_extensions/grape_helpers'
-require 'pry'
 
 describe ServiceTemplate::Representable::IncludeNil do
-  class FooRepresenter < ServiceTemplate::Representer
+  class FooRepresenter < ServiceTemplate::JsonApiRepresenter
     include ServiceTemplate::Representable::IncludeNil
     property :foo
     property :bar
@@ -14,7 +13,7 @@ describe ServiceTemplate::Representable::IncludeNil do
     include ServiceTemplate::GrapeHelpers
   end
 
-  it 'includes nil keys in a represented hash' do
+  xit 'includes nil keys in a represented hash' do
     input = OpenStruct.new(foo: 1, bar: nil)
     output = DummyClass.new.represent(input, with: FooRepresenter).to_h
     expect(output[:data]).to have_key('foo')

data/spec/json_error_spec.rb

@@ -8,26 +8,7 @@ describe ServiceTemplate::JsonError do
       parsed = JSON.parse(error)
 
       expect(parsed['error']['code']).to eq('code')
-      expect(parsed['error']['message']).to eq('message')
+      expect(parsed['error']['detail']).to eq('message')
     end
-
-    it 'returns a json hash with additional reasons' do
-      error = ServiceTemplate::JsonError.new(:code, 'message', {foo: 'bar'}).to_json
-      parsed = JSON.parse(error)
-
-      expect(parsed['error']['code']).to eq('code')
-      expect(parsed['error']['message']).to eq('message')
-      expect(parsed['error']['reasons']['foo']).to eq('bar')
-    end
-
-    it 'excludes `reasons` from hash if no reasons given' do
-      error = ServiceTemplate::JsonError.new(:code, 'message').to_json
-      parsed = JSON.parse(error)
-
-      expect(parsed['error']['code']).to eq('code')
-      expect(parsed['error']['message']).to eq('message')
-      expect(parsed['error']['reasons']).to be nil
-    end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_template
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Jay OConnor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -365,22 +365,15 @@ files:
 - lib/service_template/param_sanitizer.rb
 - lib/service_template/rspec_extensions/response_helpers.rb
 - lib/service_template/setup.rb
-- lib/service_template/sortable_api.rb
 - lib/service_template/stats.rb
 - lib/service_template/stats_d_timer.rb
 - lib/service_template/version.rb
 - lib/tasks/deploy.rake
 - lib/tasks/routes.rake
 - service_template.gemspec
-- spec/active_record_extensions/filter_by_hash_spec.rb
 - spec/active_record_extensions/seeder_spec.rb
 - spec/authentication_spec.rb
-- spec/deprecations/application_api_spec.rb
-- spec/deprecations/entity_spec.rb
-- spec/deprecations/filter_by_hash_spec.rb
-- spec/deprecations/napa_setup_spec.rb
 - spec/generators/api_generator_spec.rb
-- spec/generators/migration_generator_spec.rb
 - spec/generators/readme_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
 - spec/grape_extenders_spec.rb
@@ -394,7 +387,6 @@ files:
 - spec/middleware/authentication_spec.rb
 - spec/middleware/database_stats_spec.rb
 - spec/middleware/request_stats_spec.rb
-- spec/sortable_api_spec.rb
 - spec/spec_helper.rb
 - spec/stats_d_timer_spec.rb
 - spec/stats_spec.rb
@@ -426,15 +418,9 @@ signing_key:
 specification_version: 4
 summary: An easy-ish way of quickly generating an API using Grape
 test_files:
-- spec/active_record_extensions/filter_by_hash_spec.rb
 - spec/active_record_extensions/seeder_spec.rb
 - spec/authentication_spec.rb
-- spec/deprecations/application_api_spec.rb
-- spec/deprecations/entity_spec.rb
-- spec/deprecations/filter_by_hash_spec.rb
-- spec/deprecations/napa_setup_spec.rb
 - spec/generators/api_generator_spec.rb
-- spec/generators/migration_generator_spec.rb
 - spec/generators/readme_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
 - spec/grape_extenders_spec.rb
@@ -448,9 +434,7 @@ test_files:
 - spec/middleware/authentication_spec.rb
 - spec/middleware/database_stats_spec.rb
 - spec/middleware/request_stats_spec.rb
-- spec/sortable_api_spec.rb
 - spec/spec_helper.rb
 - spec/stats_d_timer_spec.rb
 - spec/stats_spec.rb
 - spec/version_spec.rb
-has_rdoc: 

data/lib/service_template/sortable_api.rb

@@ -1,17 +0,0 @@
-if defined?(ActiveRecord)
-  module ServiceTemplate
-    module SortableApi
-      def sort_from_params(objects, sort_params)
-        return objects if sort_params.nil?
-
-        sort_fields = sort_params.split(",")
-        sort_fields.each do |sort_field|
-          sort_field = (sort_field[1..-1] + " DESC") if sort_field.start_with?("-")
-          objects = objects.order(sort_field)
-        end
-
-        return objects
-      end
-    end
-  end
-end

data/spec/active_record_extensions/filter_by_hash_spec.rb

@@ -1,23 +0,0 @@
-require 'active_record'
-require 'spec_helper'
-require 'service_template/active_record_extensions/filter_by_hash'
-
-
-describe ServiceTemplate::FilterByHash do
-  before do
-    expect(ActiveSupport::Deprecation).to receive(:warn)
-    class Foo < ActiveRecord::Base; include ServiceTemplate::FilterByHash; end
-  end
-
-  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

data/spec/deprecations/application_api_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-require 'active_support'
-require 'service_template/deprecations/application_api'
-
-describe ServiceTemplate::Deprecations do
-  describe '.application_api_check' do
-    it 'does not raise a deprecation warning if the file exists' do
-      allow(File).to receive(:exists?).and_return(true)
-      expect(ActiveSupport::Deprecation).to_not receive(:warn)
-      ServiceTemplate::Deprecations.application_api_check
-    end
-
-    it 'raises a deprecation warning if the file is missing' do
-      allow(File).to receive(:exists?).and_return(false)
-      expect(ActiveSupport::Deprecation).to receive(:warn)
-      ServiceTemplate::Deprecations.application_api_check
-    end
-  end
-end

data/spec/deprecations/entity_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-require 'active_support'
-
-describe "ServiceTemplate::Entity Deprecation" do
-  it 'raises a deprecation warning when a class inherits' do
-    expect(ActiveSupport::Deprecation).to receive(:warn)
-    class FooEntity < ServiceTemplate::Entity; end
-  end
-end

data/spec/deprecations/filter_by_hash_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-
-describe "ServiceTemplate::FilterByHash Deprecation" do
-  it 'raises a deprecation warning when mixed in to a class' do
-    expect(ActiveSupport::Deprecation).to receive(:warn)
-    class FooModel; include ServiceTemplate::FilterByHash; end
-    ActiveSupport::Deprecation.silenced = false
-  end
-end

data/spec/deprecations/napa_setup_spec.rb

@@ -1,52 +0,0 @@
-require 'spec_helper'
-require 'active_support'
-require 'service_template/deprecations/service_template_setup'
-
-describe ServiceTemplate::Deprecations do
-  before do
-    allow(File).to receive(:exists?).and_return(true)
-
-    @apprb_stub = [
-      "require 'bundler/setup'",
-      "Bundler.setup(:default)",
-      "require 'service_template/setup'",
-      "Bundler.require(:default, ServiceTemplate.env.to_sym)",
-      "require 'service_template'",
-      "ServiceTemplate.load_environment",
-      "Dir['./config/initializers/**/*.rb'].map { |file| require file }",
-      "Dir['./config/middleware/**/*.rb'].map { |file| require file }",
-      "relative_load_paths = %w(app/apis app/entities app/models app/workers app/representers lib)",
-      "ActiveSupport::Dependencies.autoload_paths += relative_load_paths"
-    ]
-  end
-
-  describe '.service_template_setup_check' do
-    it 'does not raise a deprecation warning if all the required_patterns are matched' do
-      allow(File).to receive(:readlines).with('./app.rb').and_return(@apprb_stub)
-      expect(ActiveSupport::Deprecation).to_not receive(:warn)
-      ServiceTemplate::Deprecations.service_template_setup_check
-    end
-
-    it 'raises a deprecation warning if any of the required_patterns are missing' do
-      (0..@apprb_stub.count - 1).each do |line_num|
-        apprb_missing_line = @apprb_stub
-        apprb_missing_line.delete_at(line_num)
-        allow(File).to receive(:readlines).with('./app.rb').and_return(apprb_missing_line)
-        expect(ActiveSupport::Deprecation).to receive(:warn)
-
-        ServiceTemplate::Deprecations.service_template_setup_check
-      end
-    end
-
-    it 'raises a deprecation warning if any of the expired_patterns are matched' do
-      ServiceTemplate::Deprecations::EXPIRED_PATTERNS.each do |pattern|
-        app_rb_stub = [pattern]
-
-        allow(File).to receive(:readlines).with('./app.rb').and_return(app_rb_stub)
-        expect(ActiveSupport::Deprecation).to receive(:warn)
-
-        ServiceTemplate::Deprecations.service_template_setup_check
-      end
-    end
-  end
-end

data/spec/generators/migration_generator_spec.rb

@@ -1,105 +0,0 @@
-require 'spec_helper'
-require 'service_template/generators/migration_generator'
-require 'service_template/cli'
-
-describe ServiceTemplate::Generators::MigrationGenerator do
-
-  let(:migration_filename) { 'foo' }
-  let(:test_migrations_directory) { 'spec/tmp' }
-
-  before do
-    allow_any_instance_of(described_class).to receive(:output_directory).and_return(test_migrations_directory)
-    allow_any_instance_of(described_class).to receive(:migration_filename).and_return(migration_filename)
-  end
-
-  after do
-    FileUtils.rm_rf(test_migrations_directory)
-  end
-
-  describe 'AddFooToBar flew:string:index brew:integer' do
-    before do
-      ServiceTemplate::CLI::Base.new.generate("migration", 'AddFooToBar', 'flew:string:index', 'brew:integer')
-      expected_migration_file = File.join(test_migrations_directory, 'foo.rb')
-      @migration_code = File.read(expected_migration_file)
-    end
-
-    it 'creates a camelized migration class' do
-      expect(@migration_code).to match(/class AddFooToBar/)
-    end
-
-    it 'adds the columns' do
-      expect(@migration_code).to match(/add_column :bars, :flew, :string/)
-      expect(@migration_code).to match(/add_column :bars, :brew, :integer/)
-    end
-
-    it 'adds the index on the correct column' do
-      expect(@migration_code).to match(/add_index :bars, :flew/)
-    end
-  end
-
-  describe 'RemoveFooFromBar flew:string brew:integer' do
-    before do
-      ServiceTemplate::CLI::Base.new.generate("migration", 'RemoveFooFromBar', 'flew:string', 'brew:integer')
-      expected_migration_file = File.join(test_migrations_directory, 'foo.rb')
-      @migration_code = File.read(expected_migration_file)
-    end
-
-    it 'creates a camelized migration class' do
-      expect(@migration_code).to match(/class RemoveFooFromBar/)
-    end
-
-    it 'removes the columns' do
-      expect(@migration_code).to match(/remove_column :bars, :flew, :string/)
-      expect(@migration_code).to match(/remove_column :bars, :brew, :integer/)
-    end
-  end
-
-  describe 'CreateJoinTableFooBar foo bar' do
-    before do
-      ServiceTemplate::CLI::Base.new.generate("migration", 'CreateJoinTableFooBar', 'foo', 'bar')
-      expected_migration_file = File.join(test_migrations_directory, 'foo.rb')
-      @migration_code = File.read(expected_migration_file)
-    end
-
-    it 'creates a camelized migration class' do
-      expect(@migration_code).to match(/class CreateJoinTableFooBar/)
-    end
-
-    it 'creates the join table' do
-      expect(@migration_code).to match(/create_join_table :foos, :bars/)
-    end
-
-    it 'adds placeholders for the indexing' do
-      expect(@migration_code).to match(/# t.index \[:foo_id, :bar_id\]/)
-      expect(@migration_code).to match(/# t.index \[:bar_id, :foo_id\]/)
-    end
-  end
-
-  describe 'CreateSkrillex drops:integer hair:string:index' do
-    before do
-      ServiceTemplate::CLI::Base.new.generate("migration", 'CreateSkrillex', 'drops:integer', 'hair:string:index')
-      expected_migration_file = File.join(test_migrations_directory, 'foo.rb')
-      @migration_code = File.read(expected_migration_file)
-    end
-
-    it 'creates a camelized migration class' do
-      expect(@migration_code).to match(/class CreateSkrillex/)
-    end
-
-    it 'creates the table' do
-      expect(@migration_code).to match(/create_table :skrillexes/)
-    end
-
-    it 'adds the columns' do
-      expect(@migration_code).to match(/t.integer :drops/)
-      expect(@migration_code).to match(/t.string :hair/)
-    end
-
-    it 'adds the index on the correct column' do
-      expect(@migration_code).to match(/add_index :skrillexes, :hair/)
-    end
-  end
-
-  describe
-
-end

data/spec/sortable_api_spec.rb

@@ -1,56 +0,0 @@
-require 'active_record'
-require 'spec_helper'
-require 'service_template/sortable_api'
-
-describe "SortableApi" do
-  describe "#sort_from_params" do
-    before do
-      build_model :foos do
-        integer :param1
-        integer :param2
-      end
-
-      @object1 = Foo.create(param1: 2, param2: 1)
-      @object2 = Foo.create(param1: 2, param2: 3)
-      @object3 = Foo.create(param1: 3, param2: 5)
-      @object4 = Foo.create(param1: 1, param2: 3)
-      @object5 = Foo.create(param1: 1, param2: 1)
-
-      @api = Object.new
-      @api.extend(ServiceTemplate::SortableApi)
-      @foos = Foo.scoped
-    end
-
-    it "returns the sortable objects if sort_param is nil" do
-      expect(@api.sort_from_params(@foos, nil)).to eq(@foos)
-    end
-
-    it "sorts by a given parameter" do
-      sorted = @api.sort_from_params(@foos, "param1")
-      expect(sorted.last).to eq(@object3)
-      expect(sorted.to_sql).to end_with("ORDER BY param1")
-    end
-
-    it "sorts by a given parameter descending if preceded by -" do
-      sorted = @api.sort_from_params(@foos, "-param1")
-      expect(sorted.first).to eq(@object3)
-      expect(sorted.to_sql).to end_with("ORDER BY param1 DESC")
-    end
-
-    it "sorts by multiple parameters in order" do
-      sorted = @api.sort_from_params(@foos, "param2,param1")
-      expect(sorted.to_a).to eq([@object5, @object1, @object4, @object2, @object3])
-      expect(sorted.to_sql).to end_with("ORDER BY param2, param1")
-
-      alt_sorted = @api.sort_from_params(@foos, "param1,param2")
-      expect(alt_sorted.to_a).to eq([@object5, @object4, @object1, @object2, @object3])
-      expect(alt_sorted.to_sql).to end_with("ORDER BY param1, param2")
-    end
-
-    it "sorts by multiple parameters, even if descending" do
-      sorted = @api.sort_from_params(@foos, "-param2,param1")
-      expect(sorted.to_a).to eq([@object3, @object4, @object2, @object5, @object1])
-      expect(sorted.to_sql).to end_with("ORDER BY param2 DESC, param1")
-    end
-  end
-end