smooth 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +21 -0
  3. data/Gemfile +10 -0
  4. data/LICENSE.txt +22 -0
  5. data/README.md +29 -0
  6. data/Rakefile +24 -0
  7. data/app/assets/images/smooth/.keep +0 -0
  8. data/app/assets/javascripts/smooth/.keep +0 -0
  9. data/app/controllers/.keep +0 -0
  10. data/app/helpers/.keep +0 -0
  11. data/app/mailers/.keep +0 -0
  12. data/app/models/.keep +0 -0
  13. data/app/views/.keep +0 -0
  14. data/config/routes.rb +2 -0
  15. data/lib/smooth.rb +64 -0
  16. data/lib/smooth/api.rb +72 -0
  17. data/lib/smooth/api/policy.rb +18 -0
  18. data/lib/smooth/api/tracking.rb +31 -0
  19. data/lib/smooth/cache.rb +19 -0
  20. data/lib/smooth/command.rb +55 -0
  21. data/lib/smooth/command/instrumented.rb +51 -0
  22. data/lib/smooth/configuration.rb +25 -0
  23. data/lib/smooth/documentation.rb +31 -0
  24. data/lib/smooth/dsl.rb +36 -0
  25. data/lib/smooth/event.rb +27 -0
  26. data/lib/smooth/example.rb +6 -0
  27. data/lib/smooth/ext/core.rb +5 -0
  28. data/lib/smooth/ext/mutations.rb +1 -0
  29. data/lib/smooth/query.rb +62 -0
  30. data/lib/smooth/resource.rb +173 -0
  31. data/lib/smooth/resource/tracking.rb +17 -0
  32. data/lib/smooth/serializer.rb +94 -0
  33. data/lib/smooth/version.rb +3 -0
  34. data/smooth.gemspec +36 -0
  35. data/spec/dummy/README.rdoc +28 -0
  36. data/spec/dummy/Rakefile +6 -0
  37. data/spec/dummy/app/apis/application_api.rb +34 -0
  38. data/spec/dummy/app/assets/images/.keep +0 -0
  39. data/spec/dummy/app/assets/javascripts/application.js +13 -0
  40. data/spec/dummy/app/assets/stylesheets/application.css +15 -0
  41. data/spec/dummy/app/controllers/application_controller.rb +5 -0
  42. data/spec/dummy/app/controllers/concerns/.keep +0 -0
  43. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  44. data/spec/dummy/app/mailers/.keep +0 -0
  45. data/spec/dummy/app/models/.keep +0 -0
  46. data/spec/dummy/app/models/author.rb +2 -0
  47. data/spec/dummy/app/models/book.rb +2 -0
  48. data/spec/dummy/app/models/concerns/.keep +0 -0
  49. data/spec/dummy/app/resources/books.rb +103 -0
  50. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  51. data/spec/dummy/bin/bundle +3 -0
  52. data/spec/dummy/bin/rails +4 -0
  53. data/spec/dummy/bin/rake +4 -0
  54. data/spec/dummy/config.ru +4 -0
  55. data/spec/dummy/config/application.rb +30 -0
  56. data/spec/dummy/config/boot.rb +5 -0
  57. data/spec/dummy/config/database.yml +25 -0
  58. data/spec/dummy/config/environment.rb +5 -0
  59. data/spec/dummy/config/environments/development.rb +37 -0
  60. data/spec/dummy/config/environments/production.rb +82 -0
  61. data/spec/dummy/config/environments/test.rb +39 -0
  62. data/spec/dummy/config/initializers/assets.rb +8 -0
  63. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  64. data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
  65. data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  66. data/spec/dummy/config/initializers/inflections.rb +16 -0
  67. data/spec/dummy/config/initializers/mime_types.rb +4 -0
  68. data/spec/dummy/config/initializers/session_store.rb +3 -0
  69. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  70. data/spec/dummy/config/locales/en.yml +23 -0
  71. data/spec/dummy/config/routes.rb +3 -0
  72. data/spec/dummy/config/secrets.yml +22 -0
  73. data/spec/dummy/db/development.sqlite3 +0 -0
  74. data/spec/dummy/db/migrate/20140822065900_create_books.rb +11 -0
  75. data/spec/dummy/db/migrate/20140822065916_create_authors.rb +9 -0
  76. data/spec/dummy/db/schema.rb +30 -0
  77. data/spec/dummy/db/test.sqlite3 +0 -0
  78. data/spec/dummy/lib/assets/.keep +0 -0
  79. data/spec/dummy/log/.keep +0 -0
  80. data/spec/dummy/public/404.html +67 -0
  81. data/spec/dummy/public/422.html +67 -0
  82. data/spec/dummy/public/500.html +66 -0
  83. data/spec/dummy/public/favicon.ico +0 -0
  84. data/spec/lib/smooth/api/policy_spec.rb +5 -0
  85. data/spec/lib/smooth/api_spec.rb +23 -0
  86. data/spec/lib/smooth/cache_spec.rb +8 -0
  87. data/spec/lib/smooth/command_spec.rb +36 -0
  88. data/spec/lib/smooth/configuration_spec.rb +16 -0
  89. data/spec/lib/smooth/event_spec.rb +20 -0
  90. data/spec/lib/smooth/example_spec.rb +5 -0
  91. data/spec/lib/smooth/query_spec.rb +5 -0
  92. data/spec/lib/smooth/resource_spec.rb +38 -0
  93. data/spec/lib/smooth/serializer_spec.rb +26 -0
  94. data/spec/spec_helper.rb +18 -0
  95. metadata +394 -0
@@ -0,0 +1,3 @@
1
+ module Smooth
2
+ VERSION = "2.0.1"
3
+ end
@@ -0,0 +1,36 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'smooth/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "smooth"
8
+ spec.version = Smooth::VERSION
9
+ spec.authors = ["Jonathan Soeder"]
10
+ spec.email = ["jonathan.soeder@gmail.com"]
11
+ spec.description = %q{Smooth provides a simple DSL building powerful JSON APIs on top of ActiveRecord.}
12
+ spec.summary = %q{Smooth provides a DSL for creating self-testing, self-documenting, highly inspectable API endpoints which are able to generate extendable client libraries.}
13
+ spec.homepage = "http://smooth.io"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_dependency 'hashie'
22
+ spec.add_dependency 'activesupport', '>= 4.0.0'
23
+ spec.add_dependency 'activerecord', '>= 4.0.0'
24
+ spec.add_dependency 'active_model_serializers'
25
+ spec.add_dependency 'faker'
26
+ spec.add_dependency 'mutations'
27
+
28
+ spec.add_development_dependency "bundler", "~> 1.3"
29
+ spec.add_development_dependency "rake"
30
+ spec.add_development_dependency "pry"
31
+ spec.add_development_dependency "pry-nav"
32
+ spec.add_development_dependency "rack-test"
33
+ spec.add_development_dependency 'rails'
34
+ spec.add_development_dependency 'rspec-rails'
35
+ spec.add_development_dependency 'sqlite3'
36
+ end
@@ -0,0 +1,28 @@
1
+ == README
2
+
3
+ This README would normally document whatever steps are necessary to get the
4
+ application up and running.
5
+
6
+ Things you may want to cover:
7
+
8
+ * Ruby version
9
+
10
+ * System dependencies
11
+
12
+ * Configuration
13
+
14
+ * Database creation
15
+
16
+ * Database initialization
17
+
18
+ * How to run the test suite
19
+
20
+ * Services (job queues, cache servers, search engines, etc.)
21
+
22
+ * Deployment instructions
23
+
24
+ * ...
25
+
26
+
27
+ Please feel free to use a different markup language if you do not plan to run
28
+ <tt>rake doc:app</tt>.
@@ -0,0 +1,6 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require File.expand_path('../config/application', __FILE__)
5
+
6
+ Rails.application.load_tasks
@@ -0,0 +1,34 @@
1
+ require 'smooth/dsl'
2
+
3
+ api "My Application" do
4
+ version :v1
5
+
6
+ desc "Public users include anyone with access to the URL"
7
+ policy :public_users do
8
+
9
+ # commands / queries can be set to true or false to allow
10
+ # all commands and queries defined for the books resource.
11
+ allow :books, :commands => false, :queries => true
12
+
13
+ # we can also pass an array of queries or commands
14
+ # allow :books, :commands => [:like]
15
+ end
16
+
17
+ desc "Authenticated users register and are given an auth token"
18
+ policy :logged_in_users do
19
+ authenticate_with :header => 'X-AUTH-TOKEN', :param => :auth_token
20
+ allow :books, :commands => true, :queries => true
21
+ end
22
+
23
+ desc "Admin users have the admin flag set to true"
24
+ policy :admin_users do
25
+ same_as :logged_in_users
26
+
27
+ # what method should we call on the current_user to see if
28
+ # it is eligible for this policy?
29
+ test :admin?
30
+
31
+ # an alternative. checks to see if the method 'role' returns 'admin'
32
+ # test :role => "admin"
33
+ end
34
+ end
File without changes
@@ -0,0 +1,13 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // compiled file.
9
+ //
10
+ // Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
11
+ // about supported directives.
12
+ //
13
+ //= require_tree .
@@ -0,0 +1,15 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
9
+ * compiled file so the styles you add here take precedence over styles defined in any styles
10
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
11
+ * file per style scope.
12
+ *
13
+ *= require_tree .
14
+ *= require_self
15
+ */
@@ -0,0 +1,5 @@
1
+ class ApplicationController < ActionController::Base
2
+ # Prevent CSRF attacks by raising an exception.
3
+ # For APIs, you may want to use :null_session instead.
4
+ protect_from_forgery with: :exception
5
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
File without changes
File without changes
@@ -0,0 +1,2 @@
1
+ class Author < ActiveRecord::Base
2
+ end
@@ -0,0 +1,2 @@
1
+ class Book < ActiveRecord::Base
2
+ end
File without changes
@@ -0,0 +1,103 @@
1
+ resource "Books" do
2
+ serializer do
3
+ desc "A unique id for the book", :type => :integer
4
+ attribute :id
5
+
6
+ desc "The title of the book", :type => :string
7
+ attribute :title
8
+
9
+ desc "The author of the book"
10
+ has_one :author
11
+
12
+ desc "Documentation for computed property"
13
+ def computed_property
14
+ object.created_at
15
+ end
16
+ end
17
+
18
+ # This will create a class 'UpdateBook'. The execute method
19
+ # is open for definition by the developer.
20
+ command :update, "Update a book's attributes" do
21
+ # Will ensure the command is run with
22
+ # Book.accessible_to(current_user).find(id).
23
+ scope :accessible_to
24
+
25
+ params do
26
+ duck :id, :method => :to_s
27
+
28
+ optional do
29
+ string :title
30
+ end
31
+ end
32
+ end
33
+
34
+ command :create, "Add a new book to the library" do
35
+ scope :accessible_to
36
+
37
+ params do
38
+ string :title
39
+ end
40
+ end
41
+
42
+ command :like, 'Toggle liking on/off for a book' do
43
+ scope :all
44
+
45
+ params do
46
+ duck :id, :method => :to_s
47
+
48
+ optional do
49
+ desc "You can manually pass true or false. If you leave it off, it will toggle the liking status"
50
+ boolean :like, :discard_empty => true
51
+ end
52
+ end
53
+ end
54
+
55
+ # This will create a class 'BookQuery'. The build_scope method
56
+ # is open for definition by the developer.
57
+ query do
58
+ start_from :scope => :accessible_to
59
+
60
+ params do
61
+ desc "The year the book was published (example: YYYY)"
62
+ integer :year_published
63
+ end
64
+
65
+ role :admin do
66
+ start_from :scope => :all
67
+ end
68
+ end
69
+
70
+ # Each resource will be mounted by the API under a base path
71
+ # such as /api/v1. So the routes defined here would be available
72
+ # under /api/v1/books, /api/v1/books/1 etc
73
+ routes do
74
+ desc "List all books"
75
+ get "/books", :to => :query
76
+
77
+ desc "Show an individual book"
78
+ show "/books/:id", :to => :show
79
+
80
+ desc "Create a new book"
81
+ post "/books", :to => :create
82
+
83
+ desc "Update an existing book"
84
+ put "/books/:id", :to => :update
85
+
86
+ desc "Like a book"
87
+ put "/books/:id/like", :to => :like
88
+ end
89
+
90
+ examples :client => :rest do
91
+ setup_data do
92
+ let(:books) do
93
+ 3.times.map { |n| create(:book, title: "Book #{ n }") }
94
+ end
95
+ end
96
+
97
+ with_profile :public_user do
98
+ example "Listing all of the books", :route => :query
99
+ example "Viewing a single book", :route => :show
100
+ end
101
+ end
102
+
103
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
6
+ <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
3
+ load Gem.bin_path('bundler', 'bundle')
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ APP_PATH = File.expand_path('../../config/application', __FILE__)
3
+ require_relative '../config/boot'
4
+ require 'rails/commands'
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ require_relative '../config/boot'
3
+ require 'rake'
4
+ Rake.application.run
@@ -0,0 +1,4 @@
1
+ # This file is used by Rack-based servers to start the application.
2
+
3
+ require ::File.expand_path('../config/environment', __FILE__)
4
+ run Rails.application
@@ -0,0 +1,30 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ # Pick the frameworks you want:
4
+ require "active_record/railtie"
5
+ require "action_controller/railtie"
6
+ require "action_mailer/railtie"
7
+ require "action_view/railtie"
8
+ require "sprockets/railtie"
9
+ # require "rails/test_unit/railtie"
10
+
11
+ Bundler.require(*Rails.groups)
12
+
13
+ require "smooth"
14
+
15
+ module Dummy
16
+ class Application < Rails::Application
17
+ # Settings in config/environments/* take precedence over those specified here.
18
+ # Application configuration should go into files in config/initializers
19
+ # -- all .rb files in that directory are automatically loaded.
20
+
21
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
22
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
23
+ # config.time_zone = 'Central Time (US & Canada)'
24
+
25
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
26
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
27
+ # config.i18n.default_locale = :de
28
+ end
29
+ end
30
+
@@ -0,0 +1,5 @@
1
+ # Set up gems listed in the Gemfile.
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
3
+
4
+ require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
5
+ $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
@@ -0,0 +1,25 @@
1
+ # SQLite version 3.x
2
+ # gem install sqlite3
3
+ #
4
+ # Ensure the SQLite 3 gem is defined in your Gemfile
5
+ # gem 'sqlite3'
6
+ #
7
+ default: &default
8
+ adapter: sqlite3
9
+ pool: 5
10
+ timeout: 5000
11
+
12
+ development:
13
+ <<: *default
14
+ database: db/development.sqlite3
15
+
16
+ # Warning: The database defined as "test" will be erased and
17
+ # re-generated from your development database when you run "rake".
18
+ # Do not set this db to the same as development or production.
19
+ test:
20
+ <<: *default
21
+ database: db/test.sqlite3
22
+
23
+ production:
24
+ <<: *default
25
+ database: db/production.sqlite3
@@ -0,0 +1,5 @@
1
+ # Load the Rails application.
2
+ require File.expand_path('../application', __FILE__)
3
+
4
+ # Initialize the Rails application.
5
+ Rails.application.initialize!
@@ -0,0 +1,37 @@
1
+ Rails.application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb.
3
+
4
+ # In the development environment your application's code is reloaded on
5
+ # every request. This slows down response time but is perfect for development
6
+ # since you don't have to restart the web server when you make code changes.
7
+ config.cache_classes = false
8
+
9
+ # Do not eager load code on boot.
10
+ config.eager_load = false
11
+
12
+ # Show full error reports and disable caching.
13
+ config.consider_all_requests_local = true
14
+ config.action_controller.perform_caching = false
15
+
16
+ # Don't care if the mailer can't send.
17
+ config.action_mailer.raise_delivery_errors = false
18
+
19
+ # Print deprecation notices to the Rails logger.
20
+ config.active_support.deprecation = :log
21
+
22
+ # Raise an error on page load if there are pending migrations.
23
+ config.active_record.migration_error = :page_load
24
+
25
+ # Debug mode disables concatenation and preprocessing of assets.
26
+ # This option may cause significant delays in view rendering with a large
27
+ # number of complex assets.
28
+ config.assets.debug = true
29
+
30
+ # Adds additional error checking when serving assets at runtime.
31
+ # Checks for improperly declared sprockets dependencies.
32
+ # Raises helpful error messages.
33
+ config.assets.raise_runtime_errors = true
34
+
35
+ # Raises error for missing translations
36
+ # config.action_view.raise_on_missing_translations = true
37
+ end
@@ -0,0 +1,82 @@
1
+ Rails.application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb.
3
+
4
+ # Code is not reloaded between requests.
5
+ config.cache_classes = true
6
+
7
+ # Eager load code on boot. This eager loads most of Rails and
8
+ # your application in memory, allowing both threaded web servers
9
+ # and those relying on copy on write to perform better.
10
+ # Rake tasks automatically ignore this option for performance.
11
+ config.eager_load = true
12
+
13
+ # Full error reports are disabled and caching is turned on.
14
+ config.consider_all_requests_local = false
15
+ config.action_controller.perform_caching = true
16
+
17
+ # Enable Rack::Cache to put a simple HTTP cache in front of your application
18
+ # Add `rack-cache` to your Gemfile before enabling this.
19
+ # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
20
+ # config.action_dispatch.rack_cache = true
21
+
22
+ # Disable Rails's static asset server (Apache or nginx will already do this).
23
+ config.serve_static_assets = false
24
+
25
+ # Compress JavaScripts and CSS.
26
+ config.assets.js_compressor = :uglifier
27
+ # config.assets.css_compressor = :sass
28
+
29
+ # Do not fallback to assets pipeline if a precompiled asset is missed.
30
+ config.assets.compile = false
31
+
32
+ # Generate digests for assets URLs.
33
+ config.assets.digest = true
34
+
35
+ # `config.assets.precompile` has moved to config/initializers/assets.rb
36
+
37
+ # Specifies the header that your server uses for sending files.
38
+ # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
39
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
40
+
41
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
42
+ # config.force_ssl = true
43
+
44
+ # Set to :debug to see everything in the log.
45
+ config.log_level = :info
46
+
47
+ # Prepend all log lines with the following tags.
48
+ # config.log_tags = [ :subdomain, :uuid ]
49
+
50
+ # Use a different logger for distributed setups.
51
+ # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
52
+
53
+ # Use a different cache store in production.
54
+ # config.cache_store = :mem_cache_store
55
+
56
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server.
57
+ # config.action_controller.asset_host = "http://assets.example.com"
58
+
59
+ # Precompile additional assets.
60
+ # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
61
+ # config.assets.precompile += %w( search.js )
62
+
63
+ # Ignore bad email addresses and do not raise email delivery errors.
64
+ # Set this to true and configure the email server for immediate delivery to raise delivery errors.
65
+ # config.action_mailer.raise_delivery_errors = false
66
+
67
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
68
+ # the I18n.default_locale when a translation cannot be found).
69
+ config.i18n.fallbacks = true
70
+
71
+ # Send deprecation notices to registered listeners.
72
+ config.active_support.deprecation = :notify
73
+
74
+ # Disable automatic flushing of the log to improve performance.
75
+ # config.autoflush_log = false
76
+
77
+ # Use default logging formatter so that PID and timestamp are not suppressed.
78
+ config.log_formatter = ::Logger::Formatter.new
79
+
80
+ # Do not dump schema after migrations.
81
+ config.active_record.dump_schema_after_migration = false
82
+ end