naranya_ecm-sdk 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ea93a84c6487716b367c31b4e0c416de8cdd281
+  data.tar.gz: dff98318c7c4d3997dc0dc9fec891fcdf4ce8ac2
+SHA512:
+  metadata.gz: 4ee9589ea02b1d9491d55354942ba58989d9e01e9f018c360e0e48b20c2fe1bde4ce6cba5de6b0aa4d3cd5b90bbcc68b1651ceed878a0c2f0083d27025afcaa1
+  data.tar.gz: 7850ded288a43ff49690f3c3813e1bac47639df640143b4107689dde841944ea7c2683714b628ccc704bb8cd12e2aa003266fd3c091b8a98f817aab3c7691874

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+.ruby-version
+Gemfile.lock
+/naranya_ecm.yml
+/.irb*
+/naranya_ecm-sdk-*.gem

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in naranya_ecm.gemspec
+gemspec
+
+gem 'redis-activesupport'
+
+gem 'byebug'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Roberto Quintanilla
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# NaranyaEcm
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'naranya_ecm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install naranya_ecm
+
+## Development: Running on console:
+    
+    $ bundle console
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/naranya_ecm/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dev/create_cvm.rb

@@ -0,0 +1,31 @@
+
+content = NaranyaEcm::Content.create(
+  state: "draft",
+  author: "Vovi",
+  title_translations: { "es" => "FlappyBird"},
+  main_url: "http://www.naranyamarket.com/1"
+)
+
+content_version = NaranyaEcm::ContentVersion.create(
+  content_id: content.id,
+  state: "draft",
+  description_translations: { "es" => "FlappyBird"},
+  code: 1,
+  name: "0.0.1"
+)
+
+public_media_resource = NaranyaEcm::MediaResource.create(
+  content_version_id: content_version.id,
+  type: "image/png",
+  role: "banner",
+  downloadable_url: "https://cms-ejemplo-1.s3.amazonaws.com/flappybirdbanner.png",
+  access_type: 'public'
+)
+
+private_media_resource = NaranyaEcm::MediaResource.create(
+  content_version_id: content_version.id,
+  type: "application/apk",
+  role: "main_downloadable",
+  downloadable_url: "https://cms-ejemplo-1.s3.amazonaws.com/flappybird.apk",
+  access_type: 'private'
+)

data/dev/init.rb

@@ -0,0 +1,2 @@
+require "i18n/backend/fallbacks"
+I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)

data/dev/load_cvm.rb

@@ -0,0 +1,12 @@
+
+content = Content.last
+
+version = content.versions.last
+
+media_resource = version.media_resources.last
+
+=begin
+download_authorization = DownloadAuthorization.create media_resource: media_resource, expires_at: 10.minutes.from_now
+
+download_authorization = DownloadAuthorization.find("530e5e2265636d027b000000")
+=end

data/dev/search.rb

@@ -0,0 +1,3 @@
+SEARCH1 = { query: { term: { author: "Vovi" } } } unless defined? SEARCH1
+SEARCH2 = { query: { term: { author: "Vova" } } } unless defined? SEARCH2
+SEARCH3 = { query: { term: { author: "Aldo" } } } unless defined? SEARCH3

data/lib/naranya_ecm/behaviors/localizable.rb

@@ -0,0 +1,41 @@
+require 'active_support/concern'
+
+module NaranyaEcm
+
+  module Behaviors
+    module Localizable
+
+      extend ActiveSupport::Concern
+
+      included do
+        # Delegar el acceso tipo "Enumerable":
+        delegate :any?, to: :@attributes
+
+        # Re-establece el acceso tipo Hash:
+        delegate :[],   to: :@attributes
+        delegate :[]=,  to: :@attributes
+        self.site = "http://www.example.com"
+
+        attribute_name = self.name.demodulize.underscore[0..-("_translations".length+1)]
+        alias_method attribute_name.to_sym, :lookup
+      end
+
+      def locales
+        @attributes.keys
+      end
+      alias_method :available_locales, :locales
+
+      def lookup
+        locale = ::I18n.locale
+        if ::I18n.respond_to?(:fallbacks)
+          lookup_result = @attributes[::I18n.fallbacks[locale].map(&:to_s).find{ |loc| @attributes.has_key?(loc) }]
+        else
+          lookup_result = @attributes[locale.to_s]
+        end
+        lookup_result || @attributes.present? ? @attributes.first[1] : nil
+      end
+
+    end
+  end
+
+end

data/lib/naranya_ecm/behaviors/timestampable.rb

@@ -0,0 +1,22 @@
+require 'active_support/concern'
+module NaranyaEcm
+  module Behaviors
+    module Timestampable
+
+      extend ActiveSupport::Concern
+
+      included do
+        %w(created_at updated_at).map(&:to_sym).each do |attr_sym|
+          # getter:
+          define_method(attr_sym) { @attributes[attr_sym].present? ? @attributes[attr_sym].to_datetime : nil }
+          # setter:
+          # define_method("#{attr_sym}=".to_sym) do |value|
+          #   self.send "#{attr_sym}_will_change!".to_sym unless value == @attributes[attr_sym]
+          #   @attributes[attr_sym] = value
+          # end
+        end
+      end
+
+    end
+  end
+end

data/lib/naranya_ecm/behaviors.rb

@@ -0,0 +1,9 @@
+require 'active_support/dependencies/autoload'
+
+module NaranyaEcm
+  module Behaviors
+    extend ActiveSupport::Autoload
+    autoload :Localizable
+    autoload :Timestampable
+  end
+end

data/lib/naranya_ecm/cache/key.rb

@@ -0,0 +1,73 @@
+require 'active_support/hash_with_indifferent_access'
+
+module NaranyaEcm
+  module Cache
+    class Key < String
+
+      TIMESTAMP_FORMAT = '%Y%m%d%H%M%S%L%3N'.freeze
+
+      def initialize(segments={})
+
+        @segments = ActiveSupport::HashWithIndifferentAccess.new
+
+        resource = segments.delete :resource
+
+        @segments[:class_name] = case
+        when resource.present? then resource.class.name
+        when segments.has_key?(:class_name) then segments.delete(:class_name)
+        when segments.has_key?(:resource_class) then segments.delete(:resource_class).name
+        else nil
+        end
+
+        @segments[:id] = case
+        when resource.present?                then resource.id
+        when segments.has_key?(:id)           then segments.delete(:id)
+        else nil
+        end
+
+        @segments[:timestamp] = case
+        when resource.present? then resource.respond_to?(:updated_at) ? resource.updated_at : nil
+        when segments.has_key?(:timestamp) then segments.delete(:timestamp)
+        else nil
+        end
+
+        @segments.freeze
+
+        super self.class.join_segments(@segments).freeze
+
+      end
+
+      def class_name; @segments[:class_name]; end
+      def id;         @segments[:id];         end
+      def timestamp;  @segments[:timestamp];  end
+
+      def timestamped?
+        resource_timestamp.present?
+      end
+
+      def any_timestamp
+        self.class.join_segments(@segments.except(:timestamp)) + '-*'
+      end
+
+      def with_timestamp(datetime)
+        raise "Not a valid timestamp" unless datetime.respond_to? :strftime
+        self.class.new class_name: class_name, id: id, timestamp: datetime
+      end
+
+      class << self
+        def join_segments(segments)
+          segments = segments.with_indifferent_access
+          str = segments[:class_name].underscore
+          if segments[:id].present?
+            str += "/#{segments[:id]}"
+            if segments[:timestamp].present? and segments[:timestamp].respond_to?(:strftime)
+              str += "-#{segments[:timestamp].strftime(TIMESTAMP_FORMAT)}"
+            end
+          end
+          str
+        end
+      end
+
+    end
+  end
+end

data/lib/naranya_ecm/cache/methods.rb

@@ -0,0 +1,78 @@
+require 'active_support/concern'
+module NaranyaEcm
+  module Cache
+    module Methods
+
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :load, :caching
+
+        class << self
+          alias_method_chain :find_single, :caching
+        end
+      end
+
+      def cache_key
+        @cache_key ||= NaranyaEcm.cache_key_for resource: self
+      end
+
+      def load_with_caching(attributes, remove_root = false, persisted = false)
+        res = load_without_caching(attributes, remove_root = false, persisted = false)
+        
+        cache_options = {}
+        cache_options[:expires_in] = 10.minutes unless self.updated_at.present? and self.updated_at.is_a? DateTime
+        
+        NaranyaEcm.cache.write cache_key, @attributes, cache_options
+        
+        res
+      end
+
+      module ClassMethods
+
+        def cache
+          NaranyaEcm.cache
+        end
+
+        def cache_key_for(attributes)
+          NaranyaEcm.cache_key_for attributes.merge(resource_class: self)
+        end
+
+        def find_cached(cache_key)
+          cached_attributes = cache.read(cache_key)
+          cached_attributes.present? ? instantiate_record(cached_attributes) : nil
+        end
+
+        def find_cached!(cache_key)
+          found = find_cached(cache_key)
+          raise "No record matched given attribute in cache" unless found
+          found
+        end
+
+        private
+
+          # Find a single resource from the default URL
+          def find_single_with_caching(scope, options)
+            
+            # Try to load the record from cache:
+            cache_key = cache_key_for id: scope, timestamp: options.delete(:timestamp)
+            
+            record = find_cached cache_key
+            
+            unless record.present?
+
+              # Load the record from the ECM server:
+              record = find_single_without_caching(scope, options)
+
+              # Cache the record by writing the record's attributes to the cache store,
+              # IF the attributes have not been written before:
+              cache.write(record.cache_key, record.attributes) unless cache.exist? record.cache_key
+            end
+            
+            record
+          end
+      end
+
+    end
+  end
+end

data/lib/naranya_ecm/cache.rb

@@ -0,0 +1,9 @@
+require 'active_support/dependencies/autoload'
+
+module NaranyaEcm
+  module Cache
+    extend ActiveSupport::Autoload
+    autoload :Key
+    autoload :Methods
+  end
+end

data/lib/naranya_ecm/has_many_patch.rb

@@ -0,0 +1,105 @@
+require 'active_support/concern'
+
+module NaranyaEcm
+
+  # Aplica de manera dinámica el patch visto en:
+  # https://github.com/kenips/activeresource/commit/720c06a5a4a2d1cfd7319accb649b7aececa1ca2
+  module HasManyPatch
+
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        alias_method_chain :element_path,                   :has_many_patch
+        
+        unless method_defined? :element_base_path
+          alias_method :element_base_path, :element_base_path_with_has_many_patch
+        end
+
+        alias_method_chain :defines_has_many_finder_method, :has_many_patch
+      end
+    end
+
+    def element_base_path(options = nil)
+      self.class.element_base_path(to_param, options || prefix_options)
+    end
+
+    module ClassMethods
+
+      # Gets the element path for the given ID in +id+. If the +query_options+ parameter is omitted, Rails
+      # will split from the \prefix options.
+      #
+      # ==== Options
+      # +prefix_options+ - A \hash to add a \prefix to the request for nested URLs (e.g., <tt>:account_id => 19</tt>
+      # would yield a URL like <tt>/accounts/19/purchases.json</tt>).
+      #
+      # +query_options+ - A \hash to add items to the query string for the request.
+      #
+      # ==== Examples
+      # Post.element_path(1)
+      # # => /posts/1.json
+      #
+      # class Comment < ActiveResource::Base
+      # self.site = "https://37s.sunrise.com/posts/:post_id"
+      # end
+      #
+      # Comment.element_path(1, :post_id => 5)
+      # # => /posts/5/comments/1.json
+      #
+      # Comment.element_path(1, :post_id => 5, :active => 1)
+      # # => /posts/5/comments/1.json?active=1
+      #
+      # Comment.element_path(1, {:post_id => 5}, {:active => 1})
+      # # => /posts/5/comments/1.json?active=1
+      #
+      def element_path_with_has_many_patch(id, prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{element_base_path(id, prefix_options)}#{format_extension}#{query_string(query_options)}"
+      end
+
+      # Gets the element base path for the given ID in +id+. This will never return a format extension or params,
+      # it is useful for building prefix paths. See <tt>element_path</tt> if you need format extensions and params.
+      #
+      # ==== Options
+      # +prefix_options+ - A \hash to add a \prefix to the request for nested URLs (e.g., <tt>:account_id => 19</tt>
+      # would yield a URL like <tt>/accounts/19</tt>).
+      #
+      # ==== Examples
+      # Class Post < ActiveResource::Base
+      # self.site = "https://37s.sunrise.com/api"
+      # end
+      #
+      # Post.element_base_path(1)
+      # # => /api/posts/1
+      #
+      # class Comment < ActiveResource::Base
+      # self.site = "https://37s.sunrise.com/api/posts/:post_id"
+      # end
+      #
+      # Comment.element_base_path(1, :post_id => 5)
+      # # => /api/posts/5/comments/1
+      #
+      def element_base_path_with_has_many_patch(id, prefix_options = {})
+        check_prefix_options(prefix_options)
+        "#{prefix(prefix_options)}#{collection_name}/#{URI.parser.escape id.to_s}"
+      end
+
+      # Patches the definition of the has_many finder method
+      def defines_has_many_finder_method_with_has_many_patch(method_name, association_model)
+        ivar_name = :"@#{method_name}"
+
+        define_method(method_name) do
+          if instance_variable_defined?(ivar_name)
+            instance_variable_get(ivar_name)
+          elsif attributes.include?(method_name)
+            attributes[method_name]
+          else
+            instance_variable_set(ivar_name, association_model.find(:all, :from => "#{element_base_path}/#{method_name}.#{association_model.format.extension}"))
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/naranya_ecm/lifecycles/content_lifecycle.rb

@@ -0,0 +1,36 @@
+require 'active_support/concern'
+require 'state_machine'
+
+module NaranyaEcm
+  module Lifecycles
+
+    module ContentLifecycle
+      extend ActiveSupport::Concern
+
+      included do
+
+        include NaranyaEcm::Lifecycles::Lifecycleable
+
+        ##################################################################
+        # StateMachine:
+        state_machine :lifecycle_state, initial: :draft do
+
+          state :draft
+
+          state :awaiting_validation
+
+          state :rejected
+
+          state :validated
+
+          state :published
+
+          state :deactivated
+
+        end
+      end
+
+    end
+
+  end
+end

data/lib/naranya_ecm/lifecycles/lifecycleable.rb

@@ -0,0 +1,43 @@
+require 'active_support/concern'
+
+module NaranyaEcm
+  module Lifecycles
+
+    module Lifecycleable
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :lifecycle_name, :lifecycle_state
+      end
+        
+      def lifecycle_name
+        @attributes['lifecycle_name'] ||= NaranyaEcm::Lifecycle.new(@attributes['lifecycle_name'])
+      end
+
+      def lifecycle_name=(given_lifecycle_name)
+        @attributes['lifecycle_name'] = NaranyaEcm::Lifecycle.new(given_lifecycle_name)
+        @lifecycle_name = @attributes['lifecycle_name']
+      end
+
+      def lifecycle_state
+        @attributes['lifecycle_state']
+      end
+
+      def lifecycle_state=(given_lifecycle_state)
+        @attributes['lifecycle_state']= given_lifecycle_state.to_s
+      end
+
+      def method_missing(method_name, *args, &block)
+        if method_name.to_s =~ /^(\w+)_lifecycle\?$/
+          self.lifecycle_name.is_lifecycle?($1)
+        else
+          super # You *must* call super if you don't handle the
+                # method, otherwise you'll mess up Ruby's method
+                # lookup.
+        end
+      end
+
+    end
+
+  end
+end

data/lib/naranya_ecm/lifecycles/version_lifecycle.rb

@@ -0,0 +1,75 @@
+require 'active_support/concern'
+require 'state_machine'
+
+module NaranyaEcm
+  module Lifecycles
+
+    module VersionLifecycle
+      extend ActiveSupport::Concern
+
+      included do
+
+        include NaranyaEcm::Lifecycles::Lifecycleable
+
+        ##################################################################
+        # StateMachine:
+        state_machine :lifecycle_state, initial: :draft do
+
+          # # Not working...
+          # #after_transition :on => :publish, :do => :supercede_the_content_current_version_if_published
+
+          # #########################################
+          # # Eventos:
+
+          # event :request_validation do
+          #   # Iniciar la transición de :draft a :awaiting_validation,
+          #   # si el lifecycle es sencillo:
+          #   transition :draft => :awaiting_validation, :unless => :simple_lifecycle?
+          # end
+
+          # event :validate do
+          #   # Iniciar la transición de :awaiting_validation a :validated:
+          #   transition :awaiting_validation => :validated
+          # end
+
+          # event :reject do
+          #   # Iniciar la transición de :awaiting_validation a :rejected:
+          #   transition :awaiting_validation => :rejected
+          # end
+
+          # event :publish do
+          #   # Iniciar la transición de :draft a :published,
+          #   # si el lifecycle es sencillo:
+          #   transition :draft => :published, :if => :simple_lifecycle?
+          #   transition :validated => :published
+          # end
+
+          # event :supersede do
+          #   # Iniciar la transición de :published a :superseded:
+          #   transition :published => :superseded
+          # end
+
+          # event :deactivate do
+          #   # Iniciar la transición de :published a :deactivated:
+          #   transition :published => :deactivated
+          # end
+
+          state :awaiting_validation
+
+          state :rejected
+
+          state :validated
+
+          state :published
+
+          state :superseded
+
+          state :deactivated
+
+        end
+      end
+
+    end
+
+  end
+end

data/lib/naranya_ecm/lifecycles.rb

@@ -0,0 +1,10 @@
+require 'active_support/dependencies/autoload'
+
+module NaranyaEcm
+  module Lifecycles
+    extend ActiveSupport::Autoload
+    autoload :Lifecycleable
+    autoload :ContentLifecycle
+    autoload :VersionLifecycle
+  end
+end