vodka 0.1.0 → 0.1.2

data/.travis.yml

@@ -1,3 +1,5 @@
+services:
+  - mongodb
 rvm:
   - 1.9.3
 script: ./script/ci

data/README.md

@@ -1,14 +1,15 @@
-# Vodka
+# Vodka [![Build Status](https://travis-ci.org/magnolia-fan/vodka.png)](https://travis-ci.org/magnolia-fan/vodka)
 Vodka makes communication easier. Always.
 
 Vodka uses [Her](https://github.com/remiprev/her) as a REST client.
 
-It currently supports these ORMs on server:
+Vodka currently supports these ORMs on server:
 - [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord)
+- [Mongoid](https://github.com/mongoid/mongoid)
 - [MongoMapper](https://github.com/jnunemaker/mongomapper)
 
-And the following plugins:
-- [WillPaginate](https://github.com/mislav/will_paginate)
+And the following plugins on client:
+- [WillPaginate](https://github.com/mislav/will_paginate) (and compatible)
 
 Vodka supports I18n. If you change locale on client you may expect getting response from server in this locale.
 
@@ -31,6 +32,11 @@ Add initializer `vodka_setup.rb` to `config/initializers`:
 Vodka::Server.configure do |c|
   c.request_secret = '8089c2189321798bf60df6b8c01bb661fb585080'
   c.response_secret = '3ecb42ac23cd58994a6518971e7e31d2f4545e3c'
+
+  # Optional
+
+  # Any class that responds to .hexdigest method
+  c.digest = Digest::SHA1 # Default is Digest::SHA512
 end
 ```
 
@@ -72,8 +78,8 @@ class Article < ActiveRecord::Base
   scope :best, ->{ where('rating > 100') }
   validates_presence_of :title, :body
 
-  # Defines fields and actions that would be used in :as_json method
-  present_with :id, :title, :body, :created_at
+  # If .present_with was not called, default presenter (named as ModelNamePresenter) will be used
+  # present_with ArticlePresenter
 end
 
 # comment.rb
@@ -82,8 +88,8 @@ class Comment < ActiveRecord::Base
   belongs_to :user
   validates_presence_of :body
 
-  # Defines fields and actions that would be used in :as_json method
-  present_with :id, :body, :author_name, :created_at
+  # Defines custom presenter
+  present_with CommentCustomPresenter
 
   def approve
     update_attributes(status: 'approved')
@@ -95,6 +101,16 @@ class Comment < ActiveRecord::Base
 end
 ```
 
+Add presenters:
+```ruby
+# article_presenter.rb
+class ArticlePresenter < VodkaPresenter
+  def present
+    json(id: id, title: title)
+  end
+end
+```
+
 ## Configuring client
 Add initializer `vodka_setup.rb` to `config/initializers`:
 
@@ -103,10 +119,17 @@ Vodka::Client.configure do |c|
   c.api_url = 'https://api.myproject.org/vodka'
   c.request_secret = '8089c2189321798bf60df6b8c01bb661fb585080'  # Same as server's
   c.response_secret = '3ecb42ac23cd58994a6518971e7e31d2f4545e3c' # Same as server's
+
+  # Optional
+
+  # Any class that responds to .hexdigest method
+  c.digest = Digest::SHA1 # Default is Digest::SHA512, same as server's
+
+  # Configure Her automatically
+  c.auto_configure_her = false
 end
-Vodka::Client.configure_her!
 
-# Instead of calling Vodka::Client.configure_her! you may configure her yourself
+# You can call Vodka::Client.config.configure_her! or configure Her yourself
 # Her::API.setup(url: Vodka::Client.config.api_url) do |c|
 #   c.use Vodka::Client::Middleware::ErrorAware
 #   c.use Vodka::Client::Middleware::SignedRequest

data/lib/party.rb

@@ -1,10 +1,11 @@
 require 'i18n'
 require 'vodka/client'
 require './spec/client/article'
+require './spec/client/author'
+require './spec/client/comment'
 
 Vodka::Client.configure do |c|
   c.api_url = 'http://0.0.0.0:3000/vodka'
   c.request_secret = '8089c2189321798bf60df6b8c01bb661fb585080'
   c.response_secret = '3ecb42ac23cd58994a6518971e7e31d2f4545e3c'
 end
-Vodka::Client.configure_her!

data/lib/vodka/client.rb

@@ -8,8 +8,6 @@ require 'vodka/client/exceptions/security_exception'
 require 'vodka/client/middleware/signed_request'
 require 'vodka/client/middleware/signed_response'
 require 'vodka/client/middleware/error_aware'
-require 'vodka/her/extensions/extended_orm'
-require 'vodka/her/extensions/will_paginate'
 
 module Vodka
   module Client

data/lib/vodka/client/middleware/signed_request.rb

@@ -23,7 +23,7 @@ module Vodka
         end
 
         def request_signature
-          Digest::SHA512.hexdigest([request_id, Vodka::Client.config.request_secret].join)
+          Vodka::Client.config.digest.hexdigest([request_id, Vodka::Client.config.request_secret].join)
         end
       end
     end

data/lib/vodka/client/middleware/signed_response.rb

@@ -31,7 +31,7 @@ module Vodka
         end
 
         def expected_response_signature
-          Digest::SHA512.hexdigest([request_id, Vodka::Client.config.response_secret].join)
+          Vodka::Client.config.digest.hexdigest([request_id, Vodka::Client.config.response_secret].join)
         end
       end
     end

data/lib/vodka/configuration.rb

@@ -1,6 +1,31 @@
 module Vodka
   class Configuration
-    attr_accessor :request_secret, :response_secret, :api_url
+    attr_accessor :request_secret,          # Secret token to use in signing requests, stronger is better
+                  :response_secret,         # Secret token to use in signing responses, stronger is better
+                  :digest,                  # Digest algorithm to use in signing process
+                  :perform_request_signing, # If the value is set to false no signing middlewares will be injected
+                  :her_auto_configure,      # Configure Her automatically
+                  :api_url,                 # REST API endpoint passed to Her
+                  :prefix                   # Almost the same thing, path prefix for server
+
+    def initialize
+      @digest = Digest::SHA512
+      @perform_request_signing = true
+      @her_auto_configure = true
+    end
+
+    def configure_her!
+      raise Exception.new('api_url must be set') if api_url.nil?
+
+      ::Her::API.setup(url: api_url) do |c|
+        c.use(Vodka::Client::Middleware::ErrorAware)
+        c.use(Vodka::Client::Middleware::SignedRequest) if perform_request_signing
+        c.use(Faraday::Request::UrlEncoded)
+        c.use(Vodka::Client::Middleware::SignedResponse) if perform_request_signing
+        c.use(::Her::Middleware::SecondLevelParseJSON)
+        c.use(Faraday::Adapter::NetHttp)
+      end
+    end
   end
 
   module Configurable
@@ -10,17 +35,7 @@ module Vodka
 
     def configure
       yield config if block_given?
-    end
-
-    def configure_her!
-      ::Her::API.setup(url: Vodka::Client.config.api_url) do |c|
-        c.use Vodka::Client::Middleware::ErrorAware
-        c.use Vodka::Client::Middleware::SignedRequest
-        c.use Faraday::Request::UrlEncoded
-        c.use Vodka::Client::Middleware::SignedResponse
-        c.use ::Her::Middleware::SecondLevelParseJSON
-        c.use Faraday::Adapter::NetHttp
-      end
+      config.configure_her! if config.her_auto_configure
     end
   end
 end

data/lib/vodka/server.rb

@@ -2,14 +2,17 @@ require 'vodka'
 require 'vodka/server/middleware/signed_request'
 require 'vodka/server/railtie'
 require 'vodka/server/response'
+require 'vodka/server/relation'
 require 'vodka/server/handlers/resource'
 require 'vodka/server/handlers/response'
 require 'vodka/server/handlers/scaffold'
 require 'vodka/server/controllers/vodka_controller'
+require 'vodka/server/presenters/vodka_presenter'
 require 'vodka/server/plugins/presentable'
 
 module Vodka
   module Server
     extend Configurable
+    config.her_auto_configure = false
   end
 end

data/lib/vodka/server/controllers/vodka_controller.rb

@@ -7,7 +7,7 @@ module Vodka
       include Handlers::Resource
       include Handlers::Response
 
-      before_filter :set_response_id, :fix_params_names, :set_locale
+      before_filter :set_response_id, :set_locale
       before_filter :handle_not_found, only: [:show, :update, :destroy]
 
     private
@@ -18,10 +18,6 @@ module Vodka
         I18n.locale = locale if locale.present? && locale.to_sym.in?(I18n.available_locales)
       end
 
-      def fix_params_names
-        params[:password] = params.delete(:buzzword) unless params[:buzzword].nil?
-      end
-
       def handle_not_found
         not_found if resource.nil? && vodka_response.success == false
       end

data/lib/vodka/server/handlers/resource.rb

@@ -11,14 +11,18 @@ module Vodka
         def extract_resource
           return unless params.has_key?(:id)
 
-          new_resource = resource_class.find_by_id(params[:id])
+          new_resource = begin
+            resource_class.find(params[:id])
+          rescue
+            nil
+          end
           vodka_response.success = false if new_resource.nil?
 
           new_resource
         end
 
         def filtered_params
-          params.slice(*resource_class.accessible_attributes.to_a)
+          params.permit(*(resource_class.attribute_names - ['id']).map(&:to_sym))
         end
 
         # Resource magick

data/lib/vodka/server/handlers/response.rb

@@ -2,26 +2,30 @@ module Vodka
   module Server
     module Handlers
       module Response
-
         def vodka_response
           @vodka_response ||= Vodka::Server::Response.new
         end
 
       private
 
-        def respond_with_resource(custom_resource = nil)
+        def respond_with_resource(custom_resource = nil, presenter = nil)
           vodka_response.data = custom_resource || resource
+          vodka_response.presenter = presenter unless presenter.nil?
           respond!
         end
 
-        def respond_with_collection(resources)
-          vodka_response.data = resources
+        def respond_with_collection(resources, presenter = nil)
+          vodka_response.data = resources.to_a
+          vodka_response.presenter = presenter unless presenter.nil?
           respond!
         end
 
         def respond!
-          response.headers['X-Response-Id'] = vodka_response.id
-          response.headers['X-Response-Signature'] = vodka_response.signature
+          if Vodka::Server.config.perform_request_signing
+            response.headers['X-Response-Id'] = vodka_response.id
+            response.headers['X-Response-Signature'] = vodka_response.signature
+          end
+
           return render text: vodka_response.json, status: vodka_response.code, content_type: 'application/json'
         end
 

data/lib/vodka/server/handlers/scaffold.rb

@@ -3,19 +3,9 @@ module Vodka
     module Handlers
       module Scaffold
         def index
-          if params[:vodka_special_action] == 'first'
-            resources = [resource_class.first]
-          elsif params[:vodka_special_action] == 'last'
-            resources = [resource_class.last]
-          elsif params[:vodka_special_where].present?
-            resources = vodka_special_where
-          elsif params[:page].present? && defined?(::WillPaginate)
-            resources = vodka_special_paginate
-          else
-            resources = resource_class.all
-          end
-
-          respond_with_collection(resources)
+          relation = Vodka::Server::Relation.new(resource_class, params)
+          vodka_response.metadata.merge!(relation.metadata)
+          respond_with_collection(relation.data)
         end
 
         def show
@@ -32,31 +22,11 @@ module Vodka
         end
 
         def destroy
-          resource.destroy
+          method = params.has_key?(:soft) ? :delete : :destroy
+          resource.send(method)
           vodka_response.success = resource.destroyed?
           respond_with_resource
         end
-
-      private
-
-        def vodka_special_where
-          relation = resource_class
-          conditions = MultiJson.load(params[:vodka_special_where])
-          conditions.each do |condition|
-            if condition.is_a?(Hash)
-              relation = relation.where(condition)
-            else
-              relation = relation.where(*condition)
-            end
-          end
-          relation.all
-        end
-
-        def vodka_special_paginate
-          data = resource_class.paginate(page: params[:page], per_page: params[:per_page]).all
-          vodka_response.metadata = { page: data.current_page, per_page: data.per_page, total: resource_class.count }
-          data
-        end
       end
     end
   end

data/lib/vodka/server/middleware/signed_request.rb

@@ -2,7 +2,7 @@ module Vodka
   module Server
     module Middleware
       class SignedRequest
-        attr_reader :app, :env, :request
+        attr_reader :app, :env
 
         def initialize(app, options = {})
           @app, @options = app, options
@@ -10,7 +10,9 @@ module Vodka
 
         def call(env)
           @env = env
-          @request = Rack::Request.new(env)
+
+          return app.call(env) if Vodka::Server.config.perform_request_signing == false
+          return app.call(env) unless env['REQUEST_PATH'].start_with?(Vodka::Server.config.prefix)
 
           request_signature_valid? ? app.call(env) : forbidden
         end
@@ -28,11 +30,11 @@ module Vodka
         end
 
         def expected_request_signature
-          Digest::SHA512.hexdigest([request_id, Vodka::Server.config.request_secret].join)
+          Vodka::Server.config.digest.hexdigest([request_id, Vodka::Server.config.request_secret].join)
         end
 
         def response_signature
-          Digest::SHA512.hexdigest([request_id, Vodka::Server.config.response_secret].join)
+          Vodka::Server.config.digest.hexdigest([request_id, Vodka::Server.config.response_secret].join)
         end
 
         def forbidden

data/lib/vodka/server/plugins/presentable.rb

@@ -2,12 +2,20 @@ module Vodka
   module Server
     module Plugins
       module Presentable
-        def present_with(*methods)
-          define_method 'present_vodka' do
-            json = Hash[methods.map{ |method| [method, send(method)] }]
-            json[:errors] = errors.messages
-            json[:metadata] = {}
-            json
+        extend ActiveSupport::Concern
+
+        def present
+          presenter_class = if self.class.class_variable_defined?(:@@presenter)
+            self.class.class_variable_get(:@@presenter)
+          else
+            Object.const_get(:"#{self.class.name}Presenter")
+          end
+          presenter_class.new(self).present
+        end
+
+        module ClassMethods
+          def present_with(klass)
+            class_variable_set(:@@presenter, klass)
           end
         end
       end
@@ -15,6 +23,13 @@ module Vodka
   end
 end
 
-ActiveRecord::Base.send(:extend, Vodka::Server::Plugins::Presentable) if defined?(ActiveRecord)
-MongoMapper::Document.send(:extend, Vodka::Server::Plugins::Presentable) if defined?(MongoMapper)
-MongoMapper::EmbeddedDocument.send(:extend, Vodka::Server::Plugins::Presentable) if defined?(MongoMapper)
+if defined?(ActiveRecord)
+  ActiveRecord::Base.send(:include, Vodka::Server::Plugins::Presentable)
+end
+if defined?(MongoMapper)
+  MongoMapper::Document.send(:include, Vodka::Server::Plugins::Presentable)
+  MongoMapper::EmbeddedDocument.send(:include, Vodka::Server::Plugins::Presentable)
+end
+if defined?(Mongoid)
+  Mongoid::Document.send(:include, Vodka::Server::Plugins::Presentable)
+end

data/lib/vodka/server/presenters/vodka_presenter.rb

@@ -0,0 +1,23 @@
+module Vodka
+  module Server
+    class VodkaPresenter
+      attr_accessor :resource
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def present
+        raise ::Exception.new("#{self.class.name}#present must be defined!")
+      end
+
+      def json(hash)
+        hash[:errors] = resource.errors.messages
+        hash[:metadata] = {}
+        hash
+      end
+    end
+  end
+end
+
+VodkaPresenter = Vodka::Server::VodkaPresenter