nazrin 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f98b0576f7417a5acab58c60adf492414ce08a2e
-  data.tar.gz: c745e6f9830896c0fdf08206e83fa9b9ce7a3e04
+  metadata.gz: 3765528fe1c94e124288e3af3b4015cd929a9a93
+  data.tar.gz: d145c6568fd01065ab0d6a78a2b48bf601e5ea42
 SHA512:
-  metadata.gz: 68875e9dde8ec03648a17add6d131b7ca2093150ddade67cfe6c246f30154d9eb17ee558ae5629b0dc629d89d959f270921b0e2eda9c51692d19322626a4cdeb
-  data.tar.gz: e07771ba1ed25375d58b7692026472bc1fd62c4a9a3b72a6b2293150dbc2938635df145b0d1d64971f6eda9f91b65fe36dc3d097549b0ea90a9fc9e352b20eef
+  metadata.gz: 5c9673e792b0b9011084daf9d407a4de9f98fe1eb2f3aadd69f19b850c5656d53d73ad806ec2f53134380098f03ca2c2e107fa505b3c77ac858c29f85a996e4c
+  data.tar.gz: b37bda7e9dc6f3e25d165dfcd2fae70380c06055b7b5a5f989487c1d732e7b9536bbd064ebfd7fa828bd83ebaec6083dfa9637bbc08cc27f3dd4d6d09947a40a

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [2.5.0](https://github.com/tsuwatch/nazrin/compare/v2.4.0...v2.5.0)
+
+### Features:
+
+* CloudSearch data also available [#25](https://github.com/tsuwatch/nazrin/pull/25) - [@AMHOL](https://github.com/AMHOL)
+
+* Enable accessing facets [#26](https://github.com/tsuwatch/nazrin/pull/26) - [@AMHOL](https://github.com/AMHOL)
+
 ## [2.4.0](https://github.com/tsuwatch/nazrin/compare/v2.3.0...v2.4.0)
 
 ### Features:

data/README.md

@@ -51,6 +51,10 @@ class Post < ActiveRecord::Base
   searchable_configure do |config|
     config.search_endpoint = 'http://example.com/override-search-endpoint'
     config.document_endpoint = 'http://example.com/override-document-endpoint'
+
+    # If you set domain_name, CloudSearch data using index_fields configured for the search domain is loaded, not a database.
+    # So you can use nazrin for plain object
+    config.domain_name = 'my-cloudsearch-domain-name'
   end
 
   searchable do
@@ -65,8 +69,11 @@ end
 ```
 
 ```ruby
-Post.search(where: :foo, includes: :bar).size(1).start(0).query("(and 'content')").query_parser('structured').execute
+result = Post.search(where: :foo, includes: :bar).size(1).start(0).query("(and 'content')").query_parser('structured').execute
 => [#<Post id: 1, content: "content">]
+# You can access facets
+result.facets
+=> {}
 ```
 
 ### Supported pagination libraries

data/lib/nazrin/data_accessor.rb

@@ -1,3 +1,5 @@
+require 'nazrin/result'
+
 module Nazrin
   class DataAccessor
     class NoAccessorError < StandardError; end
@@ -26,7 +28,11 @@ module Nazrin
 
       def accessor_for(clazz)
         return nil if clazz.name.nil? || clazz.name.empty?
-        if defined?(::ActiveRecord::Base) && clazz.ancestors.include?(::ActiveRecord::Base)
+
+        if clazz.respond_to?(:nazrin_searchable_config) && clazz.nazrin_searchable_config.domain_name
+          require 'nazrin/data_accessor/struct'
+          return Nazrin::DataAccessor::Struct[clazz.nazrin_searchable_config]
+        elsif defined?(::ActiveRecord::Base) && clazz.ancestors.include?(::ActiveRecord::Base)
           require 'nazrin/data_accessor/active_record'
           return Nazrin::DataAccessor::ActiveRecord
         elsif defined?(::Mongoid::Document) && clazz.ancestors.include?(::Mongoid::Document)
@@ -45,43 +51,55 @@ module Nazrin
       end
     end
 
+    attr_reader :model
+    attr_reader :options
+
     def initialize(model, options)
       @model = model
       @options = options
     end
 
     def results(client)
-      @client = client
-
-      res = @client.search
-      collection = load_all(res.data.hits.hit.map(&:id))
+      res = client.search
+      collection = load_all(data_from_response(res))
+      start = client.parameters[:start]
+      size = client.parameters[:size]
 
-      if @client.parameters[:size] && @client.parameters[:start]
+      if size && start
         total_count = res.data.hits.found
 
-        Nazrin::PaginationGenerator.generate(
+        records = Nazrin::PaginationGenerator.generate(
           collection,
-          current_page: current_page,
-          per_page: @client.parameters[:size],
+          current_page: current_page(start, size),
+          per_page: size,
           total_count: total_count,
-          last_page: last_page(total_count))
+          last_page: last_page(size, total_count))
       else
-        collection
+        records = collection
       end
+
+      Result.new(
+        records,
+        res.facets
+      )
     end
 
     def load_all
       raise NotImplementedError
     end
 
+    def data_from_response
+      raise NotImplementedError
+    end
+
     private
 
-    def last_page(total_count)
-      (total_count / @client.parameters[:size].to_f).ceil
+    def last_page(size, total_count)
+      (total_count / size.to_f).ceil
     end
 
-    def current_page
-      (@client.parameters[:start] / @client.parameters[:size].to_f).ceil + 1
+    def current_page(start, size)
+      (start / size.to_f).ceil + 1
     end
   end
 end

data/lib/nazrin/data_accessor/active_record.rb

@@ -4,16 +4,20 @@ module Nazrin
       # load from activerecord
       def load_all(ids)
         records_table = {}
-        @options.each do |k, v|
-          @model = @model.send(k, v)
+        options.each do |k, v|
+          model = model.send(k, v)
         end
-        @model.where(id: ids).each do |record|
+        model.where(id: ids).each do |record|
           records_table[record.id] = record
         end
         ids.map do |id|
           records_table.select { |k, _| k == id.to_i }[id.to_i]
         end.reject(&:nil?)
       end
+
+      def data_from_response(res)
+        res.data.hits.hit.map(&:id)
+      end
     end
   end
 end

data/lib/nazrin/data_accessor/mongoid.rb

@@ -3,20 +3,24 @@ module Nazrin
     class Mongoid < Nazrin::DataAccessor
       def load_all(ids)
         documents_table = {}
-        @options.each do |k, v|
-          @model = if v.nil?
-                     @model.send(k)
+        options.each do |k, v|
+          model = if v.nil?
+                     model.send(k)
                    else
-                     @model.send(k, v)
+                     model.send(k, v)
                    end
         end
-        @model.where('_id' => { '$in' => ids }).each do |document|
+        model.where('_id' => { '$in' => ids }).each do |document|
           documents_table[document._id.to_s] = document
         end
         ids.map do |id|
           documents_table[id]
         end.reject(&:nil?)
       end
+
+      def data_from_response(res)
+        res.data.hits.hit.map(&:id)
+      end
     end
   end
 end

data/lib/nazrin/data_accessor/struct.rb

@@ -0,0 +1,68 @@
+require 'aws-sdk-cloudsearch'
+
+module Nazrin
+  class DataAccessor
+    class Struct < Nazrin::DataAccessor
+      class MissingDomainNameConfigError < StandardError; end
+
+      class << self
+        attr_reader :config
+
+        def [](config)
+          Class.new(self).tap do |clazz|
+            clazz.instance_variable_set(:@config, config)
+          end
+        end
+
+        def transform_attributes(attributes)
+          attributes.each_with_object({}) do |(name, value), hash|
+            type = field_types[name]
+
+            if type.end_with?('array')
+              hash[name] = value
+            else
+              hash[name] = value.first
+            end
+          end
+        end
+
+        def field_types
+          return @field_types if defined?(@field_types)
+
+          response = cloudsearch_client.describe_index_fields(
+            domain_name: config.domain_name
+          )
+
+          @field_types = response.index_fields.each_with_object({}) do |field, fields|
+            name = field.options[:index_field_name]
+            type = field.options[:index_field_type]
+
+            fields[name] = type
+          end
+        end
+
+        private
+
+        def cloudsearch_client
+          @cloudsearch_client ||= Aws::CloudSearch::Client.new(
+            access_key_id: config.access_key_id,
+            secret_access_key: config.secret_access_key,
+            logger: config.logger
+          )
+        end
+      end
+
+      def load_all(data)
+        data.map do |attributes|
+          model.new(attributes)
+        end
+      end
+
+      def data_from_response(res)
+        res.data[:hits][:hit].map do |hit|
+          self.class.transform_attributes(hit[:fields])
+        end
+      end
+    end
+  end
+end

data/lib/nazrin/result.rb

@@ -0,0 +1,10 @@
+module Nazrin
+  class Result < SimpleDelegator
+    attr_reader :facets
+
+    def initialize(result, facets)
+      super(result)
+      @facets = facets
+    end
+  end
+end

data/lib/nazrin/searchable/config.rb

@@ -1,6 +1,8 @@
 module Nazrin
   module Searchable
     class Configuration
+      attr_accessor :domain_name
+
       %i(
         search_endpoint
         document_endpoint

data/lib/nazrin/version.rb

@@ -1,3 +1,3 @@
 module Nazrin
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

data/nazrin.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'aws-sdk-core', '~> 3'
+  spec.add_dependency 'aws-sdk-cloudsearch', '~> 1.0'
   spec.add_dependency 'aws-sdk-cloudsearchdomain', '~> 1.0'
   spec.add_dependency 'activesupport', '>= 4.0.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nazrin
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Tomohiro Suwa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudsearchdomain
   requirement: !ruby/object:Gem::Requirement
@@ -202,9 +216,11 @@ files:
 - lib/nazrin/data_accessor.rb
 - lib/nazrin/data_accessor/active_record.rb
 - lib/nazrin/data_accessor/mongoid.rb
+- lib/nazrin/data_accessor/struct.rb
 - lib/nazrin/document_client.rb
 - lib/nazrin/paginated_array.rb
 - lib/nazrin/pagination_generator.rb
+- lib/nazrin/result.rb
 - lib/nazrin/search_client.rb
 - lib/nazrin/searchable.rb
 - lib/nazrin/searchable/config.rb