bobot 1.0.52

data/spec/bobot/event/referral_spec.rb

@@ -0,0 +1,66 @@
+require 'rails_helper'
+
+RSpec.describe Bobot::Event::Referral do
+  let :payload do
+    {
+      'sender' => {
+        'id' => '3'
+      },
+      'recipient' => {
+        'id' => '3'
+      },
+      'timestamp' => 1_458_692_752_478,
+      'referral' => {
+        'ref' => 'my-ref-value',
+        'source' => 'SHORTLINK',
+        'type' => 'OPEN_THREAD'
+      }
+    }
+  end
+
+  subject { Bobot::Event::Referral.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 message was sent' do
+      expect(subject.sent_at).to eq(Time.zone.at(payload['timestamp'] / 1000))
+    end
+  end
+
+  describe '.referral' do
+    it 'returns the ref value' do
+      expect(subject.referral.ref).to eq(payload['referral']['ref'])
+    end
+
+    it 'returns the source value' do
+      expect(subject.referral.source).to eq(payload['referral']['source'])
+    end
+
+    it 'returns the type value' do
+      expect(subject.referral.type).to eq(payload['referral']['type'])
+    end
+  end
+
+  describe '.ref' do
+    it 'returns the ref value' do
+      expect(subject.ref).to eq(payload['referral']['ref'])
+    end
+  end
+end

data/spec/bobot/event_spec.rb

@@ -0,0 +1,167 @@
+require 'rails_helper'
+
+RSpec.describe Bobot::Event do
+  describe '.parse' do
+    context 'when the payload is unknown' do
+      let :payload do
+        {
+          'foo' => 'bar'
+        }
+      end
+
+      it 'raises UnknownPayload' do
+        expect { subject.parse(payload) }.to raise_error(
+          Bobot::Event::UnknownPayload, payload.to_s
+        )
+      end
+    end
+
+    context 'when the payload is a message' do
+      let :payload do
+        {
+          'sender' => {
+            'id' => '2'
+          },
+          'recipient' => {
+            'id' => '3'
+          },
+          'timestamp' => 145_776_419_762_7,
+          'message' => {
+            'mid' => 'mid.1457764197618:41d102a3e1ae206a38',
+            'seq' => 73,
+            'text' => 'Hello, bot!'
+          }
+        }
+      end
+
+      it 'returns an Event::Message' do
+        expect(subject.parse(payload)).to be_a(
+          Bobot::Event::Message
+        )
+      end
+    end
+
+    context 'when the payload is a message echo' do
+      let :payload do
+        {
+          'sender' => {
+            'id' => '2'
+          },
+          'recipient' => {
+            'id' => '3'
+          },
+          'timestamp' => 145_776_419_762_7,
+          'message' => {
+            'is_echo' => true,
+            'mid' => 'mid.1457764197618:41d102a3e1ae206a38',
+            'seq' => 73,
+            'text' => 'Hello, bot!'
+          }
+        }
+      end
+
+      it 'returns an Event::MessageEcho' do
+        expect(subject.parse(payload)).to be_a(
+          Bobot::Event::MessageEcho
+        )
+      end
+    end
+
+    context 'when the payload is a 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
+
+      it 'returns an Event::Delivery' do
+        expect(subject.parse(payload)).to be_a(
+          Bobot::Event::Delivery
+        )
+      end
+    end
+
+    context 'when the payload is a postback' do
+      let :payload do
+        {
+          'sender' => {
+            'id' => '3'
+          },
+          'recipient' => {
+            'id' => '3'
+          },
+          'timestamp' => 145_776_419_762_7,
+          'postback' => {
+            'payload' => 'USER_DEFINED_PAYLOAD'
+          }
+        }
+      end
+
+      it 'returns an Event::Postback' do
+        expect(subject.parse(payload)).to be_a(
+          Bobot::Event::Postback
+        )
+      end
+    end
+
+    context 'when the payload is an optin' do
+      let :payload do
+        {
+          'sender' => {
+            'id' => '3'
+          },
+          'recipient' => {
+            'id' => '3'
+          },
+          'timestamp' => 145_776_419_762_7,
+          'optin' => {
+            'ref' => 'PASS_THROUGH_PARAM'
+          }
+        }
+      end
+
+      it 'returns an Event::Optin' do
+        expect(subject.parse(payload)).to be_a(
+          Bobot::Event::Optin
+        )
+      end
+    end
+
+    context 'when the payload is a read' do
+      let :payload do
+        {
+          'sender' => {
+            'id' => '3'
+          },
+          'recipient' => {
+            'id' => '3'
+          },
+          'timestamp' => 145_776_419_762_7,
+          'read' => {
+            'watermark' => 145_866_885_625_3,
+            'seq' => 38
+          }
+        }
+      end
+
+      it 'returns an Event::Read' do
+        expect(subject.parse(payload)).to be_a(
+          Bobot::Event::Read
+        )
+      end
+    end
+  end
+end

data/spec/bobot/install_generator_spec.rb

@@ -0,0 +1,43 @@
+require 'rails_helper'
+require 'generators/bobot/install_generator'
+
+RSpec.describe Bobot::InstallGenerator, type: :generator do
+  destination File.expand_path('../../dummy/tmp/generator', __FILE__)
+  arguments ['bot']
+
+  before do
+    prepare_destination
+  end
+
+  it 'mounts Bobot as Engine and generates Bobot Initializer' do
+    expect_any_instance_of(generator_class).to receive(:route).
+      with('mount Bobot::Engine => \'/bot\', as: \'bot\'')
+    silence_stream(STDOUT) do
+      generator.invoke('install')
+    end
+    expect(destination_root).to have_structure {
+      directory 'config' do
+        directory 'initializers' do
+          file 'bobot.rb' do
+            contains 'Bobot.configure'
+          end
+        end
+        directory 'locales' do
+          file 'bobot.en.yml' do
+            contains 'en:'
+          end
+          file 'bobot.fr.yml' do
+            contains 'fr:'
+          end
+        end
+      end
+      directory 'app' do
+        directory 'bobot' do
+          file 'workflow.rb' do
+            contains 'Bobot::Commander'
+          end
+        end
+      end
+    }
+  end
+end

data/spec/bobot/profile_spec.rb

@@ -0,0 +1,170 @@
+require 'rails_helper'
+require 'helpers/graph_api_helpers'
+
+RSpec.describe Bobot::Profile do
+  let(:access_token) { 'access token' }
+
+  let(:messenger_profile_url) do
+    File.join(
+      described_class::GRAPH_FB_URL,
+      described_class::GRAPH_FB_VERSION,
+      '/me/messenger_profile'
+    )
+  end
+
+  before do
+    Bobot.page_access_token = access_token
+  end
+
+  describe '.set' do
+    context 'with a successful response' do
+      before do
+        stub_request(:post, messenger_profile_url)
+          .with(
+            query: {
+              access_token: access_token
+            },
+            body: ActiveSupport::JSON.encode(
+              get_started: {
+                payload: 'GET_STARTED_PAYLOAD'
+              }
+            )
+          )
+          .to_return(
+            body: ActiveSupport::JSON.encode(
+              result: 'Successfully added Get Started button'
+            ),
+            status: :ok,
+            headers: default_graph_api_response_headers
+          )
+      end
+
+      it 'returns hash' do
+        expect(
+          subject.set(
+            body: {
+              get_started: {
+                payload: 'GET_STARTED_PAYLOAD'
+              }
+            },
+            query: {
+              access_token: access_token
+            }
+          )
+        ).to include('result' => 'Successfully added Get Started button')
+      end
+    end
+
+    context 'with an unsuccessful response' do
+      let(:error_message) { 'Invalid OAuth access token.' }
+
+      before do
+        stub_request(:post, messenger_profile_url)
+          .with(query: { access_token: access_token })
+          .to_return(
+            body: ActiveSupport::JSON.encode(
+              'error' => {
+                'message' => error_message,
+                'type' => 'OAuthException',
+                'code' => 190,
+                'fbtrace_id' => 'Hlssg2aiVlN'
+              }
+            ),
+            status: :ok,
+            headers: default_graph_api_response_headers
+          )
+      end
+
+      it 'raises an error' do
+        expect do
+          subject.set(
+            body: {
+              get_started: {
+                payload: 'GET_STARTED_PAYLOAD'
+              }
+            },
+            query: {
+              access_token: access_token
+            }
+          )
+        end.to raise_error(Bobot::AccessTokenError)
+      end
+    end
+  end
+
+  describe '.unset' do
+    context 'with a successful response' do
+      before do
+        stub_request(:delete, messenger_profile_url)
+          .with(
+            query: {
+              access_token: access_token
+            },
+            body: ActiveSupport::JSON.encode(
+              fields: [
+                'get_started'
+              ]
+            )
+          )
+          .to_return(
+            body: ActiveSupport::JSON.encode(
+              result: 'Successfully deleted Get Started button'
+            ),
+            status: :ok,
+            headers: default_graph_api_response_headers
+          )
+      end
+
+      it 'returns hash' do
+        expect(
+          subject.unset(
+            body: {
+              fields: [
+                'get_started'
+              ]
+            },
+            query: {
+              access_token: access_token
+            }
+          )
+        ).to include('result' => 'Successfully deleted Get Started button')
+      end
+    end
+
+    context 'with an unsuccessful response' do
+      let(:error_message) { 'Invalid OAuth access token.' }
+
+      before do
+        stub_request(:delete, messenger_profile_url)
+          .with(query: { access_token: access_token })
+          .to_return(
+            body: ActiveSupport::JSON.encode(
+              'error' => {
+                'message' => error_message,
+                'type' => 'OAuthException',
+                'code' => 190,
+                'fbtrace_id' => 'Hlssg2aiVlN'
+              }
+            ),
+            status: :ok,
+            headers: default_graph_api_response_headers
+          )
+      end
+
+      it 'raises an error' do
+        expect do
+          subject.unset(
+            body: {
+              fields: [
+                'get_started'
+              ]
+            },
+            query: {
+              access_token: access_token
+            }
+          )
+        end.to raise_error(Bobot::AccessTokenError)
+      end
+    end
+  end
+end

data/spec/bobot/subscription_spec.rb

@@ -0,0 +1,139 @@
+require 'rails_helper'
+require 'helpers/graph_api_helpers'
+
+RSpec.describe Bobot::Subscription do
+  let(:access_token) { 'access token' }
+  let(:page_id) { 'page-id' }
+
+  let(:subscription_url) do
+    File.join(
+      described_class::GRAPH_FB_URL,
+      described_class::GRAPH_FB_VERSION,
+      "/#{page_id}",
+      '/subscribed_apps',
+    )
+  end
+
+  before do
+    Bobot.page_access_token = access_token
+    Bobot.page_id = page_id
+  end
+
+  describe '.set' do
+    context 'with a successful response' do
+      before do
+        stub_request(:post, subscription_url)
+          .with(query: { access_token: access_token})
+          .to_return(
+            body: ActiveSupport::JSON.encode(
+              success: true,
+            ),
+            status: :ok,
+            headers: default_graph_api_response_headers
+          )
+      end
+
+      it 'returns hash' do
+        expect(
+          subject.set(
+            query: {
+              page_id: page_id,
+              access_token: access_token,
+            }
+          )
+        ).to include('success' => true)
+      end
+    end
+
+    context 'with an unsuccessful response' do
+      let(:error_message) { 'Invalid OAuth access token.' }
+
+      before do
+        stub_request(:post, subscription_url)
+          .with(query: { access_token: access_token })
+          .to_return(
+            body: {
+              'error' => {
+                'message' => error_message,
+                'type' => 'OAuthException',
+                'code' => 190,
+                'fbtrace_id' => 'Hlssg2aiVlN'
+              }
+            }.to_json,
+            status: :ok,
+            headers: default_graph_api_response_headers
+          )
+      end
+
+      it 'raises an error' do
+        expect do
+          subject.set(
+            query: {
+              page_id: page_id,
+              access_token: access_token,
+            }
+          )
+        end.to raise_error(Bobot::AccessTokenError)
+      end
+    end
+  end
+
+  describe '.unset' do
+    context 'with a successful response' do
+      before do
+        stub_request(:delete, subscription_url)
+          .with(query: { access_token: access_token })
+          .to_return(
+            body: ActiveSupport::JSON.encode(
+              success: true,
+            ),
+            status: :ok,
+            headers: default_graph_api_response_headers
+          )
+      end
+
+      it 'returns hash' do
+        expect(
+          subject.unset(
+            query: {
+              page_id: page_id,
+              access_token: access_token,
+            }
+          )
+        ).to include('success' => true)
+      end
+    end
+
+    context 'with an unsuccessful response' do
+      let(:error_message) { 'Invalid OAuth access token.' }
+
+      before do
+        stub_request(:delete, subscription_url)
+          .with(query: { access_token: access_token })
+          .to_return(
+            body: {
+              'error' => {
+                'message' => error_message,
+                'type' => 'OAuthException',
+                'code' => 190,
+                'fbtrace_id' => 'Hlssg2aiVlN'
+              }
+            }.to_json,
+            status: :ok,
+            headers: default_graph_api_response_headers
+          )
+      end
+
+      it 'raises an error' do
+        expect do
+          subject.unset(
+            query: {
+              page_id: page_id,
+              access_token: access_token,
+            }
+          )
+        end.to raise_error(Bobot::AccessTokenError)
+      end
+    end
+  end
+end