shamu 0.0.1 → 0.0.2

data/lib/shamu/sessions/cookie_store.rb

@@ -0,0 +1,79 @@
+require "shamu/rack/cookies"
+
+module Shamu
+  module Sessions
+
+    # Track persistent values in a cookie stored on the user's machine. Values
+    # kept in the CookieStore are not encrypted but they are protected by HMAC
+    # hashing to ensure that they have not been modified.
+    #
+    # To support cookies, in your service it must be instantiated as part of a
+    # Rack request and you must add {Shamu::Rack::CookieMiddleware} to your app.
+    #
+    # ## Adding support to a Rails app
+    #
+    # ```
+    # # application.rb
+    #
+    # config.middleware.use Shamu::Rack::CookiesMiddleware
+    # ```
+    #
+    # ## In a standalone Rack app
+    #
+    # ```
+    # require "shamu/rack"
+    #
+    # app = Rack::Builder.new do
+    #   use Shamu::Rack::CookiesMiddleware
+    #
+    # end
+    #
+    # run app
+    # ```
+    class CookieStore < Services::Service
+      include Sessions::SessionStore
+      include Shamu::Security::HashedValue
+
+      # How long cookies should be kept.
+      TTL = ( 30 * 24 * 60 * 60 ).freeze
+
+      # ============================================================================
+      # @!group Dependencies
+      #
+
+      # @!attribute
+      # @return [Shamu::Rack::Cookies]
+      attr_dependency :cookies, Shamu::Rack::Cookies
+
+      #
+      # @!endgroup Dependencies
+      #
+
+      # @param [String] private_key the private key used to verify cookie
+      #     values.
+      initialize do |private_key = Shamu::Security.private_key, **|
+        @private_key = private_key
+      end
+
+      # (see SessionStore#fetch)
+      def fetch( key, &block )
+        if cookies.key?( key )
+          verify_hash( cookies.get( key ) )
+        elsif block_given?
+          yield
+        end
+      end
+
+      # (see SessionStore#set)
+      def set( key, value )
+        cookies.set( key, value: hash_value( value ), secure: true, max_age: TTL )
+      end
+
+      # (see SessionStore#delete)
+      def delete( key )
+        cookies.delete( key )
+      end
+
+    end
+  end
+end

data/lib/shamu/sessions/session_store.rb

@@ -0,0 +1,42 @@
+module Shamu
+  module Sessions
+
+    # Exposes a persistent key/value store to track state across multiple
+    # requests.
+    module SessionStore
+
+      def self.create( scorpion, *args, **dependencies, &block )
+        return scorpion.fetch Shamu::Sessions::CookieStore, *args, **dependencies, &block if defined? Rack
+
+        fail "Configure a Shamu::Sessions::SessionStore in your scorpion setup."
+      end
+
+      # Fetch the value with the given key from the store. If they key does not
+      # yet exist, yields to the block and caches the result.
+      #
+      # @param [String] key
+      # @yieldreturn The calculated value of the key.
+      # @return [Object]
+      def fetch( key, &block )
+        fail NotImplementedError
+      end
+
+      # Save a named value in the session.
+      #
+      # @param [String] key
+      # @param [Object] value. Must be a primitive (String, Number, Hash, Array).
+      # @return [value]
+      def set( key, value )
+        fail NotImplementedError
+      end
+
+      # Remove the value with the given key.
+      # @param [String] key
+      # @return [nil]
+      def delete( key )
+        fail NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/shamu/sessions.rb

@@ -0,0 +1,8 @@
+module Shamu
+
+  # {include:file:lib/shamu/sessions/README.md}
+  module Sessions
+    require "shamu/sessions/session_store"
+    require "shamu/sessions/cookie_store"
+  end
+end

data/lib/shamu/to_bool_extension.rb

@@ -0,0 +1,57 @@
+module Shamu
+
+  # Adds `to_bool` to strings, numbers, booleans and nil class to provide a
+  # consistent means of parsing values to a Boolean type.
+  module ToBoolExtension
+
+    # Extend common classes to add `to_model_id` method.
+    def self.extend!
+      String.include Strings
+      Integer.include Integers
+      TrueClass.include Boolean
+      FalseClass.include Boolean
+      NilClass.include Nil
+    end
+
+    # Add `to_model_id` to String types.
+    module Strings
+      def to_bool( default = false )
+        case self
+        when "1", /\At(rue)?\z/i, /\Ay(es)?\z/i     then true
+        when "0", "", /\Af(alse)?\z/i, /\An(o)?\z/i then false
+        else                                             default
+        end
+      end
+    end
+
+    # Add `to_model_id` to Integer types.
+    module Integers
+      def to_bool( default = false )
+        case self
+        when 1 then true
+        when 0 then false
+        else        default
+        end
+      end
+    end
+
+    # Add `to_model_id` to Boolean types.
+    module Boolean
+      def to_bool( default = self )
+        self
+      end
+    end
+
+    # Add `to_model_id` to nil.
+    module Nil
+      def to_bool( default = self )
+        default
+      end
+    end
+
+
+  end
+end
+
+
+Shamu::ToBoolExtension.extend!

data/lib/shamu/to_model_id_extension.rb

@@ -0,0 +1,50 @@
+require "active_model"
+
+module Shamu
+
+  # Adds `to_model_id` to several classes that are often used to look up
+  # models by id.
+  module ToModelIdExtension
+
+    # Extend common classes to add `to_model_id` method.
+    def self.extend!
+      Integer.include Integers
+      String.include Strings
+      Array.include Enumerables
+
+      ActiveRecord::Base.include Models if defined? ActiveRecord::Base
+    end
+
+    # Add `to_model_id` to String types.
+    module Strings
+      NUMERIC_PATTERN = /\A\s*[0-9]+\z/
+
+      def to_model_id
+        self =~ NUMERIC_PATTERN ? to_i : nil
+      end
+    end
+
+    # Add `to_model_id` to Integer types.
+    module Integers
+      def to_model_id
+        self
+      end
+    end
+
+    # Add `to_model_id` to Enumerable types.
+    module Enumerables
+      def to_model_id
+        map( &:to_model_id )
+      end
+    end
+
+    # Add `to_model_id` to ActiveModel types.
+    module Models
+      def to_model_id
+        id
+      end
+    end
+  end
+end
+
+Shamu::ToModelIdExtension.extend!

data/lib/shamu/version.rb

@@ -1,5 +1,11 @@
-module Scorpion
-  VERSION_NUMBER  = "0.0.1"
-  VERSION_SUFFIX  = ""
-  VERSION         = "#{VERSION_NUMBER}#{VERSION_SUFFIX}"
+# frozen_string_literal: true
+module Shamu
+  # The primary version number
+  VERSION_NUMBER  = "0.0.2".freeze
+
+  # Version suffix such as 'beta' or 'alpha'
+  VERSION_SUFFIX  = "".freeze
+
+  # Published version number
+  VERSION         = "#{ VERSION_NUMBER }#{ VERSION_SUFFIX }".freeze
 end

data/lib/shamu.rb

@@ -1,10 +1,22 @@
-require 'i18n'
+require "i18n"
 
-I18n.load_path += Dir[ File.expand_path( '../shamu/locale/*.yml', __FILE__ ) ]
+I18n.load_path += Dir[ File.expand_path( "../shamu/locale/*.yml", __FILE__ ) ]
 
-module Scorpion
-
-  require 'shamu/version'
-  require 'shamu/error'
+# {include:file:README.md}
+module Shamu
+  require "shamu/version"
+  require "shamu/error"
+  require "shamu/attributes"
+  require "shamu/entities"
+  require "shamu/logger"
+  require "shamu/services"
+  require "shamu/security"
+  require "shamu/auditing"
+  require "shamu/events"
+  require "shamu/sessions"
+  require "shamu/features"
+  require "shamu/to_model_id_extension"
+  require "shamu/to_bool_extension"
 
+  require "shamu/rails" if defined? Rails
 end

data/shamu.gemspec

@@ -1,14 +1,14 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path( "../lib", __FILE__ )
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'shamu/version'
+require "shamu/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "shamu"
-  spec.version       = "#{Scorpion::VERSION}"
-  spec.authors       = ["Paul Alexander"]
-  spec.email         = ["me@phallguy.com"]
-  spec.summary       = %q{Have a whale of a good time adding Service Oriented Architecture to your ruby projects.}
+  spec.version       = Shamu::VERSION
+  spec.authors       = [ "Paul Alexander" ]
+  spec.email         = [ "me@phallguy.com" ]
+  spec.summary       = "Have a whale of a good time adding Service Oriented Architecture to your ruby projects."
   spec.homepage      = "https://github.com/phallguy/shamu"
   spec.license       = "MIT"
 
@@ -17,10 +17,21 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = ">= 2.3.0"
+
+
+  spec.add_dependency "activemodel", "~> 4.2"
+  spec.add_dependency "activesupport", "~> 4.2"
+  spec.add_dependency "scorpion-ioc", "~> 0.5.16"
+  spec.add_dependency "multi_json", "~> 1.11.2"
+  spec.add_dependency "rack", "~> 1"
+  spec.add_dependency "listen", "~> 3"
+  spec.add_dependency "crc32", "~> 1"
+
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", '~> 10'
-  spec.add_development_dependency "rspec", '~> 3.00'
-  spec.add_development_dependency "rspec-rails", '~> 3.00'
+  spec.add_development_dependency "i18n", "~> 0.7"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec", "~> 3.00"
+  spec.add_development_dependency "combustion", "~> 0.5"
 end

data/spec/internal/README.md

@@ -0,0 +1,4 @@
+This is a dummy rails app used by the
+[combustion](https://github.com/pat/combustion) gem to support rails
+integration testing.
+

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/lib/shamu/active_record_support.rb

@@ -0,0 +1,32 @@
+require "active_record"
+require "shamu/entities/active_record"
+
+module ActiveRecordSpec
+  class Favorite < ::ActiveRecord::Base
+    self.table_name = "favorites"
+    extend Shamu::Entities::ActiveRecord
+    include Shamu::Entities::ActiveRecordSoftDestroy
+
+    scope :by_name, ->( name ) { where( name: name ) }
+    scope :by_label, ->( label ) { where( label: label ) }
+  end
+
+  class FavoriteMigration < ::ActiveRecord::Migration
+    def self.up
+      create_table :favorites do |t|
+        t.string :name
+        t.string :label
+
+        t.datetime :destroyed_at
+      end
+    end
+
+    def self.down
+      drop_table :favorites
+    end
+  end
+
+  class FavoriteScope < Shamu::Entities::ListScope
+    attribute :name
+  end
+end

data/spec/lib/shamu/attributes/assignment_spec.rb

@@ -0,0 +1,129 @@
+require "spec_helper"
+require "shamu/attributes"
+
+describe Shamu::Attributes::Assignment do
+  let( :base_klass ) do
+    Class.new do
+      include Shamu::Attributes
+      include Shamu::Attributes::Assignment
+
+      attribute :value
+    end
+  end
+
+  describe "arrays" do
+    let( :klass ) do
+      Class.new( base_klass ) do
+        attribute :tags, coerce: :to_s, array: true
+      end
+    end
+
+    it "converts a single value to an array" do
+      instance = klass.new( tags: "apple" )
+      expect( instance.tags ).to eq ["apple"]
+    end
+
+    it "coerces each item in the array" do
+      instance = klass.new( tags: [:orange] )
+      expect( instance.tags ).to eq ["orange"]
+    end
+  end
+
+  it "updates instance variable" do
+    instance = base_klass.new
+    instance.value = "abc"
+
+    expect( instance.instance_variable_get( :@value ) ).to eq "abc"
+  end
+
+  it "calls assignment methods on assign_attributes" do
+    klass = Class.new( base_klass ) do
+      attribute :attr
+    end
+
+    expect_any_instance_of( klass ).to receive( :assign_attr )
+
+    klass.new( attr: 1 )
+  end
+
+  it "creates aliased assignment" do
+    klass = Class.new do
+      include Shamu::Attributes
+      include Shamu::Attributes::Assignment
+
+      attribute :q, as: :query
+    end
+
+    instance = klass.new
+    instance.query = "ABC"
+    expect( instance.q ).to eq "ABC"
+  end
+
+  describe "coercion" do
+    it "coerces using given method name" do
+      klass = Class.new( base_klass ) do
+        attribute :count, coerce: :to_i
+      end
+
+      value = double
+      expect( value ).to receive( :to_i ).and_return( 5 )
+
+      instance = klass.new
+      instance.count = value
+
+      expect( instance.count ).to eq 5
+    end
+
+    it "coerces using given method proc" do
+      klass = Class.new( base_klass ) do
+        attribute :label, coerce: ->(_) { "coerced" }
+      end
+
+      instance = klass.new( label: "original" )
+      expect( instance.label ).to eq "coerced"
+    end
+
+    describe "smart" do
+      let( :klass ) do
+        Class.new( base_klass ) do
+          attribute :updated_at
+          attribute :expire_on
+
+          attribute :user_id
+          attribute :tag_ids
+        end
+      end
+      let( :instance ) { klass.new }
+
+      it "coerces nnn_at to timestamps" do
+        value = double
+        expect( value ).to receive( :to_datetime )
+
+        instance.updated_at = value
+      end
+
+      it "coerces nnn_on to timestamps" do
+        value = double
+        expect( value ).to receive( :to_datetime )
+
+        instance.expire_on = value
+      end
+
+      it "coerces nnn_id to an Integer" do
+        value = double
+        expect( value ).to receive( :to_i )
+
+        instance.user_id = value
+      end
+
+      it "coerces nnn_ids to an array of Integers" do
+        value = double
+        expect( value ).to receive( :to_i )
+
+        instance.tag_ids = value
+      end
+
+    end
+  end
+
+end

data/spec/lib/shamu/attributes/equality_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+require "shamu/attributes"
+
+describe Shamu::Attributes::Equality do
+  let( :klass ) do
+    Class.new do
+      include Shamu::Attributes
+      include Shamu::Attributes::Equality
+
+      attribute :name
+      attribute :random, ignore_inequality: true
+    end
+  end
+
+  let( :value )     { klass.new( name: "same" ) }
+  let( :same )      { klass.new( name: "same" ) }
+  let( :different ) { klass.new( name: "different" ) }
+
+
+  it "is eql? for the same attributes" do
+    expect( value ).to eq same
+  end
+
+  it "isn't eql? for different attributes" do
+    expect( value ).not_to eq different
+  end
+
+  it "isn't eql? for different types with the same attributes" do
+    other_klass = Class.new do
+      include Shamu::Attributes
+      include Shamu::Attributes::Equality
+
+      attribute :name
+    end
+
+    other = other_klass.new( name: value.name )
+
+    expect( value ).not_to eq other
+  end
+
+  it "is eql? for derived types with same attributes" do
+    derived_klass = Class.new( klass )
+    derived = derived_klass.new( name: value.name )
+
+    expect( value ).to eq derived
+    expect( derived ).to eq value
+  end
+
+  it "has the same hash for the same attributes" do
+    expect( value.hash ).to eq same.hash
+  end
+
+  it "has a different hash for different attributes" do
+    expect( value.hash ).not_to eq different.hash
+  end
+
+  it "ignores excluded attributes" do
+    v1 = klass.new( name: "same", random: 123 )
+    v2 = klass.new( name: "same", random: 456 )
+
+    expect( v1 ).to eq v2
+  end
+end

data/spec/lib/shamu/attributes/fluid_assignment_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+require "shamu/attributes"
+
+describe Shamu::Attributes::FluidAssignment do
+  let( :klass ) do
+    Class.new do
+      include Shamu::Attributes
+      include Shamu::Attributes::Assignment
+      include Shamu::Attributes::FluidAssignment
+
+      attribute :value
+    end
+  end
+
+  it "returns the current value with no arguments" do
+    instance = klass.new( value: "one" )
+
+    expect( instance.value ).to eq "one"
+  end
+
+  it "assigns the value when arguments present" do
+    instance = klass.new
+    instance.value( "two" )
+  end
+
+  it "return self on assignment" do
+    instance = klass.new
+    expect( instance.value( "two" ) ).to be instance
+  end
+
+end

data/spec/lib/shamu/attributes/validation_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+require "shamu/attributes"
+
+describe Shamu::Attributes::Validation do
+  let( :klass ) do
+    Class.new do
+      include Shamu::Attributes
+      include Shamu::Attributes::Assignment
+      include Shamu::Attributes::Validation
+
+      attribute :name, presence: true
+
+      def self.name
+        "Example"
+      end
+    end
+  end
+
+  it "forwards unused options to .validates method" do
+    TestClass = Class.new do
+      include Shamu::Attributes
+      include Shamu::Attributes::Validation
+    end
+
+    expect( TestClass ).to receive( :validates ).with( :name, presence: true )
+    class TestClass
+      attribute :name, on: :user, presence: true
+    end
+  end
+
+  it "doesn't clear errors on call to valid?" do
+    instance = klass.new( {} )
+    instance.validate
+    expect( instance ).not_to be_valid
+
+    instance.name = "Something"
+    expect( instance ).not_to be_valid
+  end
+
+  it "validates methods on validate" do
+    instance = klass.new( {} )
+    instance.validate
+
+    expect( instance.errors ).to have_key :name
+  end
+
+  it "validates on first call to valid?" do
+    instance = klass.new( {} )
+    expect( instance ).to receive( :validate ).once.and_call_original
+    instance.valid?
+    instance.valid?
+  end
+end