pliny 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 004648bb41bd9b42b488da08c6bfb88c511cb9e9
-  data.tar.gz: 028e79c785b698a736c844f55b7d6b893c981fc8
+  metadata.gz: 1d36f4a628a9157de2ecfa657662a5a638944e2f
+  data.tar.gz: 5c5f671fec1d136e0968bdfe8b6b743fec540d36
 SHA512:
-  metadata.gz: c8f55bc31871bd47ad2097ef2ab00810d117c9a3b132099e78177749fa7dfcd6103d8c71aacd0f42e8872facd17659e8779901d3a7eea590c237d308a0903477
-  data.tar.gz: b5320ef0938d9ace02977eb8639e70be0957ac2df3bc1d66f463143a95449555fd2011c1dd65b5693331f06cf27c29052ed18707c1ae45f60a6434b79a6f6d75
+  metadata.gz: acea4ff673529b2218632bf1e44711cc3d998e24d2134fbb38859509494388f571cac7e7842d0fa0acdc18ed775ee05e907ecfada795d4d5bb9381d3d10df11c
+  data.tar.gz: a2bdb510b4ae82de58cf6ea001a0dce1dc0d1474695c6e0a2a185bd7a4ca669eca4c7ee1c2b6fdb43b00eae7534a4f2c7c5f6b898ae85cbb85297f864fb6283d

data/lib/pliny/commands/generator/schema.rb

@@ -4,8 +4,15 @@ require 'prmd'
 module Pliny::Commands
   class Generator
     class Schema < Base
+      def initialize(*)
+        super
+        @warned_legacy = false
+      end
+
       def create
-        schema = "./docs/schema/schemata/#{field_name}.yaml"
+        warn_legacy if legacy?
+
+        schema = schema_yaml_path(field_name)
         write_file(schema) do
           Prmd.init(name.singularize, yaml: true)
         end
@@ -13,11 +20,54 @@ module Pliny::Commands
       end
 
       def rebuild
-        schemata = './docs/schema.json'
-        write_file(schemata) do
-          Prmd.combine('./docs/schema/schemata', meta: './docs/schema/meta.json')
+        warn_legacy if legacy?
+
+        write_file(schema_json_path) do
+          Prmd.combine(schemata_path, meta: meta_path)
+        end
+        display "rebuilt #{schema_json_path}"
+      end
+
+      def legacy?
+        File.exist?("./docs/schema.json") || File.directory?("./docs/schema/schemata")
+      end
+
+      def warn_legacy
+        return if @warned_legacy
+        display "WARNING: Using legacy schema layout under docs/. To use new layout under schema/, run `mkdir -p schema && git mv docs/schema.json docs/schema/meta.* docs/schema/schemata schema` then check for remaining schema-related files under docs/."
+        @warned_legacy = true
+      end
+
+      def schema_json_path
+        if legacy?
+          "./docs/schema.json"
+        else
+          "./schema/schema.json"
         end
-        display "rebuilt #{schemata}"
+      end
+
+      def meta_path
+        if legacy?
+          "./docs/schema/meta.json"
+        else
+          "./schema/meta.json"
+        end
+      end
+
+      def schemata_path
+        if legacy?
+          "./docs/schema/schemata"
+        else
+          "./schema/schemata"
+        end
+      end
+
+      def schema_base
+        Pathname.new("./schema")
+      end
+
+      def schema_yaml_path(field_name)
+        File.join(schemata_path, "#{field_name}.yaml")
       end
     end
   end

data/lib/pliny/errors.rb

@@ -62,6 +62,7 @@ module Pliny
     class RequestedRangeNotSatisfiable < HTTPStatusError; end # 416
     class ExpectationFailed < HTTPStatusError; end            # 417
     class UnprocessableEntity < HTTPStatusError; end          # 422
+    class TooManyRequests < HTTPStatusError; end              # 429
     class InternalServerError < HTTPStatusError; end          # 500
     class NotImplemented < HTTPStatusError; end               # 501
     class BadGateway < HTTPStatusError; end                   # 502
@@ -105,6 +106,7 @@ module Pliny
       RequestedRangeNotSatisfiable => [416, 'Requested range not satisfiable'],
       ExpectationFailed            => [417, 'Expectation failed'],
       UnprocessableEntity          => [422, 'Unprocessable entity'],
+      TooManyRequests              => [429, 'Too many requests'],
       InternalServerError          => [500, 'Internal server error'],
       NotImplemented               => [501, 'Not implemented'],
       BadGateway                   => [502, 'Bad gateway'],

data/lib/pliny/templates/endpoint_scaffold_acceptance_test.erb

@@ -23,7 +23,7 @@ describe Endpoints::<%= plural_class_name %> do
   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_equal 200, last_response.status
       assert_schema_conform
     end
   end
@@ -33,7 +33,7 @@ describe Endpoints::<%= plural_class_name %> 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_equal 201, last_response.status
       assert_schema_conform
     end
   end
@@ -42,7 +42,7 @@ describe Endpoints::<%= plural_class_name %> do
   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_equal 200, last_response.status
       assert_schema_conform
     end
   end
@@ -51,7 +51,7 @@ describe Endpoints::<%= plural_class_name %> 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_equal 200, last_response.status
       assert_schema_conform
     end
   end
@@ -59,7 +59,7 @@ describe Endpoints::<%= plural_class_name %> do
   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_equal 200, last_response.status
       assert_schema_conform
     end
   end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.6.3"
+  VERSION = "0.7.0"
 end

data/lib/template/Gemfile

@@ -4,7 +4,7 @@ ruby "2.2.0"
 gem "multi_json"
 gem "oj"
 gem "pg"
-gem "pliny", "~> 0.6"
+gem "pliny", "~> 0.7"
 gem "pry"
 gem "puma", "~> 2.10"
 gem "rack-ssl"

data/spec/commands/generator/schema_spec.rb

@@ -0,0 +1,73 @@
+require 'pliny/commands/generator'
+require 'pliny/commands/generator/schema'
+require 'spec_helper'
+
+describe Pliny::Commands::Generator::Schema do
+  let(:stream) { StringIO.new }
+  subject { Pliny::Commands::Generator::Schema.new('artist', {}, stream) }
+
+  around do |example|
+    Dir.mktmpdir do |dir|
+      app_dir = File.join(dir, "app")
+      # schema work depends on files seeded by the template
+      Pliny::Commands::Creator.run([app_dir], {}, StringIO.new)
+      Dir.chdir(app_dir, &example)
+    end
+  end
+
+  describe '#create' do
+    context 'with new layout' do
+      before do
+        subject.create
+      end
+
+      it 'creates a schema' do
+        assert File.exist?('schema/schemata/artist.yaml')
+      end
+    end
+
+    context 'with legacy layout' do
+      before do
+        FileUtils.mkdir_p('./docs/schema/schemata')
+        FileUtils.cp('./schema/meta.json', './docs/schema')
+        subject.create
+      end
+
+      it 'creates a legacy schema' do
+        assert File.exist?('docs/schema/schemata/artist.yaml')
+      end
+
+      it 'warns' do
+        assert_match(/WARNING/m, stream.string)
+      end
+    end
+  end
+
+  describe '#rebuild' do
+    context 'with new layout' do
+      before do
+        subject.rebuild
+      end
+
+      it 'rebuilds schema.json' do
+        assert File.exist?('./schema/schema.json')
+      end
+    end
+
+    context 'with legacy layout' do
+      before do
+        FileUtils.mkdir_p('./docs/schema/schemata')
+        FileUtils.cp('./schema/meta.json', './docs/schema')
+        subject.rebuild
+      end
+
+      it 'rebuilds legacy schema.json' do
+        assert File.exist?('docs/schema.json')
+      end
+
+      it 'warns' do
+        assert_match(/WARNING/m, stream.string)
+      end
+    end
+  end
+end

data/spec/commands/generator_spec.rb

@@ -4,7 +4,7 @@ require 'pliny/commands/generator/base'
 require 'spec_helper'
 
 describe Pliny::Commands::Generator do
-subject { Pliny::Commands::Generator.new }
+  subject { Pliny::Commands::Generator.new }
 
   before do
     Timecop.freeze(@t = Time.now)
@@ -127,7 +127,7 @@ subject { Pliny::Commands::Generator.new }
     end
 
     it 'creates a schema' do
-      assert File.exist?('docs/schema/schemata/artist.yaml')
+      assert File.exist?('schema/schemata/artist.yaml')
     end
 
     it 'creates a new serializer module' do
@@ -145,7 +145,7 @@ subject { Pliny::Commands::Generator.new }
     end
 
     it 'creates a schema' do
-      assert File.exist?('docs/schema/schemata/artist.yaml')
+      assert File.exist?('schema/schemata/artist.yaml')
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -395,8 +395,6 @@ files:
 - lib/template/config/puma.rb
 - lib/template/db/schema.sql
 - lib/template/db/seeds.rb
-- lib/template/docs/schema/meta.json
-- lib/template/docs/schema/schemata/.gitkeep
 - lib/template/lib/application.rb
 - lib/template/lib/endpoints/base.rb
 - lib/template/lib/endpoints/root.rb
@@ -405,12 +403,15 @@ files:
 - lib/template/lib/routes.rb
 - lib/template/lib/serializers/base.rb
 - lib/template/lib/tasks/spec.rake
+- lib/template/schema/meta.json
+- lib/template/schema/schemata/.gitkeep
 - lib/template/spec/spec_helper.rb
 - lib/template/spec/support/auto_define_rack_app.rb
 - lib/template/spec/support/log.rb
 - spec/commands/creator_spec.rb
 - spec/commands/generator/base_spec.rb
 - spec/commands/generator/endpoint_spec.rb
+- spec/commands/generator/schema_spec.rb
 - spec/commands/generator_spec.rb
 - spec/errors_spec.rb
 - spec/extensions/instruments_spec.rb
@@ -452,4 +453,3 @@ signing_key:
 specification_version: 4
 summary: Basic tooling to support API apps in Sinatra
 test_files: []
-has_rdoc: