flex 0.1.0

data/lib/generators/flex/setup/templates/flex_config.yml

@@ -0,0 +1,16 @@
+# ANCHORS litheral key: it will not be used as template
+# you can store here fragments of structures to reuse below
+ANCHORS:
+  -
+
+# This is a dynamic index name The settings and mapping below will work with any index.
+# The default index name generated by Flex is usually <application_name>_<environment>,
+# but you may have changed it in the initializers/flex.rb or you can hardcode it if you prefer.
+<%= Flex::Configuration.variables[:index] %>:
+
+  settings:
+    number_of_shards: 5
+    number_of_replicas: 1
+
+  # add your custom mappings here
+  mappings: {}

data/lib/generators/flex/setup/templates/flex_dir/es.rb.erb

@@ -0,0 +1,18 @@
+# inspect the methods loaded in this module and their usage
+# in the rails console by just typing:
+# >> puts <%= @class_name %>.flex.info
+# you can eventually restrict the info to a single method by pasing its name:
+# >> puts <%= @class_name %>.flex.info :search
+# see the detailed doc for this feature at https://github.com/ddnexus/flex/wiki/Selfdoc
+
+module <%= @class_name %>
+
+  extend self
+
+  include Flex::Loader
+  flex.load_search_source
+
+  # you may need to add more method here, usually wrapper methods
+  # that use one of the autogenerated methods from the loaded templates
+
+end

data/lib/generators/flex/setup/templates/flex_dir/es.yml.erb

@@ -0,0 +1,19 @@
+# Add here your search queries
+# see the detailed Source documentation at https://github.com/ddnexus/flex/wiki/Sources
+
+
+# ANCHORS litheral key: it will not be used as template
+# you can store here fragments of queries to reuse in the templates below
+ANCHORS:
+  -
+
+# this is a a basic template loaded in your class <%= @class_name %>
+# it defines the 'q' tag. You can check its usage from the rails console by just typing:
+# >> puts <%= @class_name %>.flex.info
+# You can eventually restrict the info to a single method by pasing its name:
+# >> puts <%= @class_name %>.flex.info :search
+# see the detailed doc for this feature at https://github.com/ddnexus/flex/wiki/Selfdoc
+search:
+- query:
+    query_string: <<q= "*">>
+

data/lib/generators/flex/setup/templates/flex_dir/es_extender.rb.erb

@@ -0,0 +1,17 @@
+# see the detailed Extenders documentation at https://github.com/ddnexus/flex/wiki/Extenders
+
+module <%= @extender_name  %>
+
+  # set this method to restrict this extender to certain types of results
+  # see the other Flex extenders for reference (https://github.com/ddnexus/flex/tree/master/lib/flex/result)
+  def self.should_extend?(response)
+    false
+  end
+
+  # adds your methods
+
+  def an_extending_method
+    # self is the structure returned by ES
+  end
+
+end

data/lib/generators/flex/setup/templates/flex_initializer.rb.erb

@@ -0,0 +1,44 @@
+# see the detailed Configuration documentation at https://github.com/ddnexus/flex/wiki/Configuration
+
+Flex::Configuration.configure do |config|
+
+  # you MUST add your indexed model names here
+  config.flex_models = %w[  ]
+
+  # Add the your result extenders here
+  config.result_extenders |= [ <%= "#{@extender_name}" %> ]
+
+  # Add the default variables here
+  # see also the details Variables documentation at https://github.com/ddnexus/flex/wiki/Variables
+  # config.variables.add :index => 'my_index',
+  #                      :type  => 'project',
+  #                      :anything => 'anything
+
+  # The custom url of your ElasticSearch server
+  # config.base_uri = 'http://localhost:9200'
+
+  # Set it to false to skip the logging of the debug infos
+  # config.debug = true
+
+  # Debug info are actually valid curl commands
+  # config.debug_to_curl = false
+
+  # The custom logger you want Flex to use. Default Rails.logger
+  # config.logger = Logger.new(STDERR)
+
+  # Custom config file path
+  # config.config_file = '/custom/path/to/flex.yml',
+
+  # Custom flex dir path
+  # config.flex_dir = '/custom/path/to/flex',
+
+  # The custom http_client you may want to implement
+  # config.http_client = 'Your::Client'
+
+  # The options passed to the http_client. They are client specific.
+  # config.http_client_options = {:timeout => 5}
+
+  # Experimental: checks the response and return a boolean (should raise?)
+  # config.raise_proc = proc{|response| response.status >= 400}
+
+end

data/lib/tasks/index.rake

@@ -0,0 +1,23 @@
+require defined?(Rails) ? 'flex/rails' : 'flex'
+require 'flex/tasks'
+
+env = defined?(Rails) ? :environment : []
+
+namespace :flex do
+
+  desc 'imports from an ActiveRecord or Mongoid models'
+  task(:import => env) { Flex::Tasks.import_models }
+
+  desc 'create indices from the Flex::Configuration.config_file file'
+  task(:create_index => env) { Flex::Tasks.create_indices }
+
+  desc 'alias for flex:create_index'
+  task(:create_indices => env) { Flex::Tasks.create_indices }
+
+  desc 'destroy indices in the Flex::Configuration.config_file file'
+  task(:delete_index => env) { Flex::Tasks.delete_indices }
+
+  desc 'alias for flex:delete_index'
+  task(:delete_indices => env) { Flex::Tasks.delete_indices }
+
+end

data/test/flex.irt

@@ -0,0 +1,143 @@
+desc 'check version'
+Flex::VERSION
+_eql?( "0.1" )
+
+desc 'Flex responds to all public methods'
+methods =  [ # api methods from yaml
+             :indices_exists, :create_index, :put_index, :post_index, :get_settings, :put_mapping, :get_mapping, :delete_mapping,
+             :delete_index, :delete_by_query, :bulk, :count, :stats, :store, :put_store, :post_store, :remove, :get, :multi_get,
+             # utility_methods
+             :configuration, :config, :search, :slim_search, :HEAD, :GET, :PUT, :POST, :DELETE, :json2yaml, :yaml2json,
+             :process_bulk, :import_collection, :delete_collection,
+             # other methods
+             :exist? ]
+defined, not_defined = methods.partition {|k| Flex.respond_to?(k)}
+defined
+_eql?( methods )
+
+
+desc 'create index with PUT (explicit index)'
+Flex.delete_index(:index => INDEX_NAME) if Flex.exist?(:index => INDEX_NAME)
+Flex.put_index(:index => INDEX_NAME)
+_eql?( {"ok"=>true, "acknowledged"=>true} )
+
+
+# in the irt_helper.rb we set the default index to INDEX_NAME and Flex.reload! so we don't need to pass any explicit index
+
+desc 'create index with PUT'
+Flex.delete_index if Flex.exist?
+Flex.put_index
+_eql?( {"ok"=>true, "acknowledged"=>true} )
+
+
+desc "index #{INDEX_NAME} exist"
+Flex.exist?
+_eql?( true )
+
+
+desc "index #{unexistent = 'flex_unexistent_index'} doesn't exist'"
+Flex.exist?(:index => unexistent)
+_eql?( false )
+
+
+desc 'create_index with POST (explicit index)'
+Flex.delete_index(:index => TMP_INDEX_NAME) if Flex.exist?(:index => TMP_INDEX_NAME)
+Flex.post_index(:index => TMP_INDEX_NAME)
+_eql?( {"ok"=>true, "acknowledged"=>true} )
+Flex.delete_index(:index => TMP_INDEX_NAME)
+
+
+desc 'get_settings'
+Flex.get_settings
+_eql?( {"flex_test_index"=>{"settings"=>{"index.number_of_replicas"=>"1", "index.number_of_shards"=>"5", "index.version.created"=>"190299"}}} )
+
+
+desc 'put_mapping'
+Flex.put_mapping(:type       => 'type1',
+                 :properties => {'test1' => {'type' => 'string'} })
+_eql?( {"ok"=>true, "acknowledged"=>true} )
+
+
+desc 'check mapping'
+Flex.get_mapping
+_eql?( {"flex_test_index"=>{"type1"=>{"properties"=>{"test1"=>{"type"=>"string"}}}}} )
+
+
+desc 'delete_mapping'
+Flex.delete_mapping(:type => 'type1')
+_eql?( {"ok"=>true} )
+
+
+desc 'delete_index'
+Flex.delete_index
+_eql?( {"ok"=>true, "acknowledged"=>true} )
+
+
+desc 'check delete_index'
+Flex.exist?
+_eql?( false )
+
+
+desc 'store'
+Flex.store(:type => 'type1', :id => 1, :data => {'a'=>2, 'b'=>3})
+_eql?( {"ok"=>true, "_index"=>"flex_test_index", "_type"=>"type1", "_id"=>"1", "_version"=>1} )
+
+
+desc 'get'
+Flex.get(:type => 'type1', :id => 1)
+_eql?( {"_index"=>"flex_test_index", "_type"=>"type1", "_id"=>"1", "_version"=>1, "exists"=>true, "_source"=>{"a"=>2, "b"=>3}} )
+
+
+desc 'count (may fail in test, but it\'s ok)'
+Flex.count :type => 'type1'
+_eql?( {"count"=>1, "_shards"=>{"total"=>5, "successful"=>5, "failed"=>0}} )
+
+
+desc 'remove'
+Flex.remove(:type => 'type1', :id => 1)
+_eql?( {"ok"=>true, "found"=>true, "_index"=>"flex_test_index", "_type"=>"type1", "_id"=>"1", "_version"=>2} )
+
+
+desc 'check remove'
+Flex.get(:type => 'type1', :id => 1, :raise => false)
+_eql?( nil )
+
+
+desc 'delete_by_query'
+# in Patron the :data option is not working, since currently patron cannot send data with a DELETE request
+Flex.store(:type => 'type1', :id => 1, :data => {'a'=>2, 'myfield'=>'pippo'})
+Flex.delete_by_query :type => 'type1', :params => {:q => 'myfield:pippo'}
+_eql?( {"ok"=>true, "_indices"=>{"flex_test_index"=>{"_shards"=>{"total"=>5, "successful"=>5, "failed"=>0}}}} )
+
+
+desc 'strict_existence doesn\'t affect exist'
+Flex.get(:type => 'type1', :id => 1, :raise => false)
+_eql?( nil )
+
+
+desc 'json2yaml'
+struct = {:a => {:b => [3,4,5]}}
+yaml = Flex.json2yaml MultiJson.encode(struct)
+_eql? <<EOS
+---
+a:
+  b:
+  - 3
+  - 4
+  - 5
+EOS
+
+desc 'yaml2json'
+Flex.yaml2json(yaml)
+_eql?( "{\"a\":{\"b\":[3,4,5]}}" )
+
+
+desc "exist with HEAD"
+Flex.HEAD "/#{INDEX_NAME}"
+# empty result object
+_eql?( true )
+
+desc "doesn't exist with HEAD'"
+Flex.HEAD "/unexistent_flex_index"
+_eql?( false )
+

data/test/flex/configuration.irt

@@ -0,0 +1,53 @@
+
+desc 'Flex::Configuration responds to all public methods'
+methods =  [ # regular methods from class
+             :configure,
+             # data methods
+             :base_uri, :result_extenders, :logger, :variables, :flex_models, :config_file, :flex_dir,
+             :http_client, :http_client_options, :debug, :debug_to_curl, :raise_proc]
+
+defined, not_defined = methods.partition {|k| Flex::Configuration.respond_to?(k)}
+defined
+_eql?( methods )
+
+
+desc 'block set variables'
+Flex::Configuration.configure do |conf|
+  conf.base_uri = 'http://something:123'
+end
+Flex::Configuration.base_uri
+_eql?( "http://something:123" )
+
+
+desc 'direct set variables'
+Flex::Configuration.test = false
+Flex::Configuration.test
+_eql?( false )
+
+
+desc 'new configuration object'
+Flex::Configuration.configure do |conf|
+  conf.custom = 23
+  conf.base_uri = 'http://other_host:9200'
+end
+
+
+desc 'custom arg accessor'
+Flex::Configuration.custom
+_eql?( 23 )
+
+
+desc 'modified configuration'
+Flex::Configuration.base_uri
+_eql?( 'http://other_host:9200' )
+
+
+desc 'add custom configuration with accessor'
+Flex::Configuration.new_custom = 3
+_eql?( 3 )
+
+
+desc 'custom option is in object'
+Flex::Configuration.new_custom
+_eql?( 3 )
+

data/test/irt_helper.rb

@@ -0,0 +1,12 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'flex'
+
+INDEX_NAME     = 'flex_test_index'
+TMP_INDEX_NAME = 'flex_tmp_test_index'
+
+INDEX_NAME_1   = 'flex_test_index_1'
+INDEX_NAME_2   = 'flex_test_index_2'
+
+Flex.create_index(:index => INDEX_NAME) unless Flex.exist?(:index => INDEX_NAME)
+Flex.config.variables[:index] = INDEX_NAME
+Flex.reload!

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: flex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Domizio Demichelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: prompter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: irt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.10
+- !ruby/object:Gem::Dependency
+  name: patron
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.18
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+description: ! 'Flex is a complete ruby client for ElasticSearch. It introduces a
+  new way to send any kind of request (not just search queries) to the ES server,
+  and to manage any kind of response. You can transparently integrate it with ActiveRecord
+  and MongoId models with or without automatic synchronization, with or without Rails.
+  It is fast and efficient, easy to use and customize.
+
+'
+email: dd.nexus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- VERSION
+- flex.gemspec
+- lib/flex.rb
+- lib/flex/api_methods.yml
+- lib/flex/class_proxy.rb
+- lib/flex/configuration.rb
+- lib/flex/errors.rb
+- lib/flex/http_clients/patron.rb
+- lib/flex/http_clients/rest_client.rb
+- lib/flex/loader.rb
+- lib/flex/logger.rb
+- lib/flex/model.rb
+- lib/flex/model/class_proxy.rb
+- lib/flex/model/instance_proxy.rb
+- lib/flex/model/manager.rb
+- lib/flex/rails.rb
+- lib/flex/rails/engine.rb
+- lib/flex/rails/helper.rb
+- lib/flex/related_model.rb
+- lib/flex/related_model/class_proxy.rb
+- lib/flex/related_model/class_sync.rb
+- lib/flex/related_model/instance_proxy.rb
+- lib/flex/result.rb
+- lib/flex/result/bulk.rb
+- lib/flex/result/collection.rb
+- lib/flex/result/document.rb
+- lib/flex/result/indifferent_access.rb
+- lib/flex/result/search.rb
+- lib/flex/result/source_document.rb
+- lib/flex/result/source_search.rb
+- lib/flex/structure/indifferent_access.rb
+- lib/flex/structure/mergeable.rb
+- lib/flex/tasks.rb
+- lib/flex/template.rb
+- lib/flex/template/base.rb
+- lib/flex/template/info.rb
+- lib/flex/template/partial.rb
+- lib/flex/template/search.rb
+- lib/flex/template/slim_search.rb
+- lib/flex/template/tags.rb
+- lib/flex/utility_methods.rb
+- lib/flex/utils.rb
+- lib/flex/variables.rb
+- lib/generators/flex/setup/setup_generator.rb
+- lib/generators/flex/setup/templates/flex_config.yml
+- lib/generators/flex/setup/templates/flex_dir/es.rb.erb
+- lib/generators/flex/setup/templates/flex_dir/es.yml.erb
+- lib/generators/flex/setup/templates/flex_dir/es_extender.rb.erb
+- lib/generators/flex/setup/templates/flex_initializer.rb.erb
+- lib/tasks/index.rake
+- test/flex.irt
+- test/flex/configuration.irt
+- test/irt_helper.rb
+homepage: http://github.com/ddnexus/flex
+licenses: []
+post_install_message: ! "________________________________________________________________________________\n\n
+  \                             INSTALLATION NOTES\n________________________________________________________________________________\n\nIn
+  order to use Flex, a supported http-client must be installed on this system.\n\nThe
+  suported http-client gems are \"patron\" and \"rest-client\".\n\nYou should install
+  \"patron\" (a libcurl based gem developed in C) for best\nperformances, or install
+  \"rest-client\" if you cannot use libcurl on your system.\n\nAs an alternative you
+  could eventually develop your own http-client interface\nand set the Flex::Configuration.http_client
+  option.\n\n________________________________________________________________________________\n"
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby Client for ElasticSearch
+test_files: []
+has_rdoc: