service_template 0.5.0

data/lib/service_template/rspec_extensions/response_helpers.rb

@@ -0,0 +1,46 @@
+module ServiceTemplate
+  module RspecExtensions
+    module ResponseHelpers
+      def parsed_response
+        Hashie::Mash.new(JSON.parse(last_response.body))
+      end
+
+      def response_code
+        last_response.status
+      end
+
+      def response_body
+        last_response.body
+      end
+
+      def result_count
+        parsed_response.data.count
+      end
+
+      def first_result
+        parsed_response.data.first
+      end
+
+      def result_with_id(id)
+        parsed_response.data.select { |r| r.id == id }.first
+      end
+
+      def expect_count_of(count)
+        expect(result_count).to eq(count)
+      end
+
+      def expect_only(object)
+        expect_count_of 1
+        expect(first_result.id).to eq(object.id)
+      end
+
+      def expect_to_have(object)
+        expect(!!result_with_id(object.id)).to be_truthy
+      end
+
+      def expect_to_not_have(object)
+        expect(!!result_with_id(object.id)).to be_falsy
+      end
+    end
+  end
+end

data/lib/service_template/setup.rb

@@ -0,0 +1,36 @@
+# setup for service_template
+# require the files that are required before everything else in service_template
+# useful if you want to use any variables/methods defined here without loading the rest of service_template immediately
+require 'active_support'
+
+module ServiceTemplate
+  class << self
+    def load_environment
+      Dotenv.load(ServiceTemplate.env.test? ? '.env.test' : '.env')
+    end
+
+    def skip_initialization
+      @_skip_initialization || false
+    end
+
+    def skip_initialization=(value)
+      @_skip_initialization = value if [TrueClass, FalseClass].include?(value.class)
+    end
+
+    def env
+      @_env ||= ActiveSupport::StringInquirer.new(ENV['RACK_ENV'] || 'development')
+    end
+
+    def env=(environment)
+      @_env = ActiveSupport::StringInquirer.new(environment)
+    end
+
+    def cache
+      @_cache ||= ActiveSupport::Cache.lookup_store(:memory_store)
+    end
+
+    def cache=(store_option)
+      @_cache = ActiveSupport::Cache.lookup_store(store_option)
+    end
+  end
+end

data/lib/service_template/sortable_api.rb

@@ -0,0 +1,17 @@
+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/lib/service_template/stats.rb

@@ -0,0 +1,43 @@
+require 'statsd'
+module ServiceTemplate
+  class Stats
+    class << self
+      def emitter=(emitter)
+        @emitter = emitter
+      end
+
+      def emitter
+        unless @emitter
+          # Log an error if StatsD settings are not configured
+          message = 'StatsD host and port not configured in environment variables, using default settings'
+          ServiceTemplate::Logger.logger.warn message unless ENV['STATSD_HOST'] && ENV['STATSD_PORT']
+
+          # Create a new StatsD emitter with the service name as the namespace
+          # Defaults to localhost port 8125 if env vars are nil
+          @emitter = Statsd.new(ENV['STATSD_HOST'], ENV['STATSD_PORT']).tap { |sd| sd.namespace = namespace }
+        end
+        @emitter
+      end
+
+      def namespace
+        environment = ENV['RACK_ENV'] || 'development'
+
+        if ENV['STATSD_API_KEY'].present?
+          "#{ENV['STATSD_API_KEY']}.#{ServiceTemplate::Identity.name}.#{environment}"
+        else
+          "#{ServiceTemplate::Identity.name}.#{environment}"
+        end
+      end
+
+      def path_to_key(method, path)
+        # split the path on forward slash
+        # remove any elements that are empty
+        # replace any number strings with _
+        # join all parts with a .
+        # prepend with the method
+        # downcase the whole thing
+        "#{method}.#{path.split(/\//).reject{|p| p.empty?}.collect{|p| p.gsub(/\d+/,'_')}.join('.')}".downcase
+      end
+    end
+  end
+end

data/lib/service_template/stats_d_timer.rb

@@ -0,0 +1,26 @@
+module ServiceTemplate
+  module StatsDTimer
+    def report_time(timer_name, sample_rate: 1)
+      if (Time.now.to_f * 1000).to_i % sample_rate == 0
+        start_time = Time.now
+        yield
+        response_time = (Time.now - start_time) * 1000 # statsd reports timers in milliseconds
+        ServiceTemplate::Stats.emitter.timing(timer_name, response_time)
+      else
+        yield
+      end
+    end
+
+    module ClassMethods
+      def report_time(timer_name, sample_rate: 1)
+        new.report_time(timer_name, sample_rate: sample_rate) do
+          yield
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/service_template/version.rb

@@ -0,0 +1,45 @@
+module ServiceTemplate
+  VERSION = '0.5.0'
+
+  class Version
+    class << self
+      def next_major
+        next_level(:major)
+      end
+
+      def next_minor
+        next_level(:minor)
+      end
+
+      def next_patch
+        next_level(:patch)
+      end
+
+      def next_level(level)
+        fail 'Unidentified Level' unless [:major, :minor, :patch].include?(level)
+
+        parts = ServiceTemplate::VERSION.split('.').map { |p| p.to_i }
+
+        if level == :major
+          parts[0] += 1
+          significant_index = 1
+        end
+
+        if level == :minor
+          parts[1] += 1
+          significant_index = 2
+        end
+
+        if level == :patch
+          parts[2] += 1
+          significant_index = 3
+        end
+
+        parts.map.with_index { |p, i| parts[i] = 0 if i >= significant_index }
+
+        parts.join('.')
+      end
+
+    end
+  end
+end

data/lib/tasks/deploy.rake

@@ -0,0 +1,11 @@
+namespace :deploy do
+  desc "Deploy to production"
+  task :production do
+    puts "\033[31mrake deploy:production is deprecated, please use 'service_template deploy production'\033[0m"
+  end
+
+  desc "Deploy to staging"
+  task :staging do
+    puts "\033[31mrake deploy:staging is deprecated, please use 'service_template deploy staging'\033[0m"
+  end
+end

data/lib/tasks/routes.rake

@@ -0,0 +1,11 @@
+unless defined?(Rails)
+  desc "display all routes for Grape"
+  task :routes do
+    ApplicationApi.routes.each do |api|
+      method      = api.route_method.ljust(10)
+      path        = api.route_path.ljust(40)
+      description = api.route_description
+      puts        "     #{method} #{path} # #{description}"
+    end
+  end
+end

data/service_template.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/service_template/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jay OConnor"]
+  gem.email         = ["jay@jayoconnor.com"]
+  gem.description   = %q{An opiniated lib and generator for building APIs with Grape}
+  gem.summary       = %q{An easy-ish way of quickly generating an API using Grape}
+  gem.homepage      = "https://github.com/jdoconnor/service_template"
+  gem.licenses      = ['MIT']
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   << 'service_template'
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "service_template"
+  gem.require_paths = ["lib"]
+  gem.version       = ServiceTemplate::VERSION
+  gem.required_ruby_version = '>= 2.0'
+
+
+  gem.add_dependency 'rake', '~> 10.3'
+  gem.add_dependency 'logging', '~> 1.8'
+  gem.add_dependency 'dotenv', '~> 1.0'
+  gem.add_dependency 'octokit', '~> 3.5'
+  gem.add_dependency 'thor', '~> 0.19'
+  gem.add_dependency 'virtus', '~> 1.0'
+  gem.add_dependency 'grape', '~> 0.11.0'
+  gem.add_dependency 'grape-swagger', '~> 0.8'
+  gem.add_dependency 'roar', '~> 1.0.0'
+  gem.add_dependency 'statsd-ruby', '~> 1.2'
+  gem.add_dependency 'racksh', '~> 1.0'
+  gem.add_dependency 'git', '~> 1.2'
+  gem.add_dependency 'actionpack', '~> 4.2.0'
+
+  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'pry', '~> 0.10'
+  gem.add_development_dependency 'rubocop', '~> 0.25'
+  gem.add_development_dependency 'activerecord', '~> 4.2.0'
+  gem.add_development_dependency 'sqlite3', '~> 1.3'
+  gem.add_development_dependency 'acts_as_fu', '~> 0'
+  gem.add_development_dependency 'codeclimate-test-reporter'
+end

data/spec/active_record_extensions/filter_by_hash_spec.rb

@@ -0,0 +1,23 @@
+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/active_record_extensions/seeder_spec.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'spec_helper'
+require 'service_template/active_record_extensions/seeder'
+
+describe ServiceTemplate::ActiveRecordSeeder do
+
+  context 'when a valid file is not provided' do
+    it 'raises an exception' do
+    	expect{ServiceTemplate::ActiveRecordSeeder.load_file 'not-a-file'}.to raise_error
+    end
+  end
+
+end

data/spec/authentication_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'service_template/authentication'
+
+describe ServiceTemplate::Authentication do
+  context '#password_header' do
+    it "returns a password hash for the request header" do
+      ENV['HEADER_PASSWORD'] = 'foo'
+      expect(ServiceTemplate::Authentication.password_header.class).to eq(Hash)
+      expect(ServiceTemplate::Authentication.password_header).to eq('Password' => 'foo')
+    end
+
+    it 'raises when the HEADER_PASSWORD env var is not defined' do
+      ENV['HEADER_PASSWORD'] = nil
+      expect{ServiceTemplate::Authentication.password_header}.to raise_error
+    end
+  end
+end

data/spec/deprecations/application_api_spec.rb

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

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

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

@@ -0,0 +1,52 @@
+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/api_generator_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'service_template/generators/api_generator'
+require 'service_template/cli'
+
+describe ServiceTemplate::Generators::ApiGenerator do
+  let(:api_name) { 'foo' }
+  let(:test_api_directory) { 'spec/tmp' }
+
+  before do
+    allow_any_instance_of(described_class).to receive(:output_directory).and_return(test_api_directory)
+    ServiceTemplate::CLI::Base.new.generate("api", api_name)
+  end
+
+  after do
+    FileUtils.rm_rf(test_api_directory)
+  end
+
+  describe 'app' do
+    it 'creates an api class' do
+      expected_api_file = File.join(test_api_directory, 'app/apis/foos_api.rb')
+      api_code = File.read(expected_api_file)
+
+      expect(api_code).to match(/class FoosApi/)
+    end
+
+    it 'creates a model class' do
+      expected_model_file = File.join(test_api_directory, 'app/models/foo.rb')
+      model_code = File.read(expected_model_file)
+
+      expect(model_code).to match(/class Foo/)
+    end
+
+    it 'creates a representer class' do
+      expected_representer_file = File.join(test_api_directory, 'app/representers/foo_representer.rb')
+      representer_code = File.read(expected_representer_file)
+
+      expect(representer_code).to match(/class FooRepresenter/)
+    end
+
+    it 'representers should inherit from ServiceTemplate::Representer' do
+      representer_file = File.join(test_api_directory, 'app/representers/foo_representer.rb')
+      require "./#{representer_file}"
+      expect(FooRepresenter.superclass).to be(ServiceTemplate::Representer)
+    end
+  end
+
+  describe 'spec' do
+    it 'creates an api spec' do
+      expected_api_file = File.join(test_api_directory, 'spec/apis/foos_api_spec.rb')
+      api_code = File.read(expected_api_file)
+
+      expect(api_code).to match(/describe FoosApi/)
+    end
+
+    it 'creates a model spec' do
+      expected_model_file = File.join(test_api_directory, 'spec/models/foo_spec.rb')
+      model_code = File.read(expected_model_file)
+
+      expect(model_code).to match(/describe Foo/)
+    end
+  end
+
+end