bobot 1.0.52

data/spec/bobot/bobot_spec.rb

@@ -0,0 +1,24 @@
+require 'rails_helper'
+
+RSpec.describe Bobot do
+  describe '#configure' do
+    it 'sets correct configuration' do
+      Bobot.configure do |config|
+        config.app_id = '1'
+        config.app_secret = '2'
+        config.page_access_token = '3'
+        config.verify_token = '4'
+        config.page_id = '5'
+        config.debug_log = true
+        config.async = true
+      end
+      expect(Bobot.app_id).to eql('1')
+      expect(Bobot.app_secret).to eql('2')
+      expect(Bobot.page_access_token).to eql('3')
+      expect(Bobot.verify_token).to eql('4')
+      expect(Bobot.page_id).to eql('5')
+      expect(Bobot.debug_log).to eql(true)
+      expect(Bobot.async).to eql(true)
+    end
+  end
+end

data/spec/bobot/event/account_linking_spec.rb

@@ -0,0 +1,59 @@
+require 'rails_helper'
+require 'helpers/graph_api_helpers'
+
+RSpec.describe Bobot::Event::AccountLinking do
+  let :payload do
+    {
+      'sender' => {
+        'id' => '3'
+      },
+      'recipient' => {
+        'id' => '3'
+      },
+      'timestamp' => 145_776_419_762_7,
+      'account_linking' => {
+        'status' => 'linked',
+        'authorization_code' => 'PASS_THROUGH_AUTHORIZATION_CODE'
+      }
+    }
+  end
+
+  subject { Bobot::Event::AccountLinking.new(payload) }
+
+  describe '.messaging' do
+    it 'returns the original payload' do
+      expect(subject.messaging).to eq(payload)
+    end
+  end
+
+  describe '.sender' do
+    it 'returns the sender' do
+      expect(subject.sender).to eq(payload['sender'])
+    end
+  end
+
+  describe '.recipient' do
+    it 'returns the recipient' do
+      expect(subject.recipient).to eq(payload['recipient'])
+    end
+  end
+
+  describe '.sent_at' do
+    it 'returns when the postback was sent' do
+      expect(subject.sent_at).to eq(Time.zone.at(payload['timestamp'] / 1000))
+    end
+  end
+
+  describe '.status' do
+    it 'returns linking status defined with the entry point' do
+      expect(subject.status).to eq(payload['account_linking']['status'])
+    end
+  end
+
+  describe '.authorization_code' do
+    it 'returns authorization code defined with the entry point' do
+      expect(subject.authorization_code)
+        .to eq(payload['account_linking']['authorization_code'])
+    end
+  end
+end

data/spec/bobot/event/common_spec.rb

@@ -0,0 +1,259 @@
+require 'rails_helper'
+
+module Bobot
+  class Dummy
+    include Bobot::Event::Common
+  end
+end
+
+RSpec.describe Bobot::Dummy do
+  let :payload do
+    {
+      'sender' => {
+        'id' => '3'
+      },
+      'recipient' => {
+        'id' => '3'
+      },
+      'timestamp' => 145_776_419_762_7,
+      'message' => {
+        'is_echo' => false,
+        'mid' => 'mid.1457764197618:41d102a3e1ae206a38',
+        'seq' => 73,
+        'text' => 'Hello, bot!',
+        'quick_reply' => {
+          'payload' => 'Hi, I am a quick reply!'
+        },
+        'attachments' => [{
+          'type' => 'image',
+          'payload' => {
+            'url' => 'https://www.example.com/1.jpg'
+          }
+        }]
+      }
+    }
+  end
+
+  let(:access_token) { 'access_token' }
+
+  before do
+    Bobot.page_access_token = access_token
+  end
+
+  subject { described_class.new(payload) }
+
+  describe '.sender' do
+    it 'returns the sender' do
+      expect(subject.sender).to eq(payload['sender'])
+    end
+  end
+
+  describe '.recipient' do
+    it 'returns the recipient' do
+      expect(subject.recipient).to eq(payload['recipient'])
+    end
+  end
+
+  describe '.sent_at' do
+    it 'returns when the message was sent' do
+      expect(subject.sent_at).to eq(Time.zone.at(payload['timestamp'] / 1000))
+    end
+  end
+
+  describe '.show_typing' do
+    it 'sends a typing on indicator to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: { sender_action: 'typing_on' }
+      )
+      subject.show_typing(state: true)
+    end
+    it 'sends a typing on indicator to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: { sender_action: 'typing_off' }
+      )
+      subject.show_typing(state: false)
+    end
+  end
+
+  describe '.mark_as_seen' do
+    it 'sends a typing off indicator to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: { sender_action: 'mark_seen' }
+      )
+      subject.mark_as_seen
+    end
+  end
+
+  describe '.reply_with_text' do
+    it 'replies to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: { message: { text: 'Hello, human' } }
+      )
+      subject.reply_with_text(text: 'Hello, human')
+    end
+  end
+
+  describe '.reply_with_image' do
+    it 'replies to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: {
+          message: {
+            attachment: {
+              type: 'image',
+              payload: {
+                url: 'https://www.foo.bar/image.jpg',
+                is_reusable: true,
+              },
+            },
+          },
+        },
+      )
+      subject.reply_with_image(url: 'https://www.foo.bar/image.jpg')
+    end
+  end
+
+  describe '.reply_with_audio' do
+    it 'replies to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: {
+          message: {
+            attachment: {
+              type: 'audio',
+              payload: {
+                url: 'https://www.foo.bar/audio.mp3',
+              },
+            },
+          },
+        },
+      )
+      subject.reply_with_audio(url: 'https://www.foo.bar/audio.mp3')
+    end
+  end
+
+  describe '.reply_with_video' do
+    it 'replies to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: {
+          message: {
+            attachment: {
+              type: 'video',
+              payload: {
+                url: 'https://www.foo.bar/video.mp4',
+              },
+            },
+          },
+        },
+      )
+      subject.reply_with_video(url: 'https://www.foo.bar/video.mp4')
+    end
+  end
+
+  describe '.reply_with_file' do
+    it 'replies to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: {
+          message: {
+            attachment: {
+              type: 'file',
+              payload: {
+                url: 'https://www.foo.bar/file.zip',
+              },
+            },
+          },
+        },
+      )
+      subject.reply_with_file(url: 'https://www.foo.bar/file.zip')
+    end
+  end
+
+  describe '.reply_with_quick_replies' do
+    it 'replies to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: {
+          message: {
+            text: 'Pick a color:',
+            quick_replies: [
+              {
+                content_type: 'text',
+                title: 'RED',
+                payload: 'PICKED_RED_COLOR',
+                image_url: 'https://foo.bar/red.png'
+              },
+              {
+                content_type: 'text',
+                title: 'GREEN',
+                payload: 'PICKED_GREEN_COLOR'
+              }
+            ]
+          },
+        },
+      )
+      subject.reply_with_quick_replies(
+        text: 'Pick a color:',
+        quick_replies: [
+          {
+            content_type: 'text',
+            title: 'RED',
+            payload: 'PICKED_RED_COLOR',
+            image_url: 'https://foo.bar/red.png'
+          },
+          {
+            content_type: 'text',
+            title: 'GREEN',
+            payload: 'PICKED_GREEN_COLOR'
+          },
+        ]
+      )
+    end
+    it 'asks the location to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: {
+          message: {
+            text: 'Where are you',
+            quick_replies: [
+              {
+                content_type: 'location',
+                image_url: 'https://foo.bar/gps.png',
+              }
+            ]
+          },
+        },
+      )
+      subject.reply_with_quick_replies(
+        text: 'Where are you',
+        quick_replies: [
+          Bobot::Buttons.quick_reply_location(image_url: 'https://foo.bar/gps.png')
+        ]
+      )
+    end
+  end
+
+  describe '.reply_with_buttons' do
+    it 'replies to the sender' do
+      expect(subject).to receive(:deliver).with(
+        payload_template: {
+          message: {
+            attachment: {
+              type: 'template',
+              payload: {
+                template_type: 'button',
+                text: 'Human, do you like me?',
+                buttons: [
+                  { type: 'postback', title: 'Yes', payload: 'HARMLESS' },
+                  { type: 'postback', title: 'No', payload: 'WHAT_IS_A_CHATBOT' }
+                ]
+              }
+            }
+          },
+        },
+      )
+      subject.reply_with_buttons(
+        text: 'Human, do you like me?',
+        buttons: [
+          { type: 'postback', title: 'Yes', payload: 'HARMLESS' },
+          { type: 'postback', title: 'No', payload: 'WHAT_IS_A_CHATBOT' }
+        ]
+      )
+    end
+  end
+end

data/spec/bobot/event/delivery_spec.rb

@@ -0,0 +1,62 @@
+require 'rails_helper'
+
+RSpec.describe Bobot::Event::Delivery do
+  let :payload do
+    {
+      'sender' => {
+        'id' => '3'
+      },
+      'recipient' => {
+        'id' => '3'
+      },
+      'delivery' => {
+        'mids' => [
+          'mid.1457764197618:41d102a3e1ae206a38',
+          'mid.1458668856218:ed81099e15d3f4f233'
+        ],
+        'watermark' => 145_866_885_625_3,
+        'seq' => 37
+      }
+    }
+  end
+
+  subject { Bobot::Event::Delivery.new(payload) }
+
+  describe '.messaging' do
+    it 'returns the original payload' do
+      expect(subject.messaging).to eq(payload)
+    end
+  end
+
+  describe '.ids' do
+    it 'returns the message ids' do
+      expect(subject.ids).to eq(payload['delivery']['mids'])
+    end
+  end
+
+  describe '.sender' do
+    it 'returns the sender' do
+      expect(subject.sender).to eq(payload['sender'])
+    end
+  end
+
+  describe '.recipient' do
+    it 'returns the recipient' do
+      expect(subject.recipient).to eq(payload['recipient'])
+    end
+  end
+
+  describe '.seq' do
+    it 'returns the message sequence number' do
+      expect(subject.seq).to eq(payload['delivery']['seq'])
+    end
+  end
+
+  describe '.at' do
+    it 'returns a Time' do
+      expect(subject.at).to eq(
+        Time.zone.at(payload['delivery']['watermark'] / 1000)
+      )
+    end
+  end
+end

data/spec/bobot/event/message_echo_spec.rb

@@ -0,0 +1,276 @@
+require 'rails_helper'
+
+RSpec.describe Bobot::Event::MessageEcho do
+  let :payload do
+    {
+      'sender' => {
+        'id' => '3'
+      },
+      'recipient' => {
+        'id' => '3'
+      },
+      'timestamp' => 145_776_419_762_7,
+      'message' => {
+        'is_echo' => true,
+        'app_id' => 184_719_329_217_930_000,
+        'mid' => 'mid.1457764197618:41d102a3e1ae206a38',
+        'seq' => 73,
+        'text' => 'Hello, bot!',
+        'quick_reply' => {
+          'payload' => 'Hi, I am a quick reply!'
+        },
+        'attachments' => [{
+          'type' => 'image',
+          'payload' => {
+            'url' => 'https://www.example.com/1.jpg'
+          }
+        }]
+      }
+    }
+  end
+
+  let :video_payload do
+    {
+      'sender' => {
+        'id' => '5'
+      },
+      'recipient' => {
+        'id' => '7'
+      },
+      'timestamp' => 145_776_419_762_4,
+      'message' => {
+        'is_echo' => true,
+        'app_id' => 184_719_329_217_930_001,
+        'mid' => 'mid.1457764197618:41d102a3e1ae206a38',
+        'attachments' => [{
+          'type' => 'video',
+          'payload' => {
+            'url' => 'https://www.example.com/2.mp4'
+          }
+        }]
+      }
+    }
+  end
+
+  let :file_payload do
+    {
+      'sender' => {
+        'id' => '5'
+      },
+      'recipient' => {
+        'id' => '7'
+      },
+      'timestamp' => 145_776_412_762_4,
+      'message' => {
+        'is_echo' => true,
+        'app_id' => 184_719_329_217_930_001,
+        'mid' => 'mid.1457764197618:41d102a3e1ae206a39',
+        'attachments' => [{
+          'type' => 'file',
+          'payload' => {
+            'url' => 'https://www.example.com/3.pdf'
+          }
+        }]
+      }
+    }
+  end
+
+  let :audio_payload do
+    {
+      'sender' => {
+        'id' => '8'
+      },
+      'recipient' => {
+        'id' => '9'
+      },
+      'timestamp' => 145_776_419_732_4,
+      'message' => {
+        'is_echo' => true,
+        'app_id' => 184_719_329_217_930_001,
+        'mid' => 'mid.1457764197618:41d102a3e1ae206a48',
+        'attachments' => [{
+          'type' => 'audio',
+          'payload' => {
+            'url' => 'https://www.example.com/4.ogg'
+          }
+        }]
+      }
+    }
+  end
+
+  let :location_payload do
+    {
+      'sender' => {
+        'id' => '6'
+      },
+      'recipient' => {
+        'id' => '9'
+      },
+      'timestamp' => 145_776_429_762_4,
+      'message' => {
+        'is_echo' => true,
+        'app_id' => 184_719_329_222_930_001,
+        'mid' => 'mid.1457764197618:41d102a3e1ae206a38',
+        'attachments' => [{
+          'type' => 'location',
+          'payload' => {
+            'coordinates' => {
+              'lat' => '39.920_770',
+              'long' => '40.920_770'
+            }
+          }
+        }]
+      }
+    }
+  end
+
+  subject { Bobot::Event::MessageEcho.new(payload) }
+
+  describe '.messaging' do
+    it 'returns the original payload' do
+      expect(subject.messaging).to eq(payload)
+    end
+  end
+
+  describe '.id' do
+    it 'returns the message echo id' do
+      expect(subject.id).to eq(payload['message']['mid'])
+    end
+  end
+
+  describe '.sender' do
+    it 'returns the sender' do
+      expect(subject.sender).to eq(payload['sender'])
+    end
+  end
+
+  describe '.recipient' do
+    it 'returns the recipient' do
+      expect(subject.recipient).to eq(payload['recipient'])
+    end
+  end
+
+  describe '.seq' do
+    it 'returns the message echo sequence number' do
+      expect(subject.seq).to eq(payload['message']['seq'])
+    end
+  end
+
+  describe '.sent_at' do
+    it 'returns when the message echo was sent' do
+      expect(subject.sent_at).to eq(Time.zone.at(payload['timestamp'] / 1000))
+    end
+  end
+
+  describe '.text' do
+    it 'returns the text of the message echo' do
+      expect(subject.text).to eq(payload['message']['text'])
+    end
+  end
+
+  describe '.echo?' do
+    it 'returns the echo status of the message echo' do
+      expect(subject.echo?).to eq(payload['message']['is_echo'])
+    end
+  end
+
+  describe '.attachments' do
+    it 'returns the message echo attachments' do
+      expect(subject.attachments).to eq(payload['message']['attachments'])
+    end
+  end
+
+  describe '.image_attachment?' do
+    it 'returns whether the attachment is an image' do
+      expect(subject.image_attachment?).to be(true)
+    end
+  end
+
+  describe '.video_attachment?' do
+    subject { Bobot::Event::MessageEcho.new(video_payload) }
+
+    it 'returns whether the attachment is a video' do
+      expect(subject.video_attachment?).to be(true)
+    end
+  end
+
+  describe '.location_attachment?' do
+    subject { Bobot::Event::MessageEcho.new(location_payload) }
+
+    it 'returns whether the attachment is a video' do
+      expect(subject.location_attachment?).to be(true)
+    end
+  end
+
+  describe '.audio_attachment?' do
+    subject { Bobot::Event::MessageEcho.new(audio_payload) }
+
+    it 'returns whether the attachment is an audio' do
+      expect(subject.audio_attachment?).to be(true)
+    end
+  end
+
+  describe '.file_attachment?' do
+    subject { Bobot::Event::MessageEcho.new(file_payload) }
+
+    it 'returns whether the attachment is a file' do
+      expect(subject.file_attachment?).to be(true)
+    end
+  end
+
+  describe '.location_coordinates' do
+    subject { Bobot::Event::MessageEcho.new(location_payload) }
+
+    let(:attachments) { location_payload['message']['attachments'] }
+
+    it 'returns array of lat long coordinates' do
+      expect(subject.location_coordinates).to eq(
+        [
+          attachments.first['payload']['coordinates']['lat'],
+          attachments.first['payload']['coordinates']['long']
+        ]
+      )
+    end
+  end
+
+  describe '.attachment_type' do
+    it 'returns the type of the attachment' do
+      expect(subject.attachment_type).to eq(
+        payload['message']['attachments'].first['type']
+      )
+    end
+  end
+
+  describe '.attachment_url' do
+    it 'returns the url of the attachment' do
+      expect(subject.attachment_url).to eq(
+        payload['message']['attachments'].first['payload']['url']
+      )
+    end
+  end
+  describe '.app_id' do
+    it 'returns the app_id from which the message echo was sent' do
+      expect(subject.app_id).to eq(payload['message']['app_id'])
+    end
+  end
+
+  describe '.quick_reply' do
+    context 'when a quick reply was used' do
+      it 'returns the payload of the quick reply' do
+        expect(subject.quick_reply).to eq(
+          payload['message']['quick_reply']['payload']
+        )
+      end
+    end
+
+    context 'when a quick reply was not used' do
+      before do
+        payload['message'].delete('quick_reply')
+      end
+
+      it 'returns nil' do
+        expect(subject.quick_reply).to eq(nil)
+      end
+    end
+  end
+end