pliny 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7fbff3373db889d7b52ffa893a452c05253aa06
-  data.tar.gz: b370bc0af3c5b543bbc64a8410628ec8300e0caa
+  metadata.gz: 0b3d302c95bbb9e4efdc88a49e8a5b776e6da923
+  data.tar.gz: dd49138a22449f1ac5311ecface0e021e3a61e2c
 SHA512:
-  metadata.gz: 51c1c3f22d6b9bd3ee954ab6812ea47234d7a1330b174cf11d0ce4fc8b11c814f37e9868113076940e651652e8532175357e59a224db5946f3023303f177460d
-  data.tar.gz: 123dc25a74c7d1ea2df8a61dc33c28a9d60c64c6938a31166715e029ad8aec6bdacbf5e6ea61452c02b92631ead20bacf999579363320dbefcf451df1849e2c6
+  metadata.gz: 114580f793a3db337e548ca506e85019d35376d4d6d59fcbc0501c45e3e6b52a7495e5074bdaaf58f5f54d19e10c68ebb478f346d36a2ccc1be713293cd07301
+  data.tar.gz: 60e5461d06bce0f370b6a2640731709623154e3bdaee6a7f6676f04898e194f1b1f662638c3cdd585a6a155a1d7bf4ca749750e6bed2e67611f2b6e15fbf4a6d

data/README.md

@@ -23,7 +23,6 @@ And gems/helpers to tie these together and support operations:
 - [Rack-test](https://github.com/brynary/rack-test) to test the API endpoints
 - [Request IDs](lib/pliny/middleware/request_id.rb)
 - [RequestStore](http://brandur.org/antipatterns), thread safe option to store data with the current request
-- [RR](https://github.com/rr/rr/blob/master/doc/03_api_overview.md) for amazing mocks and stubs
 - [Sequel](http://sequel.jeremyevans.net/) for ORM
 - [Sequel-PG](https://github.com/jeremyevans/sequel_pg) because we don't like mysql
 - [Versioning](lib/pliny/middleware/versioning.rb) to allow versioning your API in the HTTP Accept header

data/lib/pliny/templates/endpoint_acceptance_test.erb

@@ -8,33 +8,49 @@ describe Endpoints::<%= plural_class_name %> do
     Routes
   end
 
-  it "GET <%= url_path %>" do
-    get "<%= url_path %>"
-    last_response.status.should eq(200)
-    last_response.body.should eq("[]")
+  def schema_path
+    "./docs/schema.json"
   end
 
-  it "POST <%= url_path %>/:id" do
-    post "<%= url_path %>"
-    last_response.status.should eq(201)
-    last_response.body.should eq("{}")
+  describe 'GET <%= url_path %>' do
+    it 'returns correct status code and conforms to schema' do
+      get '<%= url_path %>'
+      expect(last_response.status).to eq(200)
+      assert_schema_conform
+    end
   end
 
-  it "GET <%= url_path %>/:id" do
-    get "<%= url_path %>/123"
-    last_response.status.should eq(200)
-    last_response.body.should eq("{}")
+  describe 'POST <%= url_path %>/:id' do
+    it 'returns correct status code and conforms to schema' do
+      header "Content-Type", "application/json"
+      post '<%= url_path %>', MultiJson.encode({})
+      expect(last_response.status).to eq(201)
+      assert_schema_conform
+    end
   end
 
-  it "PATCH <%= url_path %>/:id" do
-    patch "<%= url_path %>/123"
-    last_response.status.should eq(200)
-    last_response.body.should eq("{}")
+  describe 'GET <%= url_path %>/:id' do
+    it 'returns correct status code and conforms to schema' do
+      get "<%= url_path %>/123"
+      expect(last_response.status).to eq(200)
+      assert_schema_conform
+    end
   end
 
-  it "DELETE <%= url_path %>/:id" do
-    delete "<%= url_path %>/123"
-    last_response.status.should eq(200)
-    last_response.body.should eq("{}")
+  describe 'PATCH <%= url_path %>/:id' do
+    it 'returns correct status code and conforms to schema' do
+      header "Content-Type", "application/json"
+      patch '<%= url_path %>/123', MultiJson.encode({})
+      expect(last_response.status).to eq(200)
+      assert_schema_conform
+    end
+  end
+
+  describe 'DELETE <%= url_path %>/:id' do
+    it 'returns correct status code and conforms to schema' do
+      delete '<%= url_path %>/123'
+      expect(last_response.status).to eq(200)
+      assert_schema_conform
+    end
   end
 end

data/lib/pliny/templates/endpoint_scaffold.erb

@@ -37,12 +37,8 @@ module Endpoints
 
       private
 
-      def serialize(data)
-        {
-          created_at: data.created_at.try(:iso8601),
-          id:         data.uuid,
-          updated_at: data.updated_at.try(:iso8601),
-        }
+      def serialize(data, structure = :default)
+        Serializers::<%= singular_class_name %>.new(structure).serialize(data)
       end
     end
   end

data/lib/pliny/templates/endpoint_scaffold_acceptance_test.erb

@@ -20,37 +20,47 @@ describe Endpoints::<%= plural_class_name %> do
     @<%= field_name %>.save
   end
 
-  it "GET <%= url_path %>" do
-    get "<%= url_path %>"
-    last_response.status.should eq(200)
-    assert_schema_conform
+  describe 'GET <%= url_path %>' do
+    it 'returns correct status code and conforms to schema' do
+      get '<%= url_path %>'
+      expect(last_response.status).to eq(200)
+      assert_schema_conform
+    end
   end
 
 =begin
-  it "POST <%= url_path %>" do
-    header "Content-Type", "application/json"
-    post "<%= url_path %>", MultiJson.encode({})
-    last_response.status.should eq(201)
-    assert_schema_conform
+  describe 'POST <%= url_path %>/:id' do
+    it 'returns correct status code and conforms to schema' do
+      header "Content-Type", "application/json"
+      post '<%= url_path %>', MultiJson.encode({})
+      expect(last_response.status).to eq(201)
+      assert_schema_conform
+    end
   end
 =end
 
-  it "GET <%= url_path %>/:id" do
-    get "<%= url_path %>/#{@<%= field_name %>.uuid}"
-    last_response.status.should eq(200)
-    assert_schema_conform
+  describe 'GET <%= url_path %>/:id' do
+    it 'returns correct status code and conforms to schema' do
+      get "<%= url_path %>/#{@<%= field_name %>.uuid}"
+      expect(last_response.status).to eq(200)
+      assert_schema_conform
+    end
   end
 
-  it "PATCH <%= url_path %>/:id" do
-    header "Content-Type", "application/json"
-    patch "<%= url_path %>/#{@<%= field_name %>.uuid}", MultiJson.encode({})
-    last_response.status.should eq(200)
-    assert_schema_conform
+  describe 'PATCH <%= url_path %>/:id' do
+    it 'returns correct status code and conforms to schema' do
+      header "Content-Type", "application/json"
+      patch "<%= url_path %>/#{@<%= field_name %>.uuid}", MultiJson.encode({})
+      expect(last_response.status).to eq(200)
+      assert_schema_conform
+    end
   end
 
-  it "GET <%= url_path %>/:id" do
-    delete "<%= url_path %>/#{@<%= field_name %>.uuid}"
-    last_response.status.should eq(200)
-    assert_schema_conform
+  describe 'DELETE <%= url_path %>/:id' do
+    it 'returns correct status code and conforms to schema' do
+      delete "<%= url_path %>/#{@<%= field_name %>.uuid}"
+      expect(last_response.status).to eq(200)
+      assert_schema_conform
+    end
   end
 end

data/lib/pliny/templates/endpoint_test.erb

@@ -10,7 +10,7 @@ describe Endpoints::<%= plural_class_name %> do
   describe "GET <%= url_path %>" do
     it "succeeds" do
       get "<%= url_path %>"
-      last_response.status.should eq(200)
+      expect(last_response.status).to eq(200)
     end
   end
 end

data/lib/pliny/templates/serializer.erb

@@ -10,6 +10,9 @@
 <%=  ident %>class <%= modules.last %> < Serializers::Base
 <%=  ident %>  structure(:default) do |arg|
 <%=  ident %>    {
+<%=  ident %>      created_at: arg.created_at.try(:iso8601),
+<%=  ident %>      id:         arg.uuid,
+<%=  ident %>      updated_at: arg.updated_at.try(:iso8601),
 <%=  ident %>    }
 <%=  ident %>  end
 <%=  ident %>end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/template/.env.test

@@ -1,5 +1,5 @@
 DATABASE_URL=postgres://localhost/pliny-test
 RACK_ENV=test
 TZ=UTC
-RESCUE_ERRORS=false
+RAISE_ERRORS=true
 FORCE_SSL=false

data/template/Gemfile

@@ -1,20 +1,27 @@
 source "https://rubygems.org"
 ruby "2.1.2"
 
-gem "honeybadger", '~> 1.14'
 gem "multi_json"
 gem "oj"
 gem "pg"
 gem "pliny"
+gem "pry"
+gem "pry-doc"
 gem "puma"
 gem "rack-ssl"
 gem "rake"
+gem "rollbar"
 gem "sequel"
 gem "sequel-paranoid"
 gem "sequel_pg", require: "sequel"
 gem "sinatra", require: "sinatra/base"
 gem "sinatra-contrib", require: ["sinatra/namespace", "sinatra/reloader"]
 gem "sinatra-router"
+gem "sucker_punch"
+
+group :development, :test do
+  gem "pry-byebug"
+end
 
 group :development do
   gem "foreman"
@@ -24,7 +31,5 @@ group :test do
   gem "committee"
   gem "database_cleaner"
   gem "rack-test"
-  gem "rr", require: false
-  gem "rspec-core"
-  gem "rspec-expectations"
+  gem "rspec"
 end

data/template/Gemfile.lock

@@ -8,26 +8,33 @@ GEM
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
     backports (3.6.0)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    columnize (0.8.9)
     committee (0.4.13)
       multi_json (> 0.0)
       rack (> 0.0)
     database_cleaner (1.2.0)
+    debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
     dotenv (0.7.0)
     erubis (2.7.0)
     foreman (0.67.0)
       dotenv (~> 0.7.0)
       thor (~> 0.17.0)
-    honeybadger (1.15.0)
-      json
     http_accept (0.1.5)
     i18n (0.6.9)
     json (1.8.1)
-    minitest (5.3.4)
+    method_source (0.8.2)
+    minitest (5.3.5)
     multi_json (1.10.1)
     oj (2.9.0)
     pg (0.17.1)
-    pliny (0.0.3)
+    pliny (0.1.0)
       activesupport (~> 4.1, >= 4.1.0)
       http_accept (~> 0.1, >= 0.1.5)
       multi_json (~> 1.9, >= 1.9.3)
@@ -38,6 +45,16 @@ GEM
       sinatra-router (~> 0.2, >= 0.2.3)
     prmd (0.3.2)
       erubis (~> 2.7)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-byebug (1.3.2)
+      byebug (~> 2.7)
+      pry (~> 0.9.12)
+    pry-doc (0.6.0)
+      pry (~> 0.9)
+      yard (~> 0.8)
     puma (2.8.2)
       rack (>= 1.1, < 2.0)
     rack (1.5.2)
@@ -48,10 +65,20 @@ GEM
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (10.3.1)
-    rr (1.1.2)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
+    rollbar (0.12.20)
+      multi_json (~> 1.3)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
     sequel (4.11.0)
     sequel-paranoid (0.4.3)
       sequel
@@ -71,11 +98,16 @@ GEM
       tilt (~> 1.3)
     sinatra-router (0.2.3)
       sinatra (~> 1.4)
+    slop (3.5.0)
+    sucker_punch (1.0.5)
+      celluloid (~> 0.15.2)
     thor (0.17.0)
     thread_safe (0.3.4)
     tilt (1.4.1)
+    timers (1.1.0)
     tzinfo (1.2.1)
       thread_safe (~> 0.1)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
@@ -84,21 +116,23 @@ DEPENDENCIES
   committee
   database_cleaner
   foreman
-  honeybadger (~> 1.14)
   multi_json
   oj
   pg
   pliny
+  pry
+  pry-byebug
+  pry-doc
   puma
   rack-ssl
   rack-test
   rake
-  rr
-  rspec-core
-  rspec-expectations
+  rollbar
+  rspec
   sequel
   sequel-paranoid
   sequel_pg
   sinatra
   sinatra-contrib
   sinatra-router
+  sucker_punch

data/template/bin/console

@@ -1,9 +1,31 @@
 #!/usr/bin/env ruby
 
-require "irb"
-require "irb/completion"
 require "bundler"
 Bundler.require
 require "./lib/initializer"
 
-IRB.start
+def basic_prompt(target_self, nest_level, pry)
+  # override CONSOLE_BANNER to include something like a release identifier
+  nesting = nest_level.zero? ? "" : ":#{nest_level}"
+  "[#{pry.input_array.size}] #{console_prefix}(#{Pry.view_clip(target_self)})#{nesting}"
+end
+
+def console_prefix
+  if Config.console_banner
+    Config.console_banner
+  elsif Config.rack_env == "production"
+    "production"
+  end
+end
+
+Pry.prompt = [
+   proc { |target_self, nest_level, pry|
+     basic_prompt(target_self, nest_level, pry) + "> "
+   },
+
+   proc { |target_self, nest_level, pry|
+     basic_prompt(target_self, nest_level, pry) + "* "
+   }
+]
+
+Pry.start

data/template/config/config.rb

@@ -19,7 +19,7 @@ module Config
 
   # Optional -- value is returned or `nil` if it wasn't present.
   optional \
-    :honeybadger_api_key,
+    :console_banner,
     :placeholder,
     :versioning_default,
     :versioning_app_name
@@ -32,7 +32,8 @@ module Config
     puma_min_threads: 1,
     puma_workers:     3,
     rack_env:         'development',
-    rescue_errors:    'true',
+    raise_errors:     'false',
+    root:             File.expand_path("../../", __FILE__),
     timeout:          45,
     force_ssl:        'true',
     versioning:       'false'

data/template/config/initializers/rollbar.rb

@@ -0,0 +1,5 @@
+Rollbar.configure do |config|
+  config.access_token = ENV["ROLLBAR_ACCESS_TOKEN"]
+  config.use_sucker_punch
+end
+

data/template/lib/endpoints/base.rb

@@ -3,8 +3,13 @@ module Endpoints
   class Base < Sinatra::Base
     register Pliny::Extensions::Instruments
     register Sinatra::Namespace
+
     helpers Pliny::Helpers::Params
 
+    set :dump_errors, false
+    set :raise_errors, true
+    set :show_exceptions, false
+
     configure :development do
       register Sinatra::Reloader
     end

data/template/lib/initializer.rb

@@ -7,7 +7,7 @@ module Initializer
   end
 
   def self.require_config
-    require! "config/config"
+    require_relative "../config/config"
   end
 
   def self.require_lib
@@ -29,19 +29,15 @@ module Initializer
   end
 
   def self.require_initializers
-    Pliny::Utils.require_glob("#{root}/config/initializers/*.rb")
+    Pliny::Utils.require_glob("#{Config.root}/config/initializers/*.rb")
   end
 
   def self.require!(globs)
     globs = [globs] unless globs.is_a?(Array)
     globs.each do |f|
-      Pliny::Utils.require_glob("#{root}/#{f}.rb")
+      Pliny::Utils.require_glob("#{Config.root}/#{f}.rb")
     end
   end
-
-  def self.root
-    @@root ||= File.expand_path("../../", __FILE__)
-  end
 end
 
 Initializer.run

data/template/lib/routes.rb

@@ -1,16 +1,15 @@
 Routes = Rack::Builder.new do
-  use Pliny::Middleware::RescueErrors, raise: !Config.rescue_errors?
-  use Honeybadger::Rack::ErrorNotifier if Config.honeybadger_api_key
+  use Pliny::Middleware::RescueErrors, raise: Config.raise_errors?
   use Pliny::Middleware::CORS
   use Pliny::Middleware::RequestID
   use Pliny::Middleware::RequestStore, store: Pliny::RequestStore
   use Pliny::Middleware::Timeout, timeout: Config.timeout.to_i if Config.timeout.to_i > 0
   use Pliny::Middleware::Versioning,
       default: Config.versioning_default,
-      app_name: Config.versioning_app_name if Config.versioning.downcase == 'true'
+      app_name: Config.versioning_app_name if Config.versioning?
   use Rack::Deflater
   use Rack::MethodOverride
-  use Rack::SSL if Config.force_ssl.downcase == 'true'
+  use Rack::SSL if Config.force_ssl?
 
   use Pliny::Router do
     # mount all endpoints here

data/template/spec/spec_helper.rb

@@ -10,8 +10,6 @@ ENV["RACK_ENV"] = "test"
 require "bundler"
 Bundler.require(:default, :test)
 
-require "rr"
-
 root = File.expand_path("../../", __FILE__)
 ENV.update(Pliny::Utils.parse_env("#{root}/.env.test"))
 
@@ -20,11 +18,9 @@ require_relative "../lib/initializer"
 DatabaseCleaner.strategy = :transaction
 
 # pull in test initializers
-Pliny::Utils.require_glob("#{Initializer.root}/spec/support/**/*.rb")
+Pliny::Utils.require_glob("#{Config.root}/spec/support/**/*.rb")
 
 RSpec.configure do |config|
-  config.mock_framework = :rr
-
   config.before :all do
     load('db/seeds.rb') if File.exist?('db/seeds.rb')
   end
@@ -37,7 +33,6 @@ RSpec.configure do |config|
     DatabaseCleaner.clean
   end
 
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
@@ -46,4 +41,9 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
+
+  # the rack app to be tested with rack-test:
+  def app
+    @rack_app || fail("Missing @rack_app")
+  end
 end

data/template/spec/support/auto_define_rack_app.rb

@@ -0,0 +1,8 @@
+RSpec.configure do |config|
+  config.before(:context) do |spec|
+    # weird ruby syntax, but test if the described_class inherits Sinatra::Base:
+    if !@rack_app && spec.described_class < Sinatra::Base
+      @rack_app = spec.described_class
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -185,6 +185,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 description: Pliny is a set of base classes and helpers to help developers write excellent
   APIs in Sinatra
 email:
@@ -251,7 +293,7 @@ files:
 - template/config.ru
 - template/config/config.rb
 - template/config/initializers/database.rb
-- template/config/initializers/honeybadger.rb
+- template/config/initializers/rollbar.rb
 - template/config/puma.rb
 - template/db/schema.sql
 - template/db/seeds.rb
@@ -264,6 +306,7 @@ files:
 - template/lib/routes.rb
 - template/lib/serializers/base.rb
 - template/spec/spec_helper.rb
+- template/spec/support/auto_define_rack_app.rb
 - template/spec/support/log.rb
 - test/commands/creator_test.rb
 - test/commands/generator_test.rb

data/template/config/initializers/honeybadger.rb

@@ -1,3 +0,0 @@
-Honeybadger.configure do |config|
-  config.api_key = Config.honeybadger_api_key
-end