xip 0.0.1 → 2.0.0.beta2

data/spec/lock_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe "Xip::Lock" do
+  let(:session_id) { SecureRandom.hex(14) }
+  let(:session_slug) { 'hello->say_hello' }
+
+  before(:each) do
+    Xip.config.lock_autorelease = 30
+  end
+
+  describe "create" do
+    it "should raise an ArgumentError if the session_slug was not provided" do
+      lock = Xip::Lock.new(session_id: session_id)
+      expect {
+        lock.create
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should save the lock using a canonical key and value" do
+      lock = Xip::Lock.new(session_id: session_id, session_slug: session_slug)
+      canonical_key = "#{session_id}-lock"
+      expected_value = "#{lock.tid}##{session_slug}"
+      lock.create
+      expect($redis.get(canonical_key)).to eq expected_value
+    end
+
+    it "should include the reply file position in the lock" do
+      lock = Xip::Lock.new(
+        session_id: session_id,
+        session_slug: session_slug,
+        position: 3
+      )
+      canonical_key = "#{session_id}-lock"
+      expected_value = "#{lock.tid}##{session_slug}:3"
+      lock.create
+      expect($redis.get(canonical_key)).to eq expected_value
+    end
+
+    it "should set the lock expiration to lock_autorelease" do
+      lock = Xip::Lock.new(session_id: session_id, session_slug: session_slug)
+      canonical_key = "#{session_id}-lock"
+      expected_value = "#{lock.tid}##{session_slug}"
+      lock.create
+      expect($redis.ttl(canonical_key)).to be_between(1, 30).inclusive
+    end
+  end
+
+  describe "release" do
+    it "should delete the key in Redis" do
+      lock = Xip::Lock.new(session_id: session_id, session_slug: session_slug)
+      canonical_key = "#{session_id}-lock"
+      lock.create
+      expect($redis.get(canonical_key)).to_not be_nil
+      lock.release
+      expect($redis.get(canonical_key)).to be_nil
+    end
+  end
+
+  describe "slug" do
+    it "should return the lock slug from Redis" do
+      lock = Xip::Lock.new(session_id: session_id, session_slug: session_slug)
+      lock.create
+      canonical_key = "#{session_id}-lock"
+      expect(lock.slug).to eq "#{lock.tid}##{session_slug}"
+    end
+  end
+
+  describe "flow_and_state" do
+    it "should return a hash containing the flow and state" do
+      lock = Xip::Lock.new(session_id: session_id, session_slug: session_slug)
+      expect(lock.flow_and_state[:flow]).to eq 'hello'
+      expect(lock.flow_and_state[:state]).to eq 'say_hello'
+    end
+  end
+
+  describe "self.find_lock" do
+    it "should load the lock from Redis" do
+      lock_key = "#{session_id}-lock"
+      example_tid = 'ovefhgJvx'
+      example_session = 'goodbye->say_goodbye'
+      example_position = 2
+      example_lock = "#{example_tid}##{example_session}:#{example_position}"
+      $redis.set(lock_key, example_lock)
+
+      lock = Xip::Lock.find_lock(session_id: session_id)
+      expect(lock.tid).to eq example_tid
+      expect(lock.session_slug).to eq example_session
+      expect(lock.position).to eq example_position
+    end
+
+    it "should return nil if the lock is not found" do
+      lock_key = "#{session_id}-lock"
+      lock = Xip::Lock.find_lock(session_id: session_id)
+      expect($redis.get(lock_key)).to be_nil
+      expect(lock).to be_nil
+    end
+  end
+end

data/spec/nlp/client_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe "Xip::Nlp::Client" do
+
+  describe 'blank client' do
+    let(:nlp_client) { Xip::Nlp::Client.new }
+
+    it 'should return nil for client' do
+      expect(nlp_client.client).to be_nil
+    end
+
+    it 'should return nil for the understand call' do
+      expect(nlp_client.understand(query: 'hello world!')).to be_nil
+    end
+
+    it 'should return nil for the understand_speec call' do
+      expect(nlp_client.understand_speech(audio_file: 'https://path.to/audio.mp3')).to be_nil
+    end
+  end
+
+end

data/spec/nlp/result_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe "Xip::Nlp::Result" do
+
+  it 'should return the built-in entity types' do
+    expect(Xip::Nlp::Result::ENTITY_TYPES).to eq %i(number currency email percentage phone age
+                      url ordinal geo dimension temp datetime duration
+                      key_phrase name)
+  end
+
+  describe 'blank result' do
+    let(:xip_result) { Xip::Nlp::Result.new(result: 1234) }
+
+    it 'should initialize @result to the value provided during instantiation' do
+      expect(xip_result.result).to eq 1234
+    end
+
+    it 'should return nil for parsed_result' do
+      expect(xip_result.parsed_result).to be_nil
+    end
+
+    it 'should return nil for intent_id' do
+      expect(xip_result.intent_id).to be_nil
+    end
+
+    it 'should return nil for intent' do
+      expect(xip_result.intent).to be_nil
+    end
+
+    it 'should return nil for intent_score' do
+      expect(xip_result.intent_score).to be_nil
+    end
+
+    it 'should return {} for raw_entities' do
+      expect(xip_result.raw_entities).to eq({})
+    end
+
+    it 'should return {} for entities' do
+      expect(xip_result.entities).to eq({})
+    end
+
+    it 'should return nil for sentiment' do
+      expect(xip_result.sentiment).to be_nil
+    end
+
+    it 'should return nil for sentiment_score' do
+      expect(xip_result.sentiment_score).to be_nil
+    end
+
+    it 'should return false for present?' do
+      expect(xip_result.present?).to be false
+    end
+  end
+
+end

data/spec/replies/hello.yml.erb

@@ -0,0 +1,15 @@
+- reply_type: text
+  text: "Hi, <%= first_name %>. Welcome to Xip bot..."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "What do you think of our bot?"
+  buttons:
+    - text: "Cool"
+      payload: cool
+    - text: "Show me more"
+      payload: more

data/spec/replies/messages/say_hola.yml+facebook.erb

@@ -0,0 +1,6 @@
+- reply_type: text
+  text: "Hi, Facebook. Welcome to Xip bot..."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."

data/spec/replies/messages/say_hola.yml+twilio.erb

@@ -0,0 +1,6 @@
+- reply_type: text
+  text: "Hi, Twilio. Welcome to Xip bot..."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."

data/spec/replies/messages/say_hola.yml.erb

@@ -0,0 +1,6 @@
+- reply_type: text
+  text: "Hi, Morty. Welcome to Xip bot..."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."

data/spec/replies/messages/say_howdy_with_dynamic.yml

@@ -0,0 +1,79 @@
+- reply_type: delay # position 0
+  duration: dynamic
+- reply_type: text
+  text: "Lorem ipsum dolor sit amet posuere."
+- reply_type: delay # position 2
+  duration: dynamic
+- reply_type: text
+  text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin in lobortis ante. Duis elementum lacus sit amet volutpat."
+- reply_type: delay  # position 4
+  duration: dynamic
+- reply_type: text
+  text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer quis fermentum arcu, eget maximus metus. Vivamus ante tortor, scelerisque vel laoreet sit amet, sodales in augue. Nam vel quam a tellus mattis vestibulum non a amet."
+  buttons:
+    - text: "Cool"
+      payload: cool
+    - text: "Show me more"
+      payload: more
+- reply_type: delay  # position 6
+  duration: dynamic
+- reply_type: text
+  text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec quis consequat dolor. Suspendisse sed egestas lacus. Nam a viverra risus. Aliquam erat volutpat. Nunc molestie, metus ut cursus varius, purus quam pharetra nisi, sit amet porttitor tellus nisl sit amet est. Nam volutpat id lorem a condimentum. Sed quam mauris, faucibus sed pharetra sed."
+- reply_type: delay  # position 8
+  duration: dynamic
+- reply_type: image
+  text: "https://via.placeholder.com/350x150"
+- reply_type: delay  # position 10
+  duration: dynamic
+- reply_type: video
+  text: "https://via.placeholder.com/350x150"
+- reply_type: delay  # position 12
+  duration: dynamic
+- reply_type: audio
+  text: "https://via.placeholder.com/350x150"
+- reply_type: delay  # position 14
+  duration: dynamic
+- reply_type: file
+  text: "https://via.placeholder.com/350x150"
+- reply_type: delay  # position 16
+  duration: dynamic
+- reply_type: cards
+  sharable: true
+  aspect_ratio: horizontal
+  elements:
+    - title: My App
+      subtitle: Download our app below or visit our website for more info.
+      image_url: "https://my-app.com/app-image.png"
+      buttons:
+        - type: url
+          url: "https://my-app.com"
+          text: 'View'
+          webview_height: 'tall'
+        - type: url
+          url: "https://itunes.apple.com/us/app/my-app"
+          text: 'Download iOS App'
+- reply_type: delay  # position 18
+  duration: dynamic
+- reply_type: list
+  top_element_style: large
+  buttons:
+    - type: payload
+      text: View More
+      payload: view_more
+  elements:
+    - title: Your Daily News Update
+      subtitle: The following stories have been curated just for you.
+      image_url: "https://loremflickr.com/320/240"
+      buttons:
+        - type: url
+          url: "https://news-articles.com/199"
+          text: 'View'
+          webview_height: 'tall'
+    - title: Breakthrough in AI
+      subtitle: Major breakthrough in the AI space.
+      image_url: "https://loremflickr.com/320/320"
+      default_action:
+        - url: "https://news-articles.com/232"
+          webview_height: 'tall'
+- reply_type: delay  # position 20
+  duration: dynamic

data/spec/replies/messages/say_msgs_without_breaks.yml

@@ -0,0 +1,4 @@
+- reply_type: text
+  text: "Hi, Morty. Welcome to Xip bot..."
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."

data/spec/replies/messages/say_offer.yml

@@ -0,0 +1,6 @@
+- reply_type: text
+  text: "Hi, Morty. Welcome to Xip bot..."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."

data/spec/replies/messages/say_offer_with_dynamic.yml

@@ -0,0 +1,6 @@
+- reply_type: text
+  text: "Hi, Morty. Welcome to Xip bot..."
+- reply_type: delay
+  duration: dynamic
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."

data/spec/replies/messages/say_oi.yml.erb

@@ -0,0 +1,15 @@
+- reply_type: text
+  text: "Hi, <%= @first_name %>. Welcome to Xip bot..."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "What do you think of our bot?"
+  buttons:
+    - text: "Cool"
+      payload: cool
+    - text: "Show me more"
+      payload: more

data/spec/replies/messages/say_randomize_speech.yml

@@ -0,0 +1,10 @@
+- reply_type: speech
+  text:
+    - Build amazing chatbots with tools you know and love.
+    - Xip is an open source Ruby framework for voice and text chatbots.
+    - From our MVC architecture to our convention over configuration philosophy, you'll feel right at home with Xip.
+    - Every service integration in Xip is a Ruby gem.
+    - From web servers to continuous integration testing, Xip is built to take advantage of all the great work done by the web development community.
+    - Xip is a Rack application.
+    - Xip already powers bots for large, well-known brands.
+    - Xip is MIT licensed to ensure you own your bot.

data/spec/replies/messages/say_randomize_text.yml

@@ -0,0 +1,10 @@
+- reply_type: text
+  text:
+    - Build amazing chatbots with tools you know and love.
+    - Xip is an open source Ruby framework for voice and text chatbots.
+    - From our MVC architecture to our convention over configuration philosophy, you'll feel right at home with Xip.
+    - Every service integration in Xip is a Ruby gem.
+    - From web servers to continuous integration testing, Xip is built to take advantage of all the great work done by the web development community.
+    - Xip is a Rack application.
+    - Xip already powers bots for large, well-known brands.
+    - Xip is MIT licensed to ensure you own your bot.

data/spec/replies/messages/say_yo.yml

@@ -0,0 +1,6 @@
+- reply_type: text
+  text: "Yo, Morty! Welcome to Xip bot..."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."

data/spec/replies/messages/say_yo.yml+twitter

@@ -0,0 +1,6 @@
+- reply_type: text
+  text: "Yo, Morty from Twitter! Welcome to Xip bot..."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."

data/spec/replies/messages/sub1/sub2/say_nested.yml

@@ -0,0 +1,10 @@
+- reply_type: text
+  text: "Hi, Morty. Welcome to Xip bot..."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: "This reply was nested."

data/spec/reply_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe "Xip::Reply" do
+
+  let!(:unstructured_text) {
+    { 'reply_type' => 'text', 'text' => 'Hello World!' }
+  }
+  let!(:unstructured_delay) {
+    { 'reply_type' => 'delay', 'duration' => 'dynamic' }
+  }
+  let(:text_reply) { Xip::Reply.new(unstructured_reply: unstructured_text) }
+  let(:delay_reply) { Xip::Reply.new(unstructured_reply: unstructured_delay) }
+
+  describe 'hash-like [] getter' do
+    it 'should return the values' do
+      expect(text_reply['text']).to eq 'Hello World!'
+      expect(delay_reply['duration']).to eq 'dynamic'
+    end
+  end
+
+  describe 'hash-like []= setter' do
+    it 'should return the values' do
+      text_reply['woot'] = 'root'
+      delay_reply['duration'] = 4.3
+      expect(text_reply['woot']).to eq 'root'
+      expect(delay_reply['duration']).to eq 4.3
+    end
+  end
+
+  describe 'reply_type' do
+    it 'should act as a getter method for reply_type' do
+      expect(text_reply.reply_type).to eq 'text'
+      expect(delay_reply.reply_type).to eq 'delay'
+    end
+  end
+
+  describe 'delay?' do
+    it 'should return false for a text reply' do
+      expect(text_reply.delay?).to be false
+    end
+
+    it 'should return true for a delay reply' do
+      expect(delay_reply.delay?).to be true
+    end
+  end
+
+  describe 'self.dynamic_delay' do
+    it 'should return a new Xip::Reply' do
+      expect(Xip::Reply.dynamic_delay).to be_a(Xip::Reply)
+    end
+
+    it 'should be a dynamic delay' do
+      expect(Xip::Reply.dynamic_delay.delay?).to be true
+      expect(Xip::Reply.dynamic_delay.reply_type).to eq 'delay'
+      expect(Xip::Reply.dynamic_delay['duration']).to eq 'dynamic'
+    end
+  end
+
+end