napa 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0eeeb8e92f9f844abe34b2a0545655227c5d493f
-  data.tar.gz: 2d38e5b45cab67654e24388746a3c46eb168739c
+  metadata.gz: e880773f7d012f8c314fd0d58baf8b321cc0970d
+  data.tar.gz: 0610b2934b4e1edc1a72a0f60883b116240a1f3c
 SHA512:
-  metadata.gz: ac876295c7e2f01d861766a12efe01302ae3b0bf816773cc34e2a99a41fd6698821b5fc86db54f1247383cae5e3656ffe56a472f8c44bae7c3c56ccf385a4ff0
-  data.tar.gz: 9bb036efa3d541e90c8aa20a3b6f088daa6d4f55d17d7acb22e7ffa4786b432aba6513974a2d0459081058b86fc5e70662ba3462a01947634dddfc53453fccb1
+  metadata.gz: 15a72bf0f710f598bb027068fe1e9724fd8a21c5e11eae46e1656d4ac051b48dbe82aeae35b2725c1b3d1a4cf1a5692d5f92bc6732d3be3e34457ec563cce99b
+  data.tar.gz: bafddb18590875dc3439383d62fc2d1974aadef74c4debd94937add6e9786370c69b2c39d0d0ebb2b6df5318a8cf766aba94cb9de532b91c6a89aaf7f5c9ed98

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 master
 ===
 
+0.4.0
+===
+* Added `Napa.cache` to wrap `ActiveSupport::Cache`
+* Added README generator
+* Update the HoneyBadger scaffolding
+* Fixed a bug with Napa::StatsDTimer where time was being reported in seconds, not milliseconds
+* Removed additional StatsD counter metric for request stats middleware
+* Added new deploy CLI with `force` and `revision` options `napa deploy production`
+* Added deprecation warnings
+* Added initialization hook to run code when a Napa service boots
+* Added Migration generators from Rails
+* Added rake db:seed functionality
+* Added some convinience methods to spec_helper
+
 0.3.0
 ===
 * Added `rake db:rollback` to rollback migrations just like Rails

data/README.md

@@ -35,12 +35,14 @@ Run `napa` terminal prompt to see available features:
 
 ```
 Commands:
-  napa console                              # Start the Napa console
-  napa generate api <api_name>              # Create a Grape API, Model and Representer, api_name should be singular i.e. user
-  napa generate migration <migration_name>  # Create a Database Migration
-  napa help [COMMAND]                       # Describe available commands or one specific command
-  napa new <app_name> [app_path]            # Create a scaffold for a new Napa service
-  napa version                              # Shows the Napa version number
+  napa console [environment]                                                            # Start the Napa console
+  napa generate api <api_name>                                                          # Create a Grape API, Model and Representer
+  napa generate migration <migration_name> [field[:type][:index] field[:type][:index]]  # Create a Database Migration
+  napa generate readme                                                                  # Create a formatted README
+  napa deploy <environment>                                                             # Deploy to <environment> by setting a git tag
+  napa help [COMMAND]                                                                   # Describe available commands or one specific command
+  napa new <app_name> [app_path]                                                        # Create a scaffold for a new Napa service
+  napa version                                                                          # Shows the Napa version number
 ```
 
 
@@ -51,6 +53,21 @@ Similar to the Rails console, load an IRB sesson with your applications environm
 napa console
 ```
 
+### Deploy
+Napa provides a CLI for deploying to a given environment by setting a git tag. This is useful for chef-based deploys where deploys are trigged when a git SHA changes.
+
+```sh
+napa deploy production
+Are you sure you want to deploy this service? Y
+#=> <git SHA> tagged as production by danielmackey at October 09, 2014 14:41
+```
+
+If you want to skip the 'Are you sure?' prompt, pass the `--confirm` flag to set the tag automatically
+```sh
+napa deploy production --confirm
+#=> <git SHA> tagged as production by danielmackey at October 09, 2014 14:41
+```
+
 ### Rake Tasks
 
 `rake -T` will give you a list of all available rake tasks:
@@ -62,8 +79,7 @@ rake db:migrate         # Migrate the database through scripts in db/migrate
 rake db:reset           # Create the test database
 rake db:schema:dump     # Create a db/schema.rb file that can be portably used against any DB supported by AR
 rake db:schema:load     # Load a schema.rb file into the database
-rake deploy:production  # Deploy to production
-rake deploy:staging     # Deploy to staging
+rake db:seed            # Load the seed data from db/seeds.rb
 rake git:set_tag[tag]   # Set tag, which triggers deploy
 rake git:verify         # Verify git repository is in a good state for deployment
 rake routes             # display all routes for Grape
@@ -135,6 +151,23 @@ If you want to see the StatsD reporting in action you can hook up the logger to
 Statsd.logger = Napa::Logger.logger
 ```
 
+### Caching
+
+Napa adds a simple wrapper around `ActiveSupport::Cache` that allows you to easily access it similar to how it works in Rails. `Napa.cache` will give you access to all of the methods available in `ActiveSupport::Cache::Store` [http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html](). So, for example:
+
+```
+Napa.cache.read
+Napa.cache.write
+Napa.cache.fetch
+...
+```
+
+By default it will use `:memory_store`, but you can override it to use any other caching strategy, like Memcache by setting the store:
+
+```
+Napa.cache = :dalli_store
+```
+
 ## Bugs & Feature Requests
 Please add an issue in [Github](https://github.com/bellycard/napa/issues) if you discover a bug or have a feature request.
 

data/Rakefile

@@ -2,3 +2,4 @@
 Dir.glob('./tasks/*.rake').each { |r| import r }
 require 'bundler/gem_tasks'
 require 'napa/active_record_extensions/stats.rb'
+require 'napa/active_record_extensions/seeder.rb'

data/docs/grape_entity_to_roar.md

@@ -0,0 +1,110 @@
+Converting from Napa::Entity to Napa::Representer
+=====================================
+
+The fastest way to figure this out is by example.
+
+Here are two objects, an Entity and a Representer, that create the __exact same API response__:
+
+### Entity
+```ruby
+class FooEntity < Napa::Entity
+  root :data, :data
+
+  expose  :some_attr,
+          :other_attr
+
+  expose :weird_name, as: sane_name
+
+  expose :collection_of_things
+
+  expose :id, format_with: to_s, documentation:
+    {type: 'String', description: 'ID'}
+
+  expose :bar, using: BarEntity
+  expose :caz, using: CazEntity, if: lambda { |instance, opts| opts[:blah] == instance.blah }
+
+  expose :use_a_method do
+    some_property < 100
+  end
+end
+```
+
+### Representer
+```ruby
+class FooRepresenter < Napa::Representer
+  property :some_attr
+  property :other_attr
+
+  property :weird_name, as: sane_name
+
+  collection :collection_of_things
+
+  property :id, type: String
+
+  property :bar, decorator: BarRepresenter
+  property :caz, decorator: CazEntity, if: lambda { |opts| opts[:blah] == @blah }
+
+  property :use_a_method, exec_context: :decorator
+
+  def use_a_method
+    represented.some_property < 100
+  end
+
+end
+```
+
+Check out the options on Representers if there are other cases:
+
+https://github.com/apotonick/representable#available-options
+
+### Some Gotchas
+
+In your `Grape::API`, you'll something like this for Entities:
+
+```
+desc 'whatever', entity: FooEntity
+get do
+  # code code
+  present foo, with: FooEntity
+end
+```
+
+Do this instead:
+
+```
+desc 'whatever'
+get do
+  # code code
+  represent foo, with: FooRepresenter
+end
+```
+
+Change `present` to `represent`
+
+---
+
+`Napa::Entity` defines the following convenience methods
+
+```ruby
+  format_with :to_s do |val|
+    val.to_s
+  end
+
+  def object_type
+    object.class.name.underscore
+  end
+```
+
+These may be defined inline for your Entities if they're not using Napa::Entity
+
+---
+
+There is no `Boolean` class in Ruby, but in `Napa:Entity` you can do `type: 'Boolean'`.
+
+If it's a boolean in the database, you don't have to worry about it. If not, convert it in lambda method:
+
+```ruby
+class FooRepresenter < Napa::Representer
+  property :some_string, getter: lambda { |opts| @value == "weird" }
+end
+```

data/docs/quickstart.md

@@ -73,7 +73,7 @@ rspec spec
 
 Now that we have our service scaffolded up, let's generate an API.
 
-Napa include an API generator which will create a Grape API, Model and Representer by running:
+Napa includes an API generator which will create a Grape API, Model and Representer by running:
 
 ```
 napa generate api person
@@ -96,7 +96,7 @@ Done!
 From the output above, we can see that the generated create a `Person` model, so we should create a migration to actually build the table for that in our database. So, let's run:
 
 ```
-napa generate migration CreatePerson
+napa generate migration CreatePerson name job_title email 
 ```
 
 You will see the following output:
@@ -108,7 +108,7 @@ Generating migration...
 Done!
 ```
 
-Open up that migration file and add the migration to create the `people` table:
+Open up that migration file and see the generated migration for the `people` table:
 
 ```ruby
 class CreatePerson < ActiveRecord::Migration
@@ -284,6 +284,32 @@ curl -X PUT -d job_title="Doctor Pepper" http://localhost:9393/people/1
 }
 ```
 
+## README Generator
+
+Now that you have an API service, time to document it!
+
+```
+napa generate readme
+```
+
+**Note:** Napa will have generated a README already, so you'll most likely see the conflict below
+
+You will see the following output:
+
+```
+Generating readme...
+       exist
+    conflict  README.md
+Overwrite /Users/main/workspace/napa/README.md? (enter "h" for help) [Ynaqdh] y
+       force  README.md
+      create  spec/docs/readme_spec.rb
+Done!
+```
+
+Go through the formatted README and fill out all of the sections that have a :bow:
+
+- - -
+
 So, there you have it, a new API service in minutes. It's very basic, but you can continue to build it out from here. One thing to note, we don't generate a `DELETE` request from the generator, but you can easily add that. The resources section below will link you to the Grape docs where you can find those instructions.
 
 ## Resources

data/lib/napa/active_record_extensions/filter_by_hash.rb

@@ -13,6 +13,7 @@ if defined?(ActiveRecord)
       end
 
       def self.included(base)
+        ActiveSupport::Deprecation.warn 'Napa::FilterByHash is deprecated, this module will be removed in future releases', caller
         base.extend(ClassMethods)
       end
     end

data/lib/napa/active_record_extensions/seeder.rb

@@ -0,0 +1,14 @@
+if defined?(ActiveRecord)
+  module Napa
+    class ActiveRecordSeeder
+      def initialize(seed_file)
+        @seed_file = seed_file
+      end
+
+      def load_seed
+        raise "Seed file '#{@seed_file}' does not exist" unless File.file?(@seed_file)
+        load @seed_file
+      end
+    end
+  end
+end

data/lib/napa/cli.rb

@@ -1,7 +1,10 @@
 require 'thor'
 require 'napa/generators'
+require 'napa/deploy'
 require 'napa/version'
 
+Napa.load_environment if defined?(Dotenv)
+
 module Napa
   class CLI
     class Generate < Thor
@@ -15,9 +18,16 @@ module Napa
       register(
         Generators::MigrationGenerator,
         'migration',
-        'migration <migration_name>',
+        'migration <migration_name> [field[:type][:index] field[:type][:index]]',
         'Create a Database Migration'
       )
+
+      register(
+        Generators::ReadmeGenerator,
+        'readme',
+        'readme',
+        'Create a formatted README'
+      )
     end
   end
 
@@ -53,6 +63,19 @@ module Napa
         interpreter.start
       end
 
+      desc 'deploy [target]', 'Deploys A Service to a given target (i.e. production, staging, etc.)'
+      method_options :force => :boolean, :revision => :string, :confirm => :boolean
+      def deploy(environment)
+        if options[:confirm] || yes?('Are you sure you want to deploy this service?', Thor::Shell::Color::YELLOW)
+          deploy = Napa::Deploy.new(environment, force: options[:force], revision: options[:revision])
+          if deploy.deployable?
+            say(deploy.deploy!, Thor::Shell::Color::GREEN)
+          else
+            say("Deploy Failed:\n#{deploy.errors.join("\n")}", Thor::Shell::Color::RED)
+          end
+        end
+      end
+
       register(
         Generators::ScaffoldGenerator,
         'new',
@@ -63,8 +86,11 @@ module Napa
       desc "generate api <api_name>", "Create a Grape API, Model and Representer"
       subcommand "generate api", Napa::CLI::Generate
 
-      desc "generate migration <migration_name>", "Create a Database Migration"
+      desc "generate migration <migration_name> [field[:type][:index] field[:type][:index]]", "Create a Database Migration"
       subcommand "generate", Napa::CLI::Generate
+
+      desc "generate readme", "Create a formatted README"
+      subcommand "generate readme", Napa::CLI::Generate
     end
   end
 end

data/lib/napa/deploy.rb

@@ -0,0 +1,98 @@
+require 'git'
+require 'octokit'
+
+module Napa
+  class Deploy
+    attr_reader :errors, :github_login
+
+    def initialize(environment, revision: nil, force: false, github_repo: nil, github_token: nil)
+      Napa.load_environment
+
+      @github_repo  = github_repo || ENV['GITHUB_REPO']
+      @github_token = github_token || ENV['GITHUB_OAUTH_TOKEN']
+      @environment  = environment
+      @revision     = revision || local_head_revision
+      @force        = force
+
+      @errors       = []
+    end
+
+    def deploy!
+      if deployable?
+        set_github_tag
+        "#{@revision} tagged as #{@environment} by #{@github_login} at #{Time.now.to_s(:long)}"
+      else
+        "Deploy error(s): #{@errors.join(' --- ')}"
+      end
+    end
+
+    def set_github_tag
+      begin
+        github_client.update_ref(
+          @github_repo,
+          "tags/#{@environment}",
+          @revision,
+          @force
+        )
+      rescue Octokit::UnprocessableEntity
+        github_client.create_ref(
+          @github_repo,
+          "tags/#{@environment}",
+          @revision
+        )
+      end
+    end
+
+    def local_repo
+      @local_repo ||= Git.open('.')
+    end
+
+    def local_repo_status
+      @local_repo_status ||= local_repo.status
+    end
+
+    def github_client
+      return @github_client if @github_client
+      @errors << "ENV['GITHUB_REPO'] is not defined" if @github_repo.nil?
+      @errors << "ENV['GITHUB_OAUTH_TOKEN'] is not defined" if @github_token.nil?
+
+      client = Octokit::Client.new(access_token: @github_token)
+      begin
+        @github_login = client.login
+        return @github_client = client
+      rescue Octokit::Unauthorized
+        @errors << "Access denied for GITHUB_OAUTH_TOKEN"
+      end
+    end
+
+    def local_head_revision
+      local_repo.object('HEAD').sha
+    end
+
+    def deployable?
+      revision_exists_on_github?
+      any_local_uncommited_changes?
+      any_local_untracked_files?
+
+      @errors.empty? || @force
+    end
+
+    def revision_exists_on_github?
+      begin
+        github_client.commit(@github_repo, @revision)
+      rescue Octokit::NotFound
+        @errors << "Revision #{@revision} does not exist on #{@github_repo}, make sure you've merged your changes."
+      end
+    end
+
+    def any_local_uncommited_changes?
+      changes = local_repo_status.changed.collect{|change| change[0]}
+      @errors << "#{changes.to_sentence} have been changed and not committed." if changes.any?
+    end
+
+    def any_local_untracked_files?
+      changes = local_repo_status.untracked.collect{|change| change[0]}
+      @errors << "#{changes.to_sentence} file(s) have been added and are not tracked." if changes.any?
+    end
+  end
+end

data/lib/napa/deprecations/active_support_behavior.rb

@@ -0,0 +1,8 @@
+if Napa.env.test?
+  ActiveSupport::Deprecation.behavior = :stderr
+else
+  ActiveSupport::Deprecation.behavior = ->(message, callstack) {
+    # ignoring callstack for now because it's fairly noisy
+    Napa::Logger.logger.info(napa_deprecation_warning: message)
+  }
+end

data/lib/napa/deprecations/application_api.rb

@@ -0,0 +1,9 @@
+module Napa
+  class Deprecations
+    def self.application_api_check
+      unless File.exists?('./app/apis/application_api.rb')
+        ActiveSupport::Deprecation.warn 'no application_api.rb file found in app/apis, see https://github.com/bellycard/napa/blob/master/lib/napa/generators/templates/scaffold/app/apis/application_api.rb for an example', caller
+      end
+    end
+  end
+end

data/lib/napa/deprecations/grape_entity.rb

@@ -0,0 +1,5 @@
+class Grape::Entity
+  def self.inherited(subclass)
+    ActiveSupport::Deprecation.warn 'Use of Grape::Entity is discouraged, please transition your code to Roar representers - https://github.com/bellycard/napa/blob/master/docs/grape_entity_to_roar.md', caller
+  end
+end

data/lib/napa/deprecations/napa_setup.rb

@@ -0,0 +1,38 @@
+module Napa
+  class Deprecations
+    REQUIRED_PATTERNS = [
+      /require 'bundler\/setup'/,
+      /Bundler.setup\(:default\)/,
+      /require 'napa\/setup'/,
+      /Bundler.require\(:default, Napa.env.to_sym\)/,
+      /require 'napa'/,
+      /Napa.load_environment/,
+      /Dir['.\/config\/initializers\/**\/*.rb'].map { |file| require file }/,
+      /Dir['.\/config\/middleware\/**\/*.rb'].map { |file| require file }/,
+      /relative_load_paths/,
+      /ActiveSupport::Dependencies.autoload_paths \+\= relative_load_paths/
+    ]
+
+    EXPIRED_PATTERNS = [
+      /require 'dotenv'/,
+      "RACK_ENV = ENV['RACK_ENV']",
+      "if RACK_ENV == 'test'",
+      /Dotenv.load\(".env.test"\)/,
+      /Dotenv.load\(Napa.env.test\? \? '.env.test' : '.env'\)/,
+      /Bundler.require :default, RACK_ENV/,
+      /require 'will_paginate'/,
+      /require 'will_paginate\/active_record'/
+    ]
+
+    def self.napa_setup_check
+      required_patterns_regex = Regexp.union(REQUIRED_PATTERNS)
+      expired_patterns_regex = Regexp.union(EXPIRED_PATTERNS)
+
+      if File.exists?('./app.rb')
+        if File.readlines('./app.rb').grep(expired_patterns_regex).any? || (File.readlines('./app.rb').grep(required_patterns_regex).count < REQUIRED_PATTERNS.count)
+          ActiveSupport::Deprecation.warn 'app.rb is out of date, please update your configuration', caller
+        end
+      end
+    end
+  end
+end

data/lib/napa/deprecations.rb

@@ -0,0 +1,13 @@
+require 'napa/deprecations/active_support_behavior'
+require 'napa/deprecations/application_api'
+require 'napa/deprecations/napa_setup'
+require 'napa/deprecations/grape_entity'
+
+module Napa
+  class Deprecations
+    def self.initialization_checks
+      napa_setup_check
+      application_api_check
+    end
+  end
+end

data/lib/napa/gem_dependency.rb

@@ -0,0 +1,37 @@
+require 'active_support/json'
+
+module Napa
+  class GemDependency
+    def self.log_all
+      Napa::Logger.logger.info(gems: list_all.as_json)
+    end
+
+    def self.list_all
+      Gem.loaded_specs.map { |spec| new(spec).to_hash }
+    end
+
+    def initialize(spec)
+      @spec = spec[1]
+    end
+
+    def name
+      @spec.name
+    end
+
+    def version
+      @spec.version.to_s
+    end
+
+    def git_version
+      @spec.git_version
+    end
+
+    def to_hash
+      {}.tap do |h|
+        h[:name] = name
+        h[:version] = version
+        h[:git_version] = git_version if git_version
+      end
+    end
+  end
+end