digital_opera 0.0.10 → 0.0.12

data/lib/digital_opera/document.rb

@@ -0,0 +1,167 @@
+## Tableless models designed to work in a similar fashion to how
+## a Mongoid document works
+require_relative "document/fields/standard"
+
+module DigitalOpera
+  module Document
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :fields
+
+      self.fields = {}
+    end
+
+    def attribute_names
+      self.class.fields.keys.reject{ |k| !respond_to?(k) }
+    end
+
+    module ClassMethods
+      # Defines all the fields that are accessible on the Document
+      # For each field that is defined, a getter and setter will be
+      # added as an instance method to the Document.
+      #
+      # @example Define a field.
+      #   field :score, :type => Integer, :default => 0
+      #
+      # @param [ Symbol ] name The name of the field.
+      # @param [ Hash ] options The options to pass to the field.
+      #
+      # @return [ Field ] The generated field
+      def field(name, options = {})
+        named = name.to_s
+        added = add_field(named, options)
+        descendants.each do |subclass|
+          subclass.add_field(named, options)
+        end
+        added
+      end
+
+      protected # -----------------------------------------
+
+      # Create the field accessors.
+      #
+      # @example Generate the accessors.
+      #   Person.create_accessors(:name, "name")
+      #   person.name #=> returns the field
+      #   person.name = "" #=> sets the field
+      #   person.name? #=> Is the field present?
+      #   person.name_before_type_cast #=> returns the field before type cast
+      #
+      # @param [ Symbol ] name The name of the field.
+      # @param [ Symbol ] meth The name of the accessor.
+      # @param [ Hash ] options The options.
+      #
+      # @since 2.0.0
+      def create_accessors(name, meth, options = {})
+        field = fields[name]
+        create_field_getter(name, meth, field)
+        create_field_setter(name, meth, field)
+      end
+
+      # Create the getter method for the provided field.
+      #
+      # @example Create the getter.
+      #   Model.create_field_getter("name", "name", field)
+      #
+      # @param [ String ] name The name of the attribute.
+      # @param [ String ] meth The name of the method.
+      # @param [ Field ] field The field.
+      #
+      # @since 2.4.0
+      def create_field_getter(name, meth, field)
+        generated_methods.module_eval do
+          define_method("#{ meth }") do
+            value = instance_variable_get "@#{ name }"
+            value.nil? ? field.default_val : value
+          end
+        end
+      end
+
+      def generated_methods
+        @generated_methods ||= begin
+          mod = Module.new
+          include(mod)
+          mod
+        end
+      end
+
+      # Create the setter method for the provided field.
+      #
+      # @example Create the setter.
+      #   Model.create_field_setter("name", "name")
+      #
+      # @param [ String ] name The name of the attribute.
+      # @param [ String ] meth The name of the method.
+      # @param [ Field ] field The field.
+      #
+      # @since 2.4.0
+      def create_field_setter(name, meth, field)
+        generated_methods.module_eval do
+          define_method("#{ meth }=") do |value|
+            instance_variable_set "@#{ name }", value
+          end
+        end
+      end
+
+      # Add the defaults to the model. This breaks them up between ones that
+      # are procs and ones that are not.
+      #
+      # @example Add to the defaults.
+      #   Model.add_defaults(field)
+      #
+      # @param [ Field ] field The field to add for.
+      #
+      # @since 2.4.0
+      def add_defaults(field)
+        default, name = field.default_val, field.name.to_s
+        remove_defaults(name)
+        unless default.nil?
+          if field.pre_processed?
+            pre_processed_defaults.push(name)
+          else
+            post_processed_defaults.push(name)
+          end
+        end
+      end
+
+      # Define a field attribute for the +Document+.
+      #
+      # @example Set the field.
+      #   Person.add_field(:name, :default => "Test")
+      #
+      # @param [ Symbol ] name The name of the field.
+      # @param [ Hash ] options The hash of options.
+      def add_field(name, options = {})
+        # aliased = options[:as]
+        # aliased_fields[aliased.to_s] = name if aliased
+        field         = field_for(name, options)
+        fields[name]  = field
+        # add_defaults(field)
+        create_accessors(name, name, options)
+        # process_options(field)
+        # create_dirty_methods(name, name)
+        # create_dirty_methods(name, aliased) if aliased
+        field
+      end
+
+      # Remove the default keys for the provided name.
+      #
+      # @example Remove the default keys.
+      #   Model.remove_defaults(name)
+      #
+      # @param [ String ] name The field name.
+      #
+      # @since 2.4.0
+      def remove_defaults(name)
+        pre_processed_defaults.delete_one(name)
+        post_processed_defaults.delete_one(name)
+      end
+
+      def field_for(name, options)
+        opts = options.merge(klass: self)
+        Fields::Standard.new(name, opts)
+      end
+    end
+  end
+end

data/lib/digital_opera/engine.rb

@@ -0,0 +1,9 @@
+# lib/digital_opera/engine.rb
+
+module DigitalOpera
+  class Engine < Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/digital_opera/form_object/base.rb

@@ -0,0 +1,115 @@
+# lib/digital_opera/form_object/base.rb
+
+module DigitalOpera
+  module FormObject
+    class Base
+      # ActiveModel plumbing to make `form_for` work
+      extend ActiveModel::Naming
+      include ActiveModel::Conversion
+      include ActiveModel::Validations
+
+      class << self
+        attr_accessor :fields
+      end
+
+      def initialize(h={})
+        assign_attributes(h)
+      end
+
+      def persisted?
+        false
+      end
+
+      def save
+        if valid?
+          persist!
+        else
+          false
+        end
+      end
+
+      def assign_attributes(args)
+        args.each do |k,v|
+          if respond_to?("#{k}=")
+            send("#{k}=", v)
+          end
+        end
+      end
+
+      def fields
+        self.class.ancestors.map do |a|
+          a.fields if a.respond_to? :fields
+        end.flatten.compact
+      end
+
+      # Class Methods ----------------------------
+
+      def self.field(*args, options)
+        if options.present? && !options.is_a?(Hash)
+          args << options
+        end
+
+        args.each do |field|
+          if options.is_a?(Hash) && options[:date] == true
+            date_field(field)
+          else
+            send :attr_accessor, field
+          end
+
+          add_to_fields field
+        end
+      end
+
+      def self.add_to_fields(field)
+        @fields = @fields || []
+        @fields << field
+      end
+
+      private # ---------------------------------------------
+
+      # overwrite on subclasses
+      def persist!
+        raise NotImplementedError
+      end
+
+      def self.date_field(field)
+        # create a getter that gets the date and converts it to strftime
+        send :define_method, field do
+          if instance_variable_get("@#{field}").present?
+            date = instance_variable_get("@#{field}")
+            begin
+              date.strftime('%m/%d/%Y')
+            rescue
+              date
+            end
+          end
+        end
+
+        # setter for date
+        send :define_method, "#{field}=" do |date|
+          if date.is_a? String
+            begin
+              d = date.gsub(' ', '')
+              new_date = Date.parse(d)
+            rescue
+              new_date = date
+            end
+          else
+            new_date = date
+          end
+
+          instance_variable_set("@#{field}", new_date)
+        end
+
+        send :define_method, "valid_#{field}" do
+          begin
+            val = send(field)
+            val.is_a?(Date) || Date.parse(val)
+          rescue
+            errors.add(field.to_sym, 'is not a valid date')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/digital_opera/form_object.rb

@@ -0,0 +1,13 @@
+## Basic building block for a FormObject that can be used to building
+## intermediate form objects that can be used to execute more complex
+## business logic when persisted.
+##
+## Recommended Use:  Forms that will create multiple objects or have
+## unique validation requirements.
+##
+require_relative 'form_object/base'
+
+module DigitalOpera
+  module FormObject
+  end
+end

data/lib/digital_opera/presenter/base.rb

@@ -6,6 +6,8 @@
 module DigitalOpera
   module Presenter
     class Base < SimpleDelegator
+      include DigitalOpera::Presenter::JsonSerialization
+
       def initialize(base, view_context=nil)
         super(base)
         @view_context = view_context || ActionController::Base.new.view_context
@@ -22,6 +24,10 @@ module DigitalOpera
       def method_missing(sym, *args, &block)
         source.send sym, *args, &block
       end
+
+      def self.wrap(collection)
+        collection.map{ |obj| self.new(obj) }
+      end
     end
   end
 end

data/lib/digital_opera/presenter/concerns/json_serialization.rb

@@ -0,0 +1,30 @@
+# lib/digital_opera/presenter/concerns/json_serialization.rb
+
+module DigitalOpera
+  module Presenter
+    module JsonSerialization
+      extend ActiveSupport::Concern
+
+      def as_json(opts={})
+        super(opts).merge( self.get_json_field_hash )
+      end
+
+      def get_json_field_hash
+        json_field_hash = {}
+
+        self.class.include_in_json.each do |method_name|
+          json_field_hash[method_name.to_sym] = self.send(method_name)
+        end
+
+        json_field_hash
+      end
+
+      module ClassMethods
+        def include_in_json(*method_names)
+          return (@json_method_names || []) if method_names.empty?
+          @json_method_names = method_names
+        end
+      end
+    end
+  end
+end

data/lib/digital_opera/presenter.rb

@@ -0,0 +1,9 @@
+# lib/digital_opera/presenter.rb
+##
+require_relative 'presenter/concerns/json_serialization'
+require_relative 'presenter/base'
+
+module DigitalOpera
+  module Presenter
+  end
+end

data/lib/digital_opera/services/s3.rb

@@ -0,0 +1,148 @@
+
+## Service for handling interactions with S3
+##
+module DigitalOpera
+  module Services
+    class S3
+      def initialize(document, options={})
+        throw 'AWS SDK is required' if !defined?(AWS) || AWS.nil?
+
+        if document.class == String
+          @key = self.get_key(document)
+        else
+          @document = document
+        end
+
+        @options = {
+          acl: 'authenticated-read'
+        }.merge(options)
+      end
+
+      def document
+        @document
+      end
+
+      def base_url
+        "https://#{self.bucket_name}.s3.amazonaws.com/"
+      end
+
+      def key
+        @key ||= if document.s3_key.present?
+          self.get_key document.s3_key
+        else
+          nil
+        end
+      end
+
+      def document_name
+        if key.present?
+          key.downcase.split('/').last
+        else
+          nil
+        end
+      end
+
+      def public_url
+        if self.s3_object.present?
+          self.s3_object.public_url.to_s
+        else
+          nil
+        end
+      end
+
+      def private_url
+        if self.s3_object.present?
+          disposition = "attachment; filename=#{document_name.parameterize}"
+          self.s3_object.url_for(:read, :expires => self.expiration(10.minutes), :response_content_disposition => disposition).to_s
+        else
+          nil
+        end
+      end
+
+      def expiration(time=10.hours)
+        (time).from_now.to_time.iso8601
+      end
+
+      def delete
+        s3_object.delete
+      end
+
+      def policy
+        Base64.encode64(self.policy_data.to_json).gsub("\n", "")
+      end
+
+      def policy_data
+        {
+          expiration: self.expiration,
+          conditions: [
+            ["starts-with", "$utf8", ""],
+            ["starts-with", "$key", ""],
+            { bucket: self.bucket_name },
+            { acl: @options[:acl] }
+          ]
+        }
+      end
+
+      def s3_object
+        @s3_object ||= if self.key.present?
+          self.bucket.objects[self.key]
+        else
+          nil
+        end
+      end
+
+      def signature
+        Base64.encode64(
+          OpenSSL::HMAC.digest(
+            OpenSSL::Digest::Digest.new('sha1'),
+            self.secret_access_key, policy
+          )
+        ).gsub("\n", "")
+      end
+
+      def upload_key
+        'documents/${filename}'
+      end
+
+      def bucket
+        ::AWS::S3.new.buckets[self.bucket_name]
+      end
+
+      def bucket_name
+        self.class.bucket_name
+      end
+
+      def access_key
+        self.class.access_key
+      end
+
+      def secret_access_key
+        self.class.secret_access_key
+      end
+
+      def get_key(url)
+        if url.start_with? self.base_url
+          url.split(self.base_url).last
+        else
+          if url.start_with? '/'
+            url[1..(url.length-1)]
+          else
+            url
+          end
+        end
+      end
+
+      def self.bucket_name
+        ENV["S3_BUCKET_NAME"]
+      end
+
+      def self.access_key
+        ENV["S3_ACCESS_KEY"]
+      end
+
+      def self.secret_access_key
+        ENV["S3_SECRET_ACCESS_KEY"]
+      end
+    end
+  end
+end

data/lib/digital_opera/version.rb

@@ -1,3 +1,3 @@
 module DigitalOpera
-  VERSION = "0.0.10"
+  VERSION = "0.0.12"
 end

data/lib/digital_opera.rb

@@ -1,7 +1,14 @@
+require "digital_opera/engine"
 require "digital_opera/token"
 require "digital_opera/base_extensions/object"
 require "digital_opera/banker"
-require "digital_opera/presenter/base"
+require "digital_opera/presenter"
+require "digital_opera/document"
+require "digital_opera/form_object"
+
+if defined?(AWS)
+  require "digital_opera/services/s3"
+end
 
 module DigitalOpera
 end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,8 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks
+require 'jasmine'
+# load 'jasmine/tasks/jasmine.rake'

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,2 @@
+//= require digital_opera/digital_opera
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "digital_opera"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)