smooth 2.0.1 → 2.0.2

data/lib/smooth/user_adapter.rb

@@ -0,0 +1,83 @@
+module Smooth
+  module UserAdapter
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:attr_accessor, :last_request_params, :last_request_headers)
+
+      base.send(:before_create, -> { generate_token(Smooth.config.auth_token_column) })
+    end
+
+    def generate_token(column)
+      if self.class.column_names.include?(column.to_s)
+        write_attribute(column, SecureRandom.urlsafe_base64)
+      end
+    end
+
+    module ClassMethods
+      def find_for_smooth_api_request(id, passed_authentication_token)
+        where(id: id, authentication_token: passed_authentication_token).first
+      end
+
+      def find_for_token_authentication(passed_authentication_token)
+        id, token = passed_authentication_token.split(':')
+        find_for_smooth_api_request(id, token)
+      end
+
+      def anonymous(params = nil, headers = nil)
+        User.new.tap do |user|
+          user.last_request_params = params if params
+          user.last_request_headers = headers if headers
+          user.making_anonymous_request = true
+        end
+      end
+    end
+
+    def making_anonymous_request=(setting)
+      @making_anonymous_request = !!(setting)
+    end
+
+    def anonymous?
+      !!(@making_anonymous_request)
+    end
+
+    def smooth_authentication_token
+      read_attribute(:authentication_token)
+      "#{ id }:#{ token }"
+    end
+
+    # Allows for using the current_user making an API request
+    # as the source of all queries, and commands run against
+    # Smooth resources.
+    #
+    # Example:
+    #
+    #   current_user.smooth.query("books.mine", published_before: 2014)
+    #
+    # Piping all queries to the Smooth Resources through the same interface
+    # makes implementing a declarative, role based access control policy pretty
+    # easy.
+    #
+    # You could even add the following methods to all of your ApplicationController
+    #
+    # Example:
+    #
+    # class ApplicationController < ActionController::Base
+    #   def run_query *args, &block
+    #     current_user.smooth.send(:query, *args, &block)
+    #   end
+    #
+    #   def run_command *args, &block
+    #     current_user.smooth.send(:run_command, *args, &block)
+    #   end
+    # end
+    #
+    # class BooksController < ApplicationController
+    #   def index
+    #     render :json => run_query("books", params)
+    #   end
+    # end
+    def smooth(api = :default)
+      Smooth.fetch_api(api).as(self)
+    end
+  end
+end

data/lib/smooth/util.rb

@@ -0,0 +1,17 @@
+module Smooth
+  module Util
+    extend self
+
+    def uri_template(url_pattern)
+      URITemplate.new(:colon, url_pattern)
+    end
+
+    def expand_url_template(uri_template, vars = {})
+      uri_template.expand(vars)
+    end
+
+    def extract_url_vars(uri_template, actual_url)
+      uri_template.extract(actual_url).tap(&:symbolize_keys!)
+    end
+  end
+end

data/lib/smooth/version.rb

@@ -1,3 +1,3 @@
 module Smooth
-  VERSION = "2.0.1"
+  VERSION = '2.0.2'
 end

data/smooth.gemspec

@@ -21,9 +21,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hashie'
   spec.add_dependency 'activesupport', '>= 4.0.0'
   spec.add_dependency 'activerecord', '>= 4.0.0'
-  spec.add_dependency 'active_model_serializers'
-  spec.add_dependency 'faker'
+  spec.add_dependency 'active_model_serializers', '~> 0.8.0'
+  spec.add_dependency 'ffaker'
+  spec.add_dependency 'factory_girl'
   spec.add_dependency 'mutations'
+  spec.add_dependency 'sinatra'
+  spec.add_dependency 'escape_utils'
+  spec.add_dependency 'uri_template'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/acceptance/books_routes_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe "The Books Resource Routes" do
+  let(:books) { Smooth("Books") }
+
+  let(:session) do
+    Rack::MockSession.new(books.api.sinatra)
+  end
+
+  let(:client) do
+    Rack::Test::Session.new(session)
+  end
+
+  it "should make a request to the show action" do
+    book = Book.create(title:"Cristian The LionHeart")
+    response = client.get("/books/#{ book.id }")
+    json = JSON.parse(response.body) rescue {}
+    book = json.fetch("book")
+
+    expect(response.status).to eq(200)
+    expect(book["title"]).to eq("Cristian The LionHeart")
+  end
+
+  it "should make a request to the books query" do
+    Book.create(title:"Luca The Coming Champ", year_published: 1895)
+    response = client.get("/books", title: "Luca")
+    json = JSON.parse(response.body) rescue {}
+
+    expect(json).not_to be_empty
+    expect(response.status).to eq(200)
+  end
+
+  it "should make a request to the create command" do
+    response = client.post("/books", title: "The Biography of Jon Soeder")
+
+    json = JSON.parse(response.body) rescue {}
+
+    book = json.fetch("book")
+
+    expect(response.status).to eq(200)
+    expect(book).to have_key("author_id")
+    expect(book["id"]).not_to be_nil
+    expect(book["title"]).to eq("The Biography of Jon Soeder")
+  end
+
+  it "should return errors if i don't include the right params" do
+    response = client.post("/books")
+    expect(response.status).not_to eq(200)
+  end
+end

data/spec/acceptance/embedded_relationships_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe "The Books Resource Routes" do
+  let(:books) { Smooth("Books") }
+
+  let(:session) do
+    Rack::MockSession.new(books.api.sinatra)
+  end
+
+  let(:client) do
+    Rack::Test::Session.new(session)
+  end
+
+  it "should fetch objects by ids" do
+
+    book_ids = 3.times.map do |n|
+      Book.create(title:"Book #{ Time.now.to_i }")
+    end.slice(0,2).map(&:id).join(',')
+
+    response =client.get("/books?ids=#{ book_ids }")
+    json = JSON.parse(response.body) rescue {}
+
+    expect(json.length).to eq(2)
+  end
+end
+

data/spec/dummy/app/apis/application_api.rb

@@ -3,12 +3,17 @@ require 'smooth/dsl'
 api "My Application" do
   version :v1
 
+  authentication_strategy :header, "X-AUTH-TOKEN"
+
+  user_class User do
+    include(Smooth::UserAdapter)
+  end
+
   desc "Public users include anyone with access to the URL"
   policy :public_users do
-
     # commands / queries can be set to true or false to allow
     # all commands and queries defined for the books resource.
-    allow :books, :commands => false, :queries => true
+    #allow :books, :commands => false, :queries => true
 
     # we can also pass an array of queries or commands
     # allow :books, :commands => [:like]
@@ -17,7 +22,7 @@ api "My Application" do
   desc "Authenticated users register and are given an auth token"
   policy :logged_in_users do
     authenticate_with :header => 'X-AUTH-TOKEN', :param => :auth_token
-    allow :books, :commands => true, :queries => true
+    #allow :books, :commands => true, :queries => true
   end
 
   desc "Admin users have the admin flag set to true"

data/spec/dummy/app/commands/create_book.rb

@@ -0,0 +1,5 @@
+class CreateBook < Smooth.config.command_class
+  def execute
+    model_class.create(title: title)
+  end
+end

data/spec/dummy/app/models/book.rb

@@ -1,2 +1,3 @@
 class Book < ActiveRecord::Base
+  belongs_to :author
 end

data/spec/dummy/app/models/library.rb

@@ -0,0 +1,2 @@
+class Library < ActiveRecord::Base
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/dummy/app/queries/book_query.rb

@@ -0,0 +1,13 @@
+class BookQuery < Smooth::Query
+  def self.developer_defined_method
+    true
+  end
+end
+
+resource "Books" do
+  query do
+    def inline_dsl_method
+      true
+    end
+  end
+end

data/spec/dummy/app/resources/{books.rb → books_definition.rb}

@@ -1,4 +1,5 @@
 resource "Books" do
+  desc "The default serializer for book"
   serializer do
     desc "A unique id for the book", :type => :integer
     attribute :id
@@ -13,11 +14,17 @@ resource "Books" do
     def computed_property
       object.created_at
     end
+
+    desc "Another way for doing computed properties"
+    computed(:another_computed_property) do
+      object.created_at.to_i
+    end
   end
 
   # This will create a class 'UpdateBook'.  The execute method
   # is open for definition by the developer.
-  command :update, "Update a book's attributes" do
+  desc "Update a book's attributes"
+  command :update do
     # Will ensure the command is run with
     # Book.accessible_to(current_user).find(id).
     scope :accessible_to
@@ -29,17 +36,21 @@ resource "Books" do
         string :title
       end
     end
+
+    execute(:update)
   end
 
-  command :create, "Add a new book to the library" do
+  desc "Create a book"
+  command :create do
     scope :accessible_to
 
     params do
-      string :title
+      string :title, faker: 'app.author'
     end
   end
 
-  command :like, 'Toggle liking on/off for a book' do
+  desc "Toggle whether you like a book or not"
+  command :like do
     scope :all
 
     params do
@@ -52,18 +63,24 @@ resource "Books" do
     end
   end
 
+  desc "Here we just define a relationship to a known class"
+  command :criticize, (CriticizeBook = Class.new(Smooth::Command))
+
   # This will create a class 'BookQuery'.  The build_scope method
   # is open for definition by the developer.
   query do
-    start_from :scope => :accessible_to
+    scope :accessible_to
 
     params do
       desc "The year the book was published (example: YYYY)"
-      integer :year_published
+      integer :year_published, operator: :gte
+
+      desc "A partial string to filter the title by"
+      string :title, operator: :like
     end
 
     role :admin do
-      start_from :scope => :all
+      scope :all
     end
   end
 
@@ -72,19 +89,27 @@ resource "Books" do
   # under /api/v1/books, /api/v1/books/1 etc
   routes do
     desc "List all books"
-    get "/books", :to => :query
+    get "/books", :to => :query, :as => :list_books
 
     desc "Show an individual book"
-    show "/books/:id", :to => :show
+    show "/books/:id", :to => :show, :as => :show_book
 
     desc "Create a new book"
-    post "/books", :to => :create
+    post "/books", :to => :create, :as => :create_book
 
     desc "Update an existing book"
-    put "/books/:id", :to => :update
+    put "/books/:id", :to => :update, :as => :update_book
 
     desc "Like a book"
-    put "/books/:id/like", :to => :like
+    put "/books/:id/like", :to => :like, :as => :like_book
+  end
+
+  template do
+    title { Smooth.faker('company.catch_phrase') }
+  end
+
+  template :ancient, class: Book do
+    year_published { 1776 }
   end
 
   examples :client => :rest do

data/spec/dummy/db/migrate/20140824215902_create_users.rb

@@ -0,0 +1,10 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :email
+      t.string :role
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20140826193259_create_libraries.rb

@@ -0,0 +1,10 @@
+class CreateLibraries < ActiveRecord::Migration
+  def change
+    create_table :libraries do |t|
+      t.string :name
+      t.string :address
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140822065916) do
+ActiveRecord::Schema.define(version: 20140824215902) do
 
   create_table "authors", force: true do |t|
     t.string   "name"
@@ -27,4 +27,11 @@ ActiveRecord::Schema.define(version: 20140822065916) do
     t.datetime "updated_at"
   end
 
+  create_table "users", force: true do |t|
+    t.string   "email"
+    t.string   "role"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
 end

data/spec/lib/smooth/api/async_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe "Smooth Command Background Job Handling" do
+  let(:api) { Smooth() }
+
+  it "should serialize a command call and restore it from memory" do
+    key = api.serialize_for_async('books.create', {title:'New Book'})
+    expect(key).to be_present
+  end
+
+  it "should deserialize a command call" do
+    key = api.serialize_for_async('books.create', {title:'New Book'})
+    hash = Smooth.config.memory_store.read(key).symbolize_keys
+    api_name, object_path, payload = hash.values_at(:api, :object_path, :payload)
+
+    expect(api_name).to eq('My Application')
+    expect(Smooth(api_name)).to eq(api)
+    expect(Smooth(api_name).lookup(object_path)).to be_present
+    expect(payload[:title]).to eq('New Book')
+  end
+end

data/spec/lib/smooth/api_spec.rb

@@ -19,5 +19,13 @@ describe "The Smooth API Definition" do
   it "should have a version" do
     expect(api.version).to equal(:v1)
   end
+
+  it "should lookup objects by a shortcut alias / path" do
+    expect(api.lookup_object_by("books")).to be_a(Smooth::Resource)
+    expect(api.lookup_object_by("books.create")).to eq(CreateBook)
+    expect(api.lookup_object_by("books.like")).to eq(LikeBook)
+    expect(api.lookup_object_by("books.query")).to eq(BookQuery)
+    expect(api.lookup_object_by("books.serializer")).to eq(BookSerializer)
+  end
 end