gris 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7a9d87376c3a34905e0ae62a2cf778917964e9a
-  data.tar.gz: beb8cd90e47c105a9465cca0d212c09ee12e98ae
+  metadata.gz: cbd71571b5bfda09a79619eecef2b1e7bf959691
+  data.tar.gz: cf81127408c56950feb8a08908717706e9fd504f
 SHA512:
-  metadata.gz: 9a4b903572ba4db5c49f94a7492881cbea0e31e2dfc90114f145f52150474790974d33d074c50bbdf2a09c4cad938ce097d2b5aec74cf938d530fb70cd2b5018
-  data.tar.gz: bb006bd646aebde08d0fe1a313d975bdc4ae106fcec1965a11d5407b3141c2bccba335dc34e5ce5b067aaddc8c89742e24e85dd73f59aabb9bdbc3eaa3203b07
+  metadata.gz: efd0cfecb9e6c05bc34266586e708239a2e595b29f121f98a7989e34128331b433f8bd97c51a452f4bd820d3a3c6703d07ca9f3196fd6715807065cbbb0bbc18
+  data.tar.gz: e658cb42d8548d4db4abd82b954a4728a6589ac00b7770780e423c3000a7c30e9cf081dfdffb815a935f43b6701abfaef0ba7b324f0b6a370f52be1c8c4841da

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    gris (0.1.6)
+    gris (0.1.7)
       activesupport (~> 4.2, >= 4.2.0)
+      chronic (~> 0.10.0)
       dotenv (~> 1.0.2, >= 1.0.2)
       git (~> 1.2, >= 1.2.8)
       grape (~> 0.11.0, >= 0.11.0)
@@ -47,6 +48,7 @@ GEM
       columnize (= 0.9.0)
     celluloid (0.16.0)
       timers (~> 4.0.0)
+    chronic (0.10.2)
     coderay (1.1.0)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)

data/Rakefile

@@ -9,6 +9,7 @@ RSpec::Core::RakeTask.new
 desc 'Run RuboCop'
 RuboCop::RakeTask.new(:rubocop) do |task|
   task.fail_on_error = true
+  task.options = %w(-D --auto-correct)
 end
 
 task default: [:rubocop, :spec]

data/gris.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'roar', '~> 1.0.1'
   s.add_dependency 'racksh', '~> 1.0'
   s.add_dependency 'hashie-forbidden_attributes', '~> 0.1.0'
+  s.add_dependency 'chronic', '~> 0.10.0'
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rspec', '~> 3.2'

data/lib/gris.rb

@@ -17,6 +17,7 @@ require 'gris/deprecations'
 require 'gris/grape_extensions/crud_helpers'
 require 'gris/grape_extensions/error_helpers'
 require 'gris/grape_extensions/authentication_helpers'
+require 'gris/grape_extensions/date_time_helpers'
 require 'gris/identity'
 require 'gris/middleware/health'
 require 'gris/output_formatters/paginated_presenter'

data/lib/gris/generators/templates/scaffold/{.env.tt → .env.example.tt}

@@ -3,9 +3,9 @@
 
 SERVICE_NAME=<%= app_name %>
 
-DATABASE_USER='<%= @database_user %>'
+DATABASE_USER='postgres'
 DATABASE_PASSWORD=''
 DATABASE_HOST=localhost
 DATABASE_NAME=<%= app_name.underscore %>_development
-BASE_URL=http://127.0.0.1:9292
+BASE_URL=http://127.0.0.1:9393
 PERMITTED_TOKENS=replace-me

data/lib/gris/generators/templates/scaffold/.gitignore.tt

@@ -2,7 +2,8 @@
 .env
 .rspec
 .env
-!.env.test
+.env.*
+!.env.example
 !log/.keep
 log/*
 tmp/*

data/lib/gris/generators/templates/scaffold/Gemfile.tt

@@ -16,6 +16,7 @@ gem 'puma'
 
 group :development, :test do
   gem 'pry'
+  gem 'hyperclient', '0.7.0'
 end
 
 group :development do

data/lib/gris/generators/templates/scaffold/README.md.tt

@@ -1,3 +1,29 @@
-# Welcome to <%= app_name %>
+<%= app_name %>
+====
+
+This is a Grape + Rack ([Gris](http://github.com/dylanfareed/gris)) hypermedia API service.
+
+
+Set-Up for Development
+---
+
+- Fork this repo
+- Clone your fork locally
+- Bundle
+```
+cd your-fork-directory
+bundle
+```
+- `DATABASE_NAME` and `PERMITTED_TOKENS` are required environment variables. Prior to executing rake tasks, running the gris console or booting the application, set up your environment by doing **one** of the following:
+  * Use [Dotenv](https://github.com/bkeepers/dotenv)—copy `.env.example` to `.env` and `.env.test` and modify it where appropriate
+  * Export the minimum required environment variables `DATABASE_NAME` and `PERMITTED_TOKENS`
+- Set up the database
+```
+DATABASE_NAME= PERMITTED_TOKENS= bundle exec rake db:create
+DATABASE_NAME= PERMITTED_TOKENS= bundle exec rake db:migrate
+```
+- Verify that [Rubocop](https://github.com/bbatsov/rubocop) and specs pass.
+```
+DATABASE_NAME= PERMITTED_TOKENS= bundle exec rake
+```
 
-TODO: Add an awesome README that explains how all this stuff works!

data/lib/gris/generators/templates/scaffold/Rakefile

@@ -1,8 +1,17 @@
 #!/usr/bin/env rake
-require 'gris/setup'
-Gris.load_environment
-
-require File.expand_path('../config/application.rb', __FILE__)
-require 'json'
+require File.expand_path('../config/boot', __FILE__)
 
 Dir.glob('./lib/tasks/*.rake').each { |r| import r }
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.options = %w(-D --auto-correct)
+end
+
+task default: [:rubocop, :spec]

data/lib/gris/generators/templates/scaffold/config/application.rb.tt

@@ -1,5 +1,12 @@
 require File.expand_path('../boot', __FILE__)
 
+# autoload initalizers
+Dir['./config/initializers/**/*.rb'].map { |file| require file }
+
+# autoload app
+relative_load_paths = %w(app/endpoints app/presenters app/models)
+ActiveSupport::Dependencies.autoload_paths += relative_load_paths
+
 module <%= app_name.classify %>
   class Application < Gris::Application
     # config.use_health_middleware = false

data/lib/gris/generators/templates/scaffold/config/boot.rb

@@ -1,16 +1,7 @@
 # load bundler
 require 'bundler/setup'
-Bundler.setup(:default)
-
 require 'gris/setup'
+
 Bundler.require(:default, Gris.env.to_sym)
 
-# load environment
 Gris.load_environment
-
-# autoload initalizers
-Dir['./config/initializers/**/*.rb'].map { |file| require file }
-
-# autoload app
-relative_load_paths = %w(app/endpoints app/presenters app/models)
-ActiveSupport::Dependencies.autoload_paths += relative_load_paths

data/lib/gris/generators/templates/scaffold/config/initializers/active_record.rb

@@ -1,4 +1,8 @@
 require 'erb'
-db = YAML.load(ERB.new(File.read('./config/database.yml')).result)[Gris.env]
-ActiveRecord::Base.establish_connection(db)
+if ENV['DATABASE_URL']
+  ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+else
+  db = YAML.load(ERB.new(File.read('./config/database.yml')).result)[Gris.env]
+  ActiveRecord::Base.establish_connection(db)
+end
 ActiveRecord::Base.include_root_in_json = false

data/lib/gris/grape_extensions/crud_helpers.rb

@@ -17,6 +17,7 @@ module Gris
 
     def permitted_params(options = {})
       options = { include_missing: false }.merge(options)
+      process_datetime_params(params) if keys_to_convert
       declared(params, options)
     end
 

data/lib/gris/grape_extensions/date_time_helpers.rb

@@ -0,0 +1,34 @@
+require 'chronic'
+
+module Gris
+  module DateTimeHelpers
+    extend ActiveSupport::Concern
+
+    # define keys that need to be converted from strings
+    # to datetime via Chronic
+    def datetime_params(*keys_to_convert)
+      @datetime_keys_to_convert = Set.new(keys_to_convert)
+    end
+
+    def keys_to_convert
+      @datetime_keys_to_convert
+    end
+
+    def process_datetime_params(params)
+      params.keys.each do |key|
+        if keys_to_convert.include?(key)
+          params[key] = string_to_datetime(params[key])
+        end
+      end
+    end
+
+    def string_to_datetime(string)
+      return string if string.blank?
+      if string.to_s =~ /^\d+$/
+        Time.at(string.to_i).to_datetime.utc
+      else
+        Chronic.parse(string).try(:utc)
+      end
+    end
+  end
+end

data/lib/gris/version.rb

@@ -1,5 +1,5 @@
 module Gris
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 
   class Version
     class << self

data/spec/generators/scaffold_generator_spec.rb

@@ -35,9 +35,9 @@ describe Gris::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.example file with with a development database name' do
+      expect(File).to exist("#{app_path}/.env.example")
+      env_file = File.read("#{app_path}/.env.example")
       expect(env_file).to match(/#{app_name}_development/)
     end
 
@@ -47,10 +47,10 @@ describe Gris::Generators::ScaffoldGenerator do
       expect(env_file).to match(/web: bundle exec puma/)
     end
 
-    it 'creates a .env.test file with a test database name' do
-      expect(File).to exist("#{app_path}/.env.test")
-      env_test_file = File.read("#{app_path}/.env.test")
-      expect(env_test_file).to match(/#{app_name}_test/)
+    it 'creates a .env.example file with a development database name' do
+      expect(File).to exist("#{app_path}/.env.example")
+      env_test_file = File.read("#{app_path}/.env.example")
+      expect(env_test_file).to match(/#{app_name}_development/)
     end
 
     it 'selects postgresql as the default database adapter' do

data/spec/grape_extensions/crud_helpers_spec.rb

@@ -2,4 +2,22 @@ require 'spec_helper'
 require 'gris/grape_extensions/crud_helpers'
 
 describe Gris::CrudHelpers do
+  before do
+    @helper = SpecCrudHelper.new
+  end
+
+  it 'returns permitted_params' do
+    @helper.params = { id: 1 }
+    expect(@helper.permitted_params).to eq(id: 1)
+  end
+
+  it 'uses date time helpers' do
+    @helper.datetime_params :created_at
+    @helper.params = { message: 'hi', created_at: 1_293_901_200 }
+    expected = {
+      created_at: 'Sat, 01 Jan 2011 17:00:00 +0000',
+      message: 'hi'
+    }
+    expect(@helper.permitted_params).to eq(expected)
+  end
 end

data/spec/grape_extensions/date_time_helpers_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'gris/grape_extensions/date_time_helpers'
+
+describe Gris::DateTimeHelpers do
+  before do
+    @helper = Class.new do
+      include Gris::DateTimeHelpers
+    end.new
+  end
+
+  it 'parses a date string' do
+    MY_TIME = '2011-01-02 17:00:23 UTC'
+    actual = @helper.string_to_datetime(MY_TIME)
+    expect(actual.to_s).to eq(MY_TIME)
+  end
+
+  it 'converts seconds since epoch' do
+    SECONDS = '1429823204'
+    actual = @helper.string_to_datetime(SECONDS)
+    expect(actual).to eq(Time.at(SECONDS.to_i))
+  end
+
+  it "returns '' for a blank string" do
+    expect(@helper.string_to_datetime('')).to eq('')
+  end
+
+  it 'returns nil for a nil string' do
+    expect(@helper.string_to_datetime(nil)).to be_nil
+  end
+
+  it 'sets the keys to be converted' do
+    @helper.datetime_params :created_at, :updated_at
+    expect(@helper.keys_to_convert).to eq(Set.new([:created_at, :updated_at]))
+  end
+
+  it 'converts the correct keys' do
+    @helper.datetime_params :created_at, :updated_at
+    params = { message: 'hi', created_at: 1_293_901_200, updated_at: 1_325_397_600 }
+    @helper.process_datetime_params(params)
+    expect(params[:message]).to eq('hi')
+    expect(params[:created_at].strftime).to eq('2011-01-01T17:00:00+00:00')
+    expect(params[:updated_at].strftime).to eq('2012-01-01T06:00:00+00:00')
+  end
+end

data/spec/support/spec_crud_helper.rb

@@ -0,0 +1,9 @@
+class SpecCrudHelper
+  include Gris::CrudHelpers
+  include Gris::DateTimeHelpers
+  attr_accessor :params
+
+  def declared(params, _options)
+    params
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gris
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -220,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -330,8 +344,7 @@ files:
 - lib/gris/generators/templates/api/spec/models/%name_underscore%_spec.rb.tt
 - lib/gris/generators/templates/create_table_migration/%migration_filename%.rb.tt
 - lib/gris/generators/templates/migration/%migration_filename%.rb.tt
-- lib/gris/generators/templates/scaffold/.env.test.tt
-- lib/gris/generators/templates/scaffold/.env.tt
+- lib/gris/generators/templates/scaffold/.env.example.tt
 - lib/gris/generators/templates/scaffold/.gitignore.tt
 - lib/gris/generators/templates/scaffold/.rspec.tt
 - lib/gris/generators/templates/scaffold/.rubocop.yml
@@ -354,6 +367,7 @@ files:
 - lib/gris/generators/templates/scaffold/spec/support/app_helper.rb.tt
 - lib/gris/grape_extensions/authentication_helpers.rb
 - lib/gris/grape_extensions/crud_helpers.rb
+- lib/gris/grape_extensions/date_time_helpers.rb
 - lib/gris/grape_extensions/error_helpers.rb
 - lib/gris/identity.rb
 - lib/gris/middleware/health.rb
@@ -371,11 +385,13 @@ files:
 - spec/generators/scaffold_generator_spec.rb
 - spec/grape_extensions/authentication_helpers_spec.rb
 - spec/grape_extensions/crud_helpers_spec.rb
+- spec/grape_extensions/date_time_helpers_spec.rb
 - spec/grape_extensions/error_helpers_spec.rb
 - spec/identity_spec.rb
 - spec/spec_helper.rb
 - spec/support/spec_api_auth_helper.rb
 - spec/support/spec_api_error_helper.rb
+- spec/support/spec_crud_helper.rb
 - spec/support/spec_generators_helper.rb
 - spec/version_spec.rb
 homepage: http://github.com/dylanfareed/gris/
@@ -408,10 +424,12 @@ test_files:
 - spec/generators/scaffold_generator_spec.rb
 - spec/grape_extensions/authentication_helpers_spec.rb
 - spec/grape_extensions/crud_helpers_spec.rb
+- spec/grape_extensions/date_time_helpers_spec.rb
 - spec/grape_extensions/error_helpers_spec.rb
 - spec/identity_spec.rb
 - spec/spec_helper.rb
 - spec/support/spec_api_auth_helper.rb
 - spec/support/spec_api_error_helper.rb
+- spec/support/spec_crud_helper.rb
 - spec/support/spec_generators_helper.rb
 - spec/version_spec.rb

data/lib/gris/generators/templates/scaffold/.env.test.tt

@@ -1,12 +0,0 @@
-# Uncomment when using Gris::Middleware::Authentication
-# HEADER_PASSWORD=''
-
-SERVICE_NAME=<%= app_name %>
-RACK_ENV=test
-
-DATABASE_USER=''
-DATABASE_PASSWORD=''
-DATABASE_HOST=localhost
-DATABASE_NAME=<%= app_name.underscore %>_test
-BASE_URL=http://127.0.0.1:9393
-PERMITTED_TOKENS=replace-me