pliny 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e0f67945b6d0c56fbc12eeeb1f05c27552d34ec
-  data.tar.gz: 0561658c246936f0e5aea4d84bb9594bf547901d
+  metadata.gz: 15e8fffa3d46a900635fa060a7fd577a42e8ee90
+  data.tar.gz: 797a949412bc6f88afc4533fffbab5bc160d66ab
 SHA512:
-  metadata.gz: fc4d4d529b7f99a29fad0261059bea8e038cb5e516fa1f6145d5c549b3e63d19801cbae9889ad30bf25eeec6073fcc35becf4fd190df4e05725e5db8cb3bfa28
-  data.tar.gz: b49455e9fe4a7d1064df6fa29903b35f6be59a297263ef6c3d90f3078a73603184ef1f2053cff12a28ea59a0f200989fde44b3384ff66e29891e7cc44f99c88d
+  metadata.gz: 51e4c8d782819ab40293e3b2b41b9fcd392e2ead19465f87951bcdd885b9149350c6b49e453918fee945233f3be8e9f7a519281e61c3f752af93656451c99b05
+  data.tar.gz: 15485eccede81da5f81e667fb2f3867fb5a409610db0d08b32c0ac325a5e5b32d0e48e7ac7cfb8209814153566c68bc8d4d4661469001cf7f0b51d7dbc0d7176

data/README.md

@@ -1,53 +1,35 @@
 # Pliny
 
-Opinionated template Sinatra app for writing excellent APIs in Ruby.
-
+[![Gem version](http://img.shields.io/gem/v/pliny.svg)](https://rubygems.org/gems/pliny)
 [![Build Status](https://travis-ci.org/interagent/pliny.svg?branch=master)](https://travis-ci.org/interagent/pliny)
 
-It bundles some of the patterns we like to develop these apps:
-
-- Config: `ENV` wrapper for explicit defining what config vars are mandatory and optional
-- Endpoints: the Sinatra equivalent of a Rails Controller
-- Initializers: tiny files to configure libraries/etc (equivalent of Rails)
-- Mediators: plain ruby classes to manipulate models
-- Models: very thin wrappers around the database
-
-And gems/helpers to tie these together and support operations:
-
-- [CORS middleware](lib/pliny/middleware/cors.rb) to allow JS developers to consume your API
-- [Rollbar](https://www.rollbar.com/) for tracking exceptions
-- [Log helper](spec/log_spec.rb) that logs in [data format](https://www.youtube.com/watch?v=rpmc-wHFUBs) [to stdout](https://adam.heroku.com/past/2011/4/1/logs_are_streams_not_files)
-- [Mediators](http://brandur.org/mediator) to help encapsulate more complex interactions
-- [Rspec](https://github.com/rspec/rspec) for lean and fast testing
-- [Puma](http://puma.io/) as the web server, [configured for optimal performance on Heroku](lib/template/config/puma.rb)
-- [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
-- [Sequel](http://sequel.jeremyevans.net/) for ORM
-- [Sequel-PG](https://github.com/jeremyevans/sequel_pg) to talk to the world's most advanced open source database
-- [Versioning](lib/pliny/middleware/versioning.rb) to allow versioning your API in the HTTP Accept header
+Pliny helps Ruby developers write and maintain excellent APIs.
 
-## Getting started
+It bundles the best patterns, libraries and practices we've seen after writing a lot of APIs.
 
-First make sure the following is installed:
 
-* [Postgres](http://www.postgresql.org/)
-    * The [uuid-ossp](http://www.postgresql.org/docs/9.3/static/uuid-ossp.html) module for Postgres
+## Resources
 
-Then install the gem:
+- [Documentation](https://github.com/interagent/pliny/wiki)
+- [Mailing list](https://groups.google.com/group/pliny-talk)
+
+
+## Getting started
+
+Install gem:
 
 ```bash
 $ gem install pliny
 ```
 
-And initialize a new app:
+And initialize your new API app:
 
 ```bash
 $ pliny-new myapp
 $ cd myapp && bin/setup
 ```
 
-Pliny also bundles [some generators](#generators) to help you get started:
+Pliny bundles [generators](#generators) to help you get started:
 
 ```bash
 $ bundle exec pliny-generate model artist
@@ -106,13 +88,13 @@ Commands:
 
 ### Rake tasks
 
-Pliny comes with several rake tasks:
+Pliny adds common Rake tasks to help maintain your app:
 
 ```bash
 rake db:create        # Create the database
 rake db:drop          # Drop the database
 rake db:migrate       # Run database migrations
-rake db:rollback      # Rollback the database
+rake db:rollback      # Rollback last database migration
 rake db:schema:dump   # Dump the database schema
 rake db:schema:load   # Load the database schema
 rake db:schema:merge  # Merges migrations into schema and removes them
@@ -152,3 +134,5 @@ $ rake
 ## Meta
 
 Created by Brandur Leach and Pedro Belo.
+
+MIT licensed.

data/lib/pliny/commands/generator.rb

@@ -3,9 +3,9 @@ require 'thor'
 
 module Pliny::Commands
   class Generator < Thor
-    desc 'endpoint [NAME]', 'Generates an endpoint'
+    desc 'endpoint NAME', 'Generates an endpoint'
     method_option :scaffold, type: :boolean, default: false, hide: true
-    def endpoint(*name)
+    def endpoint(name)
       require_relative 'generator/endpoint'
 
       ep = Endpoint.new(name, options)
@@ -14,8 +14,8 @@ module Pliny::Commands
       ep.create_acceptance_test
     end
 
-    desc 'mediator [NAME]', 'Generates a mediator'
-    def mediator(*name)
+    desc 'mediator NAME', 'Generates a mediator'
+    def mediator(name)
       require_relative 'generator/mediator'
 
       md = Mediator.new(name, options)
@@ -23,17 +23,17 @@ module Pliny::Commands
       md.create_test
     end
 
-    desc 'migration [NAME]', 'Generates a migration'
-    def migration(*name)
+    desc 'migration NAME', 'Generates a migration'
+    def migration(name)
       require_relative 'generator/migration'
 
       mg = Migration.new(name, options)
       mg.create
     end
 
-    desc 'model [NAME]', 'Generates a model'
+    desc 'model NAME', 'Generates a model'
     method_option :paranoid, type: :boolean, default: false, desc: 'adds paranoid support to model'
-    def model(*name)
+    def model(name)
       require_relative 'generator/model'
 
       md = Model.new(name, options)
@@ -42,18 +42,18 @@ module Pliny::Commands
       md.create_test
     end
 
-    desc 'scaffold [NAME]', 'Generates a scaffold of endpoint, model, schema and serializer'
+    desc 'scaffold NAME', 'Generates a scaffold of endpoint, model, schema and serializer'
     method_option :paranoid, type: :boolean, default: false, desc: 'adds paranoid support to model'
     method_option :scaffold, type: :boolean, default: true, hide: true
-    def scaffold(*name)
-      endpoint(*name)
-      model(*name)
-      schema(*name)
-      serializer(*name)
+    def scaffold(name)
+      endpoint(name)
+      model(name)
+      schema(name)
+      serializer(name)
     end
 
-    desc 'schema [NAME]', 'Generates a schema'
-    def schema(*name)
+    desc 'schema NAME', 'Generates a schema'
+    def schema(name)
       require_relative 'generator/schema'
 
       sc = Schema.new(name, options)
@@ -61,8 +61,8 @@ module Pliny::Commands
       sc.rebuild
     end
 
-    desc 'serializer [NAME]', 'Generates a serializer'
-    def serializer(*name)
+    desc 'serializer NAME', 'Generates a serializer'
+    def serializer(name)
       require_relative 'generator/serializer'
 
       se = Serializer.new(name, options)

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

@@ -62,9 +62,7 @@ module Pliny::Commands
       private
 
       def normalize_name(name)
-        Array(name).map(&:underscore)
-                   .map { |n| n.tr(' ', '_') }
-                   .join('_')
+        name.underscore.tr(' ', '_')
       end
     end
   end

data/lib/pliny/middleware/cors.rb

@@ -4,7 +4,7 @@ module Pliny::Middleware
     ALLOW_METHODS  =
       %w( GET POST PUT PATCH DELETE OPTIONS ).freeze
     ALLOW_HEADERS  =
-      %w( * Content-Type Accept AUTHORIZATION Cache-Control ).freeze
+      %w( Content-Type Accept Authorization Cache-Control If-None-Match If-Modified-Since ).freeze
     EXPOSE_HEADERS =
       %w( Cache-Control Content-Language Content-Type Expires Last-Modified Pragma ).freeze
 

data/lib/pliny/tasks/db.rake

@@ -1,148 +1,153 @@
 require "logger"
-require "sequel"
-require "sequel/extensions/migration"
 require "uri"
-
-require "pliny/db_support"
 require "pliny/utils"
 
-namespace :db do
-  desc "Run database migrations"
-  task :migrate do
-    next if Dir["./db/migrate/*.rb"].empty?
-    database_urls.each do |database_url|
-      Pliny::DbSupport.run(database_url, $stdout) do |helper|
-        helper.migrate
-        puts "Migrated `#{name_from_uri(database_url)}`"
+begin
+  require "sequel"
+  require "sequel/extensions/migration"
+  require "pliny/db_support"
+
+  namespace :db do
+    desc "Run database migrations"
+    task :migrate do
+      next if Dir["./db/migrate/*.rb"].empty?
+      database_urls.each do |database_url|
+        Pliny::DbSupport.run(database_url, $stdout) do |helper|
+          helper.migrate
+          puts "Migrated `#{name_from_uri(database_url)}`"
+        end
       end
     end
-  end
 
-  desc "Rollback last database migration"
-  task :rollback do
-    next if Dir["./db/migrate/*.rb"].empty?
-    database_urls.each do |database_url|
-      Pliny::DbSupport.run(database_url, $stdout) do |helper|
-        helper.rollback
-        puts "Rolled back `#{name_from_uri(database_url)}`"
+    desc "Rollback last database migration"
+    task :rollback do
+      next if Dir["./db/migrate/*.rb"].empty?
+      database_urls.each do |database_url|
+        Pliny::DbSupport.run(database_url, $stdout) do |helper|
+          helper.rollback
+          puts "Rolled back `#{name_from_uri(database_url)}`"
+        end
       end
     end
-  end
 
-  desc "Seed the database with data"
-  task :seed do
-    if File.exist?('./db/seeds.rb')
-      database_urls.each do |database_url|
-        Sequel.connect(database_url)
-        load 'db/seeds.rb'
+    desc "Seed the database with data"
+    task :seed do
+      if File.exist?('./db/seeds.rb')
+        database_urls.each do |database_url|
+          Sequel.connect(database_url)
+          load 'db/seeds.rb'
+        end
+        disconnect
       end
-      disconnect
     end
-  end
 
-  desc "Create the database"
-  task :create do
-    database_urls.each do |database_url|
-      db_name = name_from_uri(database_url)
-      if Pliny::DbSupport.setup?(database_url)
-        puts "Skipping `#{db_name}`, already exists"
-      else
-        admin_url = Pliny::DbSupport.admin_url(database_url)
-        Pliny::DbSupport.run(admin_url) do |helper|
-          helper.create(db_name)
-          puts "Created `#{db_name}`"
+    desc "Create the database"
+    task :create do
+      database_urls.each do |database_url|
+        db_name = name_from_uri(database_url)
+        if Pliny::DbSupport.setup?(database_url)
+          puts "Skipping `#{db_name}`, already exists"
+        else
+          admin_url = Pliny::DbSupport.admin_url(database_url)
+          Pliny::DbSupport.run(admin_url) do |helper|
+            helper.create(db_name)
+            puts "Created `#{db_name}`"
+          end
         end
       end
+      disconnect
     end
-    disconnect
-  end
 
-  desc "Drop the database"
-  task :drop do
-    database_urls.each do |database_url|
-      admin_url = Pliny::DbSupport.admin_url(database_url)
-      db = Sequel.connect(admin_url)
-      name = name_from_uri(database_url)
-      db.run(%{DROP DATABASE IF EXISTS "#{name}"})
-      puts "Dropped `#{name}`"
+    desc "Drop the database"
+    task :drop do
+      database_urls.each do |database_url|
+        admin_url = Pliny::DbSupport.admin_url(database_url)
+        db = Sequel.connect(admin_url)
+        name = name_from_uri(database_url)
+        db.run(%{DROP DATABASE IF EXISTS "#{name}"})
+        puts "Dropped `#{name}`"
+      end
+      disconnect
     end
-    disconnect
-  end
 
-  namespace :schema do
-    desc "Load the database schema"
-    task :load do
-      if File.exists?("./db/schema.sql")
-        schema = File.read("./db/schema.sql")
-        database_urls.each do |database_url|
-          db = Sequel.connect(database_url)
-          db.run(schema)
-          puts "Loaded `#{name_from_uri(database_url)}`"
+    namespace :schema do
+      desc "Load the database schema"
+      task :load do
+        if File.exists?("./db/schema.sql")
+          schema = File.read("./db/schema.sql")
+          database_urls.each do |database_url|
+            db = Sequel.connect(database_url)
+            db.run(schema)
+            puts "Loaded `#{name_from_uri(database_url)}`"
+          end
+          disconnect
+        else
+          puts "Skipped schema load, schema.sql not present"
         end
-        disconnect
-      else
-        puts "Skipped schema load, schema.sql not present"
       end
-    end
 
-    desc "Dump the database schema"
-    task :dump do
-      file = File.join("db", "schema.sql")
-      database_url = database_urls.first
-      `pg_dump -i -s -x -O -f #{file} #{database_url}`
-
-      schema = File.read(file)
-      # filter all COMMENT ON EXTENSION, only owners and the db
-      # superuser can execute these, making it impossible to just
-      # replay such statements in certain production databases
-      schema.gsub!(/^COMMENT ON EXTENSION.*\n/, "")
-
-      # add migrations used to compose this schema
-      db = Sequel.connect(database_urls.first)
-      if db.table_exists?(:schema_migrations)
-        db[:schema_migrations].each do |migration|
-          schema << db[:schema_migrations].insert_sql(migration) + ";\n"
+      desc "Dump the database schema"
+      task :dump do
+        file = File.join("db", "schema.sql")
+        database_url = database_urls.first
+        `pg_dump -i -s -x -O -f #{file} #{database_url}`
+
+        schema = File.read(file)
+        # filter all COMMENT ON EXTENSION, only owners and the db
+        # superuser can execute these, making it impossible to just
+        # replay such statements in certain production databases
+        schema.gsub!(/^COMMENT ON EXTENSION.*\n/, "")
+
+        # add migrations used to compose this schema
+        db = Sequel.connect(database_urls.first)
+        if db.table_exists?(:schema_migrations)
+          db[:schema_migrations].each do |migration|
+            schema << db[:schema_migrations].insert_sql(migration) + ";\n"
+          end
         end
+        disconnect
+
+        File.open(file, "w") { |f| f.puts schema }
+        puts "Dumped `#{name_from_uri(database_url)}` to #{file}"
       end
-      disconnect
 
-      File.open(file, "w") { |f| f.puts schema }
-      puts "Dumped `#{name_from_uri(database_url)}` to #{file}"
+      desc "Merges migrations into schema and removes them"
+      task :merge => ["db:setup", "db:schema:dump"] do
+        FileUtils.rm Dir["./db/migrate/*.rb"]
+        puts "Removed migrations"
+      end
     end
 
-    desc "Merges migrations into schema and removes them"
-    task :merge => ["db:setup", "db:schema:dump"] do
-      FileUtils.rm Dir["./db/migrate/*.rb"]
-      puts "Removed migrations"
-    end
-  end
+    desc "Setup the database"
+    task :setup => [:drop, :create, "schema:load", :migrate, :seed]
 
-  desc "Setup the database"
-  task :setup => [:drop, :create, "schema:load", :migrate, :seed]
+    private
 
-  private
+    def disconnect
+      Sequel::DATABASES.each { |db| db.disconnect }
+      Sequel::DATABASES.clear
+    end
 
-  def disconnect
-    Sequel::DATABASES.each { |db| db.disconnect }
-    Sequel::DATABASES.clear
-  end
+    def database_urls
+      if ENV["DATABASE_URL"]
+        [ENV["DATABASE_URL"]]
+      else
+        %w(.env .env.test).map { |env_file|
+          env_path = "./#{env_file}"
+          if File.exists?(env_path)
+            Pliny::Utils.parse_env(env_path)["DATABASE_URL"]
+          else
+            nil
+          end
+        }.compact
+      end
+    end
 
-  def database_urls
-    if ENV["DATABASE_URL"]
-      [ENV["DATABASE_URL"]]
-    else
-      %w(.env .env.test).map { |env_file|
-        env_path = "./#{env_file}"
-        if File.exists?(env_path)
-          Pliny::Utils.parse_env(env_path)["DATABASE_URL"]
-        else
-          nil
-        end
-      }.compact
+    def name_from_uri(uri)
+      URI.parse(uri).path[1..-1]
     end
   end
 
-  def name_from_uri(uri)
-    URI.parse(uri).path[1..-1]
-  end
+rescue LoadError
+  puts "Couldn't load sequel. Skipping database tasks"
 end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.11.0"
+  VERSION = "0.11.1"
 end

data/spec/commands/generator/base_spec.rb

@@ -10,7 +10,6 @@ describe Pliny::Commands::Generator::Base do
   describe '#name' do
     it 'generates a normalized name given differents argument formats' do
       [
-        %w(resource history),
         'resource history',
         'resource-history',
         'resource_history',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport