naranya_ecm-sdk 0.0.42 → 0.0.43

data/lib/naranya_ecm/rest/relation.rb

@@ -1,5 +1,4 @@
 require 'naranya_ecm/rest/errors'
-require 'naranya_ecm/rest/client'
 
 module NaranyaEcm::Rest
   class Relation
@@ -26,8 +25,7 @@ module NaranyaEcm::Rest
     end
 
     def fetch_from_server
-      format = NaranyaEcm.options[:format] || 'json'
-      Client.get("#{klass.path}.#{format}", query: conditions).to_a
+      NContent::SDK::RESTClient.get("#{klass.path}.json", query: conditions).body
     end
 
     def load(given_list)
@@ -36,7 +34,15 @@ module NaranyaEcm::Rest
         raise "Type Mismatch: some elements are not a hash nor associated_class"
       end
 
-      @elements = given_list.map { |e| e.is_a?(Hash) ? @klass.load(e) : e }
+      @elements = given_list.map do |element|
+        if element.is_a?(Hash)
+          loaded_element = @klass.load(element)
+          loaded_element.instance_variable_set("@new_resource", false)
+          loaded_element
+        else
+          element
+        end
+      end
     end
 
     private
@@ -45,7 +51,11 @@ module NaranyaEcm::Rest
       end
 
       def materialize!
-        @elements = fetch_from_server.map { |s| klass.load s }
+        @elements = fetch_from_server.map do |s|
+          resource = klass.load s
+          resource.instance_variable_set("@new_resource", false)
+          resource
+        end
       end
 
   end

data/lib/naranya_ecm/search/results.rb

@@ -1,11 +1,10 @@
 require 'naranya_ecm/rest/relation'
-require 'naranya_ecm/rest/client'
 
 module NaranyaEcm::Search
   class Results < NaranyaEcm::Rest::Relation
 
     DEFAULT_MATERIALIZER = Proc.new do |search_results|
-    
+
       # Duplicate the hits array - we'll replace each element with the
       # resource:
       result_elements = search_results.hits.dup
@@ -15,11 +14,11 @@ module NaranyaEcm::Search
       pending_hits.map(&:klass).uniq.each do |hit_klass|
         # Obtain the ids for this hit_klass:
         hit_ids = pending_hits.select { |e| e.klass == hit_klass }.map(&:id)
-        
+
         # Fetch the data from server:
         hit_klass.where(id: hit_ids).fetch_from_server.each do |fetched_data|
           r = hit_klass.load fetched_data
-          
+
           hit_data = result_elements.detect { |e| e.is_a?(NaranyaEcm::Search::Hit) && e.klass == r.class && e.id == r.id }
           hit_index = result_elements.find_index hit_data
 
@@ -31,6 +30,8 @@ module NaranyaEcm::Search
       result_elements
     end
 
+    delegate :get, to: NContent::SDK::RESTClient
+
     attr_accessor :materializer
 
     def total_hits
@@ -88,7 +89,7 @@ module NaranyaEcm::Search
     def materializer
       @materializer || DEFAULT_MATERIALIZER
     end
-    
+
     def to_a
       materialize! unless @elements
       elements
@@ -99,20 +100,21 @@ module NaranyaEcm::Search
       def do_search!
 
         start_time = Time.now
-        
+
         # Strip '.json' from collection path:
         search_path = klass.present? ? klass.path : ''
         search_path += '/_search'
 
-        search_body = ActiveSupport::JSON.encode(conditions)
-        search_response = NaranyaEcm::Rest::Client.get search_path, body: search_body
-        
-        # puts "curl -XGET '#{NaranyaEcm.options[:site]}#{search_path}?pretty=true' -d '#{search_body}'"
-        
+        search_response = get search_path do |req|
+          req.body = ActiveSupport::JSON.encode(conditions)
+        end
+
+        # puts "curl -XGET '#{NContent::SDK.config.api_host}#{search_path}?pretty=true' -d '#{search_body}'"
+
         # Parse the search results:
-        @facts = search_response.to_hash.with_indifferent_access
+        @facts = search_response.body.with_indifferent_access
 
-        # Obtain the query processing time, which is given in miliseconds as 'took' key: 
+        # 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
@@ -121,12 +123,12 @@ module NaranyaEcm::Search
         @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!
@@ -138,8 +140,8 @@ module NaranyaEcm::Search
           .sort_by do |element|
             element.search_order
           end
-        
+
       end
-  
+
   end
 end

data/lib/ncontent-sdk-testing.rb

@@ -0,0 +1,13 @@
+require 'naranya_ecm-sdk'
+require 'ncontent-sdk'
+
+module NContent
+  module SDK
+
+    module Testing
+      extend ActiveSupport::Autoload
+      autoload :ServerMock, 'ncontent/sdk/testing/server_mock'
+    end
+
+  end
+end

data/lib/ncontent-sdk.rb

@@ -0,0 +1,85 @@
+
+# Require the Railtie if loaded from Rails app:
+require 'ncontent/sdk/railtie' if defined? Rails
+require 'active_support/core_ext/module'
+
+module NContent
+
+  module SDK
+
+    extend ActiveSupport::Autoload
+
+    autoload :Config,     "ncontent/sdk/config"
+    autoload :RESTClient, "ncontent/sdk/rest_client"
+
+    def self.config
+      @@config ||= NContent::SDK::Config.new
+    end
+
+    def self.configure(config_hash = {})
+      if block_given?
+        yield config
+      else
+        config_hash.each do |config_key, config_value|
+          if config.respond_to? "#{config_key}="
+            config.public_send "#{config_key}=", config_value
+          end
+        end
+      end
+    end
+
+    mattr_writer :logger
+    def self.logger
+      @@logger ||= Logger.new($stdout)
+    end
+
+    def self.storage
+      @@storage ||= Fog::Storage.new \
+        provider: config.bucket_provider,
+        aws_access_key_id: config.bucket_api_key,
+        aws_secret_access_key: config.bucket_api_secret
+
+    end
+
+    def self.root_directory
+      @@root_directory ||= storage.directories.get(config.bucket_name)
+    end
+
+    mattr_writer :cache
+    def self.cache
+      @@cache ||= ActiveSupport::Cache.lookup_store *config.cache
+    end
+
+    def self.api_client
+      @@api_client ||= begin
+        require 'oauth2'
+        require 'ncontent/sdk/faraday_middleware'
+
+        OAuth2::Client.new(config.api_key, config.api_secret, site: config.api_host) do |faraday|
+          ### Oauth2 Client (Faraday) builder:
+
+          faraday.request :url_encoded # them posts...
+
+          faraday.response :logger, NContent::SDK.logger
+
+          # faraday.use NContent::SDK::FaradayMiddleware::ResponseParser
+          faraday.use NContent::SDK::FaradayMiddleware::RESTAPICallBenchmark
+
+          if defined?(Patron)
+            faraday.adapter :patron # Prefer patron if exists
+          else
+            faraday.adapter Faraday.default_adapter  # make requests with Net::HTTP
+          end
+        end
+      end
+    end
+
+    def self.api_client_token
+      @@api_client_token ||= begin
+
+      end
+    end
+
+  end
+
+end

data/lib/ncontent/sdk/config.rb

@@ -0,0 +1,75 @@
+require "active_support/configurable"
+require 'i18n/core_ext/hash'
+require 'yaml'
+require 'erb'
+
+module NContent
+  module SDK
+
+    class Config
+
+      include ActiveSupport::Configurable
+
+      config_accessor :api_host do
+        ENV['NCONTENT_API_HOST'] || ENV['NARANYA_ECM_SITE'] || 'http://proy-cms-1.herokuapp.com'
+      end
+
+      config_accessor :api_key do
+        ENV['NCONTENT_API_KEY'] || ENV['NARANYA_ECM_API_KEY']
+      end
+
+      config_accessor :api_secret do
+        ENV['NCONTENT_API_SECRET'] || ENV['NARANYA_ECM_API_SECRET']
+      end
+
+      # API Call Timeout in seconds:
+      config_accessor :api_call_timeout do
+        ENV.fetch("NCONTENT_API_CALL_TIMEOUT", '30').to_i
+      end
+
+      # API Call Open Timeout in seconds:
+      config_accessor :api_call_open_timeout do
+        ENV.fetch("NCONTENT_API_CALL_OPEN_TIMEOUT", '5').to_i
+      end
+
+      config_accessor :bucket_provider do
+        ENV['NCONTENT_BUCKET_PROVIDER'] || ENV['NARANYA_ECM_STORAGE_PROVIDER'] || 'AWS'
+      end
+
+      # (AWS) Bucket name
+      config_accessor :bucket_name do
+        ENV['NCONTENT_BUCKET_NAME'] || ENV['NARANYA_ECM_STORAGE_DIR']
+      end
+
+      config_accessor :bucket_api_key do
+        ENV['NCONTENT_BUCKET_API_KEY'] || ENV['NARANYA_ECM_STORAGE_KEY']
+      end
+
+      config_accessor :bucket_api_secret do
+        ENV['NCONTENT_BUCKET_API_SECRET'] || ENV['NARANYA_ECM_STORAGE_SECRET']
+      end
+
+      config_accessor(:media_profiles) { {} }
+
+      config_accessor (:extra_attributes) { {} }
+
+      config_accessor(:cache) { :memory_store }
+
+      config_accessor :client_notify_url do
+        'http://www.example.com/ncontent/notifications'
+      end
+
+      config_accessor(:notification_processing_modules) { [] }
+
+      def self.parse_yaml(yaml_path)
+        YAML.load(ERB.new(File.read(yaml_path)).result) if File.exist?(yaml_path)
+      end
+
+      delegate :parse_yaml, to: :class
+
+      protected
+
+      end
+
+  end
+end

data/lib/ncontent/sdk/faraday_middleware.rb

@@ -0,0 +1,4 @@
+
+require "ncontent/sdk/faraday_middleware/required_response_format"
+require "ncontent/sdk/faraday_middleware/response_parser"
+require "ncontent/sdk/faraday_middleware/rest_api_call_benchmark"

data/lib/ncontent/sdk/faraday_middleware/required_response_format.rb

@@ -0,0 +1,14 @@
+module NContent
+  module SDK
+    module FaradayMiddleware
+
+      # Adds the required response format to the request parameters, in order for
+      # the SDK to work:
+      class RequiredResponseFormat < Faraday::Middleware
+        def call(env)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/ncontent/sdk/faraday_middleware/response_parser.rb

@@ -0,0 +1,35 @@
+require "benchmark"
+
+module NContent
+  module SDK
+    module FaradayMiddleware
+      # Parses the responses to models:
+      class ResponseParser < Faraday::Middleware
+
+        def call(request_env)
+          # do something with the request
+          # request_env[:request_headers].merge!(...)
+
+          @app.call(request_env).on_complete do |response_env|
+            
+            unless request_env.url.path =~ /\A\/oauth/i ||
+                   response_env.response_headers["Content-Type"] !~ /\Aapplication\/json/i ||
+                   response_env.body.strip.empty?
+
+              benchmark = Benchmark.measure "api_response_parsing" do
+                # replace body with parsed_data:
+                response_env[:body] = ActiveSupport::JSON.decode(
+                  response_env[:body]
+                )
+              end
+
+              response_env[:ncontent_api_response_parsing_tms] = benchmark
+
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ncontent/sdk/faraday_middleware/rest_api_call_benchmark.rb

@@ -0,0 +1,49 @@
+require "benchmark"
+
+module NContent
+  module SDK
+    module FaradayMiddleware
+      # Parses the responses to models:
+      class RESTAPICallBenchmark < Faraday::Middleware
+
+        def call(request_env)
+
+          # Get the start times:
+          t0 = Process.times
+          r0 = if defined?(Benchmark::BENCHMARK_CLOCK)
+            Process.clock_gettime(Benchmark::BENCHMARK_CLOCK)
+          else
+            Time.now
+          end
+
+          @app.call(request_env).on_complete do |response_env|
+
+            response_env[:ncontent_rest_api_response_datetime] = Time.parse(
+              response_env.response_headers["Date"]
+            ) if response_env.response_headers.key? "Date"
+
+            # Get the finish times:
+            t1 = Process.times
+            r1 = if defined?(Benchmark::BENCHMARK_CLOCK)
+              Process.clock_gettime(Benchmark::BENCHMARK_CLOCK)
+            else
+              Time.now
+            end
+
+            response_env[:ncontent_rest_api_calling_tms] = ::Benchmark::Tms.new(
+              t1.utime  - t0.utime,
+              t1.stime  - t0.stime,
+              t1.cutime - t0.cutime,
+              t1.cstime - t0.cstime,
+              r1 - r0,
+              "api_calling"
+            )
+
+
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ncontent/sdk/railtie.rb

@@ -0,0 +1,59 @@
+# -*- encoding : utf-8 -*-
+
+module NContent
+  module SDK
+
+    class Railtie < Rails::Railtie
+
+      def self.app_name
+        Rails.application.railtie_name.sub(/_application$/, '')
+      end
+
+      initializer "ncontent.configure_rails" do
+
+        config_from_yaml = NContent::SDK.config.parse_yaml(
+          Rails.root.join('config/ncontent.yml').to_s
+        ) || NContent::SDK.config.parse_yaml(
+          Rails.root.join('config/naranya_ecm.yml').to_s
+        ) || {}
+
+        if config_from_yaml.key? Rails.env
+          config_from_yaml = config_from_yaml[Rails.env]
+        end
+
+        # config from whatever was parsed or not:
+        NContent::SDK.configure config_from_yaml
+
+        # Setup the logger:
+        NContent::SDK.logger = Rails.logger
+
+        # Setup the cache:
+        NContent::SDK.cache = Rails.cache
+
+      end
+
+      #initializer "cequel.add_new_relic" do
+      #  if configuration.fetch(:newrelic_enabled, true)
+      #    begin
+      #      require 'new_relic/agent/method_tracer'
+      #    rescue LoadError => e
+      #      Rails.logger.debug(
+      #        "New Relic not installed; skipping New Relic integration")
+      #    else
+      #      require 'cequel/metal/new_relic_instrumentation'
+      #    end
+      #  end
+      #end
+
+      #rake_tasks do
+      #  require "cequel/record/tasks"
+      #end
+
+      #generators do
+      #  require 'cequel/record/configuration_generator'
+      #  require 'cequel/record/record_generator'
+      #end
+
+    end
+  end
+end