es_importer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 128cea52bee57453bd7676e12976bfcdf910aa54
+  data.tar.gz: b2017bf956da03ee8e37fe55a5b62a4021d8bbcd
+SHA512:
+  metadata.gz: bbe4876a6d400599f8b7ed3561c71f9171fcd3b182975df57633dff793fbf6b50bb8a15293c3c084b1f22b76a94592353e67cfce96528a3bd9b02ee079fff2b3
+  data.tar.gz: add933d42aaae36fbe2f0a6a7a2f714706c1aa5c8ac29fd97606ca9eed633906aa075a8147ca9f8ad91aa36212f58441e061bd1e72ca2df344560ba313d66649

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at damir.roso@nih.gov. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in es_importer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    es_importer (0.1.0)
+      aws-sdk
+      elasticsearch
+      faraday
+      faraday_middleware
+      faraday_middleware-aws-signers-v4
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (2.10.105)
+      aws-sdk-resources (= 2.10.105)
+    aws-sdk-core (2.10.105)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.10.105)
+      aws-sdk-core (= 2.10.105)
+    aws-sigv4 (1.0.2)
+    diff-lcs (1.3)
+    elasticsearch (6.0.2)
+      elasticsearch-api (= 6.0.2)
+      elasticsearch-transport (= 6.0.2)
+    elasticsearch-api (6.0.2)
+      multi_json
+    elasticsearch-transport (6.0.2)
+      faraday
+      multi_json
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    faraday_middleware-aws-signers-v4 (0.1.9)
+      aws-sdk-resources (>= 2, < 3)
+      faraday (~> 0.9)
+    ffi (1.9.23)
+    jmespath (1.3.1)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  es_importer!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Damir Roso
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# Elasticsearch importer
+Transform and import JSON documents into elastic search. Configure indices and transformations with ruby hash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'es_importer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install es_importer
+
+## Usage
+
+See inline coments:
+
+```ruby
+require 'es_importer'
+
+# configure client
+EsImporter.configure('http://localhost:9200')
+
+# generate some users
+users = (1..100).to_a.map do |i|
+  { user_id: i,
+    first_name: 'John',
+    last_name: 'Doe',
+    created_at: Time.now.iso8601,
+    active: true,
+    email: "USER_#{i}@example.com",
+    country_code: 'US',
+    friends: {
+      US: ['Joe']
+    }
+  }
+end
+
+# define elastic id, mapping and keywords for index; provide conversion procs
+importer = {
+
+  # name of the index
+  users: {
+
+  # build id from single or multiple keys
+  id_key: [:user_id, :created_at],
+
+  # define index mapping
+  mapping: {
+    user_id: :text,
+    active: :boolean,
+    email: :text,
+    created_at: :date,
+    country_code: :text
+  },
+
+  # keyword generated is 'country_code.keyword'
+  keywords: [:country_code],
+
+  converters: {
+    # downcase existing field value, second argument is document being processed
+    'email' => Proc.new{|attr, _| attr.downcase},
+
+    # add new entry to array under existing nested key
+    'friends.US' => Proc.new{|attr| attr << 'Marry'},
+
+    # generate new key with composite value
+    'full_name' => Proc.new{|doc| "#{doc['first_name']} #{doc['last_name']}"},
+
+    # generate new nested key as array
+    'profile.emails' => Proc.new{|doc| [doc['email']]}
+    }
+  }
+}
+
+# register importer
+EsImporter.add_importer(importer)
+
+# create index
+EsImporter.create_index!(:users)
+
+# import users
+EsImporter.import(:users, users)
+
+#  delete index
+EsImporter.delete_index!(:users)
+
+```
+
+AWS elastic instance is also supported, region is extracted from url and credentials are set form ruby SDK.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/es_importer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EsImporter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/es_importer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "es_importer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/es_importer.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "es_importer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "es_importer"
+  spec.version       = EsImporter::VERSION
+  spec.authors       = ["Damir Roso"]
+  spec.email         = ["damir.roso@nih.gov"]
+
+  spec.summary       = %q{Transform and import JSON documents into elastic search.}
+  spec.description   = %q{Configure indices and transformations with ruby hash.}
+  spec.homepage      = "https://github.com/damir/es_importer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'aws-sdk'
+  spec.add_dependency 'elasticsearch'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'faraday_middleware-aws-signers-v4'
+  spec.add_dependency 'typhoeus'
+end

data/lib/es_importer/version.rb

@@ -0,0 +1,3 @@
+module EsImporter
+  VERSION = "0.1.0"
+end

data/lib/es_importer.rb

@@ -0,0 +1,148 @@
+require "es_importer/version"
+require 'elasticsearch'
+
+module EsImporter
+
+  extend self
+
+  # configure state and return es client
+  def configure(uri, logger: nil)
+    @importers    = {}
+    @logger       = logger
+    @es_uri       = uri
+    @client       = Elasticsearch::Client.new transport: transport
+  end
+
+  # init es transport
+  def transport
+    # parse uri for host configuration
+    es_uri = URI.parse(@es_uri)
+    host_config = {host: es_uri.host, port: es_uri.port, scheme: es_uri.scheme}
+
+    # aws support
+    if is_amazon_uri = es_uri.host.include?('es.amazonaws.com')
+      require 'aws-sdk'
+      require 'faraday_middleware/aws_signers_v4'
+      aws_region = es_uri.host.split('.')[-4]
+      credentials = Aws::ElasticsearchService::Client.new(region: aws_region).instance_eval{@config.credentials}
+    end
+
+    faraday_config = lambda do |faraday|
+      # sign for aws
+      faraday.request :aws_signers_v4,
+          { credentials: credentials,
+            service_name: 'es',
+            region: aws_region} if is_amazon_uri
+      faraday.headers['Content-Type'] = 'application/json'
+      faraday.adapter :typhoeus
+    end
+    Elasticsearch::Transport::Transport::HTTP::Faraday.new(hosts: [host_config], &faraday_config)
+  end
+
+  # save importer
+  def add_importer(importer)
+    @importers.update(importer)
+  end
+
+  # create es index
+  def create_index!(es_index)
+    puts "Creating #{es_index} index at #{@es_uri} ..."
+    @client.indices.create index: es_index, body: {
+      mappings: {
+        es_index.to_s.chomp('s') => {
+          dynamic: false,
+          properties: @importers.dig(es_index, :mapping).reduce({}){|a, (k,v)| a.update({k => {type: v}.update(@importers.dig(es_index, :keywords)&.include?(k) ? {fields: {keyword: {type: :keyword}}} : {})})}
+        }
+      }
+    }
+    rescue => error
+      puts "Error creating #{es_index} index. #{error.class}: #{error.message}"
+      raise
+  end
+
+  # create es index
+  def delete_index!(es_index)
+    puts "Deleting #{es_index} index at #{@es_uri} ..."
+    @client.indices.delete index: es_index
+    rescue => error
+      puts "Error deleting #{es_index} index. #{error.class}: #{error.message}"
+      raise
+  end
+
+  # import documents
+  def import(es_index, documents)
+
+    # import stats init
+    start_time = Time.now
+    failed = 0; imported = 0
+
+    # insert into elastic
+    documents.each_with_index do |document, index|
+
+      # convert all keys to strings
+      document =  _deep_transform_keys_in_object(document, &:to_s)
+
+      # generate id
+      id_key  = @importers.dig(es_index, :id_key)
+      id      = document[id_key.to_s] if id_key.is_a?(Symbol) # single key
+      id      = id_key.reduce([]){|acc, key| acc << document[key.to_s]}.join('-') if id_key.is_a?(Array) # composite key
+
+      # convert keys or add new ones
+      @importers.dig(es_index, :converters)&.each do |keys, converter|
+        keys = keys.split('.')
+
+        # transform existing key
+        if value = document.dig(*keys)
+          document[keys.first] = converter.call(value, document) if keys.size == 1 # lvl 1
+          keys.first(keys.size-1).reduce(document, :fetch)[keys.last] = converter.call(value, document) if keys.size > 1 # lvl > 1
+
+        # add new key
+        else
+          missing_key_index = nil
+          keys.each_with_index do |key, index|
+            missing_key_index = index and break unless document.dig(*keys.first(index + 1))
+          end
+
+          tail_keys = keys[missing_key_index..-1]
+          tail_hash = keys[0...missing_key_index].reduce(document, :fetch)
+
+          tail_keys.each_with_index do |key, index|
+            tail_hash[tail_keys[index]] = tail_keys.size == index + 1 ? converter.call(document) : {}
+            tail_hash = tail_hash[tail_keys[index]]
+          end
+        end
+      end
+
+      begin
+        @client.index index: es_index, type: es_index.to_s.chomp('s'), id: id, body: document
+        puts "##{index + 1} imported #{id}" if @logger
+        imported = imported + 1
+      rescue => e
+        puts "##{index + 1} failed #{id}" if @logger
+        puts e.class; puts e.message
+        failed = failed + 1
+      end
+    end
+
+    # print import statistics
+    puts; puts "#{es_index} import statistics"; puts '-' * 100
+    puts "Failed: #{failed}"
+    puts "Imported: #{imported}"
+    puts "Time spent: #{Time.now - start_time} sec"
+    puts
+  end
+
+  # taken from https://github.com/rails/rails/blob/f213e926892020f9ab6c8974612c59e2ba959253/activesupport/lib/active_support/core_ext/hash/keys.rb#L145
+  def _deep_transform_keys_in_object(object, &block)
+    case object
+    when Hash
+      object.each_with_object({}) do |(key, value), result|
+        result[yield(key)] = _deep_transform_keys_in_object(value, &block)
+      end
+    when Array
+      object.map { |e| _deep_transform_keys_in_object(e, &block) }
+    else
+      object
+    end
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: es_importer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damir Roso
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware-aws-signers-v4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Configure indices and transformations with ruby hash.
+email:
+- damir.roso@nih.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- es_importer.gemspec
+- lib/es_importer.rb
+- lib/es_importer/version.rb
+homepage: https://github.com/damir/es_importer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Transform and import JSON documents into elastic search.
+test_files: []