ncore 2.1.2 → 3.1.0

data/lib/ncore/client_cache.rb

@@ -0,0 +1,48 @@
+module NCore
+  module Client::Cache
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      private
+
+      # cache_opts: true
+      #   use *::Api.cache_store
+      # cache_opts: {...}
+      #   use: *::Api.cache_store, with options: {...}
+      #   hint: add  force: true  execute the query and rewrite the cache
+      # cache_opts: Store.new
+      #   use Store.new as-is
+      def execute_request(req, cache_opts=nil)
+        case cache_opts
+        when true
+          store, cache_opts = cache_store, {}
+        when Hash
+          store, cache_opts = cache_store, cache_opts.symbolize_keys
+        when nil, false
+          store = false
+        else
+          store, cache_opts = cache_opts, {}
+        end
+
+        if store && req[:method] == :get
+          store.fetch request_cache_key(req.slice(:url, :headers)), cache_opts do
+            super
+          end
+        else
+          super
+        end
+      end
+
+
+      def request_cache_key(url:, headers:)
+        [ 'ncore',
+          url.gsub(/[^a-zA-Z0-9]+/,'-'),
+          Digest::MD5.hexdigest(headers.sort.to_s)
+        ].join ':'
+      end
+
+    end
+
+  end
+end

data/lib/ncore/configuration.rb

@@ -28,6 +28,9 @@ module NCore
         mattr_accessor :strict_attributes
         self.strict_attributes = true
 
+        mattr_accessor :i18n_scope
+        self.i18n_scope = :ncore
+
         mattr_accessor :instrument_key
         self.instrument_key = 'request.ncore'
 
@@ -37,10 +40,18 @@ module NCore
         mattr_accessor :auth_header_prefix
         self.auth_header_prefix = 'X-Api'
 
-        mattr_accessor :bearer_credential_key
+        mattr_reader :bearer_credential_key
+        class_eval <<-MTH
+          def self.bearer_credential_key=(v)
+            @@bearer_credential_key = v&.to_s
+          end
+          def bearer_credential_key=(v)
+            @@bearer_credential_key = v&.to_s
+          end
+        MTH
 
         mattr_accessor :credentials_error_message
-        self.credentials_error_message = %Q{Missing API credentials. Set default credentials using "#{self.parent.name}.credentials = {api_user: YOUR_API_USER, api_key: YOUR_API_KEY}"}
+        self.credentials_error_message = %Q{Missing API credentials. Set default credentials using "#{self.module_parent.name}.credentials = {api_user: YOUR_API_USER, api_key: YOUR_API_KEY}"}
 
         mattr_accessor :verify_ssl
         self.verify_ssl = true
@@ -48,6 +59,8 @@ module NCore
         mattr_accessor :ssl_cert_bundle
         self.ssl_cert_bundle = File.dirname(__FILE__)+'/ssl/ca-certificates.crt'
 
+        mattr_accessor :cache_store
+
         mattr_accessor :logger
         self.logger = Logger.new(STDOUT)
       end

data/lib/ncore/exceptions.rb

@@ -23,9 +23,13 @@ module NCore
             cl_name ||= object.class.class_name if object.class.respond_to?(:class_name)
             cl_name ||= object.name if object.respond_to?(:name)
             cl_name ||= object.class.name
-            msg = "\#{cl_name} Invalid: \#{@object.errors.to_a.join(' ')}"
+            msg = "\#{cl_name} Invalid: \#{object.errors.to_a.join(' ')}"
             super msg
           end
+
+          def errors
+            object&.errors
+          end
         end
 
         class QueryError < Error
@@ -39,6 +43,8 @@ module NCore
         end
 
         class BulkActionError < QueryError ; end
+
+        # DEPRECATED; to be removed in v3.1
         class ValidationError < QueryError ; end
       INCL
     end

data/lib/ncore/identity.rb

@@ -15,9 +15,36 @@ module NCore
         class_name.underscore
       end
       alias :json_root :attrib_name
+
+      def i18n_scope
+        module_parent::Api.i18n_scope
+      end
+
+      # make NCore::SomeResource.model_name do the right thing
+      def model_name
+        ::ActiveModel::Name.new(self, nil, ::ActiveSupport::Inflector.demodulize(self))
+      end
+
     end
 
 
+    # from ActiveRecord::Core
+    def ==(comparison_object)
+      super ||
+        comparison_object.instance_of?(self.class) &&
+        !id.nil? &&
+        comparison_object.id == id
+    end
+    alias :eql? :==
+
+    def hash
+      if id
+        self.class.hash ^ id.hash
+      else
+        super
+      end
+    end
+
     def json_root
       self.class.json_root
     end

data/lib/ncore/lifecycle.rb

@@ -15,20 +15,20 @@ module NCore
         if respond_to? :update, true
           update(update_params)
         else
-          raise self.class.parent::Error, "Updating #{self.class.name} objects is not supported."
+          raise self.class.module_parent::Error, "Updating #{self.class.name} objects is not supported."
         end
       else
         if respond_to? :create, true
           create(update_params)
         else
-          raise self.class.parent::Error, "Creating #{self.class.name} objects is not supported."
+          raise self.class.module_parent::Error, "Creating #{self.class.name} objects is not supported."
         end
       end
     end
     alias :update_attributes :save
 
     def save!(update_params={})
-      save(update_params) || raise(self.class.parent::RecordInvalid, self)
+      save(update_params) || raise(self.class.module_parent::RecordInvalid, self)
     end
     alias :update_attributes! :save!
 

data/lib/ncore/methods/all.rb

@@ -5,18 +5,14 @@ module NCore
     module ClassMethods
       def all(params={})
         params = parse_request_params(params)
-        parsed, creds = request(:get, url, params)
+        parsed, creds = request(:get, resource_path, params)
         if parsed[:errors].any?
-          raise parent::QueryError, parsed[:errors]
+          raise module_parent::QueryError, parsed[:errors]
         end
         Collection.new.tap do |coll|
           coll.metadata = parsed[:metadata]
           parsed[:data].each do |hash|
-            if key = hash[:object]
-              coll << discover_class(key, self).new(hash.merge(metadata: parsed[:metadata]), creds)
-            else
-              coll << new(hash.merge(metadata: parsed[:metadata]), creds)
-            end
+            coll << factory(hash.merge(metadata: parsed[:metadata]), creds)
           end
         end
       end

data/lib/ncore/methods/build.rb

@@ -5,9 +5,9 @@ module NCore
     module ClassMethods
       def build(params={})
         params = parse_request_params(params)
-        parsed, creds = request(:get, url+'/new', params)
+        parsed, creds = request(:get, "#{resource_path}/new", params)
         if parsed[:errors].any?
-          raise parent::QueryError, parsed[:errors]
+          raise module_parent::QueryError, parsed[:errors]
         end
         new(parsed, creds)
       end

data/lib/ncore/methods/count.rb

@@ -5,7 +5,7 @@ module NCore
     module ClassMethods
       def count(params={})
         params = parse_request_params(params)
-        parsed, _ = request(:get, "#{url}/count", params)
+        parsed, _ = request(:get, "#{resource_path}/count", params)
         parsed[:data][:count]
       end
     end

data/lib/ncore/methods/create.rb

@@ -6,16 +6,15 @@ module NCore
       def create!(attribs={})
         obj = create(attribs)
         if obj.errors?
-          raise parent::RecordInvalid, obj
+          raise module_parent::RecordInvalid, obj
         end
         obj
       end
 
       # always returns a new object; check .errors? or .valid? to see how it went
       def create(attribs={})
-        params = parse_request_params(attribs)
-        obj = new({}, params[:credentials])
-        obj.send :create, params
+        obj = new
+        obj.send :create, attribs
         obj
       end
     end
@@ -24,7 +23,7 @@ module NCore
 
     def create(attribs={})
       params = parse_request_params(attribs, json_root: json_root).reverse_merge credentials: api_creds
-      parsed, @api_creds = request(:post, self.class.url, params)
+      parsed, @api_creds = request(:post, self.class.resource_path, params)
       load(data: params[json_root]) if parsed[:errors].any?
       load(parsed)
       errors.empty? ? self : false

data/lib/ncore/methods/delete.rb

@@ -4,18 +4,17 @@ module NCore
 
     module ClassMethods
       def delete!(id, params={})
-        obj = delete(id, attribs)
+        obj = delete(id, params)
         if obj.errors?
-          raise parent::RecordInvalid, obj
+          raise module_parent::RecordInvalid, obj
         end
         obj
       end
 
       # always returns a new object; check .errors? or .valid? to see how it went
       def delete(id, params={})
-        raise(parent::RecordNotFound, "Cannot delete id=nil") if id.blank?
-        params = parse_request_params(params)
-        obj = new({id: id}, params[:credentials])
+        raise(module_parent::RecordNotFound, "Cannot delete id=nil") if id.blank?
+        obj = new(id: id)
         obj.delete(params)
         obj
       end
@@ -23,13 +22,13 @@ module NCore
 
     def delete(params={})
       params = parse_request_params(params).reverse_merge credentials: api_creds
-      parsed, @api_creds = request(:delete, url, params)
+      parsed, @api_creds = request(:delete, resource_path, params)
       load(parsed)
       errors.empty? ? self : false
     end
 
     def delete!(params={})
-      delete(params) || raise(self.class.parent::RecordInvalid, self)
+      delete(params) || raise(self.class.module_parent::RecordInvalid, self)
     end
 
   end

data/lib/ncore/methods/delete_bulk.rb

@@ -4,12 +4,12 @@ module NCore
 
     module ClassMethods
       def bulk_delete!(ids, params={})
-        raise(parent::RecordNotFound, "ids must not be empty") if ids.blank?
+        raise(module_parent::RecordNotFound, "ids must not be empty") if ids.blank?
         params[:ids] = ids
         params = parse_request_params(params)
-        parsed, creds = request(:delete, url, params)
+        parsed, creds = request(:delete, resource_path, params)
         if parsed[:errors].any?
-          raise parent::BulkActionError, parsed[:errors]
+          raise module_parent::BulkActionError, parsed[:errors]
         else
           parsed[:metadata]
         end
@@ -17,7 +17,7 @@ module NCore
 
       def bulk_delete(ids, params={})
         bulk_delete!(ids, params)
-      rescue parent::RecordNotFound, parent::BulkActionError
+      rescue module_parent::RecordNotFound, module_parent::BulkActionError
         false
       end
     end

data/lib/ncore/methods/delete_single.rb

@@ -4,21 +4,20 @@ module NCore
 
     module ClassMethods
       def delete(params={})
-        params = parse_request_params(params)
-        obj = new({}, params[:credentials])
-        obj.delete(params) || raise(parent::RecordInvalid, obj)
+        obj = new
+        obj.delete!(params)
       end
     end
 
     def delete(params={})
       params = parse_request_params(params).reverse_merge credentials: api_creds
-      parsed, @api_creds = request(:delete, url, params)
+      parsed, @api_creds = request(:delete, resource_path, params)
       load(parsed)
       errors.empty? ? self : false
     end
 
     def delete!(params={})
-      delete(params) || raise(self.class.parent::RecordInvalid, self)
+      delete(params) || raise(self.class.module_parent::RecordInvalid, self)
     end
 
   end

data/lib/ncore/methods/find.rb

@@ -4,23 +4,22 @@ module NCore
 
     module ClassMethods
       def find(id, params={})
-        raise(parent::RecordNotFound, "Cannot find id=nil") if id.blank?
-        params = parse_request_params(params)
-        o = new({id: id}, params[:credentials])
+        raise(module_parent::RecordNotFound, "Cannot find id=nil") if id.blank?
+        o = new(id: id)
         o.reload(params)
       end
 
       def retrieve(id, params={})
         find id, params
-      rescue parent::RecordNotFound
-        false
+      rescue module_parent::RecordNotFound
+        nil
       end
     end
 
     def reload(find_params={})
       return if id.blank?
       params = parse_request_params(find_params).reverse_merge credentials: api_creds
-      parsed, @api_creds = request(:get, url, params)
+      parsed, @api_creds = request(:get, resource_path, params)
       @attribs = {}.with_indifferent_access
       load(parsed)
     end

data/lib/ncore/methods/find_single.rb

@@ -4,18 +4,14 @@ module NCore
 
     module ClassMethods
       def find(params={})
-        params = parse_request_params(params)
-        parsed, creds = request(:get, url, params)
-        if parsed[:errors].any?
-          raise parent::QueryError, parsed[:errors]
-        end
-        new(parsed, creds)
+        obj = new
+        obj.reload(params)
       end
 
       def retrieve(params={})
         find params
-      rescue parent::RecordNotFound
-        false
+      rescue module_parent::RecordNotFound
+        nil
       end
     end
 
@@ -27,7 +23,7 @@ module NCore
 
     def reload(find_params={})
       params = parse_request_params(find_params).reverse_merge credentials: api_creds
-      parsed, @api_creds = request(:get, url, params)
+      parsed, @api_creds = request(:get, resource_path, params)
       @attribs = {}.with_indifferent_access
       load(parsed)
     end

data/lib/ncore/methods/update.rb

@@ -6,31 +6,30 @@ module NCore
       def update!(id, attribs)
         obj = update(id, attribs)
         if obj.errors?
-          raise parent::RecordInvalid, obj
+          raise module_parent::RecordInvalid, obj
         end
         obj
       end
 
       # always returns a new object; check .errors? or .valid? to see how it went
       def update(id, attribs)
-        raise(parent::RecordNotFound, "Cannot update id=nil") if id.blank?
-        params = parse_request_params(attribs)
-        obj = new({id: id}, params[:credentials])
-        obj.update params
+        raise(module_parent::RecordNotFound, "Cannot update id=nil") if id.blank?
+        obj = new(id: id)
+        obj.update attribs
         obj
       end
     end
 
     def update(attribs={})
       params = parse_request_params(attribs, json_root: json_root).reverse_merge credentials: api_creds
-      parsed, @api_creds = request(:put, url, params)
+      parsed, @api_creds = request(:put, resource_path, params)
       load(data: params[json_root]) if parsed[:errors].any?
       load(parsed)
       errors.empty? ? self : false
     end
 
     def update!(params={})
-      update(params) || raise(self.class.parent::RecordInvalid, self)
+      update(params) || raise(self.class.module_parent::RecordInvalid, self)
     end
 
   end

data/lib/ncore/methods/update_bulk.rb

@@ -0,0 +1,26 @@
+module NCore
+  module UpdateBulk
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def bulk_update!(ids, params={})
+        raise(module_parent::RecordNotFound, "ids must not be empty") if ids.blank?
+        params = parse_request_params(params, json_root: json_root)
+        params[:ids] = ids
+        parsed, creds = request(:put, resource_path, params)
+        if parsed[:errors].any?
+          raise module_parent::BulkActionError, parsed[:errors]
+        else
+          parsed[:metadata]
+        end
+      end
+
+      def bulk_update(ids, params={})
+        bulk_update!(ids, params)
+      rescue module_parent::RecordNotFound, module_parent::BulkActionError
+        false
+      end
+    end
+
+  end
+end