servies 0.2.0

data/lib/generators/servies/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module Servies
+  class InstallGenerator < Rails::Generators::Base
+    def self.source_root
+      @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+    end
+
+    def copy_backend_directory
+      directory 'backend', 'app/backend', recursive: true
+    end
+
+    def add_backend_to_autoload_paths
+      application "config.autoload_paths += %W(\#{config.root}/app/backend)"
+    end
+  end
+end

data/lib/generators/servies/templates/backend/backend.rb

@@ -0,0 +1,3 @@
+class Backend < Servies::Backend
+  # This class is a placeholder that will be expanded by a later feature branch
+end

data/lib/generators/servies/templates/backend/command.rb

@@ -0,0 +1,3 @@
+class Command
+  include Servies::Operation
+end

data/lib/generators/servies/templates/backend/interactor.rb

@@ -0,0 +1,16 @@
+class Interactor
+  include Servies::Operation
+
+  # If you want your interactors to be compatible with a backgrounding
+  # daemon, you can use this base class to add support.
+  #
+  # Example for Resque:
+  #
+  # def self.perform(*args)
+  #   new(*args).call
+  # end
+
+  def authorized?
+    raise NotImplementedError
+  end
+end

data/lib/generators/servies/templates/backend/query.rb

@@ -0,0 +1,3 @@
+class Query
+  include Servies::Operation
+end

data/lib/servies.rb

@@ -0,0 +1,19 @@
+module Servies
+  # this method is also available as constantize in Rails,
+  # but we want to be able to write classes and/or tests without Rails
+  def self.get_class_by_string classname
+    classname.constantize
+  end
+
+  def self.string_to_classname string
+    string.to_s.camelize
+  end
+end
+
+require_relative 'servies/engine' if defined?(Rails)
+require_relative 'servies/access_denied'
+require_relative 'servies/validation_error'
+require_relative 'servies/validations'
+require_relative 'servies/backend'
+require_relative 'servies/operation'
+require_relative 'servies/version'

data/lib/servies/access_denied.rb

@@ -0,0 +1,4 @@
+module Servies
+  class AccessDenied < StandardError
+  end
+end

data/lib/servies/backend.rb

@@ -0,0 +1,23 @@
+require 'servies/operation_finder'
+
+module Servies
+  class Backend
+    attr_reader :context
+
+    def initialize(context = {})
+      @context = context
+    end
+
+    def interactors
+      OperationFinder.new("Interactors", self, false)
+    end
+
+    def queries
+      OperationFinder.new("Queries", self, true)
+    end
+
+    def commands
+      OperationFinder.new("Commands", self, true)
+    end
+  end
+end

data/lib/servies/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module Servies
+  class Engine < Rails::Engine
+  end
+end

data/lib/servies/operation.rb

@@ -0,0 +1,77 @@
+require 'active_support/concern'
+require 'servies/validations'
+require 'virtus'
+require_relative 'access_denied'
+
+module Servies
+  module Operation
+    include ActiveSupport::Concern
+    include Servies::Validations
+    include Virtus
+
+    attribute :backend, ::Servies::Backend
+
+    def validate
+      return false unless attributes_without_defaults_have_values
+      if respond_to? :valid?
+        raise Servies::ValidationError, "an argument is invalid" unless valid?
+      else
+        true
+      end
+    end
+
+    def call(*args, &block)
+      validate
+      check_authorization
+      execute(*args, &block)
+    end
+
+    private
+
+    def commands
+      backend.commands
+    end
+
+    def queries
+      backend.queries
+    end
+
+    def interactors
+      backend.interactors
+    end
+
+    def context
+      backend.context
+    end
+
+    def servies_options
+      @options
+    end
+
+    def raise_unauthorized(message='Unauthorized')
+      raise Servies::AccessDenied, message
+    end
+
+    def check_authorization
+      raise_unauthorized if respond_to? :authorized?, true and not authorized?
+    end
+
+    def attributes_without_defaults_have_values
+      attributes_without_value = attribute_set.select do |attribute|
+        not attribute.options.has_key?(:default) and send(attribute.name).nil?
+      end
+      attributes_without_value.empty?
+    end
+
+    module ClassMethods
+      # make our interactors behave as Resque jobs
+      def perform(*args)
+        new(*args).call
+      end
+
+      def queue
+        @queue || :interactor_operations
+      end
+    end
+  end
+end

data/lib/servies/operation_finder.rb

@@ -0,0 +1,34 @@
+require 'active_support/inflector'
+
+module Servies
+  class OperationFinder
+    attr_reader :namespace, :backend
+
+    def initialize(namespace, backend, autocall = false)
+      @namespace = namespace
+      @backend   = backend
+      @autocall  = autocall
+    end
+
+    def method_missing(name, attributes = {})
+      klass    = _find_klass(name)
+      instance = klass.new(attributes.merge(backend: backend))
+
+      if @autocall
+        instance.call
+      else
+        instance
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      _find_klass(name)
+    end
+
+    private
+
+    def _find_klass(name)
+      namespace.constantize.const_get(name.to_s.camelize)
+    end
+  end
+end

data/lib/servies/validation_error.rb

@@ -0,0 +1,4 @@
+module Servies
+  class ValidationError < StandardError
+  end
+end

data/lib/servies/validations.rb

@@ -0,0 +1,45 @@
+require 'servies/validation_error'
+
+module Servies
+  module Validations
+    def validate_hexadecimal_string param_name, param
+      #warn "[DEPRECATION] `validate_hexadecimal_string` is deprecated. Please use the ActiveModel validation instead."
+      raise Servies::ValidationError,  "#{param_name.to_s} should be an hexadecimal string." unless param.is_a? String and /\A[\da-fA-F]+\Z/.match param
+    end
+
+    def validate_regex param_name, param, regex, message
+      #warn "[DEPRECATION] `validate_integer` is deprecated. Please use the default format_of ActiveModel validator instead."
+      raise Servies::ValidationError, "#{param_name.to_s} #{message}" unless regex.match param
+    end
+
+    def validate_integer param_name, param, opts = {}
+      #warn "[DEPRECATION] `validate_integer` is deprecated. Please use the default numericality ActiveModel validator with the :only_integer option instead."
+      return if opts[:allow_blank] && param.blank?
+      raise Servies::ValidationError, "#{param_name.to_s} should be an integer." unless param.is_a? Integer
+    end
+
+    def validate_in_set param_name, param, set
+      raise Servies::ValidationError, "#{param_name.to_s} should be on of these values: #{set.inspect}." unless set.include? param
+    end
+
+    def validate_string param_name, param
+      #warn "[DEPRECATION] `validate_string` is deprecated. Please use the ActiveModel validation instead."
+      raise Servies::ValidationError, "#{param_name.to_s} should be a string." unless param.is_a? String
+    end
+
+    def validate_nonempty_string param_name, param
+      #warn "[DEPRECATION] `validate_string` is deprecated. Please use the ActiveModel validation with the :non_empty option instead."
+      raise Servies::ValidationError, "#{param_name.to_s} should be a nonempty string." unless param.is_a?(String) && not(param.nil?) && not(param.empty?)
+    end
+
+    def validate_integer_string param_name, param
+      #warn "[DEPRECATION] `validate_integer_string` is deprecated. Please use the ActiveModel validation instead."
+      raise Servies::ValidationError, "#{param_name.to_s} should be an integer string." unless param.is_a? String and /\A\d+\Z/.match param
+    end
+
+    def validate_not_nil param_name, param
+      #warn "[DEPRECATION] `validate_not_nil` is deprecated. Please use the default presence ActiveModel validator instead."
+      raise Servies::ValidationError, "#{param_name.to_s} should not be nil." if param.nil?
+    end
+  end
+end

data/lib/servies/version.rb

@@ -0,0 +1,3 @@
+module Servies
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: servies
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Marten Veldthuis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Servies helps you to build a backend for your application.
+email:
+- marten@veldthuis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/servies/install_generator.rb
+- lib/generators/servies/templates/backend/backend.rb
+- lib/generators/servies/templates/backend/command.rb
+- lib/generators/servies/templates/backend/interactor.rb
+- lib/generators/servies/templates/backend/query.rb
+- lib/servies.rb
+- lib/servies/access_denied.rb
+- lib/servies/backend.rb
+- lib/servies/engine.rb
+- lib/servies/operation.rb
+- lib/servies/operation_finder.rb
+- lib/servies/validation_error.rb
+- lib/servies/validations.rb
+- lib/servies/version.rb
+homepage: https://github.com/marten/servies/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2216746290766598287
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2216746290766598287
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A service object framework for Ruby, with extra support for Rails.
+test_files: []