witai-charyf 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bdb9e479da32a198798e5f5f75a37051f3b6373
-  data.tar.gz: cfaec1ce78a70a836d4d2df6a319c54d152c7b6a
+  metadata.gz: 21b73b62decb583d09e7ec92651ec8bb79bf2073
+  data.tar.gz: 98137080809ae25d5874afefb8823640da226aaa
 SHA512:
-  metadata.gz: 9359a1eaae707dd76b64112bec3dbe03c6530100c94198966a35048ea76d49027ce08c9cbc199819e3e1d4f723575c4218ed93a8728a90615670942cab7a2316
-  data.tar.gz: eabd2d18f413e457e9c92f60e706d11d3bda511970b6ab9ee7ff01ab161b7373e9a9c0df786ec761bc811410959f3dd8955b04991f09627866fe7935d6c32e4b
+  metadata.gz: 63114f7199fb2432f0ec885060069b589cacd14f552dab3d1b0c602881677b2c772ffb2900e7bc556c40991c941566c162600d7548315537ab4c192ecae04d5c
+  data.tar.gz: 3b03e7e82f1136abd3fdceb70d88eb1e4b7b8efe1ad8979627d1b235f9e62355bf6ae8248c17c03749a6232c2a62c63ab07ddde4c5bbdd7d02f6c0d7147534e0

data/.gitignore

@@ -10,4 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
-.idea
+.idea
+.rvmrc

data/README.md

@@ -6,33 +6,48 @@ TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+### New application
+When generating new charyf app, you can install wit intent processor automatically by specifying
+``charyf new [app_nane] --intent-processors=wit``
 
+### Existing application
+
+To install wit processor to existing charyf application
+Add gem to your gemfile
 ```ruby
-gem 'wit-nlp-charyf'
+gem 'adapt-charyf', '>= 0.2.4'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+Edit *enabled_intent_processors* inside *config/application.rb*
+```ruby
+ config.enabled_intent_processors = [:wit, etc...]
+```
 
-    $ gem install wit-nlp-charyf
+Add the require inside inside *config/load.rb*
+```ruby
+require 'witai/charyf'
+```
 
-## Usage
+### Configure
 
-TODO: Write usage instructions here
+If you dont set your api keys for wit application, the initialization will throw  
+``/Users/rycco/.rvm/gems/ruby-2.2.2@charyf/gems/witai-charyf-0.2.0/lib/witai/charyf/processor.rb:18:in `initialize': WitAI::Charyf.api_key has not been set (WitAI::Charyf::Processor::NoKeyProvided)``
 
-## Development
+To configure create file *config/initializers/witai.rb* and set the API key
+```ruby
+require 'witai/charyf'
 
-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.
+WitAI::Charyf::Extension.configure do
+  config.api_key = 'SOME_CLIENT_API_KEY'
+end     
+```
 
-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).
+## Usage
 
-## Contributing
+To define intent visit http://wit.ai/ and define an intent and entities inside your application.
+Don't forget to wait for training to finish.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wit-nlp-charyf. 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.
+Define routing as usually using *config/routes.rb*
 
 ## License
 

data/lib/witai/charyf.rb

@@ -7,6 +7,10 @@ module WitAI
   module Charyf
     class Extension < ::Charyf::Extension
 
+      generators do
+        require_relative 'charyf/generators/install/install_generator'
+      end
+
       config.api_key = nil
 
     end

data/lib/witai/charyf/generators/install/install_generator.rb

@@ -0,0 +1,27 @@
+require 'charyf/utils/generator/base'
+
+module WitAI
+  module Charyf
+    module Generators
+      class InstallGenerator < ::Charyf::Generators::Base
+
+        source_root File.expand_path('templates', __dir__)
+
+        namespace 'witai:install'
+
+        def initializer
+          template 'config/initializers/wit.rb.tt'
+        end
+
+        def finalize
+          return unless behavior == :invoke
+
+          say_status 'notice', "Wit installed" +
+              "\n\t\tDo not forget to set adapt intent processor in application configuration" +
+              "\n\t\t\tconfig.enabled_intent_processors = [.., :wit, ..]", :green
+        end
+
+      end
+    end
+  end
+end

data/lib/witai/charyf/generators/install/templates/config/initializers/wit.rb.tt

@@ -0,0 +1,8 @@
+WitAI::Charyf::Extension.configure do
+  # Set to you Wit.AI App API Key
+  # As charyf uses wit only to determine intent you can use
+  # either server or client key
+  #
+  # config.api_key = 'PUMSOASDDB43HCJ3OMBOXKEENOOS92WDI6'
+  # PS: The key above is made up :)
+end

data/lib/witai/charyf/version.rb

@@ -1,5 +1,5 @@
 module WitAI
   module Charyf
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: witai-charyf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Richard Ludvigh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-30 00:00:00.000000000 Z
+date: 2018-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: charyf
@@ -112,6 +112,8 @@ files:
 - bin/console
 - bin/setup
 - lib/witai/charyf.rb
+- lib/witai/charyf/generators/install/install_generator.rb
+- lib/witai/charyf/generators/install/templates/config/initializers/wit.rb.tt
 - lib/witai/charyf/processor.rb
 - lib/witai/charyf/version.rb
 - witai-charyf.gemspec