neuromancer-indexer 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bfeb244c643ecd7751c471d2bcfa6c0c2d83f3ca
-  data.tar.gz: 474fe0b12cb2600926689dd5355299f60e52249f
+SHA256:
+  metadata.gz: f76b29711a1de358acaadfe86774796d81d912133e67d65b03cc5a3cbf622cd8
+  data.tar.gz: 3bf9160dfe06c129eac287f74ff4ac6d6823eb942103e96828034ab3f888ee28
 SHA512:
-  metadata.gz: 4f724edc9577bf9053691caefdc4fc27e880ca59bc30b77c8be5618b1d76ac8fa427a4045770e6f919eb7728bb0a543f6606b8b93ad3d830a5e0bdd66d215b94
-  data.tar.gz: d9e4476c2542d9fd38329c10a0b9a3cf36c6ab140212e818c3643d7cb0ab2339eb0ec75e2a9af7be741697849958c5d4c7228c8c8caf45b7f641e17d752089e0
+  metadata.gz: fb394dd151dfa324bfe5825e32f49a2793e1fc180cc277c3121a1f8e99cc5a4c0849199dbc0401df630413e901c16574c8a15c8e564304c2e3128a1f3abb28e6
+  data.tar.gz: 8af32893e9d39ff3afc76227e4fba269d9bdb2b46399846dda0423b9020896044b31706ec50c8d5b4adb73c0d823c43b040608bff1ede779c1f0686eeff3d4b3

data/.github/workflows/ruby-gems.yml

@@ -0,0 +1,46 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  ruby-gem:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install
+
+      - name: Push to GitHub Package Repository
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+          OWNER: ${{ github.repository_owner }}
+
+      - name: Push to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+
+name: Tests
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install
+      - name: Run RSpec
+        run: bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install
+      - name: Run Rubocop
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,56 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'bin/*'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+    - 'spec/**/*'
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+#### 0.4.2
+- add `Neuromancer::Indexer.delete`
+- add GitHub workflows for `RSpec`, `Rubocop` and `RubyGems`
+
 #### 0.3.0
 - optionally use AWS user credentials for SQS instead of role credentials
 

data/README.md

@@ -1,6 +1,6 @@
 # neuromancer-indexer
 
-[![Build Status](https://travis-ci.com/jdahlke/neuromancer-indexer.svg?branch=develop)](https://travis-ci.com/jdahlke/neuromancer-indexer)
+[![GitHub Actions Test Status](https://github.com/jdahlke/neuromancer-indexer/workflows/Tests/badge.svg?branch=develop)](https://github.com/jdahlke/neuromancer-indexer/actions)
 
 Ruby gem to push data for indexing to the Neuromancer service
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rspec/core'

data/{Gemfile.lock → gems.locked}

@@ -7,6 +7,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
     aws-eventstream (1.0.3)
     aws-partitions (1.226.0)
     aws-sdk-core (3.69.1)
@@ -21,7 +22,13 @@ GEM
       aws-eventstream (~> 1.0, >= 1.0.2)
     diff-lcs (1.3)
     jmespath (1.4.0)
-    rake (10.5.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -35,15 +42,29 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17.3)
+  bundler
   neuromancer-indexer!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop (= 0.86.0)
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/{Gemfile → gems.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in neuromancer-indexer.gemspec

data/lib/neuromancer/indexer.rb

@@ -1,13 +1,36 @@
 # frozen_string_literal: true
 
+require 'json'
+require 'aws-sdk-sqs'
+
 require 'neuromancer/indexer/version'
 require 'neuromancer/indexer/client'
+require 'neuromancer/indexer/document'
 require 'neuromancer/indexer/configuration'
 
 module Neuromancer
   module Indexer
-    class Error < StandardError; end
-    class ConfigurationError < Error; end
+    class Error < StandardError
+    end
+
+    class ConfigurationError < Error
+    end
+
+    class InvalidDocument < Error
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+      end
+
+      def message
+        errors.join(', ')
+      end
+
+      def inspect
+        "#<#{self.class.name}: '#{message}'>"
+      end
+    end
 
     def self.config
       @config ||= Configuration.new
@@ -20,9 +43,16 @@ module Neuromancer
       config
     end
 
-    def self.index(obj)
+    def self.client
       @client ||= Client.new
-      @client.index(obj)
+    end
+
+    def self.index(obj)
+      client.index(obj)
+    end
+
+    def self.delete(obj)
+      client.delete(obj)
     end
   end
 end

data/lib/neuromancer/indexer/client.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'aws-sdk-sqs'
-
 module Neuromancer
   module Indexer
     class Client
@@ -13,15 +10,31 @@ module Neuromancer
         @sqs = sqs
       end
 
-      def index(obj)
-        message = obj.to_json
-        validate_message!(message)
+      def index(id:, type:, body:)
+        document = Document.new(id: id, type: type, body: body)
+        document.validate!
+
+        enqueue(action: 'index', document: document)
+      end
+
+      def delete(id:, type:)
+        document = Document.new(id: id, type: type, body: {})
+        document.validate!
 
-        sqs.send_message({
+        enqueue(action: 'delete', document: document)
+      end
+
+      def enqueue(action:, document:)
+        message = {
+          action: action,
+          document: document
+        }
+
+        sqs.send_message(
           queue_url: config.sqs_url,
-          message_body: message,
+          message_body: message.to_json,
           delay_seconds: 1
-        })
+        )
       end
 
       private
@@ -34,7 +47,7 @@ module Neuromancer
         options = {
           region: config.region
         }
-        if config.access_key_id && config.secret_access_key
+        if present?(config.access_key_id) && present?(config.secret_access_key)
           options[:credentials] = Aws::Credentials.new(
             config.access_key_id,
             config.secret_access_key
@@ -44,23 +57,11 @@ module Neuromancer
         options
       end
 
-      def validate_message!(message)
-        hash = JSON.parse(message)
-        id = hash['id'].to_s
-        type = hash['type'].to_s
-        body = hash['body']
-
-        if id.empty?
-          raise Error, 'Key `id` in obj cannot be empty'
-        end
-
-        if type.empty?
-          raise Error, 'Key `type` in obj cannot be empty'
-        end
+      def present?(value)
+        return false if value.nil?
+        return false if value.empty?
 
-        if !body.is_a?(Hash)
-          raise Error, 'Key `body` must be a Hash'
-        end
+        true
       end
     end
   end

data/lib/neuromancer/indexer/configuration.rb

@@ -14,23 +14,17 @@ module Neuromancer
       end
 
       def validate!
-        if region.to_s.empty?
-          raise ConfigurationError, '`region` cannot be empty'
-        end
+        raise ConfigurationError, '\'region\' cannot be empty' if region.to_s.empty?
 
-        if sqs_url.to_s.empty?
-          raise ConfigurationError, '`sqs_url` cannot be empty'
-        end
+        raise ConfigurationError, '\'sqs_url\' cannot be empty' if sqs_url.to_s.empty?
 
+        invalid_protocol = '\'sqs_url\' must be a HTTPS url'
         begin
-          if URI(sqs_url).scheme != 'https'
-            raise ConfigurationError, '`sqs_url` must be a HTTPS url'
-          end
-        rescue => e
-          raise ConfigurationError, '`sqs_url` must be a HTTPS url'
+          raise ConfigurationError, invalid_protocol if URI(sqs_url).scheme != 'https'
+        rescue StandardError
+          raise ConfigurationError, invalid_protocol
         end
       end
     end
   end
 end
-

data/lib/neuromancer/indexer/document.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Neuromancer
+  module Indexer
+    class Document
+      attr_reader :id, :type, :body
+
+      def initialize(attributes)
+        @id = indifferent_value(attributes, :id).to_s
+        @type = indifferent_value(attributes, :type).to_s
+        @body = indifferent_value(attributes, :body)
+      end
+
+      def as_json
+        {
+          id: id,
+          type: type,
+          body: body
+        }
+      end
+
+      def validate!
+        errors = []
+
+        errors << 'document#id is empty' if id.empty?
+        errors << 'document#type is empty' if type.empty?
+        errors << 'document#body is not a Hash' unless body.is_a?(Hash)
+
+        raise(InvalidDocument, errors) unless errors.empty?
+      end
+
+      def indifferent_value(hash, key)
+        hash[key.to_sym] || hash[key.to_s]
+      end
+    end
+  end
+end

data/lib/neuromancer/indexer/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Neuromancer
   module Indexer
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.2'
   end
 end

data/neuromancer-indexer.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'neuromancer/indexer/version'
@@ -12,19 +14,6 @@ Gem::Specification.new do |spec|
   spec.description   = 'Ruby gem to push data for indexing to the Neuromancer service.'
   spec.homepage      = 'https://github.com/jdahlke/neuromancer-indexer'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = 'https://github.com/jdahlke/neuromancer-indexer'
-    spec.metadata['changelog_uri'] = 'https://github.com/jdahlke/neuromancer-indexer/blob/master/CHANGELOG.md'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -36,7 +25,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'aws-sdk-sqs'
 
-  spec.add_development_dependency 'bundler', '~> 1.17.3'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '0.86.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neuromancer-indexer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Joergen Dahlke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -26,18 +26,32 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.86.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.86.0
 description: Ruby gem to push data for indexing to the Neuromancer service.
 email:
 - joergen.dahlke@infopark.de
@@ -73,30 +87,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby-gems.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- gems.locked
+- gems.rb
 - lib/neuromancer-indexer/rspec.rb
 - lib/neuromancer/indexer.rb
 - lib/neuromancer/indexer/client.rb
 - lib/neuromancer/indexer/configuration.rb
+- lib/neuromancer/indexer/document.rb
 - lib/neuromancer/indexer/version.rb
 - neuromancer-indexer.gemspec
 homepage: https://github.com/jdahlke/neuromancer-indexer
 licenses: []
-metadata:
-  allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/jdahlke/neuromancer-indexer
-  source_code_uri: https://github.com/jdahlke/neuromancer-indexer
-  changelog_uri: https://github.com/jdahlke/neuromancer-indexer/blob/master/CHANGELOG.md
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -113,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Ruby gem to push data for indexing to the Neuromancer service.

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.1.10
-  - 2.3.8
-  - 2.5.5
-before_install:
-  - gem install bundler -v 1.17.3
-script:
-  - bundle exec rake spec