pliny 0.0.1.pre2 → 0.0.1.pre3

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: aa54dbd33376e27df178725c05baa908730d6888
-  data.tar.gz: b6ba451d723ac5aad1014582631a45deecd892d6
-SHA512:
-  metadata.gz: 6f52fc0bc37d165d3900e165dd0747491abe689a1133d941efedd6d7084d15ae28da9e6fe562fbbd302a6034026254f2909904aabc4cab28b8bcdd2b50cc85eb
-  data.tar.gz: 284fcd33dc86aaf0c0b0176d6725668d9a8932f64c30f9c60c26e29a4e44840f0244f7c78d5f7efd1f4092bacf0211e37360ad6fb689dbf975d5e1d5716d9e27
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTE1OTRlNTVkZmNmNWE3OTQ0MDM0ZTg4NjliMzk3ZTA0MmY2N2Q3Ng==
+  data.tar.gz: !binary |-
+    NTcyMDExYTgyMjIzMDlhYzQwYzczNTVhMDFlNTNlNjUyNjI4YzA1Mg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTVkYTVlNTZlMjY0NDgxYjU2NGVmMDFmMzQ4MzhhZjU5ZDQ5MzUxNzc1MzJl
+    YTk0YjAzNGJlMDZjN2E5MmU4NWIxNDNiZGE0NDkyODcwMTYwMDMxMDExODli
+    YmRkY2NkZjY2MjFlNzZiYjZiNjljODE3YzU5N2Q3ODJkYjViMzU=
+  data.tar.gz: !binary |-
+    ZWU3ZjQxY2ExZGI1MTVjZmMwMDUzY2IxMzVjMGI4NzcyNWE2MzE0MDk3YmVk
+    MGY3ZTNlMmQxMWQ2ZTM2OWEyYjc0M2ZiYTQxYTg4YTdjYzJiMzRjN2EwMGFm
+    NmUzNjFkYzUyZWI2ODMwOGEwMzVmODI1NGVmYTkyYzEyNTgxZjk=

data/README.md

@@ -1,5 +1,92 @@
-# Pliny Gem
+# Pliny
 
-[![Build Status](https://travis-ci.org/12-oz/pliny-gem.svg?branch=master)](https://travis-ci.org/12-oz/pliny-gem)
+Opinionated template Sinatra app for writing excellent APIs in Ruby.
 
-Please refer to the [Pliny template](https://github.com/12-oz/pliny) for now.
+[![Build Status](https://travis-ci.org/12-oz/pliny.svg?branch=master)](https://travis-ci.org/12-oz/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
+- [Honeybadger](https://www.honeybadger.io/) for tracking exceptions
+- [Log helper](test/log_test.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)
+- [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](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
+- [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
+
+## Getting started
+
+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
+
+Then install the gem:
+
+```bash
+$ gem install pliny
+```
+
+And initialize a new app:
+
+```bash
+$ pliny-new myapp
+$ cd myapp && bin/setup
+```
+
+Pliny also bundles some generators to help you get started:
+
+```bash
+$ bundle exec pliny-generate model artist
+created model file ./lib/models/artist.rb
+created migration ./db/migrate/1395873224_create_artist.rb
+created test ./test/models/artist_test.rb
+
+$ bundle exec pliny-generate mediator artists/creator
+created base mediator ./lib/mediators/base.rb
+created mediator file ./lib/mediators/artists/creator.rb
+created test ./test/mediators/artists/creator_test.rb
+
+$ bundle exec pliny-generate endpoint artists
+created endpoint file ./lib/endpoints/artists.rb
+add the following to lib/routes.rb:
+  mount Endpoints::Artists
+created test ./spec/endpoints/artists_spec.rb
+created test ./spec/acceptance/artists_spec.rb
+
+$ bundle exec pliny-generate migration fix_something
+created migration ./db/migrate/1395873228_fix_something.rb
+
+$ bundle exec pliny-generate schema artists
+created schema file ./docs/schema/schemata/artist.yaml
+rebuilt ./docs/schema.json
+```
+
+To test your application:
+
+```bash
+bundle exec rake
+```
+
+Or to run a single test suite:
+
+```bash
+bundle exec rspec spec/acceptance/artists_spec.rb
+```
+
+## Meta
+
+Created by Brandur Leach and Pedro Belo.

data/bin/pliny-new

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler"
+Bundler.require
+
+Pliny::Commands::Creator.run(ARGV.dup)

data/lib/pliny.rb

@@ -2,6 +2,7 @@ require "multi_json"
 require "sinatra/base"
 
 require "pliny/version"
+require "pliny/commands/creator"
 require "pliny/commands/generator"
 require "pliny/errors"
 require "pliny/extensions/instruments"

data/lib/pliny/commands/creator.rb

@@ -0,0 +1,45 @@
+require "fileutils"
+
+module Pliny::Commands
+  class Creator
+    attr_accessor :args, :stream
+
+    def self.run(args, stream=$stdout)
+      new(args, stream).run!
+    end
+
+    def initialize(args={}, stream=$stdout)
+      @args = args
+      @stream = stream
+    end
+
+    def run!
+      if File.exists?(app_dir)
+        abort("#{name} already exists")
+      end
+
+      FileUtils.copy_entry template_dir, app_dir
+      FileUtils.rm_rf("#{app_dir}/.git")
+      display "Pliny app created. To start, run:"
+      display "cd #{app_dir} && bin/setup"
+    end
+
+    protected
+
+    def display(msg)
+      stream.puts msg
+    end
+
+    def name
+      args.first
+    end
+
+    def template_dir
+      File.expand_path('../../../template', File.dirname(__FILE__))
+    end
+
+    def app_dir
+      "./#{name}"
+    end
+  end
+end

data/lib/pliny/commands/generator.rb

@@ -39,6 +39,8 @@ module Pliny::Commands
         create_model
         create_model_migration
         create_model_test
+        create_serializer
+        create_serializer_test
       when "scaffold"
         create_endpoint(scaffold: true)
         create_endpoint_test
@@ -48,9 +50,14 @@ module Pliny::Commands
         create_model_test
         create_schema
         rebuild_schema
+        create_serializer
+        create_serializer_test
       when "schema"
         create_schema
         rebuild_schema
+      when "serializer"
+        create_serializer
+        create_serializer_test
       else
         abort("Don't know how to generate '#{type}'.")
       end
@@ -65,11 +72,11 @@ module Pliny::Commands
     end
 
     def singular_class_name
-      name.singularize.camelize
+      name.gsub(/-/, '_').singularize.camelize
     end
 
     def plural_class_name
-      name.pluralize.camelize
+      name.gsub(/-/, '_').pluralize.camelize
     end
 
     def field_name
@@ -174,6 +181,18 @@ module Pliny::Commands
       display "rebuilt #{schemata}"
     end
 
+    def create_serializer
+      serializer = "./lib/serializers/#{name}_serializer.rb"
+      render_template("serializer.erb", serializer, singular_class_name: singular_class_name)
+      display "created serializer file #{serializer}"
+    end
+
+    def create_serializer_test
+      test = "./spec/serializers/#{name}_serializer_spec.rb"
+      render_template("serializer_test.erb", test, singular_class_name: singular_class_name)
+      display "created test #{test}"
+    end
+
     def render_template(template_file, destination_path, vars={})
       template_path = File.dirname(__FILE__) + "/../templates/#{template_file}"
       template = ERB.new(File.read(template_path), 0, ">")

data/lib/pliny/templates/serializer.erb

@@ -0,0 +1,19 @@
+<%
+  modules = singular_class_name.split("::")
+  modules[0] = "Serializers::#{modules[0]}"
+  ident = ""
+%>
+<% modules[0..-2].each do |m| %>
+<%=  "#{ident}module #{m}\n" %>
+<%   ident << "  " %>
+<% end %>
+<%=  ident %>class <%= modules.last %> < Serializers::Base
+<%=  ident %>  def structure(args) do |arg|
+<%=  ident %>    {
+<%=  ident %>    }
+<%=  ident %>  end
+<%=  ident %>end
+<% while ident.size > 0 do %>
+<%   ident.chop!.chop! %>
+<%=  "#{ident}end\n" %>
+<% end %>

data/lib/pliny/templates/serializer_test.erb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Serializers::<%= singular_class_name %> do
+  
+end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.0.1.pre2"
+  VERSION = "0.0.1.pre3"
 end

data/test/commands/creator_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+describe Pliny::Commands::Creator do
+  before do
+    @gen = Pliny::Commands::Creator.new(["foobar"], StringIO.new)
+  end
+
+  describe "#run!" do
+    before do
+      FileUtils.rm_rf("/tmp/plinytest")
+      FileUtils.mkdir_p("/tmp/plinytest")
+      Dir.chdir("/tmp/plinytest")
+    end
+
+    it "copies the template app over" do
+      @gen.run!
+      assert File.exists?("./foobar")
+      assert File.exists?("./foobar/Gemfile")
+    end
+
+    it "deletes the .git from it" do
+      @gen.run!
+      refute File.exists?("./foobar/.git")
+    end
+  end
+end

data/test/commands/generator_test.rb

@@ -10,6 +10,11 @@ describe Pliny::Commands::Generator do
       @gen.args = ["model", "resource_histories"]
       assert_equal "ResourceHistories", @gen.plural_class_name
     end
+
+    it "handles hyphens as underscores" do
+      @gen.args = ["model", "resource-histories"]
+      assert_equal "ResourceHistories", @gen.plural_class_name
+    end
   end
 
   describe "#singular_class_name" do
@@ -17,6 +22,11 @@ describe Pliny::Commands::Generator do
       @gen.args = ["model", "resource_histories"]
       assert_equal "ResourceHistory", @gen.singular_class_name
     end
+
+    it "handles hyphens as underscores" do
+      @gen.args = ["model", "resource-histories"]
+      assert_equal "ResourceHistory", @gen.singular_class_name
+    end
   end
 
   describe "#table_name" do
@@ -24,6 +34,11 @@ describe Pliny::Commands::Generator do
       @gen.args = ["model", "resource_history"]
       assert_equal "resource_histories", @gen.table_name
     end
+
+    it "handles hyphens as underscores" do
+      @gen.args = ["model", "resource-history"]
+      assert_equal "resource_histories", @gen.table_name
+    end
   end
 
   describe "#run!" do
@@ -63,7 +78,7 @@ describe Pliny::Commands::Generator do
         @gen.run!
       end
 
-      it "creates a new endpoint module" do
+      it "creates a new mediator module" do
         assert File.exists?("lib/mediators/artists/creator.rb")
       end
 
@@ -89,6 +104,14 @@ describe Pliny::Commands::Generator do
       it "creates a test" do
         assert File.exists?("spec/models/artist_spec.rb")
       end
+
+      it "creates a serializer" do
+        assert File.exists?("lib/serializers/artist_serializer.rb")
+      end
+
+      it "creates a serializer test" do
+        assert File.exists?("spec/serializers/artist_serializer_spec.rb")
+      end
     end
 
     describe "generating scaffolds" do
@@ -124,6 +147,14 @@ describe Pliny::Commands::Generator do
       it "creates a schema" do
         assert File.exists?("docs/schema/schemata/artist.yaml")
       end
+
+      it "creates a new serializer module" do
+        assert File.exists?("lib/serializers/artist_serializer.rb")
+      end
+
+      it "creates a test" do
+        assert File.exists?("spec/serializers/artist_serializer_spec.rb")
+      end
     end
 
     describe "generating schemas" do
@@ -136,6 +167,21 @@ describe Pliny::Commands::Generator do
         assert File.exists?("docs/schema/schemata/artist.yaml")
       end
     end
+
+    describe "generating serializers" do
+      before do
+        @gen.args = ["serializer", "artist"]
+        @gen.run!
+      end
+
+      it "creates a new serializer module" do
+        assert File.exists?("lib/serializers/artist_serializer.rb")
+      end
+
+      it "creates a test" do
+        assert File.exists?("spec/serializers/artist_serializer_spec.rb")
+      end
+    end
   end
 
   describe "#url_path" do

data/test/integration_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+
+describe "Pliny integration test" do
+  before do
+    FileUtils.rm_rf("/tmp/plinytest")
+    FileUtils.mkdir_p("/tmp/plinytest")
+    Dir.chdir("/tmp/plinytest")
+  end
+
+  it "works" do
+    bash "pliny-new myapp"
+    bash_app "bin/setup"
+    assert File.exists?("./myapp/Gemfile.lock")
+    bash_app "pliny-generate model artist"
+    assert File.exists?("./myapp/lib/models/artist.rb")
+    # could use something like bin/run in the template app to facilitate testing this
+  end
+
+  def bash(cmd)
+    bin  = File.expand_path('../bin', File.dirname(__FILE__))
+    path = "#{bin}:#{ENV["PATH"]}"
+    env = { "PATH" => path }
+    unless system(env, "#{cmd} > /dev/null")
+      raise "Failed to run #{cmd}"
+    end
+  end
+
+  def bash_app(cmd)
+    bash "cd myapp && #{cmd}"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre2
+  version: 0.0.1.pre3
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,180 +9,180 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.9.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.9.3
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.17'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.17.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.17'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: prmd
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.9'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.9'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.9.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.4.5
 - !ruby/object:Gem::Dependency
   name: http_accept
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: sinatra-router
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
 description: Pliny is a set of base classes and helpers to help developers write excellent
@@ -192,12 +192,15 @@ email:
 - pedrobelo@gmail.com
 executables:
 - pliny-generate
+- pliny-new
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - bin/pliny-generate
+- bin/pliny-new
 - lib/pliny.rb
+- lib/pliny/commands/creator.rb
 - lib/pliny/commands/generator.rb
 - lib/pliny/config_helpers.rb
 - lib/pliny/errors.rb
@@ -225,11 +228,15 @@ files:
 - lib/pliny/templates/model.erb
 - lib/pliny/templates/model_migration.erb
 - lib/pliny/templates/model_test.erb
+- lib/pliny/templates/serializer.erb
+- lib/pliny/templates/serializer_test.erb
 - lib/pliny/utils.rb
 - lib/pliny/version.rb
+- test/commands/creator_test.rb
 - test/commands/generator_test.rb
 - test/errors_test.rb
 - test/extensions/instruments_test.rb
+- test/integration_test.rb
 - test/log_test.rb
 - test/middleware/cors_test.rb
 - test/middleware/request_id_test.rb
@@ -240,7 +247,7 @@ files:
 - test/request_store_test.rb
 - test/router_test.rb
 - test/test_helper.rb
-homepage: https://github.com/heroku/pliny
+homepage: https://github.com/12-oz/pliny
 licenses:
 - MIT
 metadata: {}
@@ -250,17 +257,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ! '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Basic tooling to support API apps in Sinatra