naranya_ecm-sdk 0.0.4

data/lib/naranya_ecm/search/results.rb

@@ -0,0 +1,161 @@
+module NaranyaEcm
+  module Search
+    class Results
+
+      DEFAULT_MATERIALIZER = Proc.new do |resource_class, hits|
+      
+        # Extract the object ids for ActiveResource loading:
+        unloaded_resource_ids = hits.map(&:id)
+
+        materialized_elements = []
+
+        # Load from cache any matching element caching_key:
+        hits.each do |hit|
+          cached_element = resource_class.find_cached(resource_class.cache_key_for id: hit.id, timestamp: hit.updated_at)
+          if cached_element.present?
+            cached_element.merge_search_hit_data(hit)
+            materialized_elements << cached_element
+            unloaded_resource_ids.delete cached_element.id
+          end
+        end
+
+        # Load from server all elements not in cache:
+        resource_class.find(:all, params: { id: unloaded_resource_ids }).each do |element|
+          hit = hits.detect { |hit| hit.id == element.id }
+          
+          # Add the hit score and order to each element:
+          element.merge_search_hit_data(hit)
+
+          # Add it to the loaded_elements:
+          materialized_elements << element
+        end unless unloaded_resource_ids.empty?
+
+        materialized_elements
+      end
+
+      include Enumerable
+      delegate :to_yaml, :all?, :each, to: :to_a
+
+      # The array of actual elements returned by index actions
+      attr_reader :elements, :resource_class
+
+      attr_accessor :materializer
+
+      def initialize(given_dsl, given_resource_class = nil)
+        @dsl, @resource_class = given_dsl, given_resource_class
+      end
+
+      def total_hits
+        do_search! unless @total_hits
+        @total_hits
+      end
+      alias_method :total_count, :total_hits
+
+      def hits
+        do_search! unless @hits
+        @hits
+      end
+
+      def count
+        hits.count
+      end
+
+      def any?
+        count > 0
+      end
+
+      def empty?
+        count < 1
+      end
+
+      def facts
+        do_search! unless @facts
+        @facts
+      end
+
+      def max_score
+        do_search! unless @max_score
+        @max_score
+      end
+
+      def query_process_time
+        do_search! unless @query_process_time
+        @query_process_time
+      end
+
+      def query_total_time
+        do_search! unless @query_total_time
+        @query_total_time
+      end
+
+      def materializer
+        @materializer || DEFAULT_MATERIALIZER
+      end
+      
+      def to_a
+        materialize! unless @elements
+        elements
+      end
+
+      private
+
+        def do_search!
+
+          start_time = Time.now
+          
+          # Strip '.json' from collection path:
+          search_path = resource_class.present? ? resource_class.collection_path.split('.').first : ''
+          search_path += '/_search'
+
+          search_site = URI(NaranyaEcm.options.site)
+
+          search_connection = Net::HTTP.new search_site.host, search_site.port
+
+          search_get_url = URI("#{search_site}#{search_path}")
+
+          search_request = Net::HTTP::Get.new search_get_url
+          search_request.body = ActiveSupport::JSON.encode @dsl
+
+          puts "curl --XGET '#{search_get_url}?pretty=true' -d '#{search_request.body}'"
+
+          # Use the class connection to get the search results,
+          # using any authentication / headers configured:
+          #search_response = connection.get(search_path, headers)
+          search_response = search_connection.request search_request
+          
+          # Parse the search results:
+          @facts = ActiveSupport::JSON.decode(search_response.body)
+            .with_indifferent_access
+
+          # Obtain the query processing time, which is given in miliseconds as 'took' key: 
+          @query_process_time = (Float(@facts.delete(:took)) / 1000)
+
+          result_hits = @facts.delete :hits
+
+          @total_hits = result_hits.delete :total
+          @max_score  = result_hits.delete :max_score
+
+          @hits = result_hits[:hits].each_with_index.map { |ht, o| Hit.new(ht.merge(order: o)) }
+          
+          @hits.freeze
+          @facts.freeze
+
+          @query_total_time = (Time.now - start_time)
+          
+        end
+
+        def materialize!
+          # Call the materializer and:
+          # - Filter out elements that materialized as nulls
+          # - Order the elements by relevance
+          @elements = materializer.call(resource_class, hits)
+            .select { |materialized_element| materialized_element.present? }
+            .sort_by do |element|
+              element.search_order
+            end
+          
+        end
+    
+    end
+  end
+end

data/lib/naranya_ecm/search.rb

@@ -0,0 +1,14 @@
+require 'active_support/dependencies/autoload'
+
+module NaranyaEcm
+  module Search
+    
+    extend ActiveSupport::Autoload
+
+    autoload :Hit
+    autoload :Methods
+    autoload :Query
+    autoload :Results
+
+  end
+end

data/lib/naranya_ecm/site_from_configuration.rb

@@ -0,0 +1,15 @@
+require 'active_support/concern'
+
+module NaranyaEcm
+  
+  module SiteFromConfiguration
+
+    extend ActiveSupport::Concern
+
+    included do
+      self.site = NaranyaEcm.options.site
+    end
+
+  end
+
+end

data/lib/naranya_ecm-sdk/version.rb

@@ -0,0 +1,3 @@
+module NaranyaEcm
+  VERSION = "0.0.4"
+end

data/lib/naranya_ecm-sdk.rb

@@ -0,0 +1,84 @@
+require "naranya_ecm-sdk/version"
+
+require 'active_support/time'
+require 'active_support/configurable'
+require 'active_support/dependencies/autoload'
+require 'yaml'
+
+require 'fog'
+
+
+module NaranyaEcm
+  
+  extend ActiveSupport::Autoload
+  
+  autoload :Cache
+  autoload :Search
+
+  autoload :Lifecycles
+
+  autoload :Models
+  autoload :Behaviors
+  
+  autoload :SiteFromConfiguration
+
+  include ActiveSupport::Configurable
+
+  include Models
+
+  DEFAULT_CONFIG = {
+    site: "http://ecm.naranya.net:5000",
+  }.freeze
+
+  class << self
+
+    def storage
+      @storage ||= Fog::Storage.new options['storage'].except('root_directory').symbolize_keys!
+    end
+
+    def root_directory
+      @root_directory ||= storage.directories.get(options['storage']['root_directory'])
+    end
+
+    def setup
+      yield config
+    end
+
+    def options
+      auto_conf unless config.present?
+      config.clone
+    end
+
+    def cache_key_for(attributes = {})
+      Cache::Key.new attributes
+    end
+
+    def load_config_from_yml(yml_path, env="production")
+      raise "YAML file doesn't extst" unless File.exist?(yml_path)
+      yml_config = DEFAULT_CONFIG.merge(YAML::load(ERB.new(File.read(yml_path)).result)[env])
+      setup { |config| yml_config.each { |key, val| config.send "#{key}=".to_sym, val } }
+    end
+
+    def cache
+      auto_conf unless config.present?
+      @cache ||= ActiveSupport::Cache.lookup_store *options[:cache]
+    end
+  
+    protected
+
+    def auto_conf
+      # Cargar configuracion dentro del folder de config en Rails:
+      if defined?(Rails)
+        yml_path = File.join(Rails.root, 'config', 'naranya_ecm.yml')
+        load_config_from_yml(yml_path, Rails.env)
+
+        # Use the Rails cache:
+        @cache = Rails.cache
+      elsif File.exists?('./naranya_ecm.yml')
+        load_config_from_yml('./naranya_ecm.yml')
+      end
+    end
+
+  end
+  
+end

data/naranya_ecm-sdk.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'naranya_ecm-sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "naranya_ecm-sdk"
+  spec.version       = NaranyaEcm::VERSION
+  spec.authors       = ["Roberto Quintanilla"]
+  spec.email         = ["roberto.quintanilla@naranya.com"]
+  spec.summary       = %q{Cliente Ruby de NaranyaEcm}
+  spec.description   = %q{Cliente Ruby de NaranyaEcm}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '~> 4.0.2'
+  spec.add_dependency 'activemodel', '~> 4.0.2'
+  spec.add_dependency 'activeresource', '~> 4.0.0'
+  spec.add_dependency 'state_machine'
+  spec.add_dependency 'fog'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0.beta2"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock", "~> 1.16"
+end

data/spec/models/category_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe NaranyaEcm::Category, vcr: true do
+
+  it_behaves_like "a NaranyaEcm resource"
+
+  it "responds to #names" do
+    expect(subject).to respond_to :names
+  end
+
+end

data/spec/models/content_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe NaranyaEcm::Content, vcr: true do
+
+  it_behaves_like "a NaranyaEcm resource"
+
+  it "responds to #titles" do
+    expect(subject).to respond_to :titles
+  end
+
+end

data/spec/models/content_version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe NaranyaEcm::ContentVersion, vcr: true do
+
+  it_behaves_like "a NaranyaEcm resource"
+
+end

data/spec/models/download_authorization.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe NaranyaEcm::DownloadAuthorization, vcr: true do
+
+  it_behaves_like "a NaranyaEcm resource"
+
+end

data/spec/models/media_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe NaranyaEcm::Media, vcr: true do
+
+  it_behaves_like "a NaranyaEcm resource"
+
+end

data/spec/models/module_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe NaranyaEcm, vcr: true do
+
+  it "responds to #options" do
+    expect(subject).to respond_to :options
+  end
+
+  describe "options" do
+    
+    subject { NaranyaEcm.options }
+
+    it "responds to #site" do
+      expect(subject).to respond_to :site
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+# require File.expand_path("../dummy/config/environment", __FILE__)
+# require 'rspec/rails'
+# require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+# ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
+
+
+require 'vcr'
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/recorded_responses'
+  config.hook_into :webmock #
+  config.configure_rspec_metadata!
+  config.default_cassette_options = { record: :new_episodes, erb: true }
+end
+
+require 'naranya_ecm'
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+end
+

data/spec/support/naranya_ecms_shared_specs.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+shared_examples "a NaranyaEcm resource" do
+
+  describe "class" do
+    
+    subject { described_class }
+
+    it "responds to #site" do
+      expect(subject).to respond_to :site
+    end
+
+    describe "#site" do
+      subject { described_class.site }
+
+      it "has the same URL as in the configuration options" do
+        expect(subject.to_s).to eq NaranyaEcm.options.site
+      end
+    end
+
+    it "responds to #find" do
+      expect(subject).to respond_to :find
+    end
+
+  end
+
+  describe "instance" do
+    it "responds to #id" do
+      expect(subject).to respond_to :id
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: naranya_ecm-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Roberto Quintanilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: state_machine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: Cliente Ruby de NaranyaEcm
+email:
+- roberto.quintanilla@naranya.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dev/create_cvm.rb
+- dev/init.rb
+- dev/load_cvm.rb
+- dev/search.rb
+- lib/naranya_ecm-sdk.rb
+- lib/naranya_ecm-sdk/version.rb
+- lib/naranya_ecm/behaviors.rb
+- lib/naranya_ecm/behaviors/localizable.rb
+- lib/naranya_ecm/behaviors/timestampable.rb
+- lib/naranya_ecm/cache.rb
+- lib/naranya_ecm/cache/key.rb
+- lib/naranya_ecm/cache/methods.rb
+- lib/naranya_ecm/has_many_patch.rb
+- lib/naranya_ecm/lifecycles.rb
+- lib/naranya_ecm/lifecycles/content_lifecycle.rb
+- lib/naranya_ecm/lifecycles/lifecycleable.rb
+- lib/naranya_ecm/lifecycles/version_lifecycle.rb
+- lib/naranya_ecm/models.rb
+- lib/naranya_ecm/models/category.rb
+- lib/naranya_ecm/models/content.rb
+- lib/naranya_ecm/models/content_version.rb
+- lib/naranya_ecm/models/download_authorization.rb
+- lib/naranya_ecm/models/lifecycle.rb
+- lib/naranya_ecm/models/media_resource.rb
+- lib/naranya_ecm/search.rb
+- lib/naranya_ecm/search/hit.rb
+- lib/naranya_ecm/search/methods.rb
+- lib/naranya_ecm/search/query.rb
+- lib/naranya_ecm/search/results.rb
+- lib/naranya_ecm/site_from_configuration.rb
+- naranya_ecm-sdk.gemspec
+- spec/models/category_spec.rb
+- spec/models/content_spec.rb
+- spec/models/content_version_spec.rb
+- spec/models/download_authorization.rb
+- spec/models/media_spec.rb
+- spec/models/module_spec.rb
+- spec/spec_helper.rb
+- spec/support/naranya_ecms_shared_specs.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Cliente Ruby de NaranyaEcm
+test_files:
+- spec/models/category_spec.rb
+- spec/models/content_spec.rb
+- spec/models/content_version_spec.rb
+- spec/models/download_authorization.rb
+- spec/models/media_spec.rb
+- spec/models/module_spec.rb
+- spec/spec_helper.rb
+- spec/support/naranya_ecms_shared_specs.rb