smooth 2.0.1

data/spec/lib/smooth/cache_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe "The Smooth Cache Adapter" do
+  it "should delegate to rails caching system" do
+    value = Smooth.cache.fetch(:key) { 2 }
+    expect(value).to equal(1)
+  end
+end

data/spec/lib/smooth/command_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe "The Smooth Command" do
+  let(:command) { Smooth.current_api.resource("Books").fetch(:command, :like) }
+
+  it "should allow for descriptions of the filters" do
+    expect(command.input_descriptions[:like]).not_to be_blank
+    expect(command.input_descriptions[:left_out]).to be_blank
+  end
+
+  it "should know the resource name" do
+    expect(command.resource_name).to eq("Books")
+  end
+
+  it "should know the command action" do
+    expect(command.command_action).to eq("like")
+  end
+
+  it "should know the event namespace" do
+    expect(command.event_namespace).to eq("like.book")
+  end
+
+  describe "Event Tracking Integration" do
+    it "should track events" do
+      bucket = []
+
+      Smooth.subscribe_to(/like.book/)  do |event|
+        bucket << event
+      end
+
+      command.run()
+
+      expect(bucket).not_to be_empty
+    end
+  end
+end

data/spec/lib/smooth/configuration_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe "Smooth Configuration" do
+  it "should be accessible from the module level" do
+    expect(Smooth.config.class).to equal(Smooth::Configuration)
+  end
+
+  it "should give me the various base classes for smooth objects" do
+    expect(Smooth.config.query_class).to equal(Smooth::Query)
+    expect(Smooth.config.command_class).to equal(Smooth::Command)
+  end
+
+  it "should enable event tracking by default" do
+    expect(Smooth.config.enable_event_tracking?).to eq(true)
+  end
+end

data/spec/lib/smooth/event_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe "The Smooth Event Tracking API" do
+  let(:events) { Smooth::Event }
+
+  it "should use the instrumentation system to implement a little pub sub" do
+    bucket = []
+
+    events.subscribe_to "test.smooth" do |event|
+      bucket << event
+    end
+
+    needle = rand(46**8).to_s(36)
+    events.track_event 'test.smooth', line: "what up #{ needle }?"
+
+    got_event = bucket.any? {|e| e.payload.line.include?(needle) }
+
+    expect(got_event).to equal(true)
+  end
+end

data/spec/lib/smooth/example_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe "The Smooth API Request Example" do
+
+end

data/spec/lib/smooth/query_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe "The Smooth Query" do
+
+end

data/spec/lib/smooth/resource_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe "The Smooth Resource" do
+  let(:api) { Smooth.current_api }
+  let(:books) { api.resource("Books") }
+
+  it "should reference its parent api" do
+    expect(books.api).to be_present
+  end
+
+  it "should have a name" do
+    expect(books.name).to eq("Books")
+  end
+
+  it "should have a like command class" do
+    command = books.fetch(:command, :like)
+    expect(command).to respond_to(:run)
+  end
+
+  it "should have an update command class" do
+    command = books.fetch(:command, :update)
+    expect(command).to respond_to(:run)
+  end
+
+  it "should have a create command class" do
+    command = books.fetch(:command, :create)
+    expect(command).to respond_to(:run)
+  end
+
+  it "should generate a default serializer" do
+    expect(BookSerializer < Smooth::Serializer).to equal(true)
+  end
+
+  it "should generate a default query context" do
+    expect(BookQuery < Smooth::Query).to equal(true)
+  end
+
+end

data/spec/lib/smooth/serializer_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe "The Smooth Serializer" do
+  let(:books) { Smooth.current_api.resource("Books") }
+  let(:serializer) { books.fetch(:serializer, "Default") }
+
+  it "should configure the serializer" do
+    expect(serializer.schema_attributes).not_to be_empty
+  end
+
+  it "should relate to the book model" do
+    expect(Book.active_model_serializer).to equal(serializer)
+  end
+
+  it "should have documentation for its attributes" do
+    expect(serializer.documentation_for_attribute(:title).description).not_to be_blank
+  end
+
+  it "should have documentation for its relationships" do
+    expect(serializer.documentation_for_association(:author).description).not_to be_blank
+  end
+
+  it "should have documentation for its computed properties" do
+    expect(serializer.documentation_for_attribute(:computed_property).description).not_to be_blank
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+
+require 'rspec/rails'
+require 'faker'
+require 'rack/test'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+end

metadata

@@ -0,0 +1,394 @@
+--- !ruby/object:Gem::Specification
+name: smooth
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- Jonathan Soeder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Smooth provides a simple DSL building powerful JSON APIs on top of ActiveRecord.
+email:
+- jonathan.soeder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/images/smooth/.keep
+- app/assets/javascripts/smooth/.keep
+- app/controllers/.keep
+- app/helpers/.keep
+- app/mailers/.keep
+- app/models/.keep
+- app/views/.keep
+- config/routes.rb
+- lib/smooth.rb
+- lib/smooth/api.rb
+- lib/smooth/api/policy.rb
+- lib/smooth/api/tracking.rb
+- lib/smooth/cache.rb
+- lib/smooth/command.rb
+- lib/smooth/command/instrumented.rb
+- lib/smooth/configuration.rb
+- lib/smooth/documentation.rb
+- lib/smooth/dsl.rb
+- lib/smooth/event.rb
+- lib/smooth/example.rb
+- lib/smooth/ext/core.rb
+- lib/smooth/ext/mutations.rb
+- lib/smooth/query.rb
+- lib/smooth/resource.rb
+- lib/smooth/resource/tracking.rb
+- lib/smooth/serializer.rb
+- lib/smooth/version.rb
+- smooth.gemspec
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/apis/application_api.rb
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.keep
+- spec/dummy/app/models/.keep
+- spec/dummy/app/models/author.rb
+- spec/dummy/app/models/book.rb
+- spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/resources/books.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20140822065900_create_books.rb
+- spec/dummy/db/migrate/20140822065916_create_authors.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/lib/assets/.keep
+- spec/dummy/log/.keep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/lib/smooth/api/policy_spec.rb
+- spec/lib/smooth/api_spec.rb
+- spec/lib/smooth/cache_spec.rb
+- spec/lib/smooth/command_spec.rb
+- spec/lib/smooth/configuration_spec.rb
+- spec/lib/smooth/event_spec.rb
+- spec/lib/smooth/example_spec.rb
+- spec/lib/smooth/query_spec.rb
+- spec/lib/smooth/resource_spec.rb
+- spec/lib/smooth/serializer_spec.rb
+- spec/spec_helper.rb
+homepage: http://smooth.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Smooth provides a DSL for creating self-testing, self-documenting, highly
+  inspectable API endpoints which are able to generate extendable client libraries.
+test_files:
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/apis/application_api.rb
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.keep
+- spec/dummy/app/models/.keep
+- spec/dummy/app/models/author.rb
+- spec/dummy/app/models/book.rb
+- spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/resources/books.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20140822065900_create_books.rb
+- spec/dummy/db/migrate/20140822065916_create_authors.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/lib/assets/.keep
+- spec/dummy/log/.keep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/lib/smooth/api/policy_spec.rb
+- spec/lib/smooth/api_spec.rb
+- spec/lib/smooth/cache_spec.rb
+- spec/lib/smooth/command_spec.rb
+- spec/lib/smooth/configuration_spec.rb
+- spec/lib/smooth/event_spec.rb
+- spec/lib/smooth/example_spec.rb
+- spec/lib/smooth/query_spec.rb
+- spec/lib/smooth/resource_spec.rb
+- spec/lib/smooth/serializer_spec.rb
+- spec/spec_helper.rb