db_bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e28f734175b47109f6a295b07ef831ff72dcfafe
+  data.tar.gz: 81c2d563390a6f9a3a4a3d1dfaca2e319a17869e
+SHA512:
+  metadata.gz: d2f6d9ffa8218439018299f0cc692aa92a5b654051a5321db510101b7d1033344fc630245e16df15a065d0761fc2617562192d3eb84cf7568fe94bd4d6f1f5e2
+  data.tar.gz: e3290ac11e9e1eb5f259c7b12365205a04d05dfdc9fb2274605cf3060f2ae704c7ebc6653fecc91fd9f26f3c431cf424c4ffc0dc01cf545a3a2e31fdc60dc2ac

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dawilster143@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 William Porter
+
+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,56 @@
+# Bot
+
+DB Bot uses Natural Language Processing (NLP) to construct DB queries. What that means is you can interact with your database like you're talking to a human  
+**Here's an example**
+
+```ruby
+> bot = DbBot.message('How many users signed up this week?')
+> bot.response
+=> "5 users"
+> bot = DbBot.message('Find the last 10 users') 
+> bot.response
+=> "There you go"
+> bot.collection
+=> #<ActiveRecord::Relation [#<User id: 1...
+```
+It's rather basic at the moment but I'm working on incorporating more complex database queries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'db_bot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install db_bot
+
+## Getting Started
+The only thing you'll need to do after installing `db_bot` is add our **Wit.ai** access token. This gives you access to all the language rules. You can view our project here https://wit.ai/dawilster/db_bot. 
+
+```
+WIT_ACCESS_TOKEN=M4GJHCDJLSI34OTZW5M4NPP672IR3UOS
+```
+
+Then you can jump in and asks questions like. 
+```ruby
+> DbBot.message('How many users signed up last week?')
+> DbBot.message('Display the 50 most recent sales')
+> DbBot.message('How many sales does the item with id 103 have?') (coming soon)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dawilster/db_bot. 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](http://opensource.org/licenses/MIT).
+

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 "bot"
+
+# 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

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/db_bot.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db_bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "db_bot"
+  spec.version       = DbBot::VERSION
+  spec.authors       = ["William Porter"]
+  spec.email         = ["willports@gmail.com"]
+  spec.summary       = "Bot to interact with your database using plain english"
+  spec.description   = "DB Bot uses Natural Language Processing (NLP) to construct DB queries. What that means is you can interact with your database like you're talking to a human"
+  spec.homepage      = "https://github.com/dawilster"
+  spec.license       = "MIT"
+
+  # 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"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 4.2.0"
+  spec.add_dependency "activesupport", "~> 4.2.0"
+  spec.add_dependency "wit", "~> 4.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-activemodel-mocks", "~> 1.0"
+  spec.add_development_dependency "awesome_print"
+end

data/lib/db_bot.rb

@@ -0,0 +1,8 @@
+require "db_bot/version"
+require "db_bot/translate"
+
+module DbBot
+  def self.message(message)
+    Translate.perform(message)
+  end
+end

data/lib/db_bot/translate.rb

@@ -0,0 +1,109 @@
+require 'wit'
+require 'date'
+
+module DbBot
+  class Translate
+
+    attr_accessor :response,
+                  :when,
+                  :table,
+                  :verb,
+                  :query,
+                  :number,
+                  :search_query,
+                  :target_attribute,
+                  :collection
+
+    def self.perform(*args)
+      return new(*args).tap { |use_case| use_case.perform }
+    end
+
+    def initialize(message)
+      @message = message
+    end
+
+    def perform
+      init_wit_client
+
+      construct_entities
+
+      process_verb
+
+    rescue TranslateException => e
+      @response = e.message
+    end
+
+    private
+
+    def init_wit_client
+      @client = Wit.new(access_token: 'RAS7ZDEPPJCGRTYONX7Q2UP6JOMY4OF2')
+      # @client = Wit.new(access_token: ENV['WIT_ACCESS_KEY'])
+    end
+
+    def construct_entities
+      translation = @client.message(@message)
+      puts entities = translation['entities']
+
+      @table  = entities['table'][0]['value'] if entities['table']
+      @query  = entities['query'][0]['value'] if entities['query']
+      @verb   = entities['verb'][0]['value'] if entities['verb']
+      @when   = ::DateTime.parse(entities['datetime'][0]['value']) if entities['datetime']
+      @number = entities['number'][0]['value'] if entities['number']
+      @target_attribute = entities['target_attribute'][0]['value'] if entities['target_attribute']
+      @search_query = entities['search_query'][0]['value'] if entities['search_query']
+    end
+
+    def process_verb
+      case @verb
+      when 'count'
+        if @table && @query
+          return count_verb
+        end
+      when 'return'
+        return return_verb
+      end
+
+      @response = "Please try again"
+    end
+
+    ## Verbs
+
+    def count_verb
+      find_class
+
+      if @when
+        @response = @class.where('created_at >= ?', @when).size.to_s
+      else
+        @response = @class.all.size.to_s
+      end
+    end
+
+    def return_verb
+      find_class
+
+      if @target_attribute
+        @collection = @class.where(@target_attribute.to_sym => @search_query)
+      else
+        @collection = @class.limit(@number || 100)
+      end
+
+      if @collection.any?
+        @response = 'There you go'
+      else
+        @response = "There weren't any #{@table}"
+      end
+    end
+
+    ## Helpers
+
+    def find_class
+      @class = @table.singularize.camelize.constantize
+
+    rescue NameError
+      raise TranslateException, 'Class cannot be found'
+    end
+
+    ## Our own exception
+    class TranslateException < StandardError; end
+  end
+end

data/lib/db_bot/version.rb

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

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: db_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William Porter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: wit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec-activemodel-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+description: DB Bot uses Natural Language Processing (NLP) to construct DB queries.
+  What that means is you can interact with your database like you're talking to a
+  human
+email:
+- willports@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db_bot.gemspec
+- lib/db_bot.rb
+- lib/db_bot/translate.rb
+- lib/db_bot/version.rb
+homepage: https://github.com/dawilster
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1
+signing_key: 
+specification_version: 4
+summary: Bot to interact with your database using plain english
+test_files: []