CloudSesame 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1aa78ac110ff6d8751cd235c990abb352c511af
+  data.tar.gz: e5375370b5e608dd76ff693e50294ee01dda5793
+SHA512:
+  metadata.gz: a05e5969a34dfb7f6050f806519ee93d6abac10421d6e6c0467b7f8c151ac42024d437be920649eb9be41289ec163b8335d12c03184717a2647198e216b2a3fd
+  data.tar.gz: a677cdd1996244801289914952e7e77f902a62267300ee2eb46b0f1f5d7f6ec47e4bc9eebb0f7a8160866d4166e5b8b16b38435621a3c657b3260283aceb8ba1

data/.gitignore

@@ -0,0 +1,4 @@
+/tmp
+.DS_Store
+
+aws.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    CloudSesame (0.1.0)
+      aws-sdk (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (2.2.10)
+      aws-sdk-resources (= 2.2.10)
+    aws-sdk-core (2.2.10)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.2.10)
+      aws-sdk-core (= 2.2.10)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.6.4)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jmespath (1.1.3)
+    listen (3.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.10)
+    method_source (0.8.2)
+    nenv (0.2.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  CloudSesame!
+  guard
+  guard-rspec
+  pry (~> 0)
+  rspec (~> 3)

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/cloud_sesame.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = 'CloudSesame'
+  s.version     = '0.1.0'
+  s.date        = '2016-01-13'
+  s.summary     = "AWS CloudSearch Query Interface"
+  s.description = "AWS CloudSearch Query Interface"
+  s.authors = ['Scott Chu', 'Emily Fan', 'Greg Ward', 'David McHoull',
+    'Alishan Ladhani', 'Justine Jones', 'Gillian Chesnais', 'Jeff Li']
+  s.email = 'dev@retailcommon.com'
+  s.homepage = 'https://github.com/47colborne/cloud_sesame'
+  s.platform = Gem::Platform::RUBY
+  s.license = 'MIT'
+
+  s.files = `git ls-files -z`.split("\x0")
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency('aws-sdk', '~> 2')
+
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'pry', '~> 0'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+end

data/lib/abstract_object.rb

@@ -0,0 +1,67 @@
+class AbstractObject
+
+	def self.accept(key, options = {})
+		key = key.to_sym
+		set_definitions key, options
+		define_accessor key, options
+	end
+
+	def initialize(options = {})
+		raise "Definitions can not be empty" if self.class.definitions.empty?
+		@attributes = rename filter options.kind_of?(AbstractObject) ? options.to_hash : options
+	end
+
+	def to_hash
+		attributes.dup
+	end
+
+	private
+
+	def self.define_accessor(key, options)
+		aliases = options.delete(:as) || []
+		define_reader key, [key, *aliases], options.delete(:default)
+		define_writer key, [key, *aliases], options.delete(:callback)
+	end
+
+	def self.define_reader(key, aliases, default)
+		aliases.each { |name| define_method name, &reader_block(key, default) }
+	end
+
+	def self.reader_block(key, default)
+		default.is_a?(Proc) ? -> { attributes[key] ||= default.call(self) } : -> { attributes[key] ||= default }
+	end
+
+	def self.define_writer(key, aliases, callbacks)
+		aliases.each { |name| define_method "#{ name }=", &writer_block(key, callbacks) }
+	end
+
+	def self.writer_block(key, callback)
+		callback.is_a?(Proc) ? -> (value) { attributes[key] = callback.call(value) } : -> (value) { attributes[key] = value }
+	end
+
+	def self.set_definitions(key, options)
+		[key, *options.fetch(:as, [])].each { |name| definitions[name] = key }
+	end
+
+	def self.definitions
+		@definitions ||= (parent = self.superclass).respond_to?(:definitions) ? parent.definitions.dup : {}
+	end
+
+	def attributes
+		@attributes ||= {}
+	end
+
+	def filter(attributes)
+		attributes.delete_if { |key| self.class.definitions[key].nil? }
+	end
+
+	def rename(attributes)
+		attributes.keys.each do |key|
+			if (name = self.class.definitions[key])
+				attributes[name] = attributes.delete(key)
+			end
+		end
+		attributes
+	end
+
+end

data/lib/cloud_sesame.rb

@@ -0,0 +1,77 @@
+# External Libraries
+# ===============================================
+require 'aws-sdk'
+require 'forwardable'
+
+# Internal Libraries
+# ===============================================
+require 'abstract_object'
+require 'cloud_sesame/config/credential'
+
+require 'cloud_sesame/query/error/missing_operator_symbol'
+require 'cloud_sesame/query/error/missing_query'
+
+
+require 'cloud_sesame/query/dsl/base'
+require 'cloud_sesame/query/dsl/and'
+require 'cloud_sesame/query/dsl/or'
+require 'cloud_sesame/query/dsl/range'
+require 'cloud_sesame/query/dsl/literal'
+require 'cloud_sesame/query/dsl/scope'
+require 'cloud_sesame/query/dsl/filter_query'
+
+
+require 'cloud_sesame/query/dsl'
+require 'cloud_sesame/query/builder'
+
+require 'cloud_sesame/query/ast/multi_branch'
+require 'cloud_sesame/query/ast/single_branch'
+require 'cloud_sesame/query/ast/leaf'
+require 'cloud_sesame/query/ast/root'
+require 'cloud_sesame/query/ast/operator'
+require 'cloud_sesame/query/ast/and'
+require 'cloud_sesame/query/ast/or'
+require 'cloud_sesame/query/ast/not'
+require 'cloud_sesame/query/ast/literal'
+require 'cloud_sesame/query/ast/compound_array'
+require 'cloud_sesame/query/ast/prefix_literal'
+require 'cloud_sesame/query/ast/value'
+
+require 'cloud_sesame/query/node/abstract'
+require 'cloud_sesame/query/node/request'
+require 'cloud_sesame/query/node/query'
+require 'cloud_sesame/query/node/query_options'
+require 'cloud_sesame/query/node/query_options_field'
+require 'cloud_sesame/query/node/query_parser'
+require 'cloud_sesame/query/node/filter_query'
+require 'cloud_sesame/query/node/facet'
+require 'cloud_sesame/query/node/page'
+require 'cloud_sesame/query/node/sort'
+
+require 'cloud_sesame/domain/base'
+require 'cloud_sesame/domain/client'
+require 'cloud_sesame/domain/config'
+require 'cloud_sesame/domain/context'
+
+
+# Public Interface
+# ===============================================
+module CloudSesame
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def cloudsearch
+      @cloudsearch ||= CloudSesame::Domain::Base.new self
+    end
+
+    def define_cloudsearch(&block)
+      cloudsearch.instance_eval &block if block_given?
+    end
+
+  end
+
+end

data/lib/cloud_sesame/config/credential.rb

@@ -0,0 +1,8 @@
+module CloudSesame
+	module Config
+		class Credential < ::AbstractObject
+			accept :access_key_id, as: [:access_key]
+			accept :secret_access_key, as: [:secret_key]
+		end
+	end
+end

data/lib/cloud_sesame/domain/base.rb

@@ -0,0 +1,70 @@
+module CloudSesame
+	module Domain
+		class Base
+			extend Forwardable
+
+			attr_reader :searchable_class
+
+			def_delegator :client, :config
+
+			def_delegators 	:builder, :query, :terms,
+																:page, :size,
+																:sort, :and, :or,
+																:included?, :excluded?
+
+			def initialize(searchable_class)
+				@searchable_class = searchable_class
+			end
+
+			def client
+				@client ||= Client.new
+			end
+
+			def builder
+				@builder ||= CloudSesame::Query::Builder.new context, searchable_class
+			end
+
+			# DEFAULT CONTEXT METHODS
+			# =========================================
+
+			def context
+				@context ||= Context.new
+			end
+
+			def default_size(value)
+				context[:page, true][:size] = value
+			end
+
+			def field(name, options = {})
+				# define filter query fields
+				context[:filter_query, true][:fields, true][name.to_sym] = {}
+
+				# define query options fields
+				define_query_options(name, options[:query]) if options[:query]
+
+				# define facet options
+				define_facet_options(name, options[:facet]) if options[:facet]
+			end
+
+			def define_query_options(name, query_options)
+				context[:query_options, true][:fields, true][name.to_sym] = format_options(query_options)
+			end
+
+			def define_facet_options(name, facet_options)
+				context[:facet, true][name.to_sym] = format_options(facet_options)
+			end
+
+			def scope(name, proc = nil, &block)
+				block = proc unless block_given?
+				context[:filter_query, true][:scopes, true][name.to_sym] = block
+			end
+
+			private
+
+			def format_options(options)
+				options.is_a?(Hash) ? options : {}
+			end
+
+		end
+	end
+end

data/lib/cloud_sesame/domain/client.rb

@@ -0,0 +1,28 @@
+module CloudSesame
+	module Domain
+		class Client
+			extend Forwardable
+
+			def_delegator :aws_client, :search
+
+			def self.configure
+				yield global_config if block_given?
+			end
+
+			def self.global_config
+				@global_config ||= Config.new
+			end
+
+			def config
+				@config ||= Config.new self.class.global_config
+			end
+
+			private
+
+			def aws_client
+				@aws_client ||= ::Aws::CloudSearchDomain::Client.new config.to_hash
+			end
+
+		end
+	end
+end